This is org.info, produced by makeinfo version 6.6 from org.texi.

This manual is for Org version 9.1.9.

   Copyright © 2004–2019 Free Software Foundation, Inc.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.3 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being “A GNU Manual,” and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     “GNU Free Documentation License.”

     (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
     modify this GNU manual.”
INFO-DIR-SECTION Emacs editing modes
START-INFO-DIR-ENTRY
* Org Mode: (org).      Outline-based notes management and organizer
END-INFO-DIR-ENTRY


File: org.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)

Org Mode Manual
***************

This manual is for Org version 9.1.9.

   Copyright © 2004–2019 Free Software Foundation, Inc.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.3 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being “A GNU Manual,” and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     “GNU Free Documentation License.”

     (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
     modify this GNU manual.”

* Menu:

* Introduction::                Getting started
* Document structure::          A tree works like your brain
* Tables::                      Pure magic for quick formatting
* Hyperlinks::                  Notes in context
* TODO items::                  Every tree branch can be a TODO item
* Tags::                        Tagging headlines and matching sets of tags
* Properties and columns::      Storing information about an entry
* Dates and times::             Making items useful for planning
* Capture - Refile - Archive::  The ins and outs for projects
* Agenda views::                Collecting information into views
* Markup::                      Prepare text for rich export
* Exporting::                   Sharing and publishing notes
* Publishing::                  Create a web site of linked Org files
* Working with source code::    Export, evaluate, and tangle code blocks
* Miscellaneous::               All the rest which did not fit elsewhere
* Hacking::                     How to hack your way around
* History and acknowledgments::  How Org came into being
* GNU Free Documentation License::  The license for this documentation.
* Main Index::                  An index of Org’s concepts and features
* Key Index::                   Key bindings and where they are described
* Command and Function Index::  Command names and some internal functions
* Variable Index::              Variables mentioned in the manual

 — The Detailed Node Listing —

Introduction

* Summary::                     Brief summary of what Org does
* Installation::                Installing Org
* Activation::                  How to activate Org for certain buffers
* Feedback::                    Bug reports, ideas, patches etc.
* Conventions::                 Typesetting conventions in the manual

Document structure

* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
* Blocks::                      Folding blocks
* Footnotes::                   How footnotes are defined in Org’s syntax
* Orgstruct mode::              Structure editing outside Org
* Org syntax::                  Formal description of Org’s syntax

Visibility cycling

* Global and local cycling::    Cycling through various visibility states
* Initial visibility::          Setting the initial visibility state
* Catching invisible edits::    Preventing mistakes when editing invisible parts

Tables

* Built-in table editor::       Simple tables
* Column width and alignment::  Overrule the automatic settings
* Column groups::               Grouping to trigger vertical lines
* Orgtbl mode::                 The table editor as minor mode
* The spreadsheet::             The table editor has spreadsheet capabilities
* Org-Plot::                    Plotting from org tables

The spreadsheet

* References::                  How to refer to another field or range
* Formula syntax for Calc::     Using Calc to compute stuff
* Formula syntax for Lisp::     Writing formulas in Emacs Lisp
* Durations and time values::   How to compute durations and time values
* Field and range formulas::    Formula for specific (ranges of) fields
* Column formulas::             Formulas valid for an entire column
* Lookup functions::            Lookup functions for searching tables
* Editing and debugging formulas::  Fixing formulas
* Updating the table::          Recomputing all dependent fields
* Advanced features::           Field and column names, parameters and automatic recalc

Hyperlinks

* Link format::                 How links in Org are formatted
* Internal links::              Links to other places in the current file
* External links::              URL-like links to the world
* Handling links::              Creating, inserting and following
* Using links outside Org::     Linking from my C source code?
* Link abbreviations::          Shortcuts for writing complex links
* Search options::              Linking to a specific location
* Custom searches::             When the default search is not enough

Internal links

* Radio targets::               Make targets trigger links in plain text

TODO items

* TODO basics::                 Marking and displaying TODO entries
* TODO extensions::             Workflow and assignments
* Progress logging::            Dates and notes for progress
* Priorities::                  Some things are more important than others
* Breaking down tasks::         Splitting a task into manageable pieces
* Checkboxes::                  Tick-off lists

Extended use of TODO keywords

* Workflow states::             From TODO to DONE in steps
* TODO types::                  I do this, Fred does the rest
* Multiple sets in one file::   Mixing it all, and still finding your way
* Fast access to TODO states::  Single letter selection of a state
* Per-file keywords::           Different files, different requirements
* Faces for TODO keywords::     Highlighting states
* TODO dependencies::           When one task needs to wait for others

Progress logging

* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
* Tracking your habits::        How consistent have you been?

Tags

* Tag inheritance::             Tags use the tree structure of the outline
* Setting tags::                How to assign tags to a headline
* Tag hierarchy::               Create a hierarchy of tags
* Tag searches::                Searching for combinations of tags

Properties and columns

* Property syntax::             How properties are spelled out
* Special properties::          Access to other Org mode features
* Property searches::           Matching property values
* Property inheritance::        Passing values down the tree
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers

Column view

* Defining columns::            The COLUMNS format property
* Using column view::           How to create and use column view
* Capturing column view::       A dynamic block for column view

Defining columns

* Scope of column definitions::  Where defined, where valid?
* Column attributes::           Appearance and content of a column

Dates and times

* Timestamps::                  Assigning a time to a tree entry
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
* Clocking work time::          Tracking how long you spend on a task
* Effort estimates::            Planning work effort in advance
* Timers::                      Notes with a running timer

Creating timestamps

* The date/time prompt::        How Org mode helps you entering date and time
* Custom time format::          Making dates look different

Deadlines and scheduling

* Inserting deadline/schedule::  Planning items
* Repeated tasks::              Items that show up again and again

Clocking work time

* Clocking commands::           Starting and stopping a clock
* The clock table::             Detailed reports
* Resolving idle time::         Resolving time when you’ve been idle

Capture - Refile - Archive

* Capture::                     Capturing new stuff
* Attachments::                 Add files to tasks
* RSS feeds::                   Getting input from RSS feeds
* Protocols::                   External (e.g., Browser) access to Emacs and Org
* Refile and copy::             Moving/copying a tree from one place to another
* Archiving::                   What to do with finished projects

Capture

* Setting up capture::          Where notes will be stored
* Using capture::               Commands to invoke and terminate capture
* Capture templates::           Define the outline of different note types

Capture templates

* Template elements::           What is needed for a complete template entry
* Template expansion::          Filling in information about time and context
* Templates in contexts::       Only show a template in a specific context

Protocols for external access

* store-link protocol::  Store a link, push URL to kill-ring.
* capture protocol::     Fill a buffer with external information.
* open-source protocol::  Edit published contents.

Archiving

* Moving subtrees::             Moving a tree to an archive file
* Internal archiving::          Switch off a tree but keep it in the file

Agenda views

* Agenda files::                Files being searched for agenda information
* Agenda dispatcher::           Keyboard access to agenda views
* Built-in agenda views::       What is available out of the box?
* Presentation and sorting::    How agenda items are prepared for display
* Agenda commands::             Remote editing of Org trees
* Custom agenda views::         Defining special searches and views
* Exporting agenda views::      Writing a view to a file
* Agenda column view::          Using column view for collected entries

The built-in agenda views

* Weekly/daily agenda::         The calendar page with current tasks
* Global TODO list::            All unfinished action items
* Matching tags and properties::  Structured information with fine-tuned search
* Search view::                 Find entries by searching for text
* Stuck projects::              Find projects you need to review

Presentation and sorting

* Categories::                  Not all tasks are equal
* Time-of-day specifications::  How the agenda knows the time
* Sorting agenda items::        The order of things
* Filtering/limiting agenda items::  Dynamically narrow the agenda

Custom agenda views

* Storing searches::            Type once, use often
* Block agenda::                All the stuff you need in a single buffer
* Setting options::             Changing the rules

Markup for rich export

* Paragraphs::                  The basic unit of text
* Emphasis and monospace::      Bold, italic, etc.
* Horizontal rules::            Make a line
* Images and tables::           Images, tables and caption mechanism
* Literal examples::            Source code examples with special formatting
* Special symbols::             Greek letters and other symbols
* Subscripts and superscripts::  Simple syntax for raising/lowering text
* Embedded LaTeX::           LaTeX can be freely used inside Org documents

Embedded LaTeX

* LaTeX fragments::          Complex formulas made easy
* Previewing LaTeX fragments::  What will this snippet look like?
* CDLaTeX mode::                Speed up entering of formulas

Exporting

* The export dispatcher::       The main interface
* Export settings::             Common export settings
* Table of contents::           The if and where of the table of contents
* Include files::               Include additional files into a document
* Macro replacement::           Use macros to create templates
* Comment lines::               What will not be exported
* ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
* Beamer export::               Exporting as a Beamer presentation
* HTML export::                 Exporting to HTML
* LaTeX export::             Exporting to LaTeX, and processing to PDF
* Markdown export::             Exporting to Markdown
* OpenDocument Text export::    Exporting to OpenDocument Text
* Org export::                  Exporting to Org
* Texinfo export::              Exporting to Texinfo
* iCalendar export::            Exporting to iCalendar
* Other built-in back-ends::    Exporting to a man page
* Advanced configuration::      Fine-tuning the export output
* Export in foreign buffers::   Author tables and lists in Org syntax

Beamer export

* Beamer export commands::      For creating Beamer documents.
* Beamer specific export settings::  For customizing Beamer export.
* Sectioning Frames and Blocks in Beamer::  For composing Beamer slides.
* Beamer specific syntax::      For using in Org documents.
* Editing support::             For using helper functions.
* A Beamer example::            A complete presentation.

HTML export

* HTML Export commands::        Invoking HTML export
* HTML Specific export settings::  Settings for HTML export
* HTML doctypes::               Exporting various (X)HTML flavors
* HTML preamble and postamble::  Inserting preamble and postamble
* Quoting HTML tags::           Using direct HTML in Org files
* Links in HTML export::        Interpreting and formatting links
* Tables in HTML export::       Formatting and modifying tables
* Images in HTML export::       Inserting figures with HTML output
* Math formatting in HTML export::  Handling math equations
* Text areas in HTML export::   Showing an alternate approach, an example
* CSS support::                 Styling HTML output
* JavaScript support::          Folding scripting in the web browser

LaTeX export

* LaTeX export commands::    For producing LaTeX and PDF documents.
* LaTeX specific export settings::  Unique to this LaTeX back-end.
* LaTeX header and sectioning::  For file structure.
* Quoting LaTeX code::       Directly in the Org document.
* Tables in LaTeX export::   Attributes specific to tables.
* Images in LaTeX export::   Attributes specific to images.
* Plain lists in LaTeX export::  Attributes specific to lists.
* Source blocks in LaTeX export::  Attributes specific to source code blocks.
* Example blocks in LaTeX export::  Attributes specific to example blocks.
* Special blocks in LaTeX export::  Attributes specific to special blocks.
* Horizontal rules in LaTeX export::  Attributes specific to horizontal rules.

OpenDocument Text export

* Pre-requisites for ODT export::  Required packages.
* ODT export commands::         Invoking export.
* ODT specific export settings::  Configuration options.
* Extending ODT export::        Producing ‘.doc’, ‘.pdf’ files.
* Applying custom styles::      Styling the output.
* Links in ODT export::         Handling and formatting links.
* Tables in ODT export::        Org table conversions.
* Images in ODT export::        Inserting images.
* Math formatting in ODT export::  Formatting LaTeX fragments.
* Labels and captions in ODT export::  Rendering objects.
* Literal examples in ODT export::  For source code and example blocks.
* Advanced topics in ODT export::  For power users.

Math formatting in ODT export

* Working with LaTeX math snippets::  Embedding in LaTeX format.
* Working with MathML or OpenDocument formula files::  Embedding in native format.

Advanced topics in ODT export

* Configuring a document converter::  Registering a document converter.
* Working with OpenDocument style files::  Exploring internals.
* Creating one-off styles::     Customizing styles, highlighting.
* Customizing tables in ODT export::  Defining table templates.
* Validating OpenDocument XML::  Debugging corrupted OpenDocument files.

Texinfo export

* Texinfo export commands::     Invoking commands.
* Texinfo specific export settings::  Setting the environment.
* Texinfo file header::         Generating the header.
* Texinfo title and copyright page::  Creating preamble pages.
* Info directory file::     Installing a manual in Info file hierarchy.
* Headings and sectioning structure::  Building document structure.
* Indices::                     Creating indices.
* Quoting Texinfo code::        Incorporating literal Texinfo code.
* Plain lists in Texinfo export::  List attributes.
* Tables in Texinfo export::    Table attributes.
* Images in Texinfo export::    Image attributes.
* Special blocks in Texinfo export::  Special block attributes.
* A Texinfo example::           Processing Org to Texinfo.

Publishing

* Configuration::               Defining projects
* Uploading files::             How to get files up on the server
* Sample configuration::        Example projects
* Triggering publication::      Publication commands

Configuration

* Project alist::               The central configuration variable
* Sources and destinations::    From here to there
* Selecting files::             What files are part of the project?
* Publishing action::           Setting the function doing the publishing
* Publishing options::          Tweaking HTML/LaTeX export
* Publishing links::            Which links keep working after publishing?
* Sitemap::                     Generating a list of all pages
* Generating an index::         An index that reaches across pages

Sample configuration

* Simple example::              One-component publishing
* Complex example::             A multi-component publishing example

Working with source code

* Structure of code blocks::    Code block syntax described
* Editing source code::         Language major-mode editing
* Exporting code blocks::       Export contents and/or results
* Extracting source code::      Create pure source code files
* Evaluating code blocks::      Place results of evaluation in the Org mode buffer
* Library of Babel::            Use and contribute to a library of useful code blocks
* Languages::                   List of supported code block languages
* Header arguments::            Configure code block functionality
* Results of evaluation::       How evaluation results are handled
* Noweb reference syntax::      Literate programming in Org mode
* Key bindings and useful functions::  Work quickly with code blocks
* Batch execution::             Call functions from the command line

Header arguments

* Using header arguments::      Different ways to set header arguments
* Specific header arguments::   List of header arguments

Using header arguments

* System-wide header arguments::  Set globally, language-specific
* Language-specific header arguments::  Set in the Org file’s headers
* Header arguments in Org mode properties::  Set in the Org file
* Language-specific mode properties::
* Code block specific header arguments::  The most commonly used method
* Arguments in function calls::  The most specific level, takes highest priority

Specific header arguments

* var::                         Pass arguments to ‘src’ code blocks
* results::                     Specify results type; how to collect
* file::                        Specify a path for output file
* file-desc::                   Specify a description for file results
* file-ext::                    Specify an extension for file output
* output-dir::                  Specify a directory for output file
* dir::                         Specify the default directory for code block execution
* exports::                     Specify exporting code, results, both, none
* tangle::                      Toggle tangling; or specify file name
* mkdirp::                      Toggle for parent directory creation for target files during tangling
* comments::                    Toggle insertion of comments in tangled code files
* padline::                     Control insertion of padding lines in tangled code files
* no-expand::                   Turn off variable assignment and noweb expansion during tangling
* session::                     Preserve the state of code evaluation
* noweb::                       Toggle expansion of noweb references
* noweb-ref::                   Specify block’s noweb reference resolution target
* noweb-sep::                   String to separate noweb references
* cache::                       Avoid re-evaluating unchanged code blocks
* sep::                         Delimiter for writing tabular results outside Org
* hlines::                      Handle horizontal lines in tables
* colnames::                    Handle column names in tables
* rownames::                    Handle row names in tables
* shebang::                     Make tangled files executable
* tangle-mode::                 Set permission of tangled files
* eval::                        Limit evaluation of specific code blocks
* wrap::                        Mark source block evaluation results
* post::                        Post processing of results of code block evaluation
* prologue::                    Text to prepend to body of code block
* epilogue::                    Text to append to body of code block

Miscellaneous

* Completion::                  M-<TAB> guesses completions
* Easy templates::              Quick insertion of structural elements
* Speed keys::                  Electric commands at the beginning of a headline
* Code evaluation security::    Org mode files evaluate inline code
* Customization::               Adapting Org to changing tastes
* In-buffer settings::          Overview of the #+KEYWORDS
* The very busy C-c C-c key::   When in doubt, press C-c C-c
* Clean view::                  Getting rid of leading stars in the outline
* TTY keys::                    Using Org on a tty
* Interaction::                 With other Emacs packages
* org-crypt::                   Encrypting Org files
* Org Mobile::                  Viewing and capture on a mobile device

Interaction with other packages

* Cooperation::                 Packages Org cooperates with
* Conflicts::                   Packages that lead to conflicts

Org Mobile

* Setting up the staging area::  For the mobile device
* Pushing to the mobile application::  Uploading Org files and agendas
* Pulling from the mobile application::  Integrating captured and flagged items

Hacking

* Hooks::                       How to reach into Org’s internals
* Add-on packages::             Available extensions
* Adding hyperlink types::      New custom link types
* Adding export back-ends::     How to write new export back-ends
* Context-sensitive commands::  How to add functionality to such commands
* Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
* Speeding up your agendas::    Tips on how to speed up your agendas
* Extracting agenda information::  Post-processing of agenda information
* Using the property API::      Writing programs that use entry properties
* Using the mapping API::       Mapping over all or selected entries

Tables and lists in arbitrary syntax

* Radio tables::                Sending and receiving radio tables
* A LaTeX example::          Step by step, almost a tutorial
* Translator functions::        Copy and modify
* Radio lists::                 Sending and receiving lists



File: org.info,  Node: Introduction,  Next: Document structure,  Up: Top

1 Introduction
**************

* Menu:

* Summary::                     Brief summary of what Org does
* Installation::                Installing Org
* Activation::                  How to activate Org for certain buffers
* Feedback::                    Bug reports, ideas, patches etc.
* Conventions::                 Typesetting conventions in the manual


File: org.info,  Node: Summary,  Next: Installation,  Up: Introduction

1.1 Summary
===========

Org is a mode for keeping notes, maintaining TODO lists, and project
planning with a fast and effective plain-text system.  It also is an
authoring system with unique support for literate programming and
reproducible research.

   Org is implemented on top of Outline mode, which makes it possible to
keep the content of large files well structured.  Visibility cycling and
structure editing help to work with the tree.  Tables are easily created
with a built-in table editor.  Plain text URL-like links connect to
websites, emails, Usenet messages, BBDB entries, and any files related
to the projects.

   Org develops organizational tasks around notes files that contain
lists or information about projects as plain text.  Project planning and
task management makes use of metadata which is part of an outline node.
Based on this data, specific entries can be extracted in queries and
create dynamic agenda views that also integrate the Emacs calendar and
diary.  Org can be used to implement many different project planning
schemes, such as David Allen’s GTD system.

   Org files can serve as a single source authoring system with export
to many different formats such as HTML, LaTeX, Open Document, and
Markdown.  New export backends can be derived from existing ones, or
defined from scratch.

   Org files can include source code blocks, which makes Org uniquely
suited for authoring technical documents with code examples.  Org source
code blocks are fully functional; they can be evaluated in place and
their results can be captured in the file.  This makes it possible to
create a single file reproducible research compendium.

   Org keeps simple things simple.  When first fired up, it should feel
like a straightforward, easy to use outliner.  Complexity is not
imposed, but a large amount of functionality is available when needed.
Org is a toolbox.  Many users actually run only a (very personal)
fraction of Org’s capabilities, and know that there is more whenever
they need it.

   All of this is achieved with strictly plain text files, the most
portable and future-proof file format.  Org runs in Emacs.  Emacs is one
of the most widely ported programs, so that Org mode is available on
every major platform.

   There is a website for Org which provides links to the newest version
of Org, as well as additional information, frequently asked questions
(FAQ), links to tutorials, etc.  This page is located at
<https://orgmode.org>.

   An earlier version (7.3) of this manual is available as a paperback
book from Network Theory Ltd.
(http://www.network-theory.co.uk/org/manual/)


File: org.info,  Node: Installation,  Next: Activation,  Prev: Summary,  Up: Introduction

1.2 Installation
================

Org is part of recent distributions of GNU Emacs, so you normally don’t
need to install it.  If, for one reason or another, you want to install
Org on top of this pre-packaged version, there are three ways to do it:

   • By using Emacs package system.
   • By downloading Org as an archive.
   • By using Org’s git repository.

   We strongly recommend to stick to a single installation method.

Using Emacs packaging system
............................

Recent Emacs distributions include a packaging system which lets you
install Elisp libraries.  You can install Org with ‘M-x package-install
<RET> org’.

Important: you need to do this in a session where no ‘.org’ file has
been visited, i.e., where no Org built-in function have been loaded.
Otherwise autoload Org functions will mess up the installation.

   Then, to make sure your Org configuration is taken into account,
initialize the package system with ‘(package-initialize)’ in your Emacs
init file before setting any Org option.  If you want to use Org’s
package repository, check out the Org ELPA page
(https://orgmode.org/elpa.html).

Downloading Org as an archive
.............................

You can download Org latest release from Org’s website
(https://orgmode.org/).  In this case, make sure you set the load-path
correctly in your Emacs init file:

     (add-to-list 'load-path "~/path/to/orgdir/lisp")

   The downloaded archive contains contributed libraries that are not
included in Emacs.  If you want to use them, add the ‘contrib’ directory
to your load-path:

     (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)

   Optionally, you can compile the files and/or install them in your
system.  Run ‘make help’ to list compilation and installation options.

Using Org’s git repository
..........................

You can clone Org’s repository and install Org like this:

     $ cd ~/src/
     $ git clone https://code.orgmode.org/bzg/org-mode.git
     $ cd org-mode/
     $ make autoloads

   Note that in this case, ‘make autoloads’ is mandatory: it defines
Org’s version in ‘org-version.el’ and Org’s autoloads in
‘org-loaddefs.el’.

   Remember to add the correct load-path as described in the method
above.

   You can also compile with ‘make’, generate the documentation with
‘make doc’, create a local configuration with ‘make config’ and install
Org with ‘make install’.  Please run ‘make help’ to get the list of
compilation/installation options.

   For more detailed explanations on Org’s build system, please check
the Org Build System page on Worg
(https://orgmode.org/worg/dev/org-build-system.html).


File: org.info,  Node: Activation,  Next: Feedback,  Prev: Installation,  Up: Introduction

1.3 Activation
==============

Org mode buffers need font-lock to be turned on: this is the default in
Emacs(1).

   There are compatibility issues between Org mode and some other Elisp
packages, please take the time to check the list (*note Conflicts::).

   The four Org commands ‘org-store-link’, ‘org-capture’, ‘org-agenda’,
and ‘org-switchb’ should be accessible through global keys (i.e.,
anywhere in Emacs, not just in Org buffers).  Here are suggested
bindings for these keys, please modify the keys to your own liking.
     (global-set-key "\C-cl" 'org-store-link)
     (global-set-key "\C-ca" 'org-agenda)
     (global-set-key "\C-cc" 'org-capture)
     (global-set-key "\C-cb" 'org-switchb)

   Files with the ‘.org’ extension use Org mode by default.  To turn on
Org mode in a file that does not have the extension ‘.org’, make the
first line of a file look like this:

     MY PROJECTS    -*- mode: org; -*-

which will select Org mode for this buffer no matter what the file’s
name is.  See also the variable ‘org-insert-mode-line-in-empty-file’.

   Many commands in Org work on the region if the region is active.  To
make use of this, you need to have ‘transient-mark-mode’ turned on,
which is the default.  If you do not like ‘transient-mark-mode’, you can
create an active region by using the mouse to select a region, or
pressing ‘C-<SPC>’ twice before moving the cursor.

   ---------- Footnotes ----------

   (1) If you don’t use font-lock globally, turn it on in Org buffer
with ‘(add-hook 'org-mode-hook 'turn-on-font-lock)’


File: org.info,  Node: Feedback,  Next: Conventions,  Prev: Activation,  Up: Introduction

1.4 Feedback
============

If you find problems with Org, or if you have questions, remarks, or
ideas about it, please mail to the Org mailing list
<emacs-orgmode@gnu.org>.  You can subscribe to the list on this web page
(https://lists.gnu.org/mailman/listinfo/emacs-orgmode).  If you are not
a member of the mailing list, your mail will be passed to the list after
a moderator has approved it(1).

   For bug reports, please first try to reproduce the bug with the
latest version of Org available—if you are running an outdated version,
it is quite possible that the bug has been fixed already.  If the bug
persists, prepare a report and provide as much information as possible,
including the version information of Emacs (‘M-x emacs-version <RET>’)
and Org (‘M-x org-version <RET>’), as well as the Org related setup in
the Emacs init file.  The easiest way to do this is to use the command
     M-x org-submit-bug-report <RET>
which will put all this information into an Emacs mail buffer so that
you only need to add your description.  If you are not sending the Email
from within Emacs, please copy and paste the content into your Email
program.

   Sometimes you might face a problem due to an error in your Emacs or
Org mode setup.  Before reporting a bug, it is very helpful to start
Emacs with minimal customizations and reproduce the problem.  Doing so
often helps you determine if the problem is with your customization or
with Org mode itself.  You can start a typical minimal session with a
command like the example below.

     $ emacs -Q -l /path/to/minimal-org.el

   However if you are using Org mode as distributed with Emacs, a
minimal setup is not necessary.  In that case it is sufficient to start
Emacs as ‘emacs -Q’.  The ‘minimal-org.el’ setup file can have contents
as shown below.

     ;;; Minimal setup to load latest 'org-mode'

     ;; activate debugging
     (setq debug-on-error t
           debug-on-signal nil
           debug-on-quit nil)

     ;; add latest org-mode to load path
     (add-to-list 'load-path "/path/to/org-mode/lisp")
     (add-to-list 'load-path "/path/to/org-mode/contrib/lisp" t)

   If an error occurs, a backtrace can be very useful (see below on how
to create one).  Often a small example file helps, along with clear
information about:

  1. What exactly did you do?
  2. What did you expect to happen?
  3. What happened instead?
Thank you for helping to improve this program.

How to create a useful backtrace
................................

If working with Org produces an error with a message you don’t
understand, you may have hit a bug.  The best way to report this is by
providing, in addition to what was mentioned above, a _backtrace_.  This
is information from the built-in debugger about where and how the error
occurred.  Here is how to produce a useful backtrace:

  1. Reload uncompiled versions of all Org mode Lisp files.  The
     backtrace contains much more information if it is produced with
     uncompiled code.  To do this, use
          C-u M-x org-reload <RET>
     or select ‘Org -> Refresh/Reload -> Reload Org uncompiled’ from the
     menu.
  2. Go to the ‘Options’ menu and select ‘Enter Debugger on Error’.
  3. Do whatever you have to do to hit the error.  Don’t forget to
     document the steps you take.
  4. When you hit the error, a ‘*Backtrace*’ buffer will appear on the
     screen.  Save this buffer to a file (for example using ‘C-x C-w’)
     and attach it to your bug report.

   ---------- Footnotes ----------

   (1) Please consider subscribing to the mailing list, in order to
minimize the work the mailing list moderators have to do.


File: org.info,  Node: Conventions,  Prev: Feedback,  Up: Introduction

1.5 Typesetting conventions used in this manual
===============================================

TODO keywords, tags, properties, etc.
.....................................

Org mainly uses three types of keywords: TODO keywords, tags and
property names.  In this manual we use the following conventions:

‘TODO’
‘WAITING’
     TODO keywords are written with all capitals, even if they are
     user-defined.
‘boss’
‘ARCHIVE’
     User-defined tags are written in lowercase; built-in tags with
     special meaning are written with all capitals.
‘Release’
‘PRIORITY’
     User-defined properties are capitalized; built-in properties with
     special meaning are written with all capitals.

   Moreover, Org uses option keywords (like ‘#+TITLE’ to set the title)
and environment keywords (like ‘#+BEGIN_EXPORT html’ to start a ‘HTML’
environment).  They are written in uppercase in the manual to enhance
its readability, but you can use lowercase in your Org file.

Key bindings and commands
.........................

The manual suggests a few global key bindings, in particular ‘C-c a’ for
‘org-agenda’ and ‘C-c c’ for ‘org-capture’.  These are only suggestions,
but the rest of the manual assumes that these key bindings are in place
in order to list commands by key access.

   Also, the manual lists both the keys and the corresponding commands
for accessing a functionality.  Org mode often uses the same key for
different functions, depending on context.  The command that is bound to
such keys has a generic name, like ‘org-metaright’.  In the manual we
will, wherever possible, give the function that is internally called by
the generic command.  For example, in the chapter on document structure,
‘M-<RIGHT>’ will be listed to call ‘org-do-demote’, while in the chapter
on tables, it will be listed to call ‘org-table-move-column-right’.  If
you prefer, you can compile the manual without the command names by
unsetting the flag ‘cmdnames’ in ‘org.texi’.


File: org.info,  Node: Document structure,  Next: Tables,  Prev: Introduction,  Up: Top

2 Document structure
********************

Org is based on Outline mode and provides flexible commands to edit the
structure of the document.

* Menu:

* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
* Blocks::                      Folding blocks
* Footnotes::                   How footnotes are defined in Org’s syntax
* Orgstruct mode::              Structure editing outside Org
* Org syntax::                  Formal description of Org’s syntax


File: org.info,  Node: Outlines,  Next: Headlines,  Up: Document structure

2.1 Outlines
============

Org is implemented on top of Outline mode.  Outlines allow a document to
be organized in a hierarchical structure, which (at least for me) is the
best representation of notes and thoughts.  An overview of this
structure is achieved by folding (hiding) large parts of the document to
show only the general document structure and the parts currently being
worked on.  Org greatly simplifies the use of outlines by compressing
the entire show/hide functionality into a single command, ‘org-cycle’,
which is bound to the <TAB> key.


File: org.info,  Node: Headlines,  Next: Visibility cycling,  Prev: Outlines,  Up: Document structure

2.2 Headlines
=============

Headlines define the structure of an outline tree.  The headlines in Org
start with one or more stars, on the left margin(1) (2).  For example:

     * Top level headline
     ** Second level
     *** 3rd level
         some text
     *** 3rd level
         more text

     * Another top level headline

Note that a headline named after ‘org-footnote-section’, which defaults
to ‘Footnotes’, is considered as special.  A subtree with this headline
will be silently ignored by exporting functions.

   Some people find the many stars too noisy and would prefer an outline
that has whitespace followed by a single star as headline starters.
*note Clean view::, describes a setup to realize this.

   An empty line after the end of a subtree is considered part of it and
will be hidden when the subtree is folded.  However, if you leave at
least two empty lines, one empty line will remain visible after folding
the subtree, in order to structure the collapsed view.  See the variable
‘org-cycle-separator-lines’ to modify this behavior.

   ---------- Footnotes ----------

   (1) See the variables ‘org-special-ctrl-a/e’, ‘org-special-ctrl-k’,
and ‘org-ctrl-k-protect-subtree’ to configure special behavior of ‘C-a’,
‘C-e’, and ‘C-k’ in headlines.

   (2) Clocking only works with headings indented less than 30 stars.


File: org.info,  Node: Visibility cycling,  Next: Motion,  Prev: Headlines,  Up: Document structure

2.3 Visibility cycling
======================

* Menu:

* Global and local cycling::    Cycling through various visibility states
* Initial visibility::          Setting the initial visibility state
* Catching invisible edits::    Preventing mistakes when editing invisible parts


File: org.info,  Node: Global and local cycling,  Next: Initial visibility,  Up: Visibility cycling

2.3.1 Global and local cycling
------------------------------

Outlines make it possible to hide parts of the text in the buffer.  Org
uses just two commands, bound to <TAB> and ‘S-<TAB>’ to change the
visibility in the buffer.

‘<TAB>’     (‘org-cycle’)
     _Subtree cycling_: Rotate current subtree among the states

          ,-> FOLDED -> CHILDREN -> SUBTREE --.
          '-----------------------------------'

     The cursor must be on a headline for this to work(1).

‘S-<TAB>’     (‘org-global-cycle’)
C-u <TAB>
     _Global cycling_: Rotate the entire buffer among the states

          ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
          '--------------------------------------'

     When ‘S-<TAB>’ is called with a numeric prefix argument N, the
     CONTENTS view up to headlines of level N will be shown.  Note that
     inside tables, ‘S-<TAB>’ jumps to the previous field.

     You can run global cycling using <TAB> only if point is at the very
     beginning of the buffer, but not on a headline, and
     ‘org-cycle-global-at-bob’ is set to a non-‘nil’ value.

‘C-u C-u <TAB>’     (‘org-set-startup-visibility’)
     Switch back to the startup visibility of the buffer (*note Initial
     visibility::).
‘C-u C-u C-u <TAB>’     (‘outline-show-all’)
     Show all, including drawers.
‘C-c C-r’     (‘org-reveal’)
     Reveal context around point, showing the current entry, the
     following heading and the hierarchy above.  Useful for working near
     a location that has been exposed by a sparse tree command (*note
     Sparse trees::) or an agenda command (*note Agenda commands::).
     With a prefix argument show, on each level, all sibling headings.
     With a double prefix argument, also show the entire subtree of the
     parent.
‘C-c C-k’     (‘outline-show-branches’)
     Expose all the headings of the subtree, CONTENTS view for just one
     subtree.
‘C-c <TAB>’     (‘outline-show-children’)
     Expose all direct children of the subtree.  With a numeric prefix
     argument N, expose all children down to level N.
‘C-c C-x b’     (‘org-tree-to-indirect-buffer’)
     Show the current subtree in an indirect buffer(2).  With a numeric
     prefix argument N, go up to level N and then take that tree.  If N
     is negative then go up that many levels.  With a ‘C-u’ prefix, do
     not remove the previously used indirect buffer.
‘C-c C-x v’     (‘org-copy-visible’)
     Copy the visible text in the region into the kill ring.

   ---------- Footnotes ----------

   (1) see, however, the option ‘org-cycle-emulate-tab’.

   (2) The indirect buffer (*note (emacs)Indirect Buffers::) will
contain the entire buffer, but will be narrowed to the current tree.
Editing the indirect buffer will also change the original buffer, but
without affecting visibility in that buffer.


File: org.info,  Node: Initial visibility,  Next: Catching invisible edits,  Prev: Global and local cycling,  Up: Visibility cycling

2.3.2 Initial visibility
------------------------

When Emacs first visits an Org file, the global state is set to
OVERVIEW, i.e., only the top level headlines are visible(1).  This can
be configured through the variable ‘org-startup-folded’, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:

     #+STARTUP: overview
     #+STARTUP: content
     #+STARTUP: showall
     #+STARTUP: showeverything

Furthermore, any entries with a ‘VISIBILITY’ property (*note Properties
and columns::) will get their visibility adapted accordingly.  Allowed
values for this property are ‘folded’, ‘children’, ‘content’, and ‘all’.

‘C-u C-u <TAB>’     (‘org-set-startup-visibility’)
     Switch back to the startup visibility of the buffer, i.e., whatever
     is requested by startup options and ‘VISIBILITY’ properties in
     individual entries.

   ---------- Footnotes ----------

   (1) When ‘org-agenda-inhibit-startup’ is non-‘nil’, Org will not
honor the default visibility state when first opening a file for the
agenda (*note Speeding up your agendas::).


File: org.info,  Node: Catching invisible edits,  Prev: Initial visibility,  Up: Visibility cycling

2.3.3 Catching invisible edits
------------------------------

Sometimes you may inadvertently edit an invisible part of the buffer and
be confused on what has been edited and how to undo the mistake.
Setting ‘org-catch-invisible-edits’ to non-‘nil’ will help prevent this.
See the docstring of this option on how Org should catch invisible edits
and process them.


File: org.info,  Node: Motion,  Next: Structure editing,  Prev: Visibility cycling,  Up: Document structure

2.4 Motion
==========

The following commands jump to other headlines in the buffer.

‘C-c C-n’     (‘org-next-visible-heading’)
     Next heading.
‘C-c C-p’     (‘org-previous-visible-heading’)
     Previous heading.
‘C-c C-f’     (‘org-forward-same-level’)
     Next heading same level.
‘C-c C-b’     (‘org-backward-same-level’)
     Previous heading same level.
‘C-c C-u’     (‘outline-up-heading’)
     Backward to higher level heading.
‘C-c C-j’     (‘org-goto’)
     Jump to a different place without changing the current outline
     visibility.  Shows the document structure in a temporary buffer,
     where you can use the following keys to find your destination:
          <TAB>         Cycle visibility.
          <DOWN> / <UP>   Next/previous visible headline.
          <RET>         Select this location.
          /           Do a Sparse-tree search
          The following keys work if you turn off ‘org-goto-auto-isearch’
          n / p        Next/previous visible headline.
          f / b        Next/previous headline same level.
          u            One level up.
          0-9          Digit argument.
          q            Quit
     See also the option ‘org-goto-interface’.


File: org.info,  Node: Structure editing,  Next: Sparse trees,  Prev: Motion,  Up: Document structure

2.5 Structure editing
=====================

‘M-<RET>’     (‘org-meta-return’)
     Insert a new heading, item or row.

     If the command is used at the _beginning_ of a line, and if there
     is a heading or a plain list item (*note Plain lists::) at point,
     the new heading/item is created _before_ the current line.  When
     used at the beginning of a regular line of text, turn that line
     into a heading.

     When this command is used in the middle of a line, the line is
     split and the rest of the line becomes the new item or headline.
     If you do not want the line to be split, customize
     ‘org-M-RET-may-split-line’.

     Calling the command with a ‘C-u’ prefix unconditionally inserts a
     new heading at the end of the current subtree, thus preserving its
     contents.  With a double ‘C-u C-u’ prefix, the new heading is
     created at the end of the parent subtree instead.
‘C-<RET>’     (‘org-insert-heading-respect-content’)
     Insert a new heading at the end of the current subtree.
‘M-S-<RET>’     (‘org-insert-todo-heading’)
     Insert new TODO entry with same level as current heading.  See also
     the variable ‘org-treat-insert-todo-heading-as-state-change’.
‘C-S-<RET>’     (‘org-insert-todo-heading-respect-content’)
     Insert new TODO entry with same level as current heading.  Like
     ‘C-<RET>’, the new headline will be inserted after the current
     subtree.
‘<TAB>’     (‘org-cycle’)
     In a new entry with no text yet, the first <TAB> demotes the entry
     to become a child of the previous one.  The next <TAB> makes it a
     parent, and so on, all the way to top level.  Yet another <TAB>,
     and you are back to the initial level.
‘M-<LEFT>’     (‘org-do-promote’)
     Promote current heading by one level.
‘M-<RIGHT>’     (‘org-do-demote’)
     Demote current heading by one level.
‘M-S-<LEFT>’     (‘org-promote-subtree’)
     Promote the current subtree by one level.
‘M-S-<RIGHT>’     (‘org-demote-subtree’)
     Demote the current subtree by one level.
‘M-<UP>’     (‘org-move-subtree-up’)
     Move subtree up (swap with previous subtree of same level).
‘M-<DOWN>’     (‘org-move-subtree-down’)
     Move subtree down (swap with next subtree of same level).
‘M-h’     (‘org-mark-element’)
     Mark the element at point.  Hitting repeatedly will mark subsequent
     elements of the one just marked.  E.g., hitting ‘M-h’ on a
     paragraph will mark it, hitting ‘M-h’ immediately again will mark
     the next one.
‘C-c @’     (‘org-mark-subtree’)
     Mark the subtree at point.  Hitting repeatedly will mark subsequent
     subtrees of the same level than the marked subtree.
‘C-c C-x C-w’     (‘org-cut-subtree’)
     Kill subtree, i.e., remove it from buffer but save in kill ring.
     With a numeric prefix argument N, kill N sequential subtrees.
‘C-c C-x M-w’     (‘org-copy-subtree’)
     Copy subtree to kill ring.  With a numeric prefix argument N, copy
     the N sequential subtrees.
‘C-c C-x C-y’     (‘org-paste-subtree’)
     Yank subtree from kill ring.  This does modify the level of the
     subtree to make sure the tree fits in nicely at the yank position.
     The yank level can also be specified with a numeric prefix
     argument, or by yanking after a headline marker like ‘****’.
‘C-y’     (‘org-yank’)
     Depending on the options ‘org-yank-adjusted-subtrees’ and
     ‘org-yank-folded-subtrees’, Org’s internal ‘yank’ command will
     paste subtrees folded and in a clever way, using the same command
     as ‘C-c C-x C-y’.  With the default settings, no level adjustment
     will take place, but the yanked tree will be folded unless doing so
     would swallow text previously visible.  Any prefix argument to this
     command will force a normal ‘yank’ to be executed, with the prefix
     passed along.  A good way to force a normal yank is ‘C-u C-y’.  If
     you use ‘yank-pop’ after a yank, it will yank previous kill items
     plainly, without adjustment and folding.
‘C-c C-x c’     (‘org-clone-subtree-with-time-shift’)
     Clone a subtree by making a number of sibling copies of it.  You
     will be prompted for the number of copies to make, and you can also
     specify if any timestamps in the entry should be shifted.  This can
     be useful, for example, to create a number of tasks related to a
     series of lectures to prepare.  For more details, see the docstring
     of the command ‘org-clone-subtree-with-time-shift’.
‘C-c C-w’     (‘org-refile’)
     Refile entry or region to a different location.  *Note Refile and
     copy::.
‘C-c ^’     (‘org-sort’)
     Sort same-level entries.  When there is an active region, all
     entries in the region will be sorted.  Otherwise the children of
     the current headline are sorted.  The command prompts for the
     sorting method, which can be alphabetically, numerically, by time
     (first timestamp with active preferred, creation time, scheduled
     time, deadline time), by priority, by TODO keyword (in the sequence
     the keywords have been defined in the setup) or by the value of a
     property.  Reverse sorting is possible as well.  You can also
     supply your own function to extract the sorting key.  With a ‘C-u’
     prefix, sorting will be case-sensitive.
‘C-x n s’     (‘org-narrow-to-subtree’)
     Narrow buffer to current subtree.
‘C-x n b’     (‘org-narrow-to-block’)
     Narrow buffer to current block.
‘C-x n w’     (‘widen’)
     Widen buffer to remove narrowing.
‘C-c *’     (‘org-toggle-heading’)
     Turn a normal line or plain list item into a headline (so that it
     becomes a subheading at its location).  Also turn a headline into a
     normal line by removing the stars.  If there is an active region,
     turn all lines in the region into headlines.  If the first line in
     the region was an item, turn only the item lines into headlines.
     Finally, if the first line is a headline, remove the stars from all
     headlines in the region.

   When there is an active region (Transient Mark mode), promotion and
demotion work on all headlines in the region.  To select a region of
headlines, it is best to place both point and mark at the beginning of a
line, mark at the beginning of the first headline, and point at the line
just after the last headline to change.  Note that when the cursor is
inside a table (*note Tables::), the Meta-Cursor keys have different
functionality.


File: org.info,  Node: Sparse trees,  Next: Plain lists,  Prev: Structure editing,  Up: Document structure

2.6 Sparse trees
================

An important feature of Org mode is the ability to construct _sparse
trees_ for selected information in an outline tree, so that the entire
document is folded as much as possible, but the selected information is
made visible along with the headline structure above it(1).  Just try it
out and you will see immediately how it works.

   Org mode contains several commands for creating such trees, all these
commands can be accessed through a dispatcher:

‘C-c /’     (‘org-sparse-tree’)
     This prompts for an extra key to select a sparse-tree creating
     command.
‘C-c / r’  or  ‘C-c / /’     (‘org-occur’)
     Prompts for a regexp and shows a sparse tree with all matches.  If
     the match is in a headline, the headline is made visible.  If the
     match is in the body of an entry, headline and body are made
     visible.  In order to provide minimal context, also the full
     hierarchy of headlines above the match is shown, as well as the
     headline following the match.  Each match is also highlighted; the
     highlights disappear when the buffer is changed by an editing
     command(2), or by pressing ‘C-c C-c’.  When called with a ‘C-u’
     prefix argument, previous highlights are kept, so several calls to
     this command can be stacked.
‘M-g n’  or  ‘M-g M-n’     (‘next-error’)
     Jump to the next sparse tree match in this buffer.
‘M-g p’  or  ‘M-g M-p’     (‘previous-error’)
     Jump to the previous sparse tree match in this buffer.

For frequently used sparse trees of specific search strings, you can use
the option ‘org-agenda-custom-commands’ to define fast keyboard access
to specific sparse trees.  These commands will then be accessible
through the agenda dispatcher (*note Agenda dispatcher::).  For example:

     (setq org-agenda-custom-commands
           '(("f" occur-tree "FIXME")))

will define the key ‘C-c a f’ as a shortcut for creating a sparse tree
matching the string ‘FIXME’.

   The other sparse tree commands select headings based on TODO
keywords, tags, or properties and will be discussed later in this
manual.

   To print a sparse tree, you can use the Emacs command
‘ps-print-buffer-with-faces’ which does not print invisible parts of the
document.  Or you can use ‘C-c C-e C-v’ to export only the visible part
of the document and print the resulting file.

   ---------- Footnotes ----------

   (1) See also the variable ‘org-show-context-detail’ to decide how
much context is shown around each match.

   (2) This depends on the option ‘org-remove-highlights-with-change’


File: org.info,  Node: Plain lists,  Next: Drawers,  Prev: Sparse trees,  Up: Document structure

2.7 Plain lists
===============

Within an entry of the outline tree, hand-formatted lists can provide
additional structure.  They also provide a way to create lists of
checkboxes (*note Checkboxes::).  Org supports editing such lists, and
every exporter (*note Exporting::) can parse and format them.

   Org knows ordered lists, unordered lists, and description lists.
   • _Unordered_ list items start with ‘-’, ‘+’, or ‘*’(1) as bullets.
   • _Ordered_ list items start with a numeral followed by either a
     period or a right parenthesis(2), such as ‘1.’ or ‘1)’(3).  If you
     want a list to start with a different value (e.g., 20), start the
     text of the item with ‘[@20]’(4).  Those constructs can be used in
     any item of the list in order to enforce a particular numbering.
   • _Description_ list items are unordered list items, and contain the
     separator ‘ :: ’ to distinguish the description _term_ from the
     description.

   Items belonging to the same list must have the same indentation on
the first line.  In particular, if an ordered list reaches number ‘10.’,
then the 2–digit numbers must be written left-aligned with the other
numbers in the list.  An item ends before the next line that is less or
equally indented than its bullet/number.

   A list ends whenever every item has ended, which means before any
line less or equally indented than items at top level.  It also ends
before two blank lines.  In that case, all items are closed.  Here is an
example:

     ** Lord of the Rings
        My favorite scenes are (in this order)
        1. The attack of the Rohirrim
        2. Eowyn's fight with the witch king
           + this was already my favorite scene in the book
           + I really like Miranda Otto.
        3. Peter Jackson being shot by Legolas
           - on DVD only
           He makes a really funny face when it happens.
        But in the end, no individual scenes matter but the film as a whole.
        Important actors in this film are:
        - Elijah Wood :: He plays Frodo
        - Sean Astin :: He plays Sam, Frodo's friend.  I still remember
          him very well from his role as Mikey Walsh in The Goonies.

   Org supports these lists by tuning filling and wrapping commands to
deal with them correctly, and by exporting them properly (*note
Exporting::).  Since indentation is what governs the structure of these
lists, many structural constructs like ‘#+BEGIN_...’ blocks can be
indented to signal that they belong to a particular item.

   If you find that using a different bullet for a sub-list (than that
used for the current list-level) improves readability, customize the
variable ‘org-list-demote-modify-bullet’.  To get a greater difference
of indentation between items and their sub-items, customize
‘org-list-indent-offset’.

   The following commands act on items when the cursor is in the first
line of an item (the line with the bullet or number).  Some of them
imply the application of automatic rules to keep list structure intact.
If some of these actions get in your way, configure
‘org-list-automatic-rules’ to disable them individually.

‘<TAB>’     (‘org-cycle’)
     Items can be folded just like headline levels.  Normally this works
     only if the cursor is on a plain list item.  For more details, see
     the variable ‘org-cycle-include-plain-lists’.  If this variable is
     set to ‘integrate’, plain list items will be treated like low-level
     headlines.  The level of an item is then given by the indentation
     of the bullet/number.  Items are always subordinate to real
     headlines, however; the hierarchies remain completely separated.
     In a new item with no text yet, the first <TAB> demotes the item to
     become a child of the previous one.  Subsequent <TAB>s move the
     item to meaningful levels in the list and eventually get it back to
     its initial position.
‘M-<RET>’     (‘org-insert-heading’)
     Insert new item at current level.  With a prefix argument, force a
     new heading (*note Structure editing::).  If this command is used
     in the middle of an item, that item is _split_ in two, and the
     second part becomes the new item(5).  If this command is executed
     _before item’s body_, the new item is created _before_ the current
     one.

‘M-S-<RET>’
     Insert a new item with a checkbox (*note Checkboxes::).
‘S-up’
‘S-down’
     Jump to the previous/next item in the current list(6), but only if
     ‘org-support-shift-select’ is off.  If not, you can still use
     paragraph jumping commands like ‘C-<UP>’ and ‘C-<DOWN>’ to quite
     similar effect.
‘M-up’
‘M-down’
     Move the item including subitems up/down(7) (swap with
     previous/next item of same indentation).  If the list is ordered,
     renumbering is automatic.
‘M-left’
‘M-right’
     Decrease/increase the indentation of an item, leaving children
     alone.
‘M-S-<LEFT>’
‘M-S-<RIGHT>’
     Decrease/increase the indentation of the item, including subitems.
     Initially, the item tree is selected based on current indentation.
     When these commands are executed several times in direct
     succession, the initially selected region is used, even if the new
     indentation would imply a different hierarchy.  To use the new
     hierarchy, break the command chain with a cursor motion or so.

     As a special case, using this command on the very first item of a
     list will move the whole list.  This behavior can be disabled by
     configuring ‘org-list-automatic-rules’.  The global indentation of
     a list has no influence on the text _after_ the list.
‘C-c C-c’
     If there is a checkbox (*note Checkboxes::) in the item line,
     toggle the state of the checkbox.  In any case, verify bullets and
     indentation consistency in the whole list.
‘C-c -’
     Cycle the entire list level through the different itemize/enumerate
     bullets (‘-’, ‘+’, ‘*’, ‘1.’, ‘1)’) or a subset of them, depending
     on ‘org-plain-list-ordered-item-terminator’, the type of list, and
     its indentation.  With a numeric prefix argument N, select the Nth
     bullet from this list.  If there is an active region when calling
     this, all selected lines are converted to list items.  With a
     prefix argument, selected text is changed into a single item.  If
     the first line already was a list item, any item marker will be
     removed from the list.  Finally, even without an active region, a
     normal line will be converted into a list item.
‘C-c *’
     Turn a plain list item into a headline (so that it becomes a
     subheading at its location).  *Note Structure editing::, for a
     detailed explanation.
‘C-c C-*’
     Turn the whole plain list into a subtree of the current heading.
     Checkboxes (*note Checkboxes::) will become TODO (resp.  DONE)
     keywords when unchecked (resp.  checked).
‘S-<LEFT>/<RIGHT>’
     This command also cycles bullet styles when the cursor in on the
     bullet or anywhere in an item line, details depending on
     ‘org-support-shift-select’.
‘C-c ^’
     Sort the plain list.  You will be prompted for the sorting method:
     numerically, alphabetically, by time, by checked status for check
     lists, or by a custom function.

   ---------- Footnotes ----------

   (1) When using ‘*’ as a bullet, lines must be indented or they will
be seen as top-level headlines.  Also, when you are hiding leading stars
to get a clean outline view, plain list items starting with a star may
be hard to distinguish from true headlines.  In short: even though ‘*’
is supported, it may be better to not use it for plain list items.

   (2) You can filter out any of them by configuring
‘org-plain-list-ordered-item-terminator’.

   (3) You can also get ‘a.’, ‘A.’, ‘a)’ and ‘A)’ by configuring
‘org-list-allow-alphabetical’.  To minimize confusion with normal text,
those are limited to one character only.  Beyond that limit, bullets
will automatically fallback to numbers.

   (4) If there’s a checkbox in the item, the cookie must be put
_before_ the checkbox.  If you have activated alphabetical lists, you
can also use counters like ‘[@b]’.

   (5) If you do not want the item to be split, customize the variable
‘org-M-RET-may-split-line’.

   (6) If you want to cycle around items that way, you may customize
‘org-list-use-circular-motion’.

   (7) See ‘org-list-use-circular-motion’ for a cyclic behavior.


File: org.info,  Node: Drawers,  Next: Blocks,  Prev: Plain lists,  Up: Document structure

2.8 Drawers
===========

Sometimes you want to keep information associated with an entry, but you
normally don’t want to see it.  For this, Org mode has _drawers_.  They
can contain anything but a headline and another drawer.  Drawers look
like this:

     ** This is a headline
        Still outside the drawer
        :DRAWERNAME:
        This is inside the drawer.
        :END:
        After the drawer.

   You can interactively insert drawers at point by calling
‘org-insert-drawer’, which is bound to ‘C-c C-x d’.  With an active
region, this command will put the region inside the drawer.  With a
prefix argument, this command calls ‘org-insert-property-drawer’ and add
a property drawer right below the current headline.  Completion over
drawer keywords is also possible using ‘M-<TAB>’(1).

   Visibility cycling (*note Visibility cycling::) on the headline will
hide and show the entry, but keep the drawer collapsed to a single line.
In order to look inside the drawer, you need to move the cursor to the
drawer line and press <TAB> there.  Org mode uses the ‘PROPERTIES’
drawer for storing properties (*note Properties and columns::), and you
can also arrange for state change notes (*note Tracking TODO state
changes::) and clock times (*note Clocking work time::) to be stored in
a drawer ‘LOGBOOK’.  If you want to store a quick note in the LOGBOOK
drawer, in a similar way to state changes, use

‘C-c C-z’
     Add a time-stamped note to the LOGBOOK drawer.

   You can select the name of the drawers which should be exported with
‘org-export-with-drawers’.  In that case, drawer contents will appear in
export output.  Property drawers are not affected by this variable:
configure ‘org-export-with-properties’ instead.

   ---------- Footnotes ----------

   (1) Many desktops intercept ‘M-<TAB>’ to switch windows.  Use ‘C-M-i’
or ‘<ESC> <TAB>’ instead for completion (*note Completion::).


File: org.info,  Node: Blocks,  Next: Footnotes,  Prev: Drawers,  Up: Document structure

2.9 Blocks
==========

Org mode uses begin...end blocks for various purposes from including
source code examples (*note Literal examples::) to capturing time
logging information (*note Clocking work time::).  These blocks can be
folded and unfolded by pressing <TAB> in the begin line.  You can also
get all blocks folded at startup by configuring the option
‘org-hide-block-startup’ or on a per-file basis by using

     #+STARTUP: hideblocks
     #+STARTUP: nohideblocks


File: org.info,  Node: Footnotes,  Next: Orgstruct mode,  Prev: Blocks,  Up: Document structure

2.10 Footnotes
==============

Org mode supports the creation of footnotes.

   A footnote is started by a footnote marker in square brackets in
column 0, no indentation allowed.  It ends at the next footnote
definition, headline, or after two consecutive empty lines.  The
footnote reference is simply the marker in square brackets, inside text.
Markers always start with ‘fn:’.  For example:

     The Org homepage[fn:1] now looks a lot better than it used to.
     ...
     [fn:1] The link is: https://orgmode.org

   Org mode extends the number-based syntax to _named_ footnotes and
optional inline definition.  Here are the valid references:

‘[fn:name]’
     A named footnote reference, where ‘name’ is a unique label word,
     or, for simplicity of automatic creation, a number.
‘[fn::This is the inline definition of this footnote]’
     A LaTeX-like anonymous footnote where the definition is given
     directly at the reference point.
‘[fn:name:a definition]’
     An inline definition of a footnote, which also specifies a name for
     the note.  Since Org allows multiple references to the same note,
     you can then use ‘[fn:name]’ to create additional references.

   Footnote labels can be created automatically, or you can create names
yourself.  This is handled by the variable ‘org-footnote-auto-label’ and
its corresponding ‘#+STARTUP’ keywords.  See the docstring of that
variable for details.

The following command handles footnotes:

‘C-c C-x f’
     The footnote action command.

     When the cursor is on a footnote reference, jump to the definition.
     When it is at a definition, jump to the (first) reference.

     Otherwise, create a new footnote.  Depending on the option
     ‘org-footnote-define-inline’(1), the definition will be placed
     right into the text as part of the reference, or separately into
     the location determined by the option ‘org-footnote-section’.

     When this command is called with a prefix argument, a menu of
     additional options is offered:
          s   Sort the footnote definitions by reference sequence.  During editing,
              Org makes no effort to sort footnote definitions into a particular
              sequence.  If you want them sorted, use this command, which will
              also move entries according to ‘org-footnote-section’.  Automatic
              sorting after each insertion/deletion can be configured using the
              option ‘org-footnote-auto-adjust’.
          r   Renumber the simple ‘fn:N’ footnotes.  Automatic renumbering
              after each insertion/deletion can be configured using the option
              ‘org-footnote-auto-adjust’.
          S   Short for first ‘r’, then ‘s’ action.
          n   Normalize the footnotes by collecting all definitions (including
              inline definitions) into a special section, and then numbering them
              in sequence.  The references will then also be numbers.
          d   Delete the footnote at point, and all definitions of and references
              to it.
     Depending on the variable ‘org-footnote-auto-adjust’(2),
     renumbering and sorting footnotes can be automatic after each
     insertion or deletion.

‘C-c C-c’
     If the cursor is on a footnote reference, jump to the definition.
     If it is a the definition, jump back to the reference.  When called
     at a footnote location with a prefix argument, offer the same menu
     as ‘C-c C-x f’.
‘C-c C-o or mouse-1/2’
     Footnote labels are also links to the corresponding
     definition/reference, and you can use the usual commands to follow
     these links.

‘C-c '’
‘C-c '’
     Edit the footnote definition corresponding to the reference at
     point in a separate window.  The window can be closed by pressing
     ‘C-c '’.

   ---------- Footnotes ----------

   (1) The corresponding in-buffer setting is: ‘#+STARTUP: fninline’ or
‘#+STARTUP: nofninline’

   (2) the corresponding in-buffer options are ‘fnadjust’ and
‘nofnadjust’.


File: org.info,  Node: Orgstruct mode,  Next: Org syntax,  Prev: Footnotes,  Up: Document structure

2.11 The Orgstruct minor mode
=============================

If you like the intuitive way the Org mode structure editing and list
formatting works, you might want to use these commands in other modes
like Text mode or Mail mode as well.  The minor mode ‘orgstruct-mode’
makes this possible.  Toggle the mode with ‘M-x orgstruct-mode <RET>’,
or turn it on by default, for example in Message mode, with one of:

     (add-hook 'message-mode-hook 'turn-on-orgstruct)
     (add-hook 'message-mode-hook 'turn-on-orgstruct++)

   When this mode is active and the cursor is on a line that looks to
Org like a headline or the first line of a list item, most structure
editing commands will work, even if the same keys normally have
different functionality in the major mode you are using.  If the cursor
is not in one of those special lines, Orgstruct mode lurks silently in
the shadows.

   When you use ‘orgstruct++-mode’, Org will also export indentation and
autofill settings into that mode, and detect item context after the
first line of an item.

   You can also use Org structure editing to fold and unfold headlines
in _any_ file, provided you defined ‘orgstruct-heading-prefix-regexp’:
the regular expression must match the local prefix to use before Org’s
headlines.  For example, if you set this variable to ‘";; "’ in Emacs
Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
commented lines.  Some commands like ‘org-demote’ are disabled when the
prefix is set, but folding/unfolding will work correctly.


File: org.info,  Node: Org syntax,  Prev: Orgstruct mode,  Up: Document structure

2.12 Org syntax
===============

A reference document providing a formal description of Org’s syntax is
available as a draft on Worg
(https://orgmode.org/worg/dev/org-syntax.html), written and maintained
by Nicolas Goaziou.  It defines Org’s core internal concepts such as
‘headlines’, ‘sections’, ‘affiliated keywords’, ‘(greater) elements’ and
‘objects’.  Each part of an Org file falls into one of the categories
above.

   To explore the abstract structure of an Org buffer, run this in a
buffer:

     M-: (org-element-parse-buffer) <RET>

   It will output a list containing the buffer’s content represented as
an abstract structure.  The export engine relies on the information
stored in this list.  Most interactive commands (e.g., for structure
editing) also rely on the syntactic meaning of the surrounding context.

   You can check syntax in your documents using ‘org-lint’ command.


File: org.info,  Node: Tables,  Next: Hyperlinks,  Prev: Document structure,  Up: Top

3 Tables
********

Org comes with a fast and intuitive table editor.  Spreadsheet-like
calculations are supported using the Emacs ‘calc’ package (*note Calc:
(calc)Top.).

* Menu:

* Built-in table editor::       Simple tables
* Column width and alignment::  Overrule the automatic settings
* Column groups::               Grouping to trigger vertical lines
* Orgtbl mode::                 The table editor as minor mode
* The spreadsheet::             The table editor has spreadsheet capabilities
* Org-Plot::                    Plotting from org tables


File: org.info,  Node: Built-in table editor,  Next: Column width and alignment,  Up: Tables

3.1 The built-in table editor
=============================

Org makes it easy to format tables in plain ASCII.  Any line with ‘|’ as
the first non-whitespace character is considered part of a table.  ‘|’
is also the column separator(1).  A table might look like this:

     | Name  | Phone | Age |
     |-------+-------+-----|
     | Peter |  1234 |  17 |
     | Anna  |  4321 |  25 |

   A table is re-aligned automatically each time you press <TAB> or
<RET> or ‘C-c C-c’ inside the table.  <TAB> also moves to the next field
(<RET> to the next row) and creates new table rows at the end of the
table or before horizontal lines.  The indentation of the table is set
by the first line.  Any line starting with ‘|-’ is considered as a
horizontal separator line and will be expanded on the next re-align to
span the whole table width.  So, to create the above table, you would
only type

     |Name|Phone|Age|
     |-

and then press <TAB> to align the table and start filling in fields.
Even faster would be to type ‘|Name|Phone|Age’ followed by ‘C-c <RET>’.

   When typing text into a field, Org treats <DEL>, <Backspace>, and all
character keys in a special way, so that inserting and deleting avoids
shifting other fields.  Also, when typing _immediately after the cursor
was moved into a new field with ‘<TAB>’, ‘S-<TAB>’ or ‘<RET>’_, the
field is automatically made blank.  If this behavior is too
unpredictable for you, configure the option
‘org-table-auto-blank-field’.

     Creation and conversion
     .......................

‘C-c |     (org-table-create-or-convert-from-region)’
     Convert the active region to a table.  If every line contains at
     least one TAB character, the function assumes that the material is
     tab separated.  If every line contains a comma, comma-separated
     values (CSV) are assumed.  If not, lines are split at whitespace
     into fields.  You can use a prefix argument to force a specific
     separator: ‘C-u’ forces CSV, ‘C-u C-u’ forces TAB, ‘C-u C-u C-u’
     will prompt for a regular expression to match the separator, and a
     numeric argument N indicates that at least N consecutive spaces, or
     alternatively a TAB will be the separator.
     If there is no active region, this command creates an empty Org
     table.  But it is easier just to start typing, like
     ‘|Name|Phone|Age <RET> |- <TAB>’.

     Re-aligning and field motion
     ............................

‘C-c C-c     (org-table-align)’
     Re-align the table and don’t move to another field.
‘C-c <SPC>     (org-table-blank-field)’
     Blank the field at point.
‘<TAB>     (org-table-next-field)’
     Re-align the table, move to the next field.  Creates a new row if
     necessary.
‘S-<TAB>     (org-table-previous-field)’
     Re-align, move to previous field.
‘<RET>     (org-table-next-row)’
     Re-align the table and move down to next row.  Creates a new row if
     necessary.  At the beginning or end of a line, <RET> still does
     NEWLINE, so it can be used to split a table.
‘M-a     (org-table-beginning-of-field)’
     Move to beginning of the current table field, or on to the previous
     field.
‘M-e     (org-table-end-of-field)’
     Move to end of the current table field, or on to the next field.

     Column and row editing
     ......................

‘M-<LEFT>     (org-table-move-column-left)’
‘M-<RIGHT>     (org-table-move-column-right)’
     Move the current column left/right.
‘M-S-<LEFT>     (org-table-delete-column)’
     Kill the current column.
‘M-S-<RIGHT>     (org-table-insert-column)’
     Insert a new column to the left of the cursor position.
‘M-<UP>     (org-table-move-row-up)’
‘M-<DOWN>     (org-table-move-row-down)’
     Move the current row up/down.
‘M-S-<UP>     (org-table-kill-row)’
     Kill the current row or horizontal line.
‘M-S-<DOWN>     (org-table-insert-row)’
     Insert a new row above the current row.  With a prefix argument,
     the line is created below the current one.
‘C-c -     (org-table-insert-hline)’
     Insert a horizontal line below current row.  With a prefix
     argument, the line is created above the current line.
‘C-c <RET>     (org-table-hline-and-move)’
     Insert a horizontal line below current row, and move the cursor
     into the row below that line.
‘C-c ^     (org-table-sort-lines)’
     Sort the table lines in the region.  The position of point
     indicates the column to be used for sorting, and the range of lines
     is the range between the nearest horizontal separator lines, or the
     entire table.  If point is before the first column, you will be
     prompted for the sorting column.  If there is an active region, the
     mark specifies the first line and the sorting column, while point
     should be in the last line to be included into the sorting.  The
     command prompts for the sorting type (alphabetically, numerically,
     or by time).  You can sort in normal or reverse order.  You can
     also supply your own key extraction and comparison functions.  When
     called with a prefix argument, alphabetic sorting will be
     case-sensitive.

     Regions
     .......

‘C-c C-x M-w     (org-table-copy-region)’
     Copy a rectangular region from a table to a special clipboard.
     Point and mark determine edge fields of the rectangle.  If there is
     no active region, copy just the current field.  The process ignores
     horizontal separator lines.
‘C-c C-x C-w     (org-table-cut-region)’
     Copy a rectangular region from a table to a special clipboard, and
     blank all fields in the rectangle.  So this is the “cut” operation.
‘C-c C-x C-y     (org-table-paste-rectangle)’
     Paste a rectangular region into a table.  The upper left corner
     ends up in the current field.  All involved fields will be
     overwritten.  If the rectangle does not fit into the present table,
     the table is enlarged as needed.  The process ignores horizontal
     separator lines.
‘M-<RET>     (org-table-wrap-region)’
     Split the current field at the cursor position and move the rest to
     the line below.  If there is an active region, and both point and
     mark are in the same column, the text in the column is wrapped to
     minimum width for the given number of lines.  A numeric prefix
     argument may be used to change the number of desired lines.  If
     there is no region, but you specify a prefix argument, the current
     field is made blank, and the content is appended to the field
     above.

     Calculations
     ............

‘C-c +     (org-table-sum)’
     Sum the numbers in the current column, or in the rectangle defined
     by the active region.  The result is shown in the echo area and can
     be inserted with ‘C-y’.
‘S-<RET>     (org-table-copy-down)’
     When current field is empty, copy from first non-empty field above.
     When not empty, copy current field down to next row and move cursor
     along with it.  Depending on the option ‘org-table-copy-increment’,
     integer field values will be incremented during copy.  Integers
     that are too large will not be incremented.  Also, a ‘0’ prefix
     argument temporarily disables the increment.  This key is also used
     by shift-selection and related modes (*note Conflicts::).

     Miscellaneous
     .............

‘C-c `     (org-table-edit-field)’
     Edit the current field in a separate window.  This is useful for
     fields that are not fully visible (*note Column width and
     alignment::).  When called with a ‘C-u’ prefix, just make the full
     field visible, so that it can be edited in place.  When called with
     two ‘C-u’ prefixes, make the editor window follow the cursor
     through the table and always show the current field.  The follow
     mode exits automatically when the cursor leaves the table, or when
     you repeat this command with ‘C-u C-u C-c `’.
‘M-x org-table-import <RET>’
     Import a file as a table.  The table should be TAB or whitespace
     separated.  Use, for example, to import a spreadsheet table or data
     from a database, because these programs generally can write
     TAB-separated text files.  This command works by inserting the file
     into the buffer and then converting the region to a table.  Any
     prefix argument is passed on to the converter, which uses it to
     determine the separator.
‘C-c |     (org-table-create-or-convert-from-region)’
     Tables can also be imported by pasting tabular text into the Org
     buffer, selecting the pasted text with ‘C-x C-x’ and then using the
     ‘C-c |’ command (see above under Creation and conversion).
‘M-x org-table-export <RET>’
     Export the table, by default as a TAB-separated file.  Use for data
     exchange with, for example, spreadsheet or database programs.  The
     format used to export the file can be configured in the option
     ‘org-table-export-default-format’.  You may also use properties
     ‘TABLE_EXPORT_FILE’ and ‘TABLE_EXPORT_FORMAT’ to specify the file
     name and the format for table export in a subtree.  Org supports
     quite general formats for exported tables.  The exporter format is
     the same as the format used by Orgtbl radio tables, see *note
     Translator functions::, for a detailed description.

   ---------- Footnotes ----------

   (1) To insert a vertical bar into a table field, use ‘\vert’ or,
inside a word ‘abc\vert{}def’.


File: org.info,  Node: Column width and alignment,  Next: Column groups,  Prev: Built-in table editor,  Up: Tables

3.2 Column width and alignment
==============================

The width of columns is automatically determined by the table editor.
And also the alignment of a column is determined automatically from the
fraction of number-like versus non-number fields in the column.

   Sometimes a single field or a few fields need to carry more text,
leading to inconveniently wide columns.  Or maybe you want to make a
table with several columns having a fixed width, regardless of content.
To set the width of a column, one field anywhere in the column may
contain just the string ‘<N>’ where ‘N’ is an integer specifying the
width of the column in characters.  The next re-align will then set the
width of this column to this value.

     |---+------------------------------|               |---+--------|
     |   |                              |               |   | <6>    |
     | 1 | one                          |               | 1 | one    |
     | 2 | two                          |     ----\     | 2 | two    |
     | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
     | 4 | four                         |               | 4 | four   |
     |---+------------------------------|               |---+--------|

Fields that are wider become clipped and end in the string ‘=>’.  Note
that the full text is still in the buffer but is hidden.  To see the
full text, hold the mouse over the field—a tool-tip window will show the
full content.  To edit such a field, use the command ‘C-c `’ (that is
‘C-c’ followed by the grave accent).  This will open a new window with
the full field.  Edit it and finish with ‘C-c C-c’.

   When visiting a file containing a table with narrowed columns, the
necessary character hiding has not yet happened, and the table needs to
be aligned before it looks nice.  Setting the option
‘org-startup-align-all-tables’ will realign all tables in a file upon
visiting, but also slow down startup.  You can also set this option on a
per-file basis with:

     #+STARTUP: align
     #+STARTUP: noalign

   If you would like to overrule the automatic alignment of number-rich
columns to the right and of string-rich columns to the left, you can use
‘<r>’, ‘<c>’(1) or ‘<l>’ in a similar fashion.  You may also combine
alignment and field width like this: ‘<r10>’.

   Lines which only contain these formatting cookies will be removed
automatically when exporting the document.

   ---------- Footnotes ----------

   (1) Centering does not work inside Emacs, but it does have an effect
when exporting to HTML.


File: org.info,  Node: Column groups,  Next: Orgtbl mode,  Prev: Column width and alignment,  Up: Tables

3.3 Column groups
=================

When Org exports tables, it does so by default without vertical lines
because that is visually more satisfying in general.  Occasionally
however, vertical lines can be useful to structure a table into groups
of columns, much like horizontal lines can do for groups of rows.  In
order to specify column groups, you can use a special row where the
first field contains only ‘/’.  The further fields can either contain
‘<’ to indicate that this column should start a group, ‘>’ to indicate
the end of a group, or ‘<>’ (no space between ‘<’ and ‘>’) to make a
column a group of its own.  Boundaries between column groups will upon
export be marked with vertical lines.  Here is an example:

     | N | N^2 | N^3 | N^4 | ~sqrt(n)~ | ~sqrt[4](N)~ |
     |---+-----+-----+-----+-----------+--------------|
     | / |   < |     |   > |         < |            > |
     | 1 |   1 |   1 |   1 |         1 |            1 |
     | 2 |   4 |   8 |  16 |    1.4142 |       1.1892 |
     | 3 |   9 |  27 |  81 |    1.7321 |       1.3161 |
     |---+-----+-----+-----+-----------+--------------|
     #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))

   It is also sufficient to just insert the column group starters after
every vertical line you would like to have:

     |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
     |----+-----+-----+-----+---------+------------|
     | /  | <   |     |     | <       |            |


File: org.info,  Node: Orgtbl mode,  Next: The spreadsheet,  Prev: Column groups,  Up: Tables

3.4 The Orgtbl minor mode
=========================

If you like the intuitive way the Org table editor works, you might also
want to use it in other modes like Text mode or Mail mode.  The minor
mode Orgtbl mode makes this possible.  You can always toggle the mode
with ‘M-x orgtbl-mode <RET>’.  To turn it on by default, for example in
Message mode, use

     (add-hook 'message-mode-hook 'turn-on-orgtbl)

   Furthermore, with some special setup, it is possible to maintain
tables in arbitrary syntax with Orgtbl mode.  For example, it is
possible to construct LaTeX tables with the underlying ease and power of
Orgtbl mode, including spreadsheet capabilities.  For details, see *note
Tables in arbitrary syntax::.


File: org.info,  Node: The spreadsheet,  Next: Org-Plot,  Prev: Orgtbl mode,  Up: Tables

3.5 The spreadsheet
===================

The table editor makes use of the Emacs ‘calc’ package to implement
spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
derive fields from other fields.  While fully featured, Org’s
implementation is not identical to other spreadsheets.  For example, Org
knows the concept of a _column formula_ that will be applied to all
non-header fields in a column without having to copy the formula to each
relevant field.  There is also a formula debugger, and a formula editor
with features for highlighting fields in the table corresponding to the
references at the point in the formula, moving these references by arrow
keys

* Menu:

* References::                  How to refer to another field or range
* Formula syntax for Calc::     Using Calc to compute stuff
* Formula syntax for Lisp::     Writing formulas in Emacs Lisp
* Durations and time values::   How to compute durations and time values
* Field and range formulas::    Formula for specific (ranges of) fields
* Column formulas::             Formulas valid for an entire column
* Lookup functions::            Lookup functions for searching tables
* Editing and debugging formulas::  Fixing formulas
* Updating the table::          Recomputing all dependent fields
* Advanced features::           Field and column names, parameters and automatic recalc


File: org.info,  Node: References,  Next: Formula syntax for Calc,  Up: The spreadsheet

3.5.1 References
----------------

To compute fields in the table from other fields, formulas must
reference other fields or ranges.  In Org, fields can be referenced by
name, by absolute coordinates, and by relative coordinates.  To find out
what the coordinates of a field are, press ‘C-c ?’ in that field, or
press ‘C-c }’ to toggle the display of a grid.

Field references
................

Formulas can reference the value of another field in two ways.  Like in
any other spreadsheet, you may reference fields with a letter/number
combination like ‘B3’, meaning the 2nd field in the 3rd row.  However,
Org prefers(1) to use another, more general representation that looks
like this:
     @ROW$COLUMN

   Column specifications can be absolute like ‘$1’, ‘$2’,...‘$N’, or
relative to the current column (i.e., the column of the field which is
being computed) like ‘$+1’ or ‘$-2’.  ‘$<’ and ‘$>’ are immutable
references to the first and last column, respectively, and you can use
‘$>>>’ to indicate the third column from the right.

   The row specification only counts data lines and ignores horizontal
separator lines (hlines).  Like with columns, you can use absolute row
numbers ‘@1’, ‘@2’,...‘@N’, and row numbers relative to the current row
like ‘@+3’ or ‘@-1’.  ‘@<’ and ‘@>’ are immutable references the first
and last(2) row in the table, respectively.  You may also specify the
row relative to one of the hlines: ‘@I’ refers to the first hline, ‘@II’
to the second, etc.  ‘@-I’ refers to the first such line above the
current line, ‘@+I’ to the first such line below the current line.  You
can also write ‘@III+2’ which is the second data line after the third
hline in the table.

   ‘@0’ and ‘$0’ refer to the current row and column, respectively,
i.e., to the row/column for the field being computed.  Also, if you omit
either the column or the row part of the reference, the current
row/column is implied.

   Org’s references with _unsigned_ numbers are fixed references in the
sense that if you use the same reference in the formula for two
different fields, the same field will be referenced each time.  Org’s
references with _signed_ numbers are floating references because the
same reference operator can reference different fields depending on the
field being calculated by the formula.

   Here are a few examples:

     @2$3      2nd row, 3rd column (same as ‘C2’)
     $5        column 5 in the current row (same as ‘E&’)
     @2        current column, row 2
     @-1$-3    the field one row up, three columns to the left
     @-I$2     field just under hline above current row, column 2
     @>$5      field in the last row, in column 5

Range references
................

You may reference a rectangular range of fields by specifying two field
references connected by two dots ‘..’.  If both fields are in the
current row, you may simply use ‘$2..$7’, but if at least one field is
in a different row, you need to use the general ‘@row$column’ format at
least for the first field (i.e the reference must start with ‘@’ in
order to be interpreted correctly).  Examples:

     $1..$3        first three fields in the current row
     $P..$Q        range, using column names (see under Advanced)
     $<<<..$>>     start in third column, continue to the last but one
     @2$1..@4$3    6 fields between these two fields (same as ‘A2..C4’)
     @-1$-2..@-1   3 fields in the row above, starting from 2 columns on the left
     @I..II        between first and second hline, short for ‘@I..@II’

Range references return a vector of values that can be fed into Calc
vector functions.  Empty fields in ranges are normally suppressed, so
that the vector contains only the non-empty fields.  For other options
with the mode switches ‘E’, ‘N’ and examples *note Formula syntax for
Calc::.

Field coordinates in formulas
.............................

One of the very first actions during evaluation of Calc formulas and
Lisp formulas is to substitute ‘@#’ and ‘$#’ in the formula with the row
or column number of the field where the current result will go to.  The
traditional Lisp formula equivalents are ‘org-table-current-dline’ and
‘org-table-current-column’.  Examples:

‘if(@# % 2, $#, string(""))’
     Insert column number on odd rows, set field to empty on even rows.
‘$2 = '(identity remote(FOO, @@#$1))’
     Copy text or values of each row of column 1 of the table named
     ‘FOO’ into column 2 of the current table.
‘@3 = 2 * remote(FOO, @1$$#)’
     Insert the doubled value of each column of row 1 of the table named
     ‘FOO’ into row 3 of the current table.

For the second/third example, the table named ‘FOO’ must have at least
as many rows/columns as the current table.  Note that this is
inefficient(3) for large number of rows/columns.

Named references
................

‘$name’ is interpreted as the name of a column, parameter or constant.
Constants are defined globally through the option
‘org-table-formula-constants’, and locally (for the file) through a line
like

     #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6

Also properties (*note Properties and columns::) can be used as
constants in table formulas: for a property ‘:Xyz:’ use the name
‘$PROP_Xyz’, and the property will be searched in the current outline
entry and in the hierarchy above it.  If you have the ‘constants.el’
package, it will also be used to resolve constants, including natural
constants like ‘$h’ for Planck’s constant, and units like ‘$km’ for
kilometers(4).  Column names and parameters can be specified in special
table lines.  These are described below, see *note Advanced features::.
All names must start with a letter, and further consist of letters and
numbers.

Remote references
.................

You may also reference constants, fields and ranges from a different
table, either in the current file or even in a different file.  The
syntax is

     remote(NAME-OR-ID,REF)

where NAME can be the name of a table in the current file as set by a
‘#+NAME: Name’ line before the table.  It can also be the ID of an
entry, even in a different file, and the reference then refers to the
first table in that entry.  REF is an absolute field or range reference
as described above for example ‘@3$3’ or ‘$somename’, valid in the
referenced table.

   Indirection of NAME-OR-ID: When NAME-OR-ID has the format
‘@ROW$COLUMN’ it will be substituted with the name or ID found in this
field of the current table.  For example ‘remote($1, @>$2)’ =>
‘remote(year_2013, @>$1)’.  The format ‘B3’ is not supported because it
can not be distinguished from a plain table name or ID.

   ---------- Footnotes ----------

   (1) Org will understand references typed by the user as ‘B4’, but it
will not use this syntax when offering a formula for editing.  You can
customize this behavior using the option
‘org-table-use-standard-references’.

   (2) For backward compatibility you can also use special names like
‘$LR5’ and ‘$LR12’ to refer in a stable way to the 5th and 12th field in
the last row of the table.  However, this syntax is deprecated, it
should not be used for new documents.  Use ‘@>$’ instead.

   (3) The computation time scales as O(N^2) because the table named
‘FOO’ is parsed for each field to be read.

   (4) ‘constants.el’ can supply the values of constants in two
different unit systems, ‘SI’ and ‘cgs’.  Which one is used depends on
the value of the variable ‘constants-unit-system’.  You can use the
‘#+STARTUP’ options ‘constSI’ and ‘constcgs’ to set this value for the
current buffer.


File: org.info,  Node: Formula syntax for Calc,  Next: Formula syntax for Lisp,  Prev: References,  Up: The spreadsheet

3.5.2 Formula syntax for Calc
-----------------------------

A formula can be any algebraic expression understood by the Emacs ‘Calc’
package.  Note that ‘calc’ has the non-standard convention that ‘/’ has
lower precedence than ‘*’, so that ‘a/b*c’ is interpreted as ‘a/(b*c)’.
Before evaluation by ‘calc-eval’ (*note calc-eval: (calc)Calling Calc
from Your Programs.), variable substitution takes place according to the
rules described above.  The range vectors can be directly fed into the
Calc vector functions like ‘vmean’ and ‘vsum’.

   A formula can contain an optional mode string after a semicolon.
This string consists of flags to influence Calc and other modes during
execution.  By default, Org uses the standard Calc modes (precision 12,
angular units degrees, fraction and symbolic modes off).  The display
format, however, has been changed to ‘(float 8)’ to keep tables compact.
The default settings can be configured using the option
‘org-calc-default-modes’.

List of modes:

‘p20’
     Set the internal Calc calculation precision to 20 digits.
‘n3’, ‘s3’, ‘e2’, ‘f4’
     Normal, scientific, engineering or fixed format of the result of
     Calc passed back to Org.  Calc formatting is unlimited in precision
     as long as the Calc calculation precision is greater.
‘D’, ‘R’
     Degree and radian angle modes of Calc.
‘F’, ‘S’
     Fraction and symbolic modes of Calc.
‘T’, ‘t’, ‘U’
     Duration computations in Calc or Lisp, *note Durations and time
     values::.
‘E’
     If and how to consider empty fields.  Without ‘E’ empty fields in
     range references are suppressed so that the Calc vector or Lisp
     list contains only the non-empty fields.  With ‘E’ the empty fields
     are kept.  For empty fields in ranges or empty field references the
     value ‘nan’ (not a number) is used in Calc formulas and the empty
     string is used for Lisp formulas.  Add ‘N’ to use 0 instead for
     both formula types.  For the value of a field the mode ‘N’ has
     higher precedence than ‘E’.
‘N’
     Interpret all fields as numbers, use 0 for non-numbers.  See the
     next section to see how this is essential for computations with
     Lisp formulas.  In Calc formulas it is used only occasionally
     because there number strings are already interpreted as numbers
     without ‘N’.
‘L’
     Literal, for Lisp formulas only.  See the next section.

Unless you use large integer numbers or high-precision-calculation and
-display for floating point numbers you may alternatively provide a
‘printf’ format specifier to reformat the Calc result after it has been
passed back to Org instead of letting Calc already do the formatting(1).
A few examples:

     $1+$2                Sum of first and second field
     $1+$2;%.2f           Same, format result to two decimals
     exp($2)+exp($1)      Math functions can be used
     $0;%.1f              Reformat current cell to 1 decimal
     ($3-32)*5/9          Degrees F -> C conversion
     $c/$1/$cm            Hz -> cm conversion, using ‘constants.el’
     tan($1);Dp3s1        Compute in degrees, precision 3, display SCI 1
     sin($1);Dp3%.1e      Same, but use printf specifier for display
     taylor($3,x=7,2)     Taylor series of $3, at x=7, second degree

   Calc also contains a complete set of logical operations, (*note
Logical Operations: (calc)Logical Operations.).  For example

‘if($1 < 20, teen, string(""))’
     "teen" if age $1 is less than 20, else the Org table result field
     is set to empty with the empty string.
‘if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1’
     Sum of the first two columns.  When at least one of the input
     fields is empty the Org table result field is set to empty.  ‘E’ is
     required to not convert empty fields to 0.  ‘f-1’ is an optional
     Calc format string similar to ‘%.1f’ but leaves empty results
     empty.
‘if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E’
     Mean value of a range unless there is any empty field.  Every field
     in the range that is empty is replaced by ‘nan’ which lets ‘vmean’
     result in ‘nan’.  Then ‘typeof == 12’ detects the ‘nan’ from
     ‘vmean’ and the Org table result field is set to empty.  Use this
     when the sample set is expected to never have missing values.
‘if("$1..$7" == "[]", string(""), vmean($1..$7))’
     Mean value of a range with empty fields skipped.  Every field in
     the range that is empty is skipped.  When all fields in the range
     are empty the mean value is not defined and the Org table result
     field is set to empty.  Use this when the sample set can have a
     variable size.
‘vmean($1..$7); EN’
     To complete the example before: Mean value of a range with empty
     fields counting as samples with value 0.  Use this only when
     incomplete sample sets should be padded with 0 to the full size.

   You can add your own Calc functions defined in Emacs Lisp with
‘defmath’ and use them in formula syntax for Calc.

   ---------- Footnotes ----------

   (1) The ‘printf’ reformatting is limited in precision because the
value passed to it is converted into an ‘integer’ or ‘double’.  The
‘integer’ is limited in size by truncating the signed value to 32 bits.
The ‘double’ is limited in precision to 64 bits overall which leaves
approximately 16 significant decimal digits.


File: org.info,  Node: Formula syntax for Lisp,  Next: Durations and time values,  Prev: Formula syntax for Calc,  Up: The spreadsheet

3.5.3 Emacs Lisp forms as formulas
----------------------------------

It is also possible to write a formula in Emacs Lisp.  This can be
useful for string manipulation and control structures, if Calc’s
functionality is not enough.

   If a formula starts with an apostrophe followed by an opening
parenthesis, then it is evaluated as a Lisp form.  The evaluation should
return either a string or a number.  Just as with ‘calc’ formulas, you
can specify modes and a printf format after a semicolon.

   With Emacs Lisp forms, you need to be conscious about the way field
references are interpolated into the form.  By default, a reference will
be interpolated as a Lisp string (in double-quotes) containing the
field.  If you provide the ‘N’ mode switch, all referenced elements will
be numbers (non-number fields will be zero) and interpolated as Lisp
numbers, without quotes.  If you provide the ‘L’ flag, all fields will
be interpolated literally, without quotes.  I.e., if you want a
reference to be interpreted as a string by the Lisp form, enclose the
reference operator itself in double-quotes, like ‘"$3"’.  Ranges are
inserted as space-separated fields, so you can embed them in list or
vector syntax.

   Here are a few examples—note how the ‘N’ mode is used when we do
computations in Lisp:

‘'(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))’
     Swap the first two characters of the content of column 1.
‘'(+ $1 $2);N’
     Add columns 1 and 2, equivalent to Calc’s ‘$1+$2’.
‘'(apply '+ '($1..$4));N’
     Compute the sum of columns 1 to 4, like Calc’s ‘vsum($1..$4)’.


File: org.info,  Node: Durations and time values,  Next: Field and range formulas,  Prev: Formula syntax for Lisp,  Up: The spreadsheet

3.5.4 Durations and time values
-------------------------------

If you want to compute time values use the ‘T’, ‘t’, or ‘U’ flag, either
in Calc formulas or Elisp formulas:

       |  Task 1 |   Task 2 |    Total |
       |---------+----------+----------|
       |    2:12 |     1:47 | 03:59:00 |
       |    2:12 |     1:47 |    03:59 |
       | 3:02:20 | -2:07:00 |     0.92 |
       #+TBLFM: @2$3=$1+$2;T::@3$3=$1+$2;U::@4$3=$1+$2;t

   Input duration values must be of the form ‘HH:MM[:SS]’, where seconds
are optional.  With the ‘T’ flag, computed durations will be displayed
as ‘HH:MM:SS’ (see the first formula above).  With the ‘U’ flag, seconds
will be omitted so that the result will be only ‘HH:MM’ (see second
formula above).  Zero-padding of the hours field will depend upon the
value of the variable ‘org-table-duration-hour-zero-padding’.

   With the ‘t’ flag, computed durations will be displayed according to
the value of the option ‘org-table-duration-custom-format’, which
defaults to ‘'hours’ and will display the result as a fraction of hours
(see the third formula in the example above).

   Negative duration values can be manipulated as well, and integers
will be considered as seconds in addition and subtraction.


File: org.info,  Node: Field and range formulas,  Next: Column formulas,  Prev: Durations and time values,  Up: The spreadsheet

3.5.5 Field and range formulas
------------------------------

To assign a formula to a particular field, type it directly into the
field, preceded by ‘:=’, for example ‘:=vsum(@II..III)’.  When you press
<TAB> or <RET> or ‘C-c C-c’ with the cursor still in the field, the
formula will be stored as the formula for this field, evaluated, and the
current field will be replaced with the result.

   Formulas are stored in a special line starting with ‘#+TBLFM:’
directly below the table.  If you type the equation in the 4th field of
the 3rd data line in the table, the formula will look like ‘@3$4=$1+$2’.
When inserting/deleting/swapping columns and rows with the appropriate
commands, absolute references (but not relative ones) in stored formulas
are modified in order to still reference the same field.  To avoid this,
in particular in range references, anchor ranges at the table borders
(using ‘@<’, ‘@>’, ‘$<’, ‘$>’), or at hlines using the ‘@I’ notation.
Automatic adaptation of field references does of course not happen if
you edit the table structure with normal editing commands—then you must
fix the equations yourself.

   Instead of typing an equation into the field, you may also use the
following command

‘C-u C-c =     (org-table-eval-formula)’
     Install a new formula for the current field.  The command prompts
     for a formula with default taken from the ‘#+TBLFM:’ line, applies
     it to the current field, and stores it.

   The left-hand side of a formula can also be a special expression in
order to assign the formula to a number of different fields.  There is
no keyboard shortcut to enter such range formulas.  To add them, use the
formula editor (*note Editing and debugging formulas::) or edit the
‘#+TBLFM:’ line directly.

‘$2=’
     Column formula, valid for the entire column.  This is so common
     that Org treats these formulas in a special way, see *note Column
     formulas::.
‘@3=’
     Row formula, applies to all fields in the specified row.  ‘@>=’
     means the last row.
‘@1$2..@4$3=’
     Range formula, applies to all fields in the given rectangular
     range.  This can also be used to assign a formula to some but not
     all fields in a row.
‘$name=’
     Named field, see *note Advanced features::.


File: org.info,  Node: Column formulas,  Next: Lookup functions,  Prev: Field and range formulas,  Up: The spreadsheet

3.5.6 Column formulas
---------------------

When you assign a formula to a simple column reference like ‘$3=’, the
same formula will be used in all fields of that column, with the
following very convenient exceptions: (i) If the table contains
horizontal separator hlines with rows above and below, everything before
the first such hline is considered part of the table _header_ and will
not be modified by column formulas.  Therefore a header is mandatory
when you use column formulas and want to add hlines to group rows, like
for example to separate a total row at the bottom from the summand rows
above.  (ii) Fields that already get a value from a field/range formula
will be left alone by column formulas.  These conditions make column
formulas very easy to use.

   To assign a formula to a column, type it directly into any field in
the column, preceded by an equal sign, like ‘=$1+$2’.  When you press
<TAB> or <RET> or ‘C-c C-c’ with the cursor still in the field, the
formula will be stored as the formula for the current column, evaluated
and the current field replaced with the result.  If the field contains
only ‘=’, the previously stored formula for this column is used.  For
each column, Org will only remember the most recently used formula.  In
the ‘#+TBLFM:’ line, column formulas will look like ‘$4=$1+$2’.  The
left-hand side of a column formula cannot be the name of column, it must
be the numeric column reference or ‘$>’.

   Instead of typing an equation into the field, you may also use the
following command:

‘C-c =     (org-table-eval-formula)’
     Install a new formula for the current column and replace current
     field with the result of the formula.  The command prompts for a
     formula, with default taken from the ‘#+TBLFM’ line, applies it to
     the current field and stores it.  With a numeric prefix
     argument(e.g., ‘C-5 C-c =’) the command will apply it to that many
     consecutive fields in the current column.


File: org.info,  Node: Lookup functions,  Next: Editing and debugging formulas,  Prev: Column formulas,  Up: The spreadsheet

3.5.7 Lookup functions
----------------------

Org has three predefined Emacs Lisp functions for lookups in tables.
‘(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)’
     Searches for the first element ‘S’ in list ‘S-LIST’ for which
          (PREDICATE VAL S)
     is ‘t’; returns the value from the corresponding position in list
     ‘R-LIST’.  The default ‘PREDICATE’ is ‘equal’.  Note that the
     parameters ‘VAL’ and ‘S’ are passed to ‘PREDICATE’ in the same
     order as the corresponding parameters are in the call to
     ‘org-lookup-first’, where ‘VAL’ precedes ‘S-LIST’.  If ‘R-LIST’ is
     ‘nil’, the matching element ‘S’ of ‘S-LIST’ is returned.
‘(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)’
     Similar to ‘org-lookup-first’ above, but searches for the last
     element for which ‘PREDICATE’ is ‘t’.
‘(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)’
     Similar to ‘org-lookup-first’, but searches for all elements for
     which ‘PREDICATE’ is ‘t’, and returns all corresponding values.
     This function can not be used by itself in a formula, because it
     returns a list of values.  However, powerful lookups can be built
     when this function is combined with other Emacs Lisp functions.

   If the ranges used in these functions contain empty fields, the ‘E’
mode for the formula should usually be specified: otherwise empty fields
will not be included in ‘S-LIST’ and/or ‘R-LIST’ which can, for example,
result in an incorrect mapping from an element of ‘S-LIST’ to the
corresponding element of ‘R-LIST’.

   These three functions can be used to implement associative arrays,
count matching cells, rank results, group data etc.  For practical
examples see this tutorial on Worg
(https://orgmode.org/worg/org-tutorials/org-lookups.html).


File: org.info,  Node: Editing and debugging formulas,  Next: Updating the table,  Prev: Lookup functions,  Up: The spreadsheet

3.5.8 Editing and debugging formulas
------------------------------------

You can edit individual formulas in the minibuffer or directly in the
field.  Org can also prepare a special buffer with all active formulas
of a table.  When offering a formula for editing, Org converts
references to the standard format (like ‘B3’ or ‘D&’) if possible.  If
you prefer to only work with the internal format (like ‘@3$2’ or ‘$4’),
configure the option ‘org-table-use-standard-references’.

‘C-c =  or  C-u C-c =     (org-table-eval-formula)’
     Edit the formula associated with the current column/field in the
     minibuffer.  See *note Column formulas::, and *note Field and range
     formulas::.
‘C-u C-u C-c =     (org-table-eval-formula)’
     Re-insert the active formula (either a field formula, or a column
     formula) into the current field, so that you can edit it directly
     in the field.  The advantage over editing in the minibuffer is that
     you can use the command ‘C-c ?’.
‘C-c ?     (org-table-field-info)’
     While editing a formula in a table field, highlight the field(s)
     referenced by the reference at the cursor position in the formula.
‘C-c }’
     Toggle the display of row and column numbers for a table, using
     overlays (‘org-table-toggle-coordinate-overlays’).  These are
     updated each time the table is aligned; you can force it with ‘C-c
     C-c’.
‘C-c {’
     Toggle the formula debugger on and off
     (‘org-table-toggle-formula-debugger’).  See below.
‘C-c '     (org-table-edit-formulas)’
     Edit all formulas for the current table in a special buffer, where
     the formulas will be displayed one per line.  If the current field
     has an active formula, the cursor in the formula editor will mark
     it.  While inside the special buffer, Org will automatically
     highlight any field or range reference at the cursor position.  You
     may edit, remove and add formulas, and use the following commands:

     ‘C-c C-c  or  C-x C-s     (org-table-fedit-finish)’
          Exit the formula editor and store the modified formulas.  With
          ‘C-u’ prefix, also apply the new formulas to the entire table.
     ‘C-c C-q     (org-table-fedit-abort)’
          Exit the formula editor without installing changes.
     ‘C-c C-r     (org-table-fedit-toggle-ref-type)’
          Toggle all references in the formula editor between standard
          (like ‘B3’) and internal (like ‘@3$2’).
     ‘<TAB>     (org-table-fedit-lisp-indent)’
          Pretty-print or indent Lisp formula at point.  When in a line
          containing a Lisp formula, format the formula according to
          Emacs Lisp rules.  Another <TAB> collapses the formula back
          again.  In the open formula, <TAB> re-indents just like in
          Emacs Lisp mode.
     ‘M-<TAB>     (lisp-complete-symbol)’
          Complete Lisp symbols, just like in Emacs Lisp mode.(1)
     ‘S-<UP>/<DOWN>/<LEFT>/<RIGHT>’
          Shift the reference at point.  For example, if the reference
          is ‘B3’ and you press ‘S-<RIGHT>’, it will become ‘C3’.  This
          also works for relative references and for hline references.
     ‘M-S-<UP>     (org-table-fedit-line-up)’
     ‘M-S-<DOWN>     (org-table-fedit-line-down)’
          Move the test line for column formulas in the Org buffer up
          and down.
     ‘M-<UP>     (org-table-fedit-scroll-down)’
     ‘M-<DOWN>     (org-table-fedit-scroll-up)’
          Scroll the window displaying the table.
     ‘C-c }’
          Turn the coordinate grid in the table on and off.

   Making a table field blank does not remove the formula associated
with the field, because that is stored in a different line (the
‘#+TBLFM’ line)—during the next recalculation the field will be filled
again.  To remove a formula from a field, you have to give an empty
reply when prompted for the formula, or to edit the ‘#+TBLFM’ line.

   You may edit the ‘#+TBLFM’ directly and re-apply the changed
equations with ‘C-c C-c’ in that line or with the normal recalculation
commands in the table.

Using multiple ‘#+TBLFM’ lines
..............................

You may apply the formula temporarily.  This is useful when you switch
the formula.  Place multiple ‘#+TBLFM’ lines right after the table, and
then press ‘C-c C-c’ on the formula to apply.  Here is an example:

     | x | y |
     |---+---|
     | 1 |   |
     | 2 |   |
     #+TBLFM: $2=$1*1
     #+TBLFM: $2=$1*2

Pressing ‘C-c C-c’ in the line of ‘#+TBLFM: $2=$1*2’ yields:

     | x | y |
     |---+---|
     | 1 | 2 |
     | 2 | 4 |
     #+TBLFM: $2=$1*1
     #+TBLFM: $2=$1*2

Note: If you recalculate this table (with ‘C-u C-c *’, for example), you
will get the following result of applying only the first ‘#+TBLFM’ line.

     | x | y |
     |---+---|
     | 1 | 1 |
     | 2 | 2 |
     #+TBLFM: $2=$1*1
     #+TBLFM: $2=$1*2

Debugging formulas
..................

When the evaluation of a formula leads to an error, the field content
becomes the string ‘#ERROR’.  If you would like see what is going on
during variable substitution and calculation in order to find a bug,
turn on formula debugging in the ‘Tbl’ menu and repeat the calculation,
for example by pressing ‘C-u C-u C-c = <RET>’ in a field.  Detailed
information will be displayed.

   ---------- Footnotes ----------

   (1) Many desktops intercept ‘M-<TAB>’ to switch windows.  Use ‘C-M-i’
or ‘<ESC> <TAB>’ instead for completion (*note Completion::).


File: org.info,  Node: Updating the table,  Next: Advanced features,  Prev: Editing and debugging formulas,  Up: The spreadsheet

3.5.9 Updating the table
------------------------

Recalculation of a table is normally not automatic, but needs to be
triggered by a command.  See *note Advanced features::, for a way to
make recalculation at least semi-automatic.

   In order to recalculate a line of a table or the entire table, use
the following commands:

‘C-c *     (org-table-recalculate)’
     Recalculate the current row by first applying the stored column
     formulas from left to right, and all field/range formulas in the
     current row.
‘C-u C-c *’
‘C-u C-c C-c’
     Recompute the entire table, line by line.  Any lines before the
     first hline are left alone, assuming that these are part of the
     table header.
‘C-u C-u C-c *  or  C-u C-u C-c C-c     (org-table-iterate)’
     Iterate the table by recomputing it until no further changes occur.
     This may be necessary if some computed fields use the value of
     other fields that are computed later in the calculation sequence.
‘M-x org-table-recalculate-buffer-tables <RET>’
     Recompute all tables in the current buffer.
‘M-x org-table-iterate-buffer-tables <RET>’
     Iterate all tables in the current buffer, in order to converge
     table-to-table dependencies.


File: org.info,  Node: Advanced features,  Prev: Updating the table,  Up: The spreadsheet

3.5.10 Advanced features
------------------------

If you want the recalculation of fields to happen automatically, or if
you want to be able to assign names(1) to fields and columns, you need
to reserve the first column of the table for special marking characters.

‘C-#     (org-table-rotate-recalc-marks)’
     Rotate the calculation mark in first column through the states ‘ ’,
     ‘#’, ‘*’, ‘!’, ‘$’.  When there is an active region, change all
     marks in the region.

   Here is an example of a table that collects exam results of students
and makes use of these features:

     |---+---------+--------+--------+--------+-------+------|
     |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
     |---+---------+--------+--------+--------+-------+------|
     | ! |         |     P1 |     P2 |     P3 |   Tot |      |
     | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
     | ^ |         |     m1 |     m2 |     m3 |    mt |      |
     |---+---------+--------+--------+--------+-------+------|
     | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
     | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
     |---+---------+--------+--------+--------+-------+------|
     |   | Average |        |        |        |  25.0 |      |
     | ^ |         |        |        |        |    at |      |
     | $ | max=50  |        |        |        |       |      |
     |---+---------+--------+--------+--------+-------+------|
     #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f

Important: please note that for these special tables, recalculating the
table with ‘C-u C-c *’ will only affect rows that are marked ‘#’ or ‘*’,
and fields that have a formula assigned to the field itself.  The column
formulas are not applied in rows with empty first field.

   The marking characters have the following meaning:

‘!’
     The fields in this line define names for the columns, so that you
     may refer to a column as ‘$Tot’ instead of ‘$6’.
‘^’
     This row defines names for the fields _above_ the row.  With such a
     definition, any formula in the table may use ‘$m1’ to refer to the
     value ‘10’.  Also, if you assign a formula to a names field, it
     will be stored as ‘$name=...’.
‘_’
     Similar to ‘^’, but defines names for the fields in the row
     _below_.
‘$’
     Fields in this row can define _parameters_ for formulas.  For
     example, if a field in a ‘$’ row contains ‘max=50’, then formulas
     in this table can refer to the value 50 using ‘$max’.  Parameters
     work exactly like constants, only that they can be defined on a
     per-table basis.
‘#’
     Fields in this row are automatically recalculated when pressing
     <TAB> or <RET> or ‘S-<TAB>’ in this row.  Also, this row is
     selected for a global recalculation with ‘C-u C-c *’.  Unmarked
     lines will be left alone by this command.
‘*’
     Selects this line for global recalculation with ‘C-u C-c *’, but
     not for automatic recalculation.  Use this when automatic
     recalculation slows down editing too much.
‘ ’
     Unmarked lines are exempt from recalculation with ‘C-u C-c *’.  All
     lines that should be recalculated should be marked with ‘#’ or ‘*’.
‘/’
     Do not export this line.  Useful for lines that contain the
     narrowing ‘<N>’ markers or column group markers.

   Finally, just to whet your appetite for what can be done with the
fantastic ‘calc.el’ package, here is a table that computes the Taylor
series of degree ‘n’ at location ‘x’ for a couple of functions.

     |---+-------------+---+-----+--------------------------------------|
     |   | Func        | n | x   | Result                               |
     |---+-------------+---+-----+--------------------------------------|
     | # | exp(x)      | 1 | x   | 1 + x                                |
     | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
     | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
     | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
     | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
     | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
     |---+-------------+---+-----+--------------------------------------|
     #+TBLFM: $5=taylor($2,$4,$3);n3

   ---------- Footnotes ----------

   (1) Such names must start by an alphabetic character and use only
alphanumeric/underscore characters.


File: org.info,  Node: Org-Plot,  Prev: The spreadsheet,  Up: Tables

3.6 Org-Plot
============

Org-Plot can produce graphs of information stored in org tables, either
graphically or in ASCII-art.

Graphical plots using ‘Gnuplot’
-------------------------------

Org-Plot produces 2D and 3D graphs using ‘Gnuplot’
<http://www.gnuplot.info/> and ‘gnuplot-mode’
<http://xafs.org/BruceRavel/GnuplotMode>.  To see this in action, ensure
that you have both Gnuplot and Gnuplot mode installed on your system,
then call ‘C-c " g’ or ‘M-x org-plot/gnuplot <RET>’ on the following
table.

     #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
     | Sede      | Max cites | H-index |
     |-----------+-----------+---------|
     | Chile     |    257.72 |   21.39 |
     | Leeds     |    165.77 |   19.68 |
     | Sao Paolo |     71.00 |   11.50 |
     | Stockholm |    134.19 |   14.33 |
     | Morelia   |    257.56 |   17.67 |

   Notice that Org Plot is smart enough to apply the table’s headers as
labels.  Further control over the labels, type, content, and appearance
of plots can be exercised through the ‘#+PLOT:’ lines preceding a table.
See below for a complete list of Org-plot options.  The ‘#+PLOT:’ lines
are optional.  For more information and examples see the Org-plot
tutorial at <https://orgmode.org/worg/org-tutorials/org-plot.html>.

Plot Options
............

‘set’
     Specify any ‘gnuplot’ option to be set when graphing.

‘title’
     Specify the title of the plot.

‘ind’
     Specify which column of the table to use as the ‘x’ axis.

‘deps’
     Specify the columns to graph as a Lisp style list, surrounded by
     parentheses and separated by spaces for example ‘dep:(3 4)’ to
     graph the third and fourth columns (defaults to graphing all other
     columns aside from the ‘ind’ column).

‘type’
     Specify whether the plot will be ‘2d’, ‘3d’, or ‘grid’.

‘with’
     Specify a ‘with’ option to be inserted for every col being plotted
     (e.g., ‘lines’, ‘points’, ‘boxes’, ‘impulses’, etc...).  Defaults
     to ‘lines’.

‘file’
     If you want to plot to a file, specify
     ‘"PATH/TO/DESIRED/OUTPUT-FILE"’.

‘labels’
     List of labels to be used for the ‘deps’ (defaults to the column
     headers if they exist).

‘line’
     Specify an entire line to be inserted in the Gnuplot script.

‘map’
     When plotting ‘3d’ or ‘grid’ types, set this to ‘t’ to graph a flat
     mapping rather than a ‘3d’ slope.

‘timefmt’
     Specify format of Org mode timestamps as they will be parsed by
     Gnuplot.  Defaults to ‘%Y-%m-%d-%H:%M:%S’.

‘script’
     If you want total control, you can specify a script file (place the
     file name between double-quotes) which will be used to plot.
     Before plotting, every instance of ‘$datafile’ in the specified
     script will be replaced with the path to the generated data file.
     Note: even if you set this option, you may still want to specify
     the plot type, as that can impact the content of the data file.

ASCII bar plots
---------------

While the cursor is on a column, typing ‘C-c " a’ or ‘M-x
orgtbl-ascii-plot <RET>’ create a new column containing an ASCII-art
bars plot.  The plot is implemented through a regular column formula.
When the source column changes, the bar plot may be updated by
refreshing the table, for example typing ‘C-u C-c *’.

     | Sede          | Max cites |              |
     |---------------+-----------+--------------|
     | Chile         |    257.72 | WWWWWWWWWWWW |
     | Leeds         |    165.77 | WWWWWWWh     |
     | Sao Paolo     |     71.00 | WWW;         |
     | Stockholm     |    134.19 | WWWWWW:      |
     | Morelia       |    257.56 | WWWWWWWWWWWH |
     | Rochefourchat |      0.00 |              |
     #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)

   The formula is an elisp call:
     (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)

‘COLUMN’
     is a reference to the source column.

‘MIN MAX’
     are the minimal and maximal values displayed.  Sources values
     outside this range are displayed as ‘too small’ or ‘too large’.

‘WIDTH’
     is the width in characters of the bar-plot.  It defaults to ‘12’.


File: org.info,  Node: Hyperlinks,  Next: TODO items,  Prev: Tables,  Up: Top

4 Hyperlinks
************

Like HTML, Org provides links inside a file, external links to other
files, Usenet articles, emails, and much more.

* Menu:

* Link format::                 How links in Org are formatted
* Internal links::              Links to other places in the current file
* External links::              URL-like links to the world
* Handling links::              Creating, inserting and following
* Using links outside Org::     Linking from my C source code?
* Link abbreviations::          Shortcuts for writing complex links
* Search options::              Linking to a specific location
* Custom searches::             When the default search is not enough


File: org.info,  Node: Link format,  Next: Internal links,  Up: Hyperlinks

4.1 Link format
===============

Org will recognize plain URL-like links and activate them as clickable
links.  The general link format, however, looks like this:

     [[link][description]]       or alternatively           [[link]]

Once a link in the buffer is complete (all brackets present), Org will
change the display so that ‘description’ is displayed instead of
‘[[link][description]]’ and ‘link’ is displayed instead of ‘[[link]]’.
Links will be highlighted in the face ‘org-link’, which by default is an
underlined face.  You can directly edit the visible part of a link.
Note that this can be either the ‘link’ part (if there is no
description) or the ‘description’ part.  To edit also the invisible
‘link’ part, use ‘C-c C-l’ with the cursor on the link.

   If you place the cursor at the beginning or just behind the end of
the displayed text and press <BACKSPACE>, you will remove the
(invisible) bracket at that location.  This makes the link incomplete
and the internals are again displayed as plain text.  Inserting the
missing bracket hides the link internals again.  To show the internal
structure of all links, use the menu entry ‘Org->Hyperlinks->Literal
links’.


File: org.info,  Node: Internal links,  Next: External links,  Prev: Link format,  Up: Hyperlinks

4.2 Internal links
==================

If the link does not look like a URL, it is considered to be internal in
the current file.  The most important case is a link like
‘[[#my-custom-id]]’ which will link to the entry with the ‘CUSTOM_ID’
property ‘my-custom-id’.  You are responsible yourself to make sure
these custom IDs are unique in a file.

   Links such as ‘[[My Target]]’ or ‘[[My Target][Find my target]]’ lead
to a text search in the current file.

   The link can be followed with ‘C-c C-o’ when the cursor is on the
link, or with a mouse click (*note Handling links::).  Links to custom
IDs will point to the corresponding headline.  The preferred match for a
text link is a dedicated target: the same string in double angular
brackets, like ‘<<My Target>>’.

   If no dedicated target exists, the link will then try to match the
exact name of an element within the buffer.  Naming is done with the
‘#+NAME’ keyword, which has to be put in the line before the element it
refers to, as in the following example

     #+NAME: My Target
     | a  | table      |
     |----+------------|
     | of | four cells |

   If none of the above succeeds, Org will search for a headline that is
exactly the link text but may also include a TODO keyword and tags(1).

   During export, internal links will be used to mark objects and assign
them a number.  Marked objects will then be referenced by links pointing
to them.  In particular, links without a description will appear as the
number assigned to the marked object(2).  In the following excerpt from
an Org buffer

     - one item
     - <<target>>another item
     Here we refer to item [[target]].

The last sentence will appear as ‘Here we refer to item 2’ when
exported.

   In non-Org files, the search will look for the words in the link
text.  In the above example the search would be for ‘my target’.

   Following a link pushes a mark onto Org’s own mark ring.  You can
return to the previous position with ‘C-c &’.  Using this command
several times in direct succession goes back to positions recorded
earlier.

* Menu:

* Radio targets::               Make targets trigger links in plain text

   ---------- Footnotes ----------

   (1) To insert a link targeting a headline, in-buffer completion can
be used.  Just type a star followed by a few optional letters into the
buffer and press ‘M-<TAB>’.  All headlines in the current buffer will be
offered as completions.

   (2) When targeting a ‘#+NAME’ keyword, ‘#+CAPTION’ keyword is
mandatory in order to get proper numbering (*note Images and tables::).


File: org.info,  Node: Radio targets,  Up: Internal links

4.2.1 Radio targets
-------------------

Org can automatically turn any occurrences of certain target names in
normal text into a link.  So without explicitly creating a link, the
text connects to the target radioing its position.  Radio targets are
enclosed by triple angular brackets.  For example, a target ‘<<<My
Target>>>’ causes each occurrence of ‘my target’ in normal text to
become activated as a link.  The Org file is scanned automatically for
radio targets only when the file is first loaded into Emacs.  To update
the target list during editing, press ‘C-c C-c’ with the cursor on or at
a target.


File: org.info,  Node: External links,  Next: Handling links,  Prev: Internal links,  Up: Hyperlinks

4.3 External links
==================

Org supports links to files, websites, Usenet and email messages, BBDB
database entries and links to both IRC conversations and their logs.
External links are URL-like locators.  They start with a short
identifying string followed by a colon.  There can be no space after the
colon.  The following list shows examples for each link type.

     http://www.astro.uva.nl/~dominik             on the web
     doi:10.1000/182                              DOI for an electronic resource
     file:/home/dominik/images/jupiter.jpg        file, absolute path
     /home/dominik/images/jupiter.jpg             same as above
     file:papers/last.pdf                         file, relative path
     ./papers/last.pdf                            same as above
     file:/ssh:myself@some.where:papers/last.pdf  file, path on remote machine
     /ssh:myself@some.where:papers/last.pdf       same as above
     file:sometextfile::NNN                       file, jump to line number
     file:projects.org                            another Org file
     file:projects.org::some words                text search in Org file(1)
     file:projects.org::*task title               heading search in Org file(2)
     docview:papers/last.pdf::NNN                 open in doc-view mode at page
     id:B7423F4D-2E8A-471B-8810-C40F074717E9      Link to heading by ID
     news:comp.emacs                              Usenet link
     mailto:adent@galaxy.net                      Mail link
     mhe:folder                                   MH-E folder link
     mhe:folder#id                                MH-E message link
     rmail:folder                                 RMAIL folder link
     rmail:folder#id                              RMAIL message link
     gnus:group                                   Gnus group link
     gnus:group#id                                Gnus article link
     bbdb:R.*Stallman                             BBDB link (with regexp)
     irc:/irc.com/#emacs/bob                      IRC link
     info:org#External links                      Info node or index link
     shell:ls *.org                               A shell command
     elisp:org-agenda                             Interactive Elisp command
     elisp:(find-file-other-frame "Elisp.org")    Elisp form to evaluate

   On top of these built-in link types, some are available through the
‘contrib/’ directory (*note Installation::).  For example, these links
to VM or Wanderlust messages are available when you load the
corresponding libraries from the ‘contrib/’ directory:

     vm:folder                                    VM folder link
     vm:folder#id                                 VM message link
     vm://myself@some.where.org/folder#id         VM on remote machine
     vm-imap:account:folder                       VM IMAP folder link
     vm-imap:account:folder#id                    VM IMAP message link
     wl:folder                                    WANDERLUST folder link
     wl:folder#id                                 WANDERLUST message link

   For customizing Org to add new link types *note Adding hyperlink
types::.

   A link should be enclosed in double brackets and may contain a
descriptive text to be displayed instead of the URL (*note Link
format::), for example:

     [[https://www.gnu.org/software/emacs/][GNU Emacs]]

If the description is a file name or URL that points to an image, HTML
export (*note HTML export::) will inline the image as a clickable
button.  If there is no description at all and the link points to an
image, that image will be inlined into the exported HTML file.

   Org also finds external links in the normal text and activates them
as links.  If spaces must be part of the link (for example in
‘bbdb:Richard Stallman’), or if you need to remove ambiguities about the
end of the link, enclose them in square brackets.

   ---------- Footnotes ----------

   (1) The actual behavior of the search will depend on the value of the
option ‘org-link-search-must-match-exact-headline’.  If its value is
‘nil’, then a fuzzy text search will be done.  If it is ‘t’, then only
the exact headline will be matched, ignoring spaces and cookies.  If the
value is ‘query-to-create’, then an exact headline will be searched; if
it is not found, then the user will be queried to create it.

   (2) Headline searches always match the exact headline, ignoring
spaces and cookies.  If the headline is not found and the value of the
option ‘org-link-search-must-match-exact-headline’ is ‘query-to-create’,
then the user will be queried to create it.


File: org.info,  Node: Handling links,  Next: Using links outside Org,  Prev: External links,  Up: Hyperlinks

4.4 Handling links
==================

Org provides methods to create a link in the correct syntax, to insert
it into an Org file, and to follow the link.

‘C-c l     (org-store-link)’
     Store a link to the current location.  This is a _global_ command
     (you must create the key binding yourself) which can be used in any
     buffer to create a link.  The link will be stored for later
     insertion into an Org buffer (see below).  What kind of link will
     be created depends on the current buffer:

     Org mode buffers
     For Org files, if there is a ‘<<target>>’ at the cursor, the link
     points to the target.  Otherwise it points to the current headline,
     which will also be the description(1).

     If the headline has a ‘CUSTOM_ID’ property, a link to this custom
     ID will be stored.  In addition or alternatively (depending on the
     value of ‘org-id-link-to-org-use-id’), a globally unique ‘ID’
     property will be created and/or used to construct a link(2).  So
     using this command in Org buffers will potentially create two
     links: a human-readable from the custom ID, and one that is
     globally unique and works even if the entry is moved from file to
     file.  Later, when inserting the link, you need to decide which one
     to use.

     Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus
     Pretty much all Emacs mail clients are supported.  The link will
     point to the current article, or, in some GNUS buffers, to the
     group.  The description is constructed from the author and the
     subject.

     Web browsers: Eww, W3 and W3M
     Here the link will be the current URL, with the page title as
     description.

     Contacts: BBDB
     Links created in a BBDB buffer will point to the current entry.

     Chat: IRC
     For IRC links, if you set the option ‘org-irc-link-to-logs’ to ‘t’,
     a ‘file:/’ style link to the relevant point in the logs for the
     current conversation is created.  Otherwise an ‘irc:/’ style link
     to the user/channel/server under the point will be stored.

     Other files
     For any other files, the link will point to the file, with a search
     string (*note Search options::) pointing to the contents of the
     current line.  If there is an active region, the selected words
     will form the basis of the search string.  If the automatically
     created link is not working correctly or accurately enough, you can
     write custom functions to select the search string and to do the
     search for particular file types—see *note Custom searches::.  The
     key binding ‘C-c l’ is only a suggestion—see *note Installation::.

     Agenda view
     When the cursor is in an agenda view, the created link points to
     the entry referenced by the current line.

‘C-c C-l     (org-insert-link)’
     Insert a link(3).  This prompts for a link to be inserted into the
     buffer.  You can just type a link, using text for an internal link,
     or one of the link type prefixes mentioned in the examples above.
     The link will be inserted into the buffer(4), along with a
     descriptive text.  If some text was selected when this command is
     called, the selected text becomes the default description.

     Inserting stored links
     All links stored during the current session are part of the history
     for this prompt, so you can access them with <UP> and <DOWN> (or
     ‘M-p/n’).

     Completion support
     Completion with <TAB> will help you to insert valid link prefixes
     like ‘https:’, including the prefixes defined through link
     abbreviations (*note Link abbreviations::).  If you press <RET>
     after inserting only the PREFIX, Org will offer specific completion
     support for some link types(5) For example, if you type ‘file
     <RET>’, file name completion (alternative access: ‘C-u C-c C-l’,
     see below) will be offered, and after ‘bbdb <RET>’ you can complete
     contact names.
‘C-u C-c C-l’
     When ‘C-c C-l’ is called with a ‘C-u’ prefix argument, a link to a
     file will be inserted and you may use file name completion to
     select the name of the file.  The path to the file is inserted
     relative to the directory of the current Org file, if the linked
     file is in the current directory or in a sub-directory of it, or if
     the path is written relative to the current directory using ‘../’.
     Otherwise an absolute path is used, if possible with ‘~/’ for your
     home directory.  You can force an absolute path with two ‘C-u’
     prefixes.
‘C-c C-l  (with cursor on existing link)’
     When the cursor is on an existing link, ‘C-c C-l’ allows you to
     edit the link and description parts of the link.
‘C-c C-o     (org-open-at-point)’
     Open link at point.  This will launch a web browser for URLs (using
     ‘browse-url-at-point’), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
     the corresponding links, and execute the command in a shell link.
     When the cursor is on an internal link, this command runs the
     corresponding search.  When the cursor is on a TAG list in a
     headline, it creates the corresponding TAGS view.  If the cursor is
     on a timestamp, it compiles the agenda for that date.  Furthermore,
     it will visit text and remote files in ‘file:’ links with Emacs and
     select a suitable application for local non-text files.
     Classification of files is based on file extension only.  See
     option ‘org-file-apps’.  If you want to override the default
     application and visit the file with Emacs, use a ‘C-u’ prefix.  If
     you want to avoid opening in Emacs, use a ‘C-u C-u’ prefix.
     If the cursor is on a headline, but not on a link, offer all links
     in the headline and entry text.  If you want to setup the frame
     configuration for following links, customize
     ‘org-link-frame-setup’.

‘<RET>’
     When ‘org-return-follows-link’ is set, ‘<RET>’ will also follow the
     link at point.
‘mouse-2’
‘mouse-1’
     On links, ‘mouse-1’ and ‘mouse-2’ will open the link just as ‘C-c
     C-o’ would.
‘mouse-3’
     Like ‘mouse-2’, but force file links to be opened with Emacs, and
     internal links to be displayed in another window(6).
‘C-c C-x C-v     (org-toggle-inline-images)’
     Toggle the inline display of linked images.  Normally this will
     only inline images that have no description part in the link, i.e.,
     images that will also be inlined during export.  When called with a
     prefix argument, also display images that do have a link
     description.  You can ask for inline images to be displayed at
     startup by configuring the variable
     ‘org-startup-with-inline-images’(7).
‘C-c %     (org-mark-ring-push)’
     Push the current position onto the mark ring, to be able to return
     easily.  Commands following an internal link do this automatically.
‘C-c &     (org-mark-ring-goto)’
     Jump back to a recorded position.  A position is recorded by the
     commands following internal links, and by ‘C-c %’.  Using this
     command several times in direct succession moves through a ring of
     previously recorded positions.
‘C-c C-x C-n     (org-next-link)’
‘C-c C-x C-p     (org-previous-link)’
     Move forward/backward to the next link in the buffer.  At the limit
     of the buffer, the search fails once, and then wraps around.  The
     key bindings for this are really too long; you might want to bind
     this also to ‘C-n’ and ‘C-p’
          (add-hook 'org-load-hook
            (lambda ()
              (define-key org-mode-map "\C-n" 'org-next-link)
              (define-key org-mode-map "\C-p" 'org-previous-link)))

   ---------- Footnotes ----------

   (1) If the headline contains a timestamp, it will be removed from the
link and result in a wrong link—you should avoid putting timestamp in
the headline.

   (2) The library ‘org-id.el’ must first be loaded, either through
‘org-customize’ by enabling ‘org-id’ in ‘org-modules’, or by adding
‘(require 'org-id)’ in your Emacs init file.

   (3) Note that you don’t have to use this command to insert a link.
Links in Org are plain text, and you can type or paste them straight
into the buffer.  By using this command, the links are automatically
enclosed in double brackets, and you will be asked for the optional
descriptive text.

   (4) After insertion of a stored link, the link will be removed from
the list of stored links.  To keep it in the list later use, use a
triple ‘C-u’ prefix argument to ‘C-c C-l’, or configure the option
‘org-keep-stored-link-after-insertion’.

   (5) This works if a completion function is defined in the ‘:complete’
property of a link in ‘org-link-parameters’.

   (6) See the option ‘org-display-internal-link-with-indirect-buffer’

   (7) with corresponding ‘#+STARTUP’ keywords ‘inlineimages’ and
‘noinlineimages’


File: org.info,  Node: Using links outside Org,  Next: Link abbreviations,  Prev: Handling links,  Up: Hyperlinks

4.5 Using links outside Org
===========================

You can insert and follow links that have Org syntax not only in Org,
but in any Emacs buffer.  For this, you should create two global
commands, like this (please select suitable global keys yourself):

     (global-set-key "\C-c L" 'org-insert-link-global)
     (global-set-key "\C-c o" 'org-open-at-point-global)


File: org.info,  Node: Link abbreviations,  Next: Search options,  Prev: Using links outside Org,  Up: Hyperlinks

4.6 Link abbreviations
======================

Long URLs can be cumbersome to type, and often many similar links are
needed in a document.  For this you can use link abbreviations.  An
abbreviated link looks like this

     [[linkword:tag][description]]

where the tag is optional.  The linkword must be a word, starting with a
letter, followed by letters, numbers, ‘-’, and ‘_’.  Abbreviations are
resolved according to the information in the variable
‘org-link-abbrev-alist’ that relates the linkwords to replacement text.
Here is an example:

     (setq org-link-abbrev-alist
       '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
         ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
         ("google"    . "http://www.google.com/search?q=")
         ("gmap"      . "http://maps.google.com/maps?q=%s")
         ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
         ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))

   If the replacement text contains the string ‘%s’, it will be replaced
with the tag.  Using ‘%h’ instead of ‘%s’ will url-encode the tag (see
the example above, where we need to encode the URL parameter.)  Using
‘%(my-function)’ will pass the tag to a custom function, and replace it
by the resulting string.

   If the replacement text doesn’t contain any specifier, the tag will
simply be appended in order to create the link.

   Instead of a string, you may also specify a function that will be
called with the tag as the only argument to create the link.

   With the above setting, you could link to a specific bug with
‘[[bugzilla:129]]’, search the web for ‘OrgMode’ with
‘[[google:OrgMode]]’, show the map location of the Free Software
Foundation ‘[[gmap:51 Franklin Street, Boston]]’ or of Carsten office
‘[[omap:Science Park 904, Amsterdam, The Netherlands]]’ and find out
what the Org author is doing besides Emacs hacking with
‘[[ads:Dominik,C]]’.

   If you need special abbreviations just for a single Org buffer, you
can define them in the file with

     #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
     #+LINK: google    http://www.google.com/search?q=%s

In-buffer completion (*note Completion::) can be used after ‘[’ to
complete link abbreviations.  You may also define a function that
implements special (e.g., completion) support for inserting such a link
with ‘C-c C-l’.  Such a function should not accept any arguments, and
return the full link with prefix.  You can add a completion function to
a link like this:

     (org-link-set-parameters ``type'' :complete #'some-function)


File: org.info,  Node: Search options,  Next: Custom searches,  Prev: Link abbreviations,  Up: Hyperlinks

4.7 Search options in file links
================================

File links can contain additional information to make Emacs jump to a
particular location in the file when following a link.  This can be a
line number or a search option after a double(1) colon.  For example,
when the command ‘C-c l’ creates a link (*note Handling links::) to a
file, it encodes the words in the current line as a search string that
can be used to find this line back later when following the link with
‘C-c C-o’.

   Here is the syntax of the different ways to attach a search to a file
link, together with an explanation:

     [[file:~/code/main.c::255]]
     [[file:~/xx.org::My Target]]
     [[file:~/xx.org::*My Target]]
     [[file:~/xx.org::#my-custom-id]]
     [[file:~/xx.org::/regexp/]]

‘255’
     Jump to line 255.
‘My Target’
     Search for a link target ‘<<My Target>>’, or do a text search for
     ‘my target’, similar to the search in internal links, see *note
     Internal links::.  In HTML export (*note HTML export::), such a
     file link will become an HTML reference to the corresponding named
     anchor in the linked file.
‘*My Target’
     In an Org file, restrict search to headlines.
‘#my-custom-id’
     Link to a heading with a ‘CUSTOM_ID’ property
‘/regexp/’
     Do a regular expression search for ‘regexp’.  This uses the Emacs
     command ‘occur’ to list all matches in a separate window.  If the
     target file is in Org mode, ‘org-occur’ is used to create a sparse
     tree with the matches.

   As a degenerate case, a file link with an empty file name can be used
to search the current file.  For example, ‘[[file:::find me]]’ does a
search for ‘find me’ in the current file, just as ‘[[find me]]’ would.

   ---------- Footnotes ----------

   (1) For backward compatibility, line numbers can also follow a single
colon.


File: org.info,  Node: Custom searches,  Prev: Search options,  Up: Hyperlinks

4.8 Custom Searches
===================

The default mechanism for creating search strings and for doing the
actual search related to a file link may not work correctly in all
cases.  For example, BibTeX database files have many entries like
‘year="1993"’ which would not result in good search strings, because the
only unique identification for a BibTeX entry is the citation key.

   If you come across such a problem, you can write custom functions to
set the right search string for a particular file type, and to do the
search for the string in the file.  Using ‘add-hook’, these functions
need to be added to the hook variables
‘org-create-file-search-functions’ and
‘org-execute-file-search-functions’.  See the docstring for these
variables for more information.  Org actually uses this mechanism for
BibTeX database files, and you can use the corresponding code as an
implementation example.  See the file ‘org-bibtex.el’.


File: org.info,  Node: TODO items,  Next: Tags,  Prev: Hyperlinks,  Up: Top

5 TODO items
************

Org mode does not maintain TODO lists as separate documents(1).
Instead, TODO items are an integral part of the notes file, because TODO
items usually come up while taking notes!  With Org mode, simply mark
any entry in a tree as being a TODO item.  In this way, information is
not duplicated, and the entire context from which the TODO item emerged
is always present.

   Of course, this technique for managing TODO items scatters them
throughout your notes file.  Org mode compensates for this by providing
methods to give you an overview of all the things that you have to do.

* Menu:

* TODO basics::                 Marking and displaying TODO entries
* TODO extensions::             Workflow and assignments
* Progress logging::            Dates and notes for progress
* Priorities::                  Some things are more important than others
* Breaking down tasks::         Splitting a task into manageable pieces
* Checkboxes::                  Tick-off lists

   ---------- Footnotes ----------

   (1) Of course, you can make a document that contains only long lists
of TODO items, but this is not required.


File: org.info,  Node: TODO basics,  Next: TODO extensions,  Up: TODO items

5.1 Basic TODO functionality
============================

Any headline becomes a TODO item when it starts with the word ‘TODO’,
for example:

     *** TODO Write letter to Sam Fortune

The most important commands to work with TODO entries are:

‘C-c C-t     (org-todo)’

     Rotate the TODO state of the current item among

          ,-> (unmarked) -> TODO -> DONE --.
          '--------------------------------'

     If TODO keywords have fast access keys (see *note Fast access to
     TODO states::), you will be prompted for a TODO keyword through the
     fast selection interface; this is the default behavior when
     ‘org-use-fast-todo-selection’ is non-‘nil’.

     The same rotation can also be done “remotely” from agenda buffers
     with the ‘t’ command key (*note Agenda commands::).

‘C-u C-c C-t’
     When TODO keywords have no selection keys, select a specific
     keyword using completion; otherwise force cycling through TODO
     states with no prompt.  When ‘org-use-fast-todo-selection’ is set
     to ‘prefix’, use the fast selection interface.

‘S-<RIGHT>  /  S-<LEFT>’
     Select the following/preceding TODO state, similar to cycling.
     Useful mostly if more than two TODO states are possible (*note TODO
     extensions::).  See also *note Conflicts::, for a discussion of the
     interaction with ‘shift-selection-mode’.  See also the variable
     ‘org-treat-S-cursor-todo-selection-as-state-change’.
‘C-c / t     (org-show-todo-tree)’
     View TODO items in a _sparse tree_ (*note Sparse trees::).  Folds
     the entire buffer, but shows all TODO items (with not-DONE state)
     and the headings hierarchy above them.  With a prefix argument (or
     by using ‘C-c / T’), search for a specific TODO.  You will be
     prompted for the keyword, and you can also give a list of keywords
     like ‘KWD1|KWD2|...’ to list entries that match any one of these
     keywords.  With a numeric prefix argument N, show the tree for the
     Nth keyword in the option ‘org-todo-keywords’.  With two prefix
     arguments, find all TODO states, both un-done and done.
‘C-c a t     (org-todo-list)’
     Show the global TODO list.  Collects the TODO items (with not-DONE
     states) from all agenda files (*note Agenda views::) into a single
     buffer.  The new buffer will be in ‘agenda-mode’, which provides
     commands to examine and manipulate the TODO entries from the new
     buffer (*note Agenda commands::).  *Note Global TODO list::, for
     more information.
‘S-M-<RET>     (org-insert-todo-heading)’
     Insert a new TODO entry below the current one.

Changing a TODO state can also trigger tag changes.  See the docstring
of the option ‘org-todo-state-tags-triggers’ for details.


File: org.info,  Node: TODO extensions,  Next: Progress logging,  Prev: TODO basics,  Up: TODO items

5.2 Extended use of TODO keywords
=================================

By default, marked TODO entries have one of only two states: TODO and
DONE.  Org mode allows you to classify TODO items in more complex ways
with _TODO keywords_ (stored in ‘org-todo-keywords’).  With special
setup, the TODO keyword system can work differently in different files.

   Note that tags are another way to classify headlines in general and
TODO items in particular (*note Tags::).

* Menu:

* Workflow states::             From TODO to DONE in steps
* TODO types::                  I do this, Fred does the rest
* Multiple sets in one file::   Mixing it all, and still finding your way
* Fast access to TODO states::  Single letter selection of a state
* Per-file keywords::           Different files, different requirements
* Faces for TODO keywords::     Highlighting states
* TODO dependencies::           When one task needs to wait for others


File: org.info,  Node: Workflow states,  Next: TODO types,  Up: TODO extensions

5.2.1 TODO keywords as workflow states
--------------------------------------

You can use TODO keywords to indicate different _sequential_ states in
the process of working on an item, for example(1):

     (setq org-todo-keywords
       '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))

   The vertical bar separates the TODO keywords (states that _need
action_) from the DONE states (which need _no further action_).  If you
don’t provide the separator bar, the last state is used as the DONE
state.  With this setup, the command ‘C-c C-t’ will cycle an entry from
TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
You may also use a numeric prefix argument to quickly select a specific
state.  For example ‘C-3 C-c C-t’ will change the state immediately to
VERIFY.  Or you can use ‘S-<LEFT>’ to go backward through the sequence.
If you define many keywords, you can use in-buffer completion (*note
Completion::) or even a special one-key selection scheme (*note Fast
access to TODO states::) to insert these words into the buffer.
Changing a TODO state can be logged with a timestamp, see *note Tracking
TODO state changes::, for more information.

   ---------- Footnotes ----------

   (1) Changing this variable only becomes effective after restarting
Org mode in a buffer.


File: org.info,  Node: TODO types,  Next: Multiple sets in one file,  Prev: Workflow states,  Up: TODO extensions

5.2.2 TODO keywords as types
----------------------------

The second possibility is to use TODO keywords to indicate different
_types_ of action items.  For example, you might want to indicate that
items are for “work” or “home”.  Or, when you work with several people
on a single project, you might want to assign action items directly to
persons, by using their names as TODO keywords.  This would be set up
like this:

     (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))

   In this case, different keywords do not indicate a sequence, but
rather different types.  So the normal work flow would be to assign a
task to a person, and later to mark it DONE.  Org mode supports this
style by adapting the workings of the command ‘C-c C-t’(1).  When used
several times in succession, it will still cycle through all names, in
order to first select the right type for a task.  But when you return to
the item after some time and execute ‘C-c C-t’ again, it will switch
from any name directly to DONE.  Use prefix arguments or completion to
quickly select a specific name.  You can also review the items of a
specific TODO type in a sparse tree by using a numeric prefix to ‘C-c /
t’.  For example, to see all things Lucy has to do, you would use ‘C-3
C-c / t’.  To collect Lucy’s items from all agenda files into a single
buffer, you would use the numeric prefix argument as well when creating
the global TODO list: ‘C-3 C-c a t’.

   ---------- Footnotes ----------

   (1) This is also true for the ‘t’ command in the agenda buffers.


File: org.info,  Node: Multiple sets in one file,  Next: Fast access to TODO states,  Prev: TODO types,  Up: TODO extensions

5.2.3 Multiple keyword sets in one file
---------------------------------------

Sometimes you may want to use different sets of TODO keywords in
parallel.  For example, you may want to have the basic ‘TODO’/‘DONE’,
but also a workflow for bug fixing, and a separate state indicating that
an item has been canceled (so it is not DONE, but also does not require
action).  Your setup would then look like this:

     (setq org-todo-keywords
           '((sequence "TODO" "|" "DONE")
             (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
             (sequence "|" "CANCELED")))

   The keywords should all be different, this helps Org mode to keep
track of which subsequence should be used for a given entry.  In this
setup, ‘C-c C-t’ only operates within a subsequence, so it switches from
‘DONE’ to (nothing) to ‘TODO’, and from ‘FIXED’ to (nothing) to
‘REPORT’.  Therefore you need a mechanism to initially select the
correct sequence.  Besides the obvious ways like typing a keyword or
using completion, you may also apply the following commands:

‘C-u C-u C-c C-t’
‘C-S-<RIGHT>’
‘C-S-<LEFT>’
     These keys jump from one TODO subset to the next.  In the above
     example, ‘C-u C-u C-c C-t’ or ‘C-S-<RIGHT>’ would jump from ‘TODO’
     or ‘DONE’ to ‘REPORT’, and any of the words in the second row to
     ‘CANCELED’.  Note that the ‘C-S-’ key binding conflict with
     ‘shift-selection-mode’ (*note Conflicts::).
‘S-<RIGHT>’
‘S-<LEFT>’
     ‘S-<LEFT>’ and ‘S-<RIGHT>’ and walk through _all_ keywords from all
     sets, so for example ‘S-<RIGHT>’ would switch from ‘DONE’ to
     ‘REPORT’ in the example above.  See also *note Conflicts::, for a
     discussion of the interaction with ‘shift-selection-mode’.


File: org.info,  Node: Fast access to TODO states,  Next: Per-file keywords,  Prev: Multiple sets in one file,  Up: TODO extensions

5.2.4 Fast access to TODO states
--------------------------------

If you would like to quickly change an entry to an arbitrary TODO state
instead of cycling through the states, you can set up keys for
single-letter access to the states.  This is done by adding the
selection character after each keyword, in parentheses(1).  For example:

     (setq org-todo-keywords
           '((sequence "TODO(t)" "|" "DONE(d)")
             (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
             (sequence "|" "CANCELED(c)")))

   If you then press ‘C-c C-t’ followed by the selection key, the entry
will be switched to this state.  ‘<SPC>’ can be used to remove any TODO
keyword from an entry.(2)

   ---------- Footnotes ----------

   (1) All characters are allowed except ‘@^!’, which have a special
meaning here.

   (2) Check also the option ‘org-fast-tag-selection-include-todo’, it
allows you to change the TODO state through the tags interface (*note
Setting tags::), in case you like to mingle the two concepts.  Note that
this means you need to come up with unique keys across both sets of
keywords.


File: org.info,  Node: Per-file keywords,  Next: Faces for TODO keywords,  Prev: Fast access to TODO states,  Up: TODO extensions

5.2.5 Setting up keywords for individual files
----------------------------------------------

It can be very useful to use different aspects of the TODO mechanism in
different files.  For file-local settings, you need to add special lines
to the file which set the keywords and interpretation for that file
only.  For example, to set one of the two examples discussed above, you
need one of the following lines anywhere in the file:

     #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
(you may also write ‘#+SEQ_TODO’ to be explicit about the
interpretation, but it means the same as ‘#+TODO’), or
     #+TYP_TODO: Fred Sara Lucy Mike | DONE

   A setup for using several sets in parallel would be:

     #+TODO: TODO | DONE
     #+TODO: REPORT BUG KNOWNCAUSE | FIXED
     #+TODO: | CANCELED

To make sure you are using the correct keyword, type ‘#+’ into the
buffer and then use ‘M-<TAB>’ completion.

   Remember that the keywords after the vertical bar (or the last
keyword if no bar is there) must always mean that the item is DONE
(although you may use a different word).  After changing one of these
lines, use ‘C-c C-c’ with the cursor still in the line to make the
changes known to Org mode(1).

   ---------- Footnotes ----------

   (1) Org mode parses these lines only when Org mode is activated after
visiting a file.  ‘C-c C-c’ with the cursor in a line starting with ‘#+’
is simply restarting Org mode for the current buffer.


File: org.info,  Node: Faces for TODO keywords,  Next: TODO dependencies,  Prev: Per-file keywords,  Up: TODO extensions

5.2.6 Faces for TODO keywords
-----------------------------

Org mode highlights TODO keywords with special faces: ‘org-todo’ for
keywords indicating that an item still has to be acted upon, and
‘org-done’ for keywords indicating that an item is finished.  If you are
using more than 2 different states, you might want to use special faces
for some of them.  This can be done using the option
‘org-todo-keyword-faces’.  For example:

     (setq org-todo-keyword-faces
           '(("TODO" . org-warning) ("STARTED" . "yellow")
             ("CANCELED" . (:foreground "blue" :weight bold))))

   While using a list with face properties as shown for CANCELED
_should_ work, this does not always seem to be the case.  If necessary,
define a special face and use that.  A string is interpreted as a color.
The option ‘org-faces-easy-properties’ determines if that color is
interpreted as a foreground or a background color.


File: org.info,  Node: TODO dependencies,  Prev: Faces for TODO keywords,  Up: TODO extensions

5.2.7 TODO dependencies
-----------------------

The structure of Org files (hierarchy and lists) makes it easy to define
TODO dependencies.  Usually, a parent TODO task should not be marked
DONE until all subtasks (defined as children tasks) are marked as DONE.
And sometimes there is a logical sequence to a number of (sub)tasks, so
that one task cannot be acted upon before all siblings above it are
done.  If you customize the option ‘org-enforce-todo-dependencies’, Org
will block entries from changing state to DONE while they have children
that are not DONE.  Furthermore, if an entry has a property ‘ORDERED’,
each of its children will be blocked until all earlier siblings are
marked DONE.  Here is an example:

     * TODO Blocked until (two) is done
     ** DONE one
     ** TODO two

     * Parent
       :PROPERTIES:
       :ORDERED: t
       :END:
     ** TODO a
     ** TODO b, needs to wait for (a)
     ** TODO c, needs to wait for (a) and (b)

   You can ensure an entry is never blocked by using the ‘NOBLOCKING’
property:

     * This entry is never blocked
       :PROPERTIES:
       :NOBLOCKING: t
       :END:

‘C-c C-x o     (org-toggle-ordered-property)’
     Toggle the ‘ORDERED’ property of the current entry.  A property is
     used for this behavior because this should be local to the current
     entry, not inherited like a tag.  However, if you would like to
     track the value of this property with a tag for better visibility,
     customize the option ‘org-track-ordered-property-with-tag’.
‘C-u C-u C-u C-c C-t’
     Change TODO state, circumventing any state blocking.

   If you set the option ‘org-agenda-dim-blocked-tasks’, TODO entries
that cannot be closed because of such dependencies will be shown in a
dimmed font or even made invisible in agenda views (*note Agenda
views::).

   You can also block changes of TODO states by looking at checkboxes
(*note Checkboxes::).  If you set the option
‘org-enforce-todo-checkbox-dependencies’, an entry that has unchecked
checkboxes will be blocked from switching to DONE.

   If you need more complex dependency structures, for example
dependencies between entries in different trees or files, check out the
contributed module ‘org-depend.el’.


File: org.info,  Node: Progress logging,  Next: Priorities,  Prev: TODO extensions,  Up: TODO items

5.3 Progress logging
====================

Org mode can automatically record a timestamp and possibly a note when
you mark a TODO item as DONE, or even each time you change the state of
a TODO item.  This system is highly configurable; settings can be on a
per-keyword basis and can be localized to a file or even a subtree.  For
information on how to clock working time for a task, see *note Clocking
work time::.

* Menu:

* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
* Tracking your habits::        How consistent have you been?


File: org.info,  Node: Closing items,  Next: Tracking TODO state changes,  Up: Progress logging

5.3.1 Closing items
-------------------

The most basic logging is to keep track of _when_ a certain TODO item
was finished.  This is achieved with(1)

     (setq org-log-done 'time)

Then each time you turn an entry from a TODO (not-done) state into any
of the DONE states, a line ‘CLOSED: [timestamp]’ will be inserted just
after the headline.  If you turn the entry back into a TODO item through
further state cycling, that line will be removed again.  If you turn the
entry back to a non-TODO state (by pressing ‘C-c C-t <SPC>’ for
example), that line will also be removed, unless you set
‘org-closed-keep-when-no-todo’ to non-‘nil’.  If you want to record a
note along with the timestamp, use(2)

     (setq org-log-done 'note)

You will then be prompted for a note, and that note will be stored below
the entry with a ‘Closing Note’ heading.

   ---------- Footnotes ----------

   (1) The corresponding in-buffer setting is: ‘#+STARTUP: logdone’

   (2) The corresponding in-buffer setting is: ‘#+STARTUP: lognotedone’.


File: org.info,  Node: Tracking TODO state changes,  Next: Tracking your habits,  Prev: Closing items,  Up: Progress logging

5.3.2 Tracking TODO state changes
---------------------------------

When TODO keywords are used as workflow states (*note Workflow
states::), you might want to keep track of when a state change occurred
and maybe take a note about this change.  You can either record just a
timestamp, or a time-stamped note for a change.  These records will be
inserted after the headline as an itemized list, newest first(1).  When
taking a lot of notes, you might want to get the notes out of the way
into a drawer (*note Drawers::).  Customize ‘org-log-into-drawer’ to get
this behavior—the recommended drawer for this is called ‘LOGBOOK’(2).
You can also overrule the setting of this variable for a subtree by
setting a ‘LOG_INTO_DRAWER’ property.

   Since it is normally too much to record a note for every state, Org
mode expects configuration on a per-keyword basis for this.  This is
achieved by adding special markers ‘!’ (for a timestamp) or ‘@’ (for a
note with timestamp) in parentheses after each keyword.  For example,
with the setting

     (setq org-todo-keywords
       '((sequence "TODO(t)" "WAIT(w@/!)" "|" "DONE(d!)" "CANCELED(c@)")))

   To record a timestamp without a note for TODO keywords configured
with ‘@’, just type ‘C-c C-c’ to enter a blank note when prompted.

You not only define global TODO keywords and fast access keys, but also
request that a time is recorded when the entry is set to DONE(3), and
that a note is recorded when switching to WAIT or CANCELED.  The setting
for WAIT is even more special: the ‘!’ after the slash means that in
addition to the note taken when entering the state, a timestamp should
be recorded when leaving the WAIT state, if and only if the target state
does not configure logging for entering it.  So it has no effect when
switching from WAIT to DONE, because DONE is configured to record a
timestamp only.  But when switching from WAIT back to TODO, the ‘/!’ in
the WAIT setting now triggers a timestamp even though TODO has no
logging configured.

   You can use the exact same syntax for setting logging preferences
local to a buffer:
     #+TODO: TODO(t) WAIT(w@/!) | DONE(d!) CANCELED(c@)

   In order to define logging settings that are local to a subtree or a
single item, define a ‘LOGGING’ property in this entry.  Any non-empty
‘LOGGING’ property resets all logging settings to ‘nil’.  You may then
turn on logging for this specific tree using ‘#+STARTUP’ keywords like
‘lognotedone’ or ‘logrepeat’, as well as adding state specific settings
like ‘TODO(!)’.  For example

     * TODO Log each state with only a time
       :PROPERTIES:
       :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
       :END:
     * TODO Only log when switching to WAIT, and when repeating
       :PROPERTIES:
       :LOGGING: WAIT(@) logrepeat
       :END:
     * TODO No logging at all
       :PROPERTIES:
       :LOGGING: nil
       :END:

   ---------- Footnotes ----------

   (1) See the option ‘org-log-states-order-reversed’

   (2) Note that the ‘LOGBOOK’ drawer is unfolded when pressing ‘<SPC>’
in the agenda to show an entry—use ‘C-u <SPC>’ to keep it folded here

   (3) It is possible that Org mode will record two timestamps when you
are using both ‘org-log-done’ and state change logging.  However, it
will never prompt for two notes—if you have configured both, the state
change recording note will take precedence and cancel the ‘Closing
Note’.


File: org.info,  Node: Tracking your habits,  Prev: Tracking TODO state changes,  Up: Progress logging

5.3.3 Tracking your habits
--------------------------

Org has the ability to track the consistency of a special category of
TODOs, called “habits”.  A habit has the following properties:

  1. You have enabled the ‘habits’ module by customizing ‘org-modules’.
  2. The habit is a TODO item, with a TODO keyword representing an open
     state.
  3. The property ‘STYLE’ is set to the value ‘habit’.
  4. The TODO has a scheduled date, usually with a ‘.+’ style repeat
     interval.  A ‘++’ style may be appropriate for habits with time
     constraints, e.g., must be done on weekends, or a ‘+’ style for an
     unusual habit that can have a backlog, e.g., weekly reports.
  5. The TODO may also have minimum and maximum ranges specified by
     using the syntax ‘.+2d/3d’, which says that you want to do the task
     at least every three days, but at most every two days.
  6. You must also have state logging for the ‘DONE’ state enabled
     (*note Tracking TODO state changes::), in order for historical data
     to be represented in the consistency graph.  If it is not enabled
     it is not an error, but the consistency graphs will be largely
     meaningless.

   To give you an idea of what the above rules look like in action,
here’s an actual habit with some history:

     ** TODO Shave
        SCHEDULED: <2009-10-17 Sat .+2d/4d>
        :PROPERTIES:
        :STYLE:    habit
        :LAST_REPEAT: [2009-10-19 Mon 00:36]
        :END:
        - State "DONE"       from "TODO"       [2009-10-15 Thu]
        - State "DONE"       from "TODO"       [2009-10-12 Mon]
        - State "DONE"       from "TODO"       [2009-10-10 Sat]
        - State "DONE"       from "TODO"       [2009-10-04 Sun]
        - State "DONE"       from "TODO"       [2009-10-02 Fri]
        - State "DONE"       from "TODO"       [2009-09-29 Tue]
        - State "DONE"       from "TODO"       [2009-09-25 Fri]
        - State "DONE"       from "TODO"       [2009-09-19 Sat]
        - State "DONE"       from "TODO"       [2009-09-16 Wed]
        - State "DONE"       from "TODO"       [2009-09-12 Sat]

   What this habit says is: I want to shave at most every 2 days (given
by the ‘SCHEDULED’ date and repeat interval) and at least every 4 days.
If today is the 15th, then the habit first appears in the agenda on Oct
17, after the minimum of 2 days has elapsed, and will appear overdue on
Oct 19, after four days have elapsed.

   What’s really useful about habits is that they are displayed along
with a consistency graph, to show how consistent you’ve been at getting
that task done in the past.  This graph shows every day that the task
was done over the past three weeks, with colors for each day.  The
colors used are:

‘Blue’
     If the task wasn’t to be done yet on that day.
‘Green’
     If the task could have been done on that day.
‘Yellow’
     If the task was going to be overdue the next day.
‘Red’
     If the task was overdue on that day.

   In addition to coloring each day, the day is also marked with an
asterisk if the task was actually done that day, and an exclamation mark
to show where the current day falls in the graph.

   There are several configuration variables that can be used to change
the way habits are displayed in the agenda.

‘org-habit-graph-column’
     The buffer column at which the consistency graph should be drawn.
     This will overwrite any text in that column, so it is a good idea
     to keep your habits’ titles brief and to the point.
‘org-habit-preceding-days’
     The amount of history, in days before today, to appear in
     consistency graphs.
‘org-habit-following-days’
     The number of days after today that will appear in consistency
     graphs.
‘org-habit-show-habits-only-for-today’
     If non-‘nil’, only show habits in today’s agenda view.  This is set
     to true by default.

   Lastly, pressing ‘K’ in the agenda buffer will cause habits to
temporarily be disabled and they won’t appear at all.  Press ‘K’ again
to bring them back.  They are also subject to tag filtering, if you have
habits which should only be done in certain contexts, for example.


File: org.info,  Node: Priorities,  Next: Breaking down tasks,  Prev: Progress logging,  Up: TODO items

5.4 Priorities
==============

If you use Org mode extensively, you may end up with enough TODO items
that it starts to make sense to prioritize them.  Prioritizing can be
done by placing a _priority cookie_ into the headline of a TODO item,
like this

     *** TODO [#A] Write letter to Sam Fortune

By default, Org mode supports three priorities: ‘A’, ‘B’, and ‘C’.  ‘A’
is the highest priority.  An entry without a cookie is treated just like
priority ‘B’.  Priorities make a difference only for sorting in the
agenda (*note Weekly/daily agenda::); outside the agenda, they have no
inherent meaning to Org mode.  The cookies can be highlighted with
special faces by customizing ‘org-priority-faces’.

   Priorities can be attached to any outline node; they do not need to
be TODO items.

‘C-c ,’
     Set the priority of the current headline (‘org-priority’).  The
     command prompts for a priority character ‘A’, ‘B’ or ‘C’.  When you
     press <SPC> instead, the priority cookie is removed from the
     headline.  The priorities can also be changed “remotely” from the
     agenda buffer with the ‘,’ command (*note Agenda commands::).
‘S-<UP>     (org-priority-up)’
‘S-<DOWN>     (org-priority-down)’
     Increase/decrease priority of current headline(1).  Note that these
     keys are also used to modify timestamps (*note Creating
     timestamps::).  See also *note Conflicts::, for a discussion of the
     interaction with ‘shift-selection-mode’.

   You can change the range of allowed priorities by setting the options
‘org-highest-priority’, ‘org-lowest-priority’, and
‘org-default-priority’.  For an individual buffer, you may set these
values (highest, lowest, default) like this (please make sure that the
highest priority is earlier in the alphabet than the lowest priority):

     #+PRIORITIES: A C B

   ---------- Footnotes ----------

   (1) See also the option ‘org-priority-start-cycle-with-default’.


File: org.info,  Node: Breaking down tasks,  Next: Checkboxes,  Prev: Priorities,  Up: TODO items

5.5 Breaking tasks down into subtasks
=====================================

It is often advisable to break down large tasks into smaller, manageable
subtasks.  You can do this by creating an outline tree below a TODO
item, with detailed subtasks on the tree(1).  To keep the overview over
the fraction of subtasks that are already completed, insert either ‘[/]’
or ‘[%]’ anywhere in the headline.  These cookies will be updated each
time the TODO status of a child changes, or when pressing ‘C-c C-c’ on
the cookie.  For example:

     * Organize Party [33%]
     ** TODO Call people [1/2]
     *** TODO Peter
     *** DONE Sarah
     ** TODO Buy food
     ** DONE Talk to neighbor

   If a heading has both checkboxes and TODO children below it, the
meaning of the statistics cookie become ambiguous.  Set the property
‘COOKIE_DATA’ to either ‘checkbox’ or ‘todo’ to resolve this issue.

   If you would like to have the statistics cookie count any TODO
entries in the subtree (not just direct children), configure
‘org-hierarchical-todo-statistics’.  To do this for a single subtree,
include the word ‘recursive’ into the value of the ‘COOKIE_DATA’
property.

     * Parent capturing statistics [2/20]
       :PROPERTIES:
       :COOKIE_DATA: todo recursive
       :END:

   If you would like a TODO entry to automatically change to DONE when
all children are done, you can use the following setup:

     (defun org-summary-todo (n-done n-not-done)
       "Switch entry to DONE when all subentries are done, to TODO otherwise."
       (let (org-log-done org-log-states)   ; turn off logging
         (org-todo (if (= n-not-done 0) "DONE" "TODO"))))

     (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)

   Another possibility is the use of checkboxes to identify (a hierarchy
of) a large number of subtasks (*note Checkboxes::).

   ---------- Footnotes ----------

   (1) To keep subtasks out of the global TODO list, see the
‘org-agenda-todo-list-sublevels’.


File: org.info,  Node: Checkboxes,  Prev: Breaking down tasks,  Up: TODO items

5.6 Checkboxes
==============

Every item in a plain list(1) (*note Plain lists::) can be made into a
checkbox by starting it with the string ‘[ ]’.  This feature is similar
to TODO items (*note TODO items::), but is more lightweight.  Checkboxes
are not included in the global TODO list, so they are often great to
split a task into a number of simple steps.  Or you can use them in a
shopping list.  To toggle a checkbox, use ‘C-c C-c’, or use the mouse
(thanks to Piotr Zielinski’s ‘org-mouse.el’).

   Here is an example of a checkbox list.

     * TODO Organize party [2/4]
       - [-] call people [1/3]
         - [ ] Peter
         - [X] Sarah
         - [ ] Sam
       - [X] order food
       - [ ] think about what music to play
       - [X] talk to the neighbors

   Checkboxes work hierarchically, so if a checkbox item has children
that are checkboxes, toggling one of the children checkboxes will make
the parent checkbox reflect if none, some, or all of the children are
checked.

   The ‘[2/4]’ and ‘[1/3]’ in the first and second line are cookies
indicating how many checkboxes present in this entry have been checked
off, and the total number of checkboxes present.  This can give you an
idea on how many checkboxes remain, even without opening a folded entry.
The cookies can be placed into a headline or into (the first line of) a
plain list item.  Each cookie covers checkboxes of direct children
structurally below the headline/item on which the cookie appears(2).
You have to insert the cookie yourself by typing either ‘[/]’ or ‘[%]’.
With ‘[/]’ you get an ‘n out of m’ result, as in the examples above.
With ‘[%]’ you get information about the percentage of checkboxes
checked (in the above example, this would be ‘[50%]’ and ‘[33%]’,
respectively).  In a headline, a cookie can count either checkboxes
below the heading or TODO states of children, and it will display
whatever was changed last.  Set the property ‘COOKIE_DATA’ to either
‘checkbox’ or ‘todo’ to resolve this issue.

   If the current outline node has an ‘ORDERED’ property, checkboxes
must be checked off in sequence, and an error will be thrown if you try
to check off a box while there are unchecked boxes above it.

The following commands work with checkboxes:

‘C-c C-c     (org-toggle-checkbox)’
     Toggle checkbox status or (with prefix arg) checkbox presence at
     point.  With a single prefix argument, add an empty checkbox or
     remove the current one(3).  With a double prefix argument, set it
     to ‘[-]’, which is considered to be an intermediate state.
‘C-c C-x C-b     (org-toggle-checkbox)’
     Toggle checkbox status or (with prefix arg) checkbox presence at
     point.  With double prefix argument, set it to ‘[-]’, which is
     considered to be an intermediate state.
        − If there is an active region, toggle the first checkbox in the
          region and set all remaining boxes to the same status as the
          first.  With a prefix arg, add or remove the checkbox for all
          items in the region.
        − If the cursor is in a headline, toggle the state of the first
          checkbox in the region between this headline and the next—so
          _not_ the entire subtree—and propagate this new state to all
          other checkboxes in the same area.
        − If there is no active region, just toggle the checkbox at
          point.
‘M-S-<RET>     (org-insert-todo-heading)’
     Insert a new item with a checkbox.  This works only if the cursor
     is already in a plain list item (*note Plain lists::).
‘C-c C-x o     (org-toggle-ordered-property)’
     Toggle the ‘ORDERED’ property of the entry, to toggle if checkboxes
     must be checked off in sequence.  A property is used for this
     behavior because this should be local to the current entry, not
     inherited like a tag.  However, if you would like to track the
     value of this property with a tag for better visibility, customize
     ‘org-track-ordered-property-with-tag’.
‘C-c #     (org-update-statistics-cookies)’
     Update the statistics cookie in the current outline entry.  When
     called with a ‘C-u’ prefix, update the entire file.  Checkbox
     statistic cookies are updated automatically if you toggle
     checkboxes with ‘C-c C-c’ and make new ones with ‘M-S-<RET>’.  TODO
     statistics cookies update when changing TODO states.  If you delete
     boxes/entries or add/change them by hand, use this command to get
     things back into sync.

   ---------- Footnotes ----------

   (1) With the exception of description lists.  But you can allow it by
modifying ‘org-list-automatic-rules’ accordingly.

   (2) Set the option ‘org-checkbox-hierarchical-statistics’ if you want
such cookies to count all checkboxes below the cookie, not just those
belonging to direct children.

   (3) ‘C-u C-c C-c’ before the _first_ bullet in a list with no
checkbox will add checkboxes to the rest of the list.


File: org.info,  Node: Tags,  Next: Properties and columns,  Prev: TODO items,  Up: Top

6 Tags
******

An excellent way to implement labels and contexts for cross-correlating
information is to assign tags to headlines.  Org mode has extensive
support for tags.

   Every headline can contain a list of tags; they occur at the end of
the headline.  Tags are normal words containing letters, numbers, ‘_’,
and ‘@’.  Tags must be preceded and followed by a single colon, e.g.,
‘:work:’.  Several tags can be specified, as in ‘:work:urgent:’.  Tags
will by default be in bold face with the same color as the headline.
You may specify special faces for specific tags using the option
‘org-tag-faces’, in much the same way as you can for TODO keywords
(*note Faces for TODO keywords::).

* Menu:

* Tag inheritance::             Tags use the tree structure of the outline
* Setting tags::                How to assign tags to a headline
* Tag hierarchy::               Create a hierarchy of tags
* Tag searches::                Searching for combinations of tags


File: org.info,  Node: Tag inheritance,  Next: Setting tags,  Up: Tags

6.1 Tag inheritance
===================

Tags make use of the hierarchical structure of outline trees.  If a
heading has a certain tag, all subheadings will inherit the tag as well.
For example, in the list

     * Meeting with the French group      :work:
     ** Summary by Frank                  :boss:notes:
     *** TODO Prepare slides for him      :action:

the final heading will have the tags ‘:work:’, ‘:boss:’, ‘:notes:’, and
‘:action:’ even though the final heading is not explicitly marked with
all those tags.  You can also set tags that all entries in a file should
inherit just as if these tags were defined in a hypothetical level zero
that surrounds the entire file.  Use a line like this(1):

     #+FILETAGS: :Peter:Boss:Secret:

To limit tag inheritance to specific tags, use
‘org-tags-exclude-from-inheritance’.  To turn it off entirely, use
‘org-use-tag-inheritance’.

   When a headline matches during a tags search while tag inheritance is
turned on, all the sublevels in the same tree will (for a simple match
form) match as well(2).  The list of matches may then become very long.
If you only want to see the first tags match in a subtree, configure
‘org-tags-match-list-sublevels’ (not recommended).

   Tag inheritance is relevant when the agenda search tries to match a
tag, either in the ‘tags’ or ‘tags-todo’ agenda types.  In other agenda
types, ‘org-use-tag-inheritance’ has no effect.  Still, you may want to
have your tags correctly set in the agenda, so that tag filtering works
fine, with inherited tags.  Set ‘org-agenda-use-tag-inheritance’ to
control this: the default value includes all agenda types, but setting
this to ‘nil’ can really speed up agenda generation.

   ---------- Footnotes ----------

   (1) As with all these in-buffer settings, pressing ‘C-c C-c’
activates any changes in the line.

   (2) This is only true if the search does not involve more complex
tests including properties (*note Property searches::).


File: org.info,  Node: Setting tags,  Next: Tag hierarchy,  Prev: Tag inheritance,  Up: Tags

6.2 Setting tags
================

Tags can simply be typed into the buffer at the end of a headline.
After a colon, ‘M-<TAB>’ offers completion on tags.  There is also a
special command for inserting tags:

‘C-c C-q     (org-set-tags-command)’
     Enter new tags for the current headline.  Org mode will either
     offer completion or a special single-key interface for setting
     tags, see below.  After pressing <RET>, the tags will be inserted
     and aligned to ‘org-tags-column’.  When called with a ‘C-u’ prefix,
     all tags in the current buffer will be aligned to that column, just
     to make things look nice.  TAGS are automatically realigned after
     promotion, demotion, and TODO state changes (*note TODO basics::).

‘C-c C-c     (org-set-tags-command)’
     When the cursor is in a headline, this does the same as ‘C-c C-q’.

   Org supports tag insertion based on a _list of tags_.  By default
this list is constructed dynamically, containing all tags currently used
in the buffer.  You may also globally specify a hard list of tags with
the variable ‘org-tag-alist’.  Finally you can set the default tags for
a given file with lines like

     #+TAGS: @work @home @tennisclub
     #+TAGS: laptop car pc sailboat

   If you have globally defined your preferred set of tags using the
variable ‘org-tag-alist’, but would like to use a dynamic tag list in a
specific file, add an empty TAGS option line to that file:

     #+TAGS:

   If you have a preferred set of tags that you would like to use in
every file, in addition to those defined on a per-file basis by TAGS
option lines, then you may specify a list of tags with the variable
‘org-tag-persistent-alist’.  You may turn this off on a per-file basis
by adding a ‘#+STARTUP’ option line to that file:

     #+STARTUP: noptag

   By default Org mode uses the standard minibuffer completion
facilities for entering tags.  However, it also implements another,
quicker, tag selection method called _fast tag selection_.  This allows
you to select and deselect tags with just a single key press.  For this
to work well you should assign unique, case-sensitive, letters to most
of your commonly used tags.  You can do this globally by configuring the
variable ‘org-tag-alist’ in your Emacs init file.  For example, you may
find the need to tag many items in different files with ‘:@home:’.  In
this case you can set something like:

     (setq org-tag-alist '(("@work" . ?w) ("@home" . ?h) ("laptop" . ?l)))

If the tag is only relevant to the file you are working on, then you can
instead set the TAGS option line as:

     #+TAGS: @work(w)  @home(h)  @tennisclub(t)  laptop(l)  pc(p)

The tags interface will show the available tags in a splash window.  If
you want to start a new line after a specific tag, insert ‘\n’ into the
tag list

     #+TAGS: @work(w)  @home(h)  @tennisclub(t) \n laptop(l)  pc(p)

or write them in two lines:

     #+TAGS: @work(w)  @home(h)  @tennisclub(t)
     #+TAGS: laptop(l)  pc(p)

You can also group together tags that are mutually exclusive by using
braces, as in:

     #+TAGS: { @work(w)  @home(h)  @tennisclub(t) }  laptop(l)  pc(p)

you indicate that at most one of ‘@work’, ‘@home’, and ‘@tennisclub’
should be selected.  Multiple such groups are allowed.

Don’t forget to press ‘C-c C-c’ with the cursor in one of these lines to
activate any changes.

To set these mutually exclusive groups in the variable ‘org-tag-alist’,
you must use the dummy tags ‘:startgroup’ and ‘:endgroup’ instead of the
braces.  Similarly, you can use ‘:newline’ to indicate a line break.
The previous example would be set globally by the following
configuration:

     (setq org-tag-alist '((:startgroup . nil)
                           ("@work" . ?w) ("@home" . ?h)
                           ("@tennisclub" . ?t)
                           (:endgroup . nil)
                           ("laptop" . ?l) ("pc" . ?p)))

   If at least one tag has a selection key then pressing ‘C-c C-c’ will
automatically present you with a special interface, listing inherited
tags, the tags of the current headline, and a list of all valid tags
with corresponding keys(1).

   Pressing keys assigned to tags will add or remove them from the list
of tags in the current line.  Selecting a tag in a group of mutually
exclusive tags will turn off any other tags from that group.

   In this interface, you can also use the following special keys:

‘<TAB>’
     Enter a tag in the minibuffer, even if the tag is not in the
     predefined list.  You will be able to complete on all tags present
     in the buffer.  You can also add several tags: just separate them
     with a comma.

‘<SPC>’
     Clear all tags for this line.

‘<RET>’
     Accept the modified set.

‘C-g’
     Abort without installing changes.

‘q’
     If ‘q’ is not assigned to a tag, it aborts like ‘C-g’.

‘!’
     Turn off groups of mutually exclusive tags.  Use this to (as an
     exception) assign several tags from such a group.

‘C-c’
     Toggle auto-exit after the next change (see below).  If you are
     using expert mode, the first ‘C-c’ will display the selection
     window.

This method lets you assign tags to a headline with very few keys.  With
the above setup, you could clear the current tags and set ‘@home’,
‘laptop’ and ‘pc’ tags with just the following keys: ‘C-c C-c <SPC> h l
p <RET>’.  Switching from ‘@home’ to ‘@work’ would be done with ‘C-c C-c
w <RET>’ or alternatively with ‘C-c C-c C-c w’.  Adding the
non-predefined tag ‘Sarah’ could be done with ‘C-c C-c <TAB> S a r a h
<RET> <RET>’.

   If you find that most of the time you need only a single key press to
modify your list of tags, set ‘org-fast-tag-selection-single-key’.  Then
you no longer have to press <RET> to exit fast tag selection—it will
immediately exit after the first change.  If you then occasionally need
more keys, press ‘C-c’ to turn off auto-exit for the current tag
selection process (in effect: start selection with ‘C-c C-c C-c’ instead
of ‘C-c C-c’).  If you set the variable to the value ‘expert’, the
special window is not even shown for single-key tag selection, it comes
up only when you press an extra ‘C-c’.

   ---------- Footnotes ----------

   (1) Keys will automatically be assigned to tags which have no
configured keys.


File: org.info,  Node: Tag hierarchy,  Next: Tag searches,  Prev: Setting tags,  Up: Tags

6.3 Tag hierarchy
=================

Tags can be defined in hierarchies.  A tag can be defined as a _group
tag_ for a set of other tags.  The group tag can be seen as the “broader
term” for its set of tags.  Defining multiple _group tags_ and nesting
them creates a tag hierarchy.

   One use-case is to create a taxonomy of terms (tags) that can be used
to classify nodes in a document or set of documents.

   When you search for a group tag, it will return matches for all
members in the group and its subgroups.  In an agenda view, filtering by
a group tag will display or hide headlines tagged with at least one of
the members of the group or any of its subgroups.  This makes tag
searches and filters even more flexible.

   You can set group tags by using brackets and inserting a colon
between the group tag and its related tags—beware that all whitespaces
are mandatory so that Org can parse this line correctly:

     #+TAGS: [ GTD : Control Persp ]

   In this example, ‘GTD’ is the _group tag_ and it is related to two
other tags: ‘Control’, ‘Persp’.  Defining ‘Control’ and ‘Persp’ as group
tags creates a hierarchy of tags:

     #+TAGS: [ Control : Context Task ]
     #+TAGS: [ Persp : Vision Goal AOF Project ]

   That can conceptually be seen as a hierarchy of tags:

     - GTD
       - Persp
         - Vision
         - Goal
         - AOF
         - Project
       - Control
         - Context
         - Task

   You can use the ‘:startgrouptag’, ‘:grouptags’ and ‘:endgrouptag’
keyword directly when setting ‘org-tag-alist’ directly:

     (setq org-tag-alist '((:startgrouptag)
                           ("GTD")
                           (:grouptags)
                           ("Control")
                           ("Persp")
                           (:endgrouptag)
                           (:startgrouptag)
                           ("Control")
                           (:grouptags)
                           ("Context")
                           ("Task")
                           (:endgrouptag)))

   The tags in a group can be mutually exclusive if using the same group
syntax as is used for grouping mutually exclusive tags together; using
curly brackets.

     #+TAGS: { Context : @Home @Work @Call }

   When setting ‘org-tag-alist’ you can use ‘:startgroup’ & ‘:endgroup’
instead of ‘:startgrouptag’ & ‘:endgrouptag’ to make the tags mutually
exclusive.

   Furthermore, the members of a _group tag_ can also be regular
expressions, creating the possibility of a more dynamic and rule-based
tag structure.  The regular expressions in the group must be specified
within { }.  Here is an expanded example:

     #+TAGS: [ Vision : {V@.+} ]
     #+TAGS: [ Goal : {G@.+} ]
     #+TAGS: [ AOF : {AOF@.+} ]
     #+TAGS: [ Project : {P@.+} ]

   Searching for the tag ‘Project’ will now list all tags also including
regular expression matches for ‘P@.+’, and similarly for tag searches on
‘Vision’, ‘Goal’ and ‘AOF’.  For example, this would work well for a
project tagged with a common project-identifier, e.g.  ‘P@2014_OrgTags’.

   If you want to ignore group tags temporarily, toggle group tags
support with ‘org-toggle-tags-groups’, bound to ‘C-c C-x q’.  If you
want to disable tag groups completely, set ‘org-group-tags’ to ‘nil’.


File: org.info,  Node: Tag searches,  Prev: Tag hierarchy,  Up: Tags

6.4 Tag searches
================

Once a system of tags has been set up, it can be used to collect related
information into special lists.

‘C-c / m  or  C-c \     (org-match-sparse-tree)’
     Create a sparse tree with all headlines matching a
     tags/property/TODO search.  With a ‘C-u’ prefix argument, ignore
     headlines that are not a TODO line.  *Note Matching tags and
     properties::.
‘C-c a m     (org-tags-view)’
     Create a global list of tag matches from all agenda files.  *Note
     Matching tags and properties::.
‘C-c a M     (org-tags-view)’
     Create a global list of tag matches from all agenda files, but
     check only TODO items and force checking subitems (see the option
     ‘org-tags-match-list-sublevels’).

   These commands all prompt for a match string which allows basic
Boolean logic like ‘+boss+urgent-project1’, to find entries with tags
‘boss’ and ‘urgent’, but not ‘project1’, or ‘Kathy|Sally’ to find
entries tagged as ‘Kathy’ or ‘Sally’.  The full syntax of the search
string is rich and allows also matching against TODO keywords, entry
levels and properties.  For a complete description with many examples,
see *note Matching tags and properties::.


File: org.info,  Node: Properties and columns,  Next: Dates and times,  Prev: Tags,  Up: Top

7 Properties and columns
************************

A property is a key-value pair associated with an entry.  Properties can
be set so they are associated with a single entry, with every entry in a
tree, or with every entry in an Org mode file.

   There are two main applications for properties in Org mode.  First,
properties are like tags, but with a value.  Imagine maintaining a file
where you document bugs and plan releases for a piece of software.
Instead of using tags like ‘:release_1:’, ‘:release_2:’, you can use a
property, say ‘:Release:’, that in different subtrees has different
values, such as ‘1.0’ or ‘2.0’.  Second, you can use properties to
implement (very basic) database capabilities in an Org buffer.  Imagine
keeping track of your music CDs, where properties could be things such
as the album, artist, date of release, number of tracks, and so on.

   Properties can be conveniently edited and viewed in column view
(*note Column view::).

* Menu:

* Property syntax::             How properties are spelled out
* Special properties::          Access to other Org mode features
* Property searches::           Matching property values
* Property inheritance::        Passing values down the tree
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers


File: org.info,  Node: Property syntax,  Next: Special properties,  Up: Properties and columns

7.1 Property syntax
===================

Properties are key-value pairs.  When they are associated with a single
entry or with a tree they need to be inserted into a special drawer
(*note Drawers::) with the name ‘PROPERTIES’, which has to be located
right below a headline, and its planning line (*note Deadlines and
scheduling::) when applicable.  Each property is specified on a single
line, with the key (surrounded by colons) first, and the value after it.
Keys are case-insensitive.  Here is an example:

     * CD collection
     ** Classic
     *** Goldberg Variations
         :PROPERTIES:
         :Title:     Goldberg Variations
         :Composer:  J.S. Bach
         :Artist:    Glen Gould
         :Publisher: Deutsche Grammophon
         :NDisks:    1
         :END:

   Depending on the value of ‘org-use-property-inheritance’, a property
set this way will either be associated with a single entry, or the
subtree defined by the entry, see *note Property inheritance::.

   You may define the allowed values for a particular property ‘:Xyz:’
by setting a property ‘:Xyz_ALL:’.  This special property is
_inherited_, so if you set it in a level 1 entry, it will apply to the
entire tree.  When allowed values are defined, setting the corresponding
property becomes easier and is less prone to typing errors.  For the
example with the CD collection, we can predefine publishers and the
number of disks in a box like this:

     * CD collection
       :PROPERTIES:
       :NDisks_ALL:  1 2 3 4
       :Publisher_ALL: "Deutsche Grammophon" Philips EMI
       :END:

   If you want to set properties that can be inherited by any entry in a
file, use a line like
     #+PROPERTY: NDisks_ALL 1 2 3 4

   Contrary to properties set from a special drawer, you have to refresh
the buffer with ‘C-c C-c’ to activate this change.

   If you want to add to the value of an existing property, append a ‘+’
to the property name.  The following results in the property ‘var’
having the value “foo=1 bar=2”.
     #+PROPERTY: var  foo=1
     #+PROPERTY: var+ bar=2

   It is also possible to add to the values of inherited properties.
The following results in the ‘genres’ property having the value “Classic
Baroque” under the ‘Goldberg Variations’ subtree.
     * CD collection
     ** Classic
         :PROPERTIES:
         :GENRES: Classic
         :END:
     *** Goldberg Variations
         :PROPERTIES:
         :Title:     Goldberg Variations
         :Composer:  J.S. Bach
         :Artist:    Glen Gould
         :Publisher: Deutsche Grammophon
         :NDisks:    1
         :GENRES+:   Baroque
         :END:
   Note that a property can only have one entry per Drawer.

   Property values set with the global variable ‘org-global-properties’
can be inherited by all entries in all Org files.

The following commands help to work with properties:

‘M-<TAB>     (pcomplete)’
     After an initial colon in a line, complete property keys.  All keys
     used in the current file will be offered as possible completions.
‘C-c C-x p     (org-set-property)’
     Set a property.  This prompts for a property name and a value.  If
     necessary, the property drawer is created as well.
‘C-u M-x org-insert-drawer <RET>’
     Insert a property drawer into the current entry.  The drawer will
     be inserted early in the entry, but after the lines with planning
     information like deadlines.
‘C-c C-c     (org-property-action)’
     With the cursor in a property drawer, this executes property
     commands.
‘C-c C-c s     (org-set-property)’
     Set a property in the current entry.  Both the property and the
     value can be inserted using completion.
‘S-<RIGHT>     (org-property-next-allowed-value)’
‘S-<LEFT>     (org-property-previous-allowed-value)’
     Switch property at point to the next/previous allowed value.
‘C-c C-c d     (org-delete-property)’
     Remove a property from the current entry.
‘C-c C-c D     (org-delete-property-globally)’
     Globally remove a property, from all entries in the current file.
‘C-c C-c c     (org-compute-property-at-point)’
     Compute the property at point, using the operator and scope from
     the nearest column format definition.


File: org.info,  Node: Special properties,  Next: Property searches,  Prev: Property syntax,  Up: Properties and columns

7.2 Special properties
======================

Special properties provide an alternative access method to Org mode
features, like the TODO state or the priority of an entry, discussed in
the previous chapters.  This interface exists so that you can include
these states in a column view (*note Column view::), or to use them in
queries.  The following property names are special and should not be
used as keys in the properties drawer:

     ALLTAGS      All tags, including inherited ones.
     BLOCKED      "t" if task is currently blocked by children or siblings.
     CLOCKSUM     The sum of CLOCK intervals in the subtree.  ‘org-clock-sum’
                  must be run first to compute the values in the current buffer.
     CLOCKSUM_T   The sum of CLOCK intervals in the subtree for today.
                  ‘org-clock-sum-today’ must be run first to compute the
                  values in the current buffer.
     CLOSED       When was this entry closed?
     DEADLINE     The deadline time string, without the angular brackets.
     FILE         The filename the entry is located in.
     ITEM         The headline of the entry.
     PRIORITY     The priority of the entry, a string with a single letter.
     SCHEDULED    The scheduling timestamp, without the angular brackets.
     TAGS         The tags defined directly in the headline.
     TIMESTAMP    The first keyword-less timestamp in the entry.
     TIMESTAMP_IA The first inactive timestamp in the entry.
     TODO         The TODO keyword of the entry.


File: org.info,  Node: Property searches,  Next: Property inheritance,  Prev: Special properties,  Up: Properties and columns

7.3 Property searches
=====================

To create sparse trees and special lists with selection based on
properties, the same commands are used as for tag searches (*note Tag
searches::).

‘C-c / m  or  C-c \     (org-match-sparse-tree)’
     Create a sparse tree with all matching entries.  With a ‘C-u’
     prefix argument, ignore headlines that are not a TODO line.
‘C-c a m     (org-tags-view)’
     Create a global list of tag/property matches from all agenda files.
     *Note Matching tags and properties::.
‘C-c a M     (org-tags-view)’
     Create a global list of tag matches from all agenda files, but
     check only TODO items and force checking of subitems (see the
     option ‘org-tags-match-list-sublevels’).

   The syntax for the search string is described in *note Matching tags
and properties::.

   There is also a special command for creating sparse trees based on a
single property:

‘C-c / p’
     Create a sparse tree based on the value of a property.  This first
     prompts for the name of a property, and then for a value.  A sparse
     tree is created with all entries that define this property with the
     given value.  If you enclose the value in curly braces, it is
     interpreted as a regular expression and matched against the
     property values.


File: org.info,  Node: Property inheritance,  Next: Column view,  Prev: Property searches,  Up: Properties and columns

7.4 Property Inheritance
========================

The outline structure of Org mode documents lends itself to an
inheritance model of properties: if the parent in a tree has a certain
property, the children can inherit this property.  Org mode does not
turn this on by default, because it can slow down property searches
significantly and is often not needed.  However, if you find inheritance
useful, you can turn it on by setting the variable
‘org-use-property-inheritance’.  It may be set to ‘t’ to make all
properties inherited from the parent, to a list of properties that
should be inherited, or to a regular expression that matches inherited
properties.  If a property has the value ‘nil’, this is interpreted as
an explicit undefine of the property, so that inheritance search will
stop at this value and return ‘nil’.

   Org mode has a few properties for which inheritance is hard-coded, at
least for the special applications for which they are used:

‘COLUMNS’
     The ‘:COLUMNS:’ property defines the format of column view (*note
     Column view::).  It is inherited in the sense that the level where
     a ‘:COLUMNS:’ property is defined is used as the starting point for
     a column view table, independently of the location in the subtree
     from where columns view is turned on.
‘CATEGORY’
     For agenda view, a category set through a ‘:CATEGORY:’ property
     applies to the entire subtree.
‘ARCHIVE’
     For archiving, the ‘:ARCHIVE:’ property may define the archive
     location for the entire subtree (*note Moving subtrees::).
‘LOGGING’
     The ‘LOGGING’ property may define logging settings for an entry or
     a subtree (*note Tracking TODO state changes::).


File: org.info,  Node: Column view,  Next: Property API,  Prev: Property inheritance,  Up: Properties and columns

7.5 Column view
===============

A great way to view and edit properties in an outline tree is _column
view_.  In column view, each outline node is turned into a table row.
Columns in this table provide access to properties of the entries.  Org
mode implements columns by overlaying a tabular structure over the
headline of each item.  While the headlines have been turned into a
table row, you can still change the visibility of the outline tree.  For
example, you get a compact table by switching to CONTENTS view (‘S-<TAB>
S-<TAB>’, or simply ‘c’ while column view is active), but you can still
open, read, and edit the entry below each headline.  Or, you can switch
to column view after executing a sparse tree command and in this way get
a table only for the selected items.  Column view also works in agenda
buffers (*note Agenda views::) where queries have collected selected
items, possibly from a number of files.

* Menu:

* Defining columns::            The COLUMNS format property
* Using column view::           How to create and use column view
* Capturing column view::       A dynamic block for column view


File: org.info,  Node: Defining columns,  Next: Using column view,  Up: Column view

7.5.1 Defining columns
----------------------

Setting up a column view first requires defining the columns.  This is
done by defining a column format line.

* Menu:

* Scope of column definitions::  Where defined, where valid?
* Column attributes::           Appearance and content of a column


File: org.info,  Node: Scope of column definitions,  Next: Column attributes,  Up: Defining columns

7.5.1.1 Scope of column definitions
...................................

To define a column format for an entire file, use a line like

     #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO

   To specify a format that only applies to a specific tree, add a
‘:COLUMNS:’ property to the top node of that tree, for example:

     ** Top node for columns view
        :PROPERTIES:
        :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
        :END:

   If a ‘:COLUMNS:’ property is present in an entry, it defines columns
for the entry itself, and for the entire subtree below it.  Since the
column definition is part of the hierarchical structure of the document,
you can define columns on level 1 that are general enough for all
sublevels, and more specific columns further down, when you edit a
deeper part of the tree.


File: org.info,  Node: Column attributes,  Prev: Scope of column definitions,  Up: Defining columns

7.5.1.2 Column attributes
.........................

A column definition sets the attributes of a column.  The general
definition looks like this:

      %[WIDTH]PROPERTY[(TITLE)][{SUMMARY-TYPE}]

Except for the percent sign and the property name, all items are
optional.  The individual parts have the following meaning:

     WIDTH           An integer specifying the width of the column in characters.
                     If omitted, the width will be determined automatically.
     PROPERTY        The property that should be edited in this column.
                     Special properties representing meta data are allowed here
                     as well (*note Special properties::)
     TITLE           The header text for the column.  If omitted, the property
                     name is used.
     {SUMMARY-TYPE}  The summary type.  If specified, the column values for
                     parent nodes are computed from the children(1).
                     Supported summary types are:
                     {+}       Sum numbers in this column.
                     {+;%.1f}  Like ‘+’, but format result with ‘%.1f’.
                     {$}       Currency, short for ‘+;%.2f’.
                     {min}     Smallest number in column.
                     {max}     Largest number.
                     {mean}    Arithmetic mean of numbers.
                     {X}       Checkbox status, ‘[X]’ if all children are ‘[X]’.
                     {X/}      Checkbox status, ‘[n/m]’.
                     {X%}      Checkbox status, ‘[n%]’.
                     {:}       Sum times, HH:MM, plain numbers are
                     hours(2).
                     {:min}    Smallest time value in column.
                     {:max}    Largest time value.
                     {:mean}   Arithmetic mean of time values.
                     {@min}    Minimum age(3) (in
                     days/hours/mins/seconds).
                     {@max}    Maximum age (in days/hours/mins/seconds).
                     {@mean}   Arithmetic mean of ages (in days/hours/mins/seconds).
                     {est+}    Add ‘low-high’ estimates.

   The ‘est+’ summary type requires further explanation.  It is used for
combining estimates, expressed as ‘low-high’ ranges or plain numbers.
For example, instead of estimating a particular task will take 5 days,
you might estimate it as 5–6 days if you’re fairly confident you know
how much work is required, or 1–10 days if you don’t really know what
needs to be done.  Both ranges average at 5.5 days, but the first
represents a more predictable delivery.

   When combining a set of such estimates, simply adding the lows and
highs produces an unrealistically wide result.  Instead, ‘est+’ adds the
statistical mean and variance of the sub-tasks, generating a final
estimate from the sum.  For example, suppose you had ten tasks, each of
which was estimated at 0.5 to 2 days of work.  Straight addition
produces an estimate of 5 to 20 days, representing what to expect if
everything goes either extremely well or extremely poorly.  In contrast,
‘est+’ estimates the full job more realistically, at 10–15 days.

   Numbers are right-aligned when a format specifier with an explicit
width like ‘%5d’ or ‘%5.1f’ is used.

   You can also define custom summary types by setting
‘org-columns-summary-types’, which see.

   Here is an example for a complete columns definition, along with
allowed values.

     :COLUMNS:  %25ITEM %9Approved(Approved?){X} %Owner %11Status \(4)
                        %10Time_Estimate{:} %CLOCKSUM %CLOCKSUM_T
     :Owner_ALL:    Tammy Mark Karl Lisa Don
     :Status_ALL:   "In progress" "Not started yet" "Finished" ""
     :Approved_ALL: "[ ]" "[X]"

The first column, ‘%25ITEM’, means the first 25 characters of the item
itself, i.e., of the headline.  You probably always should start the
column definition with the ‘ITEM’ specifier.  The other specifiers
create columns ‘Owner’ with a list of names as allowed values, for
‘Status’ with four different possible values, and for a checkbox field
‘Approved’.  When no width is given after the ‘%’ character, the column
will be exactly as wide as it needs to be in order to fully display all
values.  The ‘Approved’ column does have a modified title (‘Approved?’,
with a question mark).  Summaries will be created for the
‘Time_Estimate’ column by adding time duration expressions like HH:MM,
and for the ‘Approved’ column, by providing an ‘[X]’ status if all
children have been checked.  The ‘CLOCKSUM’ and ‘CLOCKSUM_T’ columns are
special, they lists the sums of CLOCK intervals in the subtree, either
for all clocks or just for today.

   ---------- Footnotes ----------

   (1) If more than one summary type apply to the property, the parent
values are computed according to the first of them.

   (2) A time can also be a duration, using effort modifiers defined in
‘org-effort-durations’, e.g., ‘3d 1h’.  If any value in the column is as
such, the summary will also be an effort duration.

   (3) An age is defined as a duration since a given time-stamp (*note
Timestamps::).  It can also be expressed as days, hours, minutes and
seconds, identified by ‘d’, ‘h’, ‘m’ and ‘s’ suffixes, all mandatory,
e.g., ‘0d 13h 0m 10s’.

   (4) Please note that the COLUMNS definition must be on a single
line—it is wrapped here only because of formatting constraints.


File: org.info,  Node: Using column view,  Next: Capturing column view,  Prev: Defining columns,  Up: Column view

7.5.2 Using column view
-----------------------

     Turning column view on and off
     ..............................

‘C-c C-x C-c     (org-columns)’
     Turn on column view.  If the cursor is before the first headline in
     the file, or the function called with the universal prefix
     argument, column view is turned on for the entire file, using the
     ‘#+COLUMNS’ definition.  If the cursor is somewhere inside the
     outline, this command searches the hierarchy, up from point, for a
     ‘:COLUMNS:’ property that defines a format.  When one is found, the
     column view table is established for the tree starting at the entry
     that contains the ‘:COLUMNS:’ property.  If no such property is
     found, the format is taken from the ‘#+COLUMNS’ line or from the
     variable ‘org-columns-default-format’, and column view is
     established for the current entry and its subtree.
‘r     (org-columns-redo)’
     Recreate the column view, to include recent changes made in the
     buffer.
‘g     (org-columns-redo)’
     Same as ‘r’.
‘q     (org-columns-quit)’
     Exit column view.

     Editing values
     ..............

‘<LEFT> <RIGHT> <UP> <DOWN>’
     Move through the column view from field to field.
‘S-<LEFT>/<RIGHT>’
     Switch to the next/previous allowed value of the field.  For this,
     you have to have specified allowed values for a property.
‘1..9,0’
     Directly select the Nth allowed value, ‘0’ selects the 10th value.
‘n     (org-columns-next-allowed-value)’
‘p     (org-columns-previous-allowed-value)’
     Same as ‘S-<LEFT>/<RIGHT>’
‘e     (org-columns-edit-value)’
     Edit the property at point.  For the special properties, this will
     invoke the same interface that you normally use to change that
     property.  For example, when editing a TAGS property, the tag
     completion or fast selection interface will pop up.
‘C-c C-c     (org-columns-set-tags-or-toggle)’
     When there is a checkbox at point, toggle it.
‘v     (org-columns-show-value)’
     View the full value of this property.  This is useful if the width
     of the column is smaller than that of the value.
‘a     (org-columns-edit-allowed)’
     Edit the list of allowed values for this property.  If the list is
     found in the hierarchy, the modified value is stored there.  If no
     list is found, the new value is stored in the first entry that is
     part of the current column view.

     Modifying the table structure
     .............................

‘<     (org-columns-narrow)’
‘>     (org-columns-widen)’
     Make the column narrower/wider by one character.
‘S-M-<RIGHT>     (org-columns-new)’
     Insert a new column, to the left of the current column.
‘S-M-<LEFT>     (org-columns-delete)’
     Delete the current column.


File: org.info,  Node: Capturing column view,  Prev: Using column view,  Up: Column view

7.5.3 Capturing column view
---------------------------

Since column view is just an overlay over a buffer, it cannot be
exported or printed directly.  If you want to capture a column view, use
a ‘columnview’ dynamic block (*note Dynamic blocks::).  The frame of
this block looks like this:

     * The column view
     #+BEGIN: columnview :hlines 1 :id "label"

     #+END:

This dynamic block has the following parameters:

‘:id’
     This is the most important parameter.  Column view is a feature
     that is often localized to a certain (sub)tree, and the capture
     block might be at a different location in the file.  To identify
     the tree whose view to capture, you can use 4 values:
          local     use the tree in which the capture block is located
          global    make a global view, including all headings in the file
          "file:PATH-TO-FILE"
                    run column view at the top of this file
          "ID"      call column view in the tree that has an ‘:ID:’
                    property with the value label.  You can use
                    ‘M-x org-id-copy <RET>’ to create a globally unique ‘ID’ for
                    the current entry and copy it to the kill-ring.
‘:hlines’
     When ‘t’, insert an hline after every line.  When a number N,
     insert an hline before each headline with level ‘<= N’.
‘:vlines’
     When set to ‘t’, force column groups to get vertical lines.
‘:maxlevel’
     When set to a number, don’t capture entries below this level.
‘:skip-empty-rows’
     When set to ‘t’, skip rows where the only non-empty specifier of
     the column view is ‘ITEM’.
‘:indent’
     When non-‘nil’, indent each ‘ITEM’ field according to its level.

The following commands insert or update the dynamic block:

‘C-c C-x i     (org-insert-columns-dblock)’
     Insert a dynamic block capturing a column view.  You will be
     prompted for the scope or ‘ID’ of the view.
‘C-c C-c  or  C-c C-x C-u     (org-dblock-update)’
     Update dynamic block at point.
‘C-u C-c C-x C-u     (org-update-all-dblocks)’
     Update all dynamic blocks (*note Dynamic blocks::).  This is useful
     if you have several clock table blocks, column-capturing blocks or
     other dynamic blocks in a buffer.

   You can add formulas to the column view table and you may add
plotting instructions in front of the table—these will survive an update
of the block.  If there is a ‘#+TBLFM:’ after the table, the table will
actually be recalculated automatically after an update.

   An alternative way to capture and process property values into a
table is provided by Eric Schulte’s ‘org-collector.el’ which is a
contributed package(1).  It provides a general API to collect properties
from entries in a certain scope, and arbitrary Lisp expressions to
process these values before inserting them into a table or a dynamic
block.

   ---------- Footnotes ----------

   (1) Contributed packages are not part of Emacs, but are distributed
with the main distribution of Org (visit <https://orgmode.org>).


File: org.info,  Node: Property API,  Prev: Column view,  Up: Properties and columns

7.6 The Property API
====================

There is a full API for accessing and changing properties.  This API can
be used by Emacs Lisp programs to work with properties and to implement
features based on them.  For more information see *note Using the
property API::.


File: org.info,  Node: Dates and times,  Next: Capture - Refile - Archive,  Prev: Properties and columns,  Up: Top

8 Dates and times
*****************

To assist project planning, TODO items can be labeled with a date and/or
a time.  The specially formatted string carrying the date and time
information is called a _timestamp_ in Org mode.  This may be a little
confusing because timestamp is often used to indicate when something was
created or last changed.  However, in Org mode this term is used in a
much wider sense.

* Menu:

* Timestamps::                  Assigning a time to a tree entry
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
* Clocking work time::          Tracking how long you spend on a task
* Effort estimates::            Planning work effort in advance
* Timers::                      Notes with a running timer


File: org.info,  Node: Timestamps,  Next: Creating timestamps,  Up: Dates and times

8.1 Timestamps, deadlines, and scheduling
=========================================

A timestamp is a specification of a date (possibly with a time or a
range of times) in a special format, either ‘<2003-09-16 Tue>’(1) or
‘<2003-09-16 Tue 09:39>’ or ‘<2003-09-16 Tue 12:00-12:30>’(2).  A
timestamp can appear anywhere in the headline or body of an Org tree
entry.  Its presence causes entries to be shown on specific dates in the
agenda (*note Weekly/daily agenda::).  We distinguish:

PLAIN TIMESTAMP; EVENT; APPOINTMENT
     A simple timestamp just assigns a date/time to an item.  This is
     just like writing down an appointment or event in a paper agenda.
     In the agenda display, the headline of an entry associated with a
     plain timestamp will be shown exactly on that date.

          * Meet Peter at the movies
            <2006-11-01 Wed 19:15>
          * Discussion on climate change
            <2006-11-02 Thu 20:00-22:00>

TIMESTAMP WITH REPEATER INTERVAL
     A timestamp may contain a _repeater interval_, indicating that it
     applies not only on the given date, but again and again after a
     certain interval of N days (d), weeks (w), months (m), or years
     (y).  The following will show up in the agenda every Wednesday:

          * Pick up Sam at school
            <2007-05-16 Wed 12:30 +1w>

DIARY-STYLE SEXP ENTRIES
     For more complex date specifications, Org mode supports using the
     special sexp diary entries implemented in the Emacs calendar/diary
     package(3).  For example with optional time

          * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
            <%%(diary-float t 4 2)>

TIME/DATE RANGE
     Two timestamps connected by ‘--’ denote a range.  The headline will
     be shown on the first and last day of the range, and on any dates
     that are displayed and fall in the range.  Here is an example:

          ** Meeting in Amsterdam
             <2004-08-23 Mon>--<2004-08-26 Thu>

INACTIVE TIMESTAMP
     Just like a plain timestamp, but with square brackets instead of
     angular ones.  These timestamps are inactive in the sense that they
     do _not_ trigger an entry to show up in the agenda.

          * Gillian comes late for the fifth time
            [2006-11-01 Wed]

   ---------- Footnotes ----------

   (1) In this simplest form, the day name is optional when you type the
date yourself.  However, any dates inserted or modified by Org will add
that day name, for reading convenience.

   (2) This is inspired by the standard ISO 8601 date/time format.  To
use an alternative format, see *note Custom time format::.

   (3) When working with the standard diary sexp functions, you need to
be very careful with the order of the arguments.  That order depends
evilly on the variable ‘calendar-date-style’ (or, for older Emacs
versions, ‘european-calendar-style’).  For example, to specify a date
December 1, 2005, the call might look like ‘(diary-date 12 1 2005)’ or
‘(diary-date 1 12 2005)’ or ‘(diary-date 2005 12 1)’, depending on the
settings.  This has been the source of much confusion.  Org mode users
can resort to special versions of these functions like ‘org-date’ or
‘org-anniversary’.  These work just like the corresponding ‘diary-’
functions, but with stable ISO order of arguments (year, month, day)
wherever applicable, independent of the value of ‘calendar-date-style’.


File: org.info,  Node: Creating timestamps,  Next: Deadlines and scheduling,  Prev: Timestamps,  Up: Dates and times

8.2 Creating timestamps
=======================

For Org mode to recognize timestamps, they need to be in the specific
format.  All commands listed below produce timestamps in the correct
format.

‘C-c .     (org-time-stamp)’
     Prompt for a date and insert a corresponding timestamp.  When the
     cursor is at an existing timestamp in the buffer, the command is
     used to modify this timestamp instead of inserting a new one.  When
     this command is used twice in succession, a time range is inserted.
‘C-c !     (org-time-stamp-inactive)’
     Like ‘C-c .’, but insert an inactive timestamp that will not cause
     an agenda entry.
‘C-u C-c .’
‘C-u C-c !’
     Like ‘C-c .’ and ‘C-c !’, but use the alternative format which
     contains date and time.  The default time can be rounded to
     multiples of 5 minutes, see the option
     ‘org-time-stamp-rounding-minutes’.
‘C-c C-c’
     Normalize timestamp, insert/fix day name if missing or wrong.
‘C-c <     (org-date-from-calendar)’
     Insert a timestamp corresponding to the cursor date in the
     Calendar.
‘C-c >     (org-goto-calendar)’
     Access the Emacs calendar for the current date.  If there is a
     timestamp in the current line, go to the corresponding date
     instead.
‘C-c C-o     (org-open-at-point)’
     Access the agenda for the date given by the timestamp or -range at
     point (*note Weekly/daily agenda::).
‘S-<LEFT>     (org-timestamp-down-day)’
‘S-<RIGHT>     (org-timestamp-up-day)’
     Change date at cursor by one day.  These key bindings conflict with
     shift-selection and related modes (*note Conflicts::).
‘S-<UP>     (org-timestamp-up)’
‘S-<DOWN>     (org-timestamp-down-down)’
     Change the item under the cursor in a timestamp.  The cursor can be
     on a year, month, day, hour or minute.  When the timestamp contains
     a time range like ‘15:30-16:30’, modifying the first time will also
     shift the second, shifting the time block with constant length.  To
     change the length, modify the second time.  Note that if the cursor
     is in a headline and not at a timestamp, these same keys modify the
     priority of an item.  (*note Priorities::).  The key bindings also
     conflict with shift-selection and related modes (*note
     Conflicts::).
‘C-c C-y     (org-evaluate-time-range)’
     Evaluate a time range by computing the difference between start and
     end.  With a prefix argument, insert result after the time range
     (in a table: into the following column).

* Menu:

* The date/time prompt::        How Org mode helps you entering date and time
* Custom time format::          Making dates look different


File: org.info,  Node: The date/time prompt,  Next: Custom time format,  Up: Creating timestamps

8.2.1 The date/time prompt
--------------------------

When Org mode prompts for a date/time, the default is shown in default
date/time format, and the prompt therefore seems to ask for a specific
format.  But it will in fact accept date/time information in a variety
of formats.  Generally, the information should start at the beginning of
the string.  Org mode will find whatever information is in there and
derive anything you have not specified from the _default date and time_.
The default is usually the current date and time, but when modifying an
existing timestamp, or when entering the second stamp of a range, it is
taken from the stamp in the buffer.  When filling in information, Org
mode assumes that most of the time you will want to enter a date in the
future: if you omit the month/year and the given day/month is before
today, it will assume that you mean a future date(1).  If the date has
been automatically shifted into the future, the time prompt will show
this with ‘(=>F).’

   For example, let’s assume that today is June 13, 2006.  Here is how
various inputs will be interpreted, the items filled in by Org mode are
in bold.

     3-2-5         ⇒ 2003-02-05
     2/5/3         ⇒ 2003-02-05
     14            ⇒ 2006-06-14
     12            ⇒ 2006-07-12
     2/5           ⇒ 2007-02-05
     Fri           ⇒ nearest Friday after the default date
     sep 15        ⇒ 2006-09-15
     feb 15        ⇒ 2007-02-15
     sep 12 9      ⇒ 2009-09-12
     12:45         ⇒ 2006-06-13 12:45
     22 sept 0:34  ⇒ 2006-09-22 00:34
     w4            ⇒ ISO week four of the current year 2006
     2012 w4 fri   ⇒ Friday of ISO week 4 in 2012
     2012-w04-5    ⇒ Same as above

   Furthermore you can specify a relative date by giving, as the _first_
thing in the input: a plus/minus sign, a number and a letter ([hdwmy])
to indicate change in hours, days, weeks, months, or years.  With a
single plus or minus, the date is always relative to today.  With a
double plus or minus, it is relative to the default date.  If instead of
a single letter, you use the abbreviation of day name, the date will be
the Nth such day, e.g.:

     +0            ⇒ today
     .             ⇒ today
     +4d           ⇒ four days from today
     +4            ⇒ same as above
     +2w           ⇒ two weeks from today
     ++5           ⇒ five days from default date
     +2tue         ⇒ second Tuesday from now
     -wed          ⇒ last Wednesday

   The function understands English month and weekday abbreviations.  If
you want to use unabbreviated names and/or other languages, configure
the variables ‘parse-time-months’ and ‘parse-time-weekdays’.

   Not all dates can be represented in a given Emacs implementation.  By
default Org mode forces dates into the compatibility range 1970–2037
which works on all Emacs implementations.  If you want to use dates
outside of this range, read the docstring of the variable
‘org-read-date-force-compatible-dates’.

   You can specify a time range by giving start and end times or by
giving a start time and a duration (in HH:MM format).  Use one or two
dash(es) as the separator in the former case and use ’+’ as the
separator in the latter case, e.g.:

     11am-1:15pm    ⇒ 11:00-13:15
     11am--1:15pm   ⇒ same as above
     11am+2:15      ⇒ same as above

   Parallel to the minibuffer prompt, a calendar is popped up(2).  When
you exit the date prompt, either by clicking on a date in the calendar,
or by pressing <RET>, the date selected in the calendar will be combined
with the information entered at the prompt.  You can control the
calendar fully from the minibuffer:

     <RET>              Choose date at cursor in calendar.
     mouse-1            Select date by clicking on it.
     S-<RIGHT>/<LEFT>   One day forward/backward.
     S-<DOWN>/<UP>      One week forward/backward.
     M-S-<RIGHT>/<LEFT> One month forward/backward.
     > / <              Scroll calendar forward/backward by one month.
     M-v / C-v          Scroll calendar forward/backward by 3 months.
     M-S-<DOWN>/<UP>    Scroll calendar forward/backward by one year.

   The actions of the date/time prompt may seem complex, but I assure
you they will grow on you, and you will start getting annoyed by pretty
much any other way of entering a date/time out there.  To help you
understand what is going on, the current interpretation of your input
will be displayed live in the minibuffer(3).

   ---------- Footnotes ----------

   (1) See the variable ‘org-read-date-prefer-future’.  You may set that
variable to the symbol ‘time’ to even make a time before now shift the
date to tomorrow.

   (2) If you don’t need/want the calendar, configure the variable
‘org-popup-calendar-for-date-prompt’.

   (3) If you find this distracting, turn the display off with
‘org-read-date-display-live’.


File: org.info,  Node: Custom time format,  Prev: The date/time prompt,  Up: Creating timestamps

8.2.2 Custom time format
------------------------

Org mode uses the standard ISO notation for dates and times as it is
defined in ISO 8601.  If you cannot get used to this and require another
representation of date and time to keep you happy, you can get it by
customizing the options ‘org-display-custom-times’ and
‘org-time-stamp-custom-formats’.

‘C-c C-x C-t     (org-toggle-time-stamp-overlays)’
     Toggle the display of custom formats for dates and times.

Org mode needs the default format for scanning, so the custom date/time
format does not _replace_ the default format—instead it is put _over_
the default format using text properties.  This has the following
consequences:
   • You cannot place the cursor onto a timestamp anymore, only before
     or after.
   • The ‘S-<UP>/<DOWN>’ keys can no longer be used to adjust each
     component of a timestamp.  If the cursor is at the beginning of the
     stamp, ‘S-<UP>/<DOWN>’ will change the stamp by one day, just like
     ‘S-<LEFT>/<RIGHT>’.  At the end of the stamp, the time will be
     changed by one minute.
   • If the timestamp contains a range of clock times or a repeater,
     these will not be overlaid, but remain in the buffer as they were.
   • When you delete a timestamp character-by-character, it will only
     disappear from the buffer after _all_ (invisible) characters
     belonging to the ISO timestamp have been removed.
   • If the custom timestamp format is longer than the default and you
     are using dates in tables, table alignment will be messed up.  If
     the custom format is shorter, things do work as expected.


File: org.info,  Node: Deadlines and scheduling,  Next: Clocking work time,  Prev: Creating timestamps,  Up: Dates and times

8.3 Deadlines and scheduling
============================

A timestamp may be preceded by special keywords to facilitate planning.
Both the timestamp and the keyword have to be positioned immediately
after the task they refer to.

DEADLINE

     Meaning: the task (most likely a TODO item, though not necessarily)
     is supposed to be finished on that date.

     On the deadline date, the task will be listed in the agenda.  In
     addition, the agenda for _today_ will carry a warning about the
     approaching or missed deadline, starting
     ‘org-deadline-warning-days’ before the due date, and continuing
     until the entry is marked DONE.  An example:

          *** TODO write article about the Earth for the Guide
              DEADLINE: <2004-02-29 Sun>
              The editor in charge is [[bbdb:Ford Prefect]]

     You can specify a different lead time for warnings for a specific
     deadline using the following syntax.  Here is an example with a
     warning period of 5 days ‘DEADLINE: <2004-02-29 Sun -5d>’.  This
     warning is deactivated if the task gets scheduled and you set
     ‘org-agenda-skip-deadline-prewarning-if-scheduled’ to ‘t’.

SCHEDULED

     Meaning: you are planning to start working on that task on the
     given date.

     The headline will be listed under the given date(1).  In addition,
     a reminder that the scheduled date has passed will be present in
     the compilation for _today_, until the entry is marked DONE, i.e.,
     the task will automatically be forwarded until completed.

          *** TODO Call Trillian for a date on New Years Eve.
              SCHEDULED: <2004-12-25 Sat>

     If you want to _delay_ the display of this task in the agenda, use
     ‘SCHEDULED: <2004-12-25 Sat -2d>’: the task is still scheduled on
     the 25th but will appear two days later.  In case the task contains
     a repeater, the delay is considered to affect all occurrences; if
     you want the delay to only affect the first scheduled occurrence of
     the task, use ‘--2d’ instead.  See ‘org-scheduled-delay-days’ and
     ‘org-agenda-skip-scheduled-delay-if-deadline’ for details on how to
     control this globally or per agenda.

     Important: Scheduling an item in Org mode should not be understood
     in the same way that we understand scheduling a meeting.  Setting a
     date for a meeting is just a simple appointment, you should mark
     this entry with a simple plain timestamp, to get this item shown on
     the date where it applies.  This is a frequent misunderstanding by
     Org users.  In Org mode, scheduling means setting a date when you
     want to start working on an action item.

   You may use timestamps with repeaters in scheduling and deadline
entries.  Org mode will issue early and late warnings based on the
assumption that the timestamp represents the nearest instance of the
repeater.  However, the use of diary sexp entries like ‘<%%(diary-float
t 42)>’ in scheduling and deadline timestamps is limited.  Org mode does
not know enough about the internals of each sexp function to issue early
and late warnings.  However, it will show the item on each day where the
sexp entry matches.

* Menu:

* Inserting deadline/schedule::  Planning items
* Repeated tasks::              Items that show up again and again

   ---------- Footnotes ----------

   (1) It will still be listed on that date after it has been marked
DONE.  If you don’t like this, set the variable
‘org-agenda-skip-scheduled-if-done’.


File: org.info,  Node: Inserting deadline/schedule,  Next: Repeated tasks,  Up: Deadlines and scheduling

8.3.1 Inserting deadlines or schedules
--------------------------------------

The following commands allow you to quickly insert a deadline or to
schedule an item:

‘C-c C-d     (org-deadline)’
     Insert ‘DEADLINE’ keyword along with a stamp.  Any CLOSED timestamp
     will be removed.  When called with a prefix arg, an existing
     deadline will be removed from the entry.  Depending on the variable
     ‘org-log-redeadline’(1), a note will be taken when changing an
     existing deadline.

‘C-c C-s     (org-schedule)’
     Insert ‘SCHEDULED’ keyword along with a stamp.  Any CLOSED
     timestamp will be removed.  When called with a prefix argument,
     remove the scheduling date from the entry.  Depending on the
     variable ‘org-log-reschedule’(2), a note will be taken when
     changing an existing scheduling time.
‘C-c / d     (org-check-deadlines)’
     Create a sparse tree with all deadlines that are either past-due,
     or which will become due within ‘org-deadline-warning-days’.  With
     ‘C-u’ prefix, show all deadlines in the file.  With a numeric
     prefix, check that many days.  For example, ‘C-1 C-c / d’ shows all
     deadlines due tomorrow.
‘C-c / b     (org-check-before-date)’
     Sparse tree for deadlines and scheduled items before a given date.
‘C-c / a     (org-check-after-date)’
     Sparse tree for deadlines and scheduled items after a given date.

   Note that ‘org-schedule’ and ‘org-deadline’ supports setting the date
by indicating a relative time: e.g., +1d will set the date to the next
day after today, and –1w will set the date to the previous week before
any current timestamp.

   ---------- Footnotes ----------

   (1) with corresponding ‘#+STARTUP’ keywords ‘logredeadline’,
‘lognoteredeadline’, and ‘nologredeadline’

   (2) with corresponding ‘#+STARTUP’ keywords ‘logreschedule’,
‘lognotereschedule’, and ‘nologreschedule’


File: org.info,  Node: Repeated tasks,  Prev: Inserting deadline/schedule,  Up: Deadlines and scheduling

8.3.2 Repeated tasks
--------------------

Some tasks need to be repeated again and again.  Org mode helps to
organize such tasks using a so-called repeater in a ‘DEADLINE’,
‘SCHEDULED’, or plain timestamp.  In the following example
     ** TODO Pay the rent
        DEADLINE: <2005-10-01 Sat +1m>
the ‘+1m’ is a repeater; the intended interpretation is that the task
has a deadline on <2005-10-01> and repeats itself every (one) month
starting from that time.  You can use yearly, monthly, weekly, daily and
hourly repeat cookies by using the ‘y/w/m/d/h’ letters.  If you need
both a repeater and a special warning period in a deadline entry, the
repeater should come first and the warning period last: ‘DEADLINE:
<2005-10-01 Sat +1m -3d>’.

   Deadlines and scheduled items produce entries in the agenda when they
are over-due, so it is important to be able to mark such an entry as
completed once you have done so.  When you mark a ‘DEADLINE’ or a
‘SCHEDULED’ with the TODO keyword DONE, it will no longer produce
entries in the agenda.  The problem with this is, however, that then
also the _next_ instance of the repeated entry will not be active.  Org
mode deals with this in the following way: When you try to mark such an
entry DONE (using ‘C-c C-t’), it will shift the base date of the
repeating timestamp by the repeater interval, and immediately set the
entry state back to TODO(1). In the example above, setting the state to
DONE would actually switch the date like this:

     ** TODO Pay the rent
        DEADLINE: <2005-11-01 Tue +1m>

   To mark a task with a repeater as ‘DONE’, use ‘C-- 1 C-c C-t’ (i.e.,
‘org-todo’ with a numeric prefix argument of -1.)

   A timestamp(2) will be added under the deadline, to keep a record
that you actually acted on the previous instance of this deadline.

   As a consequence of shifting the base date, this entry will no longer
be visible in the agenda when checking past dates, but all future
instances will be visible.

   With the ‘+1m’ cookie, the date shift will always be exactly one
month.  So if you have not paid the rent for three months, marking this
entry DONE will still keep it as an overdue deadline.  Depending on the
task, this may not be the best way to handle it.  For example, if you
forgot to call your father for 3 weeks, it does not make sense to call
him 3 times in a single day to make up for it.  Finally, there are tasks
like changing batteries which should always repeat a certain time after
the last time you did it.  For these tasks, Org mode has special
repeaters ‘++’ and ‘.+’.  For example:

     ** TODO Call Father
        DEADLINE: <2008-02-10 Sun ++1w>
        Marking this DONE will shift the date by at least one week,
        but also by as many weeks as it takes to get this date into
        the future.  However, it stays on a Sunday, even if you called
        and marked it done on Saturday.
     ** TODO Empty kitchen trash
        DEADLINE: <2008-02-08 Fri 20:00 ++1d>
        Marking this DONE will shift the date by at least one day, and
        also by as many days as it takes to get the timestamp into the
        future.  Since there is a time in the timestamp, the next
        deadline in the future will be on today's date if you
        complete the task before 20:00.
     ** TODO Check the batteries in the smoke detectors
        DEADLINE: <2005-11-01 Tue .+1m>
        Marking this DONE will shift the date to one month after
        today.

   You may have both scheduling and deadline information for a specific
task.  If the repeater is set for the scheduling information only, you
probably want the repeater to be ignored after the deadline.  If so, set
the variable ‘org-agenda-skip-scheduled-if-deadline-is-shown’ to
‘repeated-after-deadline’.  However, any scheduling information without
a repeater is no longer relevant once the task is done, and thus,
removed upon repeating the task.  If you want both scheduling and
deadline information to repeat after the same interval, set the same
repeater for both timestamps.

   An alternative to using a repeater is to create a number of copies of
a task subtree, with dates shifted in each copy.  The command ‘C-c C-x
c’ was created for this purpose, it is described in *note Structure
editing::.

   ---------- Footnotes ----------

   (1) In fact, the target state is taken from, in this sequence, the
‘REPEAT_TO_STATE’ property or the variable ‘org-todo-repeat-to-state’.
If neither of these is specified, the target state defaults to the first
state of the TODO state sequence.

   (2) You can change this using the option ‘org-log-repeat’, or the
‘#+STARTUP’ options ‘logrepeat’, ‘lognoterepeat’, and ‘nologrepeat’.
With ‘lognoterepeat’, you will also be prompted for a note.


File: org.info,  Node: Clocking work time,  Next: Effort estimates,  Prev: Deadlines and scheduling,  Up: Dates and times

8.4 Clocking work time
======================

Org mode allows you to clock the time you spend on specific tasks in a
project.  When you start working on an item, you can start the clock.
When you stop working on that task, or when you mark the task done, the
clock is stopped and the corresponding time interval is recorded.  It
also computes the total time spent on each subtree(1) of a project.  And
it remembers a history or tasks recently clocked, so that you can jump
quickly between a number of tasks absorbing your time.

   To save the clock history across Emacs sessions, use
     (setq org-clock-persist 'history)
     (org-clock-persistence-insinuate)
   When you clock into a new task after resuming Emacs, the incomplete
clock(2) will be found (*note Resolving idle time::) and you will be
prompted about what to do with it.

* Menu:

* Clocking commands::           Starting and stopping a clock
* The clock table::             Detailed reports
* Resolving idle time::         Resolving time when you’ve been idle

   ---------- Footnotes ----------

   (1) Clocking only works if all headings are indented with less than
30 stars.  This is a hardcoded limitation of ‘lmax’ in ‘org-clock-sum’.

   (2) To resume the clock under the assumption that you have worked on
this task while outside Emacs, use ‘(setq org-clock-persist t)’.


File: org.info,  Node: Clocking commands,  Next: The clock table,  Up: Clocking work time

8.4.1 Clocking commands
-----------------------

‘C-c C-x C-i     (org-clock-in)’
     !Start the clock on the current item (clock-in).  This inserts the
     ‘CLOCK’ keyword together with a timestamp.  If this is not the
     first clocking of this item, the multiple ‘CLOCK’ lines will be
     wrapped into a ‘:LOGBOOK:’ drawer (see also the variable
     ‘org-clock-into-drawer’).  You can also overrule the setting of
     this variable for a subtree by setting a ‘CLOCK_INTO_DRAWER’ or
     ‘LOG_INTO_DRAWER’ property.  When called with a ‘C-u’ prefix
     argument, select the task from a list of recently clocked tasks.
     With two ‘C-u C-u’ prefixes, clock into the task at point and mark
     it as the default task; the default task will then always be
     available with letter ‘d’ when selecting a clocking task.  With
     three ‘C-u C-u C-u’ prefixes, force continuous clocking by starting
     the clock when the last clock stopped.
     While the clock is running, the current clocking time is shown in
     the mode line, along with the title of the task.  The clock time
     shown will be all time ever clocked for this task and its children.
     If the task has an effort estimate (*note Effort estimates::), the
     mode line displays the current clocking time against it(1) If the
     task is a repeating one (*note Repeated tasks::), only the time
     since the last reset of the task (2) will be shown.  More control
     over what time is shown can be exercised with the
     ‘CLOCK_MODELINE_TOTAL’ property.  It may have the values ‘current’
     to show only the current clocking instance, ‘today’ to show all
     time clocked on this task today (see also the variable
     ‘org-extend-today-until’), ‘all’ to include all time, or ‘auto’
     which is the default(3).
     Clicking with ‘mouse-1’ onto the mode line entry will pop up a menu
     with clocking options.
‘C-c C-x C-o     (org-clock-out)’
     Stop the clock (clock-out).  This inserts another timestamp at the
     same location where the clock was last started.  It also directly
     computes the resulting time and inserts it after the time range as
     ‘=> HH:MM’.  See the variable ‘org-log-note-clock-out’ for the
     possibility to record an additional note together with the
     clock-out timestamp(4).
‘C-c C-x C-x     (org-clock-in-last)’
     Reclock the last clocked task.  With one ‘C-u’ prefix argument,
     select the task from the clock history.  With two ‘C-u’ prefixes,
     force continuous clocking by starting the clock when the last clock
     stopped.
‘C-c C-x C-e     (org-clock-modify-effort-estimate)’
     Update the effort estimate for the current clock task.
‘C-c C-c  or  C-c C-y     (org-evaluate-time-range)’
     Recompute the time interval after changing one of the timestamps.
     This is only necessary if you edit the timestamps directly.  If you
     change them with ‘S-<cursor>’ keys, the update is automatic.
‘C-S-<up/down>     (org-clock-timestamps-up/down)’
     On ‘CLOCK’ log lines, increase/decrease both timestamps so that the
     clock duration keeps the same.
‘S-M-<up/down>     (org-timestamp-up/down)’
     On ‘CLOCK’ log lines, increase/decrease the timestamp at point and
     the one of the previous (or the next clock) timestamp by the same
     duration.  For example, if you hit ‘S-M-<UP>’ to increase a
     clocked-out timestamp by five minutes, then the clocked-in
     timestamp of the next clock will be increased by five minutes.
‘C-c C-t     (org-todo)’
     Changing the TODO state of an item to DONE automatically stops the
     clock if it is running in this same item.
‘C-c C-x C-q     (org-clock-cancel)’
     Cancel the current clock.  This is useful if a clock was started by
     mistake, or if you ended up working on something else.
‘C-c C-x C-j     (org-clock-goto)’
     Jump to the headline of the currently clocked in task.  With a
     ‘C-u’ prefix arg, select the target task from a list of recently
     clocked tasks.
‘C-c C-x C-d     (org-clock-display)’
     Display time summaries for each subtree in the current buffer.
     This puts overlays at the end of each headline, showing the total
     time recorded under that heading, including the time of any
     subheadings.  You can use visibility cycling to study the tree, but
     the overlays disappear when you change the buffer (see variable
     ‘org-remove-highlights-with-change’) or press ‘C-c C-c’.

   The ‘l’ key may be used the agenda (*note Weekly/daily agenda::) to
show which tasks have been worked on or closed during a day.

   *Important:* note that both ‘org-clock-out’ and ‘org-clock-in-last’
can have a global key binding and will not modify the window
disposition.

   ---------- Footnotes ----------

   (1) To add an effort estimate “on the fly”, hook a function doing
this to ‘org-clock-in-prepare-hook’.

   (2) as recorded by the ‘LAST_REPEAT’ property

   (3) See also the variable ‘org-clock-modeline-total’.

   (4) The corresponding in-buffer setting is: ‘#+STARTUP:
lognoteclock-out’


File: org.info,  Node: The clock table,  Next: Resolving idle time,  Prev: Clocking commands,  Up: Clocking work time

8.4.2 The clock table
---------------------

Org mode can produce quite complex reports based on the time clocking
information.  Such a report is called a _clock table_, because it is
formatted as one or several Org tables.

‘C-c C-x C-r     (org-clock-report)’
     Insert a dynamic block (*note Dynamic blocks::) containing a clock
     report as an Org mode table into the current file.  When the cursor
     is at an existing clock table, just update it.  When called with a
     prefix argument, jump to the first clock report in the current
     document and update it.  The clock table always includes also trees
     with ‘:ARCHIVE:’ tag.
‘C-c C-c  or  C-c C-x C-u     (org-dblock-update)’
     Update dynamic block at point.
‘C-u C-c C-x C-u’
     Update all dynamic blocks (*note Dynamic blocks::).  This is useful
     if you have several clock table blocks in a buffer.
‘S-<LEFT>’
‘S-<RIGHT>     (org-clocktable-try-shift)’
     Shift the current ‘:block’ interval and update the table.  The
     cursor needs to be in the ‘#+BEGIN: clocktable’ line for this
     command.  If ‘:block’ is ‘today’, it will be shifted to ‘today-1’
     etc.

   Here is an example of the frame for a clock table as it is inserted
into the buffer with the ‘C-c C-x C-r’ command:

     #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
     #+END: clocktable
The ‘BEGIN’ line specifies a number of options to define the scope,
structure, and formatting of the report.  Defaults for all these options
can be configured in the variable ‘org-clocktable-defaults’.

First there are options that determine which clock entries are to be
selected:
     :maxlevel    Maximum level depth to which times are listed in the table.
                  Clocks at deeper levels will be summed into the upper level.
     :scope       The scope to consider.  This can be any of the following:
                  nil        the current buffer or narrowed region
                  file       the full current buffer
                  subtree    the subtree where the clocktable is located
                  treeN      the surrounding level N tree, for example ‘tree3’
                  tree       the surrounding level 1 tree
                  agenda     all agenda files
                  ("file"..) scan these files
                  function   the list of files returned by a function of no argument
                  file-with-archives    current file and its archives
                  agenda-with-archives  all agenda files, including archives
     :block       The time block to consider.  This block is specified either
                  absolutely, or relative to the current time and may be any of
                  these formats:
                  2007-12-31    New year eve 2007
                  2007-12       December 2007
                  2007-W50      ISO-week 50 in 2007
                  2007-Q2       2nd quarter in 2007
                  2007          the year 2007
                  today, yesterday, today-N          a relative day
                  thisweek, lastweek, thisweek-N     a relative week
                  thismonth, lastmonth, thismonth-N  a relative month
                  thisyear, lastyear, thisyear-N     a relative year
                  untilnow
                  Use ‘S-<LEFT>/<RIGHT>’ keys to shift the time interval.
     :tstart      A time string specifying when to start considering times.
                  Relative times like ‘"<-2w>"’ can also be used.  See
                  *note Matching tags and properties:: for relative time syntax.
     :tend        A time string specifying when to stop considering times.
                  Relative times like ‘"<now>"’ can also be used.  See
                  *note Matching tags and properties:: for relative time syntax.
     :wstart      The starting day of the week.  The default is 1 for monday.
     :mstart      The starting day of the month.  The default 1 is for the first
                  day of the month.
     :step        ‘week’ or ‘day’, to split the table into chunks.
                  To use this, ‘:block’ or ‘:tstart’, ‘:tend’ are needed.
     :stepskip0   Do not show steps that have zero time.
     :fileskip0   Do not show table sections from files which did not contribute.
     :tags        A tags match to select entries that should contribute.  See
                  *note Matching tags and properties:: for the match syntax.

   Then there are options which determine the formatting of the table.
These options are interpreted by the function
‘org-clocktable-write-default’, but you can specify your own function
using the ‘:formatter’ parameter.
     :emphasize   When ‘t’, emphasize level one and level two items.
     :lang        Language(1) to use for descriptive cells like "Task".
     :link        Link the item headlines in the table to their origins.
     :narrow      An integer to limit the width of the headline column in
                  the org table.  If you write it like ‘50!’, then the
                  headline will also be shortened in export.
     :indent      Indent each headline field according to its level.
     :tcolumns    Number of columns to be used for times.  If this is smaller
                  than ‘:maxlevel’, lower levels will be lumped into one column.
     :level       Should a level number column be included?
     :sort        A cons cell like containing the column to sort and a sorting type.
                  E.g., ‘:sort (1 . ?a)’ sorts the first column alphabetically.
     :compact     Abbreviation for ‘:level nil :indent t :narrow 40! :tcolumns 1’
                  All are overwritten except if there is an explicit ‘:narrow’
     :timestamp   A timestamp for the entry, when available.  Look for ‘SCHEDULED’,
                  ‘DEADLINE’, ‘TIMESTAMP’ and ‘TIMESTAMP_IA’, in this order.
     :properties  List of properties that should be shown in the table.  Each
                  property will get its own column.
     :inherit-props When this flag is ‘t’, the values for ‘:properties’ will be inherited.
     :formula     Content of a ‘#+TBLFM’ line to be added and evaluated.
                  As a special case, ‘:formula %’ adds a column with % time.
                  If you do not specify a formula here, any existing formula
                  below the clock table will survive updates and be evaluated.
     :formatter   A function to format clock data and insert it into the buffer.
   To get a clock summary of the current level 1 tree, for the current
day, you could write
     #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
     #+END: clocktable
and to use a specific time range you could write(2)
     #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
                         :tend "<2006-08-10 Thu 12:00>"
     #+END: clocktable
   A range starting a week ago and ending right now could be written as
     #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
     #+END: clocktable
   A summary of the current subtree with % times would be
     #+BEGIN: clocktable :scope subtree :link t :formula %
     #+END: clocktable
   A horizontally compact representation of everything clocked during
last week would be
     #+BEGIN: clocktable :scope agenda :block lastweek :compact t
     #+END: clocktable

   ---------- Footnotes ----------

   (1) Language terms can be set through the variable
‘org-clock-clocktable-language-setup’.

   (2) Note that all parameters must be specified in a single line—the
line is broken here only to fit it into the manual.


File: org.info,  Node: Resolving idle time,  Prev: The clock table,  Up: Clocking work time

8.4.3 Resolving idle time and continuous clocking
-------------------------------------------------

Resolving idle time
...................

If you clock in on a work item, and then walk away from your
computer—perhaps to take a phone call—you often need to “resolve” the
time you were away by either subtracting it from the current clock, or
applying it to another one.

   By customizing the variable ‘org-clock-idle-time’ to some integer,
such as 10 or 15, Emacs can alert you when you get back to your computer
after being idle for that many minutes(1), and ask what you want to do
with the idle time.  There will be a question waiting for you when you
get back, indicating how much idle time has passed (constantly updated
with the current amount), as well as a set of choices to correct the
discrepancy:

‘k’
     To keep some or all of the minutes and stay clocked in, press ‘k’.
     Org will ask how many of the minutes to keep.  Press <RET> to keep
     them all, effectively changing nothing, or enter a number to keep
     that many minutes.
‘K’
     If you use the shift key and press ‘K’, it will keep however many
     minutes you request and then immediately clock out of that task.
     If you keep all of the minutes, this is the same as just clocking
     out of the current task.
‘s’
     To keep none of the minutes, use ‘s’ to subtract all the away time
     from the clock, and then check back in from the moment you
     returned.
‘S’
     To keep none of the minutes and just clock out at the start of the
     away time, use the shift key and press ‘S’.  Remember that using
     shift will always leave you clocked out, no matter which option you
     choose.
‘C’
     To cancel the clock altogether, use ‘C’.  Note that if instead of
     canceling you subtract the away time, and the resulting clock
     amount is less than a minute, the clock will still be canceled
     rather than clutter up the log with an empty entry.

   What if you subtracted those away minutes from the current clock, and
now want to apply them to a new clock?  Simply clock in to any task
immediately after the subtraction.  Org will notice that you have
subtracted time “on the books”, so to speak, and will ask if you want to
apply those minutes to the next task you clock in on.

   There is one other instance when this clock resolution magic occurs.
Say you were clocked in and hacking away, and suddenly your cat chased a
mouse who scared a hamster that crashed into your UPS’s power button!
You suddenly lose all your buffers, but thanks to auto-save you still
have your recent Org mode changes, including your last clock in.

   If you restart Emacs and clock into any task, Org will notice that
you have a dangling clock which was never clocked out from your last
session.  Using that clock’s starting time as the beginning of the
unaccounted-for period, Org will ask how you want to resolve that time.
The logic and behavior is identical to dealing with away time due to
idleness; it is just happening due to a recovery event rather than a set
amount of idle time.

   You can also check all the files visited by your Org agenda for
dangling clocks at any time using ‘M-x org-resolve-clocks <RET>’ (or
‘C-c C-x C-z’).

Continuous clocking
...................

You may want to start clocking from the time when you clocked out the
previous task.  To enable this systematically, set
‘org-clock-continuously’ to ‘t’.  Each time you clock in, Org retrieves
the clock-out time of the last clocked entry for this session, and start
the new clock from there.

   If you only want this from time to time, use three universal prefix
arguments with ‘org-clock-in’ and two ‘C-u C-u’ with
‘org-clock-in-last’.

   ---------- Footnotes ----------

   (1) On computers using macOS, idleness is based on actual user
idleness, not just Emacs’ idle time.  For X11, you can install a utility
program ‘x11idle.c’, available in the ‘contrib/scripts’ directory of the
Org git distribution, or install the ‘xprintidle’ package and set it to
the variable ‘org-clock-x11idle-program-name’ if you are running Debian,
to get the same general treatment of idleness.  On other systems, idle
time refers to Emacs idle time only.


File: org.info,  Node: Effort estimates,  Next: Timers,  Prev: Clocking work time,  Up: Dates and times

8.5 Effort estimates
====================

If you want to plan your work in a very detailed way, or if you need to
produce offers with quotations of the estimated work effort, you may
want to assign effort estimates to entries.  If you are also clocking
your work, you may later want to compare the planned effort with the
actual working time, a great way to improve planning estimates.  Effort
estimates are stored in a special property ‘EFFORT’.  You can set the
effort for an entry with the following commands:

‘C-c C-x e     (org-set-effort)’
     Set the effort estimate for the current entry.  With a numeric
     prefix argument, set it to the Nth allowed value (see below).  This
     command is also accessible from the agenda with the ‘e’ key.
‘C-c C-x C-e     (org-clock-modify-effort-estimate)’
     Modify the effort estimate of the item currently being clocked.

   Clearly the best way to work with effort estimates is through column
view (*note Column view::).  You should start by setting up discrete
values for effort estimates, and a ‘COLUMNS’ format that displays these
values together with clock sums (if you want to clock your time).  For a
specific buffer you can use

     #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
     #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort){:} %CLOCKSUM

or, even better, you can set up these values globally by customizing the
variables ‘org-global-properties’ and ‘org-columns-default-format’.  In
particular if you want to use this setup also in the agenda, a global
setup may be advised.

   The way to assign estimates to individual items is then to switch to
column mode, and to use ‘S-<RIGHT>’ and ‘S-<LEFT>’ to change the value.
The values you enter will immediately be summed up in the hierarchy.  In
the column next to it, any clocked time will be displayed.

   If you switch to column view in the daily/weekly agenda, the effort
column will summarize the estimated work effort for each day(1), and you
can use this to find space in your schedule.  To get an overview of the
entire part of the day that is committed, you can set the option
‘org-agenda-columns-add-appointments-to-effort-sum’.  The appointments
on a day that take place over a specified time interval will then also
be added to the load estimate of the day.

   Effort estimates can be used in secondary agenda filtering that is
triggered with the ‘/’ key in the agenda (*note Agenda commands::).  If
you have these estimates defined consistently, two or three key presses
will narrow down the list to stuff that fits into an available time
slot.

   ---------- Footnotes ----------

   (1) Please note the pitfalls of summing hierarchical data in a flat
list (*note Agenda column view::).


File: org.info,  Node: Timers,  Prev: Effort estimates,  Up: Dates and times

8.6 Taking notes with a timer
=============================

Org provides two types of timers.  There is a relative timer that counts
up, which can be useful when taking notes during, for example, a meeting
or a video viewing.  There is also a countdown timer.

   The relative and countdown are started with separate commands.

‘C-c C-x 0     (org-timer-start)’
     Start or reset the relative timer.  By default, the timer is set to
     0.  When called with a ‘C-u’ prefix, prompt the user for a starting
     offset.  If there is a timer string at point, this is taken as the
     default, providing a convenient way to restart taking notes after a
     break in the process.  When called with a double prefix argument
     ‘C-u C-u’, change all timer strings in the active region by a
     certain amount.  This can be used to fix timer strings if the timer
     was not started at exactly the right moment.
‘C-c C-x ;     (org-timer-set-timer)’
     Start a countdown timer.  The user is prompted for a duration.
     ‘org-timer-default-timer’ sets the default countdown value.  Giving
     a numeric prefix argument overrides this default value.  This
     command is available as ‘;’ in agenda buffers.

   Once started, relative and countdown timers are controlled with the
same commands.

‘C-c C-x .     (org-timer)’
     Insert the value of the current relative or countdown timer into
     the buffer.  If no timer is running, the relative timer will be
     started.  When called with a prefix argument, the relative timer is
     restarted.
‘C-c C-x -     (org-timer-item)’
     Insert a description list item with the value of the current
     relative or countdown timer.  With a prefix argument, first reset
     the relative timer to 0.
‘M-<RET>     (org-insert-heading)’
     Once the timer list is started, you can also use ‘M-<RET>’ to
     insert new timer items.
‘C-c C-x ,     (org-timer-pause-or-continue)’
     Pause the timer, or continue it if it is already paused.
‘C-c C-x _     (org-timer-stop)’
     Stop the timer.  After this, you can only start a new timer, not
     continue the old one.  This command also removes the timer from the
     mode line.


File: org.info,  Node: Capture - Refile - Archive,  Next: Agenda views,  Prev: Dates and times,  Up: Top

9 Capture - Refile - Archive
****************************

An important part of any organization system is the ability to quickly
capture new ideas and tasks, and to associate reference material with
them.  Org does this using a process called capture.  It also can store
files related to a task (attachments) in a special directory.  Once in
the system, tasks and projects need to be moved around.  Moving
completed project trees to an archive file keeps the system compact and
fast.

* Menu:

* Capture::                     Capturing new stuff
* Attachments::                 Add files to tasks
* RSS feeds::                   Getting input from RSS feeds
* Protocols::                   External (e.g., Browser) access to Emacs and Org
* Refile and copy::             Moving/copying a tree from one place to another
* Archiving::                   What to do with finished projects


File: org.info,  Node: Capture,  Next: Attachments,  Up: Capture - Refile - Archive

9.1 Capture
===========

Capture lets you quickly store notes with little interruption of your
work flow.  Org’s method for capturing new items is heavily inspired by
John Wiegley excellent ‘remember.el’ package.  Up to version 6.36, Org
used a special setup for ‘remember.el’, then replaced it with
‘org-remember.el’.  As of version 8.0, ‘org-remember.el’ has been
completely replaced by ‘org-capture.el’.

   If your configuration depends on ‘org-remember.el’, you need to
update it and use the setup described below.  To convert your
‘org-remember-templates’, run the command
     M-x org-capture-import-remember-templates <RET>
and then customize the new variable with ‘M-x customize-variable
org-capture-templates’, check the result, and save the customization.

* Menu:

* Setting up capture::          Where notes will be stored
* Using capture::               Commands to invoke and terminate capture
* Capture templates::           Define the outline of different note types


File: org.info,  Node: Setting up capture,  Next: Using capture,  Up: Capture

9.1.1 Setting up capture
------------------------

The following customization sets a default target file for notes, and
defines a global key(1) for capturing new material.

     (setq org-default-notes-file (concat org-directory "/notes.org"))
     (define-key global-map "\C-cc" 'org-capture)

   ---------- Footnotes ----------

   (1) Please select your own key, ‘C-c c’ is only a suggestion.


File: org.info,  Node: Using capture,  Next: Capture templates,  Prev: Setting up capture,  Up: Capture

9.1.2 Using capture
-------------------

‘C-c c     (org-capture)’
     Call the command ‘org-capture’.  Note that this key binding is
     global and not active by default: you need to install it.  If you
     have templates defined *note Capture templates::, it will offer
     these templates for selection or use a new Org outline node as the
     default template.  It will insert the template into the target file
     and switch to an indirect buffer narrowed to this new node.  You
     may then insert the information you want.

‘C-c C-c     (org-capture-finalize)’
     Once you have finished entering information into the capture
     buffer, ‘C-c C-c’ will return you to the window configuration
     before the capture process, so that you can resume your work
     without further distraction.  When called with a prefix arg,
     finalize and then jump to the captured item.

‘C-c C-w     (org-capture-refile)’
     Finalize the capture process by refiling (*note Refile and copy::)
     the note to a different place.  Please realize that this is a
     normal refiling command that will be executed—so the cursor
     position at the moment you run this command is important.  If you
     have inserted a tree with a parent and children, first move the
     cursor back to the parent.  Any prefix argument given to this
     command will be passed on to the ‘org-refile’ command.

‘C-c C-k     (org-capture-kill)’
     Abort the capture process and return to the previous state.

   You can also call ‘org-capture’ in a special way from the agenda,
using the ‘k c’ key combination.  With this access, any timestamps
inserted by the selected capture template will default to the cursor
date in the agenda, rather than to the current date.

   To find the locations of the last stored capture, use ‘org-capture’
with prefix commands:

‘C-u C-c c’
     Visit the target location of a capture template.  You get to select
     the template in the usual way.
‘C-u C-u C-c c’
     Visit the last stored capture item in its buffer.

   You can also jump to the bookmark ‘org-capture-last-stored’, which
will automatically be created unless you set ‘org-capture-bookmark’ to
‘nil’.

   To insert the capture at point in an Org buffer, call ‘org-capture’
with a ‘C-0’ prefix argument.


File: org.info,  Node: Capture templates,  Prev: Using capture,  Up: Capture

9.1.3 Capture templates
-----------------------

You can use templates for different types of capture items, and for
different target locations.  The easiest way to create such templates is
through the customize interface.

‘C-c c C’
     Customize the variable ‘org-capture-templates’.

   Before we give the formal description of template definitions, let’s
look at an example.  Say you would like to use one template to create
general TODO entries, and you want to put these entries under the
heading ‘Tasks’ in your file ‘~/org/gtd.org’.  Also, a date tree in the
file ‘journal.org’ should capture journal entries.  A possible
configuration would look like:

     (setq org-capture-templates
      '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
             "* TODO %?\n  %i\n  %a")
        ("j" "Journal" entry (file+olp+datetree "~/org/journal.org")
             "* %?\nEntered on %U\n  %i\n  %a")))

If you then press ‘C-c c t’, Org will prepare the template for you like
this:
     * TODO
       [[file:LINK TO WHERE YOU INITIATED CAPTURE]]

During expansion of the template, ‘%a’ has been replaced by a link to
the location from where you called the capture command.  This can be
extremely useful for deriving tasks from emails, for example.  You fill
in the task definition, press ‘C-c C-c’ and Org returns you to the same
place where you started the capture process.

   To define special keys to capture to a particular template without
going through the interactive template selection, you can create your
key binding like this:

     (define-key global-map "\C-cx"
        (lambda () (interactive) (org-capture nil "x")))

* Menu:

* Template elements::           What is needed for a complete template entry
* Template expansion::          Filling in information about time and context
* Templates in contexts::       Only show a template in a specific context


File: org.info,  Node: Template elements,  Next: Template expansion,  Up: Capture templates

9.1.3.1 Template elements
.........................

Now lets look at the elements of a template definition.  Each entry in
‘org-capture-templates’ is a list with the following items:

KEYS
     The keys that will select the template, as a string, characters
     only, for example ‘"a"’ for a template to be selected with a single
     key, or ‘"bt"’ for selection with two keys.  When using several
     keys, keys using the same prefix key must be sequential in the list
     and preceded by a 2-element entry explaining the prefix key, for
     example
                   ("b" "Templates for marking stuff to buy")
     If you do not define a template for the ‘C’ key, this key will be
     used to open the customize buffer for this complex variable.

DESCRIPTION
     A short string describing the template, which will be shown during
     selection.

TYPE
     The type of entry, a symbol.  Valid values are:

     ‘entry’
          An Org mode node, with a headline.  Will be filed as the child
          of the target entry or as a top-level entry.  The target file
          should be an Org mode file.
     ‘item’
          A plain list item, placed in the first plain list at the
          target location.  Again the target file should be an Org file.
     ‘checkitem’
          A checkbox item.  This only differs from the plain list item
          by the default template.
     ‘table-line’
          a new line in the first table at the target location.  Where
          exactly the line will be inserted depends on the properties
          ‘:prepend’ and ‘:table-line-pos’ (see below).
     ‘plain’
          Text to be inserted as it is.

TARGET
     Specification of where the captured item should be placed.  In Org
     mode files, targets usually define a node.  Entries will become
     children of this node.  Other types will be added to the table or
     list in the body of this node.  Most target specifications contain
     a file name.  If that file name is the empty string, it defaults to
     ‘org-default-notes-file’.  A file can also be given as a variable
     or as a function called with no argument.  When an absolute path is
     not specified for a target, it is taken as relative to
     ‘org-directory’.

     Valid values are:

     ‘(file "path/to/file")’
          Text will be placed at the beginning or end of that file.

     ‘(id "id of existing org entry")’
          Filing as child of this entry, or in the body of the entry.

     ‘(file+headline "path/to/file" "node headline")’
          Fast configuration if the target heading is unique in the
          file.

     ‘(file+olp "path/to/file" "Level 1 heading" "Level 2" ...)’
          For non-unique headings, the full path is safer.

     ‘(file+regexp "path/to/file" "regexp to find location")’
          Use a regular expression to position the cursor.

     ‘(file+olp+datetree "path/to/file" [ "Level 1 heading" ....])’
          This target(1) will create a heading in a date tree(2) for
          today’s date.  If the optional outline path is given, the tree
          will be built under the node it is pointing to, instead of at
          top level.  Check out the ‘:time-prompt’ and ‘:tree-type’
          properties below for additional options.

     ‘(file+function "path/to/file" function-finding-location)’
          A function to find the right location in the file.

     ‘(clock)’
          File to the entry that is currently being clocked.

     ‘(function function-finding-location)’
          Most general way: write your own function which both visits
          the file and moves point to the right location.

TEMPLATE
     The template for creating the capture item.  If you leave this
     empty, an appropriate default template will be used.  Otherwise
     this is a string with escape codes, which will be replaced
     depending on time and context of the capture call.  The string with
     escapes may be loaded from a template file, using the special
     syntax ‘(file "path/to/template")’.  See below for more details.

PROPERTIES
     The rest of the entry is a property list of additional options.
     Recognized properties are:

     ‘:prepend’
          Normally new captured information will be appended at the
          target location (last child, last table line, last list
          item...).  Setting this property will change that.

     ‘:immediate-finish’
          When set, do not offer to edit the information, just file it
          away immediately.  This makes sense if the template only needs
          information that can be added automatically.

     ‘:empty-lines’
          Set this to the number of lines to insert before and after the
          new item.  Default 0, only common other value is 1.

     ‘:clock-in’
          Start the clock in this item.

     ‘:clock-keep’
          Keep the clock running when filing the captured entry.

     ‘:clock-resume’
          If starting the capture interrupted a clock, restart that
          clock when finished with the capture.  Note that ‘:clock-keep’
          has precedence over ‘:clock-resume’.  When setting both to
          ‘t’, the current clock will run and the previous one will not
          be resumed.

     ‘:time-prompt’
          Prompt for a date/time to be used for date/week trees and when
          filling the template.  Without this property, capture uses the
          current date and time.  Even if this property has not been
          set, you can force the same behavior by calling ‘org-capture’
          with a ‘C-1’ prefix argument.

     ‘:tree-type’
          When ‘week’, make a week tree instead of the month tree, i.e.
          place the headings for each day under a heading with the
          current iso week.

     ‘:unnarrowed’
          Do not narrow the target buffer, simply show the full buffer.
          Default is to narrow it so that you only see the new material.

     ‘:table-line-pos’
          Specification of the location in the table where the new line
          should be inserted.  It can be a string, a variable holding a
          string or a function returning a string.  The string should
          look like ‘"II-3"’ meaning that the new line should become the
          third line before the second horizontal separator line.

     ‘:kill-buffer’
          If the target file was not yet visited when capture was
          invoked, kill the buffer again after capture is completed.

   ---------- Footnotes ----------

   (1) Org used to offer four different targets for date/week tree
capture.  Now, Org automatically translates these to use
‘file+olp+datetree’, applying the ‘:time-prompt’ and ‘:tree-type’
properties.  Please rewrite your date/week-tree targets using
‘file+olp+datetree’ since the older targets are now deprecated.

   (2) A date tree is an outline structure with years on the highest
level, months or ISO-weeks as sublevels and then dates on the lowest
level.  Tags are allowed in the tree structure.


File: org.info,  Node: Template expansion,  Next: Templates in contexts,  Prev: Template elements,  Up: Capture templates

9.1.3.2 Template expansion
..........................

In the template itself, special ‘%’-escapes(1) allow dynamic insertion
of content.  The templates are expanded in the order given here:

     %[FILE]     Insert the contents of the file given by FILE.
     %(SEXP)     Evaluate Elisp SEXP and replace with the result.
                       For convenience, %:keyword (see below) placeholders
                       within the expression will be expanded prior to this.
                       The sexp must return a string.
     %<...>      The result of format-time-string on the ... format specification.
     %t          Timestamp, date only.
     %T          Timestamp, with date and time.
     %u, %U      Like the above, but inactive timestamps.
     %i          Initial content, the region when capture is called while the
                 region is active.
                 The entire text will be indented like ‘%i’ itself.
     %a          Annotation, normally the link created with ‘org-store-link’.
     %A          Like ‘%a’, but prompt for the description part.
     %l          Like %a, but only insert the literal link.
     %c          Current kill ring head.
     %x          Content of the X clipboard.
     %k          Title of the currently clocked task.
     %K          Link to the currently clocked task.
     %n          User name (taken from ‘user-full-name’).
     %f          File visited by current buffer when org-capture was called.
     %F          Full path of the file or directory visited by current buffer.
     %:keyword   Specific information for certain link types, see below.
     %^g         Prompt for tags, with completion on tags in target file.
     %^G         Prompt for tags, with completion all tags in all agenda files.
     %^t         Like ‘%t’, but prompt for date.  Similarly ‘%^T’, ‘%^u’, ‘%^U’.
                 You may define a prompt like ‘%^{Birthday}t’.
     %^C         Interactive selection of which kill or clip to use.
     %^L         Like ‘%^C’, but insert as link.
     %^{PROP}p   Prompt the user for a value for property PROP.
     %^{PROMPT}  prompt the user for a string and replace this sequence with it.
                 You may specify a default value and a completion table with
                 %^{prompt|default|completion2|completion3...}.
                 The arrow keys access a prompt-specific history.
     %\1 ... %\N Insert the text entered at the Nth %^{PROMPT}, where ‘N’ is
                 a number, starting from 1.(2)
     %?          After completing the template, position cursor here.

For specific link types, the following keywords will be defined(3):

     Link type                        |  Available keywords
     ---------------------------------+----------------------------------------------
     bbdb                             |  %:name %:company
     irc                              |  %:server %:port %:nick
     vm, vm-imap, wl, mh, mew, rmail, |  %:type %:subject %:message-id
     gnus, notmuch                    |  %:from %:fromname %:fromaddress
                                      |  %:to   %:toname   %:toaddress
                                      |  %:date (message date header field)
                                      |  %:date-timestamp (date as active timestamp)
                                      |  %:date-timestamp-inactive (date as inactive timestamp)
                                      |  %:fromto (either "to NAME" or "from NAME")(4)
     gnus                             |  %:group, for messages also all email fields
     eww, w3, w3m                     |  %:url
     info                             |  %:file %:node
     calendar                         |  %:date
     org-protocol                     |  %:link %:description %:annotation

To place the cursor after template expansion use:

     %?          After completing the template, position cursor here.

   ---------- Footnotes ----------

   (1) If you need one of these sequences literally, escape the ‘%’ with
a backslash.

   (2) As required in Emacs Lisp, it is necessary to escape any
backslash character in a string with another backslash.  So, in order to
use ‘%\1’ placeholder, you need to write ‘%\\1’ in the template.

   (3) If you define your own link types (*note Adding hyperlink
types::), any property you store with ‘org-store-link-props’ can be
accessed in capture templates in a similar way.

   (4) This will always be the other, not the user.  See the variable
‘org-from-is-user-regexp’.


File: org.info,  Node: Templates in contexts,  Prev: Template expansion,  Up: Capture templates

9.1.3.3 Templates in contexts
.............................

To control whether a capture template should be accessible from a
specific context, you can customize ‘org-capture-templates-contexts’.
Let’s say for example that you have a capture template ‘"p"’ for storing
Gnus emails containing patches.  Then you would configure this option
like this:

     (setq org-capture-templates-contexts
           '(("p" (in-mode . "message-mode"))))

   You can also tell that the command key ‘"p"’ should refer to another
template.  In that case, add this command key like this:

     (setq org-capture-templates-contexts
           '(("p" "q" (in-mode . "message-mode"))))

   See the docstring of the variable for more information.


File: org.info,  Node: Attachments,  Next: RSS feeds,  Prev: Capture,  Up: Capture - Refile - Archive

9.2 Attachments
===============

It is often useful to associate reference material with an outline
node/task.  Small chunks of plain text can simply be stored in the
subtree of a project.  Hyperlinks (*note Hyperlinks::) can establish
associations with files that live elsewhere on your computer or in the
cloud, like emails or source code files belonging to a project.  Another
method is attachments, which are files located in a directory belonging
to an outline node.  Org uses directories named by the unique ID of each
entry.  These directories are located in the ‘data’ directory which
lives in the same directory where your Org file lives(1).  If you
initialize this directory with ‘git init’, Org will automatically commit
changes when it sees them.  The attachment system has been contributed
to Org by John Wiegley.

   In cases where it seems better to do so, you can also attach a
directory of your choice to an entry.  You can also make children
inherit the attachment directory from a parent, so that an entire
subtree uses the same attached directory.

The following commands deal with attachments:

‘C-c C-a     (org-attach)’
     The dispatcher for commands related to the attachment system.
     After these keys, a list of commands is displayed and you must
     press an additional key to select a command:

     ‘a     (org-attach-attach)’
          Select a file and move it into the task’s attachment
          directory.  The file will be copied, moved, or linked,
          depending on ‘org-attach-method’.  Note that hard links are
          not supported on all systems.

     ‘c/m/l’
          Attach a file using the copy/move/link method.  Note that hard
          links are not supported on all systems.

     ‘u     (org-attach-url)’
          Attach a file from URL

     ‘n     (org-attach-new)’
          Create a new attachment as an Emacs buffer.

     ‘z     (org-attach-sync)’
          Synchronize the current task with its attachment directory, in
          case you added attachments yourself.

     ‘o     (org-attach-open)’
          Open current task’s attachment.  If there is more than one,
          prompt for a file name first.  Opening will follow the rules
          set by ‘org-file-apps’.  For more details, see the information
          on following hyperlinks (*note Handling links::).

     ‘O     (org-attach-open-in-emacs)’
          Also open the attachment, but force opening the file in Emacs.

     ‘f     (org-attach-reveal)’
          Open the current task’s attachment directory.

     ‘F     (org-attach-reveal-in-emacs)’
          Also open the directory, but force using ‘dired’ in Emacs.

     ‘d     (org-attach-delete-one)’
          Select and delete a single attachment.

     ‘D     (org-attach-delete-all)’
          Delete all of a task’s attachments.  A safer way is to open
          the directory in ‘dired’ and delete from there.

     ‘s     (org-attach-set-directory)’
          Set a specific directory as the entry’s attachment directory.
          This works by putting the directory path into the ‘ATTACH_DIR’
          property.

     ‘i     (org-attach-set-inherit)’
          Set the ‘ATTACH_DIR_INHERIT’ property, so that children will
          use the same directory for attachments as the parent does.

   ---------- Footnotes ----------

   (1) If you move entries or Org files from one directory to another,
you may want to configure ‘org-attach-directory’ to contain an absolute
path.


File: org.info,  Node: RSS feeds,  Next: Protocols,  Prev: Attachments,  Up: Capture - Refile - Archive

9.3 RSS feeds
=============

Org can add and change entries based on information found in RSS feeds
and Atom feeds.  You could use this to make a task out of each new
podcast in a podcast feed.  Or you could use a phone-based note-creating
service on the web to import tasks into Org.  To access feeds, configure
the variable ‘org-feed-alist’.  The docstring of this variable has
detailed information.  Here is just an example:

     (setq org-feed-alist
          '(("Slashdot"
              "http://rss.slashdot.org/Slashdot/slashdot"
              "~/txt/org/feeds.org" "Slashdot Entries")))

will configure that new items from the feed provided by
‘rss.slashdot.org’ will result in new entries in the file
‘~/org/feeds.org’ under the heading ‘Slashdot Entries’, whenever the
following command is used:

‘C-c C-x g     (org-feed-update-all)’
‘C-c C-x g’
     Collect items from the feeds configured in ‘org-feed-alist’ and act
     upon them.
‘C-c C-x G     (org-feed-goto-inbox)’
     Prompt for a feed name and go to the inbox configured for this
     feed.

   Under the same headline, Org will create a drawer ‘FEEDSTATUS’ in
which it will store information about the status of items in the feed,
to avoid adding the same item several times.

   For more information, including how to read atom feeds, see
‘org-feed.el’ and the docstring of ‘org-feed-alist’.


File: org.info,  Node: Protocols,  Next: Refile and copy,  Prev: RSS feeds,  Up: Capture - Refile - Archive

9.4 Protocols for external access
=================================

Org protocol is a mean to trigger custom actions in Emacs from external
applications.  Any application that supports calling external programs
with an URL as argument may be used with this functionality.  For
example, you can configure bookmarks in your web browser to send a link
to the current page to Org and create a note from it using capture
(*note Capture::).  You can also create a bookmark that tells Emacs to
open the local source file of a remote website you are browsing.

   In order to use Org protocol from an application, you need to
register ‘org-protocol://’ as a valid scheme-handler.  External calls
are passed to Emacs through the ‘emacsclient’ command, so you also need
to ensure an Emacs server is running.  More precisely, when the
application calls

     emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2

Emacs calls the handler associated to ‘PROTOCOL’ with argument ‘(:key1
val1 :key2 val2)’.

   Org protocol comes with three predefined protocols, detailed in the
following sections.  Configure ‘org-protocol-protocol-alist’ to define
your own.

* Menu:

* store-link protocol::  Store a link, push URL to kill-ring.
* capture protocol::     Fill a buffer with external information.
* open-source protocol::  Edit published contents.


File: org.info,  Node: store-link protocol,  Next: capture protocol,  Up: Protocols

9.4.1 ‘store-link’ protocol
---------------------------

Using ‘store-link’ handler, you can copy links, insertable through ‘M-x
org-insert-link’ or yanking thereafter.  More precisely, the command

     emacsclient org-protocol://store-link?url=URL&title=TITLE

stores the following link:

     [[URL][TITLE]]

   In addition, ‘URL’ is pushed on the kill-ring for yanking.  You need
to encode ‘URL’ and ‘TITLE’ if they contain slashes, and probably quote
those for the shell.

   To use this feature from a browser, add a bookmark with an arbitrary
name, e.g., ‘Org: store-link’ and enter this as _Location_:

     javascript:location.href='org-protocol://store-link?url='+
           encodeURIComponent(location.href);


File: org.info,  Node: capture protocol,  Next: open-source protocol,  Prev: store-link protocol,  Up: Protocols

9.4.2 ‘capture’ protocol
------------------------

Activating ‘capture’ handler pops up a ‘Capture’ buffer and fills the
capture template associated to the ‘X’ key with them.

     emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY

   To use this feature, add a bookmark with an arbitrary name, e.g.
‘Org: capture’ and enter this as ‘Location’:

     javascript:location.href='org-protocol://template=x'+
           '&url='+encodeURIComponent(window.location.href)+
           '&title='+encodeURIComponent(document.title)+
           '&body='+encodeURIComponent(window.getSelection());

   The result depends on the capture template used, which is set in the
bookmark itself, as in the example above, or in
‘org-protocol-default-template-key’.

   The following template placeholders are available:

     %:link          The URL
     %:description   The webpage title
     %:annotation    Equivalent to [[%:link][%:description]]
     %i              The selected text


File: org.info,  Node: open-source protocol,  Prev: capture protocol,  Up: Protocols

9.4.3 ‘open-source’ protocol
----------------------------

The ‘open-source’ handler is designed to help with editing local sources
when reading a document.  To that effect, you can use a bookmark with
the following location:

     javascript:location.href='org-protocol://open-source?&url='+
           encodeURIComponent(location.href)

   The variable ‘org-protocol-project-alist’ maps URLs to local file
names, by stripping URL parameters from the end and replacing the
‘:base-url’ with ‘:working-directory’ and ‘:online-suffix’ with
‘:working-suffix’.  For example, assuming you own a local copy of
<https://orgmode.org/worg/> contents at ‘/home/user/worg’, you can set
‘org-protocol-project-alist’ to the following

     (setq org-protocol-project-alist
           '(("Worg"
     	 :base-url "https://orgmode.org/worg/"
     	 :working-directory "/home/user/worg/"
     	 :online-suffix ".html"
     	 :working-suffix ".org")))

If you are now browsing
<https://orgmode.org/worg/org-contrib/org-protocol.html> and find a typo
or have an idea about how to enhance the documentation, simply click the
bookmark and start editing.

   However, such mapping may not yield the desired results.  Suppose you
maintain an online store located at <http://example.com/>.  The local
sources reside in ‘/home/user/example/’.  It is common practice to serve
all products in such a store through one file and rewrite URLs that do
not match an existing file on the server.  That way, a request to
<http://example.com/print/posters.html> might be rewritten on the server
to something like
<http://example.com/shop/products.php/posters.html.php>.  The
‘open-source’ handler probably cannot find a file named
‘/home/user/example/print/posters.html.php’ and fails.

   Such an entry in ‘org-protocol-project-alist’ may hold an additional
property ‘:rewrites’.  This property is a list of cons cells, each of
which maps a regular expression to a path relative to the
‘:working-directory’.

   Now map the URL to the path ‘/home/user/example/products.php’ by
adding ‘:rewrites’ rules like this:

     (setq org-protocol-project-alist
           '(("example.com"
              :base-url "http://example.com/"
              :working-directory "/home/user/example/"
              :online-suffix ".php"
              :working-suffix ".php"
              :rewrites (("example.com/print/" . "products.php")
                         ("example.com/$" . "index.php")))))

Since ‘example.com/$’ is used as a regular expression, it maps
<http://example.com/>, <https://example.com>, <http://www.example.com/>
and similar to ‘/home/user/example/index.php’.

   The ‘:rewrites’ rules are searched as a last resort if and only if no
existing file name is matched.

   Two functions can help you filling ‘org-protocol-project-alist’ with
valid contents: ‘org-protocol-create’ and ‘org-protocol-create-for-org’.
The latter is of use if you’re editing an Org file that is part of a
publishing project.


File: org.info,  Node: Refile and copy,  Next: Archiving,  Prev: Protocols,  Up: Capture - Refile - Archive

9.5 Refile and copy
===================

When reviewing the captured data, you may want to refile or to copy some
of the entries into a different list, for example into a project.
Cutting, finding the right location, and then pasting the note is
cumbersome.  To simplify this process, you can use the following special
command:

‘C-c M-w     (org-copy)’
     Copying works like refiling, except that the original note is not
     deleted.
‘C-c C-w     (org-refile)’
     Refile the entry or region at point.  This command offers possible
     locations for refiling the entry and lets you select one with
     completion.  The item (or all items in the region) is filed below
     the target heading as a subitem.  Depending on
     ‘org-reverse-note-order’, it will be either the first or last
     subitem.
     By default, all level 1 headlines in the current buffer are
     considered to be targets, but you can have more complex definitions
     across a number of files.  See the variable ‘org-refile-targets’
     for details.  If you would like to select a location via a
     file-path-like completion along the outline path, see the variables
     ‘org-refile-use-outline-path’ and
     ‘org-outline-path-complete-in-steps’.  If you would like to be able
     to create new nodes as new parents for refiling on the fly, check
     the variable ‘org-refile-allow-creating-parent-nodes’.  When the
     variable ‘org-log-refile’(1) is set, a timestamp or a note will be
     recorded when an entry has been refiled.
‘C-u C-c C-w’
     Use the refile interface to jump to a heading.
‘C-u C-u C-c C-w     (org-refile-goto-last-stored)’
     Jump to the location where ‘org-refile’ last moved a tree to.
‘C-2 C-c C-w’
     Refile as the child of the item currently being clocked.
‘C-3 C-c C-w’
     Refile and keep the entry in place.  Also see ‘org-refile-keep’ to
     make this the default behavior, and beware that this may result in
     duplicated ‘ID’ properties.
‘C-0 C-c C-w  or  C-u C-u C-u C-c C-w     (org-refile-cache-clear)’
     Clear the target cache.  Caching of refile targets can be turned on
     by setting ‘org-refile-use-cache’.  To make the command see new
     possible targets, you have to clear the cache with this command.

   ---------- Footnotes ----------

   (1) with corresponding ‘#+STARTUP’ keywords ‘logrefile’,
‘lognoterefile’, and ‘nologrefile’


File: org.info,  Node: Archiving,  Prev: Refile and copy,  Up: Capture - Refile - Archive

9.6 Archiving
=============

When a project represented by a (sub)tree is finished, you may want to
move the tree out of the way and to stop it from contributing to the
agenda.  Archiving is important to keep your working files compact and
global searches like the construction of agenda views fast.

‘C-c C-x C-a     (org-archive-subtree-default)’
     Archive the current entry using the command specified in the
     variable ‘org-archive-default-command’.

* Menu:

* Moving subtrees::             Moving a tree to an archive file
* Internal archiving::          Switch off a tree but keep it in the file


File: org.info,  Node: Moving subtrees,  Next: Internal archiving,  Up: Archiving

9.6.1 Moving a tree to the archive file
---------------------------------------

The most common archiving action is to move a project tree to another
file, the archive file.

‘C-c C-x C-s  or short  C-c $     (org-archive-subtree)’
     Archive the subtree starting at the cursor position to the location
     given by ‘org-archive-location’.
‘C-u C-c C-x C-s’
     Check if any direct children of the current headline could be moved
     to the archive.  To do this, each subtree is checked for open TODO
     entries.  If none are found, the command offers to move it to the
     archive location.  If the cursor is _not_ on a headline when this
     command is invoked, the level 1 trees will be checked.
‘C-u C-u C-c C-x C-s’
     As above, but check subtree for timestamps instead of TODO entries.
     The command will offer to archive the subtree if it _does_ contain
     a timestamp, and that timestamp is in the past.

   The default archive location is a file in the same directory as the
current file, with the name derived by appending ‘_archive’ to the
current file name.  You can also choose what heading to file archived
items under, with the possibility to add them to a datetree in a file.
For information and examples on how to specify the file and the heading,
see the documentation string of the variable ‘org-archive-location’.

   There is also an in-buffer option for setting this variable, for
example:

     #+ARCHIVE: %s_done::

If you would like to have a special ARCHIVE location for a single entry
or a (sub)tree, give the entry an ‘:ARCHIVE:’ property with the location
as the value (*note Properties and columns::).

   When a subtree is moved, it receives a number of special properties
that record context information like the file from where the entry came,
its outline path the archiving time etc.  Configure the variable
‘org-archive-save-context-info’ to adjust the amount of information
added.


File: org.info,  Node: Internal archiving,  Prev: Moving subtrees,  Up: Archiving

9.6.2 Internal archiving
------------------------

If you want to just switch off—for agenda views—certain subtrees without
moving them to a different file, you can use the archive tag.

   A headline that is marked with the ‘:ARCHIVE:’ tag (*note Tags::)
stays at its location in the outline tree, but behaves in the following
way:
   − It does not open when you attempt to do so with a visibility
     cycling command (*note Visibility cycling::).  You can force
     cycling archived subtrees with ‘C-<TAB>’, or by setting the option
     ‘org-cycle-open-archived-trees’.  Also normal outline commands like
     ‘show-all’ will open archived subtrees.
   − During sparse tree construction (*note Sparse trees::), matches in
     archived subtrees are not exposed, unless you configure the option
     ‘org-sparse-tree-open-archived-trees’.
   − During agenda view construction (*note Agenda views::), the content
     of archived trees is ignored unless you configure the option
     ‘org-agenda-skip-archived-trees’, in which case these trees will
     always be included.  In the agenda you can press ‘v a’ to get
     archives temporarily included.
   − Archived trees are not exported (*note Exporting::), only the
     headline is.  Configure the details using the variable
     ‘org-export-with-archived-trees’.
   − Archived trees are excluded from column view unless the variable
     ‘org-columns-skip-archived-trees’ is configured to ‘nil’.

   The following commands help manage the ARCHIVE tag:

‘C-c C-x a     (org-toggle-archive-tag)’
     Toggle the ARCHIVE tag for the current headline.  When the tag is
     set, the headline changes to a shadowed face, and the subtree below
     it is hidden.
‘C-u C-c C-x a’
     Check if any direct children of the current headline should be
     archived.  To do this, each subtree is checked for open TODO
     entries.  If none are found, the command offers to set the ARCHIVE
     tag for the child.  If the cursor is _not_ on a headline when this
     command is invoked, the level 1 trees will be checked.
‘C-<TAB>     (org-force-cycle-archived)’
     Cycle a tree even if it is tagged with ARCHIVE.
‘C-c C-x A     (org-archive-to-archive-sibling)’
     Move the current entry to the _Archive Sibling_.  This is a sibling
     of the entry with the heading ‘Archive’ and the tag ‘ARCHIVE’.  The
     entry becomes a child of that sibling and in this way retains a lot
     of its original context, including inherited tags and approximate
     position in the outline.


File: org.info,  Node: Agenda views,  Next: Markup,  Prev: Capture - Refile - Archive,  Up: Top

10 Agenda views
***************

Due to the way Org works, TODO items, time-stamped items, and tagged
headlines can be scattered throughout a file or even a number of files.
To get an overview of open action items, or of events that are important
for a particular date, this information must be collected, sorted and
displayed in an organized way.

   Org can select items based on various criteria and display them in a
separate buffer.  Six different view types are provided:

   • an _agenda_ that is like a calendar and shows information for
     specific dates,
   • a _TODO list_ that covers all unfinished action items,
   • a _match view_, showings headlines based on the tags, properties,
     and TODO state associated with them,
   • a _text search view_ that shows all entries from multiple files
     that contain specified keywords,
   • a _stuck projects view_ showing projects that currently don’t move
     along, and
   • _custom views_ that are special searches and combinations of
     different views.

The extracted information is displayed in a special _agenda buffer_.
This buffer is read-only, but provides commands to visit the
corresponding locations in the original Org files, and even to edit
these files remotely.

   By default, the report ignores commented (*note Comment lines::) and
archived (*note Internal archiving::) entries.  You can override this by
setting ‘org-agenda-skip-comment-trees’ and
‘org-agenda-skip-archived-trees’ to ‘nil’.

   Two variables control how the agenda buffer is displayed and whether
the window configuration is restored when the agenda exits:
‘org-agenda-window-setup’ and ‘org-agenda-restore-windows-after-quit’.

* Menu:

* Agenda files::                Files being searched for agenda information
* Agenda dispatcher::           Keyboard access to agenda views
* Built-in agenda views::       What is available out of the box?
* Presentation and sorting::    How agenda items are prepared for display
* Agenda commands::             Remote editing of Org trees
* Custom agenda views::         Defining special searches and views
* Exporting agenda views::      Writing a view to a file
* Agenda column view::          Using column view for collected entries


File: org.info,  Node: Agenda files,  Next: Agenda dispatcher,  Up: Agenda views

10.1 Agenda files
=================

The information to be shown is normally collected from all _agenda
files_, the files listed in the variable ‘org-agenda-files’(1).  If a
directory is part of this list, all files with the extension ‘.org’ in
this directory will be part of the list.

   Thus, even if you only work with a single Org file, that file should
be put into the list(2).  You can customize ‘org-agenda-files’, but the
easiest way to maintain it is through the following commands

‘C-c [     (org-agenda-file-to-front)’
     Add current file to the list of agenda files.  The file is added to
     the front of the list.  If it was already in the list, it is moved
     to the front.  With a prefix argument, file is added/moved to the
     end.
‘C-c ]     (org-remove-file)’
     Remove current file from the list of agenda files.
‘C-'     (org-cycle-agenda-files)’
‘C-,’
     Cycle through agenda file list, visiting one file after the other.
‘M-x org-switchb <RET>’
     Command to use an ‘iswitchb’-like interface to switch to and
     between Org buffers.

The Org menu contains the current list of files and can be used to visit
any of them.

   If you would like to focus the agenda temporarily on a file not in
this list, or on just one file in the list, or even on only a subtree in
a file, then this can be done in different ways.  For a single agenda
command, you may press ‘<’ once or several times in the dispatcher
(*note Agenda dispatcher::).  To restrict the agenda scope for an
extended period, use the following commands:

‘C-c C-x <     (org-agenda-set-restriction-lock)’
     Permanently restrict the agenda to the current subtree.  When with
     a prefix argument, or with the cursor before the first headline in
     a file, the agenda scope is set to the entire file.  This
     restriction remains in effect until removed with ‘C-c C-x >’, or by
     typing either ‘<’ or ‘>’ in the agenda dispatcher.  If there is a
     window displaying an agenda view, the new restriction takes effect
     immediately.
‘C-c C-x >     (org-agenda-remove-restriction-lock)’
     Remove the permanent restriction created by ‘C-c C-x <’.

When working with ‘speedbar.el’, you can use the following commands in
the Speedbar frame:

‘< in the speedbar frame     (org-speedbar-set-agenda-restriction)’
     Permanently restrict the agenda to the item—either an Org file or a
     subtree in such a file—at the cursor in the Speedbar frame.  If
     there is a window displaying an agenda view, the new restriction
     takes effect immediately.
‘> in the speedbar frame     (org-agenda-remove-restriction-lock)’
     Lift the restriction.

   ---------- Footnotes ----------

   (1) If the value of that variable is not a list, but a single file
name, then the list of agenda files will be maintained in that external
file.

   (2) When using the dispatcher, pressing ‘<’ before selecting a
command will actually limit the command to the current file, and ignore
‘org-agenda-files’ until the next dispatcher command.


File: org.info,  Node: Agenda dispatcher,  Next: Built-in agenda views,  Prev: Agenda files,  Up: Agenda views

10.2 The agenda dispatcher
==========================

The views are created through a dispatcher, which should be bound to a
global key—for example ‘C-c a’ (*note Activation::).  In the following
we will assume that ‘C-c a’ is indeed how the dispatcher is accessed and
list keyboard access to commands accordingly.  After pressing ‘C-c a’,
an additional letter is required to execute a command.  The dispatcher
offers the following default commands:

‘a’
     Create the calendar-like agenda (*note Weekly/daily agenda::).
‘t / T’
     Create a list of all TODO items (*note Global TODO list::).
‘m / M’
     Create a list of headlines matching a TAGS expression (*note
     Matching tags and properties::).
‘s’
     Create a list of entries selected by a boolean expression of
     keywords and/or regular expressions that must or must not occur in
     the entry.
‘/’
     Search for a regular expression in all agenda files and
     additionally in the files listed in
     ‘org-agenda-text-search-extra-files’.  This uses the Emacs command
     ‘multi-occur’.  A prefix argument can be used to specify the number
     of context lines for each match, default is 1.
‘# / !’
     Create a list of stuck projects (*note Stuck projects::).
‘<’
     Restrict an agenda command to the current buffer(1).  After
     pressing ‘<’, you still need to press the character selecting the
     command.
‘< <’
     If there is an active region, restrict the following agenda command
     to the region.  Otherwise, restrict it to the current subtree(2).
     After pressing ‘< <’, you still need to press the character
     selecting the command.

‘*’
     Toggle sticky agenda views.  By default, Org maintains only a
     single agenda buffer and rebuilds it each time you change the view,
     to make sure everything is always up to date.  If you often switch
     between agenda views and the build time bothers you, you can turn
     on sticky agenda buffers or make this the default by customizing
     the variable ‘org-agenda-sticky’.  With sticky agendas, the agenda
     dispatcher will not recreate agenda views from scratch, it will
     only switch to the selected one, and you need to update the agenda
     by hand with ‘r’ or ‘g’ when needed.  You can toggle sticky agenda
     view any time with ‘org-toggle-sticky-agenda’.

   You can also define custom commands that will be accessible through
the dispatcher, just like the default commands.  This includes the
possibility to create extended agenda buffers that contain several
blocks together, for example the weekly agenda, the global TODO list and
a number of special tags matches.  *Note Custom agenda views::.

   ---------- Footnotes ----------

   (1) For backward compatibility, you can also press ‘1’ to restrict to
the current buffer.

   (2) For backward compatibility, you can also press ‘0’ to restrict to
the current region/subtree.


File: org.info,  Node: Built-in agenda views,  Next: Presentation and sorting,  Prev: Agenda dispatcher,  Up: Agenda views

10.3 The built-in agenda views
==============================

In this section we describe the built-in views.

* Menu:

* Weekly/daily agenda::         The calendar page with current tasks
* Global TODO list::            All unfinished action items
* Matching tags and properties::  Structured information with fine-tuned search
* Search view::                 Find entries by searching for text
* Stuck projects::              Find projects you need to review


File: org.info,  Node: Weekly/daily agenda,  Next: Global TODO list,  Up: Built-in agenda views

10.3.1 The weekly/daily agenda
------------------------------

The purpose of the weekly/daily _agenda_ is to act like a page of a
paper agenda, showing all the tasks for the current week or day.

‘C-c a a     (org-agenda-list)’
     Compile an agenda for the current week from a list of Org files.
     The agenda shows the entries for each day.  With a numeric
     prefix(1) (like ‘C-u 2 1 C-c a a’) you may set the number of days
     to be displayed.

   The default number of days displayed in the agenda is set by the
variable ‘org-agenda-span’ (or the obsolete ‘org-agenda-ndays’).  This
variable can be set to any number of days you want to see by default in
the agenda, or to a span name, such as ‘day’, ‘week’, ‘month’ or ‘year’.
For weekly agendas, the default is to start on the previous monday (see
‘org-agenda-start-on-weekday’).  You can also set the start date using a
date shift: ‘(setq org-agenda-start-day "+10d")’ will start the agenda
ten days from today in the future.

   Remote editing from the agenda buffer means, for example, that you
can change the dates of deadlines and appointments from the agenda
buffer.  The commands available in the Agenda buffer are listed in *note
Agenda commands::.

Calendar/Diary integration
..........................

Emacs contains the calendar and diary by Edward M. Reingold.  The
calendar displays a three-month calendar with holidays from different
countries and cultures.  The diary allows you to keep track of
anniversaries, lunar phases, sunrise/set, recurrent appointments
(weekly, monthly) and more.  In this way, it is quite complementary to
Org.  It can be very useful to combine output from Org with the diary.

   In order to include entries from the Emacs diary into Org mode’s
agenda, you only need to customize the variable

     (setq org-agenda-include-diary t)

After that, everything will happen automatically.  All diary entries
including holidays, anniversaries, etc., will be included in the agenda
buffer created by Org mode.  <SPC>, <TAB>, and <RET> can be used from
the agenda buffer to jump to the diary file in order to edit existing
diary entries.  The ‘i’ command to insert new entries for the current
date works in the agenda buffer, as well as the commands ‘S’, ‘M’, and
‘C’ to display Sunrise/Sunset times, show lunar phases and to convert to
other calendars, respectively.  ‘c’ can be used to switch back and forth
between calendar and agenda.

   If you are using the diary only for sexp entries and holidays, it is
faster to not use the above setting, but instead to copy or even move
the entries into an Org file.  Org mode evaluates diary-style sexp
entries, and does it faster because there is no overhead for first
creating the diary display.  Note that the sexp entries must start at
the left margin, no whitespace is allowed before them.  For example, the
following segment of an Org file will be processed and entries will be
made in the agenda:

     * Holidays
       :PROPERTIES:
       :CATEGORY: Holiday
       :END:
     %%(org-calendar-holiday)   ; special function for holiday names

     * Birthdays
       :PROPERTIES:
       :CATEGORY: Ann
       :END:
     %%(org-anniversary 1956  5 14)(2) Arthur Dent is %d years old
     %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old

Anniversaries from BBDB
.......................

If you are using the Big Brothers Database to store your contacts, you
will very likely prefer to store anniversaries in BBDB rather than in a
separate Org or diary file.  Org supports this and will show BBDB
anniversaries as part of the agenda.  All you need to do is to add the
following to one of your agenda files:

     * Anniversaries
       :PROPERTIES:
       :CATEGORY: Anniv
       :END:
     %%(org-bbdb-anniversaries)

   You can then go ahead and define anniversaries for a BBDB record.
Basically, you need to press ‘C-o anniversary <RET>’ with the cursor in
a BBDB record and then add the date in the format ‘YYYY-MM-DD’ or
‘MM-DD’, followed by a space and the class of the anniversary
(‘birthday’ or ‘wedding’, or a format string).  If you omit the class,
it will default to ‘birthday’.  Here are a few examples, the header for
the file ‘org-bbdb.el’ contains more detailed information.

     1973-06-22
     06-22
     1955-08-02 wedding
     2008-04-14 %s released version 6.01 of org mode, %d years ago

   After a change to BBDB, or for the first agenda display during an
Emacs session, the agenda display will suffer a short delay as Org
updates its hash with anniversaries.  However, from then on things will
be very fast—much faster in fact than a long list of
‘%%(diary-anniversary)’ entries in an Org or Diary file.

   If you would like to see upcoming anniversaries with a bit of
forewarning, you can use the following instead:

     * Anniversaries
       :PROPERTIES:
       :CATEGORY: Anniv
       :END:
     %%(org-bbdb-anniversaries-future 3)

   That will give you three days’ warning: on the anniversary date
itself and the two days prior.  The argument is optional: if omitted, it
defaults to 7.

Appointment reminders
.....................

Org can interact with Emacs appointments notification facility.  To add
the appointments of your agenda files, use the command
‘org-agenda-to-appt’.  This command lets you filter through the list of
your appointments and add only those belonging to a specific category or
matching a regular expression.  It also reads a ‘APPT_WARNTIME’ property
which will then override the value of ‘appt-message-warning-time’ for
this appointment.  See the docstring for details.

   ---------- Footnotes ----------

   (1) For backward compatibility, the universal prefix ‘C-u’ causes all
TODO entries to be listed before the agenda.  This feature is
deprecated, use the dedicated TODO list, or a block agenda instead
(*note Block agenda::).

   (2) ‘org-anniversary’ is just like ‘diary-anniversary’, but the
argument order is always according to ISO and therefore independent of
the value of ‘calendar-date-style’.


File: org.info,  Node: Global TODO list,  Next: Matching tags and properties,  Prev: Weekly/daily agenda,  Up: Built-in agenda views

10.3.2 The global TODO list
---------------------------

The global TODO list contains all unfinished TODO items formatted and
collected into a single place.

‘C-c a t     (org-todo-list)’
     Show the global TODO list.  This collects the TODO items from all
     agenda files (*note Agenda views::) into a single buffer.  By
     default, this lists items with a state the is not a DONE state.
     The buffer is in ‘agenda-mode’, so there are commands to examine
     and manipulate the TODO entries directly from that buffer (*note
     Agenda commands::).
‘C-c a T     (org-todo-list)’
     Like the above, but allows selection of a specific TODO keyword.
     You can also do this by specifying a prefix argument to ‘C-c a t’.
     You are prompted for a keyword, and you may also specify several
     keywords by separating them with ‘|’ as the boolean OR operator.
     With a numeric prefix, the Nth keyword in ‘org-todo-keywords’ is
     selected.  The ‘r’ key in the agenda buffer regenerates it, and you
     can give a prefix argument to this command to change the selected
     TODO keyword, for example ‘3 r’.  If you often need a search for a
     specific keyword, define a custom command for it (*note Agenda
     dispatcher::).
     Matching specific TODO keywords can also be done as part of a tags
     search (*note Tag searches::).

   Remote editing of TODO items means that you can change the state of a
TODO entry with a single key press.  The commands available in the TODO
list are described in *note Agenda commands::.

   Normally the global TODO list simply shows all headlines with TODO
keywords.  This list can become very long.  There are two ways to keep
it more compact:
   − Some people view a TODO item that has been _scheduled_ for
     execution or have a _deadline_ (*note Timestamps::) as no longer
     _open_.  Configure the variables
     ‘org-agenda-todo-ignore-scheduled’,
     ‘org-agenda-todo-ignore-deadlines’,
     ‘org-agenda-todo-ignore-timestamp’ and/or
     ‘org-agenda-todo-ignore-with-date’ to exclude such items from the
     global TODO list.
   − TODO items may have sublevels to break up the task into subtasks.
     In such cases it may be enough to list only the highest level TODO
     headline and omit the sublevels from the global list.  Configure
     the variable ‘org-agenda-todo-list-sublevels’ to get this behavior.


File: org.info,  Node: Matching tags and properties,  Next: Search view,  Prev: Global TODO list,  Up: Built-in agenda views

10.3.3 Matching tags and properties
-----------------------------------

If headlines in the agenda files are marked with _tags_ (*note Tags::),
or have properties (*note Properties and columns::), you can select
headlines based on this metadata and collect them into an agenda buffer.
The match syntax described here also applies when creating sparse trees
with ‘C-c / m’.

‘C-c a m     (org-tags-view)’
     Produce a list of all headlines that match a given set of tags.
     The command prompts for a selection criterion, which is a boolean
     logic expression with tags, like ‘+work+urgent-withboss’ or
     ‘work|home’ (*note Tags::).  If you often need a specific search,
     define a custom command for it (*note Agenda dispatcher::).
‘C-c a M     (org-tags-view)’
     Like ‘C-c a m’, but only select headlines that are also TODO items
     in a not-DONE state and force checking subitems (see variable
     ‘org-tags-match-list-sublevels’).  To exclude scheduled/deadline
     items, see the variable
     ‘org-agenda-tags-todo-honor-ignore-options’.  Matching specific
     TODO keywords together with a tags match is also possible, see
     *note Tag searches::.

   The commands available in the tags list are described in *note Agenda
commands::.

Match syntax
............

A search string can use Boolean operators ‘&’ for ‘AND’ and ‘|’ for
‘OR’.  ‘&’ binds more strongly than ‘|’.  Parentheses are not
implemented.  Each element in the search is either a tag, a regular
expression matching tags, or an expression like ‘PROPERTY OPERATOR
VALUE’ with a comparison operator, accessing a property value.  Each
element may be preceded by ‘-’, to select against it, and ‘+’ is
syntactic sugar for positive selection.  The ‘AND’ operator ‘&’ is
optional when ‘+’ or ‘-’ is present.  Here are some examples, using only
tags.

‘work’
     Select headlines tagged ‘:work:’.
‘work&boss’
     Select headlines tagged ‘:work:’ and ‘:boss:’.
‘+work-boss’
     Select headlines tagged ‘:work:’, but discard those also tagged
     ‘:boss:’.
‘work|laptop’
     Selects lines tagged ‘:work:’ or ‘:laptop:’.
‘work|laptop+night’
     Like before, but require the ‘:laptop:’ lines to be tagged also
     ‘:night:’.

   Instead of a tag, you may also specify a regular expression enclosed
in curly braces.  For example, ‘work+{^boss.*}’ matches headlines that
contain the tag ‘:work:’ and any tag starting with ‘boss’.

   Group tags (*note Tag hierarchy::) are expanded as regular
expressions.  E.g., if ‘:work:’ is a group tag for the group
‘:work:lab:conf:’, then searching for ‘work’ will search for
‘{\(?:work\|lab\|conf\)}’ and searching for ‘-work’ will search for all
headlines but those with one of the tags in the group (i.e.,
‘-{\(?:work\|lab\|conf\)}’).

   You may also test for properties (*note Properties and columns::) at
the same time as matching tags.  The properties may be real properties,
or special properties that represent other metadata (*note Special
properties::).  For example, the “property” ‘TODO’ represents the TODO
keyword of the entry and the “property” ‘PRIORITY’ represents the
PRIORITY keyword of the entry.

   In addition to the properties mentioned above, ‘LEVEL’ represents the
level of an entry.  So a search ‘+LEVEL=3+boss-TODO="DONE"’ lists all
level three headlines that have the tag ‘boss’ and are _not_ marked with
the TODO keyword DONE.  In buffers with ‘org-odd-levels-only’ set,
‘LEVEL’ does not count the number of stars, but ‘LEVEL=2’ will
correspond to 3 stars etc.

   Here are more examples:

‘work+TODO="WAITING"’
     Select ‘:work:’-tagged TODO lines with the specific TODO keyword
     ‘WAITING’.
‘work+TODO="WAITING"|home+TODO="WAITING"’
     Waiting tasks both at work and at home.

   When matching properties, a number of different operators can be used
to test the value of a property.  Here is a complex example:

     +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
              +With={Sarah\|Denny}+SCHEDULED>="<2008-10-11>"

The type of comparison will depend on how the comparison value is
written:
   − If the comparison value is a plain number, a numerical comparison
     is done, and the allowed operators are ‘<’, ‘=’, ‘>’, ‘<=’, ‘>=’,
     and ‘<>’.
   − If the comparison value is enclosed in double-quotes, a string
     comparison is done, and the same operators are allowed.
   − If the comparison value is enclosed in double-quotes _and_ angular
     brackets (like ‘DEADLINE<="<2008-12-24 18:30>"’), both values are
     assumed to be date/time specifications in the standard Org way, and
     the comparison will be done accordingly.  Special values that will
     be recognized are ‘"<now>"’ for now (including time), and
     ‘"<today>"’, and ‘"<tomorrow>"’ for these days at 00:00 hours,
     i.e., without a time specification.  Also strings like ‘"<+5d>"’ or
     ‘"<-2m>"’ with units ‘d’, ‘w’, ‘m’, and ‘y’ for day, week, month,
     and year, respectively, can be used.
   − If the comparison value is enclosed in curly braces, a regexp match
     is performed, with ‘=’ meaning that the regexp matches the property
     value, and ‘<>’ meaning that it does not match.

   So the search string in the example finds entries tagged ‘:work:’ but
not ‘:boss:’, which also have a priority value ‘A’, a ‘:Coffee:’
property with the value ‘unlimited’, an ‘Effort’ property that is
numerically smaller than 2, a ‘:With:’ property that is matched by the
regular expression ‘Sarah\|Denny’, and that are scheduled on or after
October 11, 2008.

   You can configure Org mode to use property inheritance during a
search, but beware that this can slow down searches considerably.  See
*note Property inheritance::, for details.

   For backward compatibility, and also for typing speed, there is also
a different way to test TODO states in a search.  For this, terminate
the tags/property part of the search string (which may include several
terms connected with ‘|’) with a ‘/’ and then specify a Boolean
expression just for TODO keywords.  The syntax is then similar to that
for tags, but should be applied with care: for example, a positive
selection on several TODO keywords cannot meaningfully be combined with
boolean AND.  However, _negative selection_ combined with AND can be
meaningful.  To make sure that only lines are checked that actually have
any TODO keyword (resulting in a speed-up), use ‘C-c a M’, or
equivalently start the TODO part after the slash with ‘!’.  Using ‘C-c a
M’ or ‘/!’ will not match TODO keywords in a DONE state.  Examples:

‘work/WAITING’
     Same as ‘work+TODO="WAITING"’
‘work/!-WAITING-NEXT’
     Select ‘:work:’-tagged TODO lines that are neither ‘WAITING’ nor
     ‘NEXT’
‘work/!+WAITING|+NEXT’
     Select ‘:work:’-tagged TODO lines that are either ‘WAITING’ or
     ‘NEXT’.


File: org.info,  Node: Search view,  Next: Stuck projects,  Prev: Matching tags and properties,  Up: Built-in agenda views

10.3.4 Search view
------------------

This agenda view is a general text search facility for Org mode entries.
It is particularly useful to find notes.

‘C-c a s     (org-search-view)’
     This is a special search that lets you select entries by matching a
     substring or specific words using a boolean logic.
   For example, the search string ‘computer equipment’ will find entries
that contain ‘computer equipment’ as a substring.  If the two words are
separated by more space or a line break, the search will still match.
Search view can also search for specific keywords in the entry, using
Boolean logic.  The search string ‘+computer +wifi -ethernet
-{8\.11[bg]}’ will search for note entries that contain the keywords
‘computer’ and ‘wifi’, but not the keyword ‘ethernet’, and which are
also not matched by the regular expression ‘8\.11[bg]’, meaning to
exclude both 8.11b and 8.11g.  The first ‘+’ is necessary to turn on
word search, other ‘+’ characters are optional.  For more details, see
the docstring of the command ‘org-search-view’.

   Note that in addition to the agenda files, this command will also
search the files listed in ‘org-agenda-text-search-extra-files’.


File: org.info,  Node: Stuck projects,  Prev: Search view,  Up: Built-in agenda views

10.3.5 Stuck projects
---------------------

If you are following a system like David Allen’s GTD to organize your
work, one of the “duties” you have is a regular review to make sure that
all projects move along.  A _stuck_ project is a project that has no
defined next actions, so it will never show up in the TODO lists Org
mode produces.  During the review, you need to identify such projects
and define next actions for them.

‘C-c a #     (org-agenda-list-stuck-projects)’
     List projects that are stuck.
‘C-c a !’
     Customize the variable ‘org-stuck-projects’ to define what a stuck
     project is and how to find it.

   You almost certainly will have to configure this view before it will
work for you.  The built-in default assumes that all your projects are
level-2 headlines, and that a project is not stuck if it has at least
one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.

   Let’s assume that you, in your own way of using Org mode, identify
projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
indicate a project that should not be considered yet.  Let’s further
assume that the TODO keyword DONE marks finished projects, and that NEXT
and TODO indicate next actions.  The tag @SHOP indicates shopping and is
a next action even without the NEXT tag.  Finally, if the project
contains the special word IGNORE anywhere, it should not be listed
either.  In this case you would start by identifying eligible projects
with a tags/todo match(1) ‘+PROJECT/-MAYBE-DONE’, and then check for
TODO, NEXT, @SHOP, and IGNORE in the subtree to identify projects that
are not stuck.  The correct customization for this is

     (setq org-stuck-projects
           '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")
                                    "\\<IGNORE\\>"))

   Note that if a project is identified as non-stuck, the subtree of
this entry will still be searched for stuck projects.

   ---------- Footnotes ----------

   (1) *Note Tag searches::.


File: org.info,  Node: Presentation and sorting,  Next: Agenda commands,  Prev: Built-in agenda views,  Up: Agenda views

10.4 Presentation and sorting
=============================

Before displaying items in an agenda view, Org mode visually prepares
the items and sorts them.  Each item occupies a single line.  The line
starts with a _prefix_ that contains the _category_ (*note Categories::)
of the item and other important information.  You can customize in which
column tags will be displayed through ‘org-agenda-tags-column’.  You can
also customize the prefix using the option ‘org-agenda-prefix-format’.
This prefix is followed by a cleaned-up version of the outline headline
associated with the item.

* Menu:

* Categories::                  Not all tasks are equal
* Time-of-day specifications::  How the agenda knows the time
* Sorting agenda items::        The order of things
* Filtering/limiting agenda items::  Dynamically narrow the agenda


File: org.info,  Node: Categories,  Next: Time-of-day specifications,  Up: Presentation and sorting

10.4.1 Categories
-----------------

The category is a broad label assigned to each agenda item.  By default,
the category is simply derived from the file name, but you can also
specify it with a special line in the buffer, like this:

     #+CATEGORY: Thesis

If you would like to have a special ‘CATEGORY’ for a single entry or a
(sub)tree, give the entry a ‘:CATEGORY:’ property with the special
category you want to apply as the value.

The display in the agenda buffer looks best if the category is not
longer than 10 characters.

You can set up icons for category by customizing the
‘org-agenda-category-icon-alist’ variable.


File: org.info,  Node: Time-of-day specifications,  Next: Sorting agenda items,  Prev: Categories,  Up: Presentation and sorting

10.4.2 Time-of-day specifications
---------------------------------

Org mode checks each agenda item for a time-of-day specification.  The
time can be part of the timestamp that triggered inclusion into the
agenda, for example as in ‘<2005-05-10 Tue 19:00>’.  Time ranges can be
specified with two timestamps, like
‘<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>’.

   In the headline of the entry itself, a time(range) may also appear as
plain text (like ‘12:45’ or a ‘8:30-1pm’).  If the agenda integrates the
Emacs diary (*note Weekly/daily agenda::), time specifications in diary
entries are recognized as well.

   For agenda display, Org mode extracts the time and displays it in a
standard 24 hour format as part of the prefix.  The example times in the
previous paragraphs would end up in the agenda like this:

         8:30-13:00 Arthur Dent lies in front of the bulldozer
        12:45...... Ford Prefect arrives and takes Arthur to the pub
        19:00...... The Vogon reads his poem
        20:30-22:15 Marvin escorts the Hitchhikers to the bridge

   If the agenda is in single-day mode, or for the display of today, the
timed entries are embedded in a time grid, like

         8:00...... ------------------
         8:30-13:00 Arthur Dent lies in front of the bulldozer
        10:00...... ------------------
        12:00...... ------------------
        12:45...... Ford Prefect arrives and takes Arthur to the pub
        14:00...... ------------------
        16:00...... ------------------
        18:00...... ------------------
        19:00...... The Vogon reads his poem
        20:00...... ------------------
        20:30-22:15 Marvin escorts the Hitchhikers to the bridge

   The time grid can be turned on and off with the variable
‘org-agenda-use-time-grid’, and can be configured with
‘org-agenda-time-grid’.


File: org.info,  Node: Sorting agenda items,  Next: Filtering/limiting agenda items,  Prev: Time-of-day specifications,  Up: Presentation and sorting

10.4.3 Sorting agenda items
---------------------------

Before being inserted into a view, the items are sorted.  How this is
done depends on the type of view.
   • For the daily/weekly agenda, the items for each day are sorted.
     The default order is to first collect all items containing an
     explicit time-of-day specification.  These entries will be shown at
     the beginning of the list, as a _schedule_ for the day.  After
     that, items remain grouped in categories, in the sequence given by
     ‘org-agenda-files’.  Within each category, items are sorted by
     priority (*note Priorities::), which is composed of the base
     priority (2000 for priority ‘A’, 1000 for ‘B’, and 0 for ‘C’), plus
     additional increments for overdue scheduled or deadline items.
   • For the TODO list, items remain in the order of categories, but
     within each category, sorting takes place according to priority
     (*note Priorities::).  The priority used for sorting derives from
     the priority cookie, with additions depending on how close an item
     is to its due or scheduled date.
   • For tags matches, items are not sorted at all, but just appear in
     the sequence in which they are found in the agenda files.

   Sorting can be customized using the variable
‘org-agenda-sorting-strategy’, and may also include criteria based on
the estimated effort of an entry (*note Effort estimates::).


File: org.info,  Node: Filtering/limiting agenda items,  Prev: Sorting agenda items,  Up: Presentation and sorting

10.4.4 Filtering/limiting agenda items
--------------------------------------

Agenda built-in or customized commands are statically defined.  Agenda
filters and limits provide two ways of dynamically narrowing down the
list of agenda entries: _filters_ and _limits_.  Filters only act on the
display of the items, while limits take effect before the list of agenda
entries is built.  Filters are more often used interactively, while
limits are mostly useful when defined as local variables within custom
agenda commands.

Filtering in the agenda
.......................

‘/     (org-agenda-filter-by-tag)’
     Filter the agenda view with respect to a tag and/or effort
     estimates.  The difference between this and a custom agenda command
     is that filtering is very fast, so that you can switch quickly
     between different filters without having to recreate the agenda.(1)

     You will be prompted for a tag selection letter; <SPC> will mean
     any tag at all.  Pressing <TAB> at that prompt will offer use
     completion to select a tag (including any tags that do not have a
     selection character).  The command then hides all entries that do
     not contain or inherit this tag.  When called with prefix arg,
     remove the entries that _do_ have the tag.  A second ‘/’ at the
     prompt will turn off the filter and unhide any hidden entries.
     Pressing ‘+’ or ‘-’ switches between filtering and excluding the
     next tag.

     Org also supports automatic, context-aware tag filtering.  If the
     variable ‘org-agenda-auto-exclude-function’ is set to a
     user-defined function, that function can decide which tags should
     be excluded from the agenda automatically.  Once this is set, the
     ‘/’ command then accepts ‘<RET>’ as a sub-option key and runs the
     auto exclusion logic.  For example, let’s say you use a ‘Net’ tag
     to identify tasks which need network access, an ‘Errand’ tag for
     errands in town, and a ‘Call’ tag for making phone calls.  You
     could auto-exclude these tags based on the availability of the
     Internet, and outside of business hours, with something like this:

          (defun org-my-auto-exclude-function (tag)
            (and (cond
                  ((string= tag "Net")
                   (/= 0 (call-process "/sbin/ping" nil nil nil
                                       "-c1" "-q" "-t1" "mail.gnu.org")))
                  ((or (string= tag "Errand") (string= tag "Call"))
                   (let ((hour (nth 2 (decode-time))))
                     (or (< hour 8) (> hour 21)))))
                 (concat "-" tag)))

          (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)

‘[ ] { }’
     in search view
          add new search words (‘[’ and ‘]’) or new regular expressions
          (‘{’ and ‘}’) to the query string.  The opening bracket/brace
          will add a positive search term prefixed by ‘+’, indicating
          that this search term must occur/match in the entry.  The
          closing bracket/brace will add a negative search term which
          must not occur/match in the entry for it to be selected.

‘<     (org-agenda-filter-by-category)’

     Filter the current agenda view with respect to the category of the
     item at point.  Pressing ‘<’ another time will remove this filter.
     When called with a prefix argument exclude the category of the item
     at point from the agenda.

     You can add a filter preset in custom agenda commands through the
     option ‘org-agenda-category-filter-preset’.  *Note Setting
     options::.

‘^     (org-agenda-filter-by-top-headline)’
     Filter the current agenda view and only display the siblings and
     the parent headline of the one at point.

‘=     (org-agenda-filter-by-regexp)’

     Filter the agenda view by a regular expression: only show agenda
     entries matching the regular expression the user entered.  When
     called with a prefix argument, it will filter _out_ entries
     matching the regexp.  With two universal prefix arguments, it will
     remove all the regexp filters, which can be accumulated.

     You can add a filter preset in custom agenda commands through the
     option ‘org-agenda-regexp-filter-preset’.  *Note Setting options::.

‘_     (org-agenda-filter-by-effort)’
     Filter the agenda view with respect to effort estimates.  You first
     need to set up allowed efforts globally, for example
          (setq org-global-properties
              '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
     You can then filter for an effort by first typing an operator, one
     of ‘<’, ‘>’, and ‘=’, and then the one-digit index of an effort
     estimate in your array of allowed values, where ‘0’ means the 10th
     value.  The filter will then restrict to entries with effort
     smaller-or-equal, equal, or larger-or-equal than the selected
     value.  For application of the operator, entries without a defined
     effort will be treated according to the value of
     ‘org-sort-agenda-noeffort-is-high’.

     When called with a prefix argument, it will remove entries matching
     the condition.  With two universal prefix arguments, it will clear
     effort filters, which can be accumulated.

     You can add a filter preset in custom agenda commands through the
     option ‘org-agenda-effort-filter-preset’.  *Note Setting options::.

‘|     (org-agenda-filter-remove-all)’
     Remove all filters in the current agenda view.

Setting limits for the agenda
.............................

Here is a list of options that you can set, either globally, or locally
in your custom agenda views (*note Custom agenda views::).

‘org-agenda-max-entries’
     Limit the number of entries.
‘org-agenda-max-effort’
     Limit the duration of accumulated efforts (as minutes).
‘org-agenda-max-todos’
     Limit the number of entries with TODO keywords.
‘org-agenda-max-tags’
     Limit the number of tagged entries.

   When set to a positive integer, each option will exclude entries from
other categories: for example, ‘(setq org-agenda-max-effort 100)’ will
limit the agenda to 100 minutes of effort and exclude any entry that has
no effort property.  If you want to include entries with no effort
property, use a negative value for ‘org-agenda-max-effort’.

   One useful setup is to use ‘org-agenda-max-entries’ locally in a
custom command.  For example, this custom command will display the next
five entries with a ‘NEXT’ TODO keyword.

     (setq org-agenda-custom-commands
           '(("n" todo "NEXT"
              ((org-agenda-max-entries 5)))))

   Once you mark one of these five entry as ‘DONE’, rebuilding the
agenda will again the next five entries again, including the first entry
that was excluded so far.

   You can also dynamically set temporary limits, which will be lost
when rebuilding the agenda:

‘~     (org-agenda-limit-interactively)’
     This prompts for the type of limit to apply and its value.

   ---------- Footnotes ----------

   (1) Custom commands can preset a filter by binding the variable
‘org-agenda-tag-filter-preset’ as an option.  This filter will then be
applied to the view and persist as a basic filter through refreshes and
more secondary filtering.  The filter is a global property of the entire
agenda view—in a block agenda, you should only set this in the global
options section, not in the section of an individual block.


File: org.info,  Node: Agenda commands,  Next: Custom agenda views,  Prev: Presentation and sorting,  Up: Agenda views

10.5 Commands in the agenda buffer
==================================

Entries in the agenda buffer are linked back to the Org file or diary
file where they originate.  You are not allowed to edit the agenda
buffer itself, but commands are provided to show and jump to the
original entry location, and to edit the Org files “remotely” from the
agenda buffer.  In this way, all information is stored only once,
removing the risk that your agenda and note files may diverge.

   Some commands can be executed with mouse clicks on agenda lines.  For
the other commands, the cursor needs to be in the desired line.

     Motion
     ......

‘n     (org-agenda-next-line)’
     Next line (same as <DOWN> and ‘C-n’).
‘p     (org-agenda-previous-line)’
     Previous line (same as <UP> and ‘C-p’).
‘N     (org-agenda-next-item)’
     Next item: same as next line, but only consider items.
‘P     (org-agenda-previous-item)’
     Previous item: same as previous line, but only consider items.

     View/Go to Org file
     ...................

‘<SPC>  or  mouse-3     (org-agenda-show-and-scroll-up)’
     Display the original location of the item in another window.  With
     prefix arg, make sure that drawers stay folded.
‘L     (org-agenda-recenter)’
     Display original location and recenter that window.
‘<TAB>  or  mouse-2     (org-agenda-goto)’
     Go to the original location of the item in another window.
‘<RET>     (org-agenda-switch-to)’
     Go to the original location of the item and delete other windows.
‘F     (org-agenda-follow-mode)’
     Toggle Follow mode.  In Follow mode, as you move the cursor through
     the agenda buffer, the other window always shows the corresponding
     location in the Org file.  The initial setting for this mode in new
     agenda buffers can be set with the variable
     ‘org-agenda-start-with-follow-mode’.
‘C-c C-x b     (org-agenda-tree-to-indirect-buffer)’
     Display the entire subtree of the current item in an indirect
     buffer.  With a numeric prefix argument N, go up to level N and
     then take that tree.  If N is negative, go up that many levels.
     With a ‘C-u’ prefix, do not remove the previously used indirect
     buffer.

‘C-c C-o     (org-agenda-open-link)’
     Follow a link in the entry.  This will offer a selection of any
     links in the text belonging to the referenced Org node.  If there
     is only one link, it will be followed without a selection prompt.

     Change display
     ..............

‘A’
     Interactively select another agenda view and append it to the
     current view.
‘o’
     Delete other windows.
‘v d  or short  d     (org-agenda-day-view)’
‘v w  or short  w     (org-agenda-week-view)’
‘v t     (org-agenda-fortnight-view)’
‘v m     (org-agenda-month-view)’
‘v y     (org-agenda-year-view)’
‘v <SPC>     (org-agenda-reset-view)’
     Switch to day/week/month/year view.  When switching to day or week
     view, this setting becomes the default for subsequent agenda
     refreshes.  Since month and year views are slow to create, they do
     not become the default.  A numeric prefix argument may be used to
     jump directly to a specific day of the year, ISO week, month, or
     year, respectively.  For example, ‘32 d’ jumps to February 1st, ‘9
     w’ to ISO week number 9.  When setting day, week, or month view, a
     year may be encoded in the prefix argument as well.  For example,
     ‘200712 w’ will jump to week 12 in 2007.  If such a year
     specification has only one or two digits, it will be mapped to the
     interval 1938–2037.  ‘v <SPC>’ will reset to what is set in
     ‘org-agenda-span’.
‘f     (org-agenda-later)’
     Go forward in time to display the following
     ‘org-agenda-current-span’ days.  For example, if the display covers
     a week, switch to the following week.  With prefix arg, go forward
     that many times ‘org-agenda-current-span’ days.
‘b     (org-agenda-earlier)’
     Go backward in time to display earlier dates.
‘.     (org-agenda-goto-today)’
     Go to today.
‘j     (org-agenda-goto-date)’
     Prompt for a date and go there.
‘J     (org-agenda-clock-goto)’
     Go to the currently clocked-in task in the agenda buffer.
‘D     (org-agenda-toggle-diary)’
     Toggle the inclusion of diary entries.  See *note Weekly/daily
     agenda::.
‘v l  or short  l     (org-agenda-log-mode)’
     Toggle Logbook mode.  In Logbook mode, entries that were marked
     DONE while logging was on (variable ‘org-log-done’) are shown in
     the agenda, as are entries that have been clocked on that day.  You
     can configure the entry types that should be included in log mode
     using the variable ‘org-agenda-log-mode-items’.  When called with a
     ‘C-u’ prefix, show all possible logbook entries, including state
     changes.  When called with two prefix arguments ‘C-u C-u’, show
     only logging information, nothing else.  ‘v L’ is equivalent to
     ‘C-u v l’.
‘v [  or short  [     (org-agenda-manipulate-query-add)’
     Include inactive timestamps into the current view.  Only for
     weekly/daily agenda.
‘v a     (org-agenda-archives-mode)’
‘v A     (org-agenda-archives-mode 'files)’
     Toggle Archives mode.  In Archives mode, trees that are marked
     ‘ARCHIVED’ are also scanned when producing the agenda.  When you
     use the capital ‘A’, even all archive files are included.  To exit
     archives mode, press ‘v a’ again.
‘v R  or short  R     (org-agenda-clockreport-mode)’
     Toggle Clockreport mode.  In Clockreport mode, the daily/weekly
     agenda will always show a table with the clocked times for the time
     span and file scope covered by the current agenda view.  The
     initial setting for this mode in new agenda buffers can be set with
     the variable ‘org-agenda-start-with-clockreport-mode’.  By using a
     prefix argument when toggling this mode (i.e., ‘C-u R’), the clock
     table will not show contributions from entries that are hidden by
     agenda filtering(1).  See also the variable
     ‘org-clock-report-include-clocking-task’.
‘v c’
     Show overlapping clock entries, clocking gaps, and other clocking
     problems in the current agenda range.  You can then visit clocking
     lines and fix them manually.  See the variable
     ‘org-agenda-clock-consistency-checks’ for information on how to
     customize the definition of what constituted a clocking problem.
     To return to normal agenda display, press ‘l’ to exit Logbook mode.
‘v E  or short  E     (org-agenda-entry-text-mode)’
     Toggle entry text mode.  In entry text mode, a number of lines from
     the Org outline node referenced by an agenda line will be displayed
     below the line.  The maximum number of lines is given by the
     variable ‘org-agenda-entry-text-maxlines’.  Calling this command
     with a numeric prefix argument will temporarily modify that number
     to the prefix value.
‘G     (org-agenda-toggle-time-grid)’
     Toggle the time grid on and off.  See also the variables
     ‘org-agenda-use-time-grid’ and ‘org-agenda-time-grid’.
‘r     (org-agenda-redo)’
     Recreate the agenda buffer, for example to reflect the changes
     after modification of the timestamps of items with ‘S-<LEFT>’ and
     ‘S-<RIGHT>’.  When the buffer is the global TODO list, a prefix
     argument is interpreted to create a selective list for a specific
     TODO keyword.
‘g     (org-agenda-redo)’
     Same as ‘r’.
‘C-x C-s  or short  s     (org-save-all-org-buffers)’
     Save all Org buffers in the current Emacs session, and also the
     locations of IDs.
‘C-c C-x C-c     (org-agenda-columns)’
     Invoke column view (*note Column view::) in the agenda buffer.  The
     column view format is taken from the entry at point, or (if there
     is no entry at point), from the first entry in the agenda view.  So
     whatever the format for that entry would be in the original buffer
     (taken from a property, from a ‘#+COLUMNS’ line, or from the
     default variable ‘org-columns-default-format’), will be used in the
     agenda.

‘C-c C-x >     (org-agenda-remove-restriction-lock)’
     Remove the restriction lock on the agenda, if it is currently
     restricted to a file or subtree (*note Agenda files::).

     Secondary filtering and query editing
     .....................................

     For a detailed description of these commands, *note
     Filtering/limiting agenda items::.

‘/     (org-agenda-filter-by-tag)’
     Filter the agenda view with respect to a tag and/or effort
     estimates.

‘<     (org-agenda-filter-by-category)’
     Filter the current agenda view with respect to the category of the
     item at point.

‘^     (org-agenda-filter-by-top-headline)’
     Filter the current agenda view and only display the siblings and
     the parent headline of the one at point.

‘=     (org-agenda-filter-by-regexp)’
     Filter the agenda view by a regular expression.

‘_     (org-agenda-filter-by-effort)’
     Filter the agenda view with respect to effort estimates.

‘|     (org-agenda-filter-remove-all)’
     Remove all filters in the current agenda view.

     Remote editing
     ..............

‘0--9’
     Digit argument.
‘C-_     (org-agenda-undo)’
     Undo a change due to a remote editing command.  The change is
     undone both in the agenda buffer and in the remote buffer.
‘t     (org-agenda-todo)’
     Change the TODO state of the item, both in the agenda and in the
     original org file.
‘C-S-<RIGHT>     (org-agenda-todo-nextset)’
‘C-S-<LEFT>     (org-agenda-todo-previousset)’
     Switch to the next/previous set of TODO keywords.
‘C-k     (org-agenda-kill)’
     Delete the current agenda item along with the entire subtree
     belonging to it in the original Org file.  If the text to be
     deleted remotely is longer than one line, the kill needs to be
     confirmed by the user.  See variable ‘org-agenda-confirm-kill’.
‘C-c C-w     (org-agenda-refile)’
     Refile the entry at point.
‘C-c C-x C-a  or short  a     (org-agenda-archive-default-with-confirmation)’
     Archive the subtree corresponding to the entry at point using the
     default archiving command set in ‘org-archive-default-command’.
     When using the ‘a’ key, confirmation will be required.
‘C-c C-x a     (org-agenda-toggle-archive-tag)’
     Toggle the ARCHIVE tag for the current headline.
‘C-c C-x A     (org-agenda-archive-to-archive-sibling)’
     Move the subtree corresponding to the current entry to its _archive
     sibling_.
‘C-c C-x C-s  or short  $     (org-agenda-archive)’
     Archive the subtree corresponding to the current headline.  This
     means the entry will be moved to the configured archive location,
     most likely a different file.
‘T     (org-agenda-show-tags)’
     Show all tags associated with the current item.  This is useful if
     you have turned off ‘org-agenda-show-inherited-tags’, but still
     want to see all tags of a headline occasionally.
‘:     (org-agenda-set-tags)’
     Set tags for the current headline.  If there is an active region in
     the agenda, change a tag for all headings in the region.
‘,’
     Set the priority for the current item (‘org-agenda-priority’).  Org
     mode prompts for the priority character.  If you reply with <SPC>,
     the priority cookie is removed from the entry.
‘P     (org-agenda-show-priority)’
     Display weighted priority of current item.
‘+  or  S-<UP>     (org-agenda-priority-up)’
     Increase the priority of the current item.  The priority is changed
     in the original buffer, but the agenda is not resorted.  Use the
     ‘r’ key for this.
‘-  or  S-<DOWN>     (org-agenda-priority-down)’
     Decrease the priority of the current item.
‘z  or  C-c C-z     (org-agenda-add-note)’
     Add a note to the entry.  This note will be recorded, and then
     filed to the same location where state change notes are put.
     Depending on ‘org-log-into-drawer’, this may be inside a drawer.
‘C-c C-a     (org-attach)’
     Dispatcher for all command related to attachments.
‘C-c C-s     (org-agenda-schedule)’
     Schedule this item.  With prefix arg remove the scheduling
     timestamp
‘C-c C-d     (org-agenda-deadline)’
     Set a deadline for this item.  With prefix arg remove the deadline.
‘S-<RIGHT>     (org-agenda-do-date-later)’
     Change the timestamp associated with the current line by one day
     into the future.  If the date is in the past, the first call to
     this command will move it to today.
     With a numeric prefix argument, change it by that many days.  For
     example, ‘3 6 5 S-<RIGHT>’ will change it by a year.  With a ‘C-u’
     prefix, change the time by one hour.  If you immediately repeat the
     command, it will continue to change hours even without the prefix
     arg.  With a double ‘C-u C-u’ prefix, do the same for changing
     minutes.
     The stamp is changed in the original Org file, but the change is
     not directly reflected in the agenda buffer.  Use ‘r’ or ‘g’ to
     update the buffer.
‘S-<LEFT>     (org-agenda-do-date-earlier)’
     Change the timestamp associated with the current line by one day
     into the past.
‘>     (org-agenda-date-prompt)’
     Change the timestamp associated with the current line.  The key ‘>’
     has been chosen, because it is the same as ‘S-.’ on my keyboard.
‘I     (org-agenda-clock-in)’
     Start the clock on the current item.  If a clock is running
     already, it is stopped first.
‘O     (org-agenda-clock-out)’
     Stop the previously started clock.
‘X     (org-agenda-clock-cancel)’
     Cancel the currently running clock.
‘J     (org-agenda-clock-goto)’
     Jump to the running clock in another window.
‘k     (org-agenda-capture)’
     Like ‘org-capture’, but use the date at point as the default date
     for the capture template.  See ‘org-capture-use-agenda-date’ to
     make this the default behavior of ‘org-capture’.

     Dragging agenda lines forward/backward
     ......................................

‘M-<up>     (org-agenda-drag-line-backward)’
     Drag the line at point backward one line(2).  With a numeric prefix
     argument, drag backward by that many lines.

‘M-<down>     (org-agenda-drag-line-forward)’
     Drag the line at point forward one line.  With a numeric prefix
     argument, drag forward by that many lines.

     Bulk remote editing selected entries
     ....................................

‘m     (org-agenda-bulk-mark)’
     Mark the entry at point for bulk action.  With numeric prefix
     argument, mark that many successive entries.
‘*     (org-agenda-bulk-mark-all)’
     Mark all visible agenda entries for bulk action.
‘u     (org-agenda-bulk-unmark)’
     Unmark entry at point for bulk action.
‘U     (org-agenda-bulk-remove-all-marks)’
     Unmark all marked entries for bulk action.
‘M-m     (org-agenda-bulk-toggle)’
     Toggle mark of the entry at point for bulk action.
‘M-*     (org-agenda-bulk-toggle-all)’
     Toggle marks of all visible entries for bulk action.
‘%     (org-agenda-bulk-mark-regexp)’
     Mark entries matching a regular expression for bulk action.
‘B     (org-agenda-bulk-action)’
     Bulk action: act on all marked entries in the agenda.  This will
     prompt for another key to select the action to be applied.  The
     prefix arg to ‘B’ will be passed through to the ‘s’ and ‘d’
     commands, to bulk-remove these special timestamps.  By default,
     marks are removed after the bulk.  If you want them to persist, set
     ‘org-agenda-persistent-marks’ to ‘t’ or hit ‘p’ at the prompt.

     ‘*’
          Toggle persistent marks.
     ‘$’
          Archive all selected entries.
     ‘A’
          Archive entries by moving them to their respective archive
          siblings.
     ‘t’
          Change TODO state.  This prompts for a single TODO keyword and
          changes the state of all selected entries, bypassing blocking
          and suppressing logging notes (but not timestamps).
     ‘+’
          Add a tag to all selected entries.
     ‘-’
          Remove a tag from all selected entries.
     ‘s’
          Schedule all items to a new date.  To shift existing schedule
          dates by a fixed number of days, use something starting with
          double plus at the prompt, for example ‘++8d’ or ‘++2w’.
     ‘d’
          Set deadline to a specific date.
     ‘r’
          Prompt for a single refile target and move all entries.  The
          entries will no longer be in the agenda; refresh (‘g’) to
          bring them back.
     ‘S’
          Reschedule randomly into the coming N days.  N will be
          prompted for.  With prefix arg (‘C-u B S’), scatter only
          across weekdays.
     ‘f’
          Apply a function(3) to marked entries.  For example, the
          function below sets the CATEGORY property of the entries to
          web.

               (defun set-category ()
                 (interactive "P")
                 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
                                    (org-agenda-error)))
                        (buffer (marker-buffer marker)))
                   (with-current-buffer buffer
                     (save-excursion
                       (save-restriction
                         (widen)
                         (goto-char marker)
                         (org-back-to-heading t)
                         (org-set-property "CATEGORY" "web"))))))

     Calendar commands
     .................

‘c     (org-agenda-goto-calendar)’
     Open the Emacs calendar and move to the date at the agenda cursor.
‘c     (org-calendar-goto-agenda)’
     When in the calendar, compute and show the Org mode agenda for the
     date at the cursor.
‘i     (org-agenda-diary-entry)’
     Insert a new entry into the diary, using the date at the cursor and
     (for block entries) the date at the mark.  This will add to the
     Emacs diary file(4), in a way similar to the ‘i’ command in the
     calendar.  The diary file will pop up in another window, where you
     can add the entry.

     If you configure ‘org-agenda-diary-file’ to point to an Org mode
     file, Org will create entries (in Org mode syntax) in that file
     instead.  Most entries will be stored in a date-based outline tree
     that will later make it easy to archive appointments from previous
     months/years.  The tree will be built under an entry with a
     ‘DATE_TREE’ property, or else with years as top-level entries.
     Emacs will prompt you for the entry text—if you specify it, the
     entry will be created in ‘org-agenda-diary-file’ without further
     interaction.  If you directly press <RET> at the prompt without
     typing text, the target file will be shown in another window for
     you to finish the entry there.  See also the ‘k r’ command.
‘M     (org-agenda-phases-of-moon)’
     Show the phases of the moon for the three months around current
     date.
‘S     (org-agenda-sunrise-sunset)’
     Show sunrise and sunset times.  The geographical location must be
     set with calendar variables, see the documentation for the Emacs
     calendar.
‘C     (org-agenda-convert-date)’
     Convert the date at cursor into many other cultural and historic
     calendars.
‘H     (org-agenda-holidays)’
     Show holidays for three months around the cursor date.

‘M-x org-icalendar-combine-agenda-files <RET>’
     Export a single iCalendar file containing entries from all agenda
     files.  This is a globally available command, and also available in
     the agenda menu.

     Exporting to a file
     ...................

‘C-x C-w     (org-agenda-write)’
     Write the agenda view to a file.  Depending on the extension of the
     selected file name, the view will be exported as HTML (‘.html’ or
     ‘.htm’), Postscript (‘.ps’), PDF (‘.pdf’), Org (‘.org’) and plain
     text (any other extension).  When exporting to Org, only the body
     of original headlines are exported, not subtrees or inherited tags.
     When called with a ‘C-u’ prefix argument, immediately open the
     newly created file.  Use the variable
     ‘org-agenda-exporter-settings’ to set options for ‘ps-print’ and
     for ‘htmlize’ to be used during export.

     Quit and Exit
     .............

‘q     (org-agenda-quit)’
     Quit agenda, remove the agenda buffer.
‘x     (org-agenda-exit)’
     Exit agenda, remove the agenda buffer and all buffers loaded by
     Emacs for the compilation of the agenda.  Buffers created by the
     user to visit Org files will not be removed.

   ---------- Footnotes ----------

   (1) Only tags filtering will be respected here, effort filtering is
ignored.

   (2) Moving agenda lines does not persist after an agenda refresh and
does not modify the contributing ‘.org’ files

   (3) You can also create persistent custom functions through
‘org-agenda-bulk-custom-functions’.

   (4) This file is parsed for the agenda when
‘org-agenda-include-diary’ is set.


File: org.info,  Node: Custom agenda views,  Next: Exporting agenda views,  Prev: Agenda commands,  Up: Agenda views

10.6 Custom agenda views
========================

Custom agenda commands serve two purposes: to store and quickly access
frequently used TODO and tags searches, and to create special composite
agenda buffers.  Custom agenda commands will be accessible through the
dispatcher (*note Agenda dispatcher::), just like the default commands.

* Menu:

* Storing searches::            Type once, use often
* Block agenda::                All the stuff you need in a single buffer
* Setting options::             Changing the rules


File: org.info,  Node: Storing searches,  Next: Block agenda,  Up: Custom agenda views

10.6.1 Storing searches
-----------------------

The first application of custom searches is the definition of keyboard
shortcuts for frequently used searches, either creating an agenda
buffer, or a sparse tree (the latter covering of course only the current
buffer).

   Custom commands are configured in the variable
‘org-agenda-custom-commands’.  You can customize this variable, for
example by pressing ‘C-c a C’.  You can also directly set it with Emacs
Lisp in the Emacs init file.  The following example contains all valid
agenda views:

     (setq org-agenda-custom-commands
           '(("x" agenda)
             ("y" agenda*)
             ("w" todo "WAITING")
             ("W" todo-tree "WAITING")
             ("u" tags "+boss-urgent")
             ("v" tags-todo "+boss-urgent")
             ("U" tags-tree "+boss-urgent")
             ("f" occur-tree "\\<FIXME\\>")
             ("h" . "HOME+Name tags searches") ; description for "h" prefix
             ("hl" tags "+home+Lisa")
             ("hp" tags "+home+Peter")
             ("hk" tags "+home+Kim")))

The initial string in each entry defines the keys you have to press
after the dispatcher command ‘C-c a’ in order to access the command.
Usually this will be just a single character, but if you have many
similar commands, you can also define two-letter combinations where the
first character is the same in several combinations and serves as a
prefix key(1).  The second parameter is the search type, followed by the
string or regular expression to be used for the matching.  The example
above will therefore define:

‘C-c a x’
     as a global search for agenda entries planned(2) this week/day.
‘C-c a y’
     as a global search for agenda entries planned this week/day, but
     only those with an hour specification like ‘[h]h:mm’—think of them
     as appointments.
‘C-c a w’
     as a global search for TODO entries with ‘WAITING’ as the TODO
     keyword
‘C-c a W’
     as the same search, but only in the current buffer and displaying
     the results as a sparse tree
‘C-c a u’
     as a global tags search for headlines marked ‘:boss:’ but not
     ‘:urgent:’
‘C-c a v’
     as the same search as ‘C-c a u’, but limiting the search to
     headlines that are also TODO items
‘C-c a U’
     as the same search as ‘C-c a u’, but only in the current buffer and
     displaying the result as a sparse tree
‘C-c a f’
     to create a sparse tree (again: current buffer only) with all
     entries containing the word ‘FIXME’
‘C-c a h’
     as a prefix command for a HOME tags search where you have to press
     an additional key (‘l’, ‘p’ or ‘k’) to select a name (Lisa, Peter,
     or Kim) as additional tag to match.

   Note that the ‘*-tree’ agenda views need to be called from an Org
buffer as they operate on the current buffer only.

   ---------- Footnotes ----------

   (1) You can provide a description for a prefix key by inserting a
cons cell with the prefix and the description.

   (2) _Planned_ means here that these entries have some planning
information attached to them, like a time-stamp, a scheduled or a
deadline string.  See ‘org-agenda-entry-types’ on how to set what
planning information will be taken into account.


File: org.info,  Node: Block agenda,  Next: Setting options,  Prev: Storing searches,  Up: Custom agenda views

10.6.2 Block agenda
-------------------

Another possibility is the construction of agenda views that comprise
the results of _several_ commands, each of which creates a block in the
agenda buffer.  The available commands include ‘agenda’ for the daily or
weekly agenda (as created with ‘C-c a a’), ‘alltodo’ for the global TODO
list (as constructed with ‘C-c a t’), and the matching commands
discussed above: ‘todo’, ‘tags’, and ‘tags-todo’.  Here are two
examples:

     (setq org-agenda-custom-commands
           '(("h" "Agenda and Home-related tasks"
              ((agenda "")
               (tags-todo "home")
               (tags "garden")))
             ("o" "Agenda and Office-related tasks"
              ((agenda "")
               (tags-todo "work")
               (tags "office")))))

This will define ‘C-c a h’ to create a multi-block view for stuff you
need to attend to at home.  The resulting agenda buffer will contain
your agenda for the current week, all TODO items that carry the tag
‘home’, and also all lines tagged with ‘garden’.  Finally the command
‘C-c a o’ provides a similar view for office tasks.


File: org.info,  Node: Setting options,  Prev: Block agenda,  Up: Custom agenda views

10.6.3 Setting options for custom commands
------------------------------------------

Org mode contains a number of variables regulating agenda construction
and display.  The global variables define the behavior for all agenda
commands, including the custom commands.  However, if you want to change
some settings just for a single custom view, you can do so.  Setting
options requires inserting a list of variable names and values at the
right spot in ‘org-agenda-custom-commands’.  For example:

     (setq org-agenda-custom-commands
           '(("w" todo "WAITING"
              ((org-agenda-sorting-strategy '(priority-down))
               (org-agenda-prefix-format "  Mixed: ")))
             ("U" tags-tree "+boss-urgent"
              ((org-show-context-detail 'minimal)))
             ("N" search ""
              ((org-agenda-files '("~org/notes.org"))
               (org-agenda-text-search-extra-files nil)))))

Now the ‘C-c a w’ command will sort the collected entries only by
priority, and the prefix format is modified to just say ‘ Mixed: ’
instead of giving the category of the entry.  The sparse tags tree of
‘C-c a U’ will now turn out ultra-compact, because neither the headline
hierarchy above the match, nor the headline following the match will be
shown.  The command ‘C-c a N’ will do a text search limited to only a
single file.

   For command sets creating a block agenda,
‘org-agenda-custom-commands’ has two separate spots for setting options.
You can add options that should be valid for just a single command in
the set, and options that should be valid for all commands in the set.
The former are just added to the command entry; the latter must come
after the list of command entries.  Going back to the block agenda
example (*note Block agenda::), let’s change the sorting strategy for
the ‘C-c a h’ commands to ‘priority-down’, but let’s sort the results
for GARDEN tags query in the opposite order, ‘priority-up’.  This would
look like this:

     (setq org-agenda-custom-commands
           '(("h" "Agenda and Home-related tasks"
              ((agenda)
               (tags-todo "home")
               (tags "garden"
                     ((org-agenda-sorting-strategy '(priority-up)))))
              ((org-agenda-sorting-strategy '(priority-down))))
             ("o" "Agenda and Office-related tasks"
              ((agenda)
               (tags-todo "work")
               (tags "office")))))

   As you see, the values and parentheses setting is a little complex.
When in doubt, use the customize interface to set this variable—it fully
supports its structure.  Just one caveat: when setting options in this
interface, the _values_ are just Lisp expressions.  So if the value is a
string, you need to add the double-quotes around the value yourself.

   To control whether an agenda command should be accessible from a
specific context, you can customize
‘org-agenda-custom-commands-contexts’.  Let’s say for example that you
have an agenda command ‘"o"’ displaying a view that you only need when
reading emails.  Then you would configure this option like this:

     (setq org-agenda-custom-commands-contexts
           '(("o" (in-mode . "message-mode"))))

   You can also tell that the command key ‘"o"’ should refer to another
command key ‘"r"’.  In that case, add this command key like this:

     (setq org-agenda-custom-commands-contexts
           '(("o" "r" (in-mode . "message-mode"))))

   See the docstring of the variable for more information.


File: org.info,  Node: Exporting agenda views,  Next: Agenda column view,  Prev: Custom agenda views,  Up: Agenda views

10.7 Exporting agenda views
===========================

If you are away from your computer, it can be very useful to have a
printed version of some agenda views to carry around.  Org mode can
export custom agenda views as plain text, HTML(1), Postscript, PDF(2),
and iCalendar files.  If you want to do this only occasionally, use the
command

‘C-x C-w     (org-agenda-write)’
     Write the agenda view to a file.  Depending on the extension of the
     selected file name, the view will be exported as HTML (extension
     ‘.html’ or ‘.htm’), Postscript (extension ‘.ps’), iCalendar
     (extension ‘.ics’), or plain text (any other extension).  Use the
     variable ‘org-agenda-exporter-settings’ to set options for
     ‘ps-print’ and for ‘htmlize’ to be used during export, for example

          (setq org-agenda-exporter-settings
                '((ps-number-of-columns 2)
                  (ps-landscape-mode t)
                  (org-agenda-add-entry-text-maxlines 5)
                  (htmlize-output-type 'css)))

   If you need to export certain agenda views frequently, you can
associate any custom agenda command with a list of output file names
(3).  Here is an example that first defines custom commands for the
agenda and the global TODO list, together with a number of files to
which to export them.  Then we define two block agenda commands and
specify file names for them as well.  File names can be relative to the
current working directory, or absolute.

     (setq org-agenda-custom-commands
           '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
             ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
             ("h" "Agenda and Home-related tasks"
              ((agenda "")
               (tags-todo "home")
               (tags "garden"))
              nil
              ("~/views/home.html"))
             ("o" "Agenda and Office-related tasks"
              ((agenda)
               (tags-todo "work")
               (tags "office"))
              nil
              ("~/views/office.ps" "~/calendars/office.ics"))))

   The extension of the file name determines the type of export.  If it
is ‘.html’, Org mode will try to use the ‘htmlize.el’ package to convert
the buffer to HTML and save it to this file name.  If the extension is
‘.ps’, ‘ps-print-buffer-with-faces’ is used to produce Postscript
output.  If the extension is ‘.ics’, iCalendar export is run export over
all files that were used to construct the agenda, and limit the export
to entries listed in the agenda.  Any other extension produces a plain
ASCII file.

   The export files are _not_ created when you use one of those commands
interactively because this might use too much overhead.  Instead, there
is a special command to produce _all_ specified files in one step:

‘C-c a e     (org-store-agenda-views)’
     Export all agenda views that have export file names associated with
     them.

   You can use the options section of the custom agenda commands to also
set options for the export commands.  For example:

     (setq org-agenda-custom-commands
           '(("X" agenda ""
              ((ps-number-of-columns 2)
               (ps-landscape-mode t)
               (org-agenda-prefix-format " [ ] ")
               (org-agenda-with-colors nil)
               (org-agenda-remove-tags t))
              ("theagenda.ps"))))

This command sets two options for the Postscript exporter, to make it
print in two columns in landscape format—the resulting page can be cut
in two and then used in a paper agenda.  The remaining settings modify
the agenda prefix to omit category and scheduling information, and
instead include a checkbox to check off items.  We also remove the tags
to make the lines compact, and we don’t want to use colors for the
black-and-white printer.  Settings specified in
‘org-agenda-exporter-settings’ will also apply, but the settings in
‘org-agenda-custom-commands’ take precedence.

From the command line you may also use
     emacs -eval (org-batch-store-agenda-views) -kill
or, if you need to modify some parameters(4)
     emacs -eval '(org-batch-store-agenda-views                      \
                   org-agenda-span (quote month)                     \
                   org-agenda-start-day "2007-11-01"                 \
                   org-agenda-include-diary nil                      \
                   org-agenda-files (quote ("~/org/project.org")))'  \
           -kill
which will create the agenda views restricted to the file
‘~/org/project.org’, without diary entries and with a 30-day extent.

   You can also extract agenda information in a way that allows further
processing by other programs.  See *note Extracting agenda
information::, for more information.

   ---------- Footnotes ----------

   (1) You need to install ‘htmlize.el’ from Hrvoje Niksic’s repository.
(https://github.com/hniksic/emacs-htmlize)

   (2) To create PDF output, the ghostscript ‘ps2pdf’ utility must be
installed on the system.  Selecting a PDF file will also create the
postscript file.

   (3) If you want to store standard views like the weekly agenda or the
global TODO list as well, you need to define custom commands for them in
order to be able to specify file names.

   (4) Quoting depends on the system you use, please check the FAQ for
examples.


File: org.info,  Node: Agenda column view,  Prev: Exporting agenda views,  Up: Agenda views

10.8 Using column view in the agenda
====================================

Column view (*note Column view::) is normally used to view and edit
properties embedded in the hierarchical structure of an Org file.  It
can be quite useful to use column view also from the agenda, where
entries are collected by certain criteria.

‘C-c C-x C-c     (org-agenda-columns)’
     Turn on column view in the agenda.

   To understand how to use this properly, it is important to realize
that the entries in the agenda are no longer in their proper outline
environment.  This causes the following issues:

  1. Org needs to make a decision which ‘COLUMNS’ format to use.  Since
     the entries in the agenda are collected from different files, and
     different files may have different ‘COLUMNS’ formats, this is a
     non-trivial problem.  Org first checks if the variable
     ‘org-agenda-overriding-columns-format’ is currently set, and if so,
     takes the format from there.  Otherwise it takes the format
     associated with the first item in the agenda, or, if that item does
     not have a specific format—defined in a property, or in its file—it
     uses ‘org-columns-default-format’.

  2. If any of the columns has a summary type defined (*note Column
     attributes::), turning on column view in the agenda will visit all
     relevant agenda files and make sure that the computations of this
     property are up to date.  This is also true for the special
     ‘CLOCKSUM’ property.  Org will then sum the values displayed in the
     agenda.  In the daily/weekly agenda, the sums will cover a single
     day; in all other views they cover the entire block.  It is vital
     to realize that the agenda may show the same entry _twice_—for
     example as scheduled and as a deadline—and it may show two entries
     from the same hierarchy—for example a _parent_ and its _child_.  In
     these cases, the summation in the agenda will lead to incorrect
     results because some values will count double.

  3. When the column view in the agenda shows the ‘CLOCKSUM’, that is
     always the entire clocked time for this item.  So even in the
     daily/weekly agenda, the clocksum listed in column view may
     originate from times outside the current view.  This has the
     advantage that you can compare these values with a column listing
     the planned total effort for a task—one of the major applications
     for column view in the agenda.  If you want information about
     clocked time in the displayed period use clock table mode (press
     ‘R’ in the agenda).

  4. When the column view in the agenda shows the ‘CLOCKSUM_T’, that is
     always today’s clocked time for this item.  So even in the weekly
     agenda, the clocksum listed in column view only originates from
     today.  This lets you compare the time you spent on a task for
     today, with the time already spent —via ‘CLOCKSUM’—and with the
     planned total effort for it.


File: org.info,  Node: Markup,  Next: Exporting,  Prev: Agenda views,  Up: Top

11 Markup for rich export
*************************

When exporting Org mode documents, the exporter tries to reflect the
structure of the document as accurately as possible in the back-end.
Since export targets like HTML and LaTeX allow much richer formatting,
Org mode has rules on how to prepare text for rich export.  This section
summarizes the markup rules used in an Org mode buffer.

* Menu:

* Paragraphs::                  The basic unit of text
* Emphasis and monospace::      Bold, italic, etc.
* Horizontal rules::            Make a line
* Images and tables::           Images, tables and caption mechanism
* Literal examples::            Source code examples with special formatting
* Special symbols::             Greek letters and other symbols
* Subscripts and superscripts::  Simple syntax for raising/lowering text
* Embedded LaTeX::           LaTeX can be freely used inside Org documents


File: org.info,  Node: Paragraphs,  Next: Emphasis and monospace,  Up: Markup

11.1 Paragraphs, line breaks, and quoting
=========================================

Paragraphs are separated by at least one empty line.  If you need to
enforce a line break within a paragraph, use ‘\\’ at the end of a line.

   To preserve the line breaks, indentation and blank lines in a region,
but otherwise use normal formatting, you can use this construct, which
can also be used to format poetry.

     #+BEGIN_VERSE
      Great clouds overhead
      Tiny black birds rise and fall
      Snow covers Emacs

          -- AlexSchroeder
     #+END_VERSE

   When quoting a passage from another document, it is customary to
format this as a paragraph that is indented on both the left and the
right margin.  You can include quotations in Org mode documents like
this:

     #+BEGIN_QUOTE
     Everything should be made as simple as possible,
     but not any simpler -- Albert Einstein
     #+END_QUOTE

   If you would like to center some text, do it like this:
     #+BEGIN_CENTER
     Everything should be made as simple as possible, \\
     but not any simpler
     #+END_CENTER


File: org.info,  Node: Emphasis and monospace,  Next: Horizontal rules,  Prev: Paragraphs,  Up: Markup

11.2 Emphasis and monospace
===========================

You can make words *bold*, /italic/, _underlined_, ‘=verbatim=’ and
‘~code~’, and, if you must, ‘+strike-through+’.  Text in the code and
verbatim string is not processed for Org mode specific syntax, it is
exported verbatim.

   To turn off fontification for marked up text, you can set
‘org-fontify-emphasized-text’ to ‘nil’.  To narrow down the list of
available markup syntax, you can customize ‘org-emphasis-alist’.  To
fine tune what characters are allowed before and after the markup
characters, you can tweak ‘org-emphasis-regexp-components’.  Beware that
changing one of the above variables will not take effect until you
reload Org, for which you may need to restart Emacs.


File: org.info,  Node: Horizontal rules,  Next: Images and tables,  Prev: Emphasis and monospace,  Up: Markup

11.3 Horizontal rules
=====================

A line consisting of only dashes, and at least 5 of them, will be
exported as a horizontal line.


File: org.info,  Node: Images and tables,  Next: Literal examples,  Prev: Horizontal rules,  Up: Markup

11.4 Images and Tables
======================

Both the native Org mode tables (*note Tables::) and tables formatted
with the ‘table.el’ package will be exported properly.  For Org mode
tables, the lines before the first horizontal separator line will become
table header lines.  You can use the following lines somewhere before
the table to assign a caption and a label for cross references, and in
the text you can refer to the object with ‘[[tab:basic-data]]’ (*note
Internal links::):

     #+CAPTION: This is the caption for the next table (or link)
     #+NAME:   tab:basic-data
        | ... | ...|
        |-----|----|

   Optionally, the caption can take the form:
     #+CAPTION[Caption for list of tables]: Caption for table.

   Some back-ends allow you to directly include images into the exported
document.  Org does this, if a link to an image files does not have a
description part, for example ‘[[./img/a.jpg]]’.  If you wish to define
a caption for the image and maybe a label for internal cross references,
make sure that the link is on a line by itself and precede it with
‘#+CAPTION’ and ‘#+NAME’ as follows:

     #+CAPTION: This is the caption for the next figure link (or table)
     #+NAME:   fig:SED-HR4049
     [[./img/a.jpg]]

Such images can be displayed within the buffer.  *Note the discussion of
image links: Handling links.

   Even though images and tables are prominent examples of captioned
structures, the same caption mechanism can apply to many others (e.g.,
LaTeX equations, source code blocks).  Depending on the export back-end,
those may or may not be handled.


File: org.info,  Node: Literal examples,  Next: Special symbols,  Prev: Images and tables,  Up: Markup

11.5 Literal examples
=====================

You can include literal examples that should not be subjected to markup.
Such examples will be typeset in monospace, so this is well suited for
source code and similar examples.

     #+BEGIN_EXAMPLE
     Some example from a text file.
     #+END_EXAMPLE

   Note that such blocks may be indented in order to align nicely with
indented text and in particular with plain list structure (*note Plain
lists::).  For simplicity when using small examples, you can also start
the example lines with a colon followed by a space.  There may also be
additional whitespace before the colon:

     Here is an example
        : Some example from a text file.

   If the example is source code from a programming language, or any
other text that can be marked up by font-lock in Emacs, you can ask for
the example to look like the fontified Emacs buffer(1).  This is done
with the ‘src’ block, where you also need to specify the name of the
major mode that should be used to fontify the example(2), see *note Easy
templates:: for shortcuts to easily insert code blocks.

     #+BEGIN_SRC emacs-lisp
       (defun org-xor (a b)
          "Exclusive or."
          (if a (not b) b))
     #+END_SRC

   Both in ‘example’ and in ‘src’ snippets, you can add a ‘-n’ switch to
the end of the ‘BEGIN’ line, to get the lines of the example numbered.
The ‘-n’ takes an optional numeric argument specifying the starting line
number of the block.  If you use a ‘+n’ switch, the numbering from the
previous numbered snippet will be continued in the current one.  The
‘+n’ can also take a numeric argument.  The value of the argument will
be added to the last line of the previous block to determine the
starting line number.

     #+BEGIN_SRC emacs-lisp -n 20
      ;; this will export with line number 20
      (message "This is line 21")
     #+END_SRC
     #+BEGIN_SRC emacs-lisp +n 10
      ;; This will be listed as line 31
      (message "This is line 32")
     #+END_SRC

   In literal examples, Org will interpret strings like ‘(ref:name)’ as
labels, and use them as targets for special hyperlinks like ‘[[(name)]]’
(i.e., the reference name enclosed in single parenthesis).  In HTML,
hovering the mouse over such a link will remote-highlight the
corresponding code line, which is kind of cool.

   You can also add a ‘-r’ switch which removes the labels from the
source code(3).  With the ‘-n’ switch, links to these references will be
labeled by the line numbers from the code listing, otherwise links will
use the labels with no parentheses.  Here is an example:

     #+BEGIN_SRC emacs-lisp -n -r
     (save-excursion                  (ref:sc)
        (goto-char (point-min)))      (ref:jump)
     #+END_SRC
     In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
     jumps to point-min.

   Finally, you can use ‘-i’ to preserve the indentation of a specific
code block (*note Editing source code::).

   If the syntax for the label format conflicts with the language
syntax, use a ‘-l’ switch to change the format, for example ‘#+BEGIN_SRC
pascal -n -r -l "((%s))"’.  See also the variable
‘org-coderef-label-format’.

   HTML export also allows examples to be published as text areas (*note
Text areas in HTML export::).

   Because the ‘#+BEGIN_...’ and ‘#+END_...’ patterns need to be added
so often, shortcuts are provided using the Easy templates facility
(*note Easy templates::).

‘C-c '’
     Edit the source code example at point in its native mode.  This
     works by switching to a temporary buffer with the source code.  You
     need to exit by pressing ‘C-c '’ again(4).  The edited version will
     then replace the old version in the Org buffer.  Fixed-width
     regions (where each line starts with a colon followed by a space)
     will be edited using ‘artist-mode’(5) to allow creating ASCII
     drawings easily.  Using this command in an empty line will create a
     new fixed-width region.
‘C-c l’
     Calling ‘org-store-link’ while editing a source code example in a
     temporary buffer created with ‘C-c '’ will prompt for a label.
     Make sure that it is unique in the current buffer, and insert it
     with the proper formatting like ‘(ref:label)’ at the end of the
     current line.  Then the label is stored as a link ‘(label)’, for
     retrieval with ‘C-c C-l’.

   ---------- Footnotes ----------

   (1) This works automatically for the HTML back-end (it requires
version 1.34 of the ‘htmlize.el’ package, which you need to install).
Fontified code chunks in LaTeX can be achieved using either the
<https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en>
or the <https://github.com/gpoore/minted> package.  If you use minted or
listing, you must load the packages manually, for example by adding the
desired package to ‘org-latex-packages-alist’.  Refer to
‘org-latex-listings’ for details.

   (2) Code in ‘src’ blocks may also be evaluated either interactively
or on export.  *Note Working with source code::, for more information on
evaluating code blocks.

   (3) Adding ‘-k’ to ‘-n -r’ will keep the labels in the source code
while using line numbers for the links, which might be useful to explain
those in an Org mode example code.

   (4) Upon exit, lines starting with ‘*’, ‘,*’, ‘#+’ and ‘,#+’ will get
a comma prepended, to keep them from being interpreted by Org as outline
nodes or special syntax.  These commas will be stripped for editing with
‘C-c '’, and also for export.

   (5) You may select a different-mode with the variable
‘org-edit-fixed-width-region-mode’.


File: org.info,  Node: Special symbols,  Next: Subscripts and superscripts,  Prev: Literal examples,  Up: Markup

11.6 Special symbols
====================

You can use LaTeX-like syntax to insert special symbols—named
entities—like ‘\alpha’ to indicate the Greek letter, or ‘\to’ to
indicate an arrow.  Completion for these symbols is available, just type
‘\’ and maybe a few letters, and press ‘M-<TAB>’ to see possible
completions.  If you need such a symbol inside a word, terminate it with
a pair of curly brackets.  For example

     Pro tip: Given a circle \Gamma of diameter d, the length of its circumference
     is \pi{}d.

   A large number of entities is provided, with names taken from both
HTML and LaTeX; you can comfortably browse the complete list from a
dedicated buffer using the command ‘org-entities-help’.  It is also
possible to provide your own special symbols in the variable
‘org-entities-user’.

   During export, these symbols are transformed into the native format
of the exporter back-end.  Strings like ‘\alpha’ are exported as
‘&alpha;’ in the HTML output, and as ‘\(\alpha\)’ in the LaTeX output.
Similarly, ‘\nbsp’ becomes ‘&nbsp;’ in HTML and ‘~’ in LaTeX.

   Entities may also be used as a may to escape markup in an Org
document, e.g., ‘\under{}not underlined\under’ exports as ‘_not
underlined_’.

   If you would like to see entities displayed as UTF-8 characters, use
the following command(1):

‘C-c C-x \’
     Toggle display of entities as UTF-8 characters.  This does not
     change the buffer content which remains plain ASCII, but it
     overlays the UTF-8 character for display purposes only.

   In addition to regular entities defined above, Org exports in a
special way(2) the following commonly used character combinations: ‘\-’
is treated as a shy hyphen, ‘--’ and ‘---’ are converted into dashes,
and ‘...’ becomes a compact set of dots.

   ---------- Footnotes ----------

   (1) You can turn this on by default by setting the variable
‘org-pretty-entities’, or on a per-file base with the ‘#+STARTUP’ option
‘entitiespretty’.

   (2) This behavior can be disabled with ‘-’ export setting (*note
Export settings::).


File: org.info,  Node: Subscripts and superscripts,  Next: Embedded LaTeX,  Prev: Special symbols,  Up: Markup

11.7 Subscripts and superscripts
================================

‘^’ and ‘_’ are used to indicate super- and subscripts.  To increase the
readability of ASCII text, it is not necessary—but OK—to surround
multi-character sub- and superscripts with curly braces.  Those are,
however, mandatory, when more than one word is involved.  For example

     The radius of the sun is R_sun = 6.96 x 10^8 m.  On the other hand, the
     radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}.

   If you write a text where the underscore is often used in a different
context, Org’s convention to always interpret these as subscripts can
get in your way.  Configure the variable ‘org-use-sub-superscripts’ to
change this convention.  For example, when setting this variable to
‘{}’, ‘a_b’ will not be interpreted as a subscript, but ‘a_{b}’ will.

‘C-c C-x \’
     In addition to showing entities as UTF-8 characters, this command
     will also format sub- and superscripts in a WYSIWYM way.


File: org.info,  Node: Embedded LaTeX,  Prev: Subscripts and superscripts,  Up: Markup

11.8 Embedded LaTeX
===================

Plain ASCII is normally sufficient for almost all note taking.
Exceptions include scientific notes, which often require mathematical
symbols and the occasional formula.  LaTeX(1) is widely used to typeset
scientific documents.  Org mode supports embedding LaTeX code into its
files, because many academics are used to writing and reading LaTeX
source code, and because it can be readily processed to produce pretty
output for a number of export back-ends.

* Menu:

* LaTeX fragments::          Complex formulas made easy
* Previewing LaTeX fragments::  What will this snippet look like?
* CDLaTeX mode::                Speed up entering of formulas

   ---------- Footnotes ----------

   (1) LaTeX is a macro system based on Donald E. Knuth’s TeX system.
Many of the features described here as “LaTeX” are really from TeX, but
for simplicity I am blurring this distinction.


File: org.info,  Node: LaTeX fragments,  Next: Previewing LaTeX fragments,  Up: Embedded LaTeX

11.8.1 LaTeX fragments
----------------------

Org mode can contain LaTeX math fragments, and it supports ways to
process these for several export back-ends.  When exporting to LaTeX,
the code is left as it is.  When exporting to HTML, Org can use either
MathJax (http://www.mathjax.org) (*note Math formatting in HTML
export::) or transcode the math into images (*note Previewing LaTeX
fragments::).

   LaTeX fragments don’t need any special marking at all.  The following
snippets will be identified as LaTeX source code:
   • Environments of any kind(1).  The only requirement is that the
     ‘\begin’ statement appears on a new line, at the beginning of the
     line or after whitespaces only.
   • Text within the usual LaTeX math delimiters.  To avoid conflicts
     with currency specifications, single ‘$’ characters are only
     recognized as math delimiters if the enclosed text contains at most
     two line breaks, is directly attached to the ‘$’ characters with no
     whitespace in between, and if the closing ‘$’ is followed by
     whitespace or punctuation (parentheses and quotes are considered to
     be punctuation in this context).  For the other delimiters, there
     is no such restriction, so when in doubt, use ‘\(...\)’ as inline
     math delimiters.

For example:

     \begin{equation}
     x=\sqrt{b}
     \end{equation}

     If $a^2=b$ and \( b=2 \), then the solution must be
     either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].

   LaTeX processing can be configured with the variable
‘org-export-with-latex’.  The default setting is ‘t’ which means MathJax
for HTML, and no processing for ASCII and LaTeX back-ends.  You can also
set this variable on a per-file basis using one of these lines:

     #+OPTIONS: tex:t          Do the right thing automatically (MathJax)
     #+OPTIONS: tex:nil        Do not process LaTeX fragments at all
     #+OPTIONS: tex:verbatim   Verbatim export, for jsMath or so

   ---------- Footnotes ----------

   (1) When MathJax is used, only the environments recognized by MathJax
will be processed.  When ‘dvipng’ program, ‘dvisvgm’ program or
‘imagemagick’ suite is used to create images, any LaTeX environment will
be handled.


File: org.info,  Node: Previewing LaTeX fragments,  Next: CDLaTeX mode,  Prev: LaTeX fragments,  Up: Embedded LaTeX

11.8.2 Previewing LaTeX fragments
---------------------------------

If you have a working LaTeX installation and ‘dvipng’, ‘dvisvgm’ or
‘convert’ installed(1), LaTeX fragments can be processed to produce
images of the typeset expressions to be used for inclusion while
exporting to HTML (*note LaTeX fragments::), or for inline previewing
within Org mode.

   You can customize the variables ‘org-format-latex-options’ and
‘org-format-latex-header’ to influence some aspects of the preview.  In
particular, the ‘:scale’ (and for HTML export, ‘:html-scale’) property
of the former can be used to adjust the size of the preview images.

‘C-c C-x C-l’
     Produce a preview image of the LaTeX fragment at point and overlay
     it over the source code.  If there is no fragment at point, process
     all fragments in the current entry (between two headlines).  When
     called with a prefix argument, process the entire subtree.  When
     called with two prefix arguments, or when the cursor is before the
     first headline, process the entire buffer.
‘C-c C-c’
     Remove the overlay preview images.

   You can turn on the previewing of all LaTeX fragments in a file with

     #+STARTUP: latexpreview

   To disable it, simply use

     #+STARTUP: nolatexpreview

   ---------- Footnotes ----------

   (1) These are respectively available at
<http://sourceforge.net/projects/dvipng/>, <http://dvisvgm.bplaced.net/>
and from the ‘imagemagick’ suite.  Choose the converter by setting the
variable ‘org-preview-latex-default-process’ accordingly.


File: org.info,  Node: CDLaTeX mode,  Prev: Previewing LaTeX fragments,  Up: Embedded LaTeX

11.8.3 Using CDLaTeX to enter math
----------------------------------

CDLaTeX mode is a minor mode that is normally used in combination with a
major LaTeX mode like AUCTeX in order to speed-up insertion of
environments and math templates.  Inside Org mode, you can make use of
some of the features of CDLaTeX mode.  You need to install ‘cdlatex.el’
and ‘texmathp.el’ (the latter comes also with AUCTeX) from
<https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex>.  Don’t use CDLaTeX
mode itself under Org mode, but use the light version ‘org-cdlatex-mode’
that comes as part of Org mode.  Turn it on for the current buffer with
‘M-x org-cdlatex-mode <RET>’, or for all Org files with

     (add-hook 'org-mode-hook 'turn-on-org-cdlatex)

   When this mode is enabled, the following features are present (for
more details see the documentation of CDLaTeX mode):
   • Environment templates can be inserted with ‘C-c {’.
   • The <TAB> key will do template expansion if the cursor is inside a
     LaTeX fragment(1).  For example, <TAB> will expand ‘fr’ to
     ‘\frac{}{}’ and position the cursor correctly inside the first
     brace.  Another <TAB> will get you into the second brace.  Even
     outside fragments, <TAB> will expand environment abbreviations at
     the beginning of a line.  For example, if you write ‘equ’ at the
     beginning of a line and press <TAB>, this abbreviation will be
     expanded to an ‘equation’ environment.  To get a list of all
     abbreviations, type ‘M-x cdlatex-command-help <RET>’.
   • Pressing ‘_’ and ‘^’ inside a LaTeX fragment will insert these
     characters together with a pair of braces.  If you use <TAB> to
     move out of the braces, and if the braces surround only a single
     character or macro, they are removed again (depending on the
     variable ‘cdlatex-simplify-sub-super-scripts’).
   • Pressing the grave accent ‘`’ followed by a character inserts math
     macros, also outside LaTeX fragments.  If you wait more than 1.5
     seconds after the grave accent, a help window will pop up.
   • Pressing the apostrophe ‘'’ followed by another character modifies
     the symbol before point with an accent or a font.  If you wait more
     than 1.5 seconds after the apostrophe, a help window will pop up.
     Character modification will work only inside LaTeX fragments;
     outside the quote is normal.

   ---------- Footnotes ----------

   (1) Org mode has a method to test if the cursor is inside such a
fragment, see the documentation of the function
‘org-inside-LaTeX-fragment-p’.


File: org.info,  Node: Exporting,  Next: Publishing,  Prev: Markup,  Up: Top

12 Exporting
************

Sometimes, you may want to pretty print your notes, publish them on the
web or even share them with people not using Org.  In these cases, the
Org export facilities can be used to convert your documents to a variety
of other formats, while retaining as much structure (*note Document
structure::) and markup (*note Markup::) as possible.

   Libraries responsible for such translation are called back-ends.  Org
ships with the following ones

   • ascii (ASCII format)
   • beamer (LaTeX Beamer format)
   • html (HTML format)
   • icalendar (iCalendar format)
   • latex (LaTeX format)
   • md (Markdown format)
   • odt (OpenDocument Text format)
   • org (Org format)
   • texinfo (Texinfo format)
   • man (Man page format)

Org also uses additional libraries located in ‘contrib/’ directory
(*note Installation::).  Users can install additional export libraries
for additional formats from the Emacs packaging system.  For easy
discovery, these packages have a common naming scheme: ‘ox-NAME’, where
NAME is one of the formats.  For example, ‘ox-koma-letter’ for
‘koma-letter’ back-end.

   Org loads back-ends for the following formats by default: ‘ascii’,
‘html’, ‘icalendar’, ‘latex’ and ‘odt’.

   Org can load additional back-ends either of two ways: through the
‘org-export-backends’ variable configuration; or, by requiring the
library in the Emacs init file like this:

     (require 'ox-md)

* Menu:

* The export dispatcher::       The main interface
* Export settings::             Common export settings
* Table of contents::           The if and where of the table of contents
* Include files::               Include additional files into a document
* Macro replacement::           Use macros to create templates
* Comment lines::               What will not be exported
* ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
* Beamer export::               Exporting as a Beamer presentation
* HTML export::                 Exporting to HTML
* LaTeX export::             Exporting to LaTeX, and processing to PDF
* Markdown export::             Exporting to Markdown
* OpenDocument Text export::    Exporting to OpenDocument Text
* Org export::                  Exporting to Org
* Texinfo export::              Exporting to Texinfo
* iCalendar export::            Exporting to iCalendar
* Other built-in back-ends::    Exporting to a man page
* Advanced configuration::      Fine-tuning the export output
* Export in foreign buffers::   Author tables and lists in Org syntax


File: org.info,  Node: The export dispatcher,  Next: Export settings,  Up: Exporting

12.1 The export dispatcher
==========================

The export dispatcher is the main interface for Org’s exports.  A
hierarchical menu presents the currently configured export formats.
Options are shown as easy toggle switches on the same screen.

   Org also has a minimal prompt interface for the export dispatcher.
When the variable ‘org-export-dispatch-use-expert-ui’ is set to a
non-‘nil’ value, Org prompts in the minibuffer.  To switch back to the
hierarchical menu, press <?>.

‘C-c C-e’     (‘org-export-dispatch’)

     Invokes the export dispatcher interface.  The options show default
     settings.  The ‘C-u’ prefix argument preserves options from the
     previous export, including any sub-tree selections.

   Org exports the entire buffer by default.  If the Org buffer has an
active region, then Org exports just that region.

   These are the export options, the key combinations that toggle them
(*note Export settings::):

‘C-a’
     Toggles asynchronous export.  Asynchronous export uses an external
     Emacs process with a specially configured initialization file to
     complete the exporting process in the background thereby releasing
     the current interface.  This is particularly useful when exporting
     long documents.

     Output from an asynchronous export is saved on the “the export
     stack”.  To view this stack, call the export dispatcher with a
     double ‘C-u’ prefix argument.  If already in the export dispatcher
     menu, ‘&’ displays the stack.

     To make the background export process the default, customize the
     variable, ‘org-export-in-background’.

‘C-b’
     Toggle body-only export.  Useful for excluding headers and footers
     in the export.  Affects only those back-end formats that have such
     sections—like ‘<head>...</head>’ in HTML.

‘C-s’
     Toggle sub-tree export.  When turned on, Org exports only the
     sub-tree starting from the cursor position at the time the export
     dispatcher was invoked.  Org uses the top heading of this sub-tree
     as the document’s title.  If the cursor is not on a heading, Org
     uses the nearest enclosing header.  If the cursor is in the
     document preamble, Org signals an error and aborts export.

     To make the sub-tree export the default, customize the variable,
     ‘org-export-initial-scope’.

‘C-v’
     Toggle visible-only export.  Useful for exporting only visible
     parts of an Org document by adjusting outline visibility settings.


File: org.info,  Node: Export settings,  Next: Table of contents,  Prev: The export dispatcher,  Up: Exporting

12.2 Export settings
====================

Export options can be set: globally with variables; for an individual
file by making variables buffer-local with in-buffer settings (*note
In-buffer settings::), by setting individual keywords, or by specifying
them in a compact form with the ‘#+OPTIONS’ keyword; or for a tree by
setting properties (*note Properties and columns::).  Options set at a
specific level override options set at a more general level.

   In-buffer settings may appear anywhere in the file, either directly
or indirectly through a file included using ‘#+SETUPFILE: filename or
URL’ syntax.  Option keyword sets tailored to a particular back-end can
be inserted from the export dispatcher (*note The export dispatcher::)
using the ‘Insert template’ command by pressing ‘#’.  To insert keywords
individually, a good way to make sure the keyword is correct is to type
‘#+’ and then to use ‘M-<TAB>’(1) for completion.

   The export keywords available for every back-end, and their
equivalent global variables, include:

‘AUTHOR’
     The document author (‘user-full-name’).

‘CREATOR’
     Entity responsible for output generation
     (‘org-export-creator-string’).

‘DATE’
     A date or a time-stamp(2).

‘EMAIL’
     The email address (‘user-mail-address’).

‘LANGUAGE’
     Language to use for translating certain strings
     (‘org-export-default-language’).  With ‘#+LANGUAGE: fr’, for
     example, Org translates _Table of contents_ to the French _Table
     des matières_.

‘SELECT_TAGS’
     The default value is ‘:export:’.  When a tree is tagged with
     ‘:export:’ (‘org-export-select-tags’), Org selects that tree and
     its sub-trees for export.  Org excludes trees with ‘:noexport:’
     tags, see below.  When selectively exporting files with ‘:export:’
     tags set, Org does not export any text that appears before the
     first headline.

‘EXCLUDE_TAGS’
     The default value is ‘:noexport:’.  When a tree is tagged with
     ‘:noexport:’ (‘org-export-exclude-tags’), Org excludes that tree
     and its sub-trees from export.  Entries tagged with ‘:noexport:’
     will be unconditionally excluded from the export, even if they have
     an ‘:export:’ tag.  Even if a sub-tree is not exported, Org will
     execute any code blocks contained in them.

‘TITLE’
     Org displays this title.  For long titles, use multiple ‘#+TITLE’
     lines.

‘EXPORT_FILE_NAME’
     The name of the output file to be generated.  Otherwise, Org
     generates the file name based on the buffer name and the extension
     based on the back-end format.

   The ‘#+OPTIONS’ keyword is a compact form.  To configure multiple
options, use several ‘#+OPTIONS’ lines.  ‘#+OPTIONS’ recognizes the
following arguments.

‘':’
     Toggle smart quotes (‘org-export-with-smart-quotes’).  Depending on
     the language used, when activated, Org treats pairs of double
     quotes as primary quotes, pairs of single quotes as secondary
     quotes, and single quote marks as apostrophes.

‘*:’
     Toggle emphasized text (‘org-export-with-emphasize’).

‘-:’
     Toggle conversion of special strings
     (‘org-export-with-special-strings’).

‘::’
     Toggle fixed-width sections (‘org-export-with-fixed-width’).

‘<:’
     Toggle inclusion of time/date active/inactive stamps
     (‘org-export-with-timestamps’).

‘\n:’
     Toggles whether to preserve line breaks
     (‘org-export-preserve-breaks’).

‘^:’
     Toggle TeX-like syntax for sub- and superscripts.  If you write
     "^:{}", ‘a_{b}’ will be interpreted, but the simple ‘a_b’ will be
     left as it is (‘org-export-with-sub-superscripts’).

‘arch:’
     Configure how archived trees are exported.  When set to ‘headline’,
     the export process skips the contents and processes only the
     headlines (‘org-export-with-archived-trees’).

‘author:’
     Toggle inclusion of author name into exported file
     (‘org-export-with-author’).

‘broken-links:’
     Toggles if Org should continue exporting upon finding a broken
     internal link.  When set to ‘mark’, Org clearly marks the problem
     link in the output (‘org-export-with-broken-links’).

‘c:’
     Toggle inclusion of CLOCK keywords (‘org-export-with-clocks’).

‘creator:’
     Toggle inclusion of creator information in the exported file
     (‘org-export-with-creator’).

‘d:’
     Toggles inclusion of drawers, or list of drawers to include, or
     list of drawers to exclude (‘org-export-with-drawers’).

‘date:’
     Toggle inclusion of a date into exported file
     (‘org-export-with-date’).

‘e:’
     Toggle inclusion of entities (‘org-export-with-entities’).

‘email:’
     Toggle inclusion of the author’s e-mail into exported file
     (‘org-export-with-email’).

‘f:’
     Toggle the inclusion of footnotes (‘org-export-with-footnotes’).

‘H:’
     Set the number of headline levels for export
     (‘org-export-headline-levels’).  Below that level, headlines are
     treated differently.  In most back-ends, they become list items.

‘inline:’
     Toggle inclusion of inlinetasks (‘org-export-with-inlinetasks’).

‘num:’
     Toggle section-numbers (‘org-export-with-section-numbers’).  When
     set to number ‘n’, Org numbers only those headlines at level ‘n’ or
     above.  Setting ‘UNNUMBERED’ property to non-‘nil’ disables
     numbering of a heading.  Since subheadings inherit from this
     property, it affects their numbering, too.

‘p:’
     Toggle export of planning information (‘org-export-with-planning’).
     “Planning information” comes from lines located right after the
     headline and contain any combination of these cookies:
     ‘SCHEDULED:’, ‘DEADLINE:’, or ‘CLOSED:’.

‘pri:’
     Toggle inclusion of priority cookies (‘org-export-with-priority’).

‘prop:’
     Toggle inclusion of property drawers, or list the properties to
     include (‘org-export-with-properties’).

‘stat:’
     Toggle inclusion of statistics cookies
     (‘org-export-with-statistics-cookies’).

‘tags:’
     Toggle inclusion of tags, may also be ‘not-in-toc’
     (‘org-export-with-tags’).

‘tasks:’
     Toggle inclusion of tasks (TODO items); or ‘nil’ to remove all
     tasks; or ‘todo’ to remove DONE tasks; or list the keywords to keep
     (‘org-export-with-tasks’).

‘tex:’
     ‘nil’ does not export; ‘t’ exports; ‘verbatim’ keeps everything in
     verbatim (‘org-export-with-latex’).

‘timestamp:’
     Toggle inclusion of the creation time in the exported file
     (‘org-export-time-stamp-file’).

‘title:’
     Toggle inclusion of title (‘org-export-with-title’).

‘toc:’
     Toggle inclusion of the table of contents, or set the level limit
     (‘org-export-with-toc’).

‘todo:’
     Toggle inclusion of TODO keywords into exported text
     (‘org-export-with-todo-keywords’).

‘|:’
     Toggle inclusion of tables (‘org-export-with-tables’).

   When exporting sub-trees, special node properties in them can
override the above keywords.  They are special because they have an
‘EXPORT_’ prefix.  For example, ‘DATE’ and ‘EXPORT_FILE_NAME’ keywords
become, respectively, ‘EXPORT_DATE’ and ‘EXPORT_FILE_NAME’.  Except for
‘SETUPFILE’, all other keywords listed above have an ‘EXPORT_’
equivalent.

   If ‘org-export-allow-bind-keywords’ is non-‘nil’, Emacs variables can
become buffer-local during export by using the BIND keyword.  Its syntax
is ‘#+BIND: variable value’.  This is particularly useful for in-buffer
settings that cannot be changed using keywords.

   ---------- Footnotes ----------

   (1) Many desktops intercept ‘M-<TAB>’ to switch windows.  Use ‘C-M-i’
or ‘<ESC> <TAB>’ instead.

   (2) The variable ‘org-export-date-timestamp-format’ defines how this
time-stamp will be exported.


File: org.info,  Node: Table of contents,  Next: Include files,  Prev: Export settings,  Up: Exporting

12.3 Table of contents
======================

Org normally inserts the table of contents directly before the first
headline of the file.  Org sets the TOC depth the same as the headline
levels in the file.  Use a lower number for lower TOC depth.  To turn
off TOC entirely, use ‘nil’.  This is configured in the
‘org-export-with-toc’ variable or as keywords in an Org file as:

     #+OPTIONS: toc:2          only include two levels in TOC
     #+OPTIONS: toc:nil        no default TOC at all

   To move the table of contents to a different location, first turn off
the default with ‘org-export-with-toc’ variable or with ‘#+OPTIONS:
toc:nil’.  Then insert ‘#+TOC: headlines N’ at the desired location(s).

     #+OPTIONS: toc:nil        no default TOC
     ...
     #+TOC: headlines 2        insert TOC here, with two headline levels

   To adjust the TOC depth for a specific section of the Org document,
append an additional ‘local’ parameter.  This parameter becomes a
relative depth for the current level.

   Note that for this feature to work properly in LaTeX export, the Org
file requires the inclusion of the ‘titletoc’ package.  Because of
compatibility issues, ‘titletoc’ has to be loaded _before_ ‘hyperref’.
Customize the ‘org-latex-default-packages-alist’ variable.

     * Section #+TOC: headlines 1 local insert local TOC, with direct children
     only

   Use the ‘TOC’ keyword to generate list of tables (resp. all listings)
with captions.

     #+TOC: listings           build a list of listings
     #+TOC: tables             build a list of tables

   Normally Org uses the headline for its entry in the table of
contents.  But with ‘ALT_TITLE’ property, a different entry can be
specified for the table of contents.


File: org.info,  Node: Include files,  Next: Macro replacement,  Prev: Table of contents,  Up: Exporting

12.4 Include files
==================

Include other files during export.  For example, to include your
‘.emacs’ file, you could use:

     #+INCLUDE: "~/.emacs" src emacs-lisp

The first parameter is the file name to include.  The optional second
parameter specifies the block type: ‘example’, ‘export’ or ‘src’.  The
optional third parameter specifies the source code language to use for
formatting the contents.  This is relevant to both ‘export’ and ‘src’
block types.

   If an include file is specified as having a markup language, Org
neither checks for valid syntax nor changes the contents in any way.
For ‘example’ and ‘src’ blocks, Org code-escapes the contents before
inclusion.

   If an include file is not specified as having any markup language,
Org assumes it be in Org format and proceeds as usual with a few
exceptions.  Org makes the footnote labels (*note Footnotes::) in the
included file local to that file.  The contents of the included file
will belong to the same structure—headline, item—containing the
‘INCLUDE’ keyword.  In particular, headlines within the file will become
children of the current section.  That behavior can be changed by
providing an additional keyword parameter, ‘:minlevel’.  It shifts the
headlines in the included file to become the lowest level.  For example,
this syntax makes the included file a sibling of the current top-level
headline:

     #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1

   Inclusion of only portions of files are specified using ranges
parameter with ‘:lines’ keyword.  The line at the upper end of the range
will not be included.  The start and/or the end of the range may be
omitted to use the obvious defaults.

     #+INCLUDE: "~/.emacs" :lines "5-10"   Include lines 5 to 10, 10 excluded
     #+INCLUDE: "~/.emacs" :lines "-10"    Include lines 1 to 10, 10 excluded
     #+INCLUDE: "~/.emacs" :lines "10-"    Include lines from 10 to EOF

   Inclusions may specify a file-link to extract an object matched by
‘org-link-search’(1) (*note Search options::).

   To extract only the contents of the matched object, set
‘:only-contents’ property to non-‘nil’.  This will omit any planning
lines or property drawers.  The ranges for ‘:lines’ keyword are relative
to the requested element.  Some examples:

     #+INCLUDE: "./paper.org::#theory" :only-contents t
        Include the body of the heading with the custom id ‘theory’
     #+INCLUDE: "./paper.org::mytable"  Include named element.
     #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
        Include the first 20 lines of the headline named ‘conclusion’.

‘C-c '’
     Visit the include file at point.

   ---------- Footnotes ----------

   (1) Note that ‘org-link-search-must-match-exact-headline’ is locally
bound to non-‘nil’.  Therefore, ‘org-link-search’ only matches headlines
and named elements.


File: org.info,  Node: Macro replacement,  Next: Comment lines,  Prev: Include files,  Up: Exporting

12.5 Macro replacement
======================

Macros replace text snippets during export.  Macros are defined globally
in ‘org-export-global-macros’, or document-wise with the following
syntax:

     #+MACRO: name   replacement text $1, $2 are arguments

which can be referenced using ‘{{{name(arg1, arg2)}}}’(1).

   Org recognizes macro references in following Org markup areas:
paragraphs, headlines, verse blocks, tables cells and lists.  Org also
recognizes macro references in keywords, such as ‘#+CAPTION’, ‘#+TITLE’,
‘#+AUTHOR’, ‘#+DATE’, and for some back-end specific export options.

   Org comes with following pre-defined macros:

‘{{{title}}}’
‘{{{author}}}’
‘{{{email}}}’
     Org replaces these macro references with available information at
     the time of export.

‘{{{date}}}’
‘{{{date(FORMAT)}}}’
     This macro refers to the ‘#+DATE’ keyword.  FORMAT is an optional
     argument to the ‘{{{date}}}’ macro that will be used only if
     ‘#+DATE’ is a single timestamp.  FORMAT should be a format string
     understood by ‘format-time-string’.

‘{{{time(FORMAT)}}}’
‘{{{modification-time(FORMAT, VC)}}}’
     These macros refer to the document’s date and time of export and
     date and time of modification.  FORMAT is a string understood by
     ‘format-time-string’.  If the second argument to the
     ‘modification-time’ macro is non-‘nil’, Org uses ‘vc.el’ to
     retrieve the document’s modification time from the version control
     system.  Otherwise Org reads the file attributes.

‘{{{input-file}}}’
     This macro refers to the filename of the exported file.

‘{{{property(PROPERTY-NAME)}}}’
‘{{{property(PROPERTY-NAME,SEARCH-OPTION)}}}’
     This macro returns the value of property PROPERTY-NAME in the
     current entry.  If SEARCH-OPTION (*note Search options::) refers to
     a remote entry, that will be used instead.

‘{{{n}}}’
‘{{{n(NAME)}}}’
‘{{{n(NAME,ACTION)}}}’
     This macro implements custom counters by returning the number of
     times the macro has been expanded so far while exporting the
     buffer.  You can create more than one counter using different NAME
     values.  If ACTION is ‘-’, previous value of the counter is held,
     i.e.  the specified counter is not incremented.  If the value is a
     number, the specified counter is set to that value.  If it is any
     other non-empty string, the specified counter is reset to 1.  You
     may leave NAME empty to reset the default counter.

   The surrounding brackets can be made invisible by setting
‘org-hide-macro-markers’ non-‘nil’.

   Org expands macros at the very beginning of the export process.

   ---------- Footnotes ----------

   (1) Since commas separate the arguments, commas within arguments have
to be escaped with the backslash character.  So only those backslash
characters before a comma need escaping with another backslash
character.


File: org.info,  Node: Comment lines,  Next: ASCII/Latin-1/UTF-8 export,  Prev: Macro replacement,  Up: Exporting

12.6 Comment lines
==================

Lines starting with zero or more whitespace characters followed by one
‘#’ and a whitespace are treated as comments and, as such, are not
exported.

   Likewise, regions surrounded by ‘#+BEGIN_COMMENT’ ...
‘#+END_COMMENT’ are not exported.

   Finally, a ‘COMMENT’ keyword at the beginning of an entry, but after
any other keyword or priority cookie, comments out the entire subtree.
In this case, the subtree is not exported and no code block within it is
executed either(1).  The command below helps changing the comment status
of a headline.

‘C-c ;’
     Toggle the ‘COMMENT’ keyword at the beginning of an entry.

   ---------- Footnotes ----------

   (1) For a less drastic behavior, consider using a select tag (*note
Export settings::) instead.


File: org.info,  Node: ASCII/Latin-1/UTF-8 export,  Next: Beamer export,  Prev: Comment lines,  Up: Exporting

12.7 ASCII/Latin-1/UTF-8 export
===============================

ASCII export produces an output file containing only plain ASCII
characters.  This is the most simplest and direct text output.  It does
not contain any Org markup either.  Latin-1 and UTF-8 export use
additional characters and symbols available in these encoding standards.
All three of these export formats offer the most basic of text output
for maximum portability.

   On export, Org fills and justifies text according to the text width
set in ‘org-ascii-text-width’.

   Org exports links using a footnote-like style where the descriptive
part is in the text and the link is in a note before the next heading.
See the variable ‘org-ascii-links-to-notes’ for details.

ASCII export commands
---------------------

‘C-c C-e t a/l/u     (org-ascii-export-to-ascii)’
     Export as an ASCII file with a ‘.txt’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.txt’, overwriting without warning.  For
     ‘myfile.txt’, Org exports to ‘myfile.txt.txt’ in order to prevent
     data loss.
‘C-c C-e t A/L/U     (org-ascii-export-as-ascii)’
     Export to a temporary buffer.  Does not create a file.

ASCII specific export settings
------------------------------

The ASCII export back-end has one extra keyword for customizing ASCII
output.  Setting this keyword works similar to the general options
(*note Export settings::).

‘SUBTITLE’
     The document subtitle.  For long subtitles, use multiple
     ‘#+SUBTITLE’ lines in the Org file.  Org prints them on one
     continuous line, wrapping into multiple lines if necessary.

Header and sectioning structure
-------------------------------

Org converts the first three outline levels into headlines for ASCII
export.  The remaining levels are turned into lists.  To change this
cut-off point where levels become lists, *note Export settings::.

Quoting ASCII text
------------------

To insert text within the Org file by the ASCII back-end, use one the
following constructs, inline, keyword, or export block:

     Inline text @@ascii:and additional text@@ within a paragraph.

     #+ASCII: Some text

     #+BEGIN_EXPORT ascii
     Org exports text in this block only when using ASCII back-end.
     #+END_EXPORT

ASCII specific attributes
-------------------------

ASCII back-end recognizes only one attribute, ‘:width’, which specifies
the width of a horizontal rule in number of characters.  The keyword and
syntax for specifying widths is:

     #+ATTR_ASCII: :width 10
     -----

ASCII special blocks
--------------------

Besides ‘#+BEGIN_CENTER’ blocks (*note Paragraphs::), ASCII back-end has
these two left and right justification blocks:

     #+BEGIN_JUSTIFYLEFT
     It's just a jump to the left...
     #+END_JUSTIFYLEFT

     #+BEGIN_JUSTIFYRIGHT
     ...and then a step to the right.
     #+END_JUSTIFYRIGHT


File: org.info,  Node: Beamer export,  Next: HTML export,  Prev: ASCII/Latin-1/UTF-8 export,  Up: Exporting

12.8 Beamer export
==================

Org uses _Beamer_ export to convert an Org file tree structure into a
high-quality interactive slides for presentations.  _Beamer_ is a LaTeX
document class for creating presentations in PDF, HTML, and other
popular display formats.

* Menu:

* Beamer export commands::      For creating Beamer documents.
* Beamer specific export settings::  For customizing Beamer export.
* Sectioning Frames and Blocks in Beamer::  For composing Beamer slides.
* Beamer specific syntax::      For using in Org documents.
* Editing support::             For using helper functions.
* A Beamer example::            A complete presentation.


File: org.info,  Node: Beamer export commands,  Next: Beamer specific export settings,  Up: Beamer export

12.8.1 Beamer export commands
-----------------------------

‘C-c C-e l b     (org-beamer-export-to-latex)’
     Export as LaTeX file with a ‘.tex’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.tex’, overwriting without warning.
‘C-c C-e l B     (org-beamer-export-as-latex)’
     Export to a temporary buffer.  Does not create a file.
‘C-c C-e l P     (org-beamer-export-to-pdf)’
     Export as LaTeX file and then convert it to PDF format.
‘C-c C-e l O’
     Export as LaTeX file, convert it to PDF format, and then open the
     PDF file.


File: org.info,  Node: Beamer specific export settings,  Next: Sectioning Frames and Blocks in Beamer,  Prev: Beamer export commands,  Up: Beamer export

12.8.2 Beamer specific export settings
--------------------------------------

Beamer export back-end has several additional keywords for customizing
Beamer output.  These keywords work similar to the general options
settings (*note Export settings::).

‘BEAMER_THEME’
     The Beamer layout theme (‘org-beamer-theme’).  Use square brackets
     for options.  For example:
          #+BEAMER_THEME: Rochester [height=20pt]

‘BEAMER_FONT_THEME’
     The Beamer font theme.

‘BEAMER_INNER_THEME’
     The Beamer inner theme.

‘BEAMER_OUTER_THEME’
     The Beamer outer theme.

‘BEAMER_HEADER’
     Arbitrary lines inserted in the preamble, just before the
     ‘hyperref’ settings.

‘DESCRIPTION’
     The document description.  For long descriptions, use multiple
     ‘#+DESCRIPTION’ keywords.  By default, ‘hyperref’ inserts
     ‘#+DESCRIPTION’ as metadata.  Use ‘org-latex-hyperref-template’ to
     configure document metadata.  Use ‘org-latex-title-command’ to
     configure typesetting of description as part of front matter.

‘KEYWORDS’
     The keywords for defining the contents of the document.  Use
     multiple ‘#+KEYWORDS’ lines if necessary.  By default, ‘hyperref’
     inserts ‘#+KEYWORDS’ as metadata.  Use
     ‘org-latex-hyperref-template’ to configure document metadata.  Use
     ‘org-latex-title-command’ to configure typesetting of keywords as
     part of front matter.

‘SUBTITLE’
     Document’s subtitle.  For typesetting, use
     ‘org-beamer-subtitle-format’ string.  Use
     ‘org-latex-hyperref-template’ to configure document metadata.  Use
     ‘org-latex-title-command’ to configure typesetting of subtitle as
     part of front matter.


File: org.info,  Node: Sectioning Frames and Blocks in Beamer,  Next: Beamer specific syntax,  Prev: Beamer specific export settings,  Up: Beamer export

12.8.3 Sectioning, Frames and Blocks in Beamer
----------------------------------------------

Org transforms heading levels into Beamer’s sectioning elements, frames
and blocks.  Any Org tree with a not-too-deep-level nesting should in
principle be exportable as a Beamer presentation.

   − Org headlines become Beamer frames when the heading level in Org is
     equal to ‘org-beamer-frame-level’ or ‘H’ value in an ‘OPTIONS’ line
     (*note Export settings::).

     Org overrides headlines to frames conversion for the current tree
     of an Org file if it encounters the ‘BEAMER_ENV’ property set to
     ‘frame’ or ‘fullframe’.  Org ignores whatever
     ‘org-beamer-frame-level’ happens to be for that headline level in
     the Org tree.  In Beamer terminology, a ‘fullframe’ is a frame
     without its title.

   − Org exports a Beamer frame’s objects as ‘block’ environments.  Org
     can enforce wrapping in special block types when ‘BEAMER_ENV’
     property is set(1).  For valid values see
     ‘org-beamer-environments-default’.  To add more values, see
     ‘org-beamer-environments-extra’.

   − If ‘BEAMER_ENV’ is set to ‘appendix’, Org exports the entry as an
     appendix.  When set to ‘note’, Org exports the entry as a note
     within the frame or between frames, depending on the entry’s
     heading level.  When set to ‘noteNH’, Org exports the entry as a
     note without its title.  When set to ‘againframe’, Org exports the
     entry with ‘\againframe’ command, which makes setting the
     ‘BEAMER_REF’ property mandatory because ‘\againframe’ needs frame
     to resume.

     When ‘ignoreheading’ is set, Org export ignores the entry’s
     headline but not its content.  This is useful for inserting content
     between frames.  It is also useful for properly closing a ‘column’
     environment.

   When ‘BEAMER_ACT’ is set for a headline, Org export translates that
headline as an overlay or action specification.  When enclosed in square
brackets, Org export makes the overlay specification a default.  Use
‘BEAMER_OPT’ to set any options applicable to the current Beamer frame
or block.  The Beamer export back-end wraps with appropriate angular or
square brackets.  It also adds the ‘fragile’ option for any code that
may require a verbatim block.

   To create a column on the Beamer slide, use the ‘BEAMER_COL’ property
for its headline in the Org file.  Set the value of ‘BEAMER_COL’ to a
decimal number representing the fraction of the total text width.
Beamer export uses this value to set the column’s width and fills the
column with the contents of the Org entry.  If the Org entry has no
specific environment defined, Beamer export ignores the heading.  If the
Org entry has a defined environment, Beamer export uses the heading as
title.  Behind the scenes, Beamer export automatically handles LaTeX
column separations for contiguous headlines.  To manually adjust them
for any unique configurations needs, use the ‘BEAMER_ENV’ property.

   ---------- Footnotes ----------

   (1) If ‘BEAMER_ENV’ is set, Org export adds ‘:B_environment:’ tag to
make it visible.  The tag serves as a visual aid and has no semantic
relevance.


File: org.info,  Node: Beamer specific syntax,  Next: Editing support,  Prev: Sectioning Frames and Blocks in Beamer,  Up: Beamer export

12.8.4 Beamer specific syntax
-----------------------------

Since Org’s Beamer export back-end is an extension of the LaTeX
back-end, it recognizes other LaTeX specific syntax—for example,
‘#+LATEX:’ or ‘#+ATTR_LATEX:’.  *Note LaTeX export::, for details.

   Beamer export wraps the table of contents generated with ‘toc:t’
‘OPTION’ keyword in a ‘frame’ environment.  Beamer export does not wrap
the table of contents generated with ‘TOC’ keyword (*note Table of
contents::).  Use square brackets for specifying options.

     #+TOC: headlines [currentsection]

   Insert Beamer-specific code using the following constructs:

     #+BEAMER: \pause

     #+BEGIN_EXPORT beamer
     Only Beamer export back-end will export this line.
     #+END_BEAMER

     Text @@beamer:some code@@ within a paragraph.

   Inline constructs, such as the last one above, are useful for adding
overlay specifications to objects with ‘bold’, ‘item’, ‘link’,
‘radio-target’ and ‘target’ types.  Enclose the value in angular
brackets and place the specification at the beginning the object as
shown in this example:

     A *@@beamer:<2->@@useful* feature

   Beamer export recognizes the ‘ATTR_BEAMER’ keyword with the following
attributes from Beamer configurations: ‘:environment’ for changing local
Beamer environment, ‘:overlay’ for specifying Beamer overlays in angular
or square brackets, and ‘:options’ for inserting optional arguments.

     #+ATTR_BEAMER: :environment nonindentlist
     - item 1, not indented
     - item 2, not indented
     - item 3, not indented

     #+ATTR_BEAMER: :overlay <+->
     - item 1
     - item 2

     #+ATTR_BEAMER: :options [Lagrange]
     Let $G$ be a finite group, and let $H$ be
     a subgroup of $G$.  Then the order of $H$ divides the order of $G$.


File: org.info,  Node: Editing support,  Next: A Beamer example,  Prev: Beamer specific syntax,  Up: Beamer export

12.8.5 Editing support
----------------------

The ‘org-beamer-mode’ is a special minor mode for faster editing of
Beamer documents.

     #+STARTUP: beamer

‘C-c C-b     (org-beamer-select-environment)’
     The ‘org-beamer-mode’ provides this key for quicker selections in
     Beamer normal environments, and for selecting the ‘BEAMER_COL’
     property.


File: org.info,  Node: A Beamer example,  Prev: Editing support,  Up: Beamer export

12.8.6 A Beamer example
-----------------------

Here is an example of an Org document ready for Beamer export.

     #+TITLE: Example Presentation
     #+AUTHOR: Carsten Dominik
     #+OPTIONS: H:2 toc:t num:t
     #+LATEX_CLASS: beamer
     #+LATEX_CLASS_OPTIONS: [presentation]
     #+BEAMER_THEME: Madrid
     #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)

     * This is the first structural section

     ** Frame 1
     *** Thanks to Eric Fraga                                           :B_block:
         :PROPERTIES:
         :BEAMER_COL: 0.48
         :BEAMER_ENV: block
         :END:
         for the first viable Beamer setup in Org
     *** Thanks to everyone else                                        :B_block:
         :PROPERTIES:
         :BEAMER_COL: 0.48
         :BEAMER_ACT: <2->
         :BEAMER_ENV: block
         :END:
         for contributing to the discussion
     **** This will be formatted as a beamer note                       :B_note:
          :PROPERTIES:
          :BEAMER_env: note
          :END:
     ** Frame 2 (where we will not use columns)
     *** Request
         Please test this stuff!


File: org.info,  Node: HTML export,  Next: LaTeX export,  Prev: Beamer export,  Up: Exporting

12.9 HTML export
================

Org mode contains an HTML exporter with extensive HTML formatting
compatible with XHTML 1.0 strict standard.

* Menu:

* HTML Export commands::        Invoking HTML export
* HTML Specific export settings::  Settings for HTML export
* HTML doctypes::               Exporting various (X)HTML flavors
* HTML preamble and postamble::  Inserting preamble and postamble
* Quoting HTML tags::           Using direct HTML in Org files
* Links in HTML export::        Interpreting and formatting links
* Tables in HTML export::       Formatting and modifying tables
* Images in HTML export::       Inserting figures with HTML output
* Math formatting in HTML export::  Handling math equations
* Text areas in HTML export::   Showing an alternate approach, an example
* CSS support::                 Styling HTML output
* JavaScript support::          Folding scripting in the web browser


File: org.info,  Node: HTML Export commands,  Next: HTML Specific export settings,  Up: HTML export

12.9.1 HTML export commands
---------------------------

‘C-c C-e h h     (org-html-export-to-html)’
     Export as HTML file with a ‘.html’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.html’, overwriting without warning.  ‘C-c
     C-e h o’ Exports to HTML and opens it in a web browser.

‘C-c C-e h H     (org-html-export-as-html)’
     Exports to a temporary buffer.  Does not create a file.


File: org.info,  Node: HTML Specific export settings,  Next: HTML doctypes,  Prev: HTML Export commands,  Up: HTML export

12.9.2 HTML Specific export settings
------------------------------------

HTML export has a number of keywords, similar to the general options
settings described in *note Export settings::.

‘DESCRIPTION’
     This is the document’s description, which the HTML exporter inserts
     it as a HTML meta tag in the HTML file.  For long descriptions, use
     multiple ‘#+DESCRIPTION’ lines.  The exporter takes care of
     wrapping the lines properly.

‘HTML_DOCTYPE’
     Specify the document type, for example: HTML5 (‘org-html-doctype’).

‘HTML_CONTAINER’
     Specify the HTML container, such as ‘div’, for wrapping sections
     and elements (‘org-html-container-element’).

‘HTML_LINK_HOME’
     The URL for home link (‘org-html-link-home’).

‘HTML_LINK_UP’
     The URL for the up link of exported HTML pages
     (‘org-html-link-up’).

‘HTML_MATHJAX’
     Options for MathJax (‘org-html-mathjax-options’).  MathJax is used
     to typeset LaTeX math in HTML documents.  *Note Math formatting in
     HTML export::, for an example.

‘HTML_HEAD’
     Arbitrary lines for appending to the HTML document’s head
     (‘org-html-head’).

‘HTML_HEAD_EXTRA’
     More arbitrary lines for appending to the HTML document’s head
     (‘org-html-head-extra’).

‘KEYWORDS’
     Keywords to describe the document’s content.  HTML exporter inserts
     these keywords as HTML meta tags.  For long keywords, use multiple
     ‘#+KEYWORDS’ lines.

‘LATEX_HEADER’
     Arbitrary lines for appending to the preamble; HTML exporter
     appends when transcoding LaTeX fragments to images (*note Math
     formatting in HTML export::).

‘SUBTITLE’
     The document’s subtitle.  HTML exporter formats subtitle if
     document type is ‘HTML5’ and the CSS has a ‘subtitle’ class.

   Some of these keywords are explained in more detail in the following
sections of the manual.


File: org.info,  Node: HTML doctypes,  Next: HTML preamble and postamble,  Prev: HTML Specific export settings,  Up: HTML export

12.9.3 HTML doctypes
--------------------

Org can export to various (X)HTML flavors.

   Set the ‘org-html-doctype’ variable for different (X)HTML variants.
Depending on the variant, the HTML exporter adjusts the syntax of HTML
conversion accordingly.  Org includes the following ready-made variants:

   • “html4-strict”
   • “html4-transitional”
   • “html4-frameset”
   • “xhtml-strict”
   • “xhtml-transitional”
   • “xhtml-frameset”
   • “xhtml-11”
   • “html5”
   • “xhtml5”

See the variable ‘org-html-doctype-alist’ for details.  The default is
“xhtml-strict”.

   Org’s HTML exporter does not by default enable new block elements
introduced with the HTML5 standard.  To enable them, set
‘org-html-html5-fancy’ to non-‘nil’.  Or use an ‘OPTIONS’ line in the
file to set ‘html5-fancy’.  HTML5 documents can now have arbitrary
‘#+BEGIN’ and ‘#+END’ blocks.  For example:

     #+BEGIN_aside
     Lorem ipsum
     #+END_aside

   Will export to:

     <aside>
       <p>Lorem ipsum</p>
     </aside>

   While this:

     #+ATTR_HTML: :controls controls :width 350
     #+BEGIN_video
     #+HTML: <source src="movie.mp4" type="video/mp4">
     #+HTML: <source src="movie.ogg" type="video/ogg">
     Your browser does not support the video tag.
     #+END_video

   Exports to:

     <video controls="controls" width="350">
       <source src="movie.mp4" type="video/mp4">
       <source src="movie.ogg" type="video/ogg">
       <p>Your browser does not support the video tag.</p>
     </video>

   When special blocks do not have a corresponding HTML5 element, the
HTML exporter reverts to standard translation (see
‘org-html-html5-elements’).  For example, ‘#+BEGIN_lederhosen’ exports
to ‘<div class="lederhosen">’.

   Special blocks cannot have headlines.  For the HTML exporter to wrap
the headline and its contents in ‘<section>’ or ‘<article>’ tags, set
the ‘HTML_CONTAINER’ property for the headline.


File: org.info,  Node: HTML preamble and postamble,  Next: Quoting HTML tags,  Prev: HTML doctypes,  Up: HTML export

12.9.4 HTML preamble and postamble
----------------------------------

The HTML exporter has delineations for preamble and postamble.  The
default value for ‘org-html-preamble’ is ‘t’, which makes the HTML
exporter insert the preamble.  See the variable
‘org-html-preamble-format’ for the format string.

   Set ‘org-html-preamble’ to a string to override the default format
string.  If the string is a function, the HTML exporter expects the
function to return a string upon execution.  The HTML exporter inserts
this string in the preamble.  The HTML exporter will not insert a
preamble if ‘org-html-preamble’ is set ‘nil’.

   The default value for ‘org-html-postamble’ is ‘auto’, which makes the
HTML exporter build a postamble from looking up author’s name, email
address, creator’s name, and date.  Set ‘org-html-postamble’ to ‘t’ to
insert the postamble in the format specified in the
‘org-html-postamble-format’ variable.  The HTML exporter will not insert
a postamble if ‘org-html-postamble’ is set to ‘nil’.


File: org.info,  Node: Quoting HTML tags,  Next: Links in HTML export,  Prev: HTML preamble and postamble,  Up: HTML export

12.9.5 Quoting HTML tags
------------------------

The HTML export back-end transforms ‘<’ and ‘>’ to ‘&lt;’ and ‘&gt;’.
To include raw HTML code in the Org file so the HTML export back-end can
insert that HTML code in the output, use this inline syntax: ‘@@html:’.
For example: ‘@@html:<b>@@bold text@@html:</b>@@’.  For larger raw HTML
code blocks, use these HTML export code blocks:

     #+HTML: Literal HTML code for export

or

     #+BEGIN_EXPORT html
     All lines between these markers are exported literally
     #+END_EXPORT


File: org.info,  Node: Links in HTML export,  Next: Tables in HTML export,  Prev: Quoting HTML tags,  Up: HTML export

12.9.6 Links in HTML export
---------------------------

The HTML export back-end transforms Org’s internal links (*note Internal
links::) to equivalent HTML links in the output.  The back-end similarly
handles Org’s automatic links created by radio targets (*note Radio
targets::) similarly.  For Org links to external files, the back-end
transforms the links to _relative_ paths.

   For Org links to other ‘.org’ files, the back-end automatically
changes the file extension to ‘.html’ and makes file paths relative.  If
the ‘.org’ files have an equivalent ‘.html’ version at the same
location, then the converted links should work without any further
manual intervention.  However, to disable this automatic path
translation, set ‘org-html-link-org-files-as-html’ to ‘nil’.  When
disabled, the HTML export back-end substitutes the ‘id:’-based links in
the HTML output.  For more about linking files when publishing to a
directory, *note Publishing links::.

   Org files can also have special directives to the HTML export
back-end.  For example, by using ‘#+ATTR_HTML’ lines to specify new
format attributes to ‘<a>’ or ‘<img>’ tags.  This example shows changing
the link’s ‘title’ and ‘style’:

     #+ATTR_HTML: :title The Org mode homepage :style color:red;
     [[https://orgmode.org]]


File: org.info,  Node: Tables in HTML export,  Next: Images in HTML export,  Prev: Links in HTML export,  Up: HTML export

12.9.7 Tables in HTML export
----------------------------

The HTML export back-end uses ‘org-html-table-default-attributes’ when
exporting Org tables to HTML. By default, the exporter does not draw
frames and cell borders.  To change for this for a table, use the
following lines before the table in the Org file:

     #+CAPTION: This is a table with lines around and between cells
     #+ATTR_HTML: :border 2 :rules all :frame border

   The HTML export back-end preserves column groupings in Org tables
(*note Column groups::) when exporting to HTML.

   Additional options for customizing tables for HTML export.

‘org-html-table-align-individual-fields’
     Non-‘nil’ attaches style attributes for alignment to each table
     field.

‘org-html-table-caption-above’
     Non-‘nil’ places caption string at the beginning of the table.

‘org-html-table-data-tags’
     Opening and ending tags for table data fields.

‘org-html-table-default-attributes’
     Default attributes and values for table tags.

‘org-html-table-header-tags’
     Opening and ending tags for table’s header fields.

‘org-html-table-row-tags’
     Opening and ending tags for table rows.

‘org-html-table-use-header-tags-for-first-column’
     Non-‘nil’ formats column one in tables with header tags.


File: org.info,  Node: Images in HTML export,  Next: Math formatting in HTML export,  Prev: Tables in HTML export,  Up: HTML export

12.9.8 Images in HTML export
----------------------------

The HTML export back-end has features to convert Org image links to HTML
inline images and HTML clickable image links.

   When the link in the Org file has no description, the HTML export
back-end by default in-lines that image.  For example:
‘[[file:myimg.jpg]]’ is in-lined, while ‘[[file:myimg.jpg][the image]]’
links to the text, ‘the image’.

   For more details, see the variable ‘org-html-inline-images’.

   On the other hand, if the description part of the Org link is itself
another link, such as ‘file:’ or ‘http:’ URL pointing to an image, the
HTML export back-end in-lines this image and links to the main image.
This Org syntax enables the back-end to link low-resolution thumbnail to
the high-resolution version of the image, as shown in this example:

     [[file:highres.jpg][file:thumb.jpg]]

   To change attributes of in-lined images, use ‘#+ATTR_HTML’ lines in
the Org file.  This example shows realignment to right, and adds ‘alt’
and ‘title’ attributes in support of text viewers and modern web
accessibility standards.

     #+CAPTION: A black cat stalking a spider
     #+ATTR_HTML: :alt cat/spider image :title Action! :align right
     [[./img/a.jpg]]

The HTML export back-end copies the ‘http’ links from the Org file as
is.


File: org.info,  Node: Math formatting in HTML export,  Next: Text areas in HTML export,  Prev: Images in HTML export,  Up: HTML export

12.9.9 Math formatting in HTML export
-------------------------------------

LaTeX math snippets (*note LaTeX fragments::) can be displayed in two
different ways on HTML pages.  The default is to use MathJax
(http://www.mathjax.org) which should work out of the box with Org(1).
Some MathJax display options can be configured via
‘org-html-mathjax-options’, or in the buffer.  For example, with the
following settings,
     #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
   equation labels will be displayed on the left margin and equations
will be five ems from the left margin.

See the docstring of ‘org-html-mathjax-options’ for all supported
variables.  The MathJax template can be configure via
‘org-html-mathjax-template’.

   If you prefer, you can also request that LaTeX fragments are
processed into small images that will be inserted into the browser page.
Before the availability of MathJax, this was the default method for Org
files.  This method requires that the ‘dvipng’ program, ‘dvisvgm’ or
‘imagemagick’ suite is available on your system.  You can still get this
processing with

     #+OPTIONS: tex:dvipng

     #+OPTIONS: tex:dvisvgm

   or:

     #+OPTIONS: tex:imagemagick

   ---------- Footnotes ----------

   (1) By default Org loads MathJax from cdnjs.com (https://cdnjs.com)
as recommended by MathJax (http://www.mathjax.org).


File: org.info,  Node: Text areas in HTML export,  Next: CSS support,  Prev: Math formatting in HTML export,  Up: HTML export

12.9.10 Text areas in HTML export
---------------------------------

Before Org mode’s Babel, one popular approach to publishing code in HTML
was by using ‘:textarea’.  The advantage of this approach was that
copying and pasting was built into browsers with simple JavaScript
commands.  Even editing before pasting was made simple.

   The HTML export back-end can create such text areas.  It requires an
‘#+ATTR_HTML:’ line as shown in the example below with the ‘:textarea’
option.  This must be followed by either an ‘example’ or a ‘src’ code
block.  Other Org block types will not honor the ‘:textarea’ option.

   By default, the HTML export back-end creates a text area 80
characters wide and height just enough to fit the content.  Override
these defaults with ‘:width’ and ‘:height’ options on the ‘#+ATTR_HTML:’
line.

     #+ATTR_HTML: :textarea t :width 40
     #+BEGIN_EXAMPLE
       (defun org-xor (a b)
          "Exclusive or."
          (if a (not b) b))
     #+END_EXAMPLE


File: org.info,  Node: CSS support,  Next: JavaScript support,  Prev: Text areas in HTML export,  Up: HTML export

12.9.11 CSS support
-------------------

You can modify the CSS style definitions for the exported file.  The
HTML exporter assigns the following special CSS classes(1) to
appropriate parts of the document—your style specifications may change
these, in addition to any of the standard classes like for headlines,
tables, etc.
     p.author            author information, including email
     p.date              publishing date
     p.creator           creator info, about org mode version
     .title              document title
     .subtitle           document subtitle
     .todo               TODO keywords, all not-done states
     .done               the DONE keywords, all states that count as done
     .WAITING            each TODO keyword also uses a class named after itself
     .timestamp          timestamp
     .timestamp-kwd      keyword associated with a timestamp, like ‘SCHEDULED’
     .timestamp-wrapper  span around keyword plus timestamp
     .tag                tag in a headline
     ._HOME              each tag uses itself as a class, "@" replaced by "_"
     .target             target for links
     .linenr             the line number in a code example
     .code-highlighted   for highlighting referenced code lines
     div.outline-N       div for outline level N (headline plus text))
     div.outline-text-N  extra div for text at outline level N
     .section-number-N   section number in headlines, different for each level
     .figure-number      label like "Figure 1:"
     .table-number       label like "Table 1:"
     .listing-number     label like "Listing 1:"
     div.figure          how to format an in-lined image
     pre.src             formatted source code
     pre.example         normal example
     p.verse             verse paragraph
     div.footnotes       footnote section headline
     p.footnote          footnote definition paragraph, containing a footnote
     .footref            a footnote reference number (always a <sup>)
     .footnum            footnote number in footnote definition (always <sup>)
     .org-svg            default class for a linked ‘.svg’ image

   The HTML export back-end includes a compact default style in each
exported HTML file.  To override the default style with another style,
use these keywords in the Org file.  They will replace the global
defaults the HTML exporter uses.

     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
     #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />

   To just turn off the default style, customize
‘org-html-head-include-default-style’ variable, or use this option line
in the Org file.

     #+OPTIONS: html-style:nil

For longer style definitions, either use several ‘#+HTML_HEAD’ and
‘#+HTML_HEAD_EXTRA’ lines, or use ‘<style>’ ‘</style>’ blocks around
them.  Both of these approaches can avoid referring to an external file.

   In order to add styles to a sub-tree, use the
‘:HTML_CONTAINER_CLASS:’ property to assign a class to the tree.  In
order to specify CSS styles for a particular headline, you can use the
id specified in a ‘:CUSTOM_ID:’ property.

   Never change the ‘org-html-style-default’ constant.  Instead use
other simpler ways of customizing as described above.

   ---------- Footnotes ----------

   (1) If the classes on TODO keywords and tags lead to conflicts, use
the variables ‘org-html-todo-kwd-class-prefix’ and
‘org-html-tag-class-prefix’ to make them unique.


File: org.info,  Node: JavaScript support,  Prev: CSS support,  Up: HTML export

12.9.12 JavaScript supported display of web pages
-------------------------------------------------

Sebastian Rose has written a JavaScript program especially designed to
enhance the web viewing experience of HTML files created with Org.  This
program enhances large files in two different ways of viewing.  One is
an _Info_-like mode where each section is displayed separately and
navigation can be done with the ‘n’ and ‘p’ keys (and some other keys as
well, press ‘?’ for an overview of the available keys).  The second one
has a _folding_ view, much like Org provides inside Emacs.  The script
is available at <https://orgmode.org/org-info.js> and the documentation
at <https://orgmode.org/worg/code/org-info-js/>.  The script is hosted
on <https://orgmode.org>, but for reliability, prefer installing it on
your own web server.

   To use this program, just add this line to the Org file:

     #+INFOJS_OPT: view:info toc:nil

The HTML header now has the code needed to automatically invoke the
script.  For setting options, use the syntax from the above line for
options described below:

     path:    The path to the script.  The default grabs the script from
              <https://orgmode.org/org-info.js>, but you might want to have
              a local copy and use a path like ‘../scripts/org-info.js’.
     view:    Initial view when the website is first shown.  Possible values are:
              info      Info-like interface with one section per page.
              overview  Folding interface, initially showing only top-level.
              content   Folding interface, starting with all headlines visible.
              showall   Folding interface, all headlines and text visible.
     sdepth:  Maximum headline level that will still become an independent
              section for info and folding modes.  The default is taken from
              ‘org-export-headline-levels’ (= the ‘H’ switch in ‘#+OPTIONS’).
              If this is smaller than in ‘org-export-headline-levels’, each
              info/folding section can still contain child headlines.
     toc:     Should the table of contents _initially_ be visible?
              Even when ‘nil’, you can always get to the "toc" with ‘i’.
     tdepth:  The depth of the table of contents.  The defaults are taken from
              the variables ‘org-export-headline-levels’ and ‘org-export-with-toc’.
     ftoc:    Does the CSS of the page specify a fixed position for the "toc"?
              If yes, the toc will never be displayed as a section.
     ltoc:    Should there be short contents (children) in each section?
              Make this ‘above’ if the section should be above initial text.
     mouse:   Headings are highlighted when the mouse is over them.  Should be
              ‘underline’ (default) or a background color like ‘#cccccc’.
     buttons: Should view-toggle buttons be everywhere?  When ‘nil’ (the
              default), only one such button will be present.
You can choose default values for these options by customizing the
variable ‘org-html-infojs-options’.  If you want the script to always
apply to your pages, configure the variable ‘org-html-use-infojs’.


File: org.info,  Node: LaTeX export,  Next: Markdown export,  Prev: HTML export,  Up: Exporting

12.10 LaTeX export
==================

The LaTeX export back-end can handle complex documents, incorporate
standard or custom LaTeX document classes, generate documents using
alternate LaTeX engines, and produce fully linked PDF files with
indexes, bibliographies, and tables of contents, destined for
interactive online viewing or high-quality print publication.

   While the details are covered in-depth in this section, here are some
quick references to variables for the impatient: for engines, see
‘org-latex-compiler’; for build sequences, see ‘org-latex-pdf-process’;
for packages, see ‘org-latex-default-packages-alist’ and
‘org-latex-packages-alist’.

   An important note about the LaTeX export back-end: it is sensitive to
blank lines in the Org document.  That’s because LaTeX itself depends on
blank lines to tell apart syntactical elements, such as paragraphs.

* Menu:

* LaTeX export commands::    For producing LaTeX and PDF documents.
* LaTeX specific export settings::  Unique to this LaTeX back-end.
* LaTeX header and sectioning::  For file structure.
* Quoting LaTeX code::       Directly in the Org document.
* Tables in LaTeX export::   Attributes specific to tables.
* Images in LaTeX export::   Attributes specific to images.
* Plain lists in LaTeX export::  Attributes specific to lists.
* Source blocks in LaTeX export::  Attributes specific to source code blocks.
* Example blocks in LaTeX export::  Attributes specific to example blocks.
* Special blocks in LaTeX export::  Attributes specific to special blocks.
* Horizontal rules in LaTeX export::  Attributes specific to horizontal rules.


File: org.info,  Node: LaTeX export commands,  Next: LaTeX specific export settings,  Up: LaTeX export

12.10.1 LaTeX export commands
-----------------------------

‘C-c C-e l l     (org-latex-export-to-latex)’
     Export as LaTeX file with a ‘.tex’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.tex’, overwriting without warning.  ‘C-c C-e
     l l’ Exports to LaTeX file.

‘C-c C-e l L     (org-latex-export-as-latex)’
     Export to a temporary buffer.  Do not create a file.
‘C-c C-e l p     (org-latex-export-to-pdf)’
     Export as LaTeX file and convert it to PDF file.
‘C-c C-e l o’
     Export as LaTeX file and convert it to PDF, then open the PDF using
     the default viewer.

   The LaTeX export back-end can use any of these LaTeX engines:
‘pdflatex’, ‘xelatex’, and ‘lualatex’.  These engines compile LaTeX
files with different compilers, packages, and output options.  The LaTeX
export back-end finds the compiler version to use from
‘org-latex-compiler’ variable or the ‘#+LATEX_COMPILER’ keyword in the
Org file.  See the docstring for the ‘org-latex-default-packages-alist’
for loading packages with certain compilers.  Also see
‘org-latex-bibtex-compiler’ to set the bibliography compiler(1).

   ---------- Footnotes ----------

   (1) This does not allow setting different bibliography compilers for
different files.  However, “smart” LaTeX compilation systems, such as
‘latexmk’, can select the correct bibliography compiler.


File: org.info,  Node: LaTeX specific export settings,  Next: LaTeX header and sectioning,  Prev: LaTeX export commands,  Up: LaTeX export

12.10.2 LaTeX specific export settings
--------------------------------------

The LaTeX export back-end has several additional keywords for
customizing LaTeX output.  Setting these keywords works similar to the
general options (*note Export settings::).

‘DESCRIPTION’
     The document’s description.  The description along with author
     name, keywords, and related file metadata are inserted in the
     output file by the ‘hyperref’ package.  See
     ‘org-latex-hyperref-template’ for customizing metadata items.  See
     ‘org-latex-title-command’ for typesetting description into the
     document’s front matter.  Use multiple ‘#+DESCRIPTION’ lines for
     long descriptions.

‘LATEX_CLASS’
     This is LaTeX document class, such as ‘article’, ‘report’, ‘book’,
     and so on, which contain predefined preamble and headline level
     mapping that the LaTeX export back-end needs.  The back-end reads
     the default class name from the ‘org-latex-default-class’ variable.
     Org has ‘article’ as the default class.  A valid default class must
     be an element of ‘org-latex-classes’.

‘LATEX_CLASS_OPTIONS’
     Options the LaTeX export back-end uses when calling the LaTeX
     document class.

‘LATEX_COMPILER’
     The compiler, such as ‘pdflatex’, ‘xelatex’, ‘lualatex’, for
     producing the PDF (‘org-latex-compiler’).

‘LATEX_HEADER’
     Arbitrary lines to add to the document’s preamble, before the
     ‘hyperref’ settings.  See ‘org-latex-classes’ for adjusting the
     structure and order of the LaTeX headers.

‘LATEX_HEADER_EXTRA’
     Arbitrary lines to add to the document’s preamble, before the
     ‘hyperref’ settings.  See ‘org-latex-classes’ for adjusting the
     structure and order of the LaTeX headers.

‘KEYWORDS’
     The keywords for the document.  The description along with author
     name, keywords, and related file metadata are inserted in the
     output file by the ‘hyperref’ package.  See
     ‘org-latex-hyperref-template’ for customizing metadata items.  See
     ‘org-latex-title-command’ for typesetting description into the
     document’s front matter.  Use multiple ‘#+KEYWORDS’ lines if
     necessary.

‘SUBTITLE’
     The document’s subtitle.  It is typeset as per
     ‘org-latex-subtitle-format’.  If ‘org-latex-subtitle-separate’ is
     non-‘nil’, it is typed as part of the ‘\title’-macro.  See
     ‘org-latex-hyperref-template’ for customizing metadata items.  See
     ‘org-latex-title-command’ for typesetting description into the
     document’s front matter.

   The following sections have further details.


File: org.info,  Node: LaTeX header and sectioning,  Next: Quoting LaTeX code,  Prev: LaTeX specific export settings,  Up: LaTeX export

12.10.3 LaTeX header and sectioning structure
---------------------------------------------

The LaTeX export back-end converts the first three of Org’s outline
levels into LaTeX headlines.  The remaining Org levels are exported as
‘itemize’ or ‘enumerate’ lists.  To change this globally for the cut-off
point between levels and lists, (*note Export settings::).

   By default, the LaTeX export back-end uses the ‘article’ class.

   To change the default class globally, edit ‘org-latex-default-class’.
To change the default class locally in an Org file, add option lines
‘#+LATEX_CLASS: myclass’.  To change the default class for just a part
of the Org file, set a sub-tree property, ‘EXPORT_LATEX_CLASS’.  The
class name entered here must be valid member of ‘org-latex-classes’.
This variable defines a header template for each class into which the
exporter splices the values of ‘org-latex-default-packages-alist’ and
‘org-latex-packages-alist’.  Use the same three variables to define
custom sectioning or custom classes.

   The LaTeX export back-end sends the ‘LATEX_CLASS_OPTIONS’ keyword and
‘EXPORT_LATEX_CLASS_OPTIONS’ property as options to the LaTeX
‘\documentclass’ macro.  The options and the syntax for specifying them,
including enclosing them in square brackets, follow LaTeX conventions.

     #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn]

   The LaTeX export back-end appends values from ‘LATEX_HEADER’ and
‘LATEX_HEADER_EXTRA’ keywords to the LaTeX header.  The docstring for
‘org-latex-classes’ explains in more detail.  Also note that LaTeX
export back-end does not append ‘LATEX_HEADER_EXTRA’ to the header when
previewing LaTeX snippets (*note Previewing LaTeX fragments::).

   A sample Org file with the above headers:

     #+LATEX_CLASS: article
     #+LATEX_CLASS_OPTIONS: [a4paper]
     #+LATEX_HEADER: \usepackage{xyz}

     * Headline 1
       some text
     * Headline 2
       some more text


File: org.info,  Node: Quoting LaTeX code,  Next: Tables in LaTeX export,  Prev: LaTeX header and sectioning,  Up: LaTeX export

12.10.4 Quoting LaTeX code
--------------------------

The LaTeX export back-end can insert any arbitrary LaTeX code, *note
Embedded LaTeX::.  There are three ways to embed such code in the Org
file and they all use different quoting syntax.

   Inserting in-line quoted with  symbols:
     Code embedded in-line @@latex:any arbitrary LaTeX code@@ in a paragraph.

   Inserting as one or more keyword lines in the Org file:
     #+LATEX: any arbitrary LaTeX code

   Inserting as an export block in the Org file, where the back-end
exports any code between begin and end markers:
     #+BEGIN_EXPORT latex
     any arbitrary LaTeX code
     #+END_EXPORT


File: org.info,  Node: Tables in LaTeX export,  Next: Images in LaTeX export,  Prev: Quoting LaTeX code,  Up: LaTeX export

12.10.5 Tables in LaTeX export
------------------------------

The LaTeX export back-end can pass several LaTeX attributes for table
contents and layout.  Besides specifying label and caption (*note Images
and tables::), the other valid LaTeX attributes include:

‘:mode’
     The LaTeX export back-end wraps the table differently depending on
     the mode for accurate rendering of math symbols.  Mode is either
     ‘table’, ‘math’, ‘inline-math’ or ‘verbatim’.  For ‘math’ or
     ‘inline-math’ mode, LaTeX export back-end wraps the table in a math
     environment, but every cell in it is exported as-is.  The LaTeX
     export back-end determines the default mode from
     ‘org-latex-default-table-mode’.  For , The LaTeX export back-end
     merges contiguous tables in the same mode into a single
     environment.
‘:environment’
     Set the default LaTeX table environment for the LaTeX export
     back-end to use when exporting Org tables.  Common LaTeX table
     environments are provided by these packages: ‘tabularx’,
     ‘longtable’, ‘array’, ‘tabu’, and ‘bmatrix’.  For packages, such as
     ‘tabularx’ and ‘tabu’, or any newer replacements, include them in
     the ‘org-latex-packages-alist’ variable so the LaTeX export
     back-end can insert the appropriate load package headers in the
     converted LaTeX file.  Look in the docstring for the
     ‘org-latex-packages-alist’ variable for configuring these packages
     for LaTeX snippet previews, if any.
‘:caption’
     Use ‘#+CAPTION’ keyword to set a simple caption for a table (*note
     Images and tables::).  For custom captions, use ‘:caption’
     attribute, which accepts raw LaTeX code.  ‘:caption’ value
     overrides ‘#+CAPTION’ value.
‘:float’
‘:placement’
     The table environments by default are not floats in LaTeX.  To make
     them floating objects use ‘:float’ with one of the following
     options: ‘sideways’, ‘multicolumn’, ‘t’, and ‘nil’.  Note that
     ‘sidewaystable’ has been deprecated since Org 8.3.  LaTeX floats
     can also have additional layout ‘:placement’ attributes.  These are
     the usual ‘[h t b p ! H]’ permissions specified in square brackets.
     Note that for ‘:float sideways’ tables, the LaTeX export back-end
     ignores ‘:placement’ attributes.
‘:align’
‘:font’
‘:width’
     The LaTeX export back-end uses these attributes for regular tables
     to set their alignments, fonts, and widths.
‘:spread’
     When ‘:spread’ is non-‘nil’, the LaTeX export back-end spreads or
     shrinks the table by the ‘:width’ for ‘tabu’ and ‘longtabu’
     environments.  ‘:spread’ has no effect if ‘:width’ is not set.
‘:booktabs’
‘:center’
‘:rmlines’
     All three commands are toggles.  ‘:booktabs’ brings in modern
     typesetting enhancements to regular tables.  The ‘booktabs’ package
     has to be loaded through ‘org-latex-packages-alist’.  ‘:center’ is
     for centering the table.  ‘:rmlines’ removes all but the very first
     horizontal line made of ASCII characters from "table.el" tables
     only.
‘:math-prefix’
‘:math-suffix’
‘:math-arguments’
     The LaTeX export back-end inserts ‘:math-prefix’ string value in a
     math environment before the table.  The LaTeX export back-end
     inserts ‘:math-suffix’ string value in a math environment after the
     table.  The LaTeX export back-end inserts ‘:math-arguments’ string
     value between the macro name and the table’s contents.
     ‘:math-arguments’ comes in use for matrix macros that require more
     than one argument, such as ‘qbordermatrix’.

   LaTeX table attributes help formatting tables for a wide range of
situations, such as matrix product or spanning multiple pages:

     #+ATTR_LATEX: :environment longtable :align l|lp{3cm}r|l
     | ..... | ..... |
     | ..... | ..... |

     #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
     | a | b |
     | c | d |
     #+ATTR_LATEX: :mode math :environment bmatrix
     | 1 | 2 |
     | 3 | 4 |

   Set the caption with the LaTeX command
‘\bicaption{HeadingA}{HeadingB}’:

     #+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
     | ..... | ..... |
     | ..... | ..... |


File: org.info,  Node: Images in LaTeX export,  Next: Plain lists in LaTeX export,  Prev: Tables in LaTeX export,  Up: LaTeX export

12.10.6 Images in LaTeX export
------------------------------

The LaTeX export back-end processes image links in Org files that do not
have descriptions, such as these links ‘[[file:img.jpg]]’ or
‘[[./img.jpg]]’, as direct image insertions in the final PDF output.  In
the PDF, they are no longer links but actual images embedded on the
page.  The LaTeX export back-end uses ‘\includegraphics’ macro to insert
the image.  But for TikZ(1) images, the back-end uses an ‘\input’ macro
wrapped within a ‘tikzpicture’ environment.

   For specifying image ‘:width’, ‘:height’, and other ‘:options’, use
this syntax:

     #+ATTR_LATEX: :width 5cm :options angle=90
     [[./img/sed-hr4049.pdf]]

   For custom commands for captions, use the ‘:caption’ attribute.  It
will override the default ‘#+CAPTION’ value:

     #+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
     [[./img/sed-hr4049.pdf]]

   When captions follow the method as described in *note Images and
tables::, the LaTeX export back-end wraps the picture in a floating
‘figure’ environment.  To float an image without specifying a caption,
set the ‘:float’ attribute to one of the following:
   − ‘t’: for a standard ‘figure’ environment; used by default whenever
     an image has a caption.
   − ‘multicolumn’: to span the image across multiple columns of a page;
     the back-end wraps the image in a ‘figure*’ environment.
   − ‘wrap’: for text to flow around the image on the right; the figure
     occupies the left half of the page.
   − ‘sideways’: for a new page with the image sideways, rotated ninety
     degrees, in a ‘sidewaysfigure’ environment; overrides ‘:placement’
     setting.
   − ‘nil’: to avoid a ‘:float’ even if using a caption.
Use the ‘placement’ attribute to modify a floating environment’s
placement.

     #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement
     {r}{0.4\textwidth} [[./img/hst.png]]

   The LaTeX export back-end centers all images by default.  Setting
‘:center’ attribute to ‘nil’ disables centering.  To disable centering
globally, set ‘org-latex-images-centered’ to ‘t’.

   Set the ‘:comment-include’ attribute to non-‘nil’ value for the LaTeX
export back-end to comment out the ‘\includegraphics’ macro.

   ---------- Footnotes ----------

   (1) <http://sourceforge.net/projects/pgf/>


File: org.info,  Node: Plain lists in LaTeX export,  Next: Source blocks in LaTeX export,  Prev: Images in LaTeX export,  Up: LaTeX export

12.10.7 Plain lists in LaTeX export
-----------------------------------

The LaTeX export back-end accepts the ‘:environment’ and ‘:options’
attributes for plain lists.  Both attributes work together for
customizing lists, as shown in the examples:

     #+LATEX_HEADER: \usepackage[inline]{enumitem}
     Some ways to say "Hello":
     #+ATTR_LATEX: :environment itemize*
     #+ATTR_LATEX: :options [label={}, itemjoin={,}, itemjoin*={, and}]
     - Hola
     - Bonjour
     - Guten Tag.

   Since LaTeX supports only four levels of nesting for lists, use an
external package, such as ‘enumitem’ in LaTeX, for levels deeper than
four:

     #+LATEX_HEADER: \usepackage{enumitem}
     #+LATEX_HEADER: \renewlist{itemize}{itemize}{9}
     #+LATEX_HEADER: \setlist[itemize]{label=$\circ$}
     - One
       - Two
         - Three
           - Four
             - Five


File: org.info,  Node: Source blocks in LaTeX export,  Next: Example blocks in LaTeX export,  Prev: Plain lists in LaTeX export,  Up: LaTeX export

12.10.8 Source blocks in LaTeX export
-------------------------------------

The LaTeX export back-end can make source code blocks into floating
objects through the attributes ‘:float’ and ‘:options’.  For ‘:float’:

   − ‘t’: makes a source block float; by default floats any source block
     with a caption.
   − ‘multicolumn’: spans the source block across multiple columns of a
     page.
   − ‘nil’: avoids a ‘:float’ even if using a caption; useful for source
     code blocks that may not fit on a page.

     #+ATTR_LATEX: :float nil
     #+BEGIN_SRC emacs-lisp
     Lisp code that may not fit in a single page.
     #+END_SRC

   The LaTeX export back-end passes string values in ‘:options’ to LaTeX
packages for customization of that specific source block.  In the
example below, the ‘:options’ are set for Minted.  Minted is a source
code highlighting LaTeXpackage with many configurable options.

     #+ATTR_LATEX: :options commentstyle=\bfseries
     #+BEGIN_SRC emacs-lisp
       (defun Fib (n)
         (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
     #+END_SRC

   To apply similar configuration options for all source blocks in a
file, use the ‘org-latex-listings-options’ and
‘org-latex-minted-options’ variables.


File: org.info,  Node: Example blocks in LaTeX export,  Next: Special blocks in LaTeX export,  Prev: Source blocks in LaTeX export,  Up: LaTeX export

12.10.9 Example blocks in LaTeX export
--------------------------------------

The LaTeX export back-end wraps the contents of example blocks in a
‘verbatim’ environment.  To change this behavior to use another
environment globally, specify an appropriate export filter (*note
Advanced configuration::).  To change this behavior to use another
environment for each block, use the ‘:environment’ parameter to specify
a custom environment.

     #+ATTR_LATEX: :environment myverbatim
     #+BEGIN_EXAMPLE
     This sentence is false.
     #+END_EXAMPLE


File: org.info,  Node: Special blocks in LaTeX export,  Next: Horizontal rules in LaTeX export,  Prev: Example blocks in LaTeX export,  Up: LaTeX export

12.10.10 Special blocks in LaTeX export
---------------------------------------

For other special blocks in the Org file, the LaTeX export back-end
makes a special environment of the same name.  The back-end also takes
‘:options’, if any, and appends as-is to that environment’s opening
string.  For example:

     #+BEGIN_abstract
     We demonstrate how to solve the Syracuse problem.
     #+END_abstract

     #+ATTR_LATEX: :options [Proof of important theorem]
     #+BEGIN_proof
     ...
     Therefore, any even number greater than 2 is the sum of two primes.
     #+END_proof

exports to

     \begin{abstract}
     We demonstrate how to solve the Syracuse problem.
     \end{abstract}

     \begin{proof}[Proof of important theorem]
     ...
     Therefore, any even number greater than 2 is the sum of two primes.
     \end{proof}

   If you need to insert a specific caption command, use ‘:caption’
attribute.  It will override standard ‘#+CAPTION’ value, if any.  For
example:

     #+ATTR_LATEX: :caption \MyCaption{HeadingA}
     #+BEGIN_proof
     ...
     #+END_proof


File: org.info,  Node: Horizontal rules in LaTeX export,  Prev: Special blocks in LaTeX export,  Up: LaTeX export

12.10.11 Horizontal rules in LaTeX export
-----------------------------------------

The LaTeX export back-end converts horizontal rules by the specified
‘:width’ and ‘:thickness’ attributes.  For example:

     #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
     -----


File: org.info,  Node: Markdown export,  Next: OpenDocument Text export,  Prev: LaTeX export,  Up: Exporting

12.11 Markdown export
=====================

The Markdown export back-end, ‘md’, converts an Org file to a Markdown
format, as defined at <http://daringfireball.net/projects/markdown/>.

   Since ‘md’ is built on top of the HTML back-end, any Org constructs
not supported by Markdown, such as tables, the underlying ‘html’
back-end (*note HTML export::) converts them.

Markdown export commands
------------------------

‘C-c C-e m m     (org-md-export-to-markdown)’
     Export to a text file with Markdown syntax.  For ‘myfile.org’, Org
     exports to ‘myfile.md’, overwritten without warning.
‘C-c C-e m M     (org-md-export-as-markdown)’
     Export to a temporary buffer.  Does not create a file.
‘C-c C-e m o’
     Export as a text file with Markdown syntax, then open it.

Header and sectioning structure
-------------------------------

Based on ‘org-md-headline-style’, markdown export can generate headlines
of both ‘atx’ and ‘setext’ types.  ‘atx’ limits headline levels to two.
‘setext’ limits headline levels to six.  Beyond these limits, the export
back-end converts headlines to lists.  To set a limit to a level before
the absolute limit (*note Export settings::).


File: org.info,  Node: OpenDocument Text export,  Next: Org export,  Prev: Markdown export,  Up: Exporting

12.12 OpenDocument Text export
==============================

The ODT export back-end handles creating of OpenDocument Text (ODT)
format files.  The format complies with ‘OpenDocument-v1.2
specification’(1) and is compatible with LibreOffice 3.4.

* Menu:

* Pre-requisites for ODT export::  Required packages.
* ODT export commands::         Invoking export.
* ODT specific export settings::  Configuration options.
* Extending ODT export::        Producing ‘.doc’, ‘.pdf’ files.
* Applying custom styles::      Styling the output.
* Links in ODT export::         Handling and formatting links.
* Tables in ODT export::        Org table conversions.
* Images in ODT export::        Inserting images.
* Math formatting in ODT export::  Formatting LaTeX fragments.
* Labels and captions in ODT export::  Rendering objects.
* Literal examples in ODT export::  For source code and example blocks.
* Advanced topics in ODT export::  For power users.

   ---------- Footnotes ----------

   (1) Open Document Format for Office Applications (OpenDocument)
Version 1.2
(http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html)


File: org.info,  Node: Pre-requisites for ODT export,  Next: ODT export commands,  Up: OpenDocument Text export

12.12.1 Pre-requisites for ODT export
-------------------------------------

The ODT export back-end relies on the ‘zip’ program to create the final
compressed ODT output.  Check if ‘zip’ is locally available and
executable.  Without ‘zip’, export cannot finish.


File: org.info,  Node: ODT export commands,  Next: ODT specific export settings,  Prev: Pre-requisites for ODT export,  Up: OpenDocument Text export

12.12.2 ODT export commands
---------------------------

‘C-c C-e o o     (org-odt-export-to-odt)’

     Export as OpenDocument Text file.

     If ‘org-odt-preferred-output-format’ is specified, the ODT export
     back-end automatically converts the exported file to that format.
     *Note Automatically exporting to other formats:
     x-export-to-other-formats.

     For ‘myfile.org’, Org exports to ‘myfile.odt’, overwriting without
     warning.  The ODT export back-end exports a region only if a region
     was active.  Note for exporting active regions, the
     ‘transient-mark-mode’ has to be turned on.

     If the selected region is a single tree, the ODT export back-end
     makes the tree head the document title.  Incidentally, ‘C-c @’
     selects the current sub-tree.  If the tree head entry has, or
     inherits, an ‘EXPORT_FILE_NAME’ property, the ODT export back-end
     uses that for file name.

     ‘C-c C-e o O’ Export to an OpenDocument Text file format and open
     it.

     When ‘org-odt-preferred-output-format’ is specified, open the
     converted file instead.  *Note Automatically exporting to other
     formats: x-export-to-other-formats.


File: org.info,  Node: ODT specific export settings,  Next: Extending ODT export,  Prev: ODT export commands,  Up: OpenDocument Text export

12.12.3 ODT specific export settings
------------------------------------

The ODT export back-end has several additional keywords for customizing
ODT output.  Setting these keywords works similar to the general options
(*note Export settings::).

‘DESCRIPTION’
     This is the document’s description, which the ODT export back-end
     inserts as document metadata.  For long descriptions, use multiple
     ‘#+DESCRIPTION’ lines.

‘KEYWORDS’
     The keywords for the document.  The ODT export back-end inserts the
     description along with author name, keywords, and related file
     metadata as metadata in the output file.  Use multiple ‘#+KEYWORDS’
     lines if necessary.

‘ODT_STYLES_FILE’
     The ODT export back-end uses the ‘org-odt-styles-file’ by default.
     See *note Applying custom styles:: for details.

‘SUBTITLE’
     The document subtitle.


File: org.info,  Node: Extending ODT export,  Next: Applying custom styles,  Prev: ODT specific export settings,  Up: OpenDocument Text export

12.12.4 Extending ODT export
----------------------------

The ODT export back-end can produce documents in other formats besides
ODT using a specialized ODT converter process.  Its common interface
works with popular converters to produce formats such as ‘doc’, or
convert a document from one format, say ‘csv’, to another format, say
‘xls’.

   Customize ‘org-odt-convert-process’ variable to point to ‘unoconv’,
which is the ODT’s preferred converter.  Working installations of
LibreOffice would already have ‘unoconv’ installed.  Alternatively,
other converters may be substituted here.  *Note Configuring a document
converter::.

Automatically exporting to other formats
........................................

If ODT format is just an intermediate step to get to other formats, such
as ‘doc’, ‘docx’, ‘rtf’, or ‘pdf’, etc., then extend the ODT export
back-end to directly produce that format.  Specify the final format in
the ‘org-odt-preferred-output-format’ variable.  This is one way to
extend (*note Exporting to ODT: x-export-to-odt.).

Converting between document formats
...................................

The Org export back-end is made to be inter-operable with a wide range
of text document format converters.  Newer generation converters, such
as LibreOffice and Pandoc, can handle hundreds of formats at once.  Org
provides a consistent interaction with whatever converter is installed.
Here are some generic commands:

‘M-x org-odt-convert <RET>’
     Convert an existing document from one format to another.  With a
     prefix argument, opens the newly produced file.


File: org.info,  Node: Applying custom styles,  Next: Links in ODT export,  Prev: Extending ODT export,  Up: OpenDocument Text export

12.12.5 Applying custom styles
------------------------------

The ODT export back-end comes with many OpenDocument styles (*note
Working with OpenDocument style files::).  To expand or further
customize these built-in style sheets, either edit the style sheets
directly or generate them using an application such as LibreOffice.  The
example here shows creating a style using LibreOffice.

Applying custom styles: the easy way
....................................

  1. Create a sample ‘example.org’ file with settings as shown below,
     and export it to ODT format.

          #+OPTIONS: H:10 num:t

  2. Open the above ‘example.odt’ using LibreOffice.  Use the ‘Stylist’
     to locate the target styles, which typically have the ‘Org’ prefix.
     Open one, modify, and save as either OpenDocument Text (‘.odt’) or
     OpenDocument Template (‘.ott’) file.

  3. Customize the variable ‘org-odt-styles-file’ and point it to the
     newly created file.  For additional configuration options *note
     Overriding factory styles: x-overriding-factory-styles.

     To apply and ODT style to a particular file, use the
     ‘#+ODT_STYLES_FILE’ option as shown in the example below:

          #+ODT_STYLES_FILE: "/path/to/example.ott"

     or

          #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))

Using third-party styles and templates
......................................

The ODT export back-end relies on many templates and style names.  Using
third-party styles and templates can lead to mismatches.  Templates
derived from built in ODT templates and styles seem to have fewer
problems.


File: org.info,  Node: Links in ODT export,  Next: Tables in ODT export,  Prev: Applying custom styles,  Up: OpenDocument Text export

12.12.6 Links in ODT export
---------------------------

ODT export back-end creates native cross-references for internal links
and Internet-style links for all other link types.

   A link with no description and pointing to a
regular—un-itemized—outline heading is replaced with a cross-reference
and section number of the heading.

   A ‘\ref{label}’-style reference to an image, table etc. is replaced
with a cross-reference and sequence number of the labeled entity.  *Note
Labels and captions in ODT export::.


File: org.info,  Node: Tables in ODT export,  Next: Images in ODT export,  Prev: Links in ODT export,  Up: OpenDocument Text export

12.12.7 Tables in ODT export
----------------------------

The ODT export back-end handles native Org mode tables (*note Tables::)
and simple ‘table.el’ tables.  Complex ‘table.el’ tables having column
or row spans are not supported.  Such tables are stripped from the
exported document.

   By default, the ODT export back-end exports a table with top and
bottom frames and with ruled lines separating row and column groups
(*note Column groups::).  All tables are typeset to occupy the same
width.  The ODT export back-end honors any table alignments and relative
widths for columns (*note Column width and alignment::).

   Note that the ODT export back-end interprets column widths as
weighted ratios, the default weight being 1.

   Specifying ‘:rel-width’ property on an ‘#+ATTR_ODT’ line controls the
width of the table.  For example:

     #+ATTR_ODT: :rel-width 50
     | Area/Month    |   Jan |   Feb |   Mar |   Sum |
     |---------------+-------+-------+-------+-------|
     | /             |     < |       |       |     < |
     | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
     | North America |     1 |    21 |   926 |   948 |
     | Middle East   |     6 |    75 |   844 |   925 |
     | Asia Pacific  |     9 |    27 |   790 |   826 |
     |---------------+-------+-------+-------+-------|
     | Sum           |    16 |   123 |  2560 |  2699 |

   On export, the above table takes 50% of text width area.  The
exporter sizes the columns in the ratio: 13:5:5:5:6.  The first column
is left-aligned and rest of the columns, right-aligned.  Vertical rules
separate the header and the last column.  Horizontal rules separate the
header and the last row.

   For even more customization, create custom table styles and associate
them with a table using the ‘#+ATTR_ODT’ line.  *Note Customizing tables
in ODT export::.


File: org.info,  Node: Images in ODT export,  Next: Math formatting in ODT export,  Prev: Tables in ODT export,  Up: OpenDocument Text export

12.12.8 Images in ODT export
----------------------------

Embedding images
................

The ODT export back-end processes image links in Org files that do not
have descriptions, such as these links ‘[[file:img.jpg]]’ or
‘[[./img.jpg]]’, as direct image insertions in the final output.  Either
of these examples works:

     [[file:img.png]]

     [[./img.png]]

Embedding clickable images
..........................

For clickable images, provide a link whose description is another link
to an image file.  For example, to embed an image ‘org-mode-unicorn.png’
which when clicked jumps to <https://orgmode.org> website, do the
following

     [[https://orgmode.org][./org-mode-unicorn.png]]

Sizing and scaling of embedded images
.....................................

Control the size and scale of the embedded images with the ‘#+ATTR_ODT’
attribute.

   The ODT export back-end starts with establishing the size of the
image in the final document.  The dimensions of this size is measured in
centimeters.  The back-end then queries the image file for its
dimensions measured in pixels.  For this measurement, the back-end
relies on ImageMagick’s ‘identify’ program or Emacs ‘create-image’ and
‘image-size’ API. ImageMagick is the preferred choice for large file
sizes or frequent batch operations.  The back-end then converts the
pixel dimensions using ‘org-odt-pixels-per-inch’ into the familiar 72
dpi or 96 dpi.  The default value for this is in
‘display-pixels-per-inch’, which can be tweaked for better results based
on the capabilities of the output device.  Here are some common image
scaling operations:

Explicitly size the image
     To embed ‘img.png’ as a 10 cm x 10 cm image, do the following:

          #+ATTR_ODT: :width 10 :height 10
          [[./img.png]]

Scale the image
     To embed ‘img.png’ at half its size, do the following:

          #+ATTR_ODT: :scale 0.5
          [[./img.png]]

Scale the image to a specific width
     To embed ‘img.png’ with a width of 10 cm while retaining the
     original height:width ratio, do the following:

          #+ATTR_ODT: :width 10
          [[./img.png]]

Scale the image to a specific height
     To embed ‘img.png’ with a height of 10 cm while retaining the
     original height:width ratio, do the following

          #+ATTR_ODT: :height 10
          [[./img.png]]

Anchoring of images
...................

The ODT export back-end can anchor images to ‘"as-char"’, ‘"paragraph"’,
or ‘"page"’.  Set the preferred anchor using the ‘:anchor’ property of
the ‘#+ATTR_ODT’ line.

   To create an image that is anchored to a page:
     #+ATTR_ODT: :anchor "page"
     [[./img.png]]


File: org.info,  Node: Math formatting in ODT export,  Next: Labels and captions in ODT export,  Prev: Images in ODT export,  Up: OpenDocument Text export

12.12.9 Math formatting in ODT export
-------------------------------------

The ODT export back-end has special support built-in for handling math.

* Menu:

* Working with LaTeX math snippets::  Embedding in LaTeX format.
* Working with MathML or OpenDocument formula files::  Embedding in native format.


File: org.info,  Node: Working with LaTeX math snippets,  Next: Working with MathML or OpenDocument formula files,  Up: Math formatting in ODT export

Working with LaTeX math snippets
................................

LaTeX math snippets (*note LaTeX fragments::) can be embedded in an ODT
document in one of the following ways:

  1. MathML

     Add this line to the Org file.  This option is activated on a
     per-file basis.

          #+OPTIONS: LaTeX:t

     With this option, LaTeX fragments are first converted into MathML
     fragments using an external LaTeX-to-MathML converter program.  The
     resulting MathML fragments are then embedded as an OpenDocument
     Formula in the exported document.

     To specify the LaTeX-to-MathML converter, customize the variables
     ‘org-latex-to-mathml-convert-command’ and
     ‘org-latex-to-mathml-jar-file’.

     To use MathToWeb(1) as the preferred converter, configure the above
     variables as

          (setq org-latex-to-mathml-convert-command
                "java -jar %j -unicode -force -df %o %I"
                org-latex-to-mathml-jar-file
                "/path/to/mathtoweb.jar")
     To use LaTeXML(2) use
          (setq org-latex-to-mathml-convert-command
                "latexmlmath \"%i\" --presentationmathml=%o")

     To quickly verify the reliability of the LaTeX-to-MathML converter,
     use the following commands:

     ‘M-x org-odt-export-as-odf <RET>’
          Convert a LaTeX math snippet to an OpenDocument formula
          (‘.odf’) file.

     ‘M-x org-odt-export-as-odf-and-open <RET>’
          Convert a LaTeX math snippet to an OpenDocument formula
          (‘.odf’) file and open the formula file with the
          system-registered application.

  2. PNG images

     Add this line to the Org file.  This option is activated on a
     per-file basis.

          #+OPTIONS: tex:dvipng

          #+OPTIONS: tex:dvisvgm

     or:

          #+OPTIONS: tex:imagemagick

     Under this option, LaTeX fragments are processed into PNG or SVG
     images and the resulting images are embedded in the exported
     document.  This method requires ‘dvipng’ program, ‘dvisvgm’ or
     ‘imagemagick’ programs.

   ---------- Footnotes ----------

   (1) See MathToWeb
(http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl).

   (2) See <http://dlmf.nist.gov/LaTeXML/>.


File: org.info,  Node: Working with MathML or OpenDocument formula files,  Prev: Working with LaTeX math snippets,  Up: Math formatting in ODT export

Working with MathML or OpenDocument formula files
.................................................

When embedding LaTeX math snippets in ODT documents is not reliable,
there is one more option to try.  Embed an equation by linking to its
MathML (‘.mml’) source or its OpenDocument formula (‘.odf’) file as
shown below:

     [[./equation.mml]]

   or

     [[./equation.odf]]


File: org.info,  Node: Labels and captions in ODT export,  Next: Literal examples in ODT export,  Prev: Math formatting in ODT export,  Up: OpenDocument Text export

12.12.10 Labels and captions in ODT export
------------------------------------------

ODT format handles labeling and captioning of objects based on their
types.  Inline images, tables, LaTeX fragments, and Math formulas are
numbered and captioned separately.  Each object also gets a unique
sequence number based on its order of first appearance in the Org file.
Each category has its own sequence.  A caption is just a label applied
to these objects.

     #+CAPTION: Bell curve
     #+LABEL:   fig:SED-HR4049
     [[./img/a.png]]

   When rendered, it may show as follows in the exported document:

     Figure 2: Bell curve

   To modify the category component of the caption, customize the option
‘org-odt-category-map-alist’.  For example, to tag embedded images with
the string ‘Illustration’ instead of the default string ‘Figure’, use
the following setting:

     (setq org-odt-category-map-alist
           '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))

   With the above modification, the previous example changes to:

     Illustration 2: Bell curve


File: org.info,  Node: Literal examples in ODT export,  Next: Advanced topics in ODT export,  Prev: Labels and captions in ODT export,  Up: OpenDocument Text export

12.12.11 Literal examples in ODT export
---------------------------------------

The ODT export back-end supports literal examples (*note Literal
examples::) with full fontification.  Internally, the ODT export
back-end relies on ‘htmlfontify.el’ to generate the style definitions
needed for fancy listings.  The auto-generated styles get ‘OrgSrc’
prefix and inherit colors from the faces used by Emacs ‘font-lock’
library for that source language.

   For custom fontification styles, customize the
‘org-odt-create-custom-styles-for-srcblocks’ option.

   To turn off fontification of literal examples, customize the
‘org-odt-fontify-srcblocks’ option.


File: org.info,  Node: Advanced topics in ODT export,  Prev: Literal examples in ODT export,  Up: OpenDocument Text export

12.12.12 Advanced topics in ODT export
--------------------------------------

The ODT export back-end has extensive features useful for power users
and frequent uses of ODT formats.

* Menu:

* Configuring a document converter::  Registering a document converter.
* Working with OpenDocument style files::  Exploring internals.
* Creating one-off styles::     Customizing styles, highlighting.
* Customizing tables in ODT export::  Defining table templates.
* Validating OpenDocument XML::  Debugging corrupted OpenDocument files.


File: org.info,  Node: Configuring a document converter,  Next: Working with OpenDocument style files,  Up: Advanced topics in ODT export

Configuring a document converter
................................

The ODT export back-end works with popular converters with little or no
extra configuration.  *Note Extending ODT export::.  The following is
for unsupported converters or tweaking existing defaults.

  1. Register the converter

     Add the name of the converter to the ‘org-odt-convert-processes’
     variable.  Note that it also requires how the converter is invoked
     on the command line.  See the variable’s docstring for details.

  2. Configure its capabilities

     Specify which formats the converter can handle by customizing the
     variable ‘org-odt-convert-capabilities’.  Use the entry for the
     default values in this variable for configuring the new converter.
     Also see its docstring for details.

  3. Choose the converter

     Select the newly added converter as the preferred one by
     customizing the option ‘org-odt-convert-process’.


File: org.info,  Node: Working with OpenDocument style files,  Next: Creating one-off styles,  Prev: Configuring a document converter,  Up: Advanced topics in ODT export

Working with OpenDocument style files
.....................................

This section explores the internals of the ODT exporter; the means by
which it produces styled documents; the use of automatic and custom
OpenDocument styles.

a) Factory styles
.................

The ODT exporter relies on two files for generating its output.  These
files are bundled with the distribution under the directory pointed to
by the variable ‘org-odt-styles-dir’.  The two files are:

   • ‘OrgOdtStyles.xml’

     This file contributes to the ‘styles.xml’ file of the final ‘ODT’
     document.  This file gets modified for the following purposes:

       1. To control outline numbering based on user settings.

       2. To add styles generated by ‘htmlfontify.el’ for fontification
          of code blocks.

   • ‘OrgOdtContentTemplate.xml’

     This file contributes to the ‘content.xml’ file of the final ‘ODT’
     document.  The contents of the Org outline are inserted between the
     ‘<office:text>’...‘</office:text>’ elements of this file.

     Apart from serving as a template file for the final ‘content.xml’,
     the file serves the following purposes:

       1. It contains automatic styles for formatting of tables which
          are referenced by the exporter.

       2. It contains ‘<text:sequence-decl>’...‘</text:sequence-decl>’
          elements that control numbering of tables, images, equations,
          and similar entities.

b) Overriding factory styles
............................

The following two variables control the location from where the ODT
exporter picks up the custom styles and content template files.
Customize these variables to override the factory styles used by the
exporter.

   • ‘org-odt-styles-file’

     The ODT export back-end uses the file pointed to by this variable,
     such as ‘styles.xml’, for the final output.  It can take one of the
     following values:

       1. A ‘styles.xml’ file

          Use this file instead of the default ‘styles.xml’

       2. A ‘.odt’ or ‘.ott’ file

          Use the ‘styles.xml’ contained in the specified OpenDocument
          Text or Template file

       3. A ‘.odt’ or ‘.ott’ file and a subset of files contained within
          them

          Use the ‘styles.xml’ contained in the specified OpenDocument
          Text or Template file.  Additionally extract the specified
          member files and embed those within the final ‘ODT’ document.

          Use this option if the ‘styles.xml’ file references additional
          files like header and footer images.

       4. ‘nil’

          Use the default ‘styles.xml’

   • ‘org-odt-content-template-file’

     Use this variable to specify the blank ‘content.xml’ that will be
     used in the final output.


File: org.info,  Node: Creating one-off styles,  Next: Customizing tables in ODT export,  Prev: Working with OpenDocument style files,  Up: Advanced topics in ODT export

Creating one-off styles
.......................

The ODT export back-end can read embedded raw OpenDocument XML from the
Org file.  Such direct formatting are useful for one-off instances.

  1. Embedding ODT tags as part of regular text

     Enclose OpenDocument syntax in ‘@@odt:...@@’ for inline markup.
     For example, to highlight a region of text do the following:

          @@odt:<text:span text:style-name="Highlight">This is highlighted
          text</text:span>@@.  But this is regular text.

     *Hint:* To see the above example in action, edit the ‘styles.xml’
     (*note Factory styles: x-orgodtstyles-xml.) and add a custom
     ‘Highlight’ style as shown below:

          <style:style style:name="Highlight" style:family="text">
            <style:text-properties fo:background-color="#ff0000"/>
          </style:style>

  2. Embedding a one-line OpenDocument XML

     The ODT export back-end can read one-liner options with ‘#+ODT:’ in
     the Org file.  For example, to force a page break:

          #+ODT: <text:p text:style-name="PageBreak"/>

     *Hint:* To see the above example in action, edit your ‘styles.xml’
     (*note Factory styles: x-orgodtstyles-xml.) and add a custom
     ‘PageBreak’ style as shown below.

          <style:style style:name="PageBreak" style:family="paragraph"
                       style:parent-style-name="Text_20_body">
            <style:paragraph-properties fo:break-before="page"/>
          </style:style>

  3. Embedding a block of OpenDocument XML

     The ODT export back-end can also read ODT export blocks for
     OpenDocument XML. Such blocks use the ‘#+BEGIN_EXPORT
     odt’...‘#+END_EXPORT’ constructs.

     For example, to create a one-off paragraph that uses bold text, do
     the following:

          #+BEGIN_EXPORT odt
          <text:p text:style-name="Text_20_body_20_bold">
          This paragraph is specially formatted and uses bold text.
          </text:p>
          #+END_EXPORT


File: org.info,  Node: Customizing tables in ODT export,  Next: Validating OpenDocument XML,  Prev: Creating one-off styles,  Up: Advanced topics in ODT export

Customizing tables in ODT export
................................

Override the default table format by specifying a custom table style
with the ‘#+ATTR_ODT’ line.  For a discussion on default formatting of
tables *note Tables in ODT export::.

   This feature closely mimics the way table templates are defined in
the OpenDocument-v1.2 specification.(1)

   For quick preview of this feature, install the settings below and
export the table that follows:

     (setq org-odt-table-styles
           (append org-odt-table-styles
                 '(("TableWithHeaderRowAndColumn" "Custom"
                     ((use-first-row-styles . t)
                      (use-first-column-styles . t)))
                     ("TableWithFirstRowandLastRow" "Custom"
                      ((use-first-row-styles . t)
                      (use-last-row-styles . t))))))

     #+ATTR_ODT: :style TableWithHeaderRowAndColumn
     | Name  | Phone | Age |
     | Peter |  1234 |  17 |
     | Anna  |  4321 |  25 |

   The example above used ‘Custom’ template and installed two table
styles ‘TableWithHeaderRowAndColumn’ and ‘TableWithFirstRowandLastRow’.
*Important:* The OpenDocument styles needed for producing the above
template were pre-defined.  They are available in the section marked
‘Custom Table Template’ in ‘OrgOdtContentTemplate.xml’ (*note Factory
styles: x-orgodtcontenttemplate-xml.  For adding new templates, define
new styles here.

   To use this feature proceed as follows:

  1. Create a table template(2)

     A table template is set of ‘table-cell’ and ‘paragraph’ styles for
     each of the following table cell categories:

        − Body
        − First column
        − Last column
        − First row
        − Last row
        − Even row
        − Odd row
        − Even column
        − Odd Column

     The names for the above styles must be chosen based on the name of
     the table template using a well-defined convention.

     The naming convention is better illustrated with an example.  For a
     table template with the name ‘Custom’, the needed style names are
     listed in the following table.

     Table cell type   ‘table-cell’ style          ‘paragraph’ style
     -------------------------------------------------------------------------------
     Body              ‘CustomTableCell’           ‘CustomTableParagraph’
     First column      ‘CustomFirstColumnTableCell’‘CustomFirstColumnTableParagraph’
     Last column       ‘CustomLastColumnTableCell’ ‘CustomLastColumnTableParagraph’
     First row         ‘CustomFirstRowTableCell’   ‘CustomFirstRowTableParagraph’
     Last row          ‘CustomLastRowTableCell’    ‘CustomLastRowTableParagraph’
     Even row          ‘CustomEvenRowTableCell’    ‘CustomEvenRowTableParagraph’
     Odd row           ‘CustomOddRowTableCell’     ‘CustomOddRowTableParagraph’
     Even column       ‘CustomEvenColumnTableCell’ ‘CustomEvenColumnTableParagraph’
     Odd column        ‘CustomOddColumnTableCell’  ‘CustomOddColumnTableParagraph’

     To create a table template with the name ‘Custom’, define the above
     styles in the
     ‘<office:automatic-styles>’...‘</office:automatic-styles>’ element
     of the content template file (*note Factory styles:
     x-orgodtcontenttemplate-xml.).

  2. Define a table style(3)

     To define a table style, create an entry for the style in the
     variable ‘org-odt-table-styles’ and specify the following:

        − the name of the table template created in step (1)
        − the set of cell styles in that template that are to be
          activated

     For example, the entry below defines two different table styles
     ‘TableWithHeaderRowAndColumn’ and ‘TableWithFirstRowandLastRow’
     based on the same template ‘Custom’.  The styles achieve their
     intended effect by selectively activating the individual cell
     styles in that template.

          (setq org-odt-table-styles
                (append org-odt-table-styles
                        '(("TableWithHeaderRowAndColumn" "Custom"
                           ((use-first-row-styles . t)
                            (use-first-column-styles . t)))
                          ("TableWithFirstRowandLastRow" "Custom"
                           ((use-first-row-styles . t)
                            (use-last-row-styles . t))))))

  3. Associate a table with the table style

     To do this, specify the table style created in step (2) as part of
     the ‘ATTR_ODT’ line as shown below.

          #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
          | Name  | Phone | Age |
          | Peter |  1234 |  17 |
          | Anna  |  4321 |  25 |

   ---------- Footnotes ----------

   (1) OpenDocument-v1.2 Specification
(http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html)

   (2) See the ‘<table:table-template>’ element of the OpenDocument-v1.2
specification

   (3) See the attributes ‘table:template-name’,
‘table:use-first-row-styles’, ‘table:use-last-row-styles’,
‘table:use-first-column-styles’, ‘table:use-last-column-styles’,
‘table:use-banding-rows-styles’, and ‘table:use-banding-column-styles’
of the ‘<table:table>’ element in the OpenDocument-v1.2 specification


File: org.info,  Node: Validating OpenDocument XML,  Prev: Customizing tables in ODT export,  Up: Advanced topics in ODT export

Validating OpenDocument XML
...........................

Sometimes ODT format files may not open due to ‘.odt’ file corruption.
To verify if the ‘.odt’ file is corrupt, validate it against the
OpenDocument RELAX NG Compact Syntax—RNC—schema.  But first the ‘.odt’
files have to be decompressed using ‘zip’.  Note that ‘.odt’ files are
‘zip’ archives: *note (emacs)File Archives::.  The contents of ‘.odt’
files are in ‘.xml’.  For general help with validation—and
schema-sensitive editing—of XML files: *note (nxml-mode)Introduction::.

   Customize ‘org-odt-schema-dir’ to point to a directory with
OpenDocument ‘.rnc’ files and the needed schema-locating rules.  The ODT
export back-end takes care of updating the ‘rng-schema-locating-files’.


File: org.info,  Node: Org export,  Next: Texinfo export,  Prev: OpenDocument Text export,  Up: Exporting

12.13 Org export
================

‘org’ export back-end creates a normalized version of the Org document
in current buffer.  The exporter evaluates Babel code (*note Evaluating
code blocks::) and removes content specific to other back-ends.

Org export commands
-------------------

‘C-c C-e O o     (org-org-export-to-org)’
     Export as an Org file with a ‘.org’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.org.org’, overwriting without warning.

‘C-c C-e O O     (org-org-export-as-org)’
     Export to a temporary buffer.  Does not create a file.
‘C-c C-e O v’
     Export to an Org file, then open it.


File: org.info,  Node: Texinfo export,  Next: iCalendar export,  Prev: Org export,  Up: Exporting

12.14 Texinfo export
====================

The ‘texinfo’ export back-end generates documents with Texinfo code that
can compile to Info format.

* Menu:

* Texinfo export commands::     Invoking commands.
* Texinfo specific export settings::  Setting the environment.
* Texinfo file header::         Generating the header.
* Texinfo title and copyright page::  Creating preamble pages.
* Info directory file::     Installing a manual in Info file hierarchy.
* Headings and sectioning structure::  Building document structure.
* Indices::                     Creating indices.
* Quoting Texinfo code::        Incorporating literal Texinfo code.
* Plain lists in Texinfo export::  List attributes.
* Tables in Texinfo export::    Table attributes.
* Images in Texinfo export::    Image attributes.
* Special blocks in Texinfo export::  Special block attributes.
* A Texinfo example::           Processing Org to Texinfo.


File: org.info,  Node: Texinfo export commands,  Next: Texinfo specific export settings,  Up: Texinfo export

12.14.1 Texinfo export commands
-------------------------------

‘C-c C-e i t     (org-texinfo-export-to-texinfo)’
     Export as a Texinfo file with ‘.texi’ extension.  For ‘myfile.org’,
     Org exports to ‘myfile.texi’, overwriting without warning.
‘C-c C-e i i     (org-texinfo-export-to-info)’
     Export to Texinfo format first and then process it to make an Info
     file.  To generate other formats, such as DocBook, customize the
     ‘org-texinfo-info-process’ variable.


File: org.info,  Node: Texinfo specific export settings,  Next: Texinfo file header,  Prev: Texinfo export commands,  Up: Texinfo export

12.14.2 Texinfo specific export settings
----------------------------------------

The Texinfo export back-end has several additional keywords for
customizing Texinfo output.  Setting these keywords works similar to the
general options (*note Export settings::).

‘SUBTITLE’
     The document subtitle.

‘SUBAUTHOR’
     The document subauthor.

‘TEXINFO_FILENAME’
     The Texinfo filename.

‘TEXINFO_CLASS’
     The default document class (‘org-texinfo-default-class’), which
     must be a member of ‘org-texinfo-classes’.

‘TEXINFO_HEADER’
     Arbitrary lines inserted at the end of the header.

‘TEXINFO_POST_HEADER’
     Arbitrary lines inserted after the end of the header.

‘TEXINFO_DIR_CATEGORY’
     The directory category of the document.

‘TEXINFO_DIR_TITLE’
     The directory title of the document.

‘TEXINFO_DIR_DESC’
     The directory description of the document.

‘TEXINFO_PRINTED_TITLE’
     The printed title of the document.


File: org.info,  Node: Texinfo file header,  Next: Texinfo title and copyright page,  Prev: Texinfo specific export settings,  Up: Texinfo export

12.14.3 Texinfo file header
---------------------------

After creating the header for a Texinfo file, the Texinfo back-end
automatically generates a name and destination path for the Info file.
To override this default with a more sensible path and name, specify the
‘#+TEXINFO_FILENAME’ keyword.

   Along with the output’s file name, the Texinfo header also contains
language details (*note Export settings::) and encoding system as set in
the ‘org-texinfo-coding-system’ variable.  Insert ‘#+TEXINFO_HEADER’
keywords for each additional command in the header, for example:
@code{@synindex}.

   Instead of repeatedly installing the same set of commands, define a
class in ‘org-texinfo-classes’ once, and then activate it in the
document by setting the ‘#+TEXINFO_CLASS’ keyword to that class.


File: org.info,  Node: Texinfo title and copyright page,  Next: Info directory file,  Prev: Texinfo file header,  Up: Texinfo export

12.14.4 Texinfo title and copyright page
----------------------------------------

The default template for hard copy output has a title page with
‘#+TITLE’ and ‘#+AUTHOR’ (*note Export settings::).  To replace the
regular ‘#+TITLE’ with something different for the printed version, use
the ‘#+TEXINFO_PRINTED_TITLE’ and ‘#+SUBTITLE’ keywords.  Both expect
raw Texinfo code for setting their values.

   If one ‘#+AUTHOR’ is not sufficient, add multiple ‘#+SUBAUTHOR’
keywords.  They have to be set in raw Texinfo code.

     #+AUTHOR: Jane Smith
     #+SUBAUTHOR: John Doe
     #+TEXINFO_PRINTED_TITLE: This Long Title@inlinefmt{tex,@*} Is Broken in @TeX{}

   Copying material is defined in a dedicated headline with a non-‘nil’
‘:COPYING:’ property.  The back-end inserts the contents within a
‘@copying’ command at the beginning of the document.  The heading itself
does not appear in the structure of the document.

   Copyright information is printed on the back of the title page.

     * Legalese
       :PROPERTIES:
       :COPYING: t
       :END:

       This is a short example of a complete Texinfo file, version 1.0.

       Copyright \copy 2019 Free Software Foundation, Inc.


File: org.info,  Node: Info directory file,  Next: Headings and sectioning structure,  Prev: Texinfo title and copyright page,  Up: Texinfo export

12.14.5 Info directory file
---------------------------

The end result of the Texinfo export process is the creation of an Info
file.  This Info file’s metadata has variables for category, title, and
description: ‘#+TEXINFO_DIR_CATEGORY’, ‘#+TEXINFO_DIR_TITLE’, and
‘#+TEXINFO_DIR_DESC’ that establish where in the Info hierarchy the file
fits.

   Here is an example that writes to the Info directory file:

     #+TEXINFO_DIR_CATEGORY: Emacs
     #+TEXINFO_DIR_TITLE: Org Mode: (org)
     #+TEXINFO_DIR_DESC: Outline-based notes management and organizer


File: org.info,  Node: Headings and sectioning structure,  Next: Indices,  Prev: Info directory file,  Up: Texinfo export

12.14.6 Headings and sectioning structure
-----------------------------------------

The Texinfo export back-end uses a pre-defined scheme to convert Org
headlines to an equivalent Texinfo structuring commands.  A scheme like
this maps top-level headlines to numbered chapters tagged as ‘@chapter’
and lower-level headlines to unnumbered chapters tagged as
‘@unnumbered’.  To override such mappings to introduce ‘@part’ or other
Texinfo structuring commands, define a new class in
‘org-texinfo-classes’.  Activate the new class with the
‘#+TEXINFO_CLASS’ keyword.  When no new class is defined and activated,
the Texinfo export back-end defaults to the ‘org-texinfo-default-class’.

   If an Org headline’s level has no associated Texinfo structuring
command, or is below a certain threshold (*note Export settings::), then
the Texinfo export back-end makes it into a list item.

   The Texinfo export back-end makes any headline with a non-‘nil’
‘:APPENDIX:’ property into an appendix.  This happens independent of the
Org headline level or the ‘#+TEXINFO_CLASS’.

   The Texinfo export back-end creates a menu entry after the Org
headline for each regular sectioning structure.  To override this with a
shorter menu entry, use the ‘:ALT_TITLE:’ property (*note Table of
contents::).  Texinfo menu entries also have an option for a longer
‘:DESCRIPTION:’ property.  Here’s an example that uses both to override
the default menu entry:

     * Controlling Screen Display
       :PROPERTIES:
       :ALT_TITLE: Display
       :DESCRIPTION: Controlling Screen Display
       :END:

   The text before the first headline belongs to the ‘Top’ node, i.e.,
the node in which a reader enters an Info manual.  As such, it is
expected not to appear in printed output generated from the ‘.texi’
file.  *note (texinfo)The Top Node::, for more information.


File: org.info,  Node: Indices,  Next: Quoting Texinfo code,  Prev: Headings and sectioning structure,  Up: Texinfo export

12.14.7 Indices
---------------

The Texinfo export back-end recognizes these indexing keywords if used
in the Org file: ‘#+CINDEX’, ‘#+FINDEX’, ‘#+KINDEX’, ‘#+PINDEX’,
‘#+TINDEX’, and ‘#+VINDEX’.  Write their value as verbatim Texinfo code;
in particular, ‘{’, ‘}’ and ‘@’ characters need to be escaped with ‘@’
if they not belong to a Texinfo command.

     #+CINDEX: Defining indexing entries

   For the back-end to generate an index entry for a headline, set the
‘:INDEX:’ property to ‘cp’ or ‘vr’.  These abbreviations come from
Texinfo that stand for concept index and variable index.  The Texinfo
manual has abbreviations for all other kinds of indexes.  The back-end
exports the headline as an unnumbered chapter or section command, and
then inserts the index after its contents.

     * Concept Index
       :PROPERTIES:
       :INDEX: cp
       :END:


File: org.info,  Node: Quoting Texinfo code,  Next: Plain lists in Texinfo export,  Prev: Indices,  Up: Texinfo export

12.14.8 Quoting Texinfo code
----------------------------

Use any of the following three methods to insert or escape raw Texinfo
code:

     Richard @@texinfo:@sc{@@Stallman@@texinfo:}@@ commence' GNU.

     #+TEXINFO: @need800
     This paragraph is preceded by...

     #+BEGIN_EXPORT texinfo
     @auindex Johnson, Mark
     @auindex Lakoff, George
     #+END_EXPORT


File: org.info,  Node: Plain lists in Texinfo export,  Next: Tables in Texinfo export,  Prev: Quoting Texinfo code,  Up: Texinfo export

12.14.9 Plain lists in Texinfo export
-------------------------------------

The Texinfo export back-end by default converts description lists in the
Org file using the default command ‘@table’, which results in a table
with two columns.  To change this behavior, specify ‘:table-type’ with
‘ftable’ or ‘vtable’ attributes.  For more information, *note
(texinfo)Two-column Tables::.

   The Texinfo export back-end by default also applies a text highlight
based on the defaults stored in ‘org-texinfo-table-default-markup’.  To
override the default highlight command, specify another one with the
‘:indic’ attribute.

   Org syntax is limited to one entry per list item.  Nevertheless, the
Texinfo export back-end can split that entry according to any text
provided through the ‘:sep’ attribute.  Each part then becomes a new
entry in the first column of the table.

   The following example illustrates all the attributes above:

     #+ATTR_TEXINFO: :table-type vtable :sep , :indic asis
     - foo, bar :: This is the common text for variables foo and bar.

becomes

     @vtable @asis
     @item foo
     @itemx bar
     This is the common text for variables foo and bar.
     @end table


File: org.info,  Node: Tables in Texinfo export,  Next: Images in Texinfo export,  Prev: Plain lists in Texinfo export,  Up: Texinfo export

12.14.10 Tables in Texinfo export
---------------------------------

When exporting tables, the Texinfo export back-end uses the widest cell
width in each column.  To override this and instead specify as fractions
of line length, use the ‘:columns’ attribute.  See example below.

     #+ATTR_TEXINFO: :columns .5 .5
     | a cell | another cell |


File: org.info,  Node: Images in Texinfo export,  Next: Special blocks in Texinfo export,  Prev: Tables in Texinfo export,  Up: Texinfo export

12.14.11 Images in Texinfo export
---------------------------------

Insert a file link to the image in the Org file, and the Texinfo export
back-end inserts the image.  These links must have the usual supported
image extensions and no descriptions.  To scale the image, use ‘:width’
and ‘:height’ attributes.  For alternate text, use ‘:alt’ and specify
the text using Texinfo code, as shown in the example:

     #+ATTR_TEXINFO: :width 1in :alt Alternate @i{text}
     [[ridt.pdf]]


File: org.info,  Node: Special blocks in Texinfo export,  Next: A Texinfo example,  Prev: Images in Texinfo export,  Up: Texinfo export

12.14.12 Special blocks
-----------------------

The Texinfo export back-end converts special blocks to commands with the
same name.  It also adds any ‘:options’ attributes to the end of the
command, as shown in this example:

     #+ATTR_TEXINFO: :options org-org-export-to-org ...
     #+begin_defun
     A somewhat obsessive function.
     #+end_defun

becomes

     @defun org-org-export-to-org ...
     A somewhat obsessive function.
     @end defun


File: org.info,  Node: A Texinfo example,  Prev: Special blocks in Texinfo export,  Up: Texinfo export

12.14.13 A Texinfo example
--------------------------

Here is a more detailed example Org file.  See *note (texinfo)GNU Sample
Texts:: for an equivalent example using Texinfo code.

     #+TITLE: GNU Sample {{{version}}}
     #+SUBTITLE: for version {{{version}}}, {{{updated}}}
     #+AUTHOR: A.U. Thor
     #+EMAIL: bug-sample@gnu.org

     #+OPTIONS: ':t toc:t author:t email:t
     #+LANGUAGE: en

     #+MACRO: version 2.0
     #+MACRO: updated last updated 4 March 2014

     #+TEXINFO_FILENAME: sample.info
     #+TEXINFO_HEADER: @syncodeindex pg cp

     #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
     #+TEXINFO_DIR_TITLE: sample: (sample)
     #+TEXINFO_DIR_DESC: Invoking sample

     #+TEXINFO_PRINTED_TITLE: GNU Sample

     This manual is for GNU Sample (version {{{version}}},
     {{{updated}}}).

     * Copying
       :PROPERTIES:
       :COPYING:  t
       :END:

       This manual is for GNU Sample (version {{{version}}},
       {{{updated}}}), which is an example in the Texinfo documentation.

       Copyright \copy 2019 Free Software Foundation, Inc.

       #+BEGIN_QUOTE
       Permission is granted to copy, distribute and/or modify this
       document under the terms of the GNU Free Documentation License,
       Version 1.3 or any later version published by the Free Software
       Foundation; with no Invariant Sections, with no Front-Cover Texts,
       and with no Back-Cover Texts.  A copy of the license is included in
       the section entitled "GNU Free Documentation License".
       #+END_QUOTE

     * Invoking sample

       #+PINDEX: sample
       #+CINDEX: invoking @command{sample}

       This is a sample manual.  There is no sample program to invoke, but
       if there were, you could see its basic usage and command line
       options here.

     * GNU Free Documentation License
       :PROPERTIES:
       :APPENDIX: t
       :END:

       #+TEXINFO: @include fdl.texi

     * Index
       :PROPERTIES:
       :INDEX:    cp
       :END:


File: org.info,  Node: iCalendar export,  Next: Other built-in back-ends,  Prev: Texinfo export,  Up: Exporting

12.15 iCalendar export
======================

A large part of Org mode’s inter-operability success is its ability to
easily export to or import from external applications.  The iCalendar
export back-end takes calendar data from Org files and exports to the
standard iCalendar format.

   The iCalendar export back-end can also incorporate TODO entries based
on the configuration of the ‘org-icalendar-include-todo’ variable.  The
back-end exports plain timestamps as VEVENT, TODO items as VTODO, and
also create events from deadlines that are in non-TODO items.  The
back-end uses the deadlines and scheduling dates in Org TODO items for
setting the start and due dates for the iCalendar TODO entry.  Consult
the ‘org-icalendar-use-deadline’ and ‘org-icalendar-use-scheduled’
variables for more details.

   For tags on the headline, the iCalendar export back-end makes them
into iCalendar categories.  To tweak the inheritance of tags and TODO
states, configure the variable ‘org-icalendar-categories’.  To assign
clock alarms based on time, configure the ‘org-icalendar-alarm-time’
variable.

   The iCalendar format standard requires globally unique
identifier—UID—for each entry.  The iCalendar export back-end creates
UIDs during export.  To save a copy of the UID in the Org file set the
variable ‘org-icalendar-store-UID’.  The back-end looks for the ‘:ID:’
property of the entry for re-using the same UID for subsequent exports.

   Since a single Org entry can result in multiple iCalendar entries—as
timestamp, deadline, scheduled item, or TODO item—Org adds prefixes to
the UID, depending on which part of the Org entry triggered the creation
of the iCalendar entry.  Prefixing ensures UIDs remains unique, yet
enable synchronization programs trace the connections.

‘C-c C-e c f     (org-icalendar-export-to-ics)’
     Create iCalendar entries from the current Org buffer and store them
     in the same directory, using a file extension ‘.ics’.
‘C-c C-e c a     (org-icalendar-export-agenda-files)’
     Create iCalendar entries from Org files in ‘org-agenda-files’ and
     store in a separate iCalendar file for each Org file.
‘C-c C-e c c     (org-icalendar-combine-agenda-files)’
     Create a combined iCalendar file from Org files in
     ‘org-agenda-files’ and write it to
     ‘org-icalendar-combined-agenda-file’ file name.

   The iCalendar export back-end includes ‘SUMMARY’, ‘DESCRIPTION’,
‘LOCATION’ and ‘TIMEZONE’ properties from the Org entries when
exporting.  To force the back-end to inherit the ‘LOCATION’ and
‘TIMEZONE’ properties, configure the ‘org-use-property-inheritance’
variable.

   When Org entries do not have ‘SUMMARY’, ‘DESCRIPTION’ and ‘LOCATION’
properties, the iCalendar export back-end derives the summary from the
headline, and derives the description from the body of the Org item.
The ‘org-icalendar-include-body’ variable limits the maximum number of
characters of the content are turned into its description.

   The ‘TIMEZONE’ property can be used to specify a per-entry time zone,
and will be applied to any entry with timestamp information.  Time zones
should be specified as per the IANA time zone database format, e.g.
“Asia/Almaty”.  Alternately, the property value can be “UTC”, to force
UTC time for this entry only.

   Exporting to iCalendar format depends in large part on the
capabilities of the destination application.  Some are more lenient than
others.  Consult the Org mode FAQ for advice on specific applications.


File: org.info,  Node: Other built-in back-ends,  Next: Advanced configuration,  Prev: iCalendar export,  Up: Exporting

12.16 Other built-in back-ends
==============================

Other export back-ends included with Org are:

   • ‘ox-man.el’: export to a man page.

   To activate such back-ends, either customize ‘org-export-backends’ or
load directly with ‘(require 'ox-man)’.  On successful load, the
back-end adds new keys in the export dispatcher (*note The export
dispatcher::).

   Follow the comment section of such files, for example, ‘ox-man.el’,
for usage and configuration details.


File: org.info,  Node: Advanced configuration,  Next: Export in foreign buffers,  Prev: Other built-in back-ends,  Up: Exporting

12.17 Advanced configuration
============================

Hooks
-----

The export process executes two hooks before the actual exporting
begins.  The first hook, ‘org-export-before-processing-hook’, runs
before any expansions of macros, Babel code, and include keywords in the
buffer.  The second hook, ‘org-export-before-parsing-hook’, runs before
the buffer is parsed.  Both hooks are specified as functions, see
example below.  Their main use is for heavy duty structural
modifications of the Org content.  For example, removing every headline
in the buffer during export:

     (defun my-headline-removal (backend)
       "Remove all headlines in the current buffer.
     BACKEND is the export back-end being used, as a symbol."
       (org-map-entries
        (lambda () (delete-region (point) (progn (forward-line) (point))))))

     (add-hook 'org-export-before-parsing-hook 'my-headline-removal)

   Note that the hook function must have a mandatory argument that is a
symbol for the back-end.

Filters
-------

The Org export process relies on filters to process specific parts of
conversion process.  Filters are just lists of functions to be applied
to certain parts for a given back-end.  The output from the first
function in the filter is passed on to the next function in the filter.
The final output is the output from the final function in the filter.

   The Org export process has many filter sets applicable to different
types of objects, plain text, parse trees, export options, and final
output formats.  The filters are named after the element type or object
type: ‘org-export-filter-TYPE-functions’, where ‘TYPE’ is the type
targeted by the filter.  Valid types are:

body                     bold                     babel-call
center-block             clock                    code
diary-sexp               drawer                   dynamic-block
entity                   example-block            export-block
export-snippet           final-output             fixed-width
footnote-definition      footnote-reference       headline
horizontal-rule          inline-babel-call        inline-src-block
inlinetask               italic                   item
keyword                  latex-environment        latex-fragment
line-break               link                     node-property
options                  paragraph                parse-tree
plain-list               plain-text               planning
property-drawer          quote-block              radio-target
section                  special-block            src-block
statistics-cookie        strike-through           subscript
superscript              table                    table-cell
table-row                target                   timestamp
underline                verbatim                 verse-block

   Here is an example filter that replaces non-breaking spaces ‘~’ in
the Org buffer with ‘_’ for the LaTeX back-end.

     (defun my-latex-filter-nobreaks (text backend info)
       "Ensure \"_\" are properly handled in LaTeX export."
       (when (org-export-derived-backend-p backend 'latex)
             (replace-regexp-in-string "_" "~" text)))

     (add-to-list 'org-export-filter-plain-text-functions
                  'my-latex-filter-nobreaks)

   A filter requires three arguments: the code to be transformed, the
name of the back-end, and some optional information about the export
process.  The third argument can be safely ignored.  Note the use of
‘org-export-derived-backend-p’ predicate that tests for ‘latex’ back-end
or any other back-end, such as ‘beamer’, derived from ‘latex’.

Defining filters for individual files
-------------------------------------

The Org export can filter not just for back-ends, but also for specific
files through the ‘#+BIND’ keyword.  Here is an example with two
filters; one removes brackets from time stamps, and the other removes
strike-through text.  The filter functions are defined in a ‘src’ code
block in the same Org file, which is a handy location for debugging.

     #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
     #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
     #+begin_src emacs-lisp :exports results :results none
       (defun tmp-f-timestamp (s backend info)
         (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
       (defun tmp-f-strike-through (s backend info) "")
     #+end_src

Extending an existing back-end
------------------------------

Some parts of the conversion process can be extended for certain
elements so as to introduce a new or revised translation.  That is how
the HTML export back-end was extended to handle Markdown format.  The
extensions work seamlessly so any aspect of filtering not done by the
extended back-end is handled by the original back-end.  Of all the
export customization in Org, extending is very powerful as it operates
at the parser level.

   For this example, make the ‘ascii’ back-end display the language used
in a source code block.  Also make it display only when some attribute
is non-‘nil’, like the following:

     #+ATTR_ASCII: :language t

   Then extend ‘ascii’ back-end with a custom ‘my-ascii’ back-end.

     (defun my-ascii-src-block (src-block contents info)
       "Transcode a SRC-BLOCK element from Org to ASCII.
     CONTENTS is nil.  INFO is a plist used as a communication
     channel."
       (if (not (org-export-read-attribute :attr_ascii src-block :language))
         (org-export-with-backend 'ascii src-block contents info)
       (concat
        (format ",--[ %s ]--\n%s`----"
                (org-element-property :language src-block)
                (replace-regexp-in-string
                 "^" "| "
                 (org-element-normalize-string
                  (org-export-format-code-default src-block info)))))))

     (org-export-define-derived-backend 'my-ascii 'ascii
       :translate-alist '((src-block . my-ascii-src-block)))

   The ‘my-ascii-src-block’ function looks at the attribute above the
current element.  If not true, hands over to ‘ascii’ back-end.  If true,
which it is in this example, it creates a box around the code and leaves
room for the inserting a string for language.  The last form creates the
new back-end that springs to action only when translating ‘src-block’
type elements.

   To use the newly defined back-end, call the following from an Org
buffer:

     (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")

   Further steps to consider would be an interactive function,
self-installing an item in the export dispatcher menu, and other
user-friendly improvements.


File: org.info,  Node: Export in foreign buffers,  Prev: Advanced configuration,  Up: Exporting

12.18 Export in foreign buffers
===============================

The export back-ends in Org often include commands to convert selected
regions.  A convenient feature of this in-place conversion is that the
exported output replaces the original source.  Here are such functions:

‘org-html-convert-region-to-html’
     Convert the selected region into HTML.
‘org-latex-convert-region-to-latex’
     Convert the selected region into LaTeX.
‘org-texinfo-convert-region-to-texinfo’
     Convert the selected region into ‘Texinfo’.
‘org-md-convert-region-to-md’
     Convert the selected region into ‘MarkDown’.

   In-place conversions are particularly handy for quick conversion of
tables and lists in foreign buffers.  For example, turn on the minor
mode ‘M-x orgstruct-mode’ in an HTML buffer, then use the convenient Org
keyboard commands to create a list, select it, and covert it to HTML
with ‘M-x org-html-convert-region-to-html <RET>’.


File: org.info,  Node: Publishing,  Next: Working with source code,  Prev: Exporting,  Up: Top

13 Publishing
*************

Org includes a publishing management system that allows you to configure
automatic HTML conversion of _projects_ composed of interlinked org
files.  You can also configure Org to automatically upload your exported
HTML pages and related attachments, such as images and source code
files, to a web server.

   You can also use Org to convert files into PDF, or even combine HTML
and PDF conversion so that files are available in both formats on the
server.

   Publishing has been contributed to Org by David O’Toole.

* Menu:

* Configuration::               Defining projects
* Uploading files::             How to get files up on the server
* Sample configuration::        Example projects
* Triggering publication::      Publication commands


File: org.info,  Node: Configuration,  Next: Uploading files,  Up: Publishing

13.1 Configuration
==================

Publishing needs significant configuration to specify files, destination
and many other properties of a project.

* Menu:

* Project alist::               The central configuration variable
* Sources and destinations::    From here to there
* Selecting files::             What files are part of the project?
* Publishing action::           Setting the function doing the publishing
* Publishing options::          Tweaking HTML/LaTeX export
* Publishing links::            Which links keep working after publishing?
* Sitemap::                     Generating a list of all pages
* Generating an index::         An index that reaches across pages


File: org.info,  Node: Project alist,  Next: Sources and destinations,  Up: Configuration

13.1.1 The variable ‘org-publish-project-alist’
-----------------------------------------------

Publishing is configured almost entirely through setting the value of
one variable, called ‘org-publish-project-alist’.  Each element of the
list configures one project, and may be in one of the two following
forms:

        ("project-name" :property value :property value ...)
          i.e., a well-formed property list with alternating keys and values
     or
        ("project-name" :components ("project-name" "project-name" ...))


   In both cases, projects are configured by specifying property values.
A project defines the set of files that will be published, as well as
the publishing configuration to use when publishing those files.  When a
project takes the second form listed above, the individual members of
the ‘:components’ property are taken to be sub-projects, which group
together files requiring different publishing options.  When you publish
such a “meta-project”, all the components will also be published, in the
sequence given.


File: org.info,  Node: Sources and destinations,  Next: Selecting files,  Prev: Project alist,  Up: Configuration

13.1.2 Sources and destinations for files
-----------------------------------------

Most properties are optional, but some should always be set.  In
particular, Org needs to know where to look for source files, and where
to put published files.

‘:base-directory’      Directory containing publishing source files
‘:publishing-directory’Directory where output files will be published.
                       You can directly publish to a web server using a
                       file name syntax appropriate for the Emacs
                       ‘tramp’ package.  Or you can publish to a local
                       directory and use external tools to upload your
                       website (*note Uploading files::).
‘:preparation-function’Function or list of functions to be called
                       before starting the publishing process, for
                       example, to run ‘make’ for updating files to be
                       published.  Each preparation function is called
                       with a single argument, the project property
                       list.
‘:completion-function’ Function or list of functions called after
                       finishing the publishing process, for example,
                       to change permissions of the resulting files.
                       Each completion function is called with a single
                       argument, the project property list.


File: org.info,  Node: Selecting files,  Next: Publishing action,  Prev: Sources and destinations,  Up: Configuration

13.1.3 Selecting files
----------------------

By default, all files with extension ‘.org’ in the base directory are
considered part of the project.  This can be modified by setting the
properties
‘:base-extension’  Extension (without the dot!)  of source files.  This
                   actually is a regular expression.  Set this to the
                   symbol ‘any’ if you want to get all files in
                   ‘:base-directory’, even without extension.
                   
‘:exclude’         Regular expression to match file names that should
                   not be published, even though they have been
                   selected on the basis of their extension.
                   
‘:include’         List of files to be included regardless of
                   ‘:base-extension’ and ‘:exclude’.
                   
‘:recursive’       non-‘nil’ means, check base-directory recursively
                   for files to publish.


File: org.info,  Node: Publishing action,  Next: Publishing options,  Prev: Selecting files,  Up: Configuration

13.1.4 Publishing action
------------------------

Publishing means that a file is copied to the destination directory and
possibly transformed in the process.  The default transformation is to
export Org files as HTML files, and this is done by the function
‘org-html-publish-to-html’, which calls the HTML exporter (*note HTML
export::).  But you also can publish your content as PDF files using
‘org-latex-publish-to-pdf’ or as ‘ascii’, ‘Texinfo’, etc., using the
corresponding functions.

   If you want to publish the Org file as an ‘.org’ file but with the
archived, commented and tag-excluded trees removed, use the function
‘org-org-publish-to-org’.  This will produce ‘file.org’ and put it in
the publishing directory.  If you want a htmlized version of this file,
set the parameter ‘:htmlized-source’ to ‘t’, it will produce
‘file.org.html’ in the publishing directory(1).

   Other files like images only need to be copied to the publishing
destination.  For this you can use ‘org-publish-attachment’.  For
non-org files, you always need to specify the publishing function:

‘:publishing-function’ Function executing the publication of a file.
                       This may also be a list of functions, which will
                       all be called in turn.
‘:htmlized-source’     non-‘nil’ means, publish htmlized source.

   The function must accept three arguments: a property list containing
at least a ‘:publishing-directory’ property, the name of the file to be
published and the path to the publishing directory of the output file.
It should take the specified file, make the necessary transformation (if
any) and place the result into the destination folder.

   ---------- Footnotes ----------

   (1) If the publishing directory is the same than the source
directory, ‘file.org’ will be exported as ‘file.org.org’, so probably
don’t want to do this.


File: org.info,  Node: Publishing options,  Next: Publishing links,  Prev: Publishing action,  Up: Configuration

13.1.5 Options for the exporters
--------------------------------

The property list can be used to set export options during the
publishing process.  In most cases, these properties correspond to user
variables in Org.  While some properties are available for all export
back-ends, most of them are back-end specific.  The following sections
list properties along with the variable they belong to.  See the
documentation string of these options for details.

   When a property is given a value in ‘org-publish-project-alist’, its
setting overrides the value of the corresponding user variable (if any)
during publishing.  Options set within a file (*note Export settings::),
however, override everything.

Generic properties
..................

‘:archived-trees’         ‘org-export-with-archived-trees’
‘:exclude-tags’           ‘org-export-exclude-tags’
‘:headline-levels’        ‘org-export-headline-levels’
‘:language’               ‘org-export-default-language’
‘:preserve-breaks’        ‘org-export-preserve-breaks’
‘:section-numbers’        ‘org-export-with-section-numbers’
‘:select-tags’            ‘org-export-select-tags’
‘:with-author’            ‘org-export-with-author’
‘:with-broken-links’      ‘org-export-with-broken-links’
‘:with-clocks’            ‘org-export-with-clocks’
‘:with-creator’           ‘org-export-with-creator’
‘:with-date’              ‘org-export-with-date’
‘:with-drawers’           ‘org-export-with-drawers’
‘:with-email’             ‘org-export-with-email’
‘:with-emphasize’         ‘org-export-with-emphasize’
‘:with-fixed-width’       ‘org-export-with-fixed-width’
‘:with-footnotes’         ‘org-export-with-footnotes’
‘:with-latex’             ‘org-export-with-latex’
‘:with-planning’          ‘org-export-with-planning’
‘:with-priority’          ‘org-export-with-priority’
‘:with-properties’        ‘org-export-with-properties’
‘:with-special-strings’   ‘org-export-with-special-strings’
‘:with-sub-superscript’   ‘org-export-with-sub-superscripts’
‘:with-tables’            ‘org-export-with-tables’
‘:with-tags’              ‘org-export-with-tags’
‘:with-tasks’             ‘org-export-with-tasks’
‘:with-timestamps’        ‘org-export-with-timestamps’
‘:with-title’             ‘org-export-with-title’
‘:with-toc’               ‘org-export-with-toc’
‘:with-todo-keywords’     ‘org-export-with-todo-keywords’

ASCII specific properties
.........................

‘:ascii-bullets’                         ‘org-ascii-bullets’
‘:ascii-caption-above’                   ‘org-ascii-caption-above’
‘:ascii-charset’                         ‘org-ascii-charset’
‘:ascii-global-margin’                   ‘org-ascii-global-margin’
‘:ascii-format-drawer-function’          ‘org-ascii-format-drawer-function’
‘:ascii-format-inlinetask-function’      ‘org-ascii-format-inlinetask-function’
‘:ascii-headline-spacing’                ‘org-ascii-headline-spacing’
‘:ascii-indented-line-width’             ‘org-ascii-indented-line-width’
‘:ascii-inlinetask-width’                ‘org-ascii-inlinetask-width’
‘:ascii-inner-margin’                    ‘org-ascii-inner-margin’
‘:ascii-links-to-notes’                  ‘org-ascii-links-to-notes’
‘:ascii-list-margin’                     ‘org-ascii-list-margin’
‘:ascii-paragraph-spacing’               ‘org-ascii-paragraph-spacing’
‘:ascii-quote-margin’                    ‘org-ascii-quote-margin’
‘:ascii-table-keep-all-vertical-lines’   ‘org-ascii-table-keep-all-vertical-lines’
‘:ascii-table-use-ascii-art’             ‘org-ascii-table-use-ascii-art’
‘:ascii-table-widen-columns’             ‘org-ascii-table-widen-columns’
‘:ascii-text-width’                      ‘org-ascii-text-width’
‘:ascii-underline’                       ‘org-ascii-underline’
‘:ascii-verbatim-format’                 ‘org-ascii-verbatim-format’

Beamer specific properties
..........................

‘:beamer-theme’                   ‘org-beamer-theme’
‘:beamer-column-view-format’      ‘org-beamer-column-view-format’
‘:beamer-environments-extra’      ‘org-beamer-environments-extra’
‘:beamer-frame-default-options’   ‘org-beamer-frame-default-options’
‘:beamer-outline-frame-options’   ‘org-beamer-outline-frame-options’
‘:beamer-outline-frame-title’     ‘org-beamer-outline-frame-title’
‘:beamer-subtitle-format’         ‘org-beamer-subtitle-format’

HTML specific properties
........................

‘:html-allow-name-attribute-in-anchors’          ‘org-html-allow-name-attribute-in-anchors’
‘:html-checkbox-type’                            ‘org-html-checkbox-type’
‘:html-container’                                ‘org-html-container-element’
‘:html-divs’                                     ‘org-html-divs’
‘:html-doctype’                                  ‘org-html-doctype’
‘:html-extension’                                ‘org-html-extension’
‘:html-footnote-format’                          ‘org-html-footnote-format’
‘:html-footnote-separator’                       ‘org-html-footnote-separator’
‘:html-footnotes-section’                        ‘org-html-footnotes-section’
‘:html-format-drawer-function’                   ‘org-html-format-drawer-function’
‘:html-format-headline-function’                 ‘org-html-format-headline-function’
‘:html-format-inlinetask-function’               ‘org-html-format-inlinetask-function’
‘:html-head-extra’                               ‘org-html-head-extra’
‘:html-head-include-default-style’               ‘org-html-head-include-default-style’
‘:html-head-include-scripts’                     ‘org-html-head-include-scripts’
‘:html-head’                                     ‘org-html-head’
‘:html-home/up-format’                           ‘org-html-home/up-format’
‘:html-html5-fancy’                              ‘org-html-html5-fancy’
‘:html-indent’                                   ‘org-html-indent’
‘:html-infojs-options’                           ‘org-html-infojs-options’
‘:html-infojs-template’                          ‘org-html-infojs-template’
‘:html-inline-image-rules’                       ‘org-html-inline-image-rules’
‘:html-inline-images’                            ‘org-html-inline-images’
‘:html-link-home’                                ‘org-html-link-home’
‘:html-link-org-files-as-html’                   ‘org-html-link-org-files-as-html’
‘:html-link-up’                                  ‘org-html-link-up’
‘:html-link-use-abs-url’                         ‘org-html-link-use-abs-url’
‘:html-mathjax-options’                          ‘org-html-mathjax-options’
‘:html-mathjax-template’                         ‘org-html-mathjax-template’
‘:html-metadata-timestamp-format’                ‘org-html-metadata-timestamp-format’
‘:html-postamble-format’                         ‘org-html-postamble-format’
‘:html-postamble’                                ‘org-html-postamble’
‘:html-preamble-format’                          ‘org-html-preamble-format’
‘:html-preamble’                                 ‘org-html-preamble’
‘:html-table-align-individual-fields’            ‘org-html-table-align-individual-fields’
‘:html-table-attributes’                         ‘org-html-table-default-attributes’
‘:html-table-caption-above’                      ‘org-html-table-caption-above’
‘:html-table-data-tags’                          ‘org-html-table-data-tags’
‘:html-table-header-tags’                        ‘org-html-table-header-tags’
‘:html-table-row-tags’                           ‘org-html-table-row-tags’
‘:html-table-use-header-tags-for-first-column’   ‘org-html-table-use-header-tags-for-first-column’
‘:html-tag-class-prefix’                         ‘org-html-tag-class-prefix’
‘:html-text-markup-alist’                        ‘org-html-text-markup-alist’
‘:html-todo-kwd-class-prefix’                    ‘org-html-todo-kwd-class-prefix’
‘:html-toplevel-hlevel’                          ‘org-html-toplevel-hlevel’
‘:html-use-infojs’                               ‘org-html-use-infojs’
‘:html-validation-link’                          ‘org-html-validation-link’
‘:html-viewport’                                 ‘org-html-viewport’
‘:html-xml-declaration’                          ‘org-html-xml-declaration’

LaTeX specific properties
.........................

‘:latex-active-timestamp-format’         ‘org-latex-active-timestamp-format’
‘:latex-caption-above’                   ‘org-latex-caption-above’
‘:latex-classes’                         ‘org-latex-classes’
‘:latex-class’                           ‘org-latex-default-class’
‘:latex-compiler’                        ‘org-latex-compiler’
‘:latex-default-figure-position’         ‘org-latex-default-figure-position’
‘:latex-default-table-environment’       ‘org-latex-default-table-environment’
‘:latex-default-table-mode’              ‘org-latex-default-table-mode’
‘:latex-diary-timestamp-format’          ‘org-latex-diary-timestamp-format’
‘:latex-footnote-defined-format’         ‘org-latex-footnote-defined-format’
‘:latex-footnote-separator’              ‘org-latex-footnote-separator’
‘:latex-format-drawer-function’          ‘org-latex-format-drawer-function’
‘:latex-format-headline-function’        ‘org-latex-format-headline-function’
‘:latex-format-inlinetask-function’      ‘org-latex-format-inlinetask-function’
‘:latex-hyperref-template’               ‘org-latex-hyperref-template’
‘:latex-image-default-height’            ‘org-latex-image-default-height’
‘:latex-image-default-option’            ‘org-latex-image-default-option’
‘:latex-image-default-width’             ‘org-latex-image-default-width’
‘:latex-images-centered’                 ‘org-latex-images-centered’
‘:latex-inactive-timestamp-format’       ‘org-latex-inactive-timestamp-format’
‘:latex-inline-image-rules’              ‘org-latex-inline-image-rules’
‘:latex-link-with-unknown-path-format’   ‘org-latex-link-with-unknown-path-format’
‘:latex-listings-langs’                  ‘org-latex-listings-langs’
‘:latex-listings-options’                ‘org-latex-listings-options’
‘:latex-listings’                        ‘org-latex-listings’
‘:latex-minted-langs’                    ‘org-latex-minted-langs’
‘:latex-minted-options’                  ‘org-latex-minted-options’
‘:latex-prefer-user-labels’              ‘org-latex-prefer-user-labels’
‘:latex-subtitle-format’                 ‘org-latex-subtitle-format’
‘:latex-subtitle-separate’               ‘org-latex-subtitle-separate’
‘:latex-table-scientific-notation’       ‘org-latex-table-scientific-notation’
‘:latex-tables-booktabs’                 ‘org-latex-tables-booktabs’
‘:latex-tables-centered’                 ‘org-latex-tables-centered’
‘:latex-text-markup-alist’               ‘org-latex-text-markup-alist’
‘:latex-title-command’                   ‘org-latex-title-command’
‘:latex-toc-command’                     ‘org-latex-toc-command’

Markdown specific properties
............................

‘:md-footnote-format’     ‘org-md-footnote-format’
‘:md-footnotes-section’   ‘org-md-footnotes-section’
‘:md-headline-style’      ‘org-md-headline-style’

ODT specific properties
.......................

‘:odt-content-template-file’        ‘org-odt-content-template-file’
‘:odt-display-outline-level’        ‘org-odt-display-outline-level’
‘:odt-fontify-srcblocks’            ‘org-odt-fontify-srcblocks’
‘:odt-format-drawer-function’       ‘org-odt-format-drawer-function’
‘:odt-format-headline-function’     ‘org-odt-format-headline-function’
‘:odt-format-inlinetask-function’   ‘org-odt-format-inlinetask-function’
‘:odt-inline-formula-rules’         ‘org-odt-inline-formula-rules’
‘:odt-inline-image-rules’           ‘org-odt-inline-image-rules’
‘:odt-pixels-per-inch’              ‘org-odt-pixels-per-inch’
‘:odt-styles-file’                  ‘org-odt-styles-file’
‘:odt-table-styles’                 ‘org-odt-table-styles’
‘:odt-use-date-fields’              ‘org-odt-use-date-fields’

Texinfo specific properties
...........................

‘:texinfo-active-timestamp-format’         ‘org-texinfo-active-timestamp-format’
‘:texinfo-classes’                         ‘org-texinfo-classes’
‘:texinfo-class’                           ‘org-texinfo-default-class’
‘:texinfo-table-default-markup’            ‘org-texinfo-table-default-markup’
‘:texinfo-diary-timestamp-format’          ‘org-texinfo-diary-timestamp-format’
‘:texinfo-filename’                        ‘org-texinfo-filename’
‘:texinfo-format-drawer-function’          ‘org-texinfo-format-drawer-function’
‘:texinfo-format-headline-function’        ‘org-texinfo-format-headline-function’
‘:texinfo-format-inlinetask-function’      ‘org-texinfo-format-inlinetask-function’
‘:texinfo-inactive-timestamp-format’       ‘org-texinfo-inactive-timestamp-format’
‘:texinfo-link-with-unknown-path-format’   ‘org-texinfo-link-with-unknown-path-format’
‘:texinfo-node-description-column’         ‘org-texinfo-node-description-column’
‘:texinfo-table-scientific-notation’       ‘org-texinfo-table-scientific-notation’
‘:texinfo-tables-verbatim’                 ‘org-texinfo-tables-verbatim’
‘:texinfo-text-markup-alist’               ‘org-texinfo-text-markup-alist’


File: org.info,  Node: Publishing links,  Next: Sitemap,  Prev: Publishing options,  Up: Configuration

13.1.6 Links between published files
------------------------------------

To create a link from one Org file to another, you would use something
like ‘[[file:foo.org][The foo]]’ or simply ‘file:foo.org’ (*note
External links::).  When published, this link becomes a link to
‘foo.html’.  You can thus interlink the pages of your “org web” project
and the links will work as expected when you publish them to HTML. If
you also publish the Org source file and want to link to it, use an
‘http:’ link instead of a ‘file:’ link, because ‘file:’ links are
converted to link to the corresponding ‘html’ file.

   You may also link to related files, such as images.  Provided you are
careful with relative file names, and provided you have also configured
Org to upload the related files, these links will work too.  See *note
Complex example::, for an example of this usage.

   Eventually, links between published documents can contain some search
options (*note Search options::), which will be resolved to the
appropriate location in the linked file.  For example, once published to
HTML, the following links all point to a dedicated anchor in ‘foo.html’.

     [[file:foo.org::*heading]]
     [[file:foo.org::#custom-id]]
     [[file:foo.org::target]]


File: org.info,  Node: Sitemap,  Next: Generating an index,  Prev: Publishing links,  Up: Configuration

13.1.7 Generating a sitemap
---------------------------

The following properties may be used to control publishing of a map of
files for a given project.

‘:auto-sitemap’           When non-‘nil’, publish a sitemap during
                          ‘org-publish-current-project’ or
                          ‘org-publish-all’.
                          
‘:sitemap-filename’       Filename for output of sitemap.  Defaults to
                          ‘sitemap.org’ (which becomes ‘sitemap.html’).
                          
‘:sitemap-title’          Title of sitemap page.  Defaults to name of
                          file.
                          
‘:sitemap-format-entry’   With this option one can tell how a site-map
                          entry is formatted in the site-map.  It is a
                          function called with three arguments: the
                          file or directory name relative to base
                          directory of the project, the site-map style
                          and the current project.  It is expected to
                          return a string.  Default value turns file
                          names into links and use document titles as
                          descriptions.  For specific formatting needs,
                          one can use ‘org-publish-find-date’,
                          ‘org-publish-find-title’ and
                          ‘org-publish-find-property’, to retrieve
                          additional information about published
                          documents.
                          
‘:sitemap-function’       Plug-in function to use for generation of the
                          sitemap.  It is called with two arguments:
                          the title of the site-map and a
                          representation of the files and directories
                          involved in the project as a radio list
                          (*note Radio lists::).  The latter can
                          further be transformed using
                          ‘org-list-to-generic’, ‘org-list-to-subtree’
                          and alike.  Default value generates a plain
                          list of links to all files in the project.
                          
‘:sitemap-sort-folders’   Where folders should appear in the sitemap.
                          Set this to ‘first’ (default) or ‘last’ to
                          display folders first or last, respectively.
                          When set to ‘ignore’, folders are ignored
                          altogether.  Any other value will mix files
                          and folders.  This variable has no effect
                          when site-map style is ‘tree’.
                          
‘:sitemap-sort-files’     How the files are sorted in the site map.
                          Set this to ‘alphabetically’ (default),
                          ‘chronologically’ or ‘anti-chronologically’.
                          ‘chronologically’ sorts the files with older
                          date first while ‘anti-chronologically’ sorts
                          the files with newer date first.
                          ‘alphabetically’ sorts the files
                          alphabetically.  The date of a file is
                          retrieved with ‘org-publish-find-date’.
                          
‘:sitemap-ignore-case’    Should sorting be case-sensitive?  Default
                          ‘nil’.
                          
‘:sitemap-date-format’    Format string for the ‘format-time-string’
                          function that tells how a sitemap entry’s
                          date is to be formatted.  This property
                          bypasses ‘org-publish-sitemap-date-format’
                          which defaults to ‘%Y-%m-%d’.
                          


File: org.info,  Node: Generating an index,  Prev: Sitemap,  Up: Configuration

13.1.8 Generating an index
--------------------------

Org mode can generate an index across the files of a publishing project.

‘:makeindex’       When non-‘nil’, generate in index in the file
                   ‘theindex.org’ and publish it as ‘theindex.html’.

   The file will be created when first publishing a project with the
‘:makeindex’ set.  The file only contains a statement ‘#+INCLUDE:
"theindex.inc"’.  You can then build around this include statement by
adding a title, style information, etc.

   Index entries are specified with ‘#+INDEX’ keyword.  An entry that
contains an exclamation mark will create a sub item.

     * Curriculum Vitae
     #+INDEX: CV
     #+INDEX: Application!CV


File: org.info,  Node: Uploading files,  Next: Sample configuration,  Prev: Configuration,  Up: Publishing

13.2 Uploading files
====================

For those people already utilizing third party sync tools such as
‘rsync’ or ‘unison’, it might be preferable not to use the built in
remote publishing facilities of Org mode which rely heavily on Tramp.
Tramp, while very useful and powerful, tends not to be so efficient for
multiple file transfer and has been known to cause problems under heavy
usage.

   Specialized synchronization utilities offer several advantages.  In
addition to timestamp comparison, they also do content and
permissions/attribute checks.  For this reason you might prefer to
publish your web to a local directory (possibly even in place with your
Org files) and then use ‘unison’ or ‘rsync’ to do the synchronization
with the remote host.

   Since Unison (for example) can be configured as to which files to
transfer to a certain remote destination, it can greatly simplify the
project publishing definition.  Simply keep all files in the correct
location, process your Org files with ‘org-publish’ and let the
synchronization tool do the rest.  You do not need, in this scenario, to
include attachments such as ‘jpg’, ‘css’ or ‘gif’ files in the project
definition since the 3rd party tool syncs them.

   Publishing to a local directory is also much faster than to a remote
one, so that you can afford more easily to republish entire projects.
If you set ‘org-publish-use-timestamps-flag’ to ‘nil’, you gain the main
benefit of re-including any changed external files such as source
example files you might include with ‘#+INCLUDE:’.  The timestamp
mechanism in Org is not smart enough to detect if included files have
been modified.


File: org.info,  Node: Sample configuration,  Next: Triggering publication,  Prev: Uploading files,  Up: Publishing

13.3 Sample configuration
=========================

Below we provide two example configurations.  The first one is a simple
project publishing only a set of Org files.  The second example is more
complex, with a multi-component project.

* Menu:

* Simple example::              One-component publishing
* Complex example::             A multi-component publishing example


File: org.info,  Node: Simple example,  Next: Complex example,  Up: Sample configuration

13.3.1 Example: simple publishing configuration
-----------------------------------------------

This example publishes a set of Org files to the ‘public_html’ directory
on the local machine.

     (setq org-publish-project-alist
           '(("org"
              :base-directory "~/org/"
              :publishing-directory "~/public_html"
              :publishing-function org-html-publish-to-html
              :section-numbers nil
              :with-toc nil
              :html-head "<link rel=\"stylesheet\"
                         href=\"../other/mystyle.css\"
                         type=\"text/css\"/>")))


File: org.info,  Node: Complex example,  Prev: Simple example,  Up: Sample configuration

13.3.2 Example: complex publishing configuration
------------------------------------------------

This more complicated example publishes an entire website, including Org
files converted to HTML, image files, Emacs Lisp source code, and style
sheets.  The publishing directory is remote and private files are
excluded.

   To ensure that links are preserved, care should be taken to replicate
your directory structure on the web server, and to use relative file
paths.  For example, if your Org files are kept in ‘~/org’ and your
publishable images in ‘~/images’, you would link to an image with
     file:../images/myimage.png
   On the web server, the relative path to the image should be the same.
You can accomplish this by setting up an "images" folder in the right
place on the web server, and publishing images to it.

     (setq org-publish-project-alist
           '(("orgfiles"
               :base-directory "~/org/"
               :base-extension "org"
               :publishing-directory "/ssh:user@host:~/html/notebook/"
               :publishing-function org-html-publish-to-html
               :exclude "PrivatePage.org"   ;; regexp
               :headline-levels 3
               :section-numbers nil
               :with-toc nil
               :html-head "<link rel=\"stylesheet\"
                       href=\"../other/mystyle.css\" type=\"text/css\"/>"
               :html-preamble t)

              ("images"
               :base-directory "~/images/"
               :base-extension "jpg\\|gif\\|png"
               :publishing-directory "/ssh:user@host:~/html/images/"
               :publishing-function org-publish-attachment)

              ("other"
               :base-directory "~/other/"
               :base-extension "css\\|el"
               :publishing-directory "/ssh:user@host:~/html/other/"
               :publishing-function org-publish-attachment)
              ("website" :components ("orgfiles" "images" "other"))))


File: org.info,  Node: Triggering publication,  Prev: Sample configuration,  Up: Publishing

13.4 Triggering publication
===========================

Once properly configured, Org can publish with the following commands:

‘C-c C-e P x     (org-publish)’
     Prompt for a specific project and publish all files that belong to
     it.
‘C-c C-e P p     (org-publish-current-project)’
     Publish the project containing the current file.
‘C-c C-e P f     (org-publish-current-file)’
     Publish only the current file.
‘C-c C-e P a     (org-publish-all)’
     Publish every project.

   Org uses timestamps to track when a file has changed.  The above
functions normally only publish changed files.  You can override this
and force publishing of all files by giving a prefix argument to any of
the commands above, or by customizing the variable
‘org-publish-use-timestamps-flag’.  This may be necessary in particular
if files include other files via ‘#+SETUPFILE:’ or ‘#+INCLUDE:’.


File: org.info,  Node: Working with source code,  Next: Miscellaneous,  Prev: Publishing,  Up: Top

14 Working with source code
***************************

Source code here refers to any code typed in Org mode documents.  Org
can manage source code in any Org file once such code is tagged with
begin and end markers.  Working with source code begins with tagging
source code blocks.  Tagged ‘src’ code blocks are not restricted to the
preamble or the end of an Org document; they can go anywhere—with a few
exceptions, such as not inside comments and fixed width areas.  Here’s a
sample ‘src’ code block in emacs-lisp:

     #+BEGIN_SRC emacs-lisp
       (defun org-xor (a b)
          "Exclusive or."
          (if a (not b) b))
     #+END_SRC

   Org can take the code in the block between the ‘#+BEGIN_SRC’ and
‘#+END_SRC’ tags, and format, compile, execute, and show the results.
Org can simplify many housekeeping tasks essential to modern code
maintenance.  That’s why these blocks in Org mode literature are
sometimes referred to as ‘live code’ blocks (as compared to the static
text and documentation around it).  Users can control how ‘live’ they
want each block by tweaking the headers for compiling, execution,
extraction.

   Org’s ‘src’ code block type is one of many block types, such as
quote, export, verse, latex, example, and verbatim.  This section
pertains to ‘src’ code blocks between ‘#+BEGIN_SRC’ and ‘#+END_SRC’

   For editing ‘src’ code blocks, Org provides native Emacs major-modes.
That leverages the latest Emacs features for that source code language
mode.

   For exporting, Org can then extract ‘src’ code blocks into compilable
source files (in a conversion process known as “tangling” in literate
programming terminology).

   For publishing, Org’s back-ends can handle the ‘src’ code blocks and
the text for output to a variety of formats with native syntax
highlighting.

   For executing the source code in the ‘src’ code blocks, Org provides
facilities that glue the tasks of compiling, collecting the results of
the execution, and inserting them back to the Org file.  Besides text
output, results may include links to other data types that Emacs can
handle: audio, video, and graphics.

   An important feature of Org’s execution of the ‘src’ code blocks is
passing variables, functions, and results between ‘src’ blocks.  Such
interoperability uses a common syntax even if these ‘src’ blocks are in
different source code languages.  The integration extends to linking the
debugger’s error messages to the line in the ‘src’ code block in the Org
file.  That should partly explain why this functionality by the original
contributors, Eric Schulte and Dan Davison, was called ‘Org Babel’.

   In literate programming, the main appeal is code and documentation
co-existing in one file.  Org mode takes this several steps further.
First by enabling execution, and then by inserting results of that
execution back into the Org file.  Along the way, Org provides extensive
formatting features, including handling tables.  Org handles multiple
source code languages in one file, and provides a common syntax for
passing variables, functions, and results between ‘src’ code blocks.

   Org mode fulfills the promise of easy verification and maintenance of
publishing reproducible research by keeping all these in the same file:
text, data, code, configuration settings of the execution environment,
the results of the execution, and associated narratives, claims,
references, and internal and external links.

   Details of Org’s facilities for working with source code are shown
next.

* Menu:

* Structure of code blocks::    Code block syntax described
* Editing source code::         Language major-mode editing
* Exporting code blocks::       Export contents and/or results
* Extracting source code::      Create pure source code files
* Evaluating code blocks::      Place results of evaluation in the Org mode buffer
* Library of Babel::            Use and contribute to a library of useful code blocks
* Languages::                   List of supported code block languages
* Header arguments::            Configure code block functionality
* Results of evaluation::       How evaluation results are handled
* Noweb reference syntax::      Literate programming in Org mode
* Key bindings and useful functions::  Work quickly with code blocks
* Batch execution::             Call functions from the command line


File: org.info,  Node: Structure of code blocks,  Next: Editing source code,  Up: Working with source code

14.1 Structure of code blocks
=============================

Org offers two ways to structure source code in Org documents: in a
‘src’ block, and directly inline.  Both specifications are shown below.

   A ‘src’ block conforms to this structure:

     #+NAME: <name>
     #+BEGIN_SRC <language> <switches> <header arguments>
       <body>
     #+END_SRC

   Org mode’s templates system (*note Easy templates::) speeds up
creating ‘src’ code blocks with just three keystrokes.  Do not be
put-off by having to remember the source block syntax.  Org also works
with other completion systems in Emacs, some of which predate Org and
have custom domain-specific languages for defining templates.  Regular
use of templates reduces errors, increases accuracy, and maintains
consistency.

   An inline code block conforms to this structure:

     src_<language>{<body>}

   or

     src_<language>[<header arguments>]{<body>}

‘#+NAME: <name>’
     Optional.  Names the ‘src’ block so it can be called, like a
     function, from other ‘src’ blocks or inline blocks to evaluate or
     to capture the results.  Code from other blocks, other files, and
     from table formulas (*note The spreadsheet::) can use the name to
     reference a ‘src’ block.  This naming serves the same purpose as
     naming Org tables.  Org mode requires unique names.  For duplicate
     names, Org mode’s behavior is undefined.
‘#+BEGIN_SRC’
‘#+END_SRC’
     Mandatory.  They mark the start and end of a block that Org
     requires.  The ‘#+BEGIN_SRC’ line takes additional arguments, as
     described next.
‘<language>’
     Mandatory for live code blocks.  It is the identifier of the source
     code language in the block.  *Note Languages::, for identifiers of
     supported languages.
‘<switches>’
     Optional.  Switches provide finer control of the code execution,
     export, and format (see the discussion of switches in *note Literal
     examples::)
‘<header arguments>’
     Optional.  Heading arguments control many aspects of evaluation,
     export and tangling of code blocks (*note Header arguments::).
     Using Org’s properties feature, header arguments can be selectively
     applied to the entire buffer or specific sub-trees of the Org
     document.
‘source code, header arguments’
‘<body>’
     Source code in the dialect of the specified language identifier.


File: org.info,  Node: Editing source code,  Next: Exporting code blocks,  Prev: Structure of code blocks,  Up: Working with source code

14.2 Editing source code
========================

‘C-c '’ for editing the current code block.  It opens a new major-mode
edit buffer containing the body of the ‘src’ code block, ready for any
edits.  ‘C-c '’ again to close the buffer and return to the Org buffer.

   ‘C-x C-s’ saves the buffer and updates the contents of the Org
buffer.

   Set ‘org-edit-src-auto-save-idle-delay’ to save the base buffer after
a certain idle delay time.

   Set ‘org-edit-src-turn-on-auto-save’ to auto-save this buffer into a
separate file using ‘auto-save-mode’.

   ‘C-c '’ to close the major-mode buffer and return back to the Org
buffer.

   While editing the source code in the major-mode, the ‘org-src-mode’
minor mode remains active.  It provides these customization variables as
described below.  For even more variables, look in the customization
group ‘org-edit-structure’.

‘org-src-lang-modes’
     If an Emacs major-mode named ‘<lang>-mode’ exists, where ‘<lang>’
     is the language identifier from code block’s header line, then the
     edit buffer uses that major-mode.  Use this variable to arbitrarily
     map language identifiers to major modes.
‘org-src-window-setup’
     For specifying Emacs window arrangement when the new edit buffer is
     created.
‘org-src-preserve-indentation’
     Default is ‘nil’.  Source code is indented.  This indentation
     applies during export or tangling, and depending on the context,
     may alter leading spaces and tabs.  When non-‘nil’, source code is
     aligned with the leftmost column.  No lines are modified during
     export or tangling, which is very useful for white-space sensitive
     languages, such as Python.
‘org-src-ask-before-returning-to-edit-buffer’
     When ‘nil’, Org returns to the edit buffer without further prompts.
     The default prompts for a confirmation.

   Set ‘org-src-fontify-natively’ to non-‘nil’ to turn on native code
fontification in the _Org_ buffer.  Fontification of ‘src’ code blocks
can give visual separation of text and code on the display page.  To
further customize the appearance of ‘org-block’ for specific languages,
customize ‘org-src-block-faces’.  The following example shades the
background of regular blocks, and colors source blocks only for Python
and Emacs-Lisp languages.
     (require 'color)
     (set-face-attribute 'org-block nil :background
                         (color-darken-name
                          (face-attribute 'default :background) 3))

     (setq org-src-block-faces '(("emacs-lisp" (:background "#EEE2FF"))
                                 ("python" (:background "#E5FFB8"))))


File: org.info,  Node: Exporting code blocks,  Next: Extracting source code,  Prev: Editing source code,  Up: Working with source code

14.3 Exporting code blocks
==========================

Org can flexibly export just the _code_ from the code blocks, just the
_results_ of evaluation of the code block, _both_ the code and the
results of the code block evaluation, or _none_.  Org defaults to
exporting _code_ for most languages.  For some languages, such as
‘ditaa’, Org defaults to _results_.  To export just the body of code
blocks, *note Literal examples::.  To selectively export sub-trees of an
Org document, *note Exporting::.

   The ‘:exports’ header arguments control exporting code blocks only
and not inline code:

Header arguments:
.................

‘:exports code’
     This is the default for most languages where the body of the code
     block is exported.  See *note Literal examples:: for more.
‘:exports results’
     On export, Org includes only the results and not the code block.
     After each evaluation, Org inserts the results after the end of
     code block in the Org buffer.  By default, Org replaces any
     previous results.  Org can also append results.
‘:exports both’
     Org exports both the code block and the results.
‘:exports none’
     Org does not export the code block nor the results.

   To stop Org from evaluating code blocks to speed exports, use the
header argument ‘:eval never-export’ (*note eval::).  To stop Org from
evaluating code blocks for greater security, set the
‘org-export-use-babel’ variable to ‘nil’, but understand that header
arguments will have no effect.

   Turning off evaluation comes in handy when batch processing.  For
example, markup languages for wikis, which have a high risk of untrusted
code.  Stopping code block evaluation also stops evaluation of all
header arguments of the code block.  This may not be desirable in some
circumstances.  So during export, to allow evaluation of just the header
arguments but not any code evaluation in the source block, set ‘:eval
never-export’ (*note eval::).

   Org never evaluates code blocks in commented sub-trees when exporting
(*note Comment lines::).  On the other hand, Org does evaluate code
blocks in sub-trees excluded from export (*note Export settings::).


File: org.info,  Node: Extracting source code,  Next: Evaluating code blocks,  Prev: Exporting code blocks,  Up: Working with source code

14.4 Extracting source code
===========================

Extracting source code from code blocks is a basic task in literate
programming.  Org has features to make this easy.  In literate
programming parlance, documents on creation are _woven_ with code and
documentation, and on export, the code is _tangled_ for execution by a
computer.  Org facilitates weaving and tangling for producing,
maintaining, sharing, and exporting literate programming documents.  Org
provides extensive customization options for extracting source code.

   When Org tangles ‘src’ code blocks, it expands, merges, and
transforms them.  Then Org recomposes them into one or more separate
files, as configured through the options.  During this _tangling_
process, Org expands variables in the source code, and resolves any
Noweb style references (*note Noweb reference syntax::).

Header arguments
................

‘:tangle no’
     By default, Org does not tangle the ‘src’ code block on export.
‘:tangle yes’
     Org extracts the contents of the code block for the tangled output.
     By default, the output file name is the same as the Org file but
     with a file extension derived from the language identifier of the
     ‘src’ code block.
‘:tangle filename’
     Override the default file name with this one for the tangled
     output.

Functions
.........

‘org-babel-tangle’
     Tangle the current file.  Bound to ‘C-c C-v t’.

     With prefix argument only tangle the current ‘src’ code block.
‘org-babel-tangle-file’
     Choose a file to tangle.  Bound to ‘C-c C-v f’.

Hooks
.....

‘org-babel-post-tangle-hook’
     This hook runs from within code tangled by ‘org-babel-tangle’,
     making it suitable for post-processing, compilation, and evaluation
     of code in the tangled files.

Jumping between code and Org
............................

Debuggers normally link errors and messages back to the source code.
But for tangled files, we want to link back to the Org file, not to the
tangled source file.  To make this extra jump, Org uses
‘org-babel-tangle-jump-to-org’ function with two additional source code
block header arguments: One, set ‘padline’ (*note padline::) to true
(the default setting).  Two, set ‘comments’ (*note comments::) to
‘link’, which makes Org insert links to the Org file.


File: org.info,  Node: Evaluating code blocks,  Next: Library of Babel,  Prev: Extracting source code,  Up: Working with source code

14.5 Evaluating code blocks
===========================

A note about security: With code evaluation comes the risk of harm.  Org
safeguards by prompting for user’s permission before executing any code
in the source block.  To customize this safeguard (or disable it) see
*note Code evaluation security::.

   Org captures the results of the ‘src’ code block evaluation and
inserts them in the Org file, right after the ‘src’ code block.  The
insertion point is after a newline and the ‘#+RESULTS’ label.  Org
creates the ‘#+RESULTS’ label if one is not already there.

   By default, Org enables only ‘emacs-lisp’ ‘src’ code blocks for
execution.  See *note Languages:: for identifiers to enable other
languages.

   Org provides many ways to execute ‘src’ code blocks.  ‘C-c C-c’ or
‘C-c C-v e’ with the point on a ‘src’ code block(1) calls the
‘org-babel-execute-src-block’ function, which executes the code in the
block, collects the results, and inserts them in the buffer.

   By calling a named code block(2) from an Org mode buffer or a table.
Org can call the named ‘src’ code blocks from the current Org mode
buffer or from the “Library of Babel” (*note Library of Babel::).
Whether inline syntax or the ‘#+CALL:’ syntax is used, the result is
wrapped based on the variable ‘org-babel-inline-result-wrap’, which by
default is set to ‘"=%s="’ to produce verbatim text suitable for markup.

   The syntax for ‘#+CALL:’ is

     #+CALL: <name>(<arguments>)
     #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>

   The syntax for inline named code block is

     ... call_<name>(<arguments>) ...
     ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...

‘<name>’
     This is the name of the code block to be evaluated (*note Structure
     of code blocks::).
‘<arguments>’
     Org passes arguments to the code block using standard function call
     syntax.  For example, a ‘#+CALL:’ line that passes ‘4’ to a code
     block named ‘double’, which declares the header argument ‘:var
     n=2’, would be written as ‘#+CALL: double(n=4)’.  Note how this
     function call syntax is different from the header argument syntax.
‘<inside header arguments>’
     Org passes inside header arguments to the named ‘src’ code block
     using the header argument syntax.  Inside header arguments apply to
     code block evaluation.  For example, ‘[:results output]’ collects
     results printed to ‘STDOUT’ during code execution of that block.
     Note how this header argument syntax is different from the function
     call syntax.
‘<end header arguments>’
     End header arguments affect the results returned by the code block.
     For example, ‘:results html’ wraps the results in a ‘BEGIN_EXPORT
     html’ block before inserting the results in the Org buffer.

     For more examples of header arguments for ‘#+CALL:’ lines, *note
     Arguments in function calls::.

   ---------- Footnotes ----------

   (1) The option ‘org-babel-no-eval-on-ctrl-c-ctrl-c’ can be used to
remove code evaluation from the ‘C-c C-c’ key binding.

   (2) Actually, the constructs call_<name>() and src_<lang>{} are not
evaluated when they appear in a keyword line (i.e.  lines starting with
‘#+KEYWORD:’, *note In-buffer settings::).


File: org.info,  Node: Library of Babel,  Next: Languages,  Prev: Evaluating code blocks,  Up: Working with source code

14.6 Library of Babel
=====================

The “Library of Babel” is a collection of code blocks.  Like a function
library, these code blocks can be called from other Org files.  A
collection of useful code blocks is available on Worg
(https://orgmode.org/worg/library-of-babel.html).  For remote code block
evaluation syntax, *note Evaluating code blocks::.

   For any user to add code to the library, first save the code in
regular ‘src’ code blocks of an Org file, and then load the Org file
with ‘org-babel-lob-ingest’, which is bound to ‘C-c C-v i’.


File: org.info,  Node: Languages,  Next: Header arguments,  Prev: Library of Babel,  Up: Working with source code

14.7 Languages
==============

Org supports the following languages for the ‘src’ code blocks:

Language           Identifier         Language           Identifier
----------------------------------------------------------------------------
Asymptote          asymptote          Awk                awk
C                  C                  C++                C++
Clojure            clojure            CSS                css
D                  d                  ditaa              ditaa
Graphviz           dot                Emacs Calc         calc
Emacs Lisp         emacs-lisp         Fortran            fortran
gnuplot            gnuplot            Haskell            haskell
Java               java               Javascript         js
LaTeX              latex              Ledger             ledger
Lisp               lisp               Lilypond           lilypond
Lua                lua                MATLAB             matlab
Mscgen             mscgen             Objective Caml     ocaml
Octave             octave             Org mode           org
Oz                 oz                 Perl               perl
Plantuml           plantuml           Processing.js      processing
Python             python             R                  R
Ruby               ruby               Sass               sass
Scheme             scheme             GNU Screen         screen
Sed                sed                shell              sh
SQL                sql                SQLite             sqlite
Vala               vala

   Additional documentation for some languages are at
<https://orgmode.org/worg/org-contrib/babel/languages.html>.

   By default, only ‘emacs-lisp’ is enabled for evaluation.  To enable
or disable other languages, customize the ‘org-babel-load-languages’
variable either through the Emacs customization interface, or by adding
code to the init file as shown next:

   In this example, evaluation is disabled for ‘emacs-lisp’, and enabled
for ‘R’.

     (org-babel-do-load-languages
      'org-babel-load-languages
      '((emacs-lisp . nil)
        (R . t)))

   Note that this is not the only way to enable a language.  Org also
enables languages when loaded with ‘require’ statement.  For example,
the following enables execution of ‘clojure’ code blocks:

     (require 'ob-clojure)


File: org.info,  Node: Header arguments,  Next: Results of evaluation,  Prev: Languages,  Up: Working with source code

14.8 Header arguments
=====================

Details of configuring header arguments are shown here.

* Menu:

* Using header arguments::      Different ways to set header arguments
* Specific header arguments::   List of header arguments


File: org.info,  Node: Using header arguments,  Next: Specific header arguments,  Up: Header arguments

14.8.1 Using header arguments
-----------------------------

Since header arguments can be set in several ways, Org prioritizes them
in case of overlaps or conflicts by giving local settings a higher
priority.  Header values in function calls, for example, override header
values from global defaults.
* Menu:

* System-wide header arguments::  Set globally, language-specific
* Language-specific header arguments::  Set in the Org file’s headers
* Header arguments in Org mode properties::  Set in the Org file
* Language-specific mode properties::
* Code block specific header arguments::  The most commonly used method
* Arguments in function calls::  The most specific level, takes highest priority


File: org.info,  Node: System-wide header arguments,  Next: Language-specific header arguments,  Up: Using header arguments

System-wide header arguments
............................

System-wide values of header arguments can be specified by adapting the
‘org-babel-default-header-args’ variable:

     :session    => "none"
     :results    => "replace"
     :exports    => "code"
     :cache      => "no"
     :noweb      => "no"

   This example sets ‘:noweb’ header arguments to ‘yes’, which makes Org
expand ‘:noweb’ references by default.

     (setq org-babel-default-header-args
           (cons '(:noweb . "yes")
                 (assq-delete-all :noweb org-babel-default-header-args)))


File: org.info,  Node: Language-specific header arguments,  Next: Header arguments in Org mode properties,  Prev: System-wide header arguments,  Up: Using header arguments

Language-specific header arguments
..................................

Each language can have separate default header arguments by customizing
the variable ‘org-babel-default-header-args:<lang>’, where ‘<lang>’ is
the name of the language.  For details, see the language-specific online
documentation at <https://orgmode.org/worg/org-contrib/babel/>.


File: org.info,  Node: Header arguments in Org mode properties,  Next: Language-specific mode properties,  Prev: Language-specific header arguments,  Up: Using header arguments

Header arguments in Org mode properties
.......................................

For header arguments applicable to the buffer, use ‘#+PROPERTY:’ lines
anywhere in the Org mode file (*note Property syntax::).

   The following example sets only for ‘R’ code blocks to ‘session’,
making all the ‘R’ code blocks execute in the same session.  Setting
‘results’ to ‘silent’ ignores the results of executions for all blocks,
not just ‘R’ code blocks; no results inserted for any block.

     #+PROPERTY: header-args:R  :session *R*
     #+PROPERTY: header-args    :results silent

   Header arguments set through Org’s property drawers (*note Property
syntax::) apply at the sub-tree level on down.  Since these property
drawers can appear anywhere in the file hierarchy, Org uses outermost
call or source block to resolve the values.  Org ignores
‘org-use-property-inheritance’ setting.

   In this example, ‘:cache’ defaults to ‘yes’ for all code blocks in
the sub-tree starting with ‘sample header’.

     * sample header
       :PROPERTIES:
       :header-args:    :cache yes
       :END:

   Properties defined through ‘org-set-property’ function, bound to ‘C-c
C-x p’, apply to all active languages.  They override properties set in
‘org-babel-default-header-args’.


File: org.info,  Node: Language-specific mode properties,  Next: Code block specific header arguments,  Prev: Header arguments in Org mode properties,  Up: Using header arguments

Language-specific mode properties
.................................

Language-specific header arguments are also read from properties
‘header-args:<lang>’ where ‘<lang>’ is the language identifier.  For
example,

     * Heading
       :PROPERTIES:
       :header-args:clojure:    :session *clojure-1*
       :header-args:R:          :session *R*
       :END:
     ** Subheading
       :PROPERTIES:
       :header-args:clojure:    :session *clojure-2*
       :END:

   would force separate sessions for clojure blocks in Heading and
Subheading, but use the same session for all ‘R’ blocks.  Blocks in
Subheading inherit settings from Heading.


File: org.info,  Node: Code block specific header arguments,  Next: Arguments in function calls,  Prev: Language-specific mode properties,  Up: Using header arguments

Code block specific header arguments
....................................

Header arguments are most commonly set at the ‘src’ code block level, on
the ‘#+BEGIN_SRC’ line.  Arguments set at this level take precedence
over those set in the ‘org-babel-default-header-args’ variable, and also
those set as header properties.

   In the following example, setting ‘results’ to ‘silent’ makes it
ignore results of the code execution.  Setting ‘:exports’ to ‘code’
exports only the body of the ‘src’ code block to HTML or LaTeX.:

     #+NAME: factorial
     #+BEGIN_SRC haskell :results silent :exports code :var n=0
     fac 0 = 1
     fac n = n * fac (n-1)
     #+END_SRC

   The same header arguments in an inline ‘src’ code block:

     src_haskell[:exports both]{fac 5}

   Code block header arguments can span multiple lines using ‘#+HEADER:’
on each line.  Note that Org currently accepts the plural spelling of
‘#+HEADER:’ only as a convenience for backward-compatibility.  It may be
removed at some point.

   Multi-line header arguments on an unnamed ‘src’ code block:

     #+HEADER: :var data1=1
     #+BEGIN_SRC emacs-lisp :var data2=2
        (message "data1:%S, data2:%S" data1 data2)
     #+END_SRC

     #+RESULTS:
     : data1:1, data2:2

   Multi-line header arguments on a named ‘src’ code block:

     #+NAME: named-block
     #+HEADER: :var data=2
     #+BEGIN_SRC emacs-lisp
       (message "data:%S" data)
     #+END_SRC

     #+RESULTS: named-block
       : data:2


File: org.info,  Node: Arguments in function calls,  Prev: Code block specific header arguments,  Up: Using header arguments

Arguments in function calls
...........................

Header arguments in function calls are the most specific and override
all other settings in case of an overlap.  They get the highest
priority.  Two ‘#+CALL:’ examples are shown below.  For the complete
syntax of ‘#+CALL:’ lines, see *note Evaluating code blocks::.

   In this example, ‘:exports results’ header argument is applied to the
evaluation of the ‘#+CALL:’ line.

     #+CALL: factorial(n=5) :exports results

   In this example, ‘:session special’ header argument is applied to the
evaluation of ‘factorial’ code block.

     #+CALL: factorial[:session special](n=5)


File: org.info,  Node: Specific header arguments,  Prev: Using header arguments,  Up: Header arguments

14.8.2 Specific header arguments
--------------------------------

Org comes with many header arguments common to all languages.  New
header arguments are added for specific languages as they become
available for use in ‘src’ code blocks.  A header argument is specified
with an initial colon followed by the argument’s name in lowercase.
Common header arguments are:

* Menu:

* var::                         Pass arguments to ‘src’ code blocks
* results::                     Specify results type; how to collect
* file::                        Specify a path for output file
* file-desc::                   Specify a description for file results
* file-ext::                    Specify an extension for file output
* output-dir::                  Specify a directory for output file
* dir::                         Specify the default directory for code block execution
* exports::                     Specify exporting code, results, both, none
* tangle::                      Toggle tangling; or specify file name
* mkdirp::                      Toggle for parent directory creation for target files during tangling
* comments::                    Toggle insertion of comments in tangled code files
* padline::                     Control insertion of padding lines in tangled code files
* no-expand::                   Turn off variable assignment and noweb expansion during tangling
* session::                     Preserve the state of code evaluation
* noweb::                       Toggle expansion of noweb references
* noweb-ref::                   Specify block’s noweb reference resolution target
* noweb-sep::                   String to separate noweb references
* cache::                       Avoid re-evaluating unchanged code blocks
* sep::                         Delimiter for writing tabular results outside Org
* hlines::                      Handle horizontal lines in tables
* colnames::                    Handle column names in tables
* rownames::                    Handle row names in tables
* shebang::                     Make tangled files executable
* tangle-mode::                 Set permission of tangled files
* eval::                        Limit evaluation of specific code blocks
* wrap::                        Mark source block evaluation results
* post::                        Post processing of results of code block evaluation
* prologue::                    Text to prepend to body of code block
* epilogue::                    Text to append to body of code block

   For language-specific header arguments, see *note Languages::.


File: org.info,  Node: var,  Next: results,  Up: Specific header arguments

14.8.2.1 ‘:var’
...............

Use ‘:var’ for passing arguments to ‘src’ code blocks.  The specifics of
variables in ‘src’ code blocks vary by the source language and are
covered in the language-specific documentation.  The syntax for ‘:var’,
however, is the same for all languages.  This includes declaring a
variable, and assigning a default value.

   Arguments can take values as literals, or as references, or even as
Emacs Lisp code (*note Emacs Lisp evaluation of variables: var.).
References are names from the Org file from the lines ‘#+NAME:’ or
‘#+RESULTS:’.  References can also refer to tables, lists,
‘#+BEGIN_EXAMPLE’ blocks, other types of ‘src’ code blocks, or the
results of execution of ‘src’ code blocks.

   For better performance, Org can cache results of evaluations.  But
caching comes with severe limitations (*note cache::).

   Argument values are indexed like arrays (*note Indexable variable
values: var.).

   The following syntax is used to pass arguments to ‘src’ code blocks
using the ‘:var’ header argument.

     :var name=assign

   The ‘assign’ is a literal value, such as a string ‘"string"’, a
number ‘9’, a reference to a table, a list, a literal example, another
code block (with or without arguments), or the results from evaluating a
code block.

   Here are examples of passing values by reference:

“table”
     an Org mode table named with either a ‘#+NAME:’ line

          #+NAME: example-table
          | 1 |
          | 2 |
          | 3 |
          | 4 |

          #+NAME: table-length
          #+BEGIN_SRC emacs-lisp :var table=example-table
          (length table)
          #+END_SRC

          #+RESULTS: table-length
          : 4

“list”
     a simple list named with a ‘#+NAME:’ line.  Note that only the top
     level list items are passed along.  Nested list items are ignored.

          #+NAME: example-list
            - simple
              - not
              - nested
            - list

          #+BEGIN_SRC emacs-lisp :var x=example-list
            (print x)
          #+END_SRC

          #+RESULTS:
          | simple | list |

“code block without arguments”
     a code block name (from the example above), as assigned by
     ‘#+NAME:’, optionally followed by parentheses

          #+BEGIN_SRC emacs-lisp :var length=table-length()
          (* 2 length)
          #+END_SRC

          #+RESULTS:
          : 8

“code block with arguments”
     a ‘src’ code block name, as assigned by ‘#+NAME:’, followed by
     parentheses and optional arguments passed within the parentheses
     following the ‘src’ code block name using standard function call
     syntax

          #+NAME: double
          #+BEGIN_SRC emacs-lisp :var input=8
          (* 2 input)
          #+END_SRC

          #+RESULTS: double
          : 16

          #+NAME: squared
          #+BEGIN_SRC emacs-lisp :var input=double(input=2)
          (* input input)
          #+END_SRC

          #+RESULTS: squared
          : 4

“literal example”
     a literal example block named with a ‘#+NAME:’ line

          #+NAME: literal-example
          #+BEGIN_EXAMPLE
          A literal example
          on two lines
          #+END_EXAMPLE

          #+NAME: read-literal-example
          #+BEGIN_SRC emacs-lisp :var x=literal-example
            (concatenate 'string x " for you.")
          #+END_SRC

          #+RESULTS: read-literal-example
          : A literal example
          : on two lines for you.


Indexable variable values
.........................

Indexing variable values enables referencing portions of a variable.
Indexes are 0 based with negative values counting backwards from the
end.  If an index is separated by ‘,’s then each subsequent section will
index as the next dimension.  Note that this indexing occurs _before_
other table-related header arguments are applied, such as ‘:hlines’,
‘:colnames’ and ‘:rownames’.  The following example assigns the last
cell of the first row the table ‘example-table’ to the variable ‘data’:

     #+NAME: example-table
     | 1 | a |
     | 2 | b |
     | 3 | c |
     | 4 | d |

     #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
       data
     #+END_SRC

     #+RESULTS:
     : a

   Ranges of variable values can be referenced using two integers
separated by a ‘:’, in which case the entire inclusive range is
referenced.  For example the following assigns the middle three rows of
‘example-table’ to ‘data’.

     #+NAME: example-table
     | 1 | a |
     | 2 | b |
     | 3 | c |
     | 4 | d |
     | 5 | 3 |

     #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
       data
     #+END_SRC

     #+RESULTS:
     | 2 | b |
     | 3 | c |
     | 4 | d |

   To pick the entire range, use an empty index, or the single character
‘*’.  ‘0:-1’ does the same thing.  Example below shows how to reference
the first column only.

     #+NAME: example-table
     | 1 | a |
     | 2 | b |
     | 3 | c |
     | 4 | d |

     #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
       data
     #+END_SRC

     #+RESULTS:
     | 1 | 2 | 3 | 4 |

   Index referencing can be used for tables and code blocks.  Index
referencing can handle any number of dimensions.  Commas delimit
multiple dimensions, as shown below.

     #+NAME: 3D
     #+BEGIN_SRC emacs-lisp
       '(((1  2  3)  (4  5  6)  (7  8  9))
         ((10 11 12) (13 14 15) (16 17 18))
         ((19 20 21) (22 23 24) (25 26 27)))
     #+END_SRC

     #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
       data
     #+END_SRC

     #+RESULTS:
     | 11 | 14 | 17 |

Emacs Lisp evaluation of variables
..................................

Emacs lisp code can set the values for variables.  To differentiate a
value from lisp code, Org interprets any value starting with ‘(’, ‘[’,
‘'’ or ‘`’ as Emacs Lisp code.  The result of evaluating that code is
then assigned to the value of that variable.  The following example
shows how to reliably query and pass file name of the Org mode buffer to
a code block using headers.  We need reliability here because the file’s
name could change once the code in the block starts executing.

     #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
       wc -w $filename
     #+END_SRC

   Note that values read from tables and lists will not be mistakenly
evaluated as Emacs Lisp code, as illustrated in the following example.

     #+NAME: table
     | (a b c) |

     #+HEADER: :var data=table[0,0]
     #+BEGIN_SRC perl
       $data
     #+END_SRC

     #+RESULTS:
     : (a b c)


File: org.info,  Node: results,  Next: file,  Prev: var,  Up: Specific header arguments

14.8.2.2 ‘:results’
...................

There are four classes of ‘:results’ header arguments.  Each ‘src’ code
block can take only one option per class.

   • collection for how the results should be collected from the ‘src’
     code block
   • type for which type of result the code block will return; affects
     how Org processes and inserts results in the Org buffer
   • format for the result; affects how Org processes and inserts
     results in the Org buffer
   • handling for processing results after evaluation of the ‘src’ code
     block

Collection
..........

Collection options specify the results.  Choose one of the options; they
are mutually exclusive.

   • ‘value’ Default.  Functional mode.  Result is the value returned by
     the last statement in the ‘src’ code block.  Languages like Python
     may require an explicit ‘return’ statement in the ‘src’ code block.
     Usage example: ‘:results value’.
   • ‘output’ Scripting mode.  Result is collected from STDOUT during
     execution of the code in the ‘src’ code block.  Usage example:
     ‘:results output’.

Type
....

Type tells what result types to expect from the execution of the code
block.  Choose one of the options; they are mutually exclusive.  The
default behavior is to automatically determine the result type.

   • ‘table’, ‘vector’ Interpret the results as an Org table.  If the
     result is a single value, create a table with one row and one
     column.  Usage example: ‘:results value table’.
   • ‘list’ Interpret the results as an Org list.  If the result is a
     single value, create a list of one element.
   • ‘scalar’, ‘verbatim’ Interpret literally and insert as quoted text.
     Do not create a table.  Usage example: ‘:results value verbatim’.
   • ‘file’ Interpret as path to a file.  Inserts a link to the file.
     Usage example: ‘:results value file’.

Format
......

Format pertains to the type of the result returned by the ‘src’ code
block.  Choose one of the options; they are mutually exclusive.  The
default follows from the type specified above.

   • ‘raw’ Interpreted as raw Org mode.  Inserted directly into the
     buffer.  Aligned if it is a table.  Usage example: ‘:results value
     raw’.
   • ‘org’ Results enclosed in a ‘BEGIN_SRC org’ block.  For
     comma-escape, either <TAB> in the block, or export the file.  Usage
     example: ‘:results value org’.
   • ‘html’ Results enclosed in a ‘BEGIN_EXPORT html’ block.  Usage
     example: ‘:results value html’.
   • ‘latex’ Results enclosed in a ‘BEGIN_EXPORT latex’ block.  Usage
     example: ‘:results value latex’.
   • ‘code’ Result enclosed in a ‘src’ code block.  Useful for parsing.
     Usage example: ‘:results value code’.
   • ‘pp’ Result converted to pretty-print source code.  Enclosed in a
     ‘src’ code block.  Languages supported: Emacs Lisp, Python, and
     Ruby.  Usage example: ‘:results value pp’.
   • ‘drawer’ Result wrapped in a RESULTS drawer.  Useful for containing
     ‘raw’ or ‘org’ results for later scripting and automated
     processing.  Usage example: ‘:results value drawer’.

Handling
........

Handling options after collecting the results.

   • ‘silent’ Do not insert results in the Org mode buffer, but echo
     them in the minibuffer.  Usage example: ‘:results output silent’.
   • ‘replace’ Default.  Insert results in the Org buffer.  Remove
     previous results.  Usage example: ‘:results output replace’.
   • ‘append’ Append results to the Org buffer.  Latest results are at
     the bottom.  Does not remove previous results.  Usage example:
     ‘:results output append’.
   • ‘prepend’ Prepend results to the Org buffer.  Latest results are at
     the top.  Does not remove previous results.  Usage example:
     ‘:results output prepend’.


File: org.info,  Node: file,  Next: file-desc,  Prev: results,  Up: Specific header arguments

14.8.2.3 ‘:file’
................

An external ‘:file’ that saves the results of execution of the code
block.  The ‘:file’ is either a file name or two strings, where the
first is the file name and the second is the description.  A link to the
file is inserted.  It uses an Org mode style ‘[[file:]]’ link (*note
Link format::).  Some languages, such as ‘R’, ‘dot’, ‘ditaa’, and
‘gnuplot’, automatically wrap the source code in additional boilerplate
code.  Such code wrapping helps recreate the output, especially graphics
output, by executing just the ‘:file’ contents.


File: org.info,  Node: file-desc,  Next: file-ext,  Prev: file,  Up: Specific header arguments

14.8.2.4 ‘:file-desc’
.....................

A description of the results file.  Org uses this description for the
link (see *note Link format::) it inserts in the Org file.  If the
‘:file-desc’ has no value, Org will use file name for both the “link”
and the “description” portion of the Org mode link.


File: org.info,  Node: file-ext,  Next: output-dir,  Prev: file-desc,  Up: Specific header arguments

14.8.2.5 ‘:file-ext’
....................

File name extension for the output file.  Org generates the file’s
complete name, and extension by combining ‘:file-ext’, ‘#+NAME:’ of the
source block, and the *note output-dir:: header argument.  To override
this auto generated file name, use the ‘:file’ header argument.


File: org.info,  Node: output-dir,  Next: dir,  Prev: file-ext,  Up: Specific header arguments

14.8.2.6 ‘:output-dir’
......................

Specifies the ‘:output-dir’ for the results file.  Org accepts an
absolute path (beginning with ‘/’) or a relative directory (without
‘/’).  The value can be combined with ‘#+NAME:’ of the source block and
*note file:: or *note file-ext:: header arguments.


File: org.info,  Node: dir,  Next: exports,  Prev: output-dir,  Up: Specific header arguments

14.8.2.7 ‘:dir’ and remote execution
....................................

While the ‘:file’ header argument can be used to specify the path to the
output file, ‘:dir’ specifies the default directory during ‘src’ code
block execution.  If it is absent, then the directory associated with
the current buffer is used.  In other words, supplying ‘:dir path’
temporarily has the same effect as changing the current directory with
‘M-x cd path <RET>’, and then not supplying ‘:dir’.  Under the surface,
‘:dir’ simply sets the value of the Emacs variable ‘default-directory’.

   When using ‘:dir’, relative paths (for example, ‘:file myfile.jpg’ or
‘:file results/myfile.jpg’) become relative to the default directory.

   For example, to save the plot file in the ‘Work’ folder of the home
directory (notice tilde is expanded):

     #+BEGIN_SRC R :file myplot.png :dir ~/Work
     matplot(matrix(rnorm(100), 10), type="l")
     #+END_SRC

Remote execution
................

To evaluate the ‘src’ code block on a remote machine, supply a remote s
directory name using ‘Tramp’ syntax.  For example:

     #+BEGIN_SRC R :file plot.png :dir /scp:dand@yakuba.princeton.edu:
     plot(1:10, main=system("hostname", intern=TRUE))
     #+END_SRC

   Org first captures the text results as usual for insertion in the Org
file.  Then Org also inserts a link to the remote file, thanks to Emacs
‘Tramp’.  Org constructs the remote path to the file name from ‘:dir’
and ‘default-directory’, as illustrated here:

     [[file:/scp:dand@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]

Some more warnings
..................

   • When ‘:dir’ is used with ‘:session’, Org sets the starting
     directory for a new session.  But Org will not alter the directory
     of an already existing session.
   • Do not use ‘:dir’ with ‘:exports results’ or with ‘:exports both’
     to avoid Org inserting incorrect links to remote files.  That is
     because Org does not expand ‘default directory’ to avoid some
     underlying portability issues.


File: org.info,  Node: exports,  Next: tangle,  Prev: dir,  Up: Specific header arguments

14.8.2.8 ‘:exports’
...................

The ‘:exports’ header argument is to specify if that part of the Org
file is exported to, say, HTML or LaTeX formats.  Note that ‘:exports’
affects only ‘src’ code blocks and not inline code.

   • ‘code’ The default.  The body of code is included into the exported
     file.  Example: ‘:exports code’.
   • ‘results’ The results of evaluation of the code is included in the
     exported file.  Example: ‘:exports results’.
   • ‘both’ Both the code and results of evaluation are included in the
     exported file.  Example: ‘:exports both’.
   • ‘none’ Neither the code nor the results of evaluation is included
     in the exported file.  Whether the code is evaluated at all depends
     on other options.  Example: ‘:exports none’.


File: org.info,  Node: tangle,  Next: mkdirp,  Prev: exports,  Up: Specific header arguments

14.8.2.9 ‘:tangle’
..................

The ‘:tangle’ header argument specifies if the ‘src’ code block is
exported to source file(s).

   • ‘tangle’ Export the ‘src’ code block to source file.  The file name
     for the source file is derived from the name of the Org file, and
     the file extension is derived from the source code language
     identifier.  Example: ‘:tangle yes’.
   • ‘no’ The default.  Do not extract the code a source code file.
     Example: ‘:tangle no’.
   • other Export the ‘src’ code block to source file whose file name is
     derived from any string passed to the ‘:tangle’ header argument.
     Org derives the file name as being relative to the directory of the
     Org file’s location.  Example: ‘:tangle path’.


File: org.info,  Node: mkdirp,  Next: comments,  Prev: tangle,  Up: Specific header arguments

14.8.2.10 ‘:mkdirp’
...................

The ‘:mkdirp’ header argument creates parent directories for tangled
files if the directory does not exist.  ‘yes’ enables directory creation
and ‘no’ inhibits directory creation.


File: org.info,  Node: comments,  Next: padline,  Prev: mkdirp,  Up: Specific header arguments

14.8.2.11 ‘:comments’
.....................

Controls inserting comments into tangled files.  These are above and
beyond whatever comments may already exist in the ‘src’ code block.

   • ‘no’ The default.  Do not insert any extra comments during
     tangling.
   • ‘link’ Wrap the ‘src’ code block in comments.  Include links
     pointing back to the place in the Org file from where the code was
     tangled.
   • ‘yes’ Kept for backward compatibility; same as “link”.
   • ‘org’ Nearest headline text from Org file is inserted as comment.
     The exact text that is inserted is picked from the leading context
     of the source block.
   • ‘both’ Includes both “link” and “org” comment options.
   • ‘noweb’ Includes “link” comment option, expands noweb references,
     and wraps them in link comments inside the body of the ‘src’ code
     block.


File: org.info,  Node: padline,  Next: no-expand,  Prev: comments,  Up: Specific header arguments

14.8.2.12 ‘:padline’
....................

Control insertion of newlines to pad ‘src’ code blocks in the tangled
file.
   • ‘yes’ Default.  Insert a newline before and after each ‘src’ code
     block in the tangled file.
   • ‘no’ Do not insert newlines to pad the tangled ‘src’ code blocks.


File: org.info,  Node: no-expand,  Next: session,  Prev: padline,  Up: Specific header arguments

14.8.2.13 ‘:no-expand’
......................

By default Org expands ‘src’ code blocks during tangling.  The
‘:no-expand’ header argument turns off such expansions.  Note that one
side-effect of expansion by ‘org-babel-expand-src-block’ also assigns
values to ‘:var’ (*note var::) variables.  Expansions also replace Noweb
references with their targets (*note Noweb reference syntax::).  Some of
these expansions may cause premature assignment, hence this option.
This option makes a difference only for tangling.  It has no effect when
exporting since ‘src’ code blocks for execution have to be expanded
anyway.


File: org.info,  Node: session,  Next: noweb,  Prev: no-expand,  Up: Specific header arguments

14.8.2.14 ‘:session’
....................

The ‘:session’ header argument is for running multiple source code
blocks under one session.  Org runs ‘src’ code blocks with the same
session name in the same interpreter process.

   • ‘none’ Default.  Each ‘src’ code block gets a new interpreter
     process to execute.  The process terminates once the block is
     evaluated.
   • ‘other’ Any string besides ‘none’ turns that string into the name
     of that session.  For example, ‘:session mysession’ names it
     ‘mysession’.  If ‘:session’ has no argument, then the session name
     is derived from the source language identifier.  Subsequent blocks
     with the same source code language use the same session.  Depending
     on the language, state variables, code from other blocks, and the
     overall interpreted environment may be shared.  Some interpreted
     languages support concurrent sessions when subsequent source code
     language blocks change session names.


File: org.info,  Node: noweb,  Next: noweb-ref,  Prev: session,  Up: Specific header arguments

14.8.2.15 ‘:noweb’
..................

The ‘:noweb’ header argument controls expansion of Noweb syntax
references (*note Noweb reference syntax::).  Expansions occur when
source code blocks are evaluated, tangled, or exported.

   • ‘no’ Default.  No expansion of Noweb syntax references in the body
     of the code when evaluating, tangling, or exporting.
   • ‘yes’ Expansion of Noweb syntax references in the body of the ‘src’
     code block when evaluating, tangling, or exporting.
   • ‘tangle’ Expansion of Noweb syntax references in the body of the
     ‘src’ code block when tangling.  No expansion when evaluating or
     exporting.
   • ‘no-export’ Expansion of Noweb syntax references in the body of the
     ‘src’ code block when evaluating or tangling.  No expansion when
     exporting.
   • ‘strip-export’ Expansion of Noweb syntax references in the body of
     the ‘src’ code block when expanding prior to evaluating or
     tangling.  Removes Noweb syntax references when exporting.
   • ‘eval’ Expansion of Noweb syntax references in the body of the
     ‘src’ code block only before evaluating.

Noweb prefix lines
..................

Noweb insertions now honor prefix characters that appear before the
Noweb syntax reference.

   This behavior is illustrated in the following example.  Because the
‘<<example>>’ noweb reference appears behind the SQL comment syntax,
each line of the expanded noweb reference will be commented.

   With:

     #+NAME: example
     #+BEGIN_SRC text
     this is the
     multi-line body of example
     #+END_SRC

   this ‘src’ code block:

     #+BEGIN_SRC sql :noweb yes
     -- <<example>>
     #+END_SRC

   expands to:

     -- this is the
     -- multi-line body of example

   Since this change will not affect noweb replacement text without
newlines in them, inline noweb references are acceptable.

   This feature can also be used for management of indentation in
exported code snippets.

   With:

     #+NAME: if-true
     #+BEGIN_SRC python :exports none
     print('Do things when True')
     #+END_SRC

     #+NAME: if-false
     #+BEGIN_SRC python :exports none
     print('Do things when False')
     #+END_SRC

   this ‘src’ code block:

     #+BEGIN_SRC python :noweb yes :results output
     if True:
         <<if-true>>
     else:
         <<if-false>>
     #+END_SRC

   expands to:

     if True:
         print('Do things when True')
     else:
         print('Do things when False')

   and evaluates to:

     Do things when True


File: org.info,  Node: noweb-ref,  Next: noweb-sep,  Prev: noweb,  Up: Specific header arguments

14.8.2.16 ‘:noweb-ref’
......................

When expanding Noweb style references, Org concatenates ‘src’ code
blocks by matching the reference name to either the code block name or
the ‘:noweb-ref’ header argument.

   For simple concatenation, set this ‘:noweb-ref’ header argument at
the sub-tree or file level.  In the example Org file shown next, the
body of the source code in each block is extracted for concatenation to
a pure code file when tangled.

      #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
        <<fullest-disk>>
      #+END_SRC
      * the mount point of the fullest disk
        :PROPERTIES:
        :header-args: :noweb-ref fullest-disk
        :END:

      ** query all mounted disks
      #+BEGIN_SRC sh
        df \
      #+END_SRC

      ** strip the header row
      #+BEGIN_SRC sh
        |sed '1d' \
      #+END_SRC

      ** output mount point of fullest disk
      #+BEGIN_SRC sh
        |awk '{if (u < +$5) {u = +$5; m = $6}} END {print m}'
      #+END_SRC


File: org.info,  Node: noweb-sep,  Next: cache,  Prev: noweb-ref,  Up: Specific header arguments

14.8.2.17 ‘:noweb-sep’
......................

By default a newline separates each noweb reference concatenation.  To
change this newline separator, edit the ‘:noweb-sep’ (*note noweb-sep::)
header argument.


File: org.info,  Node: cache,  Next: sep,  Prev: noweb-sep,  Up: Specific header arguments

14.8.2.18 ‘:cache’
..................

The ‘:cache’ header argument is for caching results of evaluating code
blocks.  Caching results can avoid re-evaluating ‘src’ code blocks that
have not changed since the previous run.  To benefit from the cache and
avoid redundant evaluations, the source block must have a result already
present in the buffer, and neither the header arguments (including the
value of ‘:var’ references) nor the text of the block itself has changed
since the result was last computed.  This feature greatly helps avoid
long-running calculations.  For some edge cases, however, the cached
results may not be reliable.

   The caching feature is best for when ‘src’ blocks are pure functions,
that is functions that return the same value for the same input
arguments (*note var::), and that do not have side effects, and do not
rely on external variables other than the input arguments.  Functions
that depend on a timer, file system objects, and random number
generators are clearly unsuitable for caching.

   A note of warning: when ‘:cache’ is used for a ‘:session’, caching
may cause unexpected results.

   When the caching mechanism tests for any source code changes, it will
not expand Noweb style references (*note Noweb reference syntax::).  For
reasons why, see <http://thread.gmane.org/gmane.emacs.orgmode/79046>.

   The ‘:cache’ header argument can have one of two values: ‘yes’ or
‘no’.

   • ‘no’ Default.  No caching of results; ‘src’ code block evaluated
     every time.
   • ‘yes’ Whether to run the code or return the cached results is
     determined by comparing the SHA1 hash value of the combined ‘src’
     code block and arguments passed to it.  This hash value is packed
     on the ‘#+RESULTS:’ line from previous evaluation.  When hash
     values match, Org does not evaluate the ‘src’ code block.  When
     hash values mismatch, Org evaluates the ‘src’ code block, inserts
     the results, recalculates the hash value, and updates ‘#+RESULTS:’
     line.

   In this example, both functions are cached.  But ‘caller’ runs only
if the result from ‘random’ has changed since the last run.

      #+NAME: random
      #+BEGIN_SRC R :cache yes
      runif(1)
      #+END_SRC

      #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
      0.4659510825295

      #+NAME: caller
      #+BEGIN_SRC emacs-lisp :var x=random :cache yes
      x
      #+END_SRC

      #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
      0.254227238707244


File: org.info,  Node: sep,  Next: hlines,  Prev: cache,  Up: Specific header arguments

14.8.2.19 ‘:sep’
................

The ‘:sep’ header argument is the delimiter for saving results as tables
to files (*note file::) external to Org mode.  Org defaults to tab
delimited output.  The function, ‘org-open-at-point’, which is bound to
‘C-c C-o’, also uses ‘:sep’ for opening tabular results.


File: org.info,  Node: hlines,  Next: colnames,  Prev: sep,  Up: Specific header arguments

14.8.2.20 ‘:hlines’
...................

In-between each table row or below the table headings, sometimes results
have horizontal lines, which are also known as hlines.  The ‘:hlines’
argument with the value ‘yes’ accepts such lines.  The default is ‘no’.

   • ‘no’ Strips horizontal lines from the input table.  For most code,
     this is desirable, or else those ‘hline’ symbols raise unbound
     variable errors.

     The default is ‘:hlines no’.  The example shows hlines removed from
     the input table.

          #+NAME: many-cols
          | a | b | c |
          |---+---+---|
          | d | e | f |
          |---+---+---|
          | g | h | i |

          #+NAME: echo-table
          #+BEGIN_SRC python :var tab=many-cols
            return tab
          #+END_SRC

          #+RESULTS: echo-table
          | a | b | c |
          | d | e | f |
          | g | h | i |

   • ‘yes’ For ‘:hlines yes’, the example shows hlines unchanged.

          #+NAME: many-cols
          | a | b | c |
          |---+---+---|
          | d | e | f |
          |---+---+---|
          | g | h | i |

          #+NAME: echo-table
          #+BEGIN_SRC python :var tab=many-cols :hlines yes
            return tab
          #+END_SRC

          #+RESULTS: echo-table
          | a | b | c |
          |---+---+---|
          | d | e | f |
          |---+---+---|
          | g | h | i |


File: org.info,  Node: colnames,  Next: rownames,  Prev: hlines,  Up: Specific header arguments

14.8.2.21 ‘:colnames’
.....................

The ‘:colnames’ header argument accepts ‘yes’, ‘no’, or ‘nil’ values.
The default value is ‘nil’, which is unassigned.  But this header
argument behaves differently depending on the source code language.

   • ‘nil’ If an input table has column names (because the second row is
     an hline), then Org removes the column names, processes the table,
     puts back the column names, and then writes the table to the
     results block.

          #+NAME: less-cols
          | a |
          |---|
          | b |
          | c |

          #+NAME: echo-table-again
          #+BEGIN_SRC python :var tab=less-cols
            return [[val + '*' for val in row] for row in tab]
          #+END_SRC

          #+RESULTS: echo-table-again
          | a  |
          |----|
          | b* |
          | c* |

     Note that column names have to accounted for when using variable
     indexing (*note Indexable variable values: var.) because column
     names are not removed for indexing.

   • ‘no’ Do not pre-process column names.

   • ‘yes’ For an input table that has no hlines, process it like the
     ‘nil’ value.  That is, Org removes the column names, processes the
     table, puts back the column names, and then writes the table to the
     results block.


File: org.info,  Node: rownames,  Next: shebang,  Prev: colnames,  Up: Specific header arguments

14.8.2.22 ‘:rownames’
.....................

The ‘:rownames’ header argument can take on values ‘yes’ or ‘no’ values.
The default is ‘no’.  Note that ‘emacs-lisp’ code blocks ignore
‘:rownames’ header argument because of the ease of table-handling in
Emacs.

   • ‘no’ Org will not pre-process row names.

   • ‘yes’ If an input table has row names, then Org removes the row
     names, processes the table, puts back the row names, and then
     writes the table to the results block.

          #+NAME: with-rownames
          | one | 1 | 2 | 3 | 4 |  5 |
          | two | 6 | 7 | 8 | 9 | 10 |

          #+NAME: echo-table-once-again
          #+BEGIN_SRC python :var tab=with-rownames :rownames yes
            return [[val + 10 for val in row] for row in tab]
          #+END_SRC

          #+RESULTS: echo-table-once-again
          | one | 11 | 12 | 13 | 14 | 15 |
          | two | 16 | 17 | 18 | 19 | 20 |

     Note that row names have to accounted for when using variable
     indexing (*note Indexable variable values: var.) because row names
     are not removed for indexing.


File: org.info,  Node: shebang,  Next: tangle-mode,  Prev: rownames,  Up: Specific header arguments

14.8.2.23 ‘:shebang’
....................

This header argument can turn results into executable script files.  By
setting the ‘:shebang’ header argument to a string value (for example,
‘:shebang "#!/bin/bash"’), Org inserts that string as the first line of
the tangled file that the ‘src’ code block is extracted to.  Org then
turns on the tangled file’s executable permission.


File: org.info,  Node: tangle-mode,  Next: eval,  Prev: shebang,  Up: Specific header arguments

14.8.2.24 ‘:tangle-mode’
........................

The ‘tangle-mode’ header argument specifies what permissions to set for
tangled files by ‘set-file-modes’.  For example, to make read-only
tangled file, use ‘:tangle-mode (identity #o444)’.  To make it
executable, use ‘:tangle-mode (identity #o755)’.

   On ‘src’ code blocks with ‘shebang’ (*note shebang::) header
argument, Org will automatically set the tangled file to executable
permissions.  But this can be overridden with custom permissions using
‘tangle-mode’ header argument.

   When multiple ‘src’ code blocks tangle to a single file with
different and conflicting ‘tangle-mode’ header arguments, Org’s behavior
is undefined.


File: org.info,  Node: eval,  Next: wrap,  Prev: tangle-mode,  Up: Specific header arguments

14.8.2.25 ‘:eval’
.................

The ‘:eval’ header argument can limit evaluation of specific code
blocks.  It is useful for protection against evaluating untrusted ‘src’
code blocks by prompting for a confirmation.  This protection is
independent of the ‘org-confirm-babel-evaluate’ setting.

‘never or no’
     Org will never evaluate this ‘src’ code block.
‘query’
     Org prompts the user for permission to evaluate this ‘src’ code
     block.
‘never-export or no-export’
     Org will not evaluate this ‘src’ code block when exporting, yet the
     user can evaluate this source block interactively.
‘query-export’
     Org prompts the user for permission to export this ‘src’ code
     block.

   If ‘:eval’ header argument is not set for a source block, then Org
determines whether to evaluate from the ‘org-confirm-babel-evaluate’
variable (*note Code evaluation security::).


File: org.info,  Node: wrap,  Next: post,  Prev: eval,  Up: Specific header arguments

14.8.2.26 ‘:wrap’
.................

The ‘:wrap’ header argument marks the results block by appending strings
to ‘#+BEGIN_’ and ‘#+END_’.  If no string is specified, Org wraps the
results in a ‘#+BEGIN/END_RESULTS’ block.


File: org.info,  Node: post,  Next: prologue,  Prev: wrap,  Up: Specific header arguments

14.8.2.27 ‘:post’
.................

The ‘:post’ header argument is for post-processing results from ‘src’
block evaluation.  When ‘:post’ has any value, Org binds the results to
‘*this*’ variable for easy passing to *note var:: header argument
specifications.  That makes results available to other ‘src’ code
blocks, or for even direct Emacs Lisp code execution.

   The following two examples illustrate ‘:post’ header argument in
action.  The first one shows how to attach ‘#+ATTR_LATEX:’ line using
‘:post’.

     #+name: attr_wrap
     #+begin_src sh :var data="" :var width="\\textwidth" :results output
       echo "#+ATTR_LATEX: :width $width"
       echo "$data"
     #+end_src

     #+header: :file /tmp/it.png
     #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
       digraph{
               a -> b;
               b -> c;
               c -> a;
       }
     #+end_src

     #+RESULTS:
     :RESULTS:
     #+ATTR_LATEX :width 5cm
     [[file:/tmp/it.png]]
     :END:

   The second example shows use of ‘:colnames’ in ‘:post’ to pass data
between ‘src’ code blocks.

     #+name: round-tbl
     #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
       (mapcar (lambda (row)
                 (mapcar (lambda (cell)
                           (if (numberp cell)
                               (format fmt cell)
                             cell))
                         row))
               tbl)
     #+end_src

     #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
     set.seed(42)
     data.frame(foo=rnorm(1))
     #+end_src

     #+RESULTS:
     |   foo |
     |-------|
     | 1.371 |


File: org.info,  Node: prologue,  Next: epilogue,  Prev: post,  Up: Specific header arguments

14.8.2.28 ‘:prologue’
.....................

The ‘prologue’ header argument is for appending to the top of the code
block for execution.  For example, a clear or reset code at the start of
new execution of a ‘src’ code block.  A ‘reset’ for ‘gnuplot’:
‘:prologue "reset"’.  See also *note epilogue::.

     (add-to-list 'org-babel-default-header-args:gnuplot
                  '((:prologue . "reset")))


File: org.info,  Node: epilogue,  Prev: prologue,  Up: Specific header arguments

14.8.2.29 ‘:epilogue’
.....................

The value of the ‘epilogue’ header argument is for appending to the end
of the code block for execution.  See also *note prologue::.


File: org.info,  Node: Results of evaluation,  Next: Noweb reference syntax,  Prev: Header arguments,  Up: Working with source code

14.9 Results of evaluation
==========================

How Org handles results of a code block execution depends on many header
arguments working together.  Here is only a summary of these.  For an
enumeration of all the header arguments that affect results, see *note
results::.

   The primary determinant is the execution context.  Is it in a
‘:session’ or not?  Orthogonal to that is if the expected result is a
‘:results value’ or ‘:results output’, which is a concatenation of
output from start to finish of the ‘src’ code block’s evaluation.

                    Non-session              Session
‘:results value’    value of last            value of last expression
                    expression
‘:results output’   contents of STDOUT       concatenation of interpreter
                                             output

   For ‘:session’ and non-session, the ‘:results value’ turns the
results into an Org mode table format.  Single values are wrapped in a
one dimensional vector.  Rows and columns of a table are wrapped in a
two-dimensional vector.

14.9.1 Non-session
------------------

14.9.1.1 ‘:results value’
.........................

Default.  Org gets the value by wrapping the code in a function
definition in the language of the ‘src’ block.  That is why when using
‘:results value’, code should execute like a function and return a
value.  For languages like Python, an explicit ‘return’ statement is
mandatory when using ‘:results value’.

   This is one of four evaluation contexts where Org automatically wraps
the code in a function definition.

14.9.1.2 ‘:results output’
..........................

For ‘:results output’, the code is passed to an external process running
the interpreter.  Org returns the contents of the standard output stream
as as text results.

14.9.2 Session
--------------

14.9.2.1 ‘:results value’
.........................

For ‘:results value’ from a ‘:session’, Org passes the code to an
interpreter running as an interactive Emacs inferior process.  So only
languages that provide interactive evaluation can have session support.
Not all languages provide this support, such as ‘C’ and ‘ditaa’.  Even
those that do support, such as ‘Python’ and ‘Haskell’, they impose
limitations on allowable language constructs that can run interactively.
Org inherits those limitations for those ‘src’ code blocks running in a
‘:session’.

   Org gets the value from the source code interpreter’s last statement
output.  Org has to use language-specific methods to obtain the value.
For example, from the variable ‘_’ in ‘Python’ and ‘Ruby’, and the value
of ‘.Last.value’ in ‘R’).

14.9.2.2 ‘:results output’
..........................

For ‘:results output’, Org passes the code to the interpreter running as
an interactive Emacs inferior process.  Org concatenates whatever text
output emitted by the interpreter to return the collection as a result.
Note that this collection is not the same as collected from ‘STDOUT’ of
a non-interactive interpreter running as an external process.  Compare
for example these two blocks:

     #+BEGIN_SRC python :results output
      print "hello"
      2
      print "bye"
     #+END_SRC

     #+RESULTS:
     : hello
     : bye

   In the above non-session mode, the “2” is not printed; so does not
appear in results.

     #+BEGIN_SRC python :results output :session
      print "hello"
      2
      print "bye"
     #+END_SRC

     #+RESULTS:
     : hello
     : 2
     : bye

   In the above ‘:session’ mode, the interactive interpreter receives
and prints “2”.  Results show that.


File: org.info,  Node: Noweb reference syntax,  Next: Key bindings and useful functions,  Prev: Results of evaluation,  Up: Working with source code

14.10 Noweb reference syntax
============================

Org supports named blocks in Noweb style syntax.  For Noweb literate
programming details, see <http://www.cs.tufts.edu/~nr/noweb/>).

     <<code-block-name>>

   For the header argument ‘:noweb yes’, Org expands Noweb style
references in the ‘src’ code block before evaluation.

   For the header argument ‘:noweb no’, Org does not expand Noweb style
references in the ‘src’ code block before evaluation.

   The default is ‘:noweb no’.  Org defaults to ‘:noweb no’ so as not to
cause errors in languages where Noweb syntax is ambiguous.  Change Org’s
default to ‘:noweb yes’ for languages where there is no risk of
confusion.

   Org offers a more flexible way to resolve Noweb style references
(*note noweb-ref::).

   Org can include the _results_ of a code block rather than its body.
To that effect, append parentheses, possibly including arguments, to the
code block name, as show below.

     <<code-block-name(optional arguments)>>

   Note that when using the above approach to a code block’s results,
the code block name set by ‘#+NAME’ keyword is required; the reference
set by ‘:noweb-ref’ will not work.

   Here is an example that demonstrates how the exported content changes
when Noweb style references are used with parentheses versus without.

   With:

     #+NAME: some-code
     #+BEGIN_SRC python :var num=0 :results output :exports none
     print(num*10)
     #+END_SRC

   this code block:

     #+BEGIN_SRC text :noweb yes
     <<some-code>>
     #+END_SRC

   expands to:

     print(num*10)

   Below, a similar Noweb style reference is used, but with parentheses,
while setting a variable ‘num’ to 10:

     #+BEGIN_SRC text :noweb yes
     <<some-code(num=10)>>
     #+END_SRC

   Note that now the expansion contains the _results_ of the code block
‘some-code’, not the code block itself:

     100

   For faster tangling of large Org mode files, set
‘org-babel-use-quick-and-dirty-noweb-expansion’ variable to ‘t’.  The
speedup comes at the expense of not correctly resolving inherited values
of the ‘:noweb-ref’ header argument.


File: org.info,  Node: Key bindings and useful functions,  Next: Batch execution,  Prev: Noweb reference syntax,  Up: Working with source code

14.11 Key bindings and useful functions
=======================================

Many common Org mode key sequences are re-bound depending on the
context.

   Active key bindings in code blocks:

‘C-c C-c’          ‘org-babel-execute-src-block’
‘C-c C-o’          ‘org-babel-open-src-block-result’
‘M-<UP>’           ‘org-babel-load-in-session’
‘M-<DOWN>’         ‘org-babel-switch-to-session’

   Active key bindings in Org mode buffer:

‘C-c C-v p’   or   ‘C-c C-v C-p’     ‘org-babel-previous-src-block’
‘C-c C-v n’   or   ‘C-c C-v C-n’     ‘org-babel-next-src-block’
‘C-c C-v e’   or   ‘C-c C-v C-e’     ‘org-babel-execute-maybe’
‘C-c C-v o’   or   ‘C-c C-v C-o’     ‘org-babel-open-src-block-result’
‘C-c C-v v’   or   ‘C-c C-v C-v’     ‘org-babel-expand-src-block’
‘C-c C-v u’   or   ‘C-c C-v C-u’     ‘org-babel-goto-src-block-head’
‘C-c C-v g’   or   ‘C-c C-v C-g’     ‘org-babel-goto-named-src-block’
‘C-c C-v r’   or   ‘C-c C-v C-r’     ‘org-babel-goto-named-result’
‘C-c C-v b’   or   ‘C-c C-v C-b’     ‘org-babel-execute-buffer’
‘C-c C-v s’   or   ‘C-c C-v C-s’     ‘org-babel-execute-subtree’
‘C-c C-v d’   or   ‘C-c C-v C-d’     ‘org-babel-demarcate-block’
‘C-c C-v t’   or   ‘C-c C-v C-t’     ‘org-babel-tangle’
‘C-c C-v f’   or   ‘C-c C-v C-f’     ‘org-babel-tangle-file’
‘C-c C-v c’   or   ‘C-c C-v C-c’     ‘org-babel-check-src-block’
‘C-c C-v j’   or   ‘C-c C-v C-j’     ‘org-babel-insert-header-arg’
‘C-c C-v l’   or   ‘C-c C-v C-l’     ‘org-babel-load-in-session’
‘C-c C-v i’   or   ‘C-c C-v C-i’     ‘org-babel-lob-ingest’
‘C-c C-v I’   or   ‘C-c C-v C-I’     ‘org-babel-view-src-block-info’
‘C-c C-v z’   or   ‘C-c C-v C-z’     ‘org-babel-switch-to-session-with-code’
‘C-c C-v a’   or   ‘C-c C-v C-a’     ‘org-babel-sha1-hash’
‘C-c C-v h’   or   ‘C-c C-v C-h’     ‘org-babel-describe-bindings’
‘C-c C-v x’   or   ‘C-c C-v C-x’     ‘org-babel-do-key-sequence-in-edit-buffer’


File: org.info,  Node: Batch execution,  Prev: Key bindings and useful functions,  Up: Working with source code

14.12 Batch execution
=====================

Org mode features, including working with source code facilities can be
invoked from the command line.  This enables building shell scripts for
batch processing, running automated system tasks, and expanding Org
mode’s usefulness.

   The sample script shows batch processing of multiple files using
‘org-babel-tangle’.

     #!/bin/sh
     # tangle files with org-mode
     #
     emacs -Q --batch --eval "
         (progn
           (require 'ob-tangle)
           (dolist (file command-line-args-left)
             (with-current-buffer (find-file-noselect file)
               (org-babel-tangle))))
       " "$@"


File: org.info,  Node: Miscellaneous,  Next: Hacking,  Prev: Working with source code,  Up: Top

15 Miscellaneous
****************

* Menu:

* Completion::                  M-<TAB> guesses completions
* Easy templates::              Quick insertion of structural elements
* Speed keys::                  Electric commands at the beginning of a headline
* Code evaluation security::    Org mode files evaluate inline code
* Customization::               Adapting Org to changing tastes
* In-buffer settings::          Overview of the ‘#+KEYWORDS’
* The very busy C-c C-c key::   When in doubt, press C-c C-c
* Clean view::                  Getting rid of leading stars in the outline
* TTY keys::                    Using Org on a tty
* Interaction::                 With other Emacs packages
* org-crypt::                   Encrypting Org files
* Org Mobile::                  Viewing and capture on a mobile device


File: org.info,  Node: Completion,  Next: Easy templates,  Up: Miscellaneous

15.1 Completion
===============

Org has in-buffer completions.  Unlike minibuffer completions, which are
useful for quick command interactions, Org’s in-buffer completions are
more suitable for content creation in Org documents.  Type one or more
letters and invoke the hot key to complete the text in-place.  Depending
on the context and the keys, Org will offer different types of
completions.  No minibuffer is involved.  Such mode-specific hot keys
have become an integral part of Emacs and Org provides several
shortcuts.

‘M-<TAB>’
     Complete word at point
        • At the beginning of a headline, complete TODO keywords.
        • After ‘\’, complete TeX symbols supported by the exporter.
        • After ‘*’, complete headlines in the current buffer so that
          they can be used in search links like ‘[[*find this
          headline]]’.
        • After ‘:’ in a headline, complete tags.  The list of tags is
          taken from the variable ‘org-tag-alist’ (possibly set through
          the ‘#+TAGS’ in-buffer option, *note Setting tags::), or it is
          created dynamically from all tags used in the current buffer.
        • After ‘:’ and not in a headline, complete property keys.  The
          list of keys is constructed dynamically from all keys used in
          the current buffer.
        • After ‘[’, complete link abbreviations (*note Link
          abbreviations::).
        • After ‘#+’, complete the special keywords like ‘TYP_TODO’ or
          file-specific ‘OPTIONS’.  After option keyword is complete,
          pressing ‘M-<TAB>’ again will insert example settings for that
          option.
        • After ‘#+STARTUP:’, complete startup keywords.
        • When the point is anywhere else, complete dictionary words
          using Ispell.
     If your desktop intercepts the combo ‘M-<TAB>’ to switch windows,
     use ‘C-M-i’ or ‘<ESC> <TAB>’ as an alternative or customize your
     environment.


File: org.info,  Node: Easy templates,  Next: Speed keys,  Prev: Completion,  Up: Miscellaneous

15.2 Easy templates
===================

With just a few keystrokes, Org’s easy templates inserts empty pairs of
structural elements, such as ‘#+BEGIN_SRC’ and ‘#+END_SRC’.  Easy
templates use an expansion mechanism, which is native to Org, in a
process similar to ‘yasnippet’ and other Emacs template expansion
packages.

   ‘<’ ‘s’ ‘<TAB>’ expands to a ‘src’ code block.

   ‘<’ ‘l’ ‘<TAB>’ expands to:

   #+BEGIN_EXPORT latex

   #+END_EXPORT

   Org comes with these pre-defined easy templates:

‘s’     ‘#+BEGIN_SRC ... #+END_SRC’
‘e’     ‘#+BEGIN_EXAMPLE ... #+END_EXAMPLE’
‘q’     ‘#+BEGIN_QUOTE ... #+END_QUOTE’
‘v’     ‘#+BEGIN_VERSE ... #+END_VERSE’
‘c’     ‘#+BEGIN_CENTER ... #+END_CENTER’
‘C’     ‘#+BEGIN_COMMENT ... #+END_COMMENT’
‘l’     ‘#+BEGIN_EXPORT latex ... #+END_EXPORT’
‘L’     ‘#+LATEX:’
‘h’     ‘#+BEGIN_EXPORT html ... #+END_EXPORT’
‘H’     ‘#+HTML:’
‘a’     ‘#+BEGIN_EXPORT ascii ... #+END_EXPORT’
‘A’     ‘#+ASCII:’
‘i’     ‘#+INDEX:’ line
‘I’     ‘#+INCLUDE:’ line

   More templates can added by customizing the variable
‘org-structure-template-alist’, whose docstring has additional details.


File: org.info,  Node: Speed keys,  Next: Code evaluation security,  Prev: Easy templates,  Up: Miscellaneous

15.3 Speed keys
===============

Single keystrokes can execute custom commands in an Org file when the
cursor is on a headline.  Without the extra burden of a meta or modifier
key, Speed Keys can speed navigation or execute custom commands.
Besides faster navigation, Speed Keys may come in handy on small mobile
devices that do not have full keyboards.  Speed Keys may also work on
TTY devices known for their problems when entering Emacs keychords.

   By default, Org has Speed Keys disabled.  To activate Speed Keys, set
the variable ‘org-use-speed-commands’ to a non-‘nil’ value.  To trigger
a Speed Key, the cursor must be at the beginning of an Org headline,
before any of the stars.

   Org comes with a pre-defined list of Speed Keys.  To add or modify
Speed Keys, customize the variable, ‘org-speed-commands-user’.  For more
details, see the variable’s docstring.  With Speed Keys activated, ‘M-x
org-speed-command-help’, or ‘?’ when cursor is at the beginning of an
Org headline, shows currently active Speed Keys, including the
user-defined ones.


File: org.info,  Node: Code evaluation security,  Next: Customization,  Prev: Speed keys,  Up: Miscellaneous

15.4 Code evaluation and security issues
========================================

Unlike plain text, running code comes with risk.  Each ‘src’ code block,
in terms of risk, is equivalent to an executable file.  Org therefore
puts a few confirmation prompts by default.  This is to alert the casual
user from accidentally running untrusted code.

   For users who do not run code blocks or write code regularly, Org’s
default settings should suffice.  However, some users may want to tweak
the prompts for fewer interruptions.  To weigh the risks of automatic
execution of code blocks, here are some details about code evaluation.

   Org evaluates code in the following circumstances:

Source code blocks
     Org evaluates ‘src’ code blocks in an Org file during export.  Org
     also evaluates a ‘src’ code block with the ‘C-c C-c’ key chord.
     Users exporting or running code blocks must load files only from
     trusted sources.  Be wary of customizing variables that remove or
     alter default security measures.

      -- User Option: org-confirm-babel-evaluate
          When ‘t’, Org prompts the user for confirmation before
          executing each code block.  When ‘nil’, Org executes code
          blocks without prompting the user for confirmation.  When this
          option is set to a custom function, Org invokes the function
          with these two arguments: the source code language and the
          body of the code block.  The custom function must return
          either a ‘t’ or ‘nil’, which determines if the user is
          prompted.  Each source code language can be handled separately
          through this function argument.

     For example, this function enables execution of ‘ditaa’ code
     +blocks without prompting:

          (defun my-org-confirm-babel-evaluate (lang body)
            (not (string= lang "ditaa")))  ; don't ask for ditaa
          (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)

Following ‘shell’ and ‘elisp’ links
     Org has two link types that can also directly evaluate code (*note
     External links::).  Because such code is not visible, these links
     have a potential risk.  Org therefore prompts the user when it
     encounters such links.  The customization variables are:

      -- User Option: org-confirm-shell-link-function
          Function that prompts the user before executing a shell link.
      -- User Option: org-confirm-elisp-link-function
          Function that prompts the user before executing an Emacs Lisp
          link.

Formulas in tables
     Org executes formulas in tables (*note The spreadsheet::) either
     through the _calc_ or the _Emacs Lisp_ interpreters.


File: org.info,  Node: Customization,  Next: In-buffer settings,  Prev: Code evaluation security,  Up: Miscellaneous

15.5 Customization
==================

Org has more than 500 variables for customization.  They can be accessed
through the usual ‘M-x org-customize <RET>’ command.  Or through the Org
menu, ‘Org->Customization->Browse Org Group’.  Org also has per-file
settings for some variables (*note In-buffer settings::).


File: org.info,  Node: In-buffer settings,  Next: The very busy C-c C-c key,  Prev: Customization,  Up: Miscellaneous

15.6 Summary of in-buffer settings
==================================

In-buffer settings start with ‘#+’, followed by a keyword, a colon, and
then a word for each setting.  Org accepts multiple settings on the same
line.  Org also accepts multiple lines for a keyword.  This manual
describes these settings throughout.  A summary follows here.

   ‘C-c C-c’ activates any changes to the in-buffer settings.  Closing
and reopening the Org file in Emacs also activates the changes.

‘#+ARCHIVE: %s_done::’
     Sets the archive location of the agenda file.  This location
     applies to the lines until the next ‘#+ARCHIVE’ line, if any, in
     the Org file.  The first archive location in the Org file also
     applies to any entries before it.  The corresponding variable is
     ‘org-archive-location’.
‘#+CATEGORY:’
     Sets the category of the agenda file, which applies to the entire
     document.
‘#+COLUMNS: %25ITEM ...’
     Sets the default format for columns view.  Org uses this format for
     column views where there is no ‘COLUMNS’ property.
‘#+CONSTANTS: name1=value1 ...’
     Set file-local values for constants that table formulas can use.
     This line sets the local variable
     ‘org-table-formula-constants-local’.  The global version of this
     variable is ‘org-table-formula-constants’.
‘#+FILETAGS: :tag1:tag2:tag3:’
     Set tags that all entries in the file will inherit from here,
     including the top-level entries.
‘#+LINK: linkword replace’
     Each line specifies one abbreviation for one link.  Use multiple
     ‘#+LINK:’ lines for more, *note Link abbreviations::.  The
     corresponding variable is ‘org-link-abbrev-alist’.
‘#+PRIORITIES: highest lowest default’
     This line sets the limits and the default for the priorities.  All
     three must be either letters A–Z or numbers 0–9.  The highest
     priority must have a lower ASCII number than the lowest priority.
‘#+PROPERTY: Property_Name Value’
     This line sets a default inheritance value for entries in the
     current buffer, most useful for specifying the allowed values of a
     property.
‘#+SETUPFILE: file or URL’
     The setup file or a URL pointing to such file is for additional
     in-buffer settings.  Org loads this file and parses it for any
     settings in it only when Org opens the main file.  If URL is
     specified, the contents are downloaded and stored in a temporary
     file cache.  ‘C-c C-c’ on the settings line will parse and load the
     file, and also reset the temporary file cache.  Org also parses and
     loads the document during normal exporting process.  Org parses the
     contents of this document as if it was included in the buffer.  It
     can be another Org file.  To visit the file (not a URL), ‘C-c '’
     while the cursor is on the line with the file name.
‘#+STARTUP:’
     Startup options Org uses when first visiting a file.

     The first set of options deals with the initial visibility of the
     outline tree.  The corresponding variable for global default
     settings is ‘org-startup-folded’ with a default value of ‘t’, which
     is the same as ‘overview’.

          overview         top-level headlines only
          content          all headlines
          showall          no folding of any entries
          showeverything   show even drawer contents

     Dynamic virtual indentation is controlled by the variable
     ‘org-startup-indented’
          indent     start with ‘org-indent-mode’ turned on
          noindent   start with ‘org-indent-mode’ turned off

     Aligns tables consistently upon visiting a file; useful for
     restoring narrowed table columns.  The corresponding variable is
     ‘org-startup-align-all-tables’ with ‘nil’ as default value.

          align      align all tables
          noalign    don’t align tables on startup

     Whether Org should automatically display inline images.  The
     corresponding variable is ‘org-startup-with-inline-images’, with a
     default value ‘nil’ to avoid delays when visiting a file.
          inlineimages   show inline images
          noinlineimages don’t show inline images on startup

     Whether Org should automatically convert LaTeX fragments to images.
     The variable ‘org-startup-with-latex-preview’, which controls this
     setting, is set to ‘nil’ by default to avoid startup delays.
          latexpreview   preview LaTeX fragments
          nolatexpreview don’t preview LaTeX fragments

     Logging the closing and reopening of TODO items and clock intervals
     can be configured using these options (see variables
     ‘org-log-done’, ‘org-log-note-clock-out’ and ‘org-log-repeat’)
          logdone             record a timestamp when an item is marked DONE
          lognotedone         record timestamp and a note when DONE
          nologdone           don’t record when items are marked DONE
          logrepeat           record a time when reinstating a repeating item
          lognoterepeat       record a note when reinstating a repeating item
          nologrepeat         do not record when reinstating repeating item
          lognoteclock-out    record a note when clocking out
          nolognoteclock-out  don’t record a note when clocking out
          logreschedule       record a timestamp when scheduling time changes
          lognotereschedule   record a note when scheduling time changes
          nologreschedule     do not record when a scheduling date changes
          logredeadline       record a timestamp when deadline changes
          lognoteredeadline   record a note when deadline changes
          nologredeadline     do not record when a deadline date changes
          logrefile           record a timestamp when refiling
          lognoterefile       record a note when refiling
          nologrefile         do not record when refiling
          logdrawer           store log into drawer
          nologdrawer         store log outside of drawer
          logstatesreversed   reverse the order of states notes
          nologstatesreversed do not reverse the order of states notes

     These options hide leading stars in outline headings, and indent
     outlines.  The corresponding variables are ‘org-hide-leading-stars’
     and ‘org-odd-levels-only’, both with a default setting of ‘nil’
     (meaning ‘showstars’ and ‘oddeven’).
          hidestars  hide all stars on the headline except one.
          showstars  show all stars on the headline
          indent     virtual indents according to the outline level
          noindent   no virtual indents
          odd        show odd outline levels only (1,3,...)
          oddeven    show all outline levels

     To turn on custom format overlays over timestamps (variables
     ‘org-put-time-stamp-overlays’ and
     ‘org-time-stamp-overlay-formats’), use
          customtime overlay custom time format

     The following options influence the table spreadsheet (variable
     ‘constants-unit-system’).
          constcgs   ‘constants.el’ should use the c-g-s unit system
          constSI    ‘constants.el’ should use the SI unit system

     For footnote settings, use the following keywords.  The
     corresponding variables are ‘org-footnote-define-inline’,
     ‘org-footnote-auto-label’, and ‘org-footnote-auto-adjust’.
          fninline    define footnotes inline
          fnnoinline  define footnotes in separate section
          fnlocal     define footnotes near first reference, but not inline
          fnprompt    prompt for footnote labels
          fnauto      create ‘[fn:1]’-like labels automatically (default)
          fnconfirm   offer automatic label for editing or confirmation
          fnplain     create ‘[1]’-like labels automatically
          fnadjust    automatically renumber and sort footnotes
          nofnadjust  do not renumber and sort automatically

     To hide blocks on startup, use these keywords.  The corresponding
     variable is ‘org-hide-block-startup’.
          hideblocks   Hide all begin/end blocks on startup
          nohideblocks Do not hide blocks on startup

     The display of entities as UTF-8 characters is governed by the
     variable ‘org-pretty-entities’ and the keywords
          entitiespretty  Show entities as UTF-8 characters where possible
          entitiesplain   Leave entities plain

‘#+TAGS: TAG1(c1) TAG2(c2)’
     These lines specify valid tags for this file.  Org accepts multiple
     tags lines.  Tags could correspond to the _fast tag selection_
     keys.  The corresponding variable is ‘org-tag-alist’.
‘#+TBLFM:’
     This line is for formulas for the table directly above.  A table
     can have multiple ‘#+TBLFM:’ lines.  On table recalculation, Org
     applies only the first ‘#+TBLFM:’ line.  For details see *note
     Using multiple #+TBLFM lines:: in *note Editing and debugging
     formulas::.
‘#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,’
‘#+OPTIONS:, #+BIND:,’
‘#+SELECT_TAGS:, #+EXCLUDE_TAGS:’
     These lines provide settings for exporting files.  For more details
     see *note Export settings::.
‘#+TODO: #+SEQ_TODO: #+TYP_TODO:’
     These lines set the TODO keywords and their significance to the
     current file.  The corresponding variable is ‘org-todo-keywords’.


File: org.info,  Node: The very busy C-c C-c key,  Next: Clean view,  Prev: In-buffer settings,  Up: Miscellaneous

15.7 The very busy C-c C-c key
==============================

The ‘C-c C-c’ key in Org serves many purposes depending on the context.
It is probably the most over-worked, multi-purpose key combination in
Org.  Its uses are well-documented through out this manual, but here is
a consolidated list for easy reference.

   − If any highlights shown in the buffer from the creation of a sparse
     tree, or from clock display, remove such highlights.
   − If the cursor is in one of the special ‘#+KEYWORD’ lines, scan the
     buffer for these lines and update the information.  Also reset the
     Org file cache used to temporary store the contents of URLs used as
     values for keywords like ‘#+SETUPFILE’.
   − If the cursor is inside a table, realign the table.  The table
     realigns even if automatic table editor is turned off.
   − If the cursor is on a ‘#+TBLFM’ line, re-apply the formulas to the
     entire table.
   − If the current buffer is a capture buffer, close the note and file
     it.  With a prefix argument, also jump to the target location after
     saving the note.
   − If the cursor is on a ‘<<<target>>>’, update radio targets and
     corresponding links in this buffer.
   − If the cursor is on a property line or at the start or end of a
     property drawer, offer property commands.
   − If the cursor is at a footnote reference, go to the corresponding
     definition, and _vice versa_.
   − If the cursor is on a statistics cookie, update it.
   − If the cursor is in a plain list item with a checkbox, toggle the
     status of the checkbox.
   − If the cursor is on a numbered item in a plain list, renumber the
     ordered list.
   − If the cursor is on the ‘#+BEGIN’ line of a dynamic block, the
     block is updated.
   − If the cursor is at a timestamp, fix the day name in the timestamp.


File: org.info,  Node: Clean view,  Next: TTY keys,  Prev: The very busy C-c C-c key,  Up: Miscellaneous

15.8 A cleaner outline view
===========================

Org’s default outline with stars and no indents can become too cluttered
for short documents.  For _book-like_ long documents, the effect is not
as noticeable.  Org provides an alternate stars and indentation scheme,
as shown on the right in the following table.  It uses only one star and
indents text to line with the heading:

     * Top level headline             |    * Top level headline
     ** Second level                  |      * Second level
     *** 3rd level                    |        * 3rd level
     some text                        |          some text
     *** 3rd level                    |        * 3rd level
     more text                        |          more text
     * Another top level headline     |    * Another top level headline


   To turn this mode on, use the minor mode, ‘org-indent-mode’.  Text
lines that are not headlines are prefixed with spaces to vertically
align with the headline text(1).

   To make more horizontal space, the headlines are shifted by two
stars.  This can be configured by the ‘org-indent-indentation-per-level’
variable.  Only one star on each headline is visible, the rest are
masked with the same font color as the background.  This font face can
be configured with the ‘org-hide’ variable.

   Note that turning on ‘org-indent-mode’ sets ‘org-hide-leading-stars’
to ‘t’ and ‘org-adapt-indentation’ to ‘nil’; ‘2.’ below shows how this
works.

   To globally turn on ‘org-indent-mode’ for all files, customize the
variable ‘org-startup-indented’.

   To turn on indenting for individual files, use ‘#+STARTUP’ option as
follows:

     #+STARTUP: indent

   Indent on startup makes Org use hard spaces to align text with
headings as shown in examples below.

  1. _Indentation of text below headlines_
     Indent text to align with the headline.

          *** 3rd level
              more text, now indented

     Org adapts indentations with paragraph filling, line wrapping, and
     structure editing(2).

  2. _Hiding leading stars_
     Org can make leading stars invisible.  For global preference,
     configure the variable ‘org-hide-leading-stars’.  For per-file
     preference, use these file ‘#+STARTUP’ options:

          #+STARTUP: hidestars
          #+STARTUP: showstars

     With stars hidden, the tree is shown as:

          * Top level headline
           * Second level
            * 3rd level
            ...

     Because Org makes the font color same as the background color to
     hide to stars, sometimes ‘org-hide’ face may need tweaking to get
     the effect right.  For some black and white combinations, ‘grey90’
     on a white background might mask the stars better.

  3. Using stars for only odd levels, 1, 3, 5, ..., can also clean up
     the clutter.  This removes two stars from each level(3).  For Org
     to properly handle this cleaner structure during edits and exports,
     configure the variable ‘org-odd-levels-only’.  To set this
     per-file, use either one of the following lines:

          #+STARTUP: odd
          #+STARTUP: oddeven

     To switch between single and double stars layouts, use ‘M-x
     org-convert-to-odd-levels <RET>’ and ‘M-x
     org-convert-to-oddeven-levels <RET>’.

   ---------- Footnotes ----------

   (1) The ‘org-indent-mode’ also sets the ‘wrap-prefix’ correctly for
indenting and wrapping long lines of headlines or text.  This minor mode
handles ‘visual-line-mode’ and directly applied settings through
‘word-wrap’.

   (2) Also see the variable ‘org-adapt-indentation’.

   (3) Because ‘LEVEL=2’ has 3 stars, ‘LEVEL=3’ has 4 stars, and so on


File: org.info,  Node: TTY keys,  Next: Interaction,  Prev: Clean view,  Up: Miscellaneous

15.9 Using Org on a tty
=======================

Org provides alternative key bindings for TTY and modern mobile devices
that cannot handle cursor keys and complex modifier key chords.  Some of
these workarounds may be more cumbersome than necessary.  Users should
look into customizing these further based on their usage needs.  For
example, the normal ‘S-<cursor>’ for editing timestamp might be better
with ‘C-c .’ chord.

Default     Alternative    Speed   Alternative
            1              key     2
‘S-<TAB>’   ‘C-u <TAB>’    ‘C’
‘M-<LEFT>’  ‘C-c C-x l’    ‘l’     ‘<Esc>
                                   <LEFT>’
‘M-S-<LEFT>’‘C-c C-x L’    ‘L’
‘M-<RIGHT>’ ‘C-c C-x r’    ‘r’     ‘<Esc>
                                   <RIGHT>’
‘M-S-<RIGHT>’‘C-c C-x R’   ‘R’
‘M-<UP>’    ‘C-c C-x u’    ‘ ’     ‘<Esc> <UP>’
‘M-S-<UP>’  ‘C-c C-x U’    ‘U’
‘M-<DOWN>’  ‘C-c C-x d’    ‘ ’     ‘<Esc>
                                   <DOWN>’
‘M-S-<DOWN>’‘C-c C-x D’    ‘D’
‘S-<RET>’   ‘C-c C-x c’    ‘ ’
‘M-<RET>’   ‘C-c C-x m’    ‘ ’     ‘<Esc>
                                   <RET>’
‘M-S-<RET>’ ‘C-c C-x M’    ‘ ’
‘S-<LEFT>’  ‘C-c <LEFT>’   ‘ ’
‘S-<RIGHT>’ ‘C-c           ‘ ’
            <RIGHT>’
‘S-<UP>’    ‘C-c <UP>’     ‘ ’
‘S-<DOWN>’  ‘C-c <DOWN>’   ‘ ’
‘C-S-<LEFT>’‘C-c C-x       ‘ ’
            <LEFT>’
‘C-S-<RIGHT>’‘C-c C-x      ‘ ’
            <RIGHT>’


File: org.info,  Node: Interaction,  Next: org-crypt,  Prev: TTY keys,  Up: Miscellaneous

15.10 Interaction with other packages
=====================================

Org’s compatibility and the level of interaction with other Emacs
packages are documented here.

* Menu:

* Cooperation::                 Packages Org cooperates with
* Conflicts::                   Packages that lead to conflicts


File: org.info,  Node: Cooperation,  Next: Conflicts,  Up: Interaction

15.10.1 Packages that Org cooperates with
-----------------------------------------

‘calc.el’ by Dave Gillespie
     Org uses the Calc package for tables to implement spreadsheet
     functionality (*note The spreadsheet::).  Org also uses Calc for
     embedded calculations.  *Note Embedded Mode: (calc)Embedded Mode.
‘constants.el’ by Carsten Dominik
     Org can use names for constants in formulas in tables.  Org can
     also use calculation suffixes for units, such as ‘M’ for ‘Mega’.
     For a standard collection of such constants, install the
     ‘constants’ package.  Install version 2.0 of this package,
     available at <https://staff.fnwi.uva.nl/c.dominik/Tools/>.  Org
     checks if the function ‘constants-get’ has been autoloaded.
     Installation instructions are in the file, ‘constants.el’.
‘cdlatex.el’ by Carsten Dominik
     Org mode can use CDLaTeX package to efficiently enter LaTeX
     fragments into Org files (*note CDLaTeX mode::).
‘imenu.el’ by Ake Stenhoff and Lars Lindberg
     Imenu creates dynamic menus based on an index of items in a file.
     Org mode supports Imenu menus.  Enable it with a mode hook as
     follows:
          (add-hook 'org-mode-hook
                    (lambda () (imenu-add-to-menubar "Imenu")))
     By default the Imenu index is two levels deep.  Change the index
     depth using the variable ‘org-imenu-depth’.
‘speedbar.el’ by Eric M. Ludlam
     Speedbar package creates a special Emacs frame for displaying files
     and index items in files.  Org mode supports Speedbar; users can
     drill into Org files directly from the Speedbar.  The ‘<’ in the
     Speedbar frame tweaks the agenda commands to that file or to a
     subtree.
‘table.el’ by Takaaki Ota

     Complex ASCII tables with automatic line wrapping, column- and
     row-spanning, and alignment can be created using the Emacs table
     package by Takaaki Ota.  Org mode recognizes such tables and export
     them properly.  ‘C-c '’ to edit these tables in a special buffer,
     much like Org’s ‘src’ code blocks.  Because of interference with
     other Org mode functionality, Takaaki Ota tables cannot be edited
     directly in the Org buffer.
     ‘C-c '     (org-edit-special)’
          Edit a ‘table.el’ table.  Works when the cursor is in a
          table.el table.
     ‘C-c ~     (org-table-create-with-table.el)’
          Insert a ‘table.el’ table.  If there is already a table at
          point, this command converts it between the ‘table.el’ format
          and the Org mode format.  See the documentation string of the
          command ‘org-convert-table’ for details.


File: org.info,  Node: Conflicts,  Prev: Cooperation,  Up: Interaction

15.10.2 Packages that conflict with Org mode
--------------------------------------------

     In Emacs, ‘shift-selection-mode’ combines cursor motions with shift
     key to enlarge regions.  Emacs sets this mode by default.  This
     conflicts with Org’s use of ‘S-<cursor>’ commands to change
     timestamps, TODO keywords, priorities, and item bullet types, etc.
     Since ‘S-<cursor>’ commands outside of specific contexts don’t do
     anything, Org offers the variable ‘org-support-shift-select’ for
     customization.  Org mode accommodates shift selection by (i) making
     it available outside of the special contexts where special commands
     apply, and (ii) extending an existing active region even if the
     cursor moves across a special context.

‘CUA.el’ by Kim. F. Storm
     Org key bindings conflict with ‘S-<cursor>’ keys used by CUA mode.
     For Org to relinquish these bindings to CUA mode, configure the
     variable ‘org-replace-disputed-keys’.  When set, Org moves the
     following key bindings in Org files, and in the agenda buffer (but
     not during date selection).

          S-<UP>      ⇒  M-p             S-<DOWN>     ⇒  M-n
          S-<LEFT>    ⇒  M--             S-<RIGHT>    ⇒  M-+
          C-S-<LEFT>  ⇒  M-S--           C-S-<RIGHT>  ⇒  M-S-+

     Yes, these are unfortunately more difficult to remember.  To define
     a different replacement keys, look at the variable
     ‘org-disputed-keys’.

‘ecomplete.el’ by Lars Magne Ingebrigtsen <larsi@gnus.org>

     Ecomplete provides “electric” address completion in address header
     lines in message buffers.  Sadly Orgtbl mode cuts ecomplete’s power
     supply: No completion happens when Orgtbl mode is enabled in
     message buffers while entering text in address header lines.  If
     one wants to use ecomplete one should _not_ follow the advice to
     automagically turn on Orgtbl mode in message buffers (see *note
     Orgtbl mode::), but instead—after filling in the message
     headers—turn on Orgtbl mode manually when needed in the messages
     body.

‘filladapt.el’ by Kyle Jones

     Org mode tries to do the right thing when filling paragraphs, list
     items and other elements.  Many users reported problems using both
     ‘filladapt.el’ and Org mode, so a safe thing to do is to disable
     filladapt like this:

          (add-hook 'org-mode-hook 'turn-off-filladapt-mode)

‘yasnippet.el’
     The way Org mode binds the <TAB> key (binding to ‘[tab]’ instead of
     ‘"\t"’) overrules YASnippet’s access to this key.  The following
     code fixed this problem:

          (add-hook 'org-mode-hook
                    (lambda ()
                      (setq-local yas/trigger-key [tab])
                      (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))

     The latest version of yasnippet doesn’t play well with Org mode.
     If the above code does not fix the conflict, first define the
     following function:

          (defun yas/org-very-safe-expand ()
            (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))

     Then tell Org mode to use that function:

          (add-hook 'org-mode-hook
                    (lambda ()
                      (make-variable-buffer-local 'yas/trigger-key)
                      (setq yas/trigger-key [tab])
                      (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
                      (define-key yas/keymap [tab] 'yas/next-field)))

‘windmove.el’ by Hovav Shacham
     This package also uses the ‘S-<cursor>’ keys, so everything written
     in the paragraph above about CUA mode also applies here.  If you
     want make the windmove function active in locations where Org mode
     does not have special functionality on ‘S-<cursor>’, add this to
     your configuration:

          ;; Make windmove work in org-mode:
          (add-hook 'org-shiftup-final-hook 'windmove-up)
          (add-hook 'org-shiftleft-final-hook 'windmove-left)
          (add-hook 'org-shiftdown-final-hook 'windmove-down)
          (add-hook 'org-shiftright-final-hook 'windmove-right)

‘viper.el’ by Michael Kifer
     Viper uses ‘C-c /’ and therefore makes this key not access the
     corresponding Org mode command ‘org-sparse-tree’.  You need to find
     another key for this command, or override the key in
     ‘viper-vi-global-user-map’ with

          (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)


File: org.info,  Node: org-crypt,  Next: Org Mobile,  Prev: Interaction,  Up: Miscellaneous

15.11 org-crypt.el
==================

Org crypt encrypts the text of an Org entry, but not the headline, or
properties.  Org crypt uses the Emacs EasyPG library to encrypt and
decrypt.

   Any text below a headline that has a ‘:crypt:’ tag will be
automatically be encrypted when the file is saved.  To use a different
tag, customize the ‘org-crypt-tag-matcher’ variable.

   Suggested Org crypt settings in Emacs init file:

     (require 'org-crypt)
     (org-crypt-use-before-save-magic)
     (setq org-tags-exclude-from-inheritance (quote ("crypt")))

     (setq org-crypt-key nil)
       ;; GPG key to use for encryption
       ;; Either the Key ID or set to nil to use symmetric encryption.

     (setq auto-save-default nil)
       ;; Auto-saving does not cooperate with org-crypt.el: so you need
       ;; to turn it off if you plan to use org-crypt.el quite often.
       ;; Otherwise, you'll get an (annoying) message each time you
       ;; start Org.

       ;; To turn it off only locally, you can insert this:
       ;;
       ;; # -*- buffer-auto-save-file-name: nil; -*-

   Excluding the crypt tag from inheritance prevents encrypting
previously encrypted text.


File: org.info,  Node: Org Mobile,  Prev: org-crypt,  Up: Miscellaneous

15.12 Org Mobile
================

Org Mobile is a protocol for synchronizing Org files between Emacs and
other applications, e.g., on mobile devices.  It enables offline-views
and capture support for an Org mode system that is rooted on a “real”
computer.  The external application can also record changes to existing
entries.

   This appendix describes Org’s support for agenda view formats
compatible with Org Mobile.  It also describes synchronizing changes,
such as to notes, between the mobile application and the computer.

   To change tags and TODO states in the mobile application, first
customize the variables ‘org-todo-keywords’ and ‘org-tag-alist’.  These
should cover all the important tags and TODO keywords, even if Org files
use only some of them.  Though the mobile application is expected to
support in-buffer settings, it is required to understand TODO states
_sets_ (see *note Per-file keywords::) and _mutually exclusive_ tags
(see *note Setting tags::) only for those set in these variables.

* Menu:

* Setting up the staging area::  For the mobile device
* Pushing to the mobile application::  Uploading Org files and agendas
* Pulling from the mobile application::  Integrating captured and flagged items


File: org.info,  Node: Setting up the staging area,  Next: Pushing to the mobile application,  Up: Org Mobile

15.12.1 Setting up the staging area
-----------------------------------

The mobile application needs access to a file directory on a server(1)
to interact with Emacs.  Pass its location through the
‘org-mobile-directory’ variable.  If you can mount that directory
locally just set the variable to point to that directory:

     (setq org-mobile-directory "~/orgmobile/")

Alternatively, by using TRAMP (see *note TRAMP User Manual:
(tramp)Top.), ‘org-mobile-directory’ may point to a remote directory
accessible through, for example, SSH and SCP:

     (setq org-mobile-directory "/scpc:user@remote.host:org/webdav/")

   With a public server, consider encrypting the files.  Org also
requires OpenSSL installed on the local computer.  To turn on
encryption, set the same password in the mobile application and in
Emacs.  Set the password in the variable ‘org-mobile-use-encryption’(2).
Note that even after the mobile application encrypts the file contents,
the file name remains visible on the file systems of the local computer,
the server, and the mobile device.

   ---------- Footnotes ----------

   (1) For a server to host files, consider using a WebDAV server, such
as Nextcloud (https://nextcloud.com).  Additional help is at this FAQ
entry (https://orgmode.org/worg/org-faq.html#mobileorg_webdav).

   (2) If Emacs is configured for safe storing of passwords, then
configure the variable ‘org-mobile-encryption-password’; please read the
docstring of that variable.


File: org.info,  Node: Pushing to the mobile application,  Next: Pulling from the mobile application,  Prev: Setting up the staging area,  Up: Org Mobile

15.12.2 Pushing to the mobile application
-----------------------------------------

The command ‘org-mobile-push’ copies files listed in ‘org-mobile-files’
into the staging area.  Files include agenda files (as listed in
‘org-agenda-files’).  Customize ‘org-mobile-files’ to add other files.
File names are staged with paths relative to ‘org-directory’, so all
files should be inside this directory(1).

   Push creates a special Org file ‘agendas.org’ with custom agenda
views defined by the user(2).

   Finally, Org writes the file ‘index.org’, containing links to other
files.  The mobile application reads this file first from the server to
determine what other files to download for agendas.  For faster
downloads, it is expected to only read files whose checksums(3) have
changed.

   ---------- Footnotes ----------

   (1) Symbolic links in ‘org-directory’ need to have the same name as
their targets.

   (2) While creating the agendas, Org mode forces ID properties on all
referenced entries, so that these entries can be uniquely identified if
Org Mobile flags them for further action.  To avoid setting properties
configure the variable ‘org-mobile-force-id-on-agenda-items’ to ‘nil’.
Org mode then relies on outline paths, assuming they are unique.

   (3) Checksums are stored automatically in the file ‘checksums.dat’.


File: org.info,  Node: Pulling from the mobile application,  Prev: Pushing to the mobile application,  Up: Org Mobile

15.12.3 Pulling from the mobile application
-------------------------------------------

The command ‘org-mobile-pull’ synchronizes changes with the server.
More specifically, it first pulls the Org files for viewing.  It then
appends captured entries and pointers to flagged or changed entries to
the file ‘mobileorg.org’ on the server.  Org ultimately integrates its
data in an inbox file format, through the following steps:

  1. Org moves all entries found in ‘mobileorg.org’(1) and appends them
     to the file pointed to by the variable ‘org-mobile-inbox-for-pull’.
     It should reside neither in the staging area nor on the server.
     Each captured entry and each editing event is a top-level entry in
     the inbox file.

  2. After moving the entries, Org processes changes to the shared
     files.  Some of them are applied directly and without user
     interaction.  Examples include changes to tags, TODO state,
     headline and body text.  Entries requiring further action are
     tagged as ‘FLAGGED’.  Org marks entries with problems with an error
     message in the inbox.  They have to be resolved manually.

  3. Org generates an agenda view for flagged entries for user
     intervention to clean up.  For notes stored in flagged entries, Org
     displays them in the echo area when point is on the corresponding
     agenda item.

     ‘?’
          Pressing ‘?’ displays the entire flagged note in another
          window.  Org also pushes it to the kill ring.  To store
          flagged note as a normal note, use ‘? z C-y C-c C-c’.
          Pressing ‘?’ twice does these things: first it removes the
          ‘FLAGGED’ tag; second, it removes the flagged note from the
          property drawer; third, it signals that manual editing of the
          flagged entry is now finished.

   From the agenda dispatcher, ‘?’ returns to the view to finish
processing flagged entries.  Note that these entries may not be the most
recent since the mobile application searches files that were last
pulled.  To get an updated agenda view with changes since the last pull,
pull again.

   ---------- Footnotes ----------

   (1) The file will be empty after this operation.


File: org.info,  Node: Hacking,  Next: History and acknowledgments,  Prev: Miscellaneous,  Up: Top

Appendix A Hacking
******************

This appendix covers some areas where users can extend the functionality
of Org.

* Menu:

* Hooks::                       How to reach into Org’s internals
* Add-on packages::             Available extensions
* Adding hyperlink types::      New custom link types
* Adding export back-ends::     How to write new export back-ends
* Context-sensitive commands::  How to add functionality to such commands
* Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
* Speeding up your agendas::    Tips on how to speed up your agendas
* Extracting agenda information::  Post-processing of agenda information
* Using the property API::      Writing programs that use entry properties
* Using the mapping API::       Mapping over all or selected entries


File: org.info,  Node: Hooks,  Next: Add-on packages,  Up: Hacking

A.1 Hooks
=========

Org has a large number of hook variables for adding functionality.  This
appendix illustrates using a few.  A complete list of hooks with
documentation is maintained by the Worg project at
<https://orgmode.org/worg/doc.html#hooks>.


File: org.info,  Node: Add-on packages,  Next: Adding hyperlink types,  Prev: Hooks,  Up: Hacking

A.2 Add-on packages
===================

Various authors wrote a large number of add-on packages for Org.

   These packages are not part of Emacs, but they are distributed as
contributed packages with the separate release available at
<https://orgmode.org>.  See the ‘contrib/README’ file in the source code
directory for a list of contributed files.  Worg page with more
information is at: <https://orgmode.org/worg/org-contrib/>.


File: org.info,  Node: Adding hyperlink types,  Next: Adding export back-ends,  Prev: Add-on packages,  Up: Hacking

A.3 Adding hyperlink types
==========================

Org has many built-in hyperlink types (*note Hyperlinks::), and an
interface for adding new link types.  The example file, ‘org-man.el’,
shows the process of adding Org links to Unix man pages, which look like
this: ‘[[man:printf][The printf manpage]]’:

     ;;; org-man.el - Support for links to manpages in Org

     (require 'org)

     (org-add-link-type "man" 'org-man-open)
     (add-hook 'org-store-link-functions 'org-man-store-link)

     (defcustom org-man-command 'man
       "The Emacs command to be used to display a man page."
       :group 'org-link
       :type '(choice (const man) (const woman)))

     (defun org-man-open (path)
       "Visit the manpage on PATH.
     PATH should be a topic that can be thrown at the man command."
       (funcall org-man-command path))

     (defun org-man-store-link ()
       "Store a link to a manpage."
       (when (memq major-mode '(Man-mode woman-mode))
         ;; This is a man page, we do make this link
         (let* ((page (org-man-get-page-name))
                (link (concat "man:" page))
                (description (format "Manpage for %s" page)))
           (org-store-link-props
            :type "man"
            :link link
            :description description))))

     (defun org-man-get-page-name ()
       "Extract the page name from the buffer name."
       ;; This works for both `Man-mode' and `woman-mode'.
       (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
           (match-string 1 (buffer-name))
         (error "Cannot create link to this man page")))

     (provide 'org-man)

     ;;; org-man.el ends here

To activate links to man pages in Org, enter this in the init file:

     (require 'org-man)

A review of ‘org-man.el’:
  1. First, ‘(require 'org)’ ensures ‘org.el’ is loaded.
  2. The ‘org-add-link-type’ defines a new link type with ‘man’ prefix.
     The call contains the function to call that follows the link type.
  3. The next line adds a function to ‘org-store-link-functions’ that
     records a useful link with the command ‘C-c l’ in a buffer
     displaying a man page.

   The rest of the file defines necessary variables and functions.
First is the customization variable ‘org-man-command’.  It has two
options, ‘man’ and ‘woman’.  Next is a function whose argument is the
link path, which for man pages is the topic of the man command.  To
follow the link, the function calls the ‘org-man-command’ to display the
man page.

   ‘C-c l’ constructs and stores the link.

   ‘C-c l’ calls the function ‘org-man-store-link’, which first checks
if the ‘major-mode’ is appropriate.  If check fails, the function
returns ‘nil’.  Otherwise the function makes a link string by combining
the ‘man:’ prefix with the man topic.  The function then calls
‘org-store-link-props’ with ‘:type’ and ‘:link’ properties.  A
‘:description’ property is an optional string that is displayed when the
function inserts the link in the Org buffer.

   ‘C-c C-l’ inserts the stored link.

   To define new link types, define a function that implements
completion support with ‘C-c C-l’.  This function should not accept any
arguments but return the appropriate prefix and complete link string.


File: org.info,  Node: Adding export back-ends,  Next: Context-sensitive commands,  Prev: Adding hyperlink types,  Up: Hacking

A.4 Adding export back-ends
===========================

Org’s export engine makes it easy for writing new back-ends.  The
framework on which the engine was built makes it easy to derive new
back-ends from existing ones.

   The two main entry points to the export engine are:
‘org-export-define-backend’ and ‘org-export-define-derived-backend’.  To
grok these functions, see ‘ox-latex.el’ for an example of defining a new
back-end from scratch, and ‘ox-beamer.el’ for an example of deriving
from an existing engine.

   For creating a new back-end from scratch, first set its name as a
symbol in an alist consisting of elements and export functions.  To make
the back-end visible to the export dispatcher, set ‘:menu-entry’
keyword.  For export options specific to this back-end, set the
‘:options-alist’.

   For creating a new back-end from an existing one, set
‘:translate-alist’ to an alist of export functions.  This alist replaces
the parent back-end functions.

   For complete documentation, see the Org Export Reference on Worg
(https://orgmode.org/worg/dev/org-export-reference.html).


File: org.info,  Node: Context-sensitive commands,  Next: Tables in arbitrary syntax,  Prev: Adding export back-ends,  Up: Hacking

A.5 Context-sensitive commands
==============================

Org has facilities for building context sensitive commands.  Authors of
Org add-ons can tap into this functionality.

   Some Org commands change depending on the context.  The most
important example of this behavior is the ‘C-c C-c’ (*note The very busy
C-c C-c key::).  Other examples are ‘M-cursor’ and ‘M-S-cursor’.

   These context sensitive commands work by providing a function that
detects special context for that add-on and executes functionality
appropriate for that context.


File: org.info,  Node: Tables in arbitrary syntax,  Next: Dynamic blocks,  Prev: Context-sensitive commands,  Up: Hacking

A.6 Tables and lists in arbitrary syntax
========================================

Because of Org’s success in handling tables with Orgtbl, a frequently
asked feature is to Org’s usability functions to other table formats
native to other modem’s, such as LaTeX.  This would be hard to do in a
general way without complicated customization nightmares.  Moreover,
that would take Org away from its simplicity roots that Orgtbl has
proven.  There is, however, an alternate approach to accomplishing the
same.

   This approach involves implementing a custom _translate_ function
that operates on a native Org _source table_ to produce a table in
another format.  This strategy would keep the excellently working Orgtbl
simple and isolate complications, if any, confined to the translate
function.  To add more alien table formats, we just add more translate
functions.  Also the burden of developing custom translate functions for
new table formats will be in the hands of those who know those formats
best.

   For an example of how this strategy works, see Orgstruct mode.  In
that mode, Bastien added the ability to use Org’s facilities to edit and
re-structure lists.  He did by turning ‘orgstruct-mode’ on, and then
exporting the list locally to another format, such as HTML, LaTeX or
Texinfo.

* Menu:

* Radio tables::                Sending and receiving radio tables
* A LaTeX example::          Step by step, almost a tutorial
* Translator functions::        Copy and modify
* Radio lists::                 Sending and receiving lists


File: org.info,  Node: Radio tables,  Next: A LaTeX example,  Up: Tables in arbitrary syntax

A.6.1 Radio tables
------------------

Radio tables are target locations for translated tables that are not
near their source.  Org finds the target location and inserts the
translated table.

   The key to finding the target location are the magic words ‘BEGIN/END
RECEIVE ORGTBL’.  They have to appear as comments in the current mode.
If the mode is C, then:

     /* BEGIN RECEIVE ORGTBL table_name */
     /* END RECEIVE ORGTBL table_name */

At the location of source, Org needs a special line to direct Orgtbl to
translate and to find the target for inserting the translated table.
For example:
     #+ORGTBL: SEND table_name translation_function arguments...

‘table_name’ is the table’s reference name, which is also used in the
receiver lines, and the ‘translation_function’ is the Lisp function that
translates.  This line, in addition, may also contain alternating key
and value arguments at the end.  The translation function gets these
values as a property list.  A few standard parameters are already
recognized and acted upon before the translation function is called:

‘:skip N’
     Skip the first N lines of the table.  Hlines do count; include them
     if they are to be skipped.

‘:skipcols (n1 n2 ...)’
     List of columns to be skipped.  First Org automatically discards
     columns with calculation marks and then sends the table to the
     translator function, which then skips columns as specified in
     ‘skipcols’.

To keep the source table intact in the buffer without being disturbed
when the source file is compiled or otherwise being worked on, use one
of these strategies:

   • Place the table in a block comment.  For example, in C mode you
     could wrap the table between ‘/*’ and ‘*/’ lines.
   • Put the table after an ‘END’ statement.  For example ‘\bye’ in TeX
     and ‘\end{document}’ in LaTeX.
   • Comment and uncomment each line of the table during edits.  The
     ‘M-x orgtbl-toggle-comment <RET>’ command makes toggling easy.


File: org.info,  Node: A LaTeX example,  Next: Translator functions,  Prev: Radio tables,  Up: Tables in arbitrary syntax

A.6.2 A LaTeX example of radio tables
-------------------------------------

To wrap a source table in LaTeX, use the ‘comment’ environment provided
by ‘comment.sty’.  To activate it, put ‘\usepackage{comment}’ in the
document header.  Orgtbl mode inserts a radio table skeleton(1) with the
command ‘M-x orgtbl-insert-radio-table <RET>’, which prompts for a table
name.  For example, if ‘salesfigures’ is the name, the template inserts:

     % BEGIN RECEIVE ORGTBL salesfigures
     % END RECEIVE ORGTBL salesfigures
     \begin{comment}
     #+ORGTBL: SEND salesfigures orgtbl-to-latex
     | | |
     \end{comment}

The line ‘#+ORGTBL: SEND’ tells Orgtbl mode to use the function
‘orgtbl-to-latex’ to convert the table to LaTeX format, then insert the
table at the target (receive) location named ‘salesfigures’.  Now the
table is ready for data entry.  It can even use spreadsheet features(2):

     % BEGIN RECEIVE ORGTBL salesfigures
     % END RECEIVE ORGTBL salesfigures
     \begin{comment}
     #+ORGTBL: SEND salesfigures orgtbl-to-latex
     | Month | Days | Nr sold | per day |
     |-------+------+---------+---------|
     | Jan   |   23 |      55 |     2.4 |
     | Feb   |   21 |      16 |     0.8 |
     | March |   22 |     278 |    12.6 |
     #+TBLFM: $4=$3/$2;%.1f
     % $ (optional extra dollar to keep font-lock happy, see footnote)
     \end{comment}

After editing, ‘C-c C-c’ inserts translated table at the target
location, between the two marker lines.

   For hand-made custom tables, note that the translator needs to skip
the first two lines of the source table.  Also the command has to
_splice_ out the target table without the header and footer.

     \begin{tabular}{lrrr}
     Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
     % BEGIN RECEIVE ORGTBL salesfigures
     % END RECEIVE ORGTBL salesfigures
     \end{tabular}
     %
     \begin{comment}
     #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
     | Month | Days | Nr sold | per day |
     |-------+------+---------+---------|
     | Jan   |   23 |      55 |     2.4 |
     | Feb   |   21 |      16 |     0.8 |
     | March |   22 |     278 |    12.6 |
     #+TBLFM: $4=$3/$2;%.1f
     \end{comment}

   The LaTeX translator function ‘orgtbl-to-latex’ is already part of
Orgtbl mode and uses ‘tabular’ environment by default to typeset the
table and mark the horizontal lines with ‘\hline’.  For additional
parameters to control output, *note Translator functions:::

‘:splice nil/t’
     When non-‘nil’, returns only table body lines; not wrapped in
     tabular environment.  Default is ‘nil’.

‘:fmt fmt’
     Format to warp each field.  It should contain ‘%s’ for the original
     field value.  For example, to wrap each field value in dollar
     symbol, you could use ‘:fmt "$%s$"’.  Format can also wrap a
     property list with column numbers and formats, for example ‘:fmt (2
     "$%s$" 4 "%s\\%%")’.  In place of a string, a function of one
     argument can be used; the function must return a formatted string.

‘:efmt efmt’
     Format numbers as exponentials.  The spec should have ‘%s’ twice
     for inserting mantissa and exponent, for example
     ‘"%s\\times10^{%s}"’.  This may also be a property list with column
     numbers and formats, for example ‘:efmt (2 "$%s\\times10^{%s}$" 4
     "$%s\\cdot10^{%s}$")’.  After ‘efmt’ has been applied to a value,
     ‘fmt’ will also be applied.  Functions with two arguments can be
     supplied instead of strings.  By default, no special formatting is
     applied.

   ---------- Footnotes ----------

   (1) By default this works only for LaTeX, HTML, and Texinfo.
Configure the variable ‘orgtbl-radio-table-templates’ to install
templates for other export formats.

   (2) If the ‘#+TBLFM’ line contains an odd number of dollar
characters, this may cause problems with font-lock in LaTeX mode.  As
shown in the example you can fix this by adding an extra line inside the
‘comment’ environment that is used to balance the dollar expressions.
If you are using AUCTeX with the font-latex library, a much better
solution is to add the ‘comment’ environment to the variable
‘LaTeX-verbatim-environments’.


File: org.info,  Node: Translator functions,  Next: Radio lists,  Prev: A LaTeX example,  Up: Tables in arbitrary syntax

A.6.3 Translator functions
--------------------------

Orgtbl mode has built-in translator functions: ‘orgtbl-to-csv’
(comma-separated values), ‘orgtbl-to-tsv’ (TAB-separated values),
‘orgtbl-to-latex’, ‘orgtbl-to-html’, ‘orgtbl-to-texinfo’,
‘orgtbl-to-unicode’ and ‘orgtbl-to-orgtbl’.  They use the generic
translator, ‘orgtbl-to-generic’, which delegates translations to various
export back-ends.

   Properties passed to the function through the ‘ORGTBL SEND’ line take
precedence over properties defined inside the function.  For example,
this overrides the default LaTeX line endings, ‘\\’, with ‘\\[2mm]’:

     #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"

   For a new language translator, define a converter function.  It can
be a generic function, such as shown in this example.  It marks a
beginning and ending of a table with ‘!BTBL!’ and ‘!ETBL!’; a beginning
and ending of lines with ‘!BL!’ and ‘!EL!’; and uses a TAB for a field
separator:

     (defun orgtbl-to-language (table params)
       "Convert the orgtbl-mode TABLE to language."
       (orgtbl-to-generic
        table
        (org-combine-plists
         '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
         params)))

The documentation for the ‘orgtbl-to-generic’ function shows a complete
list of parameters, each of which can be passed through to
‘orgtbl-to-latex’, ‘orgtbl-to-texinfo’, and any other function using
that generic function.

   For complicated translations the generic translator function could be
replaced by a custom translator function.  Such a custom function must
take two arguments and return a single string containing the formatted
table.  The first argument is the table whose lines are a list of fields
or the symbol ‘hline’.  The second argument is the property list
consisting of parameters specified in the ‘#+ORGTBL: SEND’ line.  Please
share your translator functions by posting them to the Org users mailing
list, <emacs-orgmode@gnu.org>.


File: org.info,  Node: Radio lists,  Prev: Translator functions,  Up: Tables in arbitrary syntax

A.6.4 Radio lists
-----------------

Call the ‘org-list-insert-radio-list’ function to insert a radio list
template in HTML, LaTeX, and Texinfo mode documents.  Sending and
receiving radio lists works is the same as for radio tables (*note Radio
tables::) except for these differences:

   − Orgstruct mode must be active.
   − Use ‘ORGLST’ keyword instead of ‘ORGTBL’.
   − ‘C-c C-c’ works only on the first list item.

   Built-in translators functions are: ‘org-list-to-latex’,
‘org-list-to-html’ and ‘org-list-to-texinfo’.  They use the
‘org-list-to-generic’ translator function.  See its documentation for
parameters for accurate customizations of lists.  Here is a LaTeX
example:

     % BEGIN RECEIVE ORGLST to-buy
     % END RECEIVE ORGLST to-buy
     \begin{comment}
     #+ORGLST: SEND to-buy org-list-to-latex
     - a new house
     - a new computer
       + a new keyboard
       + a new mouse
     - a new life
     \end{comment}

   ‘C-c C-c’ on ‘a new house’ inserts the translated LaTeX list
in-between the BEGIN and END marker lines.


File: org.info,  Node: Dynamic blocks,  Next: Special agenda views,  Prev: Tables in arbitrary syntax,  Up: Hacking

A.7 Dynamic blocks
==================

Org supports _dynamic blocks_ in Org documents.  They are inserted with
begin and end markers like any other ‘src’ code block, but the contents
are updated automatically by a user function.  For example, ‘C-c C-x
C-r’ inserts a dynamic table that updates the work time (*note Clocking
work time::).

   Dynamic blocks can have names and function parameters.  The syntax is
similar to ‘src’ code block specifications:

     #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...

     #+END:

   These command update dynamic blocks:

‘C-c C-x C-u     (org-dblock-update)’
     Update dynamic block at point.
‘C-u C-c C-x C-u’
     Update all dynamic blocks in the current file.

   Before updating a dynamic block, Org removes content between the
BEGIN and END markers.  Org then reads the parameters on the BEGIN line
for passing to the writer function.  If the function expects to access
the removed content, then Org expects an extra parameter, ‘:content’, on
the BEGIN line.

   To syntax for calling a writer function with a named block, ‘myblock’
is: ‘org-dblock-write:myblock’.  Parameters come from the BEGIN line.

   The following is an example of a dynamic block and a block writer
function that updates the time when the function was last run:

     #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"

     #+END:

The dynamic block’s writer function:

     (defun org-dblock-write:block-update-time (params)
       (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
         (insert "Last block update at: "
                 (format-time-string fmt))))

   To keep dynamic blocks up-to-date in an Org file, use the function,
‘org-update-all-dblocks’ in hook, such as ‘before-save-hook’.  The
‘org-update-all-dblocks’ function does not run if the file is not in Org
mode.

   Dynamic blocks, like any other block, can be narrowed with
‘org-narrow-to-block’.


File: org.info,  Node: Special agenda views,  Next: Speeding up your agendas,  Prev: Dynamic blocks,  Up: Hacking

A.8 Special agenda views
========================

Org provides a special hook to further limit items in agenda views:
‘agenda’, ‘agenda*’(1), ‘todo’, ‘alltodo’, ‘tags’, ‘tags-todo’,
‘tags-tree’.  Specify a custom function that tests inclusion of every
matched item in the view.  This function can also skip as much as is
needed.

   For a global condition applicable to agenda views, use the
‘org-agenda-skip-function-global’ variable.  Org uses a global condition
with ‘org-agenda-skip-function’ for custom searching.

   This example defines a function for a custom view showing TODO items
with WAITING status.  Manually this is a multi step search process, but
with a custom view, this can be automated as follows:

   The custom function searches the subtree for the WAITING tag and
returns ‘nil’ on match.  Otherwise it gives the location from where the
search continues.

     (defun my-skip-unless-waiting ()
       "Skip trees that are not waiting"
       (let ((subtree-end (save-excursion (org-end-of-subtree t))))
         (if (re-search-forward ":waiting:" subtree-end t)
             nil          ; tag found, do not skip
           subtree-end))) ; tag not found, continue after end of subtree

   To use this custom function in a custom agenda command:

     (org-add-agenda-custom-command
      '("b" todo "PROJECT"
        ((org-agenda-skip-function 'my-skip-unless-waiting)
         (org-agenda-overriding-header "Projects waiting for something: "))))

   Note that this also binds ‘org-agenda-overriding-header’ to a more
meaningful string suitable for the agenda view.

   Search for entries with a limit set on levels for the custom search.
This is a general approach to creating custom searches in Org.  To
include all levels, use ‘LEVEL>0’(2).  Then to selectively pick the
matched entries, use ‘org-agenda-skip-function’, which also accepts Lisp
forms, such as ‘org-agenda-skip-entry-if’ and
‘org-agenda-skip-subtree-if’.  For example:

‘(org-agenda-skip-entry-if 'scheduled)’
     Skip current entry if it has been scheduled.
‘(org-agenda-skip-entry-if 'notscheduled)’
     Skip current entry if it has not been scheduled.
‘(org-agenda-skip-entry-if 'deadline)’
     Skip current entry if it has a deadline.
‘(org-agenda-skip-entry-if 'scheduled 'deadline)’
     Skip current entry if it has a deadline, or if it is scheduled.
‘(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))’
     Skip current entry if the TODO keyword is TODO or WAITING.
‘(org-agenda-skip-entry-if 'todo 'done)’
     Skip current entry if the TODO keyword marks a DONE state.
‘(org-agenda-skip-entry-if 'timestamp)’
     Skip current entry if it has any timestamp, may also be deadline or
     scheduled.
‘(org-agenda-skip-entry-if 'regexp "regular expression")’
     Skip current entry if the regular expression matches in the entry.
‘(org-agenda-skip-entry-if 'notregexp "regular expression")’
     Skip current entry unless the regular expression matches.
‘(org-agenda-skip-subtree-if 'regexp "regular expression")’
     Same as above, but check and skip the entire subtree.

   The following is an example of a search for ‘WAITING’ without the
special function:

     (org-add-agenda-custom-command
      '("b" todo "PROJECT"
        ((org-agenda-skip-function '(org-agenda-skip-subtree-if
                                     'regexp ":waiting:"))
         (org-agenda-overriding-header "Projects waiting for something: "))))

   ---------- Footnotes ----------

   (1) The ‘agenda*’ view is the same as ‘agenda’ except that it only
considers _appointments_, i.e., scheduled and deadline items that have a
time specification ‘[h]h:mm’ in their time-stamps.

   (2) Note that, for ‘org-odd-levels-only’, a level number corresponds
to order in the hierarchy, not to the number of stars.


File: org.info,  Node: Speeding up your agendas,  Next: Extracting agenda information,  Prev: Special agenda views,  Up: Hacking

A.9 Speeding up your agendas
============================

Some agenda commands slow down when the Org files grow in size or
number.  Here are tips to speed up:

  1. Reduce the number of Org agenda files to avoid slowdowns due to
     hard drive accesses.
  2. Reduce the number of ‘DONE’ and archived headlines so agenda
     operations that skip over these can finish faster.
  3. Do not dim blocked tasks:
          (setq org-agenda-dim-blocked-tasks nil)
  4. Stop preparing agenda buffers on startup:
          (setq org-agenda-inhibit-startup nil)
  5. Disable tag inheritance for agendas:
          (setq org-agenda-use-tag-inheritance nil)

   These options can be applied to selected agenda views.  For more
details about generation of agenda views, see the docstrings for the
relevant variables, and this dedicated Worg page
(https://orgmode.org/worg/agenda-optimization.html) for agenda
optimization.


File: org.info,  Node: Extracting agenda information,  Next: Using the property API,  Prev: Speeding up your agendas,  Up: Hacking

A.10 Extracting agenda information
==================================

Org provides commands to access agendas through Emacs batch mode.
Through this command-line interface, agendas are automated for further
processing or printing.

   ‘org-batch-agenda’ creates an agenda view in ASCII and outputs to
STDOUT. This command takes one string parameter.  When string length=1,
Org uses it as a key to ‘org-agenda-custom-commands’.  These are the
same ones available through ‘C-c a’.

   This example command line directly prints the TODO list to the
printer:

     emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr

   When the string parameter length is two or more characters, Org
matches it with tags/TODO strings.  For example, this example command
line prints items tagged with ‘shop’, but excludes items tagged with
‘NewYork’:

     emacs -batch -l ~/.emacs                                      \
           -eval '(org-batch-agenda "+shop-NewYork")' | lpr

An example showing on-the-fly parameter modifications:

     emacs -batch -l ~/.emacs                                      \
        -eval '(org-batch-agenda "a"                               \
                 org-agenda-span (quote month)                     \
                 org-agenda-include-diary nil                      \
                 org-agenda-files (quote ("~/org/project.org")))'  \
        | lpr

which will produce an agenda for the next 30 days from just the
‘~/org/projects.org’ file.

   For structured processing of agenda output, use
‘org-batch-agenda-csv’ with the following fields:

     category     The category of the item
     head         The headline, without TODO keyword, TAGS and PRIORITY
     type         The type of the agenda entry, can be
                     todo               selected in TODO match
                     tagsmatch          selected in tags match
                     diary              imported from diary
                     deadline           a deadline
                     scheduled          scheduled
                     timestamp          appointment, selected by timestamp
                     closed             entry was closed on date
                     upcoming-deadline  warning about nearing deadline
                     past-scheduled     forwarded scheduled item
                     block              entry has date block including date
     todo         The TODO keyword, if any
     tags         All tags including inherited ones, separated by colons
     date         The relevant date, like 2007-2-14
     time         The time, like 15:00-16:50
     extra        String with extra planning info
     priority-l   The priority letter if any was given
     priority-n   The computed numerical priority

If the selection of the agenda item was based on a timestamp, including
those items with ‘DEADLINE’ and ‘SCHEDULED’ keywords, then Org includes
date and time in the output.

   If the selection of the agenda item was based on a timestamp (or
deadline/scheduled), then Org includes date and time in the output.

   Here is an example of a post-processing script in Perl.  It takes the
CSV output from Emacs and prints with a checkbox:

     #!/usr/bin/perl

     # define the Emacs command to run
     $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";

     # run it and capture the output
     $agenda = qx{$cmd 2>/dev/null};

     # loop over all lines
     foreach $line (split(/\n/,$agenda)) {
       # get the individual values
       ($category,$head,$type,$todo,$tags,$date,$time,$extra,
        $priority_l,$priority_n) = split(/,/,$line);
       # process and print
       print "[ ] $head\n";
     }


File: org.info,  Node: Using the property API,  Next: Using the mapping API,  Prev: Extracting agenda information,  Up: Hacking

A.11 Using the property API
===========================

Functions for working with properties.

 -- Function: org-entry-properties &optional pom which
     Get all properties of the entry at point-or-marker POM.
     This includes the TODO keyword, the tags, time strings for
     deadline, scheduled, and clocking, and any additional properties
     defined in the entry.  The return value is an alist.  Keys may
     occur multiple times if the property key was used several times.
     POM may also be ‘nil’, in which case the current entry is used.  If
     WHICH is ‘nil’ or ‘all’, get all properties.  If WHICH is ‘special’
     or ‘standard’, only get that subclass.

 -- Function: org-entry-get pom property &optional inherit
     Get value of ‘PROPERTY’ for entry at point-or-marker ‘POM’.  By
     default, this only looks at properties defined locally in the
     entry.  If ‘INHERIT’ is non-‘nil’ and the entry does not have the
     property, then also check higher levels of the hierarchy.  If
     ‘INHERIT’ is the symbol ‘selective’, use inheritance if and only if
     the setting of ‘org-use-property-inheritance’ selects ‘PROPERTY’
     for inheritance.

 -- Function: org-entry-delete pom property
     Delete the property ‘PROPERTY’ from entry at point-or-marker POM.

 -- Function: org-entry-put pom property value
     Set ‘PROPERTY’ to ‘VALUE’ for entry at point-or-marker POM.

 -- Function: org-buffer-property-keys &optional include-specials
     Get all property keys in the current buffer.

 -- Function: org-insert-property-drawer
     Insert a property drawer for the current entry.

 -- Function: org-entry-put-multivalued-property pom property &rest
          values
     Set ‘PROPERTY’ at point-or-marker ‘POM’ to ‘VALUES’.  ‘VALUES’
     should be a list of strings.  They will be concatenated, with
     spaces as separators.

 -- Function: org-entry-get-multivalued-property pom property
     Treat the value of the property ‘PROPERTY’ as a
     whitespace-separated list of values and return the values as a list
     of strings.

 -- Function: org-entry-add-to-multivalued-property pom property value
     Treat the value of the property ‘PROPERTY’ as a
     whitespace-separated list of values and make sure that ‘VALUE’ is
     in this list.

 -- Function: org-entry-remove-from-multivalued-property pom property
          value
     Treat the value of the property ‘PROPERTY’ as a
     whitespace-separated list of values and make sure that ‘VALUE’ is
     _not_ in this list.

 -- Function: org-entry-member-in-multivalued-property pom property
          value
     Treat the value of the property ‘PROPERTY’ as a
     whitespace-separated list of values and check if ‘VALUE’ is in this
     list.

 -- User Option: org-property-allowed-value-functions
     Hook for functions supplying allowed values for a specific
     property.  The functions must take a single argument, the name of
     the property, and return a flat list of allowed values.  If ‘:ETC’
     is one of the values, use the values as completion help, but allow
     also other values to be entered.  The functions must return ‘nil’
     if they are not responsible for this property.


File: org.info,  Node: Using the mapping API,  Prev: Using the property API,  Up: Hacking

A.12 Using the mapping API
==========================

Org has sophisticated mapping capabilities for finding entries.  Org
uses this functionality internally for generating agenda views.  Org
also exposes an API for executing arbitrary functions for each selected
entry.  The API’s main entry point is:

 -- Function: org-map-entries func &optional match scope &rest skip
     Call ‘FUNC’ at each headline selected by ‘MATCH’ in ‘SCOPE’.

     ‘FUNC’ is a function or a Lisp form.  With the cursor positioned at
     the beginning of the headline, call the function without arguments.
     Org returns an alist of return values of calls to the function.

     To avoid preserving point, Org wraps the call to ‘FUNC’ in
     save-excursion form.  After evaluation, Org moves the cursor to the
     end of the line that was just processed.  Search continues from
     that point forward.  This may not always work as expected under
     some conditions, such as if the current sub-tree was removed by a
     previous archiving operation.  In such rare circumstances, Org
     skips the next entry entirely when it should not.  To stop Org from
     such skips, make ‘FUNC’ set the variable ‘org-map-continue-from’ to
     a specific buffer position.

     ‘MATCH’ is a tags/property/TODO match.  Org iterates only matched
     headlines.  Org iterates over all headlines when ‘MATCH’ is ‘nil’
     or ‘t’.

     ‘SCOPE’ determines the scope of this command.  It can be any of:

          nil     the current buffer, respecting the restriction if any
          tree    the subtree started with the entry at point
          region  The entries within the active region, if any
          file    the current buffer, without restriction
          file-with-archives
                  the current buffer, and any archives associated with it
          agenda  all agenda files
          agenda-with-archives
                  all agenda files with any archive files associated with them
          (file1 file2 ...)
                  if this is a list, all files in the list will be scanned
     The remaining args are treated as settings for the scanner’s
     skipping facilities.  Valid args are:

          archive   skip trees with the archive tag
          comment   skip trees with the COMMENT keyword
          function or Lisp form
                    will be used as value for ‘org-agenda-skip-function’,
                    so whenever the function returns t, FUNC
                    will not be called for that entry and search will
                    continue from the point where the function leaves it

   The mapping routine can call any arbitrary function, even functions
that change meta data or query the property API (*note Using the
property API::).  Here are some handy functions:

 -- Function: org-todo &optional arg
     Change the TODO state of the entry.  See the docstring of the
     functions for the many possible values for the argument ‘ARG’.

 -- Function: org-priority &optional action
     Change the priority of the entry.  See the docstring of this
     function for the possible values for ‘ACTION’.

 -- Function: org-toggle-tag tag &optional onoff
     Toggle the tag ‘TAG’ in the current entry.  Setting ‘ONOFF’ to
     either ‘on’ or ‘off’ will not toggle tag, but ensure that it is
     either on or off.

 -- Function: org-promote
     Promote the current entry.

 -- Function: org-demote
     Demote the current entry.

   This example turns all entries tagged with ‘TOMORROW’ into TODO
entries with keyword ‘UPCOMING’.  Org ignores entries in comment trees
and archive trees.

     (org-map-entries
      '(org-todo "UPCOMING")
      "+TOMORROW" 'file 'archive 'comment)

   The following example counts the number of entries with TODO keyword
‘WAITING’, in all agenda files.

     (length (org-map-entries t "/+WAITING" 'agenda))


File: org.info,  Node: History and acknowledgments,  Next: GNU Free Documentation License,  Prev: Hacking,  Up: Top

Appendix B History and acknowledgments
**************************************

B.1 From Carsten
================

Org was born in 2003, out of frustration over the user interface of the
Emacs Outline mode.  I was trying to organize my notes and projects, and
using Emacs seemed to be the natural way to go.  However, having to
remember eleven different commands with two or three keys per command,
only to hide and show parts of the outline tree, that seemed entirely
unacceptable.  Also, when using outlines to take notes, I constantly
wanted to restructure the tree, organizing it paralleling my thoughts
and plans.  _Visibility cycling_ and _structure editing_ were originally
implemented in the package ‘outline-magic.el’, but quickly moved to the
more general ‘org.el’.  As this environment became comfortable for
project planning, the next step was adding _TODO entries_, basic
_timestamps_, and _table support_.  These areas highlighted the two main
goals that Org still has today: to be a new, outline-based, plain text
mode with innovative and intuitive editing features, and to incorporate
project planning functionality directly into a notes file.

   Since the first release, literally thousands of emails to me or to
<emacs-orgmode@gnu.org> have provided a constant stream of bug reports,
feedback, new ideas, and sometimes patches and add-on code.  Many thanks
to everyone who has helped to improve this package.  I am trying to keep
here a list of the people who had significant influence in shaping one
or more aspects of Org.  The list may not be complete, if I have
forgotten someone, please accept my apologies and let me know.

   Before I get to this list, a few special mentions are in order:

Bastien Guerry
     Bastien has written a large number of extensions to Org (most of
     them integrated into the core by now), including the LaTeX exporter
     and the plain list parser.  His support during the early days was
     central to the success of this project.  Bastien also invented
     Worg, helped establishing the Web presence of Org, and sponsored
     hosting costs for the orgmode.org website.  Bastien stepped in as
     maintainer of Org between 2011 and 2013, at a time when I
     desperately needed a break.
Eric Schulte and Dan Davison
     Eric and Dan are jointly responsible for the Org-babel system,
     which turns Org into a multi-language environment for evaluating
     code and doing literate programming and reproducible research.
     This has become one of Org’s killer features that define what Org
     is today.
John Wiegley
     John has contributed a number of great ideas and patches directly
     to Org, including the attachment system (‘org-attach.el’),
     integration with Apple Mail (‘org-mac-message.el’), hierarchical
     dependencies of TODO items, habit tracking (‘org-habits.el’), and
     encryption (‘org-crypt.el’).  Also, the capture system is really an
     extended copy of his great ‘remember.el’.
Sebastian Rose
     Without Sebastian, the HTML/XHTML publishing of Org would be the
     pitiful work of an ignorant amateur.  Sebastian has pushed this
     part of Org onto a much higher level.  He also wrote ‘org-info.js’,
     a Java script for displaying web pages derived from Org using an
     Info-like or a folding interface with single-key navigation.

See below for the full list of contributions!  Again, please let me know
what I am missing here!

B.2 From Bastien
================

I (Bastien) have been maintaining Org between 2011 and 2013.  This
appendix would not be complete without adding a few more acknowledgments
and thanks.

   I am first grateful to Carsten for his trust while handing me over
the maintainership of Org.  His unremitting support is what really
helped me getting more confident over time, with both the community and
the code.

   When I took over maintainership, I knew I would have to make Org more
collaborative than ever, as I would have to rely on people that are more
knowledgeable than I am on many parts of the code.  Here is a list of
the persons I could rely on, they should really be considered
co-maintainers, either of the code or the community:

Eric Schulte
     Eric is maintaining the Babel parts of Org.  His reactivity here
     kept me away from worrying about possible bugs here and let me
     focus on other parts.

Nicolas Goaziou
     Nicolas is maintaining the consistency of the deepest parts of Org.
     His work on ‘org-element.el’ and ‘ox.el’ has been outstanding, and
     it opened the doors for many new ideas and features.  He rewrote
     many of the old exporters to use the new export engine, and helped
     with documenting this major change.  More importantly (if that’s
     possible), he has been more than reliable during all the work done
     for Org 8.0, and always very reactive on the mailing list.

Achim Gratz
     Achim rewrote the building process of Org, turning some _ad hoc_
     tools into a flexible and conceptually clean process.  He patiently
     coped with the many hiccups that such a change can create for
     users.

Nick Dokos
     The Org mode mailing list would not be such a nice place without
     Nick, who patiently helped users so many times.  It is impossible
     to overestimate such a great help, and the list would not be so
     active without him.

   I received support from so many users that it is clearly impossible
to be fair when shortlisting a few of them, but Org’s history would not
be complete if the ones above were not mentioned in this manual.

B.3 List of contributions
=========================

   • Russel Adams came up with the idea for drawers.
   • Suvayu Ali has steadily helped on the mailing list, providing
     useful feedback on many features and several patches.
   • Luis Anaya wrote ‘ox-man.el’.
   • Thomas Baumann wrote ‘org-bbdb.el’ and ‘org-mhe.el’.
   • Michael Brand helped by reporting many bugs and testing many
     features.  He also implemented the distinction between empty fields
     and 0-value fields in Org’s spreadsheets.
   • Christophe Bataillon created the great unicorn logo that we use on
     the Org mode website.
   • Alex Bochannek provided a patch for rounding timestamps.
   • Jan Böcker wrote ‘org-docview.el’.
   • Brad Bozarth showed how to pull RSS feed data into Org mode files.
   • Tom Breton wrote ‘org-choose.el’.
   • Charles Cave’s suggestion sparked the implementation of templates
     for Remember, which are now templates for capture.
   • Pavel Chalmoviansky influenced the agenda treatment of items with
     specified time.
   • Gregory Chernov patched support for Lisp forms into table
     calculations and improved XEmacs compatibility, in particular by
     porting ‘nouline.el’ to XEmacs.
   • Sacha Chua suggested copying some linking code from Planner, and
     helped make Org popular through her blog.
   • Toby S. Cubitt contributed to the code for clock formats.
   • Baoqiu Cui contributed the first DocBook exporter.  In Org 8.0, we
     go a different route: you can now export to Texinfo and export the
     ‘.texi’ file to DocBook using ‘makeinfo’.
   • Eddward DeVilla proposed and tested checkbox statistics.  He also
     came up with the idea of properties, and that there should be an
     API for them.
   • Nick Dokos tracked down several nasty bugs.
   • Kees Dullemond used to edit projects lists directly in HTML and so
     inspired some of the early development, including HTML export.  He
     also asked for a way to narrow wide table columns.
   • Jason Dunsmore has been maintaining the Org-Mode server at
     Rackspace for several years now.  He also sponsored the hosting
     costs until Rackspace started to host us for free.
   • Thomas S. Dye contributed documentation on Worg and helped
     integrating the Org-Babel documentation into the manual.
   • Christian Egli converted the documentation into Texinfo format,
     inspired the agenda, patched CSS formatting into the HTML exporter,
     and wrote ‘org-taskjuggler.el’, which has been rewritten by Nicolas
     Goaziou as ‘ox-taskjuggler.el’ for Org 8.0.
   • David Emery provided a patch for custom CSS support in exported
     HTML agendas.
   • Sean Escriva took over MobileOrg development on the iPhone
     platform.
   • Nic Ferrier contributed mailcap and XOXO support.
   • Miguel A. Figueroa-Villanueva implemented hierarchical checkboxes.
   • John Foerch figured out how to make incremental search show context
     around a match in a hidden outline tree.
   • Raimar Finken wrote ‘org-git-line.el’.
   • Mikael Fornius works as a mailing list moderator.
   • Austin Frank works as a mailing list moderator.
   • Eric Fraga drove the development of BEAMER export with ideas and
     testing.
   • Barry Gidden did proofreading the manual in preparation for the
     book publication through Network Theory Ltd.
   • Niels Giesen had the idea to automatically archive DONE trees.
   • Nicolas Goaziou rewrote much of the plain list code.  He also wrote
     ‘org-element.el’ and ‘org-export.el’, which was a huge step forward
     in implementing a clean framework for Org exporters.
   • Kai Grossjohann pointed out key-binding conflicts with other
     packages.
   • Brian Gough of Network Theory Ltd publishes the Org mode manual as
     a book.
   • Bernt Hansen has driven much of the support for auto-repeating
     tasks, task state change logging, and the clocktable.  His clear
     explanations have been critical when we started to adopt the Git
     version control system.
   • Manuel Hermenegildo has contributed various ideas, small fixes and
     patches.
   • Phil Jackson wrote ‘org-irc.el’.
   • Scott Jaderholm proposed footnotes, control over whitespace between
     folded entries, and column view for properties.
   • Matt Jones wrote MobileOrg Android.
   • Tokuya Kameshima wrote ‘org-wl.el’ and ‘org-mew.el’.
   • Jonathan Leech-Pepin wrote ‘ox-texinfo.el’.
   • Shidai Liu ("Leo") asked for embedded LaTeX and tested it.  He also
     provided frequent feedback and some patches.
   • Matt Lundin has proposed last-row references for table formulas and
     named invisible anchors.  He has also worked a lot on the FAQ.
   • David Maus wrote ‘org-atom.el’, maintains the issues file for Org,
     and is a prolific contributor on the mailing list with competent
     replies, small fixes and patches.
   • Jason F. McBrayer suggested agenda export to CSV format.
   • Max Mikhanosha came up with the idea of refiling and sticky
     agendas.
   • Dmitri Minaev sent a patch to set priority limits on a per-file
     basis.
   • Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
     happy.
   • Richard Moreland wrote MobileOrg for the iPhone.
   • Rick Moynihan proposed allowing multiple TODO sequences in a file
     and being able to quickly restrict the agenda to a subtree.
   • Todd Neal provided patches for links to Info files and Elisp forms.
   • Greg Newman refreshed the unicorn logo into its current form.
   • Tim O’Callaghan suggested in-file links, search options for general
     file links, and TAGS.
   • Osamu Okano wrote ‘orgcard2ref.pl’, a Perl program to create a text
     version of the reference card.
   • Takeshi Okano translated the manual and David O’Toole’s tutorial
     into Japanese.
   • Oliver Oppitz suggested multi-state TODO items.
   • Scott Otterson sparked the introduction of descriptive text for
     links, among other things.
   • Pete Phillips helped during the development of the TAGS feature,
     and provided frequent feedback.
   • Francesco Pizzolante provided patches that helped speeding up the
     agenda generation.
   • Martin Pohlack provided the code snippet to bundle character
     insertion into bundles of 20 for undo.
   • Rackspace.com is hosting our website for free.  Thank you
     Rackspace!
   • T.V. Raman reported bugs and suggested improvements.
   • Matthias Rempe (Oelde) provided ideas, Windows support, and quality
     control.
   • Paul Rivier provided the basic implementation of named footnotes.
     He also acted as mailing list moderator for some time.
   • Kevin Rogers contributed code to access VM files on remote hosts.
   • Frank Ruell solved the mystery of the ‘keymapp nil’ bug, a conflict
     with ‘allout.el’.
   • Jason Riedy generalized the send-receive mechanism for Orgtbl
     tables with extensive patches.
   • Philip Rooke created the Org reference card, provided lots of
     feedback, developed and applied standards to the Org documentation.
   • Christian Schlauer proposed angular brackets around links, among
     other things.
   • Christopher Schmidt reworked ‘orgstruct-mode’ so that users can
     enjoy folding in non-org buffers by using Org headlines in
     comments.
   • Paul Sexton wrote ‘org-ctags.el’.
   • Linking to VM/BBDB/Gnus was first inspired by Tom Shannon’s
     ‘organizer-mode.el’.
   • Ilya Shlyakhter proposed the Archive Sibling, line numbering in
     literal examples, and remote highlighting for referenced code
     lines.
   • Stathis Sideris wrote the ‘ditaa.jar’ ASCII to PNG converter that
     is now packaged into Org’s ‘contrib’ directory.
   • Daniel Sinder came up with the idea of internal archiving by
     locking subtrees.
   • Dale Smith proposed link abbreviations.
   • James TD Smith has contributed a large number of patches for useful
     tweaks and features.
   • Adam Spiers asked for global linking commands, inspired the link
     extension system, added support for mairix, and proposed the
     mapping API.
   • Ulf Stegemann created the table to translate special symbols to
     HTML, LaTeX, UTF-8, Latin-1 and ASCII.
   • Andy Stewart contributed code to ‘org-w3m.el’, to copy HTML content
     with links transformation to Org syntax.
   • David O’Toole wrote ‘org-publish.el’ and drafted the manual chapter
     about publishing.
   • Jambunathan K contributed the ODT exporter and rewrote the HTML
     exporter.
   • Sebastien Vauban reported many issues with LaTeX and BEAMER export
     and enabled source code highlighting in Gnus.
   • Stefan Vollmar organized a video-recorded talk at the
     Max-Planck-Institute for Neurology.  He also inspired the creation
     of a concept index for HTML export.
   • Jürgen Vollmer contributed code generating the table of contents in
     HTML output.
   • Samuel Wales has provided important feedback and bug reports.
   • Chris Wallace provided a patch implementing the ‘QUOTE’ keyword.
   • David Wainberg suggested archiving, and improvements to the linking
     system.
   • Carsten Wimmer suggested some changes and helped fix a bug in
     linking to Gnus.
   • Roland Winkler requested additional key bindings to make Org work
     on a tty.
   • Piotr Zielinski wrote ‘org-mouse.el’, proposed agenda blocks and
     contributed various ideas and code snippets.
   • Marco Wahl wrote ‘org-eww.el’.


File: org.info,  Node: GNU Free Documentation License,  Next: Main Index,  Prev: History and acknowledgments,  Up: Top

Appendix C GNU Free Documentation License
*****************************************

                     Version 1.3, 3 November 2008

     Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
     <https://fsf.org/>

     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.

  0. PREAMBLE

     The purpose of this License is to make a manual, textbook, or other
     functional and useful document “free” in the sense of freedom: to
     assure everyone the effective freedom to copy and redistribute it,
     with or without modifying it, either commercially or
     noncommercially.  Secondarily, this License preserves for the
     author and publisher a way to get credit for their work, while not
     being considered responsible for modifications made by others.

     This License is a kind of “copyleft”, which means that derivative
     works of the document must themselves be free in the same sense.
     It complements the GNU General Public License, which is a copyleft
     license designed for free software.

     We have designed this License in order to use it for manuals for
     free software, because free software needs free documentation: a
     free program should come with manuals providing the same freedoms
     that the software does.  But this License is not limited to
     software manuals; it can be used for any textual work, regardless
     of subject matter or whether it is published as a printed book.  We
     recommend this License principally for works whose purpose is
     instruction or reference.

  1. APPLICABILITY AND DEFINITIONS

     This License applies to any manual or other work, in any medium,
     that contains a notice placed by the copyright holder saying it can
     be distributed under the terms of this License.  Such a notice
     grants a world-wide, royalty-free license, unlimited in duration,
     to use that work under the conditions stated herein.  The
     “Document”, below, refers to any such manual or work.  Any member
     of the public is a licensee, and is addressed as “you”.  You accept
     the license if you copy, modify or distribute the work in a way
     requiring permission under copyright law.

     A “Modified Version” of the Document means any work containing the
     Document or a portion of it, either copied verbatim, or with
     modifications and/or translated into another language.

     A “Secondary Section” is a named appendix or a front-matter section
     of the Document that deals exclusively with the relationship of the
     publishers or authors of the Document to the Document’s overall
     subject (or to related matters) and contains nothing that could
     fall directly within that overall subject.  (Thus, if the Document
     is in part a textbook of mathematics, a Secondary Section may not
     explain any mathematics.)  The relationship could be a matter of
     historical connection with the subject or with related matters, or
     of legal, commercial, philosophical, ethical or political position
     regarding them.

     The “Invariant Sections” are certain Secondary Sections whose
     titles are designated, as being those of Invariant Sections, in the
     notice that says that the Document is released under this License.
     If a section does not fit the above definition of Secondary then it
     is not allowed to be designated as Invariant.  The Document may
     contain zero Invariant Sections.  If the Document does not identify
     any Invariant Sections then there are none.

     The “Cover Texts” are certain short passages of text that are
     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
     that says that the Document is released under this License.  A
     Front-Cover Text may be at most 5 words, and a Back-Cover Text may
     be at most 25 words.

     A “Transparent” copy of the Document means a machine-readable copy,
     represented in a format whose specification is available to the
     general public, that is suitable for revising the document
     straightforwardly with generic text editors or (for images composed
     of pixels) generic paint programs or (for drawings) some widely
     available drawing editor, and that is suitable for input to text
     formatters or for automatic translation to a variety of formats
     suitable for input to text formatters.  A copy made in an otherwise
     Transparent file format whose markup, or absence of markup, has
     been arranged to thwart or discourage subsequent modification by
     readers is not Transparent.  An image format is not Transparent if
     used for any substantial amount of text.  A copy that is not
     “Transparent” is called “Opaque”.

     Examples of suitable formats for Transparent copies include plain
     ASCII without markup, Texinfo input format, LaTeX input format,
     SGML or XML using a publicly available DTD, and standard-conforming
     simple HTML, PostScript or PDF designed for human modification.
     Examples of transparent image formats include PNG, XCF and JPG.
     Opaque formats include proprietary formats that can be read and
     edited only by proprietary word processors, SGML or XML for which
     the DTD and/or processing tools are not generally available, and
     the machine-generated HTML, PostScript or PDF produced by some word
     processors for output purposes only.

     The “Title Page” means, for a printed book, the title page itself,
     plus such following pages as are needed to hold, legibly, the
     material this License requires to appear in the title page.  For
     works in formats which do not have any title page as such, “Title
     Page” means the text near the most prominent appearance of the
     work’s title, preceding the beginning of the body of the text.

     The “publisher” means any person or entity that distributes copies
     of the Document to the public.

     A section “Entitled XYZ” means a named subunit of the Document
     whose title either is precisely XYZ or contains XYZ in parentheses
     following text that translates XYZ in another language.  (Here XYZ
     stands for a specific section name mentioned below, such as
     “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.)
     To “Preserve the Title” of such a section when you modify the
     Document means that it remains a section “Entitled XYZ” according
     to this definition.

     The Document may include Warranty Disclaimers next to the notice
     which states that this License applies to the Document.  These
     Warranty Disclaimers are considered to be included by reference in
     this License, but only as regards disclaiming warranties: any other
     implication that these Warranty Disclaimers may have is void and
     has no effect on the meaning of this License.

  2. VERBATIM COPYING

     You may copy and distribute the Document in any medium, either
     commercially or noncommercially, provided that this License, the
     copyright notices, and the license notice saying this License
     applies to the Document are reproduced in all copies, and that you
     add no other conditions whatsoever to those of this License.  You
     may not use technical measures to obstruct or control the reading
     or further copying of the copies you make or distribute.  However,
     you may accept compensation in exchange for copies.  If you
     distribute a large enough number of copies you must also follow the
     conditions in section 3.

     You may also lend copies, under the same conditions stated above,
     and you may publicly display copies.

  3. COPYING IN QUANTITY

     If you publish printed copies (or copies in media that commonly
     have printed covers) of the Document, numbering more than 100, and
     the Document’s license notice requires Cover Texts, you must
     enclose the copies in covers that carry, clearly and legibly, all
     these Cover Texts: Front-Cover Texts on the front cover, and
     Back-Cover Texts on the back cover.  Both covers must also clearly
     and legibly identify you as the publisher of these copies.  The
     front cover must present the full title with all words of the title
     equally prominent and visible.  You may add other material on the
     covers in addition.  Copying with changes limited to the covers, as
     long as they preserve the title of the Document and satisfy these
     conditions, can be treated as verbatim copying in other respects.

     If the required texts for either cover are too voluminous to fit
     legibly, you should put the first ones listed (as many as fit
     reasonably) on the actual cover, and continue the rest onto
     adjacent pages.

     If you publish or distribute Opaque copies of the Document
     numbering more than 100, you must either include a machine-readable
     Transparent copy along with each Opaque copy, or state in or with
     each Opaque copy a computer-network location from which the general
     network-using public has access to download using public-standard
     network protocols a complete Transparent copy of the Document, free
     of added material.  If you use the latter option, you must take
     reasonably prudent steps, when you begin distribution of Opaque
     copies in quantity, to ensure that this Transparent copy will
     remain thus accessible at the stated location until at least one
     year after the last time you distribute an Opaque copy (directly or
     through your agents or retailers) of that edition to the public.

     It is requested, but not required, that you contact the authors of
     the Document well before redistributing any large number of copies,
     to give them a chance to provide you with an updated version of the
     Document.

  4. MODIFICATIONS

     You may copy and distribute a Modified Version of the Document
     under the conditions of sections 2 and 3 above, provided that you
     release the Modified Version under precisely this License, with the
     Modified Version filling the role of the Document, thus licensing
     distribution and modification of the Modified Version to whoever
     possesses a copy of it.  In addition, you must do these things in
     the Modified Version:

       A. Use in the Title Page (and on the covers, if any) a title
          distinct from that of the Document, and from those of previous
          versions (which should, if there were any, be listed in the
          History section of the Document).  You may use the same title
          as a previous version if the original publisher of that
          version gives permission.

       B. List on the Title Page, as authors, one or more persons or
          entities responsible for authorship of the modifications in
          the Modified Version, together with at least five of the
          principal authors of the Document (all of its principal
          authors, if it has fewer than five), unless they release you
          from this requirement.

       C. State on the Title page the name of the publisher of the
          Modified Version, as the publisher.

       D. Preserve all the copyright notices of the Document.

       E. Add an appropriate copyright notice for your modifications
          adjacent to the other copyright notices.

       F. Include, immediately after the copyright notices, a license
          notice giving the public permission to use the Modified
          Version under the terms of this License, in the form shown in
          the Addendum below.

       G. Preserve in that license notice the full lists of Invariant
          Sections and required Cover Texts given in the Document’s
          license notice.

       H. Include an unaltered copy of this License.

       I. Preserve the section Entitled “History”, Preserve its Title,
          and add to it an item stating at least the title, year, new
          authors, and publisher of the Modified Version as given on the
          Title Page.  If there is no section Entitled “History” in the
          Document, create one stating the title, year, authors, and
          publisher of the Document as given on its Title Page, then add
          an item describing the Modified Version as stated in the
          previous sentence.

       J. Preserve the network location, if any, given in the Document
          for public access to a Transparent copy of the Document, and
          likewise the network locations given in the Document for
          previous versions it was based on.  These may be placed in the
          “History” section.  You may omit a network location for a work
          that was published at least four years before the Document
          itself, or if the original publisher of the version it refers
          to gives permission.

       K. For any section Entitled “Acknowledgements” or “Dedications”,
          Preserve the Title of the section, and preserve in the section
          all the substance and tone of each of the contributor
          acknowledgements and/or dedications given therein.

       L. Preserve all the Invariant Sections of the Document, unaltered
          in their text and in their titles.  Section numbers or the
          equivalent are not considered part of the section titles.

       M. Delete any section Entitled “Endorsements”.  Such a section
          may not be included in the Modified Version.

       N. Do not retitle any existing section to be Entitled
          “Endorsements” or to conflict in title with any Invariant
          Section.

       O. Preserve any Warranty Disclaimers.

     If the Modified Version includes new front-matter sections or
     appendices that qualify as Secondary Sections and contain no
     material copied from the Document, you may at your option designate
     some or all of these sections as invariant.  To do this, add their
     titles to the list of Invariant Sections in the Modified Version’s
     license notice.  These titles must be distinct from any other
     section titles.

     You may add a section Entitled “Endorsements”, provided it contains
     nothing but endorsements of your Modified Version by various
     parties—for example, statements of peer review or that the text has
     been approved by an organization as the authoritative definition of
     a standard.

     You may add a passage of up to five words as a Front-Cover Text,
     and a passage of up to 25 words as a Back-Cover Text, to the end of
     the list of Cover Texts in the Modified Version.  Only one passage
     of Front-Cover Text and one of Back-Cover Text may be added by (or
     through arrangements made by) any one entity.  If the Document
     already includes a cover text for the same cover, previously added
     by you or by arrangement made by the same entity you are acting on
     behalf of, you may not add another; but you may replace the old
     one, on explicit permission from the previous publisher that added
     the old one.

     The author(s) and publisher(s) of the Document do not by this
     License give permission to use their names for publicity for or to
     assert or imply endorsement of any Modified Version.

  5. COMBINING DOCUMENTS

     You may combine the Document with other documents released under
     this License, under the terms defined in section 4 above for
     modified versions, provided that you include in the combination all
     of the Invariant Sections of all of the original documents,
     unmodified, and list them all as Invariant Sections of your
     combined work in its license notice, and that you preserve all
     their Warranty Disclaimers.

     The combined work need only contain one copy of this License, and
     multiple identical Invariant Sections may be replaced with a single
     copy.  If there are multiple Invariant Sections with the same name
     but different contents, make the title of each such section unique
     by adding at the end of it, in parentheses, the name of the
     original author or publisher of that section if known, or else a
     unique number.  Make the same adjustment to the section titles in
     the list of Invariant Sections in the license notice of the
     combined work.

     In the combination, you must combine any sections Entitled
     “History” in the various original documents, forming one section
     Entitled “History”; likewise combine any sections Entitled
     “Acknowledgements”, and any sections Entitled “Dedications”.  You
     must delete all sections Entitled “Endorsements.”

  6. COLLECTIONS OF DOCUMENTS

     You may make a collection consisting of the Document and other
     documents released under this License, and replace the individual
     copies of this License in the various documents with a single copy
     that is included in the collection, provided that you follow the
     rules of this License for verbatim copying of each of the documents
     in all other respects.

     You may extract a single document from such a collection, and
     distribute it individually under this License, provided you insert
     a copy of this License into the extracted document, and follow this
     License in all other respects regarding verbatim copying of that
     document.

  7. AGGREGATION WITH INDEPENDENT WORKS

     A compilation of the Document or its derivatives with other
     separate and independent documents or works, in or on a volume of a
     storage or distribution medium, is called an “aggregate” if the
     copyright resulting from the compilation is not used to limit the
     legal rights of the compilation’s users beyond what the individual
     works permit.  When the Document is included in an aggregate, this
     License does not apply to the other works in the aggregate which
     are not themselves derivative works of the Document.

     If the Cover Text requirement of section 3 is applicable to these
     copies of the Document, then if the Document is less than one half
     of the entire aggregate, the Document’s Cover Texts may be placed
     on covers that bracket the Document within the aggregate, or the
     electronic equivalent of covers if the Document is in electronic
     form.  Otherwise they must appear on printed covers that bracket
     the whole aggregate.

  8. TRANSLATION

     Translation is considered a kind of modification, so you may
     distribute translations of the Document under the terms of section
     4.  Replacing Invariant Sections with translations requires special
     permission from their copyright holders, but you may include
     translations of some or all Invariant Sections in addition to the
     original versions of these Invariant Sections.  You may include a
     translation of this License, and all the license notices in the
     Document, and any Warranty Disclaimers, provided that you also
     include the original English version of this License and the
     original versions of those notices and disclaimers.  In case of a
     disagreement between the translation and the original version of
     this License or a notice or disclaimer, the original version will
     prevail.

     If a section in the Document is Entitled “Acknowledgements”,
     “Dedications”, or “History”, the requirement (section 4) to
     Preserve its Title (section 1) will typically require changing the
     actual title.

  9. TERMINATION

     You may not copy, modify, sublicense, or distribute the Document
     except as expressly provided under this License.  Any attempt
     otherwise to copy, modify, sublicense, or distribute it is void,
     and will automatically terminate your rights under this License.

     However, if you cease all violation of this License, then your
     license from a particular copyright holder is reinstated (a)
     provisionally, unless and until the copyright holder explicitly and
     finally terminates your license, and (b) permanently, if the
     copyright holder fails to notify you of the violation by some
     reasonable means prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
     reinstated permanently if the copyright holder notifies you of the
     violation by some reasonable means, this is the first time you have
     received notice of violation of this License (for any work) from
     that copyright holder, and you cure the violation prior to 30 days
     after your receipt of the notice.

     Termination of your rights under this section does not terminate
     the licenses of parties who have received copies or rights from you
     under this License.  If your rights have been terminated and not
     permanently reinstated, receipt of a copy of some or all of the
     same material does not give you any rights to use it.

  10. FUTURE REVISIONS OF THIS LICENSE

     The Free Software Foundation may publish new, revised versions of
     the GNU Free Documentation License from time to time.  Such new
     versions will be similar in spirit to the present version, but may
     differ in detail to address new problems or concerns.  See
     <https://www.gnu.org/licenses/>.

     Each version of the License is given a distinguishing version
     number.  If the Document specifies that a particular numbered
     version of this License “or any later version” applies to it, you
     have the option of following the terms and conditions either of
     that specified version or of any later version that has been
     published (not as a draft) by the Free Software Foundation.  If the
     Document does not specify a version number of this License, you may
     choose any version ever published (not as a draft) by the Free
     Software Foundation.  If the Document specifies that a proxy can
     decide which future versions of this License can be used, that
     proxy’s public statement of acceptance of a version permanently
     authorizes you to choose that version for the Document.

  11. RELICENSING

     “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
     World Wide Web server that publishes copyrightable works and also
     provides prominent facilities for anybody to edit those works.  A
     public wiki that anybody can edit is an example of such a server.
     A “Massive Multiauthor Collaboration” (or “MMC”) contained in the
     site means any set of copyrightable works thus published on the MMC
     site.

     “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
     license published by Creative Commons Corporation, a not-for-profit
     corporation with a principal place of business in San Francisco,
     California, as well as future copyleft versions of that license
     published by that same organization.

     “Incorporate” means to publish or republish a Document, in whole or
     in part, as part of another Document.

     An MMC is “eligible for relicensing” if it is licensed under this
     License, and if all works that were first published under this
     License somewhere other than this MMC, and subsequently
     incorporated in whole or in part into the MMC, (1) had no cover
     texts or invariant sections, and (2) were thus incorporated prior
     to November 1, 2008.

     The operator of an MMC Site may republish an MMC contained in the
     site under CC-BY-SA on the same site at any time before August 1,
     2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents
====================================================

To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and license
notices just after the title page:

       Copyright (C)  YEAR  YOUR NAME.
       Permission is granted to copy, distribute and/or modify this document
       under the terms of the GNU Free Documentation License, Version 1.3
       or any later version published by the Free Software Foundation;
       with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
       Texts.  A copy of the license is included in the section entitled ``GNU
       Free Documentation License''.

   If you have Invariant Sections, Front-Cover Texts and Back-Cover
Texts, replace the “with...Texts.” line with this:

         with the Invariant Sections being LIST THEIR TITLES, with
         the Front-Cover Texts being LIST, and with the Back-Cover Texts
         being LIST.

   If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.

   If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit
their use in free software.


File: org.info,  Node: Main Index,  Next: Key Index,  Prev: GNU Free Documentation License,  Up: Top

Concept index
*************

[index]
* Menu:

* #+ARCHIVE:                             Moving subtrees.     (line  33)
* #+ASCII:                               ASCII/Latin-1/UTF-8 export.
                                                              (line  56)
* #+ATTR_ASCII:                          ASCII/Latin-1/UTF-8 export.
                                                              (line  67)
* #+ATTR_BEAMER:                         Beamer specific syntax.
                                                              (line  35)
* #+ATTR_HTML:                           Links in HTML export.
                                                              (line  27)
* #+ATTR_HTML <1>:                       Tables in HTML export.
                                                              (line  11)
* #+ATTR_HTML <2>:                       Images in HTML export.
                                                              (line  29)
* #+ATTR_LATEX, in example blocks:       Example blocks in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in horizontal rules:     Horizontal rules in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in images:               Images in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in plain lists:          Plain lists in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in source blocks:        Source blocks in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in special blocks:       Special blocks in LaTeX export.
                                                              (line   6)
* #+ATTR_LATEX, in tables:               Tables in LaTeX export.
                                                              (line   6)
* #+ATTR_ODT:                            Tables in ODT export.
                                                              (line  20)
* #+ATTR_ODT <1>:                        Images in ODT export.
                                                              (line  31)
* #+ATTR_ODT <2>:                        Images in ODT export.
                                                              (line  76)
* #+ATTR_ODT <3>:                        Customizing tables in ODT export.
                                                              (line   6)
* #+ATTR_TEXINFO, in images:             Images in Texinfo export.
                                                              (line   6)
* #+ATTR_TEXINFO, in plain lists:        Plain lists in Texinfo export.
                                                              (line   6)
* #+ATTR_TEXINFO, in special blocks:     Special blocks in Texinfo export.
                                                              (line   6)
* #+ATTR_TEXINFO, in tables:             Tables in Texinfo export.
                                                              (line   6)
* #+AUTHOR:                              Export settings.     (line  25)
* #+BEAMER:                              Beamer specific syntax.
                                                              (line  19)
* #+BEAMER_FONT_THEME:                   Beamer specific export settings.
                                                              (line  16)
* #+BEAMER_HEADER:                       Beamer specific export settings.
                                                              (line  25)
* #+BEAMER_INNER_THEME:                  Beamer specific export settings.
                                                              (line  19)
* #+BEAMER_OUTER_THEME:                  Beamer specific export settings.
                                                              (line  22)
* #+BEAMER_THEME:                        Beamer specific export settings.
                                                              (line  11)
* #+BEGIN, clocktable:                   The clock table.     (line  32)
* #+BEGIN, columnview:                   Capturing column view.
                                                              (line  11)
* #+BEGIN, dynamic block:                Dynamic blocks.      (line  15)
* #+BEGIN_CENTER:                        Paragraphs.          (line  31)
* #+BEGIN_COMMENT:                       Comment lines.       (line  10)
* #+BEGIN_EXAMPLE:                       Literal examples.    (line   8)
* #+BEGIN_EXPORT ascii:                  ASCII/Latin-1/UTF-8 export.
                                                              (line  56)
* #+BEGIN_EXPORT beamer:                 Beamer specific syntax.
                                                              (line  19)
* #+BEGIN_EXPORT html:                   Quoting HTML tags.   (line  14)
* #+BEGIN_EXPORT latex:                  Quoting LaTeX code.  (line  17)
* #+BEGIN_EXPORT texinfo:                Quoting Texinfo code.
                                                              (line   9)
* #+BEGIN_JUSTIFYLEFT:                   ASCII/Latin-1/UTF-8 export.
                                                              (line  77)
* #+BEGIN_JUSTIFYRIGHT:                  ASCII/Latin-1/UTF-8 export.
                                                              (line  77)
* #+BEGIN_QUOTE:                         Paragraphs.          (line  26)
* #+BEGIN_SRC:                           Literal examples.    (line  28)
* #+BEGIN_SRC <1>:                       Structure of code blocks.
                                                              (line   6)
* #+BEGIN_VERSE:                         Paragraphs.          (line  13)
* #+BIND:                                Export settings.     (line 210)
* #+CALL:                                Evaluating code blocks.
                                                              (line  25)
* #+CAPTION:                             Images and tables.   (line   6)
* #+CAPTION <1>:                         Tables in HTML export.
                                                              (line  11)
* #+CAPTION <2>:                         Images in HTML export.
                                                              (line  29)
* #+CATEGORY:                            Categories.          (line   6)
* #+CINDEX:                              Indices.             (line   6)
* #+COLUMNS:                             Scope of column definitions.
                                                              (line   8)
* #+CONSTANTS:                           References.          (line 108)
* #+CREATOR:                             Export settings.     (line  28)
* #+DATE:                                Export settings.     (line  32)
* #+DESCRIPTION (Beamer):                Beamer specific export settings.
                                                              (line  29)
* #+DESCRIPTION (HTML):                  HTML Specific export settings.
                                                              (line  10)
* #+DESCRIPTION (LaTeX):                 LaTeX specific export settings.
                                                              (line  11)
* #+DESCRIPTION (ODT):                   ODT specific export settings.
                                                              (line  11)
* #+EMAIL:                               Export settings.     (line  35)
* #+EXCLUDE_TAGS:                        Export settings.     (line  52)
* #+EXPORT_FILE_NAME:                    Export settings.     (line  64)
* #+FILETAGS:                            Tag inheritance.     (line  20)
* #+FINDEX:                              Indices.             (line   6)
* #+HEADER::                             Code block specific header arguments.
                                                              (line  30)
* #+HTML:                                Quoting HTML tags.   (line  12)
* #+HTML_CONTAINER:                      HTML Specific export settings.
                                                              (line  19)
* #+HTML_DOCTYPE:                        HTML Specific export settings.
                                                              (line  16)
* #+HTML_HEAD:                           HTML Specific export settings.
                                                              (line  35)
* #+HTML_HEAD <1>:                       CSS support.         (line  48)
* #+HTML_HEAD_EXTRA:                     HTML Specific export settings.
                                                              (line  39)
* #+HTML_HEAD_EXTRA <1>:                 CSS support.         (line  48)
* #+HTML_INCLUDE_STYLE:                  CSS support.         (line  43)
* #+HTML_LINK_HOME:                      HTML Specific export settings.
                                                              (line  23)
* #+HTML_LINK_UP:                        HTML Specific export settings.
                                                              (line  26)
* #+HTML_MATHJAX:                        HTML Specific export settings.
                                                              (line  30)
* #+INCLUDE:                             Include files.       (line   7)
* #+INDEX:                               Generating an index. (line  16)
* #+INFOJS_OPT:                          JavaScript support.  (line  20)
* #+KEYWORDS (Beamer):                   Beamer specific export settings.
                                                              (line  36)
* #+KEYWORDS (HTML):                     HTML Specific export settings.
                                                              (line  43)
* #+KEYWORDS (LaTeX):                    LaTeX specific export settings.
                                                              (line  46)
* #+KEYWORDS (ODT):                      ODT specific export settings.
                                                              (line  16)
* #+KINDEX:                              Indices.             (line   6)
* #+LANGUAGE:                            Export settings.     (line  38)
* #+LATEX:                               Quoting LaTeX code.  (line  13)
* #+LATEX_CLASS:                         LaTeX specific export settings.
                                                              (line  20)
* #+LATEX_CLASS <1>:                     LaTeX header and sectioning.
                                                              (line  23)
* #+LATEX_CLASS_OPTIONS:                 LaTeX specific export settings.
                                                              (line  28)
* #+LATEX_CLASS_OPTIONS <1>:             LaTeX header and sectioning.
                                                              (line  23)
* #+LATEX_COMPILER:                      LaTeX specific export settings.
                                                              (line  32)
* #+LATEX_HEADER:                        LaTeX specific export settings.
                                                              (line  36)
* #+LATEX_HEADER <1>:                    LaTeX header and sectioning.
                                                              (line  30)
* #+LATEX_HEADER (HTML):                 HTML Specific export settings.
                                                              (line  48)
* #+LATEX_HEADER_EXTRA:                  LaTeX specific export settings.
                                                              (line  41)
* #+LATEX_HEADER_EXTRA <1>:              LaTeX header and sectioning.
                                                              (line  30)
* #+LINK:                                Link abbreviations.  (line  49)
* #+MACRO:                               Macro replacement.   (line   6)
* #+NAME:                                Internal links.      (line  21)
* #+NAME <1>:                            Images and tables.   (line   6)
* #+NAME <2>:                            Structure of code blocks.
                                                              (line   6)
* #+NAME <3>:                            Structure of code blocks.
                                                              (line  39)
* #+NAME, for table:                     References.          (line 129)
* #+ODT_STYLES_FILE:                     Applying custom styles.
                                                              (line  25)
* #+OPTIONS:                             Export settings.     (line   6)
* #+ORGLST:                              Radio lists.         (line  11)
* #+ORGTBL:                              Radio tables.        (line  19)
* #+ORGTBL, SEND:                        A LaTeX example.     (line  12)
* #+PINDEX:                              Indices.             (line   6)
* #+PLOT:                                Org-Plot.            (line   6)
* #+PRIORITIES:                          Priorities.          (line  42)
* #+PROPERTY:                            Property syntax.     (line  44)
* #+RESULTS:                             Evaluating code blocks.
                                                              (line   6)
* #+SELECT_TAGS:                         Export settings.     (line  44)
* #+SEQ_TODO:                            Per-file keywords.   (line   6)
* #+SETUPFILE:                           Export settings.     (line  13)
* #+SETUPFILE <1>:                       In-buffer settings.  (line  45)
* #+STARTUP:                             In-buffer settings.  (line  58)
* #+SUBAUTHOR:                           Texinfo specific export settings.
                                                              (line  14)
* #+SUBAUTHOR <1>:                       Texinfo title and copyright page.
                                                              (line  12)
* #+SUBTITLE (ASCII):                    ASCII/Latin-1/UTF-8 export.
                                                              (line  39)
* #+SUBTITLE (Beamer):                   Beamer specific export settings.
                                                              (line  44)
* #+SUBTITLE (HTML):                     HTML Specific export settings.
                                                              (line  53)
* #+SUBTITLE (LaTeX):                    LaTeX specific export settings.
                                                              (line  55)
* #+SUBTITLE (Texinfo):                  Texinfo specific export settings.
                                                              (line  11)
* #+TAGS:                                Setting tags.        (line  28)
* #+TBLFM:                               Field and range formulas.
                                                              (line  12)
* #+TBLFM <1>:                           Editing and debugging formulas.
                                                              (line  84)
* #+TBLFM <2>:                           In-buffer settings.  (line 166)
* #+TBLFM line, multiple:                Editing and debugging formulas.
                                                              (line  84)
* #+TBLFM, switching:                    Editing and debugging formulas.
                                                              (line  84)
* #+TEXINFO:                             Quoting Texinfo code.
                                                              (line   9)
* #+TEXINFO_CLASS:                       Texinfo specific export settings.
                                                              (line  20)
* #+TEXINFO_CLASS <1>:                   Texinfo file header. (line  11)
* #+TEXINFO_CLASS <2>:                   Headings and sectioning structure.
                                                              (line   6)
* #+TEXINFO_DIR_CATEGORY:                Texinfo specific export settings.
                                                              (line  30)
* #+TEXINFO_DIR_CATEGORY <1>:            Info directory file. (line   6)
* #+TEXINFO_DIR_DESC:                    Texinfo specific export settings.
                                                              (line  36)
* #+TEXINFO_DIR_DESC <1>:                Info directory file. (line   6)
* #+TEXINFO_DIR_TITLE:                   Texinfo specific export settings.
                                                              (line  33)
* #+TEXINFO_DIR_TITLE <1>:               Info directory file. (line   6)
* #+TEXINFO_FILENAME:                    Texinfo specific export settings.
                                                              (line  17)
* #+TEXINFO_FILENAME <1>:                Texinfo file header. (line   6)
* #+TEXINFO_HEADER:                      Texinfo specific export settings.
                                                              (line  24)
* #+TEXINFO_HEADER <1>:                  Texinfo file header. (line  11)
* #+TEXINFO_POST_HEADER:                 Texinfo specific export settings.
                                                              (line  27)
* #+TEXINFO_PRINTED_TITLE:               Texinfo specific export settings.
                                                              (line  39)
* #+TEXINFO_PRINTED_TITLE <1>:           Texinfo title and copyright page.
                                                              (line   6)
* #+TINDEX:                              Indices.             (line   6)
* #+TITLE:                               Export settings.     (line  60)
* #+TOC:                                 Table of contents.   (line   6)
* #+TODO:                                Per-file keywords.   (line   6)
* #+TYP_TODO:                            Per-file keywords.   (line   6)
* #+VINDEX:                              Indices.             (line   6)
* %:annotation template expansion in capture: capture protocol.
                                                              (line  23)
* %:description template expansion in capture: capture protocol.
                                                              (line  23)
* %:link template expansion in capture:  capture protocol.    (line  23)
* :base-url property in open-source protocol: open-source protocol.
                                                              (line  13)
* :cache, src header argument:           System-wide header arguments.
                                                              (line   9)
* :cache, src header argument <1>:       cache.               (line   6)
* :colnames, src header argument:        colnames.            (line   6)
* :comments, src header argument:        comments.            (line   6)
* :dir, src header argument:             dir.                 (line   6)
* :epilogue, src header argument:        epilogue.            (line   6)
* :eval, src header argument:            eval.                (line   6)
* :exports, src header argument:         Exporting code blocks.
                                                              (line  20)
* :exports, src header argument <1>:     System-wide header arguments.
                                                              (line   9)
* :exports, src header argument <2>:     exports.             (line   6)
* :file, src header argument:            file.                (line   6)
* :file-ext, src header argument:        file-ext.            (line   6)
* :hlines, src header argument:          hlines.              (line   6)
* :indic attribute, in Texinfo export:   Plain lists in Texinfo export.
                                                              (line  12)
* :mkdirp, src header argument:          mkdirp.              (line   6)
* :no-expand, src header argument:       no-expand.           (line   6)
* :noweb, src header argument:           System-wide header arguments.
                                                              (line   9)
* :noweb, src header argument <1>:       noweb.               (line   6)
* :noweb-ref, src header argument:       noweb-ref.           (line   6)
* :noweb-sep, src header argument:       noweb-sep.           (line   6)
* :online-suffix property in open-source protocol: open-source protocol.
                                                              (line  13)
* :output-dir, src header argument:      output-dir.          (line   6)
* :padline, src header argument:         padline.             (line   6)
* :post, src header argument:            post.                (line   6)
* :prologue, src header argument:        prologue.            (line   6)
* :results, src header argument:         System-wide header arguments.
                                                              (line   9)
* :results, src header argument <1>:     results.             (line   6)
* :results, src header argument <2>:     Results of evaluation.
                                                              (line  33)
* :results, src header argument <3>:     Results of evaluation.
                                                              (line  45)
* :results, src header argument <4>:     Results of evaluation.
                                                              (line  55)
* :results, src header argument <5>:     Results of evaluation.
                                                              (line  72)
* :rewrites property in open-source protocol: open-source protocol.
                                                              (line  43)
* :rownames, src header argument:        rownames.            (line   6)
* :sep attribute, in Texinfo export:     Plain lists in Texinfo export.
                                                              (line  17)
* :sep, src header argument:             sep.                 (line   6)
* :session, src header argument:         System-wide header arguments.
                                                              (line   9)
* :session, src header argument <1>:     session.             (line   6)
* :shebang, src header argument:         shebang.             (line   6)
* :table-type attribute, in Texinfo export: Plain lists in Texinfo export.
                                                              (line   6)
* :tangle, src header argument:          Extracting source code.
                                                              (line  23)
* :tangle, src header argument <1>:      tangle.              (line   6)
* :tangle-mode, src header argument:     tangle-mode.         (line   6)
* :var, src header argument:             var.                 (line   6)
* :working-directory property in open-source protocol: open-source protocol.
                                                              (line  13)
* :working-suffix property in open-source protocol: open-source protocol.
                                                              (line  13)
* :wrap, src header argument:            wrap.                (line   6)
* abbreviation, links:                   Link abbreviations.  (line   6)
* abstract, in LaTeX export:             Special blocks in LaTeX export.
                                                              (line   6)
* acknowledgments:                       History and acknowledgments.
                                                              (line   6)
* action, for publishing:                Publishing action.   (line   6)
* activation:                            Activation.          (line   6)
* active region:                         Structure editing.   (line 116)
* active region <1>:                     Built-in table editor.
                                                              (line 145)
* active region <2>:                     ODT export commands. (line   6)
* add-on packages:                       Add-on packages.     (line   6)
* add-ons, context-sensitive commands:   Context-sensitive commands.
                                                              (line   6)
* agenda:                                Weekly/daily agenda. (line   6)
* agenda dispatcher:                     Agenda dispatcher.   (line   6)
* agenda files:                          Agenda files.        (line   6)
* agenda files, removing buffers:        Agenda commands.     (line 440)
* agenda views:                          Agenda views.        (line   6)
* agenda views, custom:                  Custom agenda views. (line   6)
* agenda views, exporting:               Agenda commands.     (line 426)
* agenda views, exporting <1>:           Exporting agenda views.
                                                              (line   6)
* agenda views, exporting <2>:           Exporting agenda views.
                                                              (line  13)
* agenda views, main example:            Storing searches.    (line   9)
* agenda views, optimization:            Speeding up your agendas.
                                                              (line   6)
* agenda views, user-defined:            Special agenda views.
                                                              (line   6)
* agenda*, as an agenda views:           Storing searches.    (line   9)
* agenda, as an agenda views:            Storing searches.    (line   9)
* agenda, column view:                   Agenda column view.  (line   6)
* agenda, pipe:                          Extracting agenda information.
                                                              (line   6)
* agenda, sticky:                        Agenda dispatcher.   (line  43)
* agenda, with block views:              Block agenda.        (line   6)
* align, STARTUP keyword:                In-buffer settings.  (line  79)
* alignment in tables:                   Column width and alignment.
                                                              (line   6)
* anniversaries, from BBDB:              Weekly/daily agenda. (line  79)
* API, for mapping:                      Using the mapping API.
                                                              (line   6)
* API, for properties:                   Property API.        (line   6)
* API, for properties <1>:               Using the property API.
                                                              (line   6)
* appointment:                           Timestamps.          (line  14)
* appointment <1>:                       Weekly/daily agenda. (line 126)
* appointment reminders:                 Weekly/daily agenda. (line 126)
* appt.el:                               Weekly/daily agenda. (line 126)
* archive locations:                     Moving subtrees.     (line  23)
* archive tag:                           Internal archiving.  (line   6)
* archived entries, in agenda views:     Agenda views.        (line  32)
* Archives mode:                         Agenda commands.     (line 115)
* archiving:                             Archiving.           (line   6)
* ASCII export:                          ASCII/Latin-1/UTF-8 export.
                                                              (line   6)
* Atom feeds:                            RSS feeds.           (line   6)
* attachments:                           Attachments.         (line   6)
* author:                                Feedback.            (line   6)
* author, macro:                         Macro replacement.   (line  24)
* autoload:                              Activation.          (line   6)
* babel, languages:                      Languages.           (line   6)
* babel, library of:                     Library of Babel.    (line   6)
* backtrace of an error:                 Feedback.            (line  63)
* BBDB links:                            External links.      (line   6)
* BBDB, anniversaries:                   Weekly/daily agenda. (line  79)
* Beamer export:                         Beamer export.       (line   6)
* begin block, end block:                Structure of code blocks.
                                                              (line  44)
* block agenda:                          Block agenda.        (line   6)
* blocking, of checkboxes:               Checkboxes.          (line  46)
* blocks, folding:                       Blocks.              (line   6)
* bold text, markup rules:               Emphasis and monospace.
                                                              (line   6)
* Boolean logic, for tag/property searches: Matching tags and properties.
                                                              (line  33)
* bug reports:                           Feedback.            (line   6)
* C-c C-c, overview:                     The very busy C-c C-c key.
                                                              (line   6)
* calc package:                          The spreadsheet.     (line   6)
* calc.el:                               Cooperation.         (line   6)
* calculations, in tables:               Built-in table editor.
                                                              (line 145)
* calculations, in tables <1>:           The spreadsheet.     (line   6)
* calendar commands, from agenda:        Agenda commands.     (line 381)
* calendar integration:                  Weekly/daily agenda. (line  32)
* calendar, for selecting date:          The date/time prompt.
                                                              (line  76)
* capture:                               Capture - Refile - Archive.
                                                              (line   6)
* capture <1>:                           Capture.             (line   6)
* capture protocol:                      capture protocol.    (line   6)
* capture, %:annotation placeholder:     capture protocol.    (line  23)
* capture, %:description placeholder:    capture protocol.    (line  23)
* capture, %:link placeholder:           capture protocol.    (line  23)
* capturing, from agenda:                Agenda commands.     (line 292)
* category:                              Categories.          (line   6)
* category filtering, in agenda:         Filtering/limiting agenda items.
                                                              (line  17)
* category, require for tags/property match: Matching tags and properties.
                                                              (line  67)
* CDLaTeX:                               CDLaTeX mode.        (line   6)
* cdlatex.el:                            Cooperation.         (line  19)
* center blocks:                         Paragraphs.          (line  31)
* center image (LaTeX export):           Images in LaTeX export.
                                                              (line  46)
* checkbox blocking:                     Checkboxes.          (line  46)
* checkbox statistics:                   Checkboxes.          (line  30)
* checkboxes:                            Checkboxes.          (line   6)
* checkboxes and TODO dependencies:      TODO dependencies.   (line  51)
* children, subtree visibility state:    Global and local cycling.
                                                              (line  10)
* clean outline view:                    Clean view.          (line   6)
* clocking time:                         Clocking work time.  (line   6)
* clocktable, dynamic block:             The clock table.     (line   6)
* code block, batch execution:           Batch execution.     (line   6)
* code block, editing:                   Editing source code. (line   6)
* code block, evaluating:                Evaluating code blocks.
                                                              (line   6)
* code block, exporting:                 Exporting code blocks.
                                                              (line   6)
* code block, extracting source code:    Extracting source code.
                                                              (line   6)
* code block, header arguments:          Header arguments.    (line   6)
* code block, key bindings:              Key bindings and useful functions.
                                                              (line   6)
* code block, languages:                 Languages.           (line   6)
* code block, library:                   Library of Babel.    (line   6)
* code block, noweb reference:           Noweb reference syntax.
                                                              (line   6)
* code block, results of evaluation:     Results of evaluation.
                                                              (line   6)
* code block, structure:                 Structure of code blocks.
                                                              (line   6)
* code line references, markup rules:    Literal examples.    (line   6)
* code text, markup rules:               Emphasis and monospace.
                                                              (line   6)
* column formula:                        Column formulas.     (line   6)
* column view, for properties:           Defining columns.    (line   6)
* column view, in agenda:                Agenda column view.  (line   6)
* column, of field coordinates:          References.          (line  86)
* commands, in agenda buffer:            Agenda commands.     (line   6)
* comment lines:                         Comment lines.       (line   6)
* comment trees:                         Comment lines.       (line  13)
* commented entries, in agenda views:    Agenda views.        (line  32)
* completion, of dictionary words:       Completion.          (line   6)
* completion, of file names:             Handling links.      (line  87)
* completion, of link abbreviations:     Completion.          (line   6)
* completion, of links:                  Handling links.      (line  65)
* completion, of option keywords:        Per-file keywords.   (line  23)
* completion, of option keywords <1>:    Completion.          (line   6)
* completion, of property keys:          Completion.          (line   6)
* completion, of tags:                   Setting tags.        (line  11)
* completion, of tags <1>:               Completion.          (line   6)
* completion, of TeX symbols:            Completion.          (line   6)
* completion, of TODO keywords:          Workflow states.     (line  15)
* completion, of TODO keywords <1>:      Completion.          (line   6)
* concept index, in Texinfo export:      Indices.             (line   6)
* constants, in calculations:            References.          (line 108)
* constants, in calculations <1>:        References.          (line 129)
* constants.el:                          Cooperation.         (line  11)
* constcgs, STARTUP keyword:             In-buffer settings.  (line 136)
* constSI, STARTUP keyword:              In-buffer settings.  (line 136)
* content, STARTUP keyword:              Initial visibility.  (line   6)
* content, STARTUP keyword <1>:          In-buffer settings.  (line  65)
* contents, global visibility state:     Global and local cycling.
                                                              (line  18)
* context-sensitive commands, hooks:     Context-sensitive commands.
                                                              (line   6)
* continuous clocking:                   Resolving idle time. (line  74)
* convert:                               Configuring a document converter.
                                                              (line   6)
* converter:                             Configuring a document converter.
                                                              (line   6)
* coordinates, of field:                 References.          (line  86)
* copying notes:                         Refile and copy.     (line   6)
* copying, of subtrees:                  Structure editing.   (line   6)
* countdown timer:                       Timers.              (line   6)
* counter, macro:                        Macro replacement.   (line  55)
* creating timestamps:                   Creating timestamps. (line   6)
* CSS, for HTML export:                  CSS support.         (line   6)
* CUA.el:                                Conflicts.           (line  18)
* custom agenda views:                   Custom agenda views. (line   6)
* custom date/time format:               Custom time format.  (line   6)
* custom search strings:                 Custom searches.     (line   6)
* customization:                         Customization.       (line   6)
* customtime, STARTUP keyword:           In-buffer settings.  (line 132)
* cutting, of subtrees:                  Structure editing.   (line   6)
* cycling, in plain lists:               Plain lists.         (line  67)
* cycling, of agenda files:              Agenda files.        (line  21)
* cycling, of TODO states:               TODO basics.         (line  14)
* cycling, visibility:                   Visibility cycling.  (line   6)
* daily agenda:                          Weekly/daily agenda. (line   6)
* dash, special symbol:                  Special symbols.     (line  39)
* data type index, in Texinfo export:    Indices.             (line   6)
* date format, custom:                   Custom time format.  (line   6)
* date range:                            Timestamps.          (line  42)
* date stamp:                            Dates and times.     (line   6)
* date stamps:                           Timestamps.          (line   6)
* date tree:                             Using capture.       (line   9)
* date, macro:                           Macro replacement.   (line  29)
* date, reading in minibuffer:           The date/time prompt.
                                                              (line   6)
* dates:                                 Dates and times.     (line   6)
* Davison, Dan:                          Working with source code.
                                                              (line   6)
* DEADLINE keyword:                      Deadlines and scheduling.
                                                              (line  11)
* deadlines:                             Timestamps.          (line   6)
* debugging, of table formulas:          Editing and debugging formulas.
                                                              (line 117)
* defining new protocols:                Protocols.           (line  25)
* demotion, of subtrees:                 Structure editing.   (line   6)
* dependencies, of TODO states:          TODO dependencies.   (line   6)
* diary entries, creating from agenda:   Agenda commands.     (line 385)
* diary integration:                     Weekly/daily agenda. (line  32)
* dictionary word completion:            Completion.          (line   6)
* dir file, in Texinfo export:           Info directory file. (line   6)
* directories, for publishing:           Sources and destinations.
                                                              (line   6)
* dispatching agenda commands:           Agenda dispatcher.   (line   6)
* display changing, in agenda:           Agenda commands.     (line  61)
* doc, docx, rtf:                        Configuring a document converter.
                                                              (line   6)
* document structure:                    Document structure.  (line   6)
* document title:                        Export settings.     (line  60)
* Dominik, Carsten:                      Cooperation.         (line  11)
* Dominik, Carsten <1>:                  Cooperation.         (line  19)
* DONE, final TODO keyword:              Per-file keywords.   (line  26)
* dragging, agenda lines:                Agenda commands.     (line 297)
* drawer, for properties:                Property syntax.     (line   6)
* drawer, for state change recording:    Tracking TODO state changes.
                                                              (line   6)
* drawers:                               Drawers.             (line   6)
* Duration, computing:                   Durations and time values.
                                                              (line   6)
* dvipng:                                Math formatting in HTML export.
                                                              (line   6)
* dvipng <1>:                            Working with LaTeX math snippets.
                                                              (line  48)
* dvisvgm:                               Math formatting in HTML export.
                                                              (line   6)
* dvisvgm <1>:                           Working with LaTeX math snippets.
                                                              (line  48)
* dynamic blocks:                        Dynamic blocks.      (line   6)
* dynamic indentation:                   Clean view.          (line   6)
* ecomplete.el:                          Conflicts.           (line  33)
* editing tables:                        Tables.              (line   6)
* editing, of table formulas:            Editing and debugging formulas.
                                                              (line   6)
* edits, catching invisible:             Catching invisible edits.
                                                              (line   6)
* effort estimates:                      Effort estimates.    (line   6)
* effort filtering, in agenda:           Filtering/limiting agenda items.
                                                              (line  17)
* Elisp links:                           External links.      (line   6)
* ellipsis, special symbol:              Special symbols.     (line  39)
* ELPA:                                  Activation.          (line   6)
* email, macro:                          Macro replacement.   (line  24)
* embedding images in ODT:               Images in ODT export.
                                                              (line   6)
* entitiesplain, STARTUP keyword:        In-buffer settings.  (line 159)
* entitiespretty, STARTUP keyword:       Special symbols.     (line  34)
* entitiespretty, STARTUP keyword <1>:   In-buffer settings.  (line 159)
* escaping characters:                   Special symbols.     (line  27)
* evaluate time range:                   Creating timestamps. (line  52)
* even, STARTUP keyword:                 In-buffer settings.  (line 122)
* example blocks, in LaTeX export:       Example blocks in LaTeX export.
                                                              (line   6)
* export back-end:                       Exporting.           (line  12)
* export back-ends, built-in:            Other built-in back-ends.
                                                              (line   6)
* Export, dispatcher:                    The export dispatcher.
                                                              (line   6)
* export, OpenDocument:                  OpenDocument Text export.
                                                              (line   6)
* Export, settings:                      Export settings.     (line   6)
* Export, writing back-ends:             Adding export back-ends.
                                                              (line   6)
* exporting:                             Exporting.           (line   6)
* exporting agenda views:                Agenda commands.     (line 426)
* exporting agenda views <1>:            Exporting agenda views.
                                                              (line  13)
* exporting, not:                        Comment lines.       (line   6)
* extended TODO keywords:                TODO extensions.     (line   6)
* external archiving:                    Moving subtrees.     (line   6)
* external links:                        External links.      (line   6)
* external links, in HTML export:        Links in HTML export.
                                                              (line   6)
* faces, for TODO keywords:              Faces for TODO keywords.
                                                              (line   6)
* FAQ:                                   Summary.             (line  49)
* feedback:                              Feedback.            (line   6)
* field coordinates:                     References.          (line  86)
* field formula:                         Field and range formulas.
                                                              (line   6)
* field references:                      References.          (line  15)
* file links:                            External links.      (line   6)
* file links, searching:                 Search options.      (line   6)
* file name completion:                  Handling links.      (line  87)
* files for agenda:                      Agenda files.        (line   6)
* files, adding to agenda list:          Agenda files.        (line  15)
* files, selecting for publishing:       Selecting files.     (line   6)
* filladapt.el:                          Conflicts.           (line  45)
* filtering, by tag, category, top headline and effort, in agenda: Filtering/limiting agenda items.
                                                              (line  17)
* Filters, exporting:                    Advanced configuration.
                                                              (line  32)
* FLAGGED, tag:                          Pulling from the mobile application.
                                                              (line  18)
* fnadjust, STARTUP keyword:             In-buffer settings.  (line 142)
* fnauto, STARTUP keyword:               In-buffer settings.  (line 142)
* fnconfirm, STARTUP keyword:            In-buffer settings.  (line 142)
* fninline, STARTUP keyword:             In-buffer settings.  (line 142)
* fnlocal, STARTUP keyword:              In-buffer settings.  (line 142)
* fnplain, STARTUP keyword:              In-buffer settings.  (line 142)
* fnprompt, STARTUP keyword:             In-buffer settings.  (line 142)
* folded, subtree visibility state:      Global and local cycling.
                                                              (line  10)
* folding, sparse trees:                 Sparse trees.        (line   6)
* following links:                       Handling links.      (line  98)
* footnotes:                             Footnotes.           (line   6)
* format specifier:                      Formula syntax for Calc.
                                                              (line  14)
* format, of links:                      Link format.         (line   6)
* formatting source code, markup rules:  Literal examples.    (line  23)
* formula debugging:                     Editing and debugging formulas.
                                                              (line 117)
* formula editing:                       Editing and debugging formulas.
                                                              (line   6)
* formula syntax, Calc:                  Formula syntax for Calc.
                                                              (line   6)
* formula, for individual table field:   Field and range formulas.
                                                              (line   6)
* formula, for range of fields:          Field and range formulas.
                                                              (line   6)
* formula, for table column:             Column formulas.     (line   6)
* formula, in tables:                    Built-in table editor.
                                                              (line 145)
* function index, in Texinfo export:     Indices.             (line   6)
* Gillespie, Dave:                       Cooperation.         (line   6)
* global cycling:                        Global and local cycling.
                                                              (line  18)
* global key bindings:                   Activation.          (line   6)
* global TODO list:                      Global TODO list.    (line   6)
* global visibility states:              Global and local cycling.
                                                              (line  18)
* Gnus links:                            External links.      (line   6)
* graph, in tables:                      Org-Plot.            (line   6)
* group tags:                            Tag hierarchy.       (line   6)
* group tags, as regular expressions:    Matching tags and properties.
                                                              (line  60)
* grouping columns in tables:            Column groups.       (line   6)
* habits:                                Tracking your habits.
                                                              (line   6)
* hacking:                               Hacking.             (line   6)
* handle rewritten URL in open-source protocol: open-source protocol.
                                                              (line  32)
* header, for LaTeX files:               LaTeX header and sectioning.
                                                              (line   6)
* headline navigation:                   Motion.              (line   6)
* headline tagging:                      Tags.                (line   6)
* headline, promotion and demotion:      Structure editing.   (line   6)
* headlines:                             Headlines.           (line   6)
* hide text:                             Visibility cycling.  (line   6)
* hideblocks, STARTUP keyword:           Blocks.              (line  13)
* hideblocks, STARTUP keyword <1>:       In-buffer settings.  (line 154)
* hidestars, STARTUP keyword:            In-buffer settings.  (line 122)
* hiding leading stars:                  Clean view.          (line   6)
* history:                               History and acknowledgments.
                                                              (line   6)
* hooks:                                 Hooks.               (line   6)
* horizontal rules, in ASCII export:     ASCII/Latin-1/UTF-8 export.
                                                              (line  67)
* horizontal rules, in LaTeX export:     Horizontal rules in LaTeX export.
                                                              (line   6)
* horizontal rules, markup rules:        Horizontal rules.    (line   6)
* HTML entities:                         Special symbols.     (line   6)
* HTML export:                           HTML export.         (line   6)
* HTML export, CSS:                      CSS support.         (line   6)
* HTML, and Orgtbl mode:                 Translator functions.
                                                              (line   6)
* HTML5, export new elements:            HTML doctypes.       (line  25)
* hyperlinks:                            Hyperlinks.          (line   6)
* hyperlinks, adding new types:          Adding hyperlink types.
                                                              (line   6)
* iCalendar export:                      iCalendar export.    (line   6)
* identify, ImageMagick:                 Images in ODT export.
                                                              (line  34)
* idle, resolve, dangling:               Resolving idle time. (line   9)
* image, centering (LaTeX export):       Images in LaTeX export.
                                                              (line  46)
* imagemagick:                           Math formatting in HTML export.
                                                              (line   6)
* imagemagick <1>:                       Working with LaTeX math snippets.
                                                              (line  48)
* images, embedding in ODT:              Images in ODT export.
                                                              (line   6)
* images, inline in HTML:                Images in HTML export.
                                                              (line   6)
* images, inline in LaTeX:               Images in LaTeX export.
                                                              (line   6)
* images, inlining:                      Handling links.      (line 129)
* imenu.el:                              Cooperation.         (line  22)
* in-buffer settings:                    In-buffer settings.  (line   6)
* inactive timestamp:                    Timestamps.          (line  50)
* include files, during export:          Include files.       (line   6)
* indent, STARTUP keyword:               In-buffer settings.  (line  70)
* indentation, in source blocks:         Literal examples.    (line  72)
* indentation, in source blocks <1>:     Editing source code. (line  36)
* index, in a publishing project:        Generating an index. (line   6)
* Info directory file, in Texinfo export: Info directory file.
                                                              (line   6)
* Info links:                            External links.      (line   6)
* inheritance, of properties:            Property inheritance.
                                                              (line   6)
* inheritance, of tags:                  Tag inheritance.     (line   6)
* inline, in LaTeX export:               Quoting LaTeX code.  (line  10)
* inlined images, markup rules:          Images and tables.   (line  22)
* inlineimages, STARTUP keyword:         Handling links.      (line 129)
* inlineimages, STARTUP keyword <1>:     In-buffer settings.  (line  84)
* inlining images:                       Handling links.      (line 129)
* inlining images in HTML:               Images in HTML export.
                                                              (line   6)
* inlining images in LaTeX:              Images in LaTeX export.
                                                              (line   6)
* input file, macro:                     Macro replacement.   (line  44)
* inserting links:                       Handling links.      (line  65)
* insertion, of templates:               Easy templates.      (line   6)
* install-info parameters, in Texinfo export: Info directory file.
                                                              (line   6)
* installation:                          Installation.        (line   6)
* Installing Org protocol:               Protocols.           (line  14)
* internal links:                        Internal links.      (line   6)
* internal links, in HTML export:        Links in HTML export.
                                                              (line   6)
* introduction:                          Introduction.        (line   6)
* IRC links:                             External links.      (line   6)
* italic text, markup rules:             Emphasis and monospace.
                                                              (line   6)
* jumping, to headlines:                 Motion.              (line   6)
* key bindings, global:                  Activation.          (line   6)
* keystroke index, in Texinfo export:    Indices.             (line   6)
* keyword options:                       Per-file keywords.   (line   6)
* LaTeX class:                           LaTeX header and sectioning.
                                                              (line   6)
* LaTeX entities:                        Special symbols.     (line   6)
* LaTeX export:                          LaTeX export.        (line   6)
* LaTeX fragments:                       LaTeX fragments.     (line   6)
* LaTeX fragments, preview:              Previewing LaTeX fragments.
                                                              (line   6)
* LaTeX header:                          LaTeX header and sectioning.
                                                              (line   6)
* LaTeX interpretation:                  Embedded LaTeX.      (line   6)
* LaTeX sectioning structure:            LaTeX header and sectioning.
                                                              (line   6)
* LaTeX, and Orgtbl mode:                A LaTeX example.     (line   6)
* latexpreview, STARTUP keyword:         In-buffer settings.  (line  90)
* Latin-1 export:                        ASCII/Latin-1/UTF-8 export.
                                                              (line   6)
* level, require for tags/property match: Matching tags and properties.
                                                              (line  67)
* LibreOffice:                           OpenDocument Text export.
                                                              (line   6)
* LibreOffice <1>:                       Extending ODT export.
                                                              (line  12)
* limits, in agenda:                     Filtering/limiting agenda items.
                                                              (line 118)
* link abbreviations:                    Link abbreviations.  (line   6)
* link abbreviations, completion of:     Completion.          (line   6)
* link completion:                       Handling links.      (line  65)
* link format:                           Link format.         (line   6)
* links, external:                       External links.      (line   6)
* links, finding next/previous:          Handling links.      (line 146)
* links, handling:                       Handling links.      (line   6)
* links, in HTML export:                 Links in HTML export.
                                                              (line   6)
* links, in ODT export:                  Links in ODT export. (line   6)
* links, internal:                       Internal links.      (line   6)
* links, publishing:                     Publishing links.    (line   6)
* links, radio targets:                  Radio targets.       (line   6)
* links, returning to:                   Handling links.      (line 140)
* linter:                                Org syntax.          (line  24)
* Lisp forms, as table formulas:         Formula syntax for Lisp.
                                                              (line   6)
* list of listings:                      Table of contents.   (line   6)
* list of tables:                        Table of contents.   (line   6)
* lists, in other modes:                 Tables in arbitrary syntax.
                                                              (line   6)
* lists, ordered:                        Plain lists.         (line   6)
* lists, plain:                          Plain lists.         (line   6)
* literal examples, markup rules:        Literal examples.    (line   6)
* logdone, STARTUP keyword:              In-buffer settings.  (line  96)
* logdrawer, STARTUP keyword:            In-buffer settings.  (line  96)
* logging, of progress:                  Progress logging.    (line   6)
* lognoteclock-out, STARTUP keyword:     In-buffer settings.  (line  96)
* lognotedone, STARTUP keyword:          In-buffer settings.  (line  96)
* lognoteredeadline, STARTUP keyword:    In-buffer settings.  (line  96)
* lognoterefile, STARTUP keyword:        In-buffer settings.  (line  96)
* lognoterepeat, STARTUP keyword:        In-buffer settings.  (line  96)
* lognotereschedule, STARTUP keyword:    In-buffer settings.  (line  96)
* logredeadline, STARTUP keyword:        In-buffer settings.  (line  96)
* logrefile, STARTUP keyword:            In-buffer settings.  (line  96)
* logrepeat, STARTUP keyword:            In-buffer settings.  (line  96)
* logreschedule, STARTUP keyword:        In-buffer settings.  (line  96)
* logstatesreversed, STARTUP keyword:    In-buffer settings.  (line  96)
* lookup functions in tables:            Lookup functions.    (line   6)
* Ludlam, Eric M.:                       Cooperation.         (line  30)
* macro replacement, during export:      Macro replacement.   (line   6)
* maintainer:                            Feedback.            (line   6)
* mapping entries, API:                  Using the mapping API.
                                                              (line   6)
* mark ring:                             Handling links.      (line 137)
* Markdown export:                       Markdown export.     (line   6)
* marking characters, tables:            Advanced features.   (line  39)
* match view:                            Matching tags and properties.
                                                              (line   6)
* matching, of properties:               Matching tags and properties.
                                                              (line   6)
* matching, of tags:                     Matching tags and properties.
                                                              (line   6)
* matching, tags:                        Tags.                (line   6)
* math symbols:                          Special symbols.     (line   6)
* MathJax:                               Math formatting in HTML export.
                                                              (line   6)
* MathML:                                Working with LaTeX math snippets.
                                                              (line   9)
* MH-E links:                            External links.      (line   6)
* minor mode for structure editing:      Orgstruct mode.      (line   6)
* minor mode for tables:                 Orgtbl mode.         (line   6)
* mode, for calc:                        Formula syntax for Calc.
                                                              (line  14)
* modification time, macro:              Macro replacement.   (line  36)
* motion commands in agenda:             Agenda commands.     (line  19)
* motion, between headlines:             Motion.              (line   6)
* Multiple entries in two-column tables, in Texinfo export: Plain lists in Texinfo export.
                                                              (line  17)
* n, macro:                              Macro replacement.   (line  55)
* name, of column or field:              References.          (line 108)
* name, of column or field <1>:          References.          (line 129)
* named references:                      References.          (line 108)
* names as TODO keywords:                TODO types.          (line   6)
* narrow columns in tables:              Column width and alignment.
                                                              (line   6)
* noalign, STARTUP keyword:              In-buffer settings.  (line  79)
* nofnadjust, STARTUP keyword:           In-buffer settings.  (line 142)
* nofninline, STARTUP keyword:           In-buffer settings.  (line 142)
* nohideblocks, STARTUP keyword:         Blocks.              (line  13)
* nohideblocks, STARTUP keyword <1>:     In-buffer settings.  (line 154)
* noindent, STARTUP keyword:             In-buffer settings.  (line  70)
* noinlineimages, STARTUP keyword:       Handling links.      (line 129)
* noinlineimages, STARTUP keyword <1>:   In-buffer settings.  (line  84)
* nolatexpreview, STARTUP keyword:       In-buffer settings.  (line  90)
* nologdone, STARTUP keyword:            In-buffer settings.  (line  96)
* nologdrawer, STARTUP keyword:          In-buffer settings.  (line  96)
* nolognoteclock-out, STARTUP keyword:   In-buffer settings.  (line  96)
* nologredeadline, STARTUP keyword:      In-buffer settings.  (line  96)
* nologrefile, STARTUP keyword:          In-buffer settings.  (line  96)
* nologrepeat, STARTUP keyword:          In-buffer settings.  (line  96)
* nologreschedule, STARTUP keyword:      In-buffer settings.  (line  96)
* nologstatesreversed, STARTUP keyword:  In-buffer settings.  (line  96)
* occur, command:                        Sparse trees.        (line   6)
* occur-tree:                            Storing searches.    (line   9)
* odd, STARTUP keyword:                  In-buffer settings.  (line 122)
* odd-levels-only outlines:              Clean view.          (line   6)
* ODT:                                   OpenDocument Text export.
                                                              (line   6)
* ODT_STYLES_FILE:                       ODT specific export settings.
                                                              (line  22)
* open-source protocol:                  open-source protocol.
                                                              (line   6)
* OpenDocument:                          OpenDocument Text export.
                                                              (line   6)
* option keyword completion:             Completion.          (line   6)
* options, for custom agenda views:      Setting options.     (line   6)
* options, for customization:            Customization.       (line   6)
* options, for publishing:               Publishing options.  (line   6)
* ordered lists:                         Plain lists.         (line   6)
* Org entities:                          Special symbols.     (line   6)
* Org export:                            Org export.          (line   6)
* Org mode, turning on:                  Activation.          (line  21)
* Org protocol, set-up:                  Protocols.           (line  14)
* Org syntax:                            Org syntax.          (line   6)
* org-agenda, command:                   Weekly/daily agenda. (line   9)
* org-capture-last-stored:               Using capture.       (line  48)
* org-crypt.el:                          org-crypt.           (line   6)
* org-decrypt-entry:                     org-crypt.           (line   6)
* org-hide-block-startup:                In-buffer settings.  (line 153)
* org-insert-drawer:                     Drawers.             (line   6)
* org-insert-drawer <1>:                 Property syntax.     (line  87)
* org-list-insert-radio-list:            Radio lists.         (line   6)
* org-pretty-entities:                   In-buffer settings.  (line 158)
* org-publish-project-alist:             Project alist.       (line   6)
* Orgstruct mode:                        Orgstruct mode.      (line   6)
* Orgtbl mode:                           Orgtbl mode.         (line   6)
* Orgtbl mode <1>:                       Tables in arbitrary syntax.
                                                              (line   6)
* Ota, Takaaki:                          Cooperation.         (line  36)
* Outline mode:                          Outlines.            (line   6)
* outline tree:                          Headlines.           (line   6)
* outlines:                              Outlines.            (line   6)
* overview, global visibility state:     Global and local cycling.
                                                              (line  18)
* overview, STARTUP keyword:             Initial visibility.  (line   6)
* overview, STARTUP keyword <1>:         In-buffer settings.  (line  65)
* packages, interaction with other:      Interaction.         (line   6)
* paragraphs, markup rules:              Paragraphs.          (line   6)
* pasting, of subtrees:                  Structure editing.   (line   6)
* PDF export:                            LaTeX export.        (line   6)
* per-file keywords:                     Per-file keywords.   (line   6)
* plain lists:                           Plain lists.         (line   6)
* plain lists, in LaTeX export:          Plain lists in LaTeX export.
                                                              (line   6)
* plain text external links:             External links.      (line  68)
* plot tables using Gnuplot:             Org-Plot.            (line   6)
* presentation, of agenda items:         Presentation and sorting.
                                                              (line   6)
* print edition:                         Summary.             (line  52)
* printing sparse trees:                 Sparse trees.        (line  49)
* priorities:                            Priorities.          (line   6)
* priorities, of agenda items:           Sorting agenda items.
                                                              (line   6)
* program index, in Texinfo export:      Indices.             (line   6)
* progress logging:                      Progress logging.    (line   6)
* projects, for publishing:              Project alist.       (line   6)
* promotion, of subtrees:                Structure editing.   (line   6)
* proof, in LaTeX export:                Special blocks in LaTeX export.
                                                              (line   6)
* properties:                            Properties and columns.
                                                              (line   6)
* properties, API:                       Property API.        (line   6)
* properties, API <1>:                   Using the property API.
                                                              (line   6)
* properties, column view:               Defining columns.    (line   6)
* properties, inheritance:               Property inheritance.
                                                              (line   6)
* properties, searching:                 Property searches.   (line   6)
* properties, special:                   Special properties.  (line   6)
* property syntax:                       Property syntax.     (line   6)
* property, +:                           Property syntax.     (line  52)
* property, + <1>:                       Property syntax.     (line  58)
* property, ALT_TITLE:                   Table of contents.   (line  41)
* property, APPENDIX:                    Headings and sectioning structure.
                                                              (line  20)
* property, ARCHIVE:                     Property inheritance.
                                                              (line  32)
* property, ARCHIVE <1>:                 Moving subtrees.     (line  35)
* property, ATTACH_DIR:                  Attachments.         (line  74)
* property, ATTACH_DIR_INHERIT:          Attachments.         (line  79)
* property, BEAMER_ACT:                  Sectioning Frames and Blocks in Beamer.
                                                              (line  41)
* property, BEAMER_COL:                  Sectioning Frames and Blocks in Beamer.
                                                              (line  49)
* property, BEAMER_ENV:                  Sectioning Frames and Blocks in Beamer.
                                                              (line  14)
* property, BEAMER_OPT:                  Sectioning Frames and Blocks in Beamer.
                                                              (line  41)
* property, BEAMER_REF:                  Sectioning Frames and Blocks in Beamer.
                                                              (line  27)
* property, CATEGORY:                    Property inheritance.
                                                              (line  29)
* property, CATEGORY <1>:                Categories.          (line  12)
* property, CLOCK_MODELINE_TOTAL:        Clocking commands.   (line  20)
* property, COLUMNS:                     Property inheritance.
                                                              (line  22)
* property, COLUMNS <1>:                 In-buffer settings.  (line  24)
* property, COOKIE_DATA:                 Breaking down tasks. (line  21)
* property, COOKIE_DATA <1>:             Checkboxes.          (line  30)
* property, COPYING:                     Texinfo title and copyright page.
                                                              (line  19)
* property, CUSTOM_ID:                   Internal links.      (line   6)
* property, CUSTOM_ID <1>:               Handling links.      (line  21)
* property, DESCRIPTION:                 Headings and sectioning structure.
                                                              (line  24)
* property, DESCRIPTION <1>:             iCalendar export.    (line  49)
* property, EFFORT:                      Effort estimates.    (line   6)
* property, EXPORT_FILE_NAME:            ODT export commands. (line   7)
* property, EXPORT_LATEX_CLASS:          LaTeX header and sectioning.
                                                              (line  23)
* property, EXPORT_LATEX_CLASS_OPTIONS:  LaTeX header and sectioning.
                                                              (line  23)
* property, ID:                          Handling links.      (line  21)
* property, ID <1>:                      Capturing column view.
                                                              (line  22)
* property, ID <2>:                      iCalendar export.    (line  26)
* property, INDEX:                       Indices.             (line  14)
* property, LAST_REPEAT:                 Clocking commands.   (line  20)
* property, LOCATION:                    iCalendar export.    (line  49)
* property, LOGGING:                     Tracking TODO state changes.
                                                              (line  45)
* property, LOGGING <1>:                 Property inheritance.
                                                              (line  35)
* property, LOG_INTO_DRAWER:             Tracking TODO state changes.
                                                              (line   6)
* property, LOG_INTO_DRAWER <1>:         Clocking commands.   (line   7)
* property, macro:                       Macro replacement.   (line  48)
* property, ORDERED:                     TODO dependencies.   (line   6)
* property, ORDERED <1>:                 TODO dependencies.   (line  38)
* property, ORDERED <2>:                 Checkboxes.          (line  46)
* property, ORDERED <3>:                 Checkboxes.          (line  75)
* property, special, ALLTAGS:            Special properties.  (line  13)
* property, special, BLOCKED:            Special properties.  (line  13)
* property, special, CLOCKSUM:           Special properties.  (line  13)
* property, special, CLOCKSUM <1>:       Agenda column view.  (line  28)
* property, special, CLOCKSUM_T:         Special properties.  (line  13)
* property, special, CLOCKSUM_T <1>:     Agenda column view.  (line  51)
* property, special, CLOSED:             Special properties.  (line  13)
* property, special, DEADLINE:           Special properties.  (line  13)
* property, special, FILE:               Special properties.  (line  13)
* property, special, ITEM:               Special properties.  (line  13)
* property, special, PRIORITY:           Special properties.  (line  13)
* property, special, SCHEDULED:          Special properties.  (line  13)
* property, special, TAGS:               Special properties.  (line  13)
* property, special, TIMESTAMP:          Special properties.  (line  13)
* property, special, TIMESTAMP_IA:       Special properties.  (line  13)
* property, special, TODO:               Special properties.  (line  13)
* property, SUMMARY:                     iCalendar export.    (line  49)
* property, TIMEZONE:                    iCalendar export.    (line  49)
* property, UNNUMBERED:                  Export settings.     (line 149)
* property, VISIBILITY:                  Initial visibility.  (line  17)
* property, _ALL:                        Property syntax.     (line  44)
* protocol, capture:                     capture protocol.    (line   6)
* protocol, new protocol:                Protocols.           (line  25)
* protocol, open-source:                 open-source protocol.
                                                              (line   6)
* protocol, open-source rewritten URL:   open-source protocol.
                                                              (line  32)
* protocol, open-source, :base-url property: open-source protocol.
                                                              (line  13)
* protocol, open-source, :online-suffix property: open-source protocol.
                                                              (line  13)
* protocol, open-source, :rewrites property: open-source protocol.
                                                              (line  43)
* protocol, open-source, :working-directory property: open-source protocol.
                                                              (line  13)
* protocol, open-source, :working-suffix property: open-source protocol.
                                                              (line  13)
* protocol, open-source, set-up mapping: open-source protocol.
                                                              (line  67)
* protocol, store-link:                  store-link protocol. (line   6)
* protocols, for external access:        Protocols.           (line   6)
* publishing:                            Publishing.          (line   6)
* query editing, in agenda:              Filtering/limiting agenda items.
                                                              (line  17)
* quote blocks:                          Paragraphs.          (line  26)
* radio lists:                           Radio lists.         (line   6)
* radio tables:                          Radio tables.        (line   6)
* radio targets:                         Radio targets.       (line   6)
* range formula:                         Field and range formulas.
                                                              (line   6)
* range references:                      References.          (line  63)
* ranges, time:                          Timestamps.          (line   6)
* recomputing table fields:              Updating the table.  (line   6)
* references:                            References.          (line   6)
* references, named:                     References.          (line 108)
* references, remote:                    References.          (line 129)
* references, to a different table:      References.          (line 129)
* references, to fields:                 References.          (line  15)
* references, to ranges:                 References.          (line  63)
* refiling notes:                        Refile and copy.     (line   6)
* region, active:                        Structure editing.   (line 116)
* region, active <1>:                    Built-in table editor.
                                                              (line 145)
* region, active <2>:                    ODT export commands. (line   6)
* regular expressions, with tags search: Matching tags and properties.
                                                              (line  56)
* relative timer:                        Timers.              (line   6)
* reminders:                             Weekly/daily agenda. (line 126)
* remote editing, bulk, from agenda:     Agenda commands.     (line 308)
* remote editing, from agenda:           Agenda commands.     (line 200)
* remote editing, undo:                  Agenda commands.     (line 201)
* remote references:                     References.          (line 129)
* repeated tasks:                        Repeated tasks.      (line   6)
* report, of clocked time:               The clock table.     (line   6)
* resolve idle time:                     Resolving idle time. (line   9)
* revealing context:                     Global and local cycling.
                                                              (line  37)
* RMAIL links:                           External links.      (line   6)
* Rose, Sebastian:                       JavaScript support.  (line   6)
* row, of field coordinates:             References.          (line  86)
* RSS feeds:                             RSS feeds.           (line   6)
* rsync:                                 Uploading files.     (line   6)
* SCHEDULED keyword:                     Deadlines and scheduling.
                                                              (line  32)
* scheduling:                            Timestamps.          (line   6)
* Schulte, Eric:                         Working with source code.
                                                              (line   6)
* Scripts, for agenda processing:        Extracting agenda information.
                                                              (line   6)
* search option in file links:           Search options.      (line   6)
* search strings, custom:                Custom searches.     (line   6)
* search view:                           Search view.         (line   6)
* searching for tags:                    Tag searches.        (line   6)
* searching, for text:                   Search view.         (line   6)
* searching, of properties:              Property searches.   (line   6)
* sectioning structure, for LaTeX export: LaTeX header and sectioning.
                                                              (line   6)
* set startup visibility, command:       Global and local cycling.
                                                              (line  33)
* set-up mappings in open-source protocol: open-source protocol.
                                                              (line  67)
* setting tags:                          Setting tags.        (line   6)
* SHELL links:                           External links.      (line   6)
* shift-selection-mode:                  Plain lists.         (line  90)
* shift-selection-mode <1>:              Conflicts.           (line   6)
* show all, command:                     Global and local cycling.
                                                              (line  35)
* show all, global visibility state:     Global and local cycling.
                                                              (line  18)
* show branches, command:                Global and local cycling.
                                                              (line  45)
* show children, command:                Global and local cycling.
                                                              (line  48)
* show hidden text:                      Visibility cycling.  (line   6)
* showall, STARTUP keyword:              Initial visibility.  (line   6)
* showall, STARTUP keyword <1>:          In-buffer settings.  (line  65)
* showeverything, STARTUP keyword:       Initial visibility.  (line   6)
* showeverything, STARTUP keyword <1>:   In-buffer settings.  (line  65)
* showstars, STARTUP keyword:            In-buffer settings.  (line 122)
* shy hyphen, special symbol:            Special symbols.     (line  39)
* sitemap, of published pages:           Sitemap.             (line   6)
* smartphone:                            Org Mobile.          (line   6)
* sorting, of agenda items:              Sorting agenda items.
                                                              (line   6)
* sorting, of plain list:                Plain lists.         (line 142)
* sorting, of subtrees:                  Structure editing.   (line   6)
* source blocks, in LaTeX export:        Source blocks in LaTeX export.
                                                              (line   6)
* source code, batch execution:          Batch execution.     (line   6)
* source code, block header arguments:   Header arguments.    (line   6)
* source code, block structure:          Structure of code blocks.
                                                              (line   6)
* source code, editing:                  Editing source code. (line   6)
* source code, evaluating:               Evaluating code blocks.
                                                              (line   6)
* source code, exporting:                Exporting code blocks.
                                                              (line   6)
* source code, extracting:               Extracting source code.
                                                              (line   6)
* source code, inline:                   Structure of code blocks.
                                                              (line  24)
* source code, language:                 Structure of code blocks.
                                                              (line  48)
* source code, languages:                Languages.           (line   6)
* source code, library:                  Library of Babel.    (line   6)
* source code, noweb reference:          Noweb reference syntax.
                                                              (line   6)
* source code, results of evaluation:    Results of evaluation.
                                                              (line   6)
* source code, switches:                 Structure of code blocks.
                                                              (line  52)
* source code, working with:             Working with source code.
                                                              (line   6)
* sparse tree, for deadlines:            Inserting deadline/schedule.
                                                              (line  23)
* sparse tree, for TODO:                 TODO basics.         (line  41)
* sparse tree, tag based:                Tags.                (line   6)
* sparse trees:                          Sparse trees.        (line   6)
* special blocks, in ASCII export:       ASCII/Latin-1/UTF-8 export.
                                                              (line  77)
* special blocks, in LaTeX export:       Special blocks in LaTeX export.
                                                              (line   6)
* special keywords:                      In-buffer settings.  (line   6)
* special symbols:                       Special symbols.     (line   6)
* special symbols, in-buffer display:    Special symbols.     (line  31)
* speed keys:                            Speed keys.          (line   6)
* speedbar.el:                           Cooperation.         (line  30)
* spreadsheet capabilities:              The spreadsheet.     (line   6)
* square brackets, around links:         External links.      (line  68)
* statistics, for checkboxes:            Checkboxes.          (line  30)
* statistics, for TODO items:            Breaking down tasks. (line   6)
* store-link protocol:                   store-link protocol. (line   6)
* storing links:                         Handling links.      (line  10)
* Storm, Kim. F.:                        Conflicts.           (line  18)
* strike-through text, markup rules:     Emphasis and monospace.
                                                              (line   6)
* structure editing:                     Structure editing.   (line   6)
* structure of document:                 Document structure.  (line   6)
* styles, custom:                        Applying custom styles.
                                                              (line   6)
* styles, custom <1>:                    Working with OpenDocument style files.
                                                              (line   6)
* sublevels, inclusion into tags match:  Tag inheritance.     (line   6)
* sublevels, inclusion into TODO list:   Global TODO list.    (line  34)
* subscript:                             Subscripts and superscripts.
                                                              (line   6)
* SUBTITLE (ODT):                        ODT specific export settings.
                                                              (line  26)
* subtree cycling:                       Global and local cycling.
                                                              (line  10)
* subtree visibility states:             Global and local cycling.
                                                              (line  10)
* subtree, cut and paste:                Structure editing.   (line   6)
* subtree, subtree visibility state:     Global and local cycling.
                                                              (line  10)
* subtrees, cut and paste:               Structure editing.   (line   6)
* summary:                               Summary.             (line   6)
* superscript:                           Subscripts and superscripts.
                                                              (line   6)
* syntax checker:                        Org syntax.          (line  24)
* syntax, noweb:                         Noweb reference syntax.
                                                              (line   6)
* syntax, of formulas:                   Formula syntax for Calc.
                                                              (line   6)
* table editor, built-in:                Built-in table editor.
                                                              (line   6)
* table editor, table.el:                Cooperation.         (line  36)
* table lookup functions:                Lookup functions.    (line   6)
* table of contents:                     Table of contents.   (line   6)
* table.el:                              Cooperation.         (line  34)
* table.el <1>:                          Cooperation.         (line  36)
* tables:                                Tables.              (line   6)
* tables, in HTML:                       Tables in HTML export.
                                                              (line   6)
* tables, in LaTeX export:               Tables in LaTeX export.
                                                              (line   6)
* tables, in ODT export:                 Tables in ODT export.
                                                              (line   6)
* tables, in ODT export <1>:             Customizing tables in ODT export.
                                                              (line   6)
* tables, in other modes:                Tables in arbitrary syntax.
                                                              (line   6)
* tables, markup rules:                  Images and tables.   (line   6)
* tag completion:                        Completion.          (line   6)
* tag filtering, in agenda:              Filtering/limiting agenda items.
                                                              (line  17)
* tag hierarchy:                         Tag hierarchy.       (line   6)
* tag inheritance:                       Tag inheritance.     (line   6)
* tag searches:                          Tag searches.        (line   6)
* tags:                                  Tags.                (line   6)
* tags view:                             Matching tags and properties.
                                                              (line   6)
* tags, as an agenda view:               Storing searches.    (line   9)
* tags, groups:                          Tag hierarchy.       (line   6)
* tags, setting:                         Setting tags.        (line   6)
* tags-todo:                             Storing searches.    (line   9)
* tags-tree:                             Storing searches.    (line   9)
* tangling:                              Extracting source code.
                                                              (line   6)
* targets, for links:                    Internal links.      (line   6)
* targets, radio:                        Radio targets.       (line   6)
* tasks, breaking down:                  Breaking down tasks. (line   6)
* tasks, repeated:                       Repeated tasks.      (line   6)
* template insertion:                    Easy templates.      (line   6)
* template, custom:                      Applying custom styles.
                                                              (line   6)
* template, custom <1>:                  Working with OpenDocument style files.
                                                              (line   6)
* templates, for Capture:                Capture templates.   (line   6)
* TeX interpretation:                    Embedded LaTeX.      (line   6)
* TeX symbol completion:                 Completion.          (line   6)
* Texinfo export:                        Texinfo export.      (line   6)
* Texinfo export, data type index:       Indices.             (line   6)
* Texinfo export, dir file:              Info directory file. (line   6)
* Texinfo export, index, concept:        Indices.             (line   6)
* Texinfo export, index, function:       Indices.             (line   6)
* Texinfo export, Info directory file:   Info directory file. (line   6)
* Texinfo export, install-info parameters: Info directory file.
                                                              (line   6)
* Texinfo export, keystroke index:       Indices.             (line   6)
* Texinfo export, program index:         Indices.             (line   6)
* Texinfo export, Top node:              Headings and sectioning structure.
                                                              (line  37)
* Texinfo export, variable index:        Indices.             (line   6)
* text areas, in HTML:                   Text areas in HTML export.
                                                              (line   6)
* text search:                           Search view.         (line   6)
* thanks:                                History and acknowledgments.
                                                              (line   5)
* The Top node, in Texinfo export:       Headings and sectioning structure.
                                                              (line  37)
* time clocking:                         Clocking work time.  (line   6)
* time format, custom:                   Custom time format.  (line   6)
* time grid:                             Time-of-day specifications.
                                                              (line  28)
* Time, computing:                       Durations and time values.
                                                              (line   6)
* time, macro:                           Macro replacement.   (line  36)
* time, reading in minibuffer:           The date/time prompt.
                                                              (line   6)
* time-of-day specification:             Time-of-day specifications.
                                                              (line   6)
* timerange:                             Timestamps.          (line  42)
* times:                                 Dates and times.     (line   6)
* timestamp:                             Dates and times.     (line   6)
* timestamp <1>:                         Timestamps.          (line  14)
* timestamp, inactive:                   Timestamps.          (line  50)
* timestamp, with repeater interval:     Timestamps.          (line  25)
* timestamps:                            Timestamps.          (line   6)
* timestamps, creating:                  Creating timestamps. (line   6)
* title, macro:                          Macro replacement.   (line  24)
* TODO dependencies:                     TODO dependencies.   (line   6)
* TODO dependencies, NOBLOCKING:         TODO dependencies.   (line   6)
* TODO items:                            TODO items.          (line   6)
* TODO keyword matching:                 Global TODO list.    (line  17)
* TODO keyword matching, with tags search: Matching tags and properties.
                                                              (line  67)
* TODO keyword sets:                     Multiple sets in one file.
                                                              (line   6)
* TODO keywords completion:              Completion.          (line   6)
* TODO list, global:                     Global TODO list.    (line   6)
* TODO types:                            TODO types.          (line   6)
* TODO workflow:                         Workflow states.     (line   6)
* todo, as an agenda view:               Storing searches.    (line   9)
* todo-tree:                             Storing searches.    (line   9)
* top headline filtering, in agenda:     Filtering/limiting agenda items.
                                                              (line  17)
* transient mark mode:                   Structure editing.   (line 116)
* transient mark mode <1>:               Built-in table editor.
                                                              (line 145)
* transient-mark-mode:                   ODT export commands. (line   6)
* translator function:                   Translator functions.
                                                              (line   6)
* trees, sparse:                         Sparse trees.        (line   6)
* trees, visibility:                     Visibility cycling.  (line   6)
* tty key bindings:                      TTY keys.            (line   6)
* Two-column tables, in Texinfo export:  Plain lists in Texinfo export.
                                                              (line   6)
* types as TODO keywords:                TODO types.          (line   6)
* underlined text, markup rules:         Emphasis and monospace.
                                                              (line   6)
* undoing remote-editing events:         Agenda commands.     (line 201)
* unison:                                Uploading files.     (line   6)
* unoconv:                               Extending ODT export.
                                                              (line  12)
* updating, table:                       Updating the table.  (line   6)
* URL links:                             External links.      (line   6)
* USENET links:                          External links.      (line   6)
* UTF-8 export:                          ASCII/Latin-1/UTF-8 export.
                                                              (line   6)
* variable index, in Texinfo export:     Indices.             (line   6)
* variables, for customization:          Customization.       (line   6)
* vectors, in table calculations:        Formula syntax for Calc.
                                                              (line  11)
* verbatim blocks, in LaTeX export:      Example blocks in LaTeX export.
                                                              (line   6)
* verbatim text, markup rules:           Emphasis and monospace.
                                                              (line   6)
* verse blocks:                          Paragraphs.          (line  13)
* viper.el:                              Conflicts.           (line  93)
* visibility cycling:                    Visibility cycling.  (line   6)
* visibility cycling, drawers:           Drawers.             (line   6)
* visibility, initialize:                Initial visibility.  (line   6)
* visible text, printing:                Sparse trees.        (line  49)
* VM links:                              External links.      (line  41)
* WANDERLUST links:                      External links.      (line  41)
* weekly agenda:                         Weekly/daily agenda. (line   6)
* windmove.el:                           Conflicts.           (line  80)
* workflow states as TODO keywords:      Workflow states.     (line   6)
* yasnippet.el:                          Conflicts.           (line  54)
* zip:                                   Pre-requisites for ODT export.
                                                              (line   6)


File: org.info,  Node: Key Index,  Next: Command and Function Index,  Prev: Main Index,  Up: Top

Key index
*********

[index]
* Menu:

* $:                                     Agenda commands.     (line 226)
* %:                                     Agenda commands.     (line 320)
* ':                                     CDLaTeX mode.        (line  38)
* *:                                     Agenda commands.     (line 310)
* +:                                     Agenda commands.     (line 243)
* ,:                                     Agenda commands.     (line 237)
* -:                                     Agenda commands.     (line 247)
* .:                                     Agenda commands.     (line  90)
* /:                                     Filtering/limiting agenda items.
                                                              (line  17)
* / <1>:                                 Agenda commands.     (line 176)
* ::                                     Agenda commands.     (line 234)
* ;:                                     Timers.              (line   6)
* <:                                     Using column view.   (line  61)
* < <1>:                                 The date/time prompt.
                                                              (line  82)
* < <2>:                                 Agenda files.        (line  53)
* < <3>:                                 Filtering/limiting agenda items.
                                                              (line  65)
* < <4>:                                 Agenda commands.     (line 180)
* =:                                     Filtering/limiting agenda items.
                                                              (line  80)
* = <1>:                                 Agenda commands.     (line 188)
* >:                                     Using column view.   (line  61)
* > <1>:                                 The date/time prompt.
                                                              (line  82)
* > <2>:                                 Agenda files.        (line  57)
* > <3>:                                 Agenda commands.     (line 276)
* ? (Agenda dispatcher):                 Pulling from the mobile application.
                                                              (line  39)
* [:                                     Filtering/limiting agenda items.
                                                              (line  56)
* [ <1>:                                 Agenda commands.     (line 109)
* ]:                                     Filtering/limiting agenda items.
                                                              (line  56)
* ^:                                     Filtering/limiting agenda items.
                                                              (line  76)
* ^ <1>:                                 Agenda commands.     (line 184)
* ^ <2>:                                 CDLaTeX mode.        (line  30)
* _:                                     Filtering/limiting agenda items.
                                                              (line  91)
* _ <1>:                                 Agenda commands.     (line 191)
* _ <2>:                                 CDLaTeX mode.        (line  30)
* `:                                     CDLaTeX mode.        (line  35)
* {:                                     Filtering/limiting agenda items.
                                                              (line  56)
* |:                                     Filtering/limiting agenda items.
                                                              (line 112)
* | <1>:                                 Agenda commands.     (line 194)
* }:                                     Filtering/limiting agenda items.
                                                              (line  56)
* ~:                                     Filtering/limiting agenda items.
                                                              (line 151)
* a:                                     Using column view.   (line  51)
* A:                                     Agenda commands.     (line  61)
* a <1>:                                 Agenda commands.     (line 217)
* b:                                     Agenda commands.     (line  88)
* B:                                     Agenda commands.     (line 322)
* c:                                     Agenda commands.     (line 381)
* c <1>:                                 Agenda commands.     (line 382)
* C:                                     Agenda commands.     (line 410)
* C-#:                                   Advanced features.   (line  10)
* C-':                                   Agenda files.        (line  21)
* C-,:                                   Agenda files.        (line  21)
* C-0 C-c C-w:                           Refile and copy.     (line  42)
* C-c !:                                 Creating timestamps. (line  15)
* C-c #:                                 Checkboxes.          (line  80)
* C-c $:                                 Moving subtrees.     (line   9)
* C-c %:                                 Handling links.      (line 135)
* C-c &:                                 Handling links.      (line 139)
* C-c ':                                 Footnotes.           (line  81)
* C-c ' <1>:                             Editing and debugging formulas.
                                                              (line  32)
* C-c ' <2>:                             Literal examples.    (line  87)
* C-c ' <3>:                             Include files.       (line  59)
* C-c ' <4>:                             Editing source code. (line   6)
* C-c ' <5>:                             Cooperation.         (line  44)
* C-c *:                                 Structure editing.   (line 106)
* C-c * <1>:                             Plain lists.         (line 130)
* C-c * <2>:                             Updating the table.  (line  13)
* C-c +:                                 Built-in table editor.
                                                              (line 145)
* C-c ,:                                 Priorities.          (line  24)
* C-c -:                                 Plain lists.         (line 119)
* C-c - <1>:                             Built-in table editor.
                                                              (line  94)
* C-c .:                                 Creating timestamps. (line  10)
* C-c /:                                 Sparse trees.        (line  15)
* C-c / <1>:                             Conflicts.           (line  93)
* C-c / /:                               Sparse trees.        (line  17)
* C-c / a:                               Inserting deadline/schedule.
                                                              (line  29)
* C-c / b:                               Inserting deadline/schedule.
                                                              (line  27)
* C-c / d:                               Inserting deadline/schedule.
                                                              (line  21)
* C-c / m:                               Tag searches.        (line   9)
* C-c / m <1>:                           Property searches.   (line  10)
* C-c / p:                               Property searches.   (line  27)
* C-c / r:                               Sparse trees.        (line  17)
* C-c / t:                               TODO basics.         (line  39)
* C-c ;:                                 Comment lines.       (line  19)
* C-c <:                                 Creating timestamps. (line  25)
* C-c =:                                 Column formulas.     (line  32)
* C-c = <1>:                             Editing and debugging formulas.
                                                              (line  13)
* C-c >:                                 Creating timestamps. (line  28)
* C-c ?:                                 Editing and debugging formulas.
                                                              (line  21)
* C-c @:                                 Structure editing.   (line  54)
* C-c a:                                 Conventions.         (line  33)
* C-c a !:                               Stuck projects.      (line  14)
* C-c a #:                               Stuck projects.      (line  13)
* C-c a a:                               Weekly/daily agenda. (line   9)
* C-c a C:                               Storing searches.    (line   9)
* C-c a e:                               Exporting agenda views.
                                                              (line  63)
* C-c a m:                               Tag searches.        (line  13)
* C-c a M:                               Tag searches.        (line  16)
* C-c a m <1>:                           Property searches.   (line  12)
* C-c a M <1>:                           Property searches.   (line  15)
* C-c a m <2>:                           Matching tags and properties.
                                                              (line  12)
* C-c a M <2>:                           Matching tags and properties.
                                                              (line  17)
* C-c a s:                               Search view.         (line   9)
* C-c a t:                               TODO basics.         (line  49)
* C-c a t <1>:                           Global TODO list.    (line   9)
* C-c a T:                               Global TODO list.    (line  15)
* C-c c:                                 Conventions.         (line  33)
* C-c c <1>:                             Using capture.       (line   6)
* C-c c C:                               Capture templates.   (line  10)
* C-c C-*:                               Plain lists.         (line 134)
* C-c C-a:                               Attachments.         (line  26)
* C-c C-a <1>:                           Agenda commands.     (line 253)
* C-c C-a a:                             Attachments.         (line  31)
* C-c C-a c:                             Attachments.         (line  37)
* C-c C-a d:                             Attachments.         (line  66)
* C-c C-a D:                             Attachments.         (line  69)
* C-c C-a f:                             Attachments.         (line  60)
* C-c C-a F:                             Attachments.         (line  63)
* C-c C-a i:                             Attachments.         (line  78)
* C-c C-a l:                             Attachments.         (line  37)
* C-c C-a m:                             Attachments.         (line  37)
* C-c C-a n:                             Attachments.         (line  44)
* C-c C-a o:                             Attachments.         (line  51)
* C-c C-a O:                             Attachments.         (line  57)
* C-c C-a s:                             Attachments.         (line  73)
* C-c C-a u:                             Attachments.         (line  41)
* C-c C-a z:                             Attachments.         (line  47)
* C-c C-b:                               Motion.              (line  13)
* C-c C-b <1>:                           Editing support.     (line  11)
* C-c C-c:                               Plain lists.         (line 115)
* C-c C-c <1>:                           Footnotes.           (line  71)
* C-c C-c <2>:                           Built-in table editor.
                                                              (line  58)
* C-c C-c <3>:                           Editing and debugging formulas.
                                                              (line  41)
* C-c C-c <4>:                           Editing and debugging formulas.
                                                              (line  77)
* C-c C-c <5>:                           Editing and debugging formulas.
                                                              (line  84)
* C-c C-c <6>:                           Checkboxes.          (line  52)
* C-c C-c <7>:                           Setting tags.        (line  19)
* C-c C-c <8>:                           Property syntax.     (line  89)
* C-c C-c <9>:                           Using column view.   (line  46)
* C-c C-c <10>:                          Capturing column view.
                                                              (line  48)
* C-c C-c <11>:                          Creating timestamps. (line  23)
* C-c C-c <12>:                          Clocking commands.   (line  48)
* C-c C-c <13>:                          Clocking commands.   (line  48)
* C-c C-c <14>:                          The clock table.     (line  16)
* C-c C-c <15>:                          Using capture.       (line  15)
* C-c C-c <16>:                          Previewing LaTeX fragments.
                                                              (line  23)
* C-c C-c <17>:                          Evaluating code blocks.
                                                              (line  20)
* C-c C-c <18>:                          Key bindings and useful functions.
                                                              (line  11)
* C-c C-c <19>:                          The very busy C-c C-c key.
                                                              (line   6)
* C-c C-c <20>:                          Cooperation.         (line  36)
* C-c C-c c:                             Property syntax.     (line 102)
* C-c C-c d:                             Property syntax.     (line  98)
* C-c C-c D:                             Property syntax.     (line 100)
* C-c C-c s:                             Property syntax.     (line  92)
* C-c C-d:                               Inserting deadline/schedule.
                                                              (line   9)
* C-c C-d <1>:                           Agenda commands.     (line 258)
* C-c C-e:                               The export dispatcher.
                                                              (line  15)
* C-c C-e c a:                           iCalendar export.    (line  40)
* C-c C-e c c:                           iCalendar export.    (line  43)
* C-c C-e c f:                           iCalendar export.    (line  38)
* C-c C-e C-v:                           Sparse trees.        (line  49)
* C-c C-e h h:                           HTML Export commands.
                                                              (line   6)
* C-c C-e h H:                           HTML Export commands.
                                                              (line  11)
* C-c C-e i i:                           Texinfo export commands.
                                                              (line   8)
* C-c C-e i t:                           Texinfo export commands.
                                                              (line   6)
* C-c C-e l b:                           Beamer export commands.
                                                              (line   6)
* C-c C-e l B:                           Beamer export commands.
                                                              (line   8)
* C-c C-e l l:                           LaTeX export commands.
                                                              (line   6)
* C-c C-e l L:                           LaTeX export commands.
                                                              (line  11)
* C-c C-e l P:                           Beamer export commands.
                                                              (line  10)
* C-c C-e l p:                           LaTeX export commands.
                                                              (line  12)
* C-c C-e m m:                           Markdown export.     (line  16)
* C-c C-e m M:                           Markdown export.     (line  18)
* C-c C-e o o:                           ODT export commands. (line   6)
* C-c C-e O o:                           Org export.          (line  13)
* C-c C-e O O:                           Org export.          (line  17)
* C-c C-e P a:                           Triggering publication.
                                                              (line  14)
* C-c C-e P f:                           Triggering publication.
                                                              (line  12)
* C-c C-e P p:                           Triggering publication.
                                                              (line  10)
* C-c C-e P x:                           Triggering publication.
                                                              (line   8)
* C-c C-e t a/l/u:                       ASCII/Latin-1/UTF-8 export.
                                                              (line  23)
* C-c C-e t A/L/U:                       ASCII/Latin-1/UTF-8 export.
                                                              (line  27)
* C-c C-f:                               Motion.              (line  11)
* C-c C-j:                               Motion.              (line  17)
* C-c C-k:                               Global and local cycling.
                                                              (line  45)
* C-c C-k <1>:                           Using capture.       (line  31)
* C-c C-l:                               Handling links.      (line  64)
* C-c C-n:                               Motion.              (line   8)
* C-c C-o:                               Footnotes.           (line  75)
* C-c C-o <1>:                           Handling links.      (line  98)
* C-c C-o <2>:                           Creating timestamps. (line  32)
* C-c C-o <3>:                           Agenda commands.     (line  53)
* C-c C-o <4>:                           Key bindings and useful functions.
                                                              (line  11)
* C-c C-p:                               Motion.              (line   9)
* C-c C-q:                               Editing and debugging formulas.
                                                              (line  44)
* C-c C-q <1>:                           Setting tags.        (line  10)
* C-c C-r:                               Global and local cycling.
                                                              (line  37)
* C-c C-r <1>:                           Editing and debugging formulas.
                                                              (line  45)
* C-c C-s:                               Inserting deadline/schedule.
                                                              (line  16)
* C-c C-s <1>:                           Agenda commands.     (line 255)
* C-c C-t:                               TODO basics.         (line  13)
* C-c C-t <1>:                           Clocking commands.   (line  61)
* C-c C-u:                               Motion.              (line  15)
* C-c C-v a:                             Key bindings and useful functions.
                                                              (line  37)
* C-c C-v b:                             Key bindings and useful functions.
                                                              (line  25)
* C-c C-v c:                             Key bindings and useful functions.
                                                              (line  30)
* C-c C-v C-a:                           Key bindings and useful functions.
                                                              (line  37)
* C-c C-v C-b:                           Key bindings and useful functions.
                                                              (line  25)
* C-c C-v C-c:                           Key bindings and useful functions.
                                                              (line  30)
* C-c C-v C-d:                           Key bindings and useful functions.
                                                              (line  27)
* C-c C-v C-e:                           Key bindings and useful functions.
                                                              (line  19)
* C-c C-v C-f:                           Key bindings and useful functions.
                                                              (line  29)
* C-c C-v C-g:                           Key bindings and useful functions.
                                                              (line  23)
* C-c C-v C-h:                           Key bindings and useful functions.
                                                              (line  37)
* C-c C-v C-i:                           Key bindings and useful functions.
                                                              (line  33)
* C-c C-v C-I:                           Key bindings and useful functions.
                                                              (line  34)
* C-c C-v C-j:                           Key bindings and useful functions.
                                                              (line  31)
* C-c C-v C-l:                           Key bindings and useful functions.
                                                              (line  32)
* C-c C-v C-n:                           Key bindings and useful functions.
                                                              (line  18)
* C-c C-v C-o:                           Key bindings and useful functions.
                                                              (line  20)
* C-c C-v C-p:                           Key bindings and useful functions.
                                                              (line  18)
* C-c C-v C-r:                           Key bindings and useful functions.
                                                              (line  24)
* C-c C-v C-s:                           Key bindings and useful functions.
                                                              (line  26)
* C-c C-v C-t:                           Key bindings and useful functions.
                                                              (line  28)
* C-c C-v C-u:                           Key bindings and useful functions.
                                                              (line  22)
* C-c C-v C-v:                           Key bindings and useful functions.
                                                              (line  21)
* C-c C-v C-x:                           Key bindings and useful functions.
                                                              (line  38)
* C-c C-v C-z:                           Key bindings and useful functions.
                                                              (line  35)
* C-c C-v d:                             Key bindings and useful functions.
                                                              (line  27)
* C-c C-v e:                             Key bindings and useful functions.
                                                              (line  19)
* C-c C-v f:                             Key bindings and useful functions.
                                                              (line  29)
* C-c C-v g:                             Key bindings and useful functions.
                                                              (line  23)
* C-c C-v h:                             Key bindings and useful functions.
                                                              (line  37)
* C-c C-v i:                             Library of Babel.    (line  12)
* C-c C-v i <1>:                         Key bindings and useful functions.
                                                              (line  33)
* C-c C-v I:                             Key bindings and useful functions.
                                                              (line  34)
* C-c C-v j:                             Key bindings and useful functions.
                                                              (line  31)
* C-c C-v l:                             Key bindings and useful functions.
                                                              (line  32)
* C-c C-v n:                             Key bindings and useful functions.
                                                              (line  18)
* C-c C-v o:                             Key bindings and useful functions.
                                                              (line  20)
* C-c C-v p:                             Key bindings and useful functions.
                                                              (line  18)
* C-c C-v r:                             Key bindings and useful functions.
                                                              (line  24)
* C-c C-v s:                             Key bindings and useful functions.
                                                              (line  26)
* C-c C-v t:                             Extracting source code.
                                                              (line  34)
* C-c C-v t <1>:                         Key bindings and useful functions.
                                                              (line  28)
* C-c C-v u:                             Key bindings and useful functions.
                                                              (line  22)
* C-c C-v v:                             Key bindings and useful functions.
                                                              (line  21)
* C-c C-v x:                             Key bindings and useful functions.
                                                              (line  38)
* C-c C-v z:                             Key bindings and useful functions.
                                                              (line  35)
* C-c C-w:                               Structure editing.   (line  86)
* C-c C-w <1>:                           Using capture.       (line  22)
* C-c C-w <2>:                           Refile and copy.     (line  14)
* C-c C-w <3>:                           Agenda commands.     (line 215)
* C-c C-x ,:                             Timers.              (line  41)
* C-c C-x -:                             Timers.              (line  34)
* C-c C-x .:                             Timers.              (line  30)
* C-c C-x 0:                             Timers.              (line  12)
* C-c C-x ;:                             Timers.              (line  20)
* C-c C-x <:                             Agenda files.        (line  39)
* C-c C-x >:                             Agenda files.        (line  46)
* C-c C-x > <1>:                         Agenda commands.     (line 166)
* C-c C-x a:                             Internal archiving.  (line  33)
* C-c C-x A:                             Internal archiving.  (line  44)
* C-c C-x a <1>:                         Agenda commands.     (line 221)
* C-c C-x A <1>:                         Agenda commands.     (line 223)
* C-c C-x b:                             Global and local cycling.
                                                              (line  51)
* C-c C-x b <1>:                         Agenda commands.     (line  45)
* C-c C-x c:                             Structure editing.   (line  79)
* C-c C-x C-a:                           Archiving.           (line  11)
* C-c C-x C-a <1>:                       Agenda commands.     (line 217)
* C-c C-x C-b:                           Checkboxes.          (line  56)
* C-c C-x C-c:                           Using column view.   (line   9)
* C-c C-x C-c <1>:                       Agenda commands.     (line 156)
* C-c C-x C-c <2>:                       Agenda column view.  (line  11)
* C-c C-x C-d:                           Clocking commands.   (line  71)
* C-c C-x C-e:                           Clocking commands.   (line  46)
* C-c C-x C-e <1>:                       Effort estimates.    (line  17)
* C-c C-x C-i:                           Clocking commands.   (line   6)
* C-c C-x C-j:                           Clocking commands.   (line  67)
* C-c C-x C-l:                           Previewing LaTeX fragments.
                                                              (line  17)
* C-c C-x C-n:                           Handling links.      (line 143)
* C-c C-x C-o:                           Clocking commands.   (line  34)
* C-c C-x C-p:                           Handling links.      (line 143)
* C-c C-x C-q:                           Clocking commands.   (line  64)
* C-c C-x C-r:                           The clock table.     (line  10)
* C-c C-x C-s:                           Moving subtrees.     (line   9)
* C-c C-x C-s <1>:                       Agenda commands.     (line 226)
* C-c C-x C-t:                           Custom time format.  (line  12)
* C-c C-x C-u:                           Capturing column view.
                                                              (line  48)
* C-c C-x C-u <1>:                       The clock table.     (line  16)
* C-c C-x C-u <2>:                       Dynamic blocks.      (line  21)
* C-c C-x C-v:                           Handling links.      (line 127)
* C-c C-x C-w:                           Structure editing.   (line  57)
* C-c C-x C-w <1>:                       Built-in table editor.
                                                              (line 122)
* C-c C-x C-x:                           Clocking commands.   (line  41)
* C-c C-x C-y:                           Structure editing.   (line  63)
* C-c C-x C-y <1>:                       Built-in table editor.
                                                              (line 126)
* C-c C-x d:                             Drawers.             (line   6)
* C-c C-x e:                             Effort estimates.    (line  14)
* C-c C-x f:                             Footnotes.           (line  39)
* C-c C-x g:                             RSS feeds.           (line  23)
* C-c C-x G:                             RSS feeds.           (line  26)
* C-c C-x i:                             Capturing column view.
                                                              (line  46)
* C-c C-x M-w:                           Structure editing.   (line  60)
* C-c C-x M-w <1>:                       Built-in table editor.
                                                              (line 118)
* C-c C-x o:                             TODO dependencies.   (line  37)
* C-c C-x o <1>:                         Checkboxes.          (line  73)
* C-c C-x p:                             Property syntax.     (line  82)
* C-c C-x p <1>:                         Header arguments in Org mode properties.
                                                              (line  31)
* C-c C-x q:                             Tag hierarchy.       (line  86)
* C-c C-x v:                             Global and local cycling.
                                                              (line  56)
* C-c C-x \:                             Special symbols.     (line  34)
* C-c C-x \ <1>:                         Subscripts and superscripts.
                                                              (line  20)
* C-c C-x _:                             Timers.              (line  43)
* C-c C-y:                               Creating timestamps. (line  50)
* C-c C-y <1>:                           Clocking commands.   (line  48)
* C-c C-y <2>:                           Clocking commands.   (line  48)
* C-c C-z:                               Drawers.             (line  35)
* C-c C-z <1>:                           Agenda commands.     (line 249)
* C-c l:                                 Handling links.      (line   9)
* C-c l <1>:                             Literal examples.    (line  95)
* C-c M-w:                               Refile and copy.     (line  12)
* C-c <RET>:                             Built-in table editor.
                                                              (line  97)
* C-c <SPC>:                             Built-in table editor.
                                                              (line  59)
* C-c <TAB>:                             Global and local cycling.
                                                              (line  48)
* C-c [:                                 Agenda files.        (line  15)
* C-c \:                                 Tag searches.        (line   9)
* C-c \ <1>:                             Property searches.   (line  10)
* C-c ]:                                 Agenda files.        (line  19)
* C-c ^:                                 Structure editing.   (line  89)
* C-c ^ <1>:                             Plain lists.         (line 142)
* C-c ^ <2>:                             Built-in table editor.
                                                              (line 100)
* C-c `:                                 Built-in table editor.
                                                              (line 161)
* C-c {:                                 Editing and debugging formulas.
                                                              (line  29)
* C-c { <1>:                             CDLaTeX mode.        (line  20)
* C-c |:                                 Built-in table editor.
                                                              (line  41)
* C-c | <1>:                             Built-in table editor.
                                                              (line 177)
* C-c }:                                 Editing and debugging formulas.
                                                              (line  24)
* C-c } <1>:                             Editing and debugging formulas.
                                                              (line  67)
* C-c ~:                                 Cooperation.         (line  46)
* C-k:                                   Agenda commands.     (line 210)
* C-M-i:                                 Completion.          (line  38)
* C-<RET>:                               Structure editing.   (line  23)
* C-S-LEFT:                              Multiple sets in one file.
                                                              (line  25)
* C-S-<LEFT>:                            Agenda commands.     (line 209)
* C-S-<RET>:                             Structure editing.   (line  28)
* C-S-RIGHT:                             Multiple sets in one file.
                                                              (line  25)
* C-S-<RIGHT>:                           Agenda commands.     (line 207)
* C-S-<up/down>:                         Clocking commands.   (line  52)
* C-<TAB>:                               Internal archiving.  (line  42)
* C-u C-c !:                             Creating timestamps. (line  17)
* C-u C-c *:                             Updating the table.  (line  16)
* C-u C-c .:                             Creating timestamps. (line  17)
* C-u C-c =:                             Field and range formulas.
                                                              (line  27)
* C-u C-c = <1>:                         Editing and debugging formulas.
                                                              (line  13)
* C-u C-c c:                             Using capture.       (line  42)
* C-u C-c C-c:                           Updating the table.  (line  18)
* C-u C-c C-l:                           Handling links.      (line  85)
* C-u C-c C-t:                           TODO basics.         (line  28)
* C-u C-c C-w:                           Refile and copy.     (line  32)
* C-u C-c C-x a:                         Internal archiving.  (line  36)
* C-u C-c C-x C-s:                       Moving subtrees.     (line  11)
* C-u C-c C-x C-u:                       Capturing column view.
                                                              (line  50)
* C-u C-c C-x C-u <1>:                   The clock table.     (line  18)
* C-u C-c C-x C-u <2>:                   Dynamic blocks.      (line  22)
* C-u C-u C-c *:                         Updating the table.  (line  21)
* C-u C-u C-c =:                         Editing and debugging formulas.
                                                              (line  16)
* C-u C-u C-c c:                         Using capture.       (line  44)
* C-u C-u C-c C-c:                       Updating the table.  (line  21)
* C-u C-u C-c C-t:                       Multiple sets in one file.
                                                              (line  25)
* C-u C-u C-c C-w:                       Refile and copy.     (line  34)
* C-u C-u C-c C-x C-s:                   Moving subtrees.     (line  17)
* C-u C-u C-u C-c C-t:                   TODO dependencies.   (line  42)
* C-u C-u C-u <TAB>:                     Global and local cycling.
                                                              (line  35)
* C-u C-u <TAB>:                         Global and local cycling.
                                                              (line  33)
* C-u C-u <TAB> <1>:                     Initial visibility.  (line  21)
* C-v:                                   The date/time prompt.
                                                              (line  82)
* C-x C-s:                               Editing and debugging formulas.
                                                              (line  41)
* C-x C-s <1>:                           Agenda commands.     (line 153)
* C-x C-w:                               Agenda commands.     (line 425)
* C-x C-w <1>:                           Exporting agenda views.
                                                              (line  12)
* C-x n b:                               Structure editing.   (line 102)
* C-x n s:                               Structure editing.   (line 100)
* C-x n w:                               Structure editing.   (line 104)
* C-y:                                   Structure editing.   (line  68)
* C-_:                                   Agenda commands.     (line 201)
* d:                                     Agenda commands.     (line  65)
* D:                                     Agenda commands.     (line  96)
* e:                                     Using column view.   (line  41)
* E:                                     Agenda commands.     (line 136)
* F:                                     Agenda commands.     (line  39)
* f:                                     Agenda commands.     (line  83)
* g:                                     Using column view.   (line  23)
* G:                                     Agenda commands.     (line 142)
* g <1>:                                 Agenda commands.     (line 151)
* H:                                     Agenda commands.     (line 413)
* I:                                     Agenda commands.     (line 279)
* i:                                     Agenda commands.     (line 385)
* j:                                     Agenda commands.     (line  92)
* J:                                     Agenda commands.     (line  94)
* J <1>:                                 Agenda commands.     (line 286)
* k:                                     Agenda commands.     (line 288)
* L:                                     Agenda commands.     (line  33)
* l:                                     Agenda commands.     (line  99)
* m:                                     Agenda commands.     (line 308)
* M:                                     Agenda commands.     (line 403)
* M-*:                                   Agenda commands.     (line 318)
* M-<down>:                              Agenda commands.     (line 301)
* M-<up>:                                Agenda commands.     (line 297)
* M-a:                                   Built-in table editor.
                                                              (line  70)
* M-<DOWN>:                              Structure editing.   (line  47)
* M-DOWN:                                Plain lists.         (line  93)
* M-<DOWN> <1>:                          Built-in table editor.
                                                              (line  86)
* M-<DOWN> <2>:                          Editing and debugging formulas.
                                                              (line  64)
* M-DOWN <1>:                            Key bindings and useful functions.
                                                              (line  13)
* M-e:                                   Built-in table editor.
                                                              (line  73)
* M-g M-n:                               Sparse trees.        (line  28)
* M-g M-p:                               Sparse trees.        (line  30)
* M-g n:                                 Sparse trees.        (line  28)
* M-g p:                                 Sparse trees.        (line  30)
* M-h:                                   Structure editing.   (line  49)
* M-<LEFT>:                              Structure editing.   (line  37)
* M-LEFT:                                Plain lists.         (line  98)
* M-<LEFT> <1>:                          Built-in table editor.
                                                              (line  80)
* M-m:                                   Agenda commands.     (line 316)
* M-<RET>:                               Structure editing.   (line   6)
* M-<RET> <1>:                           Plain lists.         (line  77)
* M-<RET> <2>:                           Built-in table editor.
                                                              (line 131)
* M-<RET> <3>:                           Timers.              (line  38)
* M-<RIGHT>:                             Structure editing.   (line  39)
* M-RIGHT:                               Plain lists.         (line  98)
* M-<RIGHT> <1>:                         Built-in table editor.
                                                              (line  80)
* M-S-<DOWN>:                            Built-in table editor.
                                                              (line  91)
* M-S-<DOWN> <1>:                        Editing and debugging formulas.
                                                              (line  60)
* M-S-DOWN:                              The date/time prompt.
                                                              (line  82)
* M-S-<LEFT>:                            Structure editing.   (line  41)
* M-S-LEFT:                              Plain lists.         (line 102)
* M-S-<LEFT> <1>:                        Built-in table editor.
                                                              (line  82)
* M-S-LEFT <1>:                          The date/time prompt.
                                                              (line  82)
* M-S-<RET>:                             Structure editing.   (line  25)
* M-S-RET:                               Plain lists.         (line  86)
* M-S-<RET> <1>:                         Checkboxes.          (line  71)
* M-S-<RIGHT>:                           Structure editing.   (line  43)
* M-S-RIGHT:                             Plain lists.         (line 102)
* M-S-<RIGHT> <1>:                       Built-in table editor.
                                                              (line  84)
* M-S-RIGHT <1>:                         The date/time prompt.
                                                              (line  82)
* M-S-<UP>:                              Built-in table editor.
                                                              (line  89)
* M-S-<UP> <1>:                          Editing and debugging formulas.
                                                              (line  60)
* M-S-UP:                                The date/time prompt.
                                                              (line  82)
* M-<TAB>:                               Editing and debugging formulas.
                                                              (line  54)
* M-TAB:                                 Per-file keywords.   (line  23)
* M-TAB <1>:                             Setting tags.        (line   6)
* M-<TAB> <1>:                           Property syntax.     (line  80)
* M-TAB <2>:                             Completion.          (line  15)
* M-<UP>:                                Structure editing.   (line  45)
* M-UP:                                  Plain lists.         (line  93)
* M-<UP> <1>:                            Built-in table editor.
                                                              (line  86)
* M-<UP> <2>:                            Editing and debugging formulas.
                                                              (line  64)
* M-UP <1>:                              Key bindings and useful functions.
                                                              (line  12)
* M-v:                                   The date/time prompt.
                                                              (line  82)
* mouse-1:                               Footnotes.           (line  75)
* mouse-1 <1>:                           Handling links.      (line 120)
* mouse-1 <2>:                           The date/time prompt.
                                                              (line  82)
* mouse-2:                               Footnotes.           (line  75)
* mouse-2 <1>:                           Handling links.      (line 120)
* mouse-2 <2>:                           Agenda commands.     (line  35)
* mouse-3:                               Handling links.      (line 124)
* mouse-3 <1>:                           Agenda commands.     (line  31)
* n:                                     Using column view.   (line  38)
* n <1>:                                 Agenda commands.     (line  19)
* N:                                     Agenda commands.     (line  22)
* o:                                     Agenda commands.     (line  63)
* O:                                     Agenda commands.     (line 282)
* p:                                     Using column view.   (line  38)
* p <1>:                                 Agenda commands.     (line  20)
* P:                                     Agenda commands.     (line  24)
* P <1>:                                 Agenda commands.     (line 241)
* q:                                     Using column view.   (line  25)
* q <1>:                                 Agenda commands.     (line 439)
* r:                                     Using column view.   (line  20)
* r <1>:                                 Global TODO list.    (line  22)
* R:                                     Agenda commands.     (line 118)
* r <2>:                                 Agenda commands.     (line 145)
* <RET>:                                 Built-in table editor.
                                                              (line  66)
* <RET> <1>:                             Handling links.      (line 118)
* RET:                                   Setting tags.        (line 116)
* RET <1>:                               The date/time prompt.
                                                              (line  82)
* <RET> <2>:                             Agenda commands.     (line  37)
* s:                                     Agenda commands.     (line 153)
* S:                                     Agenda commands.     (line 406)
* S-DOWN:                                Plain lists.         (line  87)
* S-DOWN <1>:                            Editing and debugging formulas.
                                                              (line  56)
* S-<DOWN>:                              Priorities.          (line  28)
* S-<DOWN> <1>:                          Creating timestamps. (line  39)
* S-DOWN <2>:                            The date/time prompt.
                                                              (line  82)
* S-<DOWN> <2>:                          Agenda commands.     (line 247)
* S-LEFT:                                Plain lists.         (line 138)
* S-LEFT <1>:                            Editing and debugging formulas.
                                                              (line  56)
* S-LEFT <2>:                            TODO basics.         (line  34)
* S-LEFT <3>:                            Multiple sets in one file.
                                                              (line  32)
* S-<LEFT>:                              Property syntax.     (line  95)
* S-LEFT <4>:                            Using column view.   (line  33)
* S-<LEFT> <1>:                          Creating timestamps. (line  35)
* S-LEFT <5>:                            The date/time prompt.
                                                              (line  82)
* S-<LEFT> <2>:                          The clock table.     (line  21)
* S-<LEFT> <3>:                          Agenda commands.     (line 273)
* S-M-<LEFT>:                            Using column view.   (line  65)
* S-M-<RET>:                             TODO basics.         (line  56)
* S-M-<RIGHT>:                           Using column view.   (line  63)
* S-M-<up/down>:                         Clocking commands.   (line  55)
* S-<RET>:                               Built-in table editor.
                                                              (line 148)
* S-RIGHT:                               Plain lists.         (line 138)
* S-RIGHT <1>:                           Editing and debugging formulas.
                                                              (line  56)
* S-RIGHT <2>:                           TODO basics.         (line  34)
* S-RIGHT <3>:                           Multiple sets in one file.
                                                              (line  32)
* S-<RIGHT>:                             Property syntax.     (line  95)
* S-RIGHT <4>:                           Using column view.   (line  33)
* S-<RIGHT> <1>:                         Creating timestamps. (line  35)
* S-RIGHT <5>:                           The date/time prompt.
                                                              (line  82)
* S-<RIGHT> <2>:                         The clock table.     (line  21)
* S-<RIGHT> <3>:                         Agenda commands.     (line 261)
* S-<TAB>:                               Global and local cycling.
                                                              (line  18)
* S-<TAB> <1>:                           Built-in table editor.
                                                              (line  64)
* S-UP:                                  Editing and debugging formulas.
                                                              (line  56)
* S-<UP>:                                Priorities.          (line  28)
* S-<UP> <1>:                            Creating timestamps. (line  39)
* S-UP <1>:                              The date/time prompt.
                                                              (line  82)
* S-<UP> <2>:                            Agenda commands.     (line 243)
* SPC:                                   Setting tags.        (line 113)
* <SPC>:                                 Agenda commands.     (line  31)
* t:                                     Agenda commands.     (line 204)
* T:                                     Agenda commands.     (line 230)
* <TAB>:                                 Global and local cycling.
                                                              (line  10)
* <TAB> <1>:                             Structure editing.   (line  32)
* <TAB> <2>:                             Plain lists.         (line  66)
* <TAB> <3>:                             Built-in table editor.
                                                              (line  61)
* <TAB> <4>:                             Editing and debugging formulas.
                                                              (line  48)
* TAB:                                   Setting tags.        (line 107)
* <TAB> <5>:                             Agenda commands.     (line  35)
* TAB <1>:                               CDLaTeX mode.        (line  21)
* u:                                     Agenda commands.     (line 312)
* U:                                     Agenda commands.     (line 314)
* v:                                     Using column view.   (line  48)
* v a:                                   Agenda commands.     (line 112)
* v A:                                   Agenda commands.     (line 114)
* v c:                                   Agenda commands.     (line 128)
* v d:                                   Agenda commands.     (line  65)
* v E:                                   Agenda commands.     (line 136)
* v l:                                   Agenda commands.     (line  99)
* v L:                                   Agenda commands.     (line 101)
* v m:                                   Agenda commands.     (line  69)
* v R:                                   Agenda commands.     (line 118)
* v <SPC>:                               Agenda commands.     (line  71)
* v t:                                   Agenda commands.     (line  68)
* v w:                                   Agenda commands.     (line  67)
* v y:                                   Agenda commands.     (line  70)
* v [:                                   Agenda commands.     (line 109)
* w:                                     Agenda commands.     (line  67)
* X:                                     Agenda commands.     (line 284)
* x:                                     Agenda commands.     (line 440)
* z:                                     Agenda commands.     (line 249)


File: org.info,  Node: Command and Function Index,  Next: Variable Index,  Prev: Key Index,  Up: Top

Command and function index
**************************

[index]
* Menu:

* lisp-complete-symbol:                  Editing and debugging formulas.
                                                              (line  54)
* next-error:                            Sparse trees.        (line  28)
* org-agenda:                            Activation.          (line   6)
* org-agenda <1>:                        Conventions.         (line  33)
* org-agenda-add-note:                   Agenda commands.     (line 249)
* org-agenda-archive:                    Agenda commands.     (line 226)
* org-agenda-archive-default-with-confirmation: Agenda commands.
                                                              (line 217)
* org-agenda-archive-to-archive-sibling: Agenda commands.     (line 223)
* org-agenda-archives-mode:              Agenda commands.     (line 112)
* org-agenda-archives-mode 'files:       Agenda commands.     (line 114)
* org-agenda-bulk-action:                Agenda commands.     (line 322)
* org-agenda-bulk-mark:                  Agenda commands.     (line 308)
* org-agenda-bulk-mark-all:              Agenda commands.     (line 310)
* org-agenda-bulk-mark-regexp:           Agenda commands.     (line 320)
* org-agenda-bulk-remove-all-marks:      Agenda commands.     (line 314)
* org-agenda-bulk-toggle:                Agenda commands.     (line 316)
* org-agenda-bulk-toggle-all:            Agenda commands.     (line 318)
* org-agenda-bulk-unmark:                Agenda commands.     (line 312)
* org-agenda-capture:                    Agenda commands.     (line 288)
* org-agenda-clock-cancel:               Agenda commands.     (line 284)
* org-agenda-clock-goto:                 Agenda commands.     (line  94)
* org-agenda-clock-goto <1>:             Agenda commands.     (line 286)
* org-agenda-clock-in:                   Agenda commands.     (line 279)
* org-agenda-clock-out:                  Agenda commands.     (line 282)
* org-agenda-clockreport-mode:           Agenda commands.     (line 118)
* org-agenda-columns:                    Agenda commands.     (line 156)
* org-agenda-columns <1>:                Agenda column view.  (line  11)
* org-agenda-convert-date:               Agenda commands.     (line 410)
* org-agenda-date-prompt:                Agenda commands.     (line 276)
* org-agenda-day-view:                   Agenda commands.     (line  65)
* org-agenda-deadline:                   Agenda commands.     (line 258)
* org-agenda-diary-entry:                Agenda commands.     (line 385)
* org-agenda-do-date-earlier:            Agenda commands.     (line 273)
* org-agenda-do-date-later:              Agenda commands.     (line 261)
* org-agenda-drag-line-backward:         Agenda commands.     (line 297)
* org-agenda-drag-line-forward:          Agenda commands.     (line 301)
* org-agenda-earlier:                    Agenda commands.     (line  88)
* org-agenda-entry-text-mode:            Agenda commands.     (line 136)
* org-agenda-exit:                       Agenda commands.     (line 440)
* org-agenda-file-to-front:              Agenda files.        (line  15)
* org-agenda-filter-by-category:         Filtering/limiting agenda items.
                                                              (line  65)
* org-agenda-filter-by-category <1>:     Agenda commands.     (line 180)
* org-agenda-filter-by-effort:           Filtering/limiting agenda items.
                                                              (line  91)
* org-agenda-filter-by-effort <1>:       Agenda commands.     (line 191)
* org-agenda-filter-by-regexp:           Filtering/limiting agenda items.
                                                              (line  80)
* org-agenda-filter-by-regexp <1>:       Agenda commands.     (line 188)
* org-agenda-filter-by-tag:              Filtering/limiting agenda items.
                                                              (line  17)
* org-agenda-filter-by-tag <1>:          Agenda commands.     (line 176)
* org-agenda-filter-by-top-headline:     Filtering/limiting agenda items.
                                                              (line  76)
* org-agenda-filter-by-top-headline <1>: Agenda commands.     (line 184)
* org-agenda-filter-remove-all:          Filtering/limiting agenda items.
                                                              (line 112)
* org-agenda-filter-remove-all <1>:      Agenda commands.     (line 194)
* org-agenda-follow-mode:                Agenda commands.     (line  39)
* org-agenda-fortnight-view:             Agenda commands.     (line  68)
* org-agenda-goto:                       Agenda commands.     (line  35)
* org-agenda-goto-calendar:              Agenda commands.     (line 381)
* org-agenda-goto-date:                  Agenda commands.     (line  92)
* org-agenda-goto-today:                 Agenda commands.     (line  90)
* org-agenda-holidays:                   Agenda commands.     (line 413)
* org-agenda-kill:                       Agenda commands.     (line 210)
* org-agenda-later:                      Agenda commands.     (line  83)
* org-agenda-limit-interactively:        Filtering/limiting agenda items.
                                                              (line 151)
* org-agenda-list:                       Weekly/daily agenda. (line   9)
* org-agenda-list-stuck-projects:        Stuck projects.      (line  13)
* org-agenda-log-mode:                   Agenda commands.     (line  99)
* org-agenda-manipulate-query-add:       Agenda commands.     (line 109)
* org-agenda-month-view:                 Agenda commands.     (line  69)
* org-agenda-next-item:                  Agenda commands.     (line  22)
* org-agenda-next-line:                  Agenda commands.     (line  19)
* org-agenda-open-link:                  Agenda commands.     (line  53)
* org-agenda-phases-of-moon:             Agenda commands.     (line 403)
* org-agenda-previous-item:              Agenda commands.     (line  24)
* org-agenda-previous-line:              Agenda commands.     (line  20)
* org-agenda-priority-down:              Agenda commands.     (line 247)
* org-agenda-priority-up:                Agenda commands.     (line 243)
* org-agenda-quit:                       Agenda commands.     (line 439)
* org-agenda-recenter:                   Agenda commands.     (line  33)
* org-agenda-redo:                       Agenda commands.     (line 145)
* org-agenda-redo <1>:                   Agenda commands.     (line 151)
* org-agenda-refile:                     Agenda commands.     (line 215)
* org-agenda-remove-restriction-lock:    Agenda files.        (line  46)
* org-agenda-remove-restriction-lock <1>: Agenda files.       (line  57)
* org-agenda-remove-restriction-lock <2>: Agenda commands.    (line 166)
* org-agenda-reset-view:                 Agenda commands.     (line  71)
* org-agenda-schedule:                   Agenda commands.     (line 255)
* org-agenda-set-restriction-lock:       Agenda files.        (line  39)
* org-agenda-set-tags:                   Agenda commands.     (line 234)
* org-agenda-show-and-scroll-up:         Agenda commands.     (line  31)
* org-agenda-show-priority:              Agenda commands.     (line 241)
* org-agenda-show-tags:                  Agenda commands.     (line 230)
* org-agenda-sunrise-sunset:             Agenda commands.     (line 406)
* org-agenda-switch-to:                  Agenda commands.     (line  37)
* org-agenda-todo:                       Agenda commands.     (line 204)
* org-agenda-todo-nextset:               Agenda commands.     (line 207)
* org-agenda-todo-previousset:           Agenda commands.     (line 209)
* org-agenda-toggle-archive-tag:         Agenda commands.     (line 221)
* org-agenda-toggle-diary:               Agenda commands.     (line  96)
* org-agenda-toggle-time-grid:           Agenda commands.     (line 142)
* org-agenda-tree-to-indirect-buffer:    Agenda commands.     (line  45)
* org-agenda-undo:                       Agenda commands.     (line 201)
* org-agenda-week-view:                  Agenda commands.     (line  67)
* org-agenda-write:                      Agenda commands.     (line 425)
* org-agenda-write <1>:                  Exporting agenda views.
                                                              (line  12)
* org-agenda-year-view:                  Agenda commands.     (line  70)
* org-archive-subtree:                   Moving subtrees.     (line   9)
* org-archive-subtree-default:           Archiving.           (line  11)
* org-archive-to-archive-sibling:        Internal archiving.  (line  44)
* org-ascii-export-as-ascii:             ASCII/Latin-1/UTF-8 export.
                                                              (line  27)
* org-ascii-export-to-ascii:             ASCII/Latin-1/UTF-8 export.
                                                              (line  23)
* org-attach:                            Attachments.         (line  26)
* org-attach <1>:                        Agenda commands.     (line 253)
* org-attach-attach:                     Attachments.         (line  31)
* org-attach-delete-all:                 Attachments.         (line  69)
* org-attach-delete-one:                 Attachments.         (line  66)
* org-attach-new:                        Attachments.         (line  44)
* org-attach-open:                       Attachments.         (line  51)
* org-attach-open-in-emacs:              Attachments.         (line  57)
* org-attach-reveal:                     Attachments.         (line  60)
* org-attach-reveal-in-emacs:            Attachments.         (line  63)
* org-attach-set-directory:              Attachments.         (line  73)
* org-attach-set-inherit:                Attachments.         (line  78)
* org-attach-sync:                       Attachments.         (line  47)
* org-attach-url:                        Attachments.         (line  41)
* org-backward-same-level:               Motion.              (line  13)
* org-beamer-export-as-latex:            Beamer export commands.
                                                              (line   8)
* org-beamer-export-to-latex:            Beamer export commands.
                                                              (line   6)
* org-beamer-export-to-pdf:              Beamer export commands.
                                                              (line  10)
* org-beamer-select-environment:         Editing support.     (line  11)
* org-buffer-property-keys:              Using the property API.
                                                              (line  33)
* org-calendar-goto-agenda:              Agenda commands.     (line 382)
* org-capture:                           Activation.          (line   6)
* org-capture <1>:                       Conventions.         (line  33)
* org-capture <2>:                       Using capture.       (line   6)
* org-capture-finalize:                  Using capture.       (line  15)
* org-capture-kill:                      Using capture.       (line  31)
* org-capture-refile:                    Using capture.       (line  22)
* org-check-after-date:                  Inserting deadline/schedule.
                                                              (line  29)
* org-check-before-date:                 Inserting deadline/schedule.
                                                              (line  27)
* org-check-deadlines:                   Inserting deadline/schedule.
                                                              (line  21)
* org-clock-cancel:                      Clocking commands.   (line  64)
* org-clock-display:                     Clocking commands.   (line  71)
* org-clock-goto:                        Clocking commands.   (line  67)
* org-clock-in:                          Clocking commands.   (line   6)
* org-clock-in-last:                     Clocking commands.   (line  41)
* org-clock-modify-effort-estimate:      Clocking commands.   (line  46)
* org-clock-modify-effort-estimate <1>:  Effort estimates.    (line  17)
* org-clock-out:                         Clocking commands.   (line  34)
* org-clock-report:                      The clock table.     (line  10)
* org-clock-timestamps-up/down:          Clocking commands.   (line  52)
* org-clocktable-try-shift:              The clock table.     (line  21)
* org-clone-subtree-with-time-shift:     Structure editing.   (line  79)
* org-columns:                           Using column view.   (line   9)
* org-columns-delete:                    Using column view.   (line  65)
* org-columns-edit-allowed:              Using column view.   (line  51)
* org-columns-edit-value:                Using column view.   (line  41)
* org-columns-narrow:                    Using column view.   (line  61)
* org-columns-new:                       Using column view.   (line  63)
* org-columns-next-allowed-value:        Using column view.   (line  38)
* org-columns-previous-allowed-value:    Using column view.   (line  38)
* org-columns-quit:                      Using column view.   (line  25)
* org-columns-redo:                      Using column view.   (line  20)
* org-columns-redo <1>:                  Using column view.   (line  23)
* org-columns-set-tags-or-toggle:        Using column view.   (line  46)
* org-columns-show-value:                Using column view.   (line  48)
* org-columns-widen:                     Using column view.   (line  61)
* org-compute-property-at-point:         Property syntax.     (line 102)
* org-copy:                              Refile and copy.     (line  12)
* org-copy <1>:                          Refile and copy.     (line  13)
* org-copy-subtree:                      Structure editing.   (line  60)
* org-copy-visible:                      Global and local cycling.
                                                              (line  56)
* org-cut-subtree:                       Structure editing.   (line  57)
* org-cycle:                             Global and local cycling.
                                                              (line  10)
* org-cycle <1>:                         Structure editing.   (line  32)
* org-cycle <2>:                         Plain lists.         (line  66)
* org-cycle-agenda-files:                Agenda files.        (line  21)
* org-date-from-calendar:                Creating timestamps. (line  25)
* org-dblock-update:                     Capturing column view.
                                                              (line  48)
* org-dblock-update <1>:                 The clock table.     (line  16)
* org-dblock-update <2>:                 Dynamic blocks.      (line  21)
* org-deadline:                          Inserting deadline/schedule.
                                                              (line   9)
* org-delete-property:                   Property syntax.     (line  98)
* org-delete-property-globally:          Property syntax.     (line 100)
* org-demote:                            Using the mapping API.
                                                              (line  76)
* org-demote-subtree:                    Structure editing.   (line  43)
* org-do-demote:                         Structure editing.   (line  39)
* org-do-promote:                        Structure editing.   (line  37)
* org-edit-special:                      Cooperation.         (line  44)
* org-entities-help:                     Special symbols.     (line  16)
* org-entry-add-to-multivalued-property: Using the property API.
                                                              (line  50)
* org-entry-delete:                      Using the property API.
                                                              (line  27)
* org-entry-get:                         Using the property API.
                                                              (line  18)
* org-entry-get-multivalued-property:    Using the property API.
                                                              (line  45)
* org-entry-member-in-multivalued-property: Using the property API.
                                                              (line  61)
* org-entry-properties:                  Using the property API.
                                                              (line   8)
* org-entry-put:                         Using the property API.
                                                              (line  30)
* org-entry-put-multivalued-property:    Using the property API.
                                                              (line  39)
* org-entry-remove-from-multivalued-property: Using the property API.
                                                              (line  55)
* org-evaluate-time-range:               Creating timestamps. (line  50)
* org-evaluate-time-range <1>:           Clocking commands.   (line  48)
* org-export-dispatch:                   The export dispatcher.
                                                              (line  15)
* org-feed-goto-inbox:                   RSS feeds.           (line  26)
* org-feed-update-all:                   RSS feeds.           (line  23)
* org-force-cycle-archived:              Internal archiving.  (line  42)
* org-forward-same-level:                Motion.              (line  11)
* org-global-cycle:                      Global and local cycling.
                                                              (line  18)
* org-goto:                              Motion.              (line  17)
* org-goto-calendar:                     Creating timestamps. (line  28)
* org-html-export-as-html:               HTML Export commands.
                                                              (line  11)
* org-html-export-to-html:               HTML Export commands.
                                                              (line   6)
* org-icalendar-combine-agenda-files:    iCalendar export.    (line  43)
* org-icalendar-export-agenda-files:     iCalendar export.    (line  40)
* org-icalendar-export-to-ics:           iCalendar export.    (line  38)
* org-insert-columns-dblock:             Capturing column view.
                                                              (line  46)
* org-insert-heading:                    Plain lists.         (line  77)
* org-insert-heading <1>:                Timers.              (line  38)
* org-insert-heading-respect-content:    Structure editing.   (line  23)
* org-insert-link:                       Handling links.      (line  64)
* org-insert-property-drawer:            Using the property API.
                                                              (line  18)
* org-insert-property-drawer <1>:        Using the property API.
                                                              (line  36)
* org-insert-todo-heading:               Structure editing.   (line  25)
* org-insert-todo-heading <1>:           TODO basics.         (line  56)
* org-insert-todo-heading <2>:           Checkboxes.          (line  71)
* org-insert-todo-heading-respect-content: Structure editing. (line  28)
* org-latex-export-as-latex:             LaTeX export commands.
                                                              (line  11)
* org-latex-export-to-latex:             LaTeX export commands.
                                                              (line   6)
* org-latex-export-to-pdf:               LaTeX export commands.
                                                              (line  12)
* org-lookup-all:                        Lookup functions.    (line  20)
* org-lookup-first:                      Lookup functions.    (line   8)
* org-lookup-last:                       Lookup functions.    (line  17)
* org-map-entries:                       Using the mapping API.
                                                              (line  11)
* org-mark-element:                      Structure editing.   (line  49)
* org-mark-ring-goto:                    Handling links.      (line 139)
* org-mark-ring-push:                    Handling links.      (line 135)
* org-mark-subtree:                      Structure editing.   (line  54)
* org-match-sparse-tree:                 Tag searches.        (line   9)
* org-match-sparse-tree <1>:             Property searches.   (line  10)
* org-md-export-as-markdown:             Markdown export.     (line  18)
* org-md-export-to-markdown:             Markdown export.     (line  16)
* org-meta-return:                       Structure editing.   (line   6)
* org-mobile-pull:                       Pulling from the mobile application.
                                                              (line   6)
* org-mobile-push:                       Pushing to the mobile application.
                                                              (line   6)
* org-move-subtree-down:                 Structure editing.   (line  47)
* org-move-subtree-up:                   Structure editing.   (line  45)
* org-narrow-to-block:                   Structure editing.   (line 102)
* org-narrow-to-subtree:                 Structure editing.   (line 100)
* org-next-link:                         Handling links.      (line 143)
* org-next-visible-heading:              Motion.              (line   8)
* org-occur:                             Sparse trees.        (line  17)
* org-odt-export-to-odt:                 ODT export commands. (line   6)
* org-open-at-point:                     Handling links.      (line  98)
* org-open-at-point <1>:                 Creating timestamps. (line  32)
* org-org-export-as-org:                 Org export.          (line  17)
* org-org-export-to-org:                 Org export.          (line  13)
* org-paste-subtree:                     Structure editing.   (line  63)
* org-previous-link:                     Handling links.      (line 143)
* org-previous-visible-heading:          Motion.              (line   9)
* org-priority:                          Priorities.          (line  24)
* org-priority <1>:                      Using the mapping API.
                                                              (line  64)
* org-priority-down:                     Priorities.          (line  28)
* org-priority-up:                       Priorities.          (line  28)
* org-promote:                           Using the mapping API.
                                                              (line  73)
* org-promote-subtree:                   Structure editing.   (line  41)
* org-property-action:                   Property syntax.     (line  89)
* org-property-next-allowed-value:       Property syntax.     (line  95)
* org-property-previous-allowed-value:   Property syntax.     (line  95)
* org-protocol-create:                   open-source protocol.
                                                              (line  67)
* org-protocol-create-for-org:           open-source protocol.
                                                              (line  67)
* org-publish:                           Triggering publication.
                                                              (line   8)
* org-publish-all:                       Triggering publication.
                                                              (line  14)
* org-publish-current-file:              Triggering publication.
                                                              (line  12)
* org-publish-current-project:           Triggering publication.
                                                              (line  10)
* org-refile:                            Structure editing.   (line  86)
* org-refile <1>:                        Refile and copy.     (line  14)
* org-refile <2>:                        Refile and copy.     (line  16)
* org-refile-cache-clear:                Refile and copy.     (line  42)
* org-refile-goto-last-stored:           Refile and copy.     (line  34)
* org-remove-file:                       Agenda files.        (line  19)
* org-reveal:                            Global and local cycling.
                                                              (line  37)
* org-save-all-org-buffers:              Agenda commands.     (line 153)
* org-schedule:                          Inserting deadline/schedule.
                                                              (line  16)
* org-search-view:                       Search view.         (line   9)
* org-set-effort:                        Effort estimates.    (line  14)
* org-set-property:                      Property syntax.     (line  82)
* org-set-property <1>:                  Property syntax.     (line  92)
* org-set-startup-visibility:            Global and local cycling.
                                                              (line  33)
* org-set-startup-visibility <1>:        Initial visibility.  (line  21)
* org-set-tags-command:                  Setting tags.        (line  10)
* org-set-tags-command <1>:              Setting tags.        (line  19)
* org-show-todo-tree:                    TODO basics.         (line  39)
* org-sort:                              Structure editing.   (line  89)
* org-sparse-tree:                       Sparse trees.        (line  15)
* org-speed-command-help:                Speed keys.          (line  18)
* org-speedbar-set-agenda-restriction:   Agenda files.        (line  53)
* org-store-agenda-views:                Exporting agenda views.
                                                              (line  63)
* org-store-link:                        Activation.          (line   6)
* org-store-link <1>:                    Handling links.      (line   9)
* org-switchb:                           Activation.          (line   6)
* org-table-align:                       Built-in table editor.
                                                              (line  58)
* org-table-beginning-of-field:          Built-in table editor.
                                                              (line  70)
* org-table-blank-field:                 Built-in table editor.
                                                              (line  59)
* org-table-copy-down:                   Built-in table editor.
                                                              (line 148)
* org-table-copy-region:                 Built-in table editor.
                                                              (line 118)
* org-table-create-or-convert-from-region: Built-in table editor.
                                                              (line  41)
* org-table-create-or-convert-from-region <1>: Built-in table editor.
                                                              (line 177)
* org-table-create-with-table.el:        Cooperation.         (line  46)
* org-table-cut-region:                  Built-in table editor.
                                                              (line 122)
* org-table-delete-column:               Built-in table editor.
                                                              (line  82)
* org-table-edit-field:                  Built-in table editor.
                                                              (line 161)
* org-table-edit-formulas:               Editing and debugging formulas.
                                                              (line  32)
* org-table-end-of-field:                Built-in table editor.
                                                              (line  73)
* org-table-eval-formula:                Field and range formulas.
                                                              (line  27)
* org-table-eval-formula <1>:            Column formulas.     (line  32)
* org-table-eval-formula <2>:            Editing and debugging formulas.
                                                              (line  13)
* org-table-eval-formula <3>:            Editing and debugging formulas.
                                                              (line  16)
* org-table-export:                      Built-in table editor.
                                                              (line 183)
* org-table-fedit-abort:                 Editing and debugging formulas.
                                                              (line  44)
* org-table-fedit-finish:                Editing and debugging formulas.
                                                              (line  41)
* org-table-fedit-line-down:             Editing and debugging formulas.
                                                              (line  60)
* org-table-fedit-line-up:               Editing and debugging formulas.
                                                              (line  60)
* org-table-fedit-lisp-indent:           Editing and debugging formulas.
                                                              (line  48)
* org-table-fedit-ref-down:              Editing and debugging formulas.
                                                              (line  56)
* org-table-fedit-ref-left:              Editing and debugging formulas.
                                                              (line  56)
* org-table-fedit-ref-right:             Editing and debugging formulas.
                                                              (line  56)
* org-table-fedit-ref-up:                Editing and debugging formulas.
                                                              (line  56)
* org-table-fedit-scroll-down:           Editing and debugging formulas.
                                                              (line  64)
* org-table-fedit-scroll-up:             Editing and debugging formulas.
                                                              (line  64)
* org-table-fedit-toggle-ref-type:       Editing and debugging formulas.
                                                              (line  45)
* org-table-field-info:                  Editing and debugging formulas.
                                                              (line  21)
* org-table-hline-and-move:              Built-in table editor.
                                                              (line  97)
* org-table-insert-column:               Built-in table editor.
                                                              (line  84)
* org-table-insert-hline:                Built-in table editor.
                                                              (line  94)
* org-table-insert-row:                  Built-in table editor.
                                                              (line  91)
* org-table-iterate:                     Updating the table.  (line  21)
* org-table-iterate-buffer-tables:       Updating the table.  (line  29)
* org-table-kill-row:                    Built-in table editor.
                                                              (line  89)
* org-table-move-column-left:            Built-in table editor.
                                                              (line  80)
* org-table-move-column-right:           Built-in table editor.
                                                              (line  80)
* org-table-move-row-down:               Built-in table editor.
                                                              (line  86)
* org-table-move-row-up:                 Built-in table editor.
                                                              (line  86)
* org-table-next-field:                  Built-in table editor.
                                                              (line  61)
* org-table-next-row:                    Built-in table editor.
                                                              (line  66)
* org-table-paste-rectangle:             Built-in table editor.
                                                              (line 126)
* org-table-previous-field:              Built-in table editor.
                                                              (line  64)
* org-table-recalculate:                 Updating the table.  (line  13)
* org-table-recalculate-buffer-tables:   Updating the table.  (line  27)
* org-table-rotate-recalc-marks:         Advanced features.   (line  10)
* org-table-sort-lines:                  Built-in table editor.
                                                              (line 100)
* org-table-sum:                         Built-in table editor.
                                                              (line 145)
* org-table-toggle-coordinate-overlays:  Editing and debugging formulas.
                                                              (line  24)
* org-table-toggle-coordinate-overlays <1>: Editing and debugging formulas.
                                                              (line  67)
* org-table-toggle-formula-debugger:     Editing and debugging formulas.
                                                              (line  29)
* org-table-wrap-region:                 Built-in table editor.
                                                              (line 131)
* org-tags-view:                         Tag searches.        (line  13)
* org-tags-view <1>:                     Tag searches.        (line  16)
* org-tags-view <2>:                     Property searches.   (line  12)
* org-tags-view <3>:                     Property searches.   (line  15)
* org-tags-view <4>:                     Matching tags and properties.
                                                              (line  12)
* org-tags-view <5>:                     Matching tags and properties.
                                                              (line  17)
* org-texinfo-export-to-info:            Texinfo export commands.
                                                              (line   8)
* org-texinfo-export-to-texinfo:         Texinfo export commands.
                                                              (line   6)
* org-time-stamp:                        Creating timestamps. (line  10)
* org-time-stamp-inactive:               Creating timestamps. (line  15)
* org-timer:                             Timers.              (line  30)
* org-timer-item:                        Timers.              (line  34)
* org-timer-pause-or-continue:           Timers.              (line  41)
* org-timer-set-timer:                   Timers.              (line  20)
* org-timer-start:                       Timers.              (line  12)
* org-timer-stop:                        Timers.              (line  43)
* org-timestamp-down-day:                Creating timestamps. (line  35)
* org-timestamp-down-down:               Creating timestamps. (line  39)
* org-timestamp-up:                      Creating timestamps. (line  39)
* org-timestamp-up-day:                  Creating timestamps. (line  35)
* org-timestamp-up/down:                 Clocking commands.   (line  55)
* org-todo:                              TODO basics.         (line  13)
* org-todo <1>:                          Clocking commands.   (line  61)
* org-todo <2>:                          Using the mapping API.
                                                              (line  60)
* org-todo-list:                         TODO basics.         (line  49)
* org-todo-list <1>:                     Global TODO list.    (line   9)
* org-todo-list <2>:                     Global TODO list.    (line  15)
* org-toggle-archive-tag:                Internal archiving.  (line  33)
* org-toggle-checkbox:                   Checkboxes.          (line  52)
* org-toggle-checkbox <1>:               Checkboxes.          (line  56)
* org-toggle-heading:                    Structure editing.   (line 106)
* org-toggle-inline-images:              Handling links.      (line 127)
* org-toggle-ordered-property:           TODO dependencies.   (line  37)
* org-toggle-ordered-property <1>:       Checkboxes.          (line  73)
* org-toggle-tag:                        Using the mapping API.
                                                              (line  68)
* org-toggle-time-stamp-overlays:        Custom time format.  (line  12)
* org-tree-to-indirect-buffer:           Global and local cycling.
                                                              (line  51)
* org-update-all-dblocks:                Capturing column view.
                                                              (line  50)
* org-update-statistics-cookies:         Checkboxes.          (line  80)
* org-yank:                              Structure editing.   (line  68)
* outline-show-all:                      Global and local cycling.
                                                              (line  35)
* outline-show-branches:                 Global and local cycling.
                                                              (line  45)
* outline-show-children:                 Global and local cycling.
                                                              (line  48)
* outline-up-heading:                    Motion.              (line  15)
* pcomplete:                             Property syntax.     (line  80)
* previous-error:                        Sparse trees.        (line  30)
* widen:                                 Structure editing.   (line 104)


File: org.info,  Node: Variable Index,  Prev: Command and Function Index,  Up: Top

Variable index
**************

This is not a complete index of variables and faces, only the ones that
are mentioned in the manual.  For a complete list, use ‘M-x
org-customize <RET>’.

[index]
* Menu:

* cdlatex-simplify-sub-super-scripts:    CDLaTeX mode.        (line  30)
* constants-unit-system:                 References.          (line 115)
* constants-unit-system <1>:             In-buffer settings.  (line 135)
* htmlize-output-type:                   Exporting agenda views.
                                                              (line  20)
* LaTeX-verbatim-environments:           A LaTeX example.     (line  19)
* org-adapt-indentation:                 Clean view.          (line  52)
* org-agenda-add-entry-text-maxlines:    Exporting agenda views.
                                                              (line  20)
* org-agenda-bulk-custom-functions:      Agenda commands.     (line 308)
* org-agenda-category-filter-preset:     Filtering/limiting agenda items.
                                                              (line  66)
* org-agenda-clock-consistency-checks:   Agenda commands.     (line 130)
* org-agenda-columns-add-appointments-to-effort-sum: Effort estimates.
                                                              (line  40)
* org-agenda-confirm-kill:               Agenda commands.     (line 212)
* org-agenda-custom-commands:            Sparse trees.        (line  34)
* org-agenda-custom-commands <1>:        Storing searches.    (line   9)
* org-agenda-custom-commands <2>:        Setting options.     (line   6)
* org-agenda-custom-commands <3>:        Setting options.     (line  31)
* org-agenda-custom-commands <4>:        Extracting agenda information.
                                                              (line   6)
* org-agenda-custom-commands-contexts:   Setting options.     (line  60)
* org-agenda-diary-file:                 Agenda commands.     (line 387)
* org-agenda-dim-blocked-tasks:          TODO dependencies.   (line  46)
* org-agenda-dim-blocked-tasks <1>:      Speeding up your agendas.
                                                              (line  13)
* org-agenda-effort-filter-preset:       Filtering/limiting agenda items.
                                                              (line  92)
* org-agenda-entry-text-maxlines:        Agenda commands.     (line 137)
* org-agenda-exporter-settings:          Agenda commands.     (line 426)
* org-agenda-exporter-settings <1>:      Exporting agenda views.
                                                              (line  13)
* org-agenda-files:                      Agenda files.        (line   6)
* org-agenda-files <1>:                  Sorting agenda items.
                                                              (line   8)
* org-agenda-files <2>:                  iCalendar export.    (line  42)
* org-agenda-inhibit-startup:            Initial visibility.  (line   6)
* org-agenda-inhibit-startup <1>:        Speeding up your agendas.
                                                              (line  15)
* org-agenda-log-mode-items:             Agenda commands.     (line 101)
* org-agenda-max-effort:                 Filtering/limiting agenda items.
                                                              (line 118)
* org-agenda-max-entries:                Filtering/limiting agenda items.
                                                              (line 118)
* org-agenda-max-tags:                   Filtering/limiting agenda items.
                                                              (line 118)
* org-agenda-max-todos:                  Filtering/limiting agenda items.
                                                              (line 118)
* org-agenda-ndays:                      Weekly/daily agenda. (line  15)
* org-agenda-overriding-header:          Special agenda views.
                                                              (line  38)
* org-agenda-prefix-format:              Presentation and sorting.
                                                              (line   6)
* org-agenda-regexp-filter-preset:       Filtering/limiting agenda items.
                                                              (line  81)
* org-agenda-restore-windows-after-quit: Agenda views.        (line  37)
* org-agenda-show-inherited-tags:        Agenda commands.     (line 232)
* org-agenda-show-inherited-tags <1>:    Speeding up your agendas.
                                                              (line  17)
* org-agenda-skip-archived-trees:        Internal archiving.  (line  20)
* org-agenda-skip-archived-trees <1>:    Agenda views.        (line  32)
* org-agenda-skip-comment-trees:         Agenda views.        (line  32)
* org-agenda-skip-deadline-prewarning-if-scheduled: Deadlines and scheduling.
                                                              (line  15)
* org-agenda-skip-function:              Special agenda views.
                                                              (line   6)
* org-agenda-skip-function <1>:          Special agenda views.
                                                              (line  41)
* org-agenda-skip-function <2>:          Using the mapping API.
                                                              (line  48)
* org-agenda-skip-function-global:       Special agenda views.
                                                              (line   6)
* org-agenda-skip-scheduled-delay-if-deadline: Deadlines and scheduling.
                                                              (line  44)
* org-agenda-skip-scheduled-if-deadline-is-shown: Repeated tasks.
                                                              (line  72)
* org-agenda-skip-scheduled-if-done:     Deadlines and scheduling.
                                                              (line  36)
* org-agenda-sorting-strategy:           Sorting agenda items.
                                                              (line  25)
* org-agenda-span:                       Weekly/daily agenda. (line  15)
* org-agenda-span <1>:                   Agenda commands.     (line  72)
* org-agenda-start-day:                  Weekly/daily agenda. (line  15)
* org-agenda-start-on-weekday:           Weekly/daily agenda. (line  15)
* org-agenda-start-with-clockreport-mode: Agenda commands.    (line 120)
* org-agenda-start-with-entry-text-mode: Agenda commands.     (line 137)
* org-agenda-start-with-follow-mode:     Agenda commands.     (line  41)
* org-agenda-sticky:                     Agenda dispatcher.   (line  43)
* org-agenda-tag-filter-preset:          Filtering/limiting agenda items.
                                                              (line  18)
* org-agenda-tags-column:                Presentation and sorting.
                                                              (line   6)
* org-agenda-tags-todo-honor-ignore-options: Matching tags and properties.
                                                              (line  19)
* org-agenda-text-search-extra-files:    Agenda dispatcher.   (line  25)
* org-agenda-text-search-extra-files <1>: Search view.        (line  24)
* org-agenda-time-grid:                  Time-of-day specifications.
                                                              (line  43)
* org-agenda-time-grid <1>:              Agenda commands.     (line 144)
* org-agenda-todo-ignore-deadlines:      Global TODO list.    (line  37)
* org-agenda-todo-ignore-scheduled:      Global TODO list.    (line  37)
* org-agenda-todo-ignore-timestamp:      Global TODO list.    (line  37)
* org-agenda-todo-ignore-with-date:      Global TODO list.    (line  37)
* org-agenda-todo-list-sublevels:        Breaking down tasks. (line   6)
* org-agenda-todo-list-sublevels <1>:    Global TODO list.    (line  45)
* org-agenda-use-tag-inheritance:        Tag inheritance.     (line  32)
* org-agenda-use-tag-inheritance <1>:    Speeding up your agendas.
                                                              (line  17)
* org-agenda-use-time-grid:              Time-of-day specifications.
                                                              (line  43)
* org-agenda-use-time-grid <1>:          Agenda commands.     (line 144)
* org-agenda-window-setup:               Agenda views.        (line  37)
* org-archive-default-command:           Archiving.           (line  12)
* org-archive-default-command <1>:       Agenda commands.     (line 219)
* org-archive-location:                  Moving subtrees.     (line  10)
* org-archive-location <1>:              In-buffer settings.  (line  14)
* org-archive-save-context-info:         Moving subtrees.     (line  39)
* org-ascii-links-to-notes:              ASCII/Latin-1/UTF-8 export.
                                                              (line  16)
* org-ascii-text-width:                  ASCII/Latin-1/UTF-8 export.
                                                              (line  13)
* org-attach-directory:                  Attachments.         (line   6)
* org-attach-method:                     Attachments.         (line  32)
* org-babel-default-header-args:         System-wide header arguments.
                                                              (line   6)
* org-babel-default-header-args <1>:     Header arguments in Org mode properties.
                                                              (line  31)
* org-babel-load-languages:              Languages.           (line  35)
* org-beamer-environments-default:       Sectioning Frames and Blocks in Beamer.
                                                              (line  21)
* org-beamer-environments-extra:         Sectioning Frames and Blocks in Beamer.
                                                              (line  21)
* org-beamer-frame-level:                Sectioning Frames and Blocks in Beamer.
                                                              (line  10)
* org-beamer-subtitle-format:            Beamer specific export settings.
                                                              (line  44)
* org-beamer-theme:                      Beamer specific export settings.
                                                              (line  11)
* org-calc-default-modes:                Formula syntax for Calc.
                                                              (line  14)
* org-capture-bookmark:                  Using capture.       (line  48)
* org-capture-templates:                 Capture templates.   (line  11)
* org-capture-templates-contexts:        Templates in contexts.
                                                              (line   6)
* org-capture-use-agenda-date:           Agenda commands.     (line 292)
* org-catch-invisible-edits:             Catching invisible edits.
                                                              (line   6)
* org-checkbox-hierarchical-statistics:  Checkboxes.          (line  30)
* org-clock-continuously:                Clocking commands.   (line   7)
* org-clock-continuously <1>:            Clocking commands.   (line  43)
* org-clock-continuously <2>:            Resolving idle time. (line  74)
* org-clock-idle-time:                   Resolving idle time. (line  14)
* org-clock-into-drawer:                 Clocking commands.   (line   7)
* org-clock-modeline-total:              Clocking commands.   (line  20)
* org-clock-report-include-clocking-task: Agenda commands.    (line 120)
* org-clock-x11idle-program-name:        Resolving idle time. (line   9)
* org-clocktable-defaults:               The clock table.     (line  34)
* org-closed-keep-when-no-todo:          Closing items.       (line  11)
* org-coderef-label-format:              Literal examples.    (line  75)
* org-columns-default-format:            Using column view.   (line  10)
* org-columns-default-format <1>:        Effort estimates.    (line  30)
* org-columns-default-format <2>:        Agenda commands.     (line 158)
* org-columns-default-format <3>:        Agenda column view.  (line  18)
* org-columns-skip-archived-trees:       Internal archiving.  (line  28)
* org-columns-summary-types:             Column attributes.   (line  64)
* org-confirm-babel-evaluate:            Code evaluation security.
                                                              (line  25)
* org-confirm-elisp-link-function:       Code evaluation security.
                                                              (line  51)
* org-confirm-shell-link-function:       Code evaluation security.
                                                              (line  49)
* org-create-file-search-functions:      Custom searches.     (line  12)
* org-ctrl-c-ctrl-c-hook:                Context-sensitive commands.
                                                              (line   6)
* org-ctrl-k-protect-subtree:            Headlines.           (line   6)
* org-cycle-emulate-tab:                 Global and local cycling.
                                                              (line  16)
* org-cycle-global-at-bob:               Global and local cycling.
                                                              (line  29)
* org-cycle-include-plain-lists:         Plain lists.         (line  67)
* org-cycle-open-archived-trees:         Internal archiving.  (line  12)
* org-cycle-separator-lines:             Headlines.           (line  26)
* org-deadline-warning-days:             Deadlines and scheduling.
                                                              (line  15)
* org-deadline-warning-days <1>:         Inserting deadline/schedule.
                                                              (line  23)
* org-default-notes-file:                Setting up capture.  (line   9)
* org-default-notes-file <1>:            Template elements.   (line  45)
* org-default-priority:                  Priorities.          (line  36)
* org-default-priority <1>:              In-buffer settings.  (line  39)
* org-display-custom-times:              Custom time format.  (line   6)
* org-display-internal-link-with-indirect-buffer: Handling links.
                                                              (line 126)
* org-disputed-keys:                     Conflicts.           (line  28)
* org-done (face):                       Faces for TODO keywords.
                                                              (line   6)
* org-edit-footnote-reference:           Footnotes.           (line  81)
* org-edit-src-auto-save-idle-delay:     Editing source code. (line   6)
* org-edit-src-turn-on-auto-save:        Editing source code. (line   6)
* org-emphasis-alist:                    Emphasis and monospace.
                                                              (line   6)
* org-emphasis-regexp-components:        Emphasis and monospace.
                                                              (line   6)
* org-enforce-todo-dependencies:         TODO dependencies.   (line   6)
* org-enforce-todo-dependencies <1>:     TODO dependencies.   (line  51)
* org-entities-user:                     Special symbols.     (line  16)
* org-execute-file-search-functions:     Custom searches.     (line  12)
* org-export-allow-bind-keywords:        Export settings.     (line 210)
* org-export-async-init-file:            The export dispatcher.
                                                              (line  28)
* org-export-backends:                   Exporting.           (line  33)
* org-export-backends <1>:               Other built-in back-ends.
                                                              (line   6)
* org-export-before-parsing-hook:        Advanced configuration.
                                                              (line   9)
* org-export-before-processing-hook:     Advanced configuration.
                                                              (line   9)
* org-export-creator-string:             Export settings.     (line  28)
* org-export-creator-string <1>:         HTML preamble and postamble.
                                                              (line   6)
* org-export-date-timestamp-format:      Export settings.     (line  32)
* org-export-default-language:           Export settings.     (line  38)
* org-export-dispatch-use-expert-ui:     The export dispatcher.
                                                              (line   6)
* org-export-exclude-tags:               Export settings.     (line  52)
* org-export-global-macros:              Macro replacement.   (line   6)
* org-export-headline-levels:            Export settings.     (line 141)
* org-export-in-background:              The export dispatcher.
                                                              (line  39)
* org-export-initial-scope:              The export dispatcher.
                                                              (line  48)
* org-export-preserve-breaks:            Export settings.     (line  93)
* org-export-select-tags:                Export settings.     (line  44)
* org-export-time-stamp-file:            Export settings.     (line 186)
* org-export-time-stamp-file <1>:        HTML preamble and postamble.
                                                              (line   6)
* org-export-use-babel:                  Exporting code blocks.
                                                              (line  33)
* org-export-with-archived-trees:        Internal archiving.  (line  25)
* org-export-with-archived-trees <1>:    Export settings.     (line 102)
* org-export-with-author:                Export settings.     (line 107)
* org-export-with-broken-links:          Export settings.     (line 111)
* org-export-with-clocks:                Export settings.     (line 116)
* org-export-with-creator:               Export settings.     (line 119)
* org-export-with-date:                  Export settings.     (line 127)
* org-export-with-drawers:               Drawers.             (line  38)
* org-export-with-drawers <1>:           Export settings.     (line 123)
* org-export-with-email:                 Export settings.     (line 134)
* org-export-with-entities:              Export settings.     (line 131)
* org-export-with-fixed-width:           Export settings.     (line  86)
* org-export-with-footnotes:             Export settings.     (line 138)
* org-export-with-inlinetasks:           Export settings.     (line 146)
* org-export-with-latex:                 LaTeX fragments.     (line  37)
* org-export-with-latex <1>:             Export settings.     (line 182)
* org-export-with-planning:              Export settings.     (line 156)
* org-export-with-priority:              Export settings.     (line 162)
* org-export-with-properties:            Drawers.             (line  38)
* org-export-with-properties <1>:        Export settings.     (line 165)
* org-export-with-section-numbers:       Export settings.     (line 149)
* org-export-with-smart-quotes:          Export settings.     (line  73)
* org-export-with-special-strings:       Export settings.     (line  82)
* org-export-with-statistics-cookies:    Export settings.     (line 169)
* org-export-with-sub-superscripts:      Export settings.     (line  97)
* org-export-with-tables:                Export settings.     (line 201)
* org-export-with-tags:                  Export settings.     (line 173)
* org-export-with-tasks:                 Export settings.     (line 177)
* org-export-with-timestamps:            Export settings.     (line  89)
* org-export-with-title:                 Export settings.     (line 190)
* org-export-with-toc:                   Export settings.     (line 193)
* org-export-with-toc <1>:               Table of contents.   (line   6)
* org-export-with-todo-keywords:         Export settings.     (line 197)
* org-fast-tag-selection-include-todo:   Fast access to TODO states.
                                                              (line  16)
* org-fast-tag-selection-single-key:     Setting tags.        (line 142)
* org-file-apps:                         Handling links.      (line 100)
* org-file-apps <1>:                     Attachments.         (line  52)
* org-fontify-emphasized-text:           Emphasis and monospace.
                                                              (line   6)
* org-footnote-auto-adjust:              Footnotes.           (line  45)
* org-footnote-auto-adjust <1>:          In-buffer settings.  (line 140)
* org-footnote-auto-label:               Footnotes.           (line  32)
* org-footnote-auto-label <1>:           In-buffer settings.  (line 140)
* org-footnote-define-inline:            Footnotes.           (line  45)
* org-footnote-define-inline <1>:        In-buffer settings.  (line 140)
* org-footnote-section:                  Headlines.           (line  18)
* org-footnote-section <1>:              Footnotes.           (line  45)
* org-format-latex-header:               LaTeX fragments.     (line   6)
* org-format-latex-header <1>:           Previewing LaTeX fragments.
                                                              (line  12)
* org-format-latex-options:              Previewing LaTeX fragments.
                                                              (line  12)
* org-from-is-user-regexp:               Template expansion.  (line  49)
* org-global-properties:                 Property syntax.     (line  75)
* org-global-properties <1>:             Effort estimates.    (line  30)
* org-goto-auto-isearch:                 Motion.              (line  21)
* org-goto-interface:                    Motion.              (line  32)
* org-group-tags:                        Tag hierarchy.       (line  86)
* org-hide (face):                       Clean view.          (line  70)
* org-hide-block-startup:                Blocks.              (line   6)
* org-hide-leading-stars:                In-buffer settings.  (line 119)
* org-hide-leading-stars <1>:            Clean view.          (line  55)
* org-hierarchical-todo-statistics:      Breaking down tasks. (line  25)
* org-highest-priority:                  Priorities.          (line  36)
* org-highest-priority <1>:              In-buffer settings.  (line  39)
* org-html-container-element:            HTML Specific export settings.
                                                              (line  19)
* org-html-doctype:                      HTML Specific export settings.
                                                              (line  16)
* org-html-doctype <1>:                  HTML doctypes.       (line   8)
* org-html-doctype-alist:                HTML doctypes.       (line   8)
* org-html-head:                         HTML Specific export settings.
                                                              (line  35)
* org-html-head <1>:                     CSS support.         (line  43)
* org-html-head-extra:                   HTML Specific export settings.
                                                              (line  39)
* org-html-head-extra <1>:               CSS support.         (line  43)
* org-html-head-include-default-style:   CSS support.         (line  43)
* org-html-html5-elements:               HTML doctypes.       (line  58)
* org-html-html5-fancy:                  HTML doctypes.       (line  25)
* org-html-infojs-options:               JavaScript support.  (line  51)
* org-html-inline-images:                Images in HTML export.
                                                              (line   6)
* org-html-link-home:                    HTML Specific export settings.
                                                              (line  23)
* org-html-link-org-files-as-html:       Links in HTML export.
                                                              (line   6)
* org-html-link-up:                      HTML Specific export settings.
                                                              (line  26)
* org-html-mathjax-options:              HTML Specific export settings.
                                                              (line  30)
* org-html-postamble:                    HTML preamble and postamble.
                                                              (line   6)
* org-html-postamble-format:             HTML preamble and postamble.
                                                              (line   6)
* org-html-preamble:                     HTML preamble and postamble.
                                                              (line   6)
* org-html-preamble-format:              HTML preamble and postamble.
                                                              (line   6)
* org-html-style-default:                CSS support.         (line  43)
* org-html-table-align-individual-fields: Tables in HTML export.
                                                              (line  19)
* org-html-table-caption-above:          Tables in HTML export.
                                                              (line  23)
* org-html-table-data-tags:              Tables in HTML export.
                                                              (line  26)
* org-html-table-default-attributes:     Tables in HTML export.
                                                              (line   6)
* org-html-table-default-attributes <1>: Tables in HTML export.
                                                              (line  29)
* org-html-table-header-tags:            Tables in HTML export.
                                                              (line  32)
* org-html-table-row-tags:               Tables in HTML export.
                                                              (line  35)
* org-html-table-use-header-tags-for-first-column: Tables in HTML export.
                                                              (line  38)
* org-html-tag-class-prefix:             CSS support.         (line   6)
* org-html-todo-kwd-class-prefix:        CSS support.         (line   6)
* org-html-use-infojs:                   JavaScript support.  (line  51)
* org-html-validation-link:              HTML preamble and postamble.
                                                              (line   6)
* org-icalendar-alarm-time:              iCalendar export.    (line   6)
* org-icalendar-categories:              iCalendar export.    (line   6)
* org-icalendar-combined-agenda-file:    iCalendar export.    (line  45)
* org-icalendar-include-body:            iCalendar export.    (line  49)
* org-icalendar-include-todo:            iCalendar export.    (line   6)
* org-icalendar-store-UID:               iCalendar export.    (line  26)
* org-icalendar-use-deadline:            iCalendar export.    (line   6)
* org-icalendar-use-scheduled:           iCalendar export.    (line   6)
* org-id-link-to-org-use-id:             Handling links.      (line  21)
* org-imenu-depth:                       Cooperation.         (line  27)
* org-insert-mode-line-in-empty-file:    Activation.          (line  27)
* org-irc-link-to-logs:                  Handling links.      (line  45)
* org-keep-stored-link-after-insertion:  Handling links.      (line  65)
* org-latex-bibtex-compiler:             LaTeX export commands.
                                                              (line  19)
* org-latex-classes:                     LaTeX specific export settings.
                                                              (line  20)
* org-latex-classes <1>:                 LaTeX specific export settings.
                                                              (line  36)
* org-latex-classes <2>:                 LaTeX specific export settings.
                                                              (line  41)
* org-latex-classes <3>:                 LaTeX header and sectioning.
                                                              (line  13)
* org-latex-compiler:                    LaTeX export commands.
                                                              (line  19)
* org-latex-compiler <1>:                LaTeX specific export settings.
                                                              (line  32)
* org-latex-default-class:               LaTeX specific export settings.
                                                              (line  20)
* org-latex-default-class <1>:           LaTeX header and sectioning.
                                                              (line  13)
* org-latex-default-packages-alist:      LaTeX export commands.
                                                              (line  19)
* org-latex-default-packages-alist <1>:  LaTeX header and sectioning.
                                                              (line  13)
* org-latex-default-table-environment:   Tables in LaTeX export.
                                                              (line  21)
* org-latex-default-table-mode:          Tables in LaTeX export.
                                                              (line  11)
* org-latex-images-centered:             Images in LaTeX export.
                                                              (line  46)
* org-latex-listings:                    Literal examples.    (line  23)
* org-latex-listings-options:            Source blocks in LaTeX export.
                                                              (line  21)
* org-latex-minted-options:              Source blocks in LaTeX export.
                                                              (line  21)
* org-latex-packages-alist:              LaTeX header and sectioning.
                                                              (line  13)
* org-latex-subtitle-format:             LaTeX specific export settings.
                                                              (line  55)
* org-latex-subtitle-separate:           LaTeX specific export settings.
                                                              (line  55)
* org-latex-tables-booktabs:             Tables in LaTeX export.
                                                              (line  58)
* org-latex-tables-centered:             Tables in LaTeX export.
                                                              (line  58)
* org-latex-to-mathml-convert-command:   Working with LaTeX math snippets.
                                                              (line  21)
* org-latex-to-mathml-jar-file:          Working with LaTeX math snippets.
                                                              (line  21)
* org-link-abbrev-alist:                 Link abbreviations.  (line  12)
* org-link-abbrev-alist <1>:             In-buffer settings.  (line  35)
* org-link-frame-setup:                  Handling links.      (line 100)
* org-link-parameters:                   Handling links.      (line  65)
* org-list-allow-alphabetical:           Plain lists.         (line  13)
* org-list-automatic-rules:              Plain lists.         (line  60)
* org-list-automatic-rules <1>:          Plain lists.         (line  79)
* org-list-automatic-rules <2>:          Checkboxes.          (line   6)
* org-list-demote-modify-bullet:         Plain lists.         (line  54)
* org-list-indent-offset:                Plain lists.         (line  54)
* org-list-use-circular-motion:          Plain lists.         (line  90)
* org-log-done:                          Tracking TODO state changes.
                                                              (line  29)
* org-log-done <1>:                      Agenda commands.     (line 101)
* org-log-done <2>:                      In-buffer settings.  (line  94)
* org-log-into-drawer:                   Tracking TODO state changes.
                                                              (line   6)
* org-log-into-drawer <1>:               Agenda commands.     (line 251)
* org-log-note-clock-out:                Clocking commands.   (line  36)
* org-log-note-clock-out <1>:            In-buffer settings.  (line  94)
* org-log-refile:                        Refile and copy.     (line  16)
* org-log-repeat:                        Repeated tasks.      (line  37)
* org-log-repeat <1>:                    In-buffer settings.  (line  94)
* org-log-states-order-reversed:         Tracking TODO state changes.
                                                              (line   6)
* org-lowest-priority:                   Priorities.          (line  36)
* org-lowest-priority <1>:               In-buffer settings.  (line  39)
* org-M-RET-may-split-line:              Structure editing.   (line   7)
* org-M-RET-may-split-line <1>:          Plain lists.         (line  79)
* org-md-headline-style:                 Markdown export.     (line  27)
* org-mobile-directory:                  Setting up the staging area.
                                                              (line   6)
* org-mobile-encryption:                 Setting up the staging area.
                                                              (line  19)
* org-mobile-files:                      Pushing to the mobile application.
                                                              (line   6)
* org-mobile-inbox-for-pull:             Pulling from the mobile application.
                                                              (line  12)
* org-odd-levels-only:                   Matching tags and properties.
                                                              (line  67)
* org-odd-levels-only <1>:               In-buffer settings.  (line 119)
* org-odd-levels-only <2>:               Clean view.          (line  75)
* org-odd-levels-only <3>:               Special agenda views.
                                                              (line  41)
* org-odt-category-map-alist:            Labels and captions in ODT export.
                                                              (line  21)
* org-odt-convert:                       Extending ODT export.
                                                              (line  36)
* org-odt-convert-capabilities:          Configuring a document converter.
                                                              (line  18)
* org-odt-convert-process:               Configuring a document converter.
                                                              (line  25)
* org-odt-convert-processes:             Configuring a document converter.
                                                              (line  12)
* org-odt-create-custom-styles-for-srcblocks: Literal examples in ODT export.
                                                              (line  16)
* org-odt-fontify-srcblocks:             Literal examples in ODT export.
                                                              (line  13)
* org-odt-pixels-per-inch:               Images in ODT export.
                                                              (line  34)
* org-odt-preferred-output-format:       ODT export commands. (line  10)
* org-odt-preferred-output-format <1>:   ODT export commands. (line  29)
* org-odt-preferred-output-format <2>:   Extending ODT export.
                                                              (line  21)
* org-odt-schema-dir:                    Validating OpenDocument XML.
                                                              (line  14)
* org-odt-styles-file:                   ODT specific export settings.
                                                              (line  22)
* org-odt-styles-file <1>:               Applying custom styles.
                                                              (line  25)
* org-odt-table-styles:                  Customizing tables in ODT export.
                                                              (line  13)
* org-odt-table-styles <1>:              Customizing tables in ODT export.
                                                              (line  82)
* org-outline-path-complete-in-steps:    Refile and copy.     (line  16)
* org-overriding-columns-format:         Agenda column view.  (line  18)
* org-plain-list-ordered-item-terminator: Plain lists.        (line  13)
* org-plain-list-ordered-item-terminator <1>: Plain lists.    (line 119)
* org-popup-calendar-for-date-prompt:    The date/time prompt.
                                                              (line  76)
* org-preview-latex-default-process:     Previewing LaTeX fragments.
                                                              (line   6)
* org-priority-faces:                    Priorities.          (line  13)
* org-priority-start-cycle-with-default: Priorities.          (line  31)
* org-property-allowed-value-functions:  Using the property API.
                                                              (line  67)
* org-protocol-default-template-key:     capture protocol.    (line  19)
* org-protocol-project-alist:            open-source protocol.
                                                              (line  13)
* org-publish-project-alist:             Project alist.       (line   6)
* org-publish-project-alist <1>:         Publishing options.  (line  13)
* org-publish-use-timestamps-flag:       Triggering publication.
                                                              (line  18)
* org-put-time-stamp-overlays:           In-buffer settings.  (line 130)
* org-read-date-display-live:            The date/time prompt.
                                                              (line  91)
* org-read-date-force-compatible-dates:  The date/time prompt.
                                                              (line  61)
* org-read-date-prefer-future:           The date/time prompt.
                                                              (line   6)
* org-refile-allow-creating-parent-nodes: Refile and copy.    (line  16)
* org-refile-keep:                       Refile and copy.     (line  16)
* org-refile-targets:                    Refile and copy.     (line  16)
* org-refile-use-cache:                  Refile and copy.     (line  16)
* org-refile-use-outline-path:           Refile and copy.     (line  16)
* org-remove-highlights-with-change:     Sparse trees.        (line  19)
* org-remove-highlights-with-change <1>: Clocking commands.   (line  73)
* org-replace-disputed-keys:             Conflicts.           (line  18)
* org-return-follows-link:               Handling links.      (line 119)
* org-reverse-note-order:                Refile and copy.     (line  16)
* org-scheduled-delay-days:              Deadlines and scheduling.
                                                              (line  44)
* org-show-context-detail:               Sparse trees.        (line   6)
* org-sort-agenda-noeffort-is-high:      Filtering/limiting agenda items.
                                                              (line  92)
* org-sparse-tree-open-archived-trees:   Internal archiving.  (line  17)
* org-special-ctrl-a/e:                  Headlines.           (line   6)
* org-special-ctrl-k:                    Headlines.           (line   6)
* org-speed-commands-user:               Speed keys.          (line  18)
* org-startup-align-all-tables:          Column width and alignment.
                                                              (line  33)
* org-startup-align-all-tables <1>:      In-buffer settings.  (line  75)
* org-startup-folded:                    Initial visibility.  (line   6)
* org-startup-folded <1>:                In-buffer settings.  (line  65)
* org-startup-folded <2>:                Speeding up your agendas.
                                                              (line  15)
* org-startup-indented:                  In-buffer settings.  (line  70)
* org-startup-with-inline-images:        Handling links.      (line 129)
* org-startup-with-inline-images <1>:    In-buffer settings.  (line  82)
* org-startup-with-latex-preview:        Previewing LaTeX fragments.
                                                              (line  27)
* org-startup-with-latex-preview <1>:    In-buffer settings.  (line  88)
* org-store-link-functions:              Adding hyperlink types.
                                                              (line  59)
* org-stuck-projects:                    Stuck projects.      (line  16)
* org-support-shift-select:              Plain lists.         (line  90)
* org-support-shift-select <1>:          Plain lists.         (line 140)
* org-support-shift-select <2>:          Conflicts.           (line   6)
* org-table-auto-blank-field:            Built-in table editor.
                                                              (line  30)
* org-table-copy-increment:              Built-in table editor.
                                                              (line 150)
* org-table-duration-custom-format:      Durations and time values.
                                                              (line   6)
* org-table-export-default-format:       Built-in table editor.
                                                              (line 183)
* org-table-formula:                     In-buffer settings.  (line  27)
* org-table-formula-constants:           References.          (line 108)
* org-table-formula-constants <1>:       In-buffer settings.  (line  27)
* org-table-formula-constants <2>:       Cooperation.         (line  11)
* org-table-use-standard-references:     References.          (line  17)
* org-table-use-standard-references <1>: Editing and debugging formulas.
                                                              (line   6)
* org-tag-alist:                         Setting tags.        (line  22)
* org-tag-alist <1>:                     In-buffer settings.  (line 164)
* org-tag-faces:                         Tags.                (line  10)
* org-tag-persistent-alist:              Setting tags.        (line  37)
* org-tags-column:                       Setting tags.        (line  11)
* org-tags-exclude-from-inheritance:     Tag inheritance.     (line  22)
* org-tags-match-list-sublevels:         Tag inheritance.     (line  26)
* org-tags-match-list-sublevels <1>:     Tag searches.        (line  18)
* org-tags-match-list-sublevels <2>:     Property searches.   (line  17)
* org-tags-match-list-sublevels <3>:     Matching tags and properties.
                                                              (line  19)
* org-texinfo-classes:                   Texinfo file header. (line  11)
* org-texinfo-classes <1>:               Headings and sectioning structure.
                                                              (line   6)
* org-texinfo-coding-system:             Texinfo file header. (line  11)
* org-texinfo-default-class:             Texinfo specific export settings.
                                                              (line  20)
* org-texinfo-default-class <1>:         Headings and sectioning structure.
                                                              (line   6)
* org-texinfo-info-process:              Texinfo export commands.
                                                              (line   6)
* org-texinfo-table-default-markup:      Plain lists in Texinfo export.
                                                              (line  12)
* org-time-stamp-custom-formats:         Custom time format.  (line   6)
* org-time-stamp-overlay-formats:        In-buffer settings.  (line 130)
* org-time-stamp-rounding-minutes:       Creating timestamps. (line  20)
* org-todo (face):                       Faces for TODO keywords.
                                                              (line   6)
* org-todo-keyword-faces:                Faces for TODO keywords.
                                                              (line   6)
* org-todo-keywords:                     TODO basics.         (line  41)
* org-todo-keywords <1>:                 TODO extensions.     (line   6)
* org-todo-keywords <2>:                 Global TODO list.    (line  17)
* org-todo-keywords <3>:                 In-buffer settings.  (line 179)
* org-todo-repeat-to-state:              Repeated tasks.      (line  19)
* org-todo-state-tags-triggers:          TODO basics.         (line  60)
* org-track-ordered-property-with-tag:   TODO dependencies.   (line  38)
* org-track-ordered-property-with-tag <1>: Checkboxes.        (line  75)
* org-treat-insert-todo-heading-as-state-change: Structure editing.
                                                              (line  27)
* org-treat-S-cursor-todo-selection-as-state-change: TODO basics.
                                                              (line  35)
* org-use-fast-todo-selection:           TODO basics.         (line  14)
* org-use-property-inheritance:          Property inheritance.
                                                              (line   6)
* org-use-property-inheritance <1>:      iCalendar export.    (line  49)
* org-use-property-inheritance <2>:      Header arguments in Org mode properties.
                                                              (line  17)
* org-use-property-inheritance <3>:      Using the property API.
                                                              (line  18)
* org-use-speed-commands:                Speed keys.          (line  13)
* org-use-sub-superscripts:              Subscripts and superscripts.
                                                              (line  14)
* org-use-tag-inheritance:               Tag inheritance.     (line  22)
* org-yank-adjusted-subtrees:            Structure editing.   (line  70)
* org-yank-folded-subtrees:              Structure editing.   (line  70)
* orgstruct-heading-prefix-regexp:       Orgstruct mode.      (line  26)
* parse-time-months:                     The date/time prompt.
                                                              (line  57)
* parse-time-weekdays:                   The date/time prompt.
                                                              (line  57)
* ps-landscape-mode:                     Exporting agenda views.
                                                              (line  20)
* ps-number-of-columns:                  Exporting agenda views.
                                                              (line  20)
* user-full-name:                        Export settings.     (line  25)
* user-mail-address:                     Export settings.     (line  35)



Tag Table:
Node: Top884
Node: Introduction24416
Node: Summary24850
Node: Installation27554
Node: Activation30365
Ref: Activation-Footnote-131930
Node: Feedback32058
Ref: Feedback-Footnote-135712
Node: Conventions35839
Node: Document structure37955
Node: Outlines38955
Node: Headlines39593
Ref: Headlines-Footnote-140811
Ref: Headlines-Footnote-241011
Node: Visibility cycling41082
Node: Global and local cycling41466
Ref: Global and local cycling-Footnote-144175
Ref: Global and local cycling-Footnote-244237
Node: Initial visibility44488
Ref: Initial visibility-Footnote-145564
Node: Catching invisible edits45753
Node: Motion46230
Node: Structure editing47602
Node: Sparse trees54399
Ref: Sparse trees-Footnote-156978
Ref: Sparse trees-Footnote-257093
Node: Plain lists57168
Ref: Plain lists-Footnote-164741
Ref: Plain lists-Footnote-265103
Ref: Plain lists-Footnote-365203
Ref: Plain lists-Footnote-465470
Ref: Plain lists-Footnote-565647
Ref: Plain lists-Footnote-665751
Ref: Plain lists-Footnote-765857
Node: Drawers65927
Ref: Drawers-Footnote-167833
Node: Blocks67981
Node: Footnotes68551
Ref: Footnotes-Footnote-172583
Ref: Footnotes-Footnote-272688
Node: Orgstruct mode72773
Node: Org syntax74435
Node: Tables75446
Node: Built-in table editor76096
Ref: Built-in table editor-Footnote-185718
Node: Column width and alignment85826
Ref: Column width and alignment-Footnote-188437
Node: Column groups88534
Node: Orgtbl mode90134
Node: The spreadsheet90954
Node: References92425
Ref: References-Footnote-199390
Ref: References-Footnote-299620
Ref: References-Footnote-399901
Ref: References-Footnote-4100018
Node: Formula syntax for Calc100336
Ref: Formula syntax for Calc-Footnote-1105680
Node: Formula syntax for Lisp106024
Node: Durations and time values107809
Node: Field and range formulas109238
Node: Column formulas111706
Node: Lookup functions113837
Node: Editing and debugging formulas115884
Ref: Using multiple #+TBLFM lines120229
Ref: Editing and debugging formulas-Footnote-1121522
Node: Updating the table121670
Node: Advanced features123047
Ref: Advanced features-Footnote-1127664
Node: Org-Plot127770
Node: Hyperlinks132164
Node: Link format132926
Node: Internal links134230
Ref: Internal links-Footnote-1136576
Ref: Internal links-Footnote-2136820
Node: Radio targets136966
Node: External links137650
Ref: External links-Footnote-1141703
Ref: External links-Footnote-2142139
Node: Handling links142403
Ref: Handling links-Footnote-1150418
Ref: Handling links-Footnote-2150578
Ref: Handling links-Footnote-3150780
Ref: Handling links-Footnote-4151077
Ref: Handling links-Footnote-5151335
Ref: Handling links-Footnote-6151462
Ref: Handling links-Footnote-7151538
Node: Using links outside Org151634
Node: Link abbreviations152124
Node: Search options154961
Ref: Search options-Footnote-1156908
Node: Custom searches156989
Node: TODO items158024
Ref: TODO items-Footnote-1159137
Node: TODO basics159251
Node: TODO extensions162144
Node: Workflow states163183
Ref: Workflow states-Footnote-1164503
Node: TODO types164596
Ref: TODO types-Footnote-1166229
Node: Multiple sets in one file166302
Node: Fast access to TODO states168262
Ref: Fast access to TODO states-Footnote-1169150
Ref: Fast access to TODO states-Footnote-2169238
Node: Per-file keywords169535
Ref: Per-file keywords-Footnote-1170928
Node: Faces for TODO keywords171137
Node: TODO dependencies172198
Node: Progress logging174572
Node: Closing items175289
Ref: Closing items-Footnote-1176293
Ref: Closing items-Footnote-2176366
Node: Tracking TODO state changes176444
Ref: Tracking TODO state changes-Footnote-1179557
Ref: Tracking TODO state changes-Footnote-2179616
Ref: Tracking TODO state changes-Footnote-3179773
Node: Tracking your habits180070
Node: Priorities184400
Ref: Priorities-Footnote-1186446
Node: Breaking down tasks186519
Ref: Breaking down tasks-Footnote-1188539
Node: Checkboxes188639
Ref: Checkboxes-Footnote-1193364
Ref: Checkboxes-Footnote-2193492
Ref: Checkboxes-Footnote-3193670
Node: Tags193794
Node: Tag inheritance194875
Ref: Tag inheritance-Footnote-1196741
Ref: Tag inheritance-Footnote-2196845
Node: Setting tags196971
Ref: Setting tags-Footnote-1203478
Node: Tag hierarchy203561
Node: Tag searches207035
Node: Properties and columns208358
Node: Property syntax209819
Node: Special properties214204
Node: Property searches215862
Node: Property inheritance217312
Node: Column view219184
Node: Defining columns220433
Node: Scope of column definitions220816
Node: Column attributes221734
Ref: Column attributes-Footnote-1226655
Ref: Column attributes-Footnote-2226779
Ref: Column attributes-Footnote-3226984
Ref: Column attributes-Footnote-4227238
Node: Using column view227372
Node: Capturing column view230371
Ref: Capturing column view-Footnote-1233464
Node: Property API233601
Node: Dates and times233960
Node: Timestamps234872
Ref: Timestamps-Footnote-1237287
Ref: Timestamps-Footnote-2237473
Ref: Timestamps-Footnote-3237604
Node: Creating timestamps238409
Node: The date/time prompt241259
Ref: The date/time prompt-Footnote-1245895
Ref: The date/time prompt-Footnote-2246066
Ref: The date/time prompt-Footnote-3246178
Node: Custom time format246276
Node: Deadlines and scheduling248032
Ref: Deadlines and scheduling-Footnote-1251551
Node: Inserting deadline/schedule251712
Ref: Inserting deadline/schedule-Footnote-1253556
Ref: Inserting deadline/schedule-Footnote-2253680
Node: Repeated tasks253804
Ref: Repeated tasks-Footnote-1258284
Ref: Repeated tasks-Footnote-2258541
Node: Clocking work time258764
Ref: Clocking work time-Footnote-1259957
Ref: Clocking work time-Footnote-2260109
Node: Clocking commands260251
Ref: Clocking commands-Footnote-1265280
Ref: Clocking commands-Footnote-2265395
Ref: Clocking commands-Footnote-3265449
Ref: Clocking commands-Footnote-4265511
Node: The clock table265593
Ref: The clock table-Footnote-1273203
Ref: The clock table-Footnote-2273301
Node: Resolving idle time273427
Ref: Resolving idle time-Footnote-1277363
Node: Effort estimates277847
Ref: Effort estimates-Footnote-1280644
Node: Timers280751
Node: Capture - Refile - Archive283067
Node: Capture284062
Node: Setting up capture285168
Ref: Setting up capture-Footnote-1285581
Node: Using capture285651
Node: Capture templates288122
Node: Template elements290126
Ref: Template elements-Footnote-1296903
Ref: Template elements-Footnote-2297236
Node: Template expansion297423
Ref: Template expansion-Footnote-1301544
Ref: Template expansion-Footnote-2301635
Ref: Template expansion-Footnote-3301846
Ref: Template expansion-Footnote-4302032
Node: Templates in contexts302134
Node: Attachments302975
Ref: Attachments-Footnote-1306513
Node: RSS feeds306667
Node: Protocols308185
Node: store-link protocol309655
Node: capture protocol310492
Node: open-source protocol311631
Node: Refile and copy314783
Ref: Refile and copy-Footnote-1317256
Node: Archiving317368
Node: Moving subtrees318079
Node: Internal archiving320131
Node: Agenda views322827
Node: Agenda files325189
Ref: Agenda files-Footnote-1328047
Ref: Agenda files-Footnote-2328196
Node: Agenda dispatcher328397
Ref: Agenda dispatcher-Footnote-1331306
Ref: Agenda dispatcher-Footnote-2331404
Node: Built-in agenda views331510
Node: Weekly/daily agenda332099
Ref: Weekly/daily agenda-Footnote-1337944
Ref: Weekly/daily agenda-Footnote-2338175
Node: Global TODO list338362
Node: Matching tags and properties340943
Node: Search view348290
Node: Stuck projects349654
Ref: Stuck projects-Footnote-1351740
Node: Presentation and sorting351770
Node: Categories352740
Node: Time-of-day specifications353488
Node: Sorting agenda items355486
Node: Filtering/limiting agenda items357084
Ref: Filtering/limiting agenda items-Footnote-1364381
Node: Agenda commands364801
Ref: Agenda commands-Footnote-1386240
Ref: Agenda commands-Footnote-2386321
Ref: Agenda commands-Footnote-3386444
Ref: Agenda commands-Footnote-4386548
Node: Custom agenda views386635
Node: Storing searches387281
Ref: Storing searches-Footnote-1390321
Ref: Storing searches-Footnote-2390438
Node: Block agenda390690
Node: Setting options391977
Node: Exporting agenda views395628
Ref: Exporting agenda views-Footnote-1400604
Ref: Exporting agenda views-Footnote-2400727
Ref: Exporting agenda views-Footnote-3400887
Ref: Exporting agenda views-Footnote-4401074
Node: Agenda column view401156
Node: Markup404281
Node: Paragraphs405273
Node: Emphasis and monospace406447
Node: Horizontal rules407323
Node: Images and tables407579
Node: Literal examples409311
Ref: Literal examples-Footnote-1413925
Ref: Literal examples-Footnote-2414449
Ref: Literal examples-Footnote-3414622
Ref: Literal examples-Footnote-4414809
Ref: Literal examples-Footnote-5415079
Node: Special symbols415177
Ref: Special symbols-Footnote-1417190
Ref: Special symbols-Footnote-2417357
Node: Subscripts and superscripts417450
Node: Embedded LaTeX418591
Ref: Embedded LaTeX-Footnote-1419409
Node: LaTeX fragments419605
Ref: LaTeX fragments-Footnote-1421719
Node: Previewing LaTeX fragments421954
Ref: Previewing LaTeX fragments-Footnote-1423417
Node: CDLaTeX mode423671
Ref: CDLaTeX mode-Footnote-1426247
Node: Exporting426399
Node: The export dispatcher429076
Node: Export settings431716
Ref: Export settings-Footnote-1439826
Ref: Export settings-Footnote-2439938
Node: Table of contents440044
Node: Include files441941
Ref: Include files-Footnote-1444807
Node: Macro replacement444985
Ref: Macro replacement-Footnote-1447881
Node: Comment lines448098
Ref: Comment lines-Footnote-1448933
Node: ASCII/Latin-1/UTF-8 export449033
Node: Beamer export452057
Node: Beamer export commands452832
Node: Beamer specific export settings453524
Node: Sectioning Frames and Blocks in Beamer455448
Ref: Sectioning Frames and Blocks in Beamer-Footnote-1458764
Node: Beamer specific syntax458925
Node: Editing support460911
Node: A Beamer example461404
Node: HTML export462676
Node: HTML Export commands463688
Node: HTML Specific export settings464224
Node: HTML doctypes466314
Node: HTML preamble and postamble468478
Node: Quoting HTML tags469673
Node: Links in HTML export470362
Node: Tables in HTML export471832
Node: Images in HTML export473284
Node: Math formatting in HTML export474774
Ref: Math formatting in HTML export-Footnote-1476193
Node: Text areas in HTML export476317
Node: CSS support477475
Ref: CSS support-Footnote-1480952
Node: JavaScript support481132
Node: LaTeX export484460
Node: LaTeX export commands486201
Ref: LaTeX export commands-Footnote-1487527
Node: LaTeX specific export settings487735
Node: LaTeX header and sectioning490625
Node: Quoting LaTeX code492771
Node: Tables in LaTeX export493557
Node: Images in LaTeX export498102
Ref: Images in LaTeX export-Footnote-1500637
Node: Plain lists in LaTeX export500684
Node: Source blocks in LaTeX export501706
Node: Example blocks in LaTeX export503145
Node: Special blocks in LaTeX export503858
Node: Horizontal rules in LaTeX export505113
Node: Markdown export505513
Node: OpenDocument Text export506860
Ref: OpenDocument Text export-Footnote-1507966
Node: Pre-requisites for ODT export508110
Node: ODT export commands508501
Ref: x-export-to-odt508710
Node: ODT specific export settings509874
Node: Extending ODT export510916
Ref: x-export-to-other-formats511806
Ref: x-convert-to-other-formats512231
Node: Applying custom styles512706
Node: Links in ODT export514504
Node: Tables in ODT export515166
Node: Images in ODT export517161
Node: Math formatting in ODT export520036
Node: Working with LaTeX math snippets520502
Ref: Working with LaTeX math snippets-Footnote-1522785
Ref: Working with LaTeX math snippets-Footnote-2522861
Node: Working with MathML or OpenDocument formula files522906
Node: Labels and captions in ODT export523446
Node: Literal examples in ODT export524723
Node: Advanced topics in ODT export525566
Node: Configuring a document converter526225
Ref: x-odt-converter-capabilities526914
Node: Working with OpenDocument style files527321
Ref: x-factory-styles527731
Ref: x-orgodtstyles-xml527973
Ref: x-orgodtcontenttemplate-xml528319
Ref: x-overriding-factory-styles529003
Ref: x-org-odt-styles-file529274
Ref: x-org-odt-content-template-file530240
Node: Creating one-off styles530391
Node: Customizing tables in ODT export532574
Ref: Customizing tables in ODT export-Footnote-1537591
Ref: Customizing tables in ODT export-Footnote-2537695
Ref: Customizing tables in ODT export-Footnote-3537787
Node: Validating OpenDocument XML538134
Node: Org export539063
Node: Texinfo export539824
Node: Texinfo export commands540849
Node: Texinfo specific export settings541469
Node: Texinfo file header542605
Node: Texinfo title and copyright page543574
Node: Info directory file544941
Node: Headings and sectioning structure545663
Node: Indices547690
Node: Quoting Texinfo code548731
Node: Plain lists in Texinfo export549225
Node: Tables in Texinfo export550585
Node: Images in Texinfo export551081
Node: Special blocks in Texinfo export551723
Node: A Texinfo example552322
Node: iCalendar export554434
Node: Other built-in back-ends558159
Node: Advanced configuration558780
Node: Export in foreign buffers565599
Node: Publishing566672
Node: Configuration567547
Node: Project alist568315
Node: Sources and destinations569477
Node: Selecting files571052
Node: Publishing action572159
Ref: Publishing action-Footnote-1574053
Node: Publishing options574220
Node: Publishing links588759
Node: Sitemap590152
Node: Generating an index594293
Node: Uploading files595108
Node: Sample configuration596921
Node: Simple example597415
Node: Complex example598131
Node: Triggering publication600194
Node: Working with source code601206
Node: Structure of code blocks605761
Node: Editing source code608305
Node: Exporting code blocks611163
Node: Extracting source code613500
Node: Evaluating code blocks616012
Ref: Evaluating code blocks-Footnote-1619253
Ref: Evaluating code blocks-Footnote-2619387
Node: Library of Babel619578
Node: Languages620276
Node: Header arguments622730
Node: Using header arguments623092
Node: System-wide header arguments623904
Node: Language-specific header arguments624620
Node: Header arguments in Org mode properties625155
Node: Language-specific mode properties626661
Node: Code block specific header arguments627498
Node: Arguments in function calls629206
Node: Specific header arguments629995
Node: var632694
Node: results639451
Node: file643583
Node: file-desc644289
Node: file-ext644708
Node: output-dir645148
Node: dir645571
Node: exports647799
Node: tangle648729
Node: mkdirp649628
Node: comments649963
Node: padline650987
Node: no-expand651410
Node: session652149
Node: noweb653276
Node: noweb-ref655964
Node: noweb-sep657089
Node: cache657406
Node: sep660090
Node: hlines660506
Node: colnames662033
Node: rownames663488
Node: shebang664720
Node: tangle-mode665221
Node: eval666052
Node: wrap667094
Node: post667426
Node: prologue669214
Node: epilogue669739
Node: Results of evaluation670010
Node: Noweb reference syntax673864
Node: Key bindings and useful functions676200
Node: Batch execution678540
Node: Miscellaneous679323
Node: Completion680246
Node: Easy templates682364
Node: Speed keys683747
Node: Code evaluation security684942
Node: Customization687796
Node: In-buffer settings688237
Node: The very busy C-c C-c key697898
Node: Clean view699906
Ref: Clean view-Footnote-1703400
Ref: Clean view-Footnote-2703639
Ref: Clean view-Footnote-3703698
Node: TTY keys703778
Node: Interaction705480
Node: Cooperation705884
Node: Conflicts708681
Node: org-crypt713316
Node: Org Mobile714600
Node: Setting up the staging area715923
Ref: Setting up the staging area-Footnote-1717153
Ref: Setting up the staging area-Footnote-2717360
Node: Pushing to the mobile application717532
Ref: Pushing to the mobile application-Footnote-1718543
Ref: Pushing to the mobile application-Footnote-2718634
Ref: Pushing to the mobile application-Footnote-3718994
Node: Pulling from the mobile application719070
Ref: Pulling from the mobile application-Footnote-1721383
Node: Hacking721436
Node: Hooks722447
Node: Add-on packages722771
Node: Adding hyperlink types723310
Node: Adding export back-ends726774
Node: Context-sensitive commands728031
Node: Tables in arbitrary syntax728729
Node: Radio tables730409
Node: A LaTeX example732542
Ref: A LaTeX example-Footnote-1736361
Ref: A LaTeX example-Footnote-2736531
Node: Translator functions736982
Node: Radio lists739175
Node: Dynamic blocks740374
Node: Special agenda views742470
Ref: x-agenda-skip-entry-regexp745380
Ref: Special agenda views-Footnote-1746160
Ref: Special agenda views-Footnote-2746367
Node: Speeding up your agendas746499
Node: Extracting agenda information747549
Node: Using the property API751412
Node: Using the mapping API754859
Node: History and acknowledgments758917
Node: GNU Free Documentation License774373
Node: Main Index799742
Node: Key Index898591
Node: Command and Function Index951926
Node: Variable Index989123

End Tag Table


Local Variables:
coding: utf-8
End:
