Release 4.28
[org-mode.git] / org
blob4a17dbc8d5c6ed49968efea5c85d99bfafc7ac2c
1 This is org, produced by makeinfo version 4.8 from org.texi.
3 INFO-DIR-SECTION Emacs
4 START-INFO-DIR-ENTRY
5 * Org Mode: (org).      outline-based notes management and organizer
6 END-INFO-DIR-ENTRY
8    This manual is for Org-mode (version 4.28).
10    Copyright (C) 2004, 2005, 2006 Free Software Foundation
12      Permission is granted to copy, distribute and/or modify this
13      document under the terms of the GNU Free Documentation License,
14      Version 1.1 or any later version published by the Free Software
15      Foundation; with no Invariant Sections, with the Front-Cover texts
16      being "A GNU Manual," and with the Back-Cover Texts as in (a)
17      below.  A copy of the license is included in the section entitled
18      "GNU Free Documentation License."
20      (a) The FSF's Back-Cover Text is: "You have freedom to copy and
21      modify this GNU Manual, like GNU software.  Copies published by
22      the Free Software Foundation raise funds for GNU development."
24 \x1f
25 File: org,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)
27 Org Mode Manual
28 ***************
30 This manual is for Org-mode (version 4.28).
32    Copyright (C) 2004, 2005, 2006 Free Software Foundation
34      Permission is granted to copy, distribute and/or modify this
35      document under the terms of the GNU Free Documentation License,
36      Version 1.1 or any later version published by the Free Software
37      Foundation; with no Invariant Sections, with the Front-Cover texts
38      being "A GNU Manual," and with the Back-Cover Texts as in (a)
39      below.  A copy of the license is included in the section entitled
40      "GNU Free Documentation License."
42      (a) The FSF's Back-Cover Text is: "You have freedom to copy and
43      modify this GNU Manual, like GNU software.  Copies published by
44      the Free Software Foundation raise funds for GNU development."
46 * Menu:
48 * Introduction::                Getting started
49 * Document structure::          A tree works like your brain
50 * Tables::                      Pure magic for quick formatting
51 * Hyperlinks::                  Notes in context
52 * TODO items::                  Every tree branch can be a TODO item
53 * Timestamps::                  Assign date and time to items
54 * Tags::                        Tagging headlines and matching sets of tags
55 * Agenda views::                Collecting information into views
56 * Exporting::                   Sharing and publishing of notes
57 * Miscellaneous::               All the rest which did not fit elsewhere
58 * Index::                       The fast road to specific information
59 * Key Index::                   Key bindings and where they are described
61  --- The Detailed Node Listing ---
63 Introduction
65 * Summary::                     Brief summary of what Org-mode does
66 * Installation and activation::  How to install Org-mode
67 * Feedback::                    Bug reports, ideas, patches etc.
69 Document Structure
71 * Outlines::                    Org-mode is based on outline-mode
72 * Headlines::                   How to typeset org-tree headlines
73 * Visibility cycling::          Show and hide, much simplified
74 * Motion::                      Jumping to other headlines
75 * Structure editing::           Changing sequence and level of headlines
76 * Archiving::                   Move done task trees to a different place
77 * Sparse trees::                Matches embedded in context
78 * Plain lists::                 Editing hand-formatted lists
80 Tables
82 * Built-in table editor::       Simple tables
83 * Narrow columns::              Stop wasting space in tables
84 * Table calculations::          Compute a field from other fields
85 * orgtbl-mode::                 The table editor as minor mode
86 * table.el::                    Complex tables
88 Calculations in tables
90 * Formula syntax::              How to write a formula
91 * Column formulas::             Formulas valid for all fields in a column
92 * Advanced features::           Field names, parameters and automatic recalc
93 * Named-field formulas::        Formulas valid in single fields
94 * Editing/debugging formulas::  Changing a stored formula
95 * Appetizer::                   Taste the power of calc
97 Hyperlinks
99 * Link format::                 How links in Org-mode are formatted
100 * Internal links::              Links to other places in the current file
101 * External links::              URL-like links to the world
102 * Handling links::              Creating, inserting and following
103 * Search options::              Linking to a specific location
104 * Custom searches::             When the default search is not enough
105 * Remember::                    Org-trees store quick notes
107 Internal links
109 * Radio targets::               Make targets trigger links in plain text.
110 * CamelCase links::             Activating CamelCase words as links
112 TODO items
114 * TODO basics::                 Marking and displaying TODO entries
115 * Progress logging::            Document your productivity
116 * TODO extensions::             Workflow and assignments
117 * Priorities::                  Some things are more important than others
119 Extended use of TODO keywords
121 * Workflow states::             From TODO to DONE in steps
122 * TODO types::                  I do this, Fred the rest
123 * Per file keywords::           Different files, different requirements
125 Timestamps
127 * Time stamps::                 Assigning a time to a tree entry
128 * Creating timestamps::         Commands which insert timestamps
130 Tags
132 * Tag inheritance::             Tags use the tree structure of the outline
133 * Setting tags::                How to assign tags to a headline
134 * Tag searches::                Searching for combinations of tags
136 Agenda Views
138 * Agenda files::                Files being searched for agenda information
139 * Agenda dispatcher::           Keyboard access to agenda views
140 * Weekly/Daily agenda::         The calendar page with current tasks
141 * Global TODO list::            All unfinished action items
142 * Matching headline tags::      Structured information with fine-tuned search
143 * Timeline::                    Time-sorted view for single file
144 * Agenda commands::             Remote editing of org trees
146 The weekly/daily agenda
148 * Categories::                  Not all tasks are equal
149 * Time-of-day specifications::  How the agenda knows the time
150 * Calendar/Diary integration::  Integrating Anniversaries and more
151 * Sorting of agenda items::     The order of things
153 Exporting
155 * ASCII export::                Exporting to plain ASCII
156 * HTML export::                 Exporting to HTML
157 * XML export::                  Exporting to XML
158 * iCalendar export::            Exporting in iCalendar format
159 * Text interpretation::         How the exporter looks at the file
161 Text interpretation by the exporter
163 * Comment lines::               Some lines will not be exported
164 * Enhancing text::              Subscripts, symbols and more
165 * Export options::              How to influence the export settings
167 Miscellaneous
169 * Completion::                  M-TAB knows what you need
170 * Customization::               Adapting Org-mode to your taste
171 * Summary of in-buffer settings::  Using special lines to set options
172 * The very busy C-c C-c key::   When in doubt, press C-c C-c
173 * Clean view::                  Getting rid of leading stars in the outline
174 * TTY keys::                    Using Org-mode on a tty
175 * FAQ::                         Frequently asked questions
176 * Interaction::                 Other Emacs packages
177 * Bugs::                        Things which do not work perfectly
178 * Acknowledgments::             These people provided feedback and more
180 \x1f
181 File: org,  Node: Introduction,  Next: Document structure,  Prev: Top,  Up: Top
183 1 Introduction
184 **************
186 * Menu:
188 * Summary::                     Brief summary of what Org-mode does
189 * Installation and activation::  How to install Org-mode
190 * Feedback::                    Bug reports, ideas, patches etc.
192 \x1f
193 File: org,  Node: Summary,  Next: Installation and activation,  Prev: Introduction,  Up: Introduction
195 1.1 Summary
196 ===========
198 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
199 project planning with a fast and effective plain-text system.
201    Org-mode develops organizational tasks around NOTES files that
202 contain information about projects as plain text.  Org-mode is
203 implemented on top of outline-mode, which makes it possible to keep the
204 content of large files well structured.  Visibility cycling and
205 structure editing help to work with the tree.  Tables are easily
206 created with a built-in table editor.  Org-mode supports ToDo items,
207 deadlines, time stamps, and scheduling.  It dynamically compiles
208 entries into an agenda that utilizes and smoothly integrates much of
209 the Emacs calendar and diary.  Plain text URL-like links connect to
210 websites, emails, Usenet messages, BBDB entries, and any files related
211 to the projects.  For printing and sharing of notes, an Org-mode file
212 can be exported as a structured ASCII file, as HTML, or (todo and
213 agenda items only) as an iCalendar file.
215    Org-mode keeps simple things simple.  When first fired up, it should
216 feel like a simple, easy to use outliner.  Complexity is not imposed,
217 but a large amount of functionality is available when you need it.
218 Org-mode can be used on different levels and in different ways, for
219 example:
221      * as an outline extension with visibility cycling and structure editing
222      * as an ASCII system and table editor for taking structured notes
223      * as an ASCII table editor with spreadsheet-like capabilities
224      * as a simple hypertext system, with HTML export
225      * as a TODO list editor
226      * as a full agenda and planner with deadlines and work scheduling
228    The Org-mode table editor can be integrated into any major mode by
229 activating the minor Orgtbl-mode.
231    There is a website for Org-mode which provides links to the newest
232 version of Org-mode, as well as additional information, screen shots
233 and example files.  This page is located at
234 `http://www.astro.uva.nl/~dominik/Tools/org/'.
236 \x1f
237 File: org,  Node: Installation and activation,  Next: Feedback,  Prev: Summary,  Up: Introduction
239 1.2 Installation and Activation
240 ===============================
242 If Org-mode is part of the Emacs distribution or an XEmacs package, you
243 only need to copy the following lines to your `.emacs' file.  The last
244 two lines define _global_ keys for the commands `org-store-link' and
245 `org-agenda' - please choose suitable keys yourself.
247      ;; The following lines are always needed.  Choose your own keys.
248      (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
249      (define-key global-map "\C-cl" 'org-store-link)
250      (define-key global-map "\C-ca" 'org-agenda)
252    If you have downloaded Org-mode from the Web, you must byte-compile
253 `org.el' and put it on your load path.  In addition to the Emacs Lisp
254 lines above, you also need to add the following lines to `.emacs':
256      ;; These lines only if org-mode is not part of the X/Emacs distribution.
257      (autoload 'org-mode "org" "Org mode" t)
258      (autoload 'org-diary "org" "Diary entries from Org mode")
259      (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
260      (autoload 'org-store-link "org" "Store a link to the current location" t)
261      (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
262      (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
264    With this setup, all files with extension `.org' will be put into
265 Org-mode.  As an alternative, make the first line of a file look like
266 this:
268      MY PROJECTS    -*- mode: org; -*-
270 which will select Org-mode for this buffer no matter what the file's
271 name is.  See also the variable `org-insert-mode-line-in-empty-file'.
273 \x1f
274 File: org,  Node: Feedback,  Prev: Installation and activation,  Up: Introduction
276 1.3 Feedback
277 ============
279 If you find problems with Org-mode, or if you have questions, remarks,
280 or ideas about it, please contact the maintainer Carsten Dominik at
281 <dominik@science.uva.nl>.
283    For bug reports, please provide as much information as possible,
284 including the version information of Emacs (`C-h v emacs-version
285 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
286 Org-mode related setup in `.emacs'.  If an error occurs, a traceback
287 can be very useful.  Often a small example file helps, along with clear
288 information about:
290   1. What exactly did you do?
292   2. What did you expect to happen?
294   3. What happened instead?
295         Thank you for helping to improve this mode.
297 \x1f
298 File: org,  Node: Document structure,  Next: Tables,  Prev: Introduction,  Up: Top
300 2 Document Structure
301 ********************
303 Org-mode is based on outline mode and provides flexible commands to
304 edit the structure of the document.
306 * Menu:
308 * Outlines::                    Org-mode is based on outline-mode
309 * Headlines::                   How to typeset org-tree headlines
310 * Visibility cycling::          Show and hide, much simplified
311 * Motion::                      Jumping to other headlines
312 * Structure editing::           Changing sequence and level of headlines
313 * Archiving::                   Move done task trees to a different place
314 * Sparse trees::                Matches embedded in context
315 * Plain lists::                 Editing hand-formatted lists
317 \x1f
318 File: org,  Node: Outlines,  Next: Headlines,  Prev: Document structure,  Up: Document structure
320 2.1 Outlines
321 ============
323 Org-mode is implemented on top of outline-mode.  Outlines allow to
324 organize a document in a hierarchical structure, which (at least for
325 me) is the best representation of notes and thoughts.  Overview over
326 this structure is achieved by folding (hiding) large parts of the
327 document to show only the general document structure and the parts
328 currently being worked on.  Org-mode greatly simplifies the use of
329 outlines by compressing the entire show/hide functionality into a
330 single command `org-cycle', which is bound to the <TAB> key.
332 \x1f
333 File: org,  Node: Headlines,  Next: Visibility cycling,  Prev: Outlines,  Up: Document structure
335 2.2 Headlines
336 =============
338 Headlines define the structure of an outline tree.  The headlines in
339 Org-mode start with one or more stars, on the left margin.  For example:
341      * Top level headline
342      ** Second level
343      *** 3rd level
344          some text
345      *** 3rd level
346          more text
347      * Another top level headline
349 Some people find the many stars too noisy and would prefer an outline
350 that has whitespace followed by a single star as headline starters.
351 *Note Clean view:: describes a setup to realize this.
353 \x1f
354 File: org,  Node: Visibility cycling,  Next: Motion,  Prev: Headlines,  Up: Document structure
356 2.3 Visibility cycling
357 ======================
359 Outlines make it possible to hide parts of the text in the buffer.
360 Org-mode uses a single command bound to the <TAB> key to change the
361 visibility in the buffer.
363 `<TAB>'
364      Rotate current subtree between the states
366           ,-> FOLDED -> CHILDREN -> SUBTREE --.
367           '-----------------------------------'
369      At the beginning of the buffer (or when called with `C-u'), this
370      does the same as the command `S-<TAB>' below.
372 `S-<TAB>'
373      Rotate the entire buffer between the states
375           ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
376           '--------------------------------------'
378      Note that inside tables, `S-<TAB>' jumps to the previous field.
380 `C-c C-a'
381      Show all.
383    When Emacs first visits an Org-mode file, the global state is set to
384 OVERVIEW, i.e. only the top level headlines are visible.  This can be
385 configured through the variable `org-startup-folded', or on a per-file
386 basis by adding one of the following lines anywhere in the buffer:
388      #+STARTUP: overview
389      #+STARTUP: content
390      #+STARTUP: showall
392 \x1f
393 File: org,  Node: Motion,  Next: Structure editing,  Prev: Visibility cycling,  Up: Document structure
395 2.4 Motion
396 ==========
398 The following commands jump to other headlines in the buffer.
400 `C-c C-n'
401      Next heading.  
403 `C-c C-p'
404      Previous heading.  
406 `C-c C-f'
407      Next heading same level.  
409 `C-c C-b'
410      Previous heading same level.  
412 `C-c C-u'
413      Backward to higher level heading.  
415 `C-c C-j'
416      Jump to a different place without changing the current outline
417      visibility.  Shows the document structure in a temporary buffer,
418      where you can use visibility cycling (<TAB>) to find your
419      destination.  After pressing <RET>, the cursor moves to the
420      selected location in the original buffer, and the headings
421      hierarchy above it is made visible.
423 \x1f
424 File: org,  Node: Structure editing,  Next: Archiving,  Prev: Motion,  Up: Document structure
426 2.5 Structure editing
427 =====================
429 `M-<RET>'
430      Insert new heading with same level as current.  If the cursor is
431      in a plain list item, a new item is created (*note Plain lists::).
432      To force creation of a new headline, use a prefix arg, or first
433      press <RET> to get to the beginning of the next line.  When this
434      command is used in the middle of a line, the line is split and the
435      rest of the line becomes the new headline.  If the command is used
436      at the beginning of a headline, the new headline is created before
437      the current line.  It at the beginning of any other line, the
438      content of that line is made the new heading.  
440 `M-S-<RET>'
441      Insert new TODO entry with same level as current heading.  
443 `M-<left>'
444      Promote current heading by one level.  
446 `M-<right>'
447      Demote current heading by one level.  
449 `M-S-<left>'
450      Promote the current subtree by one level.  
452 `M-S-<right>'
453      Demote the current subtree by one level.  
455 `M-S-<up>'
456      Move subtree up (swap with previous subtree of same level).  
458 `M-S-<down>'
459      Move subtree down (swap with next subtree of same level).  
461 `C-c C-x C-w'
462 `C-c C-x C-k'
463      Kill subtree, i.e. remove it from buffer but save in kill ring.  
465 `C-c C-x M-w'
466      Copy subtree to kill ring.  
468 `C-c C-x C-y'
469      Yank subtree from kill ring.  This does modify the level of the
470      subtree to make sure the tree fits in nicely at the yank position.
471      The yank level can also be specified with a prefix arg, or by
472      yanking after a headline marker like `****'.
474    When there is an active region (transient-mark-mode), promotion and
475 demotion work on all headlines in the region.  To select a region of
476 headlines, it is best to place both point and mark at the beginning of a
477 line, mark at the beginning of the first headline, and point at the line
478 just after the last headline to change.  Note that when the cursor is
479 inside a table (*note Tables::), the Meta-Cursor keys have different
480 functionality.
482 \x1f
483 File: org,  Node: Archiving,  Next: Sparse trees,  Prev: Structure editing,  Up: Document structure
485 2.6 Archiving
486 =============
488 When a project represented by a (sub)tree is finished, you may want to
489 move the tree to an archive place, either in the same file under a
490 special top-level heading, or even to a different file.
491 `C-c $'
492      Archive the subtree starting at the cursor position to the location
493      given by `org-archive-location'.
495    The default archive is a file in the same directory as the current
496 file, with the name derived by appending `_archive' to the current file
497 name.  For information and examples on how to change this, see the
498 documentation string of the variable `org-archive-location'.  If you
499 are also using the Org-mode agenda, archiving to a different file is a
500 good way to keep archived trees from contributing agenda items.
502 \x1f
503 File: org,  Node: Sparse trees,  Next: Plain lists,  Prev: Archiving,  Up: Document structure
505 2.7 Sparse trees
506 ================
508 An important feature of Org-mode is the ability to construct _sparse
509 trees_ for selected information in an outline tree.  A sparse tree
510 means that the entire document is folded as much as possible, but the
511 selected information is made visible along with the headline structure
512 above it(1).  Just try it out and you will see immediately how it works.
514    Org-mode contains several commands creating such trees.  The most
515 basic one is `org-occur':
517 `C-c /'
518      Occur.  Prompts for a regexp and shows a sparse tree with all
519      matches.  If the match is in a headline, the headline is made
520      visible.  If the match is in the body of an entry, headline and
521      body are made visible.  In order to provide minimal context, also
522      the full hierarchy of headlines above the match is shown, as well
523      as the headline following the match.  Each match is also
524      highlighted, the highlights disappear when the buffer is changed
525      with an editing command.
526    For frequently used sparse trees of specific search strings, you can
527 use the variable `org-agenda-custom-commands' to define fast keyboard
528 access to specific sparse trees.  These commands will then be
529 accessible through the agenda dispatcher (*note Agenda dispatcher::).
530 For example:
532      (setq org-agenda-custom-commands
533            '(("f" occur-tree "FIXME")))
535 will define the key `C-c a f' as a shortcut for creating a sparse tree
536 matching the string `FIXME'.
538    Other commands are using sparse trees as well.  For example `C-c
539 C-v' creates a sparse TODO tree (*note TODO basics::).
541    To print a sparse tree, you can use the Emacs command
542 `ps-print-buffer-with-faces' which does not print invisible parts of
543 the document (2).  Or you can use the command `C-c C-x v' to copy the
544 visible part of the document to another file (extension `.txt') which
545 can then be printed in any desired way.
547    ---------- Footnotes ----------
549    (1) See also the variables `org-show-hierarchy-above' and
550 `org-show-following-heading'.
552    (2) This does not work under XEmacs, because XEmacs uses selective
553 display for outlining, not text properties.
555 \x1f
556 File: org,  Node: Plain lists,  Prev: Sparse trees,  Up: Document structure
558 2.8 Plain lists
559 ===============
561 Headlines define both the structure of the Org-mode file, and also lists
562 (for example, TODO items (*note TODO items::) should be created using
563 headline levels).  However, when taking notes, the plain text is
564 sometimes easier to read with hand-formatted lists.  Org-mode supports
565 editing such lists, and the HTML exporter (*note Exporting::) does
566 parse and format them.
568    Org-mode knows ordered and unordered lists.  Unordered list items
569 start with `-', `+', or `*'(1) as bullets.  Ordered list items start
570 with `1.' or `1)'.  Items belonging to the same list must have the same
571 indentation on the first line.  In particular, if an ordered list
572 reaches number `10.', then the 2-digit numbers must be written
573 left-aligned with the other numbers in the list.  Indentation also
574 determines the end of a list item.  It ends before the next line that
575 is indented like the bullet/number, or less.  For example:
577      ** Lord of the Rings
578      My favorite scenes are (in this order)
579      1. Eowyns fight with the witch king
580         + this was already my favorite scene in the book
581         + I really like Miranda Otto.
582      2. The attack of the Rohirrim
583      3. Peter Jackson being shot by Legolas
584          - on DVD only
585         He makes a really funny face when it happens.
586      But in the end, not individual scenes matter but the film as a whole.
588    Org-mode supports these lists by tuning filling and wrapping commands
589 to correctly deal with them.  Furthermore, the following commands act
590 on items when the cursor is in the first line of an item (the line with
591 the bullet or number).
593 `<TAB>'
594      Items can be folded just like headline levels if you set the
595      variable `org-cycle-include-plain-lists'.  The level of an item is
596      then given by the indentation of the bullet/number.  However,
597      items are always subordinate to real headlines, the hierarchies
598      remain completely separated.  
600 `M-<RET>'
601      Insert new item at current level.  With prefix arg, force a new
602      heading (*note Structure editing::).  If this command is used in
603      the middle of a line, the line is _split_ and the rest of the line
604      becomes the new item.  If this command is executed in the
605      _whitespace before a bullet or number_, the new item is created
606      _before_ the current item.  If the command is executed in the
607      white space before the text that is part of an item but does not
608      contain the bullet, a bullet is added to the current line.  
610 `M-S-<up>'
611 `M-S-<down>'
612      Move the item including subitems up/down (swap with previous/next
613      item of same indentation).  If the list is ordered, renumbering is
614      automatic.  
616 `M-S-<left>'
617 `M-S-<right>'
618      Decrease/increase the indentation of the item, including subitems.
619      Initially, the item tree is selected based on current indentation.
620      When these commands are executed several times in direct
621      succession, the initially selected region is used, even if the new
622      indentation would imply a different hierarchy.  To use the new
623      hierarchy, break the command chain with a cursor motion or so.  
625 `C-c C-c'
626      Renumber the ordered list at the cursor.
628    ---------- Footnotes ----------
630    (1) When using `*' as a bullet, lines must be indented or they will
631 be seen as top-level headlines.  Also, when you are hiding leading
632 stars to get a clean outline view, plain list items starting with a
633 star are visually indistinguishable from true headlines.  In short:
634 even though `*' is supported, it may be better to not use it for plain
635 list items
637 \x1f
638 File: org,  Node: Tables,  Next: Hyperlinks,  Prev: Document structure,  Up: Top
640 3 Tables
641 ********
643 Org-mode has a very fast and intuitive table editor built-in.
644 Spreadsheet-like calculations are supported in connection with the
645 Emacs `calc' package.
647 * Menu:
649 * Built-in table editor::       Simple tables
650 * Narrow columns::              Stop wasting space in tables
651 * Table calculations::          Compute a field from other fields
652 * orgtbl-mode::                 The table editor as minor mode
653 * table.el::                    Complex tables
655 \x1f
656 File: org,  Node: Built-in table editor,  Next: Narrow columns,  Prev: Tables,  Up: Tables
658 3.1 The built-in table editor
659 =============================
661 Org-mode makes it easy to format tables in plain ASCII.  Any line with
662 `|' as the first non-white character is considered part of a table.
663 `|' is also the column separator.  A table might look like this:
665      | Name  | Phone | Age |
666      |-------+-------+-----|
667      | Peter |  1234 |  17 |
668      | Anna  |  4321 |  25 |
670    A table is re-aligned automatically each time you press <TAB> or
671 <RET> or `C-c C-c' inside the table.  <TAB> also moves to the next
672 field (<RET> to the next row) and creates new table rows at the end of
673 the table or before horizontal lines.  The indentation of the table is
674 set by the first line.  Any line starting with `|-' is considered as a
675 horizontal separator line and will be expanded on the next re-align to
676 span the whole table width.  So, to create the above table, you would
677 only type
679      |Name|Phone|Age
680      |-
682 and then press <TAB> to align the table and start filling in fields.
684    When typing text into a field, Org-mode treats <DEL>, <Backspace>,
685 and all character keys in a special way, so that inserting and deleting
686 avoids shifting other fields.  Also, when typing _immediately after the
687 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
688 the field is automatically made blank.  If this behavior is too
689 unpredictable for you, configure the variables
690 `org-enable-table-editor' and `org-table-auto-blank-field'.
692 Creation and conversion
693 .......................
695 `C-c |'
696      Convert the active region to table. If every line contains at
697      least one TAB character, the function assumes that the material is
698      tab separated.  If not, lines are split at whitespace into fields.
699      You can use a prefix argument to indicate the minimum number of
700      consecutive spaces required to identify a field separator
701      (default: just one).
702      If there is no active region, this command creates an empty
703      Org-mode table.  However, it's easier to just start typing, like
704      `|Name|Phone|Age <RET> |- <TAB>'.
706 Re-aligning and field motion
707 ............................
709 `C-c C-c'
710      Re-align the table without moving the cursor.
712 `<TAB>'
713      Re-align the table, move to the next field.  Creates a new row if
714      necessary.
716 `S-<TAB>'
717      Re-align, move to previous field.
719 `<RET>'
720      Re-align the table and move down to next row.  Creates a new row if
721      necessary.  At the beginning or end of a line, <RET> still does
722      NEWLINE, so it can be used to split a table.
724 Column and row editing
725 ......................
727 `M-<left>'
728 `M-<right>'
729      Move the current column left/right.
731 `M-S-<left>'
732      Kill the current column.
734 `M-S-<right>'
735      Insert a new column to the left of the cursor position.
737 `M-<up>'
738 `M-<down>'
739      Move the current row up/down.
741 `M-S-<up>'
742      Kill the current row or horizontal line.
744 `M-S-<down>'
745      Insert a new row above (with arg: below) the current row.
747 `C-c -'
748      Insert a horizontal line below current row. With prefix arg, the
749      line is created above the current line.
751 `C-c ^'
752      Sort the table lines in the region.  Point and mark must be in the
753      first and last line to be included, and must be in the column that
754      should be used for sorting.  The command prompts for numerical
755      versus alphanumerical sorting.
757 Regions
758 .......
760 `C-c C-x M-w'
761      Copy a rectangular region from a table to a special clipboard.
762      Point and mark determine edge fields of the rectangle.  The
763      process ignores horizontal separator lines.  
765 `C-c C-x C-w'
766      Copy a rectangular region from a table to a special clipboard, and
767      blank all fields in the rectangle.  So this is the "cut" operation.  
769 `C-c C-x C-y'
770      Paste a rectangular region into a table.  The upper right corner
771      ends up in the current field.  All involved fields will be
772      overwritten.  If the rectangle does not fit into the present table,
773      the table is enlarged as needed.  The process ignores horizontal
774      separator lines.  
776 `C-c C-q'
777      Wrap several fields in a column like a paragraph.  If there is an
778      active region, and both point and mark are in the same column, the
779      text in the column is wrapped to minimum width for the given
780      number of lines.  A prefix ARG may be used to change the number of
781      desired lines.  If there is no region, the current field is split
782      at the cursor position and the text fragment to the right of the
783      cursor is prepended to the field one line down. If there is no
784      region, but you specify a prefix ARG, the current field is made
785      blank, and the content is appended to the field above.
787 Calculations
788 ............
790 `C-c ='
791      Install a new formula for the current column and replace current
792      field with the result of the formula.
794 `C-u C-c ='
795      Install a new formula for the current field, which must be a named
796      field.  Evaluate the formula and replace the field content with the
797      result.
799 `C-c ''
800      Edit all formulas associated with the current table in a separate
801      buffer.
803 `C-c *'
804      Recalculate the current row by applying the stored formulas from
805      left to right.  When called with a `C-u' prefix, recalculate the
806      entire table, starting with the first non-header line (i.e. below
807      the first horizontal separator line).  For details, see *Note
808      Table calculations::.
810 `C-#'
811      Rotate the calculation mark in first column through the states `',
812      `#', `*', `!', `$'.  For the meaning of these marks see *Note
813      Advanced features::.  When there is an active region, change all
814      marks in the region.
816 `C-c ?'
817      Which table column is the cursor in?  Displays number >0 in echo
818      area.
820 `C-c +'
821      Sum the numbers in the current column, or in the rectangle defined
822      by the active region.  The result is shown in the echo area and can
823      be inserted with `C-y'.
825 `S-<RET>'
826      When current field is empty, copy from first non-empty field above.
827      When not empty, copy current field down to next row and move cursor
828      along with it.  Depending on the variable
829      `org-table-copy-increment', integer field values will be
830      incremented during copy.  This key is also used by CUA-mode (*note
831      Interaction::).
833 Miscellaneous
834 .............
836 `C-c `'
837      Edit the current field in a separate window.  This is useful for
838      fields that are not fully visible (*note Narrow columns::).  When
839      called with a `C-u' prefix, just make the full field visible, so
840      that it can be edited in place.
842 `C-c <TAB>'
843      This is an alias for `C-u C-c `' to make the current field fully
844      visible.
846 `M-x org-table-import'
847      Import a file as a table.  The table should be TAB- or whitespace
848      separated.  Useful, for example, to import an Excel table or data
849      from a database, because these programs generally can write
850      TAB-separated text files.  This command works by inserting the
851      file into the buffer and then converting the region to a table.
852      Any prefix argument is passed on to the converter, which uses it
853      to determine the separator.
855 `M-x org-table-export'
856      Export the table as a TAB-separated file.  Useful for data
857      exchange with, for example, Excel or database programs.
860    If you don't like the automatic table editor because it gets in your
861 way on lines which you would like to start with `|', you can turn it
862 off with
864      (setq org-enable-table-editor nil)
866 The only table command which then still works is `C-c C-c' to do a
867 manual re-align.
869 \x1f
870 File: org,  Node: Narrow columns,  Next: Table calculations,  Prev: Built-in table editor,  Up: Tables
872 3.2 Narrow columns
873 ==================
875 The width of columns is automatically determined by the table editor.
876 Sometimes a single field or a few fields need to carry more text,
877 leading to inconveniently wide columns.  To limit(1) the width of a
878 column, one field anywhere in the column may contain just the string
879 `<N>' where `N' is an integer specifying the width of the column in
880 characters.  The next re-align will then set the width of this column
881 to no more than this value.
883      |---+------------------------------|               |---+--------|
884      |   |                              |               |   | <6>    |
885      | 1 | one                          |               | 1 | one    |
886      | 2 | two                          |     ----\     | 2 | two    |
887      | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
888      | 4 | four                         |               | 4 | four   |
889      |---+------------------------------|               |---+--------|
891 Fields that are wider become clipped and end in the string `=>'.  Note
892 that the full text is still in the buffer, it is only invisible.  To
893 see the full text, hold the mouse over the field - a tooltip window
894 will show the full content.  To edit such a field, use the command `C-c
895 `' (that is `C-c' followed by the backquote).  This will open a new
896 window with the full field.  Edit it and finish with `C-c C-c'.
898    When visiting a file containing a table with narrowed columns, the
899 necessary character hiding has not yet happened, and the table needs to
900 be aligned before it looks nice.  Setting the option
901 `org-startup-align-all-tables' will realign all tables in a file upon
902 visiting, but also slow down startup.  You can also set this option on
903 a per-file basis with:
905      #+STARTUP: align
906      #+STARTUP: noalign
908    ---------- Footnotes ----------
910    (1) This feature does not work on XEmacs.
912 \x1f
913 File: org,  Node: Table calculations,  Next: orgtbl-mode,  Prev: Narrow columns,  Up: Tables
915 3.3 Calculations in tables
916 ==========================
918 The table editor makes use of the Emacs `calc' package to implement
919 spreadsheet-like capabilities.  Org-mode has two levels of complexity
920 for table calculations.  On the basic level, tables do only horizontal
921 computations, so a field can be computed from other fields _in the same
922 row_, and Org-mode assumes that there is only one formula for each
923 column.  This is very efficient to work with and enough for many tasks.
924 On the complex level, columns and individual fields can be named for
925 easier referencing in formulas, individual named fields can have their
926 own formula associated with them, and recalculation can be automated.
928 * Menu:
930 * Formula syntax::              How to write a formula
931 * Column formulas::             Formulas valid for all fields in a column
932 * Advanced features::           Field names, parameters and automatic recalc
933 * Named-field formulas::        Formulas valid in single fields
934 * Editing/debugging formulas::  Changing a stored formula
935 * Appetizer::                   Taste the power of calc
937 \x1f
938 File: org,  Node: Formula syntax,  Next: Column formulas,  Prev: Table calculations,  Up: Table calculations
940 3.3.1 Formula syntax
941 --------------------
943 A formula can be any algebraic expression understood by the Emacs
944 `calc' package.  Note that `calc' has the slightly non-standard
945 convention that `/' has lower precedence than `*', so that `a/b*c' is
946 interpreted as `a/(b*c)'.  Before evaluation by `calc-eval' (*note
947 calc-eval: (calc)Calling Calc from Your Programs.), variable
948 substitution takes place:
950        $        refers to the current field
951        $3       refers to the field in column 3 of the current row
952        $3..$7   a vector of the fields in columns 3-7 of current row
953        $P1..$P3 vector of column range, using column names
954        &2       second data field above the current, in same column
955        &5-2     vector from fifth to second field above current
956        &III-II  vector of fields between 2nd and 3rd hline above
957        &III     vector of fields between third hline above and current field
958        $name    a named field, parameter or constant
960    The range vectors can be directly fed into the calc vector functions
961 like `vmean' and `vsum'.
963    `$name' is interpreted as the name of a column, parameter or
964 constant.  Constants are defined globally through the variable
965 `org-table-formula-constants'.  If you have the `constants.el' package,
966 it will also be used to resolve constants, including natural constants
967 like `$h' for Planck's constant, and units like `$km' for kilometers.
968 Column names and parameters can be specified in special table lines.
969 These are described below, see *Note Advanced features::.
971    A formula can contain an optional mode string after a semicolon.
972 This string consists of flags to influence calc's modes(1) during
973 execution, e.g.  `p20' to switch the internal precision to 20 digits,
974 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
975 or fixed display format, respectively, and `D', `R', `F', and `S' to
976 turn on degrees, radians, fraction and symbolic modes, respectively.
977 In addition, you may provide a `printf' format specifier to reformat
978 the final result.  A few examples:
980        $1+$2                Sum of first and second field
981        $1+$2;%.2f           Same, format result to two decimals
982        exp($2)+exp($1)      Math functions can be used
983        $;%.1f               Reformat current cell to 1 decimal
984        ($3-32)*5/9          Degrees F -> C conversion
985        $c/$1/$cm            Hz -> cm conversion, using `constants.el'
986        tan($1);Dp3s1        Compute in degrees, precision 3, display SCI 1
987        sin($1);Dp3%.1e      Same, but use printf specifier for display
988        vmean($2..$7)        Compute column range mean, using vector function
989        vsum(&III)           Sum numbers from 3rd hline above, up to here
990        taylor($3,x=7,2)     taylor series of $3, at x=7, second degree
992    ---------- Footnotes ----------
994    (1) By default, Org-mode uses the standard calc modes (precision 12,
995 angular units degrees, fraction and symbolic modes off).  However, the
996 display format has been changed to `(float 5)' to keep tables compact.
997 The default settings can be configured using the variable
998 `org-calc-default-modes'.
1000 \x1f
1001 File: org,  Node: Column formulas,  Next: Advanced features,  Prev: Formula syntax,  Up: Table calculations
1003 3.3.2 Column formulas
1004 ---------------------
1006 To apply a formula to a field, type it directly into the field,
1007 preceded by an equal sign, like `=$1+$2'.  When you press <TAB> or
1008 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1009 be stored as the formula for the current column, evaluated and the
1010 current field replaced with the result.  If the field contains only
1011 `=', the previously stored formula for this column is used.
1013    For each column, Org-mode will remember the most recently used
1014 formula.  The information is stored in a special line starting with
1015 `#+TBLFM' directly below the table.  When adding/deleting/moving
1016 columns with the appropriate commands, the stored equations will be
1017 modified accordingly.  When a column used in a calculation is removed,
1018 references to this column become invalid and will cause an error upon
1019 applying the equation.
1021    Instead of typing an equation into the field, you may also use the
1022 command `C-c ='.  It prompts for a formula (with default taken from the
1023 `#+TBLFM:' line) and applies it to the current field.  A numerical
1024 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1025 in the current column.
1027    To recompute all the fields in a line, use the command `C-c *'.  It
1028 re-applies all stored equations to the current row, from left to right.
1029 With a `C-u' prefix, this will be done to every line in the table, so
1030 use this command it you want to make sure the entire table is
1031 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1032 Global updating does not touch the line(s) above the first horizontal
1033 separator line, assuming that this is the table header.
1035 \x1f
1036 File: org,  Node: Advanced features,  Next: Named-field formulas,  Prev: Column formulas,  Up: Table calculations
1038 3.3.3 Advanced features
1039 -----------------------
1041 If you want the recalculation of fields to happen automatically, or if
1042 you want to be able to assign a formula to an individual field (instead
1043 of an entire column) you need to reserve the first column of the table
1044 for special marking characters.  Here is an example of a table that
1045 collects exam results of students and makes use of these features:
1047      |---+---------+--------+--------+--------+-------+------|
1048      |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1049      |---+---------+--------+--------+--------+-------+------|
1050      | ! |         |     P1 |     P2 |     P3 |   Tot |      |
1051      | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
1052      | ^ |         |     m1 |     m2 |     m3 |    mt |      |
1053      |---+---------+--------+--------+--------+-------+------|
1054      | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
1055      | # | Sara    |      6 |     14 |     19 |    39 |  7.8 |
1056      | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
1057      |---+---------+--------+--------+--------+-------+------|
1058      |   | Average |        |        |        |  29.7 |      |
1059      | ^ |         |        |        |        |    at |      |
1060      | $ | max=50  |        |        |        |       |      |
1061      |---+---------+--------+--------+--------+-------+------|
1062      #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1064 Important: Please note that for these special tables, recalculating the
1065 table with `C-u C-c *' will only affect rows which are marked `#' or
1066 `*', and named fields.  The column formulas are not applied in rows
1067 with empty first field.
1069    The marking characters have the following meaning:
1071      The fields in this line define names for the columns, so that you
1072      may refer to a column as `$Tot' instead of `$6'.
1075      This row defines names for the fields _above_ the row.  With such
1076      a definition, any formula in the table may use `$m1' to refer to
1077      the value `10'.  Also, named fields can have their own formula
1078      associated with them.
1081      Similar to `^', but defines names for the fields in the row
1082      _below_.
1085      Fields in this row can define _parameters_ for formulas.  For
1086      example, if a field in a `$' row contains `max=50', then formulas
1087      in this table can refer to the value 50 using `$max'.  Parameters
1088      work exactly like constants, only that they can be defined on a
1089      per-table basis.  Changing a parameter and then recalculating the
1090      table can be useful.
1093      Fields in this row are automatically recalculated when pressing
1094      <TAB> or <RET> or `S-<TAB>' in this row.  Also, this row is
1095      selected for a global recalculation with `C-u C-c *'.  Unmarked
1096      lines will be left alone by this command.
1099      Selects this line for global recalculation with `C-u C-c *', but
1100      not for automatic recalculation.  Use this when automatic
1101      recalculation slows down editing too much.
1104      Unmarked lines are exempt from recalculation with `C-u C-c *'.
1105      All lines that should be recalculated should be marked with `#' or
1106      `*'.
1108 \x1f
1109 File: org,  Node: Named-field formulas,  Next: Editing/debugging formulas,  Prev: Advanced features,  Up: Table calculations
1111 3.3.4 Named-field formulas
1112 --------------------------
1114 A named field can have its own formula associated with it.  In the
1115 example above, this is used for the `at' field that contains the
1116 average result of the students.  To enter a formula for a named field,
1117 just type it into the buffer, preceded by `:='.  Or use `C-u C-c ='.
1118 This equation will be stored below the table like `$name=...'.  Any
1119 recalculation in the table (even if only requested for the current
1120 line) will also update all named field formulas.
1122 \x1f
1123 File: org,  Node: Editing/debugging formulas,  Next: Appetizer,  Prev: Named-field formulas,  Up: Table calculations
1125 3.3.5 Editing and debugging formulas
1126 ------------------------------------
1128 To edit a column or field formula, use the commands `C-c =' and `C-u
1129 C-c =', respectively.  The currently active expression is then
1130 presented as default in the minibuffer, where it may be edited.
1132    Note that making a table field blank does not remove the formula
1133 associated with the field - during the next recalculation the field
1134 will be filled again.  To remove a formula from a field, you have to
1135 give an empty reply when prompted for the formula, or to edit the
1136 `#+TBLFM' line.
1138    You may edit the `#+TBLFM' directly and re-apply the changed
1139 equations with `C-c C-c' in that line, or with the normal recalculation
1140 commands in the table.
1142    In particular for large tables with many formulas, it is convenient
1143 to use the command `C-c '' to edit the formulas of the current table in
1144 a separate buffer.  That buffer will show the formulas one per line,
1145 and you are free to edit, add and remove formulas.  Press `C-c ?' on a
1146 `$...'  expression to get information about its interpretation.
1147 Exiting the buffer with `C-c C-c' only stores the modified formulas
1148 below the table.  Exiting with `C-u C-c C-c' also applies them to the
1149 entire table.  `C-c C-q' exits without installing the changes.
1151    When the evaluation of a formula leads to an error, the field content
1152 becomes the string `#ERROR'.  If you would like see what is going on
1153 during variable substitution and calculation in order to find a bug,
1154 turn on formula debugging in the menu and repeat the calculation, for
1155 example by pressing `C-c = <RET>' in a field.  Detailed information
1156 will be displayed.
1158 \x1f
1159 File: org,  Node: Appetizer,  Prev: Editing/debugging formulas,  Up: Table calculations
1161 3.3.6 Appetizer
1162 ---------------
1164 Finally, just to wet your appetite on what can be done with the
1165 fantastic `calc' package, here is a table that computes the Taylor
1166 series for a couple of functions (homework: try that with Excel :-)
1168      |---+-------------+---+-----+--------------------------------------|
1169      |   | Func        | n | x   | Result                               |
1170      |---+-------------+---+-----+--------------------------------------|
1171      | # | exp(x)      | 1 | x   | 1 + x                                |
1172      | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
1173      | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
1174      | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1175      | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
1176      | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
1177      |---+-------------+---+-----+--------------------------------------|
1178      #+TBLFM: $5=taylor($2,$4,$3);n3
1180 \x1f
1181 File: org,  Node: orgtbl-mode,  Next: table.el,  Prev: Table calculations,  Up: Tables
1183 3.4 The Orgtbl minor mode
1184 =========================
1186 If you like the intuitive way the Org-mode table editor works, you
1187 might want to use it also in other modes like text-mode or mail-mode.
1188 The minor mode Orgtbl-mode makes this possible.  You can always toggle
1189 the mode with `M-x orgtbl-mode'.  To turn it on by default, for example
1190 in mail mode, use
1192      (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1194 \x1f
1195 File: org,  Node: table.el,  Prev: orgtbl-mode,  Up: Tables
1197 3.5 The `table.el' package
1198 ==========================
1200 Complex ASCII tables with automatic line wrapping, column- and
1201 row-spanning, and alignment can be created using the Emacs table
1202 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1203 also part of Emacs 22).  When <TAB> or `C-c C-c' is pressed in such a
1204 table, Org-mode will call `table-recognize-table' and move the cursor
1205 into the table.  Inside a table, the keymap of Org-mode is inactive.
1206 In order to execute Org-mode-related commands, leave the table.
1208 `C-c C-c'
1209      Recognize `table.el' table.  Works when the cursor is in a
1210      table.el table.
1212 `C-c ~'
1213      Insert a table.el table.  If there is already a table at point,
1214      this command converts it between the table.el format and the
1215      Org-mode format.  See the documentation string of the command
1216      `org-convert-table' for the restrictions under which this is
1217      possible.
1219 \x1f
1220 File: org,  Node: Hyperlinks,  Next: TODO items,  Prev: Tables,  Up: Top
1222 4 Hyperlinks
1223 ************
1225 Just like HMTL, Org-mode provides links inside a file, and external
1226 links to other files, Usenet articles, emails and much more.
1228 * Menu:
1230 * Link format::                 How links in Org-mode are formatted
1231 * Internal links::              Links to other places in the current file
1232 * External links::              URL-like links to the world
1233 * Handling links::              Creating, inserting and following
1234 * Search options::              Linking to a specific location
1235 * Custom searches::             When the default search is not enough
1236 * Remember::                    Org-trees store quick notes
1238 \x1f
1239 File: org,  Node: Link format,  Next: Internal links,  Prev: Hyperlinks,  Up: Hyperlinks
1241 4.1 Link format
1242 ===============
1244 Org-mode will recognize plain URL-like links and activate them as
1245 clickable links.  However, the general link format looks like this:
1247      [[link][description]]       or alternatively           [[link]]
1249    Once a link in the buffer is complete (all brackets present),
1250 Org-mode will change the display so that `description' is displayed
1251 instead of `[[link][description]]' and `link' is displayed instead of
1252 `[[link]]'.  Links will be highlighted in the face `org-link', which by
1253 default is an underlined face.  You can directly edit the visible part
1254 of a link.  Note that this can be either the `link' part (if there is
1255 not description) or the `description' part.  To edit also the invisible
1256 `link' part, use `C-c C-l' with the cursor on the link.
1258    If you place the cursor at the beginning or just behind the end of
1259 the displayed text and press <BACKSPACE>, you will remove the
1260 (invisible) bracket at that location.  This makes the link incomplete
1261 and the internals are again displayed as plain text.  Inserting the
1262 missing bracket does hide the link internals again.  To show the
1263 internal structure of all links, use the menu entry
1264 `Org->Hyperlinks->Literal links'.
1266 \x1f
1267 File: org,  Node: Internal links,  Next: External links,  Prev: Link format,  Up: Hyperlinks
1269 4.2 Internal links
1270 ==================
1272 If the link does not look like a URL, it is considered to be internal in
1273 the current file.  Links such as `[[My Target]]' or `[[My Target][Find
1274 my target]]' lead to a text search in the current file.  The link can
1275 be followed with `C-c C-o' when the cursor is on the link, or with a
1276 mouse click (*note Handling links::).  The preferred match for such a
1277 link is a dedicated target: The same string in double angular brackets.
1278 Targets may be located anywhere, often it is convenient to put them
1279 into a comment line, for example
1281      # <<My Target>>
1283 In HTML export (*note HTML export::), such targets will become named
1284 anchors for direct access through `http' links.
1286    If no dedicated target exists, Org-mode will search for the words in
1287 the link.  In the above example the search would be for `my target'.
1288 Links starting with a star like `*My Target' restrict the search to
1289 headlines.  When searching, Org-mode will first try an exact match, but
1290 then move on to more and more lenient searches.  For example, the link
1291 `[[*My Targets]]' will find any of the following:
1293      ** My targets
1294      ** TODO my targets are bright
1295      ** my 20 targets are
1297    To insert a link targeting a headline, in-buffer completion can be
1298 used.  Just type a star followed by a few optional letters into the
1299 buffer and press `M-<TAB>'.  All headlines in the current buffer will be
1300 offered as completions.  *Note Handling links::, for more commands
1301 creating links.
1303    Following a link pushes a mark onto Org-mode's own mark ring.  You
1304 can return to the previous position with `C-c &'.  Using this command
1305 several times in direct succession goes back to positions recorded
1306 earlier.
1308 * Menu:
1310 * Radio targets::               Make targets trigger links in plain text.
1311 * CamelCase links::             Activating CamelCase words as links
1313 \x1f
1314 File: org,  Node: Radio targets,  Next: CamelCase links,  Prev: Internal links,  Up: Internal links
1316 4.2.1 Radio targets
1317 -------------------
1319 You can configure Org-mode to link any occurrences of certain target
1320 names in normal text.  So without explicitly creating a link, the text
1321 connects to the target radioing its position.  Radio targets are
1322 enclosed by triple angular brackets.  For example, a target `<<<My
1323 Target>>>' causes each occurrence of `my target' in normal text to
1324 become activated as a link.  The Org-mode file is scanned automatically
1325 for radio targets only when the file is first loaded into Emacs.  To
1326 update the target list during editing, press `C-c C-c' with the cursor
1327 on or at a target.
1329 \x1f
1330 File: org,  Node: CamelCase links,  Prev: Radio targets,  Up: Internal links
1332 4.2.2 CamelCase words as links
1333 ------------------------------
1335 Org-mode also supports CamelCase words as links.  This feature is not
1336 turned on by default because of the inconsistencies this system suffers
1337 from.  To activate CamelCase words as links, you need to customize the
1338 option `org-activate-links'.  A CamelCase word then leads to a text
1339 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1341 \x1f
1342 File: org,  Node: External links,  Next: Handling links,  Prev: Internal links,  Up: Hyperlinks
1344 4.3 External links
1345 ==================
1347 Org-mode supports links to files, websites, Usenet and email messages;
1348 and BBDB database entries.  External links are URL-like locators.  The
1349 following list shows examples for each link type.
1351      http://www.astro.uva.nl/~dominik         on the web
1352      file:/home/dominik/images/jupiter.jpg    file, absolute path
1353      file:papers/last.pdf                     file, relative path
1354      news:comp.emacs                          Usenet link
1355      mailto:adent@galaxy.net                  Mail link
1356      vm:folder                                VM folder link
1357      vm:folder#id                             VM message link
1358      vm://myself@some.where.org/folder#id     VM on remote machine
1359      wl:folder                                WANDERLUST folder link
1360      wl:folder#id                             WANDERLUST message link
1361      mhe:folder                               MH-E folder link
1362      mhe:folder#id                            MH-E message link
1363      rmail:folder                             RMAIL folder link
1364      rmail:folder#id                          RMAIL message link
1365      gnus:group                               GNUS group link
1366      gnus:group#id                            GNUS article link
1367      bbdb:Richard Stallman                    BBDB link
1368      shell:ls *.org                           A shell command
1370    A link should be enclosed in double brackets and may contain a
1371 descriptive text to be displayed instead of the url (*note Link
1372 format::), for example:
1374      [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1376    Org-mode also finds external links in the normal text and activates
1377 them as links.  If spaces must be part of the link (for example in
1378 `bbdb:Richard Stallman') or to remove ambiguities about the end of the
1379 link, enclose them in angular brackets.
1381 \x1f
1382 File: org,  Node: Handling links,  Next: Search options,  Prev: External links,  Up: Hyperlinks
1384 4.4 Handling links
1385 ==================
1387 Org-mode provides methods to create a link in the correct syntax, to
1388 insert it into an org-mode file, and to follow the link.
1390 `C-c l'
1391      Store a link to the current location.  This is a _global_ command
1392      which can be used in any buffer to create a link.  The link will be
1393      stored for later insertion into an Org-mode buffer (see below).
1394      For Org-mode files, if there is a `<<target>>' at the cursor, the
1395      link points to the target.  Otherwise it points to the current
1396      headline.  For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1397      the link will indicate to the current article/entry.  For W3 and
1398      W3M buffers, the link goes to the current URL.  For any other
1399      files, the link will point to the file, with a search string
1400      (*note Search options::) pointing to the contents of the current
1401      line.  If there is an active region, the selected words will form
1402      the basis of the search string.  If the automatically created link
1403      is not working correctly or accurately enough, you can write
1404      custom functions to select the search string and to do the search
1405      for particular file types - see *Note Custom searches::.  The key
1406      binding `C-c l' is only a suggestion - see *Note Installation and
1407      activation::.
1409 `C-c C-l'
1410      Insert a link.  This prompts for a link to be inserted into the
1411      buffer.  You can just type a link, using text for an internal
1412      link, or one of the link type prefixes mentioned in the examples
1413      above.  Through completion, all links stored during the current
1414      session can be accessed.  The link will be inserted into the
1415      buffer, along with a descriptive text.  Note that you don't have
1416      to use this command to insert a link.  Links in Org-mode are plain
1417      text, and you can type or paste them straight into the buffer.  By
1418      using this command, the links are automatically enclosed in double
1419      brackets, and you will be asked for the optional descriptive text.
1421 `C-u C-c C-l'
1422      When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1423      file will be inserted and you may use file name completion to
1424      select the name of the file.  The path to the file is inserted
1425      relative to the directory of the current org file, if the linked
1426      file is in the current directory or in a subdirectory of it, or if
1427      the path is written relative to the current directory using `../'.
1428      Otherwise an absolute path is used, if possible with `~/' for
1429      your home directory.  You can force an absolute path with two
1430      `C-u' prefixes.
1432 `C-c C-l with cursor on existing link'
1433      When the cursor is on an existing link, `C-c C-l' allows to edit
1434      the link and description parts of the link.
1436 `C-c C-o'
1437      Open link at point.  This will launch a web browser for URLs (using
1438      `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1439      the corresponding links, and execute the command in a shell link.
1440      When the cursor is on an internal link, this commands runs the
1441      corresponding search.  When the cursor is on a TAGS list in a
1442      headline, it creates the corresponding TAGS view.  If the cursor
1443      is on a time stamp, it compiles the agenda for that date.
1444      Furthermore, it will visit text files in `file:' links with Emacs
1445      and select a suitable application for non-text files.
1446      Classification of files is based on file extension only.  See
1447      option `org-file-apps'.  If you want to override the default
1448      application and visit the file with Emacs, use a `C-u' prefix.
1450 `mouse-2'
1451 `mouse-1'
1452      On links, `mouse-2' will open the link just like `C-c C-o' would.
1453      Under Emacs 22, also `mouse-1' will follow a link.
1455 `mouse-3'
1456      Like `mouse-2', but force file links to be opened with Emacs.
1458 `C-c %'
1459      Push the current position onto the mark ring, to be able to return
1460      easily. Commands following an internal link do this automatically.
1462 `C-c &'
1463      Jump back to a recorded position.  A position is recorded by the
1464      commands following internal links, and by `C-c %'.  Using this
1465      command several times in direct succession moves through a ring of
1466      previously recorded positions.
1468 \x1f
1469 File: org,  Node: Search options,  Next: Custom searches,  Prev: Handling links,  Up: Hyperlinks
1471 4.5 Search options in file links
1472 ================================
1474 File links can contain additional information to make Emacs jump to a
1475 particular location in the file when following a link.  This can be a
1476 line number or a search option after a double(1) colon. For example,
1477 when the command `C-c l' creates a link (*note Handling links::) to a
1478 file, it encodes the words in the current line as a search string that
1479 can be used to find this line back later when following the link with
1480 `C-c C-o'.
1482    Here is the syntax of the different ways to attach a search to a file
1483 link, together with an explanation:
1485      [[file:~/code/main.c::255]]
1486      [[file:~/xx.org::My Target]]
1487      [[file:~/xx.org::*My Target]]
1488      [[file:~/xx.org::/regexp/]]
1490 `255'
1491      Jump to line 255.
1493 `My Target'
1494      Search for a link target `<<My Target>>', or do a text search for
1495      `my target', similar to the search in internal links, see *Note
1496      Internal links::.  In HTML export (*note HTML export::), such a
1497      file link will become an html reference to the corresponding named
1498      anchor in the linked file.
1500 `*My Target'
1501      In an Org-mode file, restrict search to headlines.
1503 `/regexp/'
1504      Do a regular expression search for `regexp'.  This uses the Emacs
1505      command `occur' to list all matches in a separate window.  If the
1506      target file is in Org-mode, `org-occur' is used to create a sparse
1507      tree with the matches.
1509    As a degenerate case, a file link with an empty file name can be used
1510 to search the current file.  For example, `<file:::find me>' does a
1511 search for `find me' in the current file, just like `[[find me]]' would.
1513    ---------- Footnotes ----------
1515    (1) For backward compatibility, line numbers can also follow a
1516 single colon.
1518 \x1f
1519 File: org,  Node: Custom searches,  Next: Remember,  Prev: Search options,  Up: Hyperlinks
1521 4.6 Custom Searches
1522 ===================
1524 The default mechanism for creating search strings and for doing the
1525 actual search related to a file link may not work correctly in all
1526 cases.  For example, BibTeX database files have many entries like
1527 `year="1993"' which would not result in good search strings, because
1528 the only unique identification for a BibTeX entry is the citation key.
1530    If you come across such a problem, you can write custom functions to
1531 set the right search string for a particular file type, and to do the
1532 search for the string in the file.  Using `add-hook', these functions
1533 need to be added to the hook variables
1534 `org-create-file-search-functions' and
1535 `org-execute-file-search-functions'.  See the docstring for these
1536 variables for more information.  Org-mode actually uses this mechanism
1537 for BibTeX database files, and you can use the corresponding code as an
1538 implementation example.  Search for `BibTeX links' in the source file.
1540 \x1f
1541 File: org,  Node: Remember,  Prev: Custom searches,  Up: Hyperlinks
1543 4.7 Remember
1544 ============
1546 Another way to create org entries with links to other files is through
1547 the _Remember_ package by John Wiegley.  _Remember_ lets you store
1548 quick notes with little interruption of your work flow.  See
1549 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1550 information.  The notes produced by _Remember_ can be stored in
1551 different ways, and Org-mode files are a good target.  Org-mode allows
1552 to file away notes either to a default file, or directly to the correct
1553 location in your Org-mode outline tree.  The following customization(1)
1554 will tell _Remember_ to use org files as target, and to create
1555 annotations compatible with Org-mode links.
1557      (setq org-directory "~/path/to/my/orgfiles/")
1558      (setq org-default-notes-file "~/.notes")
1559      (autoload 'org-remember-annotation "org")
1560      (autoload 'org-remember-apply-template "org")
1561      (autoload 'org-remember-handler "org")
1562      (setq remember-annotation-functions '(org-remember-annotation))
1563      (setq remember-handler-functions '(org-remember-handler))
1564      (add-hook 'remember-mode-hook 'org-remember-apply-template)
1566    In combination with Org-mode, you can use templates to generate
1567 different types of remember notes.  For example, if you would like to
1568 use one template to create general TODO entries, and another one for
1569 journal entries, you could use:
1571      (setq org-remember-templates
1572            '((?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org")
1573              (?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")))
1575 In these entries, the character specifies how to select the template,
1576 the first string specifies the template, and the (optional) second
1577 string specifies a default file (overruling `org-default-notes-file')
1578 as a target for this note.
1580    When you call `M-x remember' to remember something, org will prompt
1581 for a key to select the template and then prepare the buffer like
1582      * TODO
1583        <file:link to where you called remember>
1587      * [2006-03-21 Tue 15:37]
1589        <file:link to where you called remember>
1591 See the variable `org-remember-templates' for more details.
1593    When you are finished composing a note with remember, you have to
1594 press `C-c C-c' to file the note away.  The handler first prompts for a
1595 target file - if you press <RET>, the value of `org-default-notes-file'
1596 is used.  Then the command offers the headings tree of the selected
1597 file.  You can either immediately press <RET> to get the note appended
1598 to the file.  Or you can use vertical cursor motion (<up> and <down>)
1599 and visibility cycling (<TAB>) to find a better place.  Pressing <RET>
1600 or <left> or <right> leads to the following result.
1602 Cursor         Key     Note gets inserted
1603 position               
1604 buffer-start   <RET>   as level 2 heading at end of file
1605 on headline    <RET>   as sublevel of the heading at cursor
1606                <left>  as same level, before current heading
1607                <right> as same level, after current heading
1608 not on         <RET>   at cursor position, level taken from context.
1609 headline                      Or use prefix arg to specify level
1610                        manually.
1612    So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1613 append it to the default file.  Even shorter would be `C-u C-c C-c',
1614 which does the same without even showing the tree.  But with little
1615 extra effort, you can push it directly to the correct location.
1617    Before inserting the text into a tree, the function ensures that the
1618 text has a headline, i.e. a first line that starts with a `*'.  If not,
1619 a headline is constructed from the current date and some additional
1620 data.  If the variable `org-adapt-indentation' is non-nil, the entire
1621 text is also indented so that it starts in the same column as the
1622 headline (after the asterisks).
1624    ---------- Footnotes ----------
1626    (1) The three autoload forms are only necessary if `org.el' is not
1627 part of the Emacs distribution or an XEmacs package.
1629 \x1f
1630 File: org,  Node: TODO items,  Next: Timestamps,  Prev: Hyperlinks,  Up: Top
1632 5 TODO items
1633 ************
1635 Org-mode does not maintain TODO lists as a separate document.  TODO
1636 items are an integral part of the notes file, because TODO items
1637 usually come up while taking notes!  With Org-mode, you simply mark any
1638 entry in a tree as being a TODO item.  In this way, the information is
1639 not duplicated, and the entire context from which the item emerged is
1640 always present when you check.
1642    Of course, this technique causes TODO items to be scattered
1643 throughout your file.  Org-mode provides methods to give you an
1644 overview over all things you have to do.
1646 * Menu:
1648 * TODO basics::                 Marking and displaying TODO entries
1649 * Progress logging::            Document your productivity
1650 * TODO extensions::             Workflow and assignments
1651 * Priorities::                  Some things are more important than others
1653 \x1f
1654 File: org,  Node: TODO basics,  Next: Progress logging,  Prev: TODO items,  Up: TODO items
1656 5.1 Basic TODO functionality
1657 ============================
1659 Any headline can become a TODO item by starting it with the word TODO,
1660 for example:
1662      *** TODO Write letter to Sam Fortune
1664 The most important commands to work with TODO entries are:
1666 `C-c C-t'
1667      Rotate the TODO state of the current item between
1669           ,-> (unmarked) -> TODO -> DONE --.
1670           '--------------------------------'
1672      The same rotation can also be done "remotely" from the timeline and
1673      agenda buffers with the `t' command key (*note Agenda commands::).  
1675 `C-c C-v'
1676      View TODO items in a _sparse tree_ (*note Sparse trees::).  Folds
1677      the entire buffer, but shows all TODO items and the headings
1678      hierarchy above them.  With prefix arg, show also the DONE
1679      entries.  With numerical prefix N, show the tree for the Nth
1680      keyword in the variable `org-todo-keywords'.  
1682 `C-c a t'
1683      Show the global TODO list.  This collects the TODO items from all
1684      agenda files (*note Agenda views::) into a single buffer.  The
1685      buffer is in `agenda-mode', so there are commands to examine and
1686      manipulate the TODO entries directly from that buffer (*note
1687      Agenda commands::).  *Note Global TODO list::, for more
1688      information.
1690 \x1f
1691 File: org,  Node: Progress logging,  Next: TODO extensions,  Prev: TODO basics,  Up: TODO items
1693 5.2 Progress Logging
1694 ====================
1696 If you want to keep track of _when_ a certain TODO item was finished,
1697 turn on logging with
1699      (setq org-log-done t)
1701 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1702 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1703 [timestamp]' will be inserted just after the headline.  If you turn the
1704 entry back into a TODO item again through further state cycling, that
1705 line will be removed again.  In the timeline (*note Timeline::) and in
1706 the agenda (*note Weekly/Daily agenda::), you can then use the `L' key
1707 to display the TODO items closed on each day, giving you an overview of
1708 what has been done on a day.
1710 \x1f
1711 File: org,  Node: TODO extensions,  Next: Priorities,  Prev: Progress logging,  Up: TODO items
1713 5.3 Extended use of TODO keywords
1714 =================================
1716 The default implementation of TODO entries is just two states: TODO and
1717 DONE.  You can, however, use the TODO feature for more complicated
1718 things by configuring the variables `org-todo-keywords' and
1719 `org-todo-interpretation'.  Using special setup, you can even use TODO
1720 keywords in different ways in different org files.
1722    Note that tags are another way to classify headlines in general and
1723 TODO items in particular (*note Tags::).
1725 * Menu:
1727 * Workflow states::             From TODO to DONE in steps
1728 * TODO types::                  I do this, Fred the rest
1729 * Per file keywords::           Different files, different requirements
1731 \x1f
1732 File: org,  Node: Workflow states,  Next: TODO types,  Prev: TODO extensions,  Up: TODO extensions
1734 5.3.1 TODO keywords as workflow states
1735 --------------------------------------
1737 You can use TODO keywords to indicate different states in the process
1738 of working on an item, for example:
1740      (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1741            org-todo-interpretation 'sequence)
1743    Changing these variables becomes only effective in a new Emacs
1744 session.  With this setup, the command `C-c C-t' will cycle an entry
1745 from TODO to FEEDBACK, then to VERIFY, and finally to DONE.  You may
1746 also use a prefix argument to quickly select a specific state.  For
1747 example `C-3 C-c C-t' will change the state immediately to VERIFY.  If
1748 you define many keywords, you can use in-buffer completion (see *Note
1749 Completion::) to insert these words into the buffer.
1751 \x1f
1752 File: org,  Node: TODO types,  Next: Per file keywords,  Prev: Workflow states,  Up: TODO extensions
1754 5.3.2 TODO keywords as types
1755 ----------------------------
1757 The second possibility is to use TODO keywords to indicate different
1758 types of action items.  For example, you might want to indicate that
1759 items are for "work" or "home".  If you are into David Allen's _Getting
1760 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1761 `MAYBE'.  Or, when you work with several people on a single project,
1762 you might want to assign action items directly to persons, by using
1763 their names as TODO keywords.  This would be set up like this:
1765      (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1766            org-todo-interpretation 'type)
1768    In this case, different keywords do not indicate a sequence, but
1769 rather different types.  So it is normally not useful to change from
1770 one type to another.  Therefore, in this case the behavior of the
1771 command `C-c C-t' is changed slightly(1).  When used several times in
1772 succession, it will still cycle through all names.  But when you return
1773 to the item after some time and execute `C-c C-t' again, it will switch
1774 from each name directly to DONE.  Use prefix arguments or completion to
1775 quickly select a specific name.  You can also review the items of a
1776 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1777 C-v'.  For example, to see all things Lucy has to do, you would use
1778 `C-3 C-c C-v'.  To collect Lucy's items from all agenda files into a
1779 single buffer, you would use the prefix arg as well when creating the
1780 global todo list: `C-3 C-c t'.
1782    ---------- Footnotes ----------
1784    (1) This is also true for the `t' command in the timeline and agenda
1785 buffers.
1787 \x1f
1788 File: org,  Node: Per file keywords,  Prev: TODO types,  Up: TODO extensions
1790 5.3.3 Setting up TODO keywords for individual files
1791 ---------------------------------------------------
1793 It can be very useful to use different aspects of the TODO mechanism in
1794 different files, which is not possible with the global settings
1795 described above.  For file-local settings, you need to add special
1796 lines to the file which set the keywords and interpretation for that
1797 file only.  For example, to set one of the two examples discussed
1798 above, you need one of the following lines, starting in column zero
1799 anywhere in the file:
1801      #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1802      #+TYP_TODO: Fred Sara Lucy Mike DONE
1804 To make sure you are using the correct keyword, type `#+' into the
1805 buffer and then use `M-<TAB>' completion.
1807    Remember that the last keyword must always mean that the item is DONE
1808 (you may use a different word, though).  Also note that in each file,
1809 only one of the two aspects of TODO keywords can be used.  After
1810 changing one of these lines, use `C-c C-c' with the cursor still in the
1811 line to make the changes known to Org-mode(1).
1813    If you want to use very many keywords, for example when working with
1814 a large group of people, you may split the names over several lines:
1816      #+TYP_TODO: Fred Sara Lucy Mike
1817      #+TYP_TODO: Luis George Jules Jessica
1818      #+TYP_TODO: Kim Arnold Peter
1819      #+TYP_TODO: DONE
1821    ---------- Footnotes ----------
1823    (1) Org-mode parses these lines only when Org-mode is activated
1824 after visiting a file.  `C-c C-c' with the cursor in a line starting
1825 with `#+' is simply restarting Org-mode, making sure that these changes
1826 will be respected.
1828 \x1f
1829 File: org,  Node: Priorities,  Prev: TODO extensions,  Up: TODO items
1831 5.4 Priorities
1832 ==============
1834 If you use Org-mode extensively to organize your work, you may end up
1835 with a number of TODO entries so large that you'd like to prioritize
1836 them.  This can be done by placing a _priority cookie_ into the
1837 headline, like this
1839      *** TODO [#A] Write letter to Sam Fortune
1841 With its standard setup, Org-mode supports priorities `A', `B', and
1842 `C'.  `A' is the highest priority.  An entry without a cookie is
1843 treated as priority `B'.  Priorities make a difference only in the
1844 agenda (*note Weekly/Daily agenda::).
1846 `C-c ,'
1847      Set the priority of the current item.  The command prompts for a
1848      priority character `A', `B' or `C'.  When you press <SPC> instead,
1849      the priority cookie is removed from the headline.  The priorities
1850      can also be changed "remotely" from the timeline and agenda buffer
1851      with the `,' command (*note Agenda commands::).
1853 `S-<up>'
1854 `S-<down>'
1855      Increase/decrease priority of current item.  Note that these keys
1856      are also used to modify time stamps (*note Creating timestamps::).
1857      Furthermore, these keys are also used by CUA-mode (*note
1858      Interaction::).
1860 \x1f
1861 File: org,  Node: Timestamps,  Next: Tags,  Prev: TODO items,  Up: Top
1863 6 Timestamps
1864 ************
1866 Items can be labeled with timestamps to make them useful for project
1867 planning.
1869 * Menu:
1871 * Time stamps::                 Assigning a time to a tree entry
1872 * Creating timestamps::         Commands which insert timestamps
1874 \x1f
1875 File: org,  Node: Time stamps,  Next: Creating timestamps,  Prev: Timestamps,  Up: Timestamps
1877 6.1 Time stamps, deadlines and scheduling
1878 =========================================
1880 A time stamp is a specification of a date (possibly with time) in a
1881 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1882 A time stamp can appear anywhere in the headline or body of an org-tree
1883 entry.  Its presence allows entries to be shown on specific dates in
1884 the agenda (*note Weekly/Daily agenda::).  We distinguish:
1886 TIMESTAMP
1887      A simple time stamp just assigns a date/time to an item.  This is
1888      just like writing down an appointment in a paper agenda, or like
1889      writing down an event in a diary, when you want to take not of
1890      when something happened.  In the timeline and agenda displays, the
1891      headline of an entry associated with a plain time stamp will be
1892      shown exactly on that date.
1894 TIMERANGE
1895      Two time stamps connected by `--' denote a time range.  The
1896      headline will be shown on the first and last day of the range, and
1897      on any dates that are displayed and fall in the range.  Here is an
1898      example:
1900           ** Meeting in Amsterdam
1901              <2004-08-23 Mon>--<2004-08-26 Thu>
1903 SCHEDULED
1904      If a time stamp is preceded by the word `SCHEDULED:', it means you
1905      are planning to start working on that task on the given date. So
1906      this is not about recording an event, but about planning your
1907      work.  The headline will be listed under the given date.  In
1908      addition, a reminder that the scheduled date has passed will be
1909      present in the compilation for _today_, until the entry is marked
1910      DONE.  I.e., the task will automatically be forwarded until
1911      completed.
1913           *** TODO Call Trillian for a date on New Years Eve.
1914               SCHEDULED: <2004-12-25 Sat>
1916 DEADLINE
1917      If a time stamp is preceded by the word `DEADLINE:', the task
1918      (most likely a TODO item) is supposed to be finished on that date,
1919      and it will be listed then.  In addition, the compilation for
1920      _today_ will carry a warning about the approaching or missed
1921      deadline, starting `org-deadline-warning-days' before the due
1922      date, and continuing until the entry is marked DONE.  An example:
1924           *** TODO write article about the Earth for the Guide
1925               The editor in charge is <bbdb:Ford Prefect>
1926               DEADLINE: <2004-02-29 Sun>
1928 \x1f
1929 File: org,  Node: Creating timestamps,  Prev: Time stamps,  Up: Timestamps
1931 6.2 Creating timestamps
1932 =======================
1934 For Org-mode to recognize time stamps, they need to be in the specific
1935 format.  All commands listed below produce time stamps in the correct
1936 format.
1938 `C-c .'
1939      Prompt for a date and insert a corresponding time stamp.  When the
1940      cursor is at a previously used time stamp, it is updated to NOW.
1941      When this command is used twice in succession, a time range is
1942      inserted.
1944 `C-u C-c .'
1945      Like `C-c .', but use the alternative format which contains date
1946      and time.  The default time can be rounded to multiples of 5
1947      minutes, see the option `org-time-stamp-rounding-minutes'.
1949 `C-c !'
1950      Like `C-c .', but insert an inactive time stamp not triggering the
1951      agenda.
1953 `C-c <'
1954      Insert a time stamp corresponding to the cursor date in the
1955      Calendar.
1957 `C-c >'
1958      Access the Emacs calendar for the current date.  If there is a
1959      timestamp in the current line, goto the corresponding date instead.
1961 `C-c C-o'
1962      Access the agenda for the date given by the time stamp at point
1963      (*note Weekly/Daily agenda::).
1965 `C-c C-d'
1966      Insert `DEADLINE' keyword along with a stamp.  
1968 `C-c C-w'
1969      Create a sparse tree with all deadlines that are either past-due,
1970      or which will become due within `org-deadline-warning-days'.  With
1971      `C-u' prefix, show all deadlines in the file.  With a numeric
1972      prefix, check that many days.  For example, `C-1 C-c C-w' shows
1973      all deadlines due tomorrow.
1975 `C-c C-s'
1976      Insert `SCHEDULED' keyword along with a stamp.
1978 `S-<left>'
1979 `S-<right>'
1980      Change date at cursor by one day.  These key bindings conflict with
1981      CUA-mode (*note Interaction::).
1983 `S-<up>'
1984 `S-<down>'
1985      Change the item under the cursor in a timestamp.  The cursor can
1986      be on a year, month, day, hour or minute.  Note that if the cursor
1987      is not at a time stamp, these same keys modify the priority of an
1988      item.  (*note Priorities::). The key bindings also conflict with
1989      CUA-mode (*note Interaction::).
1991 `C-c C-y'
1992      Evaluate a time range by computing the difference between start and
1993      end.  With prefix arg, insert result after the time range (in a
1994      table: into the following column).
1996    When Org-mode prompts for a date/time, the function reading your
1997 input will replace anything you choose not to specify with the current
1998 date and time.  For details, see the documentation string of
1999 `org-read-date'.  Also, a calender will pop up to allow selecting a
2000 date.  The calendar can be fully controlled from the minibuffer, and a
2001 date can be selected with the following commands:
2004      Scroll calendar backwards by one month.  
2007      Scroll calendar forwards by one month.  
2009 `mouse-1'
2010      Select date by clicking on it.  
2012 `S-<right>'
2013      One day forward.  
2015 `S-<left>'
2016      One day back.  
2018 `S-<down>'
2019      One week forward.  
2021 `S-<up>'
2022      One week back.  
2024 `M-S-<right>'
2025      One month forward.  
2027 `M-S-<left>'
2028      One month back.  
2030 `<RET>'
2031      Choose date in calendar (only if nothing typed into minibuffer).
2033 \x1f
2034 File: org,  Node: Tags,  Next: Agenda views,  Prev: Timestamps,  Up: Top
2036 7 Tags
2037 ******
2039 If you wish to implement a system to cross-correlate information, an
2040 excellent way is to assign tags to headline.  Org-mode has extensive
2041 support for using tags.
2043    Every headline can contain a list of tags, at the end of the
2044 headline.  Tags are normal words containing letters, numbers, `_', and
2045 `@'.  Tags must be preceded and followed by a single colon; like
2046 `:WORK:'.  Several tags can be specified like `:WORK:URGENT:'.
2048 * Menu:
2050 * Tag inheritance::             Tags use the tree structure of the outline
2051 * Setting tags::                How to assign tags to a headline
2052 * Tag searches::                Searching for combinations of tags
2054 \x1f
2055 File: org,  Node: Tag inheritance,  Next: Setting tags,  Prev: Tags,  Up: Tags
2057 7.1 Tag inheritance
2058 ===================
2060 Tags make use of the hierarchical structure of outline trees.  If a
2061 heading has a certain tag, all subheadings will inherit the tag as
2062 well.  For example, in the list
2064      * Meeting with the French group      :WORK:
2065      ** Summary by Frank                  :BOSS:NOTES:
2066      *** TODO Prepare slides for him      :ACTION:
2068 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2069 `:ACTION:'.  When executing tag searches and Org-mode finds that a
2070 certain headline matches the search criterion, it will not check any
2071 sublevel headline, assuming that these likely also match, and that the
2072 list of matches can become very long.  However, this may not be what
2073 you want, and you can influence inheritance and searching using the
2074 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2076 \x1f
2077 File: org,  Node: Setting tags,  Next: Tag searches,  Prev: Tag inheritance,  Up: Tags
2079 7.2 Setting tags
2080 ================
2082 As Org-mode deals with plain text files, tags can simply be typed into
2083 the buffer.  After a colon, `M-<TAB>' offers completion on all tags
2084 being used in the current buffer.  There is also a special command for
2085 inserting tags:
2087 `C-c C-c'
2088      Enter new tags for the current headline.  The minibuffer will
2089      prompt for a list of tags and offer completion with respect to all
2090      other tags used in the current buffer.  Several tags, separated by
2091      colons, may be specified at the prompt.  After pressing <RET>, the
2092      tags will be inserted and aligned to `org-tags-column'.  When
2093      called with a `C-u' prefix, all tags in the current buffer will be
2094      aligned to that column, just to make things look nice.  TAGS are
2095      automatically realigned after promotion, demotion, and TODO state
2096      changes (*note TODO basics::).
2098 \x1f
2099 File: org,  Node: Tag searches,  Prev: Setting tags,  Up: Tags
2101 7.3 Tag searches
2102 ================
2104 Once a tags system has been set up, it can be used to collect related
2105 information into special lists.
2107 `C-c \'
2108      Create a sparse tree with all headlines matching a tags search.  
2110 `C-c a m'
2111      Create a global list of tag matches from all agenda files.  *Note
2112      Matching headline tags::.  
2114 `C-c a M'
2115      Create a global list of tag matches from all agenda files, but
2116      check only TODO items and force checking subitems (see variable
2117      `org-tags-match-list-sublevels').
2119    A tags search string can use Boolean operators `&' for AND and `|'
2120 for OR.  `&' binds more strongly than `|'.  Parenthesis are currently
2121 not implemented.  A tag may also be preceded by `-', to select against
2122 it, and `+' is syntactic sugar for positive selection.  The AND
2123 operator `&' is optional when `+' or `-' is present.  For example,
2124 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2125 discard those also tagged `:BOSS:'.  The search string `WORK|LAPTOP'
2126 selects all lines tagged `:WORK:' or `:LAPTOP:'.  The string
2127 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2128 `NIGHT'.
2130 \x1f
2131 File: org,  Node: Agenda views,  Next: Exporting,  Prev: Tags,  Up: Top
2133 8 Agenda Views
2134 **************
2136 Due to the way Org-mode works, TODO items, time-stamped items, and
2137 tagged headlines can be scattered throughout a file or even a number of
2138 files.  To get an overview over open action items, or over events that
2139 are important for a particular date, this information must be collected,
2140 sorted and displayed in an organized way.
2142    Org-mode can select items based on various criteria, and display them
2143 in a separate buffer.  Three different views are provided:
2145    * an _agenda_ that is like a calendar and shows information for
2146      specific dates
2148    * a _TODO list_ that covers all unfinished action items, and
2150    * a _tags view_ that shows information based on the tags associated
2151      with headlines in the outline tree.
2153 The extracted information is displayed in a special _agenda buffer_.
2154 This buffer is read-only, but provides commands to visit the
2155 corresponding locations in the original Org-mode files, and even to
2156 edit these files remotely.
2158 * Menu:
2160 * Agenda files::                Files being searched for agenda information
2161 * Agenda dispatcher::           Keyboard access to agenda views
2162 * Weekly/Daily agenda::         The calendar page with current tasks
2163 * Global TODO list::            All unfinished action items
2164 * Matching headline tags::      Structured information with fine-tuned search
2165 * Timeline::                    Time-sorted view for single file
2166 * Agenda commands::             Remote editing of org trees
2168 \x1f
2169 File: org,  Node: Agenda files,  Next: Agenda dispatcher,  Prev: Agenda views,  Up: Agenda views
2171 8.1 Agenda files
2172 ================
2174 The information to be shown is collected from all _agenda files_, the
2175 files listed in the variable `org-agenda-files'(1).  Thus even if you
2176 only work with a single Org-mode file, this file should be put into
2177 that list(2).  You can customize `org-agenda-files', but the easiest
2178 way to maintain it is through the following commands
2180 `C-c ['
2181      Add current file to the list of agenda files.  The file is added to
2182      the front of the list.  If it was already in the list, it is moved
2183      to the front.  With prefix arg, file is added/moved to the end.  
2185 `C-c ]'
2186      Remove current file from the list of agenda files.  
2188 `C-,'
2189      Cycle through agenda file list, visiting one file after the other.
2191 The Org menu contains the current list of files and can be used to
2192 visit any of them.
2194    ---------- Footnotes ----------
2196    (1) If the value of that variable is not a list, but a single file
2197 name, then the list of agenda files will be maintained in that external
2198 file.
2200    (2) When using the dispatcher pressing `1' before selecting a
2201 command will actually limit the command to the current file, and ignore
2202 `org-agenda-files' until the next dispatcher command.
2204 \x1f
2205 File: org,  Node: Agenda dispatcher,  Next: Weekly/Daily agenda,  Prev: Agenda files,  Up: Agenda views
2207 8.2 The agenda dispatcher
2208 =========================
2210 The views are created through a dispatcher that should be bound to a
2211 global key, for example `C-c a' (*note Installation and activation::).
2212 In the following we will assume that `C-c a' is indeed how the
2213 dispatcher is accessed and list keyboard access to commands
2214 accordingly.  After pressing `C-c a', an additional letter is required
2215 to execute a command.  The dispatcher offers the following default
2216 commands:
2218      Create the calendar-like agenda (*note Weekly/Daily agenda::).
2220 `t / T'
2221      Create a list of all TODO items (*note Global TODO list::).
2223 `m / M'
2224      Create a list of headlines matching a TAGS expression (*note
2225      Matching headline tags::).
2227    You can also define custom commands that will be accessible through
2228 the dispatcher, just like the default commands.  Custom commands are
2229 global searches for tags and specific TODO keywords, or a variety of
2230 sparse tree creating commands (*note Sparse trees::).  As sparse trees
2231 are only defined for a single org-mode file, these latter commands act
2232 on the current buffer instead of the list of agenda files.
2234    Custom commands are configured in the variable
2235 `org-agenda-custom-commands'.  You can customize this variable, for
2236 example by pressing `C-c a C'.  You can also directly set it with Emacs
2237 Lisp in `.emacs'.  For example:
2239      (setq org-agenda-custom-commands
2240            '(("w" todo "WAITING")
2241              ("u" tags "+BOSS-URGENT")
2242              ("U" tags-tree "+BOSS-URGENT")
2243              ("f" occur-tree "\\<FIXME\\>")))
2245 will define `C-c a w' as a global search for TODO entries with
2246 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2247 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2248 search but only in the current buffer and display the result as a
2249 sparse tree, and `C-c a f' to create a sparse tree with all entries
2250 containing the word `FIXME'.  For more information, look at the
2251 documentation string of the variable `org-agenda-custom-commands'.
2253 \x1f
2254 File: org,  Node: Weekly/Daily agenda,  Next: Global TODO list,  Prev: Agenda dispatcher,  Up: Agenda views
2256 8.3 The weekly/daily agenda
2257 ===========================
2259 The purpose of the weekly/daily _agenda_ is to act like a page of a
2260 paper agenda, showing all the tasks for the current week or day.
2262 `C-c a a'
2263      Compile an agenda for the current week from a list of org files.
2264      The agenda shows the entries for each day.  With a `C-u' prefix (or
2265      when the variable `org-agenda-include-all-todo' is `t'), all
2266      unfinished TODO items (including those without a date) are also
2267      listed at the beginning of the buffer, before the first date.
2269    Remote editing from the agenda buffer means, for example, that you
2270 can change the dates of deadlines and appointments from the agenda
2271 buffer.  The commands available in the Agenda buffer are listed in
2272 *Note Agenda commands::.
2274 * Menu:
2276 * Categories::                  Not all tasks are equal
2277 * Time-of-day specifications::  How the agenda knows the time
2278 * Calendar/Diary integration::  Integrating Anniversaries and more
2279 * Sorting of agenda items::     The order of things
2281 \x1f
2282 File: org,  Node: Categories,  Next: Time-of-day specifications,  Prev: Weekly/Daily agenda,  Up: Weekly/Daily agenda
2284 8.3.1 Categories
2285 ----------------
2287 In the agenda buffer, each entry is preceded by a _category_, which is
2288 derived from the file name.  The category can also be set with a
2289 special line anywhere in the buffer, looking like this:
2291      #+CATEGORY: Thesis
2293    If there are several such lines in a file, each specifies the
2294 category for the text below it (but the first category also applies to
2295 any text before the first CATEGORY line).  The display in the agenda
2296 buffer looks best if the category is not longer than 10 characters.
2298 \x1f
2299 File: org,  Node: Time-of-day specifications,  Next: Calendar/Diary integration,  Prev: Categories,  Up: Weekly/Daily agenda
2301 8.3.2 Time-of-Day Specifications
2302 --------------------------------
2304 Org-mode checks each agenda item for a time-of-day specification.  The
2305 time can be part of the time stamp that triggered inclusion into the
2306 agenda, for example as in `<2005-05-10 Tue 19:00>'.  Time ranges can be
2307 specified with two time stamps, like
2308 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2310    In the headline of the entry itself, a time(range) may also appear as
2311 plain text (like `12:45' or a `8:30-1pm'.  If the agenda integrates the
2312 Emacs diary (*note Calendar/Diary integration::), time specifications
2313 in diary entries are recognized as well.
2315    For agenda display, Org-mode extracts the time and displays it in a
2316 standard 24 hour format as part of the prefix.  The example times in
2317 the previous paragraphs would end up in the agenda like this:
2319          8:30-13:00 Arthur Dent lies in front of the bulldozer
2320         12:45...... Ford Prefect arrives and takes Arthur to the pub
2321         19:00...... The Vogon reads his poem
2322         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2324    If the agenda is in single-day mode, or for the display of today, the
2325 timed entries are embedded in a time grid, like
2327          8:00...... ------------------
2328          8:30-13:00 Arthur Dent lies in front of the bulldozer
2329         10:00...... ------------------
2330         12:00...... ------------------
2331         12:45...... Ford Prefect arrives and takes Arthur to the pub
2332         14:00...... ------------------
2333         16:00...... ------------------
2334         18:00...... ------------------
2335         19:00...... The Vogon reads his poem
2336         20:00...... ------------------
2337         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2339    The time grid can be turned on and off with the variable
2340 `org-agenda-use-time-grid', and can be configured with
2341 `org-agenda-time-grid'.
2343 \x1f
2344 File: org,  Node: Calendar/Diary integration,  Next: Sorting of agenda items,  Prev: Time-of-day specifications,  Up: Weekly/Daily agenda
2346 8.3.3 Calendar/Diary integration
2347 --------------------------------
2349 Emacs contains the calendar and diary by Edward M. Reingold.  The
2350 calendar displays a three-month calendar with holidays from different
2351 countries and cultures.  The diary allows you to keep track of
2352 anniversaries, lunar phases, sunrise/set, recurrent appointments
2353 (weekly, monthly) and more.  In this way, it is quite complementary to
2354 Org-mode.  It can be very useful to combine output from Org-mode with
2355 the diary.
2357    In order to include entries from the Emacs diary into Org-mode's
2358 agenda, you only need to customize the variable
2360      (setq org-agenda-include-diary t)
2362 After that, everything will happen automatically.  All diary entries
2363 including holidays, anniversaries etc will be included in the agenda
2364 buffer created by Org-mode.  <SPC>, <TAB>, and <RET> can be used from
2365 the agenda buffer to jump to the diary file in order to edit existing
2366 diary entries.  The `i' command to insert new entries for the current
2367 date works in the agenda buffer, as well as the commands `S', `M', and
2368 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2369 to other calendars, respectively.  `c' can be used to switch back and
2370 forth between calendar and agenda.
2372 \x1f
2373 File: org,  Node: Sorting of agenda items,  Prev: Calendar/Diary integration,  Up: Weekly/Daily agenda
2375 8.3.4 Sorting of agenda items
2376 -----------------------------
2378 The entries for each day are sorted.  The default order is to first
2379 collect all items containing an explicit time-of-day specification.
2380 These entries will be shown at the beginning of the list, as a
2381 _schedule_ for the day.  After that, items remain grouped in
2382 categories, in the sequence given by `org-agenda-files'.  Within each
2383 category, items are sorted by priority (*note Priorities::).
2385    The priority is a numerical quantity composed of the base priority
2386 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2387 increments for overdue scheduled or deadline items.
2389    Sorting can be customized using the variable
2390 `org-agenda-sorting-strategy'.
2392 \x1f
2393 File: org,  Node: Global TODO list,  Next: Matching headline tags,  Prev: Weekly/Daily agenda,  Up: Agenda views
2395 8.4 The global TODO list
2396 ========================
2398 The global TODO list contains all unfinished TODO items, formatted and
2399 collected into a single place.
2401 `C-c a t'
2402      Show the global TODO list.  This collects the TODO items from all
2403      agenda files (*note Agenda views::) into a single buffer.  The
2404      buffer is in `agenda-mode', so there are commands to examine and
2405      manipulate the TODO entries directly from that buffer (*note
2406      Agenda commands::).  *Note Global TODO list::, for more
2407      information.  
2409 `C-c a T'
2410      Like the above, but allows selection of a specific TODO keyword.
2411      You can also do this by specifying a prefix argument to `C-c a t'.
2412      With a `C-u' prefix you are prompted for a keyword.  With a
2413      numeric prefix, the Nth keyword in `org-todo-keywords' is selected.  The
2414      `r' key in the agenda buffer regenerates it, and you can give a
2415      prefix argument to this command to change the selected TODO
2416      keyword, for example `3 r'.  If you often need a search for a
2417      specific keyword, define a custom command for it (*note Agenda
2418      dispatcher::).
2420    Remote editing of TODO items means that you can change the state of a
2421 TODO entry with a single key press.  The commands available in the TODO
2422 list are described in *Note Agenda commands::.
2424 \x1f
2425 File: org,  Node: Matching headline tags,  Next: Timeline,  Prev: Global TODO list,  Up: Agenda views
2427 8.5 Matching headline tags
2428 ==========================
2430 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2431 you can select headlines based on the tags that apply to them and
2432 collect them into an agenda buffer.
2434 `C-c a m'
2435      Produce a list of all headlines that match a given set of tags.
2436      The command prompts for a selection criterion, which is a boolean
2437      logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2438      `WORK|HOME' (*note Tags::).  If you often need a specific search,
2439      define a custom command for it (*note Agenda dispatcher::).  
2441 `C-c a M'
2442      Like `C-c a m', but only select headlines that are also TODO items
2443      and force checking subitems (see variable
2444      `org-tags-match-list-sublevels'.
2446    The commands available in the tags list are described in *Note
2447 Agenda commands::.
2449 \x1f
2450 File: org,  Node: Timeline,  Next: Agenda commands,  Prev: Matching headline tags,  Up: Agenda views
2452 8.6 Timeline for a single file
2453 ==============================
2455 The timeline is not really an agenda view, because it only summarizes
2456 items from a single Org-mode file.  But it also uses the agenda buffer
2457 and provides similar commands, so we discuss it here.  The timeline
2458 shows all time-stamped items in a single Org-mode file (or the selected
2459 part of it), in a _time-sorted view_.  The main purpose of this command
2460 is to give an overview over events in a project.
2462 `C-c C-r'
2463      Show a time-sorted view of the org file, with all time-stamped
2464      items.  When called with a `C-u' prefix, all unfinished TODO
2465      entries (scheduled or not) are also listed under the current date.
2467 The commands available in the timeline buffer are listed in *Note
2468 Agenda commands::.
2470 \x1f
2471 File: org,  Node: Agenda commands,  Prev: Timeline,  Up: Agenda views
2473 8.7 Commands in the agenda buffer
2474 =================================
2476 Entries in the agenda buffer are linked back to the org file or diary
2477 file where they originate.  You are not allowed to edit the agenda
2478 buffer itself, but commands are provided to show and jump to the
2479 original entry location, and to edit the org-files "remotely" from the
2480 agenda buffer.  In this way, all information is stored only once,
2481 removing the risk that your agenda and note files may diverge.
2483    Some commands can be executed with mouse clicks on agenda lines.  For
2484 the other commands, the cursor needs to be in the desired line.
2486 Motion
2487 ......
2490      Next line (same as <up>).  
2493      Previous line (same as <down>).
2495 View/GoTo org file
2496 ..................
2498 `mouse-3'
2499 `<SPC>'
2500      Display the original location of the item in another window.
2503      Display original location and recenter that window.
2505 `mouse-2'
2506 `mouse-1'
2507 `<TAB>'
2508      Go to the original location of the item in another window.  Under
2509      Emacs 22, `mouse-1' will also works for this.
2511 `<RET>'
2512      Go to the original location of the item and delete other windows.
2515      Toggle Follow mode.  In Follow mode, as you move the cursor through
2516      the agenda buffer, the other window always shows the corresponding
2517      location in the org file.  The initial setting for this mode in new
2518      agenda buffers can be set with the variable
2519      `org-agenda-start-with-follow-mode'.
2522      Toggle Logbook mode.  In Logbook mode, entries that where marked
2523      DONE while logging was on (variable `org-log-done') are shown in
2524      the agenda.
2526 Change display
2527 ..............
2530      Delete other windows.
2533      Switch to weekly view (7 days displayed together).
2536      Switch to daily view (just one day displayed).
2539      Toggle the inclusion of diary entries.  See *Note Calendar/Diary
2540      integration::.
2543      Toggle the time grid on and off.  See also the variables
2544      `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2547      Recreate the agenda buffer, for example to reflect the changes
2548      after modification of the time stamps of items with S-<left> and
2549      S-<right>.  When the buffer is the global todo list, a prefix
2550      argument is interpreted to create a selective list for a specific
2551      TODO keyword.
2553 `<right>'
2554      Display the following `org-agenda-ndays' days.  For example, if
2555      the display covers a week, switch to the following week.  With
2556      prefix arg, go forward that many times `org-agenda-ndays' days.
2558 `<left>'
2559      Display the previous dates.
2562      Goto today.
2564 Remote editing
2565 ..............
2567 `0-9'
2568      Digit argument.
2571      Change the TODO state of the item, both in the agenda and in the
2572      original org file.
2575      Show all tags associated with the current item.  Because of
2576      inheritance, this may be more than the tags listed in the line
2577      itself.
2580      Set tags for the current headline.
2583      Set the priority for the current item.  Org-mode prompts for the
2584      priority character. If you reply with <SPC>, the priority cookie
2585      is removed from the entry.
2588      Display weighted priority of current item.
2591 `S-<up>'
2592      Increase the priority of the current item.  The priority is
2593      changed in the original buffer, but the agenda is not resorted.
2594      Use the `r' key for this.
2597 `S-<down>'
2598      Decrease the priority of the current item.
2600 `S-<right>'
2601      Change the time stamp associated with the current line by one day
2602      into the future.  With prefix argument, change it by that many
2603      days.  For example, `3 6 5 S-<right>' will change it by a year.
2604      The stamp is changed in the original org file, but the change is
2605      not directly reflected in the agenda buffer.  Use the `r' key to
2606      update the buffer.
2608 `S-<left>'
2609      Change the time stamp associated with the current line by one day
2610      into the past.
2613      Change the time stamp associated with the current line to today.
2614      The key `>' has been chosen, because it is the same as `S-.' on my
2615      keyboard.
2618      Insert a new entry into the diary.  Prompts for the type of entry
2619      (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2620      new entry in the diary, just like `i d' etc. would do in the
2621      calendar.  The date is taken from the cursor position.
2623 Calendar commands
2624 .................
2627      Open the Emacs calendar and move to the date at the agenda cursor.
2630      When in the calendar, compute and show the Org-mode agenda for the
2631      date at the cursor.
2634      Show the phases of the moon for the three months around current
2635      date.
2638      Show sunrise and sunset times.  The geographical location must be
2639      set with calendar variables, see documentation of the Emacs
2640      calendar.
2643      Convert the date at cursor into many other cultural and historic
2644      calendars.
2647      Show holidays for three month around the cursor date.
2649 `C-c C-x C-c'
2650      Export a single iCalendar file containing entries from all agenda
2651      files.
2653 Quit and Exit
2654 .............
2657      Quit agenda, remove the agenda buffer.
2660      Exit agenda, remove the agenda buffer and all buffers loaded by
2661      Emacs for the compilation of the agenda.  Buffers created by the
2662      user to visit org files will not be removed.
2665 \x1f
2666 File: org,  Node: Exporting,  Next: Miscellaneous,  Prev: Agenda views,  Up: Top
2668 9 Exporting
2669 ***********
2671 Org-mode documents can be exported into a variety of other formats.  For
2672 printing and sharing of notes, ASCII export produces a readable and
2673 simple version of an Org-mode file.  HTML export allows to publish a
2674 notes file on the web, while the XML format provides a solid base for
2675 exchange with a broad range of other applications.  To incorporate
2676 entries with associated times like deadlines or appointments into a
2677 desktop calendar program like iCal, Org-mode can also produce extracts
2678 in the iCalendar format.  Currently Org-mode only supports export, not
2679 import of these different formats.
2681    When exporting, Org-mode uses special conventions to enrich the
2682 output produced.  *Note Text interpretation::, for more details.
2684 * Menu:
2686 * ASCII export::                Exporting to plain ASCII
2687 * HTML export::                 Exporting to HTML
2688 * XML export::                  Exporting to XML
2689 * iCalendar export::            Exporting in iCalendar format
2690 * Text interpretation::         How the exporter looks at the file
2692 \x1f
2693 File: org,  Node: ASCII export,  Next: HTML export,  Prev: Exporting,  Up: Exporting
2695 9.1 ASCII export
2696 ================
2698 ASCII export produces an simple and very readable version of an Org-mode
2699 file.
2701 `C-c C-x a'
2702      Export as ASCII file.  If there is an active region, only the
2703      region will be exported.  For an org file `myfile.org', the ASCII
2704      file will be `myfile.txt'.  The file will be overwritten without
2705      warning.
2707    In the exported version, the first 3 outline levels will become
2708 headlines, defining a general document structure.  Additional levels
2709 will be exported as itemized lists.  If you want that transition to
2710 occur at a different level, specify it with a prefix argument.  For
2711 example,
2713      C-1 C-c C-x a org-export-as-ascii
2715 creates only top level headlines and does the rest as items.
2717 \x1f
2718 File: org,  Node: HTML export,  Next: XML export,  Prev: ASCII export,  Up: Exporting
2720 9.2 HTML export
2721 ===============
2723 Org-mode contains an HTML exporter with extensive HTML formatting, in
2724 ways similar to John Grubers _markdown_ language, but with additional
2725 support for tables.
2727 `C-c C-x h'
2728      Export as HTML file `myfile.html'.  
2730 `C-c C-x b'
2731      Export as HTML file and open it with a browser.
2733    In the exported version, the first 3 outline levels will become
2734 headlines, defining a general document structure.  Additional levels
2735 will be exported as itemized lists.  If you want that transition to
2736 occur at a different level, specify it with a prefix argument.  For
2737 example,
2739      C-2 C-c C-x b
2741 creates two levels of headings and does the rest as items.
2743    If you want to include HTML tags which should be interpreted as such,
2744 mark them with a `@' like in `@<b>bold text@</b>'.  Plain `<' and `>'
2745 are always transformed to `&lt;' and `&gt;' in HTML export.
2747    You can also give style information for the exported file.  The
2748 default specification can be configured through the option
2749 `org-export-html-style'.  If you want to use a file-local style, you
2750 may use file variables, best wrapped into a COMMENT section at the end
2751 of the outline tree.  For example:
2753      * COMMENT HTML style specifications
2755      # Local Variables:
2756      # org-export-html-style: "   <style type=\"text/css\">
2757             p {font-weight: normal; color: gray; }
2758             h1 {color: black; }
2759         </style>"
2760      # End: ***
2762    Remember to execute `M-x normal-mode' after changing this to make
2763 the new style visible to Emacs.  This command restarts org-mode for the
2764 current buffer and forces Emacs to re-evaluate the local variables
2765 section in the buffer.
2767 \x1f
2768 File: org,  Node: XML export,  Next: iCalendar export,  Prev: HTML export,  Up: Exporting
2770 9.3 XML export
2771 ==============
2773 Org-mode contains an XML exporter that produces XOXO-style XML.
2774 Currently, this exporter only handles the general outline structure and
2775 does not interpret any additional Org-mode features.
2777 `C-c C-x C-x'
2778      Export as XML file `myfile.xml'.
2780 \x1f
2781 File: org,  Node: iCalendar export,  Next: Text interpretation,  Prev: XML export,  Up: Exporting
2783 9.4 iCalendar export
2784 ====================
2786 Some people like to use Org-mode for keeping track of projects, but
2787 still prefer a standard calendar application for anniversaries and
2788 appointments.  In this case it can be useful to have deadlines and
2789 other time-stamped items in Org-mode files show up in the calendar
2790 application.  Org-mode can export calendar information in the standard
2791 iCalendar format.
2793 `C-c C-x i'
2794      Create iCalendar entries for the current file and store them in
2795      the same directory, using a file extension `.ics'.  
2797 `C-c C-x C-i'
2798      Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2799      For each of these files, a separate iCalendar file will be
2800      written.  
2802 `C-c C-x c'
2803      Create a single large iCalendar file from all files in
2804      `org-agenda-files' and write it to the file given by
2805      `org-combined-agenda-icalendar-file'.
2807    How this calendar is best read and updated, depends on the
2808 application you are using.  For example, when using iCal under Apple
2809 MacOS X, you could create a new calendar `OrgMode' (the default name
2810 for the calendar created by `C-c C-x c', see the variables
2811 `org-icalendar-combined-name' and
2812 `org-combined-agenda-icalendar-file').  Then set Org-mode to overwrite
2813 the corresponding file `~/Library/Calendars/OrgMode.ics'.  You may even
2814 use AppleScript to make iCal re-read the calendar files each time a new
2815 version of `OrgMode.ics' is produced.  Here is the setup needed for
2816 this:
2818      (setq org-combined-agenda-icalendar-file
2819          "~/Library/Calendars/OrgMode.ics")
2820      (add-hook 'org-after-save-iCalendar-file-hook
2821       (lambda ()
2822        (shell-command
2823         "osascript -e 'tell application \"iCal\" to reload calendars'")))
2825 \x1f
2826 File: org,  Node: Text interpretation,  Prev: iCalendar export,  Up: Exporting
2828 9.5 Text interpretation by the exporter
2829 =======================================
2831 The exporter backends interpret additional structure in the Org-mode
2832 file in order to produce better output.
2834 * Menu:
2836 * Comment lines::               Some lines will not be exported
2837 * Enhancing text::              Subscripts, symbols and more
2838 * Export options::              How to influence the export settings
2840 \x1f
2841 File: org,  Node: Comment lines,  Next: Enhancing text,  Prev: Text interpretation,  Up: Text interpretation
2843 9.5.1 Comment lines
2844 -------------------
2846 Lines starting with `#' in column zero are treated as comments and will
2847 never be exported.  Also entire subtrees starting with the word
2848 `COMMENT' will never be exported.  Finally, any text before the first
2849 headline will not be exported either.
2851 `C-c ;'
2852      Toggle the COMMENT keyword at the beginning of an entry.
2854 \x1f
2855 File: org,  Node: Enhancing text,  Next: Export options,  Prev: Comment lines,  Up: Text interpretation
2857 9.5.2 Enhancing text for export
2858 -------------------------------
2860 Some of the export backends of Org-mode allow for sophisticated text
2861 formatting, this is true in particular for the HTML backend.  Org-mode
2862 has a number of typing conventions that allow to produce a richly
2863 formatted output.
2865    * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
2866      enumerator will be recognized and transformed if the backend
2867      supports lists.  See *Note Plain lists::.
2869    * You can make words *bold*, /italic/, and _underlined_
2871    * Simple TeX-like math constructs are interpreted:
2873         - `10^22' and `J_n' are super- and subscripts.  You can quote
2874           `^' and `_' with a backslash: `\_' and `\^'
2876         - `\alpha' indicates a Greek letter, `\to' an arrow.  You can
2877           use completion for these macros, just type `\' and maybe a few
2878           letters, and press `M-<TAB>' to see possible completions.
2880    * Tables are transformed into native tables under the exporter, if
2881      the export backend supports this. Data fields before the first
2882      horizontal separator line will be formatted as table header fields.
2884    * If a headline starts with the word `QUOTE', the text below the
2885      headline will be typeset as fixed-width, to allow quoting of
2886      computer codes etc.  Lines starting with `:' are also typeset in
2887      fixed-width font.
2888     `C-c :'
2889           Toggle fixed-width for entry (QUOTE) or region, see below.
2891    If these conversions conflict with your habits of typing ASCII text,
2892 they can all be turned off with corresponding variables (see the
2893 customization group `org-export-general', and the following section
2894 which explains how to set export options with special lines in a buffer.
2896 \x1f
2897 File: org,  Node: Export options,  Prev: Enhancing text,  Up: Text interpretation
2899 9.5.3 Export options
2900 --------------------
2902 The exporter recognizes special lines in the buffer which provide
2903 additional information.  These lines may be put anywhere in the file.
2904 The whole set of lines can be inserted into the buffer with `C-c C-x
2905 t'.  For individual lines, a good way to make sure the keyword is
2906 correct is to type `#+' and then use `M-<TAB>' completion (*note
2907 Completion::).
2909 `C-c C-x t'
2910      Insert template with export options, see example below.
2912      #+TITLE:     the title to be shown (default is the buffer name)
2913      #+AUTHOR:    the author (default taken from `user-full-name')
2914      #+EMAIL:     his/her email address (default from `user-mail-address')
2915      #+LANGUAGE:  language for HTML, e.g. `en' (`org-export-default-language')
2916      #+TEXT:      Some descriptive text to be inserted at the beginning.
2917      #+TEXT:      Several lines may be given.
2918      #+OPTIONS:   H:2  num:t  toc:t  \n:nil  t  ::t  |:t  ^:t  *:nil  TeX:t
2920 The OPTIONS line is a compact form to specify export settings.  Here
2921 you can: 
2922      H:      set the number of headline levels for export
2923      num:    turn on/off section-numbers
2924      toc:    turn on/off table of contents
2925      \n:     turn on/off linebreak-preservation
2926      @:      turn on/off quoted html tags
2927      ::      turn on/off fixed-width sections
2928      |:      turn on/off tables
2929      ^:      turn on/off TeX-like syntax for sub- and superscripts.
2930      *:      turn on/off emphasized text (bold, italic, underlined)
2931      TeX:    turn on/off TeX macros
2933 \x1f
2934 File: org,  Node: Miscellaneous,  Next: Index,  Prev: Exporting,  Up: Top
2936 10 Miscellaneous
2937 ****************
2939 * Menu:
2941 * Completion::                  M-TAB knows what you need
2942 * Customization::               Adapting Org-mode to your taste
2943 * Summary of in-buffer settings::  Using special lines to set options
2944 * The very busy C-c C-c key::   When in doubt, press C-c C-c
2945 * Clean view::                  Getting rid of leading stars in the outline
2946 * TTY keys::                    Using Org-mode on a tty
2947 * FAQ::                         Frequently asked questions
2948 * Interaction::                 Other Emacs packages
2949 * Bugs::                        Things which do not work perfectly
2950 * Acknowledgments::             These people provided feedback and more
2952 \x1f
2953 File: org,  Node: Completion,  Next: Customization,  Prev: Miscellaneous,  Up: Miscellaneous
2955 10.1 Completion
2956 ===============
2958 Org-mode supports in-buffer completion.  This type of completion does
2959 not make use of the minibuffer.  You simply type a few letters into the
2960 buffer and use the key to complete text right there.
2962 `M-<TAB>'
2963      Complete word at point
2964         * At the beginning of a headline, complete TODO keywords.
2966         * After `\', complete TeX symbols supported by the exporter.
2968         * After `*', complete CamelCase versions of all headlines in the
2969           buffer.
2971         * After `:', complete tags used elsewhere in the buffer.
2973         * After `#+', complete the special keywords like `TYP_TODO' or
2974           `OPTIONS' which set file-specific options for Org-mode.  When
2975           the option keyword is already complete, pressing `M-<TAB>'
2976           again will insert example settings for this keyword.
2978         * Elsewhere, complete dictionary words using ispell.
2980 \x1f
2981 File: org,  Node: Customization,  Next: Summary of in-buffer settings,  Prev: Completion,  Up: Miscellaneous
2983 10.2 Customization
2984 ==================
2986 There are more than 100 variables that can be used to customize
2987 Org-mode.  For the sake of compactness of the manual, we are not
2988 describing the variables here.  A structured overview of customization
2989 variables is available with `M-x org-customize'.  Or select `Browse Org
2990 Group' from the `Org->Customization' menu.  Many settings can also be
2991 activated on a per-file basis, by putting special lines into the buffer
2992 (*note Summary of in-buffer settings::).
2994 \x1f
2995 File: org,  Node: Summary of in-buffer settings,  Next: The very busy C-c C-c key,  Prev: Customization,  Up: Miscellaneous
2997 10.3 Summary of in-buffer settings
2998 ==================================
3000 Org-mode uses special lines in the buffer to define settings on a
3001 per-file basis.  These lines start with a `#+' followed by a keyword, a
3002 colon, and then individual words defining a setting.  Several settings
3003 words con be in the same line, but you can also have multiple lines for
3004 the keyword.  While these settings are described throughout the manual,
3005 here is a summary.  After changing any of those lines in the buffer,
3006 press `C-c C-c' with the cursor still in the line to activate the
3007 changes immediately.  Otherwise they become effective only when the
3008 file is visited again in a new Emacs session.
3010 `#+STARTUP:'
3011      This line sets options to be used at startup of org-mode, when an
3012      Org-mode file is being visited.  The first set of options deals
3013      with the initial visibility of the outline tree.  The
3014      corresponding variable for global default settings is
3015      `org-startup-folded', with a default value `t', which means
3016      `overview'.
3017           overview   top-level headlines only
3018           content    all headlines
3019           showall    no folding at all, show everything
3020      Then there are options for aligning tables upon visiting a file.
3021      This is useful in files containing narrowed table columns.  The
3022      corresponding variable is `org-startup-align-all-tables', with a
3023      default value `nil'.
3024           align      align all tables
3025           noalign    don't align tables on startup
3026      Here are the options for hiding leading stars in outline headings.
3027      The corresponding variables are `org-hide-leading-stars' and
3028      `org-odd-levels-only', both with a default setting `nil' (meaning
3029      `showstars' and `oddeven').
3030           hidestars  make all but one of the stars starting a headline invisible.
3031           showstars  show all stars starting a headline
3032           odd        allow only odd outline levels (1,3,...)
3033           oddeven    allow all outline levels
3035 `#+SEQ_TODO:   #+TYP_TODO:'
3036      These lines that the TODO keywords and their interpretation in the
3037      current file.  The corresponding variables are `org-todo-keywords'
3038      and `org-todo-interpretation'.
3040 `#+CATEGORY:'
3041      This line sets the category for the agenda file.  The category
3042      applies for all subsequent lines until the next `#+CATEGORY' line,
3043      or the end of the file.
3045 `#+TBLFM:'
3046      This line contains the formulas for the table directly above the
3047      line.
3049 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
3050      These lines provide setting for exporting files.  For more details
3051      see *Note Export options::.
3053 \x1f
3054 File: org,  Node: The very busy C-c C-c key,  Next: Clean view,  Prev: Summary of in-buffer settings,  Up: Miscellaneous
3056 10.4 The very busy C-c C-c key
3057 ==============================
3059 The key `C-c C-c' has many purposes in org-mode, which are all
3060 mentioned scattered throughout this manual.  One specific function of
3061 this key is to add _tags_ to a headline (*note Tags::).  In many other
3062 circumstances it means something like _Hey Org-mode, look here and
3063 update according to what you see here_.  Here is a summary what this
3064 means in different contexts.
3066    - If the cursor is in one of the special #+KEYWORD lines, this
3067      triggers scanning the buffer for these lines and updating the
3068      information.
3070    - If the cursor is inside a table, realign the table.  This command
3071      works even if the automatic table editor has been turned off.
3073    - If the cursor is on a #+TBLFM line, re-apply the formulas to the
3074      entire table.
3076    - If the cursor is inside a table created by the `table.el' package,
3077      activate that table.
3079    - If the current buffer is a remember buffer, close note and file it.
3080      with a prefix argument, file it without further interaction to the
3081      default location.
3083    - If the cursor is on a <<<target>>>, update radio targets and
3084      corresponding links in this buffer.
3086    - If the cursor is on a numbered item in a plain list, renumber the
3087      ordered list.
3089 \x1f
3090 File: org,  Node: Clean view,  Next: TTY keys,  Prev: The very busy C-c C-c key,  Up: Miscellaneous
3092 10.5 A cleaner outline view
3093 ===========================
3095 Some people find it noisy and distracting that the Org-mode headlines
3096 are starting with a potentially large number of stars.  For example the
3097 tree from *Note Headlines:::
3099      * Top level headline
3100      ** Second level
3101      *** 3rd level
3102          some text
3103      *** 3rd level
3104          more text
3105      * Another top level headline
3107 Unfortunately this is deeply ingrained into the code of Org-mode and
3108 cannot be easily changed.  You can, however, modify the display in such
3109 a way that all leading stars become invisible and the outline more easy
3110 to read.  To do this, customize the variable `org-hide-leading-stars'
3111 like this:
3113      (setq org-hide-leading-stars t)
3115 or change this on a per-file basis with one of the lines (anywhere in
3116 the buffer)
3118      #+STARTUP: showstars
3119      #+STARTUP: hidestars
3121 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
3122 modifications.
3124    With stars hidden, the tree becomes:
3126      * Top level headline
3127       * Second level
3128        * 3rd level
3129          some text
3130        * 3rd level
3131          more text
3132      * Another top level headline
3134 Note that the leading stars are not truly replaced by whitespace, they
3135 are only fontified with the face `org-hide' that uses the background
3136 color as font color.  If are are not using either white or black
3137 background, you may have to customize this face to get the wanted
3138 effect.  Another possibility is to set this font such that the extra
3139 stars are almost invisible, for example using the color `grey90' on a
3140 white background.
3142    Things become cleaner still if you skip all the even levels and use
3143 only odd levels 1, 3, 5..., effectively adding two stars to go from one
3144 outline level to the next:
3146      * Top level headline
3147        * Second level
3148          * 3rd level
3149            some text
3150          * 3rd level
3151            more text
3152      * Another top level headline
3154 In order to make the structure editing and export commands handle this
3155 convention correctly, use
3157      (setq org-odd-levels-only t)
3159 or set this on a per-file basis with one of the following lines (don't
3160 forget to press `C-c C-c' with the cursor in the startup line to
3161 activate changes immediately).
3163      #+STARTUP: odd
3164      #+STARTUP: oddeven
3166    You can convert an Org-mode file from single-star-per-level to the
3167 double-star-per-level convention with `M-x org-convert-to-odd-levels
3168 RET' in that file.  The reverse operation is `M-x
3169 org-convert-to-oddeven-levels'.
3171 \x1f
3172 File: org,  Node: TTY keys,  Next: FAQ,  Prev: Clean view,  Up: Miscellaneous
3174 10.6 Using org-mode on a tty
3175 ============================
3177 Org-mode uses a number of keys that are not accessible on a tty.  This
3178 applies to most special keys like cursor keys, <TAB> and <RET>, when
3179 these are combined with modifier keys like <Meta> and/or <Shift>.
3180 Org-mode uses these bindings because it needs to provide keys for a
3181 large number of commands, and because these keys appeared particularly
3182 easy to remember.  In order to still be able to access the core
3183 functionality of Org-mode on a tty, alternative bindings are provided.
3184 Here is a complete list of these bindings, which are obviously more
3185 cumbersome to use.  Note that sometimes a work-around can be better.
3186 For example changing a time stamp is really only fun with `S-<cursor>'
3187 keys.  On a tty you would rather use `C-c .'  to re-insert the
3188 timestamp.
3190 Default     Alternative 1  Alternative 2
3191 `S-<TAB>'   `C-u <TAB>'    
3192 `M-<left>'  `C-c C-x l'    `<Esc> <left>'
3193 `M-S-<left>'`C-c C-x L'    
3194 `M-<right>' `C-c C-x r'    `<Esc>
3195                            <right>'
3196 `M-S-<right>'`C-c C-x R'    
3197 `M-<up>'    `C-c C-x u'    `<Esc> <up>'
3198 `M-S-<up>'  `C-c C-x U'    
3199 `M-<down>'  `C-c C-x d'    `<Esc> <down>'
3200 `M-S-<down>'`C-c C-x D'    
3201 `S-<RET>'   `C-c C-x c'    
3202 `M-<RET>'   `C-c C-x m'    `<Esc> <RET>'
3203 `M-S-<RET>' `C-c C-x M'    
3204 `S-<left>'  `C-c C-x       
3205             <left>'        
3206 `S-<right>' `C-c C-x       
3207             <right>'       
3208 `S-<up>'    `C-c C-x       
3209             <up>'          
3210 `S-<down>'  `C-c C-x       
3211             <down>'        
3213 \x1f
3214 File: org,  Node: FAQ,  Next: Interaction,  Prev: TTY keys,  Up: Miscellaneous
3216 10.7 Frequently asked questions
3217 ===============================
3219   1. When I try to use Org-mode, I always get `(wrong-type-argument
3220      keymapp nil)'.
3221      This is a conflict with an outdated version of the `allout.el'
3222      package which pretends to be also the standard outline-mode but is
3223      not.  This happens with older versions of `allout.el', for example
3224      the one distributed with Emacs 21.  Upgrade to Emacs 22 and this
3225      problem will disappear.  If for some reason you cannot do this,
3226      make sure that org.el is loaded _before_ `allout.el', for example
3227      by putting `(require 'org)' early enough into your `.emacs' file.
3229   2. Org-mode seems to be a useful default mode for the various
3230      `README' files I have scattered through my directories.  How do I
3231      turn it on for all `README' files?
3233           (add-to-list 'auto-mode-alist '("README$" . org-mode))
3235   3. Some of my links stopped working after I upgraded to a version
3236      4.20 or later.  Why is this, and how can I fix it?
3237      These must be links in plain text, containing white space, such as
3238      `bbdb:Richard Stallman'.  You need to protect these links by
3239      putting double brackets around them, like `[[bbdb:Richard
3240      Stallman]]'.
3242   4. I see that Org-mode now creates links using the double bracket
3243      convention that hides the link part and the brackets, only showing
3244      the description part.  How can I convert my old links to this new
3245      format?
3246      Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3247      This replaces angular brackets with the new link format.
3249   5. I don't care if you find the new bracket links great, I am
3250      attached to the old style using angular brackets and no hiding of
3251      the link text.  Please give them back to me, don't tell me it is
3252      not possible!
3253      Would I let you down like that?  If you must, you can do this
3255           (setq org-link-style 'plain
3256                 org-link-format "<%s>")
3258   6. When I am executing shell links I always get a confirmation prompt
3259      and need to type `yes <RET>', thats 4 key presses!  Can I get rid
3260      of this?
3261      The confirmation is there to protect you from unwantingly execute
3262      potentially dangerous commands.  For example, imagine a link
3263      `[[shell:rm -rf ~/*][Google Search]]'.  In an Org-mode buffer, this
3264      command would look like `Google Search', but really it would remove
3265      your home directory.  If you wish, you can make it easier to
3266      respond to the query by setting `org-confirm-shell-links' to
3267      `y-or-n-p'.  Then a single `y' keypress will be enough to confirm
3268      shell links.  It is also possible to turn off this check entirely,
3269      but I do not recommend to do this.  Be warned.
3271   7. All these stars are driving me mad, I just find the Emacs outlines
3272      unreadable. Can't you just put white space and a single star as a
3273      starter for headlines?
3274      See *Note Clean view::.
3276   8. I would like to have two windows on the same Org-mode file, but
3277      with different outline visibility.  Is that possible?
3278      In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3279      See the documentation on the command `make-indirect-buffer'.  In
3280      XEmacs, this is currently not possible because of the different
3281      outline implementation.
3283   9. When I export my TODO list, every TODO item becomes a separate
3284      section.  How do I enforce these items to be exported as an
3285      itemized list?
3286      If you plan to use ASCII or HTML export, make sure things you want
3287      to be exported as item lists are level 4 at least, even if that
3288      does mean there is a level jump.  For example:
3290           * Todays top priorities
3291           **** TODO write a letter to xyz
3292           **** TODO Finish the paper
3293           **** Pick up kids at the school
3295      Alternatively, if you need a specific value for the heading/item
3296      transition in a particular file, use the `+OPTIONS' line to
3297      configure the `H' switch.
3299           +OPTIONS:   H:2; ...
3301  10. I would like to export only a subtree of my file to HTML.  How?
3302      If you want to export a subtree, mark the subtree as region and
3303      then export.  Marking can be done with `C-c @ C-x C-x', for
3304      example.
3306  11. Org-mode takes over the S-cursor keys.  I also want to use
3307      CUA-mode, is there a way to fix this conflict?
3308      Yes, see *Note Interaction::.
3310  12. One of my table columns has started to fill up with `#ERROR'.
3311      What is going on?
3312      Org-mode tried to compute the column from other fields using a
3313      formula stored in the `#+TBLFM:' line just below the table, and
3314      the evaluation of the formula fails.  Fix the fields used in the
3315      formula, or fix the formula, or remove it!
3317  13. When I am in the last column of a table and just above a
3318      horizontal line in the table, pressing TAB creates a new table line
3319      before the horizontal line.  How can I quickly move to the line
3320      below the horizontal line instead?
3321      Press <down> (to get on the separator line) and then <TAB>.  Or
3322      configure the variable `org-table-tab-jumps-over-hlines'.
3324  14. How can I change the indentation of an entire table without fixing
3325      every line by hand?
3326      The indentation of a table is set by the first line.  So just fix
3327      the indentation of the first line and realign with <TAB>.
3329  15. Is it possible to include entries from org-mode files into my
3330      emacs diary?
3331      Since the org-mode agenda is much more powerful and can contain the
3332      diary (*note Calendar/Diary integration::), you should think twice
3333      before deciding to do this.  Integrating Org-mode information into
3334      the diary is, however, possible.  The following steps are
3335      necessary: Autoload the function `org-diary' as shown above under
3336      *Note Installation and activation::.  You also need to use _fancy
3337      diary display_ by setting in `.emacs':
3339           (add-hook 'diary-display-hook 'fancy-diary-display)
3341      Then include the following line into your `~/diary' file, in order
3342      to get the entries from all files listed in the variable
3343      `org-agenda-files':
3345           &%%(org-diary)
3346      You may also select specific files with
3348           &%%(org-diary) ~/path/to/some/org-file.org
3349           &%%(org-diary) ~/path/to/another/org-file.org
3351      If you now launch the calendar and press `d' to display a diary,
3352      the headlines of entries containing a timestamp, date range,
3353      schedule, or deadline referring to the selected date will be
3354      listed.  Just like in Org-mode's agenda view, the diary for
3355      _today_ contains additional entries for overdue deadlines and
3356      scheduled items.  See also the documentation of the `org-diary'
3357      function.  Under XEmacs, it is not possible to jump back from the
3358      diary to the org, this works only in the agenda buffer.
3361 \x1f
3362 File: org,  Node: Interaction,  Next: Bugs,  Prev: FAQ,  Up: Miscellaneous
3364 10.8 Interaction with other packages
3365 ====================================
3367 Org-mode can cooperate with the following packages:
3369 `org-mouse.el' by Piotr Zielinski
3370      This package implements extended mouse functionality for Org-mode.
3371      It allows you to cycle visibility and to edit the document
3372      structure with the mouse.  Best of all, it provides a
3373      context-sensitive menu on <mouse-3> that changes depending on the
3374      context of a mouse-click.  Use a search engine to find this
3375      package on the web.  
3377 `table.el' by Takaaki Ota
3378      Org mode cooperates with table.el, see *Note table.el::.
3379      `table.el' is part of Emacs 22.  
3381 `calc.el' by Dave Gillespie
3382      Org-mode uses the calc package for implementing spreadsheet
3383      functionality in its tables (*note Table calculations::).
3384      Org-modes checks for the availability of calc by looking for the
3385      function `calc-eval' which should be autoloaded in your setup if
3386      calc has been installed properly.  As of Emacs 22, calc is part of
3387      the Emacs distribution.  Another possibility for interaction
3388      between the two packages is using calc for embedded calculations.
3389      *Note Embedded Mode: (calc)Embedded Mode.  
3391 `constants.el' by Carsten Dominik
3392      In a table formula (*note Table calculations::), it is possible to
3393      use names for natural constants or units.  Instead of defining
3394      your own constants in the variable `org-table-formula-constants',
3395      install the `constants' package which defines a large number of
3396      constants and units, and lets you use unit prefixes like `M' for
3397      `Mega' etc.  You will need version 2.0 of this package, available
3398      at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3399      the function `constants-get', which has to be autoloaded in your
3400      setup.  See the installation instructions in the file
3401      `constants.el'.  
3403 `CUA.el' by Kim. F. Storm
3404      Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3405      by CUA-mode (as well as pc-select-mode and s-region-mode) to
3406      select and extend the region.  If you want to use one of these
3407      packages along with Org-mode, configure the variable
3408      `org-CUA-compatible'.  When set, Org-mode will move the following
3409      keybindings in org-mode files, and in the agenda buffer (but not
3410      during date selection).
3412           S-UP    -> M-p             S-DOWN  -> M-n
3413           S-LEFT  -> M--             S-RIGHT -> M-+
3414           S-RET   -> C-S-RET
3416      Yes, these are unfortunately more difficult to remember.  If you
3417      want to have other replacement keys, look at the variable
3418      `org-disputed-keys'.
3420 `windmove.el' by Hovav Shacham
3421      Also this package uses the `S-<cursor>' keys, so everything written
3422      in the paragraph above about CUA mode also applies here.
3424 `remember.el' by John Wiegley
3425      Org mode cooperates with remember, see *Note Remember::.
3426      `Remember.el' is not part of Emacs, find it on the web.
3428 \x1f
3429 File: org,  Node: Bugs,  Next: Acknowledgments,  Prev: Interaction,  Up: Miscellaneous
3431 10.9 Bugs
3432 =========
3434 Here is a list of things that should work differently, but which I have
3435 found too hard to fix.
3437    * If a table field starts with a link, and if the corresponding table
3438      column is narrowed (*note Narrow columns::) to a width too small to
3439      display the link, the field would look entirely empty even though
3440      it is not.  To prevent this, Org-mode throws an error.  The
3441      work-around is to make the column wide enough to fit the link, or
3442      to add some text (at least 2 characters) before the link in the
3443      same field.
3445    * Narrowing table columns does not work on XEmacs, because the
3446      `format' function does not transport text properties.
3448    * Text in an entry protected with the `QUOTE' keyword should not
3449      autowrap.
3451    * When the application called by `C-c C-o' to open a file link fails
3452      (for example because the application does not exits or refuses to
3453      open the file), it does so silently.  No error message is
3454      displayed.
3456    * Plain list items should be able to hold a TODO item.
3457      Unfortunately this has so many technical problems that I will only
3458      consider this change for the next major release (5.0).
3460    * The remote-editing commands in the agenda buffer cannot be undone
3461      with `undo' called from within the agenda buffer.  But you can go
3462      to the corresponding buffer (using <TAB> or <RET> and execute
3463      `undo' there.
3465    * Recalculating a table line applies the formulas from left to right.
3466      If a formula uses _calculated_ fields further down the row,
3467      multiple recalculation may be needed to get all fields consistent.
3469    * You can only make a single word boldface or italic.  To emphasize
3470      several words in a row, each must have the emphasize markers, like
3471      in `*three* *bold* *words*'.
3473    * The exporters work well, but could be made more efficient.
3475 \x1f
3476 File: org,  Node: Acknowledgments,  Prev: Bugs,  Up: Miscellaneous
3478 10.10 Acknowledgments
3479 =====================
3481 Org-mode was written by Carsten Dominik, who still maintains it at the
3482 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'.  The
3483 following people (in alphabetic order) have helped the development
3484 along with ideas, suggestions and patches.  Many thanks to all of you,
3485 Org-mode would not be what it is without your input.
3487    * Thomas Baumann contributed the code for links to the MH-E email
3488      system.
3490    * Alex Bochannek provided a patch for rounding time stamps.
3492    * Charles Caves' suggestion sparked the implementation of templates
3493      for Remember.
3495    * Pavel Chalmoviansky influenced the agenda treatment of items with
3496      specified time.
3498    * Sacha Chua suggested to copy some linking code from Planner.
3500    * Kees Dullemond inspired the use of narrowed tabled columns.
3502    * Christian Egli converted the documentation into TeXInfo format,
3503      patched CSS formatting into the HTML exporter, and inspired the
3504      agenda.
3506    * Nic Ferrier contributed mailcap and XML support.
3508    * Kai Grossjohann pointed out key-binding conflicts caused by
3509      Org-mode.
3511    * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3512      happy.
3514    * Tim O'Callaghan suggested in-file links, search options for
3515      general file links, and TAGS.
3517    * Oliver Oppitz suggested multi-state TODO items.
3519    * Scott Otterson sparked the introduction of descriptive text for
3520      links, among other things.
3522    * Pete Phillips helped the development of the TAGS feature.
3524    * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3525      control.
3527    * Kevin Rogers contributed code to access VM files on remote hosts.
3529    * Frank Ruell solved the mystery of the `keymapp nil' bug, a conflict
3530      with `allout.el'.
3532    * Philip Rooke created the Org-mode reference card and provided lots
3533      of feedback.
3535    * Christian Schlauer proposed angular brackets around links, among
3536      other things.
3538    * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3539      `organizer-mode.el'.
3541    * Ju"rgen Vollmer contributed code generating the table of contents
3542      in HTML output.
3544    * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3546    * David Wainberg suggested archiving, and improvements to the linking
3547      system.
3549    * John Wiegley wrote `emacs-wiki.el' and `planner.el'.  The
3550      development of Org-mode was fully independent, and both systems are
3551      really different beasts in their basic ideas and implementation
3552      details.  However, I have later looked at John's code and learned
3553      from his implementation of (i) links where the link itself is
3554      hidden and only a description is shown, and (ii) popping up a
3555      calendar to select a date.
3557    * Carsten Wimmer suggested some changes and helped fix a bug in
3558      linking to GNUS.
3560    * Roland Winkler requested additional keybindings to make Org-mode
3561      work on a tty.
3563    * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3564      with mouse-1.
3566 \x1f
3567 File: org,  Node: Index,  Next: Key Index,  Prev: Miscellaneous,  Up: Top
3569 11 Index
3570 ********
3572 \0\b[index\0\b]
3573 * Menu:
3575 * acknowledgments:                       Acknowledgments.     (line   6)
3576 * active region <1>:                     HTML export.         (line  10)
3577 * active region <2>:                     ASCII export.        (line   9)
3578 * active region <3>:                     Built-in table editor.
3579                                                               (line 165)
3580 * active region:                         Structure editing.   (line  51)
3581 * agenda:                                Weekly/Daily agenda. (line   6)
3582 * agenda commands, custom:               Agenda dispatcher.   (line   6)
3583 * agenda dispatcher:                     Agenda dispatcher.   (line   6)
3584 * agenda files, removing buffers:        Agenda commands.     (line 189)
3585 * agenda views:                          Agenda views.        (line   6)
3586 * agenda, for single file:               Timeline.            (line   6)
3587 * allout.el, conflict with:              FAQ.                 (line   6)
3588 * angular brackets, around links:        External links.      (line  35)
3589 * applescript, for calendar update:      iCalendar export.    (line  38)
3590 * archive locations:                     Archiving.           (line  13)
3591 * archiving:                             Archiving.           (line   6)
3592 * ASCII export:                          ASCII export.        (line   6)
3593 * author:                                Feedback.            (line   6)
3594 * autoload:                              Installation and activation.
3595                                                               (line   6)
3596 * BBDB links:                            External links.      (line   6)
3597 * bold text:                             Enhancing text.      (line  15)
3598 * bug reports:                           Feedback.            (line   6)
3599 * bugs:                                  Bugs.                (line   6)
3600 * calc package:                          Table calculations.  (line   6)
3601 * calc.el:                               Interaction.         (line  18)
3602 * calculations, in tables <1>:           Table calculations.  (line   6)
3603 * calculations, in tables:               Built-in table editor.
3604                                                               (line 135)
3605 * calendar integration:                  Calendar/Diary integration.
3606                                                               (line   6)
3607 * calendar, for selecting date:          Creating timestamps. (line  68)
3608 * CamelCase link completion:             Completion.          (line   6)
3609 * CamelCase links:                       Internal links.      (line   6)
3610 * CamelCase links, completion of:        CamelCase links.     (line   6)
3611 * category:                              Categories.          (line   6)
3612 * children, subtree visibility state:    Visibility cycling.  (line  10)
3613 * clean outline view:                    Clean view.          (line   6)
3614 * column formula:                        Column formulas.     (line   6)
3615 * commands, in agenda buffer:            Agenda commands.     (line   6)
3616 * comment lines:                         Comment lines.       (line   6)
3617 * completion, of CamelCase links <1>:    Completion.          (line   6)
3618 * completion, of CamelCase links:        CamelCase links.     (line   6)
3619 * completion, of dictionary words:       Completion.          (line   6)
3620 * completion, of file names:             Handling links.      (line  40)
3621 * completion, of links:                  Handling links.      (line  28)
3622 * completion, of option keywords <1>:    Completion.          (line   6)
3623 * completion, of option keywords:        Export options.      (line   6)
3624 * Completion, of option keywords:        Per file keywords.   (line  17)
3625 * completion, of tags <1>:               Completion.          (line   6)
3626 * completion, of tags:                   Setting tags.        (line  12)
3627 * completion, of TeX symbols <1>:        Completion.          (line   6)
3628 * completion, of TeX symbols:            Enhancing text.      (line  19)
3629 * completion, of TODO keywords <1>:      Completion.          (line   6)
3630 * completion, of TODO keywords:          Workflow states.     (line  12)
3631 * constants, in calculations:            Formula syntax.      (line  26)
3632 * constants.el:                          Interaction.         (line  28)
3633 * contents, global visibility state:     Visibility cycling.  (line  19)
3634 * copying, of subtrees:                  Structure editing.   (line   6)
3635 * creating timestamps:                   Creating timestamps. (line   6)
3636 * CUA.el:                                Interaction.         (line  40)
3637 * custom agenda commands:                Agenda dispatcher.   (line   6)
3638 * custom search strings:                 Custom searches.     (line   6)
3639 * customization:                         Customization.       (line   6)
3640 * cutting, of subtrees:                  Structure editing.   (line   6)
3641 * cycling, of TODO states:               TODO basics.         (line  13)
3642 * cycling, visibility:                   Visibility cycling.  (line   6)
3643 * dangerous commands:                    FAQ.                 (line  48)
3644 * date stamps:                           Time stamps.         (line   6)
3645 * date, reading in minibuffer:           Creating timestamps. (line  68)
3646 * DEADLINE keyword:                      Time stamps.         (line  43)
3647 * deadlines:                             Time stamps.         (line   6)
3648 * demotion, of subtrees:                 Structure editing.   (line   6)
3649 * diary entries, creating from agenda:   Agenda commands.     (line 147)
3650 * diary integration:                     Calendar/Diary integration.
3651                                                               (line   6)
3652 * dictionary word completion:            Completion.          (line   6)
3653 * dispatching agenda commands:           Agenda dispatcher.   (line   6)
3654 * document structure:                    Document structure.  (line   6)
3655 * DONE, final TODO keyword:              Per file keywords.   (line  20)
3656 * editing tables:                        Tables.              (line   6)
3657 * editing, of table formulas:            Editing/debugging formulas.
3658                                                               (line   6)
3659 * emphasized text:                       Export options.      (line  25)
3660 * enhancing text:                        Enhancing text.      (line   6)
3661 * evaluate time range:                   Creating timestamps. (line  63)
3662 * exporting:                             Exporting.           (line   6)
3663 * exporting a subtree:                   FAQ.                 (line  89)
3664 * exporting, not:                        Comment lines.       (line   6)
3665 * extended TODO keywords:                TODO extensions.     (line   6)
3666 * external links:                        External links.      (line   6)
3667 * FAQ:                                   FAQ.                 (line   6)
3668 * feedback:                              Feedback.            (line   6)
3669 * file links:                            External links.      (line   6)
3670 * file links, searching:                 Search options.      (line   6)
3671 * file name completion:                  Handling links.      (line  40)
3672 * files, adding to agenda list:          Agenda files.        (line  12)
3673 * filing subtrees:                       Archiving.           (line   6)
3674 * fixed width:                           Enhancing text.      (line  30)
3675 * fixed-width sections:                  Export options.      (line  25)
3676 * folded, subtree visibility state:      Visibility cycling.  (line  10)
3677 * folding, sparse trees:                 Sparse trees.        (line   6)
3678 * following links:                       Handling links.      (line  55)
3679 * format specifier:                      Formula syntax.      (line  34)
3680 * format, of links:                      Link format.         (line   6)
3681 * formula editing:                       Editing/debugging formulas.
3682                                                               (line   6)
3683 * formula syntax:                        Formula syntax.      (line   6)
3684 * formula, for named table field:        Named-field formulas.
3685                                                               (line   6)
3686 * formula, for table column:             Column formulas.     (line   6)
3687 * formula, in tables:                    Built-in table editor.
3688                                                               (line 135)
3689 * global keybindings:                    Installation and activation.
3690                                                               (line   6)
3691 * global TODO list:                      Global TODO list.    (line   6)
3692 * global visibility states:              Visibility cycling.  (line  19)
3693 * GNUS links:                            External links.      (line   6)
3694 * hand-formatted lists:                  Enhancing text.      (line  11)
3695 * headline levels:                       Export options.      (line  25)
3696 * headline levels, for exporting <1>:    HTML export.         (line  16)
3697 * headline levels, for exporting:        ASCII export.        (line  15)
3698 * headline navigation:                   Motion.              (line   6)
3699 * headline tagging:                      Tags.                (line   6)
3700 * headline, promotion and demotion:      Structure editing.   (line   6)
3701 * headlines:                             Headlines.           (line   6)
3702 * hide text:                             Visibility cycling.  (line   6)
3703 * hiding leading stars:                  Clean view.          (line   6)
3704 * HTML export:                           HTML export.         (line   6)
3705 * hyperlinks:                            Hyperlinks.          (line   6)
3706 * iCalendar export:                      iCalendar export.    (line   6)
3707 * in-buffer settings:                    Summary of in-buffer settings.
3708                                                               (line   6)
3709 * indentation, of tables:                FAQ.                 (line 113)
3710 * indirect buffers:                      FAQ.                 (line  65)
3711 * inheritance, of tags:                  Tag inheritance.     (line   6)
3712 * inserting links:                       Handling links.      (line  28)
3713 * installation:                          Installation and activation.
3714                                                               (line   6)
3715 * internal links:                        Internal links.      (line   6)
3716 * introduction:                          Introduction.        (line   6)
3717 * italic text:                           Enhancing text.      (line  15)
3718 * jumping, to headlines:                 Motion.              (line   6)
3719 * keybindings, global:                   Installation and activation.
3720                                                               (line   6)
3721 * keymapp nil error:                     FAQ.                 (line   6)
3722 * keyword options:                       Per file keywords.   (line   6)
3723 * linebreak preservation:                Export options.      (line  25)
3724 * link completion:                       Handling links.      (line  28)
3725 * link format:                           Link format.         (line   6)
3726 * links, external:                       External links.      (line   6)
3727 * links, internal:                       Internal links.      (line   6)
3728 * links, returning to:                   Handling links.      (line  81)
3729 * lists, hand-formatted:                 Enhancing text.      (line  11)
3730 * lists, ordered:                        Plain lists.         (line   6)
3731 * lists, plain:                          Plain lists.         (line   6)
3732 * logging, of progress:                  Progress logging.    (line   6)
3733 * maintainer:                            Feedback.            (line   6)
3734 * make-indirect-buffer:                  FAQ.                 (line  65)
3735 * mark ring:                             Handling links.      (line  77)
3736 * marking characters, tables:            Advanced features.   (line  34)
3737 * matching, of tags:                     Matching headline tags.
3738                                                               (line   6)
3739 * matching, tags:                        Tags.                (line   6)
3740 * MH-E links:                            External links.      (line   6)
3741 * minor mode for tables:                 orgtbl-mode.         (line   6)
3742 * mode, for calc:                        Formula syntax.      (line  34)
3743 * motion, between headlines:             Motion.              (line   6)
3744 * name, of column or field:              Formula syntax.      (line  26)
3745 * named field formula:                   Named-field formulas.
3746                                                               (line   6)
3747 * names as TODO keywords:                TODO types.          (line   6)
3748 * narrow columns in tables:              Narrow columns.      (line   6)
3749 * occur, command:                        Sparse trees.        (line   6)
3750 * option keyword completion:             Completion.          (line   6)
3751 * options, for customization:            Customization.       (line   6)
3752 * options, for export:                   Export options.      (line   6)
3753 * ordered lists:                         Plain lists.         (line   6)
3754 * org-agenda, command:                   Weekly/Daily agenda. (line   9)
3755 * org-mode, turning on:                  Installation and activation.
3756                                                               (line  28)
3757 * org-mouse.el:                          Interaction.         (line   8)
3758 * orgtbl-mode:                           orgtbl-mode.         (line   6)
3759 * outline tree:                          Headlines.           (line   6)
3760 * outline-mode:                          Outlines.            (line   6)
3761 * outlines:                              Outlines.            (line   6)
3762 * overview, global visibility state:     Visibility cycling.  (line  19)
3763 * packages, interaction with other:      Interaction.         (line   6)
3764 * pasting, of subtrees:                  Structure editing.   (line   6)
3765 * per file keywords:                     Per file keywords.   (line   6)
3766 * plain lists:                           Plain lists.         (line   6)
3767 * plain text external links:             External links.      (line  35)
3768 * printing sparse trees:                 Sparse trees.        (line  39)
3769 * priorities:                            Priorities.          (line   6)
3770 * priorities, of agenda items:           Sorting of agenda items.
3771                                                               (line   6)
3772 * progress logging:                      Progress logging.    (line   6)
3773 * promotion, of subtrees:                Structure editing.   (line   6)
3774 * quoted html tags:                      Export options.      (line  25)
3775 * ranges, time:                          Time stamps.         (line   6)
3776 * recomputing table fields:              Column formulas.     (line  27)
3777 * region, active <1>:                    HTML export.         (line  10)
3778 * region, active <2>:                    ASCII export.        (line   9)
3779 * region, active <3>:                    Built-in table editor.
3780                                                               (line 165)
3781 * region, active:                        Structure editing.   (line  51)
3782 * remember.el <1>:                       Interaction.         (line  64)
3783 * remember.el:                           Remember.            (line   6)
3784 * richer text:                           Enhancing text.      (line   6)
3785 * RMAIL links:                           External links.      (line   6)
3786 * SCHEDULED keyword:                     Time stamps.         (line  30)
3787 * scheduling:                            Time stamps.         (line   6)
3788 * search option in file links:           Search options.      (line   6)
3789 * section-numbers:                       Export options.      (line  25)
3790 * setting tags:                          Setting tags.        (line   6)
3791 * SHELL links:                           External links.      (line   6)
3792 * shell links, confirmation:             FAQ.                 (line  48)
3793 * show all, command:                     Visibility cycling.  (line  27)
3794 * show all, global visibility state:     Visibility cycling.  (line  19)
3795 * show hidden text:                      Visibility cycling.  (line   6)
3796 * single file summary:                   Timeline.            (line   6)
3797 * sorting, of agenda items:              Sorting of agenda items.
3798                                                               (line   6)
3799 * sparse tree, for deadlines:            Creating timestamps. (line  38)
3800 * sparse tree, for TODO:                 TODO basics.         (line  20)
3801 * sparse tree, tag based:                Tags.                (line   6)
3802 * sparse trees:                          Sparse trees.        (line   6)
3803 * special keywords:                      Summary of in-buffer settings.
3804                                                               (line   6)
3805 * spreadsheet capabilities:              Table calculations.  (line   6)
3806 * storing links:                         Handling links.      (line   9)
3807 * structure editing:                     Structure editing.   (line   6)
3808 * structure of document:                 Document structure.  (line   6)
3809 * subtree visibility states:             Visibility cycling.  (line  10)
3810 * subtree, cut and paste:                Structure editing.   (line   6)
3811 * subtree, subtree visibility state:     Visibility cycling.  (line  10)
3812 * subtrees, cut and paste:               Structure editing.   (line   6)
3813 * summary:                               Summary.             (line   6)
3814 * syntax, of formulas:                   Formula syntax.      (line   6)
3815 * table editor, builtin:                 Built-in table editor.
3816                                                               (line   6)
3817 * table editor, table.el:                table.el.            (line   6)
3818 * table of contents:                     Export options.      (line  25)
3819 * table.el <1>:                          Interaction.         (line  14)
3820 * table.el:                              table.el.            (line   6)
3821 * tables <1>:                            Export options.      (line  25)
3822 * tables:                                Tables.              (line   6)
3823 * tables, export:                        Enhancing text.      (line  26)
3824 * tag completion:                        Completion.          (line   6)
3825 * tag searches:                          Tag searches.        (line   6)
3826 * tags:                                  Tags.                (line   6)
3827 * tags view:                             Matching headline tags.
3828                                                               (line   6)
3829 * templates, for remember:               Remember.            (line  26)
3830 * TeX interpretation:                    Enhancing text.      (line  17)
3831 * TeX macros:                            Export options.      (line  25)
3832 * TeX symbol completion:                 Completion.          (line   6)
3833 * TeX-like syntax for sub- and superscripts: Export options.  (line  25)
3834 * thanks:                                Acknowledgments.     (line   6)
3835 * time stamps:                           Time stamps.         (line   6)
3836 * time, reading in minibuffer:           Creating timestamps. (line  68)
3837 * time-sorted view:                      Timeline.            (line   6)
3838 * timeline, single file:                 Timeline.            (line   6)
3839 * timerange:                             Time stamps.         (line  21)
3840 * timestamp:                             Time stamps.         (line  12)
3841 * timestamps, creating:                  Creating timestamps. (line   6)
3842 * TODO items:                            TODO items.          (line   6)
3843 * TODO keywords completion:              Completion.          (line   6)
3844 * TODO list, global:                     Global TODO list.    (line   6)
3845 * TODO types:                            TODO types.          (line   6)
3846 * TODO workflow:                         Workflow states.     (line   6)
3847 * transient-mark-mode <1>:               HTML export.         (line  10)
3848 * transient-mark-mode <2>:               ASCII export.        (line   9)
3849 * transient-mark-mode <3>:               Built-in table editor.
3850                                                               (line 165)
3851 * transient-mark-mode:                   Structure editing.   (line  51)
3852 * trees, sparse:                         Sparse trees.        (line   6)
3853 * trees, visibility:                     Visibility cycling.  (line   6)
3854 * tty keybindings:                       TTY keys.            (line   6)
3855 * types as TODO keywords:                TODO types.          (line   6)
3856 * underlined text:                       Enhancing text.      (line  15)
3857 * URL links:                             External links.      (line   6)
3858 * USENET links:                          External links.      (line   6)
3859 * variables, for customization:          Customization.       (line   6)
3860 * vectors, in table calculations:        Formula syntax.      (line  23)
3861 * visibility cycling:                    Visibility cycling.  (line   6)
3862 * visible text, printing:                Sparse trees.        (line  39)
3863 * VM links:                              External links.      (line   6)
3864 * WANDERLUST links:                      External links.      (line   6)
3865 * windmove.el:                           Interaction.         (line  60)
3866 * workflow states as TODO keywords:      Workflow states.     (line   6)
3867 * XML export:                            XML export.          (line   6)
3869 \x1f
3870 File: org,  Node: Key Index,  Prev: Index,  Up: Top
3872 12 Key Index
3873 ************
3875 \0\b[index\0\b]
3876 * Menu:
3878 * +:                                     Agenda commands.     (line 120)
3879 * ,:                                     Agenda commands.     (line 112)
3880 * -:                                     Agenda commands.     (line 126)
3881 * .:                                     Agenda commands.     (line  91)
3882 * ::                                     Agenda commands.     (line 109)
3883 * <:                                     Creating timestamps. (line  75)
3884 * <left>:                                Agenda commands.     (line  88)
3885 * <RET> <1>:                             Agenda commands.     (line  41)
3886 * <RET> <2>:                             Creating timestamps. (line 100)
3887 * <RET>:                                 Built-in table editor.
3888                                                               (line  64)
3889 * <right>:                               Agenda commands.     (line  83)
3890 * <SPC>:                                 Agenda commands.     (line  28)
3891 * <TAB> <1>:                             Agenda commands.     (line  35)
3892 * <TAB> <2>:                             Built-in table editor.
3893                                                               (line  57)
3894 * <TAB> <3>:                             Plain lists.         (line  38)
3895 * <TAB>:                                 Visibility cycling.  (line  10)
3896 * > <1>:                                 Agenda commands.     (line 142)
3897 * >:                                     Creating timestamps. (line  76)
3898 * C:                                     Agenda commands.     (line 172)
3899 * c:                                     Agenda commands.     (line 156)
3900 * C-#:                                   Built-in table editor.
3901                                                               (line 155)
3902 * C-,:                                   Agenda files.        (line  18)
3903 * C-c !:                                 Creating timestamps. (line  21)
3904 * C-c $:                                 Archiving.           (line   9)
3905 * C-c %:                                 Handling links.      (line  77)
3906 * C-c &:                                 Handling links.      (line  81)
3907 * C-c ' <1>:                             Editing/debugging formulas.
3908                                                               (line  20)
3909 * C-c ':                                 Built-in table editor.
3910                                                               (line 144)
3911 * C-c *:                                 Built-in table editor.
3912                                                               (line 148)
3913 * C-c +:                                 Built-in table editor.
3914                                                               (line 165)
3915 * C-c ,:                                 Priorities.          (line  18)
3916 * C-c -:                                 Built-in table editor.
3917                                                               (line  92)
3918 * C-c .:                                 Creating timestamps. (line  10)
3919 * C-c /:                                 Sparse trees.        (line  15)
3920 * C-c ::                                 Enhancing text.      (line  34)
3921 * C-c ;:                                 Comment lines.       (line  11)
3922 * C-c <:                                 Creating timestamps. (line  25)
3923 * C-c <TAB>:                             Built-in table editor.
3924                                                               (line 187)
3925 * C-c =:                                 Built-in table editor.
3926                                                               (line 135)
3927 * C-c >:                                 Creating timestamps. (line  29)
3928 * C-c ? <1>:                             Editing/debugging formulas.
3929                                                               (line  20)
3930 * C-c ?:                                 Built-in table editor.
3931                                                               (line 161)
3932 * C-c [:                                 Agenda files.        (line  12)
3933 * C-c \:                                 Tag searches.        (line   9)
3934 * C-c ]:                                 Agenda files.        (line  15)
3935 * C-c ^:                                 Built-in table editor.
3936                                                               (line  96)
3937 * C-c `:                                 Built-in table editor.
3938                                                               (line 181)
3939 * C-c a a:                               Weekly/Daily agenda. (line   9)
3940 * C-c a C:                               Agenda dispatcher.   (line  30)
3941 * C-c a M:                               Matching headline tags.
3942                                                               (line  15)
3943 * C-c a m:                               Matching headline tags.
3944                                                               (line  10)
3945 * C-c a M:                               Tag searches.        (line  14)
3946 * C-c a m:                               Tag searches.        (line  10)
3947 * C-c a T:                               Global TODO list.    (line  15)
3948 * C-c a t <1>:                           Global TODO list.    (line   9)
3949 * C-c a t:                               TODO basics.         (line  27)
3950 * C-c C-a:                               Visibility cycling.  (line  27)
3951 * C-c C-b:                               Motion.              (line  15)
3952 * C-c C-c <1>:                           The very busy C-c C-c key.
3953                                                               (line   6)
3954 * C-c C-c <2>:                           Setting tags.        (line  11)
3955 * C-c C-c <3>:                           table.el.            (line   6)
3956 * C-c C-c <4>:                           Editing/debugging formulas.
3957                                                               (line  16)
3958 * C-c C-c <5>:                           Built-in table editor.
3959                                                               (line  54)
3960 * C-c C-c:                               Plain lists.         (line  68)
3961 * C-c C-d:                               Creating timestamps. (line  37)
3962 * C-c C-f:                               Motion.              (line  12)
3963 * C-c C-j:                               Motion.              (line  21)
3964 * C-c C-l:                               Handling links.      (line  28)
3965 * C-c C-n:                               Motion.              (line   8)
3966 * C-c C-o <1>:                           Creating timestamps. (line  33)
3967 * C-c C-o:                               Handling links.      (line  55)
3968 * C-c C-p:                               Motion.              (line   9)
3969 * C-c C-q <1>:                           Editing/debugging formulas.
3970                                                               (line  20)
3971 * C-c C-q:                               Built-in table editor.
3972                                                               (line 119)
3973 * C-c C-r:                               Timeline.            (line  13)
3974 * C-c C-s:                               Creating timestamps. (line  47)
3975 * C-c C-t:                               TODO basics.         (line  13)
3976 * C-c C-u:                               Motion.              (line  18)
3977 * C-c C-v:                               TODO basics.         (line  20)
3978 * C-c C-w:                               Creating timestamps. (line  38)
3979 * C-c C-x a:                             ASCII export.        (line   9)
3980 * C-c C-x b:                             HTML export.         (line  11)
3981 * C-c C-x c:                             iCalendar export.    (line  20)
3982 * C-c C-x C-c:                           Agenda commands.     (line 179)
3983 * C-c C-x C-i:                           iCalendar export.    (line  15)
3984 * C-c C-x C-k:                           Structure editing.   (line  36)
3985 * C-c C-x C-w <1>:                       Built-in table editor.
3986                                                               (line 108)
3987 * C-c C-x C-w:                           Structure editing.   (line  36)
3988 * C-c C-x C-x:                           XML export.          (line  10)
3989 * C-c C-x C-y <1>:                       Built-in table editor.
3990                                                               (line 112)
3991 * C-c C-x C-y:                           Structure editing.   (line  43)
3992 * C-c C-x h:                             HTML export.         (line  10)
3993 * C-c C-x i:                             iCalendar export.    (line  13)
3994 * C-c C-x M-w <1>:                       Built-in table editor.
3995                                                               (line 105)
3996 * C-c C-x M-w:                           Structure editing.   (line  40)
3997 * C-c C-x t:                             Export options.      (line  13)
3998 * C-c C-x v:                             Sparse trees.        (line  39)
3999 * C-c C-y:                               Creating timestamps. (line  63)
4000 * C-c l:                                 Handling links.      (line   9)
4001 * C-c |:                                 Built-in table editor.
4002                                                               (line  40)
4003 * C-c ~:                                 table.el.            (line  18)
4004 * C-u C-c .:                             Creating timestamps. (line  16)
4005 * C-u C-c =:                             Built-in table editor.
4006                                                               (line 139)
4007 * C-u C-c C-l:                           Handling links.      (line  40)
4008 * D:                                     Agenda commands.     (line  68)
4009 * d:                                     Agenda commands.     (line  65)
4010 * f:                                     Agenda commands.     (line  44)
4011 * g:                                     Agenda commands.     (line  72)
4012 * H:                                     Agenda commands.     (line 176)
4013 * i:                                     Agenda commands.     (line 147)
4014 * l:                                     Agenda commands.     (line  51)
4015 * L:                                     Agenda commands.     (line  32)
4016 * M:                                     Agenda commands.     (line 163)
4017 * M-<down>:                              Built-in table editor.
4018                                                               (line  82)
4019 * M-<left> <1>:                          Built-in table editor.
4020                                                               (line  72)
4021 * M-<left>:                              Structure editing.   (line  18)
4022 * M-<RET> <1>:                           Plain lists.         (line  43)
4023 * M-<RET>:                               Structure editing.   (line   6)
4024 * M-<right> <1>:                         Built-in table editor.
4025                                                               (line  72)
4026 * M-<right>:                             Structure editing.   (line  21)
4027 * M-<TAB> <1>:                           Completion.          (line  10)
4028 * M-<TAB> <2>:                           Setting tags.        (line   6)
4029 * M-<TAB>:                               Per file keywords.   (line  17)
4030 * M-<up>:                                Built-in table editor.
4031                                                               (line  82)
4032 * M-S-<down> <1>:                        Built-in table editor.
4033                                                               (line  89)
4034 * M-S-<down> <2>:                        Plain lists.         (line  53)
4035 * M-S-<down>:                            Structure editing.   (line  33)
4036 * M-S-<left> <1>:                        Creating timestamps. (line  97)
4037 * M-S-<left> <2>:                        Built-in table editor.
4038                                                               (line  76)
4039 * M-S-<left> <3>:                        Plain lists.         (line  59)
4040 * M-S-<left>:                            Structure editing.   (line  24)
4041 * M-S-<RET>:                             Structure editing.   (line  15)
4042 * M-S-<right> <1>:                       Creating timestamps. (line  94)
4043 * M-S-<right> <2>:                       Built-in table editor.
4044                                                               (line  79)
4045 * M-S-<right> <3>:                       Plain lists.         (line  59)
4046 * M-S-<right>:                           Structure editing.   (line  27)
4047 * M-S-<up> <1>:                          Built-in table editor.
4048                                                               (line  86)
4049 * M-S-<up> <2>:                          Plain lists.         (line  53)
4050 * M-S-<up>:                              Structure editing.   (line  30)
4051 * mouse-1 <1>:                           Agenda commands.     (line  35)
4052 * mouse-1 <2>:                           Creating timestamps. (line  79)
4053 * mouse-1:                               Handling links.      (line  69)
4054 * mouse-2 <1>:                           Agenda commands.     (line  35)
4055 * mouse-2:                               Handling links.      (line  69)
4056 * mouse-3 <1>:                           Agenda commands.     (line  28)
4057 * mouse-3:                               Handling links.      (line  74)
4058 * n:                                     Agenda commands.     (line  19)
4059 * o:                                     Agenda commands.     (line  59)
4060 * P:                                     Agenda commands.     (line 117)
4061 * p:                                     Agenda commands.     (line  20)
4062 * q:                                     Agenda commands.     (line 186)
4063 * r <1>:                                 Agenda commands.     (line  76)
4064 * r:                                     Global TODO list.    (line  21)
4065 * S:                                     Agenda commands.     (line 167)
4066 * S-<down> <1>:                          Agenda commands.     (line 126)
4067 * S-<down> <2>:                          Creating timestamps. (line  55)
4068 * S-<down>:                              Priorities.          (line  25)
4069 * S-<left> <1>:                          Agenda commands.     (line 138)
4070 * S-<left>:                              Creating timestamps. (line  50)
4071 * S-<RET>:                               Built-in table editor.
4072                                                               (line 170)
4073 * S-<right> <1>:                         Agenda commands.     (line 130)
4074 * S-<right>:                             Creating timestamps. (line  50)
4075 * S-<TAB> <1>:                           Built-in table editor.
4076                                                               (line  61)
4077 * S-<TAB>:                               Visibility cycling.  (line  19)
4078 * S-<up> <1>:                            Agenda commands.     (line 120)
4079 * S-<up> <2>:                            Creating timestamps. (line  55)
4080 * S-<up>:                                Priorities.          (line  25)
4081 * T:                                     Agenda commands.     (line 104)
4082 * t:                                     Agenda commands.     (line 100)
4083 * w:                                     Agenda commands.     (line  62)
4084 * x:                                     Agenda commands.     (line 189)
4087 \x1f
4088 Tag Table:
4089 Node: Top\x7f959
4090 Node: Introduction\x7f7514
4091 Node: Summary\x7f7828
4092 Node: Installation and activation\x7f9936
4093 Node: Feedback\x7f11605
4094 Node: Document structure\x7f12391
4095 Node: Outlines\x7f13157
4096 Node: Headlines\x7f13817
4097 Node: Visibility cycling\x7f14440
4098 Node: Motion\x7f15636
4099 Node: Structure editing\x7f16420
4100 Node: Archiving\x7f18529
4101 Node: Sparse trees\x7f19389
4102 Ref: Sparse trees-Footnote-1\x7f21418
4103 Ref: Sparse trees-Footnote-2\x7f21510
4104 Node: Plain lists\x7f21625
4105 Ref: Plain lists-Footnote-1\x7f24919
4106 Node: Tables\x7f25276
4107 Node: Built-in table editor\x7f25824
4108 Node: Narrow columns\x7f33437
4109 Ref: Narrow columns-Footnote-1\x7f35376
4110 Node: Table calculations\x7f35422
4111 Node: Formula syntax\x7f36598
4112 Ref: Formula syntax-Footnote-1\x7f39527
4113 Node: Column formulas\x7f39826
4114 Node: Advanced features\x7f41588
4115 Node: Named-field formulas\x7f44843
4116 Node: Editing/debugging formulas\x7f45483
4117 Node: Appetizer\x7f47241
4118 Node: orgtbl-mode\x7f48343
4119 Node: table.el\x7f48834
4120 Node: Hyperlinks\x7f49811
4121 Node: Link format\x7f50515
4122 Node: Internal links\x7f51812
4123 Node: Radio targets\x7f53762
4124 Node: CamelCase links\x7f54477
4125 Node: External links\x7f54975
4126 Node: Handling links\x7f56900
4127 Node: Search options\x7f61232
4128 Ref: Search options-Footnote-1\x7f63008
4129 Node: Custom searches\x7f63089
4130 Node: Remember\x7f64137
4131 Ref: Remember-Footnote-1\x7f68004
4132 Node: TODO items\x7f68128
4133 Node: TODO basics\x7f69051
4134 Node: Progress logging\x7f70392
4135 Node: TODO extensions\x7f71178
4136 Node: Workflow states\x7f71978
4137 Node: TODO types\x7f72846
4138 Ref: TODO types-Footnote-1\x7f74504
4139 Node: Per file keywords\x7f74586
4140 Ref: Per file keywords-Footnote-1\x7f76039
4141 Node: Priorities\x7f76267
4142 Node: Timestamps\x7f77476
4143 Node: Time stamps\x7f77797
4144 Node: Creating timestamps\x7f80225
4145 Node: Tags\x7f83354
4146 Node: Tag inheritance\x7f84089
4147 Node: Setting tags\x7f85026
4148 Node: Tag searches\x7f85988
4149 Node: Agenda views\x7f87197
4150 Node: Agenda files\x7f88736
4151 Ref: Agenda files-Footnote-1\x7f89696
4152 Ref: Agenda files-Footnote-2\x7f89845
4153 Node: Agenda dispatcher\x7f90037
4154 Node: Weekly/Daily agenda\x7f92167
4155 Node: Categories\x7f93302
4156 Node: Time-of-day specifications\x7f93950
4157 Node: Calendar/Diary integration\x7f95926
4158 Node: Sorting of agenda items\x7f97303
4159 Node: Global TODO list\x7f98135
4160 Node: Matching headline tags\x7f99550
4161 Node: Timeline\x7f100493
4162 Node: Agenda commands\x7f101366
4163 Node: Exporting\x7f106755
4164 Node: ASCII export\x7f107885
4165 Node: HTML export\x7f108707
4166 Node: XML export\x7f110455
4167 Node: iCalendar export\x7f110822
4168 Node: Text interpretation\x7f112644
4169 Node: Comment lines\x7f113121
4170 Node: Enhancing text\x7f113590
4171 Node: Export options\x7f115421
4172 Node: Miscellaneous\x7f117023
4173 Node: Completion\x7f117781
4174 Node: Customization\x7f118777
4175 Node: Summary of in-buffer settings\x7f119384
4176 Node: The very busy C-c C-c key\x7f122145
4177 Node: Clean view\x7f123550
4178 Node: TTY keys\x7f126127
4179 Node: FAQ\x7f127728
4180 Node: Interaction\x7f134630
4181 Node: Bugs\x7f137664
4182 Node: Acknowledgments\x7f139618
4183 Node: Index\x7f142713
4184 Node: Key Index\x7f164083
4185 \x1f
4186 End Tag Table