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.20).
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.20).
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 * Tags:: Tagging headlines and matching sets of tags
55 * Agenda Views:: Collecting information into views
56 * Exporting:: Sharing and publishing of notes
57 * Miscellaneous:: All the rest which did not fit elsewhere
58 * Index:: The fast road to specific information
59 * Key Index:: Key bindings and where they are described
61 --- The Detailed Node Listing ---
65 * Summary:: Brief summary of what Org-mode does
66 * Installation and activation:: How to install Org-mode
67 * Feedback:: Bug reports, ideas, patches etc.
71 * Outlines:: Org-mode is based on outline-mode
72 * Headlines:: How to typeset org-tree headlines
73 * Visibility cycling:: Show and hide, much simplified
74 * Motion:: Jumping to other headlines
75 * Structure editing:: Changing sequence and level of headlines
76 * Archiving:: Move done task trees to a different place
77 * Sparse trees:: Matches embedded in context
78 * Plain Lists:: Editing hand-formatted lists
82 * Built-in table editor:: Simple tables
83 * Narrow columns:: Stop wasting space in tables
84 * Table calculations:: Compute a field from other fields
85 * orgtbl-mode:: The table editor as minor mode
86 * table.el:: Complex tables
88 Calculations in tables
90 * Formula syntax:: How to write a formula
91 * Column formulas:: Formulas valid for all fields in a column
92 * Advanced features:: Field names, parameters and automatic recalc
93 * Named-field formulas:: Formulas valid in single fields
94 * Editing/debugging formulas:: Changing a stored formula
95 * Appetizer:: Taste the power of calc
99 * Link format:: How links in Org-mode are formatted
100 * Internal links:: Links to other places in the current file
101 * External links:: URL-like links to the world
102 * Managing links:: Creating, inserting and following
103 * Search Options:: Linking to a specific location
104 * Remember:: Org-trees store quick notes
108 * Radio targets:: Make targets trigger links in plain text.
109 * CamelCase links:: Activating CamelCase words as links
113 * TODO basics:: Marking and displaying TODO entries
114 * Progress logging:: Document your productivity
115 * TODO extensions:: Workflow and assignments
116 * Priorities:: Some things are more important than others
118 Extended use of TODO keywords
120 * Workflow states:: From TODO to DONE in steps
121 * TODO types:: I do this, Fred the rest
122 * Per file keywords:: Different files, different requirements
126 * Time stamps:: Assigning a time to a tree entry
127 * Creating timestamps:: Commands which insert timestamps
131 * Tag inheritance:: Tags use the tree structure of the outline
132 * Setting tags:: How to assign tags to a headline
133 * Tag searches:: Searching for combinations of tags
137 * Agenda files:: Files being searched for agenda information
138 * Agenda dispatcher:: Keyboard access to agenda views
139 * Weekly/Daily Agenda:: The calendar page with current tasks
140 * Global TODO list:: All unfinished action items
141 * Matching headline tags:: Structured information with fine-tuned search
142 * Timeline:: Time-sorted view for single file
143 * Agenda commands:: Remote editing of org trees
145 The weekly/daily agenda
147 * Categories:: Not all tasks are equal
148 * Time-of-day specifications:: How the agenda knows the time
149 * Calendar/Diary integration:: Integrating Anniversaries and more
150 * Sorting of agenda items:: The order of things
154 * ASCII export:: Export as a structured ASCII file
155 * HTML export:: Export as an HTML file
156 * iCalendar export:: Create calendar entries.
160 * HTML formatting:: Interpretation of the buffer content
161 * Export options:: How to influence exports
162 * Comment lines:: Lines which will not be exported
166 * Completion:: M-TAB knows what you need
167 * Customization:: Adapting Org-mode to your taste
168 * Clean view:: Getting rid of leading stars in the outline
169 * TTY keys:: Using Org-mode on a tty
170 * FAQ:: Frequently asked questions
171 * Interaction:: Other Emacs packages
172 * Bugs:: Things which do not work perfectly
173 * Acknowledgments:: These people provided feedback and more
176 File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
183 * Summary:: Brief summary of what Org-mode does
184 * Installation and activation:: How to install Org-mode
185 * Feedback:: Bug reports, ideas, patches etc.
188 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
193 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
194 project planning with a fast and effective plain-text system.
196 Org-mode develops organizational tasks around NOTES files that
197 contain information about projects as plain text. Org-mode is
198 implemented on top of outline-mode, which makes it possible to keep the
199 content of large files well structured. Visibility cycling and
200 structure editing help to work with the tree. Tables are easily
201 created with a built-in table editor. Org-mode supports ToDo items,
202 deadlines, time stamps, and scheduling. It dynamically compiles
203 entries into an agenda that utilizes and smoothly integrates much of
204 the Emacs calendar and diary. Plain text URL-like links connect to
205 websites, emails, Usenet messages, BBDB entries, and any files related
206 to the projects. For printing and sharing of notes, an Org-mode file
207 can be exported as a structured ASCII file, as HTML, or (todo and
208 agenda items only) as an iCalendar file.
210 Org-mode keeps simple things simple. When first fired up, it should
211 feel like a simple but easy to use outliner. Complexity is not
212 imposed, but a large amount of functionality is available when you need
213 it. Org-mode can be used on different levels and in different ways,
216 * as an outline extension with visibility cycling and structure editing
217 * as an ASCII system and table editor for taking structured notes
218 * as an ASCII table editor with spreadsheet-like capabilities
219 * as a simple hypertext system, with HTML export
220 * as a TODO list editor
221 * as a full agenda and planner with deadlines and work scheduling
223 The Org-mode table editor can be integrated into any major mode by
224 activating the minor Orgtbl-mode.
226 There is a website for Org-mode which provides links to the newest
227 version of Org-mode, as well as additional information, screen shots
228 and example files. This page is located at
229 `http://www.astro.uva.nl/~dominik/Tools/org/'.
232 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
234 1.2 Installation and Activation
235 ===============================
237 If Org-mode is part of the Emacs distribution or an XEmacs package, you
238 only need to copy the following lines to your `.emacs' file. The last
239 two lines define _global_ keys for the commands `org-store-link' and
240 `org-agenda' - please choose suitable keys yourself.
242 ;; The following lines are always needed. Choose your own keys.
243 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
244 (define-key global-map "\C-cl" 'org-store-link)
245 (define-key global-map "\C-ca" 'org-agenda)
247 If you have downloaded Org-mode from the Web, you must byte-compile
248 `org.el' and put it on your load path. In addition to the Emacs Lisp
249 lines above, you also need to add the following lines to `.emacs':
251 ;; These lines only if org-mode is not part of the X/Emacs distribution.
252 (autoload 'org-mode "org" "Org mode" t)
253 (autoload 'org-diary "org" "Diary entries from Org mode")
254 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
255 (autoload 'org-store-link "org" "Store a link to the current location" t)
256 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
257 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
259 With this setup, all files with extension `.org' will be put into
260 Org-mode. As an alternative, make the first line of a file look like
263 MY PROJECTS -*- mode: org; -*-
265 which will select Org-mode for this buffer no matter what the file's
266 name is. See also the variable `org-insert-mode-line-in-empty-file'.
269 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
274 If you find problems with Org-mode, or if you have questions, remarks,
275 or ideas about it, please contact the maintainer Carsten Dominik at
276 <dominik@science.uva.nl>.
278 For bug reports, please provide as much information as possible,
279 including the version information of Emacs (`C-h v emacs-version
280 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
281 Org-mode related setup in `.emacs'. If an error occurs, a traceback
282 can be very useful. Often a small example file helps, along with clear
285 1. What exactly did you do?
287 2. What did you expect to happen?
289 3. What happened instead?
290 Thank you for helping to improve this mode.
293 File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
298 Org-mode is based on outline mode and provides flexible commands to
299 edit the structure of the document.
303 * Outlines:: Org-mode is based on outline-mode
304 * Headlines:: How to typeset org-tree headlines
305 * Visibility cycling:: Show and hide, much simplified
306 * Motion:: Jumping to other headlines
307 * Structure editing:: Changing sequence and level of headlines
308 * Archiving:: Move done task trees to a different place
309 * Sparse trees:: Matches embedded in context
310 * Plain Lists:: Editing hand-formatted lists
313 File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
318 Org-mode is implemented on top of outline-mode. Outlines allow to
319 organize a document in a hierarchical structure, which (at least for
320 me) is the best representation of notes and thoughts. Overview over
321 this structure is achieved by folding (hiding) large parts of the
322 document to show only the general document structure and the parts
323 currently being worked on. Org-mode greatly simplifies the use of
324 outlines by compressing the entire show/hide functionality into a
325 single command `org-cycle', which is bound to the <TAB> key.
328 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
333 Headlines define the structure of an outline tree. The headlines in
334 Org-mode start with one or more stars, on the left margin. For example:
342 * Another top level headline
344 Some people find the many stars too noisy and would prefer an outline
345 that has whitespace followed by a single star as headline starters.
346 *Note Clean view:: describes a setup to realize this.
349 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
351 2.3 Visibility cycling
352 ======================
354 Outlines make it possible to hide parts of the text in the buffer.
355 Org-mode uses a single command bound to the <TAB> key to change the
356 visibility in the buffer.
359 Rotate current subtree between the states
361 ,-> FOLDED -> CHILDREN -> SUBTREE --.
362 '-----------------------------------'
364 At the beginning of the buffer (or when called with `C-u'), this
365 does the same as the command `S-<TAB>' below.
368 Rotate the entire buffer between the states
370 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
371 '--------------------------------------'
373 Note that inside tables, `S-<TAB>' jumps to the previous field.
378 When Emacs first visits an Org-mode file, the global state is set to
379 OVERVIEW, i.e. only the top level headlines are visible. This can be
380 configured through the variable `org-startup-folded', or on a per-file
381 basis by adding one of the following lines anywhere in the buffer:
388 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
393 The following commands jump to other headlines in the buffer.
402 Next heading same level.
405 Previous heading same level.
408 Backward to higher level heading.
411 Jump to a different place without changing the current outline
412 visibility. Shows the document structure in a temporary buffer,
413 where you can use visibility cycling (<TAB>) to find your
414 destination. After pressing <RET>, the cursor moves to the
415 selected location in the original buffer, and the headings
416 hierarchy above it is made visible.
419 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document Structure
421 2.5 Structure editing
422 =====================
425 Insert new heading with same level as current. If the cursor is
426 in a plain list item, a new item is created. To force creation of
427 a new headline, use a prefix arg, or first press <RET> to get to
428 the beginning of the next line.
431 Insert new TODO entry with same level as current heading.
434 Promote current heading by one level.
437 Demote current heading by one level.
440 Promote the current subtree by one level.
443 Demote the current subtree by one level.
446 Move subtree up (swap with previous subtree of same level).
449 Move subtree down (swap with next subtree of same level).
453 Kill subtree, i.e. remove it from buffer but save in kill ring.
456 Copy subtree to kill ring.
459 Yank subtree from kill ring. This does modify the level of the
460 subtree to make sure the tree fits in nicely at the yank position.
461 The yank level can also be specified with a prefix arg, or by
462 yanking after a headline marker like `****'.
464 When there is an active region (transient-mark-mode), promotion and
465 demotion work on all headlines in the region. To select a region of
466 headlines, it is best to place both point and mark at the beginning of a
467 line, mark at the beginning of the first headline, and point at the line
468 just after the last headline to change. Note that when the cursor is
469 inside a table (*note Tables::), the Meta-Cursor keys have different
473 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document Structure
478 When a project represented by a (sub)tree is finished, you may want to
479 move the tree to an archive place, either in the same file under a
480 special top-level heading, or even to a different file.
482 Archive the subtree starting at the cursor position to the location
483 given by `org-archive-location'.
485 The default archive is a file in the same directory as the current
486 file, with the name derived by appending `_archive' to the current file
487 name. For information and examples on how to change this, see the
488 documentation string of the variable `org-archive-location'. If you
489 are also using the Org-mode agenda, archiving to a different file is a
490 good way to keep archived trees from contributing agenda items.
493 File: org, Node: Sparse trees, Next: Plain Lists, Prev: Archiving, Up: Document Structure
498 An important feature of Org-mode is the ability to construct _sparse
499 trees_ for selected information in an outline tree. A sparse tree
500 means that the entire document is folded as much as possible, but the
501 selected information is made visible along with the headline structure
502 above it(1). Just try it out and you will see immediately how it works.
504 Org-mode contains several commands creating such trees. The most
505 basic one is `org-occur':
508 Occur. Prompts for a regexp and shows a sparse tree with all
509 matches. If the match is in a headline, the headline is made
510 visible. If the match is in the body of an entry, headline and
511 body are made visible. In order to provide minimal context, also
512 the full hierarchy of headlines above the match is shown, as well
513 as the headline following the match. Each match is also
514 highlighted, the highlights disappear when the buffer is changed
515 with an editing command.
516 For frequently used sparse trees of specific search strings, you can
517 use the variable `org-agenda-custom-commands' to define fast keyboard
518 access to specific sparse trees. These commands will then be
519 accessible through the agenda dispatcher (*note Agenda dispatcher::).
522 (setq org-agenda-custom-commands
523 '(("f" occur-tree "FIXME")))
525 will define the key `C-c a f' as a shortcut for creating a sparse tree
526 matching the string `FIXME'.
528 Other commands are using sparse trees as well. For example `C-c
529 C-v' creates a sparse TODO tree (*note TODO basics::).
531 To print a sparse tree, you can use the Emacs command
532 `ps-print-buffer-with-faces' which does not print invisible parts of
533 the document (2). Or you can use the command `C-c C-x v' to copy the
534 visible part of the document to another file (extension `.txt') which
535 can then be printed in any desired way.
537 ---------- Footnotes ----------
539 (1) See also the variables `org-show-hierarchy-above' and
540 `org-show-following-heading'.
542 (2) This does not work under XEmacs, because XEmacs uses selective
543 display for outlining, not text properties
546 File: org, Node: Plain Lists, Prev: Sparse trees, Up: Document Structure
551 Headlines define both the structure of the Org-mode file, and also lists
552 (for example, TODO items (*note TODO items::) should be created using
553 headline levels). However, when taking notes, the plain text is
554 sometimes easier to read with hand-formatted lists. Org-mode supports
555 editing such lists, and the HTML exporter (*note Exporting::) does
556 parse and format them.
558 Org-mode knows ordered and unordered lists. Unordered list items
559 start with `-', `+', or `*'(1) as bullets. Ordered list items start
560 with `1.' or `1)'. Items belonging to the same list must have the same
561 indentation on the first line. In particular, if an ordered list
562 reaches number `10.', then the 2-digit numbers must be written
563 left-aligned with the other numbers in the list. Indentation also
564 determines the end of a list item. It ends before the next line that
565 is indented like the bullet/number, or less. For example:
568 My favorite scenes are (in this order)
569 1. Eowyns fight with the witch king
570 + this was already my favorite scene in the book
571 + I really like Miranda Otto.
572 2. The attack of the Rohirrim
573 3. Peter Jackson being shot by Legolas
575 He makes a really funny face when it happens.
577 Org-mode supports these lists by tuning filling and wrapping commands
578 to correctly deal with them. Furthermore, the following commands act
579 on items when the cursor is in the first line of an item (the line with
580 the bullet or number).
583 Items can be folded just like headline levels if you set the
584 variable `org-cycle-include-plain-lists'. The level of an item is
585 then given by the indentation of the bullet/number. However,
586 items are always subordinate to real headlines, the hierarchies
587 remain completely separated.
590 Insert new item at current level. With prefix arg, for a new
595 Move the item including subitems up/down (swap with previous/next
596 item of same indentation). If the list is ordered, renumbering is
601 Decrease/increase the indentation of the item, including subitems.
602 Initially, the item tree is selected based on current indentation.
603 When these commands are executed several times in direct
604 succession, the initially selected region is used, even if the new
605 indentation would imply a different hierarchy. To use the new
606 hierarchy, break the command chain with a cursor motion or so.
609 Renumber the ordered list at the cursor.
611 ---------- Footnotes ----------
613 (1) When using `*' as a bullet, lines must be indented or they will
614 be seen as top-level headlines. Also, when you are hiding leading
615 stars to get a clean outline view, plain list items starting with a
616 star are visually indistinguishable from true headlines. In short:
617 even though `*' is supported, it may be better to not use it for plain
621 File: org, Node: Tables, Next: Hyperlinks, Prev: Document Structure, Up: Top
626 Org-mode has a very fast and intuitive table editor built-in.
627 Spreadsheet-like calculations are supported in connection with the
628 Emacs `calc' package.
632 * Built-in table editor:: Simple tables
633 * Narrow columns:: Stop wasting space in tables
634 * Table calculations:: Compute a field from other fields
635 * orgtbl-mode:: The table editor as minor mode
636 * table.el:: Complex tables
639 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
641 3.1 The built-in table editor
642 =============================
644 Org-mode makes it easy to format tables in plain ASCII. Any line with
645 `|' as the first non-white character is considered part of a table.
646 `|' is also the column separator. A table might look like this:
648 | Name | Phone | Age |
649 |-------+-------+-----|
650 | Peter | 1234 | 17 |
653 A table is re-aligned automatically each time you press <TAB> or
654 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
655 field (<RET> to the next row) and creates new table rows at the end of
656 the table or before horizontal lines. The indentation of the table is
657 set by the first line. Any line starting with `|-' is considered as a
658 horizontal separator line and will be expanded on the next re-align to
659 span the whole table width. So, to create the above table, you would
665 and then press <TAB> to align the table and start filling in fields.
667 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
668 and all character keys in a special way, so that inserting and deleting
669 avoids shifting other fields. Also, when typing _immediately after the
670 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
671 the field is automatically made blank. If this behavior is too
672 unpredictable for you, configure the variables
673 `org-enable-table-editor' and `org-table-auto-blank-field'.
675 Creation and conversion
676 .......................
679 Convert the active region to table. If every line contains at
680 least one TAB character, the function assumes that the material is
681 tab separated. If not, lines are split at whitespace into fields.
682 You can use a prefix argument to indicate the minimum number of
683 consequtive spaces required to indentify a field separator
685 If there is no active region, this command creates an empty
686 Org-mode table. However, it's easier to just start typing, like
687 `|Name|Phone|Age <RET> |- <TAB>'.
689 Re-aligning and field motion
690 ............................
693 Re-align the table without moving the cursor.
696 Re-align the table, move to the next field. Creates a new row if
700 Re-align, move to previous field.
703 Re-align the table and move down to next row. Creates a new row if
704 necessary. At the beginning or end of a line, <RET> still does
705 NEWLINE, so it can be used to split a table.
707 Column and row editing
708 ......................
712 Move the current column left/right.
715 Kill the current column.
718 Insert a new column to the left of the cursor position.
722 Move the current row up/down.
725 Kill the current row or horizontal line.
728 Insert a new row above (with arg: below) the current row.
731 Insert a horizontal line below current row. With prefix arg, the
732 line is created above the current line.
735 Sort the table lines in the region. Point and mark must be in the
736 first and last line to be included, and must be in the column that
737 should be used for sorting. The command prompts for numerical
738 versus alphanumerical sorting.
744 Copy a rectangular region from a table to a special clipboard.
745 Point and mark determine edge fields of the rectangle. The
746 process ignores horizontal separator lines.
749 Copy a rectangular region from a table to a special clipboard, and
750 blank all fields in the rectangle. So this is the "cut" operation.
753 Paste a rectangular region into a table. The upper right corner
754 ends up in the current field. All involved fields will be
755 overwritten. If the rectangle does not fit into the present table,
756 the table is enlarged as needed. The process ignores horizontal
760 Wrap several fields in a column like a paragraph. If there is an
761 active region, and both point and mark are in the same column, the
762 text in the column is wrapped to minimum width for the given
763 number of lines. A prefix ARG may be used to change the number of
764 desired lines. If there is no region, the current field is split
765 at the cursor position and the text fragment to the right of the
766 cursor is prepended to the field one line down. If there is no
767 region, but you specify a prefix ARG, the current field is made
768 blank, and the content is appended to the field above.
774 Install a new formula for the current column and replace current
775 field with the result of the formula.
778 Install a new formula for the current field, which must be a named
779 field. Evaluate the formula and replace the field content with the
783 Edit all formulas associated with the current table in a separate
787 Recalculate the current row by applying the stored formulas from
788 left to right. When called with a `C-u' prefix, recalculate the
789 entire table, starting with the first non-header line (i.e. below
790 the first horizontal separator line). For details, see *Note
791 Table calculations::.
794 Rotate the calculation mark in first column through the states `',
795 `#', `*', `!', `$'. For the meaning of these marks see *Note
796 Advanced features::. When there is an active region, change all
800 Which table column is the cursor in? Displays number >0 in echo
804 Sum the numbers in the current column, or in the rectangle defined
805 by the active region. The result is shown in the echo area and can
806 be inserted with `C-y'.
809 When current field is empty, copy from first non-empty field above.
810 When not empty, copy current field down to next row and move cursor
811 along with it. Depending on the variable
812 `org-table-copy-increment', integer field values will be
813 incremented during copy. This key is also used by CUA-mode (*note
820 Edit the current field in a separate window. This is useful for
821 fields that are not fully visible (*note Narrow columns::). When
822 called with a `C-u' prefix, just make the full field visible, so
823 that it can be edited in place.
826 This is an alias for `C-u C-c `' to make the current field fully
829 `M-x org-table-import'
830 Import a file as a table. The table should be TAB- or whitespace
831 separated. Useful, for example, to import an Excel table or data
832 from a database, because these programs generally can write
833 TAB-separated text files. This command works by inserting the
834 file into the buffer and then converting the region to a table.
835 Any prefix argument is passed on to the converter, which uses it
836 to determine the separator.
838 `M-x org-table-export'
839 Export the table as a TAB-separated file. Useful for data
840 exchange with, for example, Excel or database programs.
843 If you don't like the automatic table editor because it gets in your
844 way on lines which you would like to start with `|', you can turn it
847 (setq org-enable-table-editor nil)
849 The only table command which then still works is `C-c C-c' to do a
853 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
858 The width of columns is automatically determined by the table editor.
859 Sometimes a single field or a few fields need to carry more text,
860 leading to unconveniently wide columns. To limit(1) the width of a
861 column, one field anywhere in the column must carry the string `<N>'
862 where `N' is an integer specifying the width of the column in
863 characters. The next re-align will then set the width of this column
864 to no more than this value.
866 |---+------------------------------| |---+--------|
868 | 1 | one | | 1 | one |
869 | 2 | two | ----\ | 2 | two |
870 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
871 | 4 | four | | 4 | four |
872 |---+------------------------------| |---+--------|
874 Fields that are wider become clipped and end in the string `=>'. Note
875 that the full text is still in the buffer, it is only invisible. To
876 see the full text, hold the mouse over the field - a tooltip window
877 will show the full content. To edit such a field, use the command `C-c
878 `' (that is `C-c' followed by the backquote). This will open a new
879 window with the full field. Edit it and finish with `C-c C-c'.
881 When visiting a file containing a table with narrowed columns, the
882 necessary character hiding has not yet happened, and the table needs to
883 be aligned before it looks nice. Setting the option
884 `org-startup-align-all-tables' will realign all tables in a file upon
885 visiting, but also slow down startup. You can also set this option on
886 a per-file basis with:
891 ---------- Footnotes ----------
893 (1) This feature does not work on XEmacs.
896 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
898 3.3 Calculations in tables
899 ==========================
901 The table editor makes use of the Emacs `calc' package to implement
902 spreadsheet-like capabilities. Org-mode has two levels of complexity
903 for table calculations. On the basic level, tables do only horizontal
904 computations, so a field can be computed from other fields _in the same
905 row_, and Org-mode assumes that there is only one formula for each
906 column. This is very efficient to work with and enough for many tasks.
907 On the complex level, columns and individual fields can be named for
908 easier referencing in formulas, individual named fields can have their
909 own formula associated with them, and recalculation can be automated.
913 * Formula syntax:: How to write a formula
914 * Column formulas:: Formulas valid for all fields in a column
915 * Advanced features:: Field names, parameters and automatic recalc
916 * Named-field formulas:: Formulas valid in single fields
917 * Editing/debugging formulas:: Changing a stored formula
918 * Appetizer:: Taste the power of calc
921 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
926 A formula can be any algebraic expression understood by the Emacs
927 `calc' package. Note that `calc' has the slightly non-standard
928 convention that `/' has lower precedence than `*', so that `a/b*c' is
929 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
930 calc-eval: (calc)Calling Calc from Your Lisp Programs.), variable
931 substitution takes place:
933 $ refers to the current field
934 $3 refers to the field in column 3 of the current row
935 $3..$7 a vector of the fields in columns 3-7 of current row
936 $P1..$P3 vector of column range, using column names
937 &2 second data field above the current, in same column
938 &5-2 vector from fifth to second field above current
939 &III-II vector of fields between 2nd and 3rd hline above
940 &III vector of fields between third hline above and current field
941 $name a named field, parameter or constant
943 The range vectors can be directly fed into the calc vector functions
944 like `vmean' and `vsum'.
946 `$name' is interpreted as the name of a column, parameter or
947 constant. Constants are defined globally through the variable
948 `org-table-formula-constants'. If you have the `constants.el' package,
949 it will also be used to resolve constants, including natural constants
950 like `$h' for Planck's constant, and units like `$km' for kilometers.
951 Column names and parameters can be specified in special table lines.
952 These are described below, see *Note Advanced features::.
954 A formula can contain an optional mode string after a semicolon.
955 This string consists of flags to influence calc's modes(1) during
956 execution, e.g. `p20' to switch the internal precision to 20 digits,
957 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
958 or fixed display format, respectively, and `D', `R', `F', and `S' to
959 turn on degrees, radians, fraction and symbolic modes, respectively.
960 In addition, you may provide a `printf' format specifier to reformat
961 the final result. A few examples:
963 $1+$2 Sum of first and second field
964 $1+$2;%.2f Same, format result to two decimals
965 exp($2)+exp($1) Math functions can be used
966 $;%.1f Reformat current cell to 1 decimal
967 ($3-32)*5/9 Degrees F -> C conversion
968 $c/$1/$cm Hz -> cm conversion, using `constants.el'
969 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
970 sin($1);Dp3%.1e Same, but use printf specifier for display
971 vmean($2..$7) Compute column range mean, using vector function
972 vsum(&III) Sum numbers from 3rd hline above, up to here
973 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
975 ---------- Footnotes ----------
977 (1) By default, Org-mode uses the standard calc modes (precision 12,
978 angular units degrees, fraction and symbolic modes off). However, the
979 display format has been changed to `(float 5)' to keep tables compact.
980 The default settings can be configured using the variable
981 `org-calc-default-modes'.
984 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
986 3.3.2 Column formulas
987 ---------------------
989 To apply a formula to a field, type it directly into the field,
990 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
991 <RET> or `C-c C-c' with the cursor still in the field, the formula will
992 be stored as the formula for the current column, evaluated and the
993 current field replaced with the result. If the field contains only
994 `=', the previously stored formula for this column is used.
996 For each column, Org-mode will remember the most recently used
997 formula. The information is stored in a special line starting with
998 `#+TBLFM' directly below the table. When adding/deleting/moving
999 columns with the appropriate commands, the stored equations will be
1000 modified accordingly. When a column used in a calculation is removed,
1001 references to this column become invalid and will cause an error upon
1002 applying the equation.
1004 Instead of typing an equation into the field, you may also use the
1005 command `C-c ='. It prompts for a formula (with default taken from the
1006 `#+TBLFM:' line) and applies it to the current field. A numerical
1007 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1008 in the current column.
1010 To recompute all the fields in a line, use the command `C-c *'. It
1011 re-applies all stored equations to the current row, from left to right.
1012 With a `C-u' prefix, this will be done to every line in the table, so
1013 use this command it you want to make sure the entire table is
1014 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1015 Global updating does not touch the line(s) above the first horizontal
1016 separator line, assuming that this is the table header.
1019 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1021 3.3.3 Advanced features
1022 -----------------------
1024 If you want the recalculation of fields to happen automatically, or if
1025 you want to be able to assign a formula to an individual field (instead
1026 of an entire column) you need to reserve the first column of the table
1027 for special marking characters. Here is an example of a table that
1028 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.3.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.3.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.4 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
1175 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1178 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1180 3.5 The `table.el' package
1181 ==========================
1183 Complex ASCII tables with automatic line wrapping, column- and
1184 row-spanning, and alignment can be created using the Emacs table
1185 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1186 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1187 table, Org-mode will call `table-recognize-table' and move the cursor
1188 into the table. Inside a table, the keymap of Org-mode is inactive.
1189 In order to execute Org-mode-related commands, leave the table.
1192 Recognize `table.el' table. Works when the cursor is in a
1196 Insert a table.el table. If there is already a table at point,
1197 this command converts it between the table.el format and the
1198 Org-mode format. See the documentation string of the command
1199 `org-convert-table' for the restrictions under which this is
1203 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1208 Just like HMTL, Org-mode provides links inside a file, and external
1209 links to other files, Usenet articles, emails and much more.
1213 * Link format:: How links in Org-mode are formatted
1214 * Internal links:: Links to other places in the current file
1215 * External links:: URL-like links to the world
1216 * Managing links:: Creating, inserting and following
1217 * Search Options:: Linking to a specific location
1218 * Remember:: Org-trees store quick notes
1221 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1226 Org-mode will recognize plain URL-like links and activate them as
1227 clickable links. However, the general linkformat looks like this:
1229 [[link][description]] or alternatively [[link]]
1231 Once a link in the buffer is complete (all brackets present),
1232 Org-mode will change the display so that `description' is displayed
1233 instead of `[[link][description]]' and `link' is displayed instead of
1234 `[[link]]'. Links will be highlighted in the face `org-link', which by
1235 default is an underlined face. You can directly edit the visible part
1236 of a link. Note that this can be either the `link' part (if there is
1237 not description) or the `description' part. To edit also the invisible
1238 `link' part, use `C-c C-l' with the cursor on the link.
1240 If you place the cursor at the beginning or just behind the end of
1241 the displayed text and press <BACKSPACE>, you will remove the
1242 (invisible) bracket at that location. This makes the link incomplete
1243 and the internals are again displayed as plain text. Inserting the
1244 missing bracket does hide the link internals again. To show the
1245 internal structure of all links, use the menu entry
1246 `Org->Hyperlinks->Literal links'.
1249 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1254 If the link text does not look like a URL, links are considered to be
1255 internal in the current file. Links such as `[[My Target]]' or `[[My
1256 Target][Find my target]]' lead to a text search in the current file.
1257 The link can be followed with `C-c C-o' when the cursor is on the link,
1258 or with a mouse click (*note Managing links::). The preferred match
1259 for such a link is a dedicated target: The same string in double
1260 angular brackets. Targets may be located anywhere, often it is
1261 convenient to put them into a comment line, for example
1265 If no dedicated target exists, Org-mode will search for the words in
1266 the link, often removing the need for a dedicated target. In the above
1267 example the search would be for `my target'. Links starting with a
1268 star like `*My Target' restrict the search to headlines. When
1269 searching, Org-mode will first try an exact match, but then move on to
1270 more and more lenient searches. For example, the link `[[*My
1271 Targets]]' will find any of the following:
1274 ** TODO my targets are bright
1275 ** my 20 targets are
1277 To insert a link targeting a headline, in-buffer completion can be
1278 used. Just type a star followed by a few optional letters into the
1279 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1280 offered as completions. *Note Managing links::, for more commands
1283 Following a link pushes a mark onto Org-mode's own mark ring. You
1284 can return to the previous position with `C-c &'. Using this command
1285 several times in direct succession goes back to positions recorded
1290 * Radio targets:: Make targets trigger links in plain text.
1291 * CamelCase links:: Activating CamelCase words as links
1294 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1299 You can configure Org-mode to link any occurrences of certain target
1300 names in normal text. So without explicitly creating a link, the text
1301 connects to the target radioing its position. Radio targets are
1302 enclosed by triple angular brackets. For example, a target `<<<My
1303 Target>>>' causes each occurrence of `my target' in normal text to
1304 become activated as a link. The Org-mode file is scanned automatically
1305 for radio targets only when the file is first loaded into Emacs. To
1306 update the target list during editing, press `C-c C-c' with the cursor
1310 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1312 4.2.2 CamelCase words as links
1313 ------------------------------
1315 Org-mode also supports CamelCase words as links. This feature is not
1316 turned on by default because of the inconsistencies this system suffers
1317 from. To activate CamelCase words as links, you need to customize the
1318 option `org-activate-links'. A CamelCase word then leads to a text
1319 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1322 File: org, Node: External links, Next: Managing links, Prev: Internal links, Up: Hyperlinks
1327 Org-mode supports links to files, websites, Usenet and email messages;
1328 and BBDB database entries. External links are URL-like locators. The
1329 following list shows examples for each link type.
1331 http://www.astro.uva.nl/~dominik on the web
1332 file:/home/dominik/images/jupiter.jpg file, absolute path
1333 file:papers/last.pdf file, relative path
1334 news:comp.emacs Usenet link
1335 mailto:adent@galaxy.net Mail link
1336 vm:folder VM folder link
1337 vm:folder#id VM message link
1338 vm://myself@some.where.org/folder#id VM on remote machine
1339 wl:folder WANDERLUST folder link
1340 wl:folder#id WANDERLUST message link
1341 mhe:folder MH-E folder link
1342 mhe:folder#id MH-E message link
1343 rmail:folder RMAIL folder link
1344 rmail:folder#id RMAIL message link
1345 gnus:group GNUS group link
1346 gnus:group#id GNUS article link
1347 bbdb:Richard Stallman BBDB link
1348 shell:ls *.org A shell command
1350 A link should be enclosed in double brackets and may contain a
1351 descriptive text to be displayed instead of the url (*note Link
1352 format::), for example:
1354 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1356 Org-mode also finds external links in the normal text and activates
1357 them as links. If spaces must be part of the link (for example in
1358 `bbdb:Richard Stallman') or to remove ambiguities about the end of the
1359 link, enclose them in angular brackets.
1362 File: org, Node: Managing links, Next: Search Options, Prev: External links, Up: Hyperlinks
1367 Org-mode provides methods to create a link in the correct syntax, to
1368 insert it into an org-mode file, and to follow the link.
1371 Store a link to the current location. This is a _global_ command
1372 which can be used in any buffer to create a link. The link will be
1373 stored for later insertion into an Org-mode buffer (see below).
1374 For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link
1375 will point to the current article/entry. For W3 and W3M buffers,
1376 the link goes to the current URL. For Org-mode files, the current
1377 headline is targeted. For any other files, the link will point to
1378 the file, with a search string (*note Search Options::) pointing
1379 to the contents of the current line. If there is an active
1380 region, the selected words will form the basis of the search
1381 string. The key binding `C-c l' is only a suggestion - see *Note
1382 Installation and activation::.
1385 Insert a link. This prompts for a link to be inserted into the
1386 buffer. You can just type a link, using text for an internal
1387 link, or one of the link type prefixes mentioned in the examples
1388 above. Through completion, all links stored during the current
1389 session can be accessed. The link will be formatted as given in
1390 the variable `org-link-format' and inserted into the buffer, along
1391 with a descriptive text. Note that you don't have to use this
1392 command to insert a link. Links in Org-mode are plain text, and
1393 you can type or paste them straight into the buffer. By using
1394 this command, the links are automatically enclosed in double
1395 brackets, and you will be asked for the optional descriptive text.
1398 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1399 file will be inserted and you may use file name completion to
1400 select the name of the file. The path to the file is inserted
1401 relative to the directory of the current org file, if the linked
1402 file is in the current directory or in a subdirectory of it.
1403 Otherwise an absolute path, if possible with `~/' for your home
1404 directory is used. You can force an absolute path with two `C-u'
1407 `C-c C-l with cursor on existing link'
1408 When the cursor is on an existing link, `C-c C-l' allows to edit
1409 the link and description parts of the link.
1412 Open link at point. This will launch a web browser for URLs (using
1413 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1414 the corresponding links, and execute the command in a shell link.
1415 When the cursor is on an internal link, this commands runs the
1416 corresponding search. When the cursor is on a TAGS list in a
1417 headline, it creates the corresponding TAGS view. If the cursor
1418 is on a time stamp, it compiles the agenda for that date.
1419 Furthermore, it will visit text files in `file:' links with Emacs
1420 and select a suitable application for non-text files.
1421 Classification of files is based on file extension only. See
1422 option `org-file-apps'. If you want to override the default
1423 application and visit the file with Emacs, use a `C-u' prefix.
1427 On links, `mouse-2' will open the link just like `C-c C-o' would.
1428 Under Emacs 22, also `mouse-1' will follow a link.
1431 Like `mouse-2', but force file links to be opened with Emacs.
1434 Push the current position onto the mark ring, to be able to return
1435 easily. Commands following an internal link do this automatically.
1438 Jump back to a recorded position. A position is recorded by the
1439 commands following internal links, and by `C-c %'. Using this
1440 command several times in direct succession moves through a ring of
1441 previously recorded positions.
1444 File: org, Node: Search Options, Next: Remember, Prev: Managing links, Up: Hyperlinks
1446 4.5 Search options in file links
1447 ================================
1449 File links can contain additional information to make Emacs jump to a
1450 particular location in the file when following a link. This can be a
1451 line number or a search option after a double(1) colon. For example:
1453 [[file:~/code/main.c::255]]
1454 [[file:~/xx.org::My Target]]
1455 [[file:~/xx.org::*My Target]]
1456 [[file:~/xx.org::/regexp/]]
1458 Here is what these options do.
1464 Search for a link target `<<My Target>>', or do a text search for
1465 `my target', similar to the search in internal links, see *Note
1469 In an Org-mode file, restrict search to headlines.
1472 Do a regular expression search for `regexp'. This uses the Emacs
1473 command `occur' to list all matches in a separate window. If the
1474 target file is in Org-mode, `org-occur' is used to create a sparse
1475 tree with the matches.
1477 As a degenerate case, a file link with an empty file name can be used
1478 to search the current file. For example, `<file:::find me>' does a
1479 search for `find me' in the current file, just like `[[find me]]' would.
1481 ---------- Footnotes ----------
1483 (1) For backward compatibility, line numbers can also follow a
1487 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1492 Another way to create org entries with links to other files is through
1493 the _Remember_ package by John Wiegley. _Remember_ lets you store
1494 quick notes with little interruption of your work flow. See
1495 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1496 information. The notes produced by _Remember_ can be stored in
1497 different ways, and Org-mode files are a good target. Org-mode allows
1498 to file away notes either to a default file, or directly to the correct
1499 location in your Org-mode outline tree. The following customization(1)
1500 will tell _Remember_ to use org files as target, and to create
1501 annotations compatible with Org-mode links.
1503 (setq org-directory "~/path/to/my/orgfiles/")
1504 (setq org-default-notes-file "~/.notes")
1505 (autoload 'org-remember-annotation "org")
1506 (autoload 'org-remember-apply-template "org")
1507 (autoload 'org-remember-handler "org")
1508 (setq remember-annotation-functions '(org-remember-annotation))
1509 (setq remember-handler-functions '(org-remember-handler))
1510 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1512 In combination with Org-mode, you can use templates to generate
1513 different types of remember notes. For example, if you would like to
1514 use one template to create general TODO entries, and another one for
1515 journal entries, you could use:
1517 (setq org-remember-templates
1518 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1519 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1521 In these entries, the character specifies how to select the template,
1522 the first string specifies the template, and the (optional) second
1523 string specifies a default file (overruling `org-default-notes-file')
1524 as a target for this note.
1526 When you call `M-x remember' to remember something, org will prompt
1527 for a key to select the template and then prepare the buffer like
1529 <file:link to where you called remember>
1533 * [2006-03-21 Tue 15:37]
1535 <file:link to where you called remember>
1537 See the variable `org-remember-templates' for more details.
1539 When you are finished composing a note with remember, you have to
1540 press `C-c C-c' to file the note away. The handler first prompts for a
1541 target file - if you press <RET>, the value of `org-default-notes-file'
1542 is used. Then the command offers the headings tree of the selected
1543 file. You can either immediately press <RET> to get the note appended
1544 to the file. Or you can use vertical cursor motion (<up> and <down>)
1545 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1546 or <left> or <right> leads to the following result.
1548 Cursor Key Note gets inserted
1550 buffer-start <RET> as level 2 heading at end of file
1551 on headline <RET> as sublevel of the heading at cursor
1552 <left> as same level, before current heading
1553 <right> as same level, after current heading
1554 not on <RET> at cursor position, level taken from context.
1555 headline Or use prefix arg to specify level
1558 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1559 append it to the default file. Even shorter would be `C-u C-c C-c',
1560 which does the same without even showing the tree. But with little
1561 extra effort, you can push it directly to the correct location.
1563 Before inserting the text into a tree, the function ensures that the
1564 text has a headline, i.e. a first line that starts with a `*'. If not,
1565 a headline is constructed from the current date and some additional
1566 data. If the variable `org-adapt-indentation' is non-nil, the entire
1567 text is also indented so that it starts in the same column as the
1568 headline (after the asterisks).
1570 ---------- Footnotes ----------
1572 (1) The three autoload forms are only necessary if `org.el' is not
1573 part of the Emacs distribution or an XEmacs package.
1576 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1581 Org-mode does not maintain TODO lists as a separate document. TODO
1582 items are an integral part of the notes file, because TODO items
1583 usually come up while taking notes! With Org-mode, you simply mark any
1584 entry in a tree as being a TODO item. In this way, the information is
1585 not duplicated, and the entire context from which the item emerged is
1586 always present when you check.
1588 Of course, this technique causes TODO items to be scattered
1589 throughout your file. Org-mode provides methods to give you an
1590 overview over all things you have to do.
1594 * TODO basics:: Marking and displaying TODO entries
1595 * Progress logging:: Document your productivity
1596 * TODO extensions:: Workflow and assignments
1597 * Priorities:: Some things are more important than others
1600 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1602 5.1 Basic TODO functionality
1603 ============================
1605 Any headline can become a TODO item by starting it with the word TODO,
1608 *** TODO Write letter to Sam Fortune
1610 The most important commands to work with TODO entries are:
1613 Rotate the TODO state of the current item between
1615 ,-> (unmarked) -> TODO -> DONE --.
1616 '--------------------------------'
1618 The same rotation can also be done "remotely" from the timeline and
1619 agenda buffers with the `t' command key (*note Agenda commands::).
1622 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1623 the entire buffer, but shows all TODO items and the headings
1624 hierarchy above them. With prefix arg, show also the DONE
1625 entries. With numerical prefix N, show the tree for the Nth
1626 keyword in the variable `org-todo-keywords'.
1629 Show the global TODO list. This collects the TODO items from all
1630 agenda files (*note Agenda Views::) into a single buffer. The
1631 buffer is in `agenda-mode', so there are commands to examine and
1632 manipulate the TODO entries directly from that buffer (*note
1633 Agenda commands::). *Note Global TODO list::, for more
1636 ``org-agenda-include-all-todo''
1637 If you would like to have all your TODO items listed as part of
1638 your agenda, customize the variable `org-agenda-include-all-todo'.
1641 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1643 5.2 Progress Logging
1644 ====================
1646 If you want to keep track of _when_ a certain TODO item was finished,
1647 turn on logging with
1649 (setq org-log-done t)
1651 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1652 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1653 [timestamp]' will be inserted just after the headline. If you turn the
1654 entry back into a TODO item again through further state cycling, that
1655 line will be removed again. In the timeline (*note Timeline::) and in
1656 the agenda (*note Weekly/Daily Agenda::), you can then use the `L' key
1657 to display the TODO items closed on each day, giving you an overview of
1658 what has been done on a day.
1661 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1663 5.3 Extended use of TODO keywords
1664 =================================
1666 The default implementation of TODO entries is just two states: TODO and
1667 DONE. You can, however, use the TODO feature for more complicated
1668 things by configuring the variables `org-todo-keywords' and
1669 `org-todo-interpretation'. Using special setup, you can even use TODO
1670 keywords in different ways in different org files.
1672 Note that tags are another way to classify headlines in general and
1673 TODO items in particular (*note Tags::).
1677 * Workflow states:: From TODO to DONE in steps
1678 * TODO types:: I do this, Fred the rest
1679 * Per file keywords:: Different files, different requirements
1682 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1684 5.3.1 TODO keywords as workflow states
1685 --------------------------------------
1687 You can use TODO keywords to indicate different states in the process
1688 of working on an item, for example:
1690 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1691 org-todo-interpretation 'sequence)
1693 Changing these variables becomes only effective in a new Emacs
1694 session. With this setup, the command `C-c C-t' will cycle an entry
1695 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1696 also use a prefix argument to quickly select a specific state. For
1697 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1698 you define many keywords, you can use in-buffer completion (see *Note
1699 Completion::) to insert these words into the buffer.
1702 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1704 5.3.2 TODO keywords as types
1705 ----------------------------
1707 The second possibility is to use TODO keywords to indicate different
1708 types of action items. For example, you might want to indicate that
1709 items are for "work" or "home". If you are into David Allen's _Getting
1710 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1711 `MAYBE'. Or, when you work with several people on a single project,
1712 you might want to assign action items directly to persons, by using
1713 their names as TODO keywords. This would be set up like this:
1715 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1716 org-todo-interpretation 'type)
1718 In this case, different keywords do not indicate a sequence, but
1719 rather different types. So it is normally not useful to change from
1720 one type to another. Therefore, in this case the behavior of the
1721 command `C-c C-t' is changed slightly(1). When used several times in
1722 succession, it will still cycle through all names. But when you return
1723 to the item after some time and execute `C-c C-t' again, it will switch
1724 from each name directly to DONE. Use prefix arguments or completion to
1725 quickly select a specific name. You can also review the items of a
1726 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1727 C-v'. For example, to see all things Lucy has to do, you would use
1728 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1729 single buffer, you would use the prefix arg as well when creating the
1730 global todo list: `C-3 C-c t'.
1732 ---------- Footnotes ----------
1734 (1) This is also true for the `t' command in the timeline and agenda
1738 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1740 5.3.3 Setting up TODO keywords for individual files
1741 ---------------------------------------------------
1743 It can be very useful to use different aspects of the TODO mechanism in
1744 different files, which is not possible with the global settings
1745 described above. For file-local settings, you need to add special
1746 lines to the file which set the keywords and interpretation for that
1747 file only. For example, to set one of the two examples discussed
1748 above, you need one of the following lines, starting in column zero
1749 anywhere in the file:
1751 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1752 #+TYP_TODO: Fred Sara Lucy Mike DONE
1754 To make sure you are using the correct keyword, type `#+' into the
1755 buffer and then use `M-<TAB>' completion.
1757 Remember that the last keyword must always mean that the item is DONE
1758 (you may use a different word, though). Also note that in each file,
1759 only one of the two aspects of TODO keywords can be used. After
1760 changing one of these lines, use `C-c C-c' with the cursor still in the
1761 line to make the changes known to Org-mode(1).
1763 If you want to use very many keywords, for example when working with
1764 a large group of people, you may split the names over several lines:
1766 #+TYP_TODO: Fred Sara Lucy Mike
1767 #+TYP_TODO: Luis George Jules Jessica
1768 #+TYP_TODO: Kim Arnold Peter
1771 ---------- Footnotes ----------
1773 (1) Org-mode parses these lines only when Org-mode is activated
1774 after visiting a file. `C-c C-c' with the cursor in a line starting
1775 with `#+' is simply restarting Org-mode, making sure that these changes
1779 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1784 If you use Org-mode extensively to organize your work, you may end up
1785 with a number of TODO entries so large that you'd like to prioritize
1786 them. This can be done by placing a _priority cookie_ into the
1789 *** TODO [#A] Write letter to Sam Fortune
1791 With its standard setup, Org-mode supports priorities `A', `B', and
1792 `C'. `A' is the highest priority. An entry without a cookie is
1793 treated as priority `B'. Priorities make a difference only in the
1794 agenda (*note Weekly/Daily Agenda::).
1797 Set the priority of the current item. The command prompts for a
1798 priority character `A', `B' or `C'. When you press <SPC> instead,
1799 the priority cookie is removed from the headline. The priorities
1800 can also be changed "remotely" from the timeline and agenda buffer
1801 with the `,' command (*note Agenda commands::).
1805 Increase/decrease priority of current item. Note that these keys
1806 are also used to modify time stamps (*note Creating timestamps::).
1807 Furthermore, these keys are also used by CUA-mode (*note
1811 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1816 Items can be labeled with timestamps to make them useful for project
1821 * Time stamps:: Assigning a time to a tree entry
1822 * Creating timestamps:: Commands which insert timestamps
1825 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1827 6.1 Time stamps, deadlines and scheduling
1828 =========================================
1830 A time stamp is a specification of a date (possibly with time) in a
1831 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1832 A time stamp can appear anywhere in the headline or body of an org-tree
1833 entry. Its presence allows entries to be shown on specific dates in
1834 the agenda (*note Weekly/Daily Agenda::). We distinguish:
1837 A simple time stamp just assigns a date/time to an item. In the
1838 timeline and agenda displays, the headline of the entry will be
1839 shown exactly on that date.
1842 Two time stamps connected by `--' denote a time range. The
1843 headline will be shown on the first and last day of the range, and
1844 on any dates that are displayed and fall in the range. Here is an
1847 ** Meeting in Amsterdam
1848 <2004-08-23 Mon>--<2004-08-26 Thu>
1851 If a time stamp is preceded by the word `DEADLINE:', the task
1852 (most likely a TODO item) is supposed to be finished on that date,
1853 and it will be listed then. In addition, the compilation for
1854 _today_ will carry a warning about the approaching or missed
1855 deadline, starting `org-deadline-warning-days' before the due
1856 date, and continuing until the entry is marked DONE. An example:
1858 *** TODO write article about the Earth for the Guide
1859 The editor in charge is <bbdb:Ford Prefect>
1860 DEADLINE: <2004-02-29 Sun>
1863 If a time stamp is preceded by the word `SCHEDULED:', it means you
1864 are planning to start working on that task on the given date. The
1865 headline will be listed under the given date. In addition, a
1866 reminder that the scheduled date has passed will be present in the
1867 compilation for _today_, until the entry is marked DONE. I.e., the
1868 task will automatically be forwarded.
1871 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1873 6.2 Creating timestamps
1874 =======================
1876 For Org-mode to recognize time stamps, they need to be in the specific
1877 format. All commands listed below produce time stamps in the correct
1881 Prompt for a date and insert a corresponding time stamp. When the
1882 cursor is at a previously used time stamp, it is updated to NOW.
1883 When this command is used twice in succession, a time range is
1887 Like `C-c .', but use the alternative format which contains date
1888 and time. The default time can be rounded to multiples of 5
1889 minutes, see the option `org-time-stamp-rounding-minutes'.
1892 Like `C-c .', but insert an inactive time stamp not triggering the
1896 Insert a time stamp corresponding to the cursor date in the
1900 Access the Emacs calendar for the current date. If there is a
1901 timestamp in the current line, goto the corresponding date instead.
1904 Access the agenda for the date given by the time stamp at point
1905 (*note Weekly/Daily Agenda::).
1908 Insert `DEADLINE' keyword along with a stamp.
1911 Create a sparse tree with all deadlines that are either past-due,
1912 or which will become due within `org-deadline-warning-days'. With
1913 `C-u' prefix, show all deadlines in the file. With a numeric
1914 prefix, check that many days. For example, `C-1 C-c C-w' shows
1915 all deadlines due tomorrow.
1918 Insert `SCHEDULED' keyword along with a stamp.
1922 Change date at cursor by one day. These key bindings conflict with
1923 CUA-mode (*note Interaction::).
1927 Change the item under the cursor in a timestamp. The cursor can
1928 be on a year, month, day, hour or minute. Note that if the cursor
1929 is not at a time stamp, these same keys modify the priority of an
1930 item. (*note Priorities::). The key bindings also conflict with
1931 CUA-mode (*note Interaction::).
1934 Evaluate a time range by computing the difference between start and
1935 end. With prefix arg, insert result after the time range (in a
1936 table: into the following column).
1938 When Org-mode prompts for a date/time, the function reading your
1939 input will replace anything you choose not to specify with the current
1940 date and time. For details, see the documentation string of
1941 `org-read-date'. Also, a calender will pop up to allow selecting a
1942 date. The calendar can be fully controlled from the minibuffer, and a
1943 date can be selected with the following commands:
1946 Scroll calendar backwards by one month.
1949 Scroll calendar forwards by one month.
1952 Select date by clicking on it.
1973 Choose date in calendar (only if nothing typed into minibuffer).
1976 File: org, Node: Tags, Next: Agenda Views, Prev: Timestamps, Up: Top
1981 If you wish to implement a system to cross-correlate information, an
1982 excellent way is to assign tags to headline. Org-mode has extensive
1983 support for using tags.
1985 Every headline can contain a list of tags, at the end of the
1986 headline. Tags are normal words containing letters, numbers, `_', and
1987 `@'. Tags must be preceded and followed by a single colon; like
1988 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
1992 * Tag inheritance:: Tags use the tree structure of the outline
1993 * Setting tags:: How to assign tags to a headline
1994 * Tag searches:: Searching for combinations of tags
1997 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2002 Tags make use of the hierarchical structure of outline trees. If a
2003 heading has a certain tag, all subheadings will inherit the tag as
2004 well. For example, in the list
2006 * Meeting with the French group :WORK:
2007 ** Summary by Frank :BOSS:NOTES:
2008 *** TODO Prepare slides for him :ACTION:
2010 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2011 `:ACTION:'. When executing tag searches and Org-mode finds that a
2012 certain headline matches the search criterion, it will not check any
2013 sublevel headline, assuming that these likely also match, and that the
2014 list of matches can become very long. However, this may not be what
2015 you want, and you can influence inheritance and searching using the
2016 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2019 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2024 As Org-mode deals with plain text files, tags can simply be typed into
2025 the buffer. After a colon, `M-<TAB>' offers completion on all tags
2026 being used in the current buffer. There is also a special command for
2030 Enter new tags for the current headline. The minibuffer will
2031 prompt for a list of tags and offer completion with respect to all
2032 other tags used in the current buffer. Several tags, separated by
2033 colons, may be specified at the prompt. After pressing <RET>, the
2034 tags will be inserted and aligned to `org-tags-column'. When
2035 called with a `C-u' prefix, all tags in the current buffer will be
2036 aligned to that column, just to make things look nice. TAGS are
2037 automatically realigned after promotion, demotion, and TODO state
2038 changes (*note TODO basics::).
2041 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2046 Once a tags system has been set up, it can be used to collect related
2047 information into special lists.
2050 Create a sparse tree with all headlines matching a tags search.
2053 Create a global list of tag matches from all agenda files. *Note
2054 Matching headline tags::.
2057 Create a global list of tag matches from all agenda files, but
2058 check only TODO items and force checking subitems (see variable
2059 `org-tags-match-list-sublevels').
2061 A tags search string can use Boolean operators `&' for AND and `|'
2062 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2063 not implemented. A tag may also be preceded by `-', to select against
2064 it, and `+' is syntactic sugar for positive selection. The AND
2065 operator `&' is optional when `+' or `-' is present. For example,
2066 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2067 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2068 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2069 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2073 File: org, Node: Agenda Views, Next: Exporting, Prev: Tags, Up: Top
2078 Due to the way Org-mode works, TODO items, time-stamped items, and
2079 tagged headlines can be scattered throughout a file or even a number of
2080 files. To get an overview over open action items, or over events that
2081 are important for a particular date, this information must be collected,
2082 sorted and displayed in an organized way.
2084 Org-mode can select items based on various criteria, and display them
2085 in a separate buffer. Three different views are provided:
2087 * an _agenda_ that is like a calendar and shows information for
2090 * a _TODO list_ that covers all unfinished action items, and
2092 * a _tags view_ that shows information based on the tags associated
2093 with headlines in the outline tree.
2095 The extracted information is displayed in a special _agenda buffer_.
2096 This buffer is read-only, but provides commands to visit the
2097 corresponding locations in the original Org-mode files, and even to
2098 edit these files remotely.
2102 * Agenda files:: Files being searched for agenda information
2103 * Agenda dispatcher:: Keyboard access to agenda views
2104 * Weekly/Daily Agenda:: The calendar page with current tasks
2105 * Global TODO list:: All unfinished action items
2106 * Matching headline tags:: Structured information with fine-tuned search
2107 * Timeline:: Time-sorted view for single file
2108 * Agenda commands:: Remote editing of org trees
2111 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda Views, Up: Agenda Views
2116 The information to be shown is collected from all _agenda files_, the
2117 files listed in the variable `org-agenda-files'(1). Thus even if you
2118 only work with a single Org-mode file, this file should be put into
2119 that list(2). You can customize `org-agenda-files', but the easiest
2120 way to maintain it is through the following commands
2123 Add current file to the list of agenda files. The file is added to
2124 the front of the list. If it was already in the list, it is moved
2125 to the front. With prefix arg, file is added/moved to the end.
2128 Remove current file from the list of agenda files.
2131 Cycle through agenda file list, visiting one file after the other.
2133 The Org menu contains the current list of files and can be used to
2136 ---------- Footnotes ----------
2138 (1) If the value of that variable is not a list, but a single file
2139 name, then the list of agenda files will be maintained in that external
2142 (2) When using the dispatcher pressing `1' before selecting a
2143 command will actually limit the command to the current file, and ignore
2144 `org-agenda-files' until the next dispatcher command.
2147 File: org, Node: Agenda dispatcher, Next: Weekly/Daily Agenda, Prev: Agenda files, Up: Agenda Views
2149 8.2 The agenda dispatcher
2150 =========================
2152 The views are created through a dispatcher that should be bound to a
2153 global key, for example `C-c a' (*note Installation and activation::).
2154 In the following we will assume that `C-c a' is indeed how the
2155 dispatcher is accessed and list keyboard access to commands
2156 accordingly. After pressing `C-c a', an additional letter is required
2157 to execute a command. The dispatcher offers the following default
2160 Create the calendar-like agenda (*note Weekly/Daily Agenda::).
2163 Create a list of all TODO items (*note Global TODO list::).
2166 Create a list of headlines matching a TAGS expression (*note
2167 Matching headline tags::).
2169 You can also define custom commands that will be accessible through
2170 the dispatcher, just like the default commands. Custom commands are
2171 global searches for tags and specific TODO keywords, or a variety of
2172 sparse tree creating commands (*note Sparse trees::). As sparse trees
2173 are only defined for a single org-mode file, these latter commands act
2174 on the current buffer instead of the list of agenda files.
2176 Custom commands are configured in the variable
2177 `org-agenda-custom-commands'. You can customize this variable, for
2178 example by pressing `C-c a C'. You can also directly set it with Emacs
2179 Lisp in `.emacs'. For example:
2181 (setq org-agenda-custom-commands
2182 '(("w" todo "WAITING")
2183 ("u" tags "+BOSS-URGENT")
2184 ("U" tags-tree "+BOSS-URGENT")
2185 ("f" occur-tree "\\<FIXME\\>")))
2187 will define `C-c a w' as a global search for TODO entries with
2188 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2189 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2190 search but only in the current buffer and display the result as a
2191 sparse tree, and `C-c a f' to create a sparse tree with all entries
2192 containing the word `FIXME'. For more information, look at the
2193 documentation string of the variable `org-agenda-custom-commands'.
2196 File: org, Node: Weekly/Daily Agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda Views
2198 8.3 The weekly/daily agenda
2199 ===========================
2201 The purpose of the weekly/daily _agenda_ is to act like a page of a
2202 paper agenda, showing all the tasks for the current week or day.
2205 Compile an agenda for the current week from a list of org files.
2206 The agenda shows the entries for each day. With a `C-u' prefix (or
2207 when the variable `org-agenda-include-all-todo' is `t'), all
2208 unfinished TODO items (including those without a date) are also
2209 listed at the beginning of the buffer, before the first date.
2211 Remote editing from the agenda buffer means, for example, that you
2212 can change the dates of deadlines and appointments from the agenda
2213 buffer. The commands available in the Agenda buffer are listed in
2214 *Note Agenda commands::.
2218 * Categories:: Not all tasks are equal
2219 * Time-of-day specifications:: How the agenda knows the time
2220 * Calendar/Diary integration:: Integrating Anniversaries and more
2221 * Sorting of agenda items:: The order of things
2224 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily Agenda, Up: Weekly/Daily Agenda
2229 In the agenda buffer, each entry is preceded by a _category_, which is
2230 derived from the file name. The category can also be set with a
2231 special line anywhere in the buffer, looking like this:
2235 If there are several such lines in a file, each specifies the
2236 category for the text below it (but the first category also applies to
2237 any text before the first CATEGORY line). The display in the agenda
2238 buffer looks best if the category is not longer than 10 characters.
2241 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily Agenda
2243 8.3.2 Time-of-Day Specifications
2244 --------------------------------
2246 Org-mode checks each agenda item for a time-of-day specification. The
2247 time can be part of the time stamp that triggered inclusion into the
2248 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2249 specified with two time stamps, like
2250 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2252 In the headline of the entry itself, a time(range) may also appear as
2253 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2254 Emacs diary (*note Calendar/Diary integration::), time specifications
2255 in diary entries are recognized as well.
2257 For agenda display, Org-mode extracts the time and displays it in a
2258 standard 24 hour format as part of the prefix. The example times in
2259 the previous paragraphs would end up in the agenda like this:
2261 8:30-13:00 Arthur Dent lies in front of the bulldozer
2262 12:45...... Ford Prefect arrives and takes Arthur to the pub
2263 19:00...... The Vogon reads his poem
2264 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2266 If the agenda is in single-day mode, or for the display of today, the
2267 timed entries are embedded in a time grid, like
2269 8:00...... ------------------
2270 8:30-13:00 Arthur Dent lies in front of the bulldozer
2271 10:00...... ------------------
2272 12:00...... ------------------
2273 12:45...... Ford Prefect arrives and takes Arthur to the pub
2274 14:00...... ------------------
2275 16:00...... ------------------
2276 18:00...... ------------------
2277 19:00...... The Vogon reads his poem
2278 20:00...... ------------------
2279 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2281 The time grid can be turned on and off with the variable
2282 `org-agenda-use-time-grid', and can be configured with
2283 `org-agenda-time-grid'.
2286 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily Agenda
2288 8.3.3 Calendar/Diary integration
2289 --------------------------------
2291 Emacs contains the calendar and diary by Edward M. Reingold. The
2292 calendar displays a three-month calendar with holidays from different
2293 countries and cultures. The diary allows you to keep track of
2294 anniversaries, lunar phases, sunrise/set, recurrent appointments
2295 (weekly, monthly) and more. In this way, it is quite complementary to
2296 Org-mode. It can be very useful to combine output from Org-mode with
2299 In order to include entries from the Emacs diary into Org-mode's
2300 agenda, you only need to customize the variable
2302 (setq org-agenda-include-diary t)
2304 After that, everything will happen automatically. All diary entries
2305 including holidays, anniversaries etc will be included in the agenda
2306 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2307 the agenda buffer to jump to the diary file in order to edit existing
2308 diary entries. The `i' command to insert new entries for the current
2309 date works in the agenda buffer, as well as the commands `S', `M', and
2310 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2311 to other calendars, respectively. `c' can be used to switch back and
2312 forth between calendar and agenda.
2315 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily Agenda
2317 8.3.4 Sorting of agenda items
2318 -----------------------------
2320 The entries for each day are sorted. The default order is to first
2321 collect all items containing an explicit time-of-day specification.
2322 These entries will be shown at the beginning of the list, as a
2323 _schedule_ for the day. After that, items remain grouped in
2324 categories, in the sequence given by `org-agenda-files'. Within each
2325 category, items are sorted by priority (*note Priorities::).
2327 The priority is a numerical quantity composed of the base priority
2328 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2329 increments for overdue scheduled or deadline items.
2331 Sorting can be customized using the variable
2332 `org-agenda-sorting-strategy'.
2335 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily Agenda, Up: Agenda Views
2337 8.4 The global TODO list
2338 ========================
2340 The global TODO list contains all unfinished TODO items, formatted and
2341 collected into a single place.
2344 Show the global TODO list. This collects the TODO items from all
2345 agenda files (*note Agenda Views::) into a single buffer. The
2346 buffer is in `agenda-mode', so there are commands to examine and
2347 manipulate the TODO entries directly from that buffer (*note
2348 Agenda commands::). *Note Global TODO list::, for more
2352 Like the above, but allows selection of a specific TODO keyword.
2353 You can also do this by specifying a prefix argument to `C-c a t'.
2354 With a `C-u' prefix you are prompted for a keyword. With a
2355 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2356 `r' key in the agenda buffer regenerates it, and you can give a
2357 prefix argument to this command to change the selected TODO
2358 keyword, for example `3 r'. If you often need a search for a
2359 specific keyword, define a custom command for it (*note Agenda
2362 Remote editing of TODO items means that you can change the state of a
2363 TODO entry with a single key press. The commands available in the TODO
2364 list are described in *Note Agenda commands::.
2367 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda Views
2369 8.5 Matching headline tags
2370 ==========================
2372 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2373 you can select headlines based on the tags that apply to them and
2374 collect them into an agenda buffer.
2377 Produce a list of all headlines that match a given set of tags.
2378 The command prompts for a selection criterion, which is a boolean
2379 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2380 `WORK|HOME' (*note Tags::). If you often need a specific search,
2381 define a custom command for it (*note Agenda dispatcher::).
2384 Like `C-c a m', but only select headlines that are also TODO items
2385 and force checking subitems (see variable
2386 `org-tags-match-list-sublevels'.
2388 The commands available in the tags list are described in *Note
2392 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda Views
2394 8.6 Timeline for a single file
2395 ==============================
2397 The timeline is not really an agenda view, because it only summarizes
2398 items from a single Org-mode file. But it also uses the agenda buffer
2399 and provides similar commands, so we discuss it here. The timeline
2400 shows all time-stamped items in a single Org-mode file (or the selected
2401 part of it), in a _time-sorted view_. The main purpose of this command
2402 is to give an overview over events in a project.
2405 Show a time-sorted view of the org file, with all time-stamped
2406 items. When called with a `C-u' prefix, all unfinished TODO
2407 entries (scheduled or not) are also listed under the current date.
2409 The commands available in the timeline buffer are listed in *Note
2413 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda Views
2415 8.7 Commands in the agenda buffer
2416 =================================
2418 Entries in the agenda buffer are linked back to the org file or diary
2419 file where they originate. You are not allowed to edit the agenda
2420 buffer itself, but commands are provided to show and jump to the
2421 original entry location, and to edit the org-files "remotely" from the
2422 agenda buffer. In this way, all information is stored only once,
2423 removing the risk that your agenda and note files may diverge.
2425 Some commands can be executed with mouse clicks on agenda lines. For
2426 the other commands, the cursor needs to be in the desired line.
2432 Next line (same as <up>).
2435 Previous line (same as <down>).
2442 Display the original location of the item in another window.
2445 Display original location and recenter that window.
2450 Go to the original location of the item in another window. Under
2451 Emacs 22, `mouse-1' will also works for this.
2454 Go to the original location of the item and delete other windows.
2457 Toggle Follow mode. In Follow mode, as you move the cursor through
2458 the agenda buffer, the other window always shows the corresponding
2459 location in the org file.
2462 Toggle Logbook mode. In Logbook mode, entries that where marked
2463 DONE while logging was on (variable `org-log-done') are shown in
2470 Delete other windows.
2473 Switch to weekly view (7 days displayed together).
2476 Switch to daily view (just one day displayed).
2479 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2483 Toggle the time grid on and off. See also the variables
2484 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2487 Recreate the agenda buffer, for example to reflect the changes
2488 after modification of the time stamps of items with S-<left> and
2489 S-<right>. When the buffer is the global todo list, a prefix
2490 argument is interpreted to create a selective list for a specific
2494 Display the following `org-agenda-ndays' days. For example, if
2495 the display covers a week, switch to the following week. With
2496 prefix arg, go forward that many times `org-agenda-ndays' days.
2499 Display the previous dates.
2511 Change the TODO state of the item, both in the agenda and in the
2515 Show all tags associated with the current item. Because of
2516 inheritance, this may be more than the tags listed in the line
2520 Set tags for the current headline.
2523 Set the priority for the current item. Org-mode prompts for the
2524 priority character. If you reply with <SPC>, the priority cookie
2525 is removed from the entry.
2528 Display weighted priority of current item.
2532 Increase the priority of the current item. The priority is
2533 changed in the original buffer, but the agenda is not resorted.
2534 Use the `r' key for this.
2538 Decrease the priority of the current item.
2541 Change the time stamp associated with the current line by one day
2542 into the future. With prefix argument, change it by that many
2543 days. For example, `3 6 5 S-<right>' will change it by a year.
2544 The stamp is changed in the original org file, but the change is
2545 not directly reflected in the agenda buffer. Use the `r' key to
2549 Change the time stamp associated with the current line by one day
2553 Change the time stamp associated with the current line to today.
2554 The key `>' has been chosen, because it is the same as `S-.' on my
2558 Insert a new entry into the diary. Prompts for the type of entry
2559 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2560 new entry in the diary, just like `i d' etc. would do in the
2561 calendar. The date is taken from the cursor position.
2567 Open the Emacs calendar and move to the date at the agenda cursor.
2570 When in the calendar, compute and show the Org-mode agenda for the
2574 Show the phases of the moon for the three months around current
2578 Show sunrise and sunset times. The geographical location must be
2579 set with calendar variables, see documentation of the Emacs
2583 Convert the date at cursor into many other cultural and historic
2587 Show holidays for three month around the cursor date.
2590 Export a single iCalendar file containing entries from all agenda
2597 Quit agenda, remove the agenda buffer.
2600 Exit agenda, remove the agenda buffer and all buffers loaded by
2601 Emacs for the compilation of the agenda. Buffers created by the
2602 user to visit org files will not be removed.
2606 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda Views, Up: Top
2611 For printing and sharing of notes, Org-mode documents can be exported
2612 as ASCII or HTML files. To incorporate entries with associated times
2613 like deadlines or appointments into a desktop calendar program like
2614 iCal, Org-mode can also produce extracts in the iCalendar format.
2618 * ASCII export:: Export as a structured ASCII file
2619 * HTML export:: Export as an HTML file
2620 * iCalendar export:: Create calendar entries.
2623 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2629 Export as ASCII file. If there is an active region, only the
2630 region will be exported. For an org file `myfile.org', the ASCII
2631 file will be `myfile.txt'. The file will be overwritten without
2634 In the exported version, the first 3 outline levels will become
2635 headlines, defining a general document structure. Additional levels
2636 will be exported as itemized lists. If you want that transition to
2637 occur at a different level, specify it with a prefix argument. For
2640 C-1 C-c C-x a org-export-as-ascii
2642 creates only top level headlines and does the rest as items. Lines
2643 starting with `#' and subtrees starting with the word `COMMENT' will
2647 File: org, Node: HTML export, Next: iCalendar export, Prev: ASCII export, Up: Exporting
2652 Org-mode contains an HTML exporter with extensive HTML formatting, in
2653 ways similar to John Grubers _markdown_ language, but with additional
2657 Export as HTML file `myfile.html'.
2660 Export as HTML file and open it with a browser.
2663 Insert template with export options, see below.
2666 Toggle fixed-width for entry (QUOTE) or region, see below.
2668 In the exported version, the first 3 outline levels will become
2669 headlines, defining a general document structure. Additional levels
2670 will be exported as itemized lists. If you want that transition to
2671 occur at a different level, specify it with a prefix argument. For
2676 creates two levels of headings and does the rest as items.
2680 * HTML formatting:: Interpretation of the buffer content
2681 * Export options:: How to influence exports
2682 * Comment lines:: Lines which will not be exported
2685 File: org, Node: HTML formatting, Next: Export options, Prev: HTML export, Up: HTML export
2687 9.2.1 HTML formatting
2688 ---------------------
2690 Not all text is transferred literally to the exported HTML file. The
2691 exporter implements the following interpretation:
2693 * Hand-formatted lists with `-', `*' or `+' as bullet, or with `1.'
2694 or `2)' as enumerator will be recognized and transformed into HTML
2695 lists. See *Note Plain Lists::.
2697 * You can make words *bold*, /italic/, and _underlined_
2699 * Simple TeX-like math constructs are interpreted:
2701 - `10^22' and `J_n' are super- and subscripts. You can quote
2702 `^' and `_' with a backslash: `\_' and `\^'
2704 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2705 use completion for these macros, just type `\' and maybe a few
2706 letters, and press `M-<TAB>' to see possible completions.
2708 * Tables are transformed into HTML tables. Data fields before the
2709 first horizontal separator line will be formatted as table header
2712 * If a headline starts with the word `QUOTE', the text below the
2713 headline will be typeset as fixed-width, to allow quoting of
2714 computer codes etc. Lines starting with `:' are also typeset in
2717 * If you want to include HTML tags which should be interpreted as
2718 such, mark them with a `@' like in `@<b>bold text@</b>'. Plain
2719 `<' and `>' are always transformed to `<' and `>' in HTML
2722 If these conversions conflict with your habits of typing ASCII text,
2723 they can all be turned off with corresponding variables.
2726 File: org, Node: Export options, Next: Comment lines, Prev: HTML formatting, Up: HTML export
2728 9.2.2 Export options
2729 --------------------
2731 The exporter recognizes special lines in the buffer which provide
2732 additional information. These lines may be put anywhere in the file.
2733 The whole set of lines can be inserted into the buffer with `C-c C-x
2734 t'. For individual lines, a good way to make sure the keyword is
2735 correct is to type `#+' and then use `M-<TAB>' completion (*note
2738 #+TITLE: the title to be shown (default is the buffer name)
2739 #+AUTHOR: the author (default taken from `user-full-name')
2740 #+EMAIL: his/her email address (default from `user-mail-address')
2741 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2742 #+TEXT: Some descriptive text to be inserted at the beginning.
2743 #+TEXT: Several lines may be given.
2744 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2746 The OPTIONS line is a compact form to specify export settings. Here
2748 H: set the number of headline levels for export
2749 num: turn on/off section-numbers
2750 toc: turn on/off table of contents
2751 \n: turn on/off linebreak-preservation
2752 @: turn on/off quoted html tags
2753 :: turn on/off fixed-width sections
2754 |: turn on/off tables
2755 ^: turn on/off TeX-like syntax for sub- and superscripts.
2756 *: turn on/off emphasized text (bold, italic, underlined)
2757 TeX: turn on/off TeX macros
2759 You can also give style information for the exported file. The
2760 default specification can be configured through the option
2761 `org-export-html-style'. If you want to use a file-local style, you
2762 may use file variables, best wrapped into a COMMENT section at the end
2763 of the outline tree. For example:
2765 * COMMENT HTML style specifications
2768 # org-export-html-style: " <style type=\"text/css\">
2769 p {font-weight: normal; color: gray; }
2774 Remember to execute `M-x normal-mode' after changing this to make
2775 the new style visible to Emacs.
2778 File: org, Node: Comment lines, Prev: Export options, Up: HTML export
2783 Lines starting with `#' in column zero are treated as comments and will
2784 never be exported. Also entire subtrees starting with the word
2785 `COMMENT' will never be exported. Finally, any text before the first
2786 headline will not be exported either. This applies also for ASCII
2790 Toggle the COMMENT keyword at the beginning of an entry.
2793 File: org, Node: iCalendar export, Prev: HTML export, Up: Exporting
2795 9.3 iCalendar export
2796 ====================
2798 Some people like to use Org-mode for keeping track of projects, but
2799 still prefer a standard calendar application for anniversaries and
2800 appointments. In this case it can be useful to have deadlines and
2801 other time-stamped items in Org-mode files show up in the calendar
2802 application. Org-mode can export calendar information in the standard
2806 Create iCalendar entries for the current file and store them in
2807 the same directory, using a file extension `.ics'.
2810 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2811 For each of these files, a separate iCalendar file will be
2815 Create a single large iCalendar file from all files in
2816 `org-agenda-files' and write it to the file given by
2817 `org-combined-agenda-icalendar-file'.
2819 How this calendar is best read and updated, depends on the
2820 application you are using. For example, when using iCal under Apple
2821 MacOS X, you could create a new calendar `OrgMode' (the default name
2822 for the calendar created by `C-c C-x c', see the variables
2823 `org-icalendar-combined-name' and
2824 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2825 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2826 use AppleScript to make iCal re-read the calendar files each time a new
2827 version of `OrgMode.ics' is produced. Here is the setup needed for
2830 (setq org-combined-agenda-icalendar-file
2831 "~/Library/Calendars/OrgMode.ics")
2832 (add-hook 'org-after-save-iCalendar-file-hook
2835 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2838 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2845 * Completion:: M-TAB knows what you need
2846 * Customization:: Adapting Org-mode to your taste
2847 * Clean view:: Getting rid of leading stars in the outline
2848 * TTY keys:: Using Org-mode on a tty
2849 * FAQ:: Frequently asked questions
2850 * Interaction:: Other Emacs packages
2851 * Bugs:: Things which do not work perfectly
2852 * Acknowledgments:: These people provided feedback and more
2855 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2860 Org-mode supports in-buffer completion. This type of completion does
2861 not make use of the minibuffer. You simply type a few letters into the
2862 buffer and use the key to complete text right there.
2865 Complete word at point
2866 * At the beginning of a headline, complete TODO keywords.
2868 * After `\', complete TeX symbols supported by the exporter.
2870 * After `*', complete CamelCase versions of all headlines in the
2873 * After `:', complete tags used elsewhere in the buffer.
2875 * After `#+', complete the special keywords like `TYP_TODO' or
2876 `OPTIONS' which set file-specific options for Org-mode. When
2877 the option keyword is already complete, pressing `M-<TAB>'
2878 again will insert example settings for this keyword.
2880 * Elsewhere, complete dictionary words using ispell.
2883 File: org, Node: Customization, Next: Clean view, Prev: Completion, Up: Miscellaneous
2888 There are more than 100 variables that can be used to customize
2889 Org-mode. For the sake of compactness of the manual, we are not
2890 describing the variables here. A structured overview of customization
2891 variables is available with `M-x org-customize'. Or select `Browse Org
2892 Group' from the `Org->Customization' menu.
2895 File: org, Node: Clean view, Next: TTY keys, Prev: Customization, Up: Miscellaneous
2897 10.3 A cleaner outline view
2898 ===========================
2900 Some people find it noisy and distracting that the Org-mode headlines
2901 are starting with a potentially large number of stars. For example the
2902 tree from *Note Headlines:::
2904 * Top level headline
2910 * Another top level headline
2912 Unfortunately this is deeply ingrained into the code of Org-mode and
2913 cannot be easily changed. You can, however, modify the display in such
2914 a way that all leading stars become invisible and the outline more easy
2915 to read. To do this, customize the variable `org-hide-leading-stars'
2918 (setq org-hide-leading-stars t)
2920 or change this on a per-file basis with one of the lines (anywhere in
2923 #+STARTUP: showstars
2924 #+STARTUP: hidestars
2926 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
2929 With stars hidden, the tree becomes:
2931 * Top level headline
2937 * Another top level headline
2939 Note that the leading stars are not truly replaced by whitespace, they
2940 are only fontified with the face `org-hide' that uses the background
2941 color as font color. If are are not using either white or black
2942 background, you may have to customize this face to get the wanted
2943 effect. Another possibility is to set this font such that the extra
2944 stars are almost invisible, for example using the color `grey90' on a
2947 Things become cleaner still if you skip all the even levels and use
2948 only odd levels 1, 3, 5..., effectively adding two stars to go from one
2949 outline level to the next:
2951 * Top level headline
2957 * Another top level headline
2959 In order to make the structure editing and export commands handle this
2960 convention correctly, use
2962 (setq org-odd-levels-only t)
2964 or set this on a per-file basis with one of the following lines (don't
2965 forget to press `C-c C-c' with the cursor in the startup line to
2966 activate changes immediately).
2971 You can convert an Org-mode file from single-star-per-level to the
2972 double-star-per-level convention with `M-x org-convert-to-odd-levels
2973 RET' in that file. There is no command for the back conversion because
2974 such a command might merge levels and in this way destroy the structure
2978 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
2980 10.4 Using org-mode on a tty
2981 ============================
2983 Org-mode uses a number of keys that are not accessible on a tty. This
2984 applies to most special keys like cursor keys, <TAB> and <RET>, when
2985 these are combined with modifier keys like <Meta> and/or <Shift>.
2986 Org-mode uses these bindings because it needs to provide keys for a
2987 large number of commands, and because these keys appeared particularly
2988 easy to remember. In order to still be able to access the core
2989 functionality of Org-mode on a tty, alternative bindings are provided.
2990 Here is a complete list of these bindings, which are obviously more
2991 cumbersome to use. Note that sometimes a work-around can be better.
2992 For example changing a time stamp is really only fun with `S-<cursor>'
2993 keys. On a tty you would rather use `C-c .' to re-insert the
2996 Default Alternative 1 Alternative 2
2997 `S-<TAB>' `C-u <TAB>'
2998 `M-<left>' `C-c C-x l' `<Esc> <left>'
2999 `M-S-<left>'`C-c C-x L'
3000 `M-<right>' `C-c C-x r' `<Esc>
3002 `M-S-<right>'`C-c C-x R'
3003 `M-<up>' `C-c C-x u' `<Esc> <up>'
3004 `M-S-<up>' `C-c C-x U'
3005 `M-<down>' `C-c C-x d' `<Esc> <down>'
3006 `M-S-<down>'`C-c C-x D'
3007 `S-<RET>' `C-c C-x c'
3008 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3009 `M-S-<RET>' `C-c C-x M'
3012 `S-<right>' `C-c C-x
3020 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3022 10.5 Frequently asked questions
3023 ===============================
3025 1. Org-mode seems to be a useful default mode for the various
3026 `README' files I have scattered through my directories. How do I
3027 turn it on for all `README' files?
3028 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3030 2. Some of my links stopped working after I upgraded to a version
3031 4.20 or later. Why is this, and how can I fix it?
3032 These must be links in plain text, containing white space, such as
3033 `bbdb:Richard Stallman'. You need to protect these links by
3034 putting double brackets around them, like `[[bbdb:Richard
3037 3. I see that Org-mode now creates links using the double bracket
3038 convention that hides the link part and the brackets, only showing
3039 the description part. How can I convert my old links to this new
3041 Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3042 The replaces angular brackets with the link format.
3044 4. I don't care if you find the new bracket links great, I am
3045 attached to the old style using angular brackets and no hiding of
3046 the link text. Please give them back to me, don't tell me it is
3048 Would I let you down like that? If you must (even if I don't
3049 understand why), you can do this
3050 (setq org-link-style 'plain
3051 org-link-format "<%s>")
3053 5. When I am executing shell links I always get a confirmation prompt
3054 and need to type `yes <RET>', thats 4 key presses! Can I get rid
3056 The confirmation is there to protect you from unwantingly execute
3057 potentially dangerous commands. For example, imagine a link
3058 `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
3059 command would look like `Google Search', but really it would remove
3060 your home directory. If you wish, you can make it easier to
3061 respond to the query by setting `org-confirm-shell-links' to
3062 `y-or-n-p'. Then a single `y' keypress will be enough to confirm
3063 shell links. It is also possible to turn off this check entirely,
3064 but I do not recommend to do this. Be warned.
3066 6. All these stars are driving me mad, I just find the Emacs outlines
3067 unreadable. Can't you just put white space and a single star as a
3068 starter for headlines?
3069 See *Note Clean view::.
3071 7. I would like to have two windows on the same Org-mode file, but
3072 with different outline visibility. Is that possible?
3073 In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3074 See the documentation on the command `make-indirect-buffer'. In
3075 XEmacs, this is currently not possible because of the different
3076 outline implementation.
3078 8. When I export my TODO list, every TODO item becomes a separate
3079 section. How do I enforce these items to be exported as an
3081 If you plan to use ASCII or HTML export, make sure things you want
3082 to be exported as item lists are level 4 at least, even if that
3083 does mean there is a level jump. For example:
3085 * Todays top priorities
3086 **** TODO write a letter to xyz
3087 **** TODO Finish the paper
3088 **** Pick up kids at the school
3090 Alternatively, if you need a specific value for the heading/item
3091 transition in a particular file, use the `+OPTIONS' line to
3092 configure the `H' switch.
3096 9. I would like to export only a subtree of my file to HTML. How?
3097 If you want to export a subtree, mark the subtree as region and
3098 then export. Marking can be done with `C-c @ C-x C-x', for
3101 10. Org-mode takes over the S-cursor keys. I also want to use
3102 CUA-mode, is there a way to fix this conflict?
3103 Yes, see *Note Interaction::.
3105 11. One of my table columns has started to fill up with `#ERROR'.
3107 Org-mode tried to compute the column from other fields using a
3108 formula stored in the `#+TBLFMT:' line just below the table, and
3109 the evaluation of the formula fails. Fix the fields used in the
3110 formula, or fix the formula, or remove it!
3112 12. When I am in the last column of a table and just above a
3113 horizontal line in the table, pressing TAB creates a new table line
3114 before the horizontal line. How can I quickly move to the line
3115 below the horizontal line instead?
3116 Press <down> (to get on the separator line) and then <TAB>. Or
3117 configure the variable `org-table-tab-jumps-over-hlines'.
3119 13. How can I change the indentation of an entire table without fixing
3121 The indentation of a table is set by the first line. So just fix
3122 the indentation of the first line and realign with <TAB>.
3124 14. Is it possible to include entries from org-mode files into my
3126 Since the org-mode agenda is much more powerful and can contain the
3127 diary (*note Calendar/Diary integration::), you should think twice
3128 before deciding to do this. Integrating Org-mode information into
3129 the diary is, however, possible. The following steps are
3130 necessary: Autoload the function `org-diary' as shown above under
3131 *Note Installation and activation::. You also need to use _fancy
3132 diary display_ by setting in `.emacs':
3134 (add-hook 'diary-display-hook 'fancy-diary-display)
3136 Then include the following line into your `~/diary' file, in order
3137 to get the entries from all files listed in the variable
3141 You may also select specific files with
3143 &%%(org-diary) ~/path/to/some/org-file.org
3144 &%%(org-diary) ~/path/to/another/org-file.org
3146 If you now launch the calendar and press `d' to display a diary,
3147 the headlines of entries containing a timestamp, date range,
3148 schedule, or deadline referring to the selected date will be
3149 listed. Just like in Org-mode's agenda view, the diary for
3150 _today_ contains additional entries for overdue deadlines and
3151 scheduled items. See also the documentation of the `org-diary'
3156 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3158 10.6 Interaction with other packages
3159 ====================================
3161 Org-mode can cooperate with the following packages:
3163 `org-mouse.el' by Piotr Zielinski
3164 This package implements extended mouse functionality for Org-mode.
3165 It allows you to cycle visibility and to edit the document
3166 structure with the mouse. It also provides a context-sensitive
3167 menu that changes depending on the context of a mouse-click. Use
3168 a search engine to find this package on the web.
3170 `table.el' by Takaaki Ota
3171 Org mode cooperates with table.el, see *Note table.el::.
3172 `table.el' is part of Emacs 22.
3174 `calc.el' by Dave Gillespie
3175 Org-mode uses the calc package for implementing spreadsheet
3176 functionality in its tables (*note Table calculations::).
3177 Org-modes checks for the availability of calc by looking for the
3178 function `calc-eval' which should be autoloaded in your setup if
3179 calc has been installed properly. As of Emacs 22, calc is part of
3180 the Emacs distribution. Another possibility for interaction
3181 between the two packages is using calc for embedded calculations.
3182 *Note Embedded Mode: (calc)Embedded Mode.
3184 `constants.el' by Carsten Dominik
3185 In a table formula (*note Table calculations::), it is possible to
3186 use names for natural constants or units. Instead of defining
3187 your own constants in the variable `org-table-formula-constants',
3188 install the `constants' package which defines a large number of
3189 constants and units, and lets you use unit prefixes like `M' for
3190 `Mega' etc. You will need version 2.0 of this package, available
3191 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3192 the function `constants-get', which has to be autoloaded in your
3193 setup. See the installation instructions in the file
3196 `CUA.el' by Kim. F. Storm
3197 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3198 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3199 select and extend the region. If you want to use one of these
3200 packages along with Org-mode, configure the variable
3201 `org-CUA-compatible'. When set, Org-mode will move the following
3202 keybindings in org-mode files, and in the agenda buffer (but not
3203 during date selection).
3205 S-UP -> M-p S-DOWN -> M-n
3206 S-LEFT -> M-- S-RIGHT -> M-+
3209 Yes, these are unfortunately more difficult to remember. If you
3210 want to have other replacement keys, look at the variable
3211 `org-disputed-keys'.
3213 `remember.el' by John Wiegley
3214 Org mode cooperates with remember, see *Note Remember::.
3215 `Remember.el' is not part of Emacs, find it on the web.
3218 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3223 Here is a list of things that should work differently, but which I have
3224 found too hard to fix.
3226 * If a table field starts with a link, and if the corresponding table
3227 column is narrowed (*note Narrow columns::) to a width too small to
3228 display the link, the field would look entirely empty even though
3229 it is not. To prevent this, Org-mode throws an error. The
3230 work-around is to make the column wide enough to fit the link, or
3231 to add some text (at least 2 characters) before the link in the
3234 * Narrowing table columns does not work on XEmacs, because the
3235 `format' function does not transport text properties.
3237 * Text in an entry protected with the `QUOTE' keyword should not
3240 * When the application called by `C-c C-o' to open a file link fails
3241 (for example because the application does not exits or refuses to
3242 open the file), it does so silently. No error message is
3245 * Plain list items should be able to hold a TODO item.
3246 Unfortunately this has so many technical problems that I will only
3247 consider this change for the next major release (5.0).
3249 * The remote-editing commands in the agenda buffer cannot be undone
3250 with `undo' called from within the agenda buffer. But you can go
3251 to the corresponding buffer (using <TAB> or <RET> and execute
3254 * Recalculating a table line applies the formulas from left to right.
3255 If a formula uses _calculated_ fields further down the row,
3256 multiple recalculation may be needed to get all fields consistent.
3258 * Under XEmacs, if Org-mode entries are included into the diary, it
3259 is not possible to jump back from the diary to the org file.
3260 Apparently, the text properties are lost when the
3261 fancy-diary-display is used. However, from Org-mode's timeline
3262 and agenda buffers (created with `C-c C-r' and `C-c a'), things do
3265 * You can only make a single word boldface or italic. To emphasize
3266 several words in a row, each must have the emphasize markers, like
3267 in `*three* *bold* *words*'.
3269 * The exporters work well, but could be made more efficient.
3272 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3274 10.8 Acknowledgments
3275 ====================
3277 Org-mode was written by Carsten Dominik, who still maintains it at the
3278 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3279 following people (in alphabetic order) have helped the development
3280 along with ideas, suggestions and patches. Many thanks to all of you,
3281 Org-mode would not be what it is without your input.
3283 * Thomas Baumann contributed the code for links to the MH-E email
3286 * Alex Bochannek provided a patch for rounding time stamps.
3288 * Charles Caves' suggestion sparked the implementation of templates
3291 * Pavel Chalmoviansky influenced the agenda treatment of items with
3294 * Sacha Chua suggested to copy some linking code from Planner.
3296 * Christian Egli converted the documentation into TeXInfo format,
3297 patched CSS formatting into the HTML exporter, and inspired the
3300 * Nic Ferrier contributed mailcap and XML support.
3302 * Kai Grossjohann pointed out key-binding conflicts caused by
3305 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3308 * Tim O'Callaghan suggested in-file links, search options for
3309 general file links, and TAGS.
3311 * Oliver Oppitz suggested multi-state TODO items.
3313 * Scott Otterson sparked the introduction of descriptive text for
3314 links, among other things.
3316 * Pete Phillips helped the development of the TAGS feature.
3318 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3321 * Kevin Rogers contributed code to access VM files on remote hosts.
3323 * Philip Rooke created the Org-mode reference card and provided lots
3326 * Christian Schlauer proposed angular brackets around links, among
3329 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3330 `organizer-mode.el'.
3332 * Ju"rgen Vollmer contributed code generating the table of contents
3335 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3337 * David Wainberg suggested archiving, and improvements to the linking
3340 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
3341 development of Org-mode was fully independent, and both systems are
3342 really different beasts in their basic ideas and implementation
3343 details. However, I have later looked at John's code and learned
3344 from his implementation of (i) links where the link itself is
3345 hidden and only a description is shown, and (ii) popping up a
3346 calendar to select a date.
3348 * Carsten Wimmer suggested some changes and helped fix a bug in
3351 * Roland Winkler requested additional keybindings to make Org-mode
3354 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3358 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3366 * acknowledgments: Acknowledgments. (line 6)
3367 * active region <1>: HTML export. (line 10)
3368 * active region <2>: ASCII export. (line 6)
3369 * active region <3>: Built-in table editor.
3371 * active region: Structure editing. (line 46)
3372 * agenda: Weekly/Daily Agenda. (line 6)
3373 * agenda commands, custom: Agenda dispatcher. (line 6)
3374 * agenda dispatcher: Agenda dispatcher. (line 6)
3375 * agenda files, removing buffers: Agenda commands. (line 187)
3376 * agenda views: Agenda Views. (line 6)
3377 * agenda, for single file: Timeline. (line 6)
3378 * angular brackets, around links: External links. (line 35)
3379 * applescript, for calendar update: iCalendar export. (line 38)
3380 * archive locations: Archiving. (line 13)
3381 * archiving: Archiving. (line 6)
3382 * ASCII export: ASCII export. (line 6)
3383 * author: Feedback. (line 6)
3384 * autoload: Installation and activation.
3386 * BBDB links: External links. (line 6)
3387 * bold text: HTML formatting. (line 13)
3388 * bug reports: Feedback. (line 6)
3389 * bugs: Bugs. (line 6)
3390 * calc package: Table calculations. (line 6)
3391 * calc.el: Interaction. (line 17)
3392 * calculations, in tables <1>: Table calculations. (line 6)
3393 * calculations, in tables: Built-in table editor.
3395 * calendar integration: Calendar/Diary integration.
3397 * calendar, for selecting date: Creating timestamps. (line 68)
3398 * CamelCase link completion: Completion. (line 6)
3399 * CamelCase links: Internal links. (line 6)
3400 * CamelCase links, completion of: CamelCase links. (line 6)
3401 * category: Categories. (line 6)
3402 * children, subtree visibility state: Visibility cycling. (line 10)
3403 * clean outline view: Clean view. (line 6)
3404 * column formula: Column formulas. (line 6)
3405 * commands, in agenda buffer: Agenda commands. (line 6)
3406 * comment lines: Comment lines. (line 6)
3407 * completion, of CamelCase links <1>: Completion. (line 6)
3408 * completion, of CamelCase links: CamelCase links. (line 6)
3409 * completion, of dictionary words: Completion. (line 6)
3410 * completion, of file names: Managing links. (line 36)
3411 * completion, of links: Managing links. (line 23)
3412 * completion, of option keywords <1>: Completion. (line 6)
3413 * completion, of option keywords: Export options. (line 6)
3414 * Completion, of option keywords: Per file keywords. (line 17)
3415 * completion, of tags <1>: Completion. (line 6)
3416 * completion, of tags: Setting tags. (line 12)
3417 * completion, of TeX symbols <1>: Completion. (line 6)
3418 * completion, of TeX symbols: HTML formatting. (line 17)
3419 * completion, of TODO keywords <1>: Completion. (line 6)
3420 * completion, of TODO keywords: Workflow states. (line 12)
3421 * constants, in calculations: Formula syntax. (line 26)
3422 * constants.el: Interaction. (line 27)
3423 * contents, global visibility state: Visibility cycling. (line 19)
3424 * copying, of subtrees: Structure editing. (line 6)
3425 * creating timestamps: Creating timestamps. (line 6)
3426 * CUA.el: Interaction. (line 39)
3427 * custom agenda commands: Agenda dispatcher. (line 6)
3428 * customization: Customization. (line 6)
3429 * cutting, of subtrees: Structure editing. (line 6)
3430 * cycling, of TODO states: TODO basics. (line 13)
3431 * cycling, visibility: Visibility cycling. (line 6)
3432 * dangerous commands: FAQ. (line 37)
3433 * date stamps: Time stamps. (line 6)
3434 * date, reading in minibuffer: Creating timestamps. (line 68)
3435 * DEADLINE keyword: Time stamps. (line 27)
3436 * deadlines: Time stamps. (line 6)
3437 * demotion, of subtrees: Structure editing. (line 6)
3438 * diary entries, creating from agenda: Agenda commands. (line 145)
3439 * diary integration: Calendar/Diary integration.
3441 * dictionary word completion: Completion. (line 6)
3442 * dispatching agenda commands: Agenda dispatcher. (line 6)
3443 * document structure: Document Structure. (line 6)
3444 * DONE, final TODO keyword: Per file keywords. (line 20)
3445 * editing tables: Tables. (line 6)
3446 * editing, of table formulas: Editing/debugging formulas.
3448 * emphasized text: Export options. (line 22)
3449 * evaluate time range: Creating timestamps. (line 63)
3450 * exporting: Exporting. (line 6)
3451 * exporting a subtree: FAQ. (line 78)
3452 * exporting, not: Comment lines. (line 6)
3453 * extended TODO keywords: TODO extensions. (line 6)
3454 * external links: External links. (line 6)
3455 * FAQ: FAQ. (line 6)
3456 * feedback: Feedback. (line 6)
3457 * file links: External links. (line 6)
3458 * file links, searching: Search Options. (line 6)
3459 * file name completion: Managing links. (line 36)
3460 * files, adding to agenda list: Agenda files. (line 12)
3461 * filing subtrees: Archiving. (line 6)
3462 * fixed width: HTML formatting. (line 28)
3463 * fixed-width sections: Export options. (line 22)
3464 * folded, subtree visibility state: Visibility cycling. (line 10)
3465 * folding, sparse trees: Sparse trees. (line 6)
3466 * following links: Managing links. (line 50)
3467 * format specifier: Formula syntax. (line 34)
3468 * format, of links: Link format. (line 6)
3469 * formula editing: Editing/debugging formulas.
3471 * formula syntax: Formula syntax. (line 6)
3472 * formula, for named table field: Named-field formulas.
3474 * formula, for table column: Column formulas. (line 6)
3475 * formula, in tables: Built-in table editor.
3477 * global keybindings: Installation and activation.
3479 * global TODO list: Global TODO list. (line 6)
3480 * global visibility states: Visibility cycling. (line 19)
3481 * GNUS links: External links. (line 6)
3482 * hand-formatted lists: HTML formatting. (line 9)
3483 * headline levels: Export options. (line 22)
3484 * headline levels, for exporting <1>: HTML export. (line 22)
3485 * headline levels, for exporting: ASCII export. (line 12)
3486 * headline navigation: Motion. (line 6)
3487 * headline tagging: Tags. (line 6)
3488 * headline, promotion and demotion: Structure editing. (line 6)
3489 * headlines: Headlines. (line 6)
3490 * hide text: Visibility cycling. (line 6)
3491 * hiding leading stars: Clean view. (line 6)
3492 * HTML export: HTML export. (line 6)
3493 * HTML tags: HTML formatting. (line 33)
3494 * hyperlinks: Hyperlinks. (line 6)
3495 * iCalendar export: iCalendar export. (line 6)
3496 * indentation, of tables: FAQ. (line 102)
3497 * indirect buffers: FAQ. (line 54)
3498 * inheritance, of tags: Tag inheritance. (line 6)
3499 * inserting links: Managing links. (line 23)
3500 * installation: Installation and activation.
3502 * internal links: Internal links. (line 6)
3503 * introduction: Introduction. (line 6)
3504 * italic text: HTML formatting. (line 13)
3505 * jumping, to headlines: Motion. (line 6)
3506 * keybindings, global: Installation and activation.
3508 * keyword options: Per file keywords. (line 6)
3509 * linebreak preservation: Export options. (line 22)
3510 * link completion: Managing links. (line 23)
3511 * link format: Link format. (line 6)
3512 * links, external: External links. (line 6)
3513 * links, internal: Internal links. (line 6)
3514 * links, returning to: Managing links. (line 76)
3515 * lists, hand-formatted: HTML formatting. (line 9)
3516 * lists, ordered: Plain Lists. (line 6)
3517 * lists, plain: Plain Lists. (line 6)
3518 * logging, of progress: Progress logging. (line 6)
3519 * maintainer: Feedback. (line 6)
3520 * make-indirect-buffer: FAQ. (line 54)
3521 * mark ring: Managing links. (line 72)
3522 * marking characters, tables: Advanced features. (line 34)
3523 * matching, of tags: Matching headline tags.
3525 * matching, tags: Tags. (line 6)
3526 * MH-E links: External links. (line 6)
3527 * minor mode for tables: orgtbl-mode. (line 6)
3528 * mode, for calc: Formula syntax. (line 34)
3529 * motion, between headlines: Motion. (line 6)
3530 * name, of column or field: Formula syntax. (line 26)
3531 * named field formula: Named-field formulas.
3533 * names as TODO keywords: TODO types. (line 6)
3534 * narrow columns in tables: Narrow columns. (line 6)
3535 * occur, command: Sparse trees. (line 6)
3536 * option keyword completion: Completion. (line 6)
3537 * options, for customization: Customization. (line 6)
3538 * options, for export: Export options. (line 6)
3539 * ordered lists: Plain Lists. (line 6)
3540 * org-agenda, command: Weekly/Daily Agenda. (line 9)
3541 * org-mode, turning on: Installation and activation.
3543 * org-mouse.el: Interaction. (line 8)
3544 * orgtbl-mode: orgtbl-mode. (line 6)
3545 * outline tree: Headlines. (line 6)
3546 * outline-mode: Outlines. (line 6)
3547 * outlines: Outlines. (line 6)
3548 * overview, global visibility state: Visibility cycling. (line 19)
3549 * packages, interaction with other: Interaction. (line 6)
3550 * pasting, of subtrees: Structure editing. (line 6)
3551 * per file keywords: Per file keywords. (line 6)
3552 * plain lists: Plain Lists. (line 6)
3553 * plain text external links: External links. (line 35)
3554 * printing sparse trees: Sparse trees. (line 39)
3555 * priorities: Priorities. (line 6)
3556 * priorities, of agenda items: Sorting of agenda items.
3558 * progress logging: Progress logging. (line 6)
3559 * promotion, of subtrees: Structure editing. (line 6)
3560 * quoted html tags: Export options. (line 22)
3561 * ranges, time: Time stamps. (line 6)
3562 * recomputing table fields: Column formulas. (line 27)
3563 * region, active <1>: HTML export. (line 10)
3564 * region, active <2>: ASCII export. (line 6)
3565 * region, active <3>: Built-in table editor.
3567 * region, active: Structure editing. (line 46)
3568 * remember.el <1>: Interaction. (line 39)
3569 * remember.el: Remember. (line 6)
3570 * RMAIL links: External links. (line 6)
3571 * SCHEDULED keyword: Time stamps. (line 39)
3572 * scheduling: Time stamps. (line 6)
3573 * search option in file links: Search Options. (line 6)
3574 * section-numbers: Export options. (line 22)
3575 * setting tags: Setting tags. (line 6)
3576 * SHELL links: External links. (line 6)
3577 * shell links, confirmation: FAQ. (line 37)
3578 * show all, command: Visibility cycling. (line 27)
3579 * show all, global visibility state: Visibility cycling. (line 19)
3580 * show hidden text: Visibility cycling. (line 6)
3581 * single file summary: Timeline. (line 6)
3582 * sorting, of agenda items: Sorting of agenda items.
3584 * sparse tree, for deadlines: Creating timestamps. (line 38)
3585 * sparse tree, for TODO: TODO basics. (line 20)
3586 * sparse tree, tag based: Tags. (line 6)
3587 * sparse trees: Sparse trees. (line 6)
3588 * spreadsheet capabilities: Table calculations. (line 6)
3589 * storing links: Managing links. (line 9)
3590 * structure editing: Structure editing. (line 6)
3591 * structure of document: Document Structure. (line 6)
3592 * subtree visibility states: Visibility cycling. (line 10)
3593 * subtree, cut and paste: Structure editing. (line 6)
3594 * subtree, subtree visibility state: Visibility cycling. (line 10)
3595 * subtrees, cut and paste: Structure editing. (line 6)
3596 * summary: Summary. (line 6)
3597 * syntax, of formulas: Formula syntax. (line 6)
3598 * table editor, builtin: Built-in table editor.
3600 * table editor, table.el: table.el. (line 6)
3601 * table of contents: Export options. (line 22)
3602 * table.el <1>: Interaction. (line 13)
3603 * table.el: table.el. (line 6)
3604 * tables <1>: Export options. (line 22)
3605 * tables: Tables. (line 6)
3606 * tables, export to HTML: HTML formatting. (line 24)
3607 * tag completion: Completion. (line 6)
3608 * tag searches: Tag searches. (line 6)
3609 * tags: Tags. (line 6)
3610 * tags view: Matching headline tags.
3612 * templates, for remember: Remember. (line 26)
3613 * TeX interpretation: HTML formatting. (line 15)
3614 * TeX macros: Export options. (line 22)
3615 * TeX symbol completion: Completion. (line 6)
3616 * TeX-like syntax for sub- and superscripts: Export options. (line 22)
3617 * thanks: Acknowledgments. (line 6)
3618 * time stamps: Time stamps. (line 6)
3619 * time, reading in minibuffer: Creating timestamps. (line 68)
3620 * time-sorted view: Timeline. (line 6)
3621 * timeline, single file: Timeline. (line 6)
3622 * timerange: Time stamps. (line 18)
3623 * timestamp: Time stamps. (line 12)
3624 * timestamps, creating: Creating timestamps. (line 6)
3625 * TODO items: TODO items. (line 6)
3626 * TODO keywords completion: Completion. (line 6)
3627 * TODO list, global: Global TODO list. (line 6)
3628 * TODO types: TODO types. (line 6)
3629 * TODO workflow: Workflow states. (line 6)
3630 * transient-mark-mode <1>: HTML export. (line 10)
3631 * transient-mark-mode <2>: ASCII export. (line 6)
3632 * transient-mark-mode <3>: Built-in table editor.
3634 * transient-mark-mode: Structure editing. (line 46)
3635 * trees, sparse: Sparse trees. (line 6)
3636 * trees, visibility: Visibility cycling. (line 6)
3637 * tty keybindings: TTY keys. (line 6)
3638 * types as TODO keywords: TODO types. (line 6)
3639 * underlined text: HTML formatting. (line 13)
3640 * URL links: External links. (line 6)
3641 * USENET links: External links. (line 6)
3642 * variables, for customization: Customization. (line 6)
3643 * vectors, in table calculations: Formula syntax. (line 23)
3644 * visibility cycling: Visibility cycling. (line 6)
3645 * visible text, printing: Sparse trees. (line 39)
3646 * VM links: External links. (line 6)
3647 * WANDERLUST links: External links. (line 6)
3648 * workflow states as TODO keywords: Workflow states. (line 6)
3651 File: org, Node: Key Index, Prev: Index, Up: Top
3659 * +: Agenda commands. (line 118)
3660 * ,: Agenda commands. (line 110)
3661 * -: Agenda commands. (line 124)
3662 * .: Agenda commands. (line 89)
3663 * :: Agenda commands. (line 107)
3664 * <: Creating timestamps. (line 75)
3665 * <left>: Agenda commands. (line 86)
3666 * <RET> <1>: Agenda commands. (line 41)
3667 * <RET> <2>: Creating timestamps. (line 100)
3668 * <RET>: Built-in table editor.
3670 * <right>: Agenda commands. (line 81)
3671 * <SPC>: Agenda commands. (line 28)
3672 * <TAB> <1>: Agenda commands. (line 35)
3673 * <TAB> <2>: Built-in table editor.
3675 * <TAB> <3>: Plain Lists. (line 37)
3676 * <TAB>: Visibility cycling. (line 10)
3677 * > <1>: Agenda commands. (line 140)
3678 * >: Creating timestamps. (line 76)
3679 * C: Agenda commands. (line 170)
3680 * c: Agenda commands. (line 154)
3681 * C-#: Built-in table editor.
3683 * C-,: Agenda files. (line 18)
3684 * C-c !: Creating timestamps. (line 21)
3685 * C-c $: Archiving. (line 9)
3686 * C-c %: Managing links. (line 72)
3687 * C-c &: Managing links. (line 76)
3688 * C-c ' <1>: Editing/debugging formulas.
3690 * C-c ': Built-in table editor.
3692 * C-c *: Built-in table editor.
3694 * C-c +: Built-in table editor.
3696 * C-c ,: Priorities. (line 18)
3697 * C-c -: Built-in table editor.
3699 * C-c .: Creating timestamps. (line 10)
3700 * C-c /: Sparse trees. (line 15)
3701 * C-c :: HTML export. (line 17)
3702 * C-c ;: Comment lines. (line 12)
3703 * C-c <: Creating timestamps. (line 25)
3704 * C-c <TAB>: Built-in table editor.
3706 * C-c =: Built-in table editor.
3708 * C-c >: Creating timestamps. (line 29)
3709 * C-c ? <1>: Editing/debugging formulas.
3711 * C-c ?: Built-in table editor.
3713 * C-c [: Agenda files. (line 12)
3714 * C-c \: Tag searches. (line 9)
3715 * C-c ]: Agenda files. (line 15)
3716 * C-c ^: Built-in table editor.
3718 * C-c `: Built-in table editor.
3720 * C-c a a: Weekly/Daily Agenda. (line 9)
3721 * C-c a C: Agenda dispatcher. (line 30)
3722 * C-c a M: Matching headline tags.
3724 * C-c a m: Matching headline tags.
3726 * C-c a M: Tag searches. (line 14)
3727 * C-c a m: Tag searches. (line 10)
3728 * C-c a T: Global TODO list. (line 15)
3729 * C-c a t <1>: Global TODO list. (line 9)
3730 * C-c a t: TODO basics. (line 27)
3731 * C-c C-a: Visibility cycling. (line 27)
3732 * C-c C-b: Motion. (line 15)
3733 * C-c C-c <1>: Setting tags. (line 11)
3734 * C-c C-c <2>: table.el. (line 6)
3735 * C-c C-c <3>: Editing/debugging formulas.
3737 * C-c C-c <4>: Built-in table editor.
3739 * C-c C-c: Plain Lists. (line 61)
3740 * C-c C-d: Creating timestamps. (line 37)
3741 * C-c C-f: Motion. (line 12)
3742 * C-c C-j: Motion. (line 21)
3743 * C-c C-l: Managing links. (line 23)
3744 * C-c C-n: Motion. (line 8)
3745 * C-c C-o <1>: Creating timestamps. (line 33)
3746 * C-c C-o: Managing links. (line 50)
3747 * C-c C-p: Motion. (line 9)
3748 * C-c C-q <1>: Editing/debugging formulas.
3750 * C-c C-q: Built-in table editor.
3752 * C-c C-r: Timeline. (line 13)
3753 * C-c C-s: Creating timestamps. (line 47)
3754 * C-c C-t: TODO basics. (line 13)
3755 * C-c C-u: Motion. (line 18)
3756 * C-c C-v: TODO basics. (line 20)
3757 * C-c C-w: Creating timestamps. (line 38)
3758 * C-c C-x a: ASCII export. (line 6)
3759 * C-c C-x b: HTML export. (line 11)
3760 * C-c C-x c: iCalendar export. (line 20)
3761 * C-c C-x C-c: Agenda commands. (line 177)
3762 * C-c C-x C-i: iCalendar export. (line 15)
3763 * C-c C-x C-k: Structure editing. (line 31)
3764 * C-c C-x C-w <1>: Built-in table editor.
3766 * C-c C-x C-w: Structure editing. (line 31)
3767 * C-c C-x C-y <1>: Built-in table editor.
3769 * C-c C-x C-y: Structure editing. (line 38)
3770 * C-c C-x h: HTML export. (line 10)
3771 * C-c C-x i: iCalendar export. (line 13)
3772 * C-c C-x M-w <1>: Built-in table editor.
3774 * C-c C-x M-w: Structure editing. (line 35)
3775 * C-c C-x t: HTML export. (line 14)
3776 * C-c C-x v: Sparse trees. (line 39)
3777 * C-c C-y: Creating timestamps. (line 63)
3778 * C-c l: Managing links. (line 9)
3779 * C-c |: Built-in table editor.
3781 * C-c ~: table.el. (line 18)
3782 * C-u C-c .: Creating timestamps. (line 16)
3783 * C-u C-c =: Built-in table editor.
3785 * C-u C-c C-l: Managing links. (line 36)
3786 * D: Agenda commands. (line 66)
3787 * d: Agenda commands. (line 63)
3788 * f: Agenda commands. (line 44)
3789 * g: Agenda commands. (line 70)
3790 * H: Agenda commands. (line 174)
3791 * i: Agenda commands. (line 145)
3792 * l: Agenda commands. (line 49)
3793 * L: Agenda commands. (line 32)
3794 * M: Agenda commands. (line 161)
3795 * M-<down>: Built-in table editor.
3797 * M-<left> <1>: Built-in table editor.
3799 * M-<left>: Structure editing. (line 13)
3800 * M-<RET> <1>: Plain Lists. (line 42)
3801 * M-<RET>: Structure editing. (line 6)
3802 * M-<right> <1>: Built-in table editor.
3804 * M-<right>: Structure editing. (line 16)
3805 * M-<TAB> <1>: Completion. (line 10)
3806 * M-<TAB> <2>: Setting tags. (line 6)
3807 * M-<TAB>: Per file keywords. (line 17)
3808 * M-<up>: Built-in table editor.
3810 * M-S-<down> <1>: Built-in table editor.
3812 * M-S-<down> <2>: Plain Lists. (line 46)
3813 * M-S-<down>: Structure editing. (line 28)
3814 * M-S-<left> <1>: Creating timestamps. (line 97)
3815 * M-S-<left> <2>: Built-in table editor.
3817 * M-S-<left> <3>: Plain Lists. (line 52)
3818 * M-S-<left>: Structure editing. (line 19)
3819 * M-S-<RET>: Structure editing. (line 10)
3820 * M-S-<right> <1>: Creating timestamps. (line 94)
3821 * M-S-<right> <2>: Built-in table editor.
3823 * M-S-<right> <3>: Plain Lists. (line 52)
3824 * M-S-<right>: Structure editing. (line 22)
3825 * M-S-<up> <1>: Built-in table editor.
3827 * M-S-<up> <2>: Plain Lists. (line 46)
3828 * M-S-<up>: Structure editing. (line 25)
3829 * mouse-1 <1>: Agenda commands. (line 35)
3830 * mouse-1 <2>: Creating timestamps. (line 79)
3831 * mouse-1: Managing links. (line 64)
3832 * mouse-2 <1>: Agenda commands. (line 35)
3833 * mouse-2: Managing links. (line 64)
3834 * mouse-3 <1>: Agenda commands. (line 28)
3835 * mouse-3: Managing links. (line 69)
3836 * n: Agenda commands. (line 19)
3837 * o: Agenda commands. (line 57)
3838 * P: Agenda commands. (line 115)
3839 * p: Agenda commands. (line 20)
3840 * q: Agenda commands. (line 184)
3841 * r <1>: Agenda commands. (line 74)
3842 * r: Global TODO list. (line 21)
3843 * S: Agenda commands. (line 165)
3844 * S-<down> <1>: Agenda commands. (line 124)
3845 * S-<down> <2>: Creating timestamps. (line 55)
3846 * S-<down>: Priorities. (line 25)
3847 * S-<left> <1>: Agenda commands. (line 136)
3848 * S-<left>: Creating timestamps. (line 50)
3849 * S-<RET>: Built-in table editor.
3851 * S-<right> <1>: Agenda commands. (line 128)
3852 * S-<right>: Creating timestamps. (line 50)
3853 * S-<TAB> <1>: Built-in table editor.
3855 * S-<TAB>: Visibility cycling. (line 19)
3856 * S-<up> <1>: Agenda commands. (line 118)
3857 * S-<up> <2>: Creating timestamps. (line 55)
3858 * S-<up>: Priorities. (line 25)
3859 * T: Agenda commands. (line 102)
3860 * t: Agenda commands. (line 98)
3861 * w: Agenda commands. (line 60)
3862 * x: Agenda commands. (line 187)
3868 Node: Introduction
\x7f7179
3869 Node: Summary
\x7f7493
3870 Node: Installation and activation
\x7f9605
3871 Node: Feedback
\x7f11274
3872 Node: Document Structure
\x7f12060
3873 Node: Outlines
\x7f12826
3874 Node: Headlines
\x7f13486
3875 Node: Visibility cycling
\x7f14109
3876 Node: Motion
\x7f15300
3877 Node: Structure editing
\x7f16084
3878 Node: Archiving
\x7f17827
3879 Node: Sparse trees
\x7f18687
3880 Ref: Sparse trees-Footnote-1
\x7f20716
3881 Ref: Sparse trees-Footnote-2
\x7f20808
3882 Node: Plain Lists
\x7f20922
3883 Ref: Plain Lists-Footnote-1
\x7f23678
3884 Node: Tables
\x7f24035
3885 Node: Built-in table editor
\x7f24583
3886 Node: Narrow columns
\x7f32197
3887 Ref: Narrow columns-Footnote-1
\x7f34130
3888 Node: Table calculations
\x7f34176
3889 Node: Formula syntax
\x7f35352
3890 Ref: Formula syntax-Footnote-1
\x7f38286
3891 Node: Column formulas
\x7f38585
3892 Node: Advanced features
\x7f40347
3893 Node: Named-field formulas
\x7f43602
3894 Node: Editing/debugging formulas
\x7f44242
3895 Node: Appetizer
\x7f46000
3896 Node: orgtbl-mode
\x7f47102
3897 Node: table.el
\x7f47593
3898 Node: Hyperlinks
\x7f48570
3899 Node: Link format
\x7f49204
3900 Node: Internal links
\x7f50500
3901 Node: Radio targets
\x7f52390
3902 Node: CamelCase links
\x7f53105
3903 Node: External links
\x7f53603
3904 Node: Managing links
\x7f55528
3905 Node: Search Options
\x7f59512
3906 Ref: Search Options-Footnote-1
\x7f60832
3907 Node: Remember
\x7f60913
3908 Ref: Remember-Footnote-1
\x7f64779
3909 Node: TODO items
\x7f64903
3910 Node: TODO basics
\x7f65826
3911 Node: Progress logging
\x7f67341
3912 Node: TODO extensions
\x7f68127
3913 Node: Workflow states
\x7f68927
3914 Node: TODO types
\x7f69795
3915 Ref: TODO types-Footnote-1
\x7f71453
3916 Node: Per file keywords
\x7f71535
3917 Ref: Per file keywords-Footnote-1
\x7f72988
3918 Node: Priorities
\x7f73216
3919 Node: Timestamps
\x7f74425
3920 Node: Time stamps
\x7f74746
3921 Node: Creating timestamps
\x7f76761
3923 Node: Tag inheritance
\x7f80625
3924 Node: Setting tags
\x7f81562
3925 Node: Tag searches
\x7f82524
3926 Node: Agenda Views
\x7f83733
3927 Node: Agenda files
\x7f85272
3928 Ref: Agenda files-Footnote-1
\x7f86232
3929 Ref: Agenda files-Footnote-2
\x7f86381
3930 Node: Agenda dispatcher
\x7f86573
3931 Node: Weekly/Daily Agenda
\x7f88703
3932 Node: Categories
\x7f89838
3933 Node: Time-of-day specifications
\x7f90486
3934 Node: Calendar/Diary integration
\x7f92462
3935 Node: Sorting of agenda items
\x7f93839
3936 Node: Global TODO list
\x7f94671
3937 Node: Matching headline tags
\x7f96086
3938 Node: Timeline
\x7f97029
3939 Node: Agenda commands
\x7f97902
3940 Node: Exporting
\x7f103158
3941 Node: ASCII export
\x7f103730
3942 Node: HTML export
\x7f104565
3943 Node: HTML formatting
\x7f105681
3944 Node: Export options
\x7f107313
3945 Node: Comment lines
\x7f109504
3946 Node: iCalendar export
\x7f109974
3947 Node: Miscellaneous
\x7f111769
3948 Node: Completion
\x7f112396
3949 Node: Customization
\x7f113392
3950 Node: Clean view
\x7f113840
3951 Node: TTY keys
\x7f116480
3953 Node: Interaction
\x7f124316
3954 Node: Bugs
\x7f127157
3955 Node: Acknowledgments
\x7f129466
3956 Node: Index
\x7f132396
3957 Node: Key Index
\x7f153038