org.texi 592 KB
Newer Older
1

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

Carsten Dominik's avatar
Carsten Dominik committed
7 8
@set VERSION 7.3
@set DATE November 2010
9 10 11 12 13

@c Use proper quote and backtick for code sections in PDF output
@c Cf. Texinfo manual 14.2
@set txicodequoteundirected
@set txicodequotebacktick
Glenn Morris's avatar
Glenn Morris committed
14 15

@c Version and Contact Info
16
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
Glenn Morris's avatar
Glenn Morris committed
17 18
@set AUTHOR Carsten Dominik
@set MAINTAINER Carsten Dominik
19 20
@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
21 22 23 24
@c %**end of header
@finalout

@c Macro definitions
Carsten Dominik's avatar
Carsten Dominik committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
@macro orgcmd{key,command}
@iftex
@kindex \key\
@findex \command\
@item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
@end iftex
@ifnottex
@kindex \key\
@findex \command\
@item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
@end ifnottex
@end macro

@macro orgkey{key}
@kindex \key\
@item @kbd{\key\}
@end macro

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
@iftex
@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
@end iftex
@macro Ie {}
I.e.,
@end macro
@macro ie {}
i.e.,
@end macro
@macro Eg {}
E.g.,
@end macro
@macro eg {}
e.g.,
@end macro
Glenn Morris's avatar
Glenn Morris committed
58 59 60 61 62 63 64 65 66 67 68 69

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

@copying
70
This manual is for Org version @value{VERSION}.
Glenn Morris's avatar
Glenn Morris committed
71

72 73
Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
Free Software Foundation, Inc.
Glenn Morris's avatar
Glenn Morris committed
74 75 76

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

83 84 85
(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.''
86 87 88 89 90

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
91 92 93
@end quotation
@end copying

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

Glenn Morris's avatar
Glenn Morris committed
99
@titlepage
100
@title The Org Manual
Glenn Morris's avatar
Glenn Morris committed
101 102 103

@subtitle Release @value{VERSION}
@author by Carsten Dominik
104
with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
Glenn Morris's avatar
Glenn Morris committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

@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
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
* Introduction::                Getting started
* Document Structure::          A tree works like your brain
* Tables::                      Pure magic for quick formatting
* Hyperlinks::                  Notes in context
* TODO Items::                  Every tree branch can be a TODO item
* Tags::                        Tagging headlines and matching sets of tags
* Properties and Columns::      Storing information about an entry
* Dates and Times::             Making items useful for planning
* Capture - Refile - Archive::  The ins and outs for projects
* Agenda Views::                Collecting information into views
* Markup::                      Prepare text for rich export
* Exporting::                   Sharing and publishing of 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
* MobileOrg::                   Viewing and capture on a mobile device
* 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
Carsten Dominik's avatar
Carsten Dominik committed
143
* Command and Function Index::  Command names and some internal functions
144
* Variable Index::              Variables mentioned in the manual
Glenn Morris's avatar
Glenn Morris committed
145 146 147 148 149 150

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

Introduction

151 152 153 154 155
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
* Feedback::                    Bug reports, ideas, patches etc.
* Conventions::                 Type-setting conventions in the manual
156 157 158

Document structure

159 160 161 162 163 164 165 166 167 168 169
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
* Blocks::                      Folding blocks
* Footnotes::                   How footnotes are defined in Org's syntax
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
170 171 172

Tables

173 174 175 176 177 178
* 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
Glenn Morris's avatar
Glenn Morris committed
179 180 181

The spreadsheet

182 183 184 185 186
* 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
Glenn Morris's avatar
Glenn Morris committed
187
* Editing and debugging formulas::  Fixing formulas
188 189
* Updating the table::          Recomputing all dependent fields
* Advanced features::           Field names, parameters and automatic recalc
Glenn Morris's avatar
Glenn Morris committed
190 191 192

Hyperlinks

193 194 195 196 197 198 199 200
* 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
Glenn Morris's avatar
Glenn Morris committed
201 202 203

Internal links

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

206
TODO items
Glenn Morris's avatar
Glenn Morris committed
207

208 209 210 211 212 213
* 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
Glenn Morris's avatar
Glenn Morris committed
214 215 216

Extended use of TODO keywords

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

225
Progress logging
226

227 228 229
* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
* Tracking your habits::        How consistent have you been?
Glenn Morris's avatar
Glenn Morris committed
230 231 232

Tags

233 234 235
* 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
Glenn Morris's avatar
Glenn Morris committed
236

237
Properties and columns
Glenn Morris's avatar
Glenn Morris committed
238

239 240 241 242 243 244
* Property syntax::             How properties are spelled out
* Special properties::          Access to other Org-mode features
* Property searches::           Matching property values
* Property inheritance::        Passing values down the tree
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers
Glenn Morris's avatar
Glenn Morris committed
245

246
Column view
Glenn Morris's avatar
Glenn Morris committed
247

248 249 250
* 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
Glenn Morris's avatar
Glenn Morris committed
251

252
Defining columns
Glenn Morris's avatar
Glenn Morris committed
253

254 255
* Scope of column definitions::  Where defined, where valid?
* Column attributes::           Appearance and content of a column
Glenn Morris's avatar
Glenn Morris committed
256

257
Dates and times
Glenn Morris's avatar
Glenn Morris committed
258

259 260 261 262 263 264 265
* Timestamps::                  Assigning a time to a tree entry
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
* Clocking work time::          Tracking how long you spend on a task
* Resolving idle time::         Resolving time if you've been idle
* Effort estimates::            Planning work effort in advance
* Relative timer::              Notes with a running timer
Carsten Dominik's avatar
Carsten Dominik committed
266
* Countdown timer::             Starting a countdown timer for a task
Glenn Morris's avatar
Glenn Morris committed
267 268 269

Creating timestamps

270 271
* 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
272

273
Deadlines and scheduling
Glenn Morris's avatar
Glenn Morris committed
274

275 276
* Inserting deadline/schedule::  Planning items
* Repeated tasks::              Items that show up again and again
Glenn Morris's avatar
Glenn Morris committed
277

278
Capture - Refile - Archive
Carsten Dominik's avatar
Carsten Dominik committed
279

280 281 282 283 284 285
* Capture::                     Capturing new stuff
* Attachments::                 Add files to tasks
* RSS Feeds::                   Getting input from RSS feeds
* Protocols::                   External (e.g. Browser) access to Emacs and Org
* Refiling notes::              Moving a tree from one place to another
* Archiving::                   What to do with finished projects
286 287 288

Capture

289 290 291
* 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
Carsten Dominik's avatar
Carsten Dominik committed
292

293
Capture templates
Glenn Morris's avatar
Glenn Morris committed
294

295 296
* Template elements::           What is needed for a complete template entry
* Template expansion::          Filling in information about time and context
297 298 299

Archiving

300 301
* Moving subtrees::             Moving a tree to an archive file
* Internal archiving::          Switch off a tree but keep it in the file
Glenn Morris's avatar
Glenn Morris committed
302

303
Agenda views
Glenn Morris's avatar
Glenn Morris committed
304

305 306 307 308 309 310 311 312
* 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
Glenn Morris's avatar
Glenn Morris committed
313 314 315

The built-in agenda views

316 317
* Weekly/daily agenda::         The calendar page with current tasks
* Global TODO list::            All unfinished action items
Glenn Morris's avatar
Glenn Morris committed
318
* Matching tags and properties::  Structured information with fine-tuned search
319 320 321
* Timeline::                    Time-sorted view for single file
* Search view::                 Find entries by searching for text
* Stuck projects::              Find projects you need to review
Glenn Morris's avatar
Glenn Morris committed
322 323 324

Presentation and sorting

325 326 327
* Categories::                  Not all tasks are equal
* Time-of-day specifications::  How the agenda knows the time
* Sorting of agenda items::     The order of things
Glenn Morris's avatar
Glenn Morris committed
328 329 330

Custom agenda views

331 332 333
* Storing searches::            Type once, use often
* Block agenda::                All the stuff you need in a single buffer
* Setting Options::             Changing the rules
Glenn Morris's avatar
Glenn Morris committed
334

335 336
Markup for rich export

337 338 339 340 341 342 343
* Structural markup elements::  The basic structure as seen by the exporter
* Images and tables::           Tables and Images will be included
* Literal examples::            Source code examples with special formatting
* Include files::               Include additional files into a document
* Index entries::               Making an index
* Macro replacement::           Use macros to create complex output
* Embedded LaTeX::              LaTeX can be freely used inside Org documents
344 345 346

Structural markup elements

347 348 349 350 351 352 353 354 355 356
* Document title::              Where the title is taken from
* Headings and sections::       The document structure as seen by the exporter
* Table of contents::           The if and where of the table of contents
* Initial text::                Text before the first heading?
* Lists::                       Lists
* Paragraphs::                  Paragraphs
* Footnote markup::             Footnotes
* Emphasis and monospace::      Bold, italic, etc.
* Horizontal rules::            Make a line
* Comment lines::               What will *not* be exported
357

358
Embedded La@TeX{}
Glenn Morris's avatar
Glenn Morris committed
359

360 361 362 363 364
* Special symbols::             Greek letters and other symbols
* Subscripts and superscripts::  Simple syntax for raising/lowering text
* LaTeX fragments::             Complex formulas made easy
* Previewing LaTeX fragments::  What will this snippet look like?
* CDLaTeX mode::                Speed up entering of formulas
Glenn Morris's avatar
Glenn Morris committed
365 366 367

Exporting

368 369 370 371 372 373 374 375 376 377 378
* Selective export::            Using tags to select and exclude trees
* Export options::              Per-file export settings
* The export dispatcher::       How to access exporter commands
* ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
* HTML export::                 Exporting to HTML
* LaTeX and PDF export::        Exporting to La@TeX{}, and processing to PDF
* DocBook export::              Exporting to DocBook
* TaskJuggler export::          Exporting to TaskJuggler
* Freemind export::             Exporting to Freemind mind maps
* XOXO export::                 Exporting to XOXO
* iCalendar export::            Exporting in iCalendar format
379

Glenn Morris's avatar
Glenn Morris committed
380 381
HTML export

382 383 384 385 386
* HTML Export commands::        How to invoke HTML export
* Quoting HTML tags::           Using direct HTML in Org-mode
* Links in HTML export::        How links will be interpreted and formatted
* Tables in HTML export::       How to modify the formatting of tables
* Images in HTML export::       How to insert figures into HTML output
Carsten Dominik's avatar
Carsten Dominik committed
387
* Math formatting in HTML export::  Beautiful math also on the web
388 389 390
* Text areas in HTML export::   An alternative way to show an example
* CSS support::                 Changing the appearance of the output
* JavaScript support::          Info and Folding in a web browser
Glenn Morris's avatar
Glenn Morris committed
391

392
La@TeX{} and PDF export
Glenn Morris's avatar
Glenn Morris committed
393

394 395 396 397 398 399
* LaTeX/PDF export commands::   Which key invokes which commands
* Header and sectioning::       Setting up the export file structure
* Quoting LaTeX code::          Incorporating literal La@TeX{} code
* Tables in LaTeX export::      Options for exporting tables to La@TeX{}
* Images in LaTeX export::      How to insert figures into La@TeX{} output
* Beamer class export::         Turning the file into a presentation
400 401 402

DocBook export

403 404 405 406 407 408
* DocBook export commands::     How to invoke DocBook export
* Quoting DocBook code::        Incorporating DocBook code in Org files
* Recursive sections::          Recursive sections in DocBook
* Tables in DocBook export::    Tables are exported as HTML tables
* Images in DocBook export::    How to insert figures into DocBook output
* Special characters::          How to handle special characters
Glenn Morris's avatar
Glenn Morris committed
409 410 411

Publishing

412 413 414 415
* Configuration::               Defining projects
* Uploading files::             How to get files up on the server
* Sample configuration::        Example projects
* Triggering publication::      Publication commands
Glenn Morris's avatar
Glenn Morris committed
416 417 418

Configuration

419 420 421 422 423 424 425 426
* 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?
* Sitemap::                     Generating a list of all pages
* Generating an index::         An index that reaches across pages
Glenn Morris's avatar
Glenn Morris committed
427 428 429

Sample configuration

430 431
* Simple example::              One-component publishing
* Complex example::             A multi-component publishing example
432 433 434

Working with source code

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

Header arguments

450 451
* Using header arguments::      Different ways to set header arguments
* Specific header arguments::   List of header arguments
452 453 454 455

Using header arguments

* System-wide header arguments::  Set global default values
456
* Language-specific header arguments::  Set default values by language
457 458 459
* Buffer-wide header arguments::  Set default values for a specific buffer
* Header arguments in Org-mode properties::  Set default values for a buffer or heading
* Code block specific header arguments::  The most common way to set values
Carsten Dominik's avatar
Carsten Dominik committed
460
* Header arguments in function calls::  The most specific level
461 462 463

Specific header arguments

464
* var::                         Pass arguments to code blocks
Carsten Dominik's avatar
Carsten Dominik committed
465 466
* results::                     Specify the type of results and how they will
                                be collected and handled
467
* file::                        Specify a path for file output
Carsten Dominik's avatar
Carsten Dominik committed
468 469
* dir::                         Specify the default (possibly remote)
                                directory for code block execution
470 471
* exports::                     Export code and/or results
* tangle::                      Toggle tangling and specify file name
Carsten Dominik's avatar
Carsten Dominik committed
472 473 474 475
* comments::                    Toggle insertion of comments in tangled
                                code files
* no-expand::                   Turn off variable assignment and noweb
                                expansion during tangling
476 477 478 479 480 481 482
* session::                     Preserve the state of code evaluation
* noweb::                       Toggle expansion of noweb references
* cache::                       Avoid re-evaluating unchanged code blocks
* hlines::                      Handle horizontal lines in tables
* colnames::                    Handle column names in tables
* rownames::                    Handle row names in tables
* shebang::                     Make tangled files executable
Carsten Dominik's avatar
Carsten Dominik committed
483
* eval::                        Limit evaluation of specific code blocks
Glenn Morris's avatar
Glenn Morris committed
484 485 486

Miscellaneous

487
* Completion::                  M-TAB knows what you need
Carsten Dominik's avatar
Carsten Dominik committed
488
* Easy Templates::              Quick insertion of structural elements
489 490 491 492 493 494 495 496
* Speed keys::                  Electric commands at the beginning of a headline
* Code evaluation security::    Org mode files evaluate inline code
* Customization::               Adapting Org to your taste
* In-buffer settings::          Overview of the #+KEYWORDS
* The very busy C-c C-c key::   When in doubt, press C-c C-c
* Clean view::                  Getting rid of leading stars in the outline
* TTY keys::                    Using Org on a tty
* Interaction::                 Other Emacs packages
Glenn Morris's avatar
Glenn Morris committed
497 498 499

Interaction with other packages

500 501
* Cooperation::                 Packages Org cooperates with
* Conflicts::                   Packages that lead to conflicts
Glenn Morris's avatar
Glenn Morris committed
502

503
Hacking
Glenn Morris's avatar
Glenn Morris committed
504

505 506 507 508 509 510 511
* Hooks::                       Who to reach into Org's internals
* Add-on packages::             Available extensions
* Adding hyperlink types::      New custom link types
* Context-sensitive commands::  How to add functionality to such commands
* Tables in arbitrary syntax::  Orgtbl for La@TeX{} and other programs
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
512
* Extracting agenda information::  Postprocessing of agenda information
513 514
* Using the property API::      Writing programs that use entry properties
* Using the mapping API::       Mapping over all or selected entries
Glenn Morris's avatar
Glenn Morris committed
515

516
Tables and lists in arbitrary syntax
Glenn Morris's avatar
Glenn Morris committed
517

518 519 520 521
* Radio tables::                Sending and receiving radio tables
* A LaTeX example::             Step by step, almost a tutorial
* Translator functions::        Copy and modify
* Radio lists::                 Doing the same for lists
Glenn Morris's avatar
Glenn Morris committed
522

523 524
MobileOrg

525 526 527
* Setting up the staging area::  Where to interact with the mobile device
* Pushing to MobileOrg::        Uploading Org files and agendas
* Pulling from MobileOrg::      Integrating captured and flagged items
528

Glenn Morris's avatar
Glenn Morris committed
529 530 531
@end detailmenu
@end menu

532
@node Introduction, Document Structure, Top, Top
Glenn Morris's avatar
Glenn Morris committed
533 534 535 536
@chapter Introduction
@cindex introduction

@menu
537 538 539 540 541
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
* Feedback::                    Bug reports, ideas, patches etc.
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
542 543 544 545 546 547
@end menu

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

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

551 552 553
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
554 555
content of large files well structured.  Visibility cycling and
structure editing help to work with the tree.  Tables are easily created
556
with a built-in table editor.  Org supports TODO items, deadlines,
557
timestamps, and scheduling.  It dynamically compiles entries into an
Glenn Morris's avatar
Glenn Morris committed
558 559 560
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.
561
For printing and sharing of notes, an Org file can be exported as a
562
structured ASCII file, as HTML, or (TODO and agenda items only) as an
Glenn Morris's avatar
Glenn Morris committed
563
iCalendar file.  It can also serve as a publishing tool for a set of
564
linked web pages.
Glenn Morris's avatar
Glenn Morris committed
565

566 567 568 569 570 571 572 573 574 575 576 577 578 579
As a project planning environment, Org works by adding metadata to outline
nodes.  Based on this data, specific entries can be extracted in queries and
create dynamic @i{agenda views}.

Org mode contains the Org Babel environment which allows to work with
embedded source code block in a file, to facilitate code evaluation,
documentation, and tangling.

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

581
Org keeps simple things simple.  When first fired up, it should
Glenn Morris's avatar
Glenn Morris committed
582 583
feel like a straightforward, easy to use outliner.  Complexity is not
imposed, but a large amount of functionality is available when you need
584 585
it.  Org is a toolbox and can be used in different ways and for different
ends, for example:
Glenn Morris's avatar
Glenn Morris committed
586 587

@example
588 589 590 591 592
@r{@bullet{} an outline extension with visibility cycling and structure editing}
@r{@bullet{} an ASCII system and table editor for taking structured notes}
@r{@bullet{} a TODO list editor}
@r{@bullet{} a full agenda and planner with deadlines and work scheduling}
@pindex GTD, Getting Things Done
593
@r{@bullet{} an environment in which to implement David Allen's GTD system}
594 595
@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
@r{@bullet{} a publishing tool to create a set of interlinked webpages}
596
@r{@bullet{} an environment for literate programming}
Glenn Morris's avatar
Glenn Morris committed
597 598 599 600
@end example


@cindex FAQ
601 602
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
603
questions (FAQ), links to tutorials, etc@.  This page is located at
604
@uref{http://orgmode.org}.
Glenn Morris's avatar
Glenn Morris committed
605 606 607 608 609 610 611 612 613

@page


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

614 615 616
@b{Important:} @i{If you are using a version of Org that is part of the Emacs
distribution or an XEmacs package, please skip this section and go directly
to @ref{Activation}.}
Glenn Morris's avatar
Glenn Morris committed
617

618
If you have downloaded Org from the Web, either as a distribution @file{.zip}
619 620
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
621 622 623 624 625 626
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
627 628

@example
629 630 631 632 633 634 635 636 637
(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
638 639
@end example

640
@noindent Now byte-compile the Lisp files with the shell command:
Glenn Morris's avatar
Glenn Morris committed
641 642 643 644 645

@example
make
@end example

646
@noindent If you are running Org from the distribution directory, this is
647 648
all.  If you want to install Org into the system directories, use (as
administrator)
Glenn Morris's avatar
Glenn Morris committed
649 650

@example
651
make install
652 653 654 655 656 657 658 659 660 661
@end example

Installing Info files is system dependent, because of differences in the
@file{install-info} program.  In Debian it copies the info files into the
correct directory and modifies the info directory file.  In many other
systems, the files need to be copied to the correct directory separately, and
@file{install-info} then only modifies the directory file.  Check your system
documentation to find out which of the following commands you need:

@example
Glenn Morris's avatar
Glenn Morris committed
662
make install-info
663
make install-info-debian
Glenn Morris's avatar
Glenn Morris committed
664 665
@end example

666 667 668
Then add the following line to @file{.emacs}.  It is needed so that
Emacs can autoload functions that are located in files not immediately loaded
when Org-mode starts.
Glenn Morris's avatar
Glenn Morris committed
669 670 671 672
@lisp
(require 'org-install)
@end lisp

673
Do not forget to activate Org as described in the following section.
674
@page
675

Glenn Morris's avatar
Glenn Morris committed
676 677 678 679
@node Activation, Feedback, Installation, Introduction
@section Activation
@cindex activation
@cindex autoload
680 681
@cindex global key bindings
@cindex key bindings, global
Glenn Morris's avatar
Glenn Morris committed
682

683
Add the following lines to your @file{.emacs} file.  The last three lines
684
define @emph{global} keys for the commands @command{org-store-link},
685
@command{org-agenda}, and @command{org-iswitchb}---please choose suitable
686
keys yourself.
Glenn Morris's avatar
Glenn Morris committed
687 688 689 690 691 692

@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)
693
(global-set-key "\C-cb" 'org-iswitchb)
Glenn Morris's avatar
Glenn Morris committed
694 695
@end lisp

696
Furthermore, you must activate @code{font-lock-mode} in Org
Glenn Morris's avatar
Glenn Morris committed
697 698
buffers, because significant functionality depends on font-locking being
active.  You can do this with either one of the following two lines
699
(XEmacs users must use the second option):
Glenn Morris's avatar
Glenn Morris committed
700 701
@lisp
(global-font-lock-mode 1)                     ; for all buffers
702
(add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
Glenn Morris's avatar
Glenn Morris committed
703 704
@end lisp

705
@cindex Org-mode, turning on
Glenn Morris's avatar
Glenn Morris committed
706
With this setup, all files with extension @samp{.org} will be put
707
into Org-mode.  As an alternative, make the first line of a file look
Glenn Morris's avatar
Glenn Morris committed
708 709 710 711 712 713
like this:

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

714
@vindex org-insert-mode-line-in-empty-file
715
@noindent which will select Org-mode for this buffer no matter what
Glenn Morris's avatar
Glenn Morris committed
716 717 718
the file's name is.  See also the variable
@code{org-insert-mode-line-in-empty-file}.

719 720 721 722
Many commands in Org work on the region if the region is @i{active}.  To make
use 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
723 724 725
@lisp
(transient-mark-mode 1)
@end lisp
726 727 728
@noindent If you do not like @code{transient-mark-mode}, you can create an
active region by using the mouse to select a region, or pressing
@kbd{C-@key{SPC}} twice before moving the cursor.
729

730
@node Feedback, Conventions, Activation, Introduction
Glenn Morris's avatar
Glenn Morris committed
731 732 733 734 735 736
@section Feedback
@cindex feedback
@cindex bug reports
@cindex maintainer
@cindex author

737
If you find problems with Org, or if you have questions, remarks, or ideas
738
about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
739
If you are not a member of the mailing list, your mail will be passed to the
Carsten Dominik's avatar
Carsten Dominik committed
740 741 742 743 744 745 746 747 748
list after a moderator has approved it@footnote{Please consider subscribing
to the mailing list, in order to minimize the work the mailing list
moderators have to do.}.

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 (@kbd{M-x emacs-version @key{RET}}) and Org
749 750 751 752 753 754 755 756 757 758 759 760
(@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
@file{.emacs}.  The easiest way to do this is to use the command
@example
@kbd{M-x org-submit-bug-report}
@end example
@noindent which will put all this information into an Emacs mail buffer so
that you only need to add your description.  If you re not sending the Email
from within Emacs, please copy and paste the content into your Email program.

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:
Glenn Morris's avatar
Glenn Morris committed
761 762 763 764 765 766

@enumerate
@item What exactly did you do?
@item What did you expect to happen?
@item What happened instead?
@end enumerate
Carsten Dominik's avatar
Carsten Dominik committed
767
@noindent Thank you for helping to improve this program.
Glenn Morris's avatar
Glenn Morris committed
768 769 770 771

@subsubheading How to create a useful backtrace

@cindex backtrace of an error
772
If working with Org produces an error with a message you don't
Glenn Morris's avatar
Glenn Morris committed
773
understand, you may have hit a bug.  The best way to report this is by
774
providing, in addition to what was mentioned above, a @emph{backtrace}.
Glenn Morris's avatar
Glenn Morris committed
775 776 777 778 779
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
780 781 782
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
Glenn Morris's avatar
Glenn Morris committed
783
@example
784
C-u M-x org-reload RET
Glenn Morris's avatar
Glenn Morris committed
785
@end example
786 787 788
@noindent
or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
menu.
Glenn Morris's avatar
Glenn Morris committed
789 790 791 792 793 794 795 796 797 798 799 800
@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

801 802 803
@node Conventions,  , Feedback, Introduction
@section Typesetting conventions used in this manual

804
Org uses three types of keywords: TODO keywords, tags, and property
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
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

822
@node Document Structure, Tables, Introduction, Top
823
@chapter Document structure
Glenn Morris's avatar
Glenn Morris committed
824 825 826
@cindex document structure
@cindex structure of document

827
Org is based on Outline mode and provides flexible commands to
Glenn Morris's avatar
Glenn Morris committed
828 829 830
edit the structure of the document.

@menu
831 832 833 834 835 836 837 838 839 840 841
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
* Blocks::                      Folding blocks
* Footnotes::                   How footnotes are defined in Org's syntax
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
842 843
@end menu

844
@node Outlines, Headlines, Document Structure, Document Structure
Glenn Morris's avatar
Glenn Morris committed
845 846
@section Outlines
@cindex outlines
847
@cindex Outline mode
Glenn Morris's avatar
Glenn Morris committed
848

849
Org is implemented on top of Outline mode.  Outlines allow a
Glenn Morris's avatar
Glenn Morris committed
850 851 852 853
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
854
currently being worked on.  Org greatly simplifies the use of
Glenn Morris's avatar
Glenn Morris committed
855
outlines by compressing the entire show/hide functionality into a single
856
command, @command{org-cycle}, which is bound to the @key{TAB} key.
Glenn Morris's avatar
Glenn Morris committed
857

858
@node Headlines, Visibility cycling, Outlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
859 860 861
@section Headlines
@cindex headlines
@cindex outline tree
862
@vindex org-special-ctrl-a/e
863 864
@vindex org-special-ctrl-k
@vindex org-ctrl-k-protect-subtree
Glenn Morris's avatar
Glenn Morris committed
865

866 867 868 869 870
Headlines define the structure of an outline tree.  The headlines in Org
start with one or more stars, on the left margin@footnote{See the variables
@code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
@code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
@kbd{C-e}, and @kbd{C-k} in headlines.}.  For example:
Glenn Morris's avatar
Glenn Morris committed
871 872 873 874 875 876 877 878 879 880 881 882 883 884

@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
885
starters.  @ref{Clean view}, describes a setup to realize this.
Glenn Morris's avatar
Glenn Morris committed
886

887
@vindex org-cycle-separator-lines
Glenn Morris's avatar
Glenn Morris committed
888 889 890 891 892 893
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.

894
@node Visibility cycling, Motion, Headlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
895 896 897 898 899 900 901 902
@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.
903
Org uses just two commands, bound to @key{TAB} and
Glenn Morris's avatar
Glenn Morris committed
904 905 906 907 908 909 910
@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
Carsten Dominik's avatar
Carsten Dominik committed
911 912
@table @asis
@orgcmd{@key{TAB},org-cycle}
Glenn Morris's avatar
Glenn Morris committed
913 914 915 916 917 918 919
@emph{Subtree cycling}: Rotate current subtree among the states

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

920 921
@vindex org-cycle-emulate-tab
@vindex org-cycle-global-at-bob
Glenn Morris's avatar
Glenn Morris committed
922 923 924 925 926 927 928 929 930 931 932 933
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
Carsten Dominik's avatar
Carsten Dominik committed
934
@orgcmd{S-@key{TAB},org-global-cycle}
Glenn Morris's avatar
Glenn Morris committed
935 936 937 938 939 940 941 942
@itemx C-u @key{TAB}
@emph{Global cycling}: Rotate the entire buffer among the states

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

943 944 945
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
946 947

@cindex show all, command
Carsten Dominik's avatar
Carsten Dominik committed
948
@orgcmd{C-u C-u C-u @key{TAB},show-all}
Carsten Dominik's avatar
Carsten Dominik committed
949
Show all, including drawers.
Carsten Dominik's avatar
Carsten Dominik committed
950
@orgcmd{C-c C-r,org-reveal}
951 952 953 954
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
955 956
level, all sibling headings.  With double prefix arg, also show the entire
subtree of the parent.
Carsten Dominik's avatar
Carsten Dominik committed
957
@orgcmd{C-c C-k,show-branches}
958
Expose all the headings of the subtree, CONTENT view for just one subtree.
Carsten Dominik's avatar
Carsten Dominik committed
959
@orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
Glenn Morris's avatar
Glenn Morris committed
960 961 962 963 964 965 966 967 968 969
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,
970 971 972
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
973 974 975
the previously used indirect buffer.
@end table

976 977 978 979
@vindex org-startup-folded
@cindex @code{overview}, STARTUP keyword
@cindex @code{content}, STARTUP keyword
@cindex @code{showall}, STARTUP keyword
980
@cindex @code{showeverything}, STARTUP keyword
981

982
When Emacs first visits an Org file, the global state is set to
983
OVERVIEW, i.e. only the top level headlines are visible.  This can be
Glenn Morris's avatar
Glenn Morris committed
984 985 986 987 988 989 990 991
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
992
#+STARTUP: showeverything
Glenn Morris's avatar
Glenn Morris committed
993 994
@end example

995
@cindex property, VISIBILITY
996
@noindent
Glenn Morris's avatar
Glenn Morris committed
997
Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
998 999 1000
and Columns}) will get their visibility adapted accordingly.  Allowed values
for this property are @code{folded}, @code{children}, @code{content}, and
@code{all}.
Carsten Dominik's avatar
Carsten Dominik committed
1001 1002
@table @asis
@orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1003
Switch back to the startup visibility of the buffer, i.e. whatever is
1004 1005 1006 1007
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table

1008
@node Motion, Structure editing, Visibility cycling, Document Structure
Glenn Morris's avatar
Glenn Morris committed
1009 1010 1011 1012 1013 1014
@section Motion
@cindex motion, between headlines
@cindex jumping, to headlines
@cindex headline navigation
The following commands jump to other headlines in the buffer.

Carsten Dominik's avatar
Carsten Dominik committed
1015 1016
@table @asis
@orgcmd{C-c C-n,outline-next-visible-heading}
Glenn Morris's avatar
Glenn Morris committed
1017
Next heading.
Carsten Dominik's avatar
Carsten Dominik committed
1018
@orgcmd{C-c C-p,outline-previous-visible-heading}
Glenn Morris's avatar
Glenn Morris committed
1019
Previous heading.
Carsten Dominik's avatar
Carsten Dominik committed
1020
@orgcmd{C-c C-f,org-forward-same-level}
Glenn Morris's avatar
Glenn Morris committed
1021
Next heading same level.
Carsten Dominik's avatar
Carsten Dominik committed
1022
@orgcmd{C-c C-b,org-backward-same-level}
Glenn Morris's avatar
Glenn Morris committed
1023
Previous heading same level.
Carsten Dominik's avatar
Carsten Dominik committed
1024
@orgcmd{C-c C-u,outline-up-heading}
Glenn Morris's avatar
Glenn Morris committed
1025
Backward to higher level heading.
Carsten Dominik's avatar
Carsten Dominik committed
1026
@orgcmd{C-c C-j,org-goto}
Glenn Morris's avatar
Glenn Morris committed
1027 1028 1029
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:
1030
@vindex org-goto-auto-isearch
Glenn Morris's avatar
Glenn Morris committed
1031 1032 1033
@example
@key{TAB}         @r{Cycle visibility.}
@key{down} / @key{up}   @r{Next/previous visible headline.}
1034 1035 1036
@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
1037 1038 1039 1040
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.}
1041
q            @r{Quit}
Glenn Morris's avatar
Glenn Morris committed
1042
@end example
1043 1044 1045
@vindex org-goto-interface
@noindent
See also the variable @code{org-goto-interface}.
Glenn Morris's avatar
Glenn Morris committed
1046 1047
@end table

1048
@node Structure editing, Sparse trees, Motion, Document Structure
Glenn Morris's avatar
Glenn Morris committed
1049 1050 1051 1052 1053 1054 1055 1056 1057
@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
1058
@cindex sorting, of subtrees
Glenn Morris's avatar
Glenn Morris committed
1059 1060
@cindex subtrees, cut and paste

Carsten Dominik's avatar
Carsten Dominik committed
1061 1062
@table @asis
@orgcmd{M-@key{RET},org-insert-heading}
1063
@vindex org-M-RET-may-split-line
Glenn Morris's avatar
Glenn Morris committed
1064 1065
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
1066
creation of a new headline, use a prefix argument, or first press @key{RET}
Glenn Morris's avatar
Glenn Morris committed
1067 1068
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
1069 1070 1071 1072 1073
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
1074
used at the end of a folded subtree (i.e. behind the ellipses at the end
1075 1076
of a headline), then a headline like the current one will be inserted
after the end of the subtree.
Carsten Dominik's avatar
Carsten Dominik committed
1077
@orgcmd{C-@key{RET},org-insert-heading-respect-content}
1078 1079 1080
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.
Carsten Dominik's avatar
Carsten Dominik committed
1081
@orgcmd{M-S-@key{RET},org-insert-todo-heading}
1082 1083 1084
@vindex org-treat-insert-todo-heading-as-state-change
Insert new TODO entry with same level as current heading.  See also the
variable @code{org-treat-insert-todo-heading-as-state-change}.
Carsten Dominik's avatar
Carsten Dominik committed
1085
@orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
Carsten Dominik's avatar
Carsten Dominik committed
1086 1087 1088
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.
Carsten Dominik's avatar
Carsten Dominik committed
1089
@orgcmd{@key{TAB},org-cycle}
1090 1091 1092 1093
In a new entry with no text yet, the first @key{TAB} demotes the entry to
become a child of the previous one.  The next @key{TAB} makes it a parent,
and so on, all the way to top level.  Yet another @key{TAB}, and you are back
to the initial level.
Carsten Dominik's avatar
Carsten Dominik committed
1094
@orgcmd{M-@key{left},org-do-promote}