2019-12-06 19:15:46 +01:00
This is org, produced by makeinfo version 6.5 from org.texi.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
This manual is for Org version 9.3.
2019-11-26 16:46:24 +01:00
2020-01-29 18:18:31 +01:00
Copyright © 2004–
2019-11-26 16:46:24 +01:00
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’
modify this GNU manual.”
2020-02-14 23:09:34 +01:00
INFO-DIR-SECTION Emacs editing modes
2019-11-26 16:46:24 +01:00
START-INFO-DIR-ENTRY
* Org Mode: (org). Outline-based notes management and organizer.
END-INFO-DIR-ENTRY
File: org, Node: Top, Next: Introduction, Up: (dir)
The Org Manual
**************
2019-12-06 19:15:46 +01:00
This manual is for Org version 9.3.
2019-11-26 16:46:24 +01:00
2020-01-29 18:18:31 +01:00
Copyright © 2004–
2019-11-26 16:46:24 +01:00
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’
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.
2019-12-06 19:15:46 +01:00
* Refiling and Archiving:: Moving and copying information with ease.
* Capture and Attachments:: Dealing with external data.
2019-11-26 16:46:24 +01:00
* Agenda Views:: Collecting information into views.
* Markup for Rich Contents:: Compose beautiful documents.
* 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’
* 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 used in this manual.
Document Structure
* 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.
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, automatic recalculation...
Hyperlinks
* Link Format:: How links in Org are formatted.
* Internal Links:: Links to other places in the current file.
* Radio Targets:: Make targets trigger links in plain text.
* 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.
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.
TODO Extensions
* 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, still finding your way.
* Fast access to TODO states:: Single letter selection of 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
2019-12-06 19:15:46 +01:00
* Closing items:: When was this entry marked as done?
2019-11-26 16:46:24 +01:00
* 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 an 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 a tree.
* Column View:: Tabular viewing and editing.
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 to 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 enter dates and times.
* 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’
2019-12-06 19:15:46 +01:00
Refiling and Archiving
2019-11-26 16:46:24 +01:00
* Refile and Copy:: Moving/copying a tree from one place to another.
* Archiving:: What to do with finished products.
2019-12-06 19:15:46 +01:00
Archiving
* Moving subtrees:: Moving a tree to an archive file.
* Internal archiving:: Switch off a tree but keep it in the file.
Capture and Attachments
* Capture:: Capturing new stuff.
* Attachments:: Attach files to outlines.
* RSS Feeds:: Getting input from RSS feeds.
2019-11-26 16:46:24 +01:00
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.
2019-12-06 19:15:46 +01:00
Attachments
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Attachment defaults and dispatcher:: How to access attachment commands
* Attachment options:: Configuring the attachment system
* Attachment links:: Hyperlink access to attachments
* Automatic version-control with Git:: Everything safely stored away
* Attach from Dired:: Using dired to select an attachment
2019-11-26 16:46:24 +01:00
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.
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 of agenda items:: The order of things.
2019-12-06 19:15:46 +01:00
* Filtering/limiting agenda items:: Dynamically narrow the agenda.
2019-11-26 16:46:24 +01:00
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 Contents
* Paragraphs:: The basic unit of text.
* Emphasis and Monospace:: Bold, italic, etc.
* Subscripts and Superscripts:: Simple syntax for raising/lowering text.
* Special Symbols:: Greek letters and other symbols.
* Embedded LaTeX:: LaTeX can be freely used inside Org documents.
* Literal Examples:: Source code examples with special formatting.
* Images:: Display an image.
* Captions:: Describe tables, images...
* Horizontal Rules:: Make a line.
2019-12-06 19:15:46 +01:00
* Creating Footnotes:: Edit and read footnotes.
2019-11-26 16:46:24 +01:00
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.
2019-12-06 19:15:46 +01:00
* Beamer Export:: Producing presentations and slides.
2019-11-26 16:46:24 +01:00
* 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 Export 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.
* Frames and Blocks in Beamer:: For composing Beamer slides.
* Beamer specific syntax:: For using in Org documents.
* Editing support:: Editing support.
* 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.
2019-12-06 19:15:46 +01:00
* Headlines in HTML export:: Formatting headlines.
2019-11-26 16:46:24 +01:00
* Links in HTML export:: Inserting and formatting links.
* Tables in HTML export:: How to modify the formatting of tables.
* Images in HTML export:: How to insert figures into HTML output.
* Math formatting in HTML export:: Beautiful math also on the web.
* Text areas in HTML export:: An alternate way to show an example.
* CSS support:: Changing the appearance of the output.
* JavaScript support:: Info and folding in a web browser.
LaTeX Export
* LaTeX/PDF export commands:: For producing LaTeX and PDF documents.
* LaTeX specific export settings:: Unique to this LaTeX back-end.
* LaTeX header and sectioning:: Setting up the export file structure.
* Quoting LaTeX code:: Incorporating literal LaTeX code.
* Tables in LaTeX export:: Options for exporting tables to LaTeX.
* Images in LaTeX export:: How to insert figures into LaTeX output.
* 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 tables 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
* LaTeX math snippets:: Embedding in LaTeX format.
* MathML and OpenDocument formula files:: Embedding in native format.
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.
* Quotations in Texinfo export:: Quote block 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?
* Site map:: 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
2020-02-14 23:09:34 +01:00
* Features:: Enjoy the versatility of source blocks.
2019-11-26 16:46:24 +01:00
* Structure of Code Blocks:: Code block syntax described.
* Using Header Arguments:: Different ways to set header arguments.
* Environment of a Code Block:: Arguments, sessions, working directory...
* Evaluating Code Blocks:: Place results of evaluation in the Org buffer.
* Results of Evaluation:: Choosing a results type, post-processing...
* Exporting Code Blocks:: Export contents and/or results.
* Extracting Source Code:: Create pure source code files.
* Languages:: List of supported code block languages.
* Editing Source Code:: Language major-mode editing.
* Noweb Reference Syntax:: Literate programming in Org mode.
* Library of Babel:: Use and contribute to a library of useful code blocks.
* Key bindings and Useful Functions:: Work quickly with code blocks.
* Batch Execution:: Call functions from the command line.
Miscellaneous
* Completion:: ‘ ’
* Structure Templates:: Quick insertion of structural elements.
* Speed Keys:: Electric commands at the beginning of a headline.
* Clean View:: Getting rid of leading stars in the outline.
2019-12-06 19:15:46 +01:00
* Dynamic Headline Numbering:: Display and update outline numbering.
* The Very Busy C-c C-c Key:: When in doubt, press ‘ ’
* In-buffer Settings:: Overview of keywords.
* Org Syntax:: Formal description of Org’
2019-11-26 16:46:24 +01:00
* Documentation Access:: Read documentation about current syntax.
2019-12-06 19:15:46 +01:00
* Escape Character::
* Code Evaluation Security:: Org files evaluate in-line code.
2019-11-26 16:46:24 +01:00
* Interaction:: With other Emacs packages.
2019-12-06 19:15:46 +01:00
* TTY Keys:: Using Org on a tty.
* Protocols:: External access to Emacs and Org.
2019-11-26 16:46:24 +01:00
* Org Crypt:: Encrypting Org files.
* Org Mobile:: Viewing and capture on a mobile device.
2019-12-06 19:15:46 +01:00
Clean View
* Org Indent Mode::
* Hard indentation::
2019-11-26 16:46:24 +01:00
Interaction
* Cooperation:: Packages Org cooperates with.
* Conflicts:: Packages that lead to conflicts.
2019-12-06 19:15:46 +01:00
Protocols
* The store-link protocol:: Store a link, push URL to kill-ring.
* The capture protocol:: Fill a buffer with external information.
* The open-source protocol:: Edit published contents.
2019-11-26 16:46:24 +01:00
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: Hooks (2). How to reach into Org’
* Add-on Packages:: Available extensions.
* Adding Hyperlink Types:: New custom link types.
* Adding Export Back-ends:: How to write new export back-ends.
* 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 agenda information.
* Using the Property API:: Writing programs that use entry properties.
* Using the Mapping API:: Mapping over all or selected entries.
Tables in Arbitrary Syntax
* Radio tables:: Sending and receiving radio tables.
* A LaTeX example:: Step by step, almost a tutorial.
* Translator functions:: Copy and modify.
File: org, Node: Introduction, Next: Document Structure, Prev: Top, 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 used in this manual.
File: org, 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 markup language. 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 make 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’
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’
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, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
1.2 Installation
================
Org is included in all recent distributions of GNU Emacs, so you
probably do not need to install it. Most users will simply activate Org
and begin exploring its many features.
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 the Emacs package system;
• by downloading Org as an archive; or
• by using Org’
We *strongly recommend* sticking 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 ‘
<RET> org’
Important: You need to do this in a session where no ‘ ’
has been visited, i.e., where no Org built-in function have been
loaded. Otherwise autoload Org functions will mess up the
installation.
If you want to use Org’
page (https://orgmode.org/elpa.html).
Downloading Org as an archive
-----------------------------
You can download Org latest release from Org’
(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 ‘ ’
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 ‘ ’
Using Org’
--------------------------
You can clone Org’
$ cd ~/src/
2020-02-14 23:09:34 +01:00
$ git clone https://code.orgmode.org/bzg/org-mode.git
2019-11-26 16:46:24 +01:00
$ cd org-mode/
$ make autoloads
Note that in this case, ‘ ’
Org’ ‘ ’ ’
‘ ’
Remember to add the correct load-path as described in the method
above.
You can also compile with ‘ ’
‘ ’ ‘ ’
Org with ‘ ’ ‘ ’
compilation/installation options.
For more detailed explanations on Org’
the Org Build System page on Worg
(https://orgmode.org/worg/dev/org-build-system.html).
File: org, 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 (see *note Conflicts::). Please take the time to check the
list.
For a better experience, the three Org commands ‘ ’
‘ ’ ‘ ’
not just in Org buffers. To that effect, you need to bind them to
globally available keys, like the ones reserved for users (see *note
(elisp)Key Binding Conventions::). Here are suggested bindings, please
modify the keys to your own liking.
(global-set-key (kbd "C-c l") 'org-store-link)
(global-set-key (kbd "C-c a") 'org-agenda)
(global-set-key (kbd "C-c c") 'org-capture)
Files with the ‘ ’
Org mode in a file that does not have the extension ‘ ’
first line of a file look like this:
MY PROJECTS -*- mode: org; -*-
which selects Org mode for this buffer no matter what the file’
is. See also the variable ‘ ’
Many commands in Org work on the region if the region is _active_.
2019-12-06 19:15:46 +01:00
To make use of this, you need to have Transient Mark mode turned on,
which is the default. If you do not like it, you can create an active
region by using the mouse to select a region, or pressing ‘ ’
twice before moving point.
2019-11-26 16:46:24 +01:00
---------- Footnotes ----------
(1) If you do not use Font Lock globally turn it on in Org buffer
with ‘ ’
File: org, 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 send an email to the Org mailing list
<emacs-orgmode@gnu.org>. You can subscribe to the list from 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 (‘ ’
(‘ ’
file. The easiest way to do this is to use the command
M-x org-submit-bug-report <RET>
which puts 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 ‘ ’ ‘ ’
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 (expand-file-name "/path/to/org-mode/lisp"))
(add-to-list 'load-path (expand-file-name "/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 do not
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, from the menu: Org → Refresh/Reload → Reload Org uncompiled.
2. Then, activate the debugger:
M-x toggle-debug-or-error <RET>
or, from the menu: Options → Enter Debugger on Error.
3. Do whatever you have to do to hit the error. Do not forget to
document the steps you take.
4. When you hit the error, a ‘ ’
screen. Save this buffer to a file—for example using ‘ ’
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, Node: Conventions, Prev: Feedback, Up: Introduction
1.5 Typesetting Conventions Used in this Manual
===============================================
TODO keywords, tags, properties, etc.
-------------------------------------
Org uses various syntactical elements: TODO keywords, tags, property
names, keywords, blocks, etc. In this manual we use the following
conventions:
‘ ’
‘ ’
TODO keywords are written with all capitals, even if they are
user-defined.
‘ ’
‘ ’
Tags are case-sensitive. User-defined tags are written in
lowercase; built-in tags with special meaning are written as they
should appear in the document, usually with all capitals.
‘ ’
‘ ’
User-defined properties are capitalized; built-in properties with
special meaning are written with all capitals.
‘ ’
‘ ’ ‘ ’
Keywords and blocks are written in uppercase to enhance their
readability, but you can use lowercase in your Org files.
Key bindings and commands
-------------------------
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 ‘ ’
will, wherever possible, give the function that is internally called by
the generic command. For example, in the chapter on document structure,
‘ ’ ‘ ’
on tables, it will be listed to call ‘ ’
File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
2 Document Structure
********************
Org is an outliner. Outlines allow a document to be organized in a
hierarchical structure, which, least for me, is the best representation
of notes and thoughts. An overview of this structure is achieved by
folding, i.e., 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
and hide functionalities into a single command, ‘ ’
bound to the ‘ ’
* Menu:
* 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.
File: org, Node: Headlines, Next: Visibility Cycling, Up: Document Structure
2.1 Headlines
=============
Headlines define the structure of an outline tree. The headlines in Org
start with one or more stars, on the left margin(1). For example:
* Top level headline
** Second level
*** Third level
some text
*** Third level
more text
* Another top level headline
The name defined in ‘ ’
it as a title for your own headings.
Some people find the many stars too noisy and would prefer an outline
2019-12-06 19:15:46 +01:00
that has whitespace followed by a single star as headline starters.
This can be achieved using a Org Indent minor mode. See *note Clean
View:: for more information.
Headlines are not numbered. However, you may want to dynamically
number some, or all, of them. See *note Dynamic Headline Numbering::.
2019-11-26 16:46:24 +01:00
An empty line after the end of a subtree is considered part of it and
is hidden when the subtree is folded. However, if you leave at least
two empty lines, one empty line remains visible after folding the
subtree, in order to structure the collapsed view. See the variable
‘ ’
---------- Footnotes ----------
(1) See the variables ‘ ’ ‘ ’
and ‘ ’ ‘ ’
‘ ’ ‘ ’
headings indented less than 30 stars.
File: org, Node: Visibility Cycling, Next: Motion, Prev: Headlines, Up: Document Structure
2.2 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, Node: Global and local cycling, Next: Initial visibility, Up: Visibility Cycling
2.2.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 ‘ ’ ‘ ’
visibility in the buffer.
‘ ’ ‘ ’
_Subtree cycling_: Rotate current subtree among the states
,-> FOLDED -> CHILDREN -> SUBTREE --.
'-----------------------------------'
Point must be on a headline for this to work(1).
‘ ’ ‘ ’
‘ ’
_Global cycling_: Rotate the entire buffer among the states
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'
When ‘ ’
CONTENTS view up to headlines of level N are shown. Note that
inside tables (see *note Tables::), ‘ ’
field instead.
You can run global cycling using ‘ ’
very beginning of the buffer, but not on a headline, and
‘ ’ ‘ ’
‘ ’ ‘ ’
Switch back to the startup visibility of the buffer (see *note
Initial visibility::).
‘ ’ ‘ ’
Show all, including drawers.
‘ ’ ‘ ’
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 (see
*note Sparse Trees::) or an agenda command (see *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.
‘ ’ ‘ ’
Expose all the headings of the subtree, CONTENTS view for just one
subtree.
‘ ’ ‘ ’
Expose all direct children of the subtree. With a numeric prefix
argument N, expose all children down to level N.
‘ ’ ‘ ’
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 ‘ ’
not remove the previously used indirect buffer.
‘ ’ ‘ ’
Copy the _visible_ text in the region into the kill ring.
---------- Footnotes ----------
(1) See, however, the option ‘ ’
(2) The indirect buffer contains the entire buffer, but is narrowed
to the current tree. Editing the indirect buffer also changes the
original buffer, but without affecting visibility in that buffer. For
more information about indirect buffers, see *note GNU Emacs Manual:
(emacs)Indirect Buffers.
File: org, Node: Initial visibility, Next: Catching invisible edits, Prev: Global and local cycling, Up: Visibility Cycling
2.2.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 ‘ ’
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 ‘ ’
Properties and Columns::) get their visibility adapted accordingly.
Allowed values for this property are ‘ ’ ‘ ’ ‘ ’
and ‘ ’
‘ ’ ‘ ’
Switch back to the startup visibility of the buffer, i.e., whatever
is requested by startup options and ‘ ’
individual entries.
---------- Footnotes ----------
(1) When ‘ ’ ‘ ’
honor the default visibility state when first opening a file for the
agenda (see *note Speeding Up Your Agendas::).
File: org, Node: Catching invisible edits, Prev: Initial visibility, Up: Visibility Cycling
2.2.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 ‘ ’ ‘ ’
See the docstring of this option on how Org should catch invisible edits
and process them.
File: org, Node: Motion, Next: Structure Editing, Prev: Visibility Cycling, Up: Document Structure
2.3 Motion
==========
The following commands jump to other headlines in the buffer.
‘ ’ ‘ ’
Next heading.
‘ ’ ‘ ’
Previous heading.
‘ ’ ‘ ’
Next heading same level.
‘ ’ ‘ ’
Previous heading same level.
‘ ’ ‘ ’
Backward to higher level heading.
‘ ’ ‘ ’
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:
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
The following keys work if you turn off ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
See also the variable ‘ ’
File: org, Node: Structure Editing, Next: Sparse Trees, Prev: Motion, Up: Document Structure
2.4 Structure Editing
=====================
‘ ’ ‘ ’
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 (see *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
‘ ’
Calling the command with a ‘ ’
new heading at the end of the current subtree, thus preserving its
contents. With a double ‘ ’
created at the end of the parent subtree instead.
‘ ’ ‘ ’
Insert a new heading at the end of the current subtree.
‘ ’ ‘ ’
Insert new TODO entry with same level as current heading. See also
the variable ‘ ’
‘ ’ ‘ ’
Insert new TODO entry with same level as current heading. Like
‘ ’
‘ ’ ‘ ’
In a new entry with no text yet, the first ‘ ’
entry to become a child of the previous one. The next ‘ ’
makes it a parent, and so on, all the way to top level. Yet
another ‘ ’
‘ ’ ‘ ’
Promote current heading by one level.
‘ ’ ‘ ’
Demote current heading by one level.
‘ ’ ‘ ’
Promote the current subtree by one level.
‘ ’ ‘ ’
Demote the current subtree by one level.
‘ ’ ‘ ’
Move subtree up, i.e., swap with previous subtree of same level.
‘ ’ ‘ ’
Move subtree down, i.e., swap with next subtree of same level.
‘ ’ ‘ ’
Mark the subtree at point. Hitting repeatedly marks subsequent
subtrees of the same level as the marked subtree.
‘ ’ ‘ ’
Kill subtree, i.e., remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
‘ ’ ‘ ’
Copy subtree to kill ring. With a numeric prefix argument N, copy
the N sequential subtrees.
‘ ’ ‘ ’
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 ‘ ’
‘ ’ ‘ ’
Depending on the variables ‘ ’
‘ ’ ’ ‘ ’
subtrees folded and in a clever way, using the same command as ‘
C-x C-y’
place, but the yanked tree is folded unless doing so would swallow
text previously visible. Any prefix argument to this command
forces a normal ‘ ’
along. A good way to force a normal yank is ‘ ’
‘ ’
without adjustment and folding.
‘ ’ ‘ ’
Clone a subtree by making a number of sibling copies of it. You
are 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 ‘ ’
‘ ’ ‘ ’
Refile entry or region to a different location. See *note Refile
and Copy::.
‘ ’ ‘ ’
Sort same-level entries. When there is an active region, all
entries in the region are 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 ‘ ’
prefix, sorting is case-sensitive.
‘ ’ ‘ ’
Narrow buffer to current subtree.
‘ ’ ‘ ’
Narrow buffer to current block.
‘ ’ ‘ ’
Widen buffer to remove narrowing.
‘ ’ ‘ ’
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—i.e., when Transient Mark mode is
active—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 point is inside a table (see *note Tables::), the Meta-Cursor keys
have different functionality.
File: org, Node: Sparse Trees, Next: Plain Lists, Prev: Structure Editing, Up: Document Structure
2.5 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 creating such trees, all these
commands can be accessed through a dispatcher:
‘ ’ ‘ ’
This prompts for an extra key to select a sparse-tree creating
command.
‘ ’ ‘ ’ ‘ ’
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, or by pressing ‘ ’ ‘ ’
prefix argument, previous highlights are kept, so several calls to
this command can be stacked.
‘ ’ ‘ ’ ‘ ’
Jump to the next sparse tree match in this buffer.
‘ ’ ‘ ’ ‘ ’
Jump to the previous sparse tree match in this buffer.
For frequently used sparse trees of specific search strings, you can
use the variable ‘ ’
access to specific sparse trees. These commands will then be accessible
through the agenda dispatcher (see *note Agenda Dispatcher::). For
example:
(setq org-agenda-custom-commands
'(("f" occur-tree "FIXME")))
defines the key ‘ ’
the string ‘ ’
The other sparse tree commands select headings based on TODO
keywords, tags, or properties and are discussed later in this manual.
To print a sparse tree, you can use the Emacs command
‘ ’
document. Or you can use the command ‘ ’
visible part of the document and print the resulting file.
---------- Footnotes ----------
(1) See also the variable ‘ ’
much context is shown around each match.
(2) This depends on the option ‘ ’
File: org, Node: Plain Lists, Next: Drawers, Prev: Sparse Trees, Up: Document Structure
2.6 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 (see *note Checkboxes::). Org supports editing such lists,
and every exporter (see *note Exporting::) can parse and format them.
Org knows ordered lists, unordered lists, and description lists.
• _Unordered_ list items start with ‘ ’ ‘ ’ ‘ ’
• _Ordered_ list items start with a numeral followed by either a
period or a right parenthesis(2), such as ‘ ’ ‘ ’
want a list to start with a different value—e.g., 20—start the text
of the item with ‘ ’
item of the list in order to enforce a particular numbering.
• _Description_ list items are unordered list items, and contain the
separator ‘ ’
description.
Items belonging to the same list must have the same indentation on
the first line. In particular, if an ordered list reaches number ‘ ’
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
2019-12-29 11:23:16 +01:00
- Sean Astin :: He plays Sam, Frodo's friend. I still remember him
2019-11-26 16:46:24 +01:00
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 (see *note
Exporting::). Since indentation is what governs the structure of these
lists, many structural constructs like ‘ ’
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 ‘ ’
of indentation between items and theirs sub-items, customize
‘ ’
The following commands act on items when point 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 ‘ ’
to disable them individually.
‘ ’ ‘ ’
Items can be folded just like headline levels. Normally this works
only if point is on a plain list item. For more details, see the
variable ‘ ’
to ‘ ’
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 ‘ ’
to become a child of the previous one. Subsequent ‘ ’
the item to meaningful levels in the list and eventually get it
back to its initial position.
‘ ’ ‘ ’
Insert new item at current level. With a prefix argument, force a
new heading (see *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’
one.
‘ ’
Insert a new item with a checkbox (see *note Checkboxes::).
‘ ’
‘ ’
Jump to the previous/next item in the current list, but only if
‘ ’
paragraph jumping commands like ‘ ’ ‘ ’
similar effect.
‘ ’
‘ ’
Move the item including subitems up/down(7), i.e., swap with
previous/next item of same indentation. If the list is ordered,
renumbering is automatic.
‘ ’
‘ ’
Decrease/increase the indentation of an item, leaving children
alone.
‘ ’
‘ ’
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 by moving point.
As a special case, using this command on the very first item of a
list moves the whole list. This behavior can be disabled by
configuring ‘ ’
a list has no influence on the text _after_ the list.
‘ ’
If there is a checkbox (see *note Checkboxes::) in the item line,
toggle the state of the checkbox. In any case, verify bullets and
indentation consistency in the whole list.
‘ ’
Cycle the entire list level through the different itemize/enumerate
bullets (‘ ’ ‘ ’ ‘ ’ ‘ ’ ‘ ’
on ‘ ’
its indentation. With a numeric prefix argument N, select the Nth
bullet from this list. If there is an active region when calling
this, selected text is changed into an item. With a prefix
argument, all lines are converted to list items. If the first line
already was a list item, any item marker is removed from the list.
Finally, even without an active region, a normal line is converted
into a list item.
‘ ’
Turn a plain list item into a headline—so that it becomes a
subheading at its location. See *note Structure Editing::, for a
detailed explanation.
‘ ’
Turn the whole plain list into a subtree of the current heading.
2019-12-06 19:15:46 +01:00
Checkboxes (see *note Checkboxes::) become ‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
‘ ’
‘ ’
This command also cycles bullet styles when point is in on the
bullet or anywhere in an item line, details depending on
‘ ’
‘ ’
Sort the plain list. Prompt for the sorting method: numerically,
alphabetically, by time, or by custom function.
---------- Footnotes ----------
(1) When using ‘ ’
are not interpreted as 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
‘ ’
(2) You can filter out any of them by configuring
‘ ’
(3) You can also get ‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
those are limited to one character only. Beyond that limit, bullets
automatically become numbers.
(4) If there’
_before_ the checkbox. If you have activated alphabetical lists, you
can also use counters like ‘ ’
(5) If you do not want the item to be split, customize the variable
‘ ’
(6) If you want to cycle around items that way, you may customize
‘ ’
(7) See ‘ ’
File: org, Node: Drawers, Next: Blocks, Prev: Plain Lists, Up: Document Structure
2.7 Drawers
===========
Sometimes you want to keep information associated with an entry, but you
normally do not 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 a drawer at point by calling
‘ ’ ‘ ’
region, this command puts the region inside the drawer. With a prefix
argument, this command calls ‘ ’
a ‘ ’
this special drawer for storing properties (see *note Properties and
Columns::). You cannot use it for anything else.
Completion over drawer keywords is also possible using ‘ ’
Visibility cycling (see *note Visibility Cycling::) on the headline
hides and shows the entry, but keep the drawer collapsed to a single
line. In order to look inside the drawer, you need to move point to the
drawer line and press ‘ ’
You can also arrange for state change notes (see *note Tracking TODO
state changes::) and clock times (see *note Clocking Work Time::) to be
stored in a ‘ ’
in a similar way to state changes, use
‘ ’
Add a time-stamped note to the ‘ ’
---------- Footnotes ----------
(1) Many desktops intercept ‘ ’ ‘ ’
or ‘ ’
2019-12-06 19:15:46 +01:00
File: org, Node: Blocks, Prev: Drawers, Up: Document Structure
2019-11-26 16:46:24 +01:00
2.8 Blocks
==========
Org mode uses ‘ ’ ‘ ’
including source code examples (see *note Literal Examples::) to
capturing time logging information (see *note Clocking Work Time::).
These blocks can be folded and unfolded by pressing ‘ ’
‘ ’
configuring the variable ‘ ’
by using
#+STARTUP: hideblocks
#+STARTUP: nohideblocks
File: org, 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 (see *note GNU
Emacs Calculator Manual: (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, Node: Built-in Table Editor, Next: Column Width and Alignment, Up: Tables
3.1 Built-in Table Editor
=========================
Org makes it easy to format tables in plain ASCII. Any line with ‘ ’
the first non-whitespace character is considered part of a table. ‘ ’
is also the column separator(1). Moreover, a line starting with ‘ ’
2019-12-06 19:15:46 +01:00
a horizontal rule. It separates rows explicitly. Rows before the first
horizontal rule are header lines. A table might look like this:
2019-11-26 16:46:24 +01:00
| Name | Phone | Age |
|-------+-------+-----|
| Peter | 1234 | 17 |
| Anna | 4321 | 25 |
A table is re-aligned automatically each time you press ‘ ’
‘ ’ ‘ ’ ‘ ’
field—‘ ’
the table or before horizontal lines. The indentation of the table is
set by the first line. Horizontal rules are automatically expanded on
every re-align to span the whole table width. So, to create the above
table, you would only type
|Name|Phone|Age|
|-
and then press ‘ ’
Even faster would be to type ‘ ’ ‘ ’
When typing text into a field, Org treats ‘ ’ ‘ ’
character keys in a special way, so that inserting and deleting avoids
shifting other fields. Also, when typing _immediately_ after point was
moved into a new field with ‘ ’ ‘ ’ ‘ ’
automatically made blank. If this behavior is too unpredictable for
you, configure the option ‘ ’
Creation and conversion
-----------------------
‘ ’ ‘ ’
Convert the active region to table. If every line contains at
least one ‘ ’
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’
numeric argument N indicates that at least N consecutive spaces, or
alternatively a ‘ ’
If there is no active region, this command creates an empty Org
table. But it is easier just to start typing, like ‘
h o n e | A g e <RET> | - <TAB>’
Re-aligning and field motion
----------------------------
‘ ’ ‘ ’
Re-align the table without moving point.
‘ ’ ‘ ’
Re-align the table, move to the next field. Creates a new row if
necessary.
‘ ’ ‘ ’
Blank the field at point.
‘ ’ ‘ ’
Re-align, move to previous field.
‘ ’ ‘ ’
Re-align the table and move down to next row. Creates a new row if
necessary. At the beginning or end of a line, ‘ ’
inserts a new line, so it can be used to split a table.
‘ ’ ‘ ’
Move to beginning of the current table field, or on to the previous
field.
‘ ’ ‘ ’
Move to end of the current table field, or on to the next field.
Column and row editing
----------------------
‘ ’ ‘ ’
Move the current column left.
‘ ’ ‘ ’
Move the current column right.
‘ ’ ‘ ’
Kill the current column.
‘ ’ ‘ ’
Insert a new column to the left of point position.
‘ ’ ‘ ’
Move the current row up.
‘ ’ ‘ ’
Move the current row down.
‘ ’ ‘ ’
Kill the current row or horizontal line.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Move cell up by swapping with adjacent cell.
‘ ’ ‘ ’
Move cell down by swapping with adjacent cell.
‘ ’ ‘ ’
Move cell left by swapping with adjacent cell.
‘ ’ ‘ ’
Move cell right by swapping with adjacent cell.
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Insert a new row above the current row. With a prefix argument,
the line is created below the current one.
‘ ’ ‘ ’
Insert a horizontal line below current row. With a prefix
argument, the line is created above the current line.
‘ ’ ‘ ’
Insert a horizontal line below current row, and move point into the
row below that line.
‘ ’ ‘ ’
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 are
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 is
case-sensitive.
Regions
-------
‘ ’ ‘ ’
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.
‘ ’ ‘ ’
Copy a rectangular region from a table to a special clipboard, and
blank all fields in the rectangle. So this is the “cut” operation.
‘ ’ ‘ ’
Paste a rectangular region into a table. The upper left corner
ends up in the current field. All involved fields are overwritten.
If the rectangle does not fit into the present table, the table is
enlarged as needed. The process ignores horizontal separator
lines.
‘ ’ ‘ ’
Split the current field at point 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
------------
‘ ’ ‘ ’
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 ‘ ’
‘ ’ ‘ ’
When current field is empty, copy from first non-empty field above.
When not empty, copy current field down to next row and move point
2019-12-06 19:15:46 +01:00
along with it.
Depending on the variable ‘ ’
time stamp field values, and fields prefixed or suffixed with a
whole number, can be incremented during copy. Also, a ‘ ’
argument temporarily disables the increment.
This key is also used by shift-selection and related modes (see
*note Conflicts::).
2019-11-26 16:46:24 +01:00
Miscellaneous
-------------
‘ ’ ‘ ’
Edit the current field in a separate window. This is useful for
fields that are not fully visible (see *note Column Width and
Alignment::). When called with a ‘ ’
field visible, so that it can be edited in place. When called with
two ‘ ’
table and always show the current field. The follow mode exits
automatically when point leaves the table, or when you repeat this
command with ‘ ’
‘ ’
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.
‘ ’ ‘ ’
Tables can also be imported by pasting tabular text into the Org
buffer, selecting the pasted text with ‘ ’
‘ ’
‘ ’
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 variable
‘ ’
‘ ’ ‘ ’
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 ‘ ’
inside a word ‘ ’
File: org, 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.
The alignment of a column is determined automatically from the fraction
of number-like versus non-number fields in the column.
Editing a field may modify alignment of the table. Moving a
contiguous row or column—i.e., using ‘ ’ ‘ ’
re-aligns it. If you want to disable this behavior, set
‘ ’ ‘ ’
align manually a table:
‘ ’ ‘ ’
Align the current table.
Setting the option ‘ ’
tables in a file upon visiting it. You can also set this option on a
per-file basis with:
#+STARTUP: align
#+STARTUP: noalign
Sometimes a single field or a few fields need to carry more text,
leading to inconveniently wide columns. Maybe you want to hide away
several columns or display them with a fixed width, regardless of
content, as shown in the following example.
2019-12-29 11:23:16 +01:00
|---+---------------------+--------| |---+-------…+…|
2019-11-26 16:46:24 +01:00
| | <6> | | | | <6> …|…|
| 1 | one | some | ----\ | 1 | one …|…|
| 2 | two | boring | ----/ | 2 | two …|…|
| 3 | This is a long text | column | | 3 | This i…|…|
2019-12-29 11:23:16 +01:00
|---+---------------------+--------| |---+-------…+…|
2019-11-26 16:46:24 +01:00
To set the width of a column, one field anywhere in the column may
contain just the string ‘ ’
characters. You control displayed width of columns with the following
tools:
‘ ’ ‘ ’
Shrink or expand current column.
If a width cookie specifies a width W for the column, shrinking it
displays the first W visible characters only. Otherwise, the
column is shrunk to a single character.
When called before the first column or after the last one, ask for
a list of column ranges to operate on.
‘ ’ ‘ ’
Shrink all columns with a column width. Expand the others.
‘ ’ ‘ ’
Expand all columns.
To see the full text of a shrunk field, hold the mouse over it: a
tool-tip window then shows the full contents of the field.
Alternatively, ‘ ’ ‘ ’
convenience, any change near the shrunk part of a column expands it.
Setting the option ‘ ’
columns containing a width cookie in a file the moment it is visited.
You can also set this option on a per-file basis with:
#+STARTUP: shrink
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
‘ ’ ‘ ’ ‘ ’
alignment and field width like this: ‘ ’
Lines which only contain these formatting cookies are removed
automatically upon exporting the document.
File: org, 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 end of a column, or ‘ ’ ‘ ’ ‘ ’
column a group of its own. Upon export, boundaries between column
groups are 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, 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 ‘ ’
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, 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’
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 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, automatic recalculation...
File: org, 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 ‘ ’
press ‘ ’
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 ‘ ’
However, Org prefers to use another, more general representation that
looks like this:(1)
@ROW$COLUMN
Column specifications can be absolute like ‘ ’ ‘ ’ ‘ ’
relative to the current column, i.e., the column of the field which is
being computed, like ‘ ’ ‘ ’ ‘ ’ ‘ ’
references to the first and last column, respectively, and you can use
‘ ’
The row specification only counts data lines and ignores horizontal
separator lines, or “hlines”. Like with columns, you can use absolute
row numbers ‘ ’ ‘ ’ ‘ ’
current row like ‘ ’ ‘ ’ ‘ ’ ‘ ’
the first and last row in the table, respectively. You may also specify
the row relative to one of the hlines: ‘ ’
‘ ’ ‘ ’
current line, ‘ ’
can also write ‘ ’
hline in the table.
‘ ’ ‘ ’
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’
sense that if you use the same reference in the formula for two
different fields, the same field is referenced each time. Org’
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:
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
Range references
................
You may reference a rectangular range of fields by specifying two field
references connected by two dots ‘ ’
current row, you may simply use ‘ ’
in a different row, you need to use the general ‘ ’
least for the first field, i.e., the reference must start with ‘ ’
order to be interpreted correctly. Examples:
‘ ’
‘ ’
*note Advanced features::)
‘ ’
‘ ’ ‘ ’
‘ ’
the left
‘ ’ ‘ ’
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 ‘ ’ ‘ ’
for Calc::.
Field coordinates in formulas
.............................
One of the very first actions during evaluation of Calc formulas and
Lisp formulas is to substitute ‘ ’ ‘ ’
or column number of the field where the current result will go to. The
traditional Lisp formula equivalents are ‘ ’
‘ ’
‘ ’
Insert column number on odd rows, set field to empty on even rows.
‘ ’
Copy text or values of each row of column 1 of the table named FOO
into column 2 of the current table.
2019-12-29 11:23:16 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
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 and third examples, table FOO must have at least as many
rows or columns as the current table. Note that this is inefficient(2)
for large number of rows.
Named references
................
‘ ’
Constants are defined globally through the variable
‘ ’
like this example:
#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
Also, properties (see *note Properties and Columns::) can be used as
constants in table formulas: for a property ‘ ’
‘ ’
entry and in the hierarchy above it. If you have the ‘ ’
package, it will also be used to resolve constants, including natural
constants like ‘ ’ ’ ‘ ’
kilometers(3). 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,REF)
where NAME can be the name of a table in the current file as set by a
‘ ’
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 ‘ ’ ‘ ’
referenced table.
When NAME has the format ‘ ’
name or ID found in this field of the current table. For example
‘ ’ ‘ ’ ‘ ’
not supported because it can not be distinguished from a plain table
name or ID.
---------- Footnotes ----------
(1) Org understands references typed by the user as ‘ ’
not use this syntax when offering a formula for editing. You can
customize this behavior using the variable
‘ ’
(2) The computation time scales as O(N^2) because table FOO is parsed
for each field to be copied.
(3) The file ‘ ’
different unit systems, ‘ ’ ‘ ’
the value of the variable ‘ ’
‘ ’ ‘ ’ ‘ ’
current buffer.
File: org, 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 ‘ ’
lower precedence than ‘ ’ ‘ ’
‘ ’ ‘ ’
from Your Lisp Programs: (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 ‘ ’ ‘ ’
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 ‘ ’
The default settings can be configured using the variable
‘ ’
‘ ’
Set the internal Calc calculation precision to 20 digits.
‘ ’ ‘ ’ ‘ ’ ‘ ’
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.
‘ ’ ‘ ’
Degree and radian angle modes of Calc.
‘ ’ ‘ ’
Fraction and symbolic modes of Calc.
‘ ’ ‘ ’ ‘ ’
Duration computations in Calc or Lisp, *note Durations and time
values::.
‘ ’
If and how to consider empty fields. Without ‘ ’
range references are suppressed so that the Calc vector or Lisp
list contains only the non-empty fields. With ‘ ’
are kept. For empty fields in ranges or empty field references the
value ‘ ’
string is used for Lisp formulas. Add ‘ ’
both formula types. For the value of a field the mode ‘ ’
higher precedence than ‘ ’
‘ ’
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 ‘ ’
‘ ’
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
‘ ’
passed back to Org instead of letting Calc already do the formatting(1).
A few examples:
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
Calc also contains a complete set of logical operations (see *note
Logical Operations: (calc)Logical Operations.). For example
‘ ’
‘ ’ ‘ ’
field is set to empty with the empty string.
‘ ’
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. ‘ ’
required to not convert empty fields to 0. ‘ ’
Calc format string similar to ‘ ’
empty.
‘ ’
Mean value of a range unless there is any empty field. Every field
in the range that is empty is replaced by ‘ ’ ‘ ’
result in ‘ ’ ‘ ’ ‘ ’
‘ ’
when the sample set is expected to never have missing values.
‘ ’
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.
‘ ’
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
‘ ’
---------- 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, 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’
functionality is not enough.
If a formula starts with a single-quote 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 ‘ ’
With Emacs Lisp forms, you need to be conscious about the way field
references are interpolated into the form. By default, a reference is
interpolated as a Lisp string (in double-quotes) containing the field.
If you provide the ‘ ’
numbers—non-number fields will be zero—and interpolated as Lisp numbers,
without quotes. If you provide the ‘ ’
interpolated literally, without quotes. For example, if you want a
reference to be interpreted as a string by the Lisp form, enclose the
reference operator itself in double-quotes, like ‘ ’
inserted as space-separated fields, so you can embed them in list or
vector syntax.
Here are a few examples—note how the ‘ ’
computations in Lisp:
‘ ’
Swap the first two characters of the content of column 1.
‘ ’
Add columns 1 and 2, equivalent to Calc’ ‘ ’
‘ ’
Compute the sum of columns 1 to 4, like Calc’ ‘ ’
File: org, 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 ‘ ’ ‘ ’ ‘ ’
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 ‘ ’
are optional. With the ‘ ’
‘ ’ ‘ ’
are omitted so that the result is only ‘ ’
above). Zero-padding of the hours field depends upon the value of the
variable ‘ ’
With the ‘ ’
value of the option ‘ ’
to ‘ ’
formula in the example above).
Negative duration values can be manipulated as well, and integers are
considered as seconds in addition and subtraction.
File: org, 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 ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
formula is stored as the formula for this field, evaluated, and the
current field is replaced with the result.
Formulas are stored in a special ‘ ’
below the table. If you type the equation in the fourth field of the
third data line in the table, the formula looks like ‘ ’
inserting/deleting/swapping column 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 from happening, in particular in range references, anchor
ranges at the table borders (using ‘ ’ ‘ ’ ‘ ’ ‘ ’
using the ‘ ’
not happen if you edit the table structure with normal editing
commands—you must fix the formulas yourself.
Instead of typing an equation into the field, you may also use the
following command
‘ ’ ‘ ’
Install a new formula for the current field. The command prompts
for a formula with default taken from the ‘ ’
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 (see *note Editing and debugging formulas::) or edit the
‘ ’
‘ ’
Column formula, valid for the entire column. This is so common
that Org treats these formulas in a special way, see *note Column
formulas::.
‘ ’
Row formula, applies to all fields in the specified row. ‘ ’
means the last row.
‘ ’
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.
‘ ’
Named field, see *note Advanced features::.
File: org, 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 ‘ ’
same formula is 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 is not 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 are 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 ‘ ’
‘ ’ ‘ ’ ‘ ’
formula is stored as the formula for the current column, evaluated and
the current field replaced with the result. If the field contains only
‘ ’
column, Org only remembers the most recently used formula. In the
‘ ’ ‘ ’
side of a column formula can not 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:
‘ ’ ‘ ’
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 ‘ ’
the current field and stores it. With a numeric prefix argument,
e.g., ‘ ’
fields in the current column.
File: org, 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.
‘ ’
Searches for the first element S in list S-LIST for which
(PREDICATE VAL S)
is non-‘ ’
list R-LIST. The default PREDICATE is ‘ ’
parameters VAL and S are passed to PREDICATE in the same order as
the corresponding parameters are in the call to ‘ ’
where VAL precedes S-LIST. If R-LIST is ‘ ’
element S of S-LIST is returned.
‘ ’
Similar to ‘ ’
element for which PREDICATE is non-‘ ’
‘ ’
Similar to ‘ ’
which PREDICATE is non-‘ ’
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 ‘ ’
mode for the formula should usually be specified: otherwise empty fields
are not 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, 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 ‘ ’ ‘ ’
you prefer to only work with the internal format (like ‘ ’ ‘ ’
configure the variable ‘ ’
‘ ’ ‘ ’ ‘ ’
Edit the formula associated with the current column/field in the
minibuffer. See *note Column formulas::, and *note Field and range
formulas::.
‘ ’ ‘ ’
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 ‘ ’
‘ ’ ‘ ’
While editing a formula in a table field, highlight the field(s)
referenced by the reference at point position in the formula.
‘ ’ ‘ ’
Toggle the display of row and column numbers for a table, using
overlays. These are updated each time the table is aligned; you
can force it with ‘ ’
‘ ’ ‘ ’
Toggle the formula debugger on and off. See below.
‘ ’ ‘ ’
Edit all formulas for the current table in a special buffer, where
the formulas are displayed one per line. If the current field has
an active formula, point in the formula editor marks it. While
inside the special buffer, Org automatically highlights any field
or range reference at point position. You may edit, remove and add
formulas, and use the following commands:
‘ ’ ‘ ’ ‘ ’
Exit the formula editor and store the modified formulas. With
‘ ’
‘ ’ ‘ ’
Exit the formula editor without installing changes.
‘ ’ ‘ ’
Toggle all references in the formula editor between standard
(like ‘ ’ ‘ ’
‘ ’ ‘ ’
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 ‘ ’
again. In the open formula, ‘ ’
Emacs Lisp mode.
‘ ’ ‘ ’
Complete Lisp symbols, just like in Emacs Lisp mode.
‘ ’ ‘ ’ ‘ ’ ‘ ’
Shift the reference at point. For example, if the reference
is ‘ ’ ‘ ’ ‘ ’
works for relative references and for hline references.
‘ ’ ‘ ’
Move the test line for column formulas up in the Org buffer.
‘ ’ ‘ ’
Move the test line for column formulas down in the Org buffer.
‘ ’ ‘ ’
Scroll up the window displaying the table.
‘ ’ ‘ ’
Scroll down the window displaying the table.
‘ ’
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 ‘ ’
keyword 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 ‘ ’
You may edit the ‘ ’
equations with ‘ ’
commands in the table.
Using multiple ‘ ’
............................
You may apply the formula temporarily. This is useful when you want to
switch the formula applied to the table. Place multiple ‘ ’
keywords right after the table, and then press ‘ ’
to apply. Here is an example:
| x | y |
|---+---|
| 1 | |
| 2 | |
#+TBLFM: $2=$1*1
#+TBLFM: $2=$1*2
Pressing ‘ ’ ‘ ’
| x | y |
|---+---|
| 1 | 2 |
| 2 | 4 |
#+TBLFM: $2=$1*1
#+TBLFM: $2=$1*2
If you recalculate this table, with ‘ ’
the following result from applying only the first ‘ ’
| 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 ‘ ’
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 ‘ ’
information are displayed.
File: org, 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. To make recalculation at least semi-automatic,
see *note Advanced features::.
In order to recalculate a line of a table or the entire table, use
the following commands:
‘ ’ ‘ ’
Recalculate the current row by first applying the stored column
formulas from left to right, and all field/range formulas in the
current row.
‘ ’ ‘ ’
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.
‘ ’ ‘ ’ ‘ ’
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.
‘ ’
Recompute all tables in the current buffer.
‘ ’
Iterate all tables in the current buffer, in order to converge
table-to-table dependencies.
File: org, 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.
‘ ’ ‘ ’
Rotate the calculation mark in first column through the states ‘ ’
‘ ’ ‘ ’ ‘ ’
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 ‘ ’ ‘ ’
‘ ’
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 ‘ ’ ‘ ’
‘ ’
This row defines names for the fields _above_ the row. With such a
definition, any formula in the table may use ‘ ’
value ‘ ’
stored as ‘ ’
‘ ’
Similar to ‘ ’
_below_.
‘ ’
Fields in this row can define _parameters_ for formulas. For
example, if a field in a ‘ ’ ‘ ’
in this table can refer to the value 50 using ‘ ’
work exactly like constants, only that they can be defined on a
per-table basis.
‘ ’
Fields in this row are automatically recalculated when pressing
‘ ’ ‘ ’ ‘ ’
selected for a global recalculation with ‘ ’
lines are left alone by this command.
‘ ’
Selects this line for global recalculation with ‘ ’
not for automatic recalculation. Use this when automatic
recalculation slows down editing too much.
‘ ’
Do not export this line. Useful for lines that contain the
narrowing ‘ ’
Finally, just to whet your appetite for what can be done with the
fantastic Calc 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 with an alphabetic character and use only
alphanumeric/underscore characters.
File: org, 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 can produce 2D and 3D graphs of information stored in Org
tables using Gnuplot (http://www.gnuplot.info/) and Gnuplot mode
(http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html). To see
this in action, ensure that you have both Gnuplot and Gnuplot mode
installed on your system, then call ‘ ’ ‘ ’
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’
labels. Further control over the labels, type, content, and appearance
of plots can be exercised through the ‘ ’
See below for a complete list of Org Plot options. For more information
and examples see the Org Plot tutorial
(https://orgmode.org/worg/org-tutorials/org-plot.html).
Plot options
............
‘ ’
Specify any Gnuplot option to be set when graphing.
‘ ’
Specify the title of the plot.
‘ ’
Specify which column of the table to use as the ‘ ’
‘ ’
Specify the columns to graph as a Lisp style list, surrounded by
parentheses and separated by spaces for example ‘ ’
graph the third and fourth columns. Defaults to graphing all other
columns aside from the ‘ ’
‘ ’
Specify whether the plot is ‘ ’ ‘ ’ ‘ ’
‘ ’
Specify a ‘ ’
plotted, e.g., ‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
‘ ’
If you want to plot to a file, specify
‘ ’
‘ ’
List of labels to be used for the ‘ ’
headers if they exist.
‘ ’
Specify an entire line to be inserted in the Gnuplot script.
‘ ’
When plotting ‘ ’ ‘ ’ ‘ ’
mapping rather than a ‘ ’
‘ ’
Specify format of Org mode timestamps as they will be parsed by
Gnuplot. Defaults to ‘ ’
‘ ’
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 ‘ ’
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 point is on a column, typing ‘ ’ ‘ ’
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 ‘ ’
| 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.
-- Function: orgtbl-ascii-draw value min max &optional width
Draw an ASCII bar in a table.
VALUE is the value to plot.
MIN is the value displayed as an empty bar. MAX is the value
filling all the WIDTH. Sources values outside this range are
displayed as ‘ ’ ‘ ’
WIDTH is the number of characters of the bar plot. It defaults to
‘ ’
File: org, Node: Hyperlinks, Next: TODO Items, Prev: Tables, Up: Top
4 Hyperlinks
************
Like HTML, Org provides support for 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.
* Radio Targets:: Make targets trigger links in plain text.
* 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, Node: Link Format, Next: Internal Links, Up: Hyperlinks
4.1 Link Format
===============
Org recognizes plain URIs, possibly wrapped within angle brackets(1),
and activate them as clickable links.
The general link format, however, looks like this:
[[LINK][DESCRIPTION]]
or alternatively
[[LINK]]
2019-12-29 11:23:16 +01:00
Some ‘ ’ ‘ ’ ‘ ’
“escaped”, i.e., preceded by another ‘ ’
the following characters, and only them, must be escaped:
2019-12-06 19:15:46 +01:00
2019-12-29 11:23:16 +01:00
1. all ‘ ’ ‘ ’
2. every ‘ ’ ‘ ’ ‘ ’
3. every ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-29 11:23:16 +01:00
Functions inserting links (see *note Handling Links::) properly
escape ambiguous characters. You only need to bother about the rules
above when inserting directly, or yanking, a URI within square brackets.
When in doubt, you may use the function ‘ ’
link string into its escaped form.
2019-11-26 16:46:24 +01:00
Once a link in the buffer is complete, with all brackets present, Org
changes the display so that ‘ ’
‘ ’ ‘ ’ ‘ ’
Links are highlighted in the ‘ ’
underlined face.
You can directly edit the visible part of a link. This can be either
the LINK part, if there is no description, or the DESCRIPTION part
otherwise. To also edit the invisible LINK part, use ‘ ’
point on the link (see *note Handling Links::).
If you place point at the beginning or just behind the end of the
displayed text and press ‘ ’
that location(2). 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: Org → Hyperlinks → Literal links.
---------- Footnotes ----------
(1) Plain URIs are recognized only for a well-defined set of schemes.
See *note External Links::. Unlike URI syntax, they cannot contain
parenthesis or white spaces, either. URIs within angle brackets have no
such limitation.
(2) More accurately, the precise behavior depends on how point
arrived there—see *note Invisible Text: (elisp)Invisible Text.
File: org, Node: Internal Links, Next: Radio Targets, Prev: Link Format, Up: Hyperlinks
4.2 Internal Links
==================
2019-12-29 11:23:16 +01:00
A link that does not look like a URL—i.e., does not start with a known
scheme or a file name—refers to the current document. You can follow it
with ‘ ’
*note Handling Links::).
2019-11-26 16:46:24 +01:00
2019-12-29 11:23:16 +01:00
Org provides several refinements to internal navigation within a
document. Most notably, a construct like ‘ ’
specifically targets the entry with the ‘ ’
‘ ’ ‘ ’
points to a headline with the name ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-29 11:23:16 +01:00
When the link does not belong to any of the cases above, Org looks
for a _dedicated target_: the same string in double angular brackets,
like ‘ ’
2019-11-26 16:46:24 +01:00
If no dedicated target exists, the link tries to match the exact name
2019-12-29 11:23:16 +01:00
of an element within the buffer. Naming is done, unsurprisingly, with
the ‘ ’
it refers to, as in the following example
2019-11-26 16:46:24 +01:00
#+NAME: My Target
| a | table |
|----+------------|
| of | four cells |
2019-12-29 11:23:16 +01:00
Ultimately, if none of the above succeeds, Org searches for a
headline that is exactly the link text but may also include a TODO
keyword and tags, or initiates a plain text search, according to the
value of ‘ ’
Note that you must make sure custom IDs, dedicated targets, and names
are unique throughout the document. Org provides a linter to assist you
in the process, if needed. See *note Org Syntax::.
2019-11-26 16:46:24 +01:00
During export, internal links are used to mark objects and assign
them a number. Marked objects are then referenced by links pointing to
them. In particular, links without a description appear as the number
assigned to the marked object(2). In the following excerpt from an Org
buffer
1. one item
2. <<target>>another item
Here we refer to item [[target]].
The last sentence will appear as ‘ ’
exported.
In non-Org files, the search looks for the words in the link text.
In the above example the search would be for ‘ ’
Following a link pushes a mark onto Org’
return to the previous position with ‘ ’
several times in direct succession goes back to positions recorded
earlier.
---------- 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 ‘ ’
offered as completions.
(2) When targeting a ‘ ’ ‘ ’
mandatory in order to get proper numbering (see *note Captions::).
File: org, Node: Radio Targets, Next: External Links, Prev: Internal Links, Up: Hyperlinks
4.3 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 ‘
Target>>>’ ‘ ’
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 ‘ ’
target.
File: org, Node: External Links, Next: Handling Links, Prev: Radio Targets, Up: Hyperlinks
4.4 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
2019-12-06 19:15:46 +01:00
colon.
Here is the full set of built-in link types:
‘ ’
File links. File name may be remote, absolute, or relative.
Additionally, you can specify a line number, or a text search. In
Org files, you may link to a headline name, a custom ID, or a code
reference instead.
As a special case, “file” prefix may be omitted if the file name is
complete, e.g., it starts with ‘ ’ ‘ ’
‘ ’
Same as file links but for files and folders attached to the
current node (see *note Attachments::). Attachment links are
intended to behave exactly as file links but for files relative to
the attachment directory.
‘ ’
Link to a BBDB record, with possible regexp completion.
‘ ’
Link to a document opened with DocView mode. You may specify a
page number.
‘ ’
Link to an electronic resource, through its handle.
‘ ’
Execute an Elisp command upon activation.
‘ ’ ‘ ’ ‘ ’
Link to messages or folders from a given Emacs’
‘ ’
Display documentation of a symbol in ‘ ’
‘ ’ ‘ ’
Web links.
‘ ’
Link to a specific headline by its ID property, in an Org file.
‘ ’
Link to an Info manual, or to a specific node.
‘ ’
Link to an IRC channel.
‘ ’
Link to message composition.
‘ ’
Usenet links.
‘ ’
Execute a shell command upon activation.
The following table illustrates the link types above, along with
their options:
Link Type Example
------------------------------------------------------------------------
http ‘ ’
https ‘ ’
doi ‘ ’
file ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
2019-12-29 11:23:16 +01:00
‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
attachment ‘ ’
‘ ’
docview ‘ ’
id ‘ ’
news ‘ ’
mailto ‘ ’
mhe ‘ ’
‘ ’
rmail ‘ ’
‘ ’
gnus ‘ ’
‘ ’
bbdb ‘ ’
irc ‘ ’
help ‘ ’
info ‘ ’
shell ‘ ’
elisp ‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
On top of these built-in link types, additional ones are available
through the ‘ ’
example, these links to VM or Wanderlust messages are available when you
load the corresponding libraries from the ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
For information on customizing Org to add new link types, see *note
Adding Hyperlink Types::.
A link should be enclosed in double brackets and may contain
descriptive text to be displayed instead of the URL (see *note Link
Format::), for example:
[[http://www.gnu.org/software/emacs/][GNU Emacs]]
If the description is a file name or URL that points to an image,
HTML export (see *note HTML Export::) inlines the image as a clickable
button. If there is no description at all and the link points to an
image, that image is inlined into the exported HTML file.
2019-12-06 19:15:46 +01:00
Org also recognizes external links amid normal text and activates
them as links. If spaces must be part of the link (for example in
‘ ’
of the link, enclose the link in square or angular brackets.
2019-11-26 16:46:24 +01:00
---------- Footnotes ----------
(1) The actual behavior of the search depends on the value of the
variable ‘ ’
‘ ’ ‘ ’
exact headline is matched, ignoring spaces and statistic cookies. If
the value is ‘ ’
it is not found, then the user is queried to create it.
File: org, Node: Handling Links, Next: Using Links Outside Org, Prev: External Links, Up: Hyperlinks
4.5 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.
The main function is ‘ ’ ‘
org-store-link’
widely available key (see *note Activation::). It stores a link to the
current location. The link is stored for later insertion into an Org
buffer—see below. The kind of link that is created depends on the
current buffer:
_Org mode buffers_
For Org files, if there is a ‘ ’
to the target. Otherwise it points to the current headline, which
is also the description(1).
If the headline has a ‘ ’
custom ID. In addition or alternatively, depending on the value of
‘ ’
‘ ’
buffers potentially creates two links: a human-readable link 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 points
to the current article, or, in some Gnus buffers, to the group.
The description is constructed according to the variable
2019-12-06 19:15:46 +01:00
‘ ’
addressee and the subject.
2019-11-26 16:46:24 +01:00
_Web browsers: W3, W3M and EWW_
Here the link is the current URL, with the page title as the
description.
_Contacts: BBDB_
Links created in a BBDB buffer point to the current entry.
_Chat: IRC_
For IRC links, if the variable ‘ ’ ‘ ’
create a ‘ ’
the current conversation. Otherwise store an ‘ ’
the user/channel/server under the point.
_Other files_
For any other file, the link points to the file, with a search
string (see *note Search Options::) pointing to the contents of the
current line. If there is an active region, the selected words
form the basis of the search string. You can write custom Lisp
functions to select the search string and perform the search for
particular file types (see *note Custom Searches::).
You can also define dedicated links to other files. See *note
Adding Hyperlink Types::.
_Agenda view_
When point is in an agenda view, the created link points to the
entry referenced by the current line.
From an Org buffer, the following commands create, navigate or, more
generally, act on links.
‘ ’ ‘ ’
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 is inserted into the buffer, along with a descriptive
text(4). If some text was selected at this time, it 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 ‘ ’
and ‘ ’ ‘ ’ ‘ ’
_Completion support_
Completion with ‘ ’
prefixes like ‘ ’ ‘ ’
through link abbreviations (see *note Link Abbreviations::).
If you press ‘ ’
offers specific completion support for some link types(5).
For example, if you type ‘ ’
‘ ’
after ‘ ’
‘ ’
When ‘ ’ ‘ ’
link to a file. 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 ‘ ’
an absolute path is used, if possible with ‘ ’
directory. You can force an absolute path with two ‘ ’
‘ ’
When point is on an existing link, ‘ ’
link and description parts of the link.
‘ ’ ‘ ’
Open link at point. This launches a web browser for URL (using
‘ ’
the corresponding links, and execute the command in a shell link.
When point is on an internal link, this command runs the
corresponding search. When point is on the tags part of a
headline, it creates the corresponding tags view (see *note
Matching tags and properties::). If point is on a timestamp, it
compiles the agenda for that date. Furthermore, it visits text and
remote files in ‘ ’
application for local non-text files. Classification of files is
based on file extension only. See option ‘ ’
want to override the default application and visit the file with
Emacs, use a ‘ ’
use a ‘ ’
If point 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
‘ ’
‘ ’
When ‘ ’ ‘ ’
link at point.
‘ ’ ‘ ’
On links, ‘ ’ ‘ ’ ‘ ’
does.
‘ ’
Like ‘ ’
internal links to be displayed in another window(6).
‘ ’ ‘ ’
Push the current position onto the Org mark ring, to be able to
return easily. Commands following an internal link do this
automatically.
‘ ’ ‘ ’
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by ‘ ’
command several times in direct succession moves through a ring of
previously recorded positions.
‘ ’ ‘ ’
‘ ’ ‘ ’
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 ‘ ’ ‘ ’
(add-hook 'org-load-hook
(lambda ()
(define-key org-mode-map "\M-n" 'org-next-link)
(define-key org-mode-map "\M-p" 'org-previous-link)))
---------- Footnotes ----------
(1) If the headline contains a timestamp, it is removed from the
link, which results in a wrong link—you should avoid putting a timestamp
in the headline.
(2) The Org Id library must first be loaded, either through
‘ ’ ‘ ’ ‘ ’
‘ ’
(3) Note that you do not 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 for later use, use a
triple ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
(5) This works if a function has been defined in the ‘ ’
property of a link in ‘ ’
2019-12-06 19:15:46 +01:00
(6) See the variable ‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: Using Links Outside Org, Next: Link Abbreviations, Prev: Handling Links, Up: Hyperlinks
4.6 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, Org provides two functions:
‘ ’ ‘ ’
You might want to bind them to globally available keys. See *note
Activation:: for some advice.
File: org, Node: Link Abbreviations, Next: Search Options, Prev: Using Links Outside Org, Up: Hyperlinks
4.7 Link Abbreviations
======================
Long URL 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, ‘ ’ ‘ ’
resolved according to the information in the variable
‘ ’
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" . "https://ui.adsabs.harvard.edu/search/q=%20author%3A\"%s\"")))
If the replacement text contains the string ‘ ’
the tag. Using ‘ ’ ‘ ’
example above, where we need to encode the URL parameter). Using
‘ ’
it by the resulting string.
If the replacement text do not contain any specifier, it is simply
appended to the string in order to create the link.
Instead of a string, you may also specify a Lisp function to create
the link. Such a function will be called with the tag as the only
argument.
With the above setting, you could link to a specific bug with
‘ ’ ‘ ’
‘ ’
Foundation ‘ ’
‘ ’
what the Org author is doing besides Emacs hacking with
‘ ’
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 (see *note Completion::) can be used after ‘ ’
to complete link abbreviations. You may also define a Lisp function
that implements special (e.g., completion) support for inserting such a
link with ‘ ’
and should return the full link with a prefix. You can set the link
completion function like this:
(org-link-set-parameter "type" :complete #'some-completion-function)
File: org, Node: Search Options, Next: Custom Searches, Prev: Link Abbreviations, Up: Hyperlinks
4.8 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 colon(1). For example,
when the command ‘ ’
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 ‘ ’
2019-12-06 19:15:46 +01:00
Note that all search options apply for Attachment links in the same
way that they apply for File links.
2019-11-26 16:46:24 +01:00
Here is the syntax of the different ways to attach a search to a file
link, together with explanations for each:
[[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/]]
2019-12-06 19:15:46 +01:00
[[attachment:main.c::255]]
2019-11-26 16:46:24 +01:00
‘ ’
Jump to line 255.
‘ ’
Search for a link target ‘ ’
‘ ’
Internal Links::. In HTML export (see *note HTML Export::), such a
file link becomes a HTML reference to the corresponding named
anchor in the linked file.
‘ ’
In an Org file, restrict search to headlines.
‘ ’
Link to a heading with a ‘ ’
‘ ’
Do a regular expression search for REGEXP. This uses the Emacs
command ‘ ’
target file is in Org mode, ‘ ’
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, ‘ ’
search for ‘ ’ ‘ ’
---------- Footnotes ----------
(1) For backward compatibility, line numbers can also follow a single
colon.
File: org, Node: Custom Searches, Prev: Search Options, Up: Hyperlinks
4.9 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
‘ ’
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 ‘ ’
need to be added to the hook variables
‘ ’
‘ ’
variables for more information. Org actually uses this mechanism for
BibTeX database files, and you can use the corresponding code as an
2019-12-06 19:15:46 +01:00
implementation example. See the file ‘ ’
2019-11-26 16:46:24 +01:00
File: org, 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, 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 ‘ ’
for example:
*** TODO Write letter to Sam Fortune
The most important commands to work with TODO entries are:
‘ ’ ‘ ’
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::), prompt for a TODO keyword through the fast
selection interface; this is the default behavior when
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
The same state changing can also be done “remotely” from the agenda
2019-11-26 16:46:24 +01:00
buffer with the ‘ ’
‘ ’ ‘ ’
Select the following/preceding TODO state, similar to cycling.
Useful mostly if more than two TODO states are possible (see *note
TODO Extensions::). See also *note Conflicts::, for a discussion
2019-12-06 19:15:46 +01:00
of the interaction with shift-selection. See also the variable
‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
View TODO items in a _sparse tree_ (see *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 ‘ ’
are prompted for the keyword, and you can also give a list of
keywords like ‘ ’
these keywords. With a numeric prefix argument N, show the tree
for the Nth keyword in the variable ‘ ’
prefix arguments, find all TODO states, both un-done and done.
‘ ’ ‘ ’
Show the global TODO list. Collects the TODO items (with not-DONE
states) from all agenda files (see *note Agenda Views::) into a
single buffer. The new buffer is in Org Agenda mode, which
provides commands to examine and manipulate the TODO entries from
the new buffer (see *note Agenda Commands::). See *note Global
TODO list::, for more information.
‘ ’ ‘ ’
Insert a new TODO entry below the current one.
Changing a TODO state can also trigger tag changes. See the
docstring of the option ‘ ’
File: org, 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 ‘ ’
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 (see *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, still finding your way.
* Fast access to TODO states:: Single letter selection of 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, Node: Workflow states, Next: TODO types, Up: TODO Extensions
5.2.1 TODO keywords as workflow states
--------------------------------------
2019-12-06 19:15:46 +01:00
You can use TODO keywords to indicate different, possibly _sequential_
states in the process of working on an item, for example(1):
2019-11-26 16:46:24 +01:00
(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
do not provide the separator bar, the last state is used as the DONE
state.
With this setup, the command ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
You may also use a numeric prefix argument to quickly select a specific
state. For example ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’ ‘ ’
backward through the states. If you define many keywords, you can use
in-buffer completion (see *note Completion::) or a special one-key
selection scheme (see *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.
2019-11-26 16:46:24 +01:00
---------- Footnotes ----------
(1) Changing the variable ‘ ’
after restarting Org mode in a buffer.
File: org, 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
2019-12-06 19:15:46 +01:00
persons, by using their names as TODO keywords. This type of
functionality is actually much better served by using tags (see *note
Tags::), so the TODO implementation is kept just for backward
compatibility.
Using TODO types, it would be set up like this:
2019-11-26 16:46:24 +01:00
(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2019-12-06 19:15:46 +01:00
In this case, different keywords do not indicate states, 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 ‘ ’
times in succession, it still cycles 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 ‘ ’
name directly to ‘ ’
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 ‘ ’
example, to see all things Lucy has to do, you would use ‘ ’
To collect Lucy’
would use the numeric prefix argument as well when creating the global
TODO list: ‘ ’
2019-11-26 16:46:24 +01:00
---------- Footnotes ----------
(1) This is also true for the ‘ ’
File: org, 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 keep track
of which subsequence should be used for a given entry. In this setup,
‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’
correct sequence. In addition to typing a keyword or using completion
(see *note Completion::), you may also apply the following commands:
‘ ’
‘ ’
‘ ’
These keys jump from one TODO sub-sequence to the next. In the
above example, ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
row to ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
shift-selection (see *note Conflicts::).
2019-11-26 16:46:24 +01:00
‘ ’
‘ ’
‘ ’ ‘ ’
sub-sequences, so for example ‘ ’ ‘ ’
to ‘ ’
2019-12-06 19:15:46 +01:00
interaction with shift-selection, see *note Conflicts::.
2019-11-26 16:46:24 +01:00
File: org, 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 ‘ ’
is switched to this state. ‘ ’
keyword from an entry(2).
---------- Footnotes ----------
(1) All characters are allowed except ‘ ’ ‘ ’ ‘ ’
special meaning here.
(2) Check also the variable ‘ ’
allows you to change the TODO state through the tags interface (see
*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, 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, starting in column zero anywhere in the
file:
#+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
You may also write ‘ ’
interpretation, but it means the same as ‘ ’
#+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 ‘ ’
buffer and then use ‘ ’
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’
mode(1).
---------- Footnotes ----------
(1) Org mode parses these lines only when Org mode is activated after
visiting a file. ‘ ’ ‘ ’
simply restarting Org mode for the current buffer.
File: org, 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: ‘ ’
keywords indicating that an item still has to be acted upon, and
‘ ’
using more than two different states, you might want to use special
faces for some of them. This can be done using the variable
‘ ’
(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 ‘ ’
_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 variable ‘ ’
interpreted as a foreground or a background color.
File: org, 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
2019-12-06 19:15:46 +01:00
TODO dependencies. Usually, a parent TODO task should not be marked as
done until all TODO subtasks, or children tasks, are marked as done.
2019-11-26 16:46:24 +01:00
Sometimes there is a logical sequence to (sub)tasks, so that one subtask
2019-12-06 19:15:46 +01:00
cannot be acted upon before all siblings above it have been marked as
done. If you customize the variable ‘ ’
Org blocks entries from changing state to DONE while they have TODO
children that are not DONE. Furthermore, if an entry has a property
‘ ’
siblings are marked as done. Here is an example:
2019-11-26 16:46:24 +01:00
* 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 ‘ ’
property (see *note Properties and Columns::):
* This entry is never blocked
:PROPERTIES:
:NOBLOCKING: t
:END:
‘ ’ ‘ ’
Toggle the ‘ ’
used for this behavior because this should be local to the current
entry, not inherited from entries above like a tag (see *note
Tags::). However, if you would like to _track_ the value of this
property with a tag for better visibility, customize the variable
‘ ’
‘ ’
Change TODO state, regardless of any state blocking.
If you set the variable ‘ ’
2019-12-06 19:15:46 +01:00
that cannot be marked as done because of unmarked children are shown in
a dimmed font or even made invisible in agenda views (see *note Agenda
2019-11-26 16:46:24 +01:00
Views::).
You can also block changes of TODO states by using checkboxes (see
*note Checkboxes::). If you set the variable
‘ ’
checkboxes is 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 ‘ ’
File: org, Node: Progress Logging, Next: Priorities, Prev: TODO Extensions, Up: TODO Items
5.3 Progress Logging
====================
2019-12-06 19:15:46 +01:00
To record a timestamp and a note when changing a TODO state, call the
command ‘ ’
‘ ’ ‘ ’
Prompt for a note and record a the time of the TODO state change.
The note is inserted as a list item below the headline, but can
also be placed into a drawer, see *note Tracking TODO state
changes::.
If you want to be more systematic, Org mode can automatically record
a timestamp and optionally 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::.
2019-11-26 16:46:24 +01:00
* Menu:
2019-12-06 19:15:46 +01:00
* Closing items:: When was this entry marked as done?
2019-11-26 16:46:24 +01:00
* Tracking TODO state changes:: When did the status change?
* Tracking your habits:: How consistent have you been?
File: org, Node: Closing items, Next: Tracking TODO state changes, Up: Progress Logging
5.3.1 Closing items
-------------------
2019-12-06 19:15:46 +01:00
The most basic automatic logging is to keep track of _when_ a certain
TODO item was marked as done. This can be achieved with(1)
2019-11-26 16:46:24 +01:00
(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 ‘ ’
the headline. If you turn the entry back into a TODO item through
further state cycling, that line is removed again. If you turn the
entry back to a non-TODO state (by pressing ‘ ’
example), that line is also removed, unless you set
‘ ’ ‘ ’
note along with the timestamp, use(2)
(setq org-log-done 'note)
2019-12-06 19:15:46 +01:00
You are then prompted for a note, and that note is stored below the
2019-11-26 16:46:24 +01:00
entry with a ‘ ’
---------- Footnotes ----------
(1) The corresponding in-buffer setting is: ‘ ’
(2) The corresponding in-buffer setting is: ‘ ’
File: org, Node: Tracking TODO state changes, Next: Tracking your habits, Prev: Closing items, Up: Progress Logging
5.3.2 Tracking TODO state changes
---------------------------------
2019-12-06 19:15:46 +01:00
You might want to automatically 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. These records are 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 (see *note Drawers::). Customize the variable
2019-11-26 16:46:24 +01:00
‘ ’
this is called ‘ ’
variable for a subtree by setting a ‘ ’
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 ‘ ’ ‘ ’
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@)")))
2019-12-06 19:15:46 +01:00
To record a timestamp without a note for TODO keywords configured with
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
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 ‘ ’
and that a note is recorded when switching to ‘ ’ ‘ ’
The setting for ‘ ’ ‘ ’
means that in addition to the note taken when entering the state, a
timestamp should be recorded when _leaving_ the ‘ ’
only if the _target_ state does not configure logging for entering it.
So it has no effect when switching from ‘ ’ ‘ ’ ‘ ’
is configured to record a timestamp only. But when switching from
‘ ’ ‘ ’ ‘ ’ ‘ ’
timestamp even though ‘ ’
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 ‘ ’
‘ ’ ‘ ’
turn on logging for this specific tree using ‘ ’
‘ ’ ‘ ’
like ‘ ’
* 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 variable ‘ ’
(2) Note that the ‘ ’ ‘ ’
in the agenda to show an entry—use ‘ ’
(3) It is possible that Org mode records two timestamps when you are
using both ‘ ’
prompts for two notes: if you have configured both, the state change
recording note takes precedence and cancel the closing note.
File: org, 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
TODO, called “habits.” To use habits, you have to enable the ‘ ’
module by customizing the variable ‘ ’
A habit has the following properties:
1. The habit is a TODO item, with a TODO keyword representing an open
state.
2. The property ‘ ’ ‘ ’
Properties and Columns::).
3. The TODO has a scheduled date, usually with a ‘ ’
interval. A ‘ ’
constraints, e.g., must be done on weekends, or a ‘ ’
unusual habit that can have a backlog, e.g., weekly reports.
4. The TODO may also have minimum and maximum ranges specified by
using the syntax ‘ ’
at least every three days, but at most every two days.
5. State logging for the DONE state is enabled (see *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 are largely meaningless.
To give you an idea of what the above rules look like in action,
here’
** 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 ‘ ’
If today is the 15th, then the habit first appears in the agenda (see
*note Agenda Views::) on Oct 17, after the minimum of 2 days has
elapsed, and will appear overdue on Oct 19, after four days have
elapsed.
What’
with a consistency graph, to show how consistent you’
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 was not 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.
‘ ’
The buffer column at which the consistency graph should be drawn.
This overwrites any text in that column, so it is a good idea to
keep your habits’
‘ ’
The amount of history, in days before today, to appear in
consistency graphs.
‘ ’
The number of days after today that appear in consistency graphs.
‘ ’
If non-‘ ’ ’
2019-12-06 19:15:46 +01:00
value is ‘ ’ ‘ ’
variable.
2019-11-26 16:46:24 +01:00
Lastly, pressing ‘ ’
temporarily be disabled and do not appear at all. Press ‘ ’
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, 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: ‘ ’ ‘ ’ ‘ ’
‘ ’
equivalent if it had priority ‘ ’
for sorting in the agenda (see *note Weekly/daily agenda::); outside the
agenda, they have no inherent meaning to Org mode. The cookies are
displayed with the face defined by the variable ‘ ’
which can be customized.
Priorities can be attached to any outline node; they do not need to
be TODO items.
‘ ’ ‘ ’
Set the priority of the current headline. The command prompts for
a priority character ‘ ’ ‘ ’ ‘ ’ ‘ ’
instead, the priority cookie, if one is set, is removed from the
headline. The priorities can also be changed “remotely” from the
agenda buffer with the ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
Increase/decrease the priority of the current headline(1). Note
that these keys are also used to modify timestamps (see *note
Creating Timestamps::). See also *note Conflicts::, for a
2019-12-06 19:15:46 +01:00
discussion of the interaction with shift-selection.
2019-11-26 16:46:24 +01:00
You can change the range of allowed priorities by setting the
variables ‘ ’ ‘ ’
‘ ’
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 ‘ ’
File: org, Node: Breaking Down Tasks, Next: Checkboxes, Prev: Priorities, Up: TODO Items
5.5 Breaking Down Tasks 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 an overview of the
2019-12-06 19:15:46 +01:00
fraction of subtasks that have already been marked as done, insert
either ‘ ’ ‘ ’
updated each time the TODO status of a child changes, or when pressing
‘ ’
2019-11-26 16:46:24 +01:00
* 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
‘ ’ ‘ ’ ‘ ’
If you would like to have the statistics cookie count any TODO
entries in the subtree (not just direct children), configure the
variable ‘ ’
subtree, include the word ‘ ’
‘ ’
* 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 (see *note Checkboxes::).
---------- Footnotes ----------
(1) To keep subtasks out of the global TODO list, see the option
‘ ’
File: org, Node: Checkboxes, Prev: Breaking Down Tasks, Up: TODO Items
5.6 Checkboxes
==============
Every item in a plain list(1) (see *note Plain Lists::) can be made into
a checkbox by starting it with the string ‘ ’
similar to TODO items (see *note TODO Items::), but is more lightweight.
Checkboxes are not included into the global TODO list, so they are often
great to split a task into a number of simple steps. Or you can use
2019-12-06 19:15:46 +01:00
them in a shopping list.
2019-11-26 16:46:24 +01:00
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 makes the
parent checkbox reflect if none, some, or all of the children are
checked.
The ‘ ’ ‘ ’
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 ‘ ’ ‘ ’
With ‘ ’ ‘ ’
With ‘ ’
checked (in the above example, this would be ‘ ’ ‘ ’
respectively). In a headline, a cookie can count either checkboxes
below the heading or TODO states of children, and it displays whatever
was changed last. Set the property ‘ ’ ‘ ’
or ‘ ’
If the current outline node has an ‘ ’
must be checked off in sequence, and an error is thrown if you try to
check off a box while there are unchecked boxes above it.
The following commands work with checkboxes:
‘ ’ ‘ ’
Toggle checkbox status or—with prefix argument—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 ‘ ’
‘ ’ ‘ ’
Toggle checkbox status or—with prefix argument—checkbox presence at
point. With double prefix argument, set it to ‘ ’
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 argument, add or remove the checkbox for
all items in the region.
• If point is in a headline, toggle checkboxes in the region
between this headline and the next—so _not_ the entire
subtree.
• If there is no active region, just toggle the checkbox at
point.
‘ ’ ‘ ’
Insert a new item with a checkbox. This works only if point is
already in a plain list item (see *note Plain Lists::).
‘ ’ ‘ ’
Toggle the ‘ ’
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
‘ ’
‘ ’ ‘ ’
Update the statistics cookie in the current outline entry. When
called with a ‘ ’
statistic cookies are updated automatically if you toggle
checkboxes with ‘ ’ ‘ ’
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 ‘ ’
(2) Set the variable ‘ ’
want such cookies to count all checkboxes below the cookie, not just
those belonging to direct children.
(3) ‘ ’
checkboxes to the rest of the list.
File: org, 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 ‘ ’
‘ ’ ‘ ’
by default are in bold face with the same color as the headline. You
may specify special faces for specific tags using the variable
‘ ’
*note Faces for TODO keywords::).
* Menu:
* Tag Inheritance:: Tags use the tree structure of an 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, 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 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 has the tags ‘ ’ ‘ ’ ‘ ’ ‘ ’
even though the final heading is not explicitly marked with 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, or to turn it off
entirely, use the variables ‘ ’
‘ ’
When a headline matches during a tags search while tag inheritance is
turned on, all the sublevels in the same tree—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 the
variable ‘ ’
Tag inheritance is relevant when the agenda search tries to match a
tag, either in the ‘ ’ ‘ ’
types, ‘ ’
have your tags correctly set in the agenda, so that tag filtering works
fine, with inherited tags. Set ‘ ’
control this: the default value includes all agenda types, but setting
this to ‘ ’
---------- Footnotes ----------
(1) As with all these in-buffer settings, pressing ‘ ’
activates any changes in the line.
(2) This is only true if the search does not involve more complex
tests including properties (see *note Property Searches::).
File: org, 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, ‘ ’
special command for inserting tags:
‘ ’ ‘ ’
Enter new tags for the current headline. Org mode either offers
completion or a special single-key interface for setting tags, see
below. After pressing ‘ ’
to ‘ ’ ‘ ’
the current buffer are aligned to that column, just to make things
look nice. Tags are automatically realigned after promotion,
demotion, and TODO state changes (see *note TODO Basics::).
‘ ’ ‘ ’
When point is in a headline, this does the same as ‘ ’
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(1). You may also globally specify a hard list of tags
with the variable ‘ ’
for a given file using the ‘ ’
#+TAGS: @work @home @tennisclub
#+TAGS: laptop car pc sailboat
If you have globally defined your preferred set of tags using the
variable ‘ ’
specific file, add an empty ‘ ’
#+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 ‘ ’
keyword, then you may specify a list of tags with the variable
‘ ’
by adding a ‘ ’
#+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 letters to most of your commonly
used tags. You can do this globally by configuring the variable
‘ ’
need to tag many items in different files with ‘ ’
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: @work(w) @home(h) @tennisclub(t) laptop(l) pc(p)
The tags interface shows the available tags in a splash window. If
you want to start a new line after a specific tag, insert ‘ ’
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 ‘ ’ ‘ ’ ‘ ’
should be selected. Multiple such groups are allowed.
Do not forget to press ‘ ’
activate any changes.
To set these mutually exclusive groups in the variable
‘ ’ ‘ ’
‘ ’ ‘ ’
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 ‘ ’
automatically presents you with a special interface, listing inherited
tags, the tags of the current headline, and a list of all valid tags
with corresponding keys(2).
Pressing keys assigned to tags adds or removes them from the list of
tags in the current line. Selecting a tag in a group of mutually
exclusive tags turns off any other tag from that group.
In this interface, you can also use the following special keys:
‘ ’
Enter a tag in the minibuffer, even if the tag is not in the
predefined list. You can complete on all tags present in the
buffer. You can also add several tags: just separate them with a
comma.
‘ ’
Clear all tags for this line.
‘ ’
Accept the modified set.
‘ ’
Abort without installing changes.
‘ ’
If ‘ ’ ‘ ’
‘ ’
Turn off groups of mutually exclusive tags. Use this to (as an
exception) assign several tags from such a group.
‘ ’
Toggle auto-exit after the next change (see below). If you are
using expert mode, the first ‘ ’
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 ‘ ’
‘ ’ ‘ ’ ‘
p <RET>’ ‘ ’ ‘ ’ ‘
w <RET>’ ‘ ’
non-predefined tag ‘ ’ ‘
<RET>’
If you find that most of the time you need only a single key press to
modify your list of tags, set the variable
‘ ’
‘ ’
you then occasionally need more keys, press ‘ ’
for the current tag selection process (in effect: start selection with
‘ ’ ‘ ’
value ‘ ’
selection, it comes up only when you press an extra ‘ ’
---------- Footnotes ----------
(1) To extend this default list to all tags used in all agenda files
(see *note Agenda Views::), customize the variable
‘ ’
(2) Keys are automatically assigned to tags that have no configured
keys.
File: org, 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 return matches for all members in
the group and its subgroups. In an agenda view, filtering by a group
tag displays 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, ‘ ’
other tags: ‘ ’ ‘ ’ ‘ ’ ‘ ’
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:
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
You can use the ‘ ’ ‘ ’ ‘ ’
keyword directly when setting ‘ ’
(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 ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
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 curly brackets. Here is an expanded example:
#+TAGS: [ Vision : {V@.+} ]
#+TAGS: [ Goal : {G@.+} ]
#+TAGS: [ AOF : {AOF@.+} ]
#+TAGS: [ Project : {P@.+} ]
Searching for the tag ‘ ’
regular expression matches for ‘ ’
‘ ’ ‘ ’ ‘ ’
project tagged with a common project-identifier, e.g., ‘ ’
If you want to ignore group tags temporarily, toggle group tags
support with ‘ ’ ‘ ’
want to disable tag groups completely, set ‘ ’ ‘ ’
File: org, 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.
‘ ’ ‘ ’ ‘ ’
Create a sparse tree with all headlines matching a tags search.
With a ‘ ’
line.
‘ ’ ‘ ’
Create a global list of tag matches from all agenda files. See
*note Matching tags and properties::.
‘ ’ ‘ ’
Create a global list of tag matches from all agenda files, but
check only TODO items and force checking subitems (see the option
‘ ’
These commands all prompt for a match string which allows basic
Boolean logic like ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
entries which are tagged, like ‘ ’ ‘ ’
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, 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 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 ‘ ’ ‘ ’
property, say ‘ ’
values, such as ‘ ’ ‘ ’
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 (see
*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 a tree.
* Column View:: Tabular viewing and editing.
File: org, Node: Property Syntax, Next: Special Properties, Up: Properties and Columns
7.1 Property Syntax
===================
Properties are key–
entry or with a tree they need to be inserted into a special drawer (see
*note Drawers::) with the name ‘ ’
right below a headline, and its planning line (see *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: Glenn Gould
:Publisher: Deutsche Grammophon
:NDisks: 1
:END:
Depending on the value of ‘ ’
set this way is associated either with a single entry, or with the
sub-tree defined by the entry, see *note Property Inheritance::.
You may define the allowed values for a particular property ‘ ’
setting a property ‘ ’
if you set it in a level 1 entry, it applies 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 pre-define 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
If you want to add to the value of an existing property, append a ‘ ’
to the property name. The following results in the property ‘ ’
having the value ‘ ’
#+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 ‘ ’ ‘
Baroque’ ‘ ’
* CD collection
** Classic
:PROPERTIES:
:Genres: Classic
:END:
*** Goldberg Variations
:PROPERTIES:
:Title: Goldberg Variations
:Composer: J.S. Bach
:Artist: Glenn 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 ‘ ’
can be inherited by all entries in all Org files.
The following commands help to work with properties:
‘ ’ ‘ ’
After an initial colon in a line, complete property keys. All keys
used in the current file are offered as possible completions.
‘ ’ ‘ ’
Set a property. This prompts for a property name and a value. If
necessary, the property drawer is created as well.
‘ ’
Insert a property drawer into the current entry. The drawer is
inserted early in the entry, but after the lines with planning
information like deadlines.
‘ ’ ‘ ’
With point in a property drawer, this executes property commands.
‘ ’ ‘ ’
Set a property in the current entry. Both the property and the
value can be inserted using completion.
‘ ’ ‘ ’
‘ ’ ‘ ’
Switch property at point to the next/previous allowed value.
‘ ’ ‘ ’
Remove a property from the current entry.
‘ ’ ‘ ’
Globally remove a property, from all entries in the current file.
‘ ’ ‘ ’
Compute the property at point, using the operator and scope from
the nearest column format definition.
File: org, 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 (see *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:
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’ ‘ ’
must be run first to compute the values in the current buffer.
‘ ’
‘ ’
values in the current buffer.
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
File: org, 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 (see *note
Tag Searches::).
‘ ’ ‘ ’ ‘ ’
Create a sparse tree with all matching entries. With a ‘ ’
prefix argument, ignore headlines that are not a TODO line.
‘ ’ ‘ ’
Create a global list of tag/property matches from all agenda files.
‘ ’ ‘ ’
Create a global list of tag matches from all agenda files, but
check only TODO items and force checking of subitems (see the
option ‘ ’
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:
‘ ’
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, Node: Property Inheritance, Next: Column View, Prev: Property Searches, Up: Properties and Columns
7.4 Property Inheritance
========================
The outline structure of Org 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 ‘ ’
set to ‘ ’
of properties that should be inherited, or to a regular expression that
matches inherited properties. If a property has the value ‘ ’
is interpreted as an explicit un-define of the property, so that
inheritance search stops at this value and returns ‘ ’
Org mode has a few properties for which inheritance is hard-coded, at
least for the special applications for which they are used:
‘ ’
The ‘ ’
Column View::). It is inherited in the sense that the level where
a ‘ ’
column view table, independently of the location in the subtree
from where columns view is turned on.
‘ ’
For agenda view, a category set through a ‘ ’
applies to the entire subtree.
‘ ’
For archiving, the ‘ ’
location for the entire subtree (see *note Moving subtrees::).
‘ ’
The ‘ ’
a subtree (see *note Tracking TODO state changes::).
File: org, Node: Column View, 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—‘ ’ ‘ ’ ‘ ’
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 (see *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, 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, 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
‘ ’
** Top node for columns view
:PROPERTIES:
:COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
:END:
If a ‘ ’
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, 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 is determined automatically.
PROPERTY
The property that should be edited in this column. Special
properties representing meta data are allowed here as well (see
*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:
‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
You can also define custom summary types by setting
‘ ’
The ‘ ’
combining estimates, expressed as low-high ranges. For example, instead
of estimating a particular task will take 5 days, you might estimate it
as 5– ’
required, or 1–
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, ‘ ’
statistical mean and variance of the subtasks, 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,
‘ ’ –
Here is an example for a complete columns definition, along with
allowed values(3).
:COLUMNS: %25ITEM %9Approved(Approved?){X} %Owner %11Status \
%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, ‘ ’
itself, i.e., of the headline. You probably always should start the
column definition with the ‘ ’
create columns ‘ ’
‘ ’
‘ ’ ‘ ’
is exactly as wide as it needs to be in order to fully display all
values. The ‘ ’ ‘ ’
with a question mark). Summaries are created for the ‘ ’
column by adding time duration expressions like HH:MM, and for the
‘ ’ ‘ ’
been checked. The ‘ ’ ‘ ’
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 applies to the same property, the
parent values are computed according to the first of them.
(2) An age can be defined as a duration, using units defined in
‘ ’ ‘ ’
such, the summary is also expressed as a duration.
(3) Please note that the ‘ ’
line; it is wrapped here only because of formatting constraints.
File: org, Node: Using column view, Next: Capturing column view, Prev: Defining columns, Up: Column View
7.5.2 Using column view
-----------------------
Turning column view on or off
.............................
‘ ’ ‘ ’
Turn on column view. If point is before the first headline in the
file, column view is turned on for the entire file, using the
‘ ’
this command searches the hierarchy, up from point, for a ‘ ’
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 ‘ ’
format is taken from the ‘ ’
‘ ’
the current entry and its subtree.
‘ ’ ‘ ’ ‘ ’
Recreate the column view, to include recent changes made in the
buffer.
‘ ’ ‘ ’
Exit column view.
Editing values
..............
‘ ’ ‘ ’ ‘ ’ ‘ ’
Move through the column view from field to field.
‘ ’
Directly select the Nth allowed value, ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
Switch to the next/previous allowed value of the field. For this,
you have to have specified allowed values for a property.
‘ ’ ‘ ’
Edit the property at point. For the special properties, this
invokes the same interface that you normally use to change that
property. For example, the tag completion or fast selection
interface pops up when editing a ‘ ’
‘ ’ ‘ ’
When there is a checkbox at point, toggle it.
‘ ’ ‘ ’
View the full value of this property. This is useful if the width
of the column is smaller than that of the value.
‘ ’ ‘ ’
Edit the list of allowed values for this property. If the list is
found in the hierarchy, the modified values 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 column view on-the-fly
................................
‘ ’ ‘ ’
‘ ’ ‘ ’
Make the column narrower/wider by one character.
‘ ’ ‘ ’
Insert a new column, to the left of the current column.
‘ ’ ‘ ’
Delete the current column.
File: org, 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 ‘ ’
this block looks like this:
* The column view
#+BEGIN: columnview :hlines 1 :id "label"
#+END:
This dynamic block has the following parameters:
‘ ’
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 four values:
‘ ’
Use the tree in which the capture block is located.
‘ ’
Make a global view, including all headings in the file.
‘ ’
Run column view at the top of the FILENAME file.
‘ ’
Call column view in the tree that has an ‘ ’
the value LABEL. You can use ‘ ’
globally unique ID for the current entry and copy it to the
kill-ring.
‘ ’
When ‘ ’
insert an hline before each headline with level ‘ ’
‘ ’
When non-‘ ’
‘ ’
When set to a number, do not capture entries below this level.
‘ ’
When non-‘ ’
column view is ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
List of tags to exclude from column view table: entries with these
tags will be excluded from the column view.
2019-11-26 16:46:24 +01:00
‘ ’
When non-‘ ’ ‘ ’
‘ ’
Specify a column attribute (see *note Column attributes::) for the
dynamic block.
The following commands insert or update the dynamic block:
‘ ’ ‘ ’
Insert a dynamic block capturing a column view. Prompt for the
scope or ID of the view.
‘ ’ ‘ ’ ‘ ’
Update dynamic block at point. point needs to be in the ‘ ’
line of the dynamic block.
‘ ’ ‘ ’
Update all dynamic blocks (see *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 survive an update of
the block. If there is a ‘ ’
recalculated automatically after an update.
An alternative way to capture and process property values into a
table is provided by Eric Schulte’ ‘ ’
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>.
2019-12-06 19:15:46 +01:00
File: org, Node: Dates and Times, Next: Refiling and Archiving, Prev: Properties and Columns, Up: Top
2019-11-26 16:46:24 +01:00
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 as indicating 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 to 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, Node: Timestamps, Next: Creating Timestamps, Up: Dates and Times
2019-12-06 19:15:46 +01:00
8.1 Timestamps
==============
2019-11-26 16:46:24 +01:00
A timestamp is a specification of a date (possibly with a time or a
range of times) in a special format, either ‘ ’
‘ ’ ‘ ’
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 (see *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 is 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 shows up in the agenda every Wednesday:
* Pick up Sam at school
<2007-05-16 Wed 12:30 +1w>
2019-12-06 19:15:46 +01:00
Diary-style expression entries
2019-11-26 16:46:24 +01:00
For more complex date specifications, Org mode supports using the
2019-12-06 19:15:46 +01:00
special expression diary entries implemented in the Emacs Calendar
2019-11-26 16:46:24 +01:00
package(2). 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 ‘ ’
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) The Org date format is inspired by the standard ISO 8601
date/time format. To use an alternative format, see *note Custom time
format::. The day name is optional when you type the date yourself.
However, any date inserted or modified by Org adds that day name, for
reading convenience.
2019-12-06 19:15:46 +01:00
(2) When working with the standard diary expression functions, you
need to be very careful with the order of the arguments. That order
depends evilly on the variable ‘ ’
specify a date December 12, 2005, the call might look like ‘
12 1 2005)’ ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
depending on the settings. This has been the source of much confusion.
Org mode users can resort to special versions of these functions like
‘ ’ ‘ ’
‘ ’
day) wherever applicable, independent of the value of
‘ ’
File: org, 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.
‘ ’ ‘ ’
Prompt for a date and insert a corresponding timestamp. When point
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.
When called with a prefix argument, use the alternative format
which contains date and time. The default time can be rounded to
multiples of 5 minutes. See the option
‘ ’
With two prefix arguments, insert an active timestamp with the
current time without prompting.
‘ ’ ‘ ’
Like ‘ ’
an agenda entry.
‘ ’
Normalize timestamp, insert or fix day name if missing or wrong.
‘ ’ ‘ ’
Insert a timestamp corresponding to point date in the calendar.
‘ ’ ‘ ’
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, go to the corresponding date
instead.
‘ ’ ‘ ’
Access the agenda for the date given by the timestamp or -range at
point (see *note Weekly/daily agenda::).
‘ ’ ‘ ’
‘ ’ ‘ ’
Change date at point by one day. These key bindings conflict with
shift-selection and related modes (see *note Conflicts::).
‘ ’ ‘ ’
‘ ’ ‘ ’
On the beginning or enclosing bracket of a timestamp, change its
type. Within a timestamp, change the item under point. Point can
be on a year, month, day, hour or minute. When the timestamp
contains a time range like ‘ ’
also shifts the second, shifting the time block with constant
length. To change the length, modify the second time. Note that
if point is in a headline and not at a timestamp, these same keys
modify the priority of an item (see *note Priorities::). The key
bindings also conflict with shift-selection and related modes (see
*note Conflicts::).
‘ ’ ‘ ’
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 enter dates and times.
* Custom time format:: Making dates look different.
File: org, 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 in fact accepts date/time information in a variety of
formats. Generally, the information should start at the beginning of
the string. Org mode finds whatever information is in there and derives
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 want to enter a date in the
future: if you omit the month/year and the given day/month is _before_
today, it assumes that you mean a future date(1). If the date has been
automatically shifted into the future, the time prompt shows this with
‘ ’
For example, let’
various inputs are interpreted, the items filled in by Org mode are in
*bold*.
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
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—‘ ’ ‘ ’
‘ ’ ‘ ’
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 is the
Nth such day, e.g.:
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
The function understands English month and weekday abbreviations. If
you want to use un-abbreviated names and/or other languages, configure
the variables ‘ ’ ‘ ’
Not all dates can be represented in a given Emacs implementation. By
default Org mode forces dates into the compatibility range 1970–
which works on all Emacs implementations. If you want to use dates
outside of this range, read the docstring of the variable
‘ ’
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 ‘ ’
separator in the latter case, e.g.:
‘ ’
‘ ’
‘ ’
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 ‘ ’
with the information entered at the prompt. You can control the
calendar fully from the minibuffer:
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
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 is
displayed live in the minibuffer(3).
---------- Footnotes ----------
(1) See the variable ‘ ’
variable to the symbol ‘ ’
date to tomorrow.
(2) If you do not need/want the calendar, configure the variable
‘ ’
(3) If you find this distracting, turn off the display with
‘ ’
File: org, 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 variables ‘ ’
‘ ’
‘ ’ ‘ ’
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 point onto a timestamp anymore, only before or
after.
• The ‘ ’ ‘ ’
each component of a timestamp. If point is at the beginning of the
stamp, ‘ ’ ‘ ’
like ‘ ’ ‘ ’
time by one minute.
• If the timestamp contains a range of clock times or a repeater,
these are not overlaid, but remain in the buffer as they were.
• When you delete a timestamp character-by-character, it only
disappears 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, 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.
‘ ’
2019-12-06 19:15:46 +01:00
Meaning: the task—most likely a TODO item, though not
necessarily—is supposed to be finished on that date.
2019-11-26 16:46:24 +01:00
On the deadline date, the task is listed in the agenda. In
addition, the agenda for _today_ carries a warning about the
approaching or missed deadline, starting
‘ ’
2019-12-06 19:15:46 +01:00
until the entry is marked as done. An example:
2019-11-26 16:46:24 +01:00
*** 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
deadlines using the following syntax. Here is an example with a
warning period of 5 days ‘ ’
warning is deactivated if the task gets scheduled and you set
‘ ’ ‘ ’
‘ ’
Meaning: you are planning to start working on that task on the
given date.
The headline is listed under the given date(1). In addition, a
reminder that the scheduled date has passed is present in the
2019-12-06 19:15:46 +01:00
compilation for _today_, until the entry is marked as done, i.e.,
the task is automatically forwarded until completed.
2019-11-26 16:46:24 +01:00
*** 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
‘ ’
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 ‘ ’ ‘ ’
‘ ’
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 issues early and late warnings based on the
assumption that the timestamp represents the _nearest instance_ of the
2019-12-06 19:15:46 +01:00
repeater. However, the use of diary expression entries like
2019-11-26 16:46:24 +01:00
<%%(diary-float t 42)>
in scheduling and deadline timestamps is limited. Org mode does not
2019-12-06 19:15:46 +01:00
know enough about the internals of each function to issue early and late
warnings. However, it shows the item on each day where the expression
entry matches.
2019-11-26 16:46:24 +01:00
* Menu:
* Inserting deadline/schedule:: Planning items.
* Repeated tasks:: Items that show up again and again.
---------- Footnotes ----------
2019-12-06 19:15:46 +01:00
(1) It will still be listed on that date after it has been marked as
done. If you do not like this, set the variable
2019-11-26 16:46:24 +01:00
‘ ’
File: org, 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:(1)
‘ ’ ‘ ’
Insert ‘ ’
happens in the line directly following the headline. Remove any
‘ ’
remove any existing deadline from the entry. Depending on the
variable ‘ ’
existing deadline(2).
‘ ’ ‘ ’
Insert ‘ ’
happens in the line directly following the headline. Remove any
‘ ’
remove the scheduling date from the entry. Depending on the
variable ‘ ’
existing scheduling time(3).
‘ ’ ‘ ’
Create a sparse tree with all deadlines that are either past-due,
or which will become due within ‘ ’
‘ ’
prefix, check that many days. For example, ‘ ’
deadlines due tomorrow.
‘ ’ ‘ ’
Sparse tree for deadlines and scheduled items before a given date.
‘ ’ ‘ ’
Sparse tree for deadlines and scheduled items after a given date.
Note that ‘ ’ ‘ ’
by indicating a relative time e.g., ‘ ’
after today, and ‘ ’
current timestamp.
---------- Footnotes ----------
(1) The ‘ ’ ‘ ’
right below the headline. Do not put any text between this line and the
headline.
(2) Note the corresponding ‘ ’ ‘ ’
‘ ’ ‘ ’
(3) Note the corresponding ‘ ’ ‘ ’
‘ ’ ‘ ’
File: org, 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 ‘ ’
‘ ’
** TODO Pay the rent
DEADLINE: <2005-10-01 Sat +1m>
the ‘ ’
has a deadline on ‘ ’
starting from that time. You can use yearly, monthly, weekly, daily and
hourly repeat cookies by using the ‘ ’ ‘ ’ ‘ ’ ‘ ’ ‘ ’
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
2019-12-06 19:15:46 +01:00
done once you have done so. When you mark a ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
with the TODO keyword ‘ ’
agenda. The problem with this is, however, is that then also the _next_
instance of the repeated entry will not be active. Org mode deals with
2019-12-06 19:15:46 +01:00
this in the following way: when you try to mark such an entry as done,
2019-11-26 16:46:24 +01:00
using ‘ ’
the repeater interval, and immediately sets the entry state back to
2019-12-06 19:15:46 +01:00
TODO(2). In the example above, setting the state to ‘ ’
actually switch the date like this:
2019-11-26 16:46:24 +01:00
** TODO Pay the rent
DEADLINE: <2005-11-01 Tue +1m>
To mark a task with a repeater as DONE, use ‘ ’
‘ ’ ‘ ’
A timestamp(3) is 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 is no longer
visible in the agenda when checking past dates, but all future instances
will be visible.
With the ‘ ’
So if you have not paid the rent for three months, marking this entry
DONE still keeps 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
‘ ’ ‘ ’
** TODO Call Father
DEADLINE: <2008-02-10 Sun ++1w>
Marking this DONE shifts 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 shifts 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 ‘ ’
‘ ’
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’
Editing::.
---------- Footnotes ----------
(1) Org does not repeat inactive timestamps, however. See *note
Timestamps::.
(2) In fact, the target state is taken from, in this sequence, the
‘ ’ ‘ ’
it is a string, the previous TODO state if ‘ ’
‘ ’
(3) You can change this using the option ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
File: org, 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, to 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) is retrieved (see *note Resolving idle time (1)::) and you are
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’
---------- Footnotes ----------
(1) Clocking only works if all headings are indented with less than
30 stars. This is a hard-coded limitation of ‘ ’ ‘ ’
(2) To resume the clock under the assumption that you have worked on
this task while outside Emacs, use ‘ ’
File: org, Node: Clocking commands, Next: The clock table, Up: Clocking Work Time
8.4.1 Clocking commands
-----------------------
‘ ’ ‘ ’
Start the clock on the current item (clock-in). This inserts the
2019-12-06 19:15:46 +01:00
‘ ’
first clocking of this item, the multiple ‘ ’
into a ‘ ’
‘ ’
this variable for a subtree by setting a ‘ ’
‘ ’ ‘ ’
argument, select the task from a list of recently clocked tasks.
With two ‘ ’
it as the default task; the default task is always be available
with letter ‘ ’ ‘
C-u C-u’
when the last clock stopped.
2019-11-26 16:46:24 +01:00
While the clock is running, Org shows the current clocking time in
the mode line, along with the title of the task. The clock time
shown is all time ever clocked for this task and its children. If
the task has an effort estimate (see *note Effort Estimates::), the
mode line displays the current clocking time against it(1). If the
task is a repeating one (see *note Repeated tasks::), show only the
time since the last reset of the task(2). You can exercise more
control over show time with the ‘ ’
It may have the values ‘ ’
instance, ‘ ’
also the variable ‘ ’ ‘ ’
time, or ‘ ’ ‘ ’
onto the mode line entry pops up a menu with clocking options.
‘ ’ ‘ ’
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 in inserts it after the time range as
‘ ’ ‘ ’
possibility to record an additional note together with the
clock-out timestamp(4).
‘ ’ ‘ ’
Re-clock the last clocked task. With one ‘ ’
select the task from the clock history. With two ‘ ’
force continuous clocking by starting the clock when the last clock
stopped.
‘ ’ ‘ ’
Update the effort estimate for the current clock task.
‘ ’ ‘ ’ ‘ ’
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 ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
On CLOCK log lines, increase/decrease both timestamps so that the
clock duration keeps the same value.
‘ ’ ‘ ’
‘ ’ ‘ ’
On ‘ ’
the one of the previous, or the next, clock timestamp by the same
duration. For example, if you hit ‘ ’
clocked-out timestamp by five minutes, then the clocked-in
timestamp of the next clock is increased by five minutes.
‘ ’ ‘ ’
Changing the TODO state of an item to DONE automatically stops the
clock if it is running in this same item.
‘ ’ ‘ ’
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
‘ ’ ‘ ’
Jump to the headline of the currently clocked in task. With a
‘ ’
recently clocked tasks.
‘ ’ ‘ ’
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
‘ ’ ‘ ’
The ‘ ’
agenda::) to show which tasks have been worked on or closed during a
day.
*Important:* note that both ‘ ’ ‘ ’
can have a global keybinding and do not modify the window disposition.
---------- Footnotes ----------
(1) To add an effort estimate “on the fly”, hook a function doing
this to ‘ ’
(2) The last reset of the task is recorded by the ‘ ’
property.
(3) See also the variable ‘ ’
(4) The corresponding in-buffer setting is: ‘
lognoteclock-out’
File: org, 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.
2019-12-06 19:15:46 +01:00
You can insert, or update, a clock table through Org dynamic blocks
insert command (see *note Dynamic Blocks::), by pressing ‘
o c k t a b l e <RET>’
first clock table in the current document and update it. The clock
table includes archived trees.
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’ ‘ ’
Update dynamic block at point. Point needs to be in the ‘ ’
line of the dynamic block.
‘ ’
Update all dynamic blocks (see *note Dynamic Blocks::). This is
useful if you have several clock table blocks in a buffer.
‘ ’
‘ ’ ‘ ’
Shift the current ‘ ’
needs to be in the ‘ ’
‘ ’ ‘ ’ ‘ ’
Here is an example of the frame for a clock table as it is inserted
into the buffer with the ‘ ’
#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
#+END: clocktable
The ‘ ’
scope, structure, and formatting of the report. Defaults for all these
options can be configured in the variable ‘ ’
First there are options that determine which clock entries are to be
selected:
‘ ’
Maximum level depth to which times are listed in the table. Clocks
at deeper levels are summed into the upper level.
‘ ’
The scope to consider. This can be any of the following:
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
The time block to consider. This block is specified either
absolutely, or relative to the current time and may be any of these
formats:
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’
When this option is not set, Org falls back to the value in
‘ ’
year.
Use ‘ ’ ‘ ’
‘ ’
A time string specifying when to start considering times. Relative
times like ‘ ’
properties:: for relative time syntax.
‘ ’
A time string specifying when to stop considering times. Relative
times like ‘ ’
properties:: for relative time syntax.
‘ ’
The starting day of the week. The default is 1 for Monday.
‘ ’
The starting day of the month. The default is 1 for the first.
‘ ’
2019-12-06 19:15:46 +01:00
Set to ‘ ’ ‘ ’ ‘ ’ ‘ ’
chunks. To use this, either ‘ ’ ‘ ’ ‘ ’
required.
2019-11-26 16:46:24 +01:00
‘ ’
When non-‘ ’
‘ ’
When non-‘ ’
contribute.
‘ ’
A tags match to select entries that should contribute. See *note
Matching tags and properties:: for the match syntax.
Then there are options that determine the formatting of the table.
There options are interpreted by the function
‘ ’
using the ‘ ’
‘ ’
When non-‘ ’
‘ ’
Language(2) to use for descriptive cells like “Task”.
‘ ’
Link the item headlines in the table to their origins.
‘ ’
An integer to limit the width of the headline column in the Org
table. If you write it like ‘ ’
shortened in export.
‘ ’
Indent each headline field according to its level.
2019-12-06 19:15:46 +01:00
‘ ’
Hide the file column when multiple files are used to produce the
table.
2019-11-26 16:46:24 +01:00
‘ ’
Number of columns to be used for times. If this is smaller than
‘ ’
‘ ’
Should a level number column be included?
‘ ’
A cons cell containing the column to sort and a sorting type.
E.g., ‘ ’
‘ ’
Abbreviation for ‘ ’
All are overwritten except if there is an explicit ‘ ’
‘ ’
A timestamp for the entry, when available. Look for ‘ ’
‘ ’ ‘ ’ ‘ ’
*note Special Properties::), in this order.
‘ ’
When this flag is non-‘ ’ ’
‘ ’
List of properties shown in the table. Each property gets its own
column.
‘ ’
When this flag is non-‘ ’ ‘ ’
inherited.
‘ ’
Content of a ‘ ’
special case, ‘ ’
not specify a formula here, any existing formula below the clock
table survives updates and is evaluated.
‘ ’
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
To use a specific time range you could write(3)
#+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) When using ‘ ’ ‘ ’
not the beginning of time.
(2) Language terms can be set through the variable
‘ ’
(3) 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, 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 ‘ ’
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:
‘ ’
To keep some or all of the minutes and stay clocked in, press ‘ ’
Org asks how many of the minutes to keep. Press ‘ ’
them all, effectively changing nothing, or enter a number to keep
that many minutes.
‘ ’
If you use the shift key and press ‘ ’
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.
‘ ’
To keep none of the minutes, use ‘ ’
from the clock, and then check back in from the moment you
returned.
‘ ’
To keep none of the minutes and just clock out at the start of the
away time, use the shift key and press ‘ ’
shift always leave you clocked out, no matter which option you
choose.
‘ ’
To cancel the clock altogether, use ‘ ’
canceling you subtract the away time, and the resulting clock
amount is less than a minute, the clock is still canceled rather
than cluttering 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’
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’
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 ‘ ’
‘ ’
Continuous clocking
...................
You may want to start clocking from the time when you clocked out the
previous task. To enable this systematically, set
‘ ’ ‘ ’
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 ‘ ’ ‘ ’
‘ ’
---------- Footnotes ----------
(1) On computers using macOS, idleness is based on actual user
idleness, not just Emacs’
program ‘ ’ ‘ ’
the Org Git distribution, or install the xprintidle package and set it
to the variable ‘ ’
Debian, to get the same general treatment of idleness. On other
systems, idle time refers to Emacs idle time only.
File: org, 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 for an entry with the following commands:
‘ ’ ‘ ’
Set the effort estimate for the current entry. With a prefix
argument, set it to the next allowed value—see below. This command
is also accessible from the agenda with the ‘ ’
‘ ’ ‘ ’
Modify the effort estimate of the item currently being clocked.
Clearly the best way to work with effort estimates is through column
view (see *note Column View::). You should start by setting up discrete
values for effort estimates, and a ‘ ’
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 ‘ ’ ‘ ’
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 ‘ ’ ‘ ’
The values you enter are immediately summed up in the hierarchy. In the
column next to it, any clocked time is displayed.
If you switch to column view in the daily/weekly agenda, the effort
column summarizes 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
‘ ’
on a day that take place over a specified time interval are then also
added to the load estimate of the day.
Effort estimates can be used in secondary agenda filtering that is
triggered with the ‘ ’
If you have these estimates defined consistently, two or three key
presses 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 (see *note Agenda Column View::).
File: org, Node: Timers, Prev: Effort Estimates, Up: Dates and Times
8.6 Taking Notes with a Relative 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.
‘ ’ ‘ ’
Start or reset the relative timer. By default, the timer is set to
0. When called with a ‘ ’
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
‘ ’
certain amount. This can be used to fix timer strings if the timer
was not started at exactly the right moment.
‘ ’ ‘ ’
Start a countdown timer. The user is prompted for a duration.
‘ ’
a numeric prefix argument overrides this default value. This
command is available as ‘ ’
Once started, relative and countdown timers are controlled with the
same commands.
‘ ’ ‘ ’
Insert a relative time into the buffer. The first time you use
this, the timer starts. Using a prefix argument restarts it.
‘ ’ ‘ ’
Insert a description list item with the current relative time.
With a prefix argument, first reset the timer to 0.
‘ ’ ‘ ’
Once the timer list is started, you can also use ‘ ’
insert new timer items.
‘ ’ ‘ ’
Pause the timer, or continue it if it is already paused.
‘ ’ ‘ ’
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.
2019-12-06 19:15:46 +01:00
File: org, Node: Refiling and Archiving, Next: Capture and Attachments, Prev: Dates and Times, Up: Top
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
9 Refiling and Archiving
************************
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Once information is in the system, it may need to be moved around. Org
provides Refile, Copy and Archive commands for this. Refile and Copy
helps with moving and copying outlines. Archiving helps to keep the
system compact and fast.
2019-11-26 16:46:24 +01:00
* Menu:
* Refile and Copy:: Moving/copying a tree from one place to another.
* Archiving:: What to do with finished products.
2019-12-06 19:15:46 +01:00
File: org, Node: Refile and Copy, Next: Archiving, Up: Refiling and Archiving
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
9.1 Refile and Copy
===================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
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:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
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
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
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 ‘ ’
for details. If you would like to select a location via a
file-path-like completion along the outline path, see the variables
‘ ’
‘ ’
to create new nodes as new parents for refiling on the fly, check
the variable ‘ ’
variable ‘ ’
recorded whenever an entry is refiled.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’
Use the refile interface to jump to a heading.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Jump to the location where ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’
Refile as the child of the item currently being clocked.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’
Refile and keep the entry in place. Also see ‘ ’
make this the default behavior, and beware that this may result in
duplicated ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’ ‘ ’
Clear the target cache. Caching of refile targets can be turned on
by setting ‘ ’
possible targets, you have to clear the cache with this command.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Copying works like refiling, except that the original note is not
deleted.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
---------- Footnotes ----------
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
(1) Note the corresponding ‘ ’ ‘ ’
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Archiving, Prev: Refile and Copy, Up: Refiling and Archiving
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
9.2 Archiving
=============
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
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.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Archive the current entry using the command specified in the
variable ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Menu:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Moving subtrees:: Moving a tree to an archive file.
* Internal archiving:: Switch off a tree but keep it in the file.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Moving subtrees, Next: Internal archiving, Up: Archiving
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
9.2.1 Moving a tree to an archive file
--------------------------------------
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
The most common archiving action is to move a project tree to another
file, the archive file.
‘ ’ ‘ ’ ‘ ’
Archive the subtree starting at point position to the location
given by ‘ ’
‘ ’
Check if any direct children of the current headline could be moved
to the archive. To do this, check each subtree for open TODO
entries. If none is found, the command offers to move it to the
archive location. If point is _not_ on a headline when this
command is invoked, check level 1 trees.
‘ ’
As above, but check subtree for timestamps instead of TODO entries.
The command offers 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 ‘ ’
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 ‘ ’
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 ‘ ’
location as the value (see *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
‘ ’
added.
File: org, Node: Internal archiving, Prev: Moving subtrees, Up: Archiving
9.2.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 ‘ ’
A headline that is marked with the ‘ ’
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 (see *note Visibility Cycling::). You can force
cycling archived subtrees with ‘ ’
‘ ’
like ‘ ’
• During sparse tree construction (see *note Sparse Trees::), matches
in archived subtrees are not exposed, unless you configure the
option ‘ ’
• During agenda view construction (see *note Agenda Views::), the
content of archived trees is ignored unless you configure the
option ‘ ’
are always included. In the agenda you can press ‘ ’
archives temporarily included.
• Archived trees are not exported (see *note Exporting::), only the
headline is. Configure the details using the variable
‘ ’
• Archived trees are excluded from column view unless the variable
‘ ’ ‘ ’
The following commands help manage the ‘ ’
‘ ’ ‘ ’
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.
‘ ’
Check if any direct children of the current headline should be
archived. To do this, check each subtree for open TODO entries.
If none is found, the command offers to set the ‘ ’
the child. If point is _not_ on a headline when this command is
invoked, check the level 1 trees.
‘ ’ ‘ ’
Cycle a tree even if it is tagged with ‘ ’
‘ ’ ‘ ’
Move the current entry to the _Archive Sibling_. This is a sibling
of the entry with the heading ‘ ’
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, Node: Capture and Attachments, Next: Agenda Views, Prev: Refiling and Archiving, Up: Top
10 Capture and Attachments
**************************
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.
Finally, it can parse RSS feeds for information. To learn how to let
external programs (for example a web browser) trigger Org to capture
material, see *note Protocols::.
* Menu:
* Capture:: Capturing new stuff.
* Attachments:: Attach files to outlines.
* RSS Feeds:: Getting input from RSS feeds.
File: org, Node: Capture, Next: Attachments, Up: Capture and Attachments
10.1 Capture
============
Capture lets you quickly store notes with little interruption of your
work flow. Org’
John Wiegley’
* 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, Node: Setting up capture, Next: Using capture, Up: Capture
10.1.1 Setting up capture
-------------------------
The following customization sets a default target file for notes.
(setq org-default-notes-file (concat org-directory "/notes.org"))
You may also define a global key for capturing new material (see
*note Activation::).
File: org, Node: Using capture, Next: Capture templates, Prev: Setting up capture, Up: Capture
10.1.2 Using capture
--------------------
‘ ’ ‘ ’
Display the capture templates menu. If you have templates defined
(see *note Capture templates::), it offers these templates for
selection or use a new Org outline node as the default template.
It inserts 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.
‘ ’ ‘ ’
Once you have finished entering information into the capture
buffer, ‘ ’
the capture process, so that you can resume your work without
further distraction. When called with a prefix argument, finalize
and then jump to the captured item.
‘ ’ ‘ ’
Finalize the capture process by refiling the note to a different
place (see *note Refile and Copy::). Please realize that this is a
normal refiling command that will be executed—so point position at
the moment you run this command is important. If you have inserted
a tree with a parent and children, first move point back to the
parent. Any prefix argument given to this command is passed on to
the ‘ ’
‘ ’ ‘ ’
Abort the capture process and return to the previous state.
You can also call ‘ ’
using the ‘ ’
inserted by the selected capture template defaults to the date at point
in the agenda, rather than to the current date.
To find the locations of the last stored capture, use ‘ ’
with prefix commands:
‘ ’
Visit the target location of a capture template. You get to select
the template in the usual way.
‘ ’
Visit the last stored capture item in its buffer.
You can also jump to the bookmark ‘ ’
automatically created unless you set ‘ ’ ‘ ’
To insert the capture at point in an Org buffer, call ‘ ’
2019-11-26 16:46:24 +01:00
with a ‘ ’
File: org, Node: Capture templates, Prev: Using capture, Up: Capture
2019-12-06 19:15:46 +01:00
10.1.3 Capture templates
------------------------
2019-11-26 16:46:24 +01:00
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.
‘ ’
Customize the variable ‘ ’
Before we give the formal description of template definitions, let’
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 ‘ ’ ‘ ’
file ‘ ’
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+datetree "~/org/journal.org")
"* %?\nEntered on %U\n %i\n %a")))
2019-12-06 19:15:46 +01:00
If you then press ‘ ’
2019-11-26 16:46:24 +01:00
template for you like this:
* TODO
[[file:LINK TO WHERE YOU INITIATED CAPTURE]]
During expansion of the template, ‘ ’
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 ‘ ’
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:
2019-12-29 11:23:16 +01:00
(define-key global-map (kbd "C-c x")
2019-11-26 16:46:24 +01:00
(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, Node: Template elements, Next: Template expansion, Up: Capture templates
2019-12-06 19:15:46 +01:00
10.1.3.1 Template elements
..........................
2019-11-26 16:46:24 +01:00
Now lets look at the elements of a template definition. Each entry in
‘ ’
keys
The keys that selects the template, as a string, characters only,
for example ‘ ’
or ‘ ’
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 ‘ ’
Customize buffer for this complex variable.
description
A short string describing the template, shown during selection.
type
The type of entry, a symbol. Valid values are:
‘ ’
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 file.
‘ ’
A plain list item, placed in the first plain list at the
target location. Again the target file should be an Org file.
‘ ’
A checkbox item. This only differs from the plain list item
by the default template.
‘ ’
A new line in the first table at the target location. Where
exactly the line will be inserted depends on the properties
‘ ’ ‘ ’
‘ ’
Text to be inserted as it is.
target
Specification of where the captured item should be placed. In Org
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
‘ ’
or as a function called with no argument. When an absolute path is
not specified for a target, it is taken as relative to
‘ ’
Valid values are:
‘ ’
Text will be placed at the beginning or end of that file.
‘ ’
Filing as child of this entry, or in the body of the entry.
‘ ’
Fast configuration if the target heading is unique in the
file.
‘ ’
For non-unique headings, the full path is safer.
‘ ’
Use a regular expression to position point.
‘ ’
This target(1) creates a heading in a date tree(2) for today’
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 ‘ ’ ‘ ’
properties below for additional options.
‘ ’
A function to find the right location in the file.
‘ ’
File to the entry that is currently being clocked.
‘ ’
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
2019-12-29 11:23:16 +01:00
depending on time and context of the capture call. You may also
get this template string from a file(3), or dynamically, from a
function using either syntax:
(file "/path/to/template-file")
(function FUNCTION-RETURNING-THE-TEMPLATE)
2019-11-26 16:46:24 +01:00
properties
The rest of the entry is a property list of additional options.
Recognized properties are:
‘ ’
Normally new captured information will be appended at the
target location (last child, last table line, last list item,
...). Setting this property changes that.
‘ ’
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.
‘ ’
Set this to the number of lines to insert before and after the
new item. Default 0, and the only other common value is 1.
‘ ’
Start the clock in this item.
‘ ’
Keep the clock running when filing the captured entry.
‘ ’
If starting the capture interrupted a clock, restart that
clock when finished with the capture. Note that ‘ ’
has precedence over ‘ ’
non-‘ ’
will not be resumed.
‘ ’
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 ‘ ’
with a ‘ ’
‘ ’
When ‘ ’
place the headings for each day under a heading with the
current ISO week.
‘ ’
Do not narrow the target buffer, simply show the full buffer.
Default is to narrow it so that you only see the new material.
‘ ’
Specification of the location in the table where the new line
should be inserted. It should be a string like ‘ ’
that the new line should become the third line before the
second horizontal separator line.
‘ ’
If the target file was not yet visited when capture was
invoked, kill the buffer again after capture is completed.
‘ ’
Do not save the target file after finishing the capture.
---------- Footnotes ----------
(1) Org used to offer four different targets for date/week tree
capture. Now, Org automatically translates these to use
‘ ’ ‘ ’ ‘ ’
properties. Please rewrite your date/week-tree targets using
‘ ’
(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.
2019-12-29 11:23:16 +01:00
(3) When the file name is not absolute, Org assumes it is relative to
‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: Template expansion, Next: Templates in contexts, Prev: Template elements, Up: Capture templates
2019-12-06 19:15:46 +01:00
10.1.3.2 Template expansion
...........................
2019-11-26 16:46:24 +01:00
In the template itself, special “%-escapes”(1) allow dynamic insertion
of content. The templates are expanded in the order given here:
‘ ’
Insert the contents of the file given by FILE.
‘ ’
Evaluate Elisp expression EXP and replace it with the result. The
EXP form must return a string. Only placeholders pre-existing
within the template, or introduced with ‘ ’
this way. Since this happens after expanding non-interactive
“%-escapes”, those can be used to fill the expression.
‘ ’
The result of format-time-string on the FORMAT specification.
‘ ’
Timestamp, date only.
‘ ’
Timestamp, with date and time.
‘ ’ ‘ ’
Like ‘ ’ ‘ ’
‘ ’
Initial content, the region when capture is called while the region
is active. If there is text before ‘ ’
indentation, and ‘ ’ ‘ ’
added before every line in the inserted text.
‘ ’
Annotation, normally the link created with ‘ ’
‘ ’
Like ‘ ’
‘ ’
Like ‘ ’
‘ ’
Current kill ring head.
‘ ’
Content of the X clipboard.
‘ ’
Title of the currently clocked task.
‘ ’
Link to the currently clocked task.
‘ ’
User name (taken from ‘ ’
‘ ’
File visited by current buffer when org-capture was called.
‘ ’
Full path of the file or directory visited by current buffer.
‘ ’
Specific information for certain link types, see below.
‘ ’
Prompt for tags, with completion on tags in target file.
‘ ’
Prompt for tags, with completion all tags in all agenda files.
‘ ’
Like ‘ ’ ‘ ’ ‘ ’ ‘ ’
You may define a prompt like ‘ ’
‘ ’
Interactive selection of which kill or clip to use.
‘ ’
Like ‘ ’
‘ ’
Prompt the user for a value for property PROP.
‘ ’
Prompt the user for a string and replace this sequence with it.
You may specify a default value and a completion table with
‘ ’
access a prompt-specific history.
‘ ’
Insert the text entered at the Nth ‘ ’
number, starting from 1.
‘ ’
After completing the template, position point here.
For specific link types, the following keywords are defined(2):
Link type Available keywords
--------------------------------------------------------------------------
bbdb ‘ ’ ‘ ’
irc ‘ ’ ‘ ’ ‘ ’
mh, rmail ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
gnus ‘ ’
w3, w3m ‘ ’
info ‘ ’ ‘ ’
calendar ‘ ’
org-protocol ‘ ’ ‘ ’ ‘ ’
---------- Footnotes ----------
(1) If you need one of these sequences literally, escape the ‘ ’
a backslash.
(2) If you define your own link types (see *note Adding Hyperlink
Types::), any property you store with ‘ ’
accessed in capture templates in a similar way.
(3) This is always the other, not the user. See the variable
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: Templates in contexts, Prev: Template expansion, Up: Capture templates
2019-12-06 19:15:46 +01:00
10.1.3.3 Templates in contexts
..............................
2019-11-26 16:46:24 +01:00
To control whether a capture template should be accessible from a
specific context, you can customize ‘ ’
Let’
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 ‘ ’
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.
2019-12-06 19:15:46 +01:00
File: org, Node: Attachments, Next: RSS Feeds, Prev: Capture, Up: Capture and Attachments
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
10.2 Attachments
================
It is often useful to associate reference material with an outline node.
Small chunks of plain text can simply be stored in the subtree of a
project. Hyperlinks (see *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 either
named by a unique ID of each entry, or by a ‘ ’
* Menu:
* Attachment defaults and dispatcher:: How to access attachment commands
* Attachment options:: Configuring the attachment system
* Attachment links:: Hyperlink access to attachments
* Automatic version-control with Git:: Everything safely stored away
* Attach from Dired:: Using dired to select an attachment
File: org, Node: Attachment defaults and dispatcher, Next: Attachment options, Up: Attachments
10.2.1 Attachment defaults and dispatcher
-----------------------------------------
By default, org-attach will use ID properties when adding attachments to
outline nodes. This makes working with attachments fully automated.
There is no decision needed for folder-name or location. ID-based
directories are by default located in the ‘ ’
in the same directory where your Org file lives(1). For more control
over the setup, see *note Attachment options::.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
When attachments are made using ‘ ’ ‘ ’
is added to the node that gets the attachments.
2019-11-26 16:46:24 +01:00
The following commands deal with attachments:
‘ ’ ‘ ’
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:
‘ ’ ‘ ’
Select a file and move it into the task’
directory. The file is copied, moved, or linked, depending on
‘ ’
on all systems.
‘ ’ ‘ ’ ‘ ’
Attach a file using the copy/move/link method. Note that hard
links are not supported on all systems.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Select a buffer and save it as a file in the task’
directory.
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Create a new attachment as an Emacs buffer.
‘ ’ ‘ ’
Synchronize the current task with its attachment directory, in
case you added attachments yourself.
‘ ’ ‘ ’
Open current task’
prompt for a file name first. Opening follows the rules set
by ‘ ’
following hyperlinks (see *note Handling Links::).
‘ ’ ‘ ’
Also open the attachment, but force opening the file in Emacs.
‘ ’ ‘ ’
Open the current task’
‘ ’ ‘ ’
Also open the directory, but force using Dired in Emacs.
‘ ’ ‘ ’
Select and delete a single attachment.
‘ ’ ‘ ’
Delete all of a task’
the directory in Dired and delete from there.
‘ ’ ‘ ’
Set a specific directory as the entry’
2019-12-06 19:15:46 +01:00
This works by putting the directory path into the ‘ ’
2019-11-26 16:46:24 +01:00
property.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Remove the attachment directory. This command removes the
‘ ’
that folder, if an ‘ ’
or to leave the attachment directory as is but no longer
attached to the outline node.
---------- Footnotes ----------
(1) If you move entries or Org files from one directory to another,
you may want to configure ‘ ’
path.
File: org, Node: Attachment options, Next: Attachment links, Prev: Attachment defaults and dispatcher, Up: Attachments
10.2.2 Attachment options
-------------------------
There are a couple of options for attachments that are worth mentioning.
‘ ’
The directory where attachments are stored when ‘ ’
method.
‘ ’
When setting the ‘ ’ ‘ ’
(‘ ’
default. This option changes that to relative links.
‘ ’
By default folders attached to an outline node are inherited from
parents according to ‘ ’
instead want to set inheritance specifically for org-attach that
can be done using ‘ ’
documents through the node hierarchy makes a lot of sense in most
cases. Especially since the introduction of *note Attachment
links::. The following example shows one use case for attachment
inheritance:
* Chapter A ...
:PROPERTIES:
:DIR: Chapter A/
:END:
** Introduction
Some text
#+NAME: Image 1
[[Attachment:image 1.jpg]]
Without inheritance one would not be able to resolve the link to
image ‘ ’ ‘
A’
Inheritance works the same way for both ‘ ’ ‘ ’
If both properties are defined on the same headline then ‘ ’
2019-12-29 11:23:16 +01:00
takes precedence. This is also true if inheritance is enabled. If
2019-12-06 19:15:46 +01:00
‘ ’
still takes precedence over an ‘ ’
itself.
‘ ’
When attaching files using the dispatcher ‘ ’
2019-12-29 11:23:16 +01:00
copying files. The behavior can be changed by customizing
2019-12-06 19:15:46 +01:00
‘ ’
Symbolic link.
‘ ’
This customization lets you choose the default way to attach to
nodes without existing ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
Configure this to determine if attachments should be deleted or not
when a subtree that has attachments is archived.
‘ ’
When attaching files to a heading it will be assigned a tag
according to what is set here.
‘ ’
When ‘ ’
a directory-path. See ‘ ’
default function. Define a new one and add it as first element in
‘ ’
structure in any other way. All functions in this list will be
tried when resolving existing ID’
compatibility with existing folders in your system.
‘ ’
Do not show the splash buffer with the attach dispatcher when
‘ ’ ‘ ’
See customization group ‘ ’
default settings.
File: org, Node: Attachment links, Next: Automatic version-control with Git, Prev: Attachment options, Up: Attachments
10.2.3 Attachment links
-----------------------
Attached files and folders can be referenced using attachment links.
This makes it easy to refer to the material added to an outline node.
Especially if it was attached using the unique ID of the entry!
* TODO Some task
:PROPERTIES:
:ID: 95d50008-c12e-479f-a4f2-cc0238205319
:END:
See attached document for more information: [[attachment:info.org]]
See *note External Links:: for more information about these links.
File: org, Node: Automatic version-control with Git, Next: Attach from Dired, Prev: Attachment links, Up: Attachments
10.2.4 Automatic version-control with Git
-----------------------------------------
If the directory attached to an outline node is a Git repository, Org
can be configured to automatically commit changes to that repository
when it sees them.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
To make Org mode take care of versioning of attachments for you, add
the following to your Emacs config:
(require 'org-attach-git)
File: org, Node: Attach from Dired, Prev: Automatic version-control with Git, Up: Attachments
10.2.5 Attach from Dired
------------------------
It is possible to attach files to a subtree from a Dired buffer. To use
this feature, have one window in Dired mode containing the file(s) to be
attached and another window with point in the subtree that shall get the
attachments. In the Dired window, with point on a file, ‘
2019-11-26 16:46:24 +01:00
org-attach-dired-to-subtree’
attachment method set by variable ‘ ’
marked in the Dired window then all marked files get attached.
Add the following lines to the Emacs init file to have ‘ ’
attach files in Dired buffers.
(add-hook 'dired-mode-hook
(lambda ()
(define-key dired-mode-map
(kbd "C-c C-x a")
#'org-attach-dired-to-subtree)))
The following code shows how to bind the previous command with a
specific attachment method.
(add-hook 'dired-mode-hook
(lambda ()
(define-key dired-mode-map (kbd "C-c C-x c")
(lambda ()
(interactive)
(let ((org-attach-method 'cp))
(call-interactively #'org-attach-dired-to-subtree))))))
2019-12-06 19:15:46 +01:00
File: org, Node: RSS Feeds, Prev: Attachments, Up: Capture and Attachments
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
10.3 RSS Feeds
==============
2019-11-26 16:46:24 +01:00
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 ‘ ’
detailed information. With the following
(setq org-feed-alist
'(("Slashdot"
"http://rss.slashdot.org/Slashdot/slashdot"
"~/txt/org/feeds.org" "Slashdot Entries")))
new items from the feed provided by ‘ ’
entries in the file ‘ ’ ‘
Entries’
‘ ’ ‘ ’
Collect items from the feeds configured in ‘ ’
upon them.
‘ ’ ‘ ’
Prompt for a feed name and go to the inbox configured for this
feed.
Under the same headline, Org creates a drawer ‘ ’
it stores 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
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
File: org, Node: Agenda Views, Next: Markup for Rich Contents, Prev: Capture and Attachments, Up: Top
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
11 Agenda Views
***************
2019-11-26 16:46:24 +01:00
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 do not 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 (see *note Comment Lines::)
and archived (see *note Internal archiving::) entries. You can override
this by setting ‘ ’
‘ ’ ‘ ’
Two variables control how the agenda buffer is displayed and whether
the window configuration is restored when the agenda exits:
‘ ’ ‘ ’
* 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, Node: Agenda Files, Next: Agenda Dispatcher, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.1 Agenda Files
2019-11-26 16:46:24 +01:00
=================
The information to be shown is normally collected from all _agenda
files_, the files listed in the variable ‘ ’
directory is part of this list, all files with the extension ‘ ’
this directory are 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 ‘ ’
easiest way to maintain it is through the following commands
‘ ’ ‘ ’
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.
‘ ’ ‘ ’
Remove current file from the list of agenda files.
‘ ’
‘ ’ ‘ ’
Cycle through agenda file list, visiting one file after the other.
‘ ’
2019-12-06 19:15:46 +01:00
Command to use an Iswitchb-like interface to switch to and between
2019-11-26 16:46:24 +01:00
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 ‘ ’
*note Agenda Dispatcher::). To restrict the agenda scope for an
extended period, use the following commands:
‘ ’ ‘ ’
Restrict the agenda to the current subtree. If there already is a
restriction at point, remove it. When called with a universal
prefix argument or with point before the first headline in a file,
set the agenda scope to the entire file. This restriction remains
in effect until removed with ‘ ’ ‘ ’
or ‘ ’
an agenda view, the new restriction takes effect immediately.
‘ ’ ‘ ’
Remove the restriction created by ‘ ’
When working with Speedbar, you can use the following commands in the
Speedbar frame:
‘ ’ ‘ ’
Restrict the agenda to the item—either an Org file or a subtree in
such a file—at point in the Speedbar frame. If agenda is already
restricted there, remove the restriction. If there is a window
displaying an agenda view, the new restriction takes effect
immediately.
‘ ’ ‘ ’
Remove 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 in maintained in that external file.
(2) When using the dispatcher, pressing ‘ ’
command actually limits the command to the current file, and ignores
‘ ’
File: org, Node: Agenda Dispatcher, Next: Built-in Agenda Views, Prev: Agenda Files, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.2 The Agenda Dispatcher
2019-11-26 16:46:24 +01:00
==========================
The views are created through a dispatcher, accessible with ‘
org-agenda’
It displays a menu from which an additional letter is required to
execute a command. The dispatcher offers the following default
commands:
‘ ’
Create the calendar-like agenda (see *note Weekly/daily agenda::).
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Create a list of all TODO items (see *note Global TODO list::).
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Create a list of headlines matching a given expression (see *note
Matching tags and properties::).
‘ ’
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
‘ ’
‘ ’
of context lines for each match, default is
1.
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Create a list of stuck projects (see *note Stuck projects::).
‘ ’
2019-12-06 19:15:46 +01:00
Restrict an agenda command to the current buffer(1). If narrowing
is in effect restrict to the narrowed part of the buffer. After
2019-11-26 16:46:24 +01:00
pressing ‘ ’
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 ‘ ’
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 switch
between views often and the build time bothers you, you can turn on
sticky agenda buffers (make this the default by customizing the
variable ‘ ’
only switches to the selected view, you need to update it by hand
with ‘ ’ ‘ ’
‘ ’
You can also define custom commands that are 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. See *note Custom Agenda Views::.
---------- Footnotes ----------
(1) For backward compatibility, you can also press ‘ ’
the current buffer.
(2) For backward compatibility, you can also press ‘ ’
the current region/subtree.
File: org, Node: Built-in Agenda Views, Next: Presentation and Sorting, Prev: Agenda Dispatcher, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.3 The Built-in Agenda Views
2019-11-26 16:46:24 +01:00
==============================
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, Node: Weekly/daily agenda, Next: Global TODO list, Up: Built-in Agenda Views
2019-12-06 19:15:46 +01:00
11.3.1 Weekly/daily agenda
2019-11-26 16:46:24 +01:00
--------------------------
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.
‘ ’ ‘ ’
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
argument(1)—like ‘ ’
of days to be displayed.
The default number of days displayed in the agenda is set by the
variable ‘ ’
days you want to see by default in the agenda, or to a span name, such a
‘ ’ ‘ ’ ‘ ’ ‘ ’
start on the previous Monday (see ‘ ’
can also set the start date using a date shift: ‘
org-agenda-start-day "+10d")’
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’
agenda, you only need to customize the variable
(setq org-agenda-include-diary t)
After that, everything happens automatically. All diary entries
including holidays, anniversaries, etc., are included in the agenda
buffer created by Org mode. ‘ ’ ‘ ’ ‘ ’
from the agenda buffer to jump to the diary file in order to edit
existing diary entries. The ‘ ’
current date works in the agenda buffer, as well as the commands ‘ ’
‘ ’ ‘ ’
convert to other calendars, respectively. ‘ ’
back and forth between calendar and agenda.
2019-12-06 19:15:46 +01:00
If you are using the diary only for expression 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
expression entries, and does it faster because there is no overhead for
first creating the diary display. Note that the expression entries must
start at the left margin, no whitespace is allowed before them, as seen
in the following segment of an Org file:(2)
2019-11-26 16:46:24 +01:00
* Holidays
:PROPERTIES:
:CATEGORY: Holiday
:END:
%%(org-calendar-holiday) ; special function for holiday names
* Birthdays
:PROPERTIES:
:CATEGORY: Ann
:END:
%%(org-anniversary 1956 5 14) 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 Insidious Big Brother Database to store your
contacts, you very likely prefer to store anniversaries in BBDB rather
than in a separate Org or diary file. Org supports this and can 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 a field named ‘ ’
which contains the date in the format ‘ ’ ‘ ’
by a space and the class of the anniversary (‘ ’ ‘ ’
format string). If you omit the class, it defaults to ‘ ’
2019-12-06 19:15:46 +01:00
are a few examples, the header for the file ‘ ’
2019-11-26 16:46:24 +01:00
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 suffers 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 ‘ ’
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’
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
‘ ’
your appointments and add only those belonging to a specific category or
matching a regular expression. It also reads a ‘ ’
which overrides the value of ‘ ’
appointment. See the docstring for details.
---------- Footnotes ----------
(1) For backward compatibility, the universal prefix argument ‘ ’
causes all TODO entries to be listed before the agenda. This feature is
deprecated, use the dedicated TODO list, or a block agenda instead (see
*note Block agenda::).
(2) The variable ‘ ’
‘ ’
and therefore independent of the value of ‘ ’
File: org, Node: Global TODO list, Next: Matching tags and properties, Prev: Weekly/daily agenda, Up: Built-in Agenda Views
2019-12-06 19:15:46 +01:00
11.3.2 The global TODO list
2019-11-26 16:46:24 +01:00
---------------------------
The global TODO list contains all unfinished TODO items formatted and
collected into a single place.
‘ ’ ‘ ’
Show the global TODO list. This collects the TODO items from all
agenda files (see *note Agenda Views::) into a single buffer. By
default, this lists items with a state the is not a DONE state.
2019-12-06 19:15:46 +01:00
The buffer is in Agenda mode, so there are commands to examine and
manipulate the TODO entries directly from that buffer (see *note
Agenda Commands::).
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Like the above, but allows selection of a specific TODO keyword.
You can also do this by specifying a prefix argument to ‘ ’
are prompted for a keyword, and you may also specify several
keywords by separating them with ‘ ’
With a numeric prefix, the Nth keyword in ‘ ’
selected.
The ‘ ’
prefix argument to this command to change the selected TODO
keyword, for example ‘ ’
specific keyword, define a custom command for it (see *note Agenda
Dispatcher::).
Matching specific TODO keywords can also be done as part of a tags
search (see *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_ (see *note Timestamps::) as no
longer _open_. Configure the variables
2019-12-06 19:15:46 +01:00
‘ ’
items from the global TODO list, ‘ ’
to exclude some or all items with a deadline set,
‘ ’
with an active timestamp other than a DEADLINE or a SCHEDULED
timestamp and/or ‘ ’
items with at least one active timestamp.
2019-11-26 16:46:24 +01:00
• 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 ‘ ’
File: org, Node: Matching tags and properties, Next: Search view, Prev: Global TODO list, Up: Built-in Agenda Views
2019-12-06 19:15:46 +01:00
11.3.3 Matching tags and properties
2019-11-26 16:46:24 +01:00
-----------------------------------
If headlines in the agenda files are marked with _tags_ (see *note
Tags::), or have properties (see *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 ‘ ’
‘ ’ ‘ ’
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 ‘ ’
‘ ’
search, define a custom command for it (see *note Agenda
Dispatcher::).
‘ ’ ‘ ’
Like ‘ ’
force checking subitems (see the variable
‘ ’
items, see the variable
‘ ’
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::.
A search string can use Boolean operators ‘ ’ ‘ ’
‘ ’ ‘ ’
implemented. Each element in the search is either a tag, a regular
expression matching tags, or an expression like ‘
VALUE’
element may be preceded by ‘ ’ ‘ ’
syntactic sugar for positive selection. The AND operator ‘ ’
optional when ‘ ’ ‘ ’
tags.
‘ ’
Select headlines tagged ‘ ’
‘ ’
‘ ’
Selects lines tagged ‘ ’ ‘ ’
‘ ’
Like before, but require the ‘ ’
‘ ’
Instead of a tag, you may also specify a regular expression enclosed
in curly braces. For example, ‘ ’
contain the tag ‘ ’ ‘ ’
Group tags (see *note Tag Hierarchy::) are expanded as regular
expressions. E.g., if ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
headlines but those with one of the tags in the group (i.e.,
‘ ’
You may also test for properties (see *note Properties and Columns::)
at the same time as matching tags. The properties may be real
properties, or special properties that represent other metadata (see
*note Special Properties::). For example, the property ‘ ’
represents the TODO keyword of the entry. Or, the property ‘ ’
represents the level of an entry. So searching
‘ ’
the tag ‘ ’ ‘ ’
buffers with ‘ ’ ‘ ’
number of stars, but ‘ ’
Here are more examples:
‘ ’
Select ‘ ’
‘ ’
‘ ’
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 depends 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 ‘ ’
assumed to be date/time specifications in the standard Org way, and
the comparison is done accordingly. Valid values also include
‘ ’ ‘ ’ ‘ ’
for these days at 0:00 hours, i.e., without a time specification.
You can also use strings like ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
respectively.
• If the comparison value is enclosed in curly braces, a regexp match
is performed, with ‘ ’
value, and ‘ ’
So the search string in the example finds entries tagged ‘ ’
not ‘ ’ ‘ ’ ‘ ’
with the value ‘ ’ ‘ ’
smaller than 2, a ‘ ’
expression ‘ ’
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 ‘ ’ ‘ ’
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 ‘ ’
equivalently start the TODO part after the slash with ‘ ’ ‘
org-agenda M’ ‘ ’
Examples:
‘ ’
Same as ‘ ’
‘ ’
Select ‘ ’ ‘ ’
‘ ’
‘ ’
Select ‘ ’ ‘ ’
‘ ’
File: org, Node: Search view, Next: Stuck projects, Prev: Matching tags and properties, Up: Built-in Agenda Views
2019-12-06 19:15:46 +01:00
11.3.4 Search view
2019-11-26 16:46:24 +01:00
------------------
This agenda view is a general text search facility for Org mode entries.
It is particularly useful to find notes.
‘ ’ ‘ ’
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 ‘ ’
that contain ‘ ’
are separated by more space or a line break.
Search view can also search for specific keywords in the entry, using
Boolean logic. The search string ‘
-{8\.11[bg]}’ ‘ ’
and ‘ ’ ‘ ’
matched by the regular expression ‘ ’
‘ ’ ‘ ’ ‘ ’
search, other ‘ ’
docstring of the command ‘ ’
2019-12-06 19:15:46 +01:00
You can incrementally and conveniently adjust a boolean search from
the agenda search view with the following keys
2019-11-26 16:46:24 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
Note that in addition to the agenda files, this command also searches
the files listed in ‘ ’
File: org, Node: Stuck projects, Prev: Search view, Up: Built-in Agenda Views
2019-12-06 19:15:46 +01:00
11.3.5 Stuck projects
2019-11-26 16:46:24 +01:00
---------------------
If you are following a system like David Allen’
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 never shows up in the TODO lists Org mode
produces. During the review, you need to identify such projects and
define next actions for them.
‘ ’ ‘ ’
List projects that are stuck.
‘ ’
Customize the variable ‘ ’
project is and how to find it.
You almost certainly need to configure this view before it works 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 ‘ ’ ‘ ’ ‘ ’
Let’
projects with a tag ‘ ’ ‘ ’
to indicate a project that should not be considered yet. Let’
assume that the TODO keyword ‘ ’
‘ ’ ‘ ’ ‘ ’
shopping and is a next action even without the NEXT tag. Finally, if
the project contains the special word ‘ ’
be listed either. In this case you would start by identifying eligible
projects with a tags/TODO match (see *note Tag Searches::)
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
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 is searched for stuck projects.
File: org, Node: Presentation and Sorting, Next: Agenda Commands, Prev: Built-in Agenda Views, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.4 Presentation and Sorting
2019-11-26 16:46:24 +01:00
=============================
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_ (see *note
Categories::) of the item and other important information. You can
customize in which column tags are displayed through
‘ ’
option ‘ ’
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 of agenda items:: The order of things.
2019-12-06 19:15:46 +01:00
* Filtering/limiting agenda items:: Dynamically narrow the agenda.
2019-11-26 16:46:24 +01:00
File: org, Node: Categories, Next: Time-of-day specifications, Up: Presentation and Sorting
2019-12-06 19:15:46 +01:00
11.4.1 Categories
2019-11-26 16:46:24 +01:00
-----------------
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 you want to apply as the value.
The display in the agenda buffer looks best if the category is not
2019-12-06 19:15:46 +01:00
longer than 10 characters. You can set up icons for category by
customizing the ‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and Sorting
2019-12-06 19:15:46 +01:00
11.4.2 Time-of-day specifications
2019-11-26 16:46:24 +01:00
---------------------------------
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
<2005-05-10 Tue 19:00>
Time ranges can be specified with two timestamps:
<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>
In the headline of the entry itself, a time(range)—like ‘ ’
‘ ’
If the agenda integrates the Emacs diary (see *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
‘ ’
‘ ’
---------- Footnotes ----------
(1) You can, however, disable this by setting
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
File: org, Node: Sorting of agenda items, Next: Filtering/limiting agenda items, Prev: Time-of-day specifications, Up: Presentation and Sorting
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
11.4.3 Sorting of agenda items
2019-11-26 16:46:24 +01:00
------------------------------
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 are 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
‘ ’
priority (see *note Priorities::), which is composed of the base
priority (2000 for priority ‘ ’ ‘ ’ ‘ ’
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
(see *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
‘ ’
the estimated effort of an entry (see *note Effort Estimates::).
2019-12-06 19:15:46 +01:00
File: org, Node: Filtering/limiting agenda items, Prev: Sorting of agenda items, Up: Presentation and Sorting
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
11.4.4 Filtering/limiting agenda items
2019-11-26 16:46:24 +01:00
--------------------------------------
2019-12-06 19:15:46 +01:00
Agenda built-in or custom commands are statically defined. Agenda
filters and limits allow to flexibly narrow down the list of agenda
entries.
_Filters_ only change the visibility of items, are very fast and are
mostly used interactively(1). You can switch quickly between different
filters without having to recreate the agenda. _Limits_ on the other
hand take effect before the agenda buffer is populated, so they are
mostly useful when defined as local variables within custom agenda
commands.
2019-11-26 16:46:24 +01:00
Filtering in the agenda
.......................
2019-12-06 19:15:46 +01:00
The general filtering command is ‘ ’ ‘ ’
Before we introduce it, we describe commands for individual filter
types. All filtering commands handle prefix arguments in the same way:
A single ‘ ’
by the filter. A double prefix adds the new filter condition to the
one(s) already in place, so filter elements are accumulated.
‘ ’ ‘ ’
Filter the agenda view with respect to a tag. You are prompted for
a tag selection letter; ‘ ’
‘ ’
any tags that do not have a selection character. The command then
hides all entries that do not contain or inherit this tag.
Pressing ‘ ’ ‘ ’
and against the next tag. To clear the filter, press ‘ ’
(once to call the command again, and once at the prompt).
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
Filter by category of the line at point, and show only entries with
this category. When called with a prefix argument, hide all
entries with the category at point. To clear the filter, call this
command again by pressing ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Filter the agenda view by a regular expression: only show agenda
2019-12-06 19:15:46 +01:00
entries matching the regular expression the user entered. To clear
the filter, call the command again by pressing ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
Filter the agenda view with respect to effort estimates, so select
tasks that take the right amount of time. You first need to set up
a list of efforts globally, for example
2019-11-26 16:46:24 +01:00
(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 ‘ ’ ‘ ’ ‘ ’
estimate in your array of allowed values, where ‘ ’
value. The filter then restricts 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 are treated according to the value of
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
twice (once to call the command again, and once at the first
prompt).
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
Filter the current agenda view and only display items that fall
under the same top-level headline as the current entry. To clear
the filter, call this command again by pressing ‘ ’
‘ ’ ‘ ’
This is the unified interface to four of the five filter methods
described above. At the prompt, specify different filter elements
in a single string, with full completion support. For example,
+work-John+<0:10-/plot/
selects entries with category ‘ ’
minutes, and deselects entries with tag ‘ ’
2019-12-29 11:23:16 +01:00
regexp ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
ambiguities. The sequence of elements is arbitrary. The filter
2019-12-29 11:23:16 +01:00
syntax assumes that there is no overlap between categories and
tags. Otherwise, tags take priority. If you reply to the prompt
with the empty string, all filtering is removed. If a filter is
specified, it replaces all current filters. But if you call the
command with a double prefix argument, or if you add an additional
‘ ’ ‘ ’
elements are added to the active ones. A single prefix argument
applies the entire filter in a negative sense.
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Remove all filters in the current agenda view.
2019-12-06 19:15:46 +01:00
Computed tag filtering
......................
If the variable ‘ ’
user-defined function, that function can select tags that should be used
as a tag filter when requested. The function will be called with
lower-case versions of all tags represented in the current view. The
2019-12-29 11:23:16 +01:00
function should return ‘ ’
that tag, ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ’ ‘ ’
tag to identify tasks which need network access, an ‘ ’
errands in town, and a ‘ ’
auto-exclude these tags based on the availability of the Internet, and
outside of business hours, with something like this:
2019-12-29 11:23:16 +01:00
(defun my-auto-exclude-fn (tag)
(when (cond ((string= tag "net")
(/= 0 (call-process "/sbin/ping" nil nil nil
"-c1" "-q" "-t1" "mail.gnu.org")))
((member tag '("errand" "call"))
(let ((hr (nth 2 (decode-time))))
(or (< hr 8) (> hr 21)))))
(concat "-" tag)))
2019-12-06 19:15:46 +01:00
2019-12-29 11:23:16 +01:00
(setq org-agenda-auto-exclude-function #'my-auto-exclude-fn)
2019-12-06 19:15:46 +01:00
2019-12-29 11:23:16 +01:00
You can apply this self-adapting filter by using a triple prefix
argument to ‘ ’ ‘ ’
pressing ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
2019-11-26 16:46:24 +01:00
Setting limits for the agenda
.............................
Here is a list of options that you can set, either globally, or locally
in your custom agenda views (see *note Custom Agenda Views::).
‘ ’
Limit the number of entries.
‘ ’
Limit the duration of accumulated efforts (as minutes).
‘ ’
Limit the number of entries with TODO keywords.
‘ ’
Limit the number of tagged entries.
When set to a positive integer, each option excludes entries from
other categories: for example, ‘ ’
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 ‘ ’
setup is to use ‘ ’
For example, this custom command displays the next five entries with a
‘ ’
(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 are lost when
rebuilding the agenda:
‘ ’ ‘ ’
This prompts for the type of limit to apply and its value.
---------- Footnotes ----------
2019-12-06 19:15:46 +01:00
(1) Custom agenda commands can preset a filter by binding one of the
variables ‘ ’
‘ ’ ‘ ’
or ‘ ’
2019-11-26 16:46:24 +01:00
applied to the view and persists 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, Node: Agenda Commands, Next: Custom Agenda Views, Prev: Presentation and Sorting, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.5 Commands in the Agenda Buffer
2019-11-26 16:46:24 +01:00
==================================
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, point needs to be in the desired line.
Motion
------
‘ ’ ‘ ’
Next line (same as ‘ ’ ‘ ’
‘ ’ ‘ ’
Previous line (same as ‘ ’ ‘ ’
View/Go to Org file
-------------------
‘ ’ ‘ ’ ‘ ’
Display the original location of the item in another window. With
a prefix argument, make sure that drawers stay folded.
‘ ’ ‘ ’
Display original location and recenter that window.
‘ ’ ‘ ’ ‘ ’
Go to the original location of the item in another window.
‘ ’ ‘ ’
Go to the original location of the item and delete other windows.
‘ ’ ‘ ’
Toggle Follow mode. In Follow mode, as you move point 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
‘ ’
‘ ’ ‘ ’
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 ‘ ’
buffer.
‘ ’ ‘ ’
Follow a link in the entry. This offers a selection of any links
in the text belonging to the referenced Org node. If there is only
one link, follow it without a selection prompt.
Change display
--------------
‘ ’
Interactively select another agenda view and append it to the
current view.
‘ ’
Delete other windows.
‘ ’ ‘ ’ ‘ ’
Switch to day view. When switching to day view, this setting
becomes the default for subsequent agenda refreshes. A numeric
prefix argument may be used to jump directly to a specific day of
the year. For example, ‘ ’
day view, a year may be encoded in the prefix argument as well.
For example, ‘ ’
specification has only one or two digits, it is expanded into one
of the 30 next years or the last 69 years.
‘ ’ ‘ ’ ‘ ’
Switch to week view. When switching week view, this setting
becomes the default for subsequent agenda refreshes. A numeric
prefix argument may be used to jump directly to a specific day of
the ISO week. For example ‘ ’
setting week view, a year may be encoded in the prefix argument as
well. For example, ‘ ’
year specification has only one or two digits, it is expanded into
one of the 30 next years or the last 69 years.
‘ ’ ‘ ’
Switch to month view. Because month views are slow to create, they
do not become the default for subsequent agenda refreshes. A
numeric prefix argument may be used to jump directly to a specific
day of the month. When setting month view, a year may be encoded
in the prefix argument as well. For example, ‘ ’
December, 2007. If such a year specification has only one or two
digits, it is expanded into one of the 30 next years or the last 69
years.
‘ ’ ‘ ’
Switch to year view. Because year views are slow to create, they
do not become the default for subsequent agenda refreshes. A
numeric prefix argument may be used to jump directly to a specific
day of the year.
‘ ’ ‘ ’
Reset the current view to ‘ ’
‘ ’ ‘ ’
Go forward in time to display the span following the current one.
For example, if the display covers a week, switch to the following
week. With a prefix argument, repeat that many times.
‘ ’ ‘ ’
Go backward in time to display earlier dates.
‘ ’ ‘ ’
Go to today.
‘ ’ ‘ ’
Prompt for a date and go there.
‘ ’ ‘ ’
Go to the currently clocked-in task _in the agenda buffer_.
‘ ’ ‘ ’
Toggle the inclusion of diary entries. See *note Weekly/daily
agenda::.
‘ ’ ‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
Toggle Logbook mode. In Logbook mode, entries that were marked as
done while logging was on (see the variable ‘ ’
2019-11-26 16:46:24 +01:00
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 ‘ ’
2019-12-06 19:15:46 +01:00
called with a ‘ ’
entries, including state changes. When called with two prefix
arguments ‘ ’
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’ ‘ ’
Include inactive timestamps into the current view. Only for
weekly/daily agenda.
‘ ’ ‘ ’
Toggle Archives mode. In Archives mode, trees that are archived
(see *note Internal archiving::) are also scanned when producing
the agenda. To exit archives mode, press ‘ ’
‘ ’
Toggle Archives mode. Include all archive files as well.
‘ ’ ‘ ’ ‘ ’
Toggle Clockreport mode. In Clockreport mode, the daily/weekly
agenda always shows 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 ‘ ’
prefix argument when toggling this mode (i.e., ‘ ’
table does not show contributions from entries that are hidden by
agenda filtering(1). See also the variable
‘ ’
‘ ’
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
‘ ’
customize the definition of what constituted a clocking problem.
To return to normal agenda display, press ‘ ’
‘ ’ ‘ ’ ‘ ’
Toggle entry text mode. In entry text mode, a number of lines from
the Org outline node referenced by an agenda line are displayed
below the line. The maximum number of lines is given by the
variable ‘ ’
with a numeric prefix argument temporarily modifies that number to
the prefix value.
‘ ’ ‘ ’
Toggle the time grid on and off. See also the variables
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
Recreate the agenda buffer, for example to reflect the changes
after modification of the timestamps of items with ‘ ’
‘ ’
argument is interpreted to create a selective list for a specific
TODO keyword.
‘ ’ ‘ ’ ‘ ’
Save all Org buffers in the current Emacs session, and also the
locations of IDs.
‘ ’ ‘ ’
Invoke column view (see *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 ‘ ’
or from the default variable ‘ ’
in the agenda.
‘ ’ ‘ ’
Remove the restriction lock on the agenda, if it is currently
restricted to a file or subtree (see *note Agenda Files::).
‘ ’ ‘ ’
Drag the line at point backward one line. With a numeric prefix
argument, drag backward by that many lines.
Moving agenda lines does not persist after an agenda refresh and
does not modify the contributing Org files.
‘ ’ ‘ ’
Drag the line at point forward one line. With a numeric prefix
argument, drag forward by that many lines.
Remote editing
--------------
‘ ’
Digit argument.
‘ ’ ‘ ’
Undo a change due to a remote editing command. The change is
undone both in the agenda buffer and in the remote buffer.
‘ ’ ‘ ’
Change the TODO state of the item, both in the agenda and in the
2019-12-06 19:15:46 +01:00
original Org file. A prefix arg is passed through to the
‘ ’ ‘ ’
taking a note to document the state change.
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Switch to the next set of TODO keywords.
‘ ’ ‘ ’
Switch to the previous set of TODO keywords.
‘ ’ ‘ ’
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 ‘ ’
‘ ’ ‘ ’
Refile the entry at point.
‘ ’ ‘ ’ ‘ ’
Archive the subtree corresponding to the entry at point using the
default archiving command set in ‘ ’
When using the ‘ ’
‘ ’ ‘ ’
Toggle the archive tag (see *note Internal archiving::) for the
current headline.
‘ ’ ‘ ’
Move the subtree corresponding to the current entry to its _archive
sibling_.
‘ ’ ‘ ’ ‘ ’
Archive the subtree corresponding to the current headline. This
means the entry is moved to the configured archive location, most
likely a different file.
‘ ’ ‘ ’
Show all tags associated with the current item. This is useful if
you have turned off ‘ ’
want to see all tags of a headline occasionally.
‘ ’ ‘ ’
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 mode prompts for the
priority character. If you reply with ‘ ’
is removed from the entry.
‘ ’ ‘ ’ ‘ ’
Increase the priority of the current item. The priority is changed
in the original buffer, but the agenda is not resorted. Use the
‘ ’
‘ ’ ‘ ’ ‘ ’
Decrease the priority of the current item.
‘ ’ ‘ ’ ‘ ’
Add a note to the entry. This note is recorded, and then filed to
the same location where state change notes are put. Depending on
‘ ’
‘ ’ ‘ ’
Dispatcher for all command related to attachments.
‘ ’ ‘ ’
Schedule this item. With a prefix argument, remove the scheduling
timestamp
‘ ’ ‘ ’
Set a deadline for this item. With a prefix argument, remove the
deadline.
‘ ’ ‘ ’
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 moves it to today. With a numeric prefix argument,
change it by that many days. For example, ‘ ’
changes it by a year. With a ‘ ’
hour. If you immediately repeat the command, it will continue to
change hours even without the prefix argument. With a double ‘
C-u’
changed in the original Org file, but the change is not directly
reflected in the agenda buffer. Use ‘ ’ ‘ ’
buffer.
‘ ’ ‘ ’
Change the timestamp associated with the current line by one day
into the past.
‘ ’ ‘ ’
Change the timestamp associated with the current line. The key ‘ ’
has been chosen, because it is the same as ‘ ’
‘ ’ ‘ ’
Start the clock on the current item. If a clock is running
already, it is stopped first.
‘ ’ ‘ ’
Stop the previously started clock.
‘ ’ ‘ ’
Cancel the currently running clock.
‘ ’ ‘ ’
Jump to the running clock in another window.
‘ ’ ‘ ’
Like ‘ ’
for the capture template. See ‘ ’
make this the default behavior of ‘ ’
Bulk remote editing selected entries
------------------------------------
‘ ’ ‘ ’
Mark the entry at point for bulk action. If there is an active
region in the agenda, mark the entries in the region. With numeric
prefix argument, mark that many successive entries.
‘ ’ ‘ ’
Mark all visible agenda entries for bulk action.
‘ ’ ‘ ’
Unmark entry for bulk action.
‘ ’ ‘ ’
Unmark all marked entries for bulk action.
‘ ’ ‘ ’
Toggle mark of the entry at point for bulk action.
‘ ’ ‘ ’
Toggle mark of every entry for bulk action.
‘ ’ ‘ ’
Mark entries matching a regular expression for bulk action.
‘ ’ ‘ ’
Bulk action: act on all marked entries in the agenda. This prompts
for another key to select the action to be applied. The prefix
argument to ‘ ’ ‘ ’ ‘ ’
bulk-remove these special timestamps. By default, marks are
removed after the bulk. If you want them to persist, set
‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
Toggle persistent marks.
‘ ’
Archive all selected entries.
‘ ’
Archive entries by moving them to their respective archive
siblings.
‘ ’
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.
‘ ’
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 ‘ ’ ‘ ’
‘ ’
Set deadline to a specific date.
‘ ’
Prompt for a single refile target and move all entries. The
entries are no longer in the agenda; refresh (‘ ’
them back.
‘ ’
Reschedule randomly into the coming N days. N is prompted
for. With a prefix argument (‘ ’
weekdays.
‘ ’
Apply a function(2) to marked entries. For example, the
function below sets the ‘ ’
‘ ’
(defun set-category ()
(interactive "P")
(let ((marker (or (org-get-at-bol 'org-hd-marker)
(org-agenda-error))))
(org-with-point-at marker
(org-back-to-heading t)
(org-set-property "CATEGORY" "web"))))
Calendar commands
-----------------
‘ ’ ‘ ’
Open the Emacs calendar and go to the date at point in the agenda.
‘ ’ ‘ ’
When in the calendar, compute and show the Org agenda for the date
at point.
‘ ’ ‘ ’
Insert a new entry into the diary, using the date at point and (for
block entries) the date at the mark. This adds to the Emacs diary
file(3), in a way similar to the ‘ ’
diary file pops up in another window, where you can add the entry.
If you configure ‘ ’
Org creates entries in that file instead. Most entries are stored
in a date-based outline tree that will later make it easy to
archive appointments from previous months/years. The tree is built
under an entry with a ‘ ’
top-level entries. Emacs prompts you for the entry text—if you
specify it, the entry is created in ‘ ’
further interaction. If you directly press ‘ ’
without typing text, the target file is shown in another window for
you to finish the entry there. See also the ‘ ’
‘ ’ ‘ ’
Show the phases of the moon for the three months around current
date.
‘ ’ ‘ ’
Show sunrise and sunset times. The geographical location must be
set with calendar variables, see the documentation for the Emacs
calendar.
‘ ’ ‘ ’
Convert the date at point into many other cultural and historic
calendars.
‘ ’ ‘ ’
Show holidays for three months around point date.
Quit and exit
-------------
‘ ’ ‘ ’
Quit agenda, remove the agenda buffer.
‘ ’ ‘ ’
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 are not removed.
---------- Footnotes ----------
(1) Only tags filtering is respected here, effort filtering is
ignored.
(2) You can also create persistent custom functions through
‘ ’
(3) This file is parsed for the agenda when
‘ ’
File: org, Node: Custom Agenda Views, Next: Exporting Agenda Views, Prev: Agenda Commands, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.6 Custom Agenda Views
2019-11-26 16:46:24 +01:00
========================
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 are accessible through the
dispatcher (see *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, Node: Storing searches, Next: Block agenda, Up: Custom Agenda Views
2019-12-06 19:15:46 +01:00
11.6.1 Storing searches
2019-11-26 16:46:24 +01:00
-----------------------
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
‘ ’
example by pressing ‘ ’
Dispatcher::). 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")))
2019-12-06 19:15:46 +01:00
The initial string in each entry defines the keys you have to press
2019-11-26 16:46:24 +01:00
after the dispatcher command in order to access the command. Usually
2019-12-06 19:15:46 +01:00
this is 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:
2019-11-26 16:46:24 +01:00
‘ ’
as a global search for agenda entries planned(2) this week/day.
‘ ’
as the same search, but only for entries with an hour specification
like ‘ ’
‘ ’
as a global search for TODO entries with ‘ ’
keyword.
‘ ’
as the same search, but only in the current buffer and displaying
the results as a sparse tree.
‘ ’
as a global tags search for headlines tagged ‘ ’
‘ ’
‘ ’
The same search, but limiting it to headlines that are also TODO
items.
‘ ’
as the same search, but only in the current buffer and displaying
the result as a sparse tree.
‘ ’
to create a sparse tree (again, current buffer only) with all
entries containing the word ‘ ’
‘ ’
as a prefix command for a ‘ ’
press an additional key (‘ ’ ‘ ’ ‘ ’
Peter, or Kim) as additional tag to match.
Note that ‘ ’
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 ‘ ’
planning information is taken into account.
File: org, Node: Block agenda, Next: Setting options, Prev: Storing searches, Up: Custom Agenda Views
2019-12-06 19:15:46 +01:00
11.6.2 Block agenda
2019-11-26 16:46:24 +01:00
-------------------
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 ‘ ’
weekly agenda (as created with ‘ ’ ‘ ’
(as constructed with ‘ ’
‘ ’ ‘ ’ ‘ ’
(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 defines ‘ ’
attend to at home. The resulting agenda buffer contains your agenda for
the current week, all TODO items that carry the tag ‘ ’
lines tagged with ‘ ’ ‘ ’
view for office tasks.
File: org, Node: Setting options, Prev: Block agenda, Up: Custom Agenda Views
2019-12-06 19:15:46 +01:00
11.6.3 Setting options for custom commands
2019-11-26 16:46:24 +01:00
------------------------------------------
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 ‘ ’
(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 ‘ ’
the prefix format is modified to just say ‘ ’
category of the entry. The sparse tags tree of ‘ ’
ultra-compact, because neither the headline hierarchy above the match,
nor the headline following the match are shown. The command ‘ ’
text search limited to only a single file.
For command sets creating a block agenda,
‘ ’
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 (see *note Block agenda::), let’
for the ‘ ’ ‘ ’ ’
‘ ’ ‘ ’
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
‘ ’ ’
have an agenda command ‘ ’
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 ‘ ’
command key ‘ ’
(setq org-agenda-custom-commands-contexts
'(("o" "r" (in-mode . "message-mode"))))
See the docstring of the variable for more information.
File: org, Node: Exporting Agenda Views, Next: Agenda Column View, Prev: Custom Agenda Views, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.7 Exporting Agenda Views
2019-11-26 16:46:24 +01:00
===========================
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
following command:
‘ ’ ‘ ’
Write the agenda view to a file.
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 and save it to this file name. If the extension is ‘ ’
‘ ’
the extension is ‘ ’
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:
‘ ’ ‘ ’
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 do not want to use colors for the
black-and-white printer. Settings specified in
‘ ’
(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)))
but the settings in ‘ ’
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 creates the agenda views restricted to the file
‘ ’
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 ----------
2019-12-06 19:15:46 +01:00
(1) For HTML you need to install Hrvoje Nikšić’ ‘ ’
Emacs package from MELPA or from Hrvoje Nikšić’
(https://github.com/hniksic/emacs-htmlize).
2019-11-26 16:46:24 +01:00
(2) To create PDF output, the Ghostscript ps2pdf utility must be
installed on the system. Selecting a PDF file also creates 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, Node: Agenda Column View, Prev: Exporting Agenda Views, Up: Agenda Views
2019-12-06 19:15:46 +01:00
11.8 Using Column View in the Agenda
2019-11-26 16:46:24 +01:00
====================================
Column view (see *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.
‘ ’ ‘ ’
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
2019-12-06 19:15:46 +01:00
non-trivial problem. Org first checks if
2019-11-26 16:46:24 +01:00
‘ ’
2019-12-06 19:15:46 +01:00
the format from there. You should set this variable only in the
_local settings section_ of a custom agenda command (see *note
Custom Agenda Views::) to make it valid for that specific agenda
view. If no such binding exists, it checks, in sequence,
‘ ’
the first item in the agenda (through a property or a ‘ ’
setting in that buffer) and finally ‘ ’
2019-11-26 16:46:24 +01:00
2. If any of the columns has a summary type defined (see *note Column
attributes::), turning on column view in the agenda visits all
relevant agenda files and make sure that the computations of this
property are up to date. This is also true for the special
‘ ’
agenda. In the daily/weekly agenda, the sums cover a single day;
in all other views they cover the entire block.
It is important 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 leads to
incorrect results because some values count double.
3. When the column view in the agenda shows the ‘ ’
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
‘ ’
4. When the column view in the agenda shows the ‘ ’
that is always today’
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 ‘ ’
planned total effort for it.
File: org, Node: Markup for Rich Contents, Next: Exporting, Prev: Agenda Views, Up: Top
2019-12-06 19:15:46 +01:00
12 Markup for Rich Contents
2019-11-26 16:46:24 +01:00
***************************
Org is primarily about organizing and searching through your plain-text
notes. However, it also provides a lightweight yet robust markup
language for rich text formatting and more. For instance, you may want
to center or emphasize text. Or you may need to insert a formula or
image in your writing. Org offers syntax for all of this and more.
Used in conjunction with the export framework (see *note Exporting::),
you can author beautiful documents in Org—like the fine manual you are
currently reading.
* Menu:
* Paragraphs:: The basic unit of text.
* Emphasis and Monospace:: Bold, italic, etc.
* Subscripts and Superscripts:: Simple syntax for raising/lowering text.
* Special Symbols:: Greek letters and other symbols.
* Embedded LaTeX:: LaTeX can be freely used inside Org documents.
* Literal Examples:: Source code examples with special formatting.
* Images:: Display an image.
* Captions:: Describe tables, images...
* Horizontal Rules:: Make a line.
2019-12-06 19:15:46 +01:00
* Creating Footnotes:: Edit and read footnotes.
2019-11-26 16:46:24 +01:00
File: org, Node: Paragraphs, Next: Emphasis and Monospace, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.1 Paragraphs
2019-11-26 16:46:24 +01:00
===============
Paragraphs are separated by at least one empty line. If you need to
enforce a line break within a paragraph, use ‘ ’
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 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, Node: Emphasis and Monospace, Next: Subscripts and Superscripts, Prev: Paragraphs, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.2 Emphasis and Monospace
2019-11-26 16:46:24 +01:00
===========================
You can make words ‘ ’ ‘ ’ ‘ ’ ‘ ’
and ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
and verbatim string is not processed for Org specific syntax; it is
2019-11-26 16:46:24 +01:00
exported verbatim.
To turn off fontification for marked up text, you can set
‘ ’ ‘ ’
available markup syntax, you can customize ‘ ’
File: org, Node: Subscripts and Superscripts, Next: Special Symbols, Prev: Emphasis and Monospace, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.3 Subscripts and Superscripts
2019-11-26 16:46:24 +01:00
================================
‘ ’ ‘ ’
readability of ASCII text, it is not necessary, but OK, to surround
multi-character sub- and superscripts with curly braces. 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’
get in your way. Configure the variable ‘ ’
change this convention. For example, when setting this variable to
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
This command formats sub- and superscripts in a WYSIWYM way.
File: org, Node: Special Symbols, Next: Embedded LaTeX, Prev: Subscripts and Superscripts, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.4 Special Symbols
2019-11-26 16:46:24 +01:00
====================
You can use LaTeX-like syntax to insert special symbols—named
entities—like ‘ ’ ‘ ’
indicate an arrow. Completion for these symbols is available, just type
‘ ’ ‘ ’
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 ‘ ’
possible to provide your own special symbols in the variable
‘ ’
During export, these symbols are transformed into the native format
of the exporter back-end. Strings like ‘ ’
‘ ’ ‘ ’
Similarly, ‘ ’ ‘ ’ ‘ ’
If you would like to see entities displayed as UTF-8 characters, use
the following command(1):
‘ ’ ‘ ’
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 ‘ ’
---------- Footnotes ----------
(1) You can turn this on by default by setting the variable
‘ ’ ‘ ’
‘ ’
(2) This behavior can be disabled with ‘ ’
Export Settings::).
File: org, Node: Embedded LaTeX, Next: Literal Examples, Prev: Special Symbols, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.5 Embedded LaTeX
2019-11-26 16:46:24 +01:00
===================
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’
Many of the features described here as “LaTeX” are really from TeX, but
for simplicity I am blurring this distinction.
File: org, Node: LaTeX fragments, Next: Previewing LaTeX fragments, Up: Embedded LaTeX
2019-12-06 19:15:46 +01:00
12.5.1 LaTeX fragments
2019-11-26 16:46:24 +01:00
----------------------
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) (see *note Math formatting in HTML
export::) or transcode the math into images (see *note Previewing LaTeX
fragments::).
LaTeX fragments do not need any special marking at all. The
following snippets are identified as LaTeX source code:
• Environments of any kind(1). The only requirement is that the
‘ ’
whitespace.
• Text within the usual LaTeX math delimiters. To avoid conflicts
with currency specifications, single ‘ ’
recognized as math delimiters if the enclosed text contains at most
two line breaks, is directly attached to the ‘ ’
whitespace in between, and if the closing ‘ ’
whitespace, punctuation or a dash. For the other delimiters, there
is no such restriction, so when in doubt, use ‘ ’
math delimiters.
For example:
\begin{equation} % arbitrary environments,
x=\sqrt{b} % even tables, figures
\end{equation} % etc
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
‘ ’ ‘ ’
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:
‘ ’
‘ ’
‘ ’
---------- Footnotes ----------
(1) When MathJax is used, only the environments recognized by MathJax
are processed. When dvipng, dvisvgm, or ImageMagick suite is used to
create images, any LaTeX environment is handled.
File: org, Node: Previewing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
2019-12-06 19:15:46 +01:00
12.5.2 Previewing LaTeX fragments
2019-11-26 16:46:24 +01:00
---------------------------------
If you have a working LaTeX installation and ‘ ’ ‘ ’
‘ ’
images of the typeset expressions to be used for inclusion while
exporting to HTML (see *note LaTeX fragments::), or for inline
previewing within Org mode.
You can customize the variables ‘ ’
‘ ’
particular, the ‘ ’ ‘ ’
of the former can be used to adjust the size of the preview images.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
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
2019-12-06 19:15:46 +01:00
all fragments in the current entry—between two headlines.
When called with a single prefix argument, clear all images in the
current entry. Two prefix arguments produce a preview image for
all fragments in the buffer, while three of them clear all the
images in that buffer.
2019-11-26 16:46:24 +01:00
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 ‘ ’
File: org, Node: CDLaTeX mode, Prev: Previewing LaTeX fragments, Up: Embedded LaTeX
2019-12-06 19:15:46 +01:00
12.5.3 Using CDLaTeX to enter math
2019-11-26 16:46:24 +01:00
----------------------------------
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 ‘ ’
2019-12-06 19:15:46 +01:00
and ‘ ’
(https://melpa.org/) with the Emacs packaging system
(https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html)
or alternatively from
<https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex/>. Do not use
CDLaTeX mode itself under Org mode, but use the special version Org
CDLaTeX minor mode that comes as part of Org. Turn it on for the
current buffer with ‘ ’
2019-11-26 16:46:24 +01:00
(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):
‘ ’
Insert an environment template.
‘ ’
The ‘ ’
fragment(1). For example, ‘ ’ ‘ ’ ‘ ’
position point correctly inside the first brace. Another ‘ ’
gets you into the second brace.
Even outside fragments, ‘ ’
at the beginning of a line. For example, if you write ‘ ’
beginning of a line and press ‘ ’
expanded to an ‘ ’
abbreviations, type ‘ ’
‘ ’
‘ ’
Pressing ‘ ’ ‘ ’
characters together with a pair of braces. If you use ‘ ’
move out of the braces, and if the braces surround only a single
character or macro, they are removed again (depending on the
variable ‘ ’
‘ ’
Pressing the backquote followed by a character inserts math macros,
also outside LaTeX fragments. If you wait more than 1.5 seconds
after the backquote, a help window pops up.
‘ ’
Pressing the single-quote 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 single-quote, a help window pops up.
Character modification works only inside LaTeX fragments; outside
the quote is normal.
---------- Footnotes ----------
(1) Org mode has a method to test if point is inside such a fragment,
see the documentation of the function ‘ ’
File: org, Node: Literal Examples, Next: Images, Prev: Embedded LaTeX, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.6 Literal Examples
2019-11-26 16:46:24 +01:00
=====================
You can include literal examples that should not be subjected to markup.
Such examples are typeset in monospace, so this is well suited for
source code and similar examples.
#+BEGIN_EXAMPLE
Some example from a text file.
#+END_EXAMPLE
2019-12-06 19:15:46 +01:00
There is one limitation, however. You must insert a comma right
before lines starting with either ‘ ’ ‘ ’ ‘ ’ ‘ ’
be interpreted as outlines nodes or some other special syntax. Org
transparently strips these additional commas whenever it accesses the
contents of the block.
#+BEGIN_EXAMPLE
,* I am no real headline
#+END_EXAMPLE
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:
2019-11-26 16:46:24 +01:00
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 code block, where you also need to specify the name of the
major mode that should be used to fontify the example(2), see *note
Structure 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 ‘ ’ ‘ ’ ‘ ’
the end of the ‘ ’
The ‘ ’
number of the block. If you use a ‘ ’
previous numbered snippet is continued in the current one. The ‘ ’
switch can also take a numeric argument. This adds the value of the
argument to the last line of the previous block to determine the
starting line number.
#+BEGIN_SRC emacs-lisp -n 20
;; This exports with line number 20.
(message "This is line 21")
#+END_SRC
#+BEGIN_SRC emacs-lisp +n 10
;; This is listed as line 31.
(message "This is line 32")
#+END_SRC
In literal examples, Org interprets strings like ‘ ’
labels, and use them as targets for special hyperlinks like
‘ ’
In HTML, hovering the mouse over such a link remote-highlights the
corresponding code line, which is kind of cool.
You can also add a ‘ ’
source code(3). With the ‘ ’
labeled by the line numbers from the code listing. Otherwise links 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.
2019-12-06 19:15:46 +01:00
Source code and examples may be _indented_ in order to align nicely
with the surrounding text, and in particular with plain list structure
(see *note Plain Lists::). By default, Org only retains the relative
indentation between lines, e.g., when exporting the contents of the
block. However, you can use the ‘ ’
indentation, if it does matter. See *note Editing Source Code::.
2019-11-26 16:46:24 +01:00
If the syntax for the label format conflicts with the language
syntax, use a ‘ ’
#+BEGIN_SRC pascal -n -r -l "((%s))"
See also the variable ‘ ’
HTML export also allows examples to be published as text areas (see
*note Text areas in HTML export::).
Because the ‘ ’ ‘ ’
a shortcut is provided (see *note Structure Templates::).
‘ ’ ‘ ’
Edit the source code example at point in its native mode. This
works by switching to a temporary buffer with the source code. You
2019-12-06 19:15:46 +01:00
need to exit by pressing ‘ ’
2019-11-26 16:46:24 +01:00
replaces the old version in the Org buffer. Fixed-width
regions—where each line starts with a colon followed by a space—are
2019-12-06 19:15:46 +01:00
edited using Artist mode(4) to allow creating ASCII drawings
2019-11-26 16:46:24 +01:00
easily. Using this command in an empty line creates a new
fixed-width region.
Calling ‘ ’
source code example in a temporary buffer created with ‘ ’
for a label. Make sure that it is unique in the current buffer, and
insert it with the proper formatting like ‘ ’
the current line. Then the label is stored as a link ‘ ’
retrieval with ‘ ’
---------- Footnotes ----------
(1) This works automatically for the HTML backend (it requires
version 1.34 of the ‘ ’
Fontified code chunks in LaTeX can be achieved using either the listings
(https://www.ctan.org/pkg/listings) package or the minted
(https://www.ctan.org/pkg/minted) package. Refer to
‘ ’
(2) Source code in code blocks may also be evaluated either
interactively or on export. See *note Working with Source Code:: for
more information on evaluating code blocks.
(3) Adding ‘ ’ ‘ ’
while using line numbers for the links, which might be useful to explain
those in an Org mode example code.
2019-12-06 19:15:46 +01:00
(4) You may select a different mode with the variable
2019-11-26 16:46:24 +01:00
‘ ’
File: org, Node: Images, Next: Captions, Prev: Literal Examples, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.7 Images
2019-11-26 16:46:24 +01:00
===========
An image is a link to an image file(1) that does not have a description
part, for example
./img/cat.jpg
If you wish to define a caption for the image (see *note Captions::)
and maybe a label for internal cross references (see *note Internal
Links::), make sure that the link is on a line by itself and precede it
with ‘ ’ ‘ ’
#+CAPTION: This is the caption for the next figure link (or table)
#+NAME: fig:SED-HR4049
[[./img/a.jpg]]
2019-12-06 19:15:46 +01:00
Such images can be displayed within the buffer with the following
2019-11-26 16:46:24 +01:00
command:
‘ ’ ‘ ’
Toggle the inline display of linked images. 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
‘ ’
---------- Footnotes ----------
(1) What Emacs considers to be an image depends on
‘ ’ ‘ ’
(2) The variable ‘ ’
buffer with the ‘ ’ ‘ ’ ‘ ’
File: org, Node: Captions, Next: Horizontal Rules, Prev: Images, Up: Markup for Rich Contents
2019-12-06 19:15:46 +01:00
12.8 Captions
2019-11-26 16:46:24 +01:00
=============
You can assign a caption to a specific part of a document by inserting a
‘ ’
#+CAPTION: This is the caption for the next table (or link)
| ... | ... |
|-----+-----|
Optionally, the caption can take the form:
#+CAPTION[Short caption]: Longer caption.
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.
2019-12-06 19:15:46 +01:00
File: org, Node: Horizontal Rules, Next: Creating Footnotes, Prev: Captions, Up: Markup for Rich Contents
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
12.9 Horizontal Rules
2019-11-26 16:46:24 +01:00
=====================
A line consisting of only dashes, and at least 5 of them, is exported as
a horizontal line.
2019-12-06 19:15:46 +01:00
File: org, Node: Creating Footnotes, Prev: Horizontal Rules, Up: Markup for Rich Contents
12.10 Creating 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 ‘ ’
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:
‘ ’
A named footnote reference, where NAME is a unique label word, or,
for simplicity of automatic creation, a number.
‘ ’
An anonymous footnote where the definition is given directly at the
reference point.
‘ ’
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 ‘ ’
Footnote labels can be created automatically, or you can create names
yourself. This is handled by the variable ‘ ’
its corresponding ‘ ’
variable for details.
The following command handles footnotes:
‘ ’
The footnote action command.
When point 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 variable
‘ ’
into the text as part of the reference, or separately into the
location determined by the variable ‘ ’
When this command is called with a prefix argument, a menu of
additional options is offered:
‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’
references.
Depending on the variable ‘ ’
renumbering and sorting footnotes can be automatic after each
insertion or deletion.
‘ ’
If point is on a footnote reference, jump to the definition. If it
is at the definition, jump back to the reference. When called at a
footnote location with a prefix argument, offer the same menu as
‘ ’
‘ ’ ‘ ’
Footnote labels are also links to the corresponding definition or
reference, and you can use the usual commands to follow these
links.
---------- Footnotes ----------
(1) The corresponding in-buffer setting is: ‘ ’
‘ ’
(2) The corresponding in-buffer options are ‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: Exporting, Next: Publishing, Prev: Markup for Rich Contents, Up: Top
2019-12-06 19:15:46 +01:00
13 Exporting
2019-11-26 16:46:24 +01:00
************
At some point you might want to print your notes, publish them on the
web, or share them with people not using Org. Org can convert and
export documents to a variety of other formats while retaining as much
structure (see *note Document Structure::) and markup (see *note Markup
for Rich Contents::) as possible.
The libraries responsible for translating Org files to other formats
are called _back-ends_. Org ships with support for the following
back-ends:
• _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)
Users can install libraries for additional formats from the Emacs
packaging system. For easy discovery, these packages have a common
naming scheme: ‘ ’
‘ ’
found in the ‘ ’
Org only loads back-ends for the following formats by default: ASCII,
HTML, iCalendar, LaTeX, and ODT. Additional back-ends can be loaded in
either of two ways: by configuring the ‘ ’
or by requiring libraries in the Emacs init file. For example, to load
the Markdown back-end, add this to your Emacs config:
(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.
2019-12-06 19:15:46 +01:00
* Beamer Export:: Producing presentations and slides.
2019-11-26 16:46:24 +01:00
* 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 Export Configuration:: Fine-tuning the export output.
* Export in Foreign Buffers:: Author tables and lists in Org syntax.
File: org, Node: The Export Dispatcher, Next: Export Settings, Up: Exporting
2019-12-06 19:15:46 +01:00
13.1 The Export Dispatcher
2019-11-26 16:46:24 +01:00
==========================
The export dispatcher is the main interface for Org’
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 ‘ ’
non-‘ ’
hierarchical menu, press ‘ ’
‘ ’ ‘ ’
Invokes the export dispatcher interface. The options show default
settings. 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.
Within the dispatcher interface, the following key combinations can
further alter what is exported, and how.
‘ ’
Toggle asynchronous export. Asynchronous export uses an external
Emacs process with a specially configured initialization file to
complete the exporting process in the background, without tying-up
Emacs. This is particularly useful when exporting long documents.
Output from an asynchronous export is saved on the _export stack_.
To view this stack, call the export dispatcher with a double ‘ ’
prefix argument. If already in the export dispatcher menu, ‘ ’
displays the stack.
You can make asynchronous export the default by setting
‘ ’
You can set the initialization file used by the background process
by setting ‘ ’
‘ ’
Toggle body-only export. Useful for excluding headers and footers
in the export. Affects only those back-end formats that have
sections like ‘ ’
‘ ’
Toggle sub-tree export. When turned on, Org exports only the
sub-tree starting from point position at the time the export
dispatcher was invoked. Org uses the top heading of this sub-tree
as the document’
the nearest enclosing header. If point is in the document
preamble, Org signals an error and aborts export.
To make sub-tree export the default, customize the variable
‘ ’
‘ ’
Toggle visible-only export. This is useful for exporting only
certain parts of an Org document by adjusting the visibility of
particular headings.
File: org, Node: Export Settings, Next: Table of Contents, Prev: The Export Dispatcher, Up: Exporting
2019-12-06 19:15:46 +01:00
13.2 Export Settings
2019-11-26 16:46:24 +01:00
====================
Export options can be set: globally with variables; for an individual
file by making variables buffer-local with in-buffer settings (see *note
In-buffer Settings::); by setting individual keywords or specifying them
in compact form with the ‘ ’
properties (see *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 ‘
URL’
be inserted from the export dispatcher (see *note The Export
Dispatcher::) using the ‘ ’ ‘ ’
insert keywords individually, a good way to make sure the keyword is
correct is to type ‘ ’ ‘ ’
The export keywords available for every back-end, and their
equivalent global variables, include:
‘ ’
The document author (‘ ’
‘ ’
Entity responsible for output generation
(‘ ’
‘ ’
A date or a time-stamp(2).
‘ ’
The email address (‘ ’
‘ ’
Language to use for translating certain strings
(‘ ’ ‘ ’
example, Org translates ‘ ’ ‘
des matières’
‘ ’
The default value is ‘ ’
‘ ’ ‘ ’
sub-trees for export. Org excludes trees with ‘ ’
below. When selectively exporting files with ‘ ’
Org does not export any text that appears before the first
headline.
‘ ’
The default value is ‘ ’
‘ ’ ‘ ’
its sub-trees from export. Entries tagged with ‘ ’
unconditionally excluded from the export, even if they have an
‘ ’
code blocks contained there.
‘ ’
Org displays this title. For long titles, use multiple ‘ ’
lines.
‘ ’
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, use several ‘ ’ ‘ ’
following arguments.
‘ ’
Toggle smart quotes (‘ ’
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 (‘ ’
‘ ’
Toggle conversion of special strings
(‘ ’
‘ ’
Toggle fixed-width sections (‘ ’
‘ ’
Toggle inclusion of time/date active/inactive stamps
(‘ ’
‘ ’
Toggles whether to preserve line breaks
(‘ ’
‘ ’
Toggle TeX-like syntax for sub- and superscripts. If you write
‘ ’ ‘ ’ ‘ ’
is (‘ ’
‘ ’
Configure how archived trees are exported. When set to ‘ ’
the export process skips the contents and processes only the
headlines (‘ ’
‘ ’
Toggle inclusion of author name into exported file
(‘ ’
‘ ’
Toggles if Org should continue exporting upon finding a broken
internal link. When set to ‘ ’
link in the output (‘ ’
‘ ’
2019-12-06 19:15:46 +01:00
Toggle inclusion of ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’
Toggle inclusion of creator information in the exported file
(‘ ’
‘ ’
Toggles inclusion of drawers, or list of drawers to include, or
list of drawers to exclude (‘ ’
‘ ’
Toggle inclusion of a date into exported file
(‘ ’
‘ ’
Toggle inclusion of entities (‘ ’
‘ ’
Toggle inclusion of the author’
(‘ ’
‘ ’
Toggle the inclusion of footnotes (‘ ’
‘ ’
Set the number of headline levels for export
(‘ ’
treated differently. In most back-ends, they become list items.
‘ ’
Toggle inclusion of inlinetasks (‘ ’
‘ ’
Toggle section-numbers (‘ ’
set to number N, Org numbers only those headlines at level N or
above. Set ‘ ’ ‘ ’
of heading and subheadings entirely. Moreover, when the value is
‘ ’
table of contents either (see *note Table of Contents::).
‘ ’
Toggle export of planning information (‘ ’
“Planning information” comes from lines located right after the
headline and contain any combination of these cookies: ‘ ’
‘ ’ ‘ ’
‘ ’
Toggle inclusion of priority cookies (‘ ’
‘ ’
Toggle inclusion of property drawers, or list the properties to
include (‘ ’
‘ ’
Toggle inclusion of statistics cookies
(‘ ’
‘ ’
Toggle inclusion of tags, may also be ‘ ’
(‘ ’
‘ ’
Toggle inclusion of tasks (TODO items); or ‘ ’
2019-12-06 19:15:46 +01:00
tasks; or ‘ ’
2019-11-26 16:46:24 +01:00
(‘ ’
‘ ’
‘ ’ ‘ ’ ‘ ’
verbatim (‘ ’
‘ ’
Toggle inclusion of the creation time in the exported file
(‘ ’
‘ ’
Toggle inclusion of title (‘ ’
‘ ’
Toggle inclusion of the table of contents, or set the level limit
(‘ ’
‘ ’
Toggle inclusion of TODO keywords into exported text
(‘ ’
‘ ’
Toggle inclusion of tables (‘ ’
When exporting sub-trees, special node properties can override the
above keywords. These properties have an ‘ ’
example, ‘ ’ ‘ ’
sub-tree. Except for ‘ ’
an ‘ ’
If ‘ ’ ‘ ’
become buffer-local during export by using the ‘ ’
syntax is ‘ ’
in-buffer settings that cannot be changed using keywords.
---------- Footnotes ----------
(1) Many desktops intercept ‘ ’ ‘ ’
or ‘ ’
(2) The variable ‘ ’
timestamp are exported.
(3) For export to LaTeX format—or LaTeX-related formats such as
Beamer—, the ‘ ’
configuration. See *note LaTeX specific export settings::.
File: org, Node: Table of Contents, Next: Include Files, Prev: Export Settings, Up: Exporting
2019-12-06 19:15:46 +01:00
13.3 Table of Contents
2019-11-26 16:46:24 +01:00
======================
The table of contents includes all headlines in the document. Its depth
is therefore the same as the headline levels in the file. If you need
to use a different depth, or turn it off entirely, set the
‘ ’
a per file basis, using the following ‘ ’ ‘ ’
#+OPTIONS: toc:2 (only include two levels in TOC)
#+OPTIONS: toc:nil (no default TOC at all)
Org includes both numbered and unnumbered headlines in the table of
contents(1). If you need to exclude an unnumbered headline, along with
all its children, set the ‘ ’ ‘ ’
* Subtree not numbered, not in table of contents either
:PROPERTIES:
:UNNUMBERED: notoc
:END:
Org normally inserts the table of contents directly before the first
headline of the file. To move the table of contents to a different
location, first turn off the default with ‘ ’
or with ‘ ’ ‘ ’
desired location(s).
#+OPTIONS: toc:nil
...
#+TOC: headlines 2
To adjust the table of contents depth for a specific section of the
Org document, append an additional ‘ ’
becomes a relative depth for the current level. The following example
inserts a local table of contents, with direct children only.
* Section
#+TOC: headlines 1 local
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 ‘ ’
2019-12-06 19:15:46 +01:00
The following example inserts a table of contents that links to the
children of the specified target.
* Target
:PROPERTIES:
:CUSTOM_ID: TargetSection
:END:
** Heading A
** Heading B
* Another section
#+TOC: headlines 1 :target #TargetSection
The ‘ ’
ASCII export.
2019-11-26 16:46:24 +01:00
Use the ‘ ’
listings—with captions.
#+TOC: listings
#+TOC: tables
Normally Org uses the headline for its entry in the table of
contents. But with ‘ ’
specified for the table of contents.
---------- Footnotes ----------
(1) At the moment, some export back-ends do not obey this
specification. For example, LaTeX export excludes every unnumbered
headline from the table of contents.
File: org, Node: Include Files, Next: Macro Replacement, Prev: Table of Contents, Up: Exporting
2019-12-06 19:15:46 +01:00
13.4 Include Files
2019-11-26 16:46:24 +01:00
==================
During export, you can include the content of another file. For
example, to include your ‘ ’
#+INCLUDE: "~/.emacs" src emacs-lisp
The first parameter is the file name to include. The optional second
parameter specifies the block type: ‘ ’ ‘ ’ ‘ ’
optional third parameter specifies the source code language to use for
formatting the contents. This is relevant to both ‘ ’ ‘ ’
block types.
If an included file is specified as having a markup language, Org
neither checks for valid syntax nor changes the contents in any way.
For example and source blocks, Org code-escapes the contents before
inclusion.
If an included 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 (see *note Creating
Footnotes::) in the included file local to that file. The contents of
the included file belong to the same structure—headline, item—containing
the ‘ ’
children of the current section. That behavior can be changed by
providing an additional keyword parameter, ‘ ’
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 ‘ ’
will not be included. The start and/or the end of the range may be
omitted to use the obvious defaults.
‘ ’
‘ ’
‘ ’
Inclusions may specify a file-link to extract an object matched by
‘ ’
‘ ’
#+INCLUDE: "./paper.org::*conclusion" :lines 1-20
includes the first 20 lines of the headline named ‘ ’
To extract only the contents of the matched object, set
‘ ’ ‘ ’
or property drawers. For example, to include the body of the heading
with the custom ID ‘ ’
#+INCLUDE: "./paper.org::#theory" :only-contents t
2019-12-06 19:15:46 +01:00
The following command allows navigating to the included document:
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
Visit the included file at point.
---------- Footnotes ----------
(1) Note that ‘ ’
bound to non-‘ ’ ‘ ’
and named elements.
File: org, Node: Macro Replacement, Next: Comment Lines, Prev: Include Files, Up: Exporting
2019-12-06 19:15:46 +01:00
13.5 Macro Replacement
2019-11-26 16:46:24 +01:00
======================
Macros replace text snippets during export. Macros are defined globally
in ‘ ’
syntax:
#+MACRO: name replacement text; $1, $2 are arguments
which can be referenced using ‘ ’
#+MACRO: poem Rose is $1, violet's $2. Life's ordered: Org assists you.
{{{poem(red,blue)}}}
becomes
Rose is red, violet's blue. Life's ordered: Org assists you.
As a special case, Org parses any replacement text starting with
‘ ’
Within such templates, arguments become strings. Thus, the following
macro
#+MACRO: gnustamp (eval (concat "GNU/" (capitalize $1)))
turns ‘ ’ ‘ ’
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 ‘ ’ ‘ ’
‘ ’ ‘ ’
Org comes with following pre-defined macros:
‘ ’
‘ ’
‘ ’
‘ ’
The ‘ ’
throughout the buffer, separated with white space. ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
This macro refers to the ‘ ’
argument to the ‘ ’ ‘ ’
single timestamp. FORMAT should be a format string understood by
‘ ’
‘ ’
‘ ’
These macros refer to the document’
date and time of modification. FORMAT is a string understood by
‘ ’
‘ ’ ‘ ’ ‘ ’
retrieve the document’
system. Otherwise Org reads the file attributes.
‘ ’
This macro refers to the filename of the exported file.
‘ ’
‘ ’
This macro returns the value of property PROPERTY-NAME in the
current entry. If SEARCH-OPTION (see *note Search Options::)
refers to a remote entry, use it instead.
‘ ’
‘ ’
‘ ’
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 ‘ ’
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.
Moreover, inline source blocks (see *note Structure of Code Blocks::)
use the special ‘ ’
advised against re-defining it, unless you know what you are doing.
The surrounding brackets can be made invisible by setting
‘ ’ ‘ ’
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, Node: Comment Lines, Next: ASCII/Latin-1/UTF-8 export, Prev: Macro Replacement, Up: Exporting
2019-12-06 19:15:46 +01:00
13.6 Comment Lines
2019-11-26 16:46:24 +01:00
==================
Lines starting with zero or more whitespace characters followed by one
‘ ’
exported.
Likewise, regions surrounded by ‘ ’ ‘ ’
are not exported.
Finally, a ‘ ’
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.
‘ ’ ‘ ’
Toggle the ‘ ’
---------- Footnotes ----------
(1) For a less drastic behavior, consider using a select tag (see
*note Export Settings::) instead.
File: org, Node: ASCII/Latin-1/UTF-8 export, Next: Beamer Export, Prev: Comment Lines, Up: Exporting
2019-12-06 19:15:46 +01:00
13.7 ASCII/Latin-1/UTF-8 export
2019-11-26 16:46:24 +01:00
===============================
ASCII export produces an output file containing only plain ASCII
characters. This is the simplest and most direct text output. It does
not contain any Org markup. 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 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 ‘ ’
ASCII export commands
---------------------
‘ ’ ‘ ’
‘ ’
‘ ’
Export as an ASCII file with a ‘ ’ ‘ ’
Org exports to ‘ ’
‘ ’ ‘ ’
data loss.
‘ ’ ‘ ’
‘ ’
‘ ’
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 (see
*note Export Settings::).
‘ ’
The document subtitle. For long subtitles, use multiple
‘ ’
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, see *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, ‘ ’
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 ‘ ’
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, Node: Beamer Export, Next: HTML Export, Prev: ASCII/Latin-1/UTF-8 export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.8 Beamer Export
2019-11-26 16:46:24 +01:00
==================
Org uses Beamer export to convert an Org file tree structure into
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.
* Frames and Blocks in Beamer:: For composing Beamer slides.
* Beamer specific syntax:: For using in Org documents.
* Editing support:: Editing support.
* A Beamer example:: A complete presentation.
File: org, Node: Beamer export commands, Next: Beamer specific export settings, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.1 Beamer export commands
2019-11-26 16:46:24 +01:00
-----------------------------
‘ ’ ‘ ’
Export as LaTeX file with a ‘ ’ ‘ ’
Org exports to ‘ ’
‘ ’ ‘ ’
Export to a temporary buffer. Does not create a file.
‘ ’ ‘ ’
Export as LaTeX file and then convert it to PDF format.
‘ ’
Export as LaTeX file, convert it to PDF format, and then open the
PDF file.
File: org, Node: Beamer specific export settings, Next: Frames and Blocks in Beamer, Prev: Beamer export commands, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.2 Beamer specific export settings
2019-11-26 16:46:24 +01:00
--------------------------------------
Beamer export back-end has several additional keywords for customizing
Beamer output. These keywords work similar to the general options
settings (see *note Export Settings::).
‘ ’
The Beamer layout theme (‘ ’
for options. For example:
#+BEAMER_THEME: Rochester [height=20pt]
‘ ’
The Beamer font theme.
‘ ’
The Beamer inner theme.
‘ ’
The Beamer outer theme.
‘ ’
Arbitrary lines inserted in the preamble, just before the
‘ ’
‘ ’
The document description. For long descriptions, use multiple
‘ ’ ‘ ’
‘ ’ ‘ ’
configure document metadata. Use ‘ ’
configure typesetting of description as part of front matter.
‘ ’
The keywords for defining the contents of the document. Use
multiple ‘ ’ ‘ ’
inserts ‘ ’ ‘ ’
to configure document metadata. Use ‘ ’
configure typesetting of keywords as part of front matter.
‘ ’
Document’
‘ ’
‘ ’
‘ ’
part of front matter.
File: org, Node: Frames and Blocks in Beamer, Next: Beamer specific syntax, Prev: Beamer specific export settings, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.3 Frames and Blocks in Beamer
2019-11-26 16:46:24 +01:00
----------------------------------
Org transforms heading levels into Beamer’
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 ‘ ’ ‘ ’ ‘ ’
(see *note Export Settings::).
Org overrides headlines to frames conversion for the current tree
of an Org file if it encounters the ‘ ’
‘ ’ ‘ ’
‘ ’
the Org tree. In Beamer terminology, a full frame is a frame
without its title.
• Org exports a Beamer frame’
can enforce wrapping in special block types when ‘ ’
property is set(1). For valid values see
‘ ’
‘ ’
• If ‘ ’ ‘ ’
appendix. When set to ‘ ’
within the frame or between frames, depending on the entry’
heading level. When set to ‘ ’
note without its title. When set to ‘ ’
entry with ‘ ’
‘ ’ ‘ ’
to resume.
When ‘ ’ ’
headline but not its content. This is useful for inserting content
between frames. It is also useful for properly closing a ‘ ’
environment. @end itemize
When ‘ ’
headline as an overlay or action specification. When enclosed in
square brackets, Org export makes the overlay specification a
default. Use ‘ ’
current Beamer frame or block. The Beamer export back-end wraps
with appropriate angular or square brackets. It also adds the
‘ ’
To create a column on the Beamer slide, use the ‘ ’
property for its headline in the Org file. Set the value of
‘ ’
total text width. Beamer export uses this value to set the
column’
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 ‘ ’
---------- Footnotes ----------
(1) If ‘ ’ ‘ ’
make it visible. The tag serves as a visual aid and has no semantic
relevance.
File: org, Node: Beamer specific syntax, Next: Editing support, Prev: Frames and Blocks in Beamer, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.4 Beamer specific syntax
2019-11-26 16:46:24 +01:00
-----------------------------
Since Org’
back-end, it recognizes other LaTeX specific syntax—for example,
‘ ’ ‘ ’
Beamer export wraps the table of contents generated with ‘ ’
‘ ’ ‘ ’
the table of contents generated with ‘ ’
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 exports this.
#+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 ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
brackets and place the specification at the beginning of the object as
shown in this example:
A *@@beamer:<2->@@useful* feature
Beamer export recognizes the ‘ ’
attributes from Beamer configurations: ‘ ’
Beamer environment, ‘ ’
or square brackets, and ‘ ’
#+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, Node: Editing support, Next: A Beamer example, Prev: Beamer specific syntax, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.5 Editing support
2019-11-26 16:46:24 +01:00
----------------------
2019-12-06 19:15:46 +01:00
Org Beamer mode is a special minor mode for faster editing of Beamer
documents.
2019-11-26 16:46:24 +01:00
#+STARTUP: beamer
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
Org Beamer mode provides this key for quicker selections in Beamer
normal environments, and for selecting the ‘ ’
2019-11-26 16:46:24 +01:00
File: org, Node: A Beamer example, Prev: Editing support, Up: Beamer Export
2019-12-06 19:15:46 +01:00
13.8.6 A Beamer example
2019-11-26 16:46:24 +01:00
-----------------------
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)
* 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, Node: HTML Export, Next: LaTeX Export, Prev: Beamer Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.9 HTML Export
2019-11-26 16:46:24 +01:00
================
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.
2019-12-06 19:15:46 +01:00
* Headlines in HTML export:: Formatting headlines.
2019-11-26 16:46:24 +01:00
* Links in HTML export:: Inserting and formatting links.
* Tables in HTML export:: How to modify the formatting of tables.
* Images in HTML export:: How to insert figures into HTML output.
* Math formatting in HTML export:: Beautiful math also on the web.
* Text areas in HTML export:: An alternate way to show an example.
* CSS support:: Changing the appearance of the output.
* JavaScript support:: Info and folding in a web browser.
File: org, Node: HTML export commands, Next: HTML specific export settings, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.1 HTML export commands
2019-11-26 16:46:24 +01:00
---------------------------
‘ ’ ‘ ’
Export as HTML file with a ‘ ’ ‘ ’
Org exports to ‘ ’
{{{kbd{C-c C-e h o)}}} exports to HTML and opens it in a web
browser.
‘ ’ ‘ ’
Exports to a temporary buffer. Does not create a file.
File: org, Node: HTML specific export settings, Next: HTML doctypes, Prev: HTML export commands, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.2 HTML specific export settings
2019-11-26 16:46:24 +01:00
------------------------------------
HTML export has a number of keywords, similar to the general options
settings described in *note Export Settings::.
‘ ’
This is the document’
it as a HTML meta tag in the HTML file. For long descriptions, use
multiple ‘ ’
the lines properly.
‘ ’
Specify the document type, for example: HTML5 (‘ ’
‘ ’
Specify the HTML container, such as ‘ ’
and elements (‘ ’
‘ ’
The URL for home link (‘ ’
‘ ’
The URL for the up link of exported HTML pages
(‘ ’
‘ ’
Options for MathJax (‘ ’
to typeset LaTeX math in HTML documents. See *note Math formatting
in HTML export::, for an example.
‘ ’
Arbitrary lines for appending to the HTML document’
(‘ ’
‘ ’
More arbitrary lines for appending to the HTML document’
(‘ ’
‘ ’
Keywords to describe the document’
these keywords as HTML meta tags. For long keywords, use multiple
‘ ’
‘ ’
Arbitrary lines for appending to the preamble; HTML exporter
appends when transcoding LaTeX fragments to images (see *note Math
formatting in HTML export::).
‘ ’
The document’
document type is ‘ ’ ‘ ’
Some of these keywords are explained in more detail in the following
sections of the manual.
File: org, Node: HTML doctypes, Next: HTML preamble and postamble, Prev: HTML specific export settings, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.3 HTML doctypes
2019-11-26 16:46:24 +01:00
--------------------
Org can export to various (X)HTML flavors.
Set the ‘ ’
Depending on the variant, the HTML exporter adjusts the syntax of HTML
conversion accordingly. Org includes the following ready-made variants:
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
• ‘ ’
See the variable ‘ ’
‘ ’
Org’
introduced with the HTML5 standard. To enable them, set
‘ ’ ‘ ’ ‘ ’
file to set ‘ ’
HTML5 documents can now have arbitrary ‘ ’ ‘ ’
For example:
#+BEGIN_aside
Lorem ipsum
#+END_aside
exports 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
‘ ’ ‘ ’
to ‘ ’
Special blocks cannot have headlines. For the HTML exporter to wrap
the headline and its contents in ‘ ’ ‘ ’
the ‘ ’
File: org, Node: HTML preamble and postamble, Next: Quoting HTML tags, Prev: HTML doctypes, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.4 HTML preamble and postamble
2019-11-26 16:46:24 +01:00
----------------------------------
The HTML exporter has delineations for preamble and postamble. The
default value for ‘ ’ ‘ ’
exporter insert the preamble. See the variable
‘ ’
Set ‘ ’
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 does not insert a
preamble if ‘ ’ ‘ ’
The default value for ‘ ’ ‘ ’
HTML exporter build a postamble from looking up author’
address, creator’ ‘ ’ ‘ ’
insert the postamble in the format specified in the
‘ ’
a postamble if ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
File: org, Node: Quoting HTML tags, Next: Headlines in HTML export, Prev: HTML preamble and postamble, Up: HTML Export
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
13.9.5 Quoting HTML tags
2019-11-26 16:46:24 +01:00
------------------------
The HTML export back-end transforms ‘ ’ ‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
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:
2019-11-26 16:46:24 +01:00
‘ ’
@@html:<b>@@bold text@@html:</b>@@
For larger raw HTML code blocks, use these HTML export code blocks:
#+HTML: Literal HTML code for export
#+BEGIN_EXPORT html
All lines between these markers are exported literally
#+END_EXPORT
2019-12-06 19:15:46 +01:00
File: org, Node: Headlines in HTML export, Next: Links in HTML export, Prev: Quoting HTML tags, Up: HTML Export
13.9.6 Headlines in HTML export
-------------------------------
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Headlines are exported to ‘ ’ ‘ ’
‘ ’ ‘ ’
see *note Internal Links::.
When ‘ ’ ‘ ’
text of the headlines is also wrapped in ‘ ’
‘ ’
File: org, Node: Links in HTML export, Next: Tables in HTML export, Prev: Headlines in HTML export, Up: HTML Export
13.9.7 Links in HTML export
2019-11-26 16:46:24 +01:00
---------------------------
The HTML export back-end transforms Org’
Internal Links::) to equivalent HTML links in the output. The back-end
similarly handles Org’
*note Radio Targets::) similarly. For Org links to external files, the
back-end transforms the links to _relative_ paths.
For Org links to other ‘ ’
changes the file extension to ‘ ’
the ‘ ’ ‘ ’
location, then the converted links should work without any further
manual intervention. However, to disable this automatic path
translation, set ‘ ’ ‘ ’
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, see *note Publishing links::.
Org files can also have special directives to the HTML export
back-end. For example, by using ‘ ’
format attributes to ‘ ’ ‘ ’
the link’
#+ATTR_HTML: :title The Org mode homepage :style color:red;
[[https://orgmode.org]]
File: org, Node: Tables in HTML export, Next: Images in HTML export, Prev: Links in HTML export, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.8 Tables in HTML export
2019-11-26 16:46:24 +01:00
----------------------------
The HTML export back-end uses ‘ ’
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
(see *note Column Groups::) when exporting to HTML.
Additional options for customizing tables for HTML export.
‘ ’
Non-‘ ’
field.
‘ ’
Non-‘ ’
‘ ’
Opening and ending tags for table data fields.
‘ ’
Default attributes and values for table tags.
‘ ’
Opening and ending tags for table’
‘ ’
Opening and ending tags for table rows.
‘ ’
Non-‘ ’
File: org, Node: Images in HTML export, Next: Math formatting in HTML export, Prev: Tables in HTML export, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.9 Images in HTML export
2019-11-26 16:46:24 +01:00
----------------------------
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:
‘ ’ ‘ ’
links to the text, ‘ ’
‘ ’
On the other hand, if the description part of the Org link is itself
another link, such as ‘ ’ ‘ ’
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 ‘ ’
the Org file. This example shows realignment to right, and adds ‘ ’
and ‘ ’
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 ‘ ’
as-is.
File: org, Node: Math formatting in HTML export, Next: Text areas in HTML export, Prev: Images in HTML export, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.10 Math formatting in HTML export
--------------------------------------
2019-11-26 16:46:24 +01:00
LaTeX math snippets (see *note LaTeX fragments::) can be displayed in
two different ways on HTML pages. The default is to use the MathJax
(http://www.mathjax.org), which should work out of the box with
Org(1)(2). Some MathJax display options can be configured via
‘ ’
following settings,
#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
#+HTML_MATHJAX: cancel.js noErrors.js
equation labels are displayed on the left margin and equations are five
em from the left margin. In addition, it loads the two MathJax
extensions ‘ ’ ‘ ’
See the docstring of ‘ ’
variables. The MathJax template can be configure via
‘ ’
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).
(2) Please note that exported formulas are part of an HTML document,
and that signs such as ‘ ’ ‘ ’ ‘ ’
MathJax TeX and LaTeX support
(http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents).
(3) See TeX and LaTeX extensions
(http://docs.mathjax.org/en/latest/tex.html#tex-extensions) in the
MathJax manual (http://docs.mathjax.org) to learn about extensions.
File: org, Node: Text areas in HTML export, Next: CSS support, Prev: Math formatting in HTML export, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.11 Text areas in HTML export
2019-11-26 16:46:24 +01:00
---------------------------------
Before Org mode’
was by using ‘ ’
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
‘ ’ ‘ ’
option. This must be followed by either an example or a source code
block. Other Org block types do not honor the ‘ ’
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 ‘ ’ ‘ ’ ‘ ’
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, Node: CSS support, Next: JavaScript support, Prev: Text areas in HTML export, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.12 CSS support
2019-11-26 16:46:24 +01:00
-------------------
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.
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’
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
‘ ’
in the Org file.
#+OPTIONS: html-style:nil
For longer style definitions, either use several ‘ ’
‘ ’ ‘ ’
them. Both of these approaches can avoid referring to an external file.
In order to add styles to a sub-tree, use the ‘ ’
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 ‘ ’
2019-12-06 19:15:46 +01:00
property. You can also assign a specific class to a headline with the
‘ ’
2019-11-26 16:46:24 +01:00
Never change the ‘ ’
other simpler ways of customizing as described above.
---------- Footnotes ----------
(1) If the classes on TODO keywords and tags lead to conflicts, use
the variables ‘ ’
‘ ’
File: org, Node: JavaScript support, Prev: CSS support, Up: HTML Export
2019-12-06 19:15:46 +01:00
13.9.13 JavaScript supported display of web pages
2019-11-26 16:46:24 +01:00
-------------------------------------------------
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 ‘ ’ ‘ ’
well, press ‘ ’
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:
‘ ’
The path to the script. The default is to grab the script from
<https://orgmode.org/org-info.js>, but you might want to have a
local copy and use a path like ‘ ’
‘ ’
Initial view when the website is first shown. Possible values are:
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
Maximum headline level still considered as an independent section
for info and folding modes. The default is taken from
‘ ’ ‘ ’ ‘ ’
If this is smaller than in ‘ ’
info/folding section can still contain child headlines.
‘ ’
Should the table of contents _initially_ be visible? Even when
‘ ’ ‘ ’
‘ ’
The depth of the table of contents. The defaults are taken from
the variables ‘ ’
‘ ’
‘ ’
Does the CSS of the page specify a fixed position for the “toc”?
If yes, the toc is displayed as a section.
‘ ’
Should there be short contents (children) in each section? Make
this ‘ ’
‘ ’
Headings are highlighted when the mouse is over them. Should be
‘ ’ ‘ ’
‘ ’
Should view-toggle buttons be everywhere? When ‘ ’
default), only one such button is present.
You can choose default values for these options by customizing the
variable ‘ ’
to your pages, configure the variable ‘ ’
File: org, Node: LaTeX Export, Next: Markdown Export, Prev: HTML Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.10 LaTeX Export
2019-11-26 16:46:24 +01:00
==================
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
‘ ’ ‘ ’
for packages, see ‘ ’
‘ ’
An important note about the LaTeX export back-end: it is sensitive to
blank lines in the Org document. That’
blank lines to tell apart syntactical elements, such as paragraphs.
* Menu:
* LaTeX/PDF export commands:: For producing LaTeX and PDF documents.
* LaTeX specific export settings:: Unique to this LaTeX back-end.
* LaTeX header and sectioning:: Setting up the export file structure.
* Quoting LaTeX code:: Incorporating literal LaTeX code.
* Tables in LaTeX export:: Options for exporting tables to LaTeX.
* Images in LaTeX export:: How to insert figures into LaTeX output.
* 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, Node: LaTeX/PDF export commands, Next: LaTeX specific export settings, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.1 LaTeX/PDF export commands
2019-11-26 16:46:24 +01:00
---------------------------------
‘ ’ ‘ ’
Export to a LaTeX file with a ‘ ’ ‘ ’
Org exports to ‘ ’
‘ ’ ‘ ’
Export to a temporary buffer. Do not create a file.
‘ ’ ‘ ’
Export as LaTeX file and convert it to PDF file.
‘ ’
Export as LaTeX file and convert it to PDF, then open the PDF using
the default viewer.
‘ ’
Convert the region to LaTeX under the assumption that it was in Org
mode syntax before. This is a global command that can be invoked
in any buffer.
The LaTeX export back-end can use any of these LaTeX engines:
‘ ’ ‘ ’ ‘ ’
files with different compilers, packages, and output options. The LaTeX
export back-end finds the compiler version to use from
‘ ’ ‘ ’
Org file. See the docstring for the ‘ ’
for loading packages with certain compilers. Also see
‘ ’
---------- 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, Node: LaTeX specific export settings, Next: LaTeX header and sectioning, Prev: LaTeX/PDF export commands, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.2 LaTeX specific export settings
2019-11-26 16:46:24 +01:00
--------------------------------------
The LaTeX export back-end has several additional keywords for
customizing LaTeX output. Setting these keywords works similar to the
general options (see *note Export Settings::).
‘ ’
The document’
name, keywords, and related file metadata are inserted in the
output file by the hyperref package. See
‘ ’
‘ ’
document’ ‘ ’
long descriptions.
‘ ’
In order to be effective, the ‘ ’ ‘ ’
packages—according to the LaTeX compiler used—must be loaded with
the appropriate language as argument. This can be accomplished by
modifying the ‘ ’
following snippet:
(add-to-list 'org-latex-packages-alist
'("AUTO" "babel" t ("pdflatex")))
(add-to-list 'org-latex-packages-alist
'("AUTO" "polyglossia" t ("xelatex" "lualatex")))
‘ ’
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 has _article_ as the default class. A valid default class must
be an element of ‘ ’
‘ ’
Options the LaTeX export back-end uses when calling the LaTeX
document class.
‘ ’
The compiler, such as ‘ ’ ‘ ’ ‘ ’
producing the PDF. See ‘ ’
‘ ’
‘ ’
Arbitrary lines to add to the document’
hyperref settings. See ‘ ’
structure and order of the LaTeX headers.
‘ ’
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
‘ ’
‘ ’
document’ ‘ ’
necessary.
‘ ’
The document’
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
non-‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’
‘ ’
document’
The following sections have further details.
File: org, Node: LaTeX header and sectioning, Next: Quoting LaTeX code, Prev: LaTeX specific export settings, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.3 LaTeX header and sectioning structure
2019-11-26 16:46:24 +01:00
---------------------------------------------
The LaTeX export back-end converts the first three of Org’
levels into LaTeX headlines. The remaining Org levels are exported as
lists. To change this globally for the cut-off point between levels and
lists, (see *note Export Settings::).
By default, the LaTeX export back-end uses the _article_ class.
To change the default class globally, edit ‘ ’
To change the default class locally in an Org file, add option lines
‘ ’
of the Org file, set a sub-tree property, ‘ ’
class name entered here must be valid member of ‘ ’
This variable defines a header template for each class into which the
exporter splices the values of ‘ ’
‘ ’
custom sectioning or custom classes.
The LaTeX export back-end sends the ‘ ’
‘ ’
‘ ’
including enclosing them in square brackets, follow LaTeX conventions.
#+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn]
The LaTeX export back-end appends values from ‘ ’
‘ ’
‘ ’
export back-end does not append ‘ ’
previewing LaTeX snippets (see *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, Node: Quoting LaTeX code, Next: Tables in LaTeX export, Prev: LaTeX header and sectioning, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.4 Quoting LaTeX code
2019-11-26 16:46:24 +01:00
--------------------------
The LaTeX export back-end can insert any arbitrary LaTeX code, see *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, Node: Tables in LaTeX export, Next: Images in LaTeX export, Prev: Quoting LaTeX code, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.5 Tables in LaTeX export
2019-11-26 16:46:24 +01:00
------------------------------
The LaTeX export back-end can pass several LaTeX attributes for table
contents and layout. Besides specifying a label (see *note Internal
Links::) and a caption (see *note Captions::), the other valid LaTeX
attributes include:
‘ ’
The LaTeX export back-end wraps the table differently depending on
the mode for accurate rendering of math symbols. Mode is either
‘ ’ ‘ ’ ‘ ’ ‘ ’
For ‘ ’ ‘ ’
table in a math environment, but every cell in it is exported
as-is. The LaTeX export back-end determines the default mode from
‘ ’
contiguous tables in the same mode into a single 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
‘ ’
can insert the appropriate load package headers in the converted
LaTeX file. Look in the docstring for the
‘ ’
for LaTeX snippet previews, if any.
‘ ’
Use ‘ ’
*note Captions::). For custom captions, use ‘ ’
which accepts raw LaTeX code. ‘ ’ ‘ ’
value.
‘ ’
‘ ’
The table environments by default are not floats in LaTeX. To make
them floating objects use ‘ ’
options: ‘ ’ ‘ ’ ‘ ’ ‘ ’
LaTeX floats can also have additional layout ‘ ’
attributes. These are the usual ‘ ’
specified in square brackets. Note that for ‘ ’
tables, the LaTeX export back-end ignores ‘ ’
‘ ’
‘ ’
‘ ’
The LaTeX export back-end uses these attributes for regular tables
to set their alignments, fonts, and widths.
‘ ’
When ‘ ’ ‘ ’
shrinks the table by the ‘ ’
environments. ‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
All three commands are toggles. ‘ ’
typesetting enhancements to regular tables. The booktabs package
has to be loaded through ‘ ’ ‘ ’
for centering the table. ‘ ’
horizontal line made of ASCII characters from “table.el” tables
only.
‘ ’
‘ ’
‘ ’
The LaTeX export back-end inserts ‘ ’
math environment before the table. The LaTeX export back-end
inserts ‘ ’
table. The LaTeX export back-end inserts ‘ ’
value between the macro name and the table’
‘ ’
than one argument, such as ‘ ’
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
‘ ’
#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
| ... | ... |
| ... | ... |
File: org, Node: Images in LaTeX export, Next: Plain lists in LaTeX export, Prev: Tables in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.6 Images in LaTeX export
2019-11-26 16:46:24 +01:00
------------------------------
The LaTeX export back-end processes image links in Org files that do not
have descriptions, such as these links ‘ ’
‘ ’
the PDF, they are no longer links but actual images embedded on the
page. The LaTeX export back-end uses ‘ ’
the image. But for TikZ (<http://sourceforge.net/projects/pgf/>)
images, the back-end uses an ‘ ’
‘ ’
2019-12-06 19:15:46 +01:00
For specifying image ‘ ’ ‘ ’ ‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
#+ATTR_LATEX: :width 5cm :options angle=90
[[./img/sed-hr4049.pdf]]
2019-12-06 19:15:46 +01:00
A ‘ ’ ‘ ’ ‘ ’
attributes.
2019-11-26 16:46:24 +01:00
For custom commands for captions, use the ‘ ’
overrides the default ‘ ’
#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
[[./img/sed-hr4049.pdf]]
When captions follow the method as described in *note Captions::, the
LaTeX export back-end wraps the picture in a floating ‘ ’
environment. To float an image without specifying a caption, set the
‘ ’
‘ ’
For a standard ‘ ’
image has a caption.
‘ ’
To span the image across multiple columns of a page; the back-end
wraps the image in a ‘ ’
‘ ’
For text to flow around the image on the right; the figure occupies
the left half of the page.
‘ ’
For a new page with the image sideways, rotated ninety degrees, in
a ‘ ’ ‘ ’
‘ ’
To avoid a ‘ ’
Use the ‘ ’ ’
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
‘ ’ ‘ ’
set ‘ ’ ‘ ’
Set the ‘ ’ ‘ ’
export back-end to comment out the ‘ ’
File: org, Node: Plain lists in LaTeX export, Next: Source blocks in LaTeX export, Prev: Images in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.7 Plain lists in LaTeX export
2019-11-26 16:46:24 +01:00
-----------------------------------
The LaTeX export back-end accepts the ‘ ’ ‘ ’
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 ‘ ’
four:
#+LATEX_HEADER: \usepackage{enumitem}
#+LATEX_HEADER: \renewlist{itemize}{itemize}{9}
#+LATEX_HEADER: \setlist[itemize]{label=$\circ$}
- One
- Two
- Three
- Four
- Five
File: org, Node: Source blocks in LaTeX export, Next: Example blocks in LaTeX export, Prev: Plain lists in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.8 Source blocks in LaTeX export
2019-11-26 16:46:24 +01:00
-------------------------------------
The LaTeX export back-end can make source code blocks into floating
objects through the attributes ‘ ’ ‘ ’ ‘ ’
‘ ’
Makes a source block float; by default floats any source block with
a caption.
‘ ’
Spans the source block across multiple columns of a page.
‘ ’
Avoids a ‘ ’
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 ‘ ’
packages for customization of that specific source block. In the
example below, the ‘ ’
code highlighting LaTeX package 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 ‘ ’
‘ ’
File: org, Node: Example blocks in LaTeX export, Next: Special blocks in LaTeX export, Prev: Source blocks in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.9 Example blocks in LaTeX export
2019-11-26 16:46:24 +01:00
--------------------------------------
The LaTeX export back-end wraps the contents of example blocks in a
‘ ’
environment globally, specify an appropriate export filter (see *note
Advanced Export Configuration::). To change this behavior to use
another environment for each block, use the ‘ ’
specify a custom environment.
#+ATTR_LATEX: :environment myverbatim
#+BEGIN_EXAMPLE
This sentence is false.
#+END_EXAMPLE
File: org, Node: Special blocks in LaTeX export, Next: Horizontal rules in LaTeX export, Prev: Example blocks in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.10 Special blocks in LaTeX export
2019-11-26 16:46:24 +01:00
---------------------------------------
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
‘ ’ ’
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 ‘ ’
attribute. It overrides standard ‘ ’
#+ATTR_LATEX: :caption \MyCaption{HeadingA}
#+BEGIN_proof
...
#+END_proof
File: org, Node: Horizontal rules in LaTeX export, Prev: Special blocks in LaTeX export, Up: LaTeX Export
2019-12-06 19:15:46 +01:00
13.10.11 Horizontal rules in LaTeX export
2019-11-26 16:46:24 +01:00
-----------------------------------------
The LaTeX export back-end converts horizontal rules by the specified
‘ ’ ‘ ’
#+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
-----
File: org, Node: Markdown Export, Next: OpenDocument Text Export, Prev: LaTeX Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.11 Markdown Export
2019-11-26 16:46:24 +01:00
=====================
The Markdown export back-end, “md”, converts an Org file to Markdown
format, as defined at <http://daringfireball.net/projects/markdown/>.
Since it is built on top of the HTML back-end (see *note HTML
Export::), it converts every Org construct not defined in Markdown
syntax, such as tables, to HTML.
Markdown export commands
------------------------
‘ ’ ‘ ’
Export to a text file with Markdown syntax. For ‘ ’
exports to ‘ ’
‘ ’ ‘ ’
Export to a temporary buffer. Does not create a file.
‘ ’
Export as a text file with Markdown syntax, then open it.
Header and sectioning structure
-------------------------------
Based on ‘ ’
of both _atx_ and _setext_ types. _atx_ limits headline levels to two
whereas _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 (see *note Export Settings::).
File: org, Node: OpenDocument Text Export, Next: Org Export, Prev: Markdown Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.12 OpenDocument Text Export
2019-11-26 16:46:24 +01:00
==============================
The ODT export back-end handles creating of OpenDocument Text (ODT)
format. Documents created by this exporter use the ‘
specification’
* 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 tables 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) See Open Document Format for Office Applications (OpenDocument)
Version 1.2
(http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html).
File: org, Node: Pre-requisites for ODT export, Next: ODT export commands, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.1 Pre-requisites for ODT export
2019-11-26 16:46:24 +01:00
-------------------------------------
The ODT export back-end relies on the zip program to create the final
compressed ODT output. Check if ‘ ’
executable. Without it, export cannot finish.
File: org, Node: ODT export commands, Next: ODT specific export settings, Prev: Pre-requisites for ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.2 ODT export commands
2019-11-26 16:46:24 +01:00
---------------------------
‘ ’ ‘ ’
Export as OpenDocument Text file.
If ‘ ’
back-end automatically converts the exported file to that format.
For ‘ ’ ‘ ’
warning. The ODT export back-end exports a region only if a region
was active.
If the selected region is a single tree, the ODT export back-end
makes the tree head the document title. Incidentally, ‘ ’
selects the current sub-tree. If the tree head entry has, or
inherits, an ‘ ’
uses that for file name.
‘ ’
Export as an OpenDocument Text file and open the resulting file.
If ‘ ’
converted file instead. See *note Automatically exporting to other
formats::.
File: org, Node: ODT specific export settings, Next: Extending ODT export, Prev: ODT export commands, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.3 ODT specific export settings
2019-11-26 16:46:24 +01:00
------------------------------------
The ODT export back-end has several additional keywords for customizing
ODT output. Setting these keywords works similar to the general options
(see *note Export Settings::).
‘ ’
This is the document’
inserts as document metadata. For long descriptions, use multiple
lines, prefixed with ‘ ’
‘ ’
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 ‘ ’
if necessary.
‘ ’
The ODT export back-end uses the ‘ ’
See *note Applying custom styles:: for details.
‘ ’
The document subtitle.
File: org, Node: Extending ODT export, Next: Applying custom styles, Prev: ODT specific export settings, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.4 Extending ODT export
2019-11-26 16:46:24 +01:00
----------------------------
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 ‘ ’
convert a document from one format, say ‘ ’
‘ ’
Customize ‘ ’ ‘ ’
which is the ODT’
LibreOffice would already have ‘ ’
other converters may be substituted here. See *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 ‘ ’ ‘ ’ ‘ ’ ‘ ’
back-end to directly produce that format. Specify the final format in
the ‘ ’
extend (see *note ODT export commands::).
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:
‘ ’
Convert an existing document from one format to another. With a
prefix argument, opens the newly produced file.
File: org, Node: Applying custom styles, Next: Links in ODT export, Prev: Extending ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.5 Applying custom styles
2019-11-26 16:46:24 +01:00
------------------------------
The ODT export back-end comes with many OpenDocument styles (see *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 ‘ ’
and export it to ODT format.
#+OPTIONS: H:10 num:t
2. Open the above ‘ ’
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 ‘ ’
newly created file. For additional configuration options, see
*note Overriding factory styles: x-overriding-factory-styles.
To apply an ODT style to a particular file, use the
‘ ’
#+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, Node: Links in ODT export, Next: Tables in ODT export, Prev: Applying custom styles, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.6 Links in ODT export
2019-11-26 16:46:24 +01:00
---------------------------
ODT exporter creates native cross-references for internal links. It
creates Internet-style links for all other links.
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 ‘ ’
with a cross-reference and sequence number of the labeled entity. See
*note Labels and captions in ODT export::.
File: org, Node: Tables in ODT export, Next: Images in ODT export, Prev: Links in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.7 Tables in ODT export
2019-11-26 16:46:24 +01:00
----------------------------
The ODT export back-end handles native Org mode tables (see *note
Tables::) and simple ‘ ’ ‘ ’
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 (see
*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 (see *note Column Width and Alignment::).
Note that the ODT export back-end interprets column widths as
weighted ratios, the default weight being 1.
Specifying ‘ ’ ‘ ’
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 ‘ ’
tables in ODT export::.
File: org, Node: Images in ODT export, Next: Math formatting in ODT export, Prev: Tables in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.8 Images in ODT export
2019-11-26 16:46:24 +01:00
----------------------------
Embedding images
................
The ODT export back-end processes image links in Org files that do not
have descriptions, such as these links ‘ ’
‘ ’
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 ‘ ’
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 ‘ ’
attribute.
The ODT export back-end starts with establishing the size of the
image in the final document. The dimensions of this size are 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’ ‘ ’
‘ ’
sizes or frequent batch operations. The back-end then converts the
pixel dimensions using ‘ ’
dpi or 96 dpi. The default value for this is in
‘ ’
on the capabilities of the output device. Here are some common image
scaling operations:
Explicitly size the image
To embed ‘ ’
#+ATTR_ODT: :width 10 :height 10
[[./img.png]]
Scale the image
To embed ‘ ’
#+ATTR_ODT: :scale 0.5
[[./img.png]]
Scale the image to a specific width
To embed ‘ ’
original height:width ratio, do the following:
#+ATTR_ODT: :width 10
[[./img.png]]
Scale the image to a specific height
To embed ‘ ’
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 ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
To create an image that is anchored to a page:
#+ATTR_ODT: :anchor page
[[./img.png]]
File: org, Node: Math formatting in ODT export, Next: Labels and captions in ODT export, Prev: Images in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.9 Math formatting in ODT export
2019-11-26 16:46:24 +01:00
-------------------------------------
The ODT exporter has special support for handling math.
* Menu:
* LaTeX math snippets:: Embedding in LaTeX format.
* MathML and OpenDocument formula files:: Embedding in native format.
File: org, Node: LaTeX math snippets, Next: MathML and OpenDocument formula files, Up: Math formatting in ODT export
2019-12-06 19:15:46 +01:00
13.12.9.1 LaTeX math snippets
2019-11-26 16:46:24 +01:00
.............................
LaTeX math snippets (see *note LaTeX fragments::) can be embedded in the
ODT document in one of the following ways:
MathML
Add this line to the Org file. This option is activated on a
per-file basis.
#+OPTIONS: tex: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.
You can specify the LaTeX-to-MathML converter by customizing the
variables ‘ ’
‘ ’
If you prefer to use MathToWeb(1) as your converter, you can
configure the above variables as shown below.
(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")
or, to use LaTeX
(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:
‘ ’
Convert a LaTeX math snippet to an OpenDocument formula
(‘ ’
‘ ’
Convert a LaTeX math snippet to an OpenDocument formula
(‘ ’
system-registered application.
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, Node: MathML and OpenDocument formula files, Prev: LaTeX math snippets, Up: Math formatting in ODT export
2019-12-06 19:15:46 +01:00
13.12.9.2 MathML and OpenDocument formula files
2019-11-26 16:46:24 +01:00
...............................................
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 (‘ ’ ‘ ’
shown below:
[[./equation.mml]]
or
[[./equation.odf]]
File: org, Node: Labels and captions in ODT export, Next: Literal examples in ODT export, Prev: Math formatting in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.10 Labels and captions in ODT export
2019-11-26 16:46:24 +01:00
------------------------------------------
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
#+NAME: 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
‘ ’
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, Node: Literal examples in ODT export, Next: Advanced topics in ODT export, Prev: Labels and captions in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.11 Literal examples in ODT export
2019-11-26 16:46:24 +01:00
---------------------------------------
The ODT export back-end supports literal examples (see *note Literal
Examples::) with full fontification. Internally, the ODT export
back-end relies on ‘ ’
needed for fancy listings. The auto-generated styles get ‘ ’
prefix and inherit colors from the faces used by Emacs Font Lock library
for that source language.
For custom fontification styles, customize the
‘ ’
To turn off fontification of literal examples, customize the
‘ ’
File: org, Node: Advanced topics in ODT export, Prev: Literal examples in ODT export, Up: OpenDocument Text Export
2019-12-06 19:15:46 +01:00
13.12.12 Advanced topics in ODT export
2019-11-26 16:46:24 +01:00
--------------------------------------
The ODT export back-end has extensive features useful for power users
and frequent uses of ODT formats.
Configuring a document converter
................................
The ODT export back-end works with popular converters with little or no
extra configuration. See *note Extending ODT export::. The following
is for unsupported converters or tweaking existing defaults.
Register the converter
Add the name of the converter to the ‘ ’
variable. Note that it also requires how the converter is invoked
on the command line. See the variable’
Configure its capabilities
Specify which formats the converter can handle by customizing the
variable ‘ ’
default values in this variable for configuring the new converter.
Also see its docstring for details.
Choose the converter
Select the newly added converter as the preferred one by
customizing the option ‘ ’
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.
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 ‘ ’
‘ ’
This file contributes to the ‘ ’
document. This file gets modified for the following purposes:
1. To control outline numbering based on user settings;
2. To add styles generated by ‘ ’
of code blocks.
‘ ’
This file contributes to the ‘ ’
document. The contents of the Org outline are inserted between the
‘ ’ ‘ ’
Apart from serving as a template file for the final ‘ ’
the file serves the following purposes:
1. It contains automatic styles for formatting of tables which
are referenced by the exporter;
2. It contains ‘ ’ ‘ ’
elements that control numbering of tables, images, equations,
and similar entities.
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.
‘ ’
The ODT export back-end uses the file pointed to by this variable,
such as ‘ ’
following values:
‘ ’
Use this file instead of the default ‘ ’
‘ ’ ‘ ’
Use the ‘ ’
Text or Template file
‘ ’ ‘ ’
Use the ‘ ’
Text or Template file. Additionally extract the specified
member files and embed those within the final ODT document.
Use this option if the ‘ ’
files like header and footer images.
‘ ’
Use the default ‘ ’
‘ ’
Use this variable to specify the blank ‘ ’
final output.
Creating one-off styles
.......................
The ODT export back-end can read embedded raw OpenDocument XML from the
Org file. Such direct formatting is useful for one-off instances.
Embedding ODT tags as part of regular text
Enclose OpenDocument syntax in ‘ ’
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 ‘ ’
(see *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>
Embedding a one-line OpenDocument XML
The ODT export back-end can read one-liner options with ‘ ’
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 ‘ ’
(see *note Factory styles: x-orgodtstyles-xml.) and add a custom
‘ ’
<style:style style:name="PageBreak" style:family="paragraph"
style:parent-style-name="Text_20_body">
<style:paragraph-properties fo:break-before="page"/>
</style:style>
Embedding a block of OpenDocument XML
The ODT export back-end can also read ODT export blocks for
OpenDocument XML. Such blocks use the ‘ ’
‘ ’
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
Customizing tables in ODT export
................................
Override the default table format by specifying a custom table style
with the ‘ ’
tables, see *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-export-odt-table-styles
(append org-export-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 ‘ ’
styles ‘ ’ ‘ ’
*Important:* The OpenDocument styles needed for producing the above
template were pre-defined. They are available in the section marked
‘ ’ ‘ ’
Factory styles: x-orgodtcontenttemplate-xml.). For adding new
templates, define new styles there.
To use this feature proceed as follows:
1. Create a table template(2).
A table template is set of ‘ ’ ‘ ’
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 ‘ ’
listed in the following table.
Cell type Cell style Paragraph style
----------------------------------------------------------------------------------
Body ‘ ’ ‘ ’
First column ‘ ’ ‘ ’
Last column ‘ ’ ‘ ’
First row ‘ ’ ‘ ’
Last row ‘ ’ ‘ ’
Even row ‘ ’ ‘ ’
Odd row ‘ ’ ‘ ’
Even column ‘ ’ ‘ ’
Odd column ‘ ’ ‘ ’
To create a table template with the name ‘ ’
styles in the ‘ ’
‘ ’
(see *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 ‘ ’
• 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
‘ ’ ‘ ’
based on the same template ‘ ’
intended effect by selectively activating the individual cell
styles in that template.
(setq org-export-odt-table-styles
(append org-export-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: :style TableWithHeaderRowAndColumn
| Name | Phone | Age |
| Peter | 1234 | 17 |
| Anna | 4321 | 25 |
Validating OpenDocument XML
...........................
Sometimes ODT format files may not open due to ‘ ’
To verify if such a file is corrupt, validate it against the
OpenDocument Relax NG Compact (RNC) syntax schema. But first the ‘ ’
files have to be decompressed using ‘ ’ ‘ ’
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 ‘ ’
OpenDocument RNC files and the needed schema-locating rules. The ODT
export back-end takes care of updating the ‘ ’
---------- Footnotes ----------
(1) OpenDocument-v1.2 Specification
(http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html)
(2) See the ‘ ’
specification.
(3) See the attributes ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
of the ‘ ’
File: org, Node: Org Export, Next: Texinfo Export, Prev: OpenDocument Text Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.13 Org Export
2019-11-26 16:46:24 +01:00
================
_org_ export back-end creates a normalized version of the Org document
in current buffer. The exporter evaluates Babel code (see *note
Evaluating Code Blocks::) and removes content specific to other
back-ends.
Org export commands
-------------------
‘ ’ ‘ ’
Export as an Org file with a ‘ ’ ‘ ’
Org exports to ‘ ’
‘ ’
Export to an Org file, then open it.
File: org, Node: Texinfo Export, Next: iCalendar Export, Prev: Org Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.14 Texinfo Export
2019-11-26 16:46:24 +01:00
====================
* 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.
* Quotations in Texinfo export:: Quote block attributes.
* Special blocks in Texinfo export:: Special block attributes.
* A Texinfo example:: Processing Org to Texinfo.
File: org, Node: Texinfo export commands, Next: Texinfo specific export settings, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.1 Texinfo export commands
2019-11-26 16:46:24 +01:00
-------------------------------
‘ ’ ‘ ’
Export as a Texinfo file with ‘ ’ ‘ ’
Org exports to ‘ ’
‘ ’ ‘ ’
Export to Texinfo format first and then process it to make an Info
file. To generate other formats, such as DocBook, customize the
‘ ’
File: org, Node: Texinfo specific export settings, Next: Texinfo file header, Prev: Texinfo export commands, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.2 Texinfo specific export settings
2019-11-26 16:46:24 +01:00
----------------------------------------
The Texinfo export back-end has several additional keywords for
customizing Texinfo output. Setting these keywords works similar to the
general options (see *note Export Settings::).
‘ ’
The document subtitle.
‘ ’
Additional authors for the document.
‘ ’
The Texinfo filename.
‘ ’
The default document class (‘ ’
must be a member of ‘ ’
‘ ’
Arbitrary lines inserted at the end of the header.
‘ ’
Arbitrary lines inserted after the end of the header.
‘ ’
The directory category of the document.
‘ ’
The directory title of the document.
‘ ’
The directory description of the document.
‘ ’
The printed title of the document.
File: org, Node: Texinfo file header, Next: Texinfo title and copyright page, Prev: Texinfo specific export settings, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.3 Texinfo file header
2019-11-26 16:46:24 +01:00
---------------------------
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
‘ ’
Along with the output’
language details (see *note Export Settings::) and encoding system as
set in the ‘ ’
‘ ’
example:
#+TEXINFO_HEADER: @synindex
Instead of repeatedly installing the same set of commands, define a
class in ‘ ’
document by setting the ‘ ’
File: org, Node: Texinfo title and copyright page, Next: Info directory file, Prev: Texinfo file header, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.4 Texinfo title and copyright page
2019-11-26 16:46:24 +01:00
----------------------------------------
The default template for hard copy output has a title page with ‘ ’
and ‘ ’
regular title with something different for the printed version, use the
‘ ’ ‘ ’
Texinfo code for setting their values.
If one ‘ ’ ‘ ’
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-‘ ’
‘ ’
‘ ’
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 2016 Free Software Foundation, Inc.
File: org, Node: Info directory file, Next: Headings and sectioning structure, Prev: Texinfo title and copyright page, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.5 Info directory file
2019-11-26 16:46:24 +01:00
---------------------------
The end result of the Texinfo export process is the creation of an Info
file. This Info file’
description: ‘ ’ ‘ ’
‘ ’
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, Node: Headings and sectioning structure, Next: Indices, Prev: Info directory file, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.6 Headings and sectioning structure
2019-11-26 16:46:24 +01:00
-----------------------------------------
The Texinfo export back-end uses a pre-defined scheme to convert Org
headlines to equivalent Texinfo structuring commands. A scheme like
this maps top-level headlines to numbered chapters tagged as ‘ ’
and lower-level headlines to unnumbered chapters tagged as
‘ ’ ‘ ’
Texinfo structuring commands, define a new class in
‘ ’ ‘ ’
keyword. When no new class is defined and activated, the Texinfo export
back-end defaults to the ‘ ’
If an Org headline’
command, or is below a certain threshold (see *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-‘ ’
‘ ’
Org headline level or the ‘ ’
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 ‘ ’
Contents::). Texinfo menu entries also have an option for a longer
‘ ’ ’
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 ‘ ’
file. See *note (texinfo)The Top Node::, for more information.
File: org, Node: Indices, Next: Quoting Texinfo code, Prev: Headings and sectioning structure, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.7 Indices
2019-11-26 16:46:24 +01:00
---------------
The Texinfo export back-end recognizes these indexing keywords if used
in the Org file: ‘ ’ ‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
belong to a Texinfo command.
#+CINDEX: Defining indexing entries
For the back-end to generate an index entry for a headline, set the
‘ ’ ‘ ’ ‘ ’
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, Node: Quoting Texinfo code, Next: Plain lists in Texinfo export, Prev: Indices, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.8 Quoting Texinfo code
2019-11-26 16:46:24 +01:00
----------------------------
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, Node: Plain lists in Texinfo export, Next: Tables in Texinfo export, Prev: Quoting Texinfo code, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.9 Plain lists in Texinfo export
2019-11-26 16:46:24 +01:00
-------------------------------------
The Texinfo export back-end by default converts description lists in the
Org file using the default command ‘ ’
2019-12-06 19:15:46 +01:00
with two columns. To change this behavior, set ‘ ’
to either ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
(texinfo)Two-column Tables::.
The Texinfo export back-end by default also applies a text highlight
based on the defaults stored in ‘ ’
override the default highlight command, specify another one with the
‘ ’
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 ‘ ’
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
2019-12-06 19:15:46 +01:00
Ordered lists are numbered when exported to Texinfo format. Such
numbering obeys any counter (see *note Plain Lists::) in the first item
of the list. The ‘ ’
specific number, or switch to a lettered list, as illustrated here
#+ATTR_TEXINFO: :enum A
1. Alpha
2. Bravo
3. Charlie
2019-11-26 16:46:24 +01:00
File: org, Node: Tables in Texinfo export, Next: Images in Texinfo export, Prev: Plain lists in Texinfo export, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.10 Tables in Texinfo export
2019-11-26 16:46:24 +01:00
---------------------------------
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 ‘ ’
#+ATTR_TEXINFO: :columns .5 .5
| a cell | another cell |
File: org, Node: Images in Texinfo export, Next: Quotations in Texinfo export, Prev: Tables in Texinfo export, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.11 Images in Texinfo export
2019-11-26 16:46:24 +01:00
---------------------------------
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 ‘ ’
and ‘ ’ ‘ ’
the text using Texinfo code, as shown in the example:
#+ATTR_TEXINFO: :width 1in :alt Alternate @i{text}
[[ridt.pdf]]
File: org, Node: Quotations in Texinfo export, Next: Special blocks in Texinfo export, Prev: Images in Texinfo export, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.12 Quotations in Texinfo export
2019-11-26 16:46:24 +01:00
-------------------------------------
You can write the text of a quotation within a quote block (see *note
Paragraphs::). You may also emphasize some text at the beginning of the
quotation with the ‘ ’
#+ATTR_TEXINFO: :tag Warning
#+BEGIN_QUOTE
Striking your thumb with a hammer may cause severe pain and discomfort.
#+END_QUOTE
To specify the author of the quotation, use the ‘ ’
#+ATTR_TEXINFO: :author King Arthur
#+BEGIN_QUOTE
The Lady of the Lake, her arm clad in the purest shimmering samite,
held aloft Excalibur from the bosom of the water, signifying by divine
providence that I, Arthur, was to carry Excalibur. That is why I am
your king.
#+END_QUOTE
File: org, Node: Special blocks in Texinfo export, Next: A Texinfo example, Prev: Quotations in Texinfo export, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.13 Special blocks in Texinfo export
2019-11-26 16:46:24 +01:00
-----------------------------------------
The Texinfo export back-end converts special blocks to commands with the
same name. It also adds any ‘ ’
command, as shown in this example:
#+ATTR_TEXINFO: :options org-org-export-to-org ...
#+BEGIN_defun
A somewhat obsessive function name.
#+END_defun
becomes
@defun org-org-export-to-org ...
A somewhat obsessive function name.
@end defun
File: org, Node: A Texinfo example, Prev: Special blocks in Texinfo export, Up: Texinfo Export
2019-12-06 19:15:46 +01:00
13.14.14 A Texinfo example
2019-11-26 16:46:24 +01:00
--------------------------
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 2016 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:
2019-12-06 19:15:46 +01:00
#+INCLUDE: fdl.org
2019-11-26 16:46:24 +01:00
* Index
:PROPERTIES:
:INDEX: cp
:END:
File: org, Node: iCalendar Export, Next: Other Built-in Back-ends, Prev: Texinfo Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.15 iCalendar Export
2019-11-26 16:46:24 +01:00
======================
A large part of Org mode’
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 ‘ ’
back-end exports plain timestamps as ‘ ’ ‘ ’
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 ‘ ’ ‘ ’
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 ‘ ’
clock alarms based on time, configure the ‘ ’
variable.
The iCalendar format standard requires globally unique identifier—or
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
‘ ’ ‘ ’
the entry for re-using the same UID for subsequent exports.
Since a single Org entry can result in multiple iCalendar
entries—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.
‘ ’ ‘ ’
Create iCalendar entries from the current Org buffer and store them
in the same directory, using a file extension ‘ ’
‘ ’ ‘ ’
Create iCalendar entries from Org files in ‘ ’
store in a separate iCalendar file for each Org file.
‘ ’ ‘ ’
Create a combined iCalendar file from Org files in
‘ ’
‘ ’
The iCalendar export back-end includes ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’ ‘ ’
exporting. To force the back-end to inherit the ‘ ’ ‘ ’
and ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
variable.
2019-12-06 19:15:46 +01:00
When Org entries do not have ‘ ’ ‘ ’ ‘ ’
‘ ’
from the headline, and derives the description from the body of the Org
item. The ‘ ’
number of characters of the content are turned into its description.
2019-11-26 16:46:24 +01:00
The ‘ ’
and is applied to any entry with timestamp information. Time zones
should be specified as per the IANA time zone database format, e.g.,
‘ ’ ‘ ’
UTC time for this entry only.
2019-12-06 19:15:46 +01:00
The ‘ ’
class or access restrictions, and is applied to any entry with class
information. The iCalendar standard defines three visibility classes:
‘ ’
The entry is publicly visible (this is the default).
‘ ’
Only a limited group of clients get access to the event.
‘ ’
The entry can be retrieved only by its owner.
The server should treat unknown class properties the same as
‘ ’
2019-11-26 16:46:24 +01:00
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, Node: Other Built-in Back-ends, Next: Advanced Export Configuration, Prev: iCalendar Export, Up: Exporting
2019-12-06 19:15:46 +01:00
13.16 Other Built-in Back-ends
2019-11-26 16:46:24 +01:00
==============================
Other export back-ends included with Org are:
• ‘ ’
To activate such back-ends, either customize ‘ ’
load directly with ‘ ’
back-end adds new keys in the export dispatcher (see *note The Export
Dispatcher::).
Follow the comment section of such files, for example, ‘ ’
for usage and configuration details.
File: org, Node: Advanced Export Configuration, Next: Export in Foreign Buffers, Prev: Other Built-in Back-ends, Up: Exporting
2019-12-06 19:15:46 +01:00
13.17 Advanced Export Configuration
2019-11-26 16:46:24 +01:00
===================================
Hooks
-----
The export process executes two hooks before the actual exporting
begins. The first hook, ‘ ’
before any expansions of macros, Babel code, and include keywords in the
buffer. The second hook, ‘ ’
the buffer is parsed.
Functions added to these hooks are called with a single argument: the
export back-end actually used, as a symbol. You may use them for heavy
duty structural modifications of the document. For example, you can
remove every headline in the buffer during export like this:
(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) (line-beginning-position 2)))))
(add-hook 'org-export-before-parsing-hook 'my-headline-removal)
Filters
-------
Filters are 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: ‘ ’
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 ‘ ’
the Org buffer with ‘ ’
(defun my-latex-filter-nobreaks (text backend info)
"Ensure \"
(when (org-export-derived-backend-p backend 'latex)
(replace-regexp-in-string "
(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
‘ ’
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 ‘ ’
one removes brackets from time stamps, and the other removes
strike-through text. The filter functions are defined in a 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-‘ ’
#+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 ‘ ’
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 ‘ ’
type elements.
To use the newly defined back-end, evaluate 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, Node: Export in Foreign Buffers, Prev: Advanced Export Configuration, Up: Exporting
2019-12-06 19:15:46 +01:00
13.18 Export in Foreign Buffers
2019-11-26 16:46:24 +01:00
===============================
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:
‘ ’
Convert the selected region into ASCII.
‘ ’
Convert the selected region into UTF-8.
‘ ’
Convert the selected region into HTML.
‘ ’
Convert the selected region into LaTeX.
‘ ’
Convert the selected region into Texinfo.
‘ ’
Convert the selected region into Markdown.
In-place conversions are particularly handy for quick conversion of
tables and lists in foreign buffers. For example, in an HTML buffer,
write a list in Org syntax, select it, and convert it to HTML with ‘
org-html-convert-region-to-html’
File: org, Node: Publishing, Next: Working with Source Code, Prev: Exporting, Up: Top
2019-12-06 19:15:46 +01:00
14 Publishing
2019-11-26 16:46:24 +01:00
*************
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’
* Menu:
* Configuration:: Defining projects.
* Uploading Files:: How to get files up on the server.
* Sample Configuration:: Example projects.
* Triggering Publication:: Publication commands.
File: org, Node: Configuration, Next: Uploading Files, Up: Publishing
2019-12-06 19:15:46 +01:00
14.1 Configuration
2019-11-26 16:46:24 +01:00
==================
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?
* Site map:: Generating a list of all pages.
* Generating an index:: An index that reaches across pages.
File: org, Node: Project alist, Next: Sources and destinations, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.1 The variable ‘ ’
2019-11-26 16:46:24 +01:00
-----------------------------------------------
Publishing is configured almost entirely through setting the value of
one variable, called ‘ ’
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 are to 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 ‘ ’
together files requiring different publishing options. When you publish
such a “meta-project”, all the components are also published, in the
sequence given.
File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.2 Sources and destinations for files
2019-11-26 16:46:24 +01:00
-----------------------------------------
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.
‘ ’
Directory containing publishing source files.
‘ ’
Directory where output files are published. You can directly
publish to a webserver 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 (see *note Uploading
Files::).
‘ ’
Function or list of functions to be called before starting the
publishing process, for example, to run ‘ ’
to be published. Each preparation function is called with a single
argument, the project property list.
‘ ’
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, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.3 Selecting files
2019-11-26 16:46:24 +01:00
----------------------
By default, all files with extension ‘ ’
considered part of the project. This can be modified by setting the
following properties
‘ ’
Extension—without the dot—of source files. This actually is a
regular expression. Set this to the symbol ‘ ’
get all files in ‘ ’
‘ ’
Regular expression to match file names that should not be
published, even though they have been selected on the basis of
their extension.
‘ ’
List of files to be included regardless of ‘ ’
‘ ’
‘ ’
Non-‘ ’
publish.
File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.4 Publishing action
2019-11-26 16:46:24 +01:00
------------------------
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
‘ ’
Export::). But you can also publish your content as PDF files using
‘ ’
corresponding functions.
If you want to publish the Org file as an ‘ ’
_archived_, _commented_, and _tag-excluded_ trees removed, use
‘ ’ ‘ ’
publishing directory. If you want a htmlized version of this file, set
the parameter ‘ ’ ‘ ’ ‘ ’
the publishing directory(1).
Other files like images only need to be copied to the publishing
destination; for this you can use ‘ ’
files, you always need to specify the publishing function:
‘ ’
Function executing the publication of a file. This may also be a
list of functions, which are all called in turn.
‘ ’
Non-‘ ’
The function must accept three arguments: a property list containing
at least a ‘ ’
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 as the source directory,
‘ ’ ‘ ’
do this.
File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.5 Options for the exporters
2019-11-26 16:46:24 +01:00
--------------------------------
The property list can be used to set many export options for the HTML
and LaTeX exporters. In most cases, these properties correspond to user
variables in Org. The table below lists these properties along with the
variable they belong to. See the documentation string for the
respective variable for details.
When a property is given a value in ‘ ’
setting overrides the value of the corresponding user variable, if any,
during publishing. Options set within a file (see *note Export
Settings::), however, override everything.
Generic properties
..................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
ASCII specific properties
.........................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
Beamer specific properties
..........................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
HTML specific properties
........................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
‘ ’ ‘ ’
LaTeX specific properties
.........................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
Markdown specific properties
............................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
ODT specific properties
.......................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
Texinfo specific properties
...........................
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
File: org, Node: Publishing links, Next: Site map, Prev: Publishing options, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.6 Publishing links
2019-11-26 16:46:24 +01:00
-----------------------
To create a link from one Org file to another, you would use something
like ‘ ’ ‘ ’
External Links::). When published, this link becomes a link to
‘ ’
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
‘ ’ ‘ ’ ‘ ’
converted to link to the corresponding ‘ ’
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 (see *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 ‘ ’
[[file:foo.org::*heading]]
[[file:foo.org::#custom-id]]
[[file:foo.org::target]]
File: org, Node: Site map, Next: Generating an index, Prev: Publishing links, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.7 Generating a sitemap
2019-11-26 16:46:24 +01:00
---------------------------
The following properties may be used to control publishing of a map of
files for a given project.
‘ ’
When non-‘ ’
‘ ’ ‘ ’
‘ ’
Filename for output of sitemap. Defaults to ‘ ’
becomes ‘ ’
‘ ’
Title of sitemap page. Defaults to name of file.
‘ ’
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 ‘ ’ ‘ ’
‘ ’
about published documents.
‘ ’
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 nested list, which can further be transformed using
‘ ’ ‘ ’
value generates a plain list of links to all files in the project.
‘ ’
Where folders should appear in the sitemap. Set this to ‘ ’
(default) or ‘ ’
When set to ‘ ’
value mixes files and folders. This variable has no effect when
site-map style is ‘ ’
‘ ’
How the files are sorted in the site map. Set this to
‘ ’ ‘ ’
‘ ’ ‘ ’
older date first while ‘ ’
newer date first. ‘ ’
The date of a file is retrieved with ‘ ’
‘ ’
Should sorting be case-sensitive? Default ‘ ’
‘ ’
With this option one can tell how a sitemap’
the sitemap. This is a format string with some escape sequences:
‘ ’ ‘ ’
of the file and ‘ ’
retrieved with the ‘ ’
with ‘ ’ ‘ ’
‘ ’
Format string for the ‘ ’
a sitemap entry’
‘ ’ ‘ ’
File: org, Node: Generating an index, Prev: Site map, Up: Configuration
2019-12-06 19:15:46 +01:00
14.1.8 Generating an index
2019-11-26 16:46:24 +01:00
--------------------------
Org mode can generate an index across the files of a publishing project.
‘ ’
When non-‘ ’ ‘ ’
publish it as ‘ ’
The file is created when first publishing a project with the
‘ ’ ‘
"theindex.inc"’
adding a title, style information, etc.
Index entries are specified with ‘ ’
contains an exclamation mark creates a sub item.
*** Curriculum Vitae
#+INDEX: CV
#+INDEX: Application!CV
File: org, Node: Uploading Files, Next: Sample Configuration, Prev: Configuration, Up: Publishing
2019-12-06 19:15:46 +01:00
14.2 Uploading Files
2019-11-26 16:46:24 +01:00
====================
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 ‘ ’
synchronization tool do the rest. You do not need, in this scenario, to
include attachments such as JPG, CSS or PNG files in the project
definition since the third-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 ‘ ’ ‘ ’
benefit of re-including any changed external files such as source
example files you might include with ‘ ’
mechanism in Org is not smart enough to detect if included files have
been modified.
File: org, Node: Sample Configuration, Next: Triggering Publication, Prev: Uploading Files, Up: Publishing
2019-12-06 19:15:46 +01:00
14.3 Sample Configuration
2019-11-26 16:46:24 +01:00
=========================
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, Node: Simple example, Next: Complex example, Up: Sample Configuration
2019-12-06 19:15:46 +01:00
14.3.1 Example: simple publishing configuration
2019-11-26 16:46:24 +01:00
-----------------------------------------------
This example publishes a set of Org files to the ‘ ’
on the local machine.
(setq org-publish-project-alist
'(("org"
:base-directory "~/org/"
:publishing-directory "~/public_html"
:section-numbers nil
:table-of-contents nil
:style "<link rel=\"stylesheet\"
href=\"../other/mystyle.css\"
type=\"text/css\"/>")))
File: org, Node: Complex example, Prev: Simple example, Up: Sample Configuration
2019-12-06 19:15:46 +01:00
14.3.2 Example: complex publishing configuration
2019-11-26 16:46:24 +01:00
------------------------------------------------
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 ‘ ’
publishable images in ‘ ’
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 ‘ ’
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, Node: Triggering Publication, Prev: Sample Configuration, Up: Publishing
2019-12-06 19:15:46 +01:00
14.4 Triggering Publication
2019-11-26 16:46:24 +01:00
===========================
Once properly configured, Org can publish with the following commands:
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
Prompt for a specific project and publish all files that belong to
it.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
Publish the project containing the current file.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
Publish only the current file.
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
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
‘ ’
if files include other files via ‘ ’ ‘ ’
File: org, Node: Working with Source Code, Next: Miscellaneous, Prev: Publishing, Up: Top
2019-12-06 19:15:46 +01:00
15 Working with Source Code
2019-11-26 16:46:24 +01:00
***************************
Source code here refers to any plain text collection of computer
instructions, possibly with comments, written using a human-readable
programming language. Org can manage source code in an Org document
when the source code is identified with begin and end markers. Working
with source code begins with identifying source code blocks. A source
code block can be placed almost anywhere in an Org document; it is not
restricted to the preamble or the end of the document. However, Org
cannot manage a source code block if it is placed inside an Org comment
or within a fixed width section.
Here is an example source code block in the Emacs Lisp language:
#+BEGIN_SRC emacs-lisp
(defun org-xor (a b)
"Exclusive or."
(if a (not b) b))
#+END_SRC
Source code blocks are one of many Org block types, which also
include “center”, “comment”, “dynamic”, “example”, “export”, “quote”,
“special”, and “verse”. This section pertains to blocks between
‘ ’ ‘ ’
2020-02-14 23:09:34 +01:00
Details of Org’
described in the following sections.
* Menu:
* Features:: Enjoy the versatility of source blocks.
* Structure of Code Blocks:: Code block syntax described.
* Using Header Arguments:: Different ways to set header arguments.
* Environment of a Code Block:: Arguments, sessions, working directory...
* Evaluating Code Blocks:: Place results of evaluation in the Org buffer.
* Results of Evaluation:: Choosing a results type, post-processing...
* Exporting Code Blocks:: Export contents and/or results.
* Extracting Source Code:: Create pure source code files.
* Languages:: List of supported code block languages.
* Editing Source Code:: Language major-mode editing.
* Noweb Reference Syntax:: Literate programming in Org mode.
* Library of Babel:: Use and contribute to a library of useful code blocks.
* Key bindings and Useful Functions:: Work quickly with code blocks.
* Batch Execution:: Call functions from the command line.
File: org, Node: Features, Next: Structure of Code Blocks, Up: Working with Source Code
15.1 Features
=============
Org can manage the source code in the block delimited by ‘ ’
... ‘ ’
essential to modern source code maintenance. Org can edit, format,
extract, export, and publish source code blocks. Org can also compile
and execute a source code block, then capture the results. The Org mode
literature sometimes refers to source code blocks as _live code_ blocks
because they can alter the content of the Org document or the material
that it exports. Users can control how live they want each source code
block by tweaking the header arguments (see *note Using Header
Arguments::) for compiling, execution, extraction, and exporting.
2019-11-26 16:46:24 +01:00
For editing and formatting a source code block, Org uses an
appropriate Emacs major mode that includes features specifically
designed for source code in that language.
Org can extract one or more source code blocks and write them to one
or more source files—a process known as _tangling_ in literate
programming terminology.
For exporting and publishing, Org’
code block appropriately, often with native syntax highlighting.
For executing and compiling a source code block, the user can
configure Org to select the appropriate compiler. Org provides
facilities to collect the result of the execution or compiler output,
insert it into the Org document, and/or export it. In addition to text
results, Org can insert links to other data types, including audio,
video, and graphics. Org can also link a compiler error message to the
appropriate line in the source code block.
An important feature of Org’
ability to pass variables, functions, and results to one another using a
common syntax for source code blocks in any language. Although most
literate programming facilities are restricted to one language or
another, Org’
match each programming task with the appropriate computer language and
to mix them all together in a single Org document. This
interoperability among languages explains why Org’
management facility was named _Org Babel_ by its originators, Eric
Schulte and Dan Davison.
Org mode fulfills the promise of easy verification and maintenance of
publishing reproducible research by keeping text, data, code,
configuration settings of the execution environment, the results of the
execution, and associated narratives, claims, references, and internal
and external links in a single Org document.
2020-02-14 23:09:34 +01:00
File: org, Node: Structure of Code Blocks, Next: Using Header Arguments, Prev: Features, Up: Working with Source Code
2019-11-26 16:46:24 +01:00
2020-02-14 23:09:34 +01:00
15.2 Structure of Code Blocks
2019-11-26 16:46:24 +01:00
=============================
Org offers two ways to structure source code in Org documents: in a
source code block, and directly inline. Both specifications are shown
below.
A source code block conforms to this structure:
#+NAME: <name>
#+BEGIN_SRC <language> <switches> <header arguments>
<body>
#+END_SRC
Do not be put-off by having to remember the source block syntax. Org
mode offers a command for wrapping existing text in a block (see *note
Structure Templates::). 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>}
‘ ’
Optional. Names the source block so it can be called, like a
function, from other source blocks or inline code to evaluate or to
capture the results. Code from other blocks, other files, and from
table formulas (see *note The Spreadsheet::) can use the name to
reference a source block. This naming serves the same purpose as
naming Org tables. Org mode requires unique names. For duplicate
names, Org mode’
‘ ’ ‘ ’
Mandatory. They mark the start and end of a block that Org
requires. The ‘ ’
described next.
‘ ’
Mandatory. It is the identifier of the source code language in the
block. See *note Languages::, for identifiers of supported
languages.
‘ ’
Optional. Switches provide finer control of the code execution,
export, and format (see the discussion of switches in *note Literal
Examples::).
‘ ’
Optional. Heading arguments control many aspects of evaluation,
export and tangling of code blocks (see *note Using Header
Arguments::). Using Org’
be selectively applied to the entire buffer or specific sub-trees
of the Org document.
‘ ’
Source code in the dialect of the specified language identifier.
File: org, Node: Using Header Arguments, Next: Environment of a Code Block, Prev: Structure of Code Blocks, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.3 Using Header Arguments
2019-11-26 16:46:24 +01:00
===========================
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 source code blocks. A header argument is specified
with an initial colon followed by the argument’
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.
System-wide header arguments
----------------------------
System-wide values of header arguments can be specified by customizing
the ‘ ’
following values:
:session => "none"
:results => "replace"
:exports => "code"
:cache => "no"
:noweb => "no"
The example below sets ‘ ’ ‘ ’
makes Org expand ‘ ’
(setq org-babel-default-header-args
(cons '(:noweb . "yes")
(assq-delete-all :noweb org-babel-default-header-args)))
Each language can have separate default header arguments by
customizing the variable ‘ ’
<LANG> is the name of the language. For details, see the
language-specific online documentation at
<https://orgmode.org/worg/org-contrib/babel/>.
Header arguments in Org mode properties
---------------------------------------
For header arguments applicable to the buffer, use ‘ ’
anywhere in the Org file (see *note Property Syntax::).
The following example makes all the R code blocks execute in the same
session. Setting ‘ ’ ‘ ’
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’
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
‘ ’
In this example, ‘ ’ ‘ ’
the sub-tree.
* sample header
:PROPERTIES:
:header-args: :cache yes
:END:
Properties defined through ‘ ’ ‘
C-x p’
‘ ’
Language-specific header arguments are also read from properties
‘ ’
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 ‘ ’
‘ ’
‘ ’ ‘ ’
Code block specific header arguments
------------------------------------
Header arguments are most commonly set at the source code block level,
on the ‘ ’
over those set in the ‘ ’
those set as header properties.
In the following example, setting ‘ ’ ‘ ’
ignore results of the code execution. Setting ‘ ’ ‘ ’
exports only the body of the 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 code block:
src_haskell[:exports both]{fac 5}
Code block header arguments can span multiple lines using ‘ ’
on each line. Note that Org currently accepts the plural spelling of
‘ ’
removed at some point.
Multi-line header arguments on an unnamed 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 code block:
#+NAME: named-block
#+HEADER: :var data=2
#+BEGIN_SRC emacs-lisp
(message "data:%S" data)
#+END_SRC
#+RESULTS: named-block
: data:2
Header 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 ‘ ’
syntax of ‘ ’
In this example, ‘ ’
evaluation of the ‘ ’
#+CALL: factorial(n=5) :exports results
In this example, ‘ ’
evaluation of ‘ ’
#+CALL: factorial[:session special](n=5)
File: org, Node: Environment of a Code Block, Next: Evaluating Code Blocks, Prev: Using Header Arguments, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.4 Environment of a Code Block
2019-11-26 16:46:24 +01:00
================================
Passing arguments
-----------------
Use ‘ ’
variables in code blocks vary by the source language and are covered in
the language-specific documentation. The syntax for ‘ ’
the same for all languages. This includes declaring a variable, and
assigning a default value.
The following syntax is used to pass arguments to code blocks using
the ‘ ’
:var NAME=ASSIGN
NAME is the name of the variable bound in the code block body. ASSIGN
is a literal value, such as a string, a number, a reference to a table,
a list, a literal example, another code block—with or without
arguments—or the results of evaluating a code block.
Here are examples of passing values by reference:
table
A table named with a ‘ ’
#+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
When passing a table, you can treat specially the row, or the
column, containing labels for the columns, or the rows, in the
table.
The ‘ ’ ‘ ’ ‘ ’ ‘ ’
values. The default value is ‘ ’
names—because the second row is a horizontal rule—then Org removes
the column names, processes the table, puts back the column names,
and then writes the table to the results block. Using ‘ ’
does the same to the first row, even if the initial table does not
contain any horizontal rule. When set to ‘ ’
pre-process column names at all.
#+NAME: less-cols
| a |
|---|
| b |
| c |
#+BEGIN_SRC python :var tab=less-cols :colnames nil
return [[val + '*' for val in row] for row in tab]
#+END_SRC
#+RESULTS:
| a |
|----|
| b* |
| c* |
Similarly, the ‘ ’
‘ ’ ‘ ’ ‘ ’
processes the table, puts back the first column, and then writes
the table to the results block. The default is ‘ ’
Org does not pre-process the first column. Note that Emacs Lisp
code blocks ignore ‘ ’
of table-handling in Emacs.
#+NAME: with-rownames
| one | 1 | 2 | 3 | 4 | 5 |
| two | 6 | 7 | 8 | 9 | 10 |
#+BEGIN_SRC python :var tab=with-rownames :rownames yes
return [[val + 10 for val in row] for row in tab]
#+END_SRC
#+RESULTS:
| one | 11 | 12 | 13 | 14 | 15 |
| two | 16 | 17 | 18 | 19 | 20 |
list
A simple named list.
#+NAME: example-list
- simple
- not
- nested
- list
#+BEGIN_SRC emacs-lisp :var x=example-list
(print x)
#+END_SRC
#+RESULTS:
| simple | list |
Note that only the top level list items are passed along. Nested
list items are ignored.
code block without arguments
A code block name, as assigned by ‘ ’
above, optionally followed by parentheses.
#+BEGIN_SRC emacs-lisp :var length=table-length()
(* 2 length)
#+END_SRC
#+RESULTS:
: 8
code block with arguments
A code block name, as assigned by ‘ ’
parentheses and optional arguments passed within the parentheses.
#+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=1)
(* input input)
#+END_SRC
#+RESULTS: squared
: 4
literal example
A literal example block named with a ‘ ’
#+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.
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 commas then each subsequent section
indexes as the next dimension. Note that this indexing occurs _before_
other table-related header arguments are applied, such as ‘ ’
‘ ’ ‘ ’
of the first row the table ‘ ’ ‘ ’
#+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
Two integers separated by a colon reference a range of variable
values. In that case the entire inclusive range is referenced. For
example the following assigns the middle three rows of ‘ ’
to ‘ ’
#+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
‘ ’ ‘ ’
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 |
Note that row names and column names are not removed prior to
variable indexing. You need to take them into account, even when
‘ ’ ‘ ’
Emacs lisp code can also set the values for variables. To
differentiate a value from Lisp code, Org interprets any value starting
with ‘ ’ ‘ ’ ‘ ’ ‘ ’
that code is then assigned to the value of that variable. The following
example shows how to reliably query and pass the file name of the Org
mode buffer to a code block using headers. We need reliability here
because the file’
executing.
#+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
wc -w $filename
#+END_SRC
Note that values read from tables and lists are not 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)
Using sessions
--------------
Two code blocks can share the same environment. The ‘ ’
argument is for running multiple source code blocks under one session.
Org runs code blocks with the same session name in the same interpreter
process.
‘ ’
Default. Each code block gets a new interpreter process to
execute. The process terminates once the block is evaluated.
STRING
Any string besides ‘ ’
session. For example, ‘ ’ ‘ ’
‘ ’
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.
Only languages that provide interactive evaluation can have session
support. Not all languages provide this support, such as C and ditaa.
Even languages, such as Python and Haskell, that do support interactive
evaluation impose limitations on allowable language constructs that can
run interactively. Org inherits those limitations for those code blocks
running in a session.
Choosing a working directory
----------------------------
The ‘ ’
block execution. If it is absent, then the directory associated with
2019-12-06 19:15:46 +01:00
the current buffer is used. In other words, supplying ‘ ’
2019-11-26 16:46:24 +01:00
temporarily has the same effect as changing the current directory with
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
surface, ‘ ’
‘ ’ ‘ ’ ‘ ’
value creates the directory, if necessary.
2019-11-26 16:46:24 +01:00
For example, to save the plot file in the ‘ ’
directory—notice tilde is expanded:
#+BEGIN_SRC R :file myplot.png :dir ~/Work
matplot(matrix(rnorm(100), 10), type="l")
#+END_SRC
To evaluate the code block on a remote machine, supply a remote
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 ‘ ’
‘ ’
[[file:/scp:dand@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
When ‘ ’ ‘ ’
for a new session. But Org does not alter the directory of an already
existing session.
Do not use ‘ ’ ‘ ’ ‘ ’
avoid Org inserting incorrect links to remote files. That is because
Org does not expand ‘ ’
portability issues.
Inserting headers and footers
-----------------------------
The ‘ ’
block for execution, like a reset instruction. For example, you may use
‘ ’
(add-to-list 'org-babel-default-header-args:gnuplot
'((:prologue . "reset")))
Likewise, the value of the ‘ ’
appending to the end of the code block for execution.
File: org, Node: Evaluating Code Blocks, Next: Results of Evaluation, Prev: Environment of a Code Block, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.5 Evaluating Code Blocks
2019-11-26 16:46:24 +01:00
===========================
A note about security: With code evaluation comes the risk of harm. Org
safeguards by prompting for user’
in the source block. To customize this safeguard, or disable it, see
*note Code Evaluation Security::.
How to evaluate source code
---------------------------
Org captures the results of the code block evaluation and inserts them
in the Org file, right after the code block. The insertion point is
after a newline and the ‘ ’ ‘ ’
keyword if one is not already there.
By default, Org enables only Emacs Lisp code blocks for execution.
See *note Languages:: to enable other languages.
Org provides many ways to execute code blocks. ‘ ’ ‘
e’
‘ ’
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 code blocks from the current Org mode buffer or
from the “Library of Babel” (see *note Library of Babel::).
The syntax for ‘ ’
#+CALL: <name>(<arguments>)
#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
The syntax for inline named code blocks is:
... call_<name>(<arguments>) ...
... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
When inline syntax is used, the result is wrapped based on the
variable ‘ ’
‘ ’
‘ ’
This is the name of the code block (see *note Structure of Code
Blocks::) to be evaluated in the current document. If the block is
located in another file, start ‘ ’
by a colon. For example, in order to execute a block named
‘ ’ ‘ ’
#+CALL: file.org:clear-data()
‘ ’
Org passes arguments to the code block using standard function call
syntax. For example, a ‘ ’ ‘ ’
block named ‘ ’ ‘
n=2’
#+CALL: double(n=4)
Note how this function call syntax is different from the header
argument syntax.
‘ ’
Org passes inside header arguments to the named code block using
the header argument syntax. Inside header arguments apply to code
block evaluation. For example, ‘ ’
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 affect the results returned by the code block.
For example, ‘ ’ ‘
html’
Limit code block evaluation
---------------------------
The ‘ ’
and ‘ ’
untrusted code blocks by prompting for a confirmation.
‘ ’ ‘ ’
Org never evaluates the source code.
‘ ’
Org prompts the user for permission to evaluate the source code.
‘ ’ ‘ ’
Org does not evaluate the source code when exporting, yet the user
can evaluate it interactively.
‘ ’
Org prompts the user for permission to evaluate the source code
during export.
If ‘ ’
evaluate the source code from the ‘ ’
(see *note Code Evaluation Security::).
Cache results of evaluation
---------------------------
The ‘ ’
blocks. Caching results can avoid re-evaluating a code block 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 ‘ ’
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 code blocks are pure functions,
that is functions that return the same value for the same input
arguments (see *note Environment of a Code Block::), 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 ‘ ’
cause unexpected results.
When the caching mechanism tests for any source code changes, it does
not expand Noweb style references (see *note Noweb Reference Syntax::).
For reasons why, see
<http://thread.gmane.org/gmane.emacs.orgmode/79046>.
The ‘ ’ ‘ ’
‘ ’
‘ ’
Default. No caching of results; code block evaluated every time.
‘ ’
Whether to run the code or return the cached results is determined
by comparing the SHA1 hash value of the combined code block and
arguments passed to it. This hash value is packed on the
‘ ’
match, Org does not evaluate the code block. When hash values
mismatch, Org evaluates the code block, inserts the results,
recalculates the hash value, and updates ‘ ’
In this example, both functions are cached. But ‘ ’
if the result from ‘ ’
#+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
---------- Footnotes ----------
(1) The option ‘ ’
remove code evaluation from the ‘ ’
(2) Actually, the constructs ‘ ’ ‘ ’
not evaluated when they appear in a keyword (see *note In-buffer
Settings::).
File: org, Node: Results of Evaluation, Next: Exporting Code Blocks, Prev: Evaluating Code Blocks, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.6 Results of Evaluation
2019-11-26 16:46:24 +01:00
==========================
How Org handles results of a code block execution depends on many header
arguments working together. The primary determinant, however, is the
‘ ’
code block can take only one option per class:
2019-12-06 19:15:46 +01:00
Collection
2019-11-26 16:46:24 +01:00
For how the results should be collected from the code block;
2019-12-06 19:15:46 +01:00
Type
2019-11-26 16:46:24 +01:00
For which type of result the code block will return; affects how
Org processes and inserts results in the Org buffer;
2019-12-06 19:15:46 +01:00
Format
For the result; affects how Org processes results;
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Handling
For inserting results once they are properly formatted.
2019-11-26 16:46:24 +01:00
Collection
----------
Collection options specify the results. Choose one of the options; they
are mutually exclusive.
‘ ’
Default. Functional mode. Org gets the value by wrapping the code
in a function definition in the language of the source block. That
is why when using ‘ ’
function and return a value. For languages like Python, an
explicit ‘ ’ ‘
value’
code block.
When evaluating the code block in a session (see *note Environment
of a Code Block::), Org passes the code to an interpreter running
as an interactive Emacs inferior process. Org gets the value from
the source code interpreter’
use language-specific methods to obtain the value. For example,
from the variable ‘ ’
‘ ’
‘ ’
Scripting mode. Org passes the code to an external process running
the interpreter. Org returns the contents of the standard output
stream as text results.
When using a session, Org passes the code to the interpreter
running as an interactive Emacs inferior process. Org concatenates
any text output from the interpreter and returns the collection as
a result.
Note that this collection is not the same as that would be
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 it 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, the interactive interpreter receives and
prints “2”. Results show that.
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.
‘ ’
‘ ’
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:
‘ ’
In-between each table row or below the table headings, sometimes
results have horizontal lines, which are also known as “hlines”.
The ‘ ’ ‘ ’
from the input table. For most code, this is desirable, or else
those ‘ ’ ‘ ’
accepts such lines, as demonstrated in the following example.
#+NAME: many-cols
| a | b | c |
|---+---+---|
| d | e | f |
|---+---+---|
| g | h | i |
#+NAME: no-hline
#+BEGIN_SRC python :var tab=many-cols :hlines no
return tab
#+END_SRC
#+RESULTS: no-hline
| a | b | c |
| d | e | f |
| g | h | i |
#+NAME: hlines
#+BEGIN_SRC python :var tab=many-cols :hlines yes
return tab
#+END_SRC
#+RESULTS: hlines
| a | b | c |
|---+---+---|
| d | e | f |
|---+---+---|
| g | h | i |
‘ ’
Interpret the results as an Org list. If the result is a single
value, create a list of one element.
‘ ’
‘ ’
Interpret literally and insert as quoted text. Do not create a
table. Usage example: ‘ ’
‘ ’
Interpret as a filename. Save the results of execution of the code
block to that file, then insert a link to it. You can control both
the filename and the description associated to the link.
Org first tries to generate the filename from the value of the
‘ ’
‘ ’ ‘ ’
Org assumes it is the current directory.
#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
size(2cm);
draw(unitcircle);
#+END_SRC
2019-12-06 19:15:46 +01:00
If ‘ ’
of the output file from the name of the code block, and its
extension from the ‘ ’
the name and the extension are mandatory.
2019-11-26 16:46:24 +01:00
#+name: circle
#+BEGIN_SRC asymptote :results value file :file-ext pdf
size(2cm);
draw(unitcircle);
#+END_SRC
The ‘ ’
Link Format::) for the link. If ‘ ’
the generated file name for both the “link” and “description” parts
of the link.
By default, Org assumes that a table written to a file has
TAB-delimited output. You can choose a different separator with
the ‘ ’
Format
------
Format pertains to the type of the result returned by the code block.
Choose one of the options; they are mutually exclusive. The default
follows from the type specified above.
‘ ’
Result enclosed in a code block. Useful for parsing. Usage
example: ‘ ’
‘ ’
Result wrapped in a ‘ ’ ‘ ’
or ‘ ’
Usage example: ‘ ’
‘ ’
Results enclosed in a ‘ ’
‘ ’
‘ ’
Results enclosed in a ‘ ’
‘ ’
‘ ’
‘ ’
2020-02-14 23:09:34 +01:00
When used along with ‘ ’
specified in ‘ ’ ‘ ’
type, nothing is written to the disk. The block is used for its
side-effects only, as in the following example:
2019-11-26 16:46:24 +01:00
2020-02-14 23:09:34 +01:00
#+begin_src shell :results file link :file "download.tar.gz"
2019-11-26 16:46:24 +01:00
wget -c "http://example.com/download.tar.gz"
#+end_src
‘ ’
Results enclosed in a ‘ ’
either ‘ ’
‘ ’
‘ ’
Result converted to pretty-print source code. Enclosed in a code
block. Languages supported: Emacs Lisp, Python, and Ruby. Usage
example: ‘ ’
‘ ’
Interpreted as raw Org mode. Inserted directly into the buffer.
Aligned if it is a table. Usage example: ‘ ’
2019-12-06 19:15:46 +01:00
The ‘ ’
appending strings to ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
specified, Org wraps the results in a ‘ ’
‘ ’ ‘ ’
listed above. E.g.,
#+BEGIN_SRC emacs-lisp :results html :wrap EXPORT markdown
"<blink>Welcome back to the 90's</blink>"
#+END_SRC
#+RESULTS:
#+BEGIN_EXPORT markdown
<blink>Welcome back to the 90's</blink>
#+END_EXPORT
Handling
--------
Handling options after collecting the results.
‘ ’
Do not insert results in the Org mode buffer, but echo them in the
minibuffer. Usage example: ‘ ’
‘ ’
Default. Insert results in the Org buffer. Remove previous
results. Usage example: ‘ ’
‘ ’
Append results to the Org buffer. Latest results are at the
bottom. Does not remove previous results. Usage example:
‘ ’
‘ ’
Prepend results to the Org buffer. Latest results are at the top.
Does not remove previous results. Usage example: ‘
prepend’
Post-processing
---------------
The ‘ ’
evaluation. When ‘ ’
‘ ’ ‘ ’
specifications (see *note Environment of a Code Block::). That makes
results available to other code blocks, or even for direct Emacs Lisp
code execution.
The following two examples illustrate ‘ ’
action. The first one shows how to attach an ‘ ’
‘ ’
#+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 ‘ ’ ‘ ’
to pass data between 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, Node: Exporting Code Blocks, Next: Extracting Source Code, Prev: Results of Evaluation, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.7 Exporting Code Blocks
2019-11-26 16:46:24 +01:00
==========================
It is possible to export the _code_ of code blocks, the _results_ of
code block evaluation, _both_ the code and the results of 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, see *note Literal
Examples::. To selectively export sub-trees of an Org document, see
*note Exporting::.
The ‘ ’
file is exported to, say, HTML or LaTeX formats.
‘ ’
The default. The body of code is included into the exported file.
Example: ‘ ’
‘ ’
The results of evaluation of the code is included in the exported
file. Example: ‘ ’
‘ ’
Both the code and results of evaluation are included in the
exported file. Example: ‘ ’
‘ ’
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: ‘ ’
To stop Org from evaluating code blocks to speed exports, use the
header argument ‘ ’
Blocks::). To stop Org from evaluating code blocks for greater
security, set the ‘ ’ ‘ ’
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 ‘
never-export’
Org never evaluates code blocks in commented sub-trees when exporting
(see *note Comment Lines::). On the other hand, Org does evaluate code
blocks in sub-trees excluded from export (see *note Export Settings::).
File: org, Node: Extracting Source Code, Next: Languages, Prev: Exporting Code Blocks, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.8 Extracting Source Code
2019-11-26 16:46:24 +01:00
===========================
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 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 (see *note Noweb Reference Syntax::).
Header arguments
----------------
The ‘ ’
source file(s).
‘ ’
Export the 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: ‘ ’
‘ ’
The default. Do not extract the code in a source code file.
Example: ‘ ’
FILENAME
Export the code block to source file whose file name is derived
from any string passed to the ‘ ’
derives the file name as being relative to the directory of the Org
file’ ‘ ’
The ‘ ’
2019-12-06 19:15:46 +01:00
files if the directory does not exist. A ‘ ’
creation whereas ‘ ’
2019-11-26 16:46:24 +01:00
The ‘ ’
tangled files. These are above and beyond whatever comments may already
exist in the code block.
‘ ’
The default. Do not insert any extra comments during tangling.
‘ ’
Wrap the code block in comments. Include links pointing back to
the place in the Org file from where the code was tangled.
‘ ’
Kept for backward compatibility; same as ‘ ’
‘ ’
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.
‘ ’
Includes both ‘ ’ ‘ ’
‘ ’
Includes ‘ ’
Reference Syntax::), and wraps them in link comments inside the
body of the code block.
The ‘ ’
source code in the tangled file.
‘ ’
Default. Insert a newline before and after each code block in the
tangled file.
‘ ’
Do not insert newlines to pad the tangled code blocks.
The ‘ ’
files. By setting it to a string value—for example, ‘
"#!/bin/bash"’
file that the code block is extracted to. Org then turns on the tangled
file’
The ‘ ’
for tangled files by ‘ ’
tangled file, use ‘ ’
executable, use ‘ ’
executable permission granted by ‘ ’
blocks tangle to a single file with different and conflicting
‘ ’ ’
By default Org expands code blocks during tangling. The ‘ ’
header argument turns off such expansions. Note that one side-effect of
expansion by ‘ ’
Environment of a Code Block::) to variables. Expansions also replace
Noweb references with their targets (see *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 code blocks for execution have to
be expanded anyway.
Functions
---------
‘ ’
Tangle the current file. Bound to ‘ ’
With prefix argument only tangle the current code block.
‘ ’
Choose a file to tangle. Bound to ‘ ’
Hooks
-----
‘ ’
This hook is run from within code files tangled by
‘ ’
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
‘ ’
block header arguments:
1. Set ‘ ’
2. Set ‘ ’ ‘ ’
file.
File: org, Node: Languages, Next: Editing Source Code, Prev: Extracting Source Code, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.9 Languages
2019-11-26 16:46:24 +01:00
==============
Code blocks in the following languages are supported.
Language Identifier Language Identifier
-----------------------------------------------------------------------
2019-12-06 19:15:46 +01:00
Asymptote ‘ ’ ‘ ’
Awk ‘ ’ ‘ ’
C ‘ ’ ‘ ’
C++ ‘ ’ ‘ ’
Clojure ‘ ’ ‘ ’
Caml
CSS ‘ ’ ‘ ’
D ‘ ’ ‘ ’
ditaa ‘ ’ ‘ ’
Emacs Calc ‘ ’ ‘ ’
Emacs Lisp ‘ ’ ‘ ’
Eshell ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
Fortran ‘ ’ ‘ ’
Gnuplot ‘ ’ ‘ ’
GNU Screen ‘ ’ ‘ ’
Graphviz ‘ ’ ‘ ’
Haskell ‘ ’ ‘ ’
Java ‘ ’ ‘ ’
Javascript ‘ ’ ‘ ’
LaTeX ‘ ’ ‘ ’
Ledger ‘ ’ ‘ ’
Lilypond ‘ ’ ‘ ’
Additional documentation for some languages is 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 ‘ ’
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 ‘ ’
the following enables execution of Clojure code blocks:
(require 'ob-clojure)
---------- Footnotes ----------
(1) C++ language is handled in ‘ ’
for such source blocks is ‘ ’
language.
(2) D language is handled in ‘ ’
for such source blocks is ‘ ’
language.
File: org, Node: Editing Source Code, Next: Noweb Reference Syntax, Prev: Languages, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.10 Editing Source Code
=========================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Use ‘ ’
2019-11-26 16:46:24 +01:00
edit buffer containing the body of the source code block, ready for any
edits. Use ‘ ’
buffer.
‘ ’
buffer. Set ‘ ’
after a certain idle delay time. Set ‘ ’
to auto-save this buffer into a separate file using Auto-save mode.
While editing the source code in the major mode, the Org Src minor
mode remains active. It provides these customization variables as
described below. For even more variables, look in the customization
group ‘ ’
‘ ’
If an Emacs major-mode named ‘ ’
the language identifier from code block’
edit buffer uses that major mode. Use this variable to arbitrarily
map language identifiers to major modes.
‘ ’
For specifying Emacs window arrangement when the new edit buffer is
created.
‘ ’
Default is ‘ ’
applies during export or tangling, and depending on the context,
may alter leading spaces and tabs. When non-‘ ’
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.
‘ ’
When ‘ ’
The default prompts for a confirmation.
Set ‘ ’ ‘ ’
fontification in the _Org_ buffer. Fontification of code blocks can
give visual separation of text and code on the display page. To further
customize the appearance of ‘ ’
customize ‘ ’
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, Node: Noweb Reference Syntax, Next: Library of Babel, Prev: Editing Source Code, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.11 Noweb Reference Syntax
2019-11-26 16:46:24 +01:00
============================
Org supports named blocks in Noweb(1) style syntax:
<<CODE-BLOCK-ID>>
Org can replace the construct with the source code, or the results of
evaluation, of the code block identified as CODE-BLOCK-ID.
The ‘ ’
references. Expansions occur when source code blocks are evaluated,
tangled, or exported.
‘ ’
Default. No expansion of Noweb syntax references in the body of
the code when evaluating, tangling, or exporting.
‘ ’
Expansion of Noweb syntax references in the body of the code block
when evaluating, tangling, or exporting.
‘ ’
Expansion of Noweb syntax references in the body of the code block
when tangling. No expansion when evaluating or exporting.
‘ ’
Expansion of Noweb syntax references in the body of the code block
when evaluating or tangling. No expansion when exporting.
‘ ’
Expansion of Noweb syntax references in the body of the code block
when expanding prior to evaluating or tangling. Removes Noweb
syntax references when exporting.
‘ ’
Expansion of Noweb syntax references in the body of the code block
only before evaluating.
In the following example,
#+NAME: initialization
#+BEGIN_SRC emacs-lisp
(setq sentence "Never a foot too far, even.")
#+END_SRC
#+BEGIN_SRC emacs-lisp :noweb yes
<<initialization>>
(reverse sentence)
#+END_SRC
the second code block is expanded as
#+BEGIN_SRC emacs-lisp :noweb yes
(setq sentence "Never a foot too far, even.")
(reverse sentence)
#+END_SRC
Noweb insertions honor prefix characters that appear before the Noweb
syntax reference. This behavior is illustrated in the following
example. Because the ‘ ’
SQL comment syntax, each line of the expanded Noweb reference is
commented. With:
#+NAME: example
#+BEGIN_SRC text
this is the
multi-line body of example
#+END_SRC
this code block:
#+BEGIN_SRC sql :noweb yes
---<<example>>
#+END_SRC
expands to:
#+BEGIN_SRC sql :noweb yes
---this is the
---multi-line body of example
#+END_SRC
Since this change does 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 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')
When expanding Noweb style references, Org concatenates code blocks
by matching the reference name to either the code block name or, if none
is found, to the ‘ ’
For simple concatenation, set this ‘ ’
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
By default a newline separates each noweb reference concatenation.
To change this newline separator, edit the ‘ ’
Eventually, 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 shown below.
<<code-block-name(optional arguments)>>
Note that when using the above approach to a code block’
the code block name set by ‘ ’
by ‘ ’
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 ‘ ’
#+BEGIN_SRC text :noweb yes
<<some-code(num=10)>>
#+END_SRC
Note that now the expansion contains the results of the code block
‘ ’
100
---------- Footnotes ----------
(1) For Noweb literate programming details, see
<http://www.cs.tufts.edu/~nr/noweb/>.
File: org, Node: Library of Babel, Next: Key bindings and Useful Functions, Prev: Noweb Reference Syntax, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.12 Library of Babel
2019-11-26 16:46:24 +01:00
======================
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, see *note Evaluating Code Blocks::.
For any user to add code to the library, first save the code in
regular code blocks of an Org file, and then load the Org file with
‘ ’ ‘ ’
File: org, Node: Key bindings and Useful Functions, Next: Batch Execution, Prev: Library of Babel, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.13 Key bindings and Useful Functions
2019-11-26 16:46:24 +01:00
=======================================
Many common Org mode key sequences are re-bound depending on the
context.
Active key bindings in code blocks:
Key binding Function
--------------------------------------------------------
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
Active key bindings in Org mode buffer:
Key binding Function
--------------------------------------------------------------------------
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
File: org, Node: Batch Execution, Prev: Key bindings and Useful Functions, Up: Working with Source Code
2020-02-14 23:09:34 +01:00
15.14 Batch Execution
2019-11-26 16:46:24 +01:00
=====================
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’
The sample script shows batch processing of multiple files using
‘ ’
#!/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, Node: Miscellaneous, Next: Hacking, Prev: Working with Source Code, Up: Top
2019-12-06 19:15:46 +01:00
16 Miscellaneous
2019-11-26 16:46:24 +01:00
****************
* Menu:
* Completion:: ‘ ’
* Structure Templates:: Quick insertion of structural elements.
* Speed Keys:: Electric commands at the beginning of a headline.
* Clean View:: Getting rid of leading stars in the outline.
2019-12-06 19:15:46 +01:00
* Dynamic Headline Numbering:: Display and update outline numbering.
* The Very Busy C-c C-c Key:: When in doubt, press ‘ ’
* In-buffer Settings:: Overview of keywords.
* Org Syntax:: Formal description of Org’
2019-11-26 16:46:24 +01:00
* Documentation Access:: Read documentation about current syntax.
2019-12-06 19:15:46 +01:00
* Escape Character::
* Code Evaluation Security:: Org files evaluate in-line code.
2019-11-26 16:46:24 +01:00
* Interaction:: With other Emacs packages.
2019-12-06 19:15:46 +01:00
* TTY Keys:: Using Org on a tty.
* Protocols:: External access to Emacs and Org.
2019-11-26 16:46:24 +01:00
* Org Crypt:: Encrypting Org files.
* Org Mobile:: Viewing and capture on a mobile device.
File: org, Node: Completion, Next: Structure Templates, Up: Miscellaneous
2019-12-06 19:15:46 +01:00
16.1 Completion
2019-11-26 16:46:24 +01:00
===============
Org has in-buffer completions. Unlike minibuffer completions, which are
useful for quick command interactions, Org’
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 offers 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.
‘ ’
Complete word at point.
2019-12-06 19:15:46 +01:00
• At the beginning of an empty headline, complete TODO keywords.
2019-11-26 16:46:24 +01:00
• After ‘ ’
• After ‘ ’
2019-12-06 19:15:46 +01:00
they can be used in search links like: ‘
headline]]’
2019-11-26 16:46:24 +01:00
• After ‘ ’
of tags from the ‘ ’
Tags::), the variable ‘ ’
in the current buffer.
• After ‘ ’
list of keys is constructed dynamically from all keys used in
the current buffer.
• After ‘ ’
Abbreviations::).
• After ‘ ’ ‘ ’
file-specific ‘ ’
pressing ‘ ’
keyword.
• After ‘ ’
• When point is anywhere else, complete dictionary words using
Ispell.
2019-12-06 19:15:46 +01:00
File: org, Node: Structure Templates, Next: Speed Keys, Prev: Completion, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.2 Structure Templates
2019-11-26 16:46:24 +01:00
========================
With just a few keystrokes, it is possible to insert empty structural
blocks, such as ‘ ’ ‘ ’
in such a block.
‘ ’ ‘ ’
Prompt for a type of block structure, and insert the block at
point. If the region is active, it is wrapped in the block. First
prompts the user for keys, which are used to look up a structure
type from the variable below. If the key is ‘ ’ ‘ ’
‘ ’
Available structure types are defined in
‘ ’
values.
Org Tempo expands snippets to structures defined in
‘ ’ ‘ ’
example, ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
---------- Footnotes ----------
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
(1) For more information, please refer to the commentary section in
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Speed Keys, Next: Clean View, Prev: Structure Templates, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.3 Speed Keys
2019-11-26 16:46:24 +01:00
===============
Single keystrokes can execute custom commands in an Org file when point
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 key chords.
By default, Org has Speed Keys disabled. To activate Speed Keys, set
the variable ‘ ’ ‘ ’
a Speed Key, point 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, ‘ ’
details, see the variable’ ‘
org-speed-command-help’ ‘ ’
headline, shows currently active Speed Keys, including the user-defined
ones.
2019-12-06 19:15:46 +01:00
File: org, Node: Clean View, Next: Dynamic Headline Numbering, Prev: Speed Keys, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.4 A Cleaner Outline View
===========================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Org’
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 displays only one star
and indents text to line up with the heading:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Top level headline | * Top level headline
** Second level | * Second level
*** Third level | * Third level
some text | some text
*** Third level | * Third level
more text | more text
* Another top level headline | * Another top level headline
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Org can achieve this in two ways, (1) by just displaying the buffer
in this way without changing it, or (2) by actually indenting every line
in the desired amount with hard spaces and hiding leading stars.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Menu:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
* Org Indent Mode::
* Hard indentation::
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Org Indent Mode, Next: Hard indentation, Up: Clean View
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.4.1 Org Indent Mode
----------------------
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
To display the buffer in the indented view, activate Org Indent minor
mode, using ‘ ’
are prefixed with virtual spaces to vertically align with the headline
text(1).
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
To make more horizontal space, the headlines are shifted by two
characters. Configure ‘ ’
2020-01-29 18:18:31 +01:00
different number.
By default, Org Indent mode turns off ‘ ’
does hide leading stars by locally setting ‘ ’
‘ ’
the same font color as the background. If you want to customize this
default behavior, see ‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
To globally turn on Org Indent mode for all files, customize the
variable ‘ ’
use ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
#+STARTUP: indent
#+STARTUP: noindent
---------- Footnotes ----------
(1) Org Indent mode also sets ‘ ’
and wrapping long lines of headlines or text. This minor mode also
handles Visual Line mode and directly applied settings through
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Hard indentation, Prev: Org Indent Mode, Up: Clean View
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.4.2 Hard indentation
-----------------------
It is possible to use hard spaces to achieve the indentation instead, if
the bare ASCII file should have the indented look also outside Emacs(1).
With Org’
outline headers. You would use these settings:
(setq org-adapt-indentation t
org-hide-leading-stars t
org-odd-levels-only t)
_Indentation of text below headlines_ (‘ ’
The first setting modifies paragraph filling, line wrapping, and
structure editing commands to preserving or adapting the
indentation as appropriate.
_Hiding leading stars_ (‘ ’
The second setting makes leading stars invisible by applying the
face ‘ ’
‘ ’
#+STARTUP: hidestars
#+STARTUP: showstars
_Odd levels_ (‘ ’
The third setting makes Org use only odd levels, 1, 3, 5, ..., in
the outline to create more indentation. On a per-file level,
control this with:
#+STARTUP: odd
#+STARTUP: oddeven
To convert a file between single and double stars layouts, use ‘
org-convert-to-odd-levels’ ‘ ’
---------- Footnotes ----------
(1) This works, but requires extra effort. Org Indent mode is more
convenient for most applications.
File: org, Node: Dynamic Headline Numbering, Next: The Very Busy C-c C-c Key, Prev: Clean View, Up: Miscellaneous
16.5 Dynamic Headline Numbering
===============================
The Org Num minor mode, toggled with ‘ ’
outline numbering on top of headlines. It also updates it automatically
upon changes to the structure of the document.
By default, all headlines are numbered. You can limit numbering to
specific headlines according to their level, tags, ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’
If ‘ ’ ‘ ’
*note Creating Footnotes::) are not numbered either.
You can control how the numbering is displayed by setting
‘ ’ ‘ ’
File: org, Node: The Very Busy C-c C-c Key, Next: In-buffer Settings, Prev: Dynamic Headline Numbering, Up: Miscellaneous
16.6 The Very Busy ‘ ’
================================
The ‘ ’
It is probably the most over-worked, multi-purpose key combination in
Org. Its uses are well documented throughout 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 point is in one of the special ‘ ’
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 ‘ ’
• If point is inside a table, realign the table.
• If point is on a ‘ ’
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 point is on a ‘ ’
corresponding links in this buffer.
• If point is on a property line or at the start or end of a property
drawer, offer property commands.
• If point is at a footnote reference, go to the corresponding
definition, and _vice versa_.
• If point is on a statistics cookie, update it.
• If point is in a plain list item with a checkbox, toggle the status
of the checkbox.
• If point is on a numbered item in a plain list, renumber the
ordered list.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
• If point is on the ‘ ’
updated.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
• If point is at a timestamp, fix the day name in the timestamp.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: In-buffer Settings, Next: Org Syntax, Prev: The Very Busy C-c C-c Key, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.7 Summary of In-Buffer Settings
2019-11-26 16:46:24 +01:00
==================================
In-buffer settings start with ‘ ’
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.
‘ ’
and reopening the Org file in Emacs also activates the changes.
‘ ’
Sets the archive location of the agenda file. The corresponding
variable is ‘ ’
‘ ’
Sets the category of the agenda file, which applies to the entire
document.
‘ ’
Set the default format for columns view. This format applies when
columns view is invoked in locations where no ‘ ’
applies.
‘ ’
Set file-local values for constants that table formulas can use.
This line sets the local variable
‘ ’
variable is ‘ ’
‘ ’
Set tags that all entries in the file inherit from, including the
top-level entries.
‘ ’
Each line specifies one abbreviation for one link. Use multiple
‘ ’
corresponding variable is ‘ ’
‘ ’
This line sets the limits and the default for the priorities. All
three must be either letters A– –
priority must have a lower ASCII number than the lowest priority.
‘ ’
This line sets a default inheritance value for entries in the
current buffer, most useful for specifying the allowed values of a
property.
‘ ’
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. ‘ ’
file, and also resets 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—use ‘
'’
‘ ’
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 ‘ ’ ‘ ’
is the same as ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Dynamic virtual indentation is controlled by the variable
‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Aligns tables consistently upon visiting a file. The corresponding
variable is ‘ ’ ‘ ’
value.
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Shrink table columns with a width cookie. The corresponding
variable is ‘ ’ ‘ ’
value.
When visiting a file, inline images can be automatically displayed.
The corresponding variable is ‘ ’
with a default value ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Logging the closing and reopening of TODO items and clock intervals
can be configured using these options (see variables
‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
Here are the options for hiding leading stars in outline headings,
and for indenting outlines. The corresponding variables are
‘ ’ ‘ ’
default setting ‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
To turn on custom format overlays over timestamps (variables
‘ ’
‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
The following options influence the table spreadsheet (variable
‘ ’
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
To influence footnote settings, use the following keywords. The
corresponding variables are ‘ ’
‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
To hide blocks on startup, use these keywords. The corresponding
variable is ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
The display of entities as UTF-8 characters is governed by the
variable ‘ ’
2019-12-06 19:15:46 +01:00
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
‘ ’
These lines (several such lines are allowed) specify the valid tags
in this file, and (potentially) the corresponding _fast tag
selection_ keys. The corresponding variable is ‘ ’
‘ ’
‘ ’
‘ ’
These lines set the TODO keywords and their interpretation in the
current file. The corresponding variable is ‘ ’
---------- Footnotes ----------
2019-12-06 19:15:46 +01:00
(1) Note that Org Indent mode also sets the ‘ ’
such that Visual Line mode (or purely setting ‘ ’
lines, including headlines, correctly indented.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Org Syntax, Next: Documentation Access, Prev: In-buffer Settings, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.8 Org Syntax
===============
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
A reference document providing a formal description of Org’
available as a draft on Worg
(https://orgmode.org/worg/dev/org-syntax.html), written and maintained
by Nicolas Goaziou. It defines Org’
“headlines”, “sections”, “affiliated keywords”, “(greater) elements” and
“objects”. Each part of an Org document belongs to one of the previous
categories.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
To explore the abstract structure of an Org buffer, run this in a
buffer:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
M-: (org-element-parse-buffer) <RET>
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
It outputs a list containing the buffer’
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.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
You can probe the syntax of your documents with the command
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
M-x org-lint <RET>
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
It runs a number of checks to find common mistakes. It then displays
their location in a dedicated buffer, along with a description and a
“trust level”, since false-positive are possible. From there, you can
operate on the reports with the following keys:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Documentation Access, Next: Escape Character, Prev: Org Syntax, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.9 Context Dependent Documentation
====================================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’
manual depending on the syntax at point. For example, using it on a
headline displays “Document Structure” section.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Escape Character, Next: Code Evaluation Security, Prev: Documentation Access, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.10 Escape Character
======================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
You may sometimes want to write text that looks like Org syntax, but
should really read as plain text. Org may use a specific escape
2019-12-29 11:23:16 +01:00
character in some situations, i.e., a backslash in macros (see *note
Macro Replacement::) and links (see *note Link Format::), or a comma in
source and example blocks (see *note Literal Examples::). In the
general case, however, we suggest to use the zero width space. You can
insert one with any of the following:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
C-x 8 <RET> zero width space <RET>
C-x 8 <RET> 200B <RET>
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
For example, in order to write ‘ ’
may write instead
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
[X[1,2]]
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
where ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Code Evaluation Security, Next: Interaction, Prev: Escape Character, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.11 Code Evaluation and Security Issues
=========================================
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Unlike plain text, running code comes with risk. Each source 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.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
For users who do not run code blocks or write code regularly, Org’
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.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Org evaluates code in the following circumstances:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
_Source code blocks_
Org evaluates source code blocks in an Org file during export. Org
also evaluates a source code block with the ‘ ’
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.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
-- User Option: org-confirm-babel-evaluate
When ‘ ’
executing each code block. When ‘ ’
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 ‘ ’ ‘ ’
prompted. Each source code language can be handled separately
through this function argument.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
For example, here is how to execute ditaa code blocks without
prompting:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
(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)
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
_Following ‘ ’ ‘ ’
Org has two link types that can directly evaluate code (see *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:
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
-- User Option: org-link-shell-confirm-function
Function that prompts the user before executing a shell link.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
-- User Option: org-link-elisp-confirm-function
Function that prompts the user before executing an Emacs Lisp
link.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
_Formulas in tables_
Formulas in tables (see *note The Spreadsheet::) are code that is
evaluated either by the Calc interpreter, or by the Emacs Lisp
interpreter.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Interaction, Next: TTY Keys, Prev: Code Evaluation Security, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.12 Interaction with Other Packages
2019-11-26 16:46:24 +01:00
=====================================
Org’
packages are documented here.
* Menu:
* Cooperation:: Packages Org cooperates with.
* Conflicts:: Packages that lead to conflicts.
File: org, Node: Cooperation, Next: Conflicts, Up: Interaction
2019-12-06 19:15:46 +01:00
16.12.1 Packages that Org cooperates with
2019-11-26 16:46:24 +01:00
-----------------------------------------
‘ ’
Org uses the Calc package for implementing spreadsheet
functionality in its tables (see *note The Spreadsheet::). Org
also uses Calc for embedded calculations. See *note GNU Emacs Calc
Manual: (calc)Embedded Mode.
‘ ’
Org can use names for constants in formulas in tables. Org can
also use calculation suffixes for units, such as ‘ ’ ‘ ’
For a standard collection of such constants, install the
‘ ’
available at <http://www.astro.uva.nl/~dominik/Tools>. Org checks
if the function ‘ ’
instructions are in the file ‘ ’
‘ ’
Org mode can make use of the CDLaTeX package to efficiently enter
LaTeX fragments into Org files. See *note CDLaTeX mode::.
‘ ’
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 index is two levels deep—you can modify the depth
using the option ‘ ’
‘ ’
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 ‘ ’
Speedbar frame tweaks the agenda commands to that file or to a
subtree.
‘ ’
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
exports them properly. ‘ ’
buffer, much like Org’
other Org mode functionality, Takaaki Ota tables cannot be edited
directly in the Org buffer.
‘ ’ ‘ ’
Edit a ‘ ’ ‘ ’
table.
‘ ’ ‘ ’
Insert a ‘ ’
point, this command converts it between the ‘ ’
and the Org mode format. See the documentation string of the
command ‘ ’
this is possible.
File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
2019-12-06 19:15:46 +01:00
16.12.2 Packages that conflict with Org mode
2019-11-26 16:46:24 +01:00
--------------------------------------------
2019-12-06 19:15:46 +01:00
In Emacs, shift-selection combines motions of point with shift key to
enlarge regions. Emacs sets this mode by default. This conflicts with
Org’ ‘ ’
priorities, and item bullet types, etc. Since ‘ ’
outside of specific contexts do not do anything, Org offers the variable
‘ ’
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 point moves across a special context.
2019-11-26 16:46:24 +01:00
‘ ’
Org key bindings conflict with ‘ ’
For Org to relinquish these bindings to CUA mode, configure the
variable ‘ ’
following key bindings in Org files, and in the agenda buffer—but
not during date selection.
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
Yes, these are unfortunately more difficult to remember. If you
want to have other replacement keys, look at the variable
‘ ’
‘ ’
Ecomplete provides “electric” address completion in address header
lines in message buffers. Sadly Orgtbl mode cuts Ecomplete’
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.
‘ ’
Org mode tries to do the right thing when filling paragraphs, list
items and other elements. Many users reported problems using both
‘ ’
filladapt like this:
(add-hook 'org-mode-hook 'turn-off-filladapt-mode)
‘ ’
Viper uses ‘ ’
corresponding Org mode command ‘ ’
another key for this command, or override the key in
‘ ’
(define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
‘ ’
This package also uses the ‘ ’
in the paragraph above about CUA mode also applies here. If you
want to make the windmove function active in locations where Org
mode does not have special functionality on ‘ ’
to your configuration:
2019-12-06 19:15:46 +01:00
;; 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)
‘ ’
The way Org mode binds the ‘ ’ ‘ ’
of ‘ ’ ’
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 does not play well with Org mode.
If the above code does not fix the conflict, start by defining 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)))
File: org, Node: TTY Keys, Next: Protocols, Prev: Interaction, Up: Miscellaneous
16.13 Using Org on a TTY
========================
Org provides alternative key bindings for TTY and modern mobile devices
that cannot perform movement commands on point and key bindings with
modifier keys. 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 ‘ ’
timestamp might be better with ‘ ’
Default Alternative 1 Speed key Alternative 2
----------------------------------------------------------------
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
‘ ’ ‘ ’
File: org, Node: Protocols, Next: Org Crypt, Prev: TTY Keys, Up: Miscellaneous
16.14 Protocols for External Access
===================================
Org protocol is a tool 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 (see
*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 ‘ ’
are passed to Emacs through the ‘ ’
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 ‘
val1 :key2 val2)’
Org protocol comes with three predefined protocols, detailed in the
following sections. Configure ‘ ’
your own.
* Menu:
* The store-link protocol:: Store a link, push URL to kill-ring.
* The capture protocol:: Fill a buffer with external information.
* The open-source protocol:: Edit published contents.
File: org, Node: The store-link protocol, Next: The capture protocol, Up: Protocols
16.14.1 The ‘ ’
---------------------------------
Using the ‘ ’
inserted using ‘ ’
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., ‘ ’
javascript:location.href='org-protocol://store-link?url='+
encodeURIComponent(location.href);
File: org, Node: The capture protocol, Next: The open-source protocol, Prev: The store-link protocol, Up: Protocols
16.14.2 The ‘ ’
------------------------------
Activating the “capture” handler pops up a ‘ ’
using acapture template.
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.,
‘ ’ ‘ ’
javascript:location.href='org-protocol://capture?template=x'+
'&url='+encodeURIComponent(window.location.href)+
'&title='+encodeURIComponent(document.title)+
'&body='+encodeURIComponent(window.getSelection());
The capture template to be used can be specified in the bookmark
(like ‘ ’
variable ‘ ’
placeholders are available:
%:link The URL
%:description The webpage title
%:annotation Equivalent to [[%:link][%:description]]
%i The selected text
File: org, Node: The open-source protocol, Prev: The capture protocol, Up: Protocols
16.14.3 The ‘ ’
----------------------------------
The ‘ ’
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 ‘ ’
names, by stripping URL parameters from the end and replacing the
‘ ’ ‘ ’ ‘ ’
‘ ’
‘ ’ ‘ ’
‘ ’
(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
‘ ’
or have an idea about how to enhance the documentation, simply click the
bookmark and start editing.
However, such mapping may not always yield the desired results.
Suppose you maintain an online store located at ‘ ’
The local sources reside in ‘ ’
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 ‘ ’
rewritten on the server to something like
‘ ’
‘ ’
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Such an entry in ‘ ’
property ‘ ’
which maps a regular expression to a path relative to the
‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Now map the URL to the path ‘ ’
adding ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
(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")))))
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Since ‘ ’
‘ ’ ‘ ’ ‘ ’
and similar to ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
The ‘ ’
existing file name is matched.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
Two functions can help you filling ‘ ’
valid contents: ‘ ’ ‘ ’
The latter is of use if you’
publishing project.
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
File: org, Node: Org Crypt, Next: Org Mobile, Prev: Protocols, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.15 Org Crypt
2019-11-26 16:46:24 +01:00
===============
Org Crypt encrypts the text of an entry, but not the headline, or
properties. Behind the scene, it uses the Emacs EasyPG library to
encrypt and decrypt files.
Any text below a headline that has a ‘ ’
encrypted when the file is saved. To use a different tag, customize the
‘ ’
Here is a suggestion for Org Crypt settings in Emacs init file:
(require 'org-crypt)
(org-crypt-use-before-save-magic)
(setq org-tags-exclude-from-inheritance '("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; -*-
It’
specifying the respective key as property ‘ ’
* Totally secret :crypt:
:PROPERTIES:
:CRYPTKEY: 0x0123456789012345678901234567890123456789
:END:
Excluding the ‘ ’
text from being encrypted again.
2019-12-06 19:15:46 +01:00
File: org, Node: Org Mobile, Prev: Org Crypt, Up: Miscellaneous
2019-11-26 16:46:24 +01:00
2019-12-06 19:15:46 +01:00
16.16 Org Mobile
2019-11-26 16:46:24 +01:00
================
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’
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 ‘ ’ ‘ ’
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, Node: Setting up the staging area, Next: Pushing to the mobile application, Up: Org Mobile
2019-12-06 19:15:46 +01:00
16.16.1 Setting up the staging area
2019-11-26 16:46:24 +01:00
-----------------------------------
The mobile application needs access to a file directory on a server(1)
to interact with Emacs. Pass its location through the
‘ ’
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.), ‘ ’
accessible through, for example, SSH, SCP, or DAVS:
(setq org-mobile-directory "/davs: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 ‘ ’
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 ‘ ’
docstring of that variable.
File: org, Node: Pushing to the mobile application, Next: Pulling from the mobile application, Prev: Setting up the staging area, Up: Org Mobile
2019-12-06 19:15:46 +01:00
16.16.2 Pushing to the mobile application
2019-11-26 16:46:24 +01:00
-----------------------------------------
The command ‘ ’ ‘ ’
into the staging area. Files include agenda files (as listed in
‘ ’ ‘ ’
File names are staged with paths relative to ‘ ’
files should be inside this directory(1).
Push creates a special Org file ‘ ’
views defined by the user(2).
Finally, Org writes the file ‘ ’
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 ‘ ’
their targets.
(2) While creating the agendas, Org mode forces ‘ ’
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 ‘ ’
to ‘ ’
unique.
(3) Checksums are stored automatically in the file ‘ ’
File: org, Node: Pulling from the mobile application, Prev: Pushing to the mobile application, Up: Org Mobile
2019-12-06 19:15:46 +01:00
16.16.3 Pulling from the mobile application
2019-11-26 16:46:24 +01:00
-------------------------------------------
The command ‘ ’
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 ‘ ’
data in an inbox file format, through the following steps:
1. Org moves all entries found in ‘ ’
to the file pointed to by the variable ‘ ’
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 ‘ ’
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 ‘ ’
window. Org also pushes it to the kill ring. To store
flagged note as a normal note, use ‘ ’
Pressing ‘ ’
‘ ’
property drawer; third, it signals that manual editing of the
flagged entry is now finished.
From the agenda dispatcher, ‘ ’
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, Node: Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
Appendix A Hacking
******************
This appendix describes some ways a user can extend the functionality of
Org.
* Menu:
* Hooks: Hooks (2). How to reach into Org’
* Add-on Packages:: Available extensions.
* Adding Hyperlink Types:: New custom link types.
* Adding Export Back-ends:: How to write new export back-ends.
* 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 agenda information.
* Using the Property API:: Writing programs that use entry properties.
* Using the Mapping API:: Mapping over all or selected entries.
File: org, Node: Hooks (2), 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, Node: Add-on Packages, Next: Adding Hyperlink Types, Prev: Hooks (2), 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 ‘ ’
directory for a list of contributed files. Worg page with more
information is at: <https://orgmode.org/worg/org-contrib/>.
File: org, 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 (see *note Hyperlinks::), and an
interface for adding new link types. The following example shows the
process of adding Org links to Unix man pages, which look like this
[[man:printf][The printf manual]]
2020-01-29 18:18:31 +01:00
The following ‘ ’
2019-11-26 16:46:24 +01:00
2020-01-29 18:18:31 +01:00
;;; ol-man.el - Support for links to man pages in Org mode
(require 'ol)
2019-11-26 16:46:24 +01:00
(org-link-set-parameters "man"
:follow org-man-command
:export #'org-man-export
:store #'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-store-link ()
"Store a link to a man page."
(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 "Man page for %s" page)))
2020-01-29 18:18:31 +01:00
(org-link-store-props
2019-11-26 16:46:24 +01:00
: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")))
(defun org-man-export (link description format)
"Export a man page link from Org files."
(let ((path (format "http://man.he.net/?topic=%s§ion=all" link))
(desc (or description link)))
(pcase format
(`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc))
(`latex (format "\\href{%s}{%s}" path desc))
(`texinfo (format "@uref{%s,%s}" path desc))
(`ascii (format "%s (%s)" desc path))
(t path))))
2020-01-29 18:18:31 +01:00
(provide ol-man)
;;; ol-man.el ends here
2019-11-26 16:46:24 +01:00
To activate links to man pages in Org, enter this in the Emacs init
file:
2020-01-29 18:18:31 +01:00
(require 'ol-man)
2019-11-26 16:46:24 +01:00
2020-01-29 18:18:31 +01:00
A review of ‘ ’
2019-11-26 16:46:24 +01:00
2020-01-29 18:18:31 +01:00
1. First, ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
2. Then ‘ ’ ‘ ’
prefix and associates functions for following, exporting and
storing such links. See the variable ‘ ’
complete list of possible associations.
3. The rest of the file implements necessary variables and functions.
For example, ‘ ’
when ‘ ’
2019-12-06 19:15:46 +01:00
buffer displaying a man page. It first checks if the major mode is
appropriate. If check fails, the function returns ‘ ’
2019-11-26 16:46:24 +01:00
means it isn’
buffer. Otherwise the function makes a link string by combining
the ‘ ’
description. The function ‘ ’
into an Org buffer later on.
File: org, Node: Adding Export Back-ends, Next: Tables in Arbitrary Syntax, Prev: Adding Hyperlink Types, Up: Hacking
A.4 Adding Export Back-ends
===========================
Org’
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:
‘ ’ ‘ ’
grok these functions, see ‘ ’
back-end from scratch, and ‘ ’
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 ‘ ’
keyword. For export options specific to this back-end, set the
‘ ’
For creating a new back-end from an existing one, set
‘ ’
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, Node: Tables in Arbitrary Syntax, Next: Dynamic Blocks, Prev: Adding Export Back-ends, Up: Hacking
A.5 Tables in Arbitrary Syntax
==============================
Due to Org’
requested feature is the use of Org’
e.g., 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 is in the hands of those who know those formats best.
* Menu:
* Radio tables:: Sending and receiving radio tables.
* A LaTeX example:: Step by step, almost a tutorial.
* Translator functions:: Copy and modify.
File: org, Node: Radio tables, Next: A LaTeX example, Up: Tables in Arbitrary Syntax
A.5.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 is the magic words ‘
RECEIVE ORGTBL’
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 ...
‘ ’ ’
receiver lines, and the ‘ ’
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 the first N lines of the table. Hlines do count; include them
if they are to be skipped.
‘ ’
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
‘ ’
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 ‘ ’ ‘ ’
• Put the table after an “end” statement. For example ‘ ’
and ‘ ’
• Comment and un-comment each line of the table during edits. The
‘ ’
File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in Arbitrary Syntax
A.5.2 A LaTeX example of radio tables
-------------------------------------
To wrap a source table in LaTeX, use the ‘ ’
by ‘ ’ ‘ ’
document header. Orgtbl mode inserts a radio table skeleton(2) with the
command ‘ ’
For example, if ‘ ’
% BEGIN RECEIVE ORGTBL salesfigures
% END RECEIVE ORGTBL salesfigures
\begin{comment}
#+ORGTBL: SEND salesfigures orgtbl-to-latex
| | |
\end{comment}
The line ‘ ’
‘ ’
table at the target (receive) location named ‘ ’
table is ready for data entry. It can even use spreadsheet features(3):
% 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, ‘ ’
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 mode and uses a ‘ ’
marks horizontal lines with ‘ ’
control output, see *note Translator functions:::
‘ ’
When {{{var(BOOLEAN}}} is non-‘ ’
i.e., not wrapped in ‘ ’ ‘ ’
‘ ’
Format string to warp each field. It should contain ‘ ’
original field value. For example, to wrap each field value in
dollar symbol, you could use ‘ ’
property list with column numbers and formats, for example ‘
"$%s$" 4 "%s\\%%")’
argument can be used; the function must return a formatted string.
‘ ’
Format numbers as exponentials. The spec should have ‘ ’
for inserting mantissa and exponent, for example
‘ ’
numbers and formats, for example ‘
"$%s\\cdot10^{%s}$")’
FMT—see above—is also applied. Functions with two arguments can be
supplied instead of strings. By default, no special formatting is
applied.
---------- Footnotes ----------
(1) <https://www.ctan.org/pkg/comment>
(2) By default this works only for LaTeX, HTML, and Texinfo.
Configure the variable ‘ ’
templates for other modes.
(3) If the ‘ ’
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
‘ ’
If you are using AUCTeX with the font-latex library, a much better
solution is to add the ‘ ’
‘ ’
File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in Arbitrary Syntax
A.5.3 Translator functions
--------------------------
Orgtbl mode has built-in translator functions: ‘ ’
(comma-separated values), ‘ ’
‘ ’ ‘ ’ ‘ ’
‘ ’ ‘ ’
translator, ‘ ’
export back-ends.
Properties passed to the function through the ‘ ’
precedence over properties defined inside the function. For example,
this overrides the default LaTeX line endings, ‘ ’ ‘ ’
#+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 ‘ ’ ‘ ’
and ending of lines with ‘ ’ ‘ ’
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 ‘ ’
list of parameters, each of which can be passed through to
‘ ’ ‘ ’
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 ‘ ’
consisting of parameters specified in the ‘ ’
share your translator functions by posting them to the Org users mailing
list, at <emacs-orgmode@gnu.org>.
File: org, Node: Dynamic Blocks, Next: Special Agenda Views, Prev: Tables in Arbitrary Syntax, Up: Hacking
A.6 Dynamic Blocks
==================
Org supports _dynamic blocks_ in Org documents. They are inserted with
begin and end markers like any other code block, but the contents are
2019-12-06 19:15:46 +01:00
updated automatically by a user function.
You can insert a dynamic block with
‘ ’ ‘ ’
default. For example, ‘ ’
table that updates the work time (see *note Clocking Work Time::).
2019-11-26 16:46:24 +01:00
Dynamic blocks can have names and function parameters. The syntax is
similar to source code block specifications:
#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
...
#+END:
These commands update dynamic blocks:
‘ ’ ‘ ’
Update dynamic block at point.
‘ ’
Update all dynamic blocks in the current file.
Before updating a dynamic block, Org removes content between the
‘ ’ ‘ ’ ‘ ’
2019-12-06 19:15:46 +01:00
line for passing to the writer function as a plist. The previous
content of the dynamic block becomes erased from the buffer and appended
to the plist under ‘ ’
2019-11-26 16:46:24 +01:00
2019-12-29 11:23:16 +01:00
The syntax for naming a writer function with a dynamic block labeled
2019-12-06 19:15:46 +01:00
‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
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’
(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,
‘ ’ ‘ ’
‘ ’
mode.
Dynamic blocks, like any other block, can be narrowed with
‘ ’
File: org, Node: Special Agenda Views, Next: Speeding Up Your Agendas, Prev: Dynamic Blocks, Up: Hacking
A.7 Special Agenda Views
========================
Org provides a special hook to further limit items in agenda views:
‘ ’ ‘ ’ ‘ ’ ‘ ’ ‘ ’ ‘ ’
‘ ’
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
‘ ’
with ‘ ’
This example defines a function for a custom view showing TODO items
with ‘ ’
but with a custom view, this can be automated as follows:
The custom function searches the subtree for the ‘ ’
returns ‘ ’
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 ‘ ’
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 ‘ ’
matched entries, use ‘ ’
forms, such as ‘ ’
‘ ’
‘ ’
Skip current entry if it has been scheduled.
‘ ’
Skip current entry if it has not been scheduled.
‘ ’
Skip current entry if it has a deadline.
‘ ’
Skip current entry if it has a deadline, or if it is scheduled.
‘ ’
Skip current entry if the TODO keyword is TODO or WAITING.
‘ ’
Skip current entry if the TODO keyword marks a DONE state.
‘ ’
Skip current entry if it has any timestamp, may also be deadline or
scheduled.
‘ ’
Skip current entry if the regular expression matches in the entry.
‘ ’
Skip current entry unless the regular expression matches.
‘ ’
Same as above, but check and skip the entire subtree.
The following is an example of a search for ‘ ’
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 ‘ ’ ‘ ’
considers _appointments_, i.e., scheduled and deadline items that have a
time specification ‘ ’
(2) Note that, for ‘ ’
to order in the hierarchy, not to the number of stars.
File: org, Node: Speeding Up Your Agendas, Next: Extracting Agenda Information, Prev: Special Agenda Views, Up: Hacking
A.8 Speeding Up Your Agendas
============================
Some agenda commands slow down when the Org files grow in size or
number. Here are tips to speed up:
• Reduce the number of Org agenda files to avoid slowdowns due to
hard drive accesses.
• Reduce the number of DONE and archived headlines so agenda
operations that skip over these can finish faster.
• Do not dim blocked tasks:
(setq org-agenda-dim-blocked-tasks nil)
• Stop preparing agenda buffers on startup:
(setq org-agenda-inhibit-startup t)
• 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, Node: Extracting Agenda Information, Next: Using the Property API, Prev: Speeding Up Your Agendas, Up: Hacking
A.9 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.
‘ ’
standard output. This command takes one string parameter. When string
consists of a single character, Org uses it as a key to
‘ ’
the agenda dispatcher (see *note Agenda Dispatcher::).
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 ‘ ’
‘ ’
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 produces an agenda for the next 30 days from just the
‘ ’
For structured processing of agenda output, use
‘ ’
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
The TODO keyword, if any
tags
All tags including inherited ones, separated by colons
date
The relevant date, like ‘ ’
time
The time, like ‘ ’
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 ‘ ’ ‘ ’
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, Node: Using the Property API, Next: Using the Mapping API, Prev: Extracting Agenda Information, Up: Hacking
A.10 Using the Property API
===========================
Here is a description of the functions that can be used to work 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
‘ ’ ‘ ’
or ‘ ’ ‘ ’ ‘ ’
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-‘ ’
property, then also check higher levels of the hierarchy. If
INHERIT is the symbol ‘ ’
the setting of ‘ ’
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 VALUES 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. Also
-- 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 are 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 ‘ ’
is one of the values, use the values as completion help, but allow
also other values to be entered. The functions must return ‘ ’
if they are not responsible for this property.
File: org, Node: Using the Mapping API, Prev: Using the Property API, Up: Hacking
A.11 Using the Mapping API
==========================
Org has sophisticated mapping capabilities to find all entries
satisfying certain criteria. Internally, this functionality is used to
produce agenda views, but there is also an API that can be used to
execute arbitrary functions for each or selected entries. The main
entry point for this API 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 point 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
‘ ’
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 ‘ ’
specific buffer position.
MATCH is a tags/property/TODO match. Org iterates only matched
headlines. Org iterates over all headlines when MATCH is ‘ ’
‘ ’
SCOPE determines the scope of this command. It can be any of:
‘ ’
The current buffer, respecting the restriction, if any.
‘ ’
The subtree started with the entry at point.
‘ ’
The entries within the active region, if any.
‘ ’
The current buffer, without restriction.
‘ ’
The current buffer, and any archives associated with it.
‘ ’
All agenda files.
‘ ’
All agenda files with any archive files associated with them.
list of filenames
If this is a list, all files in the list are scanned.
The remaining arguments are treated as settings for the scanner’
skipping facilities. Valid arguments are:
‘ ’
Skip trees with the ‘ ’
‘ ’
Skip trees with the COMMENT keyword.
function or Lisp form
Used as value for ‘ ’
function returns ‘ ’
continues 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 (see *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
‘ ’ ‘ ’
or off.
-- Function: org-promote
Promote the current entry.
-- Function: org-demote
Demote the current entry.
This example turns all entries tagged with ‘ ’
entries with keyword ‘ ’
and archive trees.
(org-map-entries '(org-todo "UPCOMING")
"+TOMORROW" 'file 'archive 'comment)
The following example counts the number of entries with TODO keyword
‘ ’
(length (org-map-entries t "/+WAITING" 'agenda))
File: org, 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 to me. Also, when using outlines to take notes, I
constantly wanted to restructure the tree, organizing it parallel to my
thoughts and plans. _Visibility cycling_ and _structure editing_ were
originally implemented in the package ‘ ’
moved to the more general ‘ ’
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
the mailing list <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’
is today.
John Wiegley
John has contributed a number of great ideas and patches directly
to Org, including the attachment system (‘ ’
integration with Apple Mail (‘ ’
dependencies of TODO items, habit tracking (‘ ’
encryption (‘ ’
extended copy of his great ‘ ’
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 ‘ ’
2019-12-06 19:15:46 +01:00
a JavaScript program for displaying webpages derived from Org using
an Info-like or a folding interface with single-key navigation.
2019-11-26 16:46:24 +01:00
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 ‘ ’ ‘ ’
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’
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’
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.
2019-12-06 19:15:46 +01:00
• Thomas Baumann wrote ‘ ’ ‘ ’
2019-11-26 16:46:24 +01:00
• Christophe Bataillon created the great unicorn logo that we use on
the Org mode website.
• Alex Bochannek provided a patch for rounding timestamps.
2019-12-06 19:15:46 +01:00
• Jan Böcker wrote ‘ ’
2019-11-26 16:46:24 +01:00
• Brad Bozarth showed how to pull RSS feed data into Org files.
• Tom Breton wrote ‘ ’
• Charles Cave’
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 ‘ ’
• Sacha Chua suggested copying some linking code from Planner.
• Baoqiu Cui contributed the DocBook exporter.
• 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.
• 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 ‘ ’
• David Emery provided a patch for custom CSS support in exported
HTML agendas.
• 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 ‘ ’
• 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.
• 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.
2019-12-06 19:15:46 +01:00
• Phil Jackson wrote ‘ ’
2019-11-26 16:46:24 +01:00
• Scott Jaderholm proposed footnotes, control over whitespace between
folded entries, and column view for properties.
• Matt Jones wrote MobileOrg Android.
• Tokuya Kameshima wrote ‘ ’ ‘ ’
• 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 ‘ ’
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.
• 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’
file links, and tags.
• Osamu Okano wrote ‘ ’
version of the reference card.
• Takeshi Okano translated the manual and David O’ ’
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.
• Martin Pohlack provided the code snippet to bundle character
insertion into bundles of 20 for undo.
• 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 ‘ ’
with ‘ ’
• 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.
• Paul Sexton wrote ‘ ’
• Tom Shannon’ ‘ ’
• Ilya Shlyakhter proposed the Archive Sibling, line numbering in
literal examples, and remote highlighting for referenced code
lines.
• Stathis Sideris wrote the ‘ ’
is now packaged into Org’ ‘ ’
• 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.
2019-12-06 19:15:46 +01:00
• Andy Stewart contributed code to ‘ ’
2019-11-26 16:46:24 +01:00
with links transformation to Org syntax.
• David O’ ‘ ’
about publishing.
• Jambunathan K. contributed the ODT 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 ‘ ’
• 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 ‘ ’
contributed various ideas and code snippets.
2019-12-06 19:15:46 +01:00
• Marco Wahl wrote ‘ ’
2019-11-26 16:46:24 +01:00
File: org, 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
2019-12-06 19:15:46 +01:00
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
2019-11-26 16:46:24 +01:00
<http://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’
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’
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’
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’
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’
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’
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’
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
<http://www.gnu.org/copyleft/>.
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’
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.
2019-12-06 19:15:46 +01:00
C.1 ADDENDUM: How to use this License for your documents
========================================================
2019-11-26 16:46:24 +01:00
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:
2019-12-06 19:15:46 +01:00
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''.
2019-11-26 16:46:24 +01:00
If you have Invariant Sections, Front-Cover Texts and Back-Cover
Texts, replace the “with...Texts.” line with this:
2019-12-06 19:15:46 +01:00
with the Invariant Sections being LIST THEIR TITLES, with
the Front-Cover Texts being LIST, and with the Back-Cover Texts
being LIST.
2019-11-26 16:46:24 +01:00
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, Node: Main Index, Next: Key Index, Prev: GNU Free Documentation License, Up: Top
D Main Index
************
* Menu:
* *this*, in post header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 271)
2019-11-26 16:46:24 +01:00
* + suffix, in properties: Property Syntax. (line 48)
* _ALL suffix, in properties: Property Syntax. (line 46)
* abbreviation, links: Link Abbreviations. (line 6)
* abstract, in LaTeX export: Special blocks in LaTeX export.
(line 6)
* action, for publishing: Publishing action. (line 6)
* activation: Activation. (line 6)
* active region: Structure Editing. (line 132)
* add-on packages: Add-on Packages. (line 6)
* agenda: Weekly/daily agenda. (line 6)
* agenda dispatcher: Agenda Dispatcher. (line 6)
* agenda files: Agenda Files. (line 6)
2020-02-05 19:59:48 +01:00
* agenda files, removing buffers: Agenda Commands. (line 493)
2019-12-06 19:15:46 +01:00
* agenda filtering: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* agenda views: Agenda Views. (line 6)
* agenda views, custom: Custom Agenda Views. (line 6)
* agenda views, exporting: Exporting Agenda Views.
(line 6)
* agenda views, exporting <1>: Exporting Agenda Views.
(line 13)
* agenda views, main example: Storing searches. (line 11)
* 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 11)
* agenda, as an agenda views: Storing searches. (line 11)
* agenda, column view: Agenda Column View. (line 6)
* agenda, pipe: Extracting Agenda Information.
(line 6)
* agenda, with block views: Block agenda. (line 6)
* alignment in tables: Column Width and Alignment.
(line 6)
* ALLTAGS, special property: Special Properties. (line 13)
2019-12-06 19:15:46 +01:00
* ALT_TITLE, property: Table of Contents. (line 68)
2019-11-26 16:46:24 +01:00
* ALT_TITLE, property <1>: Headings and sectioning structure.
(line 24)
* angle bracket links: Link Format. (line 6)
2019-12-06 19:15:46 +01:00
* angular brackets, around links: External Links. (line 136)
2019-11-26 16:46:24 +01:00
* anniversaries, from BBDB: Weekly/daily agenda. (line 78)
* API, for mapping: Using the Mapping API.
(line 6)
* API, for properties: Using the Property API.
(line 6)
* APPENDIX, property: Headings and sectioning structure.
(line 20)
* appointment: Timestamps. (line 14)
* appointment <1>: Weekly/daily agenda. (line 125)
* appointment reminders: Weekly/daily agenda. (line 125)
* appt.el: Weekly/daily agenda. (line 125)
* APPT_WARNTIME, keyword: Weekly/daily agenda. (line 125)
* archive locations: Moving subtrees. (line 25)
* ARCHIVE, keyword: Moving subtrees. (line 35)
* ARCHIVE, keyword <1>: In-buffer Settings. (line 15)
* ARCHIVE, property: Property Inheritance.
(line 33)
* ARCHIVE, property <1>: Moving subtrees. (line 37)
* ARCHIVE, tag: Internal archiving. (line 6)
* archived entries, in agenda views: Agenda Views. (line 37)
2019-12-06 19:15:46 +01:00
* archiving: Refiling and Archiving.
(line 6)
* archiving <1>: Archiving. (line 6)
2019-11-26 16:46:24 +01:00
* arguments, in code blocks: Environment of a Code Block.
(line 9)
* ASCII export: ASCII/Latin-1/UTF-8 export.
(line 6)
* ASCII, keyword: ASCII/Latin-1/UTF-8 export.
(line 63)
2019-12-06 19:15:46 +01:00
* Atom feeds: Capture and Attachments.
(line 6)
* Atom feeds <1>: RSS Feeds. (line 6)
* attach from Dired: Attach from Dired. (line 6)
* attachment links: External Links. (line 6)
* attachment links, searching: Search Options. (line 6)
* attachments: Capture and Attachments.
(line 6)
* attachments <1>: Attachments. (line 6)
2019-11-26 16:46:24 +01:00
* ATTR_ASCII, keyword: ASCII/Latin-1/UTF-8 export.
(line 74)
* ATTR_BEAMER, keyword: Beamer specific syntax.
(line 35)
* ATTR_HTML, keyword: Links in HTML export.
(line 27)
* ATTR_HTML, keyword <1>: Tables in HTML export.
(line 11)
* ATTR_HTML, keyword <2>: Images in HTML export.
(line 28)
* ATTR_LATEX, keyword: Images in LaTeX export.
(line 6)
* ATTR_LATEX, keyword <1>: Plain lists in LaTeX export.
(line 6)
* ATTR_LATEX, keyword <2>: Source blocks in LaTeX export.
(line 6)
* ATTR_LATEX, keyword <3>: Example blocks in LaTeX export.
(line 6)
* ATTR_LATEX, keyword <4>: Special blocks in LaTeX export.
(line 6)
* ATTR_LATEX, keyword <5>: Horizontal rules in LaTeX export.
(line 6)
* ATTR_ODT, keyword: Tables in ODT export.
(line 20)
* ATTR_ODT, keyword <1>: Images in ODT export.
(line 31)
* ATTR_ODT, keyword <2>: Images in ODT export.
(line 76)
* ATTR_ODT, keyword <3>: Advanced topics in ODT export.
(line 151)
* ATTR_TEXINFO, keyword: Plain lists in Texinfo export.
(line 6)
* ATTR_TEXINFO, keyword <1>: Tables in Texinfo export.
(line 6)
* ATTR_TEXINFO, keyword <2>: Images in Texinfo export.
(line 6)
* ATTR_TEXINFO, keyword <3>: Quotations in Texinfo export.
(line 6)
* ATTR_TEXINFO, keyword <4>: Special blocks in Texinfo export.
(line 6)
* author: Feedback. (line 6)
* AUTHOR, keyword: Export Settings. (line 25)
* author, macro: Macro Replacement. (line 41)
* auto-save, in code block editing: Editing Source Code. (line 11)
* autoload: Activation. (line 6)
* babel, languages: Languages. (line 6)
* babel, library of: Library of Babel. (line 6)
2019-12-06 19:15:46 +01:00
* backslashes, in links: Link Format. (line 17)
2019-11-26 16:46:24 +01:00
* backtrace of an error: Feedback. (line 66)
* BBDB links: External Links. (line 6)
* BBDB, anniversaries: Weekly/daily agenda. (line 78)
* Beamer export: Beamer Export. (line 6)
* BEAMER, keyword: Beamer specific syntax.
(line 19)
* BEAMER_ACT, property: Frames and Blocks in Beamer.
(line 41)
* BEAMER_COL, property: Frames and Blocks in Beamer.
(line 49)
* BEAMER_ENV, property: Frames and Blocks in Beamer.
(line 14)
* BEAMER_FONT_THEME, keyword: Beamer specific export settings.
(line 17)
* BEAMER_HEADER, keyword: Beamer specific export settings.
(line 26)
* BEAMER_INNER_THEME, keyword: Beamer specific export settings.
(line 20)
* BEAMER_OPT, property: Frames and Blocks in Beamer.
(line 41)
* BEAMER_OUTER_THEME, keyword: Beamer specific export settings.
(line 23)
* BEAMER_REF, property: Frames and Blocks in Beamer.
(line 27)
* BEAMER_THEME, keyword: Beamer specific export settings.
(line 11)
2019-12-06 19:15:46 +01:00
* BEGIN clocktable: The clock table. (line 33)
2019-11-26 16:46:24 +01:00
* BEGIN columnview: Capturing column view.
(line 11)
* BEGIN_CENTER: Paragraphs. (line 32)
* BEGIN_COMMENT: Comment Lines. (line 10)
* BEGIN_EXAMPLE: Literal Examples. (line 10)
* BEGIN_EXPORT ascii: ASCII/Latin-1/UTF-8 export.
(line 63)
* BEGIN_EXPORT beamer: Beamer specific syntax.
(line 19)
2019-12-06 19:15:46 +01:00
* BEGIN_EXPORT html: Quoting HTML tags. (line 13)
2019-11-26 16:46:24 +01:00
* BEGIN_EXPORT latex: Quoting LaTeX code. (line 18)
* BEGIN_EXPORT texinfo: Quoting Texinfo code.
(line 9)
* BEGIN_JUSTIFYLEFT: ASCII/Latin-1/UTF-8 export.
(line 84)
* BEGIN_JUSTIFYRIGHT: ASCII/Latin-1/UTF-8 export.
(line 84)
* BEGIN_QUOTE: Paragraphs. (line 25)
2019-12-06 19:15:46 +01:00
* BEGIN_SRC: Literal Examples. (line 38)
2019-11-26 16:46:24 +01:00
* BEGIN_SRC <1>: Structure of Code Blocks.
(line 6)
* BEGIN_VERSE: Paragraphs. (line 13)
* BIND, keyword: Export Settings. (line 210)
* block agenda: Block agenda. (line 6)
* BLOCKED, special property: Special Properties. (line 13)
2019-12-06 19:15:46 +01:00
* blocking, of checkboxes: Checkboxes. (line 45)
2019-11-26 16:46:24 +01:00
* blocks, folding: Blocks. (line 6)
* bold text, markup rules: Emphasis and Monospace.
(line 6)
* boolean logic, for agenda searches: Matching tags and properties.
(line 32)
* bracket links: Link Format. (line 9)
* bug reports: Feedback. (line 6)
* C-c C-c, overview: The Very Busy C-c C-c Key.
(line 6)
* cache results of code evaluation: Evaluating Code Blocks.
(line 106)
* cache, header argument: Evaluating Code Blocks.
(line 106)
* Calc package: The Spreadsheet. (line 6)
* calc.el: Cooperation. (line 7)
* calculations, in tables: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 179)
2019-11-26 16:46:24 +01:00
* calculations, in tables <1>: The Spreadsheet. (line 6)
2020-02-05 19:59:48 +01:00
* calendar commands, from agenda: Agenda Commands. (line 443)
2019-11-26 16:46:24 +01:00
* calendar integration: Weekly/daily agenda. (line 32)
* calendar, for selecting date: The date/time prompt.
(line 75)
* CALL, keyword: Evaluating Code Blocks.
(line 27)
* CAPTION, keyword: Captions. (line 6)
* CAPTION, keyword <1>: Tables in HTML export.
(line 11)
* CAPTION, keyword <2>: Images in HTML export.
(line 28)
* captions, markup rules: Captions. (line 6)
2019-12-06 19:15:46 +01:00
* capture: Capture and Attachments.
2019-11-26 16:46:24 +01:00
(line 6)
* capture <1>: Capture. (line 6)
2019-12-06 19:15:46 +01:00
* capture protocol: The capture protocol.
(line 6)
2020-02-05 19:59:48 +01:00
* capturing, from agenda: Agenda Commands. (line 342)
2019-11-26 16:46:24 +01:00
* category: Categories. (line 6)
2019-12-06 19:15:46 +01:00
* category filtering, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* category, for tags/property match: Matching tags and properties.
(line 64)
* CATEGORY, keyword: Categories. (line 6)
* CATEGORY, keyword <1>: In-buffer Settings. (line 19)
* CATEGORY, property: Property Inheritance.
(line 29)
* CATEGORY, property <1>: Categories. (line 12)
* CDLaTeX: CDLaTeX mode. (line 6)
* cdlatex.el: Cooperation. (line 24)
* center blocks: Paragraphs. (line 32)
* center image in LaTeX export: Images in LaTeX export.
2019-12-06 19:15:46 +01:00
(line 60)
2019-11-26 16:46:24 +01:00
* change agenda display: Agenda Commands. (line 63)
2019-12-06 19:15:46 +01:00
* checkbox blocking: Checkboxes. (line 45)
* checkbox statistics: Checkboxes. (line 29)
2019-11-26 16:46:24 +01:00
* checkboxes: Checkboxes. (line 6)
* checkboxes and TODO dependencies: TODO dependencies. (line 53)
* children, subtree visibility state: Global and local cycling.
(line 6)
* CINDEX, keyword: Indices. (line 6)
2019-12-06 19:15:46 +01:00
* CLASS, property: iCalendar Export. (line 51)
2019-11-26 16:46:24 +01:00
* clean outline view: Clean View. (line 6)
* clocking time: Clocking Work Time. (line 6)
* CLOCKSUM, special property: Special Properties. (line 13)
2019-12-06 19:15:46 +01:00
* CLOCKSUM, special property <1>: Agenda Column View. (line 32)
2019-11-26 16:46:24 +01:00
* CLOCKSUM_T, special property: Special Properties. (line 13)
2019-12-06 19:15:46 +01:00
* CLOCKSUM_T, special property <1>: Agenda Column View. (line 56)
2019-11-26 16:46:24 +01:00
* clocktable, dynamic block: The clock table. (line 6)
2019-12-06 19:15:46 +01:00
* CLOCK_MODELINE_TOTAL, property: Clocking commands. (line 21)
2019-11-26 16:46:24 +01:00
* CLOSED, special property: Special Properties. (line 13)
* 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, 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)
* colnames, header argument: Environment of a Code Block.
(line 48)
* 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 89)
* COLUMNS, keyword: Scope of column definitions.
(line 8)
* COLUMNS, property: Property Inheritance.
(line 22)
* COLUMNS, property <1>: In-buffer Settings. (line 23)
2019-12-06 19:15:46 +01:00
* comma escape, in literal examples: Literal Examples. (line 14)
2019-11-26 16:46:24 +01:00
* commands, in agenda buffer: Agenda Commands. (line 6)
* comment block: Comment Lines. (line 10)
* comment lines: Comment Lines. (line 6)
* comment trees: Comment Lines. (line 13)
* commented entries, in agenda views: Agenda Views. (line 37)
* comments, header argument: Extracting Source Code.
(line 46)
* completion, of dictionary words: Completion. (line 6)
* completion, of file names: Handling Links. (line 92)
* completion, of link abbreviations: Completion. (line 6)
* completion, of links: Handling Links. (line 69)
* completion, of option keywords: Per-file keywords. (line 26)
* 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 17)
* completion, of TODO keywords <1>: Completion. (line 6)
* concept index, in Texinfo export: Indices. (line 6)
* constants, in calculations: References. (line 113)
* CONSTANTS, keyword: References. (line 113)
* CONSTANTS, keyword <1>: In-buffer Settings. (line 28)
* constants.el: Cooperation. (line 14)
* contents, global visibility state: Global and local cycling.
(line 20)
* continuous clocking: Resolving idle time. (line 78)
* control code block evaluation: Evaluating Code Blocks.
(line 81)
* convert: Advanced topics in ODT export.
(line 12)
* converter: Advanced topics in ODT export.
(line 12)
* COOKIE_DATA, property: Breaking Down Tasks. (line 21)
2019-12-06 19:15:46 +01:00
* COOKIE_DATA, property <1>: Checkboxes. (line 29)
2019-11-26 16:46:24 +01:00
* coordinates, of field: References. (line 89)
2019-12-06 19:15:46 +01:00
* copying notes: Refiling and Archiving.
(line 6)
* copying notes <1>: Refile and Copy. (line 6)
2019-11-26 16:46:24 +01:00
* copying, of subtrees: Structure Editing. (line 6)
* COPYING, property: Texinfo title and copyright page.
(line 19)
* countdown timer: Timers. (line 6)
* counter, macro: Macro Replacement. (line 75)
* CREATOR, keyword: Export Settings. (line 28)
* CSS, for HTML export: CSS support. (line 6)
* cua.el: Conflicts. (line 17)
* custom agenda views: Custom Agenda Views. (line 6)
* custom date/time format: Custom time format. (line 6)
* custom search strings: Custom Searches. (line 6)
2019-12-29 11:23:16 +01:00
* CUSTOM_ID, property: Internal Links. (line 11)
2019-11-26 16:46:24 +01:00
* CUSTOM_ID, property <1>: Handling Links. (line 21)
* cutting, of subtrees: Structure Editing. (line 6)
* cycling, in plain lists: Plain Lists. (line 70)
* cycling, of agenda files: Agenda Files. (line 26)
* 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 36)
* 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 7)
* DATE, keyword: Export Settings. (line 32)
* date, macro: Macro Replacement. (line 49)
* date, reading in minibuffer: The date/time prompt.
(line 6)
* dates: Dates and Times. (line 6)
* DEADLINE marker: Deadlines and Scheduling.
(line 11)
* DEADLINE, special property: Special Properties. (line 13)
* deadlines: Timestamps. (line 6)
* debugging, of table formulas: Editing and debugging formulas.
(line 132)
* default header arguments per language: Using Header Arguments.
(line 36)
* defining new protocols: Protocols. (line 25)
* demotion, of subtrees: Structure Editing. (line 6)
* dependencies, of TODO states: TODO dependencies. (line 6)
* DESCRIPTION, keyword: Beamer specific export settings.
(line 30)
* DESCRIPTION, keyword <1>: HTML specific export settings.
(line 10)
* DESCRIPTION, keyword <2>: LaTeX specific export settings.
(line 11)
* DESCRIPTION, keyword <3>: ODT specific export settings.
(line 11)
* DESCRIPTION, property: Headings and sectioning structure.
(line 24)
* DESCRIPTION, property <1>: iCalendar Export. (line 51)
2020-02-05 19:59:48 +01:00
* diary entries, creating from agenda: Agenda Commands. (line 452)
2019-11-26 16:46:24 +01:00
* diary integration: Weekly/daily agenda. (line 32)
* diary style timestamps: Timestamps. (line 34)
* dictionary word completion: Completion. (line 6)
* dir file, in Texinfo export: Info directory file. (line 6)
* dir, header argument: Environment of a Code Block.
(line 302)
2019-12-06 19:15:46 +01:00
* DIR, property: Attachment defaults and dispatcher.
(line 67)
* DIR, property <1>: Attachment defaults and dispatcher.
(line 72)
2019-11-26 16:46:24 +01:00
* directories, for publishing: Sources and destinations.
(line 6)
* dispatcher, for export commands: The Export Dispatcher.
(line 6)
* dispatching agenda commands: Agenda Dispatcher. (line 6)
* display changing, in agenda: Agenda Commands. (line 63)
* doc, docx, rtf: Advanced topics in ODT export.
(line 12)
* document structure: Document Structure. (line 6)
* document title: Export Settings. (line 60)
* documentation: Documentation Access.
(line 6)
* DONE, final TODO keyword: Per-file keywords. (line 29)
* 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>: LaTeX math snippets. (line 50)
* dvisvgm: Math formatting in HTML export.
(line 6)
* dvisvgm <1>: LaTeX math snippets. (line 50)
* dynamic blocks: Dynamic Blocks. (line 6)
* dynamic indentation: Clean View. (line 6)
* ecomplete.el: Conflicts. (line 32)
* 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)
2019-12-06 19:15:46 +01:00
* effort filtering, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* EFFORT, property: Effort Estimates. (line 6)
* Elisp links: External Links. (line 6)
* ellipsis, special symbol: Special Symbols. (line 36)
* ELPA: Activation. (line 6)
* EMAIL, keyword: Export Settings. (line 35)
* email, macro: Macro Replacement. (line 41)
* embedding images in ODT: Images in ODT export.
(line 6)
* entities: Special Symbols. (line 6)
2019-12-06 19:15:46 +01:00
* enum, Texinfo attribute: Plain lists in Texinfo export.
(line 35)
2019-11-26 16:46:24 +01:00
* epilogue, header argument: Environment of a Code Block.
2019-12-06 19:15:46 +01:00
(line 352)
2019-11-26 16:46:24 +01:00
* escape character: Escape Character. (line 6)
* escape syntax, for links: Link Format. (line 17)
* eval, header argument: Evaluating Code Blocks.
(line 81)
* evaluate time range: Creating Timestamps. (line 62)
* example block: Literal Examples. (line 10)
* example blocks, in LaTeX export: Example blocks in LaTeX export.
(line 6)
* EXCLUDE_TAGS, keyword: Export Settings. (line 52)
* excluding entries from table of contents: Table of Contents.
(line 15)
* export back-end: Exporting. (line 12)
* export, dispatcher: The Export Dispatcher.
(line 6)
* export, include files: Include Files. (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: Exporting Agenda Views.
(line 13)
* exporting, not: Comment Lines. (line 6)
* exports, header argument: Exporting Code Blocks.
(line 14)
* EXPORT_FILE_NAME, keyword: Export Settings. (line 64)
* EXPORT_FILE_NAME, property: ODT export commands. (line 9)
* EXPORT_LATEX_CLASS, property: LaTeX header and sectioning.
(line 23)
* EXPORT_LATEX_CLASS_OPTIONS, property: LaTeX header and sectioning.
(line 23)
* 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 89)
* 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 92)
* file, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 151)
2019-11-26 16:46:24 +01:00
* FILE, special property: Special Properties. (line 13)
* file-desc, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 172)
2019-11-26 16:46:24 +01:00
* file-ext, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 161)
2019-11-26 16:46:24 +01:00
* files for agenda: Agenda Files. (line 6)
* files, adding to agenda list: Agenda Files. (line 16)
* files, selecting for publishing: Selecting files. (line 6)
* FILETAGS, keyword: Tag Inheritance. (line 20)
* FILETAGS, keyword <1>: In-buffer Settings. (line 34)
* filladapt.el: Conflicts. (line 43)
2019-12-06 19:15:46 +01:00
* filtering entries, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* Filters, exporting: Advanced Export Configuration.
(line 31)
* FINDEX, keyword: Indices. (line 6)
* FLAGGED, tag: Pulling from the mobile application.
(line 18)
* folded, subtree visibility state: Global and local cycling.
(line 6)
* folding, sparse trees: Sparse Trees. (line 6)
* following links: Handling Links. (line 102)
* footers, in code blocks: Environment of a Code Block.
2019-12-06 19:15:46 +01:00
(line 344)
2019-11-26 16:46:24 +01:00
* footnotes: Creating Footnotes. (line 6)
* format specifier, in spreadsheet: Formula syntax for Calc.
(line 17)
* format, of links: Link Format. (line 6)
2019-12-06 19:15:46 +01:00
* formatting source code, markup rules: Literal Examples. (line 31)
2019-11-26 16:46:24 +01:00
* formula debugging: Editing and debugging formulas.
(line 132)
* 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.
2019-12-06 19:15:46 +01:00
(line 179)
2019-11-26 16:46:24 +01:00
* function index, in Texinfo export: Indices. (line 6)
* global cycling: Global and local cycling.
(line 20)
* global key bindings: Activation. (line 6)
* global TODO list: Global TODO list. (line 6)
* global visibility states: Global and local cycling.
(line 20)
* 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 57)
* grouping columns in tables: Column Groups. (line 6)
* habits: Tracking your habits.
(line 6)
* hacking: Hacking. (line 6)
* header arguments per language: Using Header Arguments.
(line 74)
* header arguments, in code blocks: Structure of Code Blocks.
(line 57)
* header lines, in tables: Built-in Table Editor.
(line 6)
* header, for LaTeX files: LaTeX header and sectioning.
(line 6)
* HEADER, keyword: Using Header Arguments.
(line 114)
* headers, in code blocks: Environment of a Code Block.
2019-12-06 19:15:46 +01:00
(line 344)
2019-11-26 16:46:24 +01:00
* headline navigation: Motion. (line 6)
* headline tagging: Tags. (line 6)
* headline, promotion and demotion: Structure Editing. (line 6)
* headlines: Headlines. (line 6)
2019-12-06 19:15:46 +01:00
* headlines, in HTML export: Headlines in HTML export.
(line 6)
* Help links: External Links. (line 6)
2019-11-26 16:46:24 +01:00
* hide text: Visibility Cycling. (line 6)
* hiding leading stars: Clean View. (line 6)
* hlines, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 101)
2019-11-26 16:46:24 +01:00
* hooks: Hooks (2). (line 6)
* horizontal rule, in tables: Built-in Table Editor.
(line 6)
* horizontal rules, in ASCII export: ASCII/Latin-1/UTF-8 export.
(line 74)
* horizontal rules, in LaTeX export: Horizontal rules in LaTeX export.
(line 6)
* horizontal rules, markup rules: Horizontal Rules. (line 6)
* HTML export: HTML Export. (line 6)
* HTML export, CSS: CSS support. (line 6)
* HTML, and Orgtbl mode: Translator functions.
(line 6)
2019-12-06 19:15:46 +01:00
* HTML, keyword: Quoting HTML tags. (line 13)
2019-11-26 16:46:24 +01:00
* html-style, OPTIONS item: CSS support. (line 56)
* HTML5, export new elements: HTML doctypes. (line 25)
* HTML_CONTAINER, keyword: HTML specific export settings.
(line 19)
* HTML_CONTAINER_CLASS, property: CSS support. (line 62)
* HTML_DOCTYPE, keyword: HTML specific export settings.
(line 16)
* HTML_HEAD, keyword: HTML specific export settings.
(line 35)
* HTML_HEAD, keyword <1>: CSS support. (line 49)
2019-12-06 19:15:46 +01:00
* HTML_HEADLINE_CLASS, property: CSS support. (line 62)
2019-11-26 16:46:24 +01:00
* HTML_HEAD_EXTRA, keyword: HTML specific export settings.
(line 39)
* HTML_HEAD_EXTRA, keyword <1>: CSS support. (line 49)
* HTML_INCLUDE_STYLE, keyword: CSS support. (line 44)
* HTML_LINK_HOME, keyword: HTML specific export settings.
(line 23)
* HTML_LINK_UP, keyword: HTML specific export settings.
(line 26)
* HTML_MATHJAX, keyword: HTML specific export settings.
(line 30)
* hyperlinks: Hyperlinks. (line 6)
* hyperlinks, adding new types: Adding Hyperlink Types.
(line 6)
* iCalendar export: iCalendar Export. (line 6)
* ID, property: Handling Links. (line 21)
* ID, property <1>: Capturing column view.
(line 34)
* ID, property <2>: iCalendar Export. (line 26)
* identify, ImageMagick: Images in ODT export.
(line 34)
* idle, resolve, dangling: Resolving idle time. (line 9)
* image, centering in LaTeX export: Images in LaTeX export.
2019-12-06 19:15:46 +01:00
(line 60)
2019-11-26 16:46:24 +01:00
* ImageMagick: Math formatting in HTML export.
(line 6)
* ImageMagick <1>: LaTeX math snippets. (line 50)
* 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, markup rules: Images. (line 6)
* imenu.el: Cooperation. (line 29)
* in-buffer settings: In-buffer Settings. (line 6)
* inactive timestamp: Timestamps. (line 50)
* include files, during export: Include Files. (line 6)
* INCLUDE, keyword: Include Files. (line 6)
2019-12-06 19:15:46 +01:00
* Indent mode: Org Indent Mode. (line 6)
2019-11-26 16:46:24 +01:00
* indentation, in code blocks: Editing Source Code. (line 32)
2019-12-06 19:15:46 +01:00
* indentation, in source blocks: Literal Examples. (line 81)
2019-11-26 16:46:24 +01:00
* index, in a publishing project: Generating an index. (line 6)
* INDEX, keyword: Generating an index. (line 17)
* INDEX, property: Indices. (line 14)
2019-12-06 19:15:46 +01:00
* indic, Texinfo attribute: Plain lists in Texinfo export.
(line 12)
2019-11-26 16:46:24 +01:00
* Info: Documentation Access.
(line 6)
* Info directory file, in Texinfo export: Info directory file.
(line 6)
* Info links: External Links. (line 6)
* INFOJS_OPT, keyword: JavaScript support. (line 20)
* inheritance, of properties: Property Inheritance.
(line 6)
* inheritance, of tags: Tag Inheritance. (line 6)
* inline, in LaTeX export: Quoting LaTeX code. (line 10)
* inlining images: Images. (line 6)
* 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 64)
* inserting links: Handling Links. (line 69)
* insertion, of templates: Structure Templates. (line 6)
* insertion, of templates <1>: Structure Templates. (line 21)
* install-info, 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)
2019-12-06 19:15:46 +01:00
* IRC links: External Links. (line 6)
2019-11-26 16:46:24 +01:00
* italic text, markup rules: Emphasis and Monospace.
(line 6)
* ITEM, special property: Special Properties. (line 13)
* 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)
* keyword, macro: Macro Replacement. (line 41)
* KEYWORDS, keyword: Beamer specific export settings.
(line 37)
* KEYWORDS, keyword <1>: HTML specific export settings.
(line 43)
* KEYWORDS, keyword <2>: LaTeX specific export settings.
(line 54)
* KEYWORDS, keyword <3>: ODT specific export settings.
(line 16)
* KINDEX, keyword: Indices. (line 6)
* language specific default header arguments: Using Header Arguments.
(line 36)
* language specific header arguments properties: Using Header Arguments.
(line 74)
* language, in code blocks: Structure of Code Blocks.
(line 47)
* LANGUAGE, keyword: Export Settings. (line 38)
* LANGUAGE, keyword <1>: LaTeX specific export settings.
(line 20)
2019-12-06 19:15:46 +01:00
* LAST_REPEAT, property: Clocking commands. (line 21)
2019-11-26 16:46:24 +01:00
* LaTeX class: LaTeX header and sectioning.
(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)
* LATEX, keyword: Quoting LaTeX code. (line 14)
* LATEX_CLASS, keyword: LaTeX specific export settings.
(line 32)
* LATEX_CLASS, keyword <1>: LaTeX header and sectioning.
(line 23)
* LATEX_CLASS_OPTIONS, keyword: LaTeX specific export settings.
(line 40)
* LATEX_CLASS_OPTIONS, keyword <1>: LaTeX header and sectioning.
(line 23)
* LATEX_COMPILER, keyword: LaTeX/PDF export commands.
(line 25)
* LATEX_COMPILER, keyword <1>: LaTeX specific export settings.
(line 44)
* LATEX_HEADER, keyword: HTML specific export settings.
(line 48)
* LATEX_HEADER, keyword <1>: LaTeX specific export settings.
(line 49)
* LATEX_HEADER, keyword <2>: LaTeX header and sectioning.
(line 30)
* LATEX_HEADER_EXTRA, keyword: LaTeX specific export settings.
(line 49)
* LATEX_HEADER_EXTRA, keyword <1>: LaTeX header and sectioning.
(line 30)
* Latin-1 export: ASCII/Latin-1/UTF-8 export.
(line 6)
2019-12-06 19:15:46 +01:00
* lettered lists, in Texinfo export: Plain lists in Texinfo export.
(line 35)
2019-11-26 16:46:24 +01:00
* level, for tags/property match: Matching tags and properties.
(line 64)
* LibreOffice: OpenDocument Text Export.
(line 6)
2019-12-06 19:15:46 +01:00
* limits, in agenda: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 128)
2019-11-26 16:46:24 +01:00
* line breaks, markup rules: Paragraphs. (line 9)
* lines, include: Include Files. (line 36)
* link abbreviations: Link Abbreviations. (line 6)
* link abbreviations, completion of: Completion. (line 6)
* link completion: Handling Links. (line 69)
* link format: Link Format. (line 6)
* LINK, keyword: Link Abbreviations. (line 50)
* LINK, keyword <1>: In-buffer Settings. (line 38)
* links, external: External Links. (line 6)
* links, finding next/previous: Handling Links. (line 151)
* 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 144)
* 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)
* LOCATION, property: iCalendar Export. (line 51)
* logging, of progress: Progress Logging. (line 6)
* LOGGING, property: Tracking TODO state changes.
2019-12-06 19:15:46 +01:00
(line 45)
2019-11-26 16:46:24 +01:00
* LOGGING, property <1>: Property Inheritance.
(line 37)
* LOG_INTO_DRAWER, property: Tracking TODO state changes.
(line 6)
* LOG_INTO_DRAWER, property <1>: Clocking commands. (line 7)
* lookup functions in tables: Lookup functions. (line 6)
* lualatex: LaTeX/PDF export commands.
(line 25)
* macro replacement, during export: Macro Replacement. (line 6)
* MACRO, keyword: Macro Replacement. (line 6)
* maintainer: Feedback. (line 6)
* mapping entries, API: Using the Mapping API.
(line 6)
2019-12-06 19:15:46 +01:00
* mappings in open-source protocol: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 67)
* mark ring: Handling Links. (line 139)
* 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: LaTeX math snippets. (line 10)
* MH-E links: External Links. (line 6)
* minlevel, include: Include Files. (line 22)
* minor mode for tables: Orgtbl Mode. (line 6)
2019-12-06 19:15:46 +01:00
* mkdirp, header argument: Environment of a Code Block.
(line 302)
* mkdirp, header argument <1>: Extracting Source Code.
2019-11-26 16:46:24 +01:00
(line 42)
* mode, for Calc: Formula syntax for Calc.
(line 17)
* modification-time, macro: Macro Replacement. (line 56)
* motion commands in agenda: Agenda Commands. (line 19)
* motion, between headlines: Motion. (line 6)
* multiple formula lines: Editing and debugging formulas.
(line 98)
* multiple items in Texinfo lists: Plain lists in Texinfo export.
(line 17)
* n, macro: Macro Replacement. (line 75)
* NAME keyword, in source blocks: Structure of Code Blocks.
(line 6)
* NAME, keyword: References. (line 134)
* NAME, keyword <1>: Internal Links. (line 21)
* name, of column or field: References. (line 113)
* name, of column or field <1>: References. (line 134)
* named references: References. (line 113)
* names as TODO keywords: TODO types. (line 6)
* narrow columns in tables: Column Width and Alignment.
(line 6)
* no-expand, header argument: Extracting Source Code.
(line 97)
* NOBLOCKING, property: TODO dependencies. (line 29)
* noweb, header argument: Noweb Reference Syntax.
(line 13)
* noweb-ref, header argument: Noweb Reference Syntax.
(line 118)
* noweb-sep, header argument: Noweb Reference Syntax.
(line 150)
2019-12-06 19:15:46 +01:00
* number headlines: Dynamic Headline Numbering.
(line 6)
2019-11-26 16:46:24 +01:00
* occur, command: Sparse Trees. (line 6)
* occur-tree: Storing searches. (line 11)
* odd-levels-only outlines: Clean View. (line 6)
* ODT: OpenDocument Text Export.
(line 6)
* ODT, keyword: Advanced topics in ODT export.
(line 120)
* ODT_STYLES_FILE, keyword: ODT specific export settings.
(line 22)
* ODT_STYLES_FILE, keyword <1>: Applying custom styles.
(line 29)
* only-contents, include: Include Files. (line 53)
2019-12-06 19:15:46 +01:00
* open-source protocol: The open-source protocol.
2019-11-26 16:46:24 +01:00
(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 export: Export Settings. (line 6)
* options, for publishing: Publishing options. (line 6)
* OPTIONS, keyword: Export Settings. (line 6)
* ordered lists: Plain Lists. (line 6)
* ORDERED, property: TODO dependencies. (line 6)
2019-12-06 19:15:46 +01:00
* ORDERED, property <1>: Checkboxes. (line 45)
2019-11-26 16:46:24 +01:00
* Org export: Org Export. (line 6)
* Org mode, turning on: Activation. (line 24)
2019-12-06 19:15:46 +01:00
* Org Num mode: Dynamic Headline Numbering.
(line 6)
2019-11-26 16:46:24 +01:00
* Org protocol, set-up: Protocols. (line 14)
* org-agenda, command: Weekly/daily agenda. (line 10)
* Orgtbl mode: Orgtbl Mode. (line 6)
* Orgtbl mode <1>: Tables in Arbitrary Syntax.
(line 6)
* ORGTBL, keyword: Radio tables. (line 21)
* outline tree: Headlines. (line 6)
* output-dir, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 151)
2019-11-26 16:46:24 +01:00
* overview, global visibility state: Global and local cycling.
(line 20)
* packages, interaction with other: Interaction. (line 6)
* padline, header argument: Extracting Source Code.
(line 73)
* paragraphs, markup rules: Paragraphs. (line 6)
* passing arguments to code blocks: Environment of a Code Block.
(line 9)
* pasting, of subtrees: Structure Editing. (line 6)
* PDF export: LaTeX Export. (line 6)
* pdflatex: LaTeX/PDF export commands.
(line 25)
* per-file keywords: Per-file keywords. (line 6)
* PINDEX, keyword: Indices. (line 6)
* plain links: Link Format. (line 6)
* plain lists: Plain Lists. (line 6)
* plain lists, in LaTeX export: Plain lists in LaTeX export.
(line 6)
2019-12-06 19:15:46 +01:00
* plain text external links: External Links. (line 136)
2019-11-26 16:46:24 +01:00
* plot tables using Gnuplot: Org Plot. (line 6)
* PLOT, keyword: Org Plot. (line 12)
* post, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 271)
2019-11-26 16:46:24 +01:00
* presentation, of agenda items: Presentation and Sorting.
(line 6)
* print edition: Summary. (line 54)
* printing sparse trees: Sparse Trees. (line 52)
* priorities: Priorities. (line 6)
* PRIORITIES, keyword: Priorities. (line 44)
* PRIORITIES, keyword <1>: In-buffer Settings. (line 43)
* priorities, of agenda items: Sorting of agenda items.
(line 6)
* priority cookie: Priorities. (line 6)
* PRIORITY, special property: Special Properties. (line 13)
* program index, in Texinfo export: Indices. (line 6)
* progress logging: Progress Logging. (line 6)
* projects, for publishing: Project alist. (line 6)
* prologue, header argument: Environment of a Code Block.
2019-12-06 19:15:46 +01:00
(line 344)
2019-11-26 16:46:24 +01:00
* 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: 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, keyword: Property Syntax. (line 46)
* PROPERTY, keyword <1>: In-buffer Settings. (line 48)
* property, macro: Macro Replacement. (line 68)
2019-12-06 19:15:46 +01:00
* protocol, capture: The capture protocol.
(line 6)
2019-11-26 16:46:24 +01:00
* protocol, new protocol: Protocols. (line 25)
2019-12-06 19:15:46 +01:00
* protocol, open-source: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 6)
2019-12-06 19:15:46 +01:00
* protocol, open-source rewritten URL: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 32)
2019-12-06 19:15:46 +01:00
* protocol, open-source, set-up mapping: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 67)
2019-12-06 19:15:46 +01:00
* protocol, store-link: The store-link protocol.
(line 6)
* protocols, for external access: Capture and Attachments.
(line 6)
* protocols, for external access <1>: Protocols. (line 6)
2019-11-26 16:46:24 +01:00
* publishing: Publishing. (line 6)
* publishing options: Publishing options. (line 6)
2019-12-06 19:15:46 +01:00
* query editing, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* quote blocks: Paragraphs. (line 25)
* radio tables: Radio tables. (line 6)
* radio targets: Radio Targets. (line 6)
* range formula: Field and range formulas.
(line 6)
* range references: References. (line 64)
* ranges, time: Timestamps. (line 6)
* recomputing table fields: Updating the table. (line 6)
* references: References. (line 6)
* references, named: References. (line 113)
* references, remote: References. (line 134)
* references, to a different table: References. (line 134)
* references, to fields: References. (line 15)
* references, to ranges: References. (line 64)
2019-12-06 19:15:46 +01:00
* refiling notes: Refiling and Archiving.
(line 6)
* refiling notes <1>: Refile and Copy. (line 6)
2019-11-26 16:46:24 +01:00
* refresh set-up: In-buffer Settings. (line 11)
* region, active: Structure Editing. (line 132)
* regular expressions, with tags search: Matching tags and properties.
(line 53)
* relative timer: Timers. (line 6)
* reminders: Weekly/daily agenda. (line 125)
2020-02-05 19:59:48 +01:00
* remote editing, bulk, from agenda: Agenda Commands. (line 349)
2019-11-26 16:46:24 +01:00
* remote editing, from agenda: Agenda Commands. (line 223)
* remote editing, undo: Agenda Commands. (line 227)
* remote references: References. (line 134)
* repeated tasks: Repeated tasks. (line 6)
* report, of clocked time: The clock table. (line 6)
* reporting a bug: Feedback. (line 6)
* resolve idle time: Resolving idle time. (line 9)
* results, header argument: Results of Evaluation.
(line 6)
* RESULTS, keyword: Evaluating Code Blocks.
(line 6)
* results, macro: Macro Replacement. (line 84)
* revealing context: Global and local cycling.
(line 42)
2019-12-06 19:15:46 +01:00
* rewritten URL in open-source protocol: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 32)
* Rmail links: External Links. (line 6)
* row separator, in tables: Built-in Table Editor.
(line 6)
* row, of field coordinates: References. (line 89)
* rownames, header argument: Environment of a Code Block.
(line 73)
2019-12-06 19:15:46 +01:00
* RSS feeds: Capture and Attachments.
(line 6)
* RSS feeds <1>: RSS Feeds. (line 6)
2019-11-26 16:46:24 +01:00
* rsync: Uploading Files. (line 6)
* SCHEDULED marker: Deadlines and Scheduling.
(line 31)
* SCHEDULED, special property: Special Properties. (line 13)
* scheduling: Timestamps. (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)
* SELECT_TAGS, keyword: Export Settings. (line 44)
* sep, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 177)
* sep, Texinfo attribute: Plain lists in Texinfo export.
(line 17)
2019-11-26 16:46:24 +01:00
* SEQ_TODO, keyword: Per-file keywords. (line 6)
2019-12-06 19:15:46 +01:00
* SEQ_TODO, keyword <1>: In-buffer Settings. (line 180)
2019-11-26 16:46:24 +01:00
* session, header argument: Environment of a Code Block.
(line 272)
* setting tags: Setting Tags. (line 6)
* SETUPFILE, keyword: Export Settings. (line 13)
* SETUPFILE, keyword <1>: In-buffer Settings. (line 53)
* sexp timestamps: Timestamps. (line 34)
* shebang, header argument: Extracting Source Code.
(line 83)
* shell links: External Links. (line 6)
2019-12-06 19:15:46 +01:00
* shift-selection: Conflicts. (line 6)
2019-11-26 16:46:24 +01:00
* shift-selection-mode: Plain Lists. (line 95)
* show all, command: Global and local cycling.
(line 39)
* show all, global visibility state: Global and local cycling.
(line 20)
* show branches, command: Global and local cycling.
(line 51)
* show children, command: Global and local cycling.
(line 55)
* show hidden text: Visibility Cycling. (line 6)
* shy hyphen, special symbol: Special Symbols. (line 36)
* sitemap, of published pages: Site map. (line 6)
* smartphone: Org Mobile. (line 6)
* sorting, of agenda items: Sorting of agenda items.
(line 6)
* sorting, of plain list: Plain Lists. (line 159)
* sorting, of subtrees: Structure Editing. (line 6)
2019-12-06 19:15:46 +01:00
* source block: Literal Examples. (line 38)
2019-11-26 16:46:24 +01:00
* source blocks, in LaTeX export: Source blocks in LaTeX export.
(line 6)
* source code, batch execution: Batch Execution. (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, 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, working with: Working with Source Code.
(line 6)
* sparse tree, for deadlines: Inserting deadline/schedule.
(line 26)
2019-12-06 19:15:46 +01:00
* sparse tree, for TODO: TODO Basics. (line 35)
2019-11-26 16:46:24 +01:00
* 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 84)
* 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 27)
* speed keys: Speed Keys. (line 6)
* speedbar.el: Cooperation. (line 41)
* spreadsheet capabilities: The Spreadsheet. (line 6)
2019-12-06 19:15:46 +01:00
* square brackets, around links: External Links. (line 136)
2019-11-26 16:46:24 +01:00
* startup visibility: Global and local cycling.
(line 35)
* STARTUP, keyword: Initial visibility. (line 12)
* STARTUP, keyword <1>: Blocks. (line 14)
* STARTUP, keyword <2>: In-buffer Settings. (line 65)
2019-12-06 19:15:46 +01:00
* statistics, for checkboxes: Checkboxes. (line 29)
2019-11-26 16:46:24 +01:00
* statistics, for TODO items: Breaking Down Tasks. (line 6)
2019-12-06 19:15:46 +01:00
* store-link protocol: The store-link protocol.
(line 6)
* storing link, in a source code buffer: Literal Examples. (line 111)
2019-11-26 16:46:24 +01:00
* storing links: Handling Links. (line 9)
* strike-through text, markup rules: Emphasis and Monospace.
(line 6)
* structure editing: Structure Editing. (line 6)
* structure of document: Document Structure. (line 6)
* STYLE, property: Tracking your habits.
(line 6)
* styles, custom: Applying custom styles.
(line 6)
* styles, custom <1>: Advanced topics in ODT export.
(line 34)
* SUBAUTHOR, keyword: Texinfo specific export settings.
(line 14)
* SUBAUTHOR, keyword <1>: Texinfo title and copyright page.
(line 12)
* sublevels, inclusion into tags match: Tag Inheritance. (line 6)
* sublevels, inclusion into TODO list: Global TODO list. (line 38)
* subscript: Subscripts and Superscripts.
(line 6)
* SUBTITLE, keyword: ASCII/Latin-1/UTF-8 export.
(line 46)
* SUBTITLE, keyword <1>: Beamer specific export settings.
(line 44)
* SUBTITLE, keyword <2>: HTML specific export settings.
(line 53)
* SUBTITLE, keyword <3>: LaTeX specific export settings.
(line 63)
* SUBTITLE, keyword <4>: ODT specific export settings.
(line 26)
* SUBTITLE, keyword <5>: Texinfo specific export settings.
(line 11)
* subtree cycling: Global and local cycling.
(line 6)
* subtree visibility states: Global and local cycling.
(line 6)
* subtree, cut and paste: Structure Editing. (line 6)
* subtree, subtree visibility state: Global and local cycling.
(line 6)
* subtrees, cut and paste: Structure Editing. (line 6)
* summary: Summary. (line 6)
* SUMMARY, property: iCalendar Export. (line 51)
* superscript: Subscripts and Superscripts.
(line 6)
* switches, in code blocks: Structure of Code Blocks.
(line 52)
* 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 49)
* table indirection: References. (line 147)
* table lookup functions: Lookup functions. (line 6)
* table of contents: Table of Contents. (line 6)
* table of contents, exclude entries: Table of Contents. (line 15)
* table syntax: Built-in Table Editor.
(line 6)
2019-12-06 19:15:46 +01:00
* table-type, Texinfo attribute: Plain lists in Texinfo export.
2019-11-26 16:46:24 +01:00
(line 6)
* table.el: Cooperation. (line 49)
* 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>: Advanced topics in ODT export.
(line 151)
* tables, in other modes: Tables in Arbitrary Syntax.
(line 6)
* tag completion: Completion. (line 6)
2019-12-06 19:15:46 +01:00
* tag filtering, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* tag inheritance: Tag Inheritance. (line 6)
* tag searches: Tag Searches. (line 6)
* tags: Tags. (line 6)
* tags hierarchy: Tag Hierarchy. (line 6)
* tags view: Matching tags and properties.
(line 6)
* tags, as an agenda view: Storing searches. (line 11)
* tags, groups: Tag Hierarchy. (line 6)
* TAGS, keyword: Setting Tags. (line 22)
2019-12-06 19:15:46 +01:00
* TAGS, keyword <1>: In-buffer Settings. (line 173)
2019-11-26 16:46:24 +01:00
* tags, setting: Setting Tags. (line 6)
* TAGS, special property: Special Properties. (line 13)
* tags-todo: Storing searches. (line 11)
* tags-tree: Storing searches. (line 11)
* tangle, header argument: Extracting Source Code.
(line 23)
* tangle-mode, header argument: Extracting Source Code.
(line 89)
* tangling: Extracting Source Code.
(line 6)
2019-12-29 11:23:16 +01:00
* targets, for links: Internal Links. (line 17)
2019-11-26 16:46:24 +01:00
* targets, radio: Radio Targets. (line 6)
* tasks, breaking down: Breaking Down Tasks. (line 6)
* tasks, repeated: Repeated tasks. (line 6)
* TBLFM keywords, multiple: Editing and debugging formulas.
(line 98)
* TBLFM, keyword: Field and range formulas.
(line 12)
* TBLFM, switching: Editing and debugging formulas.
(line 98)
* template expansion: Structure Templates. (line 21)
* template insertion: Structure Templates. (line 6)
* template, custom: Applying custom styles.
(line 6)
* template, custom <1>: Advanced topics in ODT export.
(line 34)
* templates, for Capture: Capture templates. (line 6)
* Tempo: Structure Templates. (line 21)
* TeX interpretation: Embedded LaTeX. (line 6)
* TeX symbol completion: Completion. (line 6)
* TEXINFO, keyword: Quoting Texinfo code.
(line 9)
* TEXINFO_CLASS, keyword: Texinfo specific export settings.
(line 20)
* TEXINFO_CLASS, keyword <1>: Texinfo file header. (line 19)
* TEXINFO_CLASS, keyword <2>: Headings and sectioning structure.
(line 6)
* TEXINFO_DIR_CATEGORY, keyword: Texinfo specific export settings.
(line 30)
* TEXINFO_DIR_CATEGORY, keyword <1>: Info directory file. (line 6)
* TEXINFO_DIR_DESC, keyword: Texinfo specific export settings.
(line 36)
* TEXINFO_DIR_DESC, keyword <1>: Info directory file. (line 6)
* TEXINFO_DIR_TITLE, keyword: Texinfo specific export settings.
(line 33)
* TEXINFO_DIR_TITLE, keyword <1>: Info directory file. (line 6)
* TEXINFO_FILENAME, keyword: Texinfo specific export settings.
(line 17)
* TEXINFO_FILENAME, keyword <1>: Texinfo file header. (line 6)
* TEXINFO_HEADER, keyword: Texinfo specific export settings.
(line 24)
* TEXINFO_HEADER, keyword <1>: Texinfo file header. (line 11)
* TEXINFO_POST_HEADER, keyword: Texinfo specific export settings.
(line 27)
* TEXINFO_PRINTED_TITLE, keyword: Texinfo specific export settings.
(line 39)
* TEXINFO_PRINTED_TITLE, keyword <1>: Texinfo title and copyright page.
(line 6)
* text areas, in HTML: Text areas in HTML export.
(line 6)
* text search: Search view. (line 6)
* time clocking: Clocking Work Time. (line 6)
* time format, custom: Custom time format. (line 6)
* time grid: Time-of-day specifications.
(line 31)
* time, computing: Durations and time values.
(line 6)
* time, macro: Macro Replacement. (line 56)
* 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, special property: Special Properties. (line 13)
* timestamp, with repeater interval: Timestamps. (line 25)
* timestamps: Timestamps. (line 6)
* TIMESTAMP_IA, special property: Special Properties. (line 13)
* TIMEZONE, property: iCalendar Export. (line 51)
* TINDEX, keyword: Indices. (line 6)
* TITLE, keyword: Export Settings. (line 60)
* title, macro: Macro Replacement. (line 41)
* toc, in OPTIONS keyword: Table of Contents. (line 6)
* TOC, keyword: Table of Contents. (line 24)
* TODO dependencies: TODO dependencies. (line 6)
* TODO dependencies, NOBLOCKING: TODO dependencies. (line 29)
* TODO items: TODO Items. (line 6)
* TODO keyword matching: Global TODO list. (line 18)
* TODO keyword matching, with tags search: Matching tags and properties.
(line 64)
* 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 11)
* TODO, keyword: Per-file keywords. (line 6)
2019-12-06 19:15:46 +01:00
* TODO, keyword <1>: In-buffer Settings. (line 180)
2019-11-26 16:46:24 +01:00
* TODO, special property: Special Properties. (line 13)
* todo-tree: Storing searches. (line 11)
2019-12-06 19:15:46 +01:00
* top headline filtering, in agenda: Filtering/limiting agenda items.
(line 20)
2019-11-26 16:46:24 +01:00
* Top node, in Texinfo export: Headings and sectioning structure.
(line 37)
* transient mark mode: Structure Editing. (line 132)
* 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)
* TYP_TODO, keyword: Per-file keywords. (line 6)
2019-12-06 19:15:46 +01:00
* TYP_TODO, keyword <1>: In-buffer Settings. (line 180)
2019-11-26 16:46:24 +01:00
* underlined text, markup rules: Emphasis and Monospace.
(line 6)
* undoing remote-editing events: Agenda Commands. (line 227)
* unison: Uploading Files. (line 6)
* UNNUMBERED, property: Export Settings. (line 149)
* 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)
* using sessions in code blocks: Environment of a Code Block.
(line 272)
* UTF-8 export: ASCII/Latin-1/UTF-8 export.
(line 6)
* var, header argument: Environment of a Code Block.
(line 9)
* variable index, in Texinfo export: Indices. (line 6)
* vectors, in table calculations: Formula syntax for Calc.
(line 14)
* 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)
* view file commands in agenda: Agenda Commands. (line 28)
* VINDEX, keyword: Indices. (line 6)
* viper.el: Conflicts. (line 51)
* visibility cycling: Visibility Cycling. (line 6)
* visibility cycling, drawers: Drawers. (line 6)
* VISIBILITY, property: Initial visibility. (line 17)
* visible text, printing: Sparse Trees. (line 52)
2019-12-06 19:15:46 +01:00
* VM links: External Links. (line 109)
* Wanderlust links: External Links. (line 109)
2019-11-26 16:46:24 +01:00
* weekly agenda: Weekly/daily agenda. (line 6)
* windmove.el: Conflicts. (line 60)
* workflow states as TODO keywords: Workflow states. (line 6)
* working directory, in a code block: Environment of a Code Block.
(line 302)
* wrap, header argument: Results of Evaluation.
2019-12-06 19:15:46 +01:00
(line 230)
2019-11-26 16:46:24 +01:00
* xelatex: LaTeX/PDF export commands.
(line 25)
* yasnippet.el: Conflicts. (line 74)
* zero width space: Escape Character. (line 6)
* zip: Pre-requisites for ODT export.
(line 6)
File: org, Node: Key Index, Next: Command and Function Index, Prev: Main Index, Up: Top
E Key Index
***********
* Menu:
* !: Setting Tags. (line 126)
* ! (Agenda dispatcher): Stuck projects. (line 17)
* # (Agenda dispatcher): Stuck projects. (line 14)
2019-12-06 19:15:46 +01:00
* $: Agenda Commands. (line 265)
2020-02-05 19:59:48 +01:00
* %: Agenda Commands. (line 376)
2019-12-06 19:15:46 +01:00
* ': CDLaTeX mode. (line 57)
2020-02-05 19:59:48 +01:00
* *: Agenda Commands. (line 356)
2019-12-06 19:15:46 +01:00
* * (Agenda dispatcher): Agenda Dispatcher. (line 53)
2020-02-05 19:59:48 +01:00
* +: Agenda Commands. (line 284)
2019-12-06 19:15:46 +01:00
* ,: Agenda Commands. (line 279)
2020-02-05 19:59:48 +01:00
* -: Agenda Commands. (line 289)
2019-11-26 16:46:24 +01:00
* .: Agenda Commands. (line 118)
2019-12-06 19:15:46 +01:00
* / (Agenda dispatcher): Agenda Dispatcher. (line 30)
2019-11-26 16:46:24 +01:00
* 1..9,0: Using column view. (line 35)
2019-12-06 19:15:46 +01:00
* :: Agenda Commands. (line 275)
2019-11-26 16:46:24 +01:00
* <: Using column view. (line 66)
* < <1>: The date/time prompt.
(line 81)
2019-12-06 19:15:46 +01:00
* < (Agenda dispatcher): Agenda Dispatcher. (line 41)
* < < (Agenda dispatcher): Agenda Dispatcher. (line 47)
2019-11-26 16:46:24 +01:00
* >: Using column view. (line 66)
* > <1>: The date/time prompt.
(line 81)
2020-02-05 19:59:48 +01:00
* > <2>: Agenda Commands. (line 325)
2019-11-26 16:46:24 +01:00
* ? (Agenda dispatcher): Pulling from the mobile application.
(line 39)
* [: Agenda Commands. (line 142)
2019-12-06 19:15:46 +01:00
* ^: CDLaTeX mode. (line 43)
* _: CDLaTeX mode. (line 43)
* `: CDLaTeX mode. (line 51)
2019-11-26 16:46:24 +01:00
* a: Using column view. (line 56)
* A: Agenda Commands. (line 64)
2019-12-06 19:15:46 +01:00
* a <1>: Agenda Commands. (line 252)
2019-11-26 16:46:24 +01:00
* a (Agenda dispatcher): Weekly/daily agenda. (line 10)
* b: Agenda Commands. (line 115)
2020-02-05 19:59:48 +01:00
* B: Agenda Commands. (line 380)
2019-11-26 16:46:24 +01:00
* C: Resolving idle time. (line 46)
2020-02-05 19:59:48 +01:00
* c: Agenda Commands. (line 444)
* c <1>: Agenda Commands. (line 447)
* C <1>: Agenda Commands. (line 478)
2019-11-26 16:46:24 +01:00
* C (Agenda dispatcher): Storing searches. (line 11)
* C (Capture menu: Capture templates. (line 11)
* C-#: Advanced features. (line 11)
* C-': Agenda Files. (line 26)
* C-,: Agenda Files. (line 26)
2019-12-06 19:15:46 +01:00
* C-0 C-c C-w: Refile and Copy. (line 46)
* C-2 C-c C-w: Refile and Copy. (line 38)
* C-3 C-c C-w: Refile and Copy. (line 41)
2019-11-26 16:46:24 +01:00
* C-c !: Creating Timestamps. (line 25)
2019-12-06 19:15:46 +01:00
* C-c #: Checkboxes. (line 87)
2019-11-26 16:46:24 +01:00
* C-c $: Moving subtrees. (line 10)
* C-c %: Handling Links. (line 139)
* C-c &: Handling Links. (line 144)
* C-c ': Editing and debugging formulas.
(line 37)
2019-12-06 19:15:46 +01:00
* C-c ' <1>: Literal Examples. (line 102)
* C-c ' <2>: Include Files. (line 63)
2019-11-26 16:46:24 +01:00
* C-c ' <3>: Editing Source Code. (line 6)
* C-c ' <4>: Cooperation. (line 59)
* C-c *: Structure Editing. (line 124)
* C-c * <1>: Plain Lists. (line 143)
* C-c * <2>: Updating the table. (line 14)
* C-c +: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 180)
2019-11-26 16:46:24 +01:00
* C-c ,: Priorities. (line 25)
* C-c -: Plain Lists. (line 131)
* C-c - <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 125)
2019-11-26 16:46:24 +01:00
* C-c .: Creating Timestamps. (line 11)
* C-c /: Sparse Trees. (line 16)
* C-c / <1>: Conflicts. (line 51)
* C-c / /: Sparse Trees. (line 20)
* C-c / a: Inserting deadline/schedule.
(line 36)
* C-c / b: Inserting deadline/schedule.
(line 33)
* C-c / d: Inserting deadline/schedule.
(line 26)
* C-c / m: Tag Searches. (line 10)
* C-c / m <1>: Property Searches. (line 11)
* C-c / p: Property Searches. (line 29)
* C-c / r: Sparse Trees. (line 20)
2019-12-06 19:15:46 +01:00
* C-c / t: TODO Basics. (line 35)
2019-11-26 16:46:24 +01:00
* C-c ;: Comment Lines. (line 20)
* C-c <: Creating Timestamps. (line 32)
* C-c =: Column formulas. (line 33)
* C-c = <1>: Editing and debugging formulas.
(line 14)
* C-c >: Creating Timestamps. (line 35)
* C-c ?: Editing and debugging formulas.
(line 25)
* C-c @: Structure Editing. (line 61)
* C-c C-*: Plain Lists. (line 148)
* C-c C-,: Structure Templates. (line 11)
2019-12-06 19:15:46 +01:00
* C-c C-a: Attachment defaults and dispatcher.
(line 19)
2020-02-05 19:59:48 +01:00
* C-c C-a <1>: Agenda Commands. (line 297)
2019-12-06 19:15:46 +01:00
* C-c C-a a: Attachment defaults and dispatcher.
(line 24)
* C-c C-a b: Attachment defaults and dispatcher.
(line 34)
* C-c C-a c: Attachment defaults and dispatcher.
(line 30)
* C-c C-a d: Attachment defaults and dispatcher.
(line 60)
* C-c C-a D: Attachment defaults and dispatcher.
(line 63)
* C-c C-a f: Attachment defaults and dispatcher.
(line 54)
* C-c C-a F: Attachment defaults and dispatcher.
(line 57)
* C-c C-a l: Attachment defaults and dispatcher.
(line 30)
* C-c C-a m: Attachment defaults and dispatcher.
(line 30)
* C-c C-a n: Attachment defaults and dispatcher.
(line 38)
* C-c C-a o: Attachment defaults and dispatcher.
(line 45)
* C-c C-a O: Attachment defaults and dispatcher.
(line 51)
* C-c C-a s: Attachment defaults and dispatcher.
(line 67)
* C-c C-a S: Attachment defaults and dispatcher.
(line 72)
* C-c C-a z: Attachment defaults and dispatcher.
(line 41)
2019-11-26 16:46:24 +01:00
* C-c C-b: Motion. (line 18)
* C-c C-b <1>: Editing support. (line 12)
* C-c C-c: Plain Lists. (line 126)
2019-12-06 19:15:46 +01:00
* C-c C-c <1>: Built-in Table Editor.
2019-11-26 16:46:24 +01:00
(line 60)
2019-12-06 19:15:46 +01:00
* C-c C-c <2>: Column Width and Alignment.
2019-11-26 16:46:24 +01:00
(line 17)
2019-12-06 19:15:46 +01:00
* C-c C-c <3>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 45)
2019-12-06 19:15:46 +01:00
* C-c C-c <4>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 91)
2019-12-06 19:15:46 +01:00
* C-c C-c <5>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 98)
2019-12-06 19:15:46 +01:00
* C-c C-c <6>: Checkboxes. (line 52)
* C-c C-c <7>: Setting Tags. (line 20)
* C-c C-c <8>: Setting Tags. (line 130)
* C-c C-c <9>: Property Syntax. (line 95)
* C-c C-c <10>: Using column view. (line 49)
* C-c C-c <11>: Capturing column view.
(line 71)
* C-c C-c <12>: Creating Timestamps. (line 29)
* C-c C-c <13>: Clocking commands. (line 53)
* C-c C-c <14>: The clock table. (line 17)
* C-c C-c <15>: Creating Footnotes. (line 65)
2019-11-26 16:46:24 +01:00
* C-c C-c <16>: Evaluating Code Blocks.
(line 22)
* C-c C-c <17>: Key bindings and Useful Functions.
(line 11)
* C-c C-c <18>: The Very Busy C-c C-c Key.
(line 6)
* C-c C-c (Capture buffer): Using capture. (line 15)
* C-c C-c c: Property Syntax. (line 112)
* C-c C-c d: Property Syntax. (line 106)
* C-c C-c D: Property Syntax. (line 109)
* C-c C-c m m: Markdown Export. (line 17)
* C-c C-c m M: Markdown Export. (line 21)
* C-c C-c s: Property Syntax. (line 98)
* C-c C-d: Inserting deadline/schedule.
(line 10)
2020-02-05 19:59:48 +01:00
* C-c C-d <1>: Agenda Commands. (line 304)
2019-11-26 16:46:24 +01:00
* C-c C-e: The Export Dispatcher.
(line 16)
* C-c C-e c a: iCalendar Export. (line 43)
* C-c C-e c c: iCalendar Export. (line 47)
* C-c C-e c f: iCalendar Export. (line 39)
* C-c C-e C-a: The Export Dispatcher.
(line 28)
* C-c C-e C-b: The Export Dispatcher.
(line 46)
* C-c C-e C-s: The Export Dispatcher.
(line 52)
* C-c C-e C-v: The Export Dispatcher.
(line 64)
* C-c C-e h h: HTML export commands.
(line 7)
* C-c C-e h H: HTML export commands.
(line 14)
* C-c C-e h o: HTML export commands.
(line 7)
* C-c C-e i i: Texinfo export commands.
(line 11)
* C-c C-e i t: Texinfo export commands.
(line 7)
* C-c C-e l b: Beamer export commands.
(line 7)
* C-c C-e l B: Beamer export commands.
(line 12)
* C-c C-e l l: LaTeX/PDF export commands.
(line 7)
* C-c C-e l L: LaTeX/PDF export commands.
(line 11)
* C-c C-e l O: Beamer export commands.
(line 20)
* C-c C-e l o: LaTeX/PDF export commands.
(line 17)
* C-c C-e l P: Beamer export commands.
(line 16)
* C-c C-e l p: LaTeX/PDF export commands.
(line 14)
* C-c C-e m o: Markdown Export. (line 24)
* C-c C-e o o: ODT export commands. (line 7)
* C-c C-e o O: ODT export commands. (line 23)
* C-c C-e O o: Org Export. (line 15)
* C-c C-e O v: Org Export. (line 19)
2019-12-06 19:15:46 +01:00
* C-c C-e P a: Triggering Publication.
(line 19)
* C-c C-e P f: Triggering Publication.
(line 16)
* C-c C-e P p: Triggering Publication.
2019-11-26 16:46:24 +01:00
(line 13)
2019-12-06 19:15:46 +01:00
* C-c C-e P x: Triggering Publication.
(line 9)
2019-11-26 16:46:24 +01:00
* C-c C-e t a: ASCII/Latin-1/UTF-8 export.
(line 26)
* C-c C-e t A: ASCII/Latin-1/UTF-8 export.
(line 35)
* C-c C-e t l: ASCII/Latin-1/UTF-8 export.
(line 26)
* C-c C-e t L: ASCII/Latin-1/UTF-8 export.
(line 35)
* C-c C-e t u: ASCII/Latin-1/UTF-8 export.
(line 26)
* C-c C-e t U: ASCII/Latin-1/UTF-8 export.
(line 35)
* C-c C-e v: Sparse Trees. (line 52)
* C-c C-f: Motion. (line 15)
* C-c C-j: Motion. (line 24)
* C-c C-k: Global and local cycling.
(line 51)
* C-c C-k (Capture buffer): Using capture. (line 31)
* C-c C-l: Handling Links. (line 69)
* C-c C-n: Motion. (line 9)
2019-12-06 19:15:46 +01:00
* C-c C-o: Handling Links. (line 106)
* C-c C-o <1>: Creating Timestamps. (line 40)
* C-c C-o <2>: Agenda Commands. (line 56)
* C-c C-o <3>: Creating Footnotes. (line 71)
2019-11-26 16:46:24 +01:00
* C-c C-o <4>: Key bindings and Useful Functions.
(line 11)
* C-c C-p: Motion. (line 12)
* C-c C-q: Editing and debugging formulas.
(line 49)
* C-c C-q <1>: Setting Tags. (line 11)
* C-c C-r: Global and local cycling.
(line 42)
* C-c C-r <1>: Editing and debugging formulas.
(line 52)
* C-c C-s: Inserting deadline/schedule.
(line 18)
2020-02-05 19:59:48 +01:00
* C-c C-s <1>: Agenda Commands. (line 300)
2019-11-26 16:46:24 +01:00
* C-c C-t: TODO Basics. (line 14)
2019-12-06 19:15:46 +01:00
* C-c C-t <1>: Clocking commands. (line 71)
2019-11-26 16:46:24 +01:00
* C-c C-u: Motion. (line 21)
* C-c C-v a: Key bindings and Useful Functions.
(line 20)
* C-c C-v b: Key bindings and Useful Functions.
(line 20)
* C-c C-v c: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-a: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-b: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-c: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-d: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-e: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-f: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-g: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-h: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-i: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-I: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-j: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-l: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-n: Key bindings and Useful Functions.
(line 20)
* 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 20)
* C-c C-v C-r: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-s: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-t: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-u: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-v: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-x: Key bindings and Useful Functions.
(line 20)
* C-c C-v C-z: Key bindings and Useful Functions.
(line 20)
* C-c C-v d: Key bindings and Useful Functions.
(line 20)
* C-c C-v e: Evaluating Code Blocks.
(line 22)
* C-c C-v e <1>: Key bindings and Useful Functions.
(line 20)
* C-c C-v f: Extracting Source Code.
(line 116)
* C-c C-v f <1>: Key bindings and Useful Functions.
(line 20)
* C-c C-v g: Key bindings and Useful Functions.
(line 20)
* C-c C-v h: Key bindings and Useful Functions.
(line 20)
* C-c C-v i: Library of Babel. (line 12)
* C-c C-v i <1>: Key bindings and Useful Functions.
(line 20)
* C-c C-v I: Key bindings and Useful Functions.
(line 20)
* C-c C-v j: Key bindings and Useful Functions.
(line 20)
* C-c C-v l: Key bindings and Useful Functions.
(line 20)
* C-c C-v n: Key bindings and Useful Functions.
(line 20)
* C-c C-v o: Key bindings and Useful Functions.
(line 20)
* C-c C-v p: Key bindings and Useful Functions.
(line 20)
* C-c C-v r: Key bindings and Useful Functions.
(line 20)
* C-c C-v s: Key bindings and Useful Functions.
(line 20)
* C-c C-v t: Extracting Source Code.
(line 111)
* C-c C-v t <1>: Key bindings and Useful Functions.
(line 20)
* C-c C-v u: Key bindings and Useful Functions.
(line 20)
* C-c C-v v: Key bindings and Useful Functions.
(line 20)
* C-c C-v x: Key bindings and Useful Functions.
(line 20)
* C-c C-v z: Key bindings and Useful Functions.
(line 20)
* C-c C-w: Structure Editing. (line 99)
2019-12-06 19:15:46 +01:00
* C-c C-w <1>: Refile and Copy. (line 13)
* C-c C-w <2>: Agenda Commands. (line 249)
2019-11-26 16:46:24 +01:00
* C-c C-w (Capture buffer): Using capture. (line 22)
* C-c C-x ,: Timers. (line 44)
* C-c C-x -: Timers. (line 36)
* C-c C-x .: Timers. (line 32)
* C-c C-x 0: Timers. (line 13)
* C-c C-x ;: Timers. (line 23)
* C-c C-x <: Agenda Files. (line 43)
* C-c C-x >: Agenda Files. (line 52)
* C-c C-x > <1>: Agenda Commands. (line 206)
* C-c C-x a: Internal archiving. (line 39)
* C-c C-x A: Internal archiving. (line 54)
2019-12-06 19:15:46 +01:00
* C-c C-x a <1>: Agenda Commands. (line 257)
* C-c C-x A <1>: Agenda Commands. (line 261)
2019-11-26 16:46:24 +01:00
* C-c C-x b: Global and local cycling.
(line 59)
* C-c C-x b <1>: Agenda Commands. (line 49)
* C-c C-x c: Structure Editing. (line 91)
* C-c C-x C-a: Archiving. (line 12)
2019-12-06 19:15:46 +01:00
* C-c C-x C-a <1>: Agenda Commands. (line 252)
* C-c C-x C-b: Checkboxes. (line 58)
2019-11-26 16:46:24 +01:00
* C-c C-x C-c: Using column view. (line 10)
* C-c C-x C-c <1>: Agenda Commands. (line 197)
* C-c C-x C-c <2>: Agenda Column View. (line 12)
2019-12-06 19:15:46 +01:00
* C-c C-x C-d: Clocking commands. (line 84)
* C-c C-x C-e: Clocking commands. (line 50)
2019-11-26 16:46:24 +01:00
* C-c C-x C-e <1>: Effort Estimates. (line 20)
* C-c C-x C-i: Clocking commands. (line 7)
2019-12-06 19:15:46 +01:00
* C-c C-x C-j: Clocking commands. (line 79)
2019-11-26 16:46:24 +01:00
* C-c C-x C-l: Previewing LaTeX fragments.
(line 18)
* C-c C-x C-n: Handling Links. (line 151)
2019-12-06 19:15:46 +01:00
* C-c C-x C-o: Clocking commands. (line 36)
2019-11-26 16:46:24 +01:00
* C-c C-x C-p: Handling Links. (line 151)
2019-12-06 19:15:46 +01:00
* C-c C-x C-q: Clocking commands. (line 75)
2019-11-26 16:46:24 +01:00
* C-c C-x C-s: Moving subtrees. (line 10)
2019-12-06 19:15:46 +01:00
* C-c C-x C-s <1>: Agenda Commands. (line 265)
2019-11-26 16:46:24 +01:00
* C-c C-x C-t: Custom time format. (line 13)
* C-c C-x C-u: Capturing column view.
2019-12-06 19:15:46 +01:00
(line 71)
* C-c C-x C-u <1>: The clock table. (line 17)
* C-c C-x C-u <2>: Dynamic Blocks. (line 25)
2019-11-26 16:46:24 +01:00
* C-c C-x C-v: Images. (line 24)
* C-c C-x C-w: Structure Editing. (line 65)
* C-c C-x C-w <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 156)
* C-c C-x C-x: Clocking commands. (line 44)
2019-11-26 16:46:24 +01:00
* C-c C-x C-y: Structure Editing. (line 73)
* C-c C-x C-y <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 160)
2019-11-26 16:46:24 +01:00
* C-c C-x d: Drawers. (line 18)
* C-c C-x e: Effort Estimates. (line 15)
2019-12-06 19:15:46 +01:00
* C-c C-x f: Creating Footnotes. (line 42)
2019-11-26 16:46:24 +01:00
* C-c C-x g: RSS Feeds. (line 23)
* C-c C-x G: RSS Feeds. (line 27)
* C-c C-x i: Capturing column view.
2019-12-06 19:15:46 +01:00
(line 67)
2019-11-26 16:46:24 +01:00
* C-c C-x I: Documentation Access.
(line 6)
* C-c C-x M-w: Structure Editing. (line 69)
* C-c C-x M-w <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 150)
2019-11-26 16:46:24 +01:00
* C-c C-x o: TODO dependencies. (line 38)
2019-12-06 19:15:46 +01:00
* C-c C-x o <1>: Checkboxes. (line 79)
2019-11-26 16:46:24 +01:00
* C-c C-x p: Property Syntax. (line 86)
* C-c C-x p <1>: Using Header Arguments.
(line 70)
* C-c C-x q: Tag Hierarchy. (line 86)
* C-c C-x v: Global and local cycling.
(line 65)
2019-12-06 19:15:46 +01:00
* C-c C-x x: Dynamic Blocks. (line 10)
2019-11-26 16:46:24 +01:00
* C-c C-x \: Subscripts and Superscripts.
(line 20)
* C-c C-x \ <1>: Special Symbols. (line 31)
* C-c C-x _: Timers. (line 47)
* C-c C-y: Creating Timestamps. (line 62)
2019-12-06 19:15:46 +01:00
* C-c C-y <1>: Clocking commands. (line 53)
2019-11-26 16:46:24 +01:00
* C-c C-z: Drawers. (line 39)
2020-02-05 19:59:48 +01:00
* C-c C-z <1>: Agenda Commands. (line 292)
2019-12-06 19:15:46 +01:00
* C-c M-w: Refile and Copy. (line 51)
2019-11-26 16:46:24 +01:00
* C-c RET: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 129)
2019-11-26 16:46:24 +01:00
* C-c SPC: Built-in Table Editor.
(line 67)
* C-c TAB: Global and local cycling.
(line 55)
* C-c TAB <1>: Column Width and Alignment.
(line 44)
* C-c [: Agenda Files. (line 16)
* C-c \: Tag Searches. (line 10)
* C-c \ <1>: Property Searches. (line 11)
* C-c ]: Agenda Files. (line 22)
* C-c ^: Structure Editing. (line 103)
* C-c ^ <1>: Plain Lists. (line 159)
* C-c ^ <2>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 133)
2019-11-26 16:46:24 +01:00
* C-c `: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 201)
2019-11-26 16:46:24 +01:00
* C-c {: Editing and debugging formulas.
(line 34)
2019-12-06 19:15:46 +01:00
* C-c { <1>: CDLaTeX mode. (line 25)
2019-11-26 16:46:24 +01:00
* C-c |: Built-in Table Editor.
(line 42)
* C-c | <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 220)
2019-11-26 16:46:24 +01:00
* C-c }: Editing and debugging formulas.
(line 29)
* C-c } <1>: Editing and debugging formulas.
(line 83)
* C-c ~: Cooperation. (line 63)
* C-g: Setting Tags. (line 120)
2019-12-06 19:15:46 +01:00
* C-k: Agenda Commands. (line 243)
2019-11-26 16:46:24 +01:00
* C-RET: Structure Editing. (line 26)
2019-12-06 19:15:46 +01:00
* C-S-DOWN: Clocking commands. (line 59)
2019-11-26 16:46:24 +01:00
* C-S-LEFT: Multiple sets in one file.
(line 28)
2019-12-06 19:15:46 +01:00
* C-S-LEFT <1>: Agenda Commands. (line 240)
2019-11-26 16:46:24 +01:00
* C-S-RET: Structure Editing. (line 33)
* C-S-RIGHT: Multiple sets in one file.
(line 28)
2019-12-06 19:15:46 +01:00
* C-S-RIGHT <1>: Agenda Commands. (line 237)
* C-S-UP: Clocking commands. (line 59)
2019-11-26 16:46:24 +01:00
* C-TAB: Internal archiving. (line 51)
* C-u C-c !: Creating Timestamps. (line 25)
* C-u C-c *: Updating the table. (line 19)
* C-u C-c .: Creating Timestamps. (line 16)
* C-u C-c =: Field and range formulas.
(line 28)
* C-u C-c = <1>: Editing and debugging formulas.
(line 14)
* C-u C-c C-c: Updating the table. (line 19)
* C-u C-c C-l: Handling Links. (line 92)
2019-12-06 19:15:46 +01:00
* C-u C-c C-t: Progress Logging. (line 10)
* C-u C-c C-w: Refile and Copy. (line 32)
2019-11-26 16:46:24 +01:00
* C-u C-c C-x a: Internal archiving. (line 44)
* C-u C-c C-x C-s: Moving subtrees. (line 14)
* C-u C-c C-x C-u: Capturing column view.
2019-12-06 19:15:46 +01:00
(line 75)
* C-u C-c C-x C-u <1>: The clock table. (line 21)
* C-u C-c C-x C-u <2>: Dynamic Blocks. (line 28)
2019-11-26 16:46:24 +01:00
* C-u C-c TAB: Column Width and Alignment.
(line 54)
* C-u C-u C-c !: Creating Timestamps. (line 25)
* C-u C-u C-c *: Updating the table. (line 24)
* C-u C-u C-c .: Creating Timestamps. (line 21)
* C-u C-u C-c =: Editing and debugging formulas.
(line 19)
* C-u C-u C-c C-c: Updating the table. (line 24)
* C-u C-u C-c C-t: Multiple sets in one file.
(line 28)
2019-12-06 19:15:46 +01:00
* C-u C-u C-c C-w: Refile and Copy. (line 35)
2019-11-26 16:46:24 +01:00
* C-u C-u C-c C-x C-s: Moving subtrees. (line 21)
* C-u C-u C-c TAB: Column Width and Alignment.
(line 57)
2019-12-06 19:15:46 +01:00
* C-u C-u C-u C-c C-w: Refile and Copy. (line 46)
* C-u C-u C-u C-u C-c C-t: TODO dependencies. (line 46)
2019-11-26 16:46:24 +01:00
* C-u C-u C-u TAB: Global and local cycling.
(line 39)
* C-u C-u TAB: Global and local cycling.
(line 35)
* C-u C-u TAB <1>: Initial visibility. (line 23)
* C-u TAB: Global and local cycling.
(line 20)
* C-v: The date/time prompt.
(line 81)
* C-x C-s: Editing and debugging formulas.
(line 45)
* C-x C-s <1>: Agenda Commands. (line 193)
* C-x C-s <2>: Editing Source Code. (line 11)
* C-x C-w: Exporting Agenda Views.
(line 13)
* C-x n b: Structure Editing. (line 118)
* C-x n s: Structure Editing. (line 115)
* C-x n w: Structure Editing. (line 121)
* C-y: Structure Editing. (line 79)
* C-_: Agenda Commands. (line 227)
* d: Agenda Commands. (line 71)
* D: Agenda Commands. (line 127)
* e: Using column view. (line 43)
* E: Agenda Commands. (line 173)
* e (Agenda dispatcher): Exporting Agenda Views.
(line 53)
* F: Agenda Commands. (line 42)
* f: Agenda Commands. (line 110)
* g: Using column view. (line 22)
* G: Agenda Commands. (line 181)
* g <1>: Agenda Commands. (line 186)
2020-02-05 19:59:48 +01:00
* H: Agenda Commands. (line 482)
* I: Agenda Commands. (line 329)
* i: Agenda Commands. (line 451)
2019-11-26 16:46:24 +01:00
* j: Agenda Commands. (line 121)
* J: Agenda Commands. (line 124)
2020-02-05 19:59:48 +01:00
* J <1>: Agenda Commands. (line 339)
2019-11-26 16:46:24 +01:00
* k: Resolving idle time. (line 23)
* K: Resolving idle time. (line 29)
2020-02-05 19:59:48 +01:00
* k <1>: Agenda Commands. (line 342)
2019-11-26 16:46:24 +01:00
* k c (Agenda): Using capture. (line 33)
* l: Agenda Commands. (line 131)
2020-02-05 19:59:48 +01:00
* m: Agenda Commands. (line 350)
* M: Agenda Commands. (line 469)
2019-11-26 16:46:24 +01:00
* m (Agenda dispatcher): Tag Searches. (line 15)
* M (Agenda dispatcher): Tag Searches. (line 19)
* m (Agenda dispatcher) <1>: Property Searches. (line 15)
* M (Agenda dispatcher) <1>: Property Searches. (line 18)
* m (Agenda dispatcher) <2>: Matching tags and properties.
(line 13)
* M (Agenda dispatcher) <2>: Matching tags and properties.
(line 21)
2020-02-05 19:59:48 +01:00
* M-*: Agenda Commands. (line 372)
2019-11-26 16:46:24 +01:00
* M-a: Built-in Table Editor.
(line 78)
* M-DOWN: Structure Editing. (line 58)
* M-DOWN <1>: Plain Lists. (line 102)
* M-DOWN <2>: Built-in Table Editor.
(line 103)
* M-DOWN <3>: Editing and debugging formulas.
(line 80)
* M-DOWN <4>: Agenda Commands. (line 217)
* M-DOWN <5>: Key bindings and Useful Functions.
(line 11)
* M-e: Built-in Table Editor.
(line 82)
* M-g M-n: Sparse Trees. (line 32)
* M-g M-p: Sparse Trees. (line 35)
* M-g n: Sparse Trees. (line 32)
* M-g p: Sparse Trees. (line 35)
* M-LEFT: Structure Editing. (line 43)
* M-LEFT <1>: Plain Lists. (line 108)
* M-LEFT <2>: Built-in Table Editor.
(line 88)
2020-02-05 19:59:48 +01:00
* M-m: Agenda Commands. (line 368)
2019-11-26 16:46:24 +01:00
* M-RET: Structure Editing. (line 7)
* M-RET <1>: Plain Lists. (line 83)
* M-RET <2>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 167)
2019-11-26 16:46:24 +01:00
* M-RET <3>: Timers. (line 40)
* M-RIGHT: Structure Editing. (line 46)
* M-RIGHT <1>: Plain Lists. (line 108)
* M-RIGHT <2>: Built-in Table Editor.
(line 91)
* M-S-DOWN: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 121)
2019-11-26 16:46:24 +01:00
* M-S-DOWN <1>: Editing and debugging formulas.
(line 74)
* M-S-LEFT: Structure Editing. (line 49)
* M-S-LEFT <1>: Plain Lists. (line 113)
* M-S-LEFT <2>: Built-in Table Editor.
(line 94)
* M-S-LEFT <3>: The date/time prompt.
(line 81)
* M-S-RET: Structure Editing. (line 29)
* M-S-RET <1>: Plain Lists. (line 91)
2019-12-06 19:15:46 +01:00
* M-S-RET <2>: Checkboxes. (line 75)
2019-11-26 16:46:24 +01:00
* M-S-RIGHT: Structure Editing. (line 52)
* M-S-RIGHT <1>: Plain Lists. (line 113)
* M-S-RIGHT <2>: Built-in Table Editor.
(line 97)
* M-S-RIGHT <3>: The date/time prompt.
(line 81)
* M-S-UP: Built-in Table Editor.
(line 106)
* M-S-UP <1>: Editing and debugging formulas.
(line 71)
* M-TAB: Editing and debugging formulas.
(line 63)
* M-TAB <1>: Per-file keywords. (line 26)
* M-TAB <2>: Setting Tags. (line 6)
* M-TAB <3>: Property Syntax. (line 82)
* M-TAB <4>: Completion. (line 15)
* M-UP: Structure Editing. (line 55)
* M-UP <1>: Plain Lists. (line 102)
* M-UP <2>: Built-in Table Editor.
(line 100)
* M-UP <3>: Editing and debugging formulas.
(line 77)
* M-UP <4>: Agenda Commands. (line 210)
* M-UP <5>: Key bindings and Useful Functions.
(line 11)
* M-v: The date/time prompt.
(line 81)
2019-12-06 19:15:46 +01:00
* mouse-1: Handling Links. (line 131)
* mouse-1 <1>: The date/time prompt.
2019-11-26 16:46:24 +01:00
(line 81)
2019-12-06 19:15:46 +01:00
* mouse-1 <2>: Creating Footnotes. (line 71)
* mouse-2: Handling Links. (line 131)
* mouse-2 <1>: Agenda Commands. (line 36)
* mouse-2 <2>: Creating Footnotes. (line 71)
2019-11-26 16:46:24 +01:00
* mouse-3: Handling Links. (line 135)
* mouse-3 <1>: Agenda Commands. (line 29)
* n: Using column view. (line 39)
* n <1>: Agenda Commands. (line 20)
* o: Agenda Commands. (line 68)
2020-02-05 19:59:48 +01:00
* O: Agenda Commands. (line 333)
2019-11-26 16:46:24 +01:00
* p: Using column view. (line 39)
* p <1>: Agenda Commands. (line 23)
* q: Setting Tags. (line 123)
* q <1>: Using column view. (line 26)
2020-02-05 19:59:48 +01:00
* q <2>: Agenda Commands. (line 488)
2019-11-26 16:46:24 +01:00
* r: Using column view. (line 22)
* r <1>: Global TODO list. (line 25)
* R: Agenda Commands. (line 154)
* r <2>: Agenda Commands. (line 186)
* RET: Built-in Table Editor.
(line 73)
* RET <1>: Handling Links. (line 127)
* RET <2>: Setting Tags. (line 117)
* RET <3>: The date/time prompt.
(line 81)
* RET <4>: Agenda Commands. (line 39)
* s: Resolving idle time. (line 35)
* S: Resolving idle time. (line 40)
* s <1>: Agenda Commands. (line 193)
2020-02-05 19:59:48 +01:00
* S <1>: Agenda Commands. (line 473)
2019-12-06 19:15:46 +01:00
* s (Agenda dispatcher): Agenda Dispatcher. (line 25)
2019-11-26 16:46:24 +01:00
* s (Agenda dispatcher) <1>: Search view. (line 10)
* S-DOWN: Plain Lists. (line 95)
2019-12-06 19:15:46 +01:00
* S-DOWN <1>: Built-in Table Editor.
(line 112)
* S-DOWN <2>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 66)
2019-12-06 19:15:46 +01:00
* S-DOWN <3>: Priorities. (line 33)
* S-DOWN <4>: Creating Timestamps. (line 50)
* S-DOWN <5>: The date/time prompt.
2019-11-26 16:46:24 +01:00
(line 81)
2020-02-05 19:59:48 +01:00
* S-DOWN <6>: Agenda Commands. (line 289)
2019-11-26 16:46:24 +01:00
* S-LEFT: Plain Lists. (line 154)
2019-12-06 19:15:46 +01:00
* S-LEFT <1>: Built-in Table Editor.
(line 115)
* S-LEFT <2>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 66)
2019-12-06 19:15:46 +01:00
* S-LEFT <3>: TODO Basics. (line 28)
* S-LEFT <4>: Multiple sets in one file.
2019-11-26 16:46:24 +01:00
(line 36)
2019-12-06 19:15:46 +01:00
* S-LEFT <5>: Property Syntax. (line 103)
* S-LEFT <6>: Using column view. (line 39)
* S-LEFT <7>: Creating Timestamps. (line 45)
* S-LEFT <8>: The date/time prompt.
2019-11-26 16:46:24 +01:00
(line 81)
2019-12-06 19:15:46 +01:00
* S-LEFT <9>: The clock table. (line 26)
2020-02-05 19:59:48 +01:00
* S-LEFT <10>: Agenda Commands. (line 321)
2019-12-06 19:15:46 +01:00
* S-M-DOWN: Clocking commands. (line 64)
2019-11-26 16:46:24 +01:00
* S-M-LEFT: Using column view. (line 72)
2019-12-06 19:15:46 +01:00
* S-M-RET: TODO Basics. (line 54)
2019-11-26 16:46:24 +01:00
* S-M-RIGHT: Using column view. (line 69)
2019-12-06 19:15:46 +01:00
* S-M-UP: Clocking commands. (line 64)
2019-11-26 16:46:24 +01:00
* S-RET: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 185)
2019-11-26 16:46:24 +01:00
* S-RIGHT: Plain Lists. (line 154)
2019-12-06 19:15:46 +01:00
* S-RIGHT <1>: Built-in Table Editor.
(line 118)
* S-RIGHT <2>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 66)
2019-12-06 19:15:46 +01:00
* S-RIGHT <3>: TODO Basics. (line 28)
* S-RIGHT <4>: Multiple sets in one file.
2019-11-26 16:46:24 +01:00
(line 36)
2019-12-06 19:15:46 +01:00
* S-RIGHT <5>: Property Syntax. (line 103)
* S-RIGHT <6>: Using column view. (line 39)
* S-RIGHT <7>: Creating Timestamps. (line 45)
* S-RIGHT <8>: The date/time prompt.
2019-11-26 16:46:24 +01:00
(line 81)
2019-12-06 19:15:46 +01:00
* S-RIGHT <9>: The clock table. (line 26)
2020-02-05 19:59:48 +01:00
* S-RIGHT <10>: Agenda Commands. (line 308)
2019-11-26 16:46:24 +01:00
* S-TAB: Global and local cycling.
(line 20)
* S-TAB <1>: Built-in Table Editor.
(line 70)
* S-UP: Plain Lists. (line 95)
2019-12-06 19:15:46 +01:00
* S-UP <1>: Built-in Table Editor.
(line 109)
* S-UP <2>: Editing and debugging formulas.
2019-11-26 16:46:24 +01:00
(line 66)
2019-12-06 19:15:46 +01:00
* S-UP <3>: Priorities. (line 33)
* S-UP <4>: Creating Timestamps. (line 50)
* S-UP <5>: The date/time prompt.
2019-11-26 16:46:24 +01:00
(line 81)
2020-02-05 19:59:48 +01:00
* S-UP <6>: Agenda Commands. (line 284)
2019-11-26 16:46:24 +01:00
* SPC: Setting Tags. (line 114)
* SPC <1>: Agenda Commands. (line 29)
* t: Agenda Commands. (line 231)
2019-12-06 19:15:46 +01:00
* T: Agenda Commands. (line 270)
* t (Agenda dispatcher): TODO Basics. (line 46)
2019-11-26 16:46:24 +01:00
* t (Agenda dispatcher) <1>: Global TODO list. (line 10)
* T (Agenda dispatcher): Global TODO list. (line 18)
* TAB: Global and local cycling.
(line 11)
* TAB <1>: Structure Editing. (line 37)
* TAB <2>: Plain Lists. (line 70)
* TAB <3>: Built-in Table Editor.
(line 63)
* TAB <4>: Editing and debugging formulas.
(line 56)
* TAB <5>: Setting Tags. (line 108)
* TAB <6>: Agenda Commands. (line 36)
2019-12-06 19:15:46 +01:00
* TAB <7>: CDLaTeX mode. (line 29)
2020-02-05 19:59:48 +01:00
* u: Agenda Commands. (line 360)
* U: Agenda Commands. (line 364)
2019-11-26 16:46:24 +01:00
* v: Using column view. (line 52)
* v a: Agenda Commands. (line 146)
* v A: Agenda Commands. (line 151)
* v c: Agenda Commands. (line 165)
* v d: Agenda Commands. (line 71)
* v E: Agenda Commands. (line 173)
* v l: Agenda Commands. (line 131)
* v L: Agenda Commands. (line 131)
* v m: Agenda Commands. (line 91)
* v R: Agenda Commands. (line 154)
* v SPC: Agenda Commands. (line 107)
* v w: Agenda Commands. (line 81)
* v y: Agenda Commands. (line 101)
* v [: Agenda Commands. (line 142)
* w: Agenda Commands. (line 81)
2020-02-05 19:59:48 +01:00
* X: Agenda Commands. (line 336)
* x: Agenda Commands. (line 492)
* z: Agenda Commands. (line 292)
2019-11-26 16:46:24 +01:00
File: org, Node: Command and Function Index, Next: Variable Index, Prev: Key Index, Up: Top
F Command and Function Index
****************************
* Menu:
* lisp-complete-symbol: Editing and debugging formulas.
(line 63)
* next-error: Sparse Trees. (line 32)
2019-12-06 19:15:46 +01:00
* or-clock-goto: Clocking commands. (line 79)
2019-11-26 16:46:24 +01:00
* org-agenda: Activation. (line 13)
2020-02-05 19:59:48 +01:00
* org-agenda-add-note: Agenda Commands. (line 292)
2019-12-06 19:15:46 +01:00
* org-agenda-archive: Agenda Commands. (line 265)
2019-11-26 16:46:24 +01:00
* org-agenda-archive-default-with-confirmation: Agenda Commands.
2019-12-06 19:15:46 +01:00
(line 252)
* org-agenda-archive-to-archive-sibling: Agenda Commands. (line 261)
2019-11-26 16:46:24 +01:00
* org-agenda-archives-mode: Agenda Commands. (line 146)
2020-02-05 19:59:48 +01:00
* org-agenda-bulk-action: Agenda Commands. (line 380)
* org-agenda-bulk-mark: Agenda Commands. (line 350)
* org-agenda-bulk-mark-all: Agenda Commands. (line 356)
* org-agenda-bulk-mark-regexp: Agenda Commands. (line 376)
* org-agenda-bulk-remove-all-marks: Agenda Commands. (line 364)
* org-agenda-bulk-toggle: Agenda Commands. (line 368)
* org-agenda-bulk-toggle-all: Agenda Commands. (line 372)
* org-agenda-bulk-unmark: Agenda Commands. (line 360)
* org-agenda-capture: Agenda Commands. (line 342)
* org-agenda-clock-cancel: Agenda Commands. (line 336)
2019-11-26 16:46:24 +01:00
* org-agenda-clock-goto: Agenda Commands. (line 124)
2020-02-05 19:59:48 +01:00
* org-agenda-clock-goto <1>: Agenda Commands. (line 339)
* org-agenda-clock-in: Agenda Commands. (line 329)
* org-agenda-clock-out: Agenda Commands. (line 333)
2019-11-26 16:46:24 +01:00
* org-agenda-clockreport-mode: Agenda Commands. (line 154)
* org-agenda-columns: Agenda Commands. (line 197)
* org-agenda-columns <1>: Agenda Column View. (line 12)
2020-02-05 19:59:48 +01:00
* org-agenda-convert-date: Agenda Commands. (line 478)
* org-agenda-date-prompt: Agenda Commands. (line 325)
2019-11-26 16:46:24 +01:00
* org-agenda-day-view: Agenda Commands. (line 71)
2020-02-05 19:59:48 +01:00
* org-agenda-deadline: Agenda Commands. (line 304)
* org-agenda-diary-entry: Agenda Commands. (line 451)
* org-agenda-do-date-earlier: Agenda Commands. (line 321)
* org-agenda-do-date-later: Agenda Commands. (line 308)
2019-11-26 16:46:24 +01:00
* org-agenda-drag-line-backward: Agenda Commands. (line 210)
* org-agenda-drag-line-forward: Agenda Commands. (line 217)
* org-agenda-earlier: Agenda Commands. (line 115)
* org-agenda-entry-text-mode: Agenda Commands. (line 173)
2020-02-05 19:59:48 +01:00
* org-agenda-exit: Agenda Commands. (line 492)
2019-11-26 16:46:24 +01:00
* org-agenda-file-to-front: Agenda Files. (line 16)
2019-12-06 19:15:46 +01:00
* org-agenda-filter: Filtering/limiting agenda items.
(line 73)
* org-agenda-filter-by-category: Filtering/limiting agenda items.
(line 38)
* org-agenda-filter-by-effort: Filtering/limiting agenda items.
(line 49)
* org-agenda-filter-by-regexp: Filtering/limiting agenda items.
(line 44)
* org-agenda-filter-by-tag: Filtering/limiting agenda items.
(line 28)
* org-agenda-filter-by-top-headline: Filtering/limiting agenda items.
(line 68)
2019-11-26 16:46:24 +01:00
* org-agenda-follow-mode: Agenda Commands. (line 42)
* org-agenda-goto: Agenda Commands. (line 36)
2020-02-05 19:59:48 +01:00
* org-agenda-goto-calendar: Agenda Commands. (line 444)
2019-11-26 16:46:24 +01:00
* org-agenda-goto-date: Agenda Commands. (line 121)
* org-agenda-goto-today: Agenda Commands. (line 118)
2020-02-05 19:59:48 +01:00
* org-agenda-holidays: Agenda Commands. (line 482)
2019-12-06 19:15:46 +01:00
* org-agenda-kill: Agenda Commands. (line 243)
2019-11-26 16:46:24 +01:00
* org-agenda-later: Agenda Commands. (line 110)
2019-12-06 19:15:46 +01:00
* org-agenda-limit-interactively: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 164)
2019-11-26 16:46:24 +01:00
* org-agenda-list: Weekly/daily agenda. (line 10)
* org-agenda-list-stuck-projects: Stuck projects. (line 14)
* org-agenda-log-mode: Agenda Commands. (line 131)
* org-agenda-manipulate-query-add: Agenda Commands. (line 142)
* org-agenda-month-view: Agenda Commands. (line 91)
* org-agenda-next-line: Agenda Commands. (line 20)
* org-agenda-open-link: Agenda Commands. (line 56)
2020-02-05 19:59:48 +01:00
* org-agenda-phases-of-moon: Agenda Commands. (line 469)
2019-11-26 16:46:24 +01:00
* org-agenda-previous-line: Agenda Commands. (line 23)
2019-12-06 19:15:46 +01:00
* org-agenda-priority: Agenda Commands. (line 279)
2020-02-05 19:59:48 +01:00
* org-agenda-priority-down: Agenda Commands. (line 289)
* org-agenda-priority-up: Agenda Commands. (line 284)
* org-agenda-quit: Agenda Commands. (line 488)
2019-11-26 16:46:24 +01:00
* org-agenda-recenter: Agenda Commands. (line 33)
* org-agenda-redo: Agenda Commands. (line 186)
2019-12-06 19:15:46 +01:00
* org-agenda-refile: Agenda Commands. (line 249)
2019-11-26 16:46:24 +01:00
* org-agenda-remove-restriction-lock: Agenda Files. (line 52)
* org-agenda-remove-restriction-lock <1>: Agenda Files. (line 65)
* org-agenda-remove-restriction-lock <2>: Agenda Commands. (line 206)
* org-agenda-reset-view: Agenda Commands. (line 107)
2020-02-05 19:59:48 +01:00
* org-agenda-schedule: Agenda Commands. (line 300)
2019-11-26 16:46:24 +01:00
* org-agenda-set-restriction-lock: Agenda Files. (line 43)
2019-12-06 19:15:46 +01:00
* org-agenda-set-tags: Agenda Commands. (line 275)
2019-11-26 16:46:24 +01:00
* org-agenda-show-and-scroll-up: Agenda Commands. (line 29)
2019-12-06 19:15:46 +01:00
* org-agenda-show-tags: Agenda Commands. (line 270)
2020-02-05 19:59:48 +01:00
* org-agenda-sunrise-sunset: Agenda Commands. (line 473)
2019-11-26 16:46:24 +01:00
* org-agenda-switch-to: Agenda Commands. (line 39)
* org-agenda-todo: Agenda Commands. (line 231)
2019-12-06 19:15:46 +01:00
* org-agenda-todo-nextset: Agenda Commands. (line 237)
* org-agenda-toggle-archive-tag: Agenda Commands. (line 257)
2019-11-26 16:46:24 +01:00
* org-agenda-toggle-diary: Agenda Commands. (line 127)
* org-agenda-tree-to-indirect-buffer: Agenda Commands. (line 49)
* org-agenda-undo: Agenda Commands. (line 227)
* org-agenda-week-view: Agenda Commands. (line 81)
* org-agenda-write: Exporting Agenda Views.
(line 13)
* org-agenda-year-view: Agenda Commands. (line 101)
* org-archive-subtree: Moving subtrees. (line 10)
* org-archive-subtree-default: Archiving. (line 12)
* org-archive-to-archive-sibling: Internal archiving. (line 54)
* org-ascii-convert-region-to-ascii: Export in Foreign Buffers.
(line 11)
* org-ascii-convert-region-to-utf8: Export in Foreign Buffers.
(line 14)
2019-12-06 19:15:46 +01:00
* org-ascii-export-as-ascii: ASCII/Latin-1/UTF-8 export.
(line 35)
2019-11-26 16:46:24 +01:00
* org-ascii-export-to-ascii: ASCII/Latin-1/UTF-8 export.
(line 26)
2019-12-06 19:15:46 +01:00
* org-attach: Attachment defaults and dispatcher.
(line 19)
2020-02-05 19:59:48 +01:00
* org-attach <1>: Agenda Commands. (line 297)
2019-12-06 19:15:46 +01:00
* org-attach-attach: Attachment defaults and dispatcher.
(line 24)
* org-attach-buffer: Attachment defaults and dispatcher.
(line 34)
* org-attach-dired-to-subtree: Attach from Dired. (line 6)
* org-attach-new: Attachment defaults and dispatcher.
(line 38)
* org-attach-open: Attachment defaults and dispatcher.
(line 45)
* org-attach-open-in-emacs: Attachment defaults and dispatcher.
(line 51)
* org-attach-reveal: Attachment defaults and dispatcher.
(line 54)
* org-attach-reveal-in-emacs: Attachment defaults and dispatcher.
(line 57)
* org-attach-sync: Attachment defaults and dispatcher.
(line 41)
2019-11-26 16:46:24 +01:00
* org-babel-check-src-block: Key bindings and Useful Functions.
(line 20)
* org-babel-demarcate-block: Key bindings and Useful Functions.
(line 20)
* org-babel-describe-bindings: Key bindings and Useful Functions.
(line 20)
* org-babel-do-key-sequence-in-edit-buffer: Key bindings and Useful Functions.
(line 20)
* org-babel-execute-buffer: Key bindings and Useful Functions.
(line 20)
* org-babel-execute-maybe: Key bindings and Useful Functions.
(line 20)
* org-babel-execute-src-block: Evaluating Code Blocks.
(line 22)
* org-babel-execute-src-block <1>: Key bindings and Useful Functions.
(line 11)
* org-babel-execute-subtree: Key bindings and Useful Functions.
(line 20)
* org-babel-expand-src-block: Key bindings and Useful Functions.
(line 20)
* org-babel-goto-named-result: Key bindings and Useful Functions.
(line 20)
* org-babel-goto-named-src-block: Key bindings and Useful Functions.
(line 20)
* org-babel-goto-src-block-head: Key bindings and Useful Functions.
(line 20)
* org-babel-insert-header-arg: Key bindings and Useful Functions.
(line 20)
* org-babel-load-in-session: Key bindings and Useful Functions.
(line 11)
* org-babel-load-in-session <1>: Key bindings and Useful Functions.
(line 20)
* org-babel-lob-ingest: Library of Babel. (line 12)
* org-babel-lob-ingest <1>: Key bindings and Useful Functions.
(line 20)
* org-babel-next-src-block: Key bindings and Useful Functions.
(line 20)
* org-babel-open-src-block-result: Key bindings and Useful Functions.
(line 11)
* org-babel-open-src-block-result <1>: Key bindings and Useful Functions.
(line 20)
* org-babel-pop-to-session: Key bindings and Useful Functions.
(line 11)
* org-babel-previous-src-block: Key bindings and Useful Functions.
(line 20)
* org-babel-sha1-hash: Key bindings and Useful Functions.
(line 20)
* org-babel-switch-to-session-with-code: Key bindings and Useful Functions.
(line 20)
* org-babel-tangle: Extracting Source Code.
(line 111)
* org-babel-tangle <1>: Key bindings and Useful Functions.
(line 20)
* org-babel-tangle-file: Extracting Source Code.
(line 116)
* org-babel-tangle-file <1>: Key bindings and Useful Functions.
(line 20)
* org-babel-tangle-jump-to-org: Extracting Source Code.
(line 129)
* org-babel-view-src-block-info: Key bindings and Useful Functions.
(line 20)
* org-backward-heading-same-level: Motion. (line 18)
* org-batch-agenda: Extracting Agenda Information.
(line 10)
* org-batch-agenda-csv: Extracting Agenda Information.
(line 41)
* org-bbdb-anniversaries: Weekly/daily agenda. (line 78)
* org-bbdb-anniversaries-future: Weekly/daily agenda. (line 109)
* org-beamer-export-as-latex: Beamer export commands.
(line 12)
* org-beamer-export-to-latex: Beamer export commands.
(line 7)
* org-beamer-export-to-pdf: Beamer export commands.
(line 16)
* org-beamer-select-environment: Editing support. (line 12)
* org-buffer-property-keys: Using the Property API.
(line 34)
2020-02-05 19:59:48 +01:00
* org-calendar-goto-agenda: Agenda Commands. (line 447)
2019-11-26 16:46:24 +01:00
* org-capture: Activation. (line 13)
* org-capture <1>: Using capture. (line 7)
* 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 36)
* org-check-before-date: Inserting deadline/schedule.
(line 33)
* org-check-deadlines: Inserting deadline/schedule.
(line 26)
2019-12-06 19:15:46 +01:00
* org-clock-cancel: Clocking commands. (line 75)
* org-clock-display: Clocking commands. (line 84)
2019-11-26 16:46:24 +01:00
* org-clock-in: Clocking commands. (line 7)
2019-12-06 19:15:46 +01:00
* org-clock-in-last: Clocking commands. (line 44)
* org-clock-modify-effort-estimate: Clocking commands. (line 50)
2019-11-26 16:46:24 +01:00
* org-clock-modify-effort-estimate <1>: Effort Estimates. (line 20)
2019-12-06 19:15:46 +01:00
* org-clock-out: Clocking commands. (line 36)
* org-clock-timestamp-down: Clocking commands. (line 64)
* org-clock-timestamp-up: Clocking commands. (line 64)
* org-clock-timestamps-down: Clocking commands. (line 59)
* org-clock-timestamps-up: Clocking commands. (line 59)
* org-clocktable-try-shift: The clock table. (line 26)
* org-clocktable-write-default: The clock table. (line 115)
2019-11-26 16:46:24 +01:00
* org-clone-subtree-with-time-shift: Structure Editing. (line 91)
* org-columns-delete: Using column view. (line 72)
* org-columns-edit-allowed: Using column view. (line 56)
* org-columns-edit-value: Using column view. (line 43)
* org-columns-narrow: Using column view. (line 66)
* org-columns-new: Using column view. (line 69)
* org-columns-next-allowed-value: Using column view. (line 39)
* org-columns-previous-allowed-value: Using column view. (line 39)
* org-columns-quit: Using column view. (line 26)
* org-columns-redo: Using column view. (line 22)
* org-columns-set-tags-or-toggle: Using column view. (line 49)
* org-columns-show-value: Using column view. (line 52)
* org-columns-widen: Using column view. (line 66)
* org-compute-property-at-point: Property Syntax. (line 112)
2019-12-06 19:15:46 +01:00
* org-copy: Refile and Copy. (line 51)
2019-11-26 16:46:24 +01:00
* org-copy-subtree: Structure Editing. (line 69)
* org-copy-visible: Global and local cycling.
(line 65)
* org-cut-subtree: Structure Editing. (line 65)
* org-cycle: Global and local cycling.
(line 11)
* org-cycle <1>: Structure Editing. (line 37)
* org-cycle <2>: Plain Lists. (line 70)
* org-cycle-agenda-files: Agenda Files. (line 26)
* org-date-from-calendar: Creating Timestamps. (line 32)
* org-dblock-update: Capturing column view.
2019-12-06 19:15:46 +01:00
(line 71)
* org-dblock-update <1>: The clock table. (line 17)
* org-dblock-update <2>: Dynamic Blocks. (line 25)
2019-11-26 16:46:24 +01:00
* org-deadline: Inserting deadline/schedule.
(line 10)
* org-delete-property: Property Syntax. (line 106)
* org-delete-property-globally: Property Syntax. (line 109)
* org-demote: Using the Mapping API.
(line 93)
* org-demote-subtree: Structure Editing. (line 52)
* org-do-demote: Structure Editing. (line 46)
* org-do-promote: Structure Editing. (line 43)
2019-12-06 19:15:46 +01:00
* org-dynamic-block-insert-dblock: Dynamic Blocks. (line 10)
* org-edit-special: Literal Examples. (line 102)
* org-edit-special <1>: Include Files. (line 63)
2019-11-26 16:46:24 +01:00
* org-edit-special <2>: Cooperation. (line 59)
* org-entities-help: Special Symbols. (line 16)
* org-entry-add-to-multivalued-property: Using the Property API.
(line 49)
* org-entry-delete: Using the Property API.
(line 28)
* org-entry-get: Using the Property API.
(line 19)
* org-entry-get-multivalued-property: Using the Property API.
(line 45)
* org-entry-member-in-multivalued-property: Using the Property API.
(line 58)
* org-entry-properties: Using the Property API.
(line 9)
* org-entry-put: Using the Property API.
(line 31)
* org-entry-put-multivalued-property: Using the Property API.
(line 40)
* org-entry-remove-from-multivalued-property: Using the Property API.
(line 53)
* org-evaluate-time-range: Creating Timestamps. (line 62)
2019-12-06 19:15:46 +01:00
* org-evaluate-time-range <1>: Clocking commands. (line 53)
2019-11-26 16:46:24 +01:00
* org-export: The Export Dispatcher.
(line 16)
* org-export-define-backend: Adding Export Back-ends.
(line 10)
* org-export-define-derived-backend: Adding Export Back-ends.
(line 10)
* org-export-to-odt: ODT export commands. (line 7)
* org-forward-heading-same-level: Motion. (line 15)
* org-global-cycle: Global and local cycling.
(line 20)
* org-goto: Motion. (line 24)
* org-goto-calendar: Creating Timestamps. (line 35)
* org-html-convert-region-to-html: Export in Foreign Buffers.
(line 17)
* org-html-export-as-html: HTML export commands.
(line 14)
* org-html-export-to-html: HTML export commands.
(line 7)
* org-icalendar-combine-agenda-files: iCalendar Export. (line 47)
* org-icalendar-export-agenda-files: iCalendar Export. (line 43)
* org-icalendar-export-to-ics: iCalendar Export. (line 39)
2019-12-06 19:15:46 +01:00
* org-indent-mode: Org Indent Mode. (line 6)
2019-11-26 16:46:24 +01:00
* org-info-find-node: Documentation Access.
(line 6)
* org-insert-columns-dblock: Capturing column view.
2019-12-06 19:15:46 +01:00
(line 67)
2019-11-26 16:46:24 +01:00
* org-insert-drawer: Drawers. (line 18)
* org-insert-drawer <1>: Property Syntax. (line 90)
* org-insert-heading: Plain Lists. (line 83)
* org-insert-heading <1>: Timers. (line 40)
* org-insert-heading-respect-content: Structure Editing. (line 26)
* org-insert-link: Handling Links. (line 69)
* org-insert-link-global: Using Links Outside Org.
(line 6)
* org-insert-property-drawer: Using the Property API.
(line 19)
* org-insert-property-drawer <1>: Using the Property API.
(line 37)
* org-insert-structure-template: Structure Templates. (line 11)
* org-insert-todo-heading: Structure Editing. (line 29)
2019-12-06 19:15:46 +01:00
* org-insert-todo-heading <1>: TODO Basics. (line 54)
* org-insert-todo-heading <2>: Checkboxes. (line 75)
2019-11-26 16:46:24 +01:00
* org-insert-todo-heading-respect-content: Structure Editing. (line 33)
* org-latex-convert-region-to-latex: Export in Foreign Buffers.
(line 20)
* org-latex-export-as-latex: LaTeX/PDF export commands.
(line 11)
* org-latex-export-to-latex~: LaTeX/PDF export commands.
(line 7)
* org-latex-export-to-pdf: LaTeX/PDF export commands.
(line 14)
2019-12-06 19:15:46 +01:00
* org-latex-preview: Previewing LaTeX fragments.
(line 18)
2019-12-29 11:23:16 +01:00
* org-link-escape: Link Format. (line 25)
2019-11-26 16:46:24 +01:00
* org-link-set-parameters: Adding Hyperlink Types.
(line 69)
* org-lint: Org Syntax. (line 24)
* org-lookup-all: Lookup functions. (line 23)
* org-lookup-first: Lookup functions. (line 9)
* org-lookup-last: Lookup functions. (line 19)
* org-map-entries: Using the Mapping API.
(line 12)
* org-mark-ring-goto: Handling Links. (line 144)
* org-mark-ring-push: Handling Links. (line 139)
* org-mark-subtree: Structure Editing. (line 61)
* org-match-sparse-tree: Tag Searches. (line 10)
* org-match-sparse-tree <1>: Property Searches. (line 11)
* org-md-convert-region-to-md: Export in Foreign Buffers.
(line 26)
* org-md-export-as-markdown: Markdown Export. (line 21)
* org-md-export-to-markdown: Markdown Export. (line 17)
* org-meta-return: Structure Editing. (line 7)
* 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 58)
* org-move-subtree-up: Structure Editing. (line 55)
* org-narrow-to-block: Structure Editing. (line 118)
2019-12-06 19:15:46 +01:00
* org-narrow-to-block <1>: Dynamic Blocks. (line 58)
2019-11-26 16:46:24 +01:00
* org-narrow-to-subtree: Structure Editing. (line 115)
* org-next-link: Handling Links. (line 151)
* org-next-visible-heading: Motion. (line 9)
* org-occur: Sparse Trees. (line 20)
* org-odt-convert: Extending ODT export.
(line 37)
* org-open-at-point: Handling Links. (line 106)
* org-open-at-point <1>: Creating Timestamps. (line 40)
* org-open-at-point-global: Using Links Outside Org.
(line 6)
* org-org-export-to-org: Org Export. (line 15)
* org-paste-subtree: Structure Editing. (line 73)
* org-previous-link: Handling Links. (line 151)
* org-previous-visible-heading: Motion. (line 12)
* org-priority: Priorities. (line 25)
* org-priority <1>: Using the Mapping API.
(line 81)
* org-priority-down: Priorities. (line 33)
* org-priority-up: Priorities. (line 33)
* org-promote: Using the Mapping API.
(line 90)
* org-promote-subtree: Structure Editing. (line 49)
* org-property-action: Property Syntax. (line 95)
2019-12-06 19:15:46 +01:00
* org-protocol-create: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 67)
2019-12-06 19:15:46 +01:00
* org-protocol-create-for-org: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 67)
* org-publish: Triggering Publication.
(line 9)
* org-publish-all: Triggering Publication.
(line 19)
* org-publish-current-file: Triggering Publication.
(line 16)
* org-publish-current-project: Triggering Publication.
(line 13)
* org-publish-find-date: Site map. (line 21)
* org-publish-find-property: Site map. (line 21)
* org-publish-find-title: Site map. (line 21)
* org-refile: Structure Editing. (line 99)
2019-12-06 19:15:46 +01:00
* org-refile <1>: Refile and Copy. (line 13)
* org-refile-cache-clear: Refile and Copy. (line 46)
* org-refile-goto-last-stored: Refile and Copy. (line 35)
2019-11-26 16:46:24 +01:00
* org-remove-file: Agenda Files. (line 22)
* org-reveal: Global and local cycling.
(line 42)
* org-save-all-org-buffers: Agenda Commands. (line 193)
* org-schedule: Inserting deadline/schedule.
(line 18)
* org-search-view: Search view. (line 10)
* org-set-effort: Effort Estimates. (line 15)
* org-set-property: Property Syntax. (line 86)
* org-set-property <1>: Property Syntax. (line 98)
* org-set-property <2>: Using Header Arguments.
(line 70)
* org-set-startup-visibility: Global and local cycling.
(line 35)
* org-set-startup-visibility <1>: Initial visibility. (line 23)
* org-set-tags-command: Setting Tags. (line 11)
2019-12-06 19:15:46 +01:00
* org-show-todo-tree: TODO Basics. (line 35)
2019-11-26 16:46:24 +01:00
* org-sort: Structure Editing. (line 103)
* org-sparse-tree: Sparse Trees. (line 16)
* org-speed-command-help: Speed Keys. (line 18)
* org-speedbar-set-agenda-restriction: Agenda Files. (line 58)
* org-store-agenda-views: Exporting Agenda Views.
(line 53)
* org-store-link: Activation. (line 13)
* org-store-link <1>: Handling Links. (line 9)
* org-submit-bug-report: Feedback. (line 13)
* org-switchb: Agenda Files. (line 29)
* org-table-align: Built-in Table Editor.
(line 60)
* org-table-align <1>: Column Width and Alignment.
(line 17)
* org-table-beginning-of-field: Built-in Table Editor.
(line 78)
* org-table-blank-field: Built-in Table Editor.
(line 67)
* org-table-copy-down: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 185)
2019-11-26 16:46:24 +01:00
* org-table-copy-region: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 150)
2019-11-26 16:46:24 +01:00
* org-table-create-or-convert-from-region: Built-in Table Editor.
(line 42)
* org-table-create-or-convert-from-region <1>: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 220)
2019-11-26 16:46:24 +01:00
* org-table-create-with-table.el: Cooperation. (line 63)
* org-table-cut-region: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 156)
2019-11-26 16:46:24 +01:00
* org-table-delete-column: Built-in Table Editor.
(line 94)
* org-table-edit-field: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 201)
2019-11-26 16:46:24 +01:00
* org-table-edit-formulas: Editing and debugging formulas.
(line 37)
* org-table-end-of-field: Built-in Table Editor.
(line 82)
* org-table-eval-formula: Field and range formulas.
(line 28)
* org-table-eval-formula <1>: Column formulas. (line 33)
* org-table-eval-formula <2>: Editing and debugging formulas.
(line 14)
* org-table-eval-formula <3>: Editing and debugging formulas.
(line 19)
* org-table-expand: Column Width and Alignment.
(line 57)
* org-table-export: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 225)
2019-11-26 16:46:24 +01:00
* org-table-fedit-abort: Editing and debugging formulas.
(line 49)
* org-table-fedit-finish: Editing and debugging formulas.
(line 45)
* org-table-fedit-line-down: Editing and debugging formulas.
(line 74)
* org-table-fedit-line-up: Editing and debugging formulas.
(line 71)
* org-table-fedit-lisp-indent: Editing and debugging formulas.
(line 56)
* org-table-fedit-ref-down: Editing and debugging formulas.
(line 66)
* org-table-fedit-ref-left: Editing and debugging formulas.
(line 66)
* org-table-fedit-ref-right: Editing and debugging formulas.
(line 66)
* org-table-fedit-ref-up: Editing and debugging formulas.
(line 66)
* org-table-fedit-scroll-down: Editing and debugging formulas.
(line 80)
* org-table-fedit-scroll-up: Editing and debugging formulas.
(line 77)
* org-table-fedit-toggle-ref-type: Editing and debugging formulas.
(line 52)
* org-table-field-info: Editing and debugging formulas.
(line 25)
* org-table-hline-and-move: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 129)
2019-11-26 16:46:24 +01:00
* org-table-import: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 211)
2019-11-26 16:46:24 +01:00
* org-table-insert-column: Built-in Table Editor.
(line 97)
* org-table-insert-hline: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 125)
2019-11-26 16:46:24 +01:00
* org-table-insert-row: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 121)
2019-11-26 16:46:24 +01:00
* org-table-iterate: Updating the table. (line 24)
* org-table-iterate-buffer-tables: Updating the table. (line 32)
* org-table-kill-row: Built-in Table Editor.
(line 106)
2019-12-06 19:15:46 +01:00
* org-table-move-cell-down: Built-in Table Editor.
(line 112)
* org-table-move-cell-left: Built-in Table Editor.
(line 115)
* org-table-move-cell-right: Built-in Table Editor.
(line 118)
* org-table-move-cell-up: Built-in Table Editor.
(line 109)
2019-11-26 16:46:24 +01:00
* org-table-move-column-left: Built-in Table Editor.
(line 88)
* org-table-move-column-right: Built-in Table Editor.
(line 91)
* org-table-move-row-down: Built-in Table Editor.
(line 103)
* org-table-move-row-up: Built-in Table Editor.
(line 100)
* org-table-next-field: Built-in Table Editor.
(line 63)
* org-table-next-row: Built-in Table Editor.
(line 73)
* org-table-paste-rectangle: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 160)
2019-11-26 16:46:24 +01:00
* org-table-previous-field: Built-in Table Editor.
(line 70)
* org-table-recalculate: Updating the table. (line 14)
* org-table-recalculate-buffer-tables: Updating the table. (line 29)
* org-table-rotate-recalc-marks: Advanced features. (line 11)
* org-table-shrink: Column Width and Alignment.
(line 54)
* org-table-sort-lines: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 133)
2019-11-26 16:46:24 +01:00
* org-table-sum: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 180)
2019-11-26 16:46:24 +01:00
* org-table-toggle-column-width: Column Width and Alignment.
(line 44)
* org-table-toggle-coordinate-overlays: Editing and debugging formulas.
(line 29)
* org-table-toggle-coordinate-overlays <1>: Editing and debugging formulas.
(line 83)
* org-table-toggle-formula-debugger: Editing and debugging formulas.
(line 34)
* org-table-wrap-region: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 167)
2019-11-26 16:46:24 +01:00
* org-tags-view: Tag Searches. (line 15)
* org-tags-view <1>: Property Searches. (line 15)
* org-tags-view <2>: Matching tags and properties.
(line 13)
* org-tags-view <3>: Matching tags and properties.
(line 21)
* org-texinfo-convert-region-to-texinfo: Export in Foreign Buffers.
(line 23)
* org-texinfo-export-to-info: Texinfo export commands.
(line 11)
* org-texinfo-export-to-texinfo: Texinfo export commands.
(line 7)
* org-time-stamp: Creating Timestamps. (line 11)
* org-time-stamp-inactive: Creating Timestamps. (line 25)
* org-timer: Timers. (line 32)
* org-timer-item: Timers. (line 36)
* org-timer-pause-or-continue: Timers. (line 44)
* org-timer-set-timer: Timers. (line 23)
* org-timer-start: Timers. (line 13)
* org-timer-stop: Timers. (line 47)
* org-timestamp-down-day: Creating Timestamps. (line 45)
* org-timestamp-up-day: Creating Timestamps. (line 45)
2019-12-06 19:15:46 +01:00
* org-todo: Clocking commands. (line 71)
2019-11-26 16:46:24 +01:00
* org-todo <1>: Using the Mapping API.
(line 77)
* org-todo-list: Global TODO list. (line 10)
* org-todo-list <1>: Global TODO list. (line 18)
* org-toggle-archive-tag: Internal archiving. (line 39)
2019-12-06 19:15:46 +01:00
* org-toggle-checkbox: Checkboxes. (line 52)
2019-11-26 16:46:24 +01:00
* org-toggle-comment: Comment Lines. (line 20)
* org-toggle-heading: Structure Editing. (line 124)
* org-toggle-inline-images: Images. (line 24)
* org-toggle-ordered-property: TODO dependencies. (line 38)
2019-12-06 19:15:46 +01:00
* org-toggle-ordered-property <1>: Checkboxes. (line 79)
2019-11-26 16:46:24 +01:00
* org-toggle-pretty-entities: Subscripts and Superscripts.
(line 20)
* org-toggle-pretty-entities <1>: Special Symbols. (line 31)
2019-12-06 19:15:46 +01:00
* org-toggle-sticky-agenda: Agenda Dispatcher. (line 53)
2019-11-26 16:46:24 +01:00
* org-toggle-tag: Using the Mapping API.
(line 85)
* org-toggle-tags-groups: Tag Hierarchy. (line 86)
* org-toggle-time-stamp-overlays: Custom time format. (line 13)
* org-tree-to-indirect-buffer: Global and local cycling.
(line 59)
2019-12-06 19:15:46 +01:00
* org-update-statistics-cookies: Checkboxes. (line 87)
2019-11-26 16:46:24 +01:00
* org-version: Feedback. (line 13)
* org-yank: Structure Editing. (line 79)
* orgtbl-ascii-draw: Org Plot. (line 109)
* orgtbl-mode: Orgtbl Mode. (line 6)
* orgtbl-to-csv: Translator functions.
(line 6)
* orgtbl-to-generic: Translator functions.
(line 6)
* orgtbl-to-html: Translator functions.
(line 6)
* orgtbl-to-latex: Translator functions.
(line 6)
* orgtbl-to-orgtbl: Translator functions.
(line 6)
* orgtbl-to-texinfo: Translator functions.
(line 6)
* orgtbl-to-tsv: Translator functions.
(line 6)
* orgtbl-to-unicode: Translator functions.
(line 6)
* outline-show-all: Global and local cycling.
(line 39)
* outline-show-branches: Global and local cycling.
(line 51)
* outline-show-children: Global and local cycling.
(line 55)
* outline-up-heading: Motion. (line 21)
* pcomplete: Property Syntax. (line 82)
* previous-error: Sparse Trees. (line 35)
* widen: Structure Editing. (line 121)
File: org, Node: Variable Index, Prev: Command and Function Index, Up: Top
G Variable Index
****************
This is not a complete index of variables and faces, only the ones that
are mentioned in the manual. For a more complete list, use ‘
org-customize’
* Menu:
2019-12-06 19:15:46 +01:00
* cdlatex-simplify-sub-super-scripts: CDLaTeX mode. (line 43)
2019-11-26 16:46:24 +01:00
* constants-unit-system: References. (line 120)
2019-12-06 19:15:46 +01:00
* constants-unit-system <1>: In-buffer Settings. (line 141)
2019-11-26 16:46:24 +01:00
* LaTeX-verbatim-environments: A LaTeX example. (line 19)
2019-12-06 19:15:46 +01:00
* org-adapt-indentation: Hard indentation. (line 16)
* org-agenda-auto-exclude-function: Filtering/limiting agenda items.
(line 98)
2020-02-05 19:59:48 +01:00
* org-agenda-bulk-custom-functions: Agenda Commands. (line 349)
* org-agenda-bulk-custom-functions <1>: Agenda Commands. (line 428)
* org-agenda-bulk-persistent-marks: Agenda Commands. (line 380)
2019-12-06 19:15:46 +01:00
* org-agenda-category-filter-preset: Filtering/limiting agenda items.
(line 6)
* org-agenda-category-icon-alist: Categories. (line 16)
2019-11-26 16:46:24 +01:00
* org-agenda-clock-consistency-checks: Agenda Commands. (line 165)
* org-agenda-columns-add-appointments-to-effort-sum: Effort Estimates.
(line 41)
2019-12-06 19:15:46 +01:00
* org-agenda-confirm-kill: Agenda Commands. (line 243)
2019-11-26 16:46:24 +01:00
* org-agenda-custom-commands: Sparse Trees. (line 37)
* org-agenda-custom-commands <1>: Storing searches. (line 11)
* org-agenda-custom-commands <2>: Setting options. (line 6)
* org-agenda-custom-commands <3>: Extracting Agenda Information.
(line 10)
* org-agenda-custom-commands-contexts: Setting options. (line 59)
2020-02-05 19:59:48 +01:00
* org-agenda-diary-file: Agenda Commands. (line 457)
2019-11-26 16:46:24 +01:00
* org-agenda-dim-blocked-tasks: TODO dependencies. (line 48)
* org-agenda-dim-blocked-tasks <1>: Speeding Up Your Agendas.
(line 15)
2019-12-06 19:15:46 +01:00
* org-agenda-effort-filter-preset: Filtering/limiting agenda items.
(line 6)
2019-11-26 16:46:24 +01:00
* org-agenda-entry-text-maxlines: Agenda Commands. (line 173)
* org-agenda-exporter-settings: Exporting Agenda Views.
(line 14)
* org-agenda-exporter-settings <1>: Exporting Agenda Views.
(line 68)
* org-agenda-files: Agenda Files. (line 6)
* org-agenda-files <1>: Sorting of agenda items.
(line 9)
* org-agenda-inhibit-startup: Speeding Up Your Agendas.
(line 19)
* org-agenda-log-mode-items: Agenda Commands. (line 131)
2019-12-06 19:15:46 +01:00
* org-agenda-max-effort: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 135)
2019-12-06 19:15:46 +01:00
* org-agenda-max-entries: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 132)
2019-12-06 19:15:46 +01:00
* org-agenda-max-tags: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 141)
2019-12-06 19:15:46 +01:00
* org-agenda-max-todos: Filtering/limiting agenda items.
2019-12-29 11:23:16 +01:00
(line 138)
2019-11-26 16:46:24 +01:00
* org-agenda-overriding-header: Special Agenda Views.
(line 38)
* org-agenda-prefix-format: Presentation and Sorting.
(line 6)
2019-12-06 19:15:46 +01:00
* org-agenda-regexp-filter-preset: Filtering/limiting agenda items.
(line 6)
2019-11-26 16:46:24 +01:00
* org-agenda-restore-windows-after-quit: Agenda Views. (line 42)
* org-agenda-search-headline-for-time: Time-of-day specifications.
(line 16)
2019-12-06 19:15:46 +01:00
* org-agenda-show-inherited-tags: Agenda Commands. (line 270)
2019-11-26 16:46:24 +01:00
* org-agenda-show-inherited-tags <1>: Speeding Up Your Agendas.
(line 23)
* org-agenda-skip-archived-trees: Internal archiving. (line 23)
* org-agenda-skip-archived-trees <1>: Agenda Views. (line 37)
* org-agenda-skip-comment-trees: Agenda Views. (line 37)
* org-agenda-skip-deadline-prewarning-if-scheduled: Deadlines and Scheduling.
(line 24)
* 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 69)
* org-agenda-skip-function-global: Special Agenda Views.
(line 6)
* org-agenda-skip-scheduled-delay-if-deadline: Deadlines and Scheduling.
(line 42)
* org-agenda-skip-scheduled-if-deadline-is-shown: Repeated tasks.
(line 76)
* org-agenda-skip-scheduled-if-done: Deadlines and Scheduling.
(line 34)
* org-agenda-sorting-strategy: Sorting of agenda items.
(line 28)
* org-agenda-span: Weekly/daily agenda. (line 15)
* org-agenda-span <1>: Agenda Commands. (line 107)
* 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 154)
* org-agenda-start-with-entry-text-mode: Agenda Commands. (line 173)
* org-agenda-start-with-follow-mode: Agenda Commands. (line 42)
2019-12-06 19:15:46 +01:00
* org-agenda-sticky: Agenda Dispatcher. (line 53)
* org-agenda-tag-filter-preset: Filtering/limiting agenda items.
(line 6)
2019-11-26 16:46:24 +01:00
* org-agenda-tags-column: Presentation and Sorting.
(line 6)
* org-agenda-tags-todo-honor-ignore-options: Matching tags and properties.
(line 21)
2019-12-06 19:15:46 +01:00
* org-agenda-text-search-extra-files: Agenda Dispatcher. (line 30)
* org-agenda-text-search-extra-files <1>: Search view. (line 34)
2019-11-26 16:46:24 +01:00
* org-agenda-time-grid: Time-of-day specifications.
(line 46)
* org-agenda-time-grid <1>: Agenda Commands. (line 181)
* org-agenda-todo-ignore-deadlines: Global TODO list. (line 42)
* org-agenda-todo-ignore-scheduled: Global TODO list. (line 42)
* org-agenda-todo-ignore-timestamp: Global TODO list. (line 42)
* org-agenda-todo-ignore-with-date: Global TODO list. (line 42)
* org-agenda-todo-list-sublevels: Breaking Down Tasks. (line 6)
2019-12-06 19:15:46 +01:00
* org-agenda-todo-list-sublevels <1>: Global TODO list. (line 53)
2019-11-26 16:46:24 +01:00
* org-agenda-use-tag-inheritance: Tag Inheritance. (line 32)
* org-agenda-use-tag-inheritance <1>: Speeding Up Your Agendas.
(line 23)
* org-agenda-use-time-grid: Time-of-day specifications.
(line 46)
* org-agenda-use-time-grid <1>: Agenda Commands. (line 181)
* org-agenda-window-setup: Agenda Views. (line 42)
* org-alphabetical-lists: Plain Lists. (line 15)
* org-archive-default-command: Archiving. (line 12)
2019-12-06 19:15:46 +01:00
* org-archive-default-command <1>: Agenda Commands. (line 252)
2019-11-26 16:46:24 +01:00
* org-archive-location: Moving subtrees. (line 10)
* org-archive-location <1>: In-buffer Settings. (line 15)
* org-archive-save-context-info: Moving subtrees. (line 41)
* 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)
2019-12-06 19:15:46 +01:00
* org-attach-archive-delete: Attachment options. (line 60)
* org-attach-auto-tag: Attachment options. (line 64)
* org-attach-dir-relative: Attachment options. (line 13)
* org-attach-expert: Attachment options. (line 77)
* org-attach-id-dir: Attachment options. (line 9)
* org-attach-id-to-path-function-list: Attachment options. (line 68)
* org-attach-method: Attachment defaults and dispatcher.
(line 24)
* org-attach-method <1>: Attachment options. (line 49)
* org-attach-preferred-new-method: Attachment options. (line 55)
* org-attach-use-inheritance: Attachment options. (line 18)
2019-11-26 16:46:24 +01:00
* org-babel-default-header-args: Using Header Arguments.
(line 19)
* org-babel-default-header-args <1>: Using Header Arguments.
(line 19)
* org-babel-inline-result-wrap: Evaluating Code Blocks.
(line 27)
2019-12-06 19:15:46 +01:00
* org-babel-load-languages: Languages. (line 36)
2019-11-26 16:46:24 +01:00
* org-babel-post-tangle-hook: Extracting Source Code.
(line 122)
* org-beamer-environments-default: Frames and Blocks in Beamer.
(line 25)
* org-beamer-environments-extra: Frames and Blocks in Beamer.
(line 25)
* org-beamer-frame-level: Frames and Blocks in Beamer.
(line 10)
* org-beamer-theme: Beamer specific export settings.
(line 11)
* org-calc-default-modes: Formula syntax for Calc.
(line 17)
* org-capture-bookmark: Using capture. (line 48)
* org-capture-last-stored: Using capture. (line 48)
* org-capture-templates: Capture templates. (line 11)
* org-capture-templates-contexts: Templates in contexts.
(line 6)
2020-02-05 19:59:48 +01:00
* org-capture-use-agenda-date: Agenda Commands. (line 342)
2019-11-26 16:46:24 +01:00
* org-catch-invisible-edits: Catching invisible edits.
(line 6)
* org-clock-continuously: Clocking commands. (line 7)
2019-12-06 19:15:46 +01:00
* org-clock-continuously <1>: Clocking commands. (line 44)
2019-11-26 16:46:24 +01:00
* org-clock-continuously <2>: Resolving idle time. (line 78)
2019-12-06 19:15:46 +01:00
* org-clock-display-default-range: The clock table. (line 77)
2019-11-26 16:46:24 +01:00
* org-clock-idle-time: Resolving idle time. (line 14)
2019-12-06 19:15:46 +01:00
* org-clock-in-prepare-hook: Clocking commands. (line 21)
2019-11-26 16:46:24 +01:00
* org-clock-into-drawer: Clocking commands. (line 7)
2019-12-06 19:15:46 +01:00
* org-clock-mode-line-total: Clocking commands. (line 21)
2019-11-26 16:46:24 +01:00
* org-clock-persist: Clocking Work Time. (line 19)
* org-clock-report-include-clocking-task: Agenda Commands. (line 154)
* org-clock-x11idle-program-name: Resolving idle time. (line 14)
2019-12-06 19:15:46 +01:00
* org-clocktable-defaults: The clock table. (line 36)
2019-11-26 16:46:24 +01:00
* org-closed-keep-when-no-todo: Closing items. (line 11)
2019-12-06 19:15:46 +01:00
* org-coderef-label-format: Literal Examples. (line 88)
2019-11-26 16:46:24 +01:00
* org-columns: Using column view. (line 10)
* org-columns-default-format: Using column view. (line 10)
* org-columns-default-format <1>: Effort Estimates. (line 31)
* org-columns-default-format <2>: Agenda Commands. (line 197)
* org-columns-default-format <3>: Agenda Column View. (line 19)
2019-12-06 19:15:46 +01:00
* org-columns-default-format-for-agenda: Agenda Column View. (line 19)
2019-11-26 16:46:24 +01:00
* org-columns-skip-archived-trees: Internal archiving. (line 33)
* org-columns-summary-types: Column attributes. (line 51)
* org-complete-tags-always-offer-all-agenda-tags: Setting Tags.
(line 22)
* org-confirm-babel-evaluate: Code Evaluation Security.
(line 25)
* org-create-file-search-functions: Custom Searches. (line 12)
* org-crypt-tag-matcher: Org Crypt. (line 10)
* 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 30)
* org-cycle-include-plain-lists: Plain Lists. (line 70)
* org-cycle-open-archived-trees: Internal archiving. (line 13)
2019-12-06 19:15:46 +01:00
* org-cycle-separator-lines: Headlines. (line 28)
2019-11-26 16:46:24 +01:00
* org-deadline-warning-days: Deadlines and Scheduling.
(line 14)
* org-deadline-warning-days <1>: Inserting deadline/schedule.
(line 26)
* org-default-notes-file: Setting up capture. (line 8)
* org-default-notes-file <1>: Template elements. (line 50)
* org-default-priority: Priorities. (line 38)
* org-default-priority <1>: In-buffer Settings. (line 43)
* org-directory: Template elements. (line 50)
* org-display-custom-times: Custom time format. (line 6)
* org-disputed-keys: Conflicts. (line 27)
* org-done, face: Faces for TODO keywords.
(line 6)
* org-edit-src-auto-save-idle-delay: Editing Source Code. (line 11)
* org-effort-property: Effort Estimates. (line 6)
* org-enforce-todo-dependencies: TODO dependencies. (line 6)
* org-enforce-todo-dependencies <1>: TODO dependencies. (line 53)
* 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 42)
* org-export-backends: Exporting. (line 33)
* org-export-before-parsing-hook: Advanced Export Configuration.
(line 9)
* org-export-before-processing-hook: Advanced Export Configuration.
(line 9)
* org-export-creator-string: 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 10)
* 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-html-table-tag: Tables in HTML export.
(line 6)
* org-export-html-tag-class-prefix: CSS support. (line 6)
* org-export-html-todo-kwd-class-prefix: CSS support. (line 6)
* org-export-html-use-infojs: JavaScript support. (line 71)
* org-export-in-background: The Export Dispatcher.
(line 39)
* org-export-initial-scope: The Export Dispatcher.
(line 60)
* org-export-odt-convert-capabilities: Advanced topics in ODT export.
(line 22)
* org-export-odt-convert-process: Advanced topics in ODT export.
(line 28)
* org-export-odt-convert-processes: Advanced topics in ODT export.
(line 17)
* org-export-odt-preferred-output-format: ODT export commands.
(line 25)
* org-export-odt-schema-dir: Advanced topics in ODT export.
(line 269)
* org-export-preserve-breaks: Export Settings. (line 93)
* org-export-select-tags: Export Settings. (line 44)
* org-export-time-stamp-file: Export Settings. (line 187)
* org-export-time-stamp-file <1>: HTML preamble and postamble.
(line 6)
* org-export-use-babel: Exporting Code Blocks.
(line 34)
* org-export-with-archived-trees: Internal archiving. (line 29)
* 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: Export Settings. (line 123)
* org-export-with-email: Export Settings. (line 134)
* org-export-with-emphasize: Export Settings. (line 79)
* 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 38)
* org-export-with-latex <1>: Export Settings. (line 183)
* org-export-with-planning: Export Settings. (line 157)
* org-export-with-priority: Export Settings. (line 163)
* org-export-with-properties: Export Settings. (line 166)
* 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 170)
* org-export-with-sub-superscripts: Export Settings. (line 97)
* org-export-with-tables: Export Settings. (line 202)
* org-export-with-tags: Export Settings. (line 174)
* org-export-with-tasks: Export Settings. (line 178)
* org-export-with-timestamps: Export Settings. (line 89)
* org-export-with-title: Export Settings. (line 191)
* org-export-with-toc: Export Settings. (line 194)
* org-export-with-toc <1>: Table of Contents. (line 6)
* org-export-with-todo-keywords: Export Settings. (line 198)
* org-expot-creator-string: Export Settings. (line 28)
* org-faces-easy-properties: Faces for TODO keywords.
(line 17)
* org-fast-tag-selection-include-todo: Fast access to TODO states.
(line 16)
* org-fast-tag-selection-single-key: Setting Tags. (line 141)
* org-file-apps: Handling Links. (line 106)
2019-12-06 19:15:46 +01:00
* org-file-apps <1>: Attachment defaults and dispatcher.
(line 45)
2019-11-26 16:46:24 +01:00
* org-fontify-emphasized-text: Emphasis and Monospace.
(line 11)
2019-12-06 19:15:46 +01:00
* org-footnote-auto-adjust: Creating Footnotes. (line 60)
* org-footnote-auto-adjust <1>: In-buffer Settings. (line 147)
* org-footnote-auto-label: Creating Footnotes. (line 32)
* org-footnote-auto-label <1>: In-buffer Settings. (line 147)
* org-footnote-define-inline: Creating Footnotes. (line 45)
* org-footnote-define-inline <1>: In-buffer Settings. (line 147)
2019-11-26 16:46:24 +01:00
* org-footnote-section: Headlines. (line 17)
2019-12-06 19:15:46 +01:00
* org-footnote-section <1>: Creating Footnotes. (line 45)
2019-11-26 16:46:24 +01:00
* 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-global-properties: Property Syntax. (line 76)
* org-global-properties <1>: Effort Estimates. (line 31)
* org-goto-auto-isearch: Motion. (line 24)
* org-goto-interface: Motion. (line 41)
* org-group-tags: Tag Hierarchy. (line 86)
* org-habit-following-days: Tracking your habits.
(line 91)
* org-habit-graph-column: Tracking your habits.
(line 82)
* org-habit-preceding-days: Tracking your habits.
(line 87)
* org-habit-show-habits-only-for-today: Tracking your habits.
(line 94)
2019-12-06 19:15:46 +01:00
* org-hide, face: Hard indentation. (line 21)
2019-11-26 16:46:24 +01:00
* org-hide-block-startup: Blocks. (line 6)
2019-12-06 19:15:46 +01:00
* org-hide-block-startup <1>: In-buffer Settings. (line 160)
* org-hide-leading-stars: Hard indentation. (line 21)
* org-hide-leading-stars <1>: In-buffer Settings. (line 123)
2019-11-26 16:46:24 +01:00
* org-hide-macro-markers: Macro Replacement. (line 88)
2019-12-06 19:15:46 +01:00
* org-hierarchical-checkbox-statistics: Checkboxes. (line 29)
2019-11-26 16:46:24 +01:00
* org-hierarchical-todo-statistics: Breaking Down Tasks. (line 25)
* org-highest-priority: Priorities. (line 38)
* org-highest-priority <1>: In-buffer Settings. (line 43)
* 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 44)
* org-html-head-extra: HTML specific export settings.
(line 39)
* org-html-head-extra <1>: CSS support. (line 44)
* org-html-head-include-default-style: CSS support. (line 52)
* org-html-html5-elements: HTML doctypes. (line 60)
* org-html-html5-fancy: HTML doctypes. (line 25)
* org-html-inline-images: Images in HTML export.
(line 9)
* org-html-link-home: HTML specific export settings.
(line 23)
* org-html-link-org-files-as-html: Links in HTML export.
(line 12)
* org-html-link-up: HTML specific export settings.
(line 26)
* org-html-mathjax-options: HTML specific export settings.
(line 30)
* org-html-mathjax-options~: Math formatting in HTML export.
(line 6)
* org-html-mathjax-template: Math formatting in HTML export.
(line 20)
* 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)
2019-12-06 19:15:46 +01:00
* org-html-self-link-headlines: Headlines in HTML export.
(line 10)
2019-11-26 16:46:24 +01:00
* org-html-style-default: CSS support. (line 44)
* org-html-table-align-individual-fields: Tables in HTML export.
(line 20)
* org-html-table-caption-above: Tables in HTML export.
(line 24)
* org-html-table-data-tags: Tables in HTML export.
(line 27)
* org-html-table-default-attributes: Tables in HTML export.
(line 30)
* org-html-table-header-tags: Tables in HTML export.
(line 33)
* org-html-table-row-tags: Tables in HTML export.
(line 36)
* org-html-table-use-header-tags-for-first-column: Tables in HTML export.
(line 39)
* org-html-validation-link: HTML preamble and postamble.
(line 6)
* org-icalendar-alarm-time: iCalendar Export. (line 20)
* org-icalendar-categories: iCalendar Export. (line 20)
* org-icalendar-combined-agenda-file: iCalendar Export. (line 47)
* org-icalendar-include-body: iCalendar Export. (line 57)
* org-icalendar-include-todo: iCalendar Export. (line 11)
* org-icalendar-store-UID: iCalendar Export. (line 26)
* org-icalendar-use-deadline: iCalendar Export. (line 11)
* org-icalendar-use-scheduled: iCalendar Export. (line 11)
* org-id-link-to-org-use-id: Handling Links. (line 21)
* org-imenu-depth: Cooperation. (line 37)
2019-12-06 19:15:46 +01:00
* org-indent-indentation-per-level: Org Indent Mode. (line 11)
2020-01-29 18:18:31 +01:00
* org-indent-mode-turns-off-org-adapt-indentation: Org Indent Mode.
(line 15)
* org-indent-mode-turns-on-hiding-stars: Org Indent Mode. (line 15)
2019-11-26 16:46:24 +01:00
* org-infojs-options: JavaScript support. (line 71)
* org-insert-mode-line-in-empty-file: Activation. (line 30)
* org-irc-links-to-logs: Handling Links. (line 45)
* org-latex-bibtex-compiler: LaTeX/PDF export commands.
(line 25)
* org-latex-classes: LaTeX specific export settings.
(line 32)
* org-latex-classes <1>: LaTeX specific export settings.
(line 49)
* org-latex-classes <2>: LaTeX header and sectioning.
(line 13)
* org-latex-compiler: LaTeX/PDF export commands.
(line 25)
* org-latex-compiler <1>: LaTeX specific export settings.
(line 44)
* org-latex-default-class: LaTeX specific export settings.
(line 32)
* org-latex-default-class <1>: LaTeX header and sectioning.
(line 13)
* org-latex-default-packages-alist: LaTeX/PDF export commands.
(line 25)
* org-latex-default-packages-alist <1>: LaTeX header and sectioning.
(line 13)
* org-latex-default-table-environment: Tables in LaTeX export.
(line 23)
* org-latex-default-table-mode: Tables in LaTeX export.
(line 12)
* org-latex-hyperref-template: LaTeX specific export settings.
(line 11)
* org-latex-hyperref-template <1>: LaTeX specific export settings.
(line 54)
* org-latex-images-centered: Images in LaTeX export.
2019-12-06 19:15:46 +01:00
(line 60)
* org-latex-listings: Literal Examples. (line 31)
2019-11-26 16:46:24 +01:00
* org-latex-listings-options: Source blocks in LaTeX export.
(line 25)
* org-latex-minted-options: Source blocks in LaTeX export.
(line 25)
2019-12-06 19:15:46 +01:00
* org-latex-packages-alist: LaTeX specific export settings.
2019-11-26 16:46:24 +01:00
(line 20)
2019-12-06 19:15:46 +01:00
* org-latex-packages-alist <1>: LaTeX header and sectioning.
2019-11-26 16:46:24 +01:00
(line 13)
* org-latex-subtitle-format: LaTeX specific export settings.
(line 63)
* org-latex-subtitle-separate: LaTeX specific export settings.
(line 63)
* org-latex-tables-booktabs: Tables in LaTeX export.
(line 65)
* org-latex-tables-centered: Tables in LaTeX export.
(line 65)
* org-latex-title-command: LaTeX specific export settings.
(line 11)
* org-latex-title-command <1>: LaTeX specific export settings.
(line 54)
* org-latex-to-mathml-convert-command: LaTeX math snippets. (line 20)
* org-latex-to-mathml-jar-file: LaTeX math snippets. (line 20)
* org-link-abbrev-alist: Link Abbreviations. (line 12)
* org-link-abbrev-alist <1>: In-buffer Settings. (line 38)
2019-12-06 19:15:46 +01:00
* org-link-elisp-confirm-function: Code Evaluation Security.
(line 52)
* org-link-email-description-format: Handling Links. (line 31)
2019-11-26 16:46:24 +01:00
* org-link-frame-setup: Handling Links. (line 121)
2019-12-06 19:15:46 +01:00
* org-link-from-user-regexp: Template expansion. (line 104)
* org-link-keep-stored-after-insertion: Handling Links. (line 69)
2019-11-26 16:46:24 +01:00
* org-link-parameters: Adding Hyperlink Types.
(line 69)
2019-12-29 11:23:16 +01:00
* org-link-search-must-match-exact-headline: Internal Links. (line 31)
2019-12-06 19:15:46 +01:00
* org-link-shell-confirm-function: Code Evaluation Security.
(line 49)
* org-link-use-indirect-buffer-for-internals: Handling Links. (line 135)
2019-11-26 16:46:24 +01:00
* org-list-automatic-rules: Plain Lists. (line 63)
* org-list-automatic-rules <1>: Checkboxes. (line 6)
* org-list-demote-modify-bullet: Plain Lists. (line 57)
* org-list-indent-offset: Plain Lists. (line 57)
* org-list-use-circular-motion: Plain Lists. (line 95)
* org-log-done: Tracking TODO state changes.
2019-12-06 19:15:46 +01:00
(line 28)
2019-11-26 16:46:24 +01:00
* org-log-done <1>: Agenda Commands. (line 131)
2019-12-06 19:15:46 +01:00
* org-log-done <2>: In-buffer Settings. (line 101)
2019-11-26 16:46:24 +01:00
* org-log-into-drawer: Tracking TODO state changes.
(line 6)
2020-02-05 19:59:48 +01:00
* org-log-into-drawer <1>: Agenda Commands. (line 292)
2019-12-06 19:15:46 +01:00
* org-log-note-clock-out: Clocking commands. (line 36)
* org-log-note-clock-out <1>: In-buffer Settings. (line 101)
2019-11-26 16:46:24 +01:00
* org-log-redeadline: Inserting deadline/schedule.
(line 10)
2019-12-06 19:15:46 +01:00
* org-log-refile: Refile and Copy. (line 13)
2019-11-26 16:46:24 +01:00
* org-log-repeat: Repeated tasks. (line 40)
2019-12-06 19:15:46 +01:00
* org-log-repeat <1>: In-buffer Settings. (line 101)
2019-11-26 16:46:24 +01:00
* org-log-reschedule: Inserting deadline/schedule.
(line 18)
* org-log-states-order-reversed: Tracking TODO state changes.
(line 6)
* org-lowest-priority: Priorities. (line 38)
* org-lowest-priority <1>: In-buffer Settings. (line 43)
* org-M-RET-may-split-line: Structure Editing. (line 7)
* org-M-RET-may-split-line <1>: Plain Lists. (line 83)
* org-md-headline-style: Markdown Export. (line 29)
* 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)
2019-12-06 19:15:46 +01:00
* org-num-face: Dynamic Headline Numbering.
(line 19)
* org-num-format-function: Dynamic Headline Numbering.
(line 19)
* org-num-max-level: Dynamic Headline Numbering.
(line 10)
* org-num-skip-commented: Dynamic Headline Numbering.
(line 10)
* org-num-skip-footnotes: Dynamic Headline Numbering.
(line 16)
* org-num-skip-tags: Dynamic Headline Numbering.
(line 10)
* org-num-skip-unnumbered: Dynamic Headline Numbering.
(line 10)
2019-11-26 16:46:24 +01:00
* org-odd-levels-only: Matching tags and properties.
(line 64)
2019-12-06 19:15:46 +01:00
* org-odd-levels-only <1>: Hard indentation. (line 29)
* org-odd-levels-only <2>: In-buffer Settings. (line 123)
2019-11-26 16:46:24 +01:00
* 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-process: Extending ODT export.
(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 9)
* org-odt-preferred-output-format <1>: Extending ODT export.
(line 21)
* org-odt-styles-file: ODT specific export settings.
(line 22)
* org-odt-styles-file <1>: Applying custom styles.
(line 25)
* org-odt-table-styles: Advanced topics in ODT export.
(line 158)
* org-odt-table-styles <1>: Advanced topics in ODT export.
(line 226)
2019-12-06 19:15:46 +01:00
* org-outline-path-complete-in-steps: Refile and Copy. (line 13)
2019-11-26 16:46:24 +01:00
* org-plain-list-ordered-item-terminator: Plain Lists. (line 15)
* org-plain-list-ordered-item-terminator <1>: Plain Lists. (line 131)
* org-popup-calendar-for-date-prompt: The date/time prompt.
(line 75)
2019-12-06 19:15:46 +01:00
* org-pretty-entities: In-buffer Settings. (line 166)
2019-11-26 16:46:24 +01:00
* org-preview-latex-default-process: Previewing LaTeX fragments.
(line 6)
* org-priority-faces: Priorities. (line 13)
* org-priority-start-cycle-with-default: Priorities. (line 33)
* org-property-allowed-value-functions: Using the Property API.
(line 63)
2019-12-06 19:15:46 +01:00
* org-protocol-default-template-key: The capture protocol.
(line 19)
* org-protocol-project-alist: The open-source protocol.
2019-11-26 16:46:24 +01:00
(line 13)
* org-publish-project-alist: Project alist. (line 6)
* org-publish-project-alist <1>: Publishing options. (line 12)
* org-publish-use-timestamps-flag: Triggering Publication.
(line 21)
2019-12-06 19:15:46 +01:00
* org-put-time-stamp-overlays: In-buffer Settings. (line 135)
2019-11-26 16:46:24 +01:00
* org-read-date-display-live: The date/time prompt.
(line 94)
* org-read-date-force-compatible-dates: The date/time prompt.
(line 60)
* org-read-date-prefer-future: The date/time prompt.
(line 6)
2019-12-06 19:15:46 +01:00
* org-refile-allow-creating-parent-nodes: Refile and Copy. (line 13)
* org-refile-keep: Refile and Copy. (line 41)
* org-refile-targets: Refile and Copy. (line 13)
* org-refile-use-cache: Refile and Copy. (line 46)
* org-refile-use-outline-path: Refile and Copy. (line 13)
2019-11-26 16:46:24 +01:00
* org-remove-highlights-with-change: Sparse Trees. (line 20)
2019-12-06 19:15:46 +01:00
* org-remove-highlights-with-change <1>: Clocking commands. (line 84)
2019-11-26 16:46:24 +01:00
* org-replace-disputed-keys: Conflicts. (line 17)
* org-return-follows-link: Handling Links. (line 127)
2019-12-06 19:15:46 +01:00
* org-reverse-note-order: Refile and Copy. (line 13)
2019-11-26 16:46:24 +01:00
* org-scheduled-delay-days: Deadlines and Scheduling.
(line 42)
* org-show-context-detail: Sparse Trees. (line 6)
2019-12-06 19:15:46 +01:00
* org-sort-agenda-noeffort-is-high: Filtering/limiting agenda items.
(line 56)
2019-11-26 16:46:24 +01:00
* org-sparse-tree-open-archived-trees: Internal archiving. (line 19)
* org-special-ctrl-a/e: Headlines. (line 6)
* org-special-ctrl-k: Headlines. (line 6)
* org-speed-commands-user: Speed Keys. (line 18)
* org-src-ask-before-returning-to-edit-buffer: Editing Source Code.
(line 40)
* org-src-block-faces: Editing Source Code. (line 43)
* org-src-fontify-natively: Editing Source Code. (line 43)
* org-src-lang-modes: Editing Source Code. (line 22)
* org-src-preserve-indentation: Editing Source Code. (line 32)
* org-src-window-setup: Editing Source Code. (line 28)
* org-startup-align-all-tables: Column Width and Alignment.
(line 19)
2019-12-06 19:15:46 +01:00
* org-startup-align-all-tables <1>: In-buffer Settings. (line 83)
2019-11-26 16:46:24 +01:00
* org-startup-folded: Initial visibility. (line 6)
* org-startup-folded <1>: In-buffer Settings. (line 67)
* org-startup-folded <2>: Speeding Up Your Agendas.
(line 19)
2020-01-29 18:18:31 +01:00
* org-startup-indented: Org Indent Mode. (line 22)
2019-12-06 19:15:46 +01:00
* org-startup-indented <1>: In-buffer Settings. (line 77)
2019-11-26 16:46:24 +01:00
* org-startup-shrink-all-tables: Column Width and Alignment.
(line 64)
2019-12-06 19:15:46 +01:00
* org-startup-shrink-all-tables <1>: In-buffer Settings. (line 90)
2019-11-26 16:46:24 +01:00
* org-startup-with-inline-images: Images. (line 24)
2019-12-06 19:15:46 +01:00
* org-startup-with-inline-images <1>: In-buffer Settings. (line 94)
2019-11-26 16:46:24 +01:00
* org-startup-with-latex-preview: Previewing LaTeX fragments.
2019-12-06 19:15:46 +01:00
(line 28)
2019-11-26 16:46:24 +01:00
* org-store-link-props: Template expansion. (line 102)
* org-structure-template-alist: Structure Templates. (line 17)
* org-stuck-projects: Stuck projects. (line 17)
* org-support-shift-select: Plain Lists. (line 95)
* org-support-shift-select <1>: Plain Lists. (line 154)
* org-support-shift-select <2>: Conflicts. (line 6)
* org-table-automatic-realign: Column Width and Alignment.
(line 10)
* org-table-copy-increment: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 185)
2019-11-26 16:46:24 +01:00
* org-table-current-column: References. (line 89)
* org-table-current-dline: References. (line 89)
* org-table-duration-custom-format: Durations and time values.
(line 6)
* org-table-export-default-format: Built-in Table Editor.
2019-12-06 19:15:46 +01:00
(line 225)
2019-11-26 16:46:24 +01:00
* org-table-formula: In-buffer Settings. (line 28)
* org-table-formula-constants: References. (line 113)
* org-table-formula-constants <1>: In-buffer Settings. (line 28)
* org-table-formula-constants <2>: Cooperation. (line 14)
* org-table-use-standard-references: Editing and debugging formulas.
(line 6)
* org-tag-alist: Setting Tags. (line 22)
2019-12-06 19:15:46 +01:00
* org-tag-alist <1>: In-buffer Settings. (line 173)
2019-11-26 16:46:24 +01:00
* 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 19)
* org-tags-match-list-sublevels <2>: Property Searches. (line 18)
* org-tags-match-list-sublevels <3>: Matching tags and properties.
(line 21)
* org-tempo-keywords-alist: Structure Templates. (line 21)
* org-texinfo-classes: Texinfo file header. (line 19)
* 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 11)
* org-texinfo-table-default-markup: Plain lists in Texinfo export.
(line 12)
* org-time-stamp-custom-formats: Custom time format. (line 6)
2019-12-06 19:15:46 +01:00
* org-time-stamp-overlay-formats: In-buffer Settings. (line 135)
2019-11-26 16:46:24 +01:00
* org-time-stamp-rounding-minutes: Creating Timestamps. (line 16)
* org-timer-default-timer: Timers. (line 23)
* org-todo, face: Faces for TODO keywords.
(line 6)
* org-todo-keyword-faces: Faces for TODO keywords.
(line 6)
2019-12-06 19:15:46 +01:00
* org-todo-keywords: TODO Basics. (line 35)
2019-11-26 16:46:24 +01:00
* org-todo-keywords <1>: TODO Extensions. (line 6)
* org-todo-keywords <2>: Global TODO list. (line 18)
2019-12-06 19:15:46 +01:00
* org-todo-keywords <3>: In-buffer Settings. (line 180)
2019-11-26 16:46:24 +01:00
* org-todo-repeat-to-state: Repeated tasks. (line 22)
2019-12-06 19:15:46 +01:00
* org-todo-state-tags-triggers: TODO Basics. (line 56)
2019-11-26 16:46:24 +01:00
* org-track-ordered-property-with-tag: TODO dependencies. (line 38)
2019-12-06 19:15:46 +01:00
* org-track-ordered-property-with-tag <1>: Checkboxes. (line 79)
2019-11-26 16:46:24 +01:00
* org-treat-insert-todo-heading-as-state-change: Structure Editing.
(line 29)
* org-treat-S-cursor-todo-selection-as-state-change: TODO Basics.
2019-12-06 19:15:46 +01:00
(line 28)
2019-11-26 16:46:24 +01:00
* org-use-property-inheritance: Property Inheritance.
(line 6)
* org-use-property-inheritance <1>: Using Header Arguments.
(line 56)
* org-use-property-inheritance <2>: Using the Property API.
(line 19)
* org-use-speed-commands: Speed Keys. (line 13)
* org-use-sub-superscripts: Subscripts and Superscripts.
(line 13)
* org-use-tag-inheritance: Tag Inheritance. (line 22)
* org-yank-adjusted-subtrees: Structure Editing. (line 79)
* org-yank-folded-subtrees: Structure Editing. (line 79)
* parse-time-months: The date/time prompt.
(line 56)
* parse-time-weekdays: The date/time prompt.
(line 56)
* user-full-name: Export Settings. (line 25)
* user-mail-address: Export Settings. (line 35)
Tag Table:
2020-02-14 23:09:34 +01:00
Node: Top
Node: Introduction
Node: Summary
Node: Installation
Ref: Using Emacs packaging system
Ref: Downloading Org as an archive
Ref: Using Org's git repository
Node: Activation
Ref: Activation-Footnote-1
Node: Feedback
Ref: How to create a useful backtrace
Ref: Feedback-Footnote-1
Node: Conventions
Ref: TODO keywords tags properties etc
Ref: Key bindings and commands
Node: Document Structure
Node: Headlines
Ref: Headlines-Footnote-1
Node: Visibility Cycling
Node: Global and local cycling
Ref: Global and local cycling-Footnote-1
Ref: Global and local cycling-Footnote-2
Node: Initial visibility
Ref: Initial visibility-Footnote-1
Node: Catching invisible edits
Node: Motion
Node: Structure Editing
Node: Sparse Trees
Ref: Sparse Trees-Footnote-1
Ref: Sparse Trees-Footnote-2
Node: Plain Lists
Ref: Plain Lists-Footnote-1
Ref: Plain Lists-Footnote-2
Ref: Plain Lists-Footnote-3
Ref: Plain Lists-Footnote-4
Ref: Plain Lists-Footnote-5
Ref: Plain Lists-Footnote-6
Ref: Plain Lists-Footnote-7
Node: Drawers
Ref: Drawers-Footnote-1
Node: Blocks
Node: Tables
Node: Built-in Table Editor
Ref: Creation and conversion
Ref: Re-aligning and field motion
Ref: Column and row editing
Ref: Regions
Ref: Calculations
Ref: Miscellaneous (1)
Ref: Built-in Table Editor-Footnote-1
Node: Column Width and Alignment
Node: Column Groups
Node: Orgtbl Mode
Node: The Spreadsheet
Node: References
Ref: Field references
Ref: Range references
Ref: Field coordinates in formulas
Ref: Named references
Ref: Remote references
Ref: References-Footnote-1
Ref: References-Footnote-2
Ref: References-Footnote-3
Node: Formula syntax for Calc
Ref: Formula syntax for Calc-Footnote-1
Node: Formula syntax for Lisp
Node: Durations and time values
Node: Field and range formulas
Node: Column formulas
Node: Lookup functions
Node: Editing and debugging formulas
Ref: Using multiple TBLFM lines
Ref: Debugging formulas
Node: Updating the table
Node: Advanced features
Ref: Advanced features-Footnote-1
Node: Org Plot
Ref: Graphical plots using Gnuplot
Ref: Plot options
Ref: ASCII bar plots
Node: Hyperlinks
Node: Link Format
Ref: Link Format-Footnote-1
Ref: Link Format-Footnote-2
Node: Internal Links
Ref: Internal Links-Footnote-1
Ref: Internal Links-Footnote-2
Node: Radio Targets
Node: External Links
Ref: External Links-Footnote-1
Node: Handling Links
Ref: Handling Links-Footnote-1
Ref: Handling Links-Footnote-2
Ref: Handling Links-Footnote-3
Ref: Handling Links-Footnote-4
Ref: Handling Links-Footnote-5
Ref: Handling Links-Footnote-6
Node: Using Links Outside Org
Node: Link Abbreviations
Node: Search Options
Ref: Search Options-Footnote-1
Node: Custom Searches
Node: TODO Items
Ref: TODO Items-Footnote-1
Node: TODO Basics
Node: TODO Extensions
Node: Workflow states
Ref: Workflow states-Footnote-1
Node: TODO types
Ref: TODO types-Footnote-1
Node: Multiple sets in one file
Node: Fast access to TODO states
Ref: Fast access to TODO states-Footnote-1
Ref: Fast access to TODO states-Footnote-2
Node: Per-file keywords
Ref: Per-file keywords-Footnote-1
Node: Faces for TODO keywords
Node: TODO dependencies
Node: Progress Logging
Node: Closing items
Ref: Closing items-Footnote-1
Ref: Closing items-Footnote-2
Node: Tracking TODO state changes
Ref: Tracking TODO state changes-Footnote-1
Ref: Tracking TODO state changes-Footnote-2
Ref: Tracking TODO state changes-Footnote-3
Node: Tracking your habits
Node: Priorities
Ref: Priorities-Footnote-1
Node: Breaking Down Tasks
Ref: Breaking Down Tasks-Footnote-1
Node: Checkboxes
Ref: Checkboxes-Footnote-1
Ref: Checkboxes-Footnote-2
Ref: Checkboxes-Footnote-3
Node: Tags
Node: Tag Inheritance
Ref: Tag Inheritance-Footnote-1
Ref: Tag Inheritance-Footnote-2
Node: Setting Tags
Ref: Setting Tags-Footnote-1
Ref: Setting Tags-Footnote-2
Node: Tag Hierarchy
Node: Tag Searches
Node: Properties and Columns
Node: Property Syntax
Node: Special Properties
Node: Property Searches
Node: Property Inheritance
Node: Column View
Node: Defining columns
Node: Scope of column definitions
Node: Column attributes
Ref: Column attributes-Footnote-1
Ref: Column attributes-Footnote-2
Ref: Column attributes-Footnote-3
Node: Using column view
Ref: Turning column view on or off
Ref: Editing values
Ref: Modifying column view on-the-fly
Node: Capturing column view
Ref: Capturing column view-Footnote-1
Node: Dates and Times
Node: Timestamps
Ref: Timestamps-Footnote-1
Ref: Timestamps-Footnote-2
Node: Creating Timestamps
Node: The date/time prompt
Ref: The date/time prompt-Footnote-1
Ref: The date/time prompt-Footnote-2
Ref: The date/time prompt-Footnote-3
Node: Custom time format
Node: Deadlines and Scheduling
Ref: Deadlines and Scheduling-Footnote-1
Node: Inserting deadline/schedule
Ref: Inserting deadline/schedule-Footnote-1
Ref: Inserting deadline/schedule-Footnote-2
Ref: Inserting deadline/schedule-Footnote-3
Node: Repeated tasks
Ref: Repeated tasks-Footnote-1
Ref: Repeated tasks-Footnote-2
Ref: Repeated tasks-Footnote-3
Node: Clocking Work Time
Ref: Clocking Work Time-Footnote-1
Ref: Clocking Work Time-Footnote-2
Node: Clocking commands
Ref: Clocking commands-Footnote-1
Ref: Clocking commands-Footnote-2
Ref: Clocking commands-Footnote-3
Ref: Clocking commands-Footnote-4
Node: The clock table
Ref: The clock table-Footnote-1
Ref: The clock table-Footnote-2
Ref: The clock table-Footnote-3
Node: Resolving idle time
Ref: Resolving idle time (1)
Ref: Continuous clocking
Ref: Resolving idle time-Footnote-1
Node: Effort Estimates
Ref: Effort Estimates-Footnote-1
Node: Timers
Node: Refiling and Archiving
Node: Refile and Copy
Ref: Refile and Copy-Footnote-1
Node: Archiving
Node: Moving subtrees
Node: Internal archiving
Node: Capture and Attachments
Node: Capture
Node: Setting up capture
Node: Using capture
Node: Capture templates
Node: Template elements
Ref: Template elements-Footnote-1
Ref: Template elements-Footnote-2
Ref: Template elements-Footnote-3
Node: Template expansion
Ref: Template expansion-Footnote-1
Ref: Template expansion-Footnote-2
Ref: Template expansion-Footnote-3
Node: Templates in contexts
Node: Attachments
Node: Attachment defaults and dispatcher
Ref: Attachment defaults and dispatcher-Footnote-1
Node: Attachment options
Node: Attachment links
Node: Automatic version-control with Git
Node: Attach from Dired
Node: RSS Feeds
Node: Agenda Views
Node: Agenda Files
Ref: Agenda Files-Footnote-1
Ref: Agenda Files-Footnote-2
Node: Agenda Dispatcher
Ref: Agenda Dispatcher-Footnote-1
Ref: Agenda Dispatcher-Footnote-2
Node: Built-in Agenda Views
Node: Weekly/daily agenda
Ref: Calendar/Diary integration
Ref: Anniversaries from BBDB
Ref: Appointment reminders
Ref: Weekly/daily agenda-Footnote-1
Ref: Weekly/daily agenda-Footnote-2
Node: Global TODO list
Node: Matching tags and properties
Node: Search view
Node: Stuck projects
Node: Presentation and Sorting
Node: Categories
Node: Time-of-day specifications
Ref: Time-of-day specifications-Footnote-1
Node: Sorting of agenda items
Node: Filtering/limiting agenda items
Ref: Filtering in the agenda
Ref: Computed tag filtering
Ref: Setting limits for the agenda
Ref: Filtering/limiting agenda items-Footnote-1
Node: Agenda Commands
Ref: Motion (1)
Ref: View/Go to Org file
Ref: Change display
Ref: Remote editing
Ref: Bulk remote editing selected entries
Ref: Calendar commands
Ref: Quit and exit
Ref: Agenda Commands-Footnote-1
Ref: Agenda Commands-Footnote-2
Ref: Agenda Commands-Footnote-3
Node: Custom Agenda Views
Node: Storing searches
Ref: Storing searches-Footnote-1
Ref: Storing searches-Footnote-2
Node: Block agenda
Node: Setting options
Node: Exporting Agenda Views
Ref: Exporting Agenda Views-Footnote-1
Ref: Exporting Agenda Views-Footnote-2
Ref: Exporting Agenda Views-Footnote-3
Ref: Exporting Agenda Views-Footnote-4
Node: Agenda Column View
Node: Markup for Rich Contents
Node: Paragraphs
Node: Emphasis and Monospace
Node: Subscripts and Superscripts
Node: Special Symbols
Ref: Special Symbols-Footnote-1
Ref: Special Symbols-Footnote-2
Node: Embedded LaTeX
Ref: Embedded LaTeX-Footnote-1
Node: LaTeX fragments
Ref: LaTeX fragments-Footnote-1
Node: Previewing LaTeX fragments
Ref: Previewing LaTeX fragments-Footnote-1
Node: CDLaTeX mode
Ref: CDLaTeX mode-Footnote-1
Node: Literal Examples
Ref: Literal Examples-Footnote-1
Ref: Literal Examples-Footnote-2
Ref: Literal Examples-Footnote-3
Ref: Literal Examples-Footnote-4
Node: Images
Ref: Images-Footnote-1
Ref: Images-Footnote-2
Node: Captions
Node: Horizontal Rules
Node: Creating Footnotes
Ref: Creating Footnotes-Footnote-1
Ref: Creating Footnotes-Footnote-2
Node: Exporting
Node: The Export Dispatcher
Node: Export Settings
Ref: Export Settings-Footnote-1
Ref: Export Settings-Footnote-2
Ref: Export Settings-Footnote-3
Node: Table of Contents
Ref: Table of Contents-Footnote-1
Node: Include Files
Ref: Include Files-Footnote-1
Node: Macro Replacement
Ref: Macro Replacement-Footnote-1
Node: Comment Lines
Ref: Comment Lines-Footnote-1
Node: ASCII/Latin-1/UTF-8 export
Ref: ASCII export commands
Ref: ASCII specific export settings
Ref: Header and sectioning structure
Ref: Quoting ASCII text
Ref: ASCII specific attributes
Ref: ASCII special blocks
Node: Beamer Export
Node: Beamer export commands
Node: Beamer specific export settings
Node: Frames and Blocks in Beamer
Ref: Frames and Blocks in Beamer-Footnote-1
Node: Beamer specific syntax
Node: Editing support
Node: A Beamer example
Node: HTML Export
Node: HTML export commands
Node: HTML specific export settings
Node: HTML doctypes
Node: HTML preamble and postamble
Node: Quoting HTML tags
Node: Headlines in HTML export
Node: Links in HTML export
Node: Tables in HTML export
Node: Images in HTML export
Node: Math formatting in HTML export
Ref: Math formatting in HTML export-Footnote-1
Ref: Math formatting in HTML export-Footnote-2
Ref: Math formatting in HTML export-Footnote-3
Node: Text areas in HTML export
Node: CSS support
Ref: CSS support-Footnote-1
Node: JavaScript support
Node: LaTeX Export
Node: LaTeX/PDF export commands
Ref: LaTeX/PDF export commands-Footnote-1
Node: LaTeX specific export settings
Node: LaTeX header and sectioning
Node: Quoting LaTeX code
Node: Tables in LaTeX export
Node: Images in LaTeX export
Node: Plain lists in LaTeX export
Node: Source blocks in LaTeX export
Node: Example blocks in LaTeX export
Node: Special blocks in LaTeX export
Node: Horizontal rules in LaTeX export
Node: Markdown Export
Ref: Markdown export commands
Ref: Header and sectioning structure (1)
Node: OpenDocument Text Export
Ref: OpenDocument Text Export-Footnote-1
Node: Pre-requisites for ODT export
Node: ODT export commands
Node: ODT specific export settings
Node: Extending ODT export
Ref: Automatically exporting to other formats
Ref: Converting between document formats
Node: Applying custom styles
Ref: Applying custom styles the easy way
Ref: Using third-party styles and templates
Node: Links in ODT export
Node: Tables in ODT export
Node: Images in ODT export
Ref: Embedding images
Ref: Embedding clickable images
Ref: Sizing and scaling of embedded images
Ref: Anchoring of images
Node: Math formatting in ODT export
Node: LaTeX math snippets
Ref: LaTeX math snippets-Footnote-1
Ref: LaTeX math snippets-Footnote-2
Node: MathML and OpenDocument formula files
Node: Labels and captions in ODT export
Node: Literal examples in ODT export
Node: Advanced topics in ODT export
Ref: Configuring a document converter
Ref: Working with OpenDocument style files
Ref: x-orgodtstyles-xml
Ref: x-orgodtcontenttemplate-xml
Ref: x-overriding-factory-styles
Ref: Creating one-off styles
Ref: Customizing tables in ODT export
Ref: Validating OpenDocument XML
Ref: Advanced topics in ODT export-Footnote-1
Ref: Advanced topics in ODT export-Footnote-2
Ref: Advanced topics in ODT export-Footnote-3
Node: Org Export
Ref: Org export commands
Node: Texinfo Export
Node: Texinfo export commands
Node: Texinfo specific export settings
Node: Texinfo file header
Node: Texinfo title and copyright page
Node: Info directory file
Node: Headings and sectioning structure
Node: Indices
Node: Quoting Texinfo code
Node: Plain lists in Texinfo export
Node: Tables in Texinfo export
Node: Images in Texinfo export
Node: Quotations in Texinfo export
Node: Special blocks in Texinfo export
Node: A Texinfo example
Node: iCalendar Export
Node: Other Built-in Back-ends
Node: Advanced Export Configuration
Ref: Hooks
Ref: Filters
Ref: Defining filters for individual files
Ref: Extending an existing back-end
Node: Export in Foreign Buffers
Node: Publishing
Node: Configuration
Node: Project alist
Node: Sources and destinations
Node: Selecting files
Node: Publishing action
Ref: Publishing action-Footnote-1
Node: Publishing options
Ref: Generic properties
Ref: ASCII specific properties
Ref: Beamer specific properties
Ref: HTML specific properties
Ref: LaTeX specific properties
Ref: Markdown specific properties
Ref: ODT specific properties
Ref: Texinfo specific properties
Node: Publishing links
Node: Site map
Node: Generating an index
Node: Uploading Files
Node: Sample Configuration
Node: Simple example
Node: Complex example
Node: Triggering Publication
Node: Working with Source Code
Node: Features
Node: Structure of Code Blocks
Node: Using Header Arguments
Ref: System-wide header arguments
Ref: Header arguments in Org mode properties
Ref: Code block specific header arguments
Ref: Header arguments in function calls
Node: Environment of a Code Block
Ref: Passing arguments
Ref: Using sessions
Ref: Choosing a working directory
Ref: Inserting headers and footers
Node: Evaluating Code Blocks
Ref: How to evaluate source code
Ref: Limit code block evaluation
Ref: Cache results of evaluation
Ref: Evaluating Code Blocks-Footnote-1
Ref: Evaluating Code Blocks-Footnote-2
Node: Results of Evaluation
Ref: Collection
Ref: Type
Ref: Format
Ref: Handling
Ref: Post-processing
Node: Exporting Code Blocks
Node: Extracting Source Code
Ref: Header arguments
Ref: Functions
Ref: Hooks (1)
Ref: Jumping between code and Org
Node: Languages
Ref: Languages-Footnote-1
Ref: Languages-Footnote-2
Node: Editing Source Code
Node: Noweb Reference Syntax
Ref: Noweb Reference Syntax-Footnote-1
Node: Library of Babel
Node: Key bindings and Useful Functions
Node: Batch Execution
Node: Miscellaneous
Node: Completion
Node: Structure Templates
Ref: Structure Templates-Footnote-1
Node: Speed Keys
Node: Clean View
Node: Org Indent Mode
Ref: Org Indent Mode-Footnote-1
Node: Hard indentation
Ref: Hard indentation-Footnote-1
Node: Dynamic Headline Numbering
Node: The Very Busy C-c C-c Key
Node: In-buffer Settings
Ref: In-buffer Settings-Footnote-1
Node: Org Syntax
Node: Documentation Access
Node: Escape Character
Node: Code Evaluation Security
Node: Interaction
Node: Cooperation
Node: Conflicts
Node: TTY Keys
Node: Protocols
Node: The store-link protocol
Node: The capture protocol
Node: The open-source protocol
Node: Org Crypt
Node: Org Mobile
Node: Setting up the staging area
Ref: Setting up the staging area-Footnote-1
Ref: Setting up the staging area-Footnote-2
Node: Pushing to the mobile application
Ref: Pushing to the mobile application-Footnote-1
Ref: Pushing to the mobile application-Footnote-2
Ref: Pushing to the mobile application-Footnote-3
Node: Pulling from the mobile application
Ref: Pulling from the mobile application-Footnote-1
Node: Hacking
Node: Hooks (2)
Node: Add-on Packages
Node: Adding Hyperlink Types
Node: Adding Export Back-ends
Node: Tables in Arbitrary Syntax
Node: Radio tables
Node: A LaTeX example
Ref: A LaTeX example-Footnote-1
Ref: A LaTeX example-Footnote-2
Ref: A LaTeX example-Footnote-3
Node: Translator functions
Node: Dynamic Blocks
Node: Special Agenda Views
Ref: Special Agenda Views-Footnote-1
Ref: Special Agenda Views-Footnote-2
Node: Speeding Up Your Agendas
Node: Extracting Agenda Information
Node: Using the Property API
Node: Using the Mapping API
Node: History and Acknowledgments
Ref: From Carsten
Ref: From Bastien
Ref: List of Contributions
Node: GNU Free Documentation License
Ref: ADDENDUM How to use this License for your documents
Node: Main Index
Node: Key Index
Node: Command and Function Index
Node: Variable Index
2019-11-26 16:46:24 +01:00
End Tag Table
Local Variables:
coding: utf-8
End:
