1 This is org, produced by makeinfo version 4.8 from org.texi.
5 * Org Mode: (org). outline-based notes management and organizer
8 This manual is for Org-mode (version 4.13).
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."
25 File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
30 This manual is for Org-mode (version 4.13).
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."
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 * Agenda Views:: Collecting information into views
55 * Exporting:: Sharing and publishing of notes
56 * Miscellaneous:: All the rest which did not fit elsewhere
57 * Index:: The fast road to specific information
58 * Key Index:: Key bindings and where they are described
60 --- The Detailed Node Listing ---
64 * Summary:: Brief summary of what Org-mode does
65 * Installation and activation:: How to install Org-mode
66 * Feedback:: Bug reports, ideas, patches etc.
70 * Outlines:: Org-mode is based on outline-mode
71 * Headlines:: How to typeset org-tree headlines
72 * Visibility cycling:: Show and hide, much simplified
73 * Motion:: Jumping to other headlines
74 * Structure editing:: Changing sequence and level of headlines
75 * Archiving:: Move done task trees to a different place
76 * Sparse trees:: Matches embedded in context
77 * Tags:: Tagging headlines and matching sets of tags
78 * Plain Lists:: Editing hand-formatted lists
82 * Built-in table editor:: Simple tables
83 * Table calculations:: Compute a field from other fields
84 * orgtbl-mode:: The table editor as minor mode
85 * table.el:: Complex tables
87 Calculations in tables
89 * Formula syntax:: How to write a formula
90 * Column formulas:: Formulas valid for all fields in a column
91 * Advanced features:: Field names, parameters and automatic recalc
92 * Named-field formulas:: Formulas valid in single fields
93 * Editing/debugging formulas:: Changing a stored formula
94 * Appetizer:: Taste the power of calc
98 * Internal links:: Links to other places in the current file
99 * External links:: URL-like links to the world
100 * Managing links:: Creating, inserting and following
101 * Search Options:: Linking to a specific location
102 * Remember:: Org-trees store quick notes
106 * Radio targets:: Make targets trigger links in plain text.
107 * CamelCase links:: Activating CamelCase words as links
111 * TODO basics:: Marking and displaying TODO entries
112 * Progress logging:: Document your productivity
113 * TODO extensions:: Workflow and assignments
114 * Priorities:: Some things are more important than others
116 Extended use of TODO keywords
118 * Workflow states:: From TODO to DONE in steps
119 * TODO types:: I do this, Fred the rest
120 * Per file keywords:: Different files, different requirements
124 * Time stamps:: Assigning a time to a tree entry
125 * Creating timestamps:: Commands which insert timestamps
129 * Agenda files:: Files being searched for agenda information
130 * Agenda dispatcher:: Keyboard access to agenda views
131 * Weekly/Daily Agenda:: The calendar page with current tasks
132 * Global TODO list:: All unfinished action items
133 * Matching headline tags:: Structured information with fine-tuned search
134 * Timeline:: Time-sorted view for single file
135 * Agenda commands:: Remote editing of org trees
137 The weekly/daily agenda
139 * Categories:: Not all tasks are equal
140 * Time-of-day specifications:: How the agenda knows the time
141 * Calendar/Diary integration:: Integrating Anniversaries and more
142 * Sorting of agenda items:: The order of things
146 * ASCII export:: Export as a structured ASCII file
147 * HTML export:: Export as an HTML file
148 * iCalendar export:: Create calendar entries.
152 * HTML formatting:: Interpretation of the buffer content
153 * Export options:: How to influence exports
154 * Comment lines:: Lines which will not be exported
158 * Completion:: M-TAB knows what you need
159 * Customization:: Adapting Org-mode to your taste
160 * Clean view:: Getting rid of leading stars in the outline
161 * TTY keys:: Using Org-mode on a tty
162 * FAQ:: Frequently asked questions
163 * Interaction:: Other Emacs packages
164 * Bugs:: Things which do not work perfectly
165 * Acknowledgments:: These people provided feedback and more
168 File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
175 * Summary:: Brief summary of what Org-mode does
176 * Installation and activation:: How to install Org-mode
177 * Feedback:: Bug reports, ideas, patches etc.
180 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
185 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
186 project planning with a fast and effective plain-text system.
188 Org-mode develops organizational tasks around NOTES files that
189 contain information about projects as plain text. Org-mode is
190 implemented on top of outline-mode, which makes it possible to keep the
191 content of large files well structured. Visibility cycling and
192 structure editing help to work with the tree. Tables are easily
193 created with a built-in table editor. Org-mode supports ToDo items,
194 deadlines, time stamps, and scheduling. It dynamically compiles
195 entries into an agenda that utilizes and smoothly integrates much of
196 the Emacs calendar and diary. Plain text URL-like links connect to
197 websites, emails, Usenet messages, BBDB entries, and any files related
198 to the projects. For printing and sharing of notes, an Org-mode file
199 can be exported as a structured ASCII file, as HTML, or (todo and
200 agenda items only) as an iCalendar file.
202 Org-mode keeps simple things simple. When first fired up, it should
203 feel like a simple but easy to use outliner. Complexity is not
204 imposed, but a large amount of functionality is available when you need
205 it. Org-mode can be used on different levels and in different ways,
208 * as an outline extension with visibility cycling and structure editing
209 * as an ASCII system and table editor for taking structured notes
210 * as an ASCII table editor with spreadsheet-like capabilities
211 * as a simple hypertext system, with HTML export
212 * as a TODO list editor
213 * as a full agenda and planner with deadlines and work scheduling
215 The Org-mode table editor can be integrated into any major mode by
216 activating the minor Orgtbl-mode.
218 There is a website for Org-mode which provides links to the newest
219 version of Org-mode, as well as additional information, screen shots
220 and example files. This page is located at
221 `http://www.astro.uva.nl/~dominik/Tools/org/'.
224 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
226 1.2 Installation and Activation
227 ===============================
229 If Org-mode is part of the Emacs distribution or an XEmacs package, you
230 only need to copy the following lines to your `.emacs' file. The last
231 two lines define _global_ keys for the commands `org-store-link' and
232 `org-agenda' - please choose suitable keys yourself.
234 ;; The following lines are always needed. Choose your own keys.
235 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
236 (define-key global-map "\C-cl" 'org-store-link)
237 (define-key global-map "\C-ca" 'org-agenda)
239 If you have downloaded Org-mode from the Web, you must byte-compile
240 `org.el' and put it on your load path. In addition to the Emacs Lisp
241 lines above, you also need to add the following lines to `.emacs':
243 ;; These lines only if org-mode is not part of the X/Emacs distribution.
244 (autoload 'org-mode "org" "Org mode" t)
245 (autoload 'org-diary "org" "Diary entries from Org mode")
246 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
247 (autoload 'org-store-link "org" "Store a link to the current location" t)
248 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
249 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
251 With this setup, all files with extension `.org' will be put into
252 Org-mode. As an alternative, make the first line of a file look like
255 MY PROJECTS -*- mode: org; -*-
257 which will select Org-mode for this buffer no matter what the file's
258 name is. See also the variable `org-insert-mode-line-in-empty-file'.
261 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
266 If you find problems with Org-mode, or if you have questions, remarks,
267 or ideas about it, please contact the maintainer Carsten Dominik at
268 <dominik@science.uva.nl>.
270 For bug reports, please provide as much information as possible,
271 including the version information of Emacs (`C-h v emacs-version
272 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
273 Org-mode related setup in `.emacs'. If an error occurs, a traceback
274 can be very useful. Often a small example file helps, along with clear
276 1. What exactly did you do?
278 2. What did you expect to happen?
280 3. What happened instead?
281 Thank you for helping to improve this mode.
284 File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
289 Org-mode is based on outline mode and provides flexible commands to
290 edit the structure of the document.
294 * Outlines:: Org-mode is based on outline-mode
295 * Headlines:: How to typeset org-tree headlines
296 * Visibility cycling:: Show and hide, much simplified
297 * Motion:: Jumping to other headlines
298 * Structure editing:: Changing sequence and level of headlines
299 * Archiving:: Move done task trees to a different place
300 * Sparse trees:: Matches embedded in context
301 * Tags:: Tagging headlines and matching sets of tags
302 * Plain Lists:: Editing hand-formatted lists
305 File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
310 Org-mode is implemented on top of outline-mode. Outlines allow to
311 organize a document in a hierarchical structure, which (at least for
312 me) is the best representation of notes and thoughts. Overview over
313 this structure is achieved by folding (hiding) large parts of the
314 document to show only the general document structure and the parts
315 currently being worked on. Org-mode greatly simplifies the use of
316 outlines by compressing the entire show/hide functionality into a
317 single command `org-cycle', which is bound to the <TAB> key.
320 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
325 Headlines define the structure of an outline tree. The headlines in
326 Org-mode start with one or more stars, on the left margin. For example:
334 * Another top level headline
335 Some people find the many stars too noisy and would prefer an
336 outline that has whitespace followed by a single star as headline
337 starters. *Note Clean view:: describes a setup to realize this.
340 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
342 2.3 Visibility cycling
343 ======================
345 Outlines make it possible to hide parts of the text in the buffer.
346 Org-mode uses a single command bound to the <TAB> key to change the
347 visibility in the buffer.
350 Rotate current subtree between the states
351 ,-> FOLDED -> CHILDREN -> SUBTREE --.
352 '-----------------------------------'
353 At the beginning of the buffer (or when called with `C-u'), this
354 does the same as the command `S-<TAB>' below.
357 Rotate the entire buffer between the states
358 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
359 '--------------------------------------'
360 Note that inside tables, `S-<TAB>' jumps to the previous field.
365 When Emacs first visits an Org-mode file, the global state is set to
366 OVERVIEW, i.e. only the top level headlines are visible. This can be
367 configured through the variable `org-startup-folded', or on a per-file
368 basis by adding one of the following lines anywhere in the buffer:
375 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
380 The following commands jump to other headlines in the buffer.
389 Next heading same level.
392 Previous heading same level.
395 Backward to higher level heading.
398 Jump to a different place without changing the current outline
399 visibility. Shows the document structure in a temporary buffer,
400 where you can use visibility cycling (<TAB>) to find your
401 destination. After pressing <RET>, the cursor moves to the
402 selected location in the original buffer, and the headings
403 hierarchy above it is made visible.
406 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document Structure
408 2.5 Structure editing
409 =====================
412 Insert new heading with same level as current. If the cursor is
413 in a plain list item, a new item is created. To force creation of
414 a new headline, use a prefix arg, or first press <RET> to get to
415 the beginning of the next line.
418 Insert new TODO entry with same level as current heading.
421 Promote current heading by one level.
424 Demote current heading by one level.
427 Promote the current subtree by one level.
430 Demote the current subtree by one level.
433 Move subtree up (swap with previous subtree of same level).
436 Move subtree down (swap with next subtree of same level).
440 Kill subtree, i.e. remove it from buffer but save in kill ring.
443 Copy subtree to kill ring.
446 Yank subtree from kill ring. This does modify the level of the
447 subtree to make sure the tree fits in nicely at the yank position.
448 The yank level can also be specified with a prefix arg, or by
449 yanking after a headline marker like `****'.
451 When there is an active region (transient-mark-mode), promotion and
452 demotion work on all headlines in the region. To select a region of
453 headlines, it is best to place both point and mark at the beginning of a
454 line, mark at the beginning of the first headline, and point at the line
455 just after the last headline to change. Note that when the cursor is
456 inside a table (*note Tables::), the Meta-Cursor keys have different
460 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document Structure
465 When a project represented by a (sub)tree is finished, you may want to
466 move the tree to an archive place, either in the same file under a
467 special top-level heading, or even to a different file.
469 Archive the subtree starting at the cursor position to the location
470 given by `org-archive-location'.
472 The default archive is a file in the same directory as the current
473 file, with the name derived by appending `_archive' to the current file
474 name. For information and examples on how to change this, see the
475 documentation string of the variable `org-archive-location'. If you
476 are also using the Org-mode agenda, archiving to a different file is a
477 good way to keep archived trees from contributing agenda items.
480 File: org, Node: Sparse trees, Next: Tags, Prev: Archiving, Up: Document Structure
485 An important feature of Org-mode is the ability to construct _sparse
486 trees_ for selected information in an outline tree. A sparse tree
487 means that the entire document is folded as much as possible, but the
488 selected information is made visible along with the headline structure
489 above it(1). Just try it out and you will see immediately how it works.
491 Org-mode contains several commands creating such trees. The most
492 basic one is `org-occur':
495 Occur. Prompts for a regexp and shows a sparse tree with all
496 matches. If the match is in a headline, the headline is made
497 visible. If the match is in the body of an entry, headline and
498 body are made visible. In order to provide minimal context, also
499 the full hierarchy of headlines above the match is shown, as well
500 as the headline following the match. Each match is also
501 highlighted, the highlights disappear when the buffer is changed
502 with an editing command.
503 For frequently used sparse trees of specific search strings, you can
504 use the variable `org-agenda-custom-commands' to define fast keyboard
505 access to specific sparse trees. These commands will then be
506 accessible through the agenda dispatcher (*note Agenda dispatcher::).
508 (setq org-agenda-custom-commands
509 '(("f" occur-tree "FIXME")))
510 will define the key `C-c a f' as a shortcut for creating a sparse
511 tree matching the string `FIXME'.
513 Other commands are using sparse trees as well. For example `C-c
514 C-v' creates a sparse TODO tree (*note TODO basics::).
516 To print a sparse tree, you can use the Emacs command
517 `ps-print-buffer-with-faces' which does not print invisible parts of
518 the document (2). Or you can use the command `C-c C-x v' to copy the
519 visible part of the document to another file (extension `.txt') which
520 can then be printed in any desired way.
522 ---------- Footnotes ----------
524 (1) See also the variables `org-show-hierarchy-above' and
525 `org-show-following-heading'.
527 (2) This does not work under XEmacs, because XEmacs uses selective
528 display for outlining, not text properties
531 File: org, Node: Tags, Next: Plain Lists, Prev: Sparse trees, Up: Document Structure
536 If you wish to implement a tag system to cross-correlate information,
537 this can be done as well in Org-mode. Every headline can contain a
538 list of tags, at the end of the headline. Tags are normal words
539 containing letters, numbers, `_', and `@'. Tags must be preceded and
540 followed by a single colon; like `:WORK:'. Several tags can be
541 specified like `:WORK:URGENT:'.
543 Tags make use of the hierarchical structure of outline trees. If a
544 heading has a certain tag, all subheadings will inherit the tag as
545 well. For example, in the list
547 * Meeting with the French group :WORK:
548 ** Summary by Frank :BOSS:NOTES:
549 *** TODO Prepare slides for him :ACTION:
550 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:',
551 and `:ACTION:'. When executing tag searches and Org-mode finds that a
552 certain headline matches the search criterion, it will not check any
553 sublevel headline, assuming that these likely also match, and that the
554 list of matches can become very long. You can influence inheritance
555 and searching using the variables `org-use-tag-inheritance' and
556 `org-tags-match-list-sublevels'.
558 Tags can simply be typed into the buffer. After a colon, `M-<TAB>'
559 offers completion on all tags being used in the current buffer. There
560 are also special commands for inserting tags, and for executing
561 searches based on tags.
564 Enter new tags for the current headline. The minibuffer will
565 prompt for a list of tags and offer completion with respect to all
566 other tags used in the current buffer. Several tags, separated by
567 colons, may be specified at the prompt. After pressing <RET>, the
568 tags will be inserted and aligned to `org-tags-column'. When
569 called with a `C-u' prefix, align all tags in the current buffer
570 to that column, just to make things look nice. TAGS are
571 automatically realigned after promotion, demotion, and TODO state
572 changes (*note TODO basics::).
575 Create a sparse tree with all headlines matching a tags search.
578 Create a global list of tag matches from all agenda files. *Note
579 Matching headline tags::.
582 Create a global list of tag matches from all agenda files, but
583 check only TODO items and force checking subitems (see variable
584 `org-tags-match-list-sublevels').
586 A tags search string can use Boolean operators `&' for AND and `|'
587 for OR. `&' binds more strongly than `|'. Parenthesis are currently
588 not implemented. A tag may also be preceded by `-', to select against
589 it, and `+' is syntactic sugar for positive selection. The AND
590 operator `&' is optional when `+' or `-' is present. For example,
591 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
592 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
593 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
594 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
598 File: org, Node: Plain Lists, Prev: Tags, Up: Document Structure
603 Headlines define both the structure of the Org-mode file, and also lists
604 (for example, TODO items (*note TODO items::) should be created using
605 headline levels). However, when taking notes, the plain text is
606 sometimes easier to read with hand-formatted lists. Org-mode supports
607 editing such lists, and the HTML exporter (*note Exporting::) does
608 parse and format them.
610 Org-mode knows ordered and unordered lists. Unordered list items
611 start with `-', `+', or `*'(1) as bullets. Ordered list items start
612 with `1.' or `1)'. Items belonging to the same list must have the same
613 indentation on the first line. In particular, if an ordered list
614 reaches number `10.', then the 2-digit numbers must be written
615 left-aligned with the other numbers in the list. Indentation also
616 determines the end of a list item. It ends before the next line that
617 is indented like the bullet/number, or less. For example:
620 My favorite scenes are (in this order)
621 1. Eowyns fight with the witch king
622 + this was already my favorite scene in the book
623 + I really like Miranda Otto.
624 2. The attack of the Rohirrim
625 3. Peter Jackson being shot by Legolas
627 He makes a really funny face when it happens.
629 Org-mode supports these lists by tuning filling and wrapping commands
630 to correctly deal with them. Furthermore, the following commands act
631 on items when the cursor is in the first line of an item (the line with
632 the bullet or number).
635 Items can be folded just like headline levels if you set the
636 variable `org-cycle-include-plain-lists'. The level of an item is
637 then given by the indentation of the bullet/number. However,
638 items are always subordinate to real headlines, the hierarchies
639 remain completely separated.
642 Insert new item at current level. With prefix arg, for a new
647 Move the item including subitems up/down (swap with previous/next
648 item of same indentation). If the list is ordered, renumbering is
653 Decrease/increase the indentation of the item, including subitems.
654 Initially, the item tree is selected based on current indentation.
655 When these commands are executed several times in direct
656 succession, the initially selected region is used, even if the new
657 indentation would imply a different hierarchy. To use the new
658 hierarchy, break the command chain with a cursor motion or so.
661 Renumber the ordered list at the cursor.
663 ---------- Footnotes ----------
665 (1) When using `*' as a bullet, lines must be indented or they will
666 be seen as top-level headlines. Also, when you are hiding leading
667 stars to get a clean outline view, plain list items starting with a
668 star are visually indistinguishable from true headlines. In short:
669 even though `*' is supported, it may be better to not use it for plain
673 File: org, Node: Tables, Next: Hyperlinks, Prev: Document Structure, Up: Top
678 Org-mode has a very fast and intuitive table editor built-in.
679 Spreadsheet-like calculations are supported in connection with the
680 Emacs `calc' package.
684 * Built-in table editor:: Simple tables
685 * Table calculations:: Compute a field from other fields
686 * orgtbl-mode:: The table editor as minor mode
687 * table.el:: Complex tables
690 File: org, Node: Built-in table editor, Next: Table calculations, Prev: Tables, Up: Tables
692 3.1 The built-in table editor
693 =============================
695 Org-mode makes it easy to format tables in plain ASCII. Any line with
696 `|' as the first non-white character is considered part of a table.
697 `|' is also the column separator. A table might look like this:
699 | Name | Phone | Age |
700 |-------+-------+-----|
701 | Peter | 1234 | 17 |
704 A table is re-aligned automatically each time you press <TAB> or
705 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
706 field (<RET> to the next row) and creates new table rows at the end of
707 the table or before horizontal lines. The indentation of the table is
708 set by the first line. Any line starting with `|-' is considered as a
709 horizontal separator line and will be expanded on the next re-align to
710 span the whole table width. So, to create the above table, you would
715 and then press <TAB> to align the table and start filling in fields.
717 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
718 and all character keys in a special way, so that inserting and deleting
719 avoids shifting other fields. Also, when typing _immediately after the
720 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
721 the field is automatically made blank. If this behavior is too
722 unpredictable for you, configure the variables
723 `org-enable-table-editor' and `org-table-auto-blank-field'.
725 Creation and conversion
726 .......................
728 `M-x org-table-create'
729 Creates an empty Org-mode table. However, it is much easier to
730 just start typing, like `|Name|Phone|Age <RET> |- <TAB>'
733 Convert region to table. Works when the cursor is not in an
734 existing table, and when there is a region defined. If every line
735 contains at least one TAB character, the function assumes that the
736 material is tab separated. If not, lines are split at whitespace
737 into fields. You can use a prefix argument to indicate the
738 minimum number of consequtive spaces required to indentify a field
739 separator (default: just one).
741 Re-aligning and field motion
742 ............................
745 Re-align the table without moving the cursor.
748 Re-align the table, move to the next field. Creates a new row if
752 Re-align, move to previous field.
755 Re-align the table and move down to next row. Creates a new row if
756 necessary. At the beginning or end of a line, <RET> still does
757 NEWLINE, so it can be used to split a table.
759 Column and row editing
760 ......................
764 Move the current column left/right.
767 Kill the current column.
770 Insert a new column to the left of the cursor position.
774 Move the current row up/down.
777 Kill the current row or horizontal line.
780 Insert a new row above (with arg: below) the current row.
783 Insert a horizontal line below current row. With prefix arg, the
784 line is created above the current line.
787 Sort the table lines in the region. Point and mark must be in the
788 first and last line to be included, and must be in the column that
789 should be used for sorting. The command prompts for numerical
790 versus alphanumerical sorting.
796 Copy a rectangular region from a table to a special clipboard.
797 Point and mark determine edge fields of the rectangle. The
798 process ignores horizontal separator lines.
801 Copy a rectangular region from a table to a special clipboard, and
802 blank all fields in the rectangle. So this is the "cut" operation.
805 Paste a rectangular region into a table. The upper right corner
806 ends up in the current field. All involved fields will be
807 overwritten. If the rectangle does not fit into the present table,
808 the table is enlarged as needed. The process ignores horizontal
812 Wrap several fields in a column like a paragraph. If there is an
813 active region, and both point and mark are in the same column, the
814 text in the column is wrapped to minimum width for the given
815 number of lines. A prefix ARG may be used to change the number of
816 desired lines. If there is no region, the current field is split
817 at the cursor position and the text fragment to the right of the
818 cursor is prepended to the field one line down. If there is no
819 region, but you specify a prefix ARG, the current field is made
820 blank, and the content is appended to the field above.
826 Install a new formula for the current column and replace current
827 field with the result of the formula.
830 Install a new formula for the current field, which must be a named
831 field. Evaluate the formula and replace the field content with the
835 Edit all formulas associated with the current table in a separate
839 Recalculate the current row by applying the stored formulas from
840 left to right. When called with a `C-u' prefix, recalculate the
841 entire table, starting with the first non-header line (i.e. below
842 the first horizontal separator line). For details, see *Note
843 Table calculations::.
846 Rotate the calculation mark in first column through the states `',
847 `#', `*', `!', `$'. For the meaning of these marks see *Note
848 Advanced features::. When there is an active region, change all
852 Which table column is the cursor in? Displays number >0 in echo
856 Sum the numbers in the current column, or in the rectangle defined
857 by the active region. The result is shown in the echo area and can
858 be inserted with `C-y'.
861 When current field is empty, copy from first non-empty field above.
862 When not empty, copy current field down to next row and move cursor
863 along with it. Depending on the variable
864 `org-table-copy-increment', integer field values will be
865 incremented during copy. This key is also used by CUA-mode (*note
872 Toggle the visibility of vertical lines in tables. The lines are
873 still there, only made invisible with a text property. Any `|'
874 added by hand will become invisible on the next align.
876 `M-x org-table-import'
877 Import a file as a table. The table should be TAB- or whitespace
878 separated. Useful, for example, to import an Excel table or data
879 from a database, because these programs generally can write
880 TAB-separated text files. This command works by inserting the
881 file into the buffer and then converting the region to a table.
882 Any prefix argument is passed on to the converter, which uses it
883 to determine the separator.
885 `M-x org-table-export'
886 Export the table as a TAB-separated file. Useful for data
887 exchange with, for example, Excel or database programs.
890 If you don't like the automatic table editor because it gets in your
891 way on lines which you would like to start with `|', you can turn it
893 (setq org-enable-table-editor nil)
894 The only table command which then still works is `C-c C-c' to do a
898 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Built-in table editor, Up: Tables
900 3.2 Calculations in tables
901 ==========================
903 The table editor makes use of the Emacs `calc' package to implement
904 spreadsheet-like capabilities. Org-mode has two levels of complexity
905 for table calculations. On the basic level, tables do only horizontal
906 computations, so a field can be computed from other fields _in the same
907 row_, and Org-mode assumes that there is only one formula for each
908 column. This is very efficient to work with and enough for many tasks.
909 On the complex level, columns and individual fields can be named for
910 easier referencing in formulas, individual named fields can have their
911 own formula associated with them, and recalculation can be automated.
915 * Formula syntax:: How to write a formula
916 * Column formulas:: Formulas valid for all fields in a column
917 * Advanced features:: Field names, parameters and automatic recalc
918 * Named-field formulas:: Formulas valid in single fields
919 * Editing/debugging formulas:: Changing a stored formula
920 * Appetizer:: Taste the power of calc
923 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
928 A formula can be any algebraic expression understood by the Emacs
929 `calc' package. Note that `calc' has the slightly non-standard
930 convention that `/' has lower precedence than `*', so that `a/b*c' is
931 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
932 calc-eval: (calc)Calling Calc from Your Lisp Programs.), variable
933 substitution takes place:
935 $ refers to the current field
936 $3 refers to the field in column 3 of the current row
937 $3..$7 a vector of the fields in columns 3-7 of current row
938 $P1..$P3 vector of column range, using column names
939 &2 second data field above the current, in same column
940 &5-2 vector from fifth to second field above current
941 &III-II vector of fields between 2nd and 3rd hline above
942 &III vector of fields between third hline above and current field
943 $name a named field, parameter or constant
945 The range vectors can be directly fed into the calc vector functions
946 like `vmean' and `vsum'.
948 `$name' is interpreted as the name of a column, parameter or
949 constant. Constants are defined globally through the variable
950 `org-table-formula-constants'. If you have the `constants.el' package,
951 it will also be used to resolve constants, including natural constants
952 like `$h' for Planck's constant, and units like `$km' for kilometers.
953 Column names and parameters can be specified in special table lines.
954 These are described below, see *Note Advanced features::.
956 A formula can contain an optional mode string after a semicolon.
957 This string consists of flags to influence calc's modes(1) during
958 execution, e.g. `p20' to switch the internal precision to 20 digits,
959 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
960 or fixed display format, respectively, and `D', `R', `F', and `S' to
961 turn on degrees, radians, fraction and symbolic modes, respectively.
962 In addition, you may provide a `printf' format specifier to reformat
963 the final result. A few examples:
964 $1+$2 Sum of first and second field
965 $1+$2;%.2f Same, format result to two decimals
966 exp($2)+exp($1) Math functions can be used
967 $;%.1f Reformat current cell to 1 decimal
968 ($3-32)*5/9 Degrees F -> C conversion
969 $c/$1/$cm Hz -> cm conversion, using `constants.el'
970 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
971 sin($1);Dp3%.1e Same, but use printf specifier for display
972 vmean($2..$7) Compute column range mean, using vector function
973 vsum(&III) Sum numbers from 3rd hline above, up to here
974 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
976 ---------- Footnotes ----------
978 (1) By default, Org-mode uses the standard calc modes (precision 12,
979 angular units degrees, fraction and symbolic modes off). However, the
980 display format has been changed to `(float 5)' to keep tables compact.
981 The default settings can be configured using the variable
982 `org-calc-default-modes'.
985 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
987 3.2.2 Column formulas
988 ---------------------
990 To apply a formula to a field, type it directly into the field,
991 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
992 <RET> or `C-c C-c' with the cursor still in the field, the formula will
993 be stored as the formula for the current column, evaluated and the
994 current field replaced with the result. If the field contains only
995 `=', the previously stored formula for this column is used.
997 For each column, Org-mode will remember the most recently used
998 formula. The information is stored in a special line starting with
999 `#+TBLFM' directly below the table. When adding/deleting/moving
1000 columns with the appropriate commands, the stored equations will be
1001 modified accordingly. When a column used in a calculation is removed,
1002 references to this column become invalid and will cause an error upon
1003 applying the equation.
1005 Instead of typing an equation into the field, you may also use the
1006 command `C-c ='. It prompts for a formula (with default taken from the
1007 `#+TBLFM:' line) and applies it to the current field. A numerical
1008 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1009 in the current column.
1011 To recompute all the fields in a line, use the command `C-c *'. It
1012 re-applies all stored equations to the current row, from left to right.
1013 With a `C-u' prefix, this will be done to every line in the table, so
1014 use this command it you want to make sure the entire table is
1015 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1016 Global updating does not touch the line(s) above the first horizontal
1017 separator line, assuming that this is the table header.
1020 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1022 3.2.3 Advanced features
1023 -----------------------
1025 If you want the recalculation of fields to happen automatically, or if
1026 you want to be able to assign a formula to an individual field (instead
1027 of an entire column) you need to reserve the first column of the table
1028 for special marking characters. Here is an example of a table that
1029 collects exam results of students and makes use of these features:
1030 |---+---------+--------+--------+--------+-------+------|
1031 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1032 |---+---------+--------+--------+--------+-------+------|
1033 | ! | | P1 | P2 | P3 | Tot | |
1034 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1035 | ^ | | m1 | m2 | m3 | mt | |
1036 |---+---------+--------+--------+--------+-------+------|
1037 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1038 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1039 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1040 |---+---------+--------+--------+--------+-------+------|
1041 | | Average | | | | 29.7 | |
1042 | ^ | | | | | at | |
1043 | $ | max=50 | | | | | |
1044 |---+---------+--------+--------+--------+-------+------|
1045 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1047 Important: Please note that for these special tables, recalculating the
1048 table with `C-u C-c *' will only affect rows which are marked `#' or
1049 `*', and named fields. The column formulas are not applied in rows
1050 with empty first field.
1052 The marking characters have the following meaning:
1054 The fields in this line define names for the columns, so that you
1055 may refer to a column as `$Tot' instead of `$6'.
1058 This row defines names for the fields _above_ the row. With such
1059 a definition, any formula in the table may use `$m1' to refer to
1060 the value `10'. Also, named fields can have their own formula
1061 associated with them.
1064 Similar to `^', but defines names for the fields in the row
1068 Fields in this row can define _parameters_ for formulas. For
1069 example, if a field in a `$' row contains `max=50', then formulas
1070 in this table can refer to the value 50 using `$max'. Parameters
1071 work exactly like constants, only that they can be defined on a
1072 per-table basis. Changing a parameter and then recalculating the
1073 table can be useful.
1076 Fields in this row are automatically recalculated when pressing
1077 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1078 selected for a global recalculation with `C-u C-c *'. Unmarked
1079 lines will be left alone by this command.
1082 Selects this line for global recalculation with `C-u C-c *', but
1083 not for automatic recalculation. Use this when automatic
1084 recalculation slows down editing too much.
1087 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1088 All lines that should be recalculated should be marked with `#' or
1092 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1094 3.2.4 Named-field formulas
1095 --------------------------
1097 A named field can have its own formula associated with it. In the
1098 example above, this is used for the `at' field that contains the
1099 average result of the students. To enter a formula for a named field,
1100 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1101 This equation will be stored below the table like `$name=...'. Any
1102 recalculation in the table (even if only requested for the current
1103 line) will also update all named field formulas.
1106 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1108 3.2.5 Editing and debugging formulas
1109 ------------------------------------
1111 To edit a column or field formula, use the commands `C-c =' and `C-u
1112 C-c =', respectively. The currently active expression is then
1113 presented as default in the minibuffer, where it may be edited.
1115 Note that making a table field blank does not remove the formula
1116 associated with the field - during the next recalculation the field
1117 will be filled again. To remove a formula from a field, you have to
1118 give an empty reply when prompted for the formula, or to edit the
1121 You may edit the `#+TBLFM' directly and re-apply the changed
1122 equations with `C-c C-c' in that line, or with the normal recalculation
1123 commands in the table.
1125 In particular for large tables with many formulas, it is convenient
1126 to use the command `C-c '' to edit the formulas of the current table in
1127 a separate buffer. That buffer will show the formulas one per line,
1128 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1129 `$...' expression to get information about its interpretation.
1130 Exiting the buffer with `C-c C-c' only stores the modified formulas
1131 below the table. Exiting with `C-u C-c C-c' also applies them to the
1132 entire table. `C-c C-q' exits without installing the changes.
1134 When the evaluation of a formula leads to an error, the field content
1135 becomes the string `#ERROR'. If you would like see what is going on
1136 during variable substitution and calculation in order to find a bug,
1137 turn on formula debugging in the menu and repeat the calculation, for
1138 example by pressing `C-c = <RET>' in a field. Detailed information
1142 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1147 Finally, just to wet your appetite on what can be done with the
1148 fantastic `calc' package, here is a table that computes the Taylor
1149 series for a couple of functions (homework: try that with Excel :-)
1151 |---+-------------+---+-----+--------------------------------------|
1152 | | Func | n | x | Result |
1153 |---+-------------+---+-----+--------------------------------------|
1154 | # | exp(x) | 1 | x | 1 + x |
1155 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1156 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1157 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1158 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1159 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1160 |---+-------------+---+-----+--------------------------------------|
1161 #+TBLFM: $5=taylor($2,$4,$3);n3
1164 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1166 3.3 The Orgtbl minor mode
1167 =========================
1169 If you like the intuitive way the Org-mode table editor works, you
1170 might want to use it also in other modes like text-mode or mail-mode.
1171 The minor mode Orgtbl-mode makes this possible. You can always toggle
1172 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1174 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1177 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1179 3.4 The `table.el' package
1180 ==========================
1182 Complex ASCII tables with automatic line wrapping, column- and
1183 row-spanning, and alignment can be created using the Emacs table
1184 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1185 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1186 table, Org-mode will call `table-recognize-table' and move the cursor
1187 into the table. Inside a table, the keymap of Org-mode is inactive.
1188 In order to execute Org-mode-related commands, leave the table.
1191 Recognize `table.el' table. Works when the cursor is in a
1195 Insert a table.el table. If there is already a table at point,
1196 this command converts it between the table.el format and the
1197 Org-mode format. See the documentation string of the command
1198 `org-convert-table' for the restrictions under which this is
1202 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1207 Just like HMTL, Org-mode provides links inside a file, and external
1208 links to other files, Usenet articles, emails and much more.
1212 * Internal links:: Links to other places in the current file
1213 * External links:: URL-like links to the world
1214 * Managing links:: Creating, inserting and following
1215 * Search Options:: Linking to a specific location
1216 * Remember:: Org-trees store quick notes
1219 File: org, Node: Internal links, Next: External links, Prev: Hyperlinks, Up: Hyperlinks
1224 Strings inside double brackets like `[[My Target]]' are links that lead
1225 to a text search in the current file. The link can be followed with
1226 `C-c C-o' or with a mouse click (*note Managing links::). The
1227 preferred match for such a link is a dedicated target: The same string
1228 in double angular brackets. Targets may be located anywhere, often it
1229 is convenient to put them into a comment line, for example
1232 If no dedicated target exists, Org-mode will search for the words in
1233 the link, in the above example for `my target'. Links starting with a
1234 star like `*My Target' restrict the search to headlines. When
1235 searching, Org-mode will first try an exact match, but then move on to
1236 more and more lenient searches. For example, the link `[[*My
1237 Targets]]' will find any of the following:
1239 ** TODO my targets are bright
1240 ** my 20 targets are
1241 It is therefore often not necessary to set a dedicated target. To
1242 insert a link targeting a headline, in-buffer completion can be used.
1243 Just type a star followed by a few optional letters into the buffer and
1244 press `M-<TAB>'. All headlines in the current buffer will be offered
1245 as completions. *Note Managing links::, for more commands creating
1248 Following a link pushes a mark onto Org-mode's own mark ring. You
1249 can return to the previous position with `C-c &'. Using this command
1250 several times in direct succession goes back to positions recorded
1255 * Radio targets:: Make targets trigger links in plain text.
1256 * CamelCase links:: Activating CamelCase words as links
1259 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1264 You can configure Org-mode to link any occurrences of certain target
1265 names in normal text. So without explicitly creating a link, the text
1266 connects to the target radioing its position. Radio targets are
1267 enclosed by triple angular brackets. For example, a target `<<<My
1268 Target>>>' causes each occurrence of `my target' in normal text to
1269 become activated as a link. The Org-mode file is scanned automatically
1270 for radio targets only when the file is first loaded into Emacs. To
1271 update the target list during editing, press `C-c C-c' with the cursor
1275 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1277 4.1.2 CamelCase words as links
1278 ------------------------------
1280 As an alternative to `[[...]]' links, Org-mode also supports CamelCase
1281 words as links. This feature is not turned on by default because of
1282 the occasional inconsistencies this system suffers from. To activate
1283 CamelCase words as links, and to make headline completion offer
1284 CamelCase version of headlines, the following customization is needed:
1285 (setq org-activate-camels t
1286 org-file-link-context-use-camel-case t)
1289 File: org, Node: External links, Next: Managing links, Prev: Internal links, Up: Hyperlinks
1294 Org-mode supports links to files, websites, Usenet and email messages;
1295 and BBDB database entries. Links are just plain-text URL-like
1296 locators, optionally enclosed by angular brackets. The following list
1297 shows examples for each link type.
1299 <http://www.astro.uva.nl/~dominik> on the web
1300 <file:/home/dominik/images/jupiter.jpg> file, absolute path
1301 <file:papers/last.pdf> file, relative path
1302 <news:comp.emacs> Usenet link
1303 <mailto:adent@galaxy.net> Mail link
1304 <vm:folder> VM folder link
1305 <vm:folder#id> VM message link
1306 <vm://myself@some.where.org/folder#id> VM on remote machine
1307 <wl:folder> WANDERLUST folder link
1308 <wl:folder#id> WANDERLUST message link
1309 <mhe:folder> MH-E folder link
1310 <mhe:folder#id> MH-E message link
1311 <rmail:folder> RMAIL folder link
1312 <rmail:folder#id> RMAIL message link
1313 <gnus:group> GNUS group link
1314 <gnus:group#id> GNUS article link
1315 <bbdb:Richard Stallman> BBDB link
1316 <shell:ls *.org>(1) A shell command
1318 A link may contain space characters and is terminated by `>' or by
1319 the end of a line. In tables, the end of a table field also terminates
1320 a link. Angle brackets around a link are not required, but are
1321 recommended to avoid problems with punctuation and other text following
1322 the link. See also the variable `org-allow-space-in-links'.
1324 ---------- Footnotes ----------
1326 (1) Note that `<' and `>' cannot be part of a link, and therefore of
1327 a shell command. If you need redirection, use @{ and @} instead.
1330 File: org, Node: Managing links, Next: Search Options, Prev: External links, Up: Hyperlinks
1335 Org-mode provides methods to create a link in the correct syntax, to
1336 insert it into an org-mode file, and to follow the link.
1339 Store a link to the current location. This is a _global_ command
1340 which can be used in any buffer to create a link. The link will be
1341 stored for later insertion into an Org-mode buffer (see below).
1342 For VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will
1343 point to the current article/entry. For W3 and W3M buffers, the
1344 link goes to the current URL. For Org-mode files, the current
1345 headline is targeted. For any other files, the link will point to
1346 the file, with a search string (*note Search Options::) pointing
1347 to the contents of the current line. If there is an active
1348 region, the selected words will form the basis of the search
1349 string. The key binding `C-c l' is only a suggestion - see *Note
1350 Installation and activation::.
1353 Insert a link. This prompts for a link to be inserted into the
1354 buffer. You can just type a link, using one of the link type
1355 prefixes mentioned in the examples above. Through completion, all
1356 links stored during the current session can be accessed. When
1357 called with prefix arg, you can use file name completion to enter
1358 a file link. The link will be formatted as given in the variable
1359 `org-link-format' and inserted into the buffer. Note that you
1360 don't have to use this command to insert a link. Links in
1361 Org-mode are plain text, and you can type or paste them straight
1365 Open link at point. This will launch a web browser for URLs (using
1366 `browse-url-at-point'), run vm/gnus/bbdb for the corresponding
1367 links, and execute the command in a shell link. When the cursor
1368 is on a CamelCase link, this commands runs the corresponding
1369 search. When the cursor is on a TAGS list in a headline, it
1370 creates the corresponding TAGS view. Furthermore, it will visit
1371 text files in `file:' links with Emacs and select a suitable
1372 application for non-text files. Classification of files is based
1373 on file extension only. See option `org-file-apps'. If there is
1374 no link at point, the current subtree will be searched for one.
1375 If you want to override the default application and visit the file
1376 with Emacs, use a `C-u' prefix. If the cursor is on a time stamp,
1377 it compiles the agenda for that date.
1379 *IMPORTANT*: Be careful not to use any dangerous commands in a
1384 On links, `mouse-2' will open the link just like `C-c C-o' would.
1385 Under Emacs 22, also `mouse-1' will follow a link.
1388 Like `mouse-2', but force file links to be opened with Emacs.
1391 Push the current position onto the mark ring, to be able to return
1392 easily. Commands following an internal link do this automatically.
1395 Jump back to a recorded position. A position is recorded by the
1396 commands following internal links, and by `C-c %'. Using this
1397 command several times in direct succession moves through a ring of
1398 previously recorded positions.
1401 File: org, Node: Search Options, Next: Remember, Prev: Managing links, Up: Hyperlinks
1403 4.4 Search options in file links
1404 ================================
1406 File links can contain additional information to make Emacs jump to a
1407 particular location in the file when following a link. This can be a
1408 line number or a search option after a double(1) colon. For example:
1409 <file:~/code/main.c::255>
1410 <file:~/xx.org::My Target>
1411 <file:~/xx.org::*My Target>
1412 <file:~/xx.org::/regexp/>
1413 Here is what these options do.
1419 Search for a link target `<<My Target>>', or do a text search for
1420 `my target', similar to the search in internal links, see *Note
1424 In an Org-mode file, restrict search to headlines.
1427 Do a regular expression search for `regexp'. This uses the Emacs
1428 command `occur' to list all matches in a separate window. If the
1429 target file is in Org-mode, `org-occur' is used to create a sparse
1430 tree with the matches.
1432 As a degenerate case, a file link with an empty file name can be used
1433 to search the current file. For example, `<file:::find me>' does a
1434 search for `find me' in the current file, just like `[[find me]]' would.
1436 ---------- Footnotes ----------
1438 (1) For backward compatibility, line numbers can also follow a
1442 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1447 Another way to create org entries with links to other files is through
1448 the _Remember_ package by John Wiegley. _Remember_ lets you store
1449 quick notes with little interruption of your work flow. See
1450 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1451 information. The notes produced by _Remember_ can be stored in
1452 different ways, and Org-mode files are a good target. Org-mode allows
1453 to file away notes either to a default file, or directly to the correct
1454 location in your Org-mode outline tree. The following customization(1)
1455 will tell _Remember_ to use org files as target, and to create
1456 annotations compatible with Org-mode links.
1458 (autoload 'org-remember-annotation "org")
1459 (autoload 'org-remember-apply-template "org")
1460 (autoload 'org-remember-handler "org")
1461 (setq org-directory "~/path/to/my/orgfiles/")
1462 (setq org-default-notes-file "~/.notes")
1463 (setq remember-annotation-functions '(org-remember-annotation))
1464 (setq remember-handler-functions '(org-remember-handler))
1465 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1467 In combination with Org-mode, you can use templates to generate
1468 different types of remember notes. For example, if you would like to
1469 use one template to create general TODO entries, and another one for
1470 journal entries, you could use:
1472 (setq org-remember-templates
1473 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1474 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1475 In these entries, the character specifies how to select the
1476 template, the first string specifies the template, and the second string
1477 specifies a default file (overruling `org-default-notes-file') as a
1478 target for this note.
1480 When you call `M-x remember' to remember something, org will prompt
1481 for a key to select the template and then prepare the buffer like
1483 <file:link to where you called remember>
1485 * [2006-03-21 Tue 15:37]
1487 <file:link to where you called remember>
1489 See the variable `org-remember-templates' for more details.
1491 When you are finished composing a note with remember, you have to
1492 press `C-c C-c' to exit remember-mode and to file the note away. The
1493 handler first prompts for a target file - if you press <RET>, the value
1494 of `org-default-notes-file' is used. Then the command offers the
1495 headings tree of the selected file. You can either immediately press
1496 <RET> to get the note appended to the file. Or you can use vertical
1497 cursor motion (<up> and <down>) and visibility cycling (<TAB>) to find
1498 a better place. Pressing <RET> or <left> or <right> leads to the
1501 Cursor Key Note gets inserted
1503 buffer-start <RET> as level 2 heading at end of file
1504 on headline <RET> as sublevel of the heading at cursor
1505 <left> as same level, before current heading
1506 <right> as same level, after current heading
1507 not on <RET> at cursor position, level taken from context.
1508 headline Or use prefix arg to specify level
1511 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1512 append it to the default file. Even shorter would be `C-u C-c C-c',
1513 which does the same without even showing the tree. But with little
1514 extra effort, you can push it directly to the correct location.
1516 Before inserting the text into a tree, the function ensures that the
1517 text has a headline, i.e. a first line that starts with a `*'. If not,
1518 a headline is constructed from the current date and some additional
1519 data. If the variable `org-adapt-indentation' is non-nil, the entire
1520 text is also indented so that it starts in the same column as the
1521 headline (after the asterisks).
1523 ---------- Footnotes ----------
1525 (1) The three autoload forms are only necessary if `org.el' is not
1526 part of the Emacs distribution or an XEmacs package.
1529 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1534 Org-mode does not maintain TODO lists as a separate document. TODO
1535 items are an integral part of the notes file, because TODO items
1536 usually come up while taking notes! With Org-mode, you simply mark any
1537 entry in a tree as being a TODO item. In this way, the information is
1538 not duplicated, and the entire context from which the item emerged is
1539 always present when you check.
1541 Of course, this technique causes TODO items to be scattered
1542 throughout your file. Org-mode provides methods to give you an
1543 overview over all things you have to do.
1547 * TODO basics:: Marking and displaying TODO entries
1548 * Progress logging:: Document your productivity
1549 * TODO extensions:: Workflow and assignments
1550 * Priorities:: Some things are more important than others
1553 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1555 5.1 Basic TODO functionality
1556 ============================
1558 Any headline can become a TODO item by starting it with the word TODO,
1561 *** TODO Write letter to Sam Fortune
1563 The most important commands to work with TODO entries are:
1566 Rotate the TODO state of the current item between
1567 ,-> (unmarked) -> TODO -> DONE --.
1568 '--------------------------------'
1569 The same rotation can also be done "remotely" from the timeline and
1570 agenda buffers with the `t' command key (*note Agenda commands::).
1573 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1574 the entire buffer, but shows all TODO items and the headings
1575 hierarchy above them. With prefix arg, show also the DONE
1576 entries. With numerical prefix N, show the tree for the Nth
1577 keyword in the variable `org-todo-keywords'.
1580 Show the global TODO list. This collects the TODO items from all
1581 agenda files (*note Agenda Views::) into a single buffer. The
1582 buffer is in `agenda-mode', so there are commands to examine and
1583 manipulate the TODO entries directly from that buffer (*note
1584 Agenda commands::). *Note Global TODO list::, for more
1587 ``org-agenda-include-all-todo''
1588 If you would like to have all your TODO items listed as part of
1589 your agenda, customize the variable `org-agenda-include-all-todo'.
1592 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1594 5.2 Progress Logging
1595 ====================
1597 If you want to keep track of _when_ a certain TODO item was finished,
1598 turn on logging with
1599 (setq org-log-done t)
1600 Then each time you turn a TODO entry into DONE using either `C-c
1601 C-t' in the Org-mode buffer or `t' in the agenda buffer, a line
1602 `CLOSED: [timestamp]' will be inserted just after the headline. If you
1603 turn the entry back into a TODO item again through further state
1604 cycling, that line will be removed again. In the timeline (*note
1605 Timeline::) and in the agenda (*note Weekly/Daily Agenda::), you can
1606 then use the `L' key to display the TODO items closed on each day,
1607 giving you an overview of what has been done on a day.
1610 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1612 5.3 Extended use of TODO keywords
1613 =================================
1615 The default implementation of TODO entries is just two states: TODO
1616 and DONE. You can, however, use the TODO feature for more complicated
1617 things by configuring the variables `org-todo-keywords' and
1618 `org-todo-interpretation'. Using special setup, you can even use TODO
1619 keywords in different ways in different org files.
1623 * Workflow states:: From TODO to DONE in steps
1624 * TODO types:: I do this, Fred the rest
1625 * Per file keywords:: Different files, different requirements
1628 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1630 5.3.1 TODO keywords as workflow states
1631 --------------------------------------
1633 You can use TODO keywords to indicate different states in the process
1634 of working on an item, for example:
1636 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1637 org-todo-interpretation 'sequence)
1639 Changing these variables becomes only effective in a new Emacs
1640 session. With this setup, the command `C-c C-t' will cycle an entry
1641 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1642 also use a prefix argument to quickly select a specific state. For
1643 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1644 you define many keywords, you can use in-buffer completion (see *Note
1645 Completion::) to insert these words into the buffer.
1648 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1650 5.3.2 TODO keywords as types
1651 ----------------------------
1653 The second possibility is to use TODO keywords to indicate different
1654 types of action items. For example, you might want to indicate that
1655 items are for "work" or "home". If you are into David Allen's _Getting
1656 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1657 `MAYBE'. Or, when you work with several people on a single project,
1658 you might want to assign action items directly to persons, by using
1659 their names as TODO keywords. This would be set up like this:
1661 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1662 org-todo-interpretation 'type)
1664 In this case, different keywords do not indicate a sequence, but
1665 rather different types. So it is normally not useful to change from
1666 one type to another. Therefore, in this case the behavior of the
1667 command `C-c C-t' is changed slightly(1). When used several times in
1668 succession, it will still cycle through all names. But when you return
1669 to the item after some time and execute `C-c C-t' again, it will switch
1670 from each name directly to DONE. Use prefix arguments or completion to
1671 quickly select a specific name. You can also review the items of a
1672 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1673 C-v'. For example, to see all things Lucy has to do, you would use
1674 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1675 single buffer, you would use the prefix arg as well when creating the
1676 global todo list: `C-3 C-c t'.
1678 ---------- Footnotes ----------
1680 (1) This is also true for the `t' command in the timeline and agenda
1684 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1686 5.3.3 Setting up TODO keywords for individual files
1687 ---------------------------------------------------
1689 It can be very useful to use different aspects of the TODO mechanism in
1690 different files, which is not possible with the global settings
1691 described above. For file-local settings, you need to add special
1692 lines to the file which set the keywords and interpretation for that
1693 file only. For example, to set one of the two examples discussed
1694 above, you need one of the following lines, starting in column zero
1695 anywhere in the file:
1697 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1698 #+TYP_TODO: Fred Sara Lucy Mike DONE
1700 To make sure you are using the correct keyword, type `#+' into the
1701 buffer and then use `M-<TAB>' completion.
1703 Remember that the last keyword must always mean that the item is DONE
1704 (you may use a different word, though). Also note that in each file,
1705 only one of the two aspects of TODO keywords can be used. After
1706 changing one of these lines, use `C-c C-c' with the cursor still in the
1707 line to make the changes known to Org-mode(1).
1709 If you want to use very many keywords, for example when working with
1710 a large group of people, you may split the names over several lines:
1712 #+TYP_TODO: Fred Sara Lucy Mike
1713 #+TYP_TODO: Luis George Jules Jessica
1714 #+TYP_TODO: Kim Arnold Peter
1717 ---------- Footnotes ----------
1719 (1) Org-mode parses these lines only when Org-mode is activated
1720 after visiting a file. `C-c C-c' with the cursor in a line starting
1721 with `#+' is simply restarting Org-mode, making sure that these changes
1725 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1730 If you use Org-mode extensively to organize your work, you may end up
1731 with a number of TODO entries so large that you'd like to prioritize
1732 them. This can be done by placing a _priority cookie_ into the
1735 *** TODO [#A] Write letter to Sam Fortune
1737 With its standard setup, Org-mode supports priorities `A', `B', and
1738 `C'. `A' is the highest priority. An entry without a cookie is
1739 treated as priority `B'. Priorities make a difference only in the
1740 agenda (*note Weekly/Daily Agenda::).
1743 Set the priority of the current item. The command prompts for a
1744 priority character `A', `B' or `C'. When you press <SPC> instead,
1745 the priority cookie is removed from the headline. The priorities
1746 can also be changed "remotely" from the timeline and agenda buffer
1747 with the `,' command (*note Agenda commands::).
1751 Increase/decrease priority of current item. Note that these keys
1752 are also used to modify time stamps (*note Creating timestamps::).
1753 Furthermore, these keys are also used by CUA-mode (*note
1757 File: org, Node: Timestamps, Next: Agenda Views, Prev: TODO items, Up: Top
1762 Items can be labeled with timestamps to make them useful for project
1767 * Time stamps:: Assigning a time to a tree entry
1768 * Creating timestamps:: Commands which insert timestamps
1771 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1773 6.1 Time stamps, deadlines and scheduling
1774 =========================================
1776 A time stamp is a specification of a date (possibly with time) in a
1777 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1778 A time stamp can appear anywhere in the headline or body of an org-tree
1779 entry. Its presence allows entries to be shown on specific dates in
1780 the agenda (*note Weekly/Daily Agenda::). We distinguish:
1783 A simple time stamp just assigns a date/time to an item. In the
1784 timeline and agenda displays, the headline of the entry will be
1785 shown exactly on that date.
1788 Two time stamps connected by `--' denote a time range. The
1789 headline will be shown on the first and last day of the range, and
1790 on any dates that are displayed and fall in the range. Here is an
1793 ** Meeting in Amsterdam
1794 <2004-08-23 Mon>--<2004-08-26 Thu>
1797 If a time stamp is preceded by the word `DEADLINE:', the task
1798 (most likely a TODO item) is supposed to be finished on that date,
1799 and it will be listed then. In addition, the compilation for
1800 _today_ will carry a warning about the approaching or missed
1801 deadline, starting `org-deadline-warning-days' before the due
1802 date, and continuing until the entry is marked DONE. An example:
1804 *** TODO write article about the Earth for the Guide
1805 The editor in charge is <bbdb:Ford Prefect>
1806 DEADLINE: <2004-02-29 Sun>
1809 If a time stamp is preceded by the word `SCHEDULED:', it means you
1810 are planning to start working on that task on the given date. The
1811 headline will be listed under the given date. In addition, a
1812 reminder that the scheduled date has passed will be present in the
1813 compilation for _today_, until the entry is marked DONE. I.e., the
1814 task will automatically be forwarded.
1817 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1819 6.2 Creating timestamps
1820 =======================
1822 For Org-mode to recognize time stamps, they need to be in the specific
1823 format. All commands listed below produce time stamps in the correct
1827 Prompt for a date and insert a corresponding time stamp. When the
1828 cursor is at a previously used time stamp, it is updated to NOW.
1829 When this command is used twice in succession, a time range is
1833 Like `C-c .', but use the alternative format which contains date
1834 and time. The default time can be rounded to multiples of 5
1835 minutes, see the option `org-time-stamp-rounding-minutes'.
1838 Like `C-c .', but insert an inactive time stamp not triggering the
1842 Insert a time stamp corresponding to the cursor date in the
1846 Access the Emacs calendar for the current date. If there is a
1847 timestamp in the current line, goto the corresponding date instead.
1850 Access the agenda for the date given by the time stamp at point
1851 (*note Weekly/Daily Agenda::).
1854 Insert `DEADLINE' keyword along with a stamp.
1857 Create a sparse tree with all deadlines that are either past-due,
1858 or which will become due within `org-deadline-warning-days'. With
1859 `C-u' prefix, show all deadlines in the file. With a numeric
1860 prefix, check that many days. For example, `C-1 C-c C-w' shows
1861 all deadlines due tomorrow.
1864 Insert `SCHEDULED' keyword along with a stamp.
1868 Change date at cursor by one day. These key bindings conflict with
1869 CUA-mode (*note Interaction::).
1873 Change the item under the cursor in a timestamp. The cursor can
1874 be on a year, month, day, hour or minute. Note that if the cursor
1875 is not at a time stamp, these same keys modify the priority of an
1876 item. (*note Priorities::). The key bindings also conflict with
1877 CUA-mode (*note Interaction::).
1880 Evaluate a time range by computing the difference between start and
1881 end. With prefix arg, insert result after the time range (in a
1882 table: into the following column).
1884 When Org-mode prompts for a date/time, the function reading your
1885 input will replace anything you choose not to specify with the current
1886 date and time. For details, see the documentation string of
1887 `org-read-date'. Also, a calender will pop up to allow selecting a
1888 date. The calendar can be fully controlled from the minibuffer, and a
1889 date can be selected with the following commands:
1892 Scroll calendar backwards by one month.
1895 Scroll calendar forwards by one month.
1898 Select date by clicking on it.
1919 Choose date in calendar (only if nothing typed into minibuffer).
1922 File: org, Node: Agenda Views, Next: Exporting, Prev: Timestamps, Up: Top
1927 Due to the way Org-mode works, TODO items and time-stamped items can be
1928 scattered throughout a file or even a number of files. To get an
1929 overview over open action items, or over events that are important for
1930 a particular date, this information must be collected, sorted and
1931 displayed in an organized way.
1933 Org-mode can select items based on various criteria, and display them
1934 in a separate buffer. Three different views are provided:
1935 * an _agenda_ that is like a calendar and shows information for
1938 * a _TODO list_ that covers all unfinished action items, and
1940 * a _tags view_ that shows information based on the tags associated
1941 with headlines in the outline tree.
1942 The extracted information is displayed in a special _agenda buffer_.
1943 This buffer is read-only, but provides commands to visit the
1944 corresponding locations in the original Org-mode files, and even to
1945 edit these files remotely.
1949 * Agenda files:: Files being searched for agenda information
1950 * Agenda dispatcher:: Keyboard access to agenda views
1951 * Weekly/Daily Agenda:: The calendar page with current tasks
1952 * Global TODO list:: All unfinished action items
1953 * Matching headline tags:: Structured information with fine-tuned search
1954 * Timeline:: Time-sorted view for single file
1955 * Agenda commands:: Remote editing of org trees
1958 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda Views, Up: Agenda Views
1963 The information to be shown is collected from all _agenda files_, the
1964 files listed in the variable `org-agenda-files'(1). Thus even if you
1965 only work with a single Org-mode file, this file should be put into
1966 that list(2). You can customize `org-agenda-files', but the easiest
1967 way to maintain it is through the following commands
1970 Add current file to the list of agenda files. The file is added to
1971 the front of the list. If it was already in the list, it is moved
1972 to the front. With prefix arg, file is added/moved to the end.
1975 Remove current file from the list of agenda files.
1978 Cycle through agenda file list, visiting one file after the other.
1979 The Org menu contains the current list of files and can be used to
1982 ---------- Footnotes ----------
1984 (1) If the value of that variable is not a list, but a single file
1985 name, then the list of agenda files will be maintained in that external
1988 (2) When using the dispatcher pressing `1' before selecting a
1989 command will actually limit the command to the current file, and ignore
1990 `org-agenda-files' until the next dispatcher command.
1993 File: org, Node: Agenda dispatcher, Next: Weekly/Daily Agenda, Prev: Agenda files, Up: Agenda Views
1995 7.2 The agenda dispatcher
1996 =========================
1998 The views are created through a dispatcher that should be bound to a
1999 global key, for example `C-c a' (*note Installation and activation::).
2000 In the following we will assume that `C-c a' is indeed how the
2001 dispatcher is accessed and lists keyboard access to commands
2002 accordingly. After pressing `C-c a', an additional letter is required
2003 to execute a command. The dispatcher offers the following default
2006 Create the calendar-like agenda (*note Weekly/Daily Agenda::).
2009 Create a list of all TODO items (*note Global TODO list::).
2012 Create a list of headlines matching a TAGS expression (*note
2013 Matching headline tags::).
2015 You can also define custom commands that will be accessible through
2016 the dispatcher, just like the default commands. Custom commands are
2017 global searches for tags and specific TODO keywords, or a variety of
2018 sparse tree creating commands (*note Sparse trees::). As sparse trees
2019 are only defined for a single org-mode file, these latter commands act
2020 on the current buffer instead of the list of agenda files.
2022 Custom commands are configured in the variable
2023 `org-agenda-custom-commands'. You can customize this variable, for
2024 example by pressing `C-c a C'. You can also directly set it with Emacs
2025 Lisp in `.emacs'. For example:
2026 (setq org-agenda-custom-commands
2027 '(("w" todo "WAITING")
2028 ("u" tags "+BOSS-URGENT")
2029 ("U" tags-tree "+BOSS-URGENT")
2030 ("f" occur-tree "\\<FIXME\\>")))
2031 will define `C-c a w' as a global search for TODO entries with
2032 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2033 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2034 search but only in the current buffer and display the result as a
2035 sparse tree, and `C-c a f' to create a sparse tree with all entries
2036 containing the word `FIXME'. For more information, look at the
2037 documentation string of the variable `org-agenda-custom-commands'.
2040 File: org, Node: Weekly/Daily Agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda Views
2042 7.3 The weekly/daily agenda
2043 ===========================
2045 The purpose of the weekly/daily _agenda_ is to act like a page of a
2046 paper agenda, showing all the tasks for the current week or day.
2049 Compile an agenda for the current week from a list of org files.
2050 The agenda shows the entries for each day. With a `C-u' prefix (or
2051 when the variable `org-agenda-include-all-todo' is `t'), all
2052 unfinished TODO items (including those without a date) are also
2053 listed at the beginning of the buffer, before the first date.
2055 Remote editing from the agenda buffer means, for example, that you
2056 can change the dates of deadlines and appointments from the agenda
2057 buffer. The commands available in the Agenda buffer are listed in
2058 *Note Agenda commands::.
2062 * Categories:: Not all tasks are equal
2063 * Time-of-day specifications:: How the agenda knows the time
2064 * Calendar/Diary integration:: Integrating Anniversaries and more
2065 * Sorting of agenda items:: The order of things
2068 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily Agenda, Up: Weekly/Daily Agenda
2073 In the agenda buffer, each entry is preceded by a _category_, which is
2074 derived from the file name. The category can also be set with a
2075 special line anywhere in the buffer, looking like this:
2077 If there are several such lines in a file, each specifies the
2078 category for the text below it (but the first category also applies to
2079 any text before the first CATEGORY line). The display in the agenda
2080 buffer looks best if the category is not longer than 10 characters.
2083 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily Agenda
2085 7.3.2 Time-of-Day Specifications
2086 --------------------------------
2088 Org-mode checks each agenda item for a time-of-day specification. The
2089 time can be part of the time stamp that triggered inclusion into the
2090 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2091 specified with two time stamps, like
2092 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2094 In the headline of the entry itself, a time(range) may also appear as
2095 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2096 Emacs diary (*note Calendar/Diary integration::), time specifications
2097 in diary entries are recognized as well.
2099 For agenda display, Org-mode extracts the time and displays it in a
2100 standard 24 hour format as part of the prefix. The example times in
2101 the previous paragraphs would end up in the agenda like this:
2103 8:30-13:00 Arthur Dent lies in front of the bulldozer
2104 12:45...... Ford Prefect arrives and takes Arthur to the pub
2105 19:00...... The Vogon reads his poem
2106 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2108 If the agenda is in single-day mode, or for the display of today, the
2109 timed entries are embedded in a time grid, like
2111 8:00...... ------------------
2112 8:30-13:00 Arthur Dent lies in front of the bulldozer
2113 10:00...... ------------------
2114 12:00...... ------------------
2115 12:45...... Ford Prefect arrives and takes Arthur to the pub
2116 14:00...... ------------------
2117 16:00...... ------------------
2118 18:00...... ------------------
2119 19:00...... The Vogon reads his poem
2120 20:00...... ------------------
2121 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2123 The time grid can be turned on and off with the variable
2124 `org-agenda-use-time-grid', and can be configured with
2125 `org-agenda-time-grid'.
2128 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily Agenda
2130 7.3.3 Calendar/Diary integration
2131 --------------------------------
2133 Emacs contains the calendar and diary by Edward M. Reingold. The
2134 calendar displays a three-month calendar with holidays from different
2135 countries and cultures. The diary allows you to keep track of
2136 anniversaries, lunar phases, sunrise/set, recurrent appointments
2137 (weekly, monthly) and more. In this way, it is quite complementary to
2138 Org-mode. It can be very useful to combine output from Org-mode with
2141 In order to include entries from the Emacs diary into Org-mode's
2142 agenda, you only need to customize the variable
2144 (setq org-agenda-include-diary t)
2145 After that, everything will happen automatically. All diary entries
2146 including holidays, anniversaries etc will be included in the agenda
2147 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2148 the agenda buffer to jump to the diary file in order to edit existing
2149 diary entries. The `i' command to insert new entries for the current
2150 date works in the agenda buffer, as well as the commands `S', `M', and
2151 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2152 to other calendars, respectively. `c' can be used to switch back and
2153 forth between calendar and agenda.
2156 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily Agenda
2158 7.3.4 Sorting of agenda items
2159 -----------------------------
2161 The entries for each day are sorted. The default order is to first
2162 collect all items containing an explicit time-of-day specification.
2163 These entries will be shown at the beginning of the list, as a
2164 _schedule_ for the day. After that, items remain grouped in
2165 categories, in the sequence given by `org-agenda-files'. Within each
2166 category, items are sorted by priority (*note Priorities::).
2168 The priority is a numerical quantity composed of the base priority
2169 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2170 increments for overdue scheduled or deadline items.
2172 Sorting can be customized using the variable
2173 `org-agenda-sorting-strategy'.
2176 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily Agenda, Up: Agenda Views
2178 7.4 The global TODO list
2179 ========================
2181 The global TODO list contains all unfinished TODO items, formatted and
2182 collected into a single place.
2185 Show the global TODO list. This collects the TODO items from all
2186 agenda files (*note Agenda Views::) into a single buffer. The
2187 buffer is in `agenda-mode', so there are commands to examine and
2188 manipulate the TODO entries directly from that buffer (*note
2189 Agenda commands::). *Note Global TODO list::, for more
2193 Like the above, but allows selection of a specific TODO keyword.
2194 You can also do this by specifying a prefix argument to `C-c a t'.
2195 With a `C-u' prefix you are prompted for a keyword. With a
2196 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2197 `r' key in the agenda buffer regenerates it, and you can give a
2198 prefix argument to this command to change the selected TODO
2199 keyword, for example `3 r'. If you often need a search for a
2200 specific keyword, define a custom command for it (*note Agenda
2203 Remote editing of TODO items means that you can change the state of a
2204 TODO entry with a single key press. The commands available in the TODO
2205 list are described in *Note Agenda commands::.
2208 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda Views
2210 7.5 Matching headline tags
2211 ==========================
2213 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2214 you can select headlines based on the tags that apply to them and
2215 collect them into an agenda buffer.
2218 Produce a list of all headlines that match a given set of tags.
2219 The command prompts for a selection criterion, which is a boolean
2220 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2221 `WORK|HOME' (*note Tags::). If you often need a specific search,
2222 define a custom command for it (*note Agenda dispatcher::).
2225 Like `C-c a m', but only select headlines that are also TODO items
2226 and force checking subitems (see variable
2227 `org-tags-match-list-sublevels'.
2229 The commands available in the tags list are described in *Note
2233 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda Views
2235 7.6 Timeline for a single file
2236 ==============================
2238 The timeline is not really an agenda view, because it only summarizes
2239 items from a single Org-mode file. But it also uses the agenda buffer
2240 and provides similar commands, so we discuss it here. The timeline
2241 shows all time-stamped items in a single Org-mode file (or the selected
2242 part of it), in a _time-sorted view_. The main purpose of this command
2243 is to give an overview over events in a project.
2246 Show a time-sorted view of the org file, with all time-stamped
2247 items. When called with a `C-u' prefix, all unfinished TODO
2248 entries (scheduled or not) are also listed under the current date.
2249 The commands available in the timeline buffer are listed in *Note
2253 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda Views
2255 7.7 Commands in the agenda buffer
2256 =================================
2258 Entries in the agenda buffer are linked back to the org file or diary
2259 file where they originate. You are not allowed to edit the agenda
2260 buffer itself, but commands are provided to show and jump to the
2261 original entry location, and to edit the org-files "remotely" from the
2262 agenda buffer. In this way, all information is stored only once,
2263 removing the risk that your agenda and note files may diverge.
2265 Some commands can be executed with mouse clicks on agenda lines. For
2266 the other commands, the cursor needs to be in the desired line.
2272 Next line (same as <up>).
2275 Previous line (same as <down>).
2282 Display the original location of the item in another window.
2285 Display original location and recenter that window.
2290 Go to the original location of the item in another window. Under
2291 Emacs 22, `mouse-1' will also works for this.
2294 Go to the original location of the item and delete other windows.
2297 Toggle Follow mode. In Follow mode, as you move the cursor through
2298 the agenda buffer, the other window always shows the corresponding
2299 location in the org file.
2302 Toggle Logbook mode. In Logbook mode, entries that where marked
2303 DONE while logging was on (variable `org-log-done') are shown in
2310 Delete other windows.
2313 Switch to weekly view (7 days displayed together).
2316 Switch to daily view (just one day displayed).
2319 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2323 Toggle the time grid on and off. See also the variables
2324 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2327 Recreate the agenda buffer, for example to reflect the changes
2328 after modification of the time stamps of items with S-<left> and
2329 S-<right>. When the buffer is the global todo list, a prefix
2330 argument is interpreted to create a selective list for a specific
2334 Display the following `org-agenda-ndays' days. For example, if
2335 the display covers a week, switch to the following week. With
2336 prefix arg, go forward that many times `org-agenda-ndays' days.
2339 Display the previous dates.
2351 Change the TODO state of the item, both in the agenda and in the
2355 Show all tags assiciated with the current item. Because of
2356 inheritance, this may be more than the tags listed in the line
2360 Set tags for the current headline.
2363 Set the priority for the current item. Org-mode prompts for the
2364 priority character. If you reply with <SPC>, the priority cookie
2365 is removed from the entry.
2368 Display weighted priority of current item.
2372 Increase the priority of the current item. The priority is
2373 changed in the original buffer, but the agenda is not resorted.
2374 Use the `r' key for this.
2378 Decrease the priority of the current item.
2381 Change the time stamp associated with the current line by one day
2382 into the future. With prefix argument, change it by that many
2383 days. For example, `3 6 5 S-<right>' will change it by a year.
2384 The stamp is changed in the original org file, but the change is
2385 not directly reflected in the agenda buffer. Use the `r' key to
2389 Change the time stamp associated with the current line by one day
2393 Change the time stamp associated with the current line to today.
2394 The key `>' has been chosen, because it is the same as `S-.' on my
2398 Insert a new entry into the diary. Prompts for the type of entry
2399 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2400 new entry in the diary, just like `i d' etc. would do in the
2401 calendar. The date is taken from the cursor position.
2407 Open the Emacs calendar and move to the date at the agenda cursor.
2410 When in the calendar, compute and show the Org-mode agenda for the
2414 Show the phases of the moon for the three month around current
2418 Show sunrise and sunset times. The geographical location must be
2419 set with calendar variables, see documentation of the Emacs
2423 Convert the date at cursor into many other cultural and historic
2427 Show holidays for three month around the cursor date.
2430 Export a single iCalendar file containing entries from all agenda
2437 Quit agenda, remove the agenda buffer.
2440 Exit agenda, remove the agenda buffer and all buffers loaded by
2441 Emacs for the compilation of the agenda. Buffers created by the
2442 user to visit org files will not be removed.
2446 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda Views, Up: Top
2451 For printing and sharing of notes, Org-mode documents can be exported
2452 as ASCII or HTML files. To incorporate entries with associated times
2453 like deadlines or appointments into a desktop calendar program like
2454 iCal, Org-mode can also produce extracts in the iCalendar format.
2458 * ASCII export:: Export as a structured ASCII file
2459 * HTML export:: Export as an HTML file
2460 * iCalendar export:: Create calendar entries.
2463 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2469 Export as ASCII file. If there is an active region, only the
2470 region will be exported. For an org file `myfile.org', the ASCII
2471 file will be `myfile.txt'. The file will be overwritten without
2474 In the exported version, the first 3 outline levels will become
2475 headlines, defining a general document structure. Additional levels
2476 will be exported as itemized lists. If you want that transition to
2477 occur at a different level, specify it with a prefix argument. For
2479 C-1 C-c C-x a org-export-as-ascii
2480 creates only top level headlines and does the rest as items. Lines
2481 starting with `#' and subtrees starting with the word `COMMENT' will
2485 File: org, Node: HTML export, Next: iCalendar export, Prev: ASCII export, Up: Exporting
2490 Org-mode contains an HTML exporter with extensive HTML formatting, in
2491 ways similar to John Grubers _markdown_ language, but with additional
2495 Export as HTML file `myfile.html'.
2498 Export as HTML file and open it with a browser.
2501 Insert template with export options, see below.
2504 Toggle fixed-width for entry (QUOTE) or region, see below.
2506 In the exported version, the first 3 outline levels will become
2507 headlines, defining a general document structure. Additional levels
2508 will be exported as itemized lists. If you want that transition to
2509 occur at a different level, specify it with a prefix argument. For
2512 creates two levels of headings and does the rest as items.
2516 * HTML formatting:: Interpretation of the buffer content
2517 * Export options:: How to influence exports
2518 * Comment lines:: Lines which will not be exported
2521 File: org, Node: HTML formatting, Next: Export options, Prev: HTML export, Up: HTML export
2523 8.2.1 HTML formatting
2524 ---------------------
2526 Not all text is transferred literally to the exported HTML file. The
2527 exporter implements the following interpretation:
2529 * Hand-formatted lists with `-', `*' or `+' as bullet, or with `1.'
2530 or `2)' as enumerator will be recognized and transformed into HTML
2531 lists. See *Note Plain Lists::.
2533 * You can make words *bold*, /italic/, and _underlined_
2535 * Simple TeX-like math constructs are interpreted:
2537 - `10^22' and `J_n' are super- and subscripts. You can quote
2538 `^' and `_' with a backslash: `\_' and `\^'
2540 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2541 use completion for these macros, just type `\' and maybe a few
2542 letters, and press `M-<TAB>' to see possible completions.
2544 * Tables are transformed into HTML tables. Data fields before the
2545 first horizontal separator line will be formatted as table header
2548 * If a headline starts with the word `QUOTE', the text below the
2549 headline will be typeset as fixed-width, to allow quoting of
2550 computer codes etc. Lines starting with `:' are also typeset in
2553 * If you want to include HTML tags which should be interpreted as
2554 such, mark them with a `@' like in `@<b>bold text@</b>'. Plain
2555 `<' and `>' are always transformed to `<' and `>' in HTML
2558 If these conversions conflict with your habits of typing ASCII text,
2559 they can all be turned off with corresponding variables.
2562 File: org, Node: Export options, Next: Comment lines, Prev: HTML formatting, Up: HTML export
2564 8.2.2 Export options
2565 --------------------
2567 The exporter recognizes special lines in the buffer which provide
2568 additional information. These lines may be put anywhere in the file.
2569 The whole set of lines can be inserted into the buffer with `C-c C-x
2570 t'. For individual lines, a good way to make sure the keyword is
2571 correct is to type `#+' and then use `M-<TAB>' completion (*note
2574 #+TITLE: the title to be shown (default is the buffer name)
2575 #+AUTHOR: the author (default taken from `user-full-name')
2576 #+EMAIL: his/her email address (default from `user-mail-address')
2577 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2578 #+TEXT: Some descriptive text to be inserted at the beginning.
2579 #+TEXT: Several lines may be given.
2580 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2581 The OPTIONS line is a compact form to specify export settings. Here
2583 H: set the number of headline levels for export
2584 num: turn on/off section-numbers
2585 toc: turn on/off table of contents
2586 \n: turn on/off linebreak-preservation
2587 @: turn on/off quoted html tags
2588 :: turn on/off fixed-width sections
2589 |: turn on/off tables
2590 ^: turn on/off TeX-like syntax for sub- and superscripts.
2591 *: turn on/off emphasized text (bold, italic, underlined)
2592 TeX: turn on/off TeX macros
2594 You can also give style information for the exported file. The
2595 default specification can be configured through the option
2596 `org-export-html-style'. If you want to use a file-local style, you
2597 may use file variables, best wrapped into a COMMENT section at the end
2598 of the outline tree. For example:
2600 * COMMENT HTML style specifications
2603 # org-export-html-style: " <style type=\"text/css\">
2604 p {font-weight: normal; color: gray; }
2609 Remember to execute `M-x normal-mode' after changing this to make
2610 the new style visible to Emacs.
2613 File: org, Node: Comment lines, Prev: Export options, Up: HTML export
2618 Lines starting with `#' in column zero are treated as comments and will
2619 never be exported. Also entire subtrees starting with the word
2620 `COMMENT' will never be exported. Finally, any text before the first
2621 headline will not be exported either. This applies also for ASCII
2625 Toggle the COMMENT keyword at the beginning of an entry.
2628 File: org, Node: iCalendar export, Prev: HTML export, Up: Exporting
2630 8.3 iCalendar export
2631 ====================
2633 Some people like to use Org-mode for keeping track of projects, but
2634 still prefer a standard calendar application for anniversaries and
2635 appointments. In this case it can be useful to have deadlines and
2636 other time-stamped items in Org-mode files show up in the calendar
2637 application. Org-mode can export calendar information in the standard
2641 Create iCalendar entries for the current file and store them in
2642 the same directory, using a file extension `.ics'.
2645 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2646 For each of these files, a separate iCalendar file will be
2650 Create a single large iCalendar file from all files in
2651 `org-agenda-files' and write it to the file given by
2652 `org-combined-agenda-icalendar-file'.
2654 How this calendar is best read and updated, depends on the
2655 application you are using. For example, when using iCal under Apple
2656 MacOS X, you could create a new calendar `OrgMode' (the default name
2657 for the calendar created by `C-c C-x c', see the variables
2658 `org-icalendar-combined-name' and
2659 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2660 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2661 use AppleScript to make iCal re-read the calendar files each time a new
2662 version of `OrgMode.ics' is produced. Here is the setup needed for
2665 (setq org-combined-agenda-icalendar-file
2666 "~/Library/Calendars/OrgMode.ics")
2667 (add-hook 'org-after-save-iCalendar-file-hook
2670 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2673 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2680 * Completion:: M-TAB knows what you need
2681 * Customization:: Adapting Org-mode to your taste
2682 * Clean view:: Getting rid of leading stars in the outline
2683 * TTY keys:: Using Org-mode on a tty
2684 * FAQ:: Frequently asked questions
2685 * Interaction:: Other Emacs packages
2686 * Bugs:: Things which do not work perfectly
2687 * Acknowledgments:: These people provided feedback and more
2690 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2695 Org-mode supports in-buffer completion. This type of completion does
2696 not make use of the minibuffer. You simply type a few letters into the
2697 buffer and use the key to complete text right there.
2700 Complete word at point
2701 * At the beginning of a headline, complete TODO keywords.
2703 * After `\', complete TeX symbols supported by the exporter.
2705 * After `*', complete CamelCase versions of all headlines in the
2708 * After `:', complete tags used elsewhere in the buffer.
2710 * After `#+', complete the special keywords like `TYP_TODO' or
2711 `OPTIONS' which set file-specific options for Org-mode. When
2712 the option keyword is already complete, pressing `M-<TAB>'
2713 again will insert example settings for this keyword.
2715 * Elsewhere, complete dictionary words using ispell.
2718 File: org, Node: Customization, Next: Clean view, Prev: Completion, Up: Miscellaneous
2723 There are more than 100 variables that can be used to customize
2724 Org-mode. For the sake of compactness of the manual, we are not
2725 describing the variables here. A structured overview of customization
2726 variables is available with `M-x org-customize'. Or select `Browse Org
2727 Group' from the `Org->Customization' menu.
2730 File: org, Node: Clean view, Next: TTY keys, Prev: Customization, Up: Miscellaneous
2732 9.3 A cleaner outline view
2733 ==========================
2735 Some people find it noisy and distracting that the Org-mode headlines
2736 are starting with a potentially large number of stars. For example in
2737 the example tree from *Note Headlines:::
2739 * Top level headline
2745 * Another top level headline
2747 Unfortunately this is deeply ingrained into the code of Org-mode and
2748 cannot be easily changed. You can, however, modify the display in such
2749 a way that all leading stars become invisible and the outline more easy
2750 to read. To do this, customize the variable `org-hide-leading-stars'
2753 (setq org-hide-leading-stars t)
2755 or change this on a per-file basis with one of the lines (anywhere in
2758 #+STARTUP: showstars
2759 #+STARTUP: hidestars
2760 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
2763 With stars hidden, the tree becomes:
2765 * Top level headline
2771 * Another top level headline
2773 Note that the leading stars are not truly replaced by whitespace, they
2774 are only fontified with the face `org-hide' that uses the background
2775 color as font color. If are are not using either white or black
2776 background, you may have to customize this face to get the wanted
2777 effect. Another possibility is to set this font such that the extra
2778 stars are almost invisible, for example using the color `grey90' on a
2781 Things become cleaner still if you skip all the even levels and use
2782 only odd levels 1, 3, 5..., effectively adding two stars to go from one
2783 outline level to the next:
2785 * Top level headline
2791 * Another top level headline
2793 In order to make the structure editing and export commands handle this
2794 convention correctly, use
2796 (setq org-odd-levels-only t)
2798 or set this on a per-file basis with one of the following lines (don't
2799 forget to press `C-c C-c' with the cursor in the startup line to
2800 activate changes immediately).
2805 You can convert an Org-mode file from single-star-per-level to the
2806 double-star-per-level convention with `M-x org-convert-to-odd-levels
2807 RET' in that file. There is no command for the back conversion because
2808 such a command might merge levels and in this way destroy the structure
2812 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
2814 9.4 Using org-mode on a tty
2815 ===========================
2817 Org-mode uses a number of keys that are not accessible on a tty. This
2818 applies to most special keys like cursor keys, <TAB> and <RET>, when
2819 these are combined with modifier keys like <Meta> and/or <Shift>.
2820 Org-mode uses these bindings because it needs to provide keys for a
2821 large number of commands, and because these keys appeared particularly
2822 easy to remember. In order to still be able to access the core
2823 functionality of Org-mode on a tty, alternative bindings are provided.
2824 Here is a complete list of these bindings, which are obviously more
2825 cumbersome to use. Note that sometimes a work-around can be better.
2826 For example changing a time stamp is really only fun with `S-<cursor>'
2827 keys. On a tty you would rather use `C-c .' to re-insert the
2830 Default Alternative 1 Alternative 2
2831 `S-<TAB>' `C-u <TAB>'
2832 `M-<left>' `C-c C-x l' `<Esc> <left>'
2833 `M-S-<left>'`C-c C-x L'
2834 `M-<right>' `C-c C-x r' `<Esc>
2836 `M-S-<right>'`C-c C-x R'
2837 `M-<up>' `C-c C-x u' `<Esc> <up>'
2838 `M-S-<up>' `C-c C-x U'
2839 `M-<down>' `C-c C-x d' `<Esc> <down>'
2840 `M-S-<down>'`C-c C-x D'
2841 `S-<RET>' `C-c C-x c'
2842 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
2843 `M-S-<RET>' `C-c C-x M'
2846 `S-<right>' `C-c C-x
2854 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
2856 9.5 Frequently asked questions
2857 ==============================
2859 1. Org-mode seems to be a useful default mode for the various
2860 `README' files I have scattered through my directories. How do I
2861 turn it on for all `README' files?
2862 (add-to-list 'auto-mode-alist '("README$" . org-mode))
2864 2. All these stars are driving me mad, I just find the Emacs outlines
2865 unreadable. Can't you just put white space and a single star as a
2866 starter for headlines?
2867 See *Note Clean view::.
2869 3. I would like to have two windows on the same Org-mode file, but
2870 with different outline visibility. Is that possible?
2871 In GNU Emacs, you may use _indirect buffers_ which do exactly
2872 this. See the documentation on the command
2873 `make-indirect-buffer'. In XEmacs, this is currently not possible
2874 because of the different outline implementation.
2876 4. Is there an easy way to insert links to web locations?
2877 Sure, just type or paste them into the buffer. A plain-text
2878 URL-like string is directly interpreted as a link.
2880 5. When I export my TODO list, every TODO item becomes a separate
2881 section. How do I enforce these items to be exported as an
2883 If you plan to use ASCII or HTML export, make sure things you want
2884 to be exported as item lists are level 4 at least, even if that
2885 does mean there is a level jump. For example:
2887 * Todays top priorities
2888 **** TODO write a letter to xyz
2889 **** TODO Finish the paper
2890 **** Pick up kids at the school
2892 Alternatively, if you need a specific value for the heading/item
2893 transition in a particular file, use the `+OPTIONS' line to
2894 configure the `H' switch.
2898 6. I would like to export only a subtree of my file to HTML. How?
2899 If you want to export a subtree, mark the subtree as region and
2900 then export. Marking can be done with `C-c @ C-x C-x', for
2903 7. Org-mode takes over the S-cursor keys. I also want to use
2904 CUA-mode, is there a way to fix this conflict?
2905 Yes, see *Note Interaction::.
2907 8. Is there an easy way to insert an empty table template with a
2908 default number of rows and columns?
2909 To insert an empty table template, just type `|-' and use <TAB>.
2910 The default size can be changed with the variable
2911 `org-table-default-size'. However, just starting to type the
2912 first line is usually much easier.
2914 9. One of my table columns has started to fill up with `#ERROR'.
2916 Org-mode tried to compute the column from other fields using a
2917 formula stored in the `#+TBLFMT:' line just below the table, and
2918 the evaluation of the formula fails. Fix the fields used in the
2919 formula, or fix the formula, or remove it!
2921 10. When I am in the last column of a table and just above a
2922 horizontal line in the table, pressing TAB creates a new table line
2923 before the horizontal line. How can I quickly move to the line
2924 below the horizontal line instead?
2925 Press <down> (to get on the separator line) and then <TAB>. Or
2926 configure the variable `org-table-tab-jumps-over-hlines'.
2928 11. How can I change the indentation of an entire table without fixing
2930 The indentation of a table is set by the first line. So just fix
2931 the indentation of the first line and realign with <TAB>.
2933 12. Is it possible to include entries from org-mode files into my
2935 Since the org-mode agenda is much more powerful and can contain the
2936 diary (*note Calendar/Diary integration::), you should think twice
2937 before deciding to do this. Integrating Org-mode information into
2938 the diary is, however, possible. The following steps are
2939 necessary: Autoload the function `org-diary' as shown above under
2940 *Note Installation and activation::. You also need to use _fancy
2941 diary display_ by setting in `.emacs':
2943 (add-hook 'diary-display-hook 'fancy-diary-display)
2945 Then include the following line into your `~/diary' file, in order
2946 to get the entries from all files listed in the variable
2950 You may also select specific files with
2952 &%%(org-diary) ~/path/to/some/org-file.org
2953 &%%(org-diary) ~/path/to/another/org-file.org
2955 If you now launch the calendar and press `d' to display a diary,
2956 the headlines of entries containing a timestamp, date range,
2957 schedule, or deadline referring to the selected date will be
2958 listed. Just like in Org-mode's agenda view, the diary for
2959 _today_ contains additional entries for overdue deadlines and
2960 scheduled items. See also the documentation of the `org-diary'
2965 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
2967 9.6 Interaction with other packages
2968 ===================================
2970 Org-mode can cooperate with the following packages:
2972 `org-mouse.el' by Piotr Zielinski
2973 This package implements extended mouse functionality for Org-mode.
2974 It allows you to cycle visibility and to edit the document
2975 structure with the mouse. It also provides a context-sensitive
2976 menu that changes depending on the context of a mouse-click. Use
2977 a search engine to find this package on the web.
2979 `table.el' by Takaaki Ota
2980 Org mode cooperates with table.el, see *Note table.el::.
2981 `table.el' is part of Emacs 22.
2983 `calc.el' by Dave Gillespie
2984 Org-mode uses the calc package for implementing spreadsheet
2985 functionality in its tables (*note Table calculations::).
2986 Org-modes checks for the availability of calc by looking for the
2987 function `calc-eval' which should be autoloaded in your setup if
2988 calc has been installed properly. As of Emacs 22, calc is part of
2989 the Emacs distribution. Another possibility for interaction
2990 between the two packages is using calc for embedded calculations.
2991 *Note Embedded Mode: (calc)Embedded Mode.
2993 `constants.el' by Carsten Dominik
2994 In a table formula (*note Table calculations::), it is possible to
2995 use names for natural constants or units. Instead of defining you
2996 own constants in the variable `org-table-formula-constants',
2997 install the `constants' package which defines a large number of
2998 constants and units, and lets you use unit prefixes like `M' for
2999 `Mega' etc. You will need version 2.0 of this package, available
3000 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3001 the function `constants-get', which has to be autoloaded in your
3002 setup. See the installation instructions in the file
3005 `CUA.el' by Kim. F. Storm
3006 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3007 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3008 select and extend the region. If you want to use one of these
3009 packages along with Org-mode, configure the variable
3010 `org-CUA-compatible'. When set, Org-mode will move the following
3011 keybindings in org-mode files, and in the agenda buffer (but not
3012 during date selection).
3013 S-UP -> M-p S-DOWN -> M-n
3014 S-LEFT -> M-- S-RIGHT -> M-+
3016 Yes, these are unfortunately more difficult to remember. If you
3017 want to have other replacement keys, look at the variable
3018 `org-disputed-keys'.
3020 `remember.el' by John Wiegley
3021 Org mode cooperates with remember, see *Note Remember::.
3022 `Remember.el' is not part of Emacs, find it on the web.
3024 `planner.el' by John Wiegley
3025 Planner is another tool to plan work and keep track of tasks.
3026 Planner uses a multi-file approach with project pages and day
3027 pages. Is it based on Emacs-Wiki. If Planner is your primary
3028 tool, it can be useful to display the agenda entries resulting
3029 from org files in day-pages of the planner. This can be done
3030 through the diary of the calendar: integrate org files into the
3031 diary as described above, and then turn on the diary support of
3032 planner. Planner is not part of Emacs, find it on the web.
3035 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3040 Here is a list of things which should work differently, but which I
3041 have found too hard to fix.
3043 * Text in an entry protected with the `QUOTE' keyword should not
3046 * When the application called by `C-c C-o' to open a file link fails
3047 (for example because the application does not exits or refuses to
3048 open the file), it does so silently. No error message is
3051 * Plain list items should be able to hold a TODO item.
3052 Unfortunately this has so many technical problems that I will only
3053 consider this change for the next major release (5.0).
3055 * The remote-editing commands in the agenda buffer cannot be undone
3056 with `undo' called from within the agenda buffer. But you can go
3057 to the corresponding buffer (using <TAB> or <RET> and execute
3060 * Recalculating a table line applies the formulas from left to right.
3061 If a formula uses _calculated_ fields further down the row,
3062 multiple recalculation may be needed to get all fields consistent.
3064 * Under XEmacs, if Org-mode entries are included into the diary, it
3065 is not possible to jump back from the diary to the org file.
3066 Apparently, the text properties are lost when the
3067 fancy-diary-display is used. However, from Org-mode's timeline
3068 and agenda buffers (created with `C-c C-r' and `C-c a'), things do
3071 * You can only make a single word boldface or italic. To emphasize
3072 several words in a row, each must have the emphasize markers, like
3073 in `*three* *bold* *words*'.
3075 * The exporters work well, but could be made more efficient.
3078 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3083 Org-mode was written by Carsten Dominik, who still maintains it at the
3084 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3085 following people (in alphabetic order) have helped the development
3086 along with ideas, suggestions and patches. Many thanks to all of you,
3087 Org-mode would not be what it is without your input.
3089 * Thomas Baumann contributed the code for links to the MH-E email
3092 * Alex Bochannek provided a patch for rounding time stamps.
3094 * Charles Caves' suggestion sparked the implementation of templates
3097 * Pavel Chalmoviansky influenced the agenda treatment of items with
3100 * Sacha Chua suggested to copy linking code from Planner (we did take
3103 * Christian Egli converted the documentation into TeXInfo format,
3104 patched CSS formatting into the HTML exporter, and inspired the
3107 * Kai Grossjohann pointed out key-binding conflicts caused by
3110 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3113 * Tim O'Callaghan suggested in-file links, search options for
3114 general file links, and TAGS.
3116 * Oliver Oppitz suggested multi-state TODO items.
3118 * Pete Phillips helped the development of the TAGS feature.
3120 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3123 * Kevin Rogers contributed code to access VM files on remote hosts.
3125 * Philip Rooke created the Org-mode reference card and provided lots
3128 * Christian Schlauer proposed angular brackets around links, among
3131 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3132 `organizer-mode.el'.
3134 * Ju"rgen Vollmer contributed code generating the table of contents
3137 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3139 * David Wainberg suggested archiving, and improvements to the linking
3142 * Scheduling TODO items was inspired by John Wiegley's `planner.el'.
3144 * Carsten Wimmer suggested some changes and helped fix a bug in
3147 * Roland Winkler requested additional keybindings to make Org-mode
3150 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3154 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3162 * acknowledgments: Acknowledgments. (line 6)
3163 * active region <1>: HTML export. (line 10)
3164 * active region <2>: ASCII export. (line 6)
3165 * active region <3>: Built-in table editor.
3167 * active region: Structure editing. (line 46)
3168 * agenda: Weekly/Daily Agenda. (line 6)
3169 * agenda commands, custom: Agenda dispatcher. (line 6)
3170 * agenda dispatcher: Agenda dispatcher. (line 6)
3171 * agenda files, removing buffers: Agenda commands. (line 187)
3172 * agenda views: Agenda Views. (line 6)
3173 * agenda, for single file: Timeline. (line 6)
3174 * applescript, for calendar update: iCalendar export. (line 38)
3175 * archive locations: Archiving. (line 13)
3176 * archiving: Archiving. (line 6)
3177 * ASCII export: ASCII export. (line 6)
3178 * author: Feedback. (line 6)
3179 * autoload: Installation and activation.
3181 * BBDB links: External links. (line 6)
3182 * bold text: HTML formatting. (line 13)
3183 * bug reports: Feedback. (line 6)
3184 * bugs: Bugs. (line 6)
3185 * calc package: Table calculations. (line 6)
3186 * calc.el: Interaction. (line 17)
3187 * calculations, in tables <1>: Table calculations. (line 6)
3188 * calculations, in tables: Built-in table editor.
3190 * calendar integration: Calendar/Diary integration.
3192 * calendar, for selecting date: Creating timestamps. (line 68)
3193 * CamelCase link completion: Completion. (line 6)
3194 * CamelCase links: Internal links. (line 6)
3195 * CamelCase links, completion of: CamelCase links. (line 6)
3196 * category: Categories. (line 6)
3197 * children, subtree visibility state: Visibility cycling. (line 10)
3198 * clean outline view: Clean view. (line 6)
3199 * column formula: Column formulas. (line 6)
3200 * commands, in agenda buffer: Agenda commands. (line 6)
3201 * comment lines: Comment lines. (line 6)
3202 * completion, of CamelCase links <1>: Completion. (line 6)
3203 * completion, of CamelCase links: CamelCase links. (line 6)
3204 * completion, of dictionary words: Completion. (line 6)
3205 * completion, of file names: Managing links. (line 23)
3206 * completion, of links: Managing links. (line 23)
3207 * completion, of option keywords <1>: Completion. (line 6)
3208 * completion, of option keywords: Export options. (line 6)
3209 * Completion, of option keywords: Per file keywords. (line 17)
3210 * completion, of tags <1>: Completion. (line 6)
3211 * completion, of tags: Tags. (line 34)
3212 * completion, of TeX symbols <1>: Completion. (line 6)
3213 * completion, of TeX symbols: HTML formatting. (line 17)
3214 * completion, of TODO keywords <1>: Completion. (line 6)
3215 * completion, of TODO keywords: Workflow states. (line 12)
3216 * constants, in calculations: Formula syntax. (line 26)
3217 * constants.el: Interaction. (line 27)
3218 * contents, global visibility state: Visibility cycling. (line 17)
3219 * copying, of subtrees: Structure editing. (line 6)
3220 * creating timestamps: Creating timestamps. (line 6)
3221 * CUA.el: Interaction. (line 39)
3222 * custom agenda commands: Agenda dispatcher. (line 6)
3223 * customization: Customization. (line 6)
3224 * cutting, of subtrees: Structure editing. (line 6)
3225 * cycling, of TODO states: TODO basics. (line 13)
3226 * cycling, visibility: Visibility cycling. (line 6)
3227 * date stamps: Time stamps. (line 6)
3228 * date, reading in minibuffer: Creating timestamps. (line 68)
3229 * DEADLINE keyword: Time stamps. (line 27)
3230 * deadlines: Time stamps. (line 6)
3231 * demotion, of subtrees: Structure editing. (line 6)
3232 * diary entries, creating from agenda: Agenda commands. (line 145)
3233 * diary integration: Calendar/Diary integration.
3235 * dictionary word completion: Completion. (line 6)
3236 * dispatching agenda commands: Agenda dispatcher. (line 6)
3237 * document structure: Document Structure. (line 6)
3238 * DONE, final TODO keyword: Per file keywords. (line 20)
3239 * editing tables: Tables. (line 6)
3240 * editing, of table formulas: Editing/debugging formulas.
3242 * emphasized text: Export options. (line 21)
3243 * evaluate time range: Creating timestamps. (line 63)
3244 * exporting: Exporting. (line 6)
3245 * exporting a subtree: FAQ. (line 46)
3246 * exporting, not: Comment lines. (line 6)
3247 * extended TODO keywords: TODO extensions. (line 6)
3248 * external links: External links. (line 6)
3249 * FAQ: FAQ. (line 6)
3250 * feedback: Feedback. (line 6)
3251 * file links: External links. (line 6)
3252 * file links, searching: Search Options. (line 6)
3253 * file name completion: Managing links. (line 23)
3254 * files, adding to agenda list: Agenda files. (line 12)
3255 * filing subtrees: Archiving. (line 6)
3256 * fixed width: HTML formatting. (line 28)
3257 * fixed-width sections: Export options. (line 21)
3258 * folded, subtree visibility state: Visibility cycling. (line 10)
3259 * folding, sparse trees: Sparse trees. (line 6)
3260 * following links: Managing links. (line 35)
3261 * format specifier: Formula syntax. (line 34)
3262 * formula editing: Editing/debugging formulas.
3264 * formula syntax: Formula syntax. (line 6)
3265 * formula, for named table field: Named-field formulas.
3267 * formula, for table column: Column formulas. (line 6)
3268 * formula, in tables: Built-in table editor.
3270 * global keybindings: Installation and activation.
3272 * global TODO list: Global TODO list. (line 6)
3273 * global visibility states: Visibility cycling. (line 17)
3274 * GNUS links: External links. (line 6)
3275 * hand-formatted lists: HTML formatting. (line 9)
3276 * headline levels: Export options. (line 21)
3277 * headline levels, for exporting <1>: HTML export. (line 22)
3278 * headline levels, for exporting: ASCII export. (line 12)
3279 * headline navigation: Motion. (line 6)
3280 * headline tagging: Tags. (line 6)
3281 * headline, promotion and demotion: Structure editing. (line 6)
3282 * headlines: Headlines. (line 6)
3283 * hide text: Visibility cycling. (line 6)
3284 * hiding leading stars: Clean view. (line 6)
3285 * HTML export: HTML export. (line 6)
3286 * HTML tags: HTML formatting. (line 33)
3287 * hyperlinks: Hyperlinks. (line 6)
3288 * iCalendar export: iCalendar export. (line 6)
3289 * indentation, of tables: FAQ. (line 77)
3290 * indirect buffers: FAQ. (line 18)
3291 * inheritance, of tags: Tags. (line 13)
3292 * inserting links: Managing links. (line 23)
3293 * installation: Installation and activation.
3295 * internal links: Internal links. (line 6)
3296 * introduction: Introduction. (line 6)
3297 * italic text: HTML formatting. (line 13)
3298 * jumping, to headlines: Motion. (line 6)
3299 * keybindings, global: Installation and activation.
3301 * keyword options: Per file keywords. (line 6)
3302 * linebreak preservation: Export options. (line 21)
3303 * link completion: Managing links. (line 23)
3304 * links, external: External links. (line 6)
3305 * links, internal: Internal links. (line 6)
3306 * links, returning to: Managing links. (line 65)
3307 * lists, hand-formatted: HTML formatting. (line 9)
3308 * lists, ordered: Plain Lists. (line 6)
3309 * lists, plain: Plain Lists. (line 6)
3310 * logging, of progress: Progress logging. (line 6)
3311 * maintainer: Feedback. (line 6)
3312 * make-indirect-buffer: FAQ. (line 18)
3313 * mark ring: Managing links. (line 61)
3314 * marking characters, tables: Advanced features. (line 33)
3315 * matching, of tags: Matching headline tags.
3317 * matching, tags: Tags. (line 6)
3318 * MH-E links: External links. (line 6)
3319 * minor mode for tables: orgtbl-mode. (line 6)
3320 * mode, for calc: Formula syntax. (line 34)
3321 * motion, between headlines: Motion. (line 6)
3322 * name, of column or field: Formula syntax. (line 26)
3323 * named field formula: Named-field formulas.
3325 * names as TODO keywords: TODO types. (line 6)
3326 * occur, command: Sparse trees. (line 6)
3327 * option keyword completion: Completion. (line 6)
3328 * options, for customization: Customization. (line 6)
3329 * options, for export: Export options. (line 6)
3330 * ordered lists: Plain Lists. (line 6)
3331 * org-agenda, command: Weekly/Daily Agenda. (line 9)
3332 * org-mode, turning on: Installation and activation.
3334 * org-mouse.el: Interaction. (line 8)
3335 * orgtbl-mode: orgtbl-mode. (line 6)
3336 * outline tree: Headlines. (line 6)
3337 * outline-mode: Outlines. (line 6)
3338 * outlines: Outlines. (line 6)
3339 * overview, global visibility state: Visibility cycling. (line 17)
3340 * packages, interaction with other: Interaction. (line 6)
3341 * pasting, of subtrees: Structure editing. (line 6)
3342 * per file keywords: Per file keywords. (line 6)
3343 * plain lists: Plain Lists. (line 6)
3344 * planner.el: Interaction. (line 58)
3345 * printing sparse trees: Sparse trees. (line 37)
3346 * priorities: Priorities. (line 6)
3347 * priorities, of agenda items: Sorting of agenda items.
3349 * progress logging: Progress logging. (line 6)
3350 * promotion, of subtrees: Structure editing. (line 6)
3351 * quoted html tags: Export options. (line 21)
3352 * ranges, time: Time stamps. (line 6)
3353 * recomputing table fields: Column formulas. (line 27)
3354 * region, active <1>: HTML export. (line 10)
3355 * region, active <2>: ASCII export. (line 6)
3356 * region, active <3>: Built-in table editor.
3358 * region, active: Structure editing. (line 46)
3359 * remember.el <1>: Interaction. (line 39)
3360 * remember.el: Remember. (line 6)
3361 * RMAIL links: External links. (line 6)
3362 * SCHEDULED keyword: Time stamps. (line 39)
3363 * scheduling: Time stamps. (line 6)
3364 * search option in file links: Search Options. (line 6)
3365 * section-numbers: Export options. (line 21)
3366 * SHELL links: External links. (line 6)
3367 * show all, command: Visibility cycling. (line 23)
3368 * show all, global visibility state: Visibility cycling. (line 17)
3369 * show hidden text: Visibility cycling. (line 6)
3370 * single file summary: Timeline. (line 6)
3371 * sorting, of agenda items: Sorting of agenda items.
3373 * sparse tree, for deadlines: Creating timestamps. (line 38)
3374 * sparse tree, for TODO: TODO basics. (line 18)
3375 * sparse tree, tag based: Tags. (line 6)
3376 * sparse trees: Sparse trees. (line 6)
3377 * spreadsheet capabilities: Table calculations. (line 6)
3378 * storing links: Managing links. (line 9)
3379 * structure editing: Structure editing. (line 6)
3380 * structure of document: Document Structure. (line 6)
3381 * subtree visibility states: Visibility cycling. (line 10)
3382 * subtree, cut and paste: Structure editing. (line 6)
3383 * subtree, subtree visibility state: Visibility cycling. (line 10)
3384 * subtrees, cut and paste: Structure editing. (line 6)
3385 * summary: Summary. (line 6)
3386 * syntax, of formulas: Formula syntax. (line 6)
3387 * table editor, builtin: Built-in table editor.
3389 * table editor, table.el: table.el. (line 6)
3390 * table of contents: Export options. (line 21)
3391 * table, empty template: FAQ. (line 56)
3392 * table.el <1>: Interaction. (line 13)
3393 * table.el: table.el. (line 6)
3394 * tables <1>: Export options. (line 21)
3395 * tables: Tables. (line 6)
3396 * tables, export to HTML: HTML formatting. (line 24)
3397 * tag completion: Completion. (line 6)
3398 * tags: Tags. (line 6)
3399 * tags view: Matching headline tags.
3401 * templates, for remember: Remember. (line 26)
3402 * TeX interpretation: HTML formatting. (line 15)
3403 * TeX macros: Export options. (line 21)
3404 * TeX symbol completion: Completion. (line 6)
3405 * TeX-like syntax for sub- and superscripts: Export options. (line 21)
3406 * thanks: Acknowledgments. (line 6)
3407 * time stamps: Time stamps. (line 6)
3408 * time, reading in minibuffer: Creating timestamps. (line 68)
3409 * time-sorted view: Timeline. (line 6)
3410 * timeline, single file: Timeline. (line 6)
3411 * timerange: Time stamps. (line 18)
3412 * timestamp: Time stamps. (line 12)
3413 * timestamps, creating: Creating timestamps. (line 6)
3414 * TODO items: TODO items. (line 6)
3415 * TODO keywords completion: Completion. (line 6)
3416 * TODO list, global: Global TODO list. (line 6)
3417 * TODO types: TODO types. (line 6)
3418 * TODO workflow: Workflow states. (line 6)
3419 * transient-mark-mode <1>: HTML export. (line 10)
3420 * transient-mark-mode <2>: ASCII export. (line 6)
3421 * transient-mark-mode <3>: Built-in table editor.
3423 * transient-mark-mode: Structure editing. (line 46)
3424 * trees, sparse: Sparse trees. (line 6)
3425 * trees, visibility: Visibility cycling. (line 6)
3426 * tty keybindings: TTY keys. (line 6)
3427 * types as TODO keywords: TODO types. (line 6)
3428 * underlined text: HTML formatting. (line 13)
3429 * URL links: External links. (line 6)
3430 * URL, paste into buffer: FAQ. (line 24)
3431 * USENET links: External links. (line 6)
3432 * variables, for customization: Customization. (line 6)
3433 * vectors, in table calculations: Formula syntax. (line 23)
3434 * visibility cycling: Visibility cycling. (line 6)
3435 * visible text, printing: Sparse trees. (line 37)
3436 * VM links: External links. (line 6)
3437 * WANDERLUST links: External links. (line 6)
3438 * workflow states as TODO keywords: Workflow states. (line 6)
3441 File: org, Node: Key Index, Prev: Index, Up: Top
3449 * +: Agenda commands. (line 118)
3450 * ,: Agenda commands. (line 110)
3451 * -: Agenda commands. (line 124)
3452 * .: Agenda commands. (line 89)
3453 * :: Agenda commands. (line 107)
3454 * <: Creating timestamps. (line 75)
3455 * <left>: Agenda commands. (line 86)
3456 * <RET> <1>: Agenda commands. (line 41)
3457 * <RET> <2>: Creating timestamps. (line 100)
3458 * <RET>: Built-in table editor.
3460 * <right>: Agenda commands. (line 81)
3461 * <SPC>: Agenda commands. (line 28)
3462 * <TAB> <1>: Agenda commands. (line 35)
3463 * <TAB> <2>: Built-in table editor.
3465 * <TAB> <3>: Plain Lists. (line 37)
3466 * <TAB>: Visibility cycling. (line 10)
3467 * > <1>: Agenda commands. (line 140)
3468 * >: Creating timestamps. (line 76)
3469 * C: Agenda commands. (line 170)
3470 * c: Agenda commands. (line 154)
3471 * C-#: Built-in table editor.
3473 * C-,: Agenda files. (line 18)
3474 * C-c !: Creating timestamps. (line 21)
3475 * C-c $: Archiving. (line 9)
3476 * C-c %: Managing links. (line 61)
3477 * C-c &: Managing links. (line 65)
3478 * C-c ' <1>: Editing/debugging formulas.
3480 * C-c ': Built-in table editor.
3482 * C-c *: Built-in table editor.
3484 * C-c +: Built-in table editor.
3486 * C-c ,: Priorities. (line 18)
3487 * C-c -: Built-in table editor.
3489 * C-c .: Creating timestamps. (line 10)
3490 * C-c /: Sparse trees. (line 15)
3491 * C-c :: HTML export. (line 17)
3492 * C-c ;: Comment lines. (line 12)
3493 * C-c <: Creating timestamps. (line 25)
3494 * C-c =: Built-in table editor.
3496 * C-c >: Creating timestamps. (line 29)
3497 * C-c ? <1>: Editing/debugging formulas.
3499 * C-c ?: Built-in table editor.
3501 * C-c [: Agenda files. (line 12)
3502 * C-c \: Tags. (line 42)
3503 * C-c ]: Agenda files. (line 15)
3504 * C-c ^: Built-in table editor.
3506 * C-c a a: Weekly/Daily Agenda. (line 9)
3507 * C-c a C: Agenda dispatcher. (line 30)
3508 * C-c a M: Matching headline tags.
3510 * C-c a m: Matching headline tags.
3512 * C-c a M: Tags. (line 49)
3513 * C-c a m: Tags. (line 45)
3514 * C-c a T: Global TODO list. (line 15)
3515 * C-c a t <1>: Global TODO list. (line 9)
3516 * C-c a t: TODO basics. (line 25)
3517 * C-c C-a: Visibility cycling. (line 23)
3518 * C-c C-b: Motion. (line 15)
3519 * C-c C-c <1>: table.el. (line 6)
3520 * C-c C-c <2>: Editing/debugging formulas.
3522 * C-c C-c <3>: Built-in table editor.
3524 * C-c C-c <4>: Plain Lists. (line 61)
3525 * C-c C-c: Tags. (line 33)
3526 * C-c C-d: Creating timestamps. (line 37)
3527 * C-c C-f: Motion. (line 12)
3528 * C-c C-j: Motion. (line 21)
3529 * C-c C-l: Managing links. (line 23)
3530 * C-c C-n: Motion. (line 8)
3531 * C-c C-o <1>: Creating timestamps. (line 33)
3532 * C-c C-o: Managing links. (line 35)
3533 * C-c C-p: Motion. (line 9)
3534 * C-c C-q <1>: Editing/debugging formulas.
3536 * C-c C-q: Built-in table editor.
3538 * C-c C-r: Timeline. (line 13)
3539 * C-c C-s: Creating timestamps. (line 47)
3540 * C-c C-t: TODO basics. (line 13)
3541 * C-c C-u: Motion. (line 18)
3542 * C-c C-v: TODO basics. (line 18)
3543 * C-c C-w: Creating timestamps. (line 38)
3544 * C-c C-x a: ASCII export. (line 6)
3545 * C-c C-x b: HTML export. (line 11)
3546 * C-c C-x c: iCalendar export. (line 20)
3547 * C-c C-x C-c: Agenda commands. (line 177)
3548 * C-c C-x C-i: iCalendar export. (line 15)
3549 * C-c C-x C-k: Structure editing. (line 31)
3550 * C-c C-x C-w <1>: Built-in table editor.
3552 * C-c C-x C-w: Structure editing. (line 31)
3553 * C-c C-x C-y <1>: Built-in table editor.
3555 * C-c C-x C-y: Structure editing. (line 38)
3556 * C-c C-x h: HTML export. (line 10)
3557 * C-c C-x i: iCalendar export. (line 13)
3558 * C-c C-x M-w <1>: Built-in table editor.
3560 * C-c C-x M-w: Structure editing. (line 35)
3561 * C-c C-x t: HTML export. (line 14)
3562 * C-c C-x v: Sparse trees. (line 37)
3563 * C-c C-y: Creating timestamps. (line 63)
3564 * C-c l: Managing links. (line 9)
3565 * C-c |: Built-in table editor.
3567 * C-c ~: table.el. (line 18)
3568 * C-u C-c .: Creating timestamps. (line 16)
3569 * C-u C-c =: Built-in table editor.
3571 * D: Agenda commands. (line 66)
3572 * d: Agenda commands. (line 63)
3573 * f: Agenda commands. (line 44)
3574 * g: Agenda commands. (line 70)
3575 * H: Agenda commands. (line 174)
3576 * i: Agenda commands. (line 145)
3577 * l: Agenda commands. (line 49)
3578 * L: Agenda commands. (line 32)
3579 * M: Agenda commands. (line 161)
3580 * M-<down>: Built-in table editor.
3582 * M-<left> <1>: Built-in table editor.
3584 * M-<left>: Structure editing. (line 13)
3585 * M-<RET> <1>: Plain Lists. (line 42)
3586 * M-<RET>: Structure editing. (line 6)
3587 * M-<right> <1>: Built-in table editor.
3589 * M-<right>: Structure editing. (line 16)
3590 * M-<TAB> <1>: Completion. (line 10)
3591 * M-<TAB> <2>: Per file keywords. (line 17)
3592 * M-<TAB>: Tags. (line 28)
3593 * M-<up>: Built-in table editor.
3595 * M-S-<down> <1>: Built-in table editor.
3597 * M-S-<down> <2>: Plain Lists. (line 46)
3598 * M-S-<down>: Structure editing. (line 28)
3599 * M-S-<left> <1>: Creating timestamps. (line 97)
3600 * M-S-<left> <2>: Built-in table editor.
3602 * M-S-<left> <3>: Plain Lists. (line 52)
3603 * M-S-<left>: Structure editing. (line 19)
3604 * M-S-<RET>: Structure editing. (line 10)
3605 * M-S-<right> <1>: Creating timestamps. (line 94)
3606 * M-S-<right> <2>: Built-in table editor.
3608 * M-S-<right> <3>: Plain Lists. (line 52)
3609 * M-S-<right>: Structure editing. (line 22)
3610 * M-S-<up> <1>: Built-in table editor.
3612 * M-S-<up> <2>: Plain Lists. (line 46)
3613 * M-S-<up>: Structure editing. (line 25)
3614 * mouse-1 <1>: Agenda commands. (line 35)
3615 * mouse-1 <2>: Creating timestamps. (line 79)
3616 * mouse-1: Managing links. (line 53)
3617 * mouse-2 <1>: Agenda commands. (line 35)
3618 * mouse-2: Managing links. (line 53)
3619 * mouse-3 <1>: Agenda commands. (line 28)
3620 * mouse-3: Managing links. (line 58)
3621 * n: Agenda commands. (line 19)
3622 * o: Agenda commands. (line 57)
3623 * P: Agenda commands. (line 115)
3624 * p: Agenda commands. (line 20)
3625 * q: Agenda commands. (line 184)
3626 * r <1>: Agenda commands. (line 74)
3627 * r: Global TODO list. (line 21)
3628 * S: Agenda commands. (line 165)
3629 * S-<down> <1>: Agenda commands. (line 124)
3630 * S-<down> <2>: Creating timestamps. (line 55)
3631 * S-<down>: Priorities. (line 25)
3632 * S-<left> <1>: Agenda commands. (line 136)
3633 * S-<left>: Creating timestamps. (line 50)
3634 * S-<RET>: Built-in table editor.
3636 * S-<right> <1>: Agenda commands. (line 128)
3637 * S-<right>: Creating timestamps. (line 50)
3638 * S-<TAB> <1>: Built-in table editor.
3640 * S-<TAB>: Visibility cycling. (line 17)
3641 * S-<up> <1>: Agenda commands. (line 118)
3642 * S-<up> <2>: Creating timestamps. (line 55)
3643 * S-<up>: Priorities. (line 25)
3644 * T: Agenda commands. (line 102)
3645 * t: Agenda commands. (line 98)
3646 * w: Agenda commands. (line 60)
3647 * x: Agenda commands. (line 187)
3653 Node: Introduction
\x7f6836
3654 Node: Summary
\x7f7150
3655 Node: Installation and activation
\x7f9262
3656 Node: Feedback
\x7f10931
3657 Node: Document Structure
\x7f11716
3658 Node: Outlines
\x7f12558
3659 Node: Headlines
\x7f13218
3660 Node: Visibility cycling
\x7f13844
3661 Node: Motion
\x7f15031
3662 Node: Structure editing
\x7f15815
3663 Node: Archiving
\x7f17558
3664 Node: Sparse trees
\x7f18418
3665 Ref: Sparse trees-Footnote-1
\x7f20441
3666 Ref: Sparse trees-Footnote-2
\x7f20533
3668 Node: Plain Lists
\x7f23739
3669 Ref: Plain Lists-Footnote-1
\x7f26487
3670 Node: Tables
\x7f26844
3671 Node: Built-in table editor
\x7f27331
3672 Node: Table calculations
\x7f34874
3673 Node: Formula syntax
\x7f36057
3674 Ref: Formula syntax-Footnote-1
\x7f38990
3675 Node: Column formulas
\x7f39289
3676 Node: Advanced features
\x7f41051
3677 Node: Named-field formulas
\x7f44305
3678 Node: Editing/debugging formulas
\x7f44945
3679 Node: Appetizer
\x7f46703
3680 Node: orgtbl-mode
\x7f47805
3681 Node: table.el
\x7f48295
3682 Node: Hyperlinks
\x7f49272
3683 Node: Internal links
\x7f49838
3684 Node: Radio targets
\x7f51588
3685 Node: CamelCase links
\x7f52303
3686 Node: External links
\x7f52876
3687 Ref: External links-Footnote-1
\x7f54802
3688 Node: Managing links
\x7f54941
3689 Node: Search Options
\x7f58276
3690 Ref: Search Options-Footnote-1
\x7f59589
3691 Node: Remember
\x7f59670
3692 Ref: Remember-Footnote-1
\x7f63554
3693 Node: TODO items
\x7f63678
3694 Node: TODO basics
\x7f64601
3695 Node: Progress logging
\x7f66114
3696 Node: TODO extensions
\x7f66901
3697 Node: Workflow states
\x7f67589
3698 Node: TODO types
\x7f68457
3699 Ref: TODO types-Footnote-1
\x7f70115
3700 Node: Per file keywords
\x7f70197
3701 Ref: Per file keywords-Footnote-1
\x7f71650
3702 Node: Priorities
\x7f71878
3703 Node: Timestamps
\x7f73087
3704 Node: Time stamps
\x7f73416
3705 Node: Creating timestamps
\x7f75431
3706 Node: Agenda Views
\x7f78560
3707 Node: Agenda files
\x7f80087
3708 Ref: Agenda files-Footnote-1
\x7f81049
3709 Ref: Agenda files-Footnote-2
\x7f81198
3710 Node: Agenda dispatcher
\x7f81390
3711 Node: Weekly/Daily Agenda
\x7f83522
3712 Node: Categories
\x7f84657
3713 Node: Time-of-day specifications
\x7f85303
3714 Node: Calendar/Diary integration
\x7f87279
3715 Node: Sorting of agenda items
\x7f88658
3716 Node: Global TODO list
\x7f89490
3717 Node: Matching headline tags
\x7f90905
3718 Node: Timeline
\x7f91848
3719 Node: Agenda commands
\x7f92723
3720 Node: Exporting
\x7f97978
3721 Node: ASCII export
\x7f98550
3722 Node: HTML export
\x7f99386
3723 Node: HTML formatting
\x7f100503
3724 Node: Export options
\x7f102135
3725 Node: Comment lines
\x7f104328
3726 Node: iCalendar export
\x7f104798
3727 Node: Miscellaneous
\x7f106593
3728 Node: Completion
\x7f107218
3729 Node: Customization
\x7f108212
3730 Node: Clean view
\x7f108658
3731 Node: TTY keys
\x7f111309
3733 Node: Interaction
\x7f117794
3734 Node: Bugs
\x7f121202
3735 Node: Acknowledgments
\x7f122944
3736 Node: Index
\x7f125364
3737 Node: Key Index
\x7f145568