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 Bastien Guerry
17 @set MAINTAINEREMAIL @email{bzg at gnu dot org}
18 @set MAINTAINERCONTACT @uref{mailto:bzg at gnu dot org,contact the maintainer}
24 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
27 @c Subheadings inside a table.
28 @macro tsubheading{text}
38 @noindent @b{Further reading}@*@noindent \text\
42 Copyright @copyright{} 2010--2013 Free Software Foundation
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.''
52 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
53 modify this GNU manual.''
59 * Org Mode Guide: (orgguide). Abbreviated Org-mode Manual
63 @title The compact Org-mode Guide
65 @subtitle Release @value{VERSION}
66 @author by Carsten Dominik
68 @c The following two commands start the copyright page.
70 @vskip 0pt plus 1filll
74 @c Output the table of contents at the beginning.
78 @node Top, Introduction, (dir), (dir)
85 * Introduction:: Getting started
86 * Document Structure:: A tree works like your brain
87 * Tables:: Pure magic for quick formatting
88 * Hyperlinks:: Notes in context
89 * TODO Items:: Every tree branch can be a TODO item
90 * Tags:: Tagging headlines and matching sets of tags
91 * Properties:: Properties
92 * Dates and Times:: Making items useful for planning
93 * Capture - Refile - Archive:: The ins and outs for projects
94 * Agenda Views:: Collecting information into views
95 * Markup:: Prepare text for rich export
96 * Exporting:: Sharing and publishing of notes
97 * Publishing:: Create a web site of linked Org files
98 * Working With Source Code:: Source code snippets embedded in Org
99 * Miscellaneous:: All the rest which did not fit elsewhere
101 * GNU Free Documentation License:: This manual license.
104 --- The Detailed Node Listing ---
109 * Installation:: How to install a downloaded version of Org
110 * Activation:: How to activate Org for certain buffers
111 * Feedback:: Bug reports, ideas, patches etc.
115 * Outlines:: Org is based on Outline mode
116 * Headlines:: How to typeset Org tree headlines
117 * Visibility cycling:: Show and hide, much simplified
118 * Motion:: Jumping to other headlines
119 * Structure editing:: Changing sequence and level of headlines
120 * Sparse trees:: Matches embedded in context
121 * Plain lists:: Additional structure within an entry
122 * Footnotes:: How footnotes are defined in Org's syntax
126 * Link format:: How links in Org are formatted
127 * Internal links:: Links to other places in the current file
128 * External links:: URL-like links to the world
129 * Handling links:: Creating, inserting and following
130 * Targeted links:: Point at a location in a file
134 * Using TODO states:: Setting and switching states
135 * Multi-state workflows:: More than just on/off
136 * Progress logging:: Dates and notes for progress
137 * Priorities:: Some things are more important than others
138 * Breaking down tasks:: Splitting a task into manageable pieces
139 * Checkboxes:: Tick-off lists
143 * Closing items:: When was this entry marked DONE?
144 * Tracking TODO state changes:: When did the status change?
148 * Tag inheritance:: Tags use the tree structure of the outline
149 * Setting tags:: How to assign tags to a headline
150 * Tag searches:: Searching for combinations of tags
151 * Tag searches:: Searching for combinations of tags
155 * Timestamps:: Assigning a time to a tree entry
156 * Creating timestamps:: Commands which insert timestamps
157 * Deadlines and scheduling:: Planning your work
158 * Clocking work time:: Tracking how long you spend on a task
160 Capture - Refile - Archive
162 * Capture:: Capturing new stuff
163 * Refile and copy:: Moving a tree from one place to another
164 * Archiving:: What to do with finished projects
168 * Setting up a capture location:: Where notes will be stored
169 * Using capture:: Commands to invoke and terminate capture
170 * Capture templates:: Define the outline of different note types
174 * Agenda files:: Files being searched for agenda information
175 * Agenda dispatcher:: Keyboard access to agenda views
176 * Built-in agenda views:: What is available out of the box?
177 * Agenda commands:: Remote editing of Org trees
178 * Custom agenda views:: Defining special searches and views
180 The built-in agenda views
182 * Weekly/daily agenda:: The calendar page with current tasks
183 * Global TODO list:: All unfinished action items
184 * Matching tags and properties:: Structured information with fine-tuned search
185 * Timeline:: Time-sorted view for single file
186 * Search view:: Find entries by searching for text
188 Markup for rich export
190 * Structural markup elements:: The basic structure as seen by the exporter
191 * Images and tables:: Tables and Images will be included
192 * Literal examples:: Source code examples with special formatting
193 * Include files:: Include additional files into a document
194 * Embedded @LaTeX{}:: @LaTeX{} can be freely used inside Org documents
196 Structural markup elements
198 * Document title:: Where the title is taken from
199 * Headings and sections:: The document structure as seen by the exporter
200 * Table of contents:: The if and where of the table of contents
201 * Paragraphs:: Paragraphs
202 * Emphasis and monospace:: Bold, italic, etc.
203 * Comment lines:: What will *not* be exported
207 * Export options:: Per-file export settings
208 * The export dispatcher:: How to access exporter commands
209 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
210 * HTML export:: Exporting to HTML
211 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
212 * DocBook export:: Exporting to DocBook
217 * Completion:: M-TAB knows what you need
218 * Clean view:: Getting rid of leading stars in the outline
219 * MobileOrg:: Org-mode on the iPhone
224 @node Introduction, Document Structure, Top, Top
225 @chapter Introduction
229 * Installation:: How to install a downloaded version of Org
230 * Activation:: How to activate Org for certain buffers
231 * Feedback:: Bug reports, ideas, patches etc.
234 @node Preface, Installation, Introduction, Introduction
237 Org is a mode for keeping notes, maintaining TODO lists, and doing project
238 planning with a fast and effective plain-text system. It is also an
239 authoring and publishing system.
241 @i{This document is a much compressed derivative of the
242 @uref{http://orgmode.org/index.html#sec-4_1, comprehensive Org-mode manual}.
243 It contains all basic features and commands, along with important hints for
244 customization. It is intended for beginners who would shy back from a 200
245 page manual because of sheer size.}
247 @node Installation, Activation, Preface, Introduction
248 @section Installation
250 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
251 distribution or an XEmacs package, please skip this section and go directly
252 to @ref{Activation}.}
254 If you have downloaded Org from the Web, either as a distribution @file{.zip}
255 or @file{.tar} file, or as a Git archive, it is best to run it directly from
256 the distribution directory. You need to add the @file{lisp} subdirectories
257 to the Emacs load path. To do this, add the following line to @file{.emacs}:
260 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
261 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
264 @noindent For speed you should byte-compile the Lisp files with the shell
271 @node Activation, Feedback, Installation, Introduction
274 Add the following lines to your @file{.emacs} file. The last three lines
275 define @emph{global} keys for some commands --- please choose suitable keys
279 ;; The following lines are always needed. Choose your own keys.
280 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) ; not needed since Emacs 22.2
281 (add-hook 'org-mode-hook 'turn-on-font-lock) ; not needed when global-font-lock-mode is on
282 (global-set-key "\C-cl" 'org-store-link)
283 (global-set-key "\C-ca" 'org-agenda)
284 (global-set-key "\C-cb" 'org-iswitchb)
287 With this setup, all files with extension @samp{.org} will be put
290 @node Feedback, , Activation, Introduction
293 If you find problems with Org, or if you have questions, remarks, or ideas
294 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
295 For information on how to submit bug reports, see the main manual.
297 @node Document Structure, Tables, Introduction, Top
298 @chapter Document Structure
300 Org is based on Outline mode and provides flexible commands to
301 edit the structure of the document.
304 * Outlines:: Org is based on Outline mode
305 * Headlines:: How to typeset Org tree headlines
306 * Visibility cycling:: Show and hide, much simplified
307 * Motion:: Jumping to other headlines
308 * Structure editing:: Changing sequence and level of headlines
309 * Sparse trees:: Matches embedded in context
310 * Plain lists:: Additional structure within an entry
311 * Footnotes:: How footnotes are defined in Org's syntax
314 @node Outlines, Headlines, Document Structure, Document Structure
317 Org is implemented on top of Outline mode. Outlines allow a
318 document to be organized in a hierarchical structure, which (at least
319 for me) is the best representation of notes and thoughts. An overview
320 of this structure is achieved by folding (hiding) large parts of the
321 document to show only the general document structure and the parts
322 currently being worked on. Org greatly simplifies the use of
323 outlines by compressing the entire show/hide functionality into a single
324 command, @command{org-cycle}, which is bound to the @key{TAB} key.
326 @node Headlines, Visibility cycling, Outlines, Document Structure
329 Headlines define the structure of an outline tree. The headlines in
330 Org start with one or more stars, on the left margin@footnote{See
331 the variable @code{org-special-ctrl-a/e} to configure special behavior
332 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
342 * Another top level headline
345 @noindent Some people find the many stars too noisy and would prefer an
346 outline that has whitespace followed by a single star as headline
347 starters. @ref{Clean view}, describes a setup to realize this.
349 @node Visibility cycling, Motion, Headlines, Document Structure
350 @section Visibility cycling
352 Outlines make it possible to hide parts of the text in the buffer.
353 Org uses just two commands, bound to @key{TAB} and
354 @kbd{S-@key{TAB}} to change the visibility in the buffer.
358 @emph{Subtree cycling}: Rotate current subtree among the states
361 ,-> FOLDED -> CHILDREN -> SUBTREE --.
362 '-----------------------------------'
365 When called with a prefix argument (@kbd{C-u @key{TAB}}) or with the shift
366 key, global cycling is invoked.
368 @item S-@key{TAB} @r{and} C-u @key{TAB}
369 @emph{Global cycling}: Rotate the entire buffer among the states
372 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
373 '--------------------------------------'
376 @item C-u C-u C-u @key{TAB}
377 Show all, including drawers.
380 When Emacs first visits an Org file, the global state is set to
381 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
382 configured through the variable @code{org-startup-folded}, or on a
383 per-file basis by adding a startup keyword @code{overview}, @code{content},
384 @code{showall}, like this:
391 @node Motion, Structure editing, Visibility cycling, Document Structure
393 The following commands jump to other headlines in the buffer.
401 Next heading same level.
403 Previous heading same level.
405 Backward to higher level heading.
408 @node Structure editing, Sparse trees, Motion, Document Structure
409 @section Structure editing
413 Insert new heading with same level as current. If the cursor is in a plain
414 list item, a new item is created (@pxref{Plain lists}). When this command is
415 used in the middle of a line, the line is split and the rest of the line
416 becomes the new headline@footnote{If you do not want the line to be split,
417 customize the variable @code{org-M-RET-may-split-line}.}.
419 Insert new TODO entry with same level as current heading.
420 @item @key{TAB} @r{in new, empty entry}
421 In a new entry with no text yet, @key{TAB} will cycle through reasonable
423 @item M-@key{left}@r{/}@key{right}
424 Promote/demote current heading by one level.
425 @item M-S-@key{left}@r{/}@key{right}
426 Promote/demote the current subtree by one level.
427 @item M-S-@key{up}@r{/}@key{down}
428 Move subtree up/down (swap with previous/next subtree of same
431 Refile entry or region to a different location. @xref{Refile and copy}.
433 Narrow buffer to current subtree / widen it again
436 When there is an active region (Transient Mark mode), promotion and
437 demotion work on all headlines in the region.
439 @node Sparse trees, Plain lists, Structure editing, Document Structure
440 @section Sparse trees
442 An important feature of Org mode is the ability to construct @emph{sparse
443 trees} for selected information in an outline tree, so that the entire
444 document is folded as much as possible, but the selected information is made
445 visible along with the headline structure above it@footnote{See also the
446 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
447 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
448 control on how much context is shown around each match.}. Just try it out
449 and you will see immediately how it works.
451 Org mode contains several commands creating such trees, all these
452 commands can be accessed through a dispatcher:
456 This prompts for an extra key to select a sparse-tree creating command.
458 Occur. Prompts for a regexp and shows a sparse tree with all matches. Each
459 match is also highlighted; the highlights disappear by pressing @kbd{C-c C-c}.
462 The other sparse tree commands select headings based on TODO keywords,
463 tags, or properties and will be discussed later in this manual.
465 @node Plain lists, Footnotes, Sparse trees, Document Structure
468 Within an entry of the outline tree, hand-formatted lists can provide
469 additional structure. They also provide a way to create lists of
470 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
471 and the HTML exporter (@pxref{Exporting}) parses and formats them.
473 Org knows ordered lists, unordered lists, and description lists.
476 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
479 @emph{Ordered} list items start with @samp{1.} or @samp{1)}.
481 @emph{Description} list use @samp{ :: } to separate the @emph{term} from the
485 Items belonging to the same list must have the same indentation on the first
486 line. An item ends before the next line that is indented like its
487 bullet/number, or less. A list ends when all items are closed, or before two
488 blank lines. An example:
493 My favorite scenes are (in this order)
494 1. The attack of the Rohirrim
495 2. Eowyn's fight with the witch king
496 + this was already my favorite scene in the book
497 + I really like Miranda Otto.
498 Important actors in this film are:
499 - @b{Elijah Wood} :: He plays Frodo
500 - @b{Sean Austin} :: He plays Sam, Frodo's friend.
504 The following commands act on items when the cursor is in the first line of
505 an item (the line with the bullet or number).
509 Items can be folded just like headline levels.
511 Insert new item at current level. With a prefix argument, force a new
512 heading (@pxref{Structure editing}).
514 Insert a new item with a checkbox (@pxref{Checkboxes}).
515 @item M-S-@key{up}@r{/}@key{down}
516 Move the item including subitems up/down (swap with previous/next item
517 of same indentation). If the list is ordered, renumbering is
519 @item M-@key{left}@r{/}M-@key{right}
520 Decrease/increase the indentation of an item, leaving children alone.
521 @item M-S-@key{left}@r{/}@key{right}
522 Decrease/increase the indentation of the item, including subitems.
524 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
525 state of the checkbox. Also verify bullets and indentation consistency in
528 Cycle the entire list level through the different itemize/enumerate bullets
529 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
532 @node Footnotes, , Plain lists, Document Structure
535 A footnote is defined in a paragraph that is started by a footnote marker in
536 square brackets in column 0, no indentation allowed. The footnote reference
537 is simply the marker in square brackets, inside text. For example:
540 The Org homepage[fn:1] now looks a lot better than it used to.
542 [fn:1] The link is: http://orgmode.org
545 @noindent The following commands handle footnotes:
549 The footnote action command. When the cursor is on a footnote reference,
550 jump to the definition. When it is at a definition, jump to the (first)
551 reference. Otherwise, create a new footnote. When this command is called
552 with a prefix argument, a menu of additional options including renumbering is
556 Jump between definition and reference.
560 @uref{http://orgmode.org/manual/Document-Structure.html#Document-Structure,
561 Chapter 2 of the manual}@*
562 @uref{http://sachachua.com/wp/2008/01/outlining-your-notes-with-org/,
563 Sacha Chua's tutorial}}
566 @node Tables, Hyperlinks, Document Structure, Top
569 Org comes with a fast and intuitive table editor. Spreadsheet-like
570 calculations are supported in connection with the Emacs @file{calc}
573 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
576 (see the Emacs Calculator manual for more information about the Emacs
580 Org makes it easy to format tables in plain ASCII. Any line with
581 @samp{|} as the first non-whitespace character is considered part of a
582 table. @samp{|} is also the column separator. A table might look like
586 | Name | Phone | Age |
587 |-------+-------+-----|
588 | Peter | 1234 | 17 |
592 A table is re-aligned automatically each time you press @key{TAB} or
593 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
594 the next field (@key{RET} to the next row) and creates new table rows
595 at the end of the table or before horizontal lines. The indentation
596 of the table is set by the first line. Any line starting with
597 @samp{|-} is considered as a horizontal separator line and will be
598 expanded on the next re-align to span the whole table width. So, to
599 create the above table, you would only type
606 @noindent and then press @key{TAB} to align the table and start filling in
607 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
610 When typing text into a field, Org treats @key{DEL},
611 @key{Backspace}, and all character keys in a special way, so that
612 inserting and deleting avoids shifting other fields. Also, when
613 typing @emph{immediately after the cursor was moved into a new field
614 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
615 field is automatically made blank.
618 @tsubheading{Creation and conversion}
620 Convert the active region to table. If every line contains at least one TAB
621 character, the function assumes that the material is tab separated. If every
622 line contains a comma, comma-separated values (CSV) are assumed. If not,
623 lines are split at whitespace into fields.
625 If there is no active region, this command creates an empty Org
626 table. But it's easier just to start typing, like
627 @kbd{|Name|Phone|Age C-c @key{RET}}.
629 @tsubheading{Re-aligning and field motion}
631 Re-align the table without moving the cursor.
634 Re-align the table, move to the next field. Creates a new row if
638 Re-align, move to previous field.
641 Re-align the table and move down to next row. Creates a new row if
644 @tsubheading{Column and row editing}
647 Move the current column left/right.
650 Kill the current column.
652 @item M-S-@key{right}
653 Insert a new column to the left of the cursor position.
657 Move the current row up/down.
660 Kill the current row or horizontal line.
663 Insert a new row above the current row. With a prefix argument, the line is
664 created below the current one.
667 Insert a horizontal line below current row. With a prefix argument, the line
668 is created above the current line.
671 Insert a horizontal line below current row, and move the cursor into the row
675 Sort the table lines in the region. The position of point indicates the
676 column to be used for sorting, and the range of lines is the range
677 between the nearest horizontal separator lines, or the entire table.
682 @uref{http://orgmode.org/manual/Tables.html#Tables, Chapter 3 of the
684 @uref{http://orgmode.org/worg/org-tutorials/tables.php, Bastien's
686 @uref{http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.php,
687 Bastien's spreadsheet tutorial}@*
688 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php, Eric's plotting tutorial}}
690 @node Hyperlinks, TODO Items, Tables, Top
693 Like HTML, Org provides links inside a file, external links to
694 other files, Usenet articles, emails, and much more.
697 * Link format:: How links in Org are formatted
698 * Internal links:: Links to other places in the current file
699 * External links:: URL-like links to the world
700 * Handling links:: Creating, inserting and following
701 * Targeted links:: Point at a location in a file
704 @node Link format, Internal links, Hyperlinks, Hyperlinks
707 Org will recognize plain URL-like links and activate them as
708 clickable links. The general link format, however, looks like this:
711 [[link][description]] @r{or alternatively} [[link]]
715 Once a link in the buffer is complete (all brackets present), Org will change
716 the display so that @samp{description} is displayed instead of
717 @samp{[[link][description]]} and @samp{link} is displayed instead of
718 @samp{[[link]]}. To edit the invisible @samp{link} part, use @kbd{C-c
719 C-l} with the cursor on the link.
721 @node Internal links, External links, Link format, Hyperlinks
722 @section Internal links
724 If the link does not look like a URL, it is considered to be internal in the
725 current file. The most important case is a link like
726 @samp{[[#my-custom-id]]} which will link to the entry with the
727 @code{CUSTOM_ID} property @samp{my-custom-id}.
729 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
730 lead to a text search in the current file for the corresponding target which
731 looks like @samp{<<My Target>>}.
733 @node External links, Handling links, Internal links, Hyperlinks
734 @section External links
736 Org supports links to files, websites, Usenet and email messages,
737 BBDB database entries and links to both IRC conversations and their
738 logs. External links are URL-like locators. They start with a short
739 identifying string followed by a colon. There can be no space after
740 the colon. Here are some examples:
743 http://www.astro.uva.nl/~dominik @r{on the web}
744 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
745 /home/dominik/images/jupiter.jpg @r{same as above}
746 file:papers/last.pdf @r{file, relative path}
747 file:projects.org @r{another Org file}
748 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
749 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
750 news:comp.emacs @r{Usenet link}
751 mailto:adent@@galaxy.net @r{Mail link}
752 vm:folder @r{VM folder link}
753 vm:folder#id @r{VM message link}
754 wl:folder#id @r{WANDERLUST message link}
755 mhe:folder#id @r{MH-E message link}
756 rmail:folder#id @r{RMAIL message link}
757 gnus:group#id @r{Gnus article link}
758 bbdb:R.*Stallman @r{BBDB link (with regexp)}
759 irc:/irc.com/#emacs/bob @r{IRC link}
760 info:org:External%20links @r{Info node link (with encoded space)}
763 A link should be enclosed in double brackets and may contain a
764 descriptive text to be displayed instead of the URL (@pxref{Link
765 format}), for example:
768 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
772 If the description is a file name or URL that points to an image, HTML export
773 (@pxref{HTML export}) will inline the image as a clickable button. If there
774 is no description at all and the link points to an image, that image will be
775 inlined into the exported HTML file.
777 @node Handling links, Targeted links, External links, Hyperlinks
778 @section Handling links
780 Org provides methods to create a link in the correct syntax, to
781 insert it into an Org file, and to follow the link.
785 Store a link to the current location. This is a @emph{global} command (you
786 must create the key binding yourself) which can be used in any buffer to
787 create a link. The link will be stored for later insertion into an Org
791 Insert a link. This prompts for a link to be inserted into the buffer. You
792 can just type a link, or use history keys @key{up} and @key{down} to access
793 stored links. You will be prompted for the description part of the link.
794 When called with a @kbd{C-u} prefix argument, file name completion is used to
797 @item C-c C-l @r{(with cursor on existing link)}
798 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
799 link and description parts of the link.
801 @item C-c C-o @r{or} mouse-1 @r{or} mouse-2
804 Jump back to a recorded position. A position is recorded by the
805 commands following internal links, and by @kbd{C-c %}. Using this
806 command several times in direct succession moves through a ring of
807 previously recorded positions.
811 @node Targeted links, , Handling links, Hyperlinks
812 @section Targeted links
814 File links can contain additional information to make Emacs jump to a
815 particular location in the file when following a link. This can be a
816 line number or a search option after a double colon.
818 Here is the syntax of the different ways to attach a search to a file
819 link, together with an explanation:
822 [[file:~/code/main.c::255]] @r{Find line 255}
823 [[file:~/xx.org::My Target]] @r{Find @samp{<<My Target>>}}
824 [[file:~/xx.org::#my-custom-id]] @r{Find entry with custom id}
828 @uref{http://orgmode.org/manual/Hyperlinks.html#Hyperlinks, Chapter 4 of the
831 @node TODO Items, Tags, Hyperlinks, Top
834 Org mode does not maintain TODO lists as separate documents@footnote{Of
835 course, you can make a document that contains only long lists of TODO items,
836 but this is not required.}. Instead, TODO items are an integral part of the
837 notes file, because TODO items usually come up while taking notes! With Org
838 mode, simply mark any entry in a tree as being a TODO item. In this way,
839 information is not duplicated, and the entire context from which the TODO
840 item emerged is always present.
842 Of course, this technique for managing TODO items scatters them
843 throughout your notes file. Org mode compensates for this by providing
844 methods to give you an overview of all the things that you have to do.
847 * Using TODO states:: Setting and switching states
848 * Multi-state workflows:: More than just on/off
849 * Progress logging:: Dates and notes for progress
850 * Priorities:: Some things are more important than others
851 * Breaking down tasks:: Splitting a task into manageable pieces
852 * Checkboxes:: Tick-off lists
855 @node Using TODO states, Multi-state workflows, TODO Items, TODO Items
856 @section Using TODO states
858 Any headline becomes a TODO item when it starts with the word
859 @samp{TODO}, for example:
862 *** TODO Write letter to Sam Fortune
866 The most important commands to work with TODO entries are:
870 Rotate the TODO state of the current item among
873 ,-> (unmarked) -> TODO -> DONE --.
874 '--------------------------------'
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.
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
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
891 Insert a new TODO entry below the current one.
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 different @emph{sequential} states
902 in the process of working on an item, for example:
905 (setq org-todo-keywords
906 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
909 The vertical bar separates the TODO keywords (states that @emph{need
910 action}) from the DONE states (which need @emph{no further action}). If
911 you don't provide the separator bar, the last state is used as the DONE
913 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
914 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
916 Sometimes you may want to use different sets of TODO keywords in
917 parallel. For example, you may want to have the basic
918 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
919 separate state indicating that an item has been canceled (so it is not
920 DONE, but also does not require action). Your setup would then look
924 (setq org-todo-keywords
925 '((sequence "TODO(t)" "|" "DONE(d)")
926 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
927 (sequence "|" "CANCELED(c)")))
930 The keywords should all be different, this helps Org mode to keep track of
931 which subsequence should be used for a given entry. The example also shows
932 how to define keys for fast access of a particular state, by adding a letter
933 in parenthesis after each keyword---you will be prompted for the key after
936 To define TODO keywords that are valid only in a single file, use the
937 following text anywhere in the file.
940 #+TODO: TODO(t) | DONE(d)
941 #+TODO: REPORT(r) BUG(b) KNOWNCAUSE(k) | FIXED(f)
942 #+TODO: | CANCELED(c)
945 After changing one of these lines, use @kbd{C-c C-c} with the cursor still in
946 the line to make the changes known to Org mode.
948 @node Progress logging, Priorities, Multi-state workflows, TODO Items
949 @section Progress logging
951 Org mode can automatically record a timestamp and possibly a note when
952 you mark a TODO item as DONE, or even each time you change the state of
953 a TODO item. This system is highly configurable; settings can be on a
954 per-keyword basis and can be localized to a file or even a subtree. For
955 information on how to clock working time for a task, see @ref{Clocking
959 * Closing items:: When was this entry marked DONE?
960 * Tracking TODO state changes:: When did the status change?
963 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
964 @unnumberedsubsec Closing items
966 The most basic logging is to keep track of @emph{when} a certain TODO
967 item was finished. This is achieved with@footnote{The corresponding
968 in-buffer setting is: @code{#+STARTUP: logdone}}.
971 (setq org-log-done 'time)
975 Then each time you turn an entry from a TODO (not-done) state into any of the
976 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
977 the headline. If you want to record a note along with the timestamp,
978 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
982 (setq org-log-done 'note)
986 You will then be prompted for a note, and that note will be stored below
987 the entry with a @samp{Closing Note} heading.
989 @node Tracking TODO state changes, , Closing items, Progress logging
990 @unnumberedsubsec Tracking TODO state changes
992 You might want to keep track of TODO state changes. You can either record
993 just a timestamp, or a time-stamped note for a change. These records will be
994 inserted after the headline as an itemized list. When taking a lot of notes,
995 you might want to get the notes out of the way into a drawer. Customize the
996 variable @code{org-log-into-drawer} to get this behavior.
998 For state logging, Org mode expects configuration on a per-keyword basis.
999 This is achieved by adding special markers @samp{!} (for a timestamp) and
1000 @samp{@@} (for a note) in parentheses after each keyword. For example:
1002 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
1005 will define TODO keywords and fast access keys, and also request that a time
1006 is recorded when the entry is set to DONE, and that a note is recorded when
1007 switching to WAIT or CANCELED. The same syntax works also when setting
1008 @code{org-todo-keywords}.
1010 @node Priorities, Breaking down tasks, Progress logging, TODO Items
1013 If you use Org mode extensively, you may end up with enough TODO items that
1014 it starts to make sense to prioritize them. Prioritizing can be done by
1015 placing a @emph{priority cookie} into the headline of a TODO item, like this
1018 *** TODO [#A] Write letter to Sam Fortune
1022 Org mode supports three priorities: @samp{A}, @samp{B}, and @samp{C}.
1023 @samp{A} is the highest, @samp{B} the default if none is given. Priorities
1024 make a difference only in the agenda.
1028 Set the priority of the current headline. Press @samp{A}, @samp{B} or
1029 @samp{C} to select a priority, or @key{SPC} to remove the cookie.
1033 Increase/decrease priority of current headline
1036 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
1037 @section Breaking tasks down into subtasks
1039 It is often advisable to break down large tasks into smaller, manageable
1040 subtasks. You can do this by creating an outline tree below a TODO item,
1041 with detailed subtasks on the tree. To keep the overview over the fraction
1042 of subtasks that are already completed, insert either @samp{[/]} or
1043 @samp{[%]} anywhere in the headline. These cookies will be updated each time
1044 the TODO status of a child changes, or when pressing @kbd{C-c C-c} on the
1045 cookie. For example:
1048 * Organize Party [33%]
1049 ** TODO Call people [1/2]
1053 ** DONE Talk to neighbor
1056 @node Checkboxes, , Breaking down tasks, TODO Items
1059 Every item in a plain list (@pxref{Plain lists}) can be made into a checkbox
1060 by starting it with the string @samp{[ ]}. Checkboxes are not included in
1061 the global TODO list, so they are often great to split a task into a number
1063 Here is an example of a checkbox list.
1066 * TODO Organize party [1/3]
1067 - [-] call people [1/2]
1071 - [ ] think about what music to play
1074 Checkboxes work hierarchically, so if a checkbox item has children that
1075 are checkboxes, toggling one of the children checkboxes will make the
1076 parent checkbox reflect if none, some, or all of the children are
1079 @noindent The following commands work with checkboxes:
1083 Toggle checkbox status or (with prefix arg) checkbox presence at point.
1085 Insert a new item with a checkbox.
1086 This works only if the cursor is already in a plain list item
1087 (@pxref{Plain lists}).
1091 @uref{http://orgmode.org/manual/TODO-Items.html#TODO-Items, Chapter 5 of the manual}@*
1092 @uref{http://orgmode.org/worg/org-tutorials/orgtutorial_dto.php, David
1093 O'Toole's introductory tutorial}@*
1094 @uref{http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html,
1095 Charles Cave's GTD setup}}
1097 @node Tags, Properties, TODO Items, Top
1100 An excellent way to implement labels and contexts for cross-correlating
1101 information is to assign @i{tags} to headlines. Org mode has extensive
1104 Every headline can contain a list of tags; they occur at the end of the
1105 headline. Tags are normal words containing letters, numbers, @samp{_}, and
1106 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
1107 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
1108 Tags will by default be in bold face with the same color as the headline.
1111 * Tag inheritance:: Tags use the tree structure of the outline
1112 * Setting tags:: How to assign tags to a headline
1113 * Tag searches:: Searching for combinations of tags
1114 * Tag searches:: Searching for combinations of tags
1117 @node Tag inheritance, Setting tags, Tags, Tags
1118 @section Tag inheritance
1120 @i{Tags} make use of the hierarchical structure of outline trees. If a
1121 heading has a certain tag, all subheadings will inherit the tag as
1122 well. For example, in the list
1125 * Meeting with the French group :work:
1126 ** Summary by Frank :boss:notes:
1127 *** TODO Prepare slides for him :action:
1131 the final heading will have the tags @samp{:work:}, @samp{:boss:},
1132 @samp{:notes:}, and @samp{:action:} even though the final heading is not
1133 explicitly marked with those tags. You can also set tags that all entries in
1134 a file should inherit just as if these tags were defined in a hypothetical
1135 level zero that surrounds the entire file. Use a line like this@footnote{As
1136 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
1137 changes in the line.}:
1140 #+FILETAGS: :Peter:Boss:Secret:
1143 @node Setting tags, Tag searches, Tag inheritance, Tags
1144 @section Setting tags
1146 Tags can simply be typed into the buffer at the end of a headline.
1147 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
1148 also a special command for inserting tags:
1152 Enter new tags for the current headline. Org mode will either offer
1153 completion or a special single-key interface for setting tags, see
1154 below. After pressing @key{RET}, the tags will be inserted and aligned
1155 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
1156 tags in the current buffer will be aligned to that column, just to make
1159 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
1162 Org will support tag insertion based on a @emph{list of tags}. By
1163 default this list is constructed dynamically, containing all tags
1164 currently used in the buffer. You may also globally specify a hard list
1165 of tags with the variable @code{org-tag-alist}. Finally you can set
1166 the default tags for a given file with lines like
1169 #+TAGS: @@work @@home @@tennisclub
1170 #+TAGS: laptop car pc sailboat
1173 By default Org mode uses the standard minibuffer completion facilities for
1174 entering tags. However, it also implements another, quicker, tag selection
1175 method called @emph{fast tag selection}. This allows you to select and
1176 deselect tags with just a single key press. For this to work well you should
1177 assign unique letters to most of your commonly used tags. You can do this
1178 globally by configuring the variable @code{org-tag-alist} in your
1179 @file{.emacs} file. For example, you may find the need to tag many items in
1180 different files with @samp{:@@home:}. In this case you can set something
1184 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
1187 @noindent If the tag is only relevant to the file you are working on, then you
1188 can instead set the TAGS option line as:
1191 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
1194 @node Tag searches, Tag searches, Setting tags, Tags
1198 @cindex tags, groups
1199 In a set of mutually exclusive tags, the first tag can be defined as a
1200 @emph{group tag}. When you search for a group tag, it will return matches
1201 for all members in the group. In an agenda view, filtering by a group tag
1202 will display headlines tagged with at least one of the members of the
1203 group. This makes tag searches and filters even more flexible.
1205 You can set group tags by inserting a colon between the group tag and other
1209 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
1212 In this example, @samp{@@read} is a @emph{group tag} for a set of three
1213 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
1215 You can also use the @code{:grouptags} keyword directly when setting
1216 @var{org-tag-alist}:
1219 (setq org-tag-alist '((:startgroup . nil)
1222 ("@@read_book" . nil)
1223 ("@@read_ebook" . nil)
1228 @vindex org-group-tags
1229 If you want to ignore group tags temporarily, toggle group tags support
1230 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
1231 want to disable tag groups completely, set @var{org-group-tags} to nil.
1233 @node Tag searches, , Tag searches, Tags
1234 @section Tag searches
1236 Once a system of tags has been set up, it can be used to collect related
1237 information into special lists.
1242 Create a sparse tree with all headlines matching a tags search. With a
1243 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
1245 Create a global list of tag matches from all agenda files.
1246 @xref{Matching tags and properties}.
1248 Create a global list of tag matches from all agenda files, but check
1249 only TODO items and force checking subitems (see variable
1250 @code{org-tags-match-list-sublevels}).
1253 These commands all prompt for a match string which allows basic Boolean logic
1254 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
1255 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
1256 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the
1257 search string is rich and allows also matching against TODO keywords, entry
1258 levels and properties. For a complete description with many examples, see
1259 @ref{Matching tags and properties}.
1262 @uref{http://orgmode.org/manual/Tags.html#Tags, Chapter 6 of the manual}@*
1263 @uref{http://sachachua.com/wp/2008/01/tagging-in-org-plus-bonus-code-for-timeclocks-and-tags/,
1264 Sacha Chua's article about tagging in Org-mode}}
1266 @node Properties, Dates and Times, Tags, Top
1269 Properties are key-value pairs associated with an entry. They live in a
1270 special drawer with the name @code{PROPERTIES}. Each
1271 property is specified on a single line, with the key (surrounded by colons)
1272 first, and the value after it:
1277 *** Goldberg Variations
1279 :Title: Goldberg Variations
1280 :Composer: J.S. Bach
1281 :Publisher: Deutsche Grammophon
1286 You may define the allowed values for a particular property @samp{:Xyz:}
1287 by setting a property @samp{:Xyz_ALL:}. This special property is
1288 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
1289 the entire tree. When allowed values are defined, setting the
1290 corresponding property becomes easier and is less prone to typing
1291 errors. For the example with the CD collection, we can predefine
1292 publishers and the number of disks in a box like this:
1297 :NDisks_ALL: 1 2 3 4
1298 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
1301 or globally using @code{org-global-properties}, or file-wide like this:
1303 #+PROPERTY: NDisks_ALL 1 2 3 4
1308 Set a property. This prompts for a property name and a value.
1310 Remove a property from the current entry.
1313 To create sparse trees and special lists with selection based on properties,
1314 the same commands are used as for tag searches (@pxref{Tag searches}). The
1315 syntax for the search string is described in @ref{Matching tags and
1322 @uref{http://orgmode.org/manual/Properties-and-Columns.html#Properties-and-Columns,
1323 Chapter 7 of the manual}@*
1324 @uref{http://orgmode.org/worg/org-tutorials/org-column-view-tutorial.php,Bastien
1325 Guerry's column view tutorial}}
1327 @node Dates and Times, Capture - Refile - Archive, Properties, Top
1328 @chapter Dates and Times
1330 To assist project planning, TODO items can be labeled with a date and/or
1331 a time. The specially formatted string carrying the date and time
1332 information is called a @emph{timestamp} in Org mode.
1335 * Timestamps:: Assigning a time to a tree entry
1336 * Creating timestamps:: Commands which insert timestamps
1337 * Deadlines and scheduling:: Planning your work
1338 * Clocking work time:: Tracking how long you spend on a task
1342 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
1345 A timestamp is a specification of a date (possibly with a time or a range of
1346 times) in a special format, either @samp{<2003-09-16 Tue>} or
1347 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue 12:00-12:30>}. A
1348 timestamp can appear anywhere in the headline or body of an Org tree entry.
1349 Its presence causes entries to be shown on specific dates in the agenda
1350 (@pxref{Weekly/daily agenda}). We distinguish:
1352 @noindent @b{Plain timestamp; Event; Appointment}@*
1353 A simple timestamp just assigns a date/time to an item. This is just
1354 like writing down an appointment or event in a paper agenda.
1357 * Meet Peter at the movies
1358 <2006-11-01 Wed 19:15>
1359 * Discussion on climate change
1360 <2006-11-02 Thu 20:00-22:00>
1363 @noindent @b{Timestamp with repeater interval}@*
1364 A timestamp may contain a @emph{repeater interval}, indicating that it
1365 applies not only on the given date, but again and again after a certain
1366 interval of N days (d), weeks (w), months (m), or years (y). The
1367 following will show up in the agenda every Wednesday:
1369 * Pick up Sam at school
1370 <2007-05-16 Wed 12:30 +1w>
1373 @noindent @b{Diary-style sexp entries}@*
1374 For more complex date specifications, Org mode supports using the
1375 special sexp diary entries implemented in the Emacs calendar/diary
1376 package. For example
1378 * The nerd meeting on every 2nd Thursday of the month
1379 <%%(diary-float t 4 2)>
1382 @noindent @b{Time/Date range}@*
1383 Two timestamps connected by @samp{--} denote a range.
1385 ** Meeting in Amsterdam
1386 <2004-08-23 Mon>--<2004-08-26 Thu>
1389 @noindent @b{Inactive timestamp}@*
1390 Just like a plain timestamp, but with square brackets instead of
1391 angular ones. These timestamps are inactive in the sense that they do
1392 @emph{not} trigger an entry to show up in the agenda.
1395 * Gillian comes late for the fifth time
1400 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
1401 @section Creating timestamps
1403 For Org mode to recognize timestamps, they need to be in the specific
1404 format. All commands listed below produce timestamps in the correct
1409 Prompt for a date and insert a corresponding timestamp. When the cursor is
1410 at an existing timestamp in the buffer, the command is used to modify this
1411 timestamp instead of inserting a new one. When this command is used twice in
1412 succession, a time range is inserted. With a prefix, also add the current
1416 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
1419 @item S-@key{left}@r{/}@key{right}
1420 Change date at cursor by one day.
1422 @item S-@key{up}@r{/}@key{down}
1423 Change the item under the cursor in a timestamp. The cursor can be on a
1424 year, month, day, hour or minute. When the timestamp contains a time range
1425 like @samp{15:30-16:30}, modifying the first time will also shift the second,
1426 shifting the time block with constant length. To change the length, modify
1430 When Org mode prompts for a date/time, it will accept any string containing
1431 some date and/or time information, and intelligently interpret the string,
1432 deriving defaults for unspecified information from the current date and time.
1433 You can also select a date in the pop-up calendar. See the manual for more
1434 information on how exactly the date/time prompt works.
1436 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
1437 @section Deadlines and scheduling
1439 A timestamp may be preceded by special keywords to facilitate planning:
1441 @noindent @b{DEADLINE}@*
1442 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
1443 to be finished on that date.
1446 Insert @samp{DEADLINE} keyword along with a stamp, in the line following the
1450 On the deadline date, the task will be listed in the agenda. In
1451 addition, the agenda for @emph{today} will carry a warning about the
1452 approaching or missed deadline, starting
1453 @code{org-deadline-warning-days} before the due date, and continuing
1454 until the entry is marked DONE. An example:
1457 *** TODO write article about the Earth for the Guide
1458 The editor in charge is [[bbdb:Ford Prefect]]
1459 DEADLINE: <2004-02-29 Sun>
1463 @noindent @b{SCHEDULED}@*
1464 Meaning: you are @i{planning to start working} on that task on the given
1465 date@footnote{This is quite different from what is normally understood by
1466 @i{scheduling a meeting}, which is done in Org-mode by just inserting a time
1467 stamp without keyword.}.
1471 Insert @samp{SCHEDULED} keyword along with a stamp, in the line following the
1475 The headline will be listed under the given date@footnote{It will still
1476 be listed on that date after it has been marked DONE. If you don't like
1477 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
1478 addition, a reminder that the scheduled date has passed will be present
1479 in the compilation for @emph{today}, until the entry is marked DONE.
1480 I.e.@: the task will automatically be forwarded until completed.
1483 *** TODO Call Trillian for a date on New Years Eve.
1484 SCHEDULED: <2004-12-25 Sat>
1487 Some tasks need to be repeated again and again. Org mode helps to
1488 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
1489 or plain timestamp. In the following example
1491 ** TODO Pay the rent
1492 DEADLINE: <2005-10-01 Sat +1m>
1495 the @code{+1m} is a repeater; the intended interpretation is that the task
1496 has a deadline on <2005-10-01> and repeats itself every (one) month starting
1499 @node Clocking work time, , Deadlines and scheduling, Dates and Times
1500 @section Clocking work time
1502 Org mode allows you to clock the time you spend on specific tasks in a
1507 Start the clock on the current item (clock-in). This inserts the CLOCK
1508 keyword together with a timestamp. When called with a @kbd{C-u} prefix
1509 argument, select the task from a list of recently clocked tasks.
1512 Stop the clock (clock-out). This inserts another timestamp at the same
1513 location where the clock was last started. It also directly computes
1514 the resulting time in inserts it after the time range as @samp{=>
1517 Update the effort estimate for the current clock task.
1519 Cancel the current clock. This is useful if a clock was started by
1520 mistake, or if you ended up working on something else.
1522 Jump to the entry that contains the currently running clock. With a
1523 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
1526 Insert a dynamic block containing a clock
1527 report as an Org-mode table into the current file. When the cursor is
1528 at an existing clock table, just update it.
1530 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
1534 For details about how to customize this view, see @uref{http://orgmode.org/manual/Clocking-work-time.html#Clocking-work-time,the manual}.
1536 Update dynamic block at point. The cursor needs to be in the
1537 @code{#+BEGIN} line of the dynamic block.
1540 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
1541 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
1542 worked on or closed during a day.
1545 @uref{http://orgmode.org/manual/Dates-and-Times.html#Dates-and-Times,
1546 Chapter 8 of the manual}@*
1547 @uref{http://members.optusnet.com.au/~charles57/GTD/org_dates/, Charles
1548 Cave's Date and Time tutorial}@*
1549 @uref{http://doc.norang.ca/org-mode.html#Clocking, Bernt Hansen's clocking workflow}}
1551 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
1552 @chapter Capture - Refile - Archive
1554 An important part of any organization system is the ability to quickly
1555 capture new ideas and tasks, and to associate reference material with them.
1556 Org defines a capture process to create tasks. It stores files related to a
1557 task (@i{attachments}) in a special directory. Once in the system, tasks and
1558 projects need to be moved around. Moving completed project trees to an
1559 archive file keeps the system compact and fast.
1562 * Capture:: Capturing new stuff
1563 * Refile and copy:: Moving a tree from one place to another
1564 * Archiving:: What to do with finished projects
1567 @node Capture, Refile and copy, Capture - Refile - Archive, Capture - Refile - Archive
1570 Org's method for capturing new items is heavily inspired by John Wiegley
1571 excellent @file{remember.el} package. It lets you store quick notes with
1572 little interruption of your work flow. Org lets you define templates for new
1573 entries and associate them with different targets for storing notes.
1576 * Setting up a capture location:: Where notes will be stored
1577 * Using capture:: Commands to invoke and terminate capture
1578 * Capture templates:: Define the outline of different note types
1581 @node Setting up a capture location, Using capture, Capture, Capture
1582 @unnumberedsubsec Setting up a capture location
1584 The following customization sets a default target@footnote{Using capture
1585 templates, you can define more fine-grained capture locations, see
1586 @ref{Capture templates}.} file for notes, and defines a global
1587 key@footnote{Please select your own key, @kbd{C-c c} is only a suggestion.}
1588 for capturing new stuff.
1591 (setq org-default-notes-file (concat org-directory "/notes.org"))
1592 (define-key global-map "\C-cc" 'org-capture)
1595 @node Using capture, Capture templates, Setting up a capture location, Capture
1596 @unnumberedsubsec Using capture
1600 Start a capture process. You will be placed into a narrowed indirect buffer
1603 Once you are done entering information into the capture buffer,
1604 @kbd{C-c C-c} will return you to the window configuration before the capture
1605 process, so that you can resume your work without further distraction.
1607 Finalize by moving the entry to a refile location (@pxref{Refile and copy}).
1609 Abort the capture process and return to the previous state.
1612 @node Capture templates, , Using capture, Capture
1613 @unnumberedsubsec Capture templates
1615 You can use templates to generate different types of capture notes, and to
1616 store them in different places. For example, if you would like
1617 to store new tasks under a heading @samp{Tasks} in file @file{TODO.org}, and
1618 journal entries in a date tree in @file{journal.org} you could
1622 (setq org-capture-templates
1623 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
1624 "* TODO %?\n %i\n %a")
1625 ("j" "Journal" entry (file+datetree "~/org/journal.org")
1626 "* %?\nEntered on %U\n %i\n %a")))
1629 @noindent In these entries, the first string is the key to reach the
1630 template, the second is a short description. Then follows the type of the
1631 entry and a definition of the target location for storing the note. Finally,
1632 the template itself, a string with %-escapes to fill in information based on
1635 When you call @kbd{M-x org-capture}, Org will prompt for a key to select the
1636 template (if you have more than one template) and then prepare the buffer like
1639 [[file:@var{link to where you were when initiating capture}]]
1643 During expansion of the template, special @kbd{%}-escapes@footnote{If you
1644 need one of these sequences literally, escape the @kbd{%} with a backslash.}
1645 allow dynamic insertion of content. Here is a small selection of the
1646 possibilities, consult the manual for more.
1648 %a @r{annotation, normally the link created with @code{org-store-link}}
1649 %i @r{initial content, the region when capture is called with C-u.}
1650 %t @r{timestamp, date only}
1651 %T @r{timestamp with date and time}
1652 %u, %U @r{like the above, but inactive timestamps}
1655 @node Refile and copy, Archiving, Capture, Capture - Refile - Archive
1656 @section Refile and copy
1658 When reviewing the captured data, you may want to refile or copy some of the
1659 entries into a different list, for example into a project. Cutting, finding
1660 the right location, and then pasting the note is cumbersome. To simplify
1661 this process, you can use the following special command:
1665 Copy the entry or region at point. This command behaves like
1666 @code{org-refile}, except that the original note will not be deleted.
1668 Refile the entry or region at point. This command offers possible locations
1669 for refiling the entry and lets you select one with completion. The item (or
1670 all items in the region) is filed below the target heading as a subitem.@*
1671 By default, all level 1 headlines in the current buffer are considered to be
1672 targets, but you can have more complex definitions across a number of files.
1673 See the variable @code{org-refile-targets} for details.
1675 Use the refile interface to jump to a heading.
1676 @item C-u C-u C-c C-w
1677 Jump to the location where @code{org-refile} last moved a tree to.
1680 @node Archiving, , Refile and copy, Capture - Refile - Archive
1683 When a project represented by a (sub)tree is finished, you may want
1684 to move the tree out of the way and to stop it from contributing to the
1685 agenda. Archiving is important to keep your working files compact and global
1686 searches like the construction of agenda views fast.
1687 The most common archiving action is to move a project tree to another file,
1692 Archive the current entry using the command specified in the variable
1693 @code{org-archive-default-command}.
1694 @item C-c C-x C-s@ @r{or short} @ C-c $
1695 Archive the subtree starting at the cursor position to the location
1696 given by @code{org-archive-location}.
1699 The default archive location is a file in the same directory as the
1700 current file, with the name derived by appending @file{_archive} to the
1701 current file name. For information and examples on how to change this,
1702 see the documentation string of the variable
1703 @code{org-archive-location}. There is also an in-buffer option for
1704 setting this variable, for example
1707 #+ARCHIVE: %s_done::
1711 @uref{http://orgmode.org/manual/Capture-_002d-Refile-_002d-Archive.html#Capture-_002d-Refile-_002d-Archive,
1712 Chapter 9 of the manual}@*
1713 @uref{http://orgmode.org/worg/org-tutorials/org-protocol-custom-handler.php,
1714 Sebastian Rose's tutorial for capturing from a web browser}}@uref{}@*
1716 @node Agenda Views, Markup, Capture - Refile - Archive, Top
1717 @chapter Agenda Views
1719 Due to the way Org works, TODO items, time-stamped items, and tagged
1720 headlines can be scattered throughout a file or even a number of files. To
1721 get an overview of open action items, or of events that are important for a
1722 particular date, this information must be collected, sorted and displayed in
1723 an organized way. There are several different views, see below.
1725 The extracted information is displayed in a special @emph{agenda buffer}.
1726 This buffer is read-only, but provides commands to visit the corresponding
1727 locations in the original Org files, and even to edit these files remotely.
1728 Remote editing from the agenda buffer means, for example, that you can
1729 change the dates of deadlines and appointments from the agenda buffer.
1730 The commands available in the Agenda buffer are listed in @ref{Agenda
1734 * Agenda files:: Files being searched for agenda information
1735 * Agenda dispatcher:: Keyboard access to agenda views
1736 * Built-in agenda views:: What is available out of the box?
1737 * Agenda commands:: Remote editing of Org trees
1738 * Custom agenda views:: Defining special searches and views
1741 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
1742 @section Agenda files
1744 The information to be shown is normally collected from all @emph{agenda
1745 files}, the files listed in the variable
1746 @code{org-agenda-files}.
1750 Add current file to the list of agenda files. The file is added to
1751 the front of the list. If it was already in the list, it is moved to
1752 the front. With a prefix argument, file is added/moved to the end.
1754 Remove current file from the list of agenda files.
1756 Cycle through agenda file list, visiting one file after the other.
1759 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
1760 @section The agenda dispatcher
1761 The views are created through a dispatcher, which should be bound to a
1762 global key---for example @kbd{C-c a} (@pxref{Installation}). After
1763 pressing @kbd{C-c a}, an additional letter is required to execute a
1767 The calendar-like agenda (@pxref{Weekly/daily agenda}).
1769 A list of all TODO items (@pxref{Global TODO list}).
1771 A list of headlines matching a TAGS expression (@pxref{Matching
1772 tags and properties}).
1774 The timeline view for the current buffer (@pxref{Timeline}).
1776 A list of entries selected by a boolean expression of keywords
1777 and/or regular expressions that must or must not occur in the entry.
1780 @node Built-in agenda views, Agenda commands, Agenda dispatcher, Agenda Views
1781 @section The built-in agenda views
1784 * Weekly/daily agenda:: The calendar page with current tasks
1785 * Global TODO list:: All unfinished action items
1786 * Matching tags and properties:: Structured information with fine-tuned search
1787 * Timeline:: Time-sorted view for single file
1788 * Search view:: Find entries by searching for text
1791 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
1792 @subsection The weekly/daily agenda
1794 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
1795 paper agenda, showing all the tasks for the current week or day.
1799 Compile an agenda for the current week from a list of Org files. The agenda
1800 shows the entries for each day.
1803 Emacs contains the calendar and diary by Edward M. Reingold. Org-mode
1804 understands the syntax of the diary and allows you to use diary sexp entries
1805 directly in Org files:
1808 * Birthdays and similar stuff
1810 %%(org-calendar-holiday) ; special function for holiday names
1812 %%(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
1813 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
1816 Org can interact with Emacs appointments notification facility. To add all
1817 the appointments of your agenda files, use the command
1818 @code{org-agenda-to-appt}. See the docstring for details.
1820 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
1821 @subsection The global TODO list
1823 The global TODO list contains all unfinished TODO items formatted and
1824 collected into a single place. Remote editing of TODO items lets you
1825 can change the state of a TODO entry with a single key press. The commands
1826 available in the TODO list are described in @ref{Agenda commands}.
1830 Show the global TODO list. This collects the TODO items from all
1831 agenda files (@pxref{Agenda Views}) into a single buffer.
1833 Like the above, but allows selection of a specific TODO keyword.
1836 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
1837 @subsection Matching tags and properties
1839 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
1840 or have properties (@pxref{Properties}), you can select headlines
1841 based on this metadata and collect them into an agenda buffer. The match
1842 syntax described here also applies when creating sparse trees with @kbd{C-c /
1843 m}. The commands available in the tags list are described in @ref{Agenda
1848 Produce a list of all headlines that match a given set of tags. The
1849 command prompts for a selection criterion, which is a boolean logic
1850 expression with tags, like @samp{+work+urgent-withboss} or
1851 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
1852 define a custom command for it (@pxref{Agenda dispatcher}).
1854 Like @kbd{C-c a m}, but only select headlines that are also TODO items.
1857 @subsubheading Match syntax
1859 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
1860 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
1861 not implemented. Each element in the search is either a tag, a regular
1862 expression matching tags, or an expression like @code{PROPERTY OPERATOR
1863 VALUE} with a comparison operator, accessing a property value. Each element
1864 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
1865 sugar for positive selection. The AND operator @samp{&} is optional when
1866 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
1870 Select headlines tagged @samp{:work:}, but discard those also tagged
1873 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
1874 @item work|laptop+night
1875 Like before, but require the @samp{:laptop:} lines to be tagged also
1879 You may also test for properties at the same
1880 time as matching tags, see the manual for more information.
1882 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
1883 @subsection Timeline for a single file
1885 The timeline summarizes all time-stamped items from a single Org mode
1886 file in a @emph{time-sorted view}. The main purpose of this command is
1887 to give an overview over events in a project.
1891 Show a time-sorted view of the Org file, with all time-stamped items.
1892 When called with a @kbd{C-u} prefix, all unfinished TODO entries
1893 (scheduled or not) are also listed under the current date.
1896 @node Search view, , Timeline, Built-in agenda views
1897 @subsection Search view
1899 This agenda view is a general text search facility for Org mode entries.
1900 It is particularly useful to find notes.
1904 This is a special search that lets you select entries by matching a substring
1905 or specific words using a boolean logic.
1907 For example, the search string @samp{computer equipment} will find entries
1908 that contain @samp{computer equipment} as a substring.
1909 Search view can also search for specific keywords in the entry, using Boolean
1910 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
1911 will search for note entries that contain the keywords @code{computer}
1912 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
1913 not matched by the regular expression @code{8\.11[bg]}, meaning to
1914 exclude both 8.11b and 8.11g.
1916 Note that in addition to the agenda files, this command will also search
1917 the files listed in @code{org-agenda-text-search-extra-files}.
1919 @node Agenda commands, Custom agenda views, Built-in agenda views, Agenda Views
1920 @section Commands in the agenda buffer
1922 Entries in the agenda buffer are linked back to the Org file or diary
1923 file where they originate. Commands are provided to show and jump to the
1924 original entry location, and to edit the Org files ``remotely'' from
1925 the agenda buffer. This is just a selection of the many commands, explore
1926 the @code{Agenda} menu and the manual for a complete list.
1929 @tsubheading{Motion}
1931 Next line (same as @key{up} and @kbd{C-p}).
1933 Previous line (same as @key{down} and @kbd{C-n}).
1934 @tsubheading{View/Go to Org file}
1937 Display the original location of the item in another window.
1938 With prefix arg, make sure that the entire entry is made visible in the
1939 outline, not only the heading.
1942 Go to the original location of the item in another window. Under Emacs
1943 22, @kbd{mouse-1} will also work for this.
1946 Go to the original location of the item and delete other windows.
1949 @tsubheading{Change display}
1951 Delete other windows.
1954 Switch to day/week view.
1957 Go forward/backward in time to display the following
1958 @code{org-agenda-current-span} days. For example, if the display covers a
1959 week, switch to the following/previous week.
1965 Prompt for a date and go there.
1967 @item v l @ @r{or short} @ l
1968 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
1969 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
1970 entries that have been clocked on that day. When called with a @kbd{C-u}
1971 prefix, show all possible logbook entries, including state changes.
1974 Recreate the agenda buffer, to reflect the changes.
1976 Save all Org buffers in the current Emacs session, and also the locations of
1979 @tsubheading{Secondary filtering and query editing}
1982 Filter the current agenda view with respect to a tag. You are prompted for a
1983 letter to select a tag. Press @samp{-} first to select against the tag.
1986 Narrow the current agenda filter by an additional condition.
1988 @tsubheading{Remote editing (see the manual for many more commands)}
1994 Change the TODO state of the item, in the agenda and in the
1998 Delete the current agenda item along with the entire subtree belonging
1999 to it in the original Org file.
2002 Refile the entry at point.
2004 @item C-c C-x C-a @ @r{or short} @ a
2005 Archive the subtree corresponding to the entry at point using the default
2006 archiving command set in @code{org-archive-default-command}.
2008 @item C-c C-x C-s @ @r{or short} @ $
2009 Archive the subtree corresponding to the current headline.
2012 Schedule this item, with prefix arg remove the scheduling timestamp
2015 Set a deadline for this item, with prefix arg remove the deadline.
2017 @item S-@key{right} @r{and} S-@key{left}
2018 Change the timestamp associated with the current line by one day.
2021 Start the clock on the current item.
2024 Stop/cancel the previously started clock.
2027 Jump to the running clock in another window.
2030 @node Custom agenda views, , Agenda commands, Agenda Views
2031 @section Custom agenda views
2033 The main application of custom searches is the definition of keyboard
2034 shortcuts for frequently used searches, either creating an agenda
2035 buffer, or a sparse tree (the latter covering of course only the current
2037 Custom commands are configured in the variable
2038 @code{org-agenda-custom-commands}. You can customize this variable, for
2039 example by pressing @kbd{C-c a C}. You can also directly set it with
2040 Emacs Lisp in @file{.emacs}. The following example contains all valid
2045 (setq org-agenda-custom-commands
2046 '(("w" todo "WAITING")
2047 ("u" tags "+boss-urgent")
2048 ("v" tags-todo "+boss-urgent")))
2053 The initial string in each entry defines the keys you have to press after the
2054 dispatcher command @kbd{C-c a} in order to access the command. Usually this
2055 will be just a single character. The second parameter is the search type,
2056 followed by the string or regular expression to be used for the matching.
2057 The example above will therefore define:
2061 as a global search for TODO entries with @samp{WAITING} as the TODO
2064 as a global tags search for headlines marked @samp{:boss:} but not
2067 as the same search as @kbd{C-c a u}, but limiting the search to
2068 headlines that are also TODO items
2072 @uref{http://orgmode.org/manual/Agenda-Views.html#Agenda-Views, Chapter 10 of
2074 @uref{http://orgmode.org/worg/org-tutorials/org-custom-agenda-commands.php,
2075 Mat Lundin's tutorial about custom agenda commands}@*
2076 @uref{http://www.newartisans.com/2007/08/using-org-mode-as-a-day-planner.html,
2077 John Wiegley's setup}}
2079 @node Markup, Exporting, Agenda Views, Top
2080 @chapter Markup for rich export
2082 When exporting Org-mode documents, the exporter tries to reflect the
2083 structure of the document as accurately as possible in the backend. Since
2084 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
2085 Org mode has rules on how to prepare text for rich export. This section
2086 summarizes the markup rules used in an Org-mode buffer.
2089 * Structural markup elements:: The basic structure as seen by the exporter
2090 * Images and tables:: Tables and Images will be included
2091 * Literal examples:: Source code examples with special formatting
2092 * Include files:: Include additional files into a document
2093 * Embedded @LaTeX{}:: @LaTeX{} can be freely used inside Org documents
2096 @node Structural markup elements, Images and tables, Markup, Markup
2097 @section Structural markup elements
2100 * Document title:: Where the title is taken from
2101 * Headings and sections:: The document structure as seen by the exporter
2102 * Table of contents:: The if and where of the table of contents
2103 * Paragraphs:: Paragraphs
2104 * Emphasis and monospace:: Bold, italic, etc.
2105 * Comment lines:: What will *not* be exported
2108 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
2109 @subheading Document title
2112 The title of the exported document is taken from the special line
2115 #+TITLE: This is the title of the document
2118 @node Headings and sections, Table of contents, Document title, Structural markup elements
2119 @subheading Headings and sections
2121 The outline structure of the document as described in @ref{Document
2122 Structure}, forms the basis for defining sections of the exported document.
2123 However, since the outline structure is also used for (for example) lists of
2124 tasks, only the first three outline levels will be used as headings. Deeper
2125 levels will become itemized lists. You can change the location of this
2126 switch globally by setting the variable @code{org-export-headline-levels}, or on a
2127 per-file basis with a line
2133 @node Table of contents, Paragraphs, Headings and sections, Structural markup elements
2134 @subheading Table of contents
2136 The table of contents is normally inserted directly before the first headline
2140 #+OPTIONS: toc:2 (only to two levels in TOC)
2141 #+OPTIONS: toc:nil (no TOC at all)
2144 @node Paragraphs, Emphasis and monospace, Table of contents, Structural markup elements
2145 @subheading Paragraphs, line breaks, and quoting
2147 Paragraphs are separated by at least one empty line. If you need to enforce
2148 a line break within a paragraph, use @samp{\\} at the end of a line.
2150 To keep the line breaks in a region, but otherwise use normal formatting, you
2151 can use this construct, which can also be used to format poetry.
2155 Great clouds overhead
2156 Tiny black birds rise and fall
2163 When quoting a passage from another document, it is customary to format this
2164 as a paragraph that is indented on both the left and the right margin. You
2165 can include quotations in Org-mode documents like this:
2169 Everything should be made as simple as possible,
2170 but not any simpler -- Albert Einstein
2174 If you would like to center some text, do it like this:
2177 Everything should be made as simple as possible, \\
2182 @node Emphasis and monospace, Comment lines, Paragraphs, Structural markup elements
2183 @subheading Emphasis and monospace
2185 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
2186 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
2187 in the code and verbatim string is not processed for Org-mode specific
2188 syntax, it is exported verbatim. To insert a horizontal rules, use a line
2189 consisting of only dashes, and at least 5 of them.
2191 @node Comment lines, , Emphasis and monospace, Structural markup elements
2192 @subheading Comment lines
2194 Lines starting with zero or more whitespace characters followed by @samp{#}
2195 are treated as comments and will never be exported. Also entire subtrees
2196 starting with the word @samp{COMMENT} will never be exported. Finally,
2197 regions surrounded by @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will
2202 Toggle the COMMENT keyword at the beginning of an entry.
2205 @node Images and tables, Literal examples, Structural markup elements, Markup
2206 @section Images and Tables
2208 For Org mode tables, the lines before the first horizontal separator line
2209 will become table header lines. You can use the following lines somewhere
2210 before the table to assign a caption and a label for cross references, and in
2211 the text you can refer to the object with @code{\ref@{tab:basic-data@}}:
2214 #+CAPTION: This is the caption for the next table (or link)
2215 #+LABEL: tbl:basic-data
2220 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
2221 images into the exported document. Org does this, if a link to an image
2222 files does not have a description part, for example @code{[[./img/a.jpg]]}.
2223 If you wish to define a caption for the image and maybe a label for internal
2224 cross references, you sure that the link is on a line by itself precede it
2228 #+CAPTION: This is the caption for the next figure link (or table)
2229 #+LABEL: fig:SED-HR4049
2233 You may also define additional attributes for the figure. As this is
2234 backend-specific, see the sections about the individual backends for more
2238 @node Literal examples, Include files, Images and tables, Markup
2239 @section Literal examples
2241 You can include literal examples that should not be subjected to
2242 markup. Such examples will be typeset in monospace, so this is well suited
2243 for source code and similar examples.
2247 Some example from a text file.
2251 For simplicity when using small examples, you can also start the example
2252 lines with a colon followed by a space. There may also be additional
2253 whitespace before the colon:
2257 : Some example from a text file.
2260 For source code from a programming language, or any other text
2261 that can be marked up by font-lock in Emacs, you can ask for it to
2262 look like the fontified Emacs buffer
2265 #+BEGIN_SRC emacs-lisp
2266 (defun org-xor (a b)
2272 To edit the example in a special buffer supporting this language, use
2273 @kbd{C-c '} to both enter and leave the editing buffer.
2275 @node Include files, Embedded @LaTeX{}, Literal examples, Markup
2276 @section Include files
2278 During export, you can include the content of another file. For example, to
2279 include your @file{.emacs} file, you could use:
2282 #+INCLUDE: "~/.emacs" src emacs-lisp
2285 The optional second and third parameter are the markup (e.g.@: @samp{quote},
2286 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
2287 language for formatting the contents. The markup is optional, if it is not
2288 given, the text will be assumed to be in Org mode format and will be
2289 processed normally. @kbd{C-c '} will visit the included file.
2291 @node Embedded @LaTeX{}, , Include files, Markup
2292 @section Embedded @LaTeX{}
2294 For scientific notes which need to be able to contain mathematical symbols
2295 and the occasional formula, Org-mode supports embedding @LaTeX{} code into
2296 its files. You can directly use TeX-like macros for special symbols, enter
2297 formulas and entire @LaTeX{} environments.
2300 Angles are written as Greek letters \alpha, \beta and \gamma. The mass if
2301 the sun is M_sun = 1.989 x 10^30 kg. The radius of the sun is R_@{sun@} =
2302 6.96 x 10^8 m. If $a^2=b$ and $b=2$, then the solution must be either
2303 $a=+\sqrt@{2@}$ or $a=-\sqrt@{2@}$.
2310 @uref{http://orgmode.org/manual/LaTeX-fragments.html#LaTeX-fragments,special
2311 setup}, @LaTeX{} snippets will be included as images when exporting to HTML.
2314 @uref{http://orgmode.org/manual/Markup.html#Markup, Chapter 11 of the manual}}
2316 @node Exporting, Publishing, Markup, Top
2319 Org-mode documents can be exported into a variety of other formats: ASCII
2320 export for inclusion into emails, HTML to publish on the web, @LaTeX{}/PDF
2321 for beautiful printed documents and DocBook to enter the world of many other
2322 formats using DocBook tools. There is also export to iCalendar format so
2323 that planning information can be incorporated into desktop calendars.
2326 * Export options:: Per-file export settings
2327 * The export dispatcher:: How to access exporter commands
2328 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
2329 * HTML export:: Exporting to HTML
2330 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
2331 * DocBook export:: Exporting to DocBook
2332 * iCalendar export::
2335 @node Export options, The export dispatcher, Exporting, Exporting
2336 @section Export options
2338 The exporter recognizes special lines in the buffer which provide
2339 additional information. These lines may be put anywhere in the file.
2340 The whole set of lines can be inserted into the buffer with @kbd{C-c
2345 Insert template with export options, see example below.
2349 #+TITLE: the title to be shown (default is the buffer name)
2350 #+AUTHOR: the author (default taken from @code{user-full-name})
2351 #+DATE: a date, fixed, of a format string for @code{format-time-string}
2352 #+EMAIL: his/her email address (default from @code{user-mail-address})
2353 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
2354 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
2355 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
2356 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
2357 #+LINK_UP: the ``up'' link of an exported page
2358 #+LINK_HOME: the ``home'' link of an exported page
2359 #+LATEX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
2362 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
2363 @section The export dispatcher
2365 All export commands can be reached using the export dispatcher, which is a
2366 prefix key that prompts for an additional key specifying the command.
2367 Normally the entire file is exported, but if there is an active region that
2368 contains one outline tree, the first heading is used as document title and
2369 the subtrees are exported.
2373 Dispatcher for export and publishing commands.
2376 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
2377 @section ASCII/Latin-1/UTF-8 export
2379 ASCII export produces a simple and very readable version of an Org-mode
2380 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
2381 with special characters and symbols available in these encodings.
2385 Export as ASCII file.
2386 @item C-c C-e n @ @ @r{and} @ @ C-c C-e N
2387 Like the above commands, but use Latin-1 encoding.
2388 @item C-c C-e u @ @ @r{and} @ @ C-c C-e U
2389 Like the above commands, but use UTF-8 encoding.
2392 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
2393 @section HTML export
2397 Export as HTML file @file{myfile.html}.
2399 Export as HTML file and immediately open it with a browser.
2402 To insert HTML that should be copied verbatim to
2403 the exported file use either
2406 #+HTML: Literal HTML code for export
2411 All lines between these markers are exported literally
2415 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
2416 @section @LaTeX{} and PDF export
2420 Export as @LaTeX{} file @file{myfile.tex}.
2422 Export as @LaTeX{} and then process to PDF.
2424 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
2427 By default, the @LaTeX{} output uses the class @code{article}. You can
2428 change this by adding an option like @code{#+LaTeX_CLASS: myclass} in your
2429 file. The class must be listed in @code{org-latex-classes}.
2431 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
2432 inserted into the @LaTeX{} file. Similarly to the HTML exporter, you can use
2433 @code{#+LaTeX:} and @code{#+BEGIN_LaTeX ... #+END_LaTeX} construct to add
2434 verbatim @LaTeX{} code.
2436 @node DocBook export, iCalendar export, @LaTeX{} and PDF export, Exporting
2437 @section DocBook export
2441 Export as DocBook file.
2444 Similarly to the HTML exporter, you can use @code{#+DOCBOOK:} and
2445 @code{#+BEGIN_DOCBOOK ... #+END_DOCBOOK} construct to add verbatim @LaTeX{}
2448 @node iCalendar export, , DocBook export, Exporting
2449 @section iCalendar export
2453 Create iCalendar entries for the current file in a @file{.ics} file.
2455 Create a single large iCalendar file from all files in
2456 @code{org-agenda-files} and write it to the file given by
2457 @code{org-combined-agenda-icalendar-file}.
2461 @uref{http://orgmode.org/manual/Exporting.html#Exporting, Chapter 12 of the manual}@*
2462 @uref{http://orgmode.org/worg/org-tutorials/images-and-xhtml-export.php,
2463 Sebastian Rose's image handling tutorial}@*
2464 @uref{http://orgmode.org/worg/org-tutorials/org-latex-export.php, Thomas
2465 Dye's LaTeX export tutorial}
2466 @uref{http://orgmode.org/worg/org-tutorials/org-beamer/tutorial.php, Eric
2467 Fraga's BEAMER presentation tutorial}}
2469 @node Publishing, Working With Source Code, Exporting, Top
2472 Org includes a publishing management system that allows you to configure
2473 automatic HTML conversion of @emph{projects} composed of interlinked org
2474 files. You can also configure Org to automatically upload your exported HTML
2475 pages and related attachments, such as images and source code files, to a web
2476 server. For detailed instructions about setup, see the manual.
2481 (setq org-publish-project-alist
2483 :base-directory "~/org/"
2484 :publishing-directory "~/public_html"
2485 :section-numbers nil
2486 :table-of-contents nil
2487 :style "<link rel=\"stylesheet\"
2488 href=\"../other/mystyle.css\"
2489 type=\"text/css\"/>")))
2494 Prompt for a specific project and publish all files that belong to it.
2496 Publish the project containing the current file.
2498 Publish only the current file.
2500 Publish every project.
2503 Org uses timestamps to track when a file has changed. The above functions
2504 normally only publish changed files. You can override this and force
2505 publishing of all files by giving a prefix argument to any of the commands
2509 @uref{http://orgmode.org/manual/Publishing.html#Publishing, Chapter 13 of the
2511 @uref{http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php,
2512 Sebastian Rose's publishing tutorial}@*
2513 @uref{http://orgmode.org/worg/org-tutorials/org-jekyll.php, Ian Barton's
2514 Jekyll/blogging setup}}
2516 @node Working With Source Code, Miscellaneous, Publishing, Top
2517 @chapter Working with source code
2518 Org-mode provides a number of features for working with source code,
2519 including editing of code blocks in their native major-mode, evaluation of
2520 code blocks, tangling of code blocks, and exporting code blocks and their
2521 results in several formats.
2523 @subheading Structure of Code Blocks
2524 The structure of code blocks is as follows:
2528 #+BEGIN_SRC <language> <switches> <header arguments>
2533 Where @code{<name>} is a string used to name the code block,
2534 @code{<language>} specifies the language of the code block
2535 (e.g.@: @code{emacs-lisp}, @code{shell}, @code{R}, @code{python}, etc...),
2536 @code{<switches>} can be used to control export of the code block,
2537 @code{<header arguments>} can be used to control many aspects of code block
2538 behavior as demonstrated below, and @code{<body>} contains the actual source
2541 @subheading Editing source code
2542 Use @kbd{C-c '} to edit the current code block. This brings up a language
2543 major-mode edit buffer containing the body of the code block. Saving this
2544 buffer will write the new contents back to the Org buffer. Use @kbd{C-c '}
2545 again to exit the edit buffer.
2547 @subheading Evaluating code blocks
2548 Use @kbd{C-c C-c} to evaluate the current code block and insert its results
2549 in the Org-mode buffer. By default, evaluation is only turned on for
2550 @code{emacs-lisp} code blocks, however support exists for evaluating blocks
2551 in many languages. For a complete list of supported languages see the
2552 manual. The following shows a code block and its results.
2555 #+BEGIN_SRC emacs-lisp
2563 @subheading Extracting source code
2564 Use @kbd{C-c C-v t} to create pure source code files by extracting code from
2565 source blocks in the current buffer. This is referred to as ``tangling''---a
2566 term adopted from the literate programming community. During ``tangling'' of
2567 code blocks their bodies are expanded using @code{org-babel-expand-src-block}
2568 which can expand both variable and ``noweb'' style references. In order to
2569 tangle a code block it must have a @code{:tangle} header argument, see the
2572 @subheading Library of Babel
2573 Use @kbd{C-c C-v l} to load the code blocks from an Org-mode files into the
2574 ``Library of Babel'', these blocks can then be evaluated from any Org-mode
2575 buffer. A collection of generally useful code blocks is distributed with
2576 Org-mode in @code{contrib/library-of-babel.org}.
2578 @subheading Header Arguments
2579 Many aspects of the evaluation and export of code blocks are controlled
2580 through header arguments. These can be specified globally, at the file
2581 level, at the outline subtree level, and at the individual code block level.
2582 The following describes some of the header arguments.
2585 The @code{:var} header argument is used to pass arguments to code blocks.
2586 The values passed to arguments can be literal values, values from org-mode
2587 tables and literal example blocks, or the results of other named code blocks.
2589 The @code{:results} header argument controls the @emph{collection},
2590 @emph{type}, and @emph{handling} of code block results. Values of
2591 @code{output} or @code{value} (the default) specify how results are collected
2592 from a code block's evaluation. Values of @code{vector}, @code{scalar}
2593 @code{file} @code{raw} @code{html} @code{latex} and @code{code} specify the
2594 type of the results of the code block which dictates how they will be
2595 incorporated into the Org-mode buffer. Values of @code{silent},
2596 @code{replace}, @code{prepend}, and @code{append} specify handling of code
2597 block results, specifically if and how the results should be inserted into
2598 the Org-mode buffer.
2600 A header argument of @code{:session} will cause the code block to be
2601 evaluated in a persistent interactive inferior process in Emacs. This allows
2602 for persisting state between code block evaluations, and for manual
2603 inspection of the results of evaluation.
2605 Any combination of the @emph{code} or the @emph{results} of a block can be
2606 retained on export, this is specified by setting the @code{:results} header
2607 argument to @code{code} @code{results} @code{none} or @code{both}.
2609 A header argument of @code{:tangle yes} will cause a code block's contents to
2610 be tangled to a file named after the filename of the Org-mode buffer. An
2611 alternate file name can be specified with @code{:tangle filename}.
2613 A header argument of @code{:cache yes} will cause associate a hash of the
2614 expanded code block with the results, ensuring that code blocks are only
2615 re-run when their inputs have changed.
2617 A header argument of @code{:noweb yes} will expand ``noweb'' style references
2618 on evaluation and tangling.
2620 Code blocks which output results to files (e.g.@: graphs, diagrams and figures)
2621 can accept a @code{:file filename} header argument in which case the results
2622 are saved to the named file, and a link to the file is inserted into the
2627 @uref{http://orgmode.org/manual/Literal-examples.html#Literal-examples,
2628 Chapter 11.3 of the manual}@*
2629 @uref{http://orgmode.org/worg/org-contrib/babel/index.php,
2630 The Babel site on Worg}}
2632 @node Miscellaneous, GNU Free Documentation License, Working With Source Code, Top
2633 @chapter Miscellaneous
2636 * Completion:: M-TAB knows what you need
2637 * Clean view:: Getting rid of leading stars in the outline
2638 * MobileOrg:: Org-mode on the iPhone
2641 @node Completion, Clean view, Miscellaneous, Miscellaneous
2644 Org supports in-buffer completion with @kbd{M-@key{TAB}}. This type of
2645 completion does not make use of the minibuffer. You simply type a few
2646 letters into the buffer and use the key to complete text right there. For
2647 example, this command will complete @TeX{} symbols after @samp{\}, TODO
2648 keywords at the beginning of a headline, and tags after @samp{:} in a
2651 @node Clean view, MobileOrg, Completion, Miscellaneous
2652 @section A cleaner outline view
2654 Some people find it noisy and distracting that the Org headlines start with a
2655 potentially large number of stars, and that text below the headlines is not
2656 indented. While this is no problem when writing a @emph{book-like} document
2657 where the outline headings are really section headings, in a more
2658 @emph{list-oriented} outline, indented structure is a lot cleaner:
2662 * Top level headline | * Top level headline
2663 ** Second level | * Second level
2664 *** 3rd level | * 3rd level
2665 some text | some text
2666 *** 3rd level | * 3rd level
2667 more text | more text
2668 * Another top level headline | * Another top level headline
2673 If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
2674 of view can be achieved dynamically at display time using
2675 @code{org-indent-mode}, which will prepend intangible space to each line.
2676 You can turn on @code{org-indent-mode} for all files by customizing the
2677 variable @code{org-startup-indented}, or you can turn it on for individual
2684 If you want a similar effect in earlier version of Emacs and/or Org, or if
2685 you want the indentation to be hard space characters so that the plain text
2686 file looks as similar as possible to the Emacs display, Org supports you by
2687 helping to indent (with @key{TAB}) text below each headline, by hiding
2688 leading stars, and by only using levels 1, 3, etc to get two characters
2689 indentation for each level. To get this support in a file, use
2692 #+STARTUP: hidestars odd
2695 @node MobileOrg, , Clean view, Miscellaneous
2698 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
2699 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
2700 capture support for an Org mode system rooted on a ``real'' computer. It
2701 does also allow you to record changes to existing entries.
2703 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
2704 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
2705 Moreland. Android users should check out
2706 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
2707 by Matt Jones. The two implementations are not identical but offer similar
2711 @uref{http://orgmode.org/manual/Miscellaneous.html#Miscellaneous, Chapter 15
2713 @uref{http://orgmode.org/manual/MobileOrg.html#MobileOrg, Appendix B of the
2715 @uref{http://orgmode.org/orgcard.pdf,Key reference card}}
2718 @node GNU Free Documentation License, , Miscellaneous, Top
2719 @appendix GNU Free Documentation License
2720 @include doclicense.texi
2730 @c LocalWords: webdavhost pre