Merge branch 'maint'
[org-mode.git] / doc / orgguide.texi
blobcacca3cf20fc894cad019a56320becaf4d9181b9
1 \input texinfo
2 @c %**start of header
3 @setfilename ../../info/orgguide
4 @settitle The compact Org-mode Guide
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Carsten Dominik
17 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
18 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
19 @c %**end of header
20 @finalout
22 @c Macro definitions
23 @iftex
24 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
25 @end iftex
27 @c Subheadings inside a table.
28 @macro tsubheading{text}
29 @ifinfo
30 @subsubheading \text\
31 @end ifinfo
32 @ifnotinfo
33 @item @b{\text\}
34 @end ifnotinfo
35 @end macro
37 @macro seealso{text}
38 @noindent @b{Further reading}@*@noindent \text\
39 @end macro
40 @copying
42 Copyright @copyright{} 2010--2014 Free Software Foundation
44 @quotation
45 Permission is granted to copy, distribute and/or modify this document
46 under the terms of the GNU Free Documentation License, Version 1.3 or
47 any later version published by the Free Software Foundation; with no
48 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
49 and with the Back-Cover Texts as in (a) below.  A copy of the license
50 is included in the section entitled ``GNU Free Documentation License''
51 in the full Org manual, which is distributed together with the compact
52 guide.
54 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
55 modify this GNU manual.''
56 @end quotation
57 @end copying
59 @dircategory Emacs
60 @direntry
61 * Org Mode Guide: (orgguide).  Abbreviated Org-mode Manual
62 @end direntry
64 @titlepage
65 @title The compact Org-mode Guide
67 @subtitle Release @value{VERSION}
68 @author by Carsten Dominik
70 @c The following two commands start the copyright page.
71 @page
72 @vskip 0pt plus 1filll
73 @insertcopying
74 @end titlepage
76 @c Output the table of contents at the beginning.
77 @shortcontents
79 @ifnottex
80 @node Top, Introduction, (dir), (dir)
81 @top Org Mode Guide
83 @insertcopying
84 @end ifnottex
86 @menu
87 * Introduction::                Getting started
88 * Document Structure::          A tree works like your brain
89 * Tables::                      Pure magic for quick formatting
90 * Hyperlinks::                  Notes in context
91 * TODO Items::                  Every tree branch can be a TODO item
92 * Tags::                        Tagging headlines and matching sets of tags
93 * Properties::                  Properties
94 * Dates and Times::             Making items useful for planning
95 * Capture - Refile - Archive::  The ins and outs for projects
96 * Agenda Views::                Collecting information into views
97 * Markup::                      Prepare text for rich export
98 * Exporting::                   Sharing and publishing of notes
99 * Publishing::                  Create a web site of linked Org files
100 * Working With Source Code::    Source code snippets embedded in Org
101 * Miscellaneous::               All the rest which did not fit elsewhere
103 * GNU Free Documentation License::  This manual license.
105 @detailmenu
106  --- The Detailed Node Listing ---
108 Introduction
110 * Preface::                     Welcome
111 * Installation::                How to install a downloaded version of Org
112 * Activation::                  How to activate Org for certain buffers
113 * Feedback::                    Bug reports, ideas, patches etc.
115 Document Structure
117 * Outlines::                    Org is based on Outline mode
118 * Headlines::                   How to typeset Org tree headlines
119 * Visibility cycling::          Show and hide, much simplified
120 * Motion::                      Jumping to other headlines
121 * Structure editing::           Changing sequence and level of headlines
122 * Sparse trees::                Matches embedded in context
123 * Plain lists::                 Additional structure within an entry
124 * Footnotes::                   How footnotes are defined in Org's syntax
126 Hyperlinks
128 * Link format::                 How links in Org are formatted
129 * Internal links::              Links to other places in the current file
130 * External links::              URL-like links to the world
131 * Handling links::              Creating, inserting and following
132 * Targeted links::              Point at a location in a file
134 TODO Items
136 * Using TODO states::           Setting and switching states
137 * Multi-state workflows::       More than just on/off
138 * Progress logging::            Dates and notes for progress
139 * Priorities::                  Some things are more important than others
140 * Breaking down tasks::         Splitting a task into manageable pieces
141 * Checkboxes::                  Tick-off lists
143 Progress logging
145 * Closing items::               When was this entry marked DONE?
146 * Tracking TODO state changes::  When did the status change?
148 Tags
150 * Tag inheritance::             Tags use the tree structure of the outline
151 * Setting tags::                How to assign tags to a headline
152 * Tag groups::                  Use one tag to search for several tags
153 * Tag searches::                Searching for combinations of tags
155 Dates and Times
157 * Timestamps::                  Assigning a time to a tree entry
158 * Creating timestamps::         Commands which insert timestamps
159 * Deadlines and scheduling::    Planning your work
160 * Clocking work time::          Tracking how long you spend on a task
162 Capture - Refile - Archive
164 * Capture::                     Capturing new stuff
165 * Refile and copy::             Moving a tree from one place to another
166 * Archiving::                   What to do with finished projects
168 Capture
170 * Setting up a capture location::  Where notes will be stored
171 * Using capture::               Commands to invoke and terminate capture
172 * Capture templates::           Define the outline of different note types
174 Agenda Views
176 * Agenda files::                Files being searched for agenda information
177 * Agenda dispatcher::           Keyboard access to agenda views
178 * Built-in agenda views::       What is available out of the box?
179 * Agenda commands::             Remote editing of Org trees
180 * Custom agenda views::         Defining special searches and views
182 The built-in agenda views
184 * Weekly/daily agenda::         The calendar page with current tasks
185 * Global TODO list::            All unfinished action items
186 * Matching tags and properties::  Structured information with fine-tuned search
187 * Timeline::                    Time-sorted view for single file
188 * Search view::                 Find entries by searching for text
190 Markup for rich export
192 * Structural markup elements::  The basic structure as seen by the exporter
193 * Images and tables::           Images, tables and caption mechanism
194 * Literal examples::            Source code examples with special formatting
195 * Include files::               Include additional files into a document
196 * Embedded @LaTeX{}::           @LaTeX{} can be freely used inside Org documents
198 Structural markup elements
200 * Document title::              Where the title is taken from
201 * Headings and sections::       The document structure as seen by the exporter
202 * Table of contents::           The if and where of the table of contents
203 * Paragraphs::                  Paragraphs
204 * Emphasis and monospace::      Bold, italic, etc.
205 * Comment lines::               What will *not* be exported
207 Exporting
209 * Export options::              Per-file export settings
210 * The export dispatcher::       How to access exporter commands
211 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
212 * HTML export::                 Exporting to HTML
213 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
214 * iCalendar export::            Exporting to iCalendar
216 Miscellaneous
218 * Completion::                  M-TAB knows what you need
219 * Clean view::                  Getting rid of leading stars in the outline
220 * MobileOrg::                   Org-mode on the iPhone
222 @end detailmenu
223 @end menu
225 @node Introduction, Document Structure, Top, Top
226 @chapter Introduction
228 @menu
229 * Preface::                     Welcome
230 * Installation::                How to install a downloaded version of Org
231 * Activation::                  How to activate Org for certain buffers
232 * Feedback::                    Bug reports, ideas, patches etc.
233 @end menu
235 @node Preface, Installation, Introduction, Introduction
236 @section Preface
238 Org is a mode for keeping notes, maintaining TODO lists, and doing project
239 planning with a fast and effective plain-text system.  It is also an
240 authoring and publishing system, and it supports working with source code for
241 literal programming and reproducible research.
243 @i{This document is a much compressed derivative of the
244 @uref{http://orgmode.org/index.html#sec-4_1, comprehensive Org-mode manual}.
245 It contains all basic features and commands, along with important hints for
246 customization.  It is intended for beginners who would shy back from a 200
247 page manual because of sheer size.}
249 @node Installation, Activation, Preface, Introduction
250 @section Installation
252 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
253 distribution or an XEmacs package, please skip this section and go directly
254 to @ref{Activation}.}
256 If you have downloaded Org from the Web, either as a distribution @file{.zip}
257 or @file{.tar} file, or as a Git archive, it is best to run it directly from
258 the distribution directory.  You need to add the @file{lisp} subdirectories
259 to the Emacs load path.  To do this, add the following line to @file{.emacs}:
261 @smallexample
262 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
263 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
264 @end smallexample
266 @noindent If you have been using git or a tar ball to get Org, you need to
267 run the following command to generate autoload information.
268 command:
270 @smallexample
271 make autoloads
272 @end smallexample
274 @node Activation, Feedback, Installation, Introduction
275 @section Activation
277 Add the following lines to your @file{.emacs} file.  The last four lines
278 define @emph{global} keys for some commands --- please choose suitable keys
279 yourself.
281 @smalllisp
282 ;; The following lines are always needed.  Choose your own keys.
283 (global-set-key "\C-cl" 'org-store-link)
284 (global-set-key "\C-ca" 'org-agenda)
285 (global-set-key "\C-cc" 'org-capture)
286 (global-set-key "\C-cb" 'org-iswitchb)
287 @end smalllisp
289 Files with extension @samp{.org} will be put into Org mode automatically.
291 @node Feedback,  , Activation, Introduction
292 @section Feedback
294 If you find problems with Org, or if you have questions, remarks, or ideas
295 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
296 For information on how to submit bug reports, see the main manual.
298 @node Document Structure, Tables, Introduction, Top
299 @chapter Document Structure
301 Org is based on Outline mode and provides flexible commands to
302 edit the structure of the document.
304 @menu
305 * Outlines::                    Org is based on Outline mode
306 * Headlines::                   How to typeset Org tree headlines
307 * Visibility cycling::          Show and hide, much simplified
308 * Motion::                      Jumping to other headlines
309 * Structure editing::           Changing sequence and level of headlines
310 * Sparse trees::                Matches embedded in context
311 * Plain lists::                 Additional structure within an entry
312 * Footnotes::                   How footnotes are defined in Org's syntax
313 @end menu
315 @node Outlines, Headlines, Document Structure, Document Structure
316 @section Outlines
318 Org is implemented on top of Outline mode.  Outlines allow a
319 document to be organized in a hierarchical structure, which (at least
320 for me) is the best representation of notes and thoughts.  An overview
321 of this structure is achieved by folding (hiding) large parts of the
322 document to show only the general document structure and the parts
323 currently being worked on.  Org greatly simplifies the use of
324 outlines by compressing the entire show/hide functionality into a single
325 command, @command{org-cycle}, which is bound to the @key{TAB} key.
327 @node Headlines, Visibility cycling, Outlines, Document Structure
328 @section Headlines
330 Headlines define the structure of an outline tree.  The headlines in
331 Org start with one or more stars, on the left margin@footnote{See
332 the variable @code{org-special-ctrl-a/e} to configure special behavior
333 of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:
335 @smallexample
336 * Top level headline
337 ** Second level
338 *** 3rd level
339     some text
340 *** 3rd level
341     more text
343 * Another top level headline
344 @end smallexample
346 @noindent Some people find the many stars too noisy and would prefer an
347 outline that has whitespace followed by a single star as headline
348 starters.  @ref{Clean view}, describes a setup to realize this.
350 @node Visibility cycling, Motion, Headlines, Document Structure
351 @section Visibility cycling
353 Outlines make it possible to hide parts of the text in the buffer.
354 Org uses just two commands, bound to @key{TAB} and
355 @kbd{S-@key{TAB}} to change the visibility in the buffer.
357 @table @kbd
358 @item @key{TAB}
359 @emph{Subtree cycling}: Rotate current subtree among the states
361 @smallexample
362 ,-> FOLDED -> CHILDREN -> SUBTREE --.
363 '-----------------------------------'
364 @end smallexample
366 When called with a prefix argument (@kbd{C-u @key{TAB}}) or with the shift
367 key, global cycling is invoked.
369 @item S-@key{TAB} @r{and} C-u @key{TAB}
370 @emph{Global cycling}: Rotate the entire buffer among the states
372 @smallexample
373 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
374 '--------------------------------------'
375 @end smallexample
377 @item C-u C-u C-u @key{TAB}
378 Show all, including drawers.
379 @end table
381 When Emacs first visits an Org file, the global state is set to
382 OVERVIEW, i.e.@: only the top level headlines are visible.  This can be
383 configured through the variable @code{org-startup-folded}, or on a
384 per-file basis by adding a startup keyword @code{overview}, @code{content},
385 @code{showall}, like this:
387 @smallexample
388 #+STARTUP: content
389 @end smallexample
392 @node Motion, Structure editing, Visibility cycling, Document Structure
393 @section Motion
394 The following commands jump to other headlines in the buffer.
396 @table @kbd
397 @item C-c C-n
398 Next heading.
399 @item C-c C-p
400 Previous heading.
401 @item C-c C-f
402 Next heading same level.
403 @item C-c C-b
404 Previous heading same level.
405 @item C-c C-u
406 Backward to higher level heading.
407 @end table
409 @node Structure editing, Sparse trees, Motion, Document Structure
410 @section Structure editing
412 @table @kbd
413 @item M-@key{RET}
414 Insert new heading with same level as current.  If the cursor is in a plain
415 list item, a new item is created (@pxref{Plain lists}).  When this command is
416 used in the middle of a line, the line is split and the rest of the line
417 becomes the new headline@footnote{If you do not want the line to be split,
418 customize the variable @code{org-M-RET-may-split-line}.}.
419 @item M-S-@key{RET}
420 Insert new TODO entry with same level as current heading.
421 @item @key{TAB} @r{in new, empty entry}
422 In a new entry with no text yet, @key{TAB} will cycle through reasonable
423 levels.
424 @item M-@key{left}@r{/}@key{right}
425 Promote/demote current heading by one level.
426 @item M-S-@key{left}@r{/}@key{right}
427 Promote/demote the current subtree by one level.
428 @item M-S-@key{up}@r{/}@key{down}
429 Move subtree up/down (swap with previous/next subtree of same
430 level).
431 @item C-c C-w
432 Refile entry or region to a different location.  @xref{Refile and copy}.
433 @item C-x n s/w
434 Narrow buffer to current subtree / widen it again
435 @end table
437 When there is an active region (Transient Mark mode), promotion and
438 demotion work on all headlines in the region.
440 @node Sparse trees, Plain lists, Structure editing, Document Structure
441 @section Sparse trees
443 An important feature of Org mode is the ability to construct @emph{sparse
444 trees} for selected information in an outline tree, so that the entire
445 document is folded as much as possible, but the selected information is made
446 visible along with the headline structure above it@footnote{See also the
447 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
448 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
449 control on how much context is shown around each match.}.  Just try it out
450 and you will see immediately how it works.
452 Org mode contains several commands creating such trees, all these
453 commands can be accessed through a dispatcher:
455 @table @kbd
456 @item C-c /
457 This prompts for an extra key to select a sparse-tree creating command.
458 @item C-c / r
459 Occur.  Prompts for a regexp and shows a sparse tree with all matches.  Each
460 match is also highlighted; the highlights disappear by pressing @kbd{C-c C-c}.
461 @end table
463 The other sparse tree commands select headings based on TODO keywords,
464 tags, or properties and will be discussed later in this manual.
466 @node Plain lists, Footnotes, Sparse trees, Document Structure
467 @section Plain lists
469 Within an entry of the outline tree, hand-formatted lists can provide
470 additional structure.  They also provide a way to create lists of
471 checkboxes (@pxref{Checkboxes}).  Org supports editing such lists,
472 and the HTML exporter (@pxref{Exporting}) parses and formats them.
474 Org knows ordered lists, unordered lists, and description lists.
475 @itemize @bullet
476 @item
477 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
478 @samp{*} as bullets.
479 @item
480 @emph{Ordered} list items start with @samp{1.} or @samp{1)}.
481 @item
482 @emph{Description} list use @samp{ :: } to separate the @emph{term} from the
483 description.
484 @end itemize
486 Items belonging to the same list must have the same indentation on the first
487 line.  An item ends before the next line that is indented like its
488 bullet/number, or less.  A list ends when all items are closed, or before two
489 blank lines.  An example:
491 @smallexample
492 @group
493 ** Lord of the Rings
494    My favorite scenes are (in this order)
495    1. The attack of the Rohirrim
496    2. Eowyn's fight with the witch king
497       + this was already my favorite scene in the book
498       + I really like Miranda Otto.
499    Important actors in this film are:
500    - @b{Elijah Wood} :: He plays Frodo
501    - @b{Sean Austin} :: He plays Sam, Frodo's friend.
502 @end group
503 @end smallexample
505 The following commands act on items when the cursor is in the first line of
506 an item (the line with the bullet or number).
508 @table @kbd
509 @item @key{TAB}
510 Items can be folded just like headline levels.
511 @item M-@key{RET}
512 Insert new item at current level.  With a prefix argument, force a new
513 heading (@pxref{Structure editing}).
514 @item M-S-@key{RET}
515 Insert a new item with a checkbox (@pxref{Checkboxes}).
516 @item M-S-@key{up}@r{/}@key{down}
517 Move the item including subitems up/down (swap with previous/next item
518 of same indentation).  If the list is ordered, renumbering is
519 automatic.
520 @item M-@key{left}@r{/}M-@key{right}
521 Decrease/increase the indentation of an item, leaving children alone.
522 @item M-S-@key{left}@r{/}@key{right}
523 Decrease/increase the indentation of the item, including subitems.
524 @item C-c C-c
525 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
526 state of the checkbox.  Also verify bullets and indentation consistency in
527 the whole list.
528 @item C-c -
529 Cycle the entire list level through the different itemize/enumerate bullets
530 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
531 @end table
533 @node Footnotes,  , Plain lists, Document Structure
534 @section Footnotes
536 A footnote is defined in a paragraph that is started by a footnote marker in
537 square brackets in column 0, no indentation allowed.  The footnote reference
538 is simply the marker in square brackets, inside text.  For example:
540 @smallexample
541 The Org homepage[fn:1] now looks a lot better than it used to.
543 [fn:1] The link is: http://orgmode.org
544 @end smallexample
546 @noindent The following commands handle footnotes:
548 @table @kbd
549 @item C-c C-x f
550 The footnote action command.  When the cursor is on a footnote reference,
551 jump to the definition.  When it is at a definition, jump to the (first)
552 reference.  Otherwise, create a new footnote.  When this command is called
553 with a prefix argument, a menu of additional options including renumbering is
554 offered.
556 @item C-c C-c
557 Jump between definition and reference.
558 @end table
560 @seealso{
561 @uref{http://orgmode.org/manual/Document-Structure.html#Document-Structure,
562 Chapter 2 of the manual}@*
563 @uref{http://sachachua.com/wp/2008/01/outlining-your-notes-with-org/,
564 Sacha Chua's tutorial}}
567 @node Tables, Hyperlinks, Document Structure, Top
568 @chapter Tables
570 Org comes with a fast and intuitive table editor.  Spreadsheet-like
571 calculations are supported in connection with the Emacs @file{calc}
572 package
573 @ifinfo
574 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
575 @end ifinfo
576 @ifnotinfo
577 (see the Emacs Calculator manual for more information about the Emacs
578 calculator).
579 @end ifnotinfo
581 Org makes it easy to format tables in plain ASCII.  Any line with
582 @samp{|} as the first non-whitespace character is considered part of a
583 table.  @samp{|} is also the column separator.  A table might look like
584 this:
586 @smallexample
587 | Name  | Phone | Age |
588 |-------+-------+-----|
589 | Peter |  1234 |  17 |
590 | Anna  |  4321 |  25 |
591 @end smallexample
593 A table is re-aligned automatically each time you press @key{TAB} or
594 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
595 the next field (@key{RET} to the next row) and creates new table rows
596 at the end of the table or before horizontal lines.  The indentation
597 of the table is set by the first line.  Any line starting with
598 @samp{|-} is considered as a horizontal separator line and will be
599 expanded on the next re-align to span the whole table width.  So, to
600 create the above table, you would only type
602 @smallexample
603 |Name|Phone|Age|
605 @end smallexample
607 @noindent and then press @key{TAB} to align the table and start filling in
608 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
609 @kbd{C-c @key{RET}}.
611 When typing text into a field, Org treats @key{DEL},
612 @key{Backspace}, and all character keys in a special way, so that
613 inserting and deleting avoids shifting other fields.  Also, when
614 typing @emph{immediately after the cursor was moved into a new field
615 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
616 field is automatically made blank.
618 @table @kbd
619 @tsubheading{Creation and conversion}
620 @item C-c |
621 Convert the active region to table.  If every line contains at least one TAB
622 character, the function assumes that the material is tab separated.  If every
623 line contains a comma, comma-separated values (CSV) are assumed.  If not,
624 lines are split at whitespace into fields.
626 If there is no active region, this command creates an empty Org
627 table.  But it's easier just to start typing, like
628 @kbd{|Name|Phone|Age C-c @key{RET}}.
630 @tsubheading{Re-aligning and field motion}
631 @item C-c C-c
632 Re-align the table without moving the cursor.
634 @item @key{TAB}
635 Re-align the table, move to the next field.  Creates a new row if
636 necessary.
638 @item S-@key{TAB}
639 Re-align, move to previous field.
641 @item @key{RET}
642 Re-align the table and move down to next row.  Creates a new row if
643 necessary.
645 @tsubheading{Column and row editing}
646 @item M-@key{left}
647 @itemx M-@key{right}
648 Move the current column left/right.
650 @item M-S-@key{left}
651 Kill the current column.
653 @item M-S-@key{right}
654 Insert a new column to the left of the cursor position.
656 @item M-@key{up}
657 @itemx M-@key{down}
658 Move the current row up/down.
660 @item M-S-@key{up}
661 Kill the current row or horizontal line.
663 @item M-S-@key{down}
664 Insert a new row above the current row.  With a prefix argument, the line is
665 created below the current one.
667 @item C-c -
668 Insert a horizontal line below current row.  With a prefix argument, the line
669 is created above the current line.
671 @item C-c @key{RET}
672 Insert a horizontal line below current row, and move the cursor into the row
673 below that line.
675 @item C-c ^
676 Sort the table lines in the region.  The position of point indicates the
677 column to be used for sorting, and the range of lines is the range
678 between the nearest horizontal separator lines, or the entire table.
680 @end table
682 @seealso{
683 @uref{http://orgmode.org/manual/Tables.html#Tables, Chapter 3 of the
684 manual}@*
685 @uref{http://orgmode.org/worg/org-tutorials/tables.php, Bastien's
686 table tutorial}@*
687 @uref{http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.php,
688 Bastien's spreadsheet tutorial}@*
689 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php, Eric's plotting tutorial}}
691 @node Hyperlinks, TODO Items, Tables, Top
692 @chapter Hyperlinks
694 Like HTML, Org provides links inside a file, external links to
695 other files, Usenet articles, emails, and much more.
697 @menu
698 * Link format::                 How links in Org are formatted
699 * Internal links::              Links to other places in the current file
700 * External links::              URL-like links to the world
701 * Handling links::              Creating, inserting and following
702 * Targeted links::              Point at a location in a file
703 @end menu
705 @node Link format, Internal links, Hyperlinks, Hyperlinks
706 @section Link format
708 Org will recognize plain URL-like links and activate them as
709 clickable links.  The general link format, however, looks like this:
711 @smallexample
712 [[link][description]]       @r{or alternatively}           [[link]]
713 @end smallexample
715 @noindent
716 Once a link in the buffer is complete (all brackets present), Org will change
717 the display so that @samp{description} is displayed instead of
718 @samp{[[link][description]]} and @samp{link} is displayed instead of
719 @samp{[[link]]}.  To edit the invisible @samp{link} part, use @kbd{C-c
720 C-l} with the cursor on the link.
722 @node Internal links, External links, Link format, Hyperlinks
723 @section Internal links
725 If the link does not look like a URL, it is considered to be internal in the
726 current file.  The most important case is a link like
727 @samp{[[#my-custom-id]]} which will link to the entry with the
728 @code{CUSTOM_ID} property @samp{my-custom-id}.
730 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
731 lead to a text search in the current file for the corresponding target which
732 looks like @samp{<<My Target>>}.
734 Internal links will be used to reference their destination, through links or
735 numbers, when possible.
737 @node External links, Handling links, Internal links, Hyperlinks
738 @section External links
740 Org supports links to files, websites, Usenet and email messages,
741 BBDB database entries and links to both IRC conversations and their
742 logs.  External links are URL-like locators.  They start with a short
743 identifying string followed by a colon.  There can be no space after
744 the colon.  Here are some examples:
746 @smallexample
747 http://www.astro.uva.nl/~dominik          @r{on the web}
748 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
749 /home/dominik/images/jupiter.jpg          @r{same as above}
750 file:papers/last.pdf                      @r{file, relative path}
751 file:projects.org                         @r{another Org file}
752 docview:papers/last.pdf::NNN              @r{open file in doc-view mode at page NNN}
753 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
754 news:comp.emacs                           @r{Usenet link}
755 mailto:adent@@galaxy.net                   @r{Mail link}
756 vm:folder                                 @r{VM folder link}
757 vm:folder#id                              @r{VM message link}
758 wl:folder#id                              @r{WANDERLUST message link}
759 mhe:folder#id                             @r{MH-E message link}
760 rmail:folder#id                           @r{RMAIL message link}
761 gnus:group#id                             @r{Gnus article link}
762 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
763 irc:/irc.com/#emacs/bob                   @r{IRC link}
764 info:org:External%20links                 @r{Info node link (with encoded space)}
765 @end smallexample
767 A link should be enclosed in double brackets and may contain a
768 descriptive text to be displayed instead of the URL (@pxref{Link
769 format}), for example:
771 @smallexample
772 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
773 @end smallexample
775 @noindent
776 If the description is a file name or URL that points to an image, HTML export
777 (@pxref{HTML export}) will inline the image as a clickable button.  If there
778 is no description at all and the link points to an image, that image will be
779 inlined into the exported HTML file.
781 @node Handling links, Targeted links, External links, Hyperlinks
782 @section Handling links
784 Org provides methods to create a link in the correct syntax, to
785 insert it into an Org file, and to follow the link.
787 @table @kbd
788 @item C-c l
789 Store a link to the current location.  This is a @emph{global} command (you
790 must create the key binding yourself) which can be used in any buffer to
791 create a link.  The link will be stored for later insertion into an Org
792 buffer (see below).
794 @item C-c C-l
795 Insert a link.  This prompts for a link to be inserted into the buffer.  You
796 can just type a link, or use history keys @key{up} and @key{down} to access
797 stored links.  You will be prompted for the description part of the link.
798 When called with a @kbd{C-u} prefix argument, file name completion is used to
799 link to a file.
801 @item C-c C-l @r{(with cursor on existing link)}
802 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
803 link and description parts of the link.
805 @item C-c C-o @r{or} mouse-1 @r{or} mouse-2
806 Open link at point.
807 @item C-c &
808 Jump back to a recorded position.  A position is recorded by the
809 commands following internal links, and by @kbd{C-c %}.  Using this
810 command several times in direct succession moves through a ring of
811 previously recorded positions.
813 @end table
815 @node Targeted links,  , Handling links, Hyperlinks
816 @section Targeted links
818 File links can contain additional information to make Emacs jump to a
819 particular location in the file when following a link.  This can be a
820 line number or a search option after a double colon.
822 Here is the syntax of the different ways to attach a search to a file
823 link, together with an explanation:
825 @smallexample
826 [[file:~/code/main.c::255]]                 @r{Find line 255}
827 [[file:~/xx.org::My Target]]                @r{Find @samp{<<My Target>>}}
828 [[file:~/xx.org::#my-custom-id]]            @r{Find entry with custom id}
829 @end smallexample
831 @seealso{
832 @uref{http://orgmode.org/manual/Hyperlinks.html#Hyperlinks, Chapter 4 of the
833 manual}}
835 @node TODO Items, Tags, Hyperlinks, Top
836 @chapter TODO Items
838 Org mode does not require TODO lists to live in separate documents.  Instead,
839 TODO items are part of a notes file, because TODO items usually
840 come up while taking notes!  With Org mode, simply mark any entry in a tree
841 as being a TODO item.  In this way, information is not duplicated, and TODO
842 items remain in the context from which they emerged.
844 Org mode providing methods to give you an overview of all the things that you
845 have to do, collected from many files.
847 @menu
848 * Using TODO states::           Setting and switching states
849 * Multi-state workflows::       More than just on/off
850 * Progress logging::            Dates and notes for progress
851 * Priorities::                  Some things are more important than others
852 * Breaking down tasks::         Splitting a task into manageable pieces
853 * Checkboxes::                  Tick-off lists
854 @end menu
856 @node Using TODO states, Multi-state workflows, TODO Items, TODO Items
857 @section Using TODO states
859 Any headline becomes a TODO item when it starts with the word
860 @samp{TODO}, for example:
862 @smallexample
863 *** TODO Write letter to Sam Fortune
864 @end smallexample
866 @noindent
867 The most important commands to work with TODO entries are:
869 @table @kbd
870 @item C-c C-t
871 Rotate the TODO state of the current item among
873 @smallexample
874 (unmarked) -> TODO -> DONE -> (unmarked)
875 @end smallexample
877 The same rotation can also be done ``remotely'' from the timeline and
878 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
880 @item S-@key{right}@r{/}@key{left}
881 Select the following/preceding TODO state, similar to cycling.
882 @item C-c / t
883 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
884 buffer, but shows all TODO items and the headings hierarchy above
885 them.
886 @item C-c a t
887 Show the global TODO list.  Collects the TODO items from all agenda files
888 (@pxref{Agenda Views}) into a single buffer.  @xref{Global TODO list}, for
889 more information.
890 @item S-M-@key{RET}
891 Insert a new TODO entry below the current one.
892 @end table
894 @noindent
895 Changing a TODO state can also trigger tag changes.  See the docstring of the
896 option @code{org-todo-state-tags-triggers} for details.
898 @node Multi-state workflows, Progress logging, Using TODO states, TODO Items
899 @section Multi-state workflows
901 You can use TODO keywords to indicate @emph{sequential} working progress
902 states:
904 @smalllisp
905 (setq org-todo-keywords
906   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
907 @end smalllisp
909 The vertical bar separates the TODO keywords (states that @emph{need action})
910 from the DONE states (which need @emph{no further action}).  If you don't
911 provide the separator bar, the last state is used as the DONE state.  With
912 this setup, the command @kbd{C-c C-t} will cycle an entry from TODO to
913 FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  Sometimes you
914 may want to use different sets of TODO keywords in parallel.  For example,
915 you may want to have the basic @code{TODO}/@code{DONE}, but also a workflow
916 for bug fixing.  Your setup would then look like this:
918 @smalllisp
919 (setq org-todo-keywords
920       '((sequence "TODO(t)" "|" "DONE(d)")
921         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")))
922 @end smalllisp
924 The keywords should all be different, this helps Org mode to keep track of
925 which subsequence should be used for a given entry.  The example also shows
926 how to define keys for fast access of a particular state, by adding a letter
927 in parenthesis after each keyword---you will be prompted for the key after
928 @kbd{C-c C-t}.
930 To define TODO keywords that are valid only in a single file, use the
931 following text anywhere in the file.
933 @smallexample
934 #+TODO: TODO(t) | DONE(d)
935 #+TODO: REPORT(r) BUG(b) KNOWNCAUSE(k) | FIXED(f)
936 #+TODO: | CANCELED(c)
937 @end smallexample
939 After changing one of these lines, use @kbd{C-c C-c} with the cursor still in
940 the line to make the changes known to Org mode.
942 @node Progress logging, Priorities, Multi-state workflows, TODO Items
943 @section Progress logging
945 Org mode can automatically record a timestamp and possibly a note when
946 you mark a TODO item as DONE, or even each time you change the state of
947 a TODO item.  This system is highly configurable; settings can be on a
948 per-keyword basis and can be localized to a file or even a subtree.  For
949 information on how to clock working time for a task, see @ref{Clocking
950 work time}.
952 @menu
953 * Closing items::               When was this entry marked DONE?
954 * Tracking TODO state changes::  When did the status change?
955 @end menu
957 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
958 @unnumberedsubsec Closing items
960 The most basic logging is to keep track of @emph{when} a certain TODO
961 item was finished.  This is achieved with@footnote{The corresponding
962 in-buffer setting is: @code{#+STARTUP: logdone}}.
964 @smalllisp
965 (setq org-log-done 'time)
966 @end smalllisp
968 @noindent
969 Then each time you turn an entry from a TODO (not-done) state into any of the
970 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
971 the headline.  If you want to record a note along with the timestamp,
972 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
973 lognotedone}}
975 @smalllisp
976 (setq org-log-done 'note)
977 @end smalllisp
979 @noindent
980 You will then be prompted for a note, and that note will be stored below
981 the entry with a @samp{Closing Note} heading.
983 @node Tracking TODO state changes,  , Closing items, Progress logging
984 @unnumberedsubsec Tracking TODO state changes
986 You might want to keep track of TODO state changes.  You can either record
987 just a timestamp, or a time-stamped note for a change.  These records will be
988 inserted after the headline as an itemized list.  When taking a lot of notes,
989 you might want to get the notes out of the way into a drawer.  Customize the
990 variable @code{org-log-into-drawer} to get this behavior.
992 For state logging, Org mode expects configuration on a per-keyword basis.
993 This is achieved by adding special markers @samp{!} (for a timestamp) and
994 @samp{@@} (for a note) in parentheses after each keyword.  For example:
995 @smallexample
996 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
997 @end smallexample
998 @noindent
999 will define TODO keywords and fast access keys, and also request that a time
1000 is recorded when the entry is set to DONE, and that a note is recorded when
1001 switching to WAIT or CANCELED.  The same syntax works also when setting
1002 @code{org-todo-keywords}.
1004 @node Priorities, Breaking down tasks, Progress logging, TODO Items
1005 @section Priorities
1007 If you use Org mode extensively, you may end up with enough TODO items that
1008 it starts to make sense to prioritize them.  Prioritizing can be done by
1009 placing a @emph{priority cookie} into the headline of a TODO item, like this
1011 @smallexample
1012 *** TODO [#A] Write letter to Sam Fortune
1013 @end smallexample
1015 @noindent
1016 Org mode supports three priorities: @samp{A}, @samp{B}, and @samp{C}.
1017 @samp{A} is the highest, @samp{B} the default if none is given.  Priorities
1018 make a difference only in the agenda.
1020 @table @kbd
1021 @item @kbd{C-c ,}
1022 Set the priority of the current headline.  Press @samp{A}, @samp{B} or
1023 @samp{C} to select a priority, or @key{SPC} to remove the cookie.
1025 @item S-@key{up}/@key{dwn}
1026 Increase/decrease priority of current headline
1027 @end table
1029 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
1030 @section Breaking tasks down into subtasks
1032 It is often advisable to break down large tasks into smaller, manageable
1033 subtasks.  You can do this by creating an outline tree below a TODO item,
1034 with detailed subtasks on the tree.  To keep the overview over the fraction
1035 of subtasks that are already completed, insert either @samp{[/]} or
1036 @samp{[%]} anywhere in the headline.  These cookies will be updated each time
1037 the TODO status of a child changes, or when pressing @kbd{C-c C-c} on the
1038 cookie.  For example:
1040 @smallexample
1041 * Organize Party [33%]
1042 ** TODO Call people [1/2]
1043 *** TODO Peter
1044 *** DONE Sarah
1045 ** TODO Buy food
1046 ** DONE Talk to neighbor
1047 @end smallexample
1049 @node Checkboxes,  , Breaking down tasks, TODO Items
1050 @section Checkboxes
1052 Every item in a plain list (@pxref{Plain lists}) can be made into a checkbox
1053 by starting it with the string @samp{[ ]}.  Checkboxes are not included in
1054 the global TODO list, so they are often great to split a task into a number
1055 of simple steps.
1056 Here is an example of a checkbox list.
1058 @smallexample
1059 * TODO Organize party [1/3]
1060   - [-] call people [1/2]
1061     - [ ] Peter
1062     - [X] Sarah
1063   - [X] order food
1064 @end smallexample
1066 Checkboxes work hierarchically, so if a checkbox item has children that
1067 are checkboxes, toggling one of the children checkboxes will make the
1068 parent checkbox reflect if none, some, or all of the children are
1069 checked.
1071 @noindent The following commands work with checkboxes:
1073 @table @kbd
1074 @item C-c C-c
1075 Toggle checkbox status or (with prefix arg) checkbox presence at point.
1076 @item M-S-@key{RET}
1077 Insert a new item with a checkbox.
1078 This works only if the cursor is already in a plain list item
1079 (@pxref{Plain lists}).
1080 @end table
1082 @seealso{
1083 @uref{http://orgmode.org/manual/TODO-Items.html#TODO-Items, Chapter 5 of the manual}@*
1084 @uref{http://orgmode.org/worg/org-tutorials/orgtutorial_dto.php, David
1085 O'Toole's introductory tutorial}@*
1086 @uref{http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html,
1087 Charles Cave's GTD setup}}
1089 @node Tags, Properties, TODO Items, Top
1090 @chapter Tags
1092 An excellent way to implement labels and contexts for cross-correlating
1093 information is to assign @i{tags} to headlines.  Org mode has extensive
1094 support for tags.
1096 Every headline can contain a list of tags; they occur at the end of the
1097 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
1098 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
1099 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
1100 Tags will by default be in bold face with the same color as the headline.
1102 @menu
1103 * Tag inheritance::             Tags use the tree structure of the outline
1104 * Setting tags::                How to assign tags to a headline
1105 * Tag groups::                  Use one tag to search for several tags
1106 * Tag searches::                Searching for combinations of tags
1107 @end menu
1109 @node Tag inheritance, Setting tags, Tags, Tags
1110 @section Tag inheritance
1112 @i{Tags} make use of the hierarchical structure of outline trees.  If a
1113 heading has a certain tag, all subheadings will inherit the tag as
1114 well.  For example, in the list
1116 @smallexample
1117 * Meeting with the French group      :work:
1118 ** Summary by Frank                  :boss:notes:
1119 *** TODO Prepare slides for him      :action:
1120 @end smallexample
1122 @noindent
1123 the final heading will have the tags @samp{:work:}, @samp{:boss:},
1124 @samp{:notes:}, and @samp{:action:} even though the final heading is not
1125 explicitly marked with those tags.  You can also set tags that all entries in
1126 a file should inherit just as if these tags were defined in a hypothetical
1127 level zero that surrounds the entire file.  Use a line like this@footnote{As
1128 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
1129 changes in the line.}:
1131 @smallexample
1132 #+FILETAGS: :Peter:Boss:Secret:
1133 @end smallexample
1135 @node Setting tags, Tag groups, Tag inheritance, Tags
1136 @section Setting tags
1138 Tags can simply be typed into the buffer at the end of a headline.
1139 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
1140 also a special command for inserting tags:
1142 @table @kbd
1143 @item C-c C-q
1144 Enter new tags for the current headline.  Org mode will either offer
1145 completion or a special single-key interface for setting tags, see
1146 below.  After pressing @key{RET}, the tags will be inserted and aligned
1147 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
1148 tags in the current buffer will be aligned to that column, just to make
1149 things look nice.
1150 @item C-c C-c
1151 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
1152 @end table
1154 Org will support tag insertion based on a @emph{list of tags}.  By
1155 default this list is constructed dynamically, containing all tags
1156 currently used in the buffer.  You may also globally specify a hard list
1157 of tags with the variable @code{org-tag-alist}.  Finally you can set
1158 the default tags for a given file with lines like
1160 @smallexample
1161 #+TAGS: @@work @@home @@tennisclub
1162 #+TAGS: laptop car pc sailboat
1163 @end smallexample
1165 By default Org mode uses the standard minibuffer completion facilities for
1166 entering tags.  However, it also implements another, quicker, tag selection
1167 method called @emph{fast tag selection}.  This allows you to select and
1168 deselect tags with just a single key press.  For this to work well you should
1169 assign unique letters to most of your commonly used tags.  You can do this
1170 globally by configuring the variable @code{org-tag-alist} in your
1171 @file{.emacs} file.  For example, you may find the need to tag many items in
1172 different files with @samp{:@@home:}.  In this case you can set something
1173 like:
1175 @smalllisp
1176 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
1177 @end smalllisp
1179 @noindent If the tag is only relevant to the file you are working on, then you
1180 can instead set the TAGS option line as:
1182 @smallexample
1183 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
1184 @end smallexample
1186 @node Tag groups, Tag searches, Setting tags, Tags
1187 @section Tag groups
1189 @cindex group tags
1190 @cindex tags, groups
1191 In a set of mutually exclusive tags, the first tag can be defined as a
1192 @emph{group tag}.  When you search for a group tag, it will return matches
1193 for all members in the group.  In an agenda view, filtering by a group tag
1194 will display headlines tagged with at least one of the members of the
1195 group.  This makes tag searches and filters even more flexible.
1197 You can set group tags by inserting a colon between the group tag and other
1198 tags, like this:
1200 @example
1201 #+TAGS: @{ @@read : @@read_book  @@read_ebook @}
1202 @end example
1204 In this example, @samp{@@read} is a @emph{group tag} for a set of three
1205 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
1207 You can also use the @code{:grouptags} keyword directly when setting
1208 @var{org-tag-alist}, see the documentation of that variable.
1210 @kindex C-c C-x q
1211 @vindex org-group-tags
1212 If you want to ignore group tags temporarily, toggle group tags support
1213 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
1214 want to disable tag groups completely, set @var{org-group-tags} to nil.
1216 @node Tag searches,  , Tag groups, Tags
1217 @section Tag searches
1219 Once a system of tags has been set up, it can be used to collect related
1220 information into special lists.
1222 @table @kbd
1223 @item C-c \
1224 @itemx C-c / m
1225 Create a sparse tree with all headlines matching a tags search.  With a
1226 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
1227 @item C-c a m
1228 Create a global list of tag matches from all agenda files.
1229 @xref{Matching tags and properties}.
1230 @item C-c a M
1231 Create a global list of tag matches from all agenda files, but check
1232 only TODO items and force checking subitems (see variable
1233 @code{org-tags-match-list-sublevels}).
1234 @end table
1236 These commands all prompt for a match string which allows basic Boolean logic
1237 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
1238 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
1239 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the
1240 search string is rich and allows also matching against TODO keywords, entry
1241 levels and properties.  For a complete description with many examples, see
1242 @ref{Matching tags and properties}.
1244 @seealso{
1245 @uref{http://orgmode.org/manual/Tags.html#Tags, Chapter 6 of the manual}@*
1246 @uref{http://sachachua.com/wp/2008/01/tagging-in-org-plus-bonus-code-for-timeclocks-and-tags/,
1247 Sacha Chua's article about tagging in Org-mode}}
1249 @node Properties, Dates and Times, Tags, Top
1250 @chapter Properties
1252 Properties are key-value pairs associated with an entry.  They live in a
1253 special drawer with the name @code{PROPERTIES}.  Each
1254 property is specified on a single line, with the key (surrounded by colons)
1255 first, and the value after it:
1257 @smallexample
1258 * CD collection
1259 ** Classic
1260 *** Goldberg Variations
1261     :PROPERTIES:
1262     :Title:     Goldberg Variations
1263     :Composer:  J.S. Bach
1264     :Publisher: Deutsche Grammophon
1265     :NDisks:    1
1266     :END:
1267 @end smallexample
1269 You may define the allowed values for a particular property @samp{:Xyz:}
1270 by setting a property @samp{:Xyz_ALL:}.  This special property is
1271 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
1272 the entire tree.  When allowed values are defined, setting the
1273 corresponding property becomes easier and is less prone to typing
1274 errors.  For the example with the CD collection, we can predefine
1275 publishers and the number of disks in a box like this:
1277 @smallexample
1278 * CD collection
1279   :PROPERTIES:
1280   :NDisks_ALL:  1 2 3 4
1281   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
1282   :END:
1283 @end smallexample
1284 or globally using @code{org-global-properties}, or file-wide like this:
1285 @smallexample
1286 #+PROPERTY: NDisks_ALL 1 2 3 4
1287 @end smallexample
1289 @table @kbd
1290 @item C-c C-x p
1291 Set a property.  This prompts for a property name and a value.
1292 @item C-c C-c d
1293 Remove a property from the current entry.
1294 @end table
1296 To create sparse trees and special lists with selection based on properties,
1297 the same commands are used as for tag searches (@pxref{Tag searches}).  The
1298 syntax for the search string is described in @ref{Matching tags and
1299 properties}.
1301 @table @kbd
1302 @end table
1304 @seealso{
1305 @uref{http://orgmode.org/manual/Properties-and-Columns.html#Properties-and-Columns,
1306 Chapter 7 of the manual}@*
1307 @uref{http://orgmode.org/worg/org-tutorials/org-column-view-tutorial.php,Bastien
1308 Guerry's column view tutorial}}
1310 @node Dates and Times, Capture - Refile - Archive, Properties, Top
1311 @chapter Dates and Times
1313 To assist project planning, TODO items can be labeled with a date and/or
1314 a time.  The specially formatted string carrying the date and time
1315 information is called a @emph{timestamp} in Org mode.
1317 @menu
1318 * Timestamps::                  Assigning a time to a tree entry
1319 * Creating timestamps::         Commands which insert timestamps
1320 * Deadlines and scheduling::    Planning your work
1321 * Clocking work time::          Tracking how long you spend on a task
1322 @end menu
1325 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
1326 @section Timestamps
1328 A timestamp is a specification of a date (possibly with a time or a range of
1329 times) in a special format, either @samp{<2003-09-16 Tue>} or
1330 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue 12:00-12:30>}.  A
1331 timestamp can appear anywhere in the headline or body of an Org tree entry.
1332 Its presence causes entries to be shown on specific dates in the agenda
1333 (@pxref{Weekly/daily agenda}).  We distinguish:
1335 @noindent @b{Plain timestamp; Event; Appointment}@*
1336 A simple timestamp just assigns a date/time to an item.  This is just
1337 like writing down an appointment or event in a paper agenda.
1339 @smallexample
1340 * Meet Peter at the movies
1341   <2006-11-01 Wed 19:15>
1342 * Discussion on climate change
1343   <2006-11-02 Thu 20:00-22:00>
1344 @end smallexample
1346 @noindent @b{Timestamp with repeater interval}@*
1347 A timestamp may contain a @emph{repeater interval}, indicating that it
1348 applies not only on the given date, but again and again after a certain
1349 interval of N days (d), weeks (w), months (m), or years (y).  The
1350 following will show up in the agenda every Wednesday:
1351 @smallexample
1352 * Pick up Sam at school
1353   <2007-05-16 Wed 12:30 +1w>
1354 @end smallexample
1356 @noindent @b{Diary-style sexp entries}@*
1357 For more complex date specifications, Org mode supports using the
1358 special sexp diary entries implemented in the Emacs calendar/diary
1359 package.  For example
1360 @smallexample
1361 * The nerd meeting on every 2nd Thursday of the month
1362   <%%(diary-float t 4 2)>
1363 @end smallexample
1365 @noindent @b{Time/Date range}@*
1366 Two timestamps connected by @samp{--} denote a range.
1367 @smallexample
1368 ** Meeting in Amsterdam
1369    <2004-08-23 Mon>--<2004-08-26 Thu>
1370 @end smallexample
1372 @noindent @b{Inactive timestamp}@*
1373 Just like a plain timestamp, but with square brackets instead of
1374 angular ones.  These timestamps are inactive in the sense that they do
1375 @emph{not} trigger an entry to show up in the agenda.
1377 @smallexample
1378 * Gillian comes late for the fifth time
1379   [2006-11-01 Wed]
1380 @end smallexample
1383 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
1384 @section Creating timestamps
1386 For Org mode to recognize timestamps, they need to be in the specific
1387 format.  All commands listed below produce timestamps in the correct
1388 format.
1390 @table @kbd
1391 @item C-c .
1392 Prompt for a date and insert a corresponding timestamp.  When the cursor is
1393 at an existing timestamp in the buffer, the command is used to modify this
1394 timestamp instead of inserting a new one.  When this command is used twice in
1395 succession, a time range is inserted.  With a prefix, also add the current
1396 time. 
1398 @item C-c !
1399 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
1400 an agenda entry.
1402 @item S-@key{left}@r{/}@key{right}
1403 Change date at cursor by one day.
1405 @item S-@key{up}@r{/}@key{down}
1406 Change the item under the cursor in a timestamp.  The cursor can be on a
1407 year, month, day, hour or minute.  When the timestamp contains a time range
1408 like @samp{15:30-16:30}, modifying the first time will also shift the second,
1409 shifting the time block with constant length.  To change the length, modify
1410 the second time.
1411 @end table
1413 When Org mode prompts for a date/time, it will accept any string containing
1414 some date and/or time information, and intelligently interpret the string,
1415 deriving defaults for unspecified information from the current date and time.
1416 You can also select a date in the pop-up calendar.  See the manual for more
1417 information on how exactly the date/time prompt works.
1419 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
1420 @section Deadlines and scheduling
1422 A timestamp may be preceded by special keywords to facilitate planning:
1424 @noindent @b{DEADLINE}@*
1425 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
1426 to be finished on that date.
1427 @table @kbd
1428 @item C-c C-d
1429 Insert @samp{DEADLINE} keyword along with a stamp, in the line following the
1430 headline.
1431 @end table
1433 On the deadline date, the task will be listed in the agenda.  In
1434 addition, the agenda for @emph{today} will carry a warning about the
1435 approaching or missed deadline, starting
1436 @code{org-deadline-warning-days} before the due date, and continuing
1437 until the entry is marked DONE.  An example:
1439 @smallexample
1440 *** TODO write article about the Earth for the Guide
1441     The editor in charge is [[bbdb:Ford Prefect]]
1442     DEADLINE: <2004-02-29 Sun>
1443 @end smallexample
1446 @noindent @b{SCHEDULED}@*
1447 Meaning: you are @i{planning to start working} on that task on the given
1448 date@footnote{This is quite different from what is normally understood by
1449 @i{scheduling a meeting}, which is done in Org-mode by just inserting a time
1450 stamp without keyword.}.
1452 @table @kbd
1453 @item C-c C-s
1454 Insert @samp{SCHEDULED} keyword along with a stamp, in the line following the
1455 headline.
1456 @end table
1458 The headline will be listed under the given date@footnote{It will still
1459 be listed on that date after it has been marked DONE.  If you don't like
1460 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
1461 addition, a reminder that the scheduled date has passed will be present
1462 in the compilation for @emph{today}, until the entry is marked DONE.
1463 I.e.@: the task will automatically be forwarded until completed.
1465 @smallexample
1466 *** TODO Call Trillian for a date on New Years Eve.
1467     SCHEDULED: <2004-12-25 Sat>
1468 @end smallexample
1470 Some tasks need to be repeated again and again.  Org mode helps to
1471 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
1472 or plain timestamp.  In the following example
1473 @smallexample
1474 ** TODO Pay the rent
1475    DEADLINE: <2005-10-01 Sat +1m>
1476 @end smallexample
1477 @noindent
1478 the @code{+1m} is a repeater; the intended interpretation is that the task
1479 has a deadline on <2005-10-01> and repeats itself every (one) month starting
1480 from that time.
1482 @node Clocking work time,  , Deadlines and scheduling, Dates and Times
1483 @section Clocking work time
1485 Org mode allows you to clock the time you spend on specific tasks in a
1486 project.
1488 @table @kbd
1489 @item C-c C-x C-i
1490 Start the clock on the current item (clock-in).  This inserts the CLOCK
1491 keyword together with a timestamp.  When called with a @kbd{C-u} prefix
1492 argument, select the task from a list of recently clocked tasks.
1494 @item C-c C-x C-o
1495 Stop the clock (clock-out).  This inserts another timestamp at the same
1496 location where the clock was last started.  It also directly computes
1497 the resulting time in inserts it after the time range as @samp{=>
1498 HH:MM}.
1499 @item C-c C-x C-e
1500 Update the effort estimate for the current clock task.
1501 @item C-c C-x C-x
1502 Cancel the current clock.  This is useful if a clock was started by
1503 mistake, or if you ended up working on something else.
1504 @item C-c C-x C-j
1505 Jump to the entry that contains the currently running clock.  With a
1506 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
1507 tasks.
1508 @item C-c C-x C-r
1509 Insert a dynamic block containing a clock
1510 report as an Org-mode table into the current file.  When the cursor is
1511 at an existing clock table, just update it.
1512 @smallexample
1513 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
1514 #+END: clocktable
1515 @end smallexample
1516 @noindent
1517 For details about how to customize this view, see @uref{http://orgmode.org/manual/Clocking-work-time.html#Clocking-work-time,the manual}.
1518 @item C-c C-c
1519 Update dynamic block at point.  The cursor needs to be in the
1520 @code{#+BEGIN} line of the dynamic block.
1521 @end table
1523 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
1524 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
1525 worked on or closed during a day.
1527 @seealso{
1528 @uref{http://orgmode.org/manual/Dates-and-Times.html#Dates-and-Times,
1529 Chapter 8 of the manual}@*
1530 @uref{http://members.optusnet.com.au/~charles57/GTD/org_dates/, Charles
1531 Cave's Date and Time tutorial}@*
1532 @uref{http://doc.norang.ca/org-mode.html#Clocking, Bernt Hansen's clocking workflow}}
1534 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
1535 @chapter Capture - Refile - Archive
1537 An important part of any organization system is the ability to quickly
1538 capture new ideas and tasks, and to associate reference material with them.
1539 Org defines a capture process to create tasks.  Once in the system, tasks and
1540 projects need to be moved around.  Moving completed project trees to an
1541 archive file keeps the system compact and fast.
1543 @menu
1544 * Capture::                     Capturing new stuff
1545 * Refile and copy::             Moving a tree from one place to another
1546 * Archiving::                   What to do with finished projects
1547 @end menu
1549 @node Capture, Refile and copy, Capture - Refile - Archive, Capture - Refile - Archive
1550 @section Capture
1552 Org's lets you store quick notes with little interruption of your work flow.
1553 You can define templates for new entries and associate them with different
1554 targets for storing notes.
1556 @menu
1557 * Setting up a capture location::  Where notes will be stored
1558 * Using capture::               Commands to invoke and terminate capture
1559 * Capture templates::           Define the outline of different note types
1560 @end menu
1562 @node Setting up a capture location, Using capture, Capture, Capture
1563 @unnumberedsubsec Setting up a capture location
1565 The following customization sets a default target@footnote{Using capture
1566 templates, you get finer control over capture locations, see
1567 @ref{Capture templates}.} file for notes, and defines a global
1568 key for capturing new stuff.
1570 @example
1571 (setq org-default-notes-file (concat org-directory "/notes.org"))
1572 (define-key global-map "\C-cc" 'org-capture)
1573 @end example
1575 @node Using capture, Capture templates, Setting up a capture location, Capture
1576 @unnumberedsubsec Using capture
1578 @table @kbd
1579 @item C-c c
1580 Start a capture process, placing you into a narrowed indirect buffer to edit.
1581 @item C-c C-c
1582 Once you are done entering information into the capture buffer, 
1583 @kbd{C-c C-c} will return you to the window configuration before the capture
1584 process, so that you can resume your work without further distraction.
1585 @item C-c C-w
1586 Finalize by moving the entry to a refile location (see section 9.2).
1587 @item C-c C-k
1588 Abort the capture process and return to the previous state.
1589 @end table
1591 @node Capture templates,  , Using capture, Capture
1592 @unnumberedsubsec Capture templates
1594 You can use templates to generate different types of capture notes, and to
1595 store them in different places.  For example, if you would like
1596 to store new tasks under a heading @samp{Tasks} in file @file{TODO.org}, and
1597 journal entries in a date tree in @file{journal.org} you could
1598 use:
1600 @smallexample
1601 (setq org-capture-templates
1602  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
1603         "* TODO %?\n  %i\n  %a")
1604    ("j" "Journal" entry (file+datetree "~/org/journal.org")
1605         "* %?\nEntered on %U\n  %i\n  %a")))
1606 @end smallexample
1608 @noindent In these entries, the first string is the key to reach the
1609 template, the second is a short description.  Then follows the type of the
1610 entry and a definition of the target location for storing the note.  Finally,
1611 the template itself, a string with %-escapes to fill in information based on
1612 time and context.
1614 When you call @kbd{M-x org-capture}, Org will prompt for a key to select the
1615 template (if you have more than one template) and then prepare the buffer like
1616 @smallexample
1617 * TODO
1618   [[file:@var{link to where you were when initiating capture}]]
1619 @end smallexample
1621 @noindent
1622 During expansion of the template, special @kbd{%}-escapes@footnote{If you
1623 need one of these sequences literally, escape the @kbd{%} with a backslash.}
1624 allow dynamic insertion of content.  Here is a small selection of the
1625 possibilities, consult the manual for more.
1626 @smallexample
1627 %a          @r{annotation, normally the link created with @code{org-store-link}}
1628 %i          @r{initial content, the region when capture is called with C-u.}
1629 %t, %T      @r{timestamp, date only, or date and time}
1630 %u, %U      @r{like above, but inactive timestamps}
1631 @end smallexample
1633 @node Refile and copy, Archiving, Capture, Capture - Refile - Archive
1634 @section Refile and copy
1636 When reviewing the captured data, you may want to refile or copy some of the
1637 entries into a different list, for example into a project.  Cutting, finding
1638 the right location, and then pasting the note is cumbersome.  To simplify
1639 this process, use the following commands:
1641 @table @kbd
1642 @item C-c M-x
1643 Copy the entry or region at point.  This command behaves like
1644 @code{org-refile}, except that the original note will not be deleted.
1645 @item C-c C-w
1646 Refile the entry or region at point.  This command offers possible locations
1647 for refiling the entry and lets you select one with completion.  The item (or
1648 all items in the region) is filed below the target heading as a subitem.@*
1649 By default, all level 1 headlines in the current buffer are considered to be
1650 targets, but you can have more complex definitions across a number of files.
1651 See the variable @code{org-refile-targets} for details.
1652 @item C-u C-c C-w
1653 Use the refile interface to jump to a heading.
1654 @item C-u C-u C-c C-w
1655 Jump to the location where @code{org-refile} last moved a tree to.
1656 @end table
1658 @node Archiving,  , Refile and copy, Capture - Refile - Archive
1659 @section Archiving
1661 When a project represented by a (sub)tree is finished, you may want
1662 to move the tree out of the way and to stop it from contributing to the
1663 agenda.  Archiving is important to keep your working files compact and global
1664 searches like the construction of agenda views fast.
1665 The most common archiving action is to move a project tree to another file,
1666 the archive file.
1668 @table @kbd
1669 @item C-c C-x C-a
1670 Archive the current entry using @code{org-archive-default-command}.
1671 @item C-c C-x C-s@ @r{or short} @ C-c $
1672 Archive the subtree starting at the cursor position to the location
1673 given by @code{org-archive-location}.
1674 @end table
1676 The default archive location is a file in the same directory as the
1677 current file, with the name derived by appending @file{_archive} to the
1678 current file name.  For information and examples on how to change this,
1679 see the documentation string of the variable
1680 @code{org-archive-location}.  There is also an in-buffer option for
1681 setting this variable, for example
1683 @smallexample
1684 #+ARCHIVE: %s_done::
1685 @end smallexample
1687 @seealso{
1688 @uref{http://orgmode.org/manual/Capture-_002d-Refile-_002d-Archive.html#Capture-_002d-Refile-_002d-Archive,
1689 Chapter 9 of the manual}@*
1690 @uref{http://orgmode.org/worg/org-tutorials/org-protocol-custom-handler.php,
1691 Sebastian Rose's tutorial for capturing from a web browser}}@uref{}@*
1693 @node Agenda Views, Markup, Capture - Refile - Archive, Top
1694 @chapter Agenda Views
1696 Due to the way Org works, TODO items, time-stamped items, and tagged
1697 headlines can be scattered throughout a file or even a number of files.  To
1698 get an overview of open action items, or of events that are important for a
1699 particular date, this information must be collected, sorted and displayed in
1700 an organized way.  There are several different views, see below.
1702 The extracted information is displayed in a special @emph{agenda buffer}.
1703 This buffer is read-only, but provides commands to visit the corresponding
1704 locations in the original Org files, and even to edit these files remotely.
1705 Remote editing from the agenda buffer means, for example, that you can
1706 change the dates of deadlines and appointments from the agenda buffer.
1707 The commands available in the Agenda buffer are listed in @ref{Agenda
1708 commands}.
1710 @menu
1711 * Agenda files::                Files being searched for agenda information
1712 * Agenda dispatcher::           Keyboard access to agenda views
1713 * Built-in agenda views::       What is available out of the box?
1714 * Agenda commands::             Remote editing of Org trees
1715 * Custom agenda views::         Defining special searches and views
1716 @end menu
1718 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
1719 @section Agenda files
1721 The information to be shown is normally collected from all @emph{agenda
1722 files}, the files listed in the variable
1723 @code{org-agenda-files}.
1725 @table @kbd
1726 @item C-c [
1727 Add current file to the list of agenda files.  The file is added to
1728 the front of the list.  If it was already in the list, it is moved to
1729 the front.  With a prefix argument, file is added/moved to the end.
1730 @item C-c ]
1731 Remove current file from the list of agenda files.
1732 @item C-,
1733 Cycle through agenda file list, visiting one file after the other.
1734 @end table
1736 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
1737 @section The agenda dispatcher
1738 The views are created through a dispatcher, which should be bound to a
1739 global key---for example @kbd{C-c a} (@pxref{Installation}).  After
1740 pressing @kbd{C-c a}, an additional letter is required to execute a
1741 command:
1742 @table @kbd
1743 @item a
1744 The calendar-like agenda (@pxref{Weekly/daily agenda}).
1745 @item t @r{/} T
1746 A list of all TODO items (@pxref{Global TODO list}).
1747 @item m @r{/} M
1748 A list of headlines matching a TAGS expression (@pxref{Matching
1749 tags and properties}).
1750 @item L
1751 The timeline view for the current buffer (@pxref{Timeline}).
1752 @item s
1753 A list of entries selected by a boolean expression of keywords
1754 and/or regular expressions that must or must not occur in the entry.
1755 @end table
1757 @node Built-in agenda views, Agenda commands, Agenda dispatcher, Agenda Views
1758 @section The built-in agenda views
1760 @menu
1761 * Weekly/daily agenda::         The calendar page with current tasks
1762 * Global TODO list::            All unfinished action items
1763 * Matching tags and properties::  Structured information with fine-tuned search
1764 * Timeline::                    Time-sorted view for single file
1765 * Search view::                 Find entries by searching for text
1766 @end menu
1768 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
1769 @subsection The weekly/daily agenda
1771 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
1772 paper agenda, showing all the tasks for the current week or day.
1774 @table @kbd
1775 @item C-c a a
1776 Compile an agenda for the current week from a list of Org files.  The agenda
1777 shows the entries for each day.
1778 @end table
1780 Emacs contains the calendar and diary by Edward M. Reingold.  Org-mode
1781 understands the syntax of the diary and allows you to use diary sexp entries
1782 directly in Org files:
1784 @smallexample
1785 * Birthdays and similar stuff
1786 #+CATEGORY: Holiday
1787 %%(org-calendar-holiday)   ; special function for holiday names
1788 #+CATEGORY: Ann
1789 %%(diary-anniversary  5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old
1790 %%(diary-anniversary 10  2 1869) Mahatma Gandhi would be %d years old
1791 @end smallexample
1793 Org can interact with Emacs appointments notification facility.  To add all
1794 the appointments of your agenda files, use the command
1795 @code{org-agenda-to-appt}.  See the docstring for details.
1797 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
1798 @subsection The global TODO list
1800 The global TODO list contains all unfinished TODO items formatted and
1801 collected into a single place.  Remote editing of TODO items lets you
1802 can change the state of a TODO entry with a single key press.  The commands
1803 available in the TODO list are described in @ref{Agenda commands}.
1805 @table @kbd
1806 @item C-c a t
1807 Show the global TODO list.  This collects the TODO items from all
1808 agenda files (@pxref{Agenda Views}) into a single buffer.
1809 @item C-c a T
1810 Like the above, but allows selection of a specific TODO keyword. 
1811 @end table
1813 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
1814 @subsection Matching tags and properties
1816 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
1817 or have properties (@pxref{Properties}), you can select headlines
1818 based on this metadata and collect them into an agenda buffer.  The match
1819 syntax described here also applies when creating sparse trees with @kbd{C-c /
1820 m}.  The commands available in the tags list are described in @ref{Agenda
1821 commands}.
1823 @table @kbd
1824 @item C-c a m
1825 Produce a list of all headlines that match a given set of tags.  The
1826 command prompts for a selection criterion, which is a boolean logic
1827 expression with tags, like @samp{+work+urgent-withboss} or
1828 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
1829 define a custom command for it (@pxref{Agenda dispatcher}).
1830 @item C-c a M
1831 Like @kbd{C-c a m}, but only select headlines that are also TODO items.
1832 @end table
1834 @subsubheading Match syntax
1836 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
1837 OR.  @samp{&} binds more strongly than @samp{|}.  Parentheses are currently
1838 not implemented.  Each element in the search is either a tag, a regular
1839 expression matching tags, or an expression like @code{PROPERTY OPERATOR
1840 VALUE} with a comparison operator, accessing a property value.  Each element
1841 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
1842 sugar for positive selection.  The AND operator @samp{&} is optional when
1843 @samp{+} or @samp{-} is present.  Here are some examples, using only tags.
1845 @table @samp
1846 @item +work-boss
1847 Select headlines tagged @samp{:work:}, but discard those also tagged
1848 @samp{:boss:}.
1849 @item work|laptop
1850 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
1851 @item work|laptop+night
1852 Like before, but require the @samp{:laptop:} lines to be tagged also
1853 @samp{:night:}.
1854 @end table
1856 You may also test for properties at the same
1857 time as matching tags, see the manual for more information.
1859 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
1860 @subsection Timeline for a single file
1862 The timeline summarizes all time-stamped items from a single Org mode
1863 file in a @emph{time-sorted view}.  The main purpose of this command is
1864 to give an overview over events in a project.
1866 @table @kbd
1867 @item C-c a L
1868 Show a time-sorted view of the Org file, with all time-stamped items.
1869 When called with a @kbd{C-u} prefix, all unfinished TODO entries
1870 (scheduled or not) are also listed under the current date.
1871 @end table
1873 @node Search view,  , Timeline, Built-in agenda views
1874 @subsection Search view
1876 This agenda view is a general text search facility for Org mode entries.
1877 It is particularly useful to find notes.
1879 @table @kbd
1880 @item C-c a s
1881 This is a special search that lets you select entries by matching a substring
1882 or specific words using a boolean logic.
1883 @end table
1884 For example, the search string @samp{computer equipment} will find entries
1885 that contain @samp{computer equipment} as a substring. 
1886 Search view can also search for specific keywords in the entry, using Boolean
1887 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
1888 will search for note entries that contain the keywords @code{computer}
1889 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
1890 not matched by the regular expression @code{8\.11[bg]}, meaning to
1891 exclude both 8.11b and 8.11g. 
1893 Note that in addition to the agenda files, this command will also search
1894 the files listed in @code{org-agenda-text-search-extra-files}.
1896 @node Agenda commands, Custom agenda views, Built-in agenda views, Agenda Views
1897 @section Commands in the agenda buffer
1899 Entries in the agenda buffer are linked back to the Org file or diary
1900 file where they originate.  Commands are provided to show and jump to the
1901 original entry location, and to edit the Org files ``remotely'' from
1902 the agenda buffer.  This is just a selection of the many commands, explore
1903 the @code{Agenda} menu and the manual for a complete list.
1905 @table @kbd
1906 @tsubheading{Motion}
1907 @item n
1908 Next line (same as @key{up} and @kbd{C-p}).
1909 @item p
1910 Previous line (same as @key{down} and @kbd{C-n}).
1911 @tsubheading{View/Go to Org file}
1912 @item mouse-3
1913 @itemx @key{SPC}
1914 Display the original location of the item in another window.
1915 With prefix arg, make sure that the entire entry is made visible in the
1916 outline, not only the heading.
1918 @itemx @key{TAB}
1919 Go to the original location of the item in another window.  Under Emacs
1920 22, @kbd{mouse-1} will also work for this.
1922 @itemx @key{RET}
1923 Go to the original location of the item and delete other windows.
1926 @tsubheading{Change display}
1927 @item o
1928 Delete other windows.
1930 @item d @r{/} w
1931 Switch to day/week view. 
1933 @item f @r{and} b
1934 Go forward/backward in time to display the following
1935 @code{org-agenda-current-span} days.  For example, if the display covers a
1936 week, switch to the following/previous week.
1938 @item .
1939 Go to today.
1941 @item j
1942 Prompt for a date and go there.
1944 @item v l @ @r{or short} @ l
1945 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
1946 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
1947 entries that have been clocked on that day.  When called with a @kbd{C-u}
1948 prefix, show all possible logbook entries, including state changes.
1950 @item r @r{or} g
1951 Recreate the agenda buffer, to reflect the changes.
1952 @item s
1953 Save all Org buffers in the current Emacs session, and also the locations of
1954 IDs.
1956 @tsubheading{Secondary filtering and query editing}
1958 @item /
1959 Filter the current agenda view with respect to a tag.  You are prompted for a
1960 letter to select a tag.  Press @samp{-} first to select against the tag.
1962 @item \
1963 Narrow the current agenda filter by an additional condition.
1965 @tsubheading{Remote editing (see the manual for many more commands)}
1967 @item 0--9
1968 Digit argument.
1970 @item t
1971 Change the TODO state of the item, in the agenda and in the
1972 org file.
1974 @item C-k
1975 Delete the current agenda item along with the entire subtree belonging
1976 to it in the original Org file.
1978 @item C-c C-w
1979 Refile the entry at point.
1981 @item C-c C-x C-a @ @r{or short} @ a
1982 Archive the subtree corresponding to the entry at point using the default
1983 archiving command set in @code{org-archive-default-command}.
1985 @item C-c C-x C-s @ @r{or short} @ $
1986 Archive the subtree corresponding to the current headline.
1988 @item C-c C-s
1989 Schedule this item, with prefix arg remove the scheduling timestamp
1991 @item C-c C-d
1992 Set a deadline for this item, with prefix arg remove the deadline.
1994 @item S-@key{right} @r{and} S-@key{left}
1995 Change the timestamp associated with the current line by one day.
1997 @item I
1998 Start the clock on the current item.
2000 @item O / X
2001 Stop/cancel the previously started clock.
2003 @item J
2004 Jump to the running clock in another window.
2005 @end table
2007 @node Custom agenda views,  , Agenda commands, Agenda Views
2008 @section Custom agenda views
2010 The main application of custom searches is the definition of keyboard
2011 shortcuts for frequently used searches, either creating an agenda
2012 buffer, or a sparse tree (the latter covering of course only the current
2013 buffer).
2014 Custom commands are configured in the variable
2015 @code{org-agenda-custom-commands}.  You can customize this variable, for
2016 example by pressing @kbd{C-c a C}.  You can also directly set it with
2017 Emacs Lisp in @file{.emacs}.  The following example contains all valid
2018 search types:
2020 @smalllisp
2021 @group
2022 (setq org-agenda-custom-commands
2023       '(("w" todo "WAITING")
2024         ("u" tags "+boss-urgent")
2025         ("v" tags-todo "+boss-urgent")))
2026 @end group
2027 @end smalllisp
2029 @noindent
2030 The initial string in each entry defines the keys you have to press after the
2031 dispatcher command @kbd{C-c a} in order to access the command.  Usually this
2032 will be just a single character.  The second parameter is the search type,
2033 followed by the string or regular expression to be used for the matching.
2034 The example above will therefore define:
2036 @table @kbd
2037 @item C-c a w
2038 as a global search for TODO entries with @samp{WAITING} as the TODO
2039 keyword
2040 @item C-c a u
2041 as a global tags search for headlines marked @samp{:boss:} but not
2042 @samp{:urgent:}
2043 @item C-c a v
2044 as the same search as @kbd{C-c a u}, but limiting the search to
2045 headlines that are also TODO items
2046 @end table
2048 @seealso{
2049 @uref{http://orgmode.org/manual/Agenda-Views.html#Agenda-Views, Chapter 10 of
2050 the manual}@*
2051 @uref{http://orgmode.org/worg/org-tutorials/org-custom-agenda-commands.php,
2052 Mat Lundin's tutorial about custom agenda commands}@*
2053 @uref{http://www.newartisans.com/2007/08/using-org-mode-as-a-day-planner.html,
2054 John Wiegley's setup}}
2056 @node Markup, Exporting, Agenda Views, Top
2057 @chapter Markup for rich export
2059 When exporting Org-mode documents, the exporter tries to reflect the
2060 structure of the document as accurately as possible in the backend.  Since
2061 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
2062 Org mode has rules on how to prepare text for rich export.  This section
2063 summarizes the markup rules used in an Org-mode buffer.
2065 @menu
2066 * Structural markup elements::  The basic structure as seen by the exporter
2067 * Images and tables::           Images, tables and caption mechanism
2068 * Literal examples::            Source code examples with special formatting
2069 * Include files::               Include additional files into a document
2070 * Embedded @LaTeX{}::           @LaTeX{} can be freely used inside Org documents
2071 @end menu
2073 @node Structural markup elements, Images and tables, Markup, Markup
2074 @section Structural markup elements
2076 @menu
2077 * Document title::              Where the title is taken from
2078 * Headings and sections::       The document structure as seen by the exporter
2079 * Table of contents::           The if and where of the table of contents
2080 * Paragraphs::                  Paragraphs
2081 * Emphasis and monospace::      Bold, italic, etc.
2082 * Comment lines::               What will *not* be exported
2083 @end menu
2085 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
2086 @subheading Document title
2088 @noindent
2089 The title of the exported document is taken from the special line
2091 @smallexample
2092 #+TITLE: This is the title of the document
2093 @end smallexample
2095 @node Headings and sections, Table of contents, Document title, Structural markup elements
2096 @subheading Headings and sections
2098 The outline structure of the document as described in @ref{Document
2099 Structure}, forms the basis for defining sections of the exported document.
2100 However, since the outline structure is also used for (for example) lists of
2101 tasks, only the first three outline levels will be used as headings.  Deeper
2102 levels will become itemized lists.  You can change the location of this
2103 switch globally by setting the variable @code{org-export-headline-levels}, or on a
2104 per-file basis with a line
2106 @smallexample
2107 #+OPTIONS: H:4
2108 @end smallexample
2110 @node Table of contents, Paragraphs, Headings and sections, Structural markup elements
2111 @subheading Table of contents
2113 The table of contents is normally inserted directly before the first headline
2114 of the file.
2116 @smallexample
2117 #+OPTIONS: toc:2          (only to two levels in TOC)
2118 #+OPTIONS: toc:nil        (no TOC at all)
2119 @end smallexample
2121 @node Paragraphs, Emphasis and monospace, Table of contents, Structural markup elements
2122 @subheading Paragraphs, line breaks, and quoting
2124 Paragraphs are separated by at least one empty line.  If you need to enforce
2125 a line break within a paragraph, use @samp{\\} at the end of a line.
2127 To keep the line breaks in a region, but otherwise use normal formatting, you
2128 can use this construct, which can also be used to format poetry.
2130 @smallexample
2131 #+BEGIN_VERSE
2132  Great clouds overhead
2133  Tiny black birds rise and fall
2134  Snow covers Emacs
2136      -- AlexSchroeder
2137 #+END_VERSE
2138 @end smallexample
2140 When quoting a passage from another document, it is customary to format this
2141 as a paragraph that is indented on both the left and the right margin.  You
2142 can include quotations in Org-mode documents like this:
2144 @smallexample
2145 #+BEGIN_QUOTE
2146 Everything should be made as simple as possible,
2147 but not any simpler -- Albert Einstein
2148 #+END_QUOTE
2149 @end smallexample
2151 If you would like to center some text, do it like this:
2152 @smallexample
2153 #+BEGIN_CENTER
2154 Everything should be made as simple as possible, \\
2155 but not any simpler
2156 #+END_CENTER
2157 @end smallexample
2159 @node Emphasis and monospace, Comment lines, Paragraphs, Structural markup elements
2160 @subheading Emphasis and monospace
2162 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
2163 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
2164 in the code and verbatim string is not processed for Org-mode specific
2165 syntax, it is exported verbatim.  To insert a horizontal rules, use a line 
2166 consisting of only dashes, and at least 5 of them.
2168 @node Comment lines,  , Emphasis and monospace, Structural markup elements
2169 @subheading Comment lines
2171 Lines starting with zero or more whitespace characters followed by @samp{#}
2172 and a whitespace are treated as comments and will never be exported.  Also
2173 entire subtrees starting with the word @samp{COMMENT} will never be exported.
2174 Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
2175 ... @samp{#+END_COMMENT} will not be exported.
2177 @table @kbd
2178 @item C-c ;
2179 Toggle the COMMENT keyword at the beginning of an entry.
2180 @end table
2182 @node Images and tables, Literal examples, Structural markup elements, Markup
2183 @section Images and Tables
2185 For Org mode tables, the lines before the first horizontal separator line
2186 will become table header lines.  You can use the following lines somewhere
2187 before the table to assign a caption and a label for cross references, and in
2188 the text you can refer to the object with @code{[[tab:basic-data]]}:
2190 @smallexample
2191 #+CAPTION: This is the caption for the next table (or link)
2192 #+NAME:   tbl:basic-data
2193    | ... | ...|
2194    |-----|----|
2195 @end smallexample
2197 Some backends allow you to directly include images into the exported
2198 document.  Org does this, if a link to an image files does not have
2199 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
2200 define a caption for the image and maybe a label for internal cross
2201 references, you sure that the link is on a line by itself precede it with:
2203 @smallexample
2204 #+CAPTION: This is the caption for the next figure link (or table)
2205 #+NAME:   fig:SED-HR4049
2206 [[./img/a.jpg]]
2207 @end smallexample
2209 The same caption mechanism applies to other structures than images and tables
2210 (e.g., @LaTeX{} equations, source code blocks), provided the chosen export
2211 back-end supports them.
2213 @node Literal examples, Include files, Images and tables, Markup
2214 @section Literal examples
2216 You can include literal examples that should not be subjected to
2217 markup.  Such examples will be typeset in monospace, so this is well suited
2218 for source code and similar examples.
2220 @smallexample
2221 #+BEGIN_EXAMPLE
2222 Some example from a text file.
2223 #+END_EXAMPLE
2224 @end smallexample
2226 For simplicity when using small examples, you can also start the example
2227 lines with a colon followed by a space.  There may also be additional
2228 whitespace before the colon:
2230 @smallexample
2231 Here is an example
2232    : Some example from a text file.
2233 @end smallexample
2235 For source code from a programming language, or any other text
2236 that can be marked up by font-lock in Emacs, you can ask for it to
2237 look like the fontified Emacs buffer
2239 @smallexample
2240 #+BEGIN_SRC emacs-lisp
2241 (defun org-xor (a b)
2242    "Exclusive or."
2243    (if a (not b) b))
2244 #+END_SRC
2245 @end smallexample
2247 To edit the example in a special buffer supporting this language, use
2248 @kbd{C-c '} to both enter and leave the editing buffer.
2250 @node Include files, Embedded @LaTeX{}, Literal examples, Markup
2251 @section Include files
2253 During export, you can include the content of another file.  For example, to
2254 include your @file{.emacs} file, you could use:
2256 @smallexample
2257 #+INCLUDE: "~/.emacs" src emacs-lisp
2258 @end smallexample
2259 @noindent
2260 The optional second and third parameter are the markup (e.g.@: @samp{quote},
2261 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
2262 language for formatting the contents.  The markup is optional, if it is not
2263 given, the text will be assumed to be in Org mode format and will be
2264 processed normally. @kbd{C-c '} will visit the included file.
2266 @node Embedded @LaTeX{},  , Include files, Markup
2267 @section Embedded @LaTeX{}
2269 For scientific notes which need to be able to contain mathematical symbols
2270 and the occasional formula, Org-mode supports embedding @LaTeX{} code into
2271 its files.  You can directly use TeX-like syntax for special symbols, enter
2272 formulas and entire @LaTeX{} environments.
2274 @smallexample
2275 Angles are written as Greek letters \alpha, \beta and \gamma.  The mass if
2276 the sun is M_sun = 1.989 x 10^30 kg.  The radius of the sun is R_@{sun@} =
2277 6.96 x 10^8 m.  If $a^2=b$ and $b=2$, then the solution must be either
2278 $a=+\sqrt@{2@}$ or $a=-\sqrt@{2@}$.
2280 \begin@{equation@}
2281 x=\sqrt@{b@}
2282 \end@{equation@}
2283 @end smallexample
2284 @noindent  With
2285 @uref{http://orgmode.org/manual/LaTeX-fragments.html#LaTeX-fragments,special
2286 setup}, @LaTeX{} snippets will be included as images when exporting to HTML.
2288 @seealso{
2289 @uref{http://orgmode.org/manual/Markup.html#Markup, Chapter 11 of the manual}}
2291 @node Exporting, Publishing, Markup, Top
2292 @chapter Exporting
2294 Org-mode documents can be exported into a variety of other formats: ASCII
2295 export for inclusion into emails, HTML to publish on the web, @LaTeX{}/PDF
2296 for beautiful printed documents and DocBook to enter the world of many other
2297 formats using DocBook tools.  There is also export to iCalendar format so
2298 that planning information can be incorporated into desktop calendars.
2300 @menu
2301 * Export options::              Per-file export settings
2302 * The export dispatcher::       How to access exporter commands
2303 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
2304 * HTML export::                 Exporting to HTML
2305 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
2306 * iCalendar export::            Exporting to iCalendar
2307 @end menu
2309 @node Export options, The export dispatcher, Exporting, Exporting
2310 @section Export options
2312 The exporter recognizes special lines in the buffer which provide
2313 additional information.  These lines may be put anywhere in the file.
2314 The whole set of lines can be inserted into the buffer with @kbd{C-c
2315 C-e t}.
2317 @table @kbd
2318 @item C-c C-e t
2319 Insert template with export options, see example below.
2320 @end table
2322 @smallexample
2323 #+TITLE:       the title to be shown (default is the buffer name)
2324 #+AUTHOR:      the author (default taken from @code{user-full-name})
2325 #+DATE:        a date, fixed, or an Org timestamp
2326 #+EMAIL:       his/her email address (default from @code{user-mail-address})
2327 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
2328 #+KEYWORDS:    the page keywords, e.g.@: for the XHTML meta tag
2329 #+LANGUAGE:    language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
2330 #+OPTIONS:     H:2 num:t toc:t \n:nil ::t |:t ^:t f:t tex:t ...
2331 @end smallexample
2333 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
2334 @section The export dispatcher
2336 All export commands can be reached using the export dispatcher, which is
2337 a prefix key that prompts for an additional key specifying the command.
2338 Normally the entire file is exported, but if a region is active, it will be
2339 exported instead.
2341 @table @kbd
2342 @item C-c C-e
2343 Dispatcher for export and publishing commands.
2344 @end table
2346 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
2347 @section ASCII/Latin-1/UTF-8 export
2349 ASCII export produces a simple and very readable version of an Org-mode
2350 file, containing only plain ASCII.  Latin-1 and UTF-8 export augment the file
2351 with special characters and symbols available in these encodings.
2353 @table @kbd
2354 @item C-c C-e t a @ @ @r{and} @ @ C-c C-e t A
2355 Export as ASCII file or temporary buffer.
2356 @item C-c C-e t n @ @ @r{and} @ @ C-c C-e t N
2357 Like the above commands, but use Latin-1 encoding.
2358 @item C-c C-e t u @ @ @r{and} @ @ C-c C-e t U
2359 Like the above commands, but use UTF-8 encoding.
2360 @end table
2362 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
2363 @section HTML export
2365 @table @kbd
2366 @item C-c C-e h h
2367 Export as HTML file @file{myfile.html}.
2368 @item C-c C-e h o
2369 Export as HTML file and immediately open it with a browser.
2370 @end table
2372 To insert HTML that should be copied verbatim to
2373 the exported file use either
2375 @smallexample
2376 #+HTML: Literal HTML code for export
2377 @end smallexample
2378 @noindent or
2379 @smallexample
2380 #+BEGIN_HTML
2381 All lines between these markers are exported literally
2382 #+END_HTML
2383 @end smallexample
2385 @node @LaTeX{} and PDF export, iCalendar export, HTML export, Exporting
2386 @section @LaTeX{} and PDF export
2388 @table @kbd
2389 @item C-c C-e l l
2390 Export as @LaTeX{} file @file{myfile.tex}.
2391 @item C-c C-e l p
2392 Export as @LaTeX{} and then process to PDF.
2393 @item C-c C-e l o
2394 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
2395 @end table
2397 By default, the @LaTeX{} output uses the class @code{article}.  You can
2398 change this by adding an option like @code{#+LATEX_CLASS: myclass} in your
2399 file.  The class must be listed in @code{org-latex-classes}.
2401 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
2402 inserted into the @LaTeX{} file.  Similarly to the HTML exporter, you can use
2403 @code{#+LATEX:} and @code{#+BEGIN_LATEX ... #+END_LATEX} construct to add
2404 verbatim @LaTeX{} code.
2406 @node iCalendar export,  , @LaTeX{} and PDF export, Exporting
2407 @section iCalendar export
2409 @table @kbd
2410 @item C-c C-e c f
2411 Create iCalendar entries for the current file in a @file{.ics} file.
2412 @item C-c C-e c c
2413 Create a single large iCalendar file from all files in
2414 @code{org-agenda-files} and write it to the file given by
2415 @code{org-icalendar-combined-agenda-file}.
2416 @end table
2418 @seealso{
2419 @uref{http://orgmode.org/manual/Exporting.html#Exporting, Chapter 12 of the manual}@*
2420 @uref{http://orgmode.org/worg/org-tutorials/images-and-xhtml-export.php,
2421 Sebastian Rose's image handling tutorial}@*
2422 @uref{http://orgmode.org/worg/org-tutorials/org-latex-export.php, Thomas
2423 Dye's LaTeX export tutorial}
2424 @uref{http://orgmode.org/worg/org-tutorials/org-beamer/tutorial.php, Eric
2425 Fraga's BEAMER presentation tutorial}}
2427 @node Publishing, Working With Source Code, Exporting, Top
2428 @chapter Publishing
2430 Org includes a publishing management system that allows you to configure
2431 automatic HTML conversion of @emph{projects} composed of interlinked org
2432 files.  You can also configure Org to automatically upload your exported HTML
2433 pages and related attachments, such as images and source code files, to a web
2434 server.  For detailed instructions about setup, see the manual.
2436 Here is an example:
2438 @smalllisp
2439 (setq org-publish-project-alist
2440       '(("org"
2441          :base-directory "~/org/"
2442          :publishing-directory "~/public_html"
2443          :section-numbers nil
2444          :table-of-contents nil
2445          :style "<link rel=\"stylesheet\"
2446                 href=\"../other/mystyle.css\"
2447                 type=\"text/css\"/>")))
2448 @end smalllisp
2450 @table @kbd
2451 @item C-c C-e P x
2452 Prompt for a specific project and publish all files that belong to it.
2453 @item C-c C-e P p
2454 Publish the project containing the current file.
2455 @item C-c C-e P f
2456 Publish only the current file.
2457 @item C-c C-e P a
2458 Publish every project.
2459 @end table
2461 Org uses timestamps to track when a file has changed.  The above functions
2462 normally only publish changed files.  You can override this and force
2463 publishing of all files by giving a prefix argument to any of the commands
2464 above.
2466 @seealso{
2467 @uref{http://orgmode.org/manual/Publishing.html#Publishing, Chapter 13 of the
2468 manual}@*
2469 @uref{http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php,
2470 Sebastian Rose's publishing tutorial}@*
2471 @uref{http://orgmode.org/worg/org-tutorials/org-jekyll.php, Ian Barton's
2472 Jekyll/blogging setup}}
2474 @node Working With Source Code, Miscellaneous, Publishing, Top
2475 @chapter Working with source code
2476 Org-mode provides a number of features for working with source code,
2477 including editing of code blocks in their native major-mode, evaluation of
2478 code blocks, tangling of code blocks, and exporting code blocks and their
2479 results in several formats.
2481 @subheading Structure of Code Blocks
2482 The structure of code blocks is as follows:
2484 @example
2485 #+NAME: <name>
2486 #+BEGIN_SRC <language> <switches> <header arguments>
2487   <body>
2488 #+END_SRC
2489 @end example
2491 Where @code{<name>} is a string used to name the code block,
2492 @code{<language>} specifies the language of the code block
2493 (e.g.@: @code{emacs-lisp}, @code{shell}, @code{R}, @code{python}, etc...),
2494 @code{<switches>} can be used to control export of the code block,
2495 @code{<header arguments>} can be used to control many aspects of code block
2496 behavior as demonstrated below, and @code{<body>} contains the actual source
2497 code.
2499 @subheading Editing source code
2500 Use @kbd{C-c '} to edit the current code block.  This brings up a language
2501 major-mode edit buffer containing the body of the code block.  Saving this
2502 buffer will write the new contents back to the Org buffer.  Use @kbd{C-c '}
2503 again to exit the edit buffer.
2505 @subheading Evaluating code blocks
2506 Use @kbd{C-c C-c} to evaluate the current code block and insert its results
2507 in the Org-mode buffer.  By default, evaluation is only turned on for
2508 @code{emacs-lisp} code blocks, however support exists for evaluating blocks
2509 in many languages.  For a complete list of supported languages see the
2510 manual.  The following shows a code block and its results.
2512 @example
2513 #+BEGIN_SRC emacs-lisp
2514   (+ 1 2 3 4)
2515 #+END_SRC
2517 #+RESULTS:
2518 : 10
2519 @end example
2521 @subheading Extracting source code
2522 Use @kbd{C-c C-v t} to create pure source code files by extracting code from
2523 source blocks in the current buffer.  This is referred to as ``tangling''---a
2524 term adopted from the literate programming community.  During ``tangling'' of
2525 code blocks their bodies are expanded using @code{org-babel-expand-src-block}
2526 which can expand both variable and ``noweb'' style references.  In order to
2527 tangle a code block it must have a @code{:tangle} header argument, see the
2528 manual for details.
2530 @subheading Library of Babel
2531 Use @kbd{C-c C-v l} to load the code blocks from an Org-mode files into the
2532 ``Library of Babel'', these blocks can then be evaluated from any Org-mode
2533 buffer.  A collection of generally useful code blocks is distributed with
2534 Org-mode in @code{contrib/library-of-babel.org}.
2536 @subheading Header Arguments
2537 Many aspects of the evaluation and export of code blocks are controlled
2538 through header arguments.  These can be specified globally, at the file
2539 level, at the outline subtree level, and at the individual code block level.
2540 The following describes some of the header arguments.
2541 @table @code
2542 @item :var
2543 The @code{:var} header argument is used to pass arguments to code blocks.
2544 The values passed to arguments can be literal values, values from org-mode
2545 tables and literal example blocks, or the results of other named code blocks.
2546 @item :results
2547 The @code{:results} header argument controls the @emph{collection},
2548 @emph{type}, and @emph{handling} of code block results.  Values of
2549 @code{output} or @code{value} (the default) specify how results are collected
2550 from a code block's evaluation.  Values of @code{vector}, @code{scalar}
2551 @code{file} @code{raw} @code{html} @code{latex} and @code{code} specify the
2552 type of the results of the code block which dictates how they will be
2553 incorporated into the Org-mode buffer.  Values of @code{silent},
2554 @code{replace}, @code{prepend}, and @code{append} specify handling of code
2555 block results, specifically if and how the results should be inserted into
2556 the Org-mode buffer.
2557 @item :session
2558 A header argument of @code{:session} will cause the code block to be
2559 evaluated in a persistent interactive inferior process in Emacs.  This allows
2560 for persisting state between code block evaluations, and for manual
2561 inspection of the results of evaluation.
2562 @item :exports
2563 Any combination of the @emph{code} or the @emph{results} of a block can be
2564 retained on export, this is specified by setting the @code{:results} header
2565 argument to @code{code} @code{results} @code{none} or @code{both}.
2566 @item :tangle
2567 A header argument of @code{:tangle yes} will cause a code block's contents to
2568 be tangled to a file named after the filename of the Org-mode buffer.  An
2569 alternate file name can be specified with @code{:tangle filename}.
2570 @item :cache
2571 A header argument of @code{:cache yes} will cause associate a hash of the
2572 expanded code block with the results, ensuring that code blocks are only
2573 re-run when their inputs have changed.
2574 @item :noweb
2575 A header argument of @code{:noweb yes} will expand ``noweb'' style references
2576 on evaluation and tangling.
2577 @item :file
2578 Code blocks which output results to files (e.g.@: graphs, diagrams and figures)
2579 can accept a @code{:file filename} header argument in which case the results
2580 are saved to the named file, and a link to the file is inserted into the
2581 Org-mode buffer.
2582 @end table
2584 @seealso{
2585 @uref{http://orgmode.org/manual/Literal-examples.html#Literal-examples,
2586 Chapter 11.3 of the manual}@*
2587 @uref{http://orgmode.org/worg/org-contrib/babel/index.php,
2588 The Babel site on Worg}}
2590 @node Miscellaneous, GNU Free Documentation License, Working With Source Code, Top
2591 @chapter Miscellaneous
2593 @menu
2594 * Completion::                  M-TAB knows what you need
2595 * Clean view::                  Getting rid of leading stars in the outline
2596 * MobileOrg::                   Org-mode on the iPhone
2597 @end menu
2599 @node Completion, Clean view, Miscellaneous, Miscellaneous
2600 @section Completion
2602 Org supports in-buffer completion with @kbd{M-@key{TAB}}.  This type of
2603 completion does not make use of the minibuffer.  You simply type a few
2604 letters into the buffer and use the key to complete text right there.  For
2605 example, this command will complete @TeX{} symbols after @samp{\}, TODO
2606 keywords at the beginning of a headline, and tags after @samp{:} in a
2607 headline.
2609 @node Clean view, MobileOrg, Completion, Miscellaneous
2610 @section A cleaner outline view
2612 Some people find it noisy and distracting that the Org headlines start with a
2613 potentially large number of stars, and that text below the headlines is not
2614 indented.  While this is no problem when writing a @emph{book-like} document
2615 where the outline headings are really section headings, in a more
2616 @emph{list-oriented} outline, indented structure is a lot cleaner:
2618 @smallexample
2619 @group
2620 * Top level headline             |    * Top level headline
2621 ** Second level                  |      * Second level
2622 *** 3rd level                    |        * 3rd level
2623 some text                        |          some text
2624 *** 3rd level                    |        * 3rd level
2625 more text                        |          more text
2626 * Another top level headline     |    * Another top level headline
2627 @end group
2628 @end smallexample
2630 @noindent
2631 If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
2632 of view can be achieved dynamically at display time using
2633 @code{org-indent-mode}, which will prepend intangible space to each line.
2634 You can turn on @code{org-indent-mode} for all files by customizing the
2635 variable @code{org-startup-indented}, or you can turn it on for individual
2636 files using
2638 @smallexample
2639 #+STARTUP: indent
2640 @end smallexample
2642 If you want a similar effect in earlier version of Emacs and/or Org, or if
2643 you want the indentation to be hard space characters so that the plain text
2644 file looks as similar as possible to the Emacs display, Org supports you by
2645 helping to indent (with @key{TAB}) text below each headline, by hiding
2646 leading stars, and by only using levels 1, 3, etc to get two characters
2647 indentation for each level.  To get this support in a file, use
2649 @smallexample
2650 #+STARTUP: hidestars odd
2651 @end smallexample
2653 @node MobileOrg,  , Clean view, Miscellaneous
2654 @section MobileOrg
2656 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
2657 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
2658 capture support for an Org mode system rooted on a ``real'' computer.  It
2659 does also allow you to record changes to existing entries.
2661 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
2662 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
2663 Moreland. Android users should check out
2664 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
2665 by Matt Jones.  The two implementations are not identical but offer similar
2666 features.
2668 @seealso{
2669 @uref{http://orgmode.org/manual/Miscellaneous.html#Miscellaneous, Chapter 15
2670 of the manual}@*
2671 @uref{http://orgmode.org/manual/MobileOrg.html#MobileOrg, Appendix B of the
2672 manual}@*
2673 @uref{http://orgmode.org/orgcard.pdf,Key reference card}}
2676 @c @node GNU Free Documentation License,  , Miscellaneous, Top
2677 @c @appendix GNU Free Documentation License
2678 @c @include doclicense.texi
2681 @bye
2683 @c Local variables:
2684 @c fill-column: 77
2685 @c End:
2688 @c  LocalWords:  webdavhost pre