org.texi 420 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1 2
\input texinfo
@c %**start of header
3
@setfilename ../../info/org
4
@settitle The Org Manual
Glenn Morris's avatar
Glenn Morris committed
5

6 7
@set VERSION 6.21b
@set DATE February 2009
Glenn Morris's avatar
Glenn Morris committed
8 9 10 11 12 13 14

@dircategory Emacs
@direntry
* Org Mode: (org).      Outline-based notes management and organizer
@end direntry

@c Version and Contact Info
15
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
Glenn Morris's avatar
Glenn Morris committed
16 17
@set AUTHOR Carsten Dominik
@set MAINTAINER Carsten Dominik
18 19
@set MAINTAINEREMAIL @email{carsten at orgmode dot org}
@set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
Glenn Morris's avatar
Glenn Morris committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
@c %**end of header
@finalout

@c Macro definitions

@c Subheadings inside a table.
@macro tsubheading{text}
@ifinfo
@subsubheading \text\
@end ifinfo
@ifnotinfo
@item @b{\text\}
@end ifnotinfo
@end macro

@copying
36
This manual is for Org (version @value{VERSION}).
Glenn Morris's avatar
Glenn Morris committed
37

Glenn Morris's avatar
Glenn Morris committed
38
Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
Glenn Morris's avatar
Glenn Morris committed
39 40 41

@quotation
Permission is granted to copy, distribute and/or modify this document
42
under the terms of the GNU Free Documentation License, Version 1.3 or
Glenn Morris's avatar
Glenn Morris committed
43 44
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
45 46
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.''
Glenn Morris's avatar
Glenn Morris committed
47

48 49 50
(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.''
51 52 53 54 55

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.
Glenn Morris's avatar
Glenn Morris committed
56 57 58 59
@end quotation
@end copying

@titlepage
60
@title The Org Manual
Glenn Morris's avatar
Glenn Morris committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

@subtitle Release @value{VERSION}
@author by Carsten Dominik

@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@c Output the table of contents at the beginning.
@contents

@ifnottex
@node Top, Introduction, (dir), (dir)
@top Org Mode Manual

@insertcopying
@end ifnottex

@menu
* Introduction::                Getting started
83
* Document Structure::          A tree works like your brain
Glenn Morris's avatar
Glenn Morris committed
84 85
* Tables::                      Pure magic for quick formatting
* Hyperlinks::                  Notes in context
86
* TODO Items::                  Every tree branch can be a TODO item
Glenn Morris's avatar
Glenn Morris committed
87
* Tags::                        Tagging headlines and matching sets of tags
88 89
* Properties and Columns::      Storing information about an entry
* Dates and Times::             Making items useful for planning
Carsten Dominik's avatar
Carsten Dominik committed
90
* Capture::                     Creating tasks and attaching files
91
* Agenda Views::                Collecting information into views
Glenn Morris's avatar
Glenn Morris committed
92 93
* Embedded LaTeX::              LaTeX fragments and formulas
* Exporting::                   Sharing and publishing of notes
94
* Publishing::                  Create a web site of linked Org files
Glenn Morris's avatar
Glenn Morris committed
95
* Miscellaneous::               All the rest which did not fit elsewhere
Carsten Dominik's avatar
Carsten Dominik committed
96
* Extensions::                  Add-ons for Org mode
Glenn Morris's avatar
Glenn Morris committed
97
* Hacking::                     How to hack your way around
98 99
* History and Acknowledgments::  How Org came into being
* Main Index::                  An index of Org's concepts and features
Glenn Morris's avatar
Glenn Morris committed
100 101 102 103 104 105 106
* Key Index::                   Key bindings and where they are described

@detailmenu
 --- The Detailed Node Listing ---

Introduction

107 108 109
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
Glenn Morris's avatar
Glenn Morris committed
110
* Feedback::                    Bug reports, ideas, patches etc.
111
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
112 113 114

Document Structure

115 116
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
117 118 119 120 121 122 123
* 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
124
* Footnotes::                   How footnotes are defined in Org's syntax
125
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
126 127 128 129 130 131 132 133 134

Archiving

* ARCHIVE tag::                 Marking a tree as inactive
* Moving subtrees::             Moving a tree to an archive file

Tables

* Built-in table editor::       Simple tables
135
* Narrow columns::              Stop wasting space in tables
Glenn Morris's avatar
Glenn Morris committed
136
* Column groups::               Grouping to trigger vertical lines
137 138
* Orgtbl mode::                 The table editor as minor mode
* The spreadsheet::             The table editor has spreadsheet capabilities
Carsten Dominik's avatar
Carsten Dominik committed
139
* Org Plot::                    Plotting from org tables
Glenn Morris's avatar
Glenn Morris committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153

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

154
* Link format::                 How links in Org are formatted
Glenn Morris's avatar
Glenn Morris committed
155 156 157
* Internal links::              Links to other places in the current file
* External links::              URL-like links to the world
* Handling links::              Creating, inserting and following
158
* Using links outside Org::     Linking from my C source code?
Glenn Morris's avatar
Glenn Morris committed
159 160 161 162 163 164
* 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

165
* Radio targets::               Make targets trigger links in plain text
Glenn Morris's avatar
Glenn Morris committed
166

167
TODO Items
Glenn Morris's avatar
Glenn Morris committed
168 169 170

* TODO basics::                 Marking and displaying TODO entries
* TODO extensions::             Workflow and assignments
171
* Progress logging::            Dates and notes for progress
Glenn Morris's avatar
Glenn Morris committed
172 173 174 175 176 177 178
* Priorities::                  Some things are more important than others
* Breaking down tasks::         Splitting a task into manageable pieces
* Checkboxes::                  Tick-off lists

Extended use of TODO keywords

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

186
Progress logging
187 188 189

* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
Glenn Morris's avatar
Glenn Morris committed
190 191 192 193 194 195 196 197 198 199

Tags

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

Properties and Columns

* Property syntax::             How properties are spelled out
200
* Special properties::          Access to other Org mode features
Glenn Morris's avatar
Glenn Morris committed
201
* Property searches::           Matching property values
202
* Property inheritance::        Passing values down the tree
Glenn Morris's avatar
Glenn Morris committed
203 204 205
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers

206
Column view
Glenn Morris's avatar
Glenn Morris committed
207 208 209

* Defining columns::            The COLUMNS format property
* Using column view::           How to create and use column view
210
* Capturing column view::       A dynamic block for column view
Glenn Morris's avatar
Glenn Morris committed
211

212
Defining columns
Glenn Morris's avatar
Glenn Morris committed
213 214 215 216

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

217
Dates and Times
Glenn Morris's avatar
Glenn Morris committed
218

219
* Timestamps::                  Assigning a time to a tree entry
Glenn Morris's avatar
Glenn Morris committed
220 221
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
222 223
* Clocking work time::          Tracking how long you spend on a task
* Effort estimates::            Planning work effort in advance
224
* Relative timer::              Notes with a running timer
Glenn Morris's avatar
Glenn Morris committed
225 226 227

Creating timestamps

228 229
* The date/time prompt::        How Org mode helps you entering date and time
* Custom time format::          Making dates look different
Glenn Morris's avatar
Glenn Morris committed
230

231
Deadlines and scheduling
Glenn Morris's avatar
Glenn Morris committed
232 233 234 235

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

Carsten Dominik's avatar
Carsten Dominik committed
236 237 238 239 240
Capture

* Remember::                    Capture new tasks/ideas with little interruption
* Attachments::                 Add files to tasks.

241
Remember
Glenn Morris's avatar
Glenn Morris committed
242

243
* Setting up Remember::         Some code for .emacs to get things going
244 245 246
* Remember templates::          Define the outline of different note types
* Storing notes::               Directly get the note to where it belongs
* Refiling notes::              Moving a note or task to a project
Glenn Morris's avatar
Glenn Morris committed
247 248 249 250 251 252 253

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
254
* Agenda commands::             Remote editing of Org trees
Glenn Morris's avatar
Glenn Morris committed
255
* Custom agenda views::         Defining special searches and views
256
* Agenda column view::          Using column view for collected entries
Glenn Morris's avatar
Glenn Morris committed
257 258 259

The built-in agenda views

260
* Weekly/daily agenda::         The calendar page with current tasks
Glenn Morris's avatar
Glenn Morris committed
261 262 263
* Global TODO list::            All unfinished action items
* Matching tags and properties::  Structured information with fine-tuned search
* Timeline::                    Time-sorted view for single file
264
* Keyword search::              Finding entries by keyword
Glenn Morris's avatar
Glenn Morris committed
265 266 267 268 269 270 271 272 273 274 275 276 277
* 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

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
278 279
* Exporting Agenda Views::      Writing agendas to files
* Using the agenda elsewhere::  Using agenda information in other programs
Glenn Morris's avatar
Glenn Morris committed
280 281 282 283

Embedded LaTeX

* Math symbols::                TeX macros for symbols and Greek letters
284
* Subscripts and superscripts::  Simple syntax for raising/lowering text
Glenn Morris's avatar
Glenn Morris committed
285 286 287 288 289 290
* LaTeX fragments::             Complex formulas made easy
* Processing LaTeX fragments::  Previewing LaTeX processing
* CDLaTeX mode::                Speed up entering of formulas

Exporting

291
* Markup rules::                Which structures are recognized?
Carsten Dominik's avatar
Carsten Dominik committed
292
* Selective export::            Using tags to select and exclude trees
293 294
* Export options::              Per-file export settings
* The export dispatcher::       How to access exporter commands
Glenn Morris's avatar
Glenn Morris committed
295 296
* ASCII export::                Exporting to plain ASCII
* HTML export::                 Exporting to HTML
297
* LaTeX and PDF export::        Exporting to LaTeX, and processing to PDF
Glenn Morris's avatar
Glenn Morris committed
298 299
* XOXO export::                 Exporting to XOXO
* iCalendar export::            Exporting in iCalendar format
300 301 302 303 304 305 306 307 308 309 310 311

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
312
* Inlined images::              How to inline images during export
313
* Footnote markup::             
314 315 316 317
* 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
Glenn Morris's avatar
Glenn Morris committed
318 319 320

HTML export

321
* HTML Export commands::        How to invoke HTML export
322
* Quoting HTML tags::           Using direct HTML in Org mode
Glenn Morris's avatar
Glenn Morris committed
323
* Links::                       Transformation of links for HTML
324 325
* Images in HTML export::       How to insert figures into HTML output
* Text areas in HTML export::   An alternative way to show an example
326 327
* CSS support::                 Changing the appearance of the output
* Javascript support::          Info and Folding in a web browser
Glenn Morris's avatar
Glenn Morris committed
328

329
LaTeX and PDF export
Glenn Morris's avatar
Glenn Morris committed
330

Glenn Morris's avatar
Glenn Morris committed
331
* LaTeX/PDF export commands::   Which key invokes which commands
Glenn Morris's avatar
Glenn Morris committed
332
* Quoting LaTeX code::          Incorporating literal LaTeX code
333
* Sectioning structure::        Changing sectioning in LaTeX output
334 335
* Tables in LaTeX export::      Options for exporting tables to LaTeX
* Images in LaTeX export::      How to insert figures into LaTeX output
Glenn Morris's avatar
Glenn Morris committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

Publishing

* Configuration::               Defining projects
* 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 export
* Publishing links::            Which links keep working after publishing?
* Project page index::          Publishing a list of project files

Sample configuration

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

Miscellaneous

* Completion::                  M-TAB knows what you need
361
* Customization::               Adapting Org to your taste
Glenn Morris's avatar
Glenn Morris committed
362 363 364
* In-buffer settings::          Overview of the #+KEYWORDS
* The very busy C-c C-c key::   When in doubt, press C-c C-c
* Clean view::                  Getting rid of leading stars in the outline
365
* TTY keys::                    Using Org on a tty
Glenn Morris's avatar
Glenn Morris committed
366 367 368 369 370
* Interaction::                 Other Emacs packages
* Bugs::                        Things which do not work perfectly

Interaction with other packages

371
* Cooperation::                 Packages Org cooperates with
Glenn Morris's avatar
Glenn Morris committed
372 373
* Conflicts::                   Packages that lead to conflicts

374 375 376 377 378 379
Extensions

* Extensions in the contrib directory::  These come with the Org distro
* Other extensions::            These you have to find on the web.

Hacking
Glenn Morris's avatar
Glenn Morris committed
380 381 382 383 384 385

* Adding hyperlink types::      New custom link types
* Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
* Using the property API::      Writing programs that use entry properties
386
* Using the mapping API::       Mapping over all or selected entries
Glenn Morris's avatar
Glenn Morris committed
387

388
Tables and lists in arbitrary syntax
Glenn Morris's avatar
Glenn Morris committed
389 390 391 392

* Radio tables::                Sending and receiving
* A LaTeX example::             Step by step, almost a tutorial
* Translator functions::        Copy and modify
393
* Radio lists::                 Doing the same for lists
Glenn Morris's avatar
Glenn Morris committed
394 395 396 397

@end detailmenu
@end menu

398
@node Introduction, Document Structure, Top, Top
Glenn Morris's avatar
Glenn Morris committed
399 400 401 402
@chapter Introduction
@cindex introduction

@menu
403 404 405
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
Glenn Morris's avatar
Glenn Morris committed
406
* Feedback::                    Bug reports, ideas, patches etc.
407
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
408 409 410 411 412 413
@end menu

@node Summary, Installation, Introduction, Introduction
@section Summary
@cindex summary

414
Org is a mode for keeping notes, maintaining TODO lists, and doing
Glenn Morris's avatar
Glenn Morris committed
415 416
project planning with a fast and effective plain-text system.

417 418 419
Org develops organizational tasks around NOTES files that contain
lists or information about projects as plain text.  Org is
implemented on top of Outline mode, which makes it possible to keep the
Glenn Morris's avatar
Glenn Morris committed
420 421
content of large files well structured.  Visibility cycling and
structure editing help to work with the tree.  Tables are easily created
422
with a built-in table editor.  Org supports TODO items, deadlines,
Glenn Morris's avatar
Glenn Morris committed
423 424 425 426
time stamps, and scheduling.  It dynamically compiles entries into an
agenda that utilizes and smoothly integrates much of the Emacs calendar
and diary.  Plain text URL-like links connect to websites, emails,
Usenet messages, BBDB entries, and any files related to the projects.
427
For printing and sharing of notes, an Org file can be exported as a
428
structured ASCII file, as HTML, or (TODO and agenda items only) as an
Glenn Morris's avatar
Glenn Morris committed
429
iCalendar file.  It can also serve as a publishing tool for a set of
430
linked web pages.
Glenn Morris's avatar
Glenn Morris committed
431

432
An important design aspect that distinguishes Org from for example
Glenn Morris's avatar
Glenn Morris committed
433 434
Planner/Muse is that it encourages to store every piece of information
only once.  In Planner, you have project pages, day pages and possibly
435
other files, duplicating some information such as tasks.  In Org,
Glenn Morris's avatar
Glenn Morris committed
436 437 438 439 440
you only have notes files.  In your notes you mark entries as tasks,
label them with tags and timestamps.  All necessary lists like a
schedule for the day, the agenda for a meeting, tasks lists selected by
tags etc are created dynamically when you need them.

441
Org keeps simple things simple.  When first fired up, it should
Glenn Morris's avatar
Glenn Morris committed
442 443
feel like a straightforward, easy to use outliner.  Complexity is not
imposed, but a large amount of functionality is available when you need
444
it.  Org is a toolbox and can be used in different ways, for
Glenn Morris's avatar
Glenn Morris committed
445 446 447 448 449 450 451 452 453 454
example as:

@example
@r{@bullet{} outline extension with visibility cycling and structure editing}
@r{@bullet{} ASCII system and table editor for taking structured notes}
@r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
@r{@bullet{} TODO list editor}
@r{@bullet{} full agenda and planner with deadlines and work scheduling}
@r{@bullet{} environment to implement David Allen's GTD system}
@r{@bullet{} a basic database application}
455
@r{@bullet{} simple hypertext system, with HTML and LaTeX export}
Glenn Morris's avatar
Glenn Morris committed
456 457 458
@r{@bullet{} publishing tool to create a set of interlinked webpages}
@end example

459
Org's automatic, context sensitive table editor with spreadsheet
Glenn Morris's avatar
Glenn Morris committed
460
capabilities can be integrated into any major mode by activating the
461
minor Orgtbl mode.  Using a translation step, it can be used to maintain
Glenn Morris's avatar
Glenn Morris committed
462
tables in arbitrary file types, for example in La@TeX{}.  The structure
463 464
editing and list creation capabilities can be used outside Org with
the minor Orgstruct mode.
Glenn Morris's avatar
Glenn Morris committed
465 466

@cindex FAQ
467 468
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
Glenn Morris's avatar
Glenn Morris committed
469
questions (FAQ), links to tutorials etc.  This page is located at
470
@uref{http://orgmode.org}.
Glenn Morris's avatar
Glenn Morris committed
471 472 473 474 475 476 477 478 479

@page


@node Installation, Activation, Summary, Introduction
@section Installation
@cindex installation
@cindex XEmacs

480
@b{Important:} @i{If Org is part of the Emacs distribution or an
Glenn Morris's avatar
Glenn Morris committed
481 482 483
XEmacs package, please skip this section and go directly to
@ref{Activation}.}

484 485 486 487 488 489 490 491 492
If you have downloaded Org from the Web, either as a distribution @file{.zip}
or @file{.tar} file, or as a GIT archive, you must take the following steps
to install it: Go into the unpacked Org distribution directory and edit the
top section of the file @file{Makefile}.  You must set the name of the Emacs
binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
directories where local Lisp and Info files are kept.  If you don't have
access to the system-wide directories, you can simply run Org directly from
the distribution directory by adding the @file{lisp} subdirectory to the
Emacs load path.  To do this, add the following line to @file{.emacs}:
Glenn Morris's avatar
Glenn Morris committed
493 494

@example
495 496 497 498 499 500 501 502 503
(setq load-path (cons "~/path/to/orgdir/lisp" load-path))
@end example

@noindent
If you plan to use code from the @file{contrib} subdirectory, do a similar
step for this directory:

@example
(setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
Glenn Morris's avatar
Glenn Morris committed
504 505 506
@end example

@b{XEmacs users now need to install the file @file{noutline.el} from
507
the @file{xemacs} sub-directory of the Org distribution.  Use the
Glenn Morris's avatar
Glenn Morris committed
508 509 510 511 512 513
command:}

@example
@b{make install-noutline}
@end example

514
@noindent Now byte-compile the Lisp files with the shell command:
Glenn Morris's avatar
Glenn Morris committed
515 516 517 518 519

@example
make
@end example

520 521
@noindent If you are running Org from the distribution directory, this is
all.  If you want to install into the system directories, use
Glenn Morris's avatar
Glenn Morris committed
522 523

@example
524
make install
Glenn Morris's avatar
Glenn Morris committed
525 526 527 528 529 530
make install-info
@end example

@noindent Then add to @file{.emacs}:

@lisp
531
;; This line only if Org is not part of the X/Emacs distribution.
Glenn Morris's avatar
Glenn Morris committed
532 533 534
(require 'org-install)
@end lisp

535
Do not forget to activate Org as described in the following section.
536

Glenn Morris's avatar
Glenn Morris committed
537 538 539 540
@node Activation, Feedback, Installation, Introduction
@section Activation
@cindex activation
@cindex autoload
541 542
@cindex global key bindings
@cindex key bindings, global
Glenn Morris's avatar
Glenn Morris committed
543 544 545

@iftex
@b{Important:} @i{If you use copy-and-paste to copy lisp code from the
Carsten Dominik's avatar
Carsten Dominik committed
546
PDF documentation as viewed by some PDF viewers to your .emacs file, the
Glenn Morris's avatar
Glenn Morris committed
547 548 549 550 551
single quote character comes out incorrectly and the code will not work.
You need to fix the single quotes by hand, or copy from Info
documentation.}
@end iftex

552
Add the following lines to your @file{.emacs} file.  The last three lines
553 554 555
define @emph{global} keys for the commands @command{org-store-link},
@command{org-agenda}, and @command{org-iswitchb} - please choose suitable
keys yourself.
Glenn Morris's avatar
Glenn Morris committed
556 557 558 559 560 561

@lisp
;; The following lines are always needed.  Choose your own keys.
(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
(global-set-key "\C-cl" 'org-store-link)
(global-set-key "\C-ca" 'org-agenda)
562
(global-set-key "\C-cb" 'org-iswitchb)
Glenn Morris's avatar
Glenn Morris committed
563 564
@end lisp

565
Furthermore, you must activate @code{font-lock-mode} in Org
Glenn Morris's avatar
Glenn Morris committed
566 567 568 569 570
buffers, because significant functionality depends on font-locking being
active.  You can do this with either one of the following two lines
(XEmacs user must use the second option):
@lisp
(global-font-lock-mode 1)                     ; for all buffers
571
(add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
Glenn Morris's avatar
Glenn Morris committed
572 573
@end lisp

574
@cindex Org mode, turning on
Glenn Morris's avatar
Glenn Morris committed
575
With this setup, all files with extension @samp{.org} will be put
576
into Org mode.  As an alternative, make the first line of a file look
Glenn Morris's avatar
Glenn Morris committed
577 578 579 580 581 582
like this:

@example
MY PROJECTS    -*- mode: org; -*-
@end example

583
@noindent which will select Org mode for this buffer no matter what
Glenn Morris's avatar
Glenn Morris committed
584 585 586
the file's name is.  See also the variable
@code{org-insert-mode-line-in-empty-file}.

Glenn Morris's avatar
Glenn Morris committed
587
Many commands in Org work on the region if the region is active.  To make use
588 589 590 591 592 593 594 595
of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
XEmacs) turned on.  In Emacs 23 this is the default, in Emacs 22 you need to
do this yourself with

@lisp
(transient-mark-mode 1)
@end lisp

596
@node Feedback, Conventions, Activation, Introduction
Glenn Morris's avatar
Glenn Morris committed
597 598 599 600 601 602
@section Feedback
@cindex feedback
@cindex bug reports
@cindex maintainer
@cindex author

603 604 605 606
If you find problems with Org, or if you have questions, remarks, or ideas
about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
If you are not a member of the mailing list, your mail will be reviewed by a
moderator and then passed through to the list.
Glenn Morris's avatar
Glenn Morris committed
607 608 609

For bug reports, please provide as much information as possible,
including the version information of Emacs (@kbd{C-h v emacs-version
610 611
@key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
the Org related setup in @file{.emacs}.  If an error occurs, a
Glenn Morris's avatar
Glenn Morris committed
612 613 614 615 616 617 618 619 620 621 622 623 624
backtrace can be very useful (see below on how to create one).  Often a
small example file helps, along with clear information about:

@enumerate
@item What exactly did you do?
@item What did you expect to happen?
@item What happened instead?
@end enumerate
@noindent Thank you for helping to improve this mode.

@subsubheading How to create a useful backtrace

@cindex backtrace of an error
625
If working with Org produces an error with a message you don't
Glenn Morris's avatar
Glenn Morris committed
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
understand, you may have hit a bug.  The best way to report this is by
providing, in addition to what was mentioned above, a @emph{Backtrace}.
This is information from the built-in debugger about where and how the
error occurred.  Here is how to produce a useful backtrace:

@enumerate
@item
Start a fresh Emacs or XEmacs, and make sure that it will load the
original Lisp code in @file{org.el} instead of the compiled version in
@file{org.elc}.  The backtrace contains much more information if it is
produced with uncompiled code.  To do this, either rename @file{org.elc}
to something else before starting Emacs, or ask Emacs explicitly to load
@file{org.el} by using the command line
@example
emacs -l /path/to/org.el
@end example
@item
Go to the @code{Options} menu and select @code{Enter Debugger on Error}
(XEmacs has this option in the @code{Troubleshooting} sub-menu).
@item
Do whatever you have to do to hit the error.  Don't forget to
document the steps you take.
@item
When you hit the error, a @file{*Backtrace*} buffer will appear on the
screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
attach it to your bug report.
@end enumerate

654 655 656
@node Conventions,  , Feedback, Introduction
@section Typesetting conventions used in this manual

657
Org uses three types of keywords: TODO keywords, tags, and property
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
names.  In this manual we use the following conventions:

@table @code
@item TODO
@itemx WAITING
TODO keywords are written with all capitals, even if they are
user-defined.
@item boss
@itemx ARCHIVE
User-defined tags are written in lowercase; built-in tags with special
meaning are written with all capitals.
@item Release
@itemx PRIORITY
User-defined properties are capitalized; built-in properties with
special meaning are written with all capitals.
@end table

675
@node Document Structure, Tables, Introduction, Top
Glenn Morris's avatar
Glenn Morris committed
676 677 678 679
@chapter Document Structure
@cindex document structure
@cindex structure of document

680
Org is based on outline mode and provides flexible commands to
Glenn Morris's avatar
Glenn Morris committed
681 682 683
edit the structure of the document.

@menu
684 685
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
686 687 688 689 690 691 692
* 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
693
* Footnotes::                   How footnotes are defined in Org's syntax
694
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
695 696
@end menu

697
@node Outlines, Headlines, Document Structure, Document Structure
Glenn Morris's avatar
Glenn Morris committed
698 699
@section Outlines
@cindex outlines
700
@cindex Outline mode
Glenn Morris's avatar
Glenn Morris committed
701

702
Org is implemented on top of Outline mode.  Outlines allow a
Glenn Morris's avatar
Glenn Morris committed
703 704 705 706
document to be organized in a hierarchical structure, which (at least
for me) is the best representation of notes and thoughts.  An overview
of this structure is achieved by folding (hiding) large parts of the
document to show only the general document structure and the parts
707
currently being worked on.  Org greatly simplifies the use of
Glenn Morris's avatar
Glenn Morris committed
708 709 710
outlines by compressing the entire show/hide functionality into a single
command @command{org-cycle}, which is bound to the @key{TAB} key.

711
@node Headlines, Visibility cycling, Outlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
712 713 714 715 716
@section Headlines
@cindex headlines
@cindex outline tree

Headlines define the structure of an outline tree.  The headlines in
717
Org start with one or more stars, on the left margin@footnote{See
Glenn Morris's avatar
Glenn Morris committed
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
the variable @code{org-special-ctrl-a/e} to configure special behavior
of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:

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

* Another top level headline
@end example

@noindent Some people find the many stars too noisy and would prefer an
outline that has whitespace followed by a single star as headline
starters.  @ref{Clean view} describes a setup to realize this.

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

742
@node Visibility cycling, Motion, Headlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
743 744 745 746 747 748 749 750
@section Visibility cycling
@cindex cycling, visibility
@cindex visibility cycling
@cindex trees, visibility
@cindex show hidden text
@cindex hide text

Outlines make it possible to hide parts of the text in the buffer.
751
Org uses just two commands, bound to @key{TAB} and
Glenn Morris's avatar
Glenn Morris committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
@kbd{S-@key{TAB}} to change the visibility in the buffer.

@cindex subtree visibility states
@cindex subtree cycling
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
@table @kbd
@kindex @key{TAB}
@item @key{TAB}
@emph{Subtree cycling}: Rotate current subtree among the states

@example
,-> FOLDED -> CHILDREN -> SUBTREE --.
'-----------------------------------'
@end example

The cursor must be on a headline for this to work@footnote{see, however,
the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
beginning of the buffer and the first line is not a headline, then
@key{TAB} actually runs global cycling (see below)@footnote{see the
option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
argument (@kbd{C-u @key{TAB}}), global cycling is invoked.

@cindex global visibility states
@cindex global cycling
@cindex overview, global visibility state
@cindex contents, global visibility state
@cindex show all, global visibility state
@kindex S-@key{TAB}
@item S-@key{TAB}
@itemx C-u @key{TAB}
@emph{Global cycling}: Rotate the entire buffer among the states

@example
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'
@end example

791 792 793
When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
CONTENTS view up to headlines of level N will be shown.  Note that inside
tables, @kbd{S-@key{TAB}} jumps to the previous field.
Glenn Morris's avatar
Glenn Morris committed
794 795

@cindex show all, command
Carsten Dominik's avatar
Carsten Dominik committed
796 797 798
@kindex C-u C-u C-u @key{TAB}
@item C-u C-u C-u @key{TAB}
Show all, including drawers.
Glenn Morris's avatar
Glenn Morris committed
799 800
@kindex C-c C-r
@item C-c C-r
801 802 803 804
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 (@pxref{Sparse trees}) or an agenda command
(@pxref{Agenda commands}).  With a prefix argument show, on each
Glenn Morris's avatar
Glenn Morris committed
805 806 807 808 809 810 811 812 813 814 815 816 817
level, all sibling headings.
@kindex C-c C-x b
@item C-c C-x b
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
(@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
@end ifinfo
@ifnotinfo
(see the Emacs manual for more information about indirect buffers)
@end ifnotinfo
will contain the entire buffer, but will be narrowed to the current
tree.  Editing the indirect buffer will also change the original buffer,
818 819 820
but without affecting visibility in that buffer.}.  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 @kbd{C-u} prefix, do not remove
Glenn Morris's avatar
Glenn Morris committed
821 822 823
the previously used indirect buffer.
@end table

824
When Emacs first visits an Org file, the global state is set to
Glenn Morris's avatar
Glenn Morris committed
825 826 827 828 829 830 831 832 833 834 835
OVERVIEW, i.e. only the top level headlines are visible.  This can be
configured through the variable @code{org-startup-folded}, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:

@example
#+STARTUP: overview
#+STARTUP: content
#+STARTUP: showall
@end example

836
@noindent
Glenn Morris's avatar
Glenn Morris committed
837
Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
838 839 840 841 842 843 844 845 846 847 848
and Columns}) will get their visibility adapted accordingly.  Allowed values
for this property are @code{folded}, @code{children}, @code{content}, and
@code{all}.
@table @kbd
@kindex C-u C-u @key{TAB}
@item C-u C-u @key{TAB}
Switch back to the startup visibility of the buffer, i.e. whatever is
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table

849
@node Motion, Structure editing, Visibility cycling, Document Structure
Glenn Morris's avatar
Glenn Morris committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
@section Motion
@cindex motion, between headlines
@cindex jumping, to headlines
@cindex headline navigation
The following commands jump to other headlines in the buffer.

@table @kbd
@kindex C-c C-n
@item C-c C-n
Next heading.
@kindex C-c C-p
@item C-c C-p
Previous heading.
@kindex C-c C-f
@item C-c C-f
Next heading same level.
@kindex C-c C-b
@item C-c C-b
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
Backward to higher level heading.
@kindex C-c C-j
@item C-c C-j
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:
@example
@key{TAB}         @r{Cycle visibility.}
@key{down} / @key{up}   @r{Next/previous visible headline.}
880 881 882
@key{RET}         @r{Select this location.}
@kbd{/}           @r{Do a Sparse-tree search}
@r{The following keys work if you turn off @code{org-goto-auto-isearch}}
Glenn Morris's avatar
Glenn Morris committed
883 884 885 886
n / p        @r{Next/previous visible headline.}
f / b        @r{Next/previous headline same level.}
u            @r{One level up.}
0-9          @r{Digit argument.}
887
q            @r{Quit}
Glenn Morris's avatar
Glenn Morris committed
888
@end example
889
See also the variable@code{org-goto-interface}.
Glenn Morris's avatar
Glenn Morris committed
890 891
@end table

892
@node Structure editing, Archiving, Motion, Document Structure
Glenn Morris's avatar
Glenn Morris committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
@section Structure editing
@cindex structure editing
@cindex headline, promotion and demotion
@cindex promotion, of subtrees
@cindex demotion, of subtrees
@cindex subtree, cut and paste
@cindex pasting, of subtrees
@cindex cutting, of subtrees
@cindex copying, of subtrees
@cindex subtrees, cut and paste

@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
Insert new heading with same level as current.  If the cursor is in a
plain list item, a new item is created (@pxref{Plain lists}).  To force
909
creation of a new headline, use a prefix argument, or first press @key{RET}
Glenn Morris's avatar
Glenn Morris committed
910 911
to get to the beginning of the next line.  When this command is used in
the middle of a line, the line is split and the rest of the line becomes
912 913 914 915 916 917 918 919
the new headline@footnote{If you do not want the line to be split,
customize the variable @code{org-M-RET-may-split-line}.}.  If the
command is used at the beginning of a headline, the new headline is
created before the current line.  If at the beginning of any other line,
the content of that line is made the new heading.  If the command is
used at the end of a folded subtree (i.e. behind the ellipses at the end
of a headline), then a headline like the current one will be inserted
after the end of the subtree.
920 921
@kindex C-@key{RET}
@item C-@key{RET}
922 923 924
Just like @kbd{M-@key{RET}}, except when adding a new heading below the
current heading, the new heading is placed after the body instead of before
it.  This command works from anywhere in the entry.
Glenn Morris's avatar
Glenn Morris committed
925 926 927
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert new TODO entry with same level as current heading.
Carsten Dominik's avatar
Carsten Dominik committed
928 929 930 931 932
@kindex C-S-@key{RET}
@item C-S-@key{RET}
Insert new TODO entry with same level as current heading.  Like
@kbd{C-@key{RET}}, the new headline will be inserted after the current
subtree.
Glenn Morris's avatar
Glenn Morris committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
@kindex M-@key{left}
@item M-@key{left}
Promote current heading by one level.
@kindex M-@key{right}
@item M-@key{right}
Demote current heading by one level.
@kindex M-S-@key{left}
@item M-S-@key{left}
Promote the current subtree by one level.
@kindex M-S-@key{right}
@item M-S-@key{right}
Demote the current subtree by one level.
@kindex M-S-@key{up}
@item M-S-@key{up}
Move subtree up (swap with previous subtree of same
level).
@kindex M-S-@key{down}
@item M-S-@key{down}
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@item C-c C-x C-w
Kill subtree, i.e. remove it from buffer but save in kill ring.
955
With a numeric prefix argument N, kill N sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
956 957
@kindex C-c C-x M-w
@item C-c C-x M-w
958 959
Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
960 961 962
@kindex C-c C-x C-y
@item C-c C-x C-y
Yank subtree from kill ring.  This does modify the level of the subtree to
963 964
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
Glenn Morris's avatar
Glenn Morris committed
965
headline marker like @samp{****}.
966
@kindex C-y
967 968 969 970
@item C-y
Depending on the variables @code{org-yank-adjusted-subtrees} and
@code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
paste subtrees folded and in a clever way, using the same command as @kbd{C-c
971 972 973 974 975 976 977
C-x C-y}.  With the default settings, no level adjustment will take place,
but the yanked tree will be folded unless doing so would swallow text
previously visible.  Any prefix argument to this command will force a normal
@code{yank} to be executed, with the prefix passed along.  A good way to
force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
978 979
@kindex C-c C-w
@item C-c C-w
980
Refile entry or region to a different location.  @xref{Refiling notes}.
Glenn Morris's avatar
Glenn Morris committed
981 982
@kindex C-c ^
@item C-c ^
983 984 985 986 987 988 989 990 991
Sort same-level entries.  When there is an active region, all entries in the
region will be sorted.  Otherwise the children of the current headline are
sorted.  The command prompts for the sorting method, which can be
alphabetically, numerically, by time (using the first time stamp in each
entry), by priority, or by TODO keyword (in the sequence the keywords have
been defined in the setup).  Reverse sorting is possible as well.  You can
also supply your own function to extract the sorting key.  With a @kbd{C-u}
prefix, sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes,
duplicate entries will also be removed.
992 993 994 995 996 997
@kindex C-x n s
@item C-x n s
Narrow buffer to current subtree.
@kindex C-x n w
@item C-x n w
Widen buffer to remove a narrowing.
998 999
@kindex C-c *
@item C-c *
1000 1001 1002 1003 1004
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
1005
headline, remove the stars from all headlines in the region.
Glenn Morris's avatar
Glenn Morris committed
1006 1007 1008 1009
@end table

@cindex region, active
@cindex active region
1010 1011
@cindex Transient mark mode
When there is an active region (Transient mark mode), promotion and
Glenn Morris's avatar
Glenn Morris committed
1012 1013 1014 1015 1016 1017 1018
demotion work on all headlines in the region.  To select a region of
headlines, it is best to place both point and mark at the beginning of a
line, mark at the beginning of the first headline, and point at the line
just after the last headline to change.  Note that when the cursor is
inside a table (@pxref{Tables}), the Meta-Cursor keys have different
functionality.

1019
@node Archiving, Sparse trees, Structure editing, Document Structure
Glenn Morris's avatar
Glenn Morris committed
1020 1021 1022 1023 1024
@section Archiving
@cindex archiving

When a project represented by a (sub)tree is finished, you may want
to move the tree out of the way and to stop it from contributing to the
1025
agenda.  Org mode knows two ways of archiving.  You can mark a tree with
Glenn Morris's avatar
Glenn Morris committed
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
the ARCHIVE tag, or you can move an entire (sub)tree to a different
location.

@menu
* ARCHIVE tag::                 Marking a tree as inactive
* Moving subtrees::             Moving a tree to an archive file
@end menu

@node ARCHIVE tag, Moving subtrees, Archiving, Archiving
@subsection The ARCHIVE tag
@cindex internal archiving

A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
its location in the outline tree, but behaves in the following way:
@itemize @minus
@item
It does not open when you attempt to do so with a visibility cycling
command (@pxref{Visibility cycling}).  You can force cycling archived
subtrees with @kbd{C-@key{TAB}}, or by setting the option
@code{org-cycle-open-archived-trees}.  Also normal outline commands like
@code{show-all} will open archived subtrees.
@item
During sparse tree construction (@pxref{Sparse trees}), matches in
archived subtrees are not exposed, unless you configure the option
@code{org-sparse-tree-open-archived-trees}.
@item
1052
During agenda view construction (@pxref{Agenda Views}), the content of
Glenn Morris's avatar
Glenn Morris committed
1053
archived trees is ignored unless you configure the option
Carsten Dominik's avatar
Carsten Dominik committed
1054 1055 1056
@code{org-agenda-skip-archived-trees}, in which case these trees will always
be included.  In the agenda you can press the @kbd{v} key to get archives
temporarily included.
Glenn Morris's avatar
Glenn Morris committed
1057 1058 1059 1060 1061 1062 1063 1064 1065
@item
Archived trees are not exported (@pxref{Exporting}), only the headline
is.  Configure the details using the variable
@code{org-export-with-archived-trees}.
@end itemize

The following commands help managing the ARCHIVE tag:

@table @kbd
1066 1067
@kindex C-c C-x a
@item C-c C-x a
Glenn Morris's avatar
Glenn Morris committed
1068
Toggle the ARCHIVE tag for the current headline.  When the tag is set,
1069
the headline changes to a shadowed face, and the subtree below it is
Glenn Morris's avatar
Glenn Morris committed
1070
hidden.
1071 1072
@kindex C-u C-c C-x a
@item C-u C-c C-x a
Glenn Morris's avatar
Glenn Morris committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
Check if any direct children of the current headline should be archived.
To do this, each subtree is checked for open TODO entries.  If none are
found, the command offers to set the ARCHIVE tag for the child.  If the
cursor is @emph{not} on a headline when this command is invoked, the
level 1 trees will be checked.
@kindex C-@kbd{TAB}
@item C-@kbd{TAB}
Cycle a tree even if it is tagged with ARCHIVE.
@end table

@node Moving subtrees,  , ARCHIVE tag, Archiving
@subsection Moving subtrees
@cindex external archiving

1087
Once an entire project is finished, you may want to move it to a different
Carsten Dominik's avatar
Carsten Dominik committed
1088
location.  Org can move it to an @emph{Archive Sibling} in the same tree, to a
1089
different tree in the current file, or to a different file, the archive file.
Glenn Morris's avatar
Glenn Morris committed
1090 1091

@table @kbd
1092 1093
@kindex C-c C-x A
@item C-c C-x A
Carsten Dominik's avatar
Carsten Dominik committed
1094 1095
Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1096 1097 1098
(@pxref{ARCHIVE tag}).  The entry becomes a child of that sibling and in this
way retains a lot of its original context, including inherited tags and
approximate position in the outline.
Glenn Morris's avatar
Glenn Morris committed
1099 1100 1101 1102
@kindex C-c C-x C-s
@item C-c C-x C-s
Archive the subtree starting at the cursor position to the location
given by @code{org-archive-location}.  Context information that could be
1103
lost like the file name, the category, inherited tags, and the TODO
Glenn Morris's avatar
Glenn Morris committed
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
state will be store as properties in the entry.
@kindex C-u C-c C-x C-s
@item C-u C-c C-x C-s
Check if any direct children of the current headline could be moved to
the archive.  To do this, each subtree is checked for open TODO entries.
If none are found, the command offers to move it to the archive
location.  If the cursor is @emph{not} on a headline when this command
is invoked, the level 1 trees will be checked.
@end table

@cindex archive locations
The default archive location is a file in the same directory as the
current file, with the name derived by appending @file{_archive} to the
current file name.  For information and examples on how to change this,
see the documentation string of the variable
@code{org-archive-location}.  There is also an in-buffer option for
1120 1121 1122 1123 1124 1125
setting this variable, for example@footnote{For backward compatibility,
the following also works: If there are several such lines in a file,
each specifies the archive location for the text below it.  The first
such line also applies to any text before its definition.  However,
using this method is @emph{strongly} deprecated as it is incompatible
with the outline structure of the document.  The correct method for
1126
setting multiple archive locations in a buffer is using properties.}:
Glenn Morris's avatar
Glenn Morris committed
1127 1128 1129 1130 1131 1132

@example
#+ARCHIVE: %s_done::
@end example

@noindent
1133 1134
If you would like to have a special ARCHIVE location for a single entry
or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1135
location as the value (@pxref{Properties and Columns}).
Glenn Morris's avatar
Glenn Morris committed
1136

1137 1138 1139 1140 1141 1142
When a subtree is moved, it receives a number of special properties that
record context information like the file from where the entry came, it's
outline path the archiving time etc.  Configure the variable
@code{org-archive-save-context-info} to adjust the amount of information
added.

1143
@node Sparse trees, Plain lists, Archiving, Document Structure
Glenn Morris's avatar
Glenn Morris committed
1144 1145 1146 1147 1148 1149
@section Sparse trees
@cindex sparse trees
@cindex trees, sparse
@cindex folding, sparse trees
@cindex occur, command

1150 1151 1152 1153 1154 1155 1156 1157
An important feature of Org mode is the ability to construct @emph{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@footnote{See also the
variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
@code{org-show-siblings}, and @code{org-show-entry-below} for detailed
control on how much context is shown around each match.}.  Just try it out
and you will see immediately how it works.
1158

1159
Org mode contains several commands creating such trees, all these
1160
commands can be accessed through a dispatcher:
Glenn Morris's avatar