org.texi 501 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
@set VERSION 6.33x
7
@set DATE November 2009
Glenn Morris's avatar
Glenn Morris committed
8 9

@c Version and Contact Info
10
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
Glenn Morris's avatar
Glenn Morris committed
11 12
@set AUTHOR Carsten Dominik
@set MAINTAINER Carsten Dominik
13 14
@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
15 16 17 18
@c %**end of header
@finalout

@c Macro definitions
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
@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
34 35 36 37 38 39 40 41 42 43 44 45

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

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

Glenn Morris's avatar
Glenn Morris committed
48
Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation
Glenn Morris's avatar
Glenn Morris committed
49 50 51

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

58 59 60
(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.''
61 62 63 64 65

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
66 67 68
@end quotation
@end copying

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

Glenn Morris's avatar
Glenn Morris committed
74
@titlepage
75
@title The Org Manual
Glenn Morris's avatar
Glenn Morris committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

@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
98
* Document Structure::          A tree works like your brain
Glenn Morris's avatar
Glenn Morris committed
99 100
* Tables::                      Pure magic for quick formatting
* Hyperlinks::                  Notes in context
101
* TODO Items::                  Every tree branch can be a TODO item
Glenn Morris's avatar
Glenn Morris committed
102
* Tags::                        Tagging headlines and matching sets of tags
103 104
* Properties and Columns::      Storing information about an entry
* Dates and Times::             Making items useful for planning
105
* Capture - Refile - Archive::  The ins and outs for projects
106
* Agenda Views::                Collecting information into views
107
* Markup::                      Prepare text for rich export
Glenn Morris's avatar
Glenn Morris committed
108
* Exporting::                   Sharing and publishing of notes
109
* Publishing::                  Create a web site of linked Org files
Glenn Morris's avatar
Glenn Morris committed
110
* Miscellaneous::               All the rest which did not fit elsewhere
Glenn Morris's avatar
Glenn Morris committed
111
* Hacking::                     How to hack your way around
112
* MobileOrg::                   Viewing and capture on a mobile device
113 114
* 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
115
* Key Index::                   Key bindings and where they are described
116
* Variable Index::              Variables mentioned in the manual
Glenn Morris's avatar
Glenn Morris committed
117 118 119 120 121 122

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

Introduction

123 124 125
* 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
126
* Feedback::                    Bug reports, ideas, patches etc.
127
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
128 129 130

Document Structure

131 132
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
133 134 135 136 137 138
* 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
139
* Blocks::                      Folding blocks
140
* Footnotes::                   How footnotes are defined in Org's syntax
141
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
142 143 144 145

Tables

* Built-in table editor::       Simple tables
146
* Column width and alignment::  Overrule the automatic settings
Glenn Morris's avatar
Glenn Morris committed
147
* Column groups::               Grouping to trigger vertical lines
148 149
* Orgtbl mode::                 The table editor as minor mode
* The spreadsheet::             The table editor has spreadsheet capabilities
150
* Org-Plot::                    Plotting from org tables
Glenn Morris's avatar
Glenn Morris committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164

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

165
* Link format::                 How links in Org are formatted
Glenn Morris's avatar
Glenn Morris committed
166 167 168
* Internal links::              Links to other places in the current file
* External links::              URL-like links to the world
* Handling links::              Creating, inserting and following
169
* Using links outside Org::     Linking from my C source code?
Glenn Morris's avatar
Glenn Morris committed
170 171 172 173 174 175
* 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

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

178
TODO Items
Glenn Morris's avatar
Glenn Morris committed
179 180 181

* TODO basics::                 Marking and displaying TODO entries
* TODO extensions::             Workflow and assignments
182
* Progress logging::            Dates and notes for progress
Glenn Morris's avatar
Glenn Morris committed
183 184 185 186 187 188 189
* 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
190
* TODO types::                  I do this, Fred does the rest
Glenn Morris's avatar
Glenn Morris committed
191
* Multiple sets in one file::   Mixing it all, and still finding your way
192 193 194
* 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
195
* TODO dependencies::           When one task needs to wait for others
196

197
Progress logging
198 199 200

* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
201
* Tracking your habits::        How consistent have you been?
Glenn Morris's avatar
Glenn Morris committed
202 203 204 205 206 207 208 209 210 211

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
212
* Special properties::          Access to other Org mode features
Glenn Morris's avatar
Glenn Morris committed
213
* Property searches::           Matching property values
214
* Property inheritance::        Passing values down the tree
Glenn Morris's avatar
Glenn Morris committed
215 216 217
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers

218
Column view
Glenn Morris's avatar
Glenn Morris committed
219 220 221

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

224
Defining columns
Glenn Morris's avatar
Glenn Morris committed
225 226 227 228

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

229
Dates and Times
Glenn Morris's avatar
Glenn Morris committed
230

231
* Timestamps::                  Assigning a time to a tree entry
Glenn Morris's avatar
Glenn Morris committed
232 233
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
234
* Clocking work time::          Tracking how long you spend on a task
235
* Resolving idle time::         Resolving time if you've been idle
236
* Effort estimates::            Planning work effort in advance
237
* Relative timer::              Notes with a running timer
Glenn Morris's avatar
Glenn Morris committed
238 239 240

Creating timestamps

241 242
* 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
243

244
Deadlines and scheduling
Glenn Morris's avatar
Glenn Morris committed
245 246 247 248

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

249
Capture - Refile - Archive
Carsten Dominik's avatar
Carsten Dominik committed
250 251 252

* Remember::                    Capture new tasks/ideas with little interruption
* Attachments::                 Add files to tasks.
253
* RSS Feeds::                   Getting input from RSS feeds
254 255 256
* 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
Carsten Dominik's avatar
Carsten Dominik committed
257

258
Remember
Glenn Morris's avatar
Glenn Morris committed
259

260
* Setting up Remember for Org::  Some code for .emacs to get things going
261 262
* Remember templates::          Define the outline of different note types
* Storing notes::               Directly get the note to where it belongs
263 264 265 266 267

Archiving

* Moving subtrees::             Moving a tree to an archive file
* Internal archiving::          Switch off a tree but keep i in the file
Glenn Morris's avatar
Glenn Morris committed
268 269 270 271 272 273 274

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
275
* Agenda commands::             Remote editing of Org trees
Glenn Morris's avatar
Glenn Morris committed
276
* Custom agenda views::         Defining special searches and views
277
* Exporting Agenda Views::      Writing a view to a file
278
* Agenda column view::          Using column view for collected entries
Glenn Morris's avatar
Glenn Morris committed
279 280 281

The built-in agenda views

282
* Weekly/daily agenda::         The calendar page with current tasks
Glenn Morris's avatar
Glenn Morris committed
283 284 285
* Global TODO list::            All unfinished action items
* Matching tags and properties::  Structured information with fine-tuned search
* Timeline::                    Time-sorted view for single file
286
* Search view::                 Find entries by searching for text
Glenn Morris's avatar
Glenn Morris committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300
* 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

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
Markup for rich export

* 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
* Macro replacement::           Use macros to create complex output
* Embedded LaTeX::              LaTeX can be freely used inside Org documents

Structural markup elements

* 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

323
Embedded La@TeX{}
Glenn Morris's avatar
Glenn Morris committed
324

325
* Special symbols::             Greek letters and other symbols
326
* Subscripts and superscripts::  Simple syntax for raising/lowering text
Glenn Morris's avatar
Glenn Morris committed
327
* LaTeX fragments::             Complex formulas made easy
328
* Previewing LaTeX fragments::  What will this snippet look like?
Glenn Morris's avatar
Glenn Morris committed
329 330 331 332
* CDLaTeX mode::                Speed up entering of formulas

Exporting

Carsten Dominik's avatar
Carsten Dominik committed
333
* Selective export::            Using tags to select and exclude trees
334 335
* Export options::              Per-file export settings
* The export dispatcher::       How to access exporter commands
Glenn Morris's avatar
Glenn Morris committed
336 337
* ASCII export::                Exporting to plain ASCII
* HTML export::                 Exporting to HTML
338 339
* LaTeX and PDF export::        Exporting to La@TeX{}, and processing to PDF
* DocBook export::              Exporting to DocBook
340
* Freemind export::             Exporting to Freemind mind maps
Glenn Morris's avatar
Glenn Morris committed
341 342
* XOXO export::                 Exporting to XOXO
* iCalendar export::            Exporting in iCalendar format
343

Glenn Morris's avatar
Glenn Morris committed
344 345
HTML export

346
* HTML Export commands::        How to invoke HTML export
347
* Quoting HTML tags::           Using direct HTML in Org mode
348
* Links in HTML export::        How links will be interpreted and formatted
349
* Tables in HTML export::       How to modify the formatting of tables
350 351
* Images in HTML export::       How to insert figures into HTML output
* Text areas in HTML export::   An alternative way to show an example
352 353
* CSS support::                 Changing the appearance of the output
* Javascript support::          Info and Folding in a web browser
Glenn Morris's avatar
Glenn Morris committed
354

355
La@TeX{} and PDF export
Glenn Morris's avatar
Glenn Morris committed
356

Glenn Morris's avatar
Glenn Morris committed
357
* LaTeX/PDF export commands::   Which key invokes which commands
358 359 360 361 362 363 364 365 366 367 368 369 370
* Quoting LaTeX code::          Incorporating literal La@TeX{} code
* Sectioning structure::        Changing sectioning in La@TeX{} output
* Tables in LaTeX export::      Options for exporting tables to La@TeX{}
* Images in LaTeX export::      How to insert figures into La@TeX{} output

DocBook export

* 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
371 372 373 374

Publishing

* Configuration::               Defining projects
375
* Uploading files::             How to get files up on the server
Glenn Morris's avatar
Glenn Morris committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
* 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
397
* Speed keys::                  Electic commands at the beginning of a headline
398
* Customization::               Adapting Org to your taste
Glenn Morris's avatar
Glenn Morris committed
399 400 401
* 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
402
* TTY keys::                    Using Org on a tty
Glenn Morris's avatar
Glenn Morris committed
403 404 405 406
* Interaction::                 Other Emacs packages

Interaction with other packages

407
* Cooperation::                 Packages Org cooperates with
Glenn Morris's avatar
Glenn Morris committed
408 409
* Conflicts::                   Packages that lead to conflicts

410
Hacking
Glenn Morris's avatar
Glenn Morris committed
411

412 413
* Hooks::                       Who to reach into Org's internals
* Add-on packages::             Available extensions
Glenn Morris's avatar
Glenn Morris committed
414
* Adding hyperlink types::      New custom link types
415 416
* Context-sensitive commands::  How to add functionality to such commands
* Tables in arbitrary syntax::  Orgtbl for La@TeX{} and other programs
Glenn Morris's avatar
Glenn Morris committed
417 418
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
419
* Extracting agenda information::  Postprocessing of agenda information
Glenn Morris's avatar
Glenn Morris committed
420
* Using the property API::      Writing programs that use entry properties
421
* Using the mapping API::       Mapping over all or selected entries
Glenn Morris's avatar
Glenn Morris committed
422

423
Tables and lists in arbitrary syntax
Glenn Morris's avatar
Glenn Morris committed
424

425
* Radio tables::                Sending and receiving radio tables
Glenn Morris's avatar
Glenn Morris committed
426 427
* A LaTeX example::             Step by step, almost a tutorial
* Translator functions::        Copy and modify
428
* Radio lists::                 Doing the same for lists
Glenn Morris's avatar
Glenn Morris committed
429

430 431 432 433 434 435
MobileOrg

* 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

Glenn Morris's avatar
Glenn Morris committed
436 437 438
@end detailmenu
@end menu

439
@node Introduction, Document Structure, Top, Top
Glenn Morris's avatar
Glenn Morris committed
440 441 442 443
@chapter Introduction
@cindex introduction

@menu
444 445 446
* 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
447
* Feedback::                    Bug reports, ideas, patches etc.
448
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
449 450 451 452 453 454
@end menu

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

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

458 459 460
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
461 462
content of large files well structured.  Visibility cycling and
structure editing help to work with the tree.  Tables are easily created
463
with a built-in table editor.  Org supports TODO items, deadlines,
464
timestamps, and scheduling.  It dynamically compiles entries into an
Glenn Morris's avatar
Glenn Morris committed
465 466 467
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.
468
For printing and sharing of notes, an Org file can be exported as a
469
structured ASCII file, as HTML, or (TODO and agenda items only) as an
Glenn Morris's avatar
Glenn Morris committed
470
iCalendar file.  It can also serve as a publishing tool for a set of
471
linked web pages.
Glenn Morris's avatar
Glenn Morris committed
472

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

482
Org keeps simple things simple.  When first fired up, it should
Glenn Morris's avatar
Glenn Morris committed
483 484
feel like a straightforward, easy to use outliner.  Complexity is not
imposed, but a large amount of functionality is available when you need
485
it.  Org is a toolbox and can be used in different ways, for
Glenn Morris's avatar
Glenn Morris committed
486 487 488
example as:

@example
489 490 491 492 493 494 495
@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{} an ASCII table editor with spreadsheet-like capabilities}
@r{@bullet{} a TODO list editor}
@r{@bullet{} a full agenda and planner with deadlines and work scheduling}
@pindex GTD, Getting Things Done
@r{@bullet{} an environment to implement David Allen's GTD system}
Glenn Morris's avatar
Glenn Morris committed
496
@r{@bullet{} a basic database application}
497 498
@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
@r{@bullet{} a publishing tool to create a set of interlinked webpages}
Glenn Morris's avatar
Glenn Morris committed
499 500
@end example

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

@cindex FAQ
509 510
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
511
questions (FAQ), links to tutorials, etc@.  This page is located at
512
@uref{http://orgmode.org}.
Glenn Morris's avatar
Glenn Morris committed
513 514 515 516 517 518 519 520 521

@page


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

522 523 524
@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
525

526
If you have downloaded Org from the Web, either as a distribution @file{.zip}
527 528
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
529 530 531 532 533 534
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
535 536

@example
537 538 539 540 541 542 543 544 545
(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
546 547
@end example

548 549 550
@sp 2
@cartouche
XEmacs users now need to install the file @file{noutline.el} from
551
the @file{xemacs} sub-directory of the Org distribution.  Use the
552
command:
Glenn Morris's avatar
Glenn Morris committed
553 554

@example
555
     make install-noutline
Glenn Morris's avatar
Glenn Morris committed
556
@end example
557 558
@end cartouche
@sp 2
Glenn Morris's avatar
Glenn Morris committed
559

560
@noindent Now byte-compile the Lisp files with the shell command:
Glenn Morris's avatar
Glenn Morris committed
561 562 563 564 565

@example
make
@end example

566
@noindent If you are running Org from the distribution directory, this is
567 568
all.  If you want to install Org into the system directories, use (as
administrator)
Glenn Morris's avatar
Glenn Morris committed
569 570

@example
571
make install
572 573 574 575 576 577 578 579 580 581
@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
582
make install-info
583
make install-info-debian
Glenn Morris's avatar
Glenn Morris committed
584 585
@end example

586 587 588
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
589 590 591 592
@lisp
(require 'org-install)
@end lisp

593
Do not forget to activate Org as described in the following section.
594
@page
595

Glenn Morris's avatar
Glenn Morris committed
596 597 598 599
@node Activation, Feedback, Installation, Introduction
@section Activation
@cindex activation
@cindex autoload
600 601
@cindex global key bindings
@cindex key bindings, global
Glenn Morris's avatar
Glenn Morris committed
602 603

@iftex
604 605 606 607
@b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
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
Glenn Morris's avatar
Glenn Morris committed
608 609 610
documentation.}
@end iftex

611
Add the following lines to your @file{.emacs} file.  The last three lines
612
define @emph{global} keys for the commands @command{org-store-link},
613
@command{org-agenda}, and @command{org-iswitchb}---please choose suitable
614
keys yourself.
Glenn Morris's avatar
Glenn Morris committed
615 616 617 618 619 620

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

624
Furthermore, you must activate @code{font-lock-mode} in Org
Glenn Morris's avatar
Glenn Morris committed
625 626
buffers, because significant functionality depends on font-locking being
active.  You can do this with either one of the following two lines
627
(XEmacs users must use the second option):
Glenn Morris's avatar
Glenn Morris committed
628 629
@lisp
(global-font-lock-mode 1)                     ; for all buffers
630
(add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
Glenn Morris's avatar
Glenn Morris committed
631 632
@end lisp

633
@cindex Org mode, turning on
Glenn Morris's avatar
Glenn Morris committed
634
With this setup, all files with extension @samp{.org} will be put
635
into Org mode.  As an alternative, make the first line of a file look
Glenn Morris's avatar
Glenn Morris committed
636 637 638 639 640 641
like this:

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

642
@vindex org-insert-mode-line-in-empty-file
643
@noindent which will select Org mode for this buffer no matter what
Glenn Morris's avatar
Glenn Morris committed
644 645 646
the file's name is.  See also the variable
@code{org-insert-mode-line-in-empty-file}.

647 648 649 650
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
651 652 653
@lisp
(transient-mark-mode 1)
@end lisp
654 655 656
@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.
657

658
@node Feedback, Conventions, Activation, Introduction
Glenn Morris's avatar
Glenn Morris committed
659 660 661 662 663 664
@section Feedback
@cindex feedback
@cindex bug reports
@cindex maintainer
@cindex author

665
If you find problems with Org, or if you have questions, remarks, or ideas
666
about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
667 668
If you are not a member of the mailing list, your mail will be passed to the
list after a moderator has approved it.
Glenn Morris's avatar
Glenn Morris committed
669

670 671 672 673 674 675 676 677 678 679 680 681 682 683
For bug reports, please provide as much information as possible, including
the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
(@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
684 685 686 687 688 689 690 691 692 693 694

@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
695
If working with Org produces an error with a message you don't
Glenn Morris's avatar
Glenn Morris committed
696
understand, you may have hit a bug.  The best way to report this is by
697
providing, in addition to what was mentioned above, a @emph{backtrace}.
Glenn Morris's avatar
Glenn Morris committed
698 699 700 701 702
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
703 704 705
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
706
@example
707
C-u M-x org-reload RET
Glenn Morris's avatar
Glenn Morris committed
708
@end example
709 710 711
@noindent
or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
menu.
Glenn Morris's avatar
Glenn Morris committed
712 713 714 715 716 717 718 719 720 721 722 723
@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

724 725 726
@node Conventions,  , Feedback, Introduction
@section Typesetting conventions used in this manual

727
Org uses three types of keywords: TODO keywords, tags, and property
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
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

745
@node Document Structure, Tables, Introduction, Top
Glenn Morris's avatar
Glenn Morris committed
746 747 748 749
@chapter Document Structure
@cindex document structure
@cindex structure of document

750
Org is based on Outline mode and provides flexible commands to
Glenn Morris's avatar
Glenn Morris committed
751 752 753
edit the structure of the document.

@menu
754 755
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
756 757 758 759 760 761
* 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
762
* Blocks::                      Folding blocks
763
* Footnotes::                   How footnotes are defined in Org's syntax
764
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
765 766
@end menu

767
@node Outlines, Headlines, Document Structure, Document Structure
Glenn Morris's avatar
Glenn Morris committed
768 769
@section Outlines
@cindex outlines
770
@cindex Outline mode
Glenn Morris's avatar
Glenn Morris committed
771

772
Org is implemented on top of Outline mode.  Outlines allow a
Glenn Morris's avatar
Glenn Morris committed
773 774 775 776
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
777
currently being worked on.  Org greatly simplifies the use of
Glenn Morris's avatar
Glenn Morris committed
778
outlines by compressing the entire show/hide functionality into a single
779
command, @command{org-cycle}, which is bound to the @key{TAB} key.
Glenn Morris's avatar
Glenn Morris committed
780

781
@node Headlines, Visibility cycling, Outlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
782 783 784
@section Headlines
@cindex headlines
@cindex outline tree
785
@vindex org-special-ctrl-a/e
Glenn Morris's avatar
Glenn Morris committed
786 787

Headlines define the structure of an outline tree.  The headlines in
788
Org start with one or more stars, on the left margin@footnote{See
Glenn Morris's avatar
Glenn Morris committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
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
805
starters.  @ref{Clean view}, describes a setup to realize this.
Glenn Morris's avatar
Glenn Morris committed
806

807
@vindex org-cycle-separator-lines
Glenn Morris's avatar
Glenn Morris committed
808 809 810 811 812 813
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.

814
@node Visibility cycling, Motion, Headlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
815 816 817 818 819 820 821 822
@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.
823
Org uses just two commands, bound to @key{TAB} and
Glenn Morris's avatar
Glenn Morris committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
@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

841 842
@vindex org-cycle-emulate-tab
@vindex org-cycle-global-at-bob
Glenn Morris's avatar
Glenn Morris committed
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
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

865 866 867
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
868 869

@cindex show all, command
Carsten Dominik's avatar
Carsten Dominik committed
870 871 872
@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
873 874
@kindex C-c C-r
@item C-c C-r
875 876 877 878
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
879 880 881 882 883 884 885 886 887 888 889 890 891
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,
892 893 894
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
895 896 897
the previously used indirect buffer.
@end table

898 899 900 901
@vindex org-startup-folded
@cindex @code{overview}, STARTUP keyword
@cindex @code{content}, STARTUP keyword
@cindex @code{showall}, STARTUP keyword
902
@cindex @code{showeverything}, STARTUP keyword
903

904
When Emacs first visits an Org file, the global state is set to
905
OVERVIEW, i.e. only the top level headlines are visible.  This can be
Glenn Morris's avatar
Glenn Morris committed
906 907 908 909 910 911 912 913
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
914
#+STARTUP: showeverything
Glenn Morris's avatar
Glenn Morris committed
915 916
@end example

917
@cindex property, VISIBILITY
918
@noindent
Glenn Morris's avatar
Glenn Morris committed
919
Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
920 921 922 923 924 925
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}
926
Switch back to the startup visibility of the buffer, i.e. whatever is
927 928 929 930
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table

931
@node Motion, Structure editing, Visibility cycling, Document Structure
Glenn Morris's avatar
Glenn Morris committed
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
@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:
959
@vindex org-goto-auto-isearch
Glenn Morris's avatar
Glenn Morris committed
960 961 962
@example
@key{TAB}         @r{Cycle visibility.}
@key{down} / @key{up}   @r{Next/previous visible headline.}
963 964 965
@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
966 967 968 969
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.}
970
q            @r{Quit}
Glenn Morris's avatar
Glenn Morris committed
971
@end example
972 973 974
@vindex org-goto-interface
@noindent
See also the variable @code{org-goto-interface}.
Glenn Morris's avatar
Glenn Morris committed
975 976
@end table

977
@node Structure editing, Sparse trees, Motion, Document Structure
Glenn Morris's avatar
Glenn Morris committed
978 979 980 981 982 983 984 985 986
@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
987
@cindex sorting, of subtrees
Glenn Morris's avatar
Glenn Morris committed
988 989 990 991 992
@cindex subtrees, cut and paste

@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
993
@vindex org-M-RET-may-split-line
Glenn Morris's avatar
Glenn Morris committed
994 995
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
996
creation of a new headline, use a prefix argument, or first press @key{RET}
Glenn Morris's avatar
Glenn Morris committed
997 998
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
999 1000 1001 1002 1003
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
1004
used at the end of a folded subtree (i.e. behind the ellipses at the end
1005 1006
of a headline), then a headline like the current one will be inserted
after the end of the subtree.
1007 1008
@kindex C-@key{RET}
@item C-@key{RET}
1009 1010 1011
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
1012 1013
@kindex M-S-@key{RET}
@item M-S-@key{RET}
1014 1015 1016
@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
1017 1018 1019 1020 1021
@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.
1022 1023 1024 1025 1026 1027
@kindex @key{TAB}
@item @key{TAB} @r{in new, empty entry}
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.
Glenn Morris's avatar
Glenn Morris committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
@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
1049
Kill subtree, i.e. remove it from buffer but save in kill ring.
1050
With a numeric prefix argument N, kill N sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
1051 1052
@kindex C-c C-x M-w
@item C-c C-x M-w
1053 1054
Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
1055 1056 1057
@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
1058 1059
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
1060
headline marker like @samp{****}.
1061
@kindex C-y
1062
@item C-y
1063 1064
@vindex org-yank-adjusted-subtrees
@vindex org-yank-folded-subtrees
1065 1066 1067
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