The Org Manual

Table of Contents

Org Mode Manual
1 Introduction
- 1.1 Summary
- 1.2 Installation
- 1.3 Activation
- 1.4 Feedback
- 1.5 Typesetting conventions used in this manual
2 Document Structure
- 2.1 Outlines
- 2.2 Headlines
- 2.3 Visibility cycling
- 2.4 Motion
- 2.5 Structure editing
- 2.6 Archiving
  - 2.6.1 The ARCHIVE tag
  - 2.6.2 Moving subtrees
- 2.7 Sparse trees
- 2.8 Plain lists
- 2.9 Drawers
- 2.10 The Orgstruct minor mode
3 Tables
- 3.1 The built-in table editor
- 3.2 Narrow columns
- 3.3 Column groups
- 3.4 The Orgtbl minor mode
- 3.5 The spreadsheet
- 3.6 Org Plot
4 Hyperlinks
- 4.1 Link format
- 4.2 Internal links
  - 4.2.1 Radio targets
- 4.3 External links
- 4.4 Handling links
- 4.5 Using links outside Org
- 4.6 Link abbreviations
- 4.7 Search options in file links
- 4.8 Custom Searches
5 TODO Items
- 5.1 Basic TODO functionality
- 5.2 Extended use of TODO keywords
- 5.3 Progress logging
  - 5.3.1 Closing items
  - 5.3.2 Tracking TODO state changes
- 5.4 Priorities
- 5.5 Breaking tasks down into subtasks
- 5.6 Checkboxes
6 Tags
- 6.1 Tag inheritance
- 6.2 Setting tags
- 6.3 Tag searches
7 Properties and Columns
- 7.1 Property syntax
- 7.2 Special properties
- 7.3 Property searches
- 7.4 Property Inheritance
- 7.5 Column view
- 7.6 The Property API
8 Dates and Times
- 8.1 Timestamps, deadlines and scheduling
- 8.2 Creating timestamps
  - 8.2.1 The date/time prompt
  - 8.2.2 Custom time format
- 8.3 Deadlines and scheduling
  - 8.3.1 Inserting deadlines or schedules
  - 8.3.2 Repeated tasks
- 8.4 Clocking work time
- 8.5 Effort estimates
9 Capture
- 9.1 Remember
- 9.2 Attachments
10 Agenda Views
- 10.1 Agenda files
- 10.2 The agenda dispatcher
- 10.3 The built-in agenda views
- 10.4 Presentation and sorting
- 10.5 Commands in the agenda buffer
- 10.6 Custom agenda views
- 10.7 Using column view in the agenda
11 Embedded LaTeX
- 11.1 Math symbols
- 11.2 Subscripts and superscripts
- 11.3 LaTeX fragments
- 11.4 Processing LaTeX fragments
- 11.5 Using CDLaTeX to enter math
12 Exporting
- 12.1 Markup rules
- 12.2 Selective export
- 12.3 Export options
- 12.4 The export dispatcher
- 12.5 ASCII export
- 12.6 HTML export
- 12.7 LaTeX and PDF export
- 12.8 XOXO export
- 12.9 iCalendar export
13 Publishing
- 13.1 Configuration
- 13.2 Sample configuration
  - 13.2.1 Example: simple publishing configuration
  - 13.2.2 Example: complex publishing configuration
- 13.3 Triggering publication
14 Miscellaneous
- 14.1 Completion
- 14.2 Customization
- 14.3 Summary of in-buffer settings
- 14.4 The very busy C-c C-c key
- 14.5 A cleaner outline view
- 14.6 Using Org on a tty
- 14.7 Interaction with other packages
  - 14.7.1 Packages that Org cooperates with
  - 14.7.2 Packages that lead to conflicts with Org mode
- 14.8 Bugs
Appendix A Extensions
- A.1 Extensions in the contrib directory
- A.2 Other extensions
Appendix B Hacking
- B.1 Adding hyperlink types
- B.2 Tables and lists in arbitrary syntax
- B.3 Dynamic blocks
- B.4 Special agenda views
- B.5 Using the property API
- B.6 Using the mapping API
Appendix C History and Acknowledgments
The Main Index
Key Index

Next: Introduction, Previous: (dir), Up: (dir)

Org Mode Manual

This manual is for Org (version 6.12a).

Copyright © 2004, 2005, 2006, 2007, 2008 Free Software Foundation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being “A GNU Manual,” and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License.”
(a) The FSF's Back-Cover Text is: “You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.”
This document is part of a collection distributed under the GNU Free Documentation License. If you want to distribute this document separately from the collection, you can do so by adding a copy of the license to the document, as described in section 6 of the license.

Introduction: Getting started
Document Structure: A tree works like your brain
Tables: Pure magic for quick formatting
Hyperlinks: Notes in context
TODO Items: Every tree branch can be a TODO item
Tags: Tagging headlines and matching sets of tags
Properties and Columns: Storing information about an entry
Dates and Times: Making items useful for planning
Capture: Creating tasks and attaching files
Agenda Views: Collecting information into views
Embedded LaTeX: LaTeX fragments and formulas
Exporting: Sharing and publishing of notes
Publishing: Create a web site of linked Org files
Miscellaneous: All the rest which did not fit elsewhere
Extensions: Add-ons for Org mode
Hacking: How hack your way around
History and Acknowledgments: How Org came into being
Main Index: An index of Org's concepts and features
Key Index: Key bindings and where they are described

--- The Detailed Node Listing ---

Introduction

Document Structure

Outlines: Org is based on Outline mode
Headlines: How to typeset Org tree headlines
Visibility cycling: Show and hide, much simplified
Motion: Jumping to other headlines
Structure editing: Changing sequence and level of headlines
Archiving: Move done task trees to a different place
Sparse trees: Matches embedded in context
Plain lists: Additional structure within an entry
Drawers: Tucking stuff away
Orgstruct mode: Structure editing outside Org

Archiving

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
Field formulas: Formulas valid for a single field
Column formulas: Formulas valid for an entire column
Editing and debugging formulas: Fixing formulas
Updating the table: Recomputing all dependent fields
Advanced features: Field names, parameters and automatic recalc

Hyperlinks

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

Internal links

TODO Items

Extended use of TODO keywords

Progress logging

Tags

Properties and Columns

Column view

Defining columns

Dates and Times

Creating timestamps

Deadlines and scheduling

Capture

Remember

Agenda Views

The built-in agenda views

Presentation and sorting

Custom agenda views

Embedded LaTeX

Exporting

Markup rules: Which structures are recognized?
Selective export: Using tags to select and exclude trees
Export options: Per-file export settings
The export dispatcher: How to access exporter commands
ASCII export: Exporting to plain ASCII
HTML export: Exporting to HTML
LaTeX and PDF export: Exporting to LaTeX, and processing to PDF
XOXO export: Exporting to XOXO
iCalendar export: Exporting in iCalendar format

Markup rules

Document title: How the document title is determined
Headings and sections: The main structure of the exported document
Table of contents: If, where, how to create a table of contents
Initial text: Text before the first headline
Lists: Plain lists are exported
Paragraphs: What determines beginning and ending
Literal examples: Source code and other examples
Include files: Include the contents of a file during export
Tables exported: Tables are exported richly
Footnotes: Numbers like [1]
Emphasis and monospace: To bold or not to bold
TeX macros and LaTeX fragments: Create special, rich export.
Horizontal rules: A line across the page
Comment lines: Some lines will not be exported

HTML export

LaTeX and PDF export

Publishing

Configuration

Sample configuration

Miscellaneous

Interaction with other packages

Extensions

Hacking

Tables and lists in arbitrary syntax