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.21).
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.21).
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 * Updating settings:: How to tell Org-mode that settings have changed
169 * Clean view:: Getting rid of leading stars in the outline
170 * TTY keys:: Using Org-mode on a tty
171 * FAQ:: Frequently asked questions
172 * Interaction:: Other Emacs packages
173 * Bugs:: Things which do not work perfectly
174 * Acknowledgments:: These people provided feedback and more
177 File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
184 * Summary:: Brief summary of what Org-mode does
185 * Installation and activation:: How to install Org-mode
186 * Feedback:: Bug reports, ideas, patches etc.
189 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
194 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
195 project planning with a fast and effective plain-text system.
197 Org-mode develops organizational tasks around NOTES files that
198 contain information about projects as plain text. Org-mode is
199 implemented on top of outline-mode, which makes it possible to keep the
200 content of large files well structured. Visibility cycling and
201 structure editing help to work with the tree. Tables are easily
202 created with a built-in table editor. Org-mode supports ToDo items,
203 deadlines, time stamps, and scheduling. It dynamically compiles
204 entries into an agenda that utilizes and smoothly integrates much of
205 the Emacs calendar and diary. Plain text URL-like links connect to
206 websites, emails, Usenet messages, BBDB entries, and any files related
207 to the projects. For printing and sharing of notes, an Org-mode file
208 can be exported as a structured ASCII file, as HTML, or (todo and
209 agenda items only) as an iCalendar file.
211 Org-mode keeps simple things simple. When first fired up, it should
212 feel like a simple but easy to use outliner. Complexity is not
213 imposed, but a large amount of functionality is available when you need
214 it. Org-mode can be used on different levels and in different ways,
217 * as an outline extension with visibility cycling and structure editing
218 * as an ASCII system and table editor for taking structured notes
219 * as an ASCII table editor with spreadsheet-like capabilities
220 * as a simple hypertext system, with HTML export
221 * as a TODO list editor
222 * as a full agenda and planner with deadlines and work scheduling
224 The Org-mode table editor can be integrated into any major mode by
225 activating the minor Orgtbl-mode.
227 There is a website for Org-mode which provides links to the newest
228 version of Org-mode, as well as additional information, screen shots
229 and example files. This page is located at
230 `http://www.astro.uva.nl/~dominik/Tools/org/'.
233 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
235 1.2 Installation and Activation
236 ===============================
238 If Org-mode is part of the Emacs distribution or an XEmacs package, you
239 only need to copy the following lines to your `.emacs' file. The last
240 two lines define _global_ keys for the commands `org-store-link' and
241 `org-agenda' - please choose suitable keys yourself.
243 ;; The following lines are always needed. Choose your own keys.
244 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
245 (define-key global-map "\C-cl" 'org-store-link)
246 (define-key global-map "\C-ca" 'org-agenda)
248 If you have downloaded Org-mode from the Web, you must byte-compile
249 `org.el' and put it on your load path. In addition to the Emacs Lisp
250 lines above, you also need to add the following lines to `.emacs':
252 ;; These lines only if org-mode is not part of the X/Emacs distribution.
253 (autoload 'org-mode "org" "Org mode" t)
254 (autoload 'org-diary "org" "Diary entries from Org mode")
255 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
256 (autoload 'org-store-link "org" "Store a link to the current location" t)
257 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
258 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
260 With this setup, all files with extension `.org' will be put into
261 Org-mode. As an alternative, make the first line of a file look like
264 MY PROJECTS -*- mode: org; -*-
266 which will select Org-mode for this buffer no matter what the file's
267 name is. See also the variable `org-insert-mode-line-in-empty-file'.
270 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
275 If you find problems with Org-mode, or if you have questions, remarks,
276 or ideas about it, please contact the maintainer Carsten Dominik at
277 <dominik@science.uva.nl>.
279 For bug reports, please provide as much information as possible,
280 including the version information of Emacs (`C-h v emacs-version
281 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
282 Org-mode related setup in `.emacs'. If an error occurs, a traceback
283 can be very useful. Often a small example file helps, along with clear
286 1. What exactly did you do?
288 2. What did you expect to happen?
290 3. What happened instead?
291 Thank you for helping to improve this mode.
294 File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
299 Org-mode is based on outline mode and provides flexible commands to
300 edit the structure of the document.
304 * Outlines:: Org-mode is based on outline-mode
305 * Headlines:: How to typeset org-tree headlines
306 * Visibility cycling:: Show and hide, much simplified
307 * Motion:: Jumping to other headlines
308 * Structure editing:: Changing sequence and level of headlines
309 * Archiving:: Move done task trees to a different place
310 * Sparse trees:: Matches embedded in context
311 * Plain Lists:: Editing hand-formatted lists
314 File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
319 Org-mode is implemented on top of outline-mode. Outlines allow to
320 organize a document in a hierarchical structure, which (at least for
321 me) is the best representation of notes and thoughts. Overview over
322 this structure is achieved by folding (hiding) large parts of the
323 document to show only the general document structure and the parts
324 currently being worked on. Org-mode greatly simplifies the use of
325 outlines by compressing the entire show/hide functionality into a
326 single command `org-cycle', which is bound to the <TAB> key.
329 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
334 Headlines define the structure of an outline tree. The headlines in
335 Org-mode start with one or more stars, on the left margin. For example:
343 * Another top level headline
345 Some people find the many stars too noisy and would prefer an outline
346 that has whitespace followed by a single star as headline starters.
347 *Note Clean view:: describes a setup to realize this.
350 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
352 2.3 Visibility cycling
353 ======================
355 Outlines make it possible to hide parts of the text in the buffer.
356 Org-mode uses a single command bound to the <TAB> key to change the
357 visibility in the buffer.
360 Rotate current subtree between the states
362 ,-> FOLDED -> CHILDREN -> SUBTREE --.
363 '-----------------------------------'
365 At the beginning of the buffer (or when called with `C-u'), this
366 does the same as the command `S-<TAB>' below.
369 Rotate the entire buffer between the states
371 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
372 '--------------------------------------'
374 Note that inside tables, `S-<TAB>' jumps to the previous field.
379 When Emacs first visits an Org-mode file, the global state is set to
380 OVERVIEW, i.e. only the top level headlines are visible. This can be
381 configured through the variable `org-startup-folded', or on a per-file
382 basis by adding one of the following lines anywhere in the buffer:
389 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
394 The following commands jump to other headlines in the buffer.
403 Next heading same level.
406 Previous heading same level.
409 Backward to higher level heading.
412 Jump to a different place without changing the current outline
413 visibility. Shows the document structure in a temporary buffer,
414 where you can use visibility cycling (<TAB>) to find your
415 destination. After pressing <RET>, the cursor moves to the
416 selected location in the original buffer, and the headings
417 hierarchy above it is made visible.
420 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document Structure
422 2.5 Structure editing
423 =====================
426 Insert new heading with same level as current. If the cursor is
427 in a plain list item, a new item is created. To force creation of
428 a new headline, use a prefix arg, or first press <RET> to get to
429 the beginning of the next line.
432 Insert new TODO entry with same level as current heading.
435 Promote current heading by one level.
438 Demote current heading by one level.
441 Promote the current subtree by one level.
444 Demote the current subtree by one level.
447 Move subtree up (swap with previous subtree of same level).
450 Move subtree down (swap with next subtree of same level).
454 Kill subtree, i.e. remove it from buffer but save in kill ring.
457 Copy subtree to kill ring.
460 Yank subtree from kill ring. This does modify the level of the
461 subtree to make sure the tree fits in nicely at the yank position.
462 The yank level can also be specified with a prefix arg, or by
463 yanking after a headline marker like `****'.
465 When there is an active region (transient-mark-mode), promotion and
466 demotion work on all headlines in the region. To select a region of
467 headlines, it is best to place both point and mark at the beginning of a
468 line, mark at the beginning of the first headline, and point at the line
469 just after the last headline to change. Note that when the cursor is
470 inside a table (*note Tables::), the Meta-Cursor keys have different
474 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document Structure
479 When a project represented by a (sub)tree is finished, you may want to
480 move the tree to an archive place, either in the same file under a
481 special top-level heading, or even to a different file.
483 Archive the subtree starting at the cursor position to the location
484 given by `org-archive-location'.
486 The default archive is a file in the same directory as the current
487 file, with the name derived by appending `_archive' to the current file
488 name. For information and examples on how to change this, see the
489 documentation string of the variable `org-archive-location'. If you
490 are also using the Org-mode agenda, archiving to a different file is a
491 good way to keep archived trees from contributing agenda items.
494 File: org, Node: Sparse trees, Next: Plain Lists, Prev: Archiving, Up: Document Structure
499 An important feature of Org-mode is the ability to construct _sparse
500 trees_ for selected information in an outline tree. A sparse tree
501 means that the entire document is folded as much as possible, but the
502 selected information is made visible along with the headline structure
503 above it(1). Just try it out and you will see immediately how it works.
505 Org-mode contains several commands creating such trees. The most
506 basic one is `org-occur':
509 Occur. Prompts for a regexp and shows a sparse tree with all
510 matches. If the match is in a headline, the headline is made
511 visible. If the match is in the body of an entry, headline and
512 body are made visible. In order to provide minimal context, also
513 the full hierarchy of headlines above the match is shown, as well
514 as the headline following the match. Each match is also
515 highlighted, the highlights disappear when the buffer is changed
516 with an editing command.
517 For frequently used sparse trees of specific search strings, you can
518 use the variable `org-agenda-custom-commands' to define fast keyboard
519 access to specific sparse trees. These commands will then be
520 accessible through the agenda dispatcher (*note Agenda dispatcher::).
523 (setq org-agenda-custom-commands
524 '(("f" occur-tree "FIXME")))
526 will define the key `C-c a f' as a shortcut for creating a sparse tree
527 matching the string `FIXME'.
529 Other commands are using sparse trees as well. For example `C-c
530 C-v' creates a sparse TODO tree (*note TODO basics::).
532 To print a sparse tree, you can use the Emacs command
533 `ps-print-buffer-with-faces' which does not print invisible parts of
534 the document (2). Or you can use the command `C-c C-x v' to copy the
535 visible part of the document to another file (extension `.txt') which
536 can then be printed in any desired way.
538 ---------- Footnotes ----------
540 (1) See also the variables `org-show-hierarchy-above' and
541 `org-show-following-heading'.
543 (2) This does not work under XEmacs, because XEmacs uses selective
544 display for outlining, not text properties
547 File: org, Node: Plain Lists, Prev: Sparse trees, Up: Document Structure
552 Headlines define both the structure of the Org-mode file, and also lists
553 (for example, TODO items (*note TODO items::) should be created using
554 headline levels). However, when taking notes, the plain text is
555 sometimes easier to read with hand-formatted lists. Org-mode supports
556 editing such lists, and the HTML exporter (*note Exporting::) does
557 parse and format them.
559 Org-mode knows ordered and unordered lists. Unordered list items
560 start with `-', `+', or `*'(1) as bullets. Ordered list items start
561 with `1.' or `1)'. Items belonging to the same list must have the same
562 indentation on the first line. In particular, if an ordered list
563 reaches number `10.', then the 2-digit numbers must be written
564 left-aligned with the other numbers in the list. Indentation also
565 determines the end of a list item. It ends before the next line that
566 is indented like the bullet/number, or less. For example:
569 My favorite scenes are (in this order)
570 1. Eowyns fight with the witch king
571 + this was already my favorite scene in the book
572 + I really like Miranda Otto.
573 2. The attack of the Rohirrim
574 3. Peter Jackson being shot by Legolas
576 He makes a really funny face when it happens.
578 Org-mode supports these lists by tuning filling and wrapping commands
579 to correctly deal with them. Furthermore, the following commands act
580 on items when the cursor is in the first line of an item (the line with
581 the bullet or number).
584 Items can be folded just like headline levels if you set the
585 variable `org-cycle-include-plain-lists'. The level of an item is
586 then given by the indentation of the bullet/number. However,
587 items are always subordinate to real headlines, the hierarchies
588 remain completely separated.
591 Insert new item at current level. With prefix arg, for a new
596 Move the item including subitems up/down (swap with previous/next
597 item of same indentation). If the list is ordered, renumbering is
602 Decrease/increase the indentation of the item, including subitems.
603 Initially, the item tree is selected based on current indentation.
604 When these commands are executed several times in direct
605 succession, the initially selected region is used, even if the new
606 indentation would imply a different hierarchy. To use the new
607 hierarchy, break the command chain with a cursor motion or so.
610 Renumber the ordered list at the cursor.
612 ---------- Footnotes ----------
614 (1) When using `*' as a bullet, lines must be indented or they will
615 be seen as top-level headlines. Also, when you are hiding leading
616 stars to get a clean outline view, plain list items starting with a
617 star are visually indistinguishable from true headlines. In short:
618 even though `*' is supported, it may be better to not use it for plain
622 File: org, Node: Tables, Next: Hyperlinks, Prev: Document Structure, Up: Top
627 Org-mode has a very fast and intuitive table editor built-in.
628 Spreadsheet-like calculations are supported in connection with the
629 Emacs `calc' package.
633 * Built-in table editor:: Simple tables
634 * Narrow columns:: Stop wasting space in tables
635 * Table calculations:: Compute a field from other fields
636 * orgtbl-mode:: The table editor as minor mode
637 * table.el:: Complex tables
640 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
642 3.1 The built-in table editor
643 =============================
645 Org-mode makes it easy to format tables in plain ASCII. Any line with
646 `|' as the first non-white character is considered part of a table.
647 `|' is also the column separator. A table might look like this:
649 | Name | Phone | Age |
650 |-------+-------+-----|
651 | Peter | 1234 | 17 |
654 A table is re-aligned automatically each time you press <TAB> or
655 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
656 field (<RET> to the next row) and creates new table rows at the end of
657 the table or before horizontal lines. The indentation of the table is
658 set by the first line. Any line starting with `|-' is considered as a
659 horizontal separator line and will be expanded on the next re-align to
660 span the whole table width. So, to create the above table, you would
666 and then press <TAB> to align the table and start filling in fields.
668 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
669 and all character keys in a special way, so that inserting and deleting
670 avoids shifting other fields. Also, when typing _immediately after the
671 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
672 the field is automatically made blank. If this behavior is too
673 unpredictable for you, configure the variables
674 `org-enable-table-editor' and `org-table-auto-blank-field'.
676 Creation and conversion
677 .......................
680 Convert the active region to table. If every line contains at
681 least one TAB character, the function assumes that the material is
682 tab separated. If not, lines are split at whitespace into fields.
683 You can use a prefix argument to indicate the minimum number of
684 consequtive spaces required to indentify a field separator
686 If there is no active region, this command creates an empty
687 Org-mode table. However, it's easier to just start typing, like
688 `|Name|Phone|Age <RET> |- <TAB>'.
690 Re-aligning and field motion
691 ............................
694 Re-align the table without moving the cursor.
697 Re-align the table, move to the next field. Creates a new row if
701 Re-align, move to previous field.
704 Re-align the table and move down to next row. Creates a new row if
705 necessary. At the beginning or end of a line, <RET> still does
706 NEWLINE, so it can be used to split a table.
708 Column and row editing
709 ......................
713 Move the current column left/right.
716 Kill the current column.
719 Insert a new column to the left of the cursor position.
723 Move the current row up/down.
726 Kill the current row or horizontal line.
729 Insert a new row above (with arg: below) the current row.
732 Insert a horizontal line below current row. With prefix arg, the
733 line is created above the current line.
736 Sort the table lines in the region. Point and mark must be in the
737 first and last line to be included, and must be in the column that
738 should be used for sorting. The command prompts for numerical
739 versus alphanumerical sorting.
745 Copy a rectangular region from a table to a special clipboard.
746 Point and mark determine edge fields of the rectangle. The
747 process ignores horizontal separator lines.
750 Copy a rectangular region from a table to a special clipboard, and
751 blank all fields in the rectangle. So this is the "cut" operation.
754 Paste a rectangular region into a table. The upper right corner
755 ends up in the current field. All involved fields will be
756 overwritten. If the rectangle does not fit into the present table,
757 the table is enlarged as needed. The process ignores horizontal
761 Wrap several fields in a column like a paragraph. If there is an
762 active region, and both point and mark are in the same column, the
763 text in the column is wrapped to minimum width for the given
764 number of lines. A prefix ARG may be used to change the number of
765 desired lines. If there is no region, the current field is split
766 at the cursor position and the text fragment to the right of the
767 cursor is prepended to the field one line down. If there is no
768 region, but you specify a prefix ARG, the current field is made
769 blank, and the content is appended to the field above.
775 Install a new formula for the current column and replace current
776 field with the result of the formula.
779 Install a new formula for the current field, which must be a named
780 field. Evaluate the formula and replace the field content with the
784 Edit all formulas associated with the current table in a separate
788 Recalculate the current row by applying the stored formulas from
789 left to right. When called with a `C-u' prefix, recalculate the
790 entire table, starting with the first non-header line (i.e. below
791 the first horizontal separator line). For details, see *Note
792 Table calculations::.
795 Rotate the calculation mark in first column through the states `',
796 `#', `*', `!', `$'. For the meaning of these marks see *Note
797 Advanced features::. When there is an active region, change all
801 Which table column is the cursor in? Displays number >0 in echo
805 Sum the numbers in the current column, or in the rectangle defined
806 by the active region. The result is shown in the echo area and can
807 be inserted with `C-y'.
810 When current field is empty, copy from first non-empty field above.
811 When not empty, copy current field down to next row and move cursor
812 along with it. Depending on the variable
813 `org-table-copy-increment', integer field values will be
814 incremented during copy. This key is also used by CUA-mode (*note
821 Edit the current field in a separate window. This is useful for
822 fields that are not fully visible (*note Narrow columns::). When
823 called with a `C-u' prefix, just make the full field visible, so
824 that it can be edited in place.
827 This is an alias for `C-u C-c `' to make the current field fully
830 `M-x org-table-import'
831 Import a file as a table. The table should be TAB- or whitespace
832 separated. Useful, for example, to import an Excel table or data
833 from a database, because these programs generally can write
834 TAB-separated text files. This command works by inserting the
835 file into the buffer and then converting the region to a table.
836 Any prefix argument is passed on to the converter, which uses it
837 to determine the separator.
839 `M-x org-table-export'
840 Export the table as a TAB-separated file. Useful for data
841 exchange with, for example, Excel or database programs.
844 If you don't like the automatic table editor because it gets in your
845 way on lines which you would like to start with `|', you can turn it
848 (setq org-enable-table-editor nil)
850 The only table command which then still works is `C-c C-c' to do a
854 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
859 The width of columns is automatically determined by the table editor.
860 Sometimes a single field or a few fields need to carry more text,
861 leading to unconveniently wide columns. To limit(1) the width of a
862 column, one field anywhere in the column must carry the string `<N>'
863 where `N' is an integer specifying the width of the column in
864 characters. The next re-align will then set the width of this column
865 to no more than this value.
867 |---+------------------------------| |---+--------|
869 | 1 | one | | 1 | one |
870 | 2 | two | ----\ | 2 | two |
871 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
872 | 4 | four | | 4 | four |
873 |---+------------------------------| |---+--------|
875 Fields that are wider become clipped and end in the string `=>'. Note
876 that the full text is still in the buffer, it is only invisible. To
877 see the full text, hold the mouse over the field - a tooltip window
878 will show the full content. To edit such a field, use the command `C-c
879 `' (that is `C-c' followed by the backquote). This will open a new
880 window with the full field. Edit it and finish with `C-c C-c'.
882 When visiting a file containing a table with narrowed columns, the
883 necessary character hiding has not yet happened, and the table needs to
884 be aligned before it looks nice. Setting the option
885 `org-startup-align-all-tables' will realign all tables in a file upon
886 visiting, but also slow down startup. You can also set this option on
887 a per-file basis with:
892 ---------- Footnotes ----------
894 (1) This feature does not work on XEmacs.
897 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
899 3.3 Calculations in tables
900 ==========================
902 The table editor makes use of the Emacs `calc' package to implement
903 spreadsheet-like capabilities. Org-mode has two levels of complexity
904 for table calculations. On the basic level, tables do only horizontal
905 computations, so a field can be computed from other fields _in the same
906 row_, and Org-mode assumes that there is only one formula for each
907 column. This is very efficient to work with and enough for many tasks.
908 On the complex level, columns and individual fields can be named for
909 easier referencing in formulas, individual named fields can have their
910 own formula associated with them, and recalculation can be automated.
914 * Formula syntax:: How to write a formula
915 * Column formulas:: Formulas valid for all fields in a column
916 * Advanced features:: Field names, parameters and automatic recalc
917 * Named-field formulas:: Formulas valid in single fields
918 * Editing/debugging formulas:: Changing a stored formula
919 * Appetizer:: Taste the power of calc
922 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
927 A formula can be any algebraic expression understood by the Emacs
928 `calc' package. Note that `calc' has the slightly non-standard
929 convention that `/' has lower precedence than `*', so that `a/b*c' is
930 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
931 calc-eval: (calc)Calling Calc from Your Lisp Programs.), variable
932 substitution takes place:
934 $ refers to the current field
935 $3 refers to the field in column 3 of the current row
936 $3..$7 a vector of the fields in columns 3-7 of current row
937 $P1..$P3 vector of column range, using column names
938 &2 second data field above the current, in same column
939 &5-2 vector from fifth to second field above current
940 &III-II vector of fields between 2nd and 3rd hline above
941 &III vector of fields between third hline above and current field
942 $name a named field, parameter or constant
944 The range vectors can be directly fed into the calc vector functions
945 like `vmean' and `vsum'.
947 `$name' is interpreted as the name of a column, parameter or
948 constant. Constants are defined globally through the variable
949 `org-table-formula-constants'. If you have the `constants.el' package,
950 it will also be used to resolve constants, including natural constants
951 like `$h' for Planck's constant, and units like `$km' for kilometers.
952 Column names and parameters can be specified in special table lines.
953 These are described below, see *Note Advanced features::.
955 A formula can contain an optional mode string after a semicolon.
956 This string consists of flags to influence calc's modes(1) during
957 execution, e.g. `p20' to switch the internal precision to 20 digits,
958 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
959 or fixed display format, respectively, and `D', `R', `F', and `S' to
960 turn on degrees, radians, fraction and symbolic modes, respectively.
961 In addition, you may provide a `printf' format specifier to reformat
962 the final result. A few examples:
964 $1+$2 Sum of first and second field
965 $1+$2;%.2f Same, format result to two decimals
966 exp($2)+exp($1) Math functions can be used
967 $;%.1f Reformat current cell to 1 decimal
968 ($3-32)*5/9 Degrees F -> C conversion
969 $c/$1/$cm Hz -> cm conversion, using `constants.el'
970 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
971 sin($1);Dp3%.1e Same, but use printf specifier for display
972 vmean($2..$7) Compute column range mean, using vector function
973 vsum(&III) Sum numbers from 3rd hline above, up to here
974 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
976 ---------- Footnotes ----------
978 (1) By default, Org-mode uses the standard calc modes (precision 12,
979 angular units degrees, fraction and symbolic modes off). However, the
980 display format has been changed to `(float 5)' to keep tables compact.
981 The default settings can be configured using the variable
982 `org-calc-default-modes'.
985 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
987 3.3.2 Column formulas
988 ---------------------
990 To apply a formula to a field, type it directly into the field,
991 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
992 <RET> or `C-c C-c' with the cursor still in the field, the formula will
993 be stored as the formula for the current column, evaluated and the
994 current field replaced with the result. If the field contains only
995 `=', the previously stored formula for this column is used.
997 For each column, Org-mode will remember the most recently used
998 formula. The information is stored in a special line starting with
999 `#+TBLFM' directly below the table. When adding/deleting/moving
1000 columns with the appropriate commands, the stored equations will be
1001 modified accordingly. When a column used in a calculation is removed,
1002 references to this column become invalid and will cause an error upon
1003 applying the equation.
1005 Instead of typing an equation into the field, you may also use the
1006 command `C-c ='. It prompts for a formula (with default taken from the
1007 `#+TBLFM:' line) and applies it to the current field. A numerical
1008 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1009 in the current column.
1011 To recompute all the fields in a line, use the command `C-c *'. It
1012 re-applies all stored equations to the current row, from left to right.
1013 With a `C-u' prefix, this will be done to every line in the table, so
1014 use this command it you want to make sure the entire table is
1015 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1016 Global updating does not touch the line(s) above the first horizontal
1017 separator line, assuming that this is the table header.
1020 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1022 3.3.3 Advanced features
1023 -----------------------
1025 If you want the recalculation of fields to happen automatically, or if
1026 you want to be able to assign a formula to an individual field (instead
1027 of an entire column) you need to reserve the first column of the table
1028 for special marking characters. Here is an example of a table that
1029 collects exam results of students and makes use of these features:
1031 |---+---------+--------+--------+--------+-------+------|
1032 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1033 |---+---------+--------+--------+--------+-------+------|
1034 | ! | | P1 | P2 | P3 | Tot | |
1035 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1036 | ^ | | m1 | m2 | m3 | mt | |
1037 |---+---------+--------+--------+--------+-------+------|
1038 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1039 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1040 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1041 |---+---------+--------+--------+--------+-------+------|
1042 | | Average | | | | 29.7 | |
1043 | ^ | | | | | at | |
1044 | $ | max=50 | | | | | |
1045 |---+---------+--------+--------+--------+-------+------|
1046 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1048 Important: Please note that for these special tables, recalculating the
1049 table with `C-u C-c *' will only affect rows which are marked `#' or
1050 `*', and named fields. The column formulas are not applied in rows
1051 with empty first field.
1053 The marking characters have the following meaning:
1055 The fields in this line define names for the columns, so that you
1056 may refer to a column as `$Tot' instead of `$6'.
1059 This row defines names for the fields _above_ the row. With such
1060 a definition, any formula in the table may use `$m1' to refer to
1061 the value `10'. Also, named fields can have their own formula
1062 associated with them.
1065 Similar to `^', but defines names for the fields in the row
1069 Fields in this row can define _parameters_ for formulas. For
1070 example, if a field in a `$' row contains `max=50', then formulas
1071 in this table can refer to the value 50 using `$max'. Parameters
1072 work exactly like constants, only that they can be defined on a
1073 per-table basis. Changing a parameter and then recalculating the
1074 table can be useful.
1077 Fields in this row are automatically recalculated when pressing
1078 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1079 selected for a global recalculation with `C-u C-c *'. Unmarked
1080 lines will be left alone by this command.
1083 Selects this line for global recalculation with `C-u C-c *', but
1084 not for automatic recalculation. Use this when automatic
1085 recalculation slows down editing too much.
1088 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1089 All lines that should be recalculated should be marked with `#' or
1093 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1095 3.3.4 Named-field formulas
1096 --------------------------
1098 A named field can have its own formula associated with it. In the
1099 example above, this is used for the `at' field that contains the
1100 average result of the students. To enter a formula for a named field,
1101 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1102 This equation will be stored below the table like `$name=...'. Any
1103 recalculation in the table (even if only requested for the current
1104 line) will also update all named field formulas.
1107 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1109 3.3.5 Editing and debugging formulas
1110 ------------------------------------
1112 To edit a column or field formula, use the commands `C-c =' and `C-u
1113 C-c =', respectively. The currently active expression is then
1114 presented as default in the minibuffer, where it may be edited.
1116 Note that making a table field blank does not remove the formula
1117 associated with the field - during the next recalculation the field
1118 will be filled again. To remove a formula from a field, you have to
1119 give an empty reply when prompted for the formula, or to edit the
1122 You may edit the `#+TBLFM' directly and re-apply the changed
1123 equations with `C-c C-c' in that line, or with the normal recalculation
1124 commands in the table.
1126 In particular for large tables with many formulas, it is convenient
1127 to use the command `C-c '' to edit the formulas of the current table in
1128 a separate buffer. That buffer will show the formulas one per line,
1129 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1130 `$...' expression to get information about its interpretation.
1131 Exiting the buffer with `C-c C-c' only stores the modified formulas
1132 below the table. Exiting with `C-u C-c C-c' also applies them to the
1133 entire table. `C-c C-q' exits without installing the changes.
1135 When the evaluation of a formula leads to an error, the field content
1136 becomes the string `#ERROR'. If you would like see what is going on
1137 during variable substitution and calculation in order to find a bug,
1138 turn on formula debugging in the menu and repeat the calculation, for
1139 example by pressing `C-c = <RET>' in a field. Detailed information
1143 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1148 Finally, just to wet your appetite on what can be done with the
1149 fantastic `calc' package, here is a table that computes the Taylor
1150 series for a couple of functions (homework: try that with Excel :-)
1152 |---+-------------+---+-----+--------------------------------------|
1153 | | Func | n | x | Result |
1154 |---+-------------+---+-----+--------------------------------------|
1155 | # | exp(x) | 1 | x | 1 + x |
1156 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1157 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1158 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1159 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1160 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1161 |---+-------------+---+-----+--------------------------------------|
1162 #+TBLFM: $5=taylor($2,$4,$3);n3
1165 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1167 3.4 The Orgtbl minor mode
1168 =========================
1170 If you like the intuitive way the Org-mode table editor works, you
1171 might want to use it also in other modes like text-mode or mail-mode.
1172 The minor mode Orgtbl-mode makes this possible. You can always toggle
1173 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1176 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1179 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1181 3.5 The `table.el' package
1182 ==========================
1184 Complex ASCII tables with automatic line wrapping, column- and
1185 row-spanning, and alignment can be created using the Emacs table
1186 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1187 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1188 table, Org-mode will call `table-recognize-table' and move the cursor
1189 into the table. Inside a table, the keymap of Org-mode is inactive.
1190 In order to execute Org-mode-related commands, leave the table.
1193 Recognize `table.el' table. Works when the cursor is in a
1197 Insert a table.el table. If there is already a table at point,
1198 this command converts it between the table.el format and the
1199 Org-mode format. See the documentation string of the command
1200 `org-convert-table' for the restrictions under which this is
1204 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1209 Just like HMTL, Org-mode provides links inside a file, and external
1210 links to other files, Usenet articles, emails and much more.
1214 * Link format:: How links in Org-mode are formatted
1215 * Internal links:: Links to other places in the current file
1216 * External links:: URL-like links to the world
1217 * Managing links:: Creating, inserting and following
1218 * Search Options:: Linking to a specific location
1219 * Remember:: Org-trees store quick notes
1222 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1227 Org-mode will recognize plain URL-like links and activate them as
1228 clickable links. However, the general link format looks like this:
1230 [[link][description]] or alternatively [[link]]
1232 Once a link in the buffer is complete (all brackets present),
1233 Org-mode will change the display so that `description' is displayed
1234 instead of `[[link][description]]' and `link' is displayed instead of
1235 `[[link]]'. Links will be highlighted in the face `org-link', which by
1236 default is an underlined face. You can directly edit the visible part
1237 of a link. Note that this can be either the `link' part (if there is
1238 not description) or the `description' part. To edit also the invisible
1239 `link' part, use `C-c C-l' with the cursor on the link.
1241 If you place the cursor at the beginning or just behind the end of
1242 the displayed text and press <BACKSPACE>, you will remove the
1243 (invisible) bracket at that location. This makes the link incomplete
1244 and the internals are again displayed as plain text. Inserting the
1245 missing bracket does hide the link internals again. To show the
1246 internal structure of all links, use the menu entry
1247 `Org->Hyperlinks->Literal links'.
1250 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1255 If the link text does not look like a URL, links are considered to be
1256 internal in the current file. Links such as `[[My Target]]' or `[[My
1257 Target][Find my target]]' lead to a text search in the current file.
1258 The link can be followed with `C-c C-o' when the cursor is on the link,
1259 or with a mouse click (*note Managing links::). The preferred match
1260 for such a link is a dedicated target: The same string in double
1261 angular brackets. Targets may be located anywhere, often it is
1262 convenient to put them into a comment line, for example
1266 If no dedicated target exists, Org-mode will search for the words in
1267 the link, often removing the need for a dedicated target. In the above
1268 example the search would be for `my target'. Links starting with a
1269 star like `*My Target' restrict the search to headlines. When
1270 searching, Org-mode will first try an exact match, but then move on to
1271 more and more lenient searches. For example, the link `[[*My
1272 Targets]]' will find any of the following:
1275 ** TODO my targets are bright
1276 ** my 20 targets are
1278 To insert a link targeting a headline, in-buffer completion can be
1279 used. Just type a star followed by a few optional letters into the
1280 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1281 offered as completions. *Note Managing links::, for more commands
1284 Following a link pushes a mark onto Org-mode's own mark ring. You
1285 can return to the previous position with `C-c &'. Using this command
1286 several times in direct succession goes back to positions recorded
1291 * Radio targets:: Make targets trigger links in plain text.
1292 * CamelCase links:: Activating CamelCase words as links
1295 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1300 You can configure Org-mode to link any occurrences of certain target
1301 names in normal text. So without explicitly creating a link, the text
1302 connects to the target radioing its position. Radio targets are
1303 enclosed by triple angular brackets. For example, a target `<<<My
1304 Target>>>' causes each occurrence of `my target' in normal text to
1305 become activated as a link. The Org-mode file is scanned automatically
1306 for radio targets only when the file is first loaded into Emacs. To
1307 update the target list during editing, press `C-c C-c' with the cursor
1311 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1313 4.2.2 CamelCase words as links
1314 ------------------------------
1316 Org-mode also supports CamelCase words as links. This feature is not
1317 turned on by default because of the inconsistencies this system suffers
1318 from. To activate CamelCase words as links, you need to customize the
1319 option `org-activate-links'. A CamelCase word then leads to a text
1320 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1323 File: org, Node: External links, Next: Managing links, Prev: Internal links, Up: Hyperlinks
1328 Org-mode supports links to files, websites, Usenet and email messages;
1329 and BBDB database entries. External links are URL-like locators. The
1330 following list shows examples for each link type.
1332 http://www.astro.uva.nl/~dominik on the web
1333 file:/home/dominik/images/jupiter.jpg file, absolute path
1334 file:papers/last.pdf file, relative path
1335 news:comp.emacs Usenet link
1336 mailto:adent@galaxy.net Mail link
1337 vm:folder VM folder link
1338 vm:folder#id VM message link
1339 vm://myself@some.where.org/folder#id VM on remote machine
1340 wl:folder WANDERLUST folder link
1341 wl:folder#id WANDERLUST message link
1342 mhe:folder MH-E folder link
1343 mhe:folder#id MH-E message link
1344 rmail:folder RMAIL folder link
1345 rmail:folder#id RMAIL message link
1346 gnus:group GNUS group link
1347 gnus:group#id GNUS article link
1348 bbdb:Richard Stallman BBDB link
1349 shell:ls *.org A shell command
1351 A link should be enclosed in double brackets and may contain a
1352 descriptive text to be displayed instead of the url (*note Link
1353 format::), for example:
1355 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1357 Org-mode also finds external links in the normal text and activates
1358 them as links. If spaces must be part of the link (for example in
1359 `bbdb:Richard Stallman') or to remove ambiguities about the end of the
1360 link, enclose them in angular brackets.
1363 File: org, Node: Managing links, Next: Search Options, Prev: External links, Up: Hyperlinks
1368 Org-mode provides methods to create a link in the correct syntax, to
1369 insert it into an org-mode file, and to follow the link.
1372 Store a link to the current location. This is a _global_ command
1373 which can be used in any buffer to create a link. The link will be
1374 stored for later insertion into an Org-mode buffer (see below).
1375 For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link
1376 will point to the current article/entry. For W3 and W3M buffers,
1377 the link goes to the current URL. For Org-mode files, the current
1378 headline is targeted. For any other files, the link will point to
1379 the file, with a search string (*note Search Options::) pointing
1380 to the contents of the current line. If there is an active
1381 region, the selected words will form the basis of the search
1382 string. The key binding `C-c l' is only a suggestion - see *Note
1383 Installation and activation::.
1386 Insert a link. This prompts for a link to be inserted into the
1387 buffer. You can just type a link, using text for an internal
1388 link, or one of the link type prefixes mentioned in the examples
1389 above. Through completion, all links stored during the current
1390 session can be accessed. The link will be formatted as given in
1391 the variable `org-link-format' and inserted into the buffer, along
1392 with a descriptive text. Note that you don't have to use this
1393 command to insert a link. Links in Org-mode are plain text, and
1394 you can type or paste them straight into the buffer. By using
1395 this command, the links are automatically enclosed in double
1396 brackets, and you will be asked for the optional descriptive text.
1399 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1400 file will be inserted and you may use file name completion to
1401 select the name of the file. The path to the file is inserted
1402 relative to the directory of the current org file, if the linked
1403 file is in the current directory or in a subdirectory of it.
1404 Otherwise an absolute path, if possible with `~/' for your home
1405 directory is used. You can force an absolute path with two `C-u'
1408 `C-c C-l with cursor on existing link'
1409 When the cursor is on an existing link, `C-c C-l' allows to edit
1410 the link and description parts of the link.
1413 Open link at point. This will launch a web browser for URLs (using
1414 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1415 the corresponding links, and execute the command in a shell link.
1416 When the cursor is on an internal link, this commands runs the
1417 corresponding search. When the cursor is on a TAGS list in a
1418 headline, it creates the corresponding TAGS view. If the cursor
1419 is on a time stamp, it compiles the agenda for that date.
1420 Furthermore, it will visit text files in `file:' links with Emacs
1421 and select a suitable application for non-text files.
1422 Classification of files is based on file extension only. See
1423 option `org-file-apps'. If you want to override the default
1424 application and visit the file with Emacs, use a `C-u' prefix.
1428 On links, `mouse-2' will open the link just like `C-c C-o' would.
1429 Under Emacs 22, also `mouse-1' will follow a link.
1432 Like `mouse-2', but force file links to be opened with Emacs.
1435 Push the current position onto the mark ring, to be able to return
1436 easily. Commands following an internal link do this automatically.
1439 Jump back to a recorded position. A position is recorded by the
1440 commands following internal links, and by `C-c %'. Using this
1441 command several times in direct succession moves through a ring of
1442 previously recorded positions.
1445 File: org, Node: Search Options, Next: Remember, Prev: Managing links, Up: Hyperlinks
1447 4.5 Search options in file links
1448 ================================
1450 File links can contain additional information to make Emacs jump to a
1451 particular location in the file when following a link. This can be a
1452 line number or a search option after a double(1) colon. For example:
1454 [[file:~/code/main.c::255]]
1455 [[file:~/xx.org::My Target]]
1456 [[file:~/xx.org::*My Target]]
1457 [[file:~/xx.org::/regexp/]]
1459 Here is what these options do.
1465 Search for a link target `<<My Target>>', or do a text search for
1466 `my target', similar to the search in internal links, see *Note
1470 In an Org-mode file, restrict search to headlines.
1473 Do a regular expression search for `regexp'. This uses the Emacs
1474 command `occur' to list all matches in a separate window. If the
1475 target file is in Org-mode, `org-occur' is used to create a sparse
1476 tree with the matches.
1478 As a degenerate case, a file link with an empty file name can be used
1479 to search the current file. For example, `<file:::find me>' does a
1480 search for `find me' in the current file, just like `[[find me]]' would.
1482 ---------- Footnotes ----------
1484 (1) For backward compatibility, line numbers can also follow a
1488 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1493 Another way to create org entries with links to other files is through
1494 the _Remember_ package by John Wiegley. _Remember_ lets you store
1495 quick notes with little interruption of your work flow. See
1496 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1497 information. The notes produced by _Remember_ can be stored in
1498 different ways, and Org-mode files are a good target. Org-mode allows
1499 to file away notes either to a default file, or directly to the correct
1500 location in your Org-mode outline tree. The following customization(1)
1501 will tell _Remember_ to use org files as target, and to create
1502 annotations compatible with Org-mode links.
1504 (setq org-directory "~/path/to/my/orgfiles/")
1505 (setq org-default-notes-file "~/.notes")
1506 (autoload 'org-remember-annotation "org")
1507 (autoload 'org-remember-apply-template "org")
1508 (autoload 'org-remember-handler "org")
1509 (setq remember-annotation-functions '(org-remember-annotation))
1510 (setq remember-handler-functions '(org-remember-handler))
1511 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1513 In combination with Org-mode, you can use templates to generate
1514 different types of remember notes. For example, if you would like to
1515 use one template to create general TODO entries, and another one for
1516 journal entries, you could use:
1518 (setq org-remember-templates
1519 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1520 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1522 In these entries, the character specifies how to select the template,
1523 the first string specifies the template, and the (optional) second
1524 string specifies a default file (overruling `org-default-notes-file')
1525 as a target for this note.
1527 When you call `M-x remember' to remember something, org will prompt
1528 for a key to select the template and then prepare the buffer like
1530 <file:link to where you called remember>
1534 * [2006-03-21 Tue 15:37]
1536 <file:link to where you called remember>
1538 See the variable `org-remember-templates' for more details.
1540 When you are finished composing a note with remember, you have to
1541 press `C-c C-c' to file the note away. The handler first prompts for a
1542 target file - if you press <RET>, the value of `org-default-notes-file'
1543 is used. Then the command offers the headings tree of the selected
1544 file. You can either immediately press <RET> to get the note appended
1545 to the file. Or you can use vertical cursor motion (<up> and <down>)
1546 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1547 or <left> or <right> leads to the following result.
1549 Cursor Key Note gets inserted
1551 buffer-start <RET> as level 2 heading at end of file
1552 on headline <RET> as sublevel of the heading at cursor
1553 <left> as same level, before current heading
1554 <right> as same level, after current heading
1555 not on <RET> at cursor position, level taken from context.
1556 headline Or use prefix arg to specify level
1559 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1560 append it to the default file. Even shorter would be `C-u C-c C-c',
1561 which does the same without even showing the tree. But with little
1562 extra effort, you can push it directly to the correct location.
1564 Before inserting the text into a tree, the function ensures that the
1565 text has a headline, i.e. a first line that starts with a `*'. If not,
1566 a headline is constructed from the current date and some additional
1567 data. If the variable `org-adapt-indentation' is non-nil, the entire
1568 text is also indented so that it starts in the same column as the
1569 headline (after the asterisks).
1571 ---------- Footnotes ----------
1573 (1) The three autoload forms are only necessary if `org.el' is not
1574 part of the Emacs distribution or an XEmacs package.
1577 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1582 Org-mode does not maintain TODO lists as a separate document. TODO
1583 items are an integral part of the notes file, because TODO items
1584 usually come up while taking notes! With Org-mode, you simply mark any
1585 entry in a tree as being a TODO item. In this way, the information is
1586 not duplicated, and the entire context from which the item emerged is
1587 always present when you check.
1589 Of course, this technique causes TODO items to be scattered
1590 throughout your file. Org-mode provides methods to give you an
1591 overview over all things you have to do.
1595 * TODO basics:: Marking and displaying TODO entries
1596 * Progress logging:: Document your productivity
1597 * TODO extensions:: Workflow and assignments
1598 * Priorities:: Some things are more important than others
1601 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1603 5.1 Basic TODO functionality
1604 ============================
1606 Any headline can become a TODO item by starting it with the word TODO,
1609 *** TODO Write letter to Sam Fortune
1611 The most important commands to work with TODO entries are:
1614 Rotate the TODO state of the current item between
1616 ,-> (unmarked) -> TODO -> DONE --.
1617 '--------------------------------'
1619 The same rotation can also be done "remotely" from the timeline and
1620 agenda buffers with the `t' command key (*note Agenda commands::).
1623 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1624 the entire buffer, but shows all TODO items and the headings
1625 hierarchy above them. With prefix arg, show also the DONE
1626 entries. With numerical prefix N, show the tree for the Nth
1627 keyword in the variable `org-todo-keywords'.
1630 Show the global TODO list. This collects the TODO items from all
1631 agenda files (*note Agenda Views::) into a single buffer. The
1632 buffer is in `agenda-mode', so there are commands to examine and
1633 manipulate the TODO entries directly from that buffer (*note
1634 Agenda commands::). *Note Global TODO list::, for more
1637 ``org-agenda-include-all-todo''
1638 If you would like to have all your TODO items listed as part of
1639 your agenda, customize the variable `org-agenda-include-all-todo'.
1642 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1644 5.2 Progress Logging
1645 ====================
1647 If you want to keep track of _when_ a certain TODO item was finished,
1648 turn on logging with
1650 (setq org-log-done t)
1652 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1653 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1654 [timestamp]' will be inserted just after the headline. If you turn the
1655 entry back into a TODO item again through further state cycling, that
1656 line will be removed again. In the timeline (*note Timeline::) and in
1657 the agenda (*note Weekly/Daily Agenda::), you can then use the `L' key
1658 to display the TODO items closed on each day, giving you an overview of
1659 what has been done on a day.
1662 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1664 5.3 Extended use of TODO keywords
1665 =================================
1667 The default implementation of TODO entries is just two states: TODO and
1668 DONE. You can, however, use the TODO feature for more complicated
1669 things by configuring the variables `org-todo-keywords' and
1670 `org-todo-interpretation'. Using special setup, you can even use TODO
1671 keywords in different ways in different org files.
1673 Note that tags are another way to classify headlines in general and
1674 TODO items in particular (*note Tags::).
1678 * Workflow states:: From TODO to DONE in steps
1679 * TODO types:: I do this, Fred the rest
1680 * Per file keywords:: Different files, different requirements
1683 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1685 5.3.1 TODO keywords as workflow states
1686 --------------------------------------
1688 You can use TODO keywords to indicate different states in the process
1689 of working on an item, for example:
1691 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1692 org-todo-interpretation 'sequence)
1694 Changing these variables becomes only effective in a new Emacs
1695 session. With this setup, the command `C-c C-t' will cycle an entry
1696 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1697 also use a prefix argument to quickly select a specific state. For
1698 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1699 you define many keywords, you can use in-buffer completion (see *Note
1700 Completion::) to insert these words into the buffer.
1703 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1705 5.3.2 TODO keywords as types
1706 ----------------------------
1708 The second possibility is to use TODO keywords to indicate different
1709 types of action items. For example, you might want to indicate that
1710 items are for "work" or "home". If you are into David Allen's _Getting
1711 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1712 `MAYBE'. Or, when you work with several people on a single project,
1713 you might want to assign action items directly to persons, by using
1714 their names as TODO keywords. This would be set up like this:
1716 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1717 org-todo-interpretation 'type)
1719 In this case, different keywords do not indicate a sequence, but
1720 rather different types. So it is normally not useful to change from
1721 one type to another. Therefore, in this case the behavior of the
1722 command `C-c C-t' is changed slightly(1). When used several times in
1723 succession, it will still cycle through all names. But when you return
1724 to the item after some time and execute `C-c C-t' again, it will switch
1725 from each name directly to DONE. Use prefix arguments or completion to
1726 quickly select a specific name. You can also review the items of a
1727 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1728 C-v'. For example, to see all things Lucy has to do, you would use
1729 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1730 single buffer, you would use the prefix arg as well when creating the
1731 global todo list: `C-3 C-c t'.
1733 ---------- Footnotes ----------
1735 (1) This is also true for the `t' command in the timeline and agenda
1739 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1741 5.3.3 Setting up TODO keywords for individual files
1742 ---------------------------------------------------
1744 It can be very useful to use different aspects of the TODO mechanism in
1745 different files, which is not possible with the global settings
1746 described above. For file-local settings, you need to add special
1747 lines to the file which set the keywords and interpretation for that
1748 file only. For example, to set one of the two examples discussed
1749 above, you need one of the following lines, starting in column zero
1750 anywhere in the file:
1752 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1753 #+TYP_TODO: Fred Sara Lucy Mike DONE
1755 To make sure you are using the correct keyword, type `#+' into the
1756 buffer and then use `M-<TAB>' completion.
1758 Remember that the last keyword must always mean that the item is DONE
1759 (you may use a different word, though). Also note that in each file,
1760 only one of the two aspects of TODO keywords can be used. After
1761 changing one of these lines, use `C-c C-c' with the cursor still in the
1762 line to make the changes known to Org-mode(1).
1764 If you want to use very many keywords, for example when working with
1765 a large group of people, you may split the names over several lines:
1767 #+TYP_TODO: Fred Sara Lucy Mike
1768 #+TYP_TODO: Luis George Jules Jessica
1769 #+TYP_TODO: Kim Arnold Peter
1772 ---------- Footnotes ----------
1774 (1) Org-mode parses these lines only when Org-mode is activated
1775 after visiting a file. `C-c C-c' with the cursor in a line starting
1776 with `#+' is simply restarting Org-mode, making sure that these changes
1780 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1785 If you use Org-mode extensively to organize your work, you may end up
1786 with a number of TODO entries so large that you'd like to prioritize
1787 them. This can be done by placing a _priority cookie_ into the
1790 *** TODO [#A] Write letter to Sam Fortune
1792 With its standard setup, Org-mode supports priorities `A', `B', and
1793 `C'. `A' is the highest priority. An entry without a cookie is
1794 treated as priority `B'. Priorities make a difference only in the
1795 agenda (*note Weekly/Daily Agenda::).
1798 Set the priority of the current item. The command prompts for a
1799 priority character `A', `B' or `C'. When you press <SPC> instead,
1800 the priority cookie is removed from the headline. The priorities
1801 can also be changed "remotely" from the timeline and agenda buffer
1802 with the `,' command (*note Agenda commands::).
1806 Increase/decrease priority of current item. Note that these keys
1807 are also used to modify time stamps (*note Creating timestamps::).
1808 Furthermore, these keys are also used by CUA-mode (*note
1812 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1817 Items can be labeled with timestamps to make them useful for project
1822 * Time stamps:: Assigning a time to a tree entry
1823 * Creating timestamps:: Commands which insert timestamps
1826 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1828 6.1 Time stamps, deadlines and scheduling
1829 =========================================
1831 A time stamp is a specification of a date (possibly with time) in a
1832 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1833 A time stamp can appear anywhere in the headline or body of an org-tree
1834 entry. Its presence allows entries to be shown on specific dates in
1835 the agenda (*note Weekly/Daily Agenda::). We distinguish:
1838 A simple time stamp just assigns a date/time to an item. In the
1839 timeline and agenda displays, the headline of the entry will be
1840 shown exactly on that date.
1843 Two time stamps connected by `--' denote a time range. The
1844 headline will be shown on the first and last day of the range, and
1845 on any dates that are displayed and fall in the range. Here is an
1848 ** Meeting in Amsterdam
1849 <2004-08-23 Mon>--<2004-08-26 Thu>
1852 If a time stamp is preceded by the word `DEADLINE:', the task
1853 (most likely a TODO item) is supposed to be finished on that date,
1854 and it will be listed then. In addition, the compilation for
1855 _today_ will carry a warning about the approaching or missed
1856 deadline, starting `org-deadline-warning-days' before the due
1857 date, and continuing until the entry is marked DONE. An example:
1859 *** TODO write article about the Earth for the Guide
1860 The editor in charge is <bbdb:Ford Prefect>
1861 DEADLINE: <2004-02-29 Sun>
1864 If a time stamp is preceded by the word `SCHEDULED:', it means you
1865 are planning to start working on that task on the given date. The
1866 headline will be listed under the given date. In addition, a
1867 reminder that the scheduled date has passed will be present in the
1868 compilation for _today_, until the entry is marked DONE. I.e., the
1869 task will automatically be forwarded.
1872 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1874 6.2 Creating timestamps
1875 =======================
1877 For Org-mode to recognize time stamps, they need to be in the specific
1878 format. All commands listed below produce time stamps in the correct
1882 Prompt for a date and insert a corresponding time stamp. When the
1883 cursor is at a previously used time stamp, it is updated to NOW.
1884 When this command is used twice in succession, a time range is
1888 Like `C-c .', but use the alternative format which contains date
1889 and time. The default time can be rounded to multiples of 5
1890 minutes, see the option `org-time-stamp-rounding-minutes'.
1893 Like `C-c .', but insert an inactive time stamp not triggering the
1897 Insert a time stamp corresponding to the cursor date in the
1901 Access the Emacs calendar for the current date. If there is a
1902 timestamp in the current line, goto the corresponding date instead.
1905 Access the agenda for the date given by the time stamp at point
1906 (*note Weekly/Daily Agenda::).
1909 Insert `DEADLINE' keyword along with a stamp.
1912 Create a sparse tree with all deadlines that are either past-due,
1913 or which will become due within `org-deadline-warning-days'. With
1914 `C-u' prefix, show all deadlines in the file. With a numeric
1915 prefix, check that many days. For example, `C-1 C-c C-w' shows
1916 all deadlines due tomorrow.
1919 Insert `SCHEDULED' keyword along with a stamp.
1923 Change date at cursor by one day. These key bindings conflict with
1924 CUA-mode (*note Interaction::).
1928 Change the item under the cursor in a timestamp. The cursor can
1929 be on a year, month, day, hour or minute. Note that if the cursor
1930 is not at a time stamp, these same keys modify the priority of an
1931 item. (*note Priorities::). The key bindings also conflict with
1932 CUA-mode (*note Interaction::).
1935 Evaluate a time range by computing the difference between start and
1936 end. With prefix arg, insert result after the time range (in a
1937 table: into the following column).
1939 When Org-mode prompts for a date/time, the function reading your
1940 input will replace anything you choose not to specify with the current
1941 date and time. For details, see the documentation string of
1942 `org-read-date'. Also, a calender will pop up to allow selecting a
1943 date. The calendar can be fully controlled from the minibuffer, and a
1944 date can be selected with the following commands:
1947 Scroll calendar backwards by one month.
1950 Scroll calendar forwards by one month.
1953 Select date by clicking on it.
1974 Choose date in calendar (only if nothing typed into minibuffer).
1977 File: org, Node: Tags, Next: Agenda Views, Prev: Timestamps, Up: Top
1982 If you wish to implement a system to cross-correlate information, an
1983 excellent way is to assign tags to headline. Org-mode has extensive
1984 support for using tags.
1986 Every headline can contain a list of tags, at the end of the
1987 headline. Tags are normal words containing letters, numbers, `_', and
1988 `@'. Tags must be preceded and followed by a single colon; like
1989 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
1993 * Tag inheritance:: Tags use the tree structure of the outline
1994 * Setting tags:: How to assign tags to a headline
1995 * Tag searches:: Searching for combinations of tags
1998 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2003 Tags make use of the hierarchical structure of outline trees. If a
2004 heading has a certain tag, all subheadings will inherit the tag as
2005 well. For example, in the list
2007 * Meeting with the French group :WORK:
2008 ** Summary by Frank :BOSS:NOTES:
2009 *** TODO Prepare slides for him :ACTION:
2011 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2012 `:ACTION:'. When executing tag searches and Org-mode finds that a
2013 certain headline matches the search criterion, it will not check any
2014 sublevel headline, assuming that these likely also match, and that the
2015 list of matches can become very long. However, this may not be what
2016 you want, and you can influence inheritance and searching using the
2017 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2020 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2025 As Org-mode deals with plain text files, tags can simply be typed into
2026 the buffer. After a colon, `M-<TAB>' offers completion on all tags
2027 being used in the current buffer. There is also a special command for
2031 Enter new tags for the current headline. The minibuffer will
2032 prompt for a list of tags and offer completion with respect to all
2033 other tags used in the current buffer. Several tags, separated by
2034 colons, may be specified at the prompt. After pressing <RET>, the
2035 tags will be inserted and aligned to `org-tags-column'. When
2036 called with a `C-u' prefix, all tags in the current buffer will be
2037 aligned to that column, just to make things look nice. TAGS are
2038 automatically realigned after promotion, demotion, and TODO state
2039 changes (*note TODO basics::).
2042 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2047 Once a tags system has been set up, it can be used to collect related
2048 information into special lists.
2051 Create a sparse tree with all headlines matching a tags search.
2054 Create a global list of tag matches from all agenda files. *Note
2055 Matching headline tags::.
2058 Create a global list of tag matches from all agenda files, but
2059 check only TODO items and force checking subitems (see variable
2060 `org-tags-match-list-sublevels').
2062 A tags search string can use Boolean operators `&' for AND and `|'
2063 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2064 not implemented. A tag may also be preceded by `-', to select against
2065 it, and `+' is syntactic sugar for positive selection. The AND
2066 operator `&' is optional when `+' or `-' is present. For example,
2067 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2068 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2069 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2070 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2074 File: org, Node: Agenda Views, Next: Exporting, Prev: Tags, Up: Top
2079 Due to the way Org-mode works, TODO items, time-stamped items, and
2080 tagged headlines can be scattered throughout a file or even a number of
2081 files. To get an overview over open action items, or over events that
2082 are important for a particular date, this information must be collected,
2083 sorted and displayed in an organized way.
2085 Org-mode can select items based on various criteria, and display them
2086 in a separate buffer. Three different views are provided:
2088 * an _agenda_ that is like a calendar and shows information for
2091 * a _TODO list_ that covers all unfinished action items, and
2093 * a _tags view_ that shows information based on the tags associated
2094 with headlines in the outline tree.
2096 The extracted information is displayed in a special _agenda buffer_.
2097 This buffer is read-only, but provides commands to visit the
2098 corresponding locations in the original Org-mode files, and even to
2099 edit these files remotely.
2103 * Agenda files:: Files being searched for agenda information
2104 * Agenda dispatcher:: Keyboard access to agenda views
2105 * Weekly/Daily Agenda:: The calendar page with current tasks
2106 * Global TODO list:: All unfinished action items
2107 * Matching headline tags:: Structured information with fine-tuned search
2108 * Timeline:: Time-sorted view for single file
2109 * Agenda commands:: Remote editing of org trees
2112 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda Views, Up: Agenda Views
2117 The information to be shown is collected from all _agenda files_, the
2118 files listed in the variable `org-agenda-files'(1). Thus even if you
2119 only work with a single Org-mode file, this file should be put into
2120 that list(2). You can customize `org-agenda-files', but the easiest
2121 way to maintain it is through the following commands
2124 Add current file to the list of agenda files. The file is added to
2125 the front of the list. If it was already in the list, it is moved
2126 to the front. With prefix arg, file is added/moved to the end.
2129 Remove current file from the list of agenda files.
2132 Cycle through agenda file list, visiting one file after the other.
2134 The Org menu contains the current list of files and can be used to
2137 ---------- Footnotes ----------
2139 (1) If the value of that variable is not a list, but a single file
2140 name, then the list of agenda files will be maintained in that external
2143 (2) When using the dispatcher pressing `1' before selecting a
2144 command will actually limit the command to the current file, and ignore
2145 `org-agenda-files' until the next dispatcher command.
2148 File: org, Node: Agenda dispatcher, Next: Weekly/Daily Agenda, Prev: Agenda files, Up: Agenda Views
2150 8.2 The agenda dispatcher
2151 =========================
2153 The views are created through a dispatcher that should be bound to a
2154 global key, for example `C-c a' (*note Installation and activation::).
2155 In the following we will assume that `C-c a' is indeed how the
2156 dispatcher is accessed and list keyboard access to commands
2157 accordingly. After pressing `C-c a', an additional letter is required
2158 to execute a command. The dispatcher offers the following default
2161 Create the calendar-like agenda (*note Weekly/Daily Agenda::).
2164 Create a list of all TODO items (*note Global TODO list::).
2167 Create a list of headlines matching a TAGS expression (*note
2168 Matching headline tags::).
2170 You can also define custom commands that will be accessible through
2171 the dispatcher, just like the default commands. Custom commands are
2172 global searches for tags and specific TODO keywords, or a variety of
2173 sparse tree creating commands (*note Sparse trees::). As sparse trees
2174 are only defined for a single org-mode file, these latter commands act
2175 on the current buffer instead of the list of agenda files.
2177 Custom commands are configured in the variable
2178 `org-agenda-custom-commands'. You can customize this variable, for
2179 example by pressing `C-c a C'. You can also directly set it with Emacs
2180 Lisp in `.emacs'. For example:
2182 (setq org-agenda-custom-commands
2183 '(("w" todo "WAITING")
2184 ("u" tags "+BOSS-URGENT")
2185 ("U" tags-tree "+BOSS-URGENT")
2186 ("f" occur-tree "\\<FIXME\\>")))
2188 will define `C-c a w' as a global search for TODO entries with
2189 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2190 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2191 search but only in the current buffer and display the result as a
2192 sparse tree, and `C-c a f' to create a sparse tree with all entries
2193 containing the word `FIXME'. For more information, look at the
2194 documentation string of the variable `org-agenda-custom-commands'.
2197 File: org, Node: Weekly/Daily Agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda Views
2199 8.3 The weekly/daily agenda
2200 ===========================
2202 The purpose of the weekly/daily _agenda_ is to act like a page of a
2203 paper agenda, showing all the tasks for the current week or day.
2206 Compile an agenda for the current week from a list of org files.
2207 The agenda shows the entries for each day. With a `C-u' prefix (or
2208 when the variable `org-agenda-include-all-todo' is `t'), all
2209 unfinished TODO items (including those without a date) are also
2210 listed at the beginning of the buffer, before the first date.
2212 Remote editing from the agenda buffer means, for example, that you
2213 can change the dates of deadlines and appointments from the agenda
2214 buffer. The commands available in the Agenda buffer are listed in
2215 *Note Agenda commands::.
2219 * Categories:: Not all tasks are equal
2220 * Time-of-day specifications:: How the agenda knows the time
2221 * Calendar/Diary integration:: Integrating Anniversaries and more
2222 * Sorting of agenda items:: The order of things
2225 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily Agenda, Up: Weekly/Daily Agenda
2230 In the agenda buffer, each entry is preceded by a _category_, which is
2231 derived from the file name. The category can also be set with a
2232 special line anywhere in the buffer, looking like this:
2236 If there are several such lines in a file, each specifies the
2237 category for the text below it (but the first category also applies to
2238 any text before the first CATEGORY line). The display in the agenda
2239 buffer looks best if the category is not longer than 10 characters.
2242 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily Agenda
2244 8.3.2 Time-of-Day Specifications
2245 --------------------------------
2247 Org-mode checks each agenda item for a time-of-day specification. The
2248 time can be part of the time stamp that triggered inclusion into the
2249 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2250 specified with two time stamps, like
2251 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2253 In the headline of the entry itself, a time(range) may also appear as
2254 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2255 Emacs diary (*note Calendar/Diary integration::), time specifications
2256 in diary entries are recognized as well.
2258 For agenda display, Org-mode extracts the time and displays it in a
2259 standard 24 hour format as part of the prefix. The example times in
2260 the previous paragraphs would end up in the agenda like this:
2262 8:30-13:00 Arthur Dent lies in front of the bulldozer
2263 12:45...... Ford Prefect arrives and takes Arthur to the pub
2264 19:00...... The Vogon reads his poem
2265 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2267 If the agenda is in single-day mode, or for the display of today, the
2268 timed entries are embedded in a time grid, like
2270 8:00...... ------------------
2271 8:30-13:00 Arthur Dent lies in front of the bulldozer
2272 10:00...... ------------------
2273 12:00...... ------------------
2274 12:45...... Ford Prefect arrives and takes Arthur to the pub
2275 14:00...... ------------------
2276 16:00...... ------------------
2277 18:00...... ------------------
2278 19:00...... The Vogon reads his poem
2279 20:00...... ------------------
2280 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2282 The time grid can be turned on and off with the variable
2283 `org-agenda-use-time-grid', and can be configured with
2284 `org-agenda-time-grid'.
2287 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily Agenda
2289 8.3.3 Calendar/Diary integration
2290 --------------------------------
2292 Emacs contains the calendar and diary by Edward M. Reingold. The
2293 calendar displays a three-month calendar with holidays from different
2294 countries and cultures. The diary allows you to keep track of
2295 anniversaries, lunar phases, sunrise/set, recurrent appointments
2296 (weekly, monthly) and more. In this way, it is quite complementary to
2297 Org-mode. It can be very useful to combine output from Org-mode with
2300 In order to include entries from the Emacs diary into Org-mode's
2301 agenda, you only need to customize the variable
2303 (setq org-agenda-include-diary t)
2305 After that, everything will happen automatically. All diary entries
2306 including holidays, anniversaries etc will be included in the agenda
2307 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2308 the agenda buffer to jump to the diary file in order to edit existing
2309 diary entries. The `i' command to insert new entries for the current
2310 date works in the agenda buffer, as well as the commands `S', `M', and
2311 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2312 to other calendars, respectively. `c' can be used to switch back and
2313 forth between calendar and agenda.
2316 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily Agenda
2318 8.3.4 Sorting of agenda items
2319 -----------------------------
2321 The entries for each day are sorted. The default order is to first
2322 collect all items containing an explicit time-of-day specification.
2323 These entries will be shown at the beginning of the list, as a
2324 _schedule_ for the day. After that, items remain grouped in
2325 categories, in the sequence given by `org-agenda-files'. Within each
2326 category, items are sorted by priority (*note Priorities::).
2328 The priority is a numerical quantity composed of the base priority
2329 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2330 increments for overdue scheduled or deadline items.
2332 Sorting can be customized using the variable
2333 `org-agenda-sorting-strategy'.
2336 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily Agenda, Up: Agenda Views
2338 8.4 The global TODO list
2339 ========================
2341 The global TODO list contains all unfinished TODO items, formatted and
2342 collected into a single place.
2345 Show the global TODO list. This collects the TODO items from all
2346 agenda files (*note Agenda Views::) into a single buffer. The
2347 buffer is in `agenda-mode', so there are commands to examine and
2348 manipulate the TODO entries directly from that buffer (*note
2349 Agenda commands::). *Note Global TODO list::, for more
2353 Like the above, but allows selection of a specific TODO keyword.
2354 You can also do this by specifying a prefix argument to `C-c a t'.
2355 With a `C-u' prefix you are prompted for a keyword. With a
2356 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2357 `r' key in the agenda buffer regenerates it, and you can give a
2358 prefix argument to this command to change the selected TODO
2359 keyword, for example `3 r'. If you often need a search for a
2360 specific keyword, define a custom command for it (*note Agenda
2363 Remote editing of TODO items means that you can change the state of a
2364 TODO entry with a single key press. The commands available in the TODO
2365 list are described in *Note Agenda commands::.
2368 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda Views
2370 8.5 Matching headline tags
2371 ==========================
2373 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2374 you can select headlines based on the tags that apply to them and
2375 collect them into an agenda buffer.
2378 Produce a list of all headlines that match a given set of tags.
2379 The command prompts for a selection criterion, which is a boolean
2380 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2381 `WORK|HOME' (*note Tags::). If you often need a specific search,
2382 define a custom command for it (*note Agenda dispatcher::).
2385 Like `C-c a m', but only select headlines that are also TODO items
2386 and force checking subitems (see variable
2387 `org-tags-match-list-sublevels'.
2389 The commands available in the tags list are described in *Note
2393 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda Views
2395 8.6 Timeline for a single file
2396 ==============================
2398 The timeline is not really an agenda view, because it only summarizes
2399 items from a single Org-mode file. But it also uses the agenda buffer
2400 and provides similar commands, so we discuss it here. The timeline
2401 shows all time-stamped items in a single Org-mode file (or the selected
2402 part of it), in a _time-sorted view_. The main purpose of this command
2403 is to give an overview over events in a project.
2406 Show a time-sorted view of the org file, with all time-stamped
2407 items. When called with a `C-u' prefix, all unfinished TODO
2408 entries (scheduled or not) are also listed under the current date.
2410 The commands available in the timeline buffer are listed in *Note
2414 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda Views
2416 8.7 Commands in the agenda buffer
2417 =================================
2419 Entries in the agenda buffer are linked back to the org file or diary
2420 file where they originate. You are not allowed to edit the agenda
2421 buffer itself, but commands are provided to show and jump to the
2422 original entry location, and to edit the org-files "remotely" from the
2423 agenda buffer. In this way, all information is stored only once,
2424 removing the risk that your agenda and note files may diverge.
2426 Some commands can be executed with mouse clicks on agenda lines. For
2427 the other commands, the cursor needs to be in the desired line.
2433 Next line (same as <up>).
2436 Previous line (same as <down>).
2443 Display the original location of the item in another window.
2446 Display original location and recenter that window.
2451 Go to the original location of the item in another window. Under
2452 Emacs 22, `mouse-1' will also works for this.
2455 Go to the original location of the item and delete other windows.
2458 Toggle Follow mode. In Follow mode, as you move the cursor through
2459 the agenda buffer, the other window always shows the corresponding
2460 location in the org file.
2463 Toggle Logbook mode. In Logbook mode, entries that where marked
2464 DONE while logging was on (variable `org-log-done') are shown in
2471 Delete other windows.
2474 Switch to weekly view (7 days displayed together).
2477 Switch to daily view (just one day displayed).
2480 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2484 Toggle the time grid on and off. See also the variables
2485 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2488 Recreate the agenda buffer, for example to reflect the changes
2489 after modification of the time stamps of items with S-<left> and
2490 S-<right>. When the buffer is the global todo list, a prefix
2491 argument is interpreted to create a selective list for a specific
2495 Display the following `org-agenda-ndays' days. For example, if
2496 the display covers a week, switch to the following week. With
2497 prefix arg, go forward that many times `org-agenda-ndays' days.
2500 Display the previous dates.
2512 Change the TODO state of the item, both in the agenda and in the
2516 Show all tags associated with the current item. Because of
2517 inheritance, this may be more than the tags listed in the line
2521 Set tags for the current headline.
2524 Set the priority for the current item. Org-mode prompts for the
2525 priority character. If you reply with <SPC>, the priority cookie
2526 is removed from the entry.
2529 Display weighted priority of current item.
2533 Increase the priority of the current item. The priority is
2534 changed in the original buffer, but the agenda is not resorted.
2535 Use the `r' key for this.
2539 Decrease the priority of the current item.
2542 Change the time stamp associated with the current line by one day
2543 into the future. With prefix argument, change it by that many
2544 days. For example, `3 6 5 S-<right>' will change it by a year.
2545 The stamp is changed in the original org file, but the change is
2546 not directly reflected in the agenda buffer. Use the `r' key to
2550 Change the time stamp associated with the current line by one day
2554 Change the time stamp associated with the current line to today.
2555 The key `>' has been chosen, because it is the same as `S-.' on my
2559 Insert a new entry into the diary. Prompts for the type of entry
2560 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2561 new entry in the diary, just like `i d' etc. would do in the
2562 calendar. The date is taken from the cursor position.
2568 Open the Emacs calendar and move to the date at the agenda cursor.
2571 When in the calendar, compute and show the Org-mode agenda for the
2575 Show the phases of the moon for the three months around current
2579 Show sunrise and sunset times. The geographical location must be
2580 set with calendar variables, see documentation of the Emacs
2584 Convert the date at cursor into many other cultural and historic
2588 Show holidays for three month around the cursor date.
2591 Export a single iCalendar file containing entries from all agenda
2598 Quit agenda, remove the agenda buffer.
2601 Exit agenda, remove the agenda buffer and all buffers loaded by
2602 Emacs for the compilation of the agenda. Buffers created by the
2603 user to visit org files will not be removed.
2607 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda Views, Up: Top
2612 For printing and sharing of notes, Org-mode documents can be exported
2613 as ASCII or HTML files. To incorporate entries with associated times
2614 like deadlines or appointments into a desktop calendar program like
2615 iCal, Org-mode can also produce extracts in the iCalendar format.
2619 * ASCII export:: Export as a structured ASCII file
2620 * HTML export:: Export as an HTML file
2621 * iCalendar export:: Create calendar entries.
2624 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2630 Export as ASCII file. If there is an active region, only the
2631 region will be exported. For an org file `myfile.org', the ASCII
2632 file will be `myfile.txt'. The file will be overwritten without
2635 In the exported version, the first 3 outline levels will become
2636 headlines, defining a general document structure. Additional levels
2637 will be exported as itemized lists. If you want that transition to
2638 occur at a different level, specify it with a prefix argument. For
2641 C-1 C-c C-x a org-export-as-ascii
2643 creates only top level headlines and does the rest as items. Lines
2644 starting with `#' and subtrees starting with the word `COMMENT' will
2648 File: org, Node: HTML export, Next: iCalendar export, Prev: ASCII export, Up: Exporting
2653 Org-mode contains an HTML exporter with extensive HTML formatting, in
2654 ways similar to John Grubers _markdown_ language, but with additional
2658 Export as HTML file `myfile.html'.
2661 Export as HTML file and open it with a browser.
2664 Insert template with export options, see below.
2667 Toggle fixed-width for entry (QUOTE) or region, see below.
2669 In the exported version, the first 3 outline levels will become
2670 headlines, defining a general document structure. Additional levels
2671 will be exported as itemized lists. If you want that transition to
2672 occur at a different level, specify it with a prefix argument. For
2677 creates two levels of headings and does the rest as items.
2681 * HTML formatting:: Interpretation of the buffer content
2682 * Export options:: How to influence exports
2683 * Comment lines:: Lines which will not be exported
2686 File: org, Node: HTML formatting, Next: Export options, Prev: HTML export, Up: HTML export
2688 9.2.1 HTML formatting
2689 ---------------------
2691 Not all text is transferred literally to the exported HTML file. The
2692 exporter implements the following interpretation:
2694 * Hand-formatted lists with `-', `*' or `+' as bullet, or with `1.'
2695 or `2)' as enumerator will be recognized and transformed into HTML
2696 lists. See *Note Plain Lists::.
2698 * You can make words *bold*, /italic/, and _underlined_
2700 * Simple TeX-like math constructs are interpreted:
2702 - `10^22' and `J_n' are super- and subscripts. You can quote
2703 `^' and `_' with a backslash: `\_' and `\^'
2705 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2706 use completion for these macros, just type `\' and maybe a few
2707 letters, and press `M-<TAB>' to see possible completions.
2709 * Tables are transformed into HTML tables. Data fields before the
2710 first horizontal separator line will be formatted as table header
2713 * If a headline starts with the word `QUOTE', the text below the
2714 headline will be typeset as fixed-width, to allow quoting of
2715 computer codes etc. Lines starting with `:' are also typeset in
2718 * If you want to include HTML tags which should be interpreted as
2719 such, mark them with a `@' like in `@<b>bold text@</b>'. Plain
2720 `<' and `>' are always transformed to `<' and `>' in HTML
2723 If these conversions conflict with your habits of typing ASCII text,
2724 they can all be turned off with corresponding variables.
2727 File: org, Node: Export options, Next: Comment lines, Prev: HTML formatting, Up: HTML export
2729 9.2.2 Export options
2730 --------------------
2732 The exporter recognizes special lines in the buffer which provide
2733 additional information. These lines may be put anywhere in the file.
2734 The whole set of lines can be inserted into the buffer with `C-c C-x
2735 t'. For individual lines, a good way to make sure the keyword is
2736 correct is to type `#+' and then use `M-<TAB>' completion (*note
2739 #+TITLE: the title to be shown (default is the buffer name)
2740 #+AUTHOR: the author (default taken from `user-full-name')
2741 #+EMAIL: his/her email address (default from `user-mail-address')
2742 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2743 #+TEXT: Some descriptive text to be inserted at the beginning.
2744 #+TEXT: Several lines may be given.
2745 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2747 The OPTIONS line is a compact form to specify export settings. Here
2749 H: set the number of headline levels for export
2750 num: turn on/off section-numbers
2751 toc: turn on/off table of contents
2752 \n: turn on/off linebreak-preservation
2753 @: turn on/off quoted html tags
2754 :: turn on/off fixed-width sections
2755 |: turn on/off tables
2756 ^: turn on/off TeX-like syntax for sub- and superscripts.
2757 *: turn on/off emphasized text (bold, italic, underlined)
2758 TeX: turn on/off TeX macros
2760 You can also give style information for the exported file. The
2761 default specification can be configured through the option
2762 `org-export-html-style'. If you want to use a file-local style, you
2763 may use file variables, best wrapped into a COMMENT section at the end
2764 of the outline tree. For example:
2766 * COMMENT HTML style specifications
2769 # org-export-html-style: " <style type=\"text/css\">
2770 p {font-weight: normal; color: gray; }
2775 Remember to execute `M-x normal-mode' after changing this to make
2776 the new style visible to Emacs. This command reastarts org-mode for the
2777 current buffer and forces Emacs to re-evaluate the loval variables
2778 section in the buffer.
2781 File: org, Node: Comment lines, Prev: Export options, Up: HTML export
2786 Lines starting with `#' in column zero are treated as comments and will
2787 never be exported. Also entire subtrees starting with the word
2788 `COMMENT' will never be exported. Finally, any text before the first
2789 headline will not be exported either. This applies also for ASCII
2793 Toggle the COMMENT keyword at the beginning of an entry.
2796 File: org, Node: iCalendar export, Prev: HTML export, Up: Exporting
2798 9.3 iCalendar export
2799 ====================
2801 Some people like to use Org-mode for keeping track of projects, but
2802 still prefer a standard calendar application for anniversaries and
2803 appointments. In this case it can be useful to have deadlines and
2804 other time-stamped items in Org-mode files show up in the calendar
2805 application. Org-mode can export calendar information in the standard
2809 Create iCalendar entries for the current file and store them in
2810 the same directory, using a file extension `.ics'.
2813 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2814 For each of these files, a separate iCalendar file will be
2818 Create a single large iCalendar file from all files in
2819 `org-agenda-files' and write it to the file given by
2820 `org-combined-agenda-icalendar-file'.
2822 How this calendar is best read and updated, depends on the
2823 application you are using. For example, when using iCal under Apple
2824 MacOS X, you could create a new calendar `OrgMode' (the default name
2825 for the calendar created by `C-c C-x c', see the variables
2826 `org-icalendar-combined-name' and
2827 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2828 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2829 use AppleScript to make iCal re-read the calendar files each time a new
2830 version of `OrgMode.ics' is produced. Here is the setup needed for
2833 (setq org-combined-agenda-icalendar-file
2834 "~/Library/Calendars/OrgMode.ics")
2835 (add-hook 'org-after-save-iCalendar-file-hook
2838 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2841 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2848 * Completion:: M-TAB knows what you need
2849 * Customization:: Adapting Org-mode to your taste
2850 * Updating settings:: How to tell Org-mode that settings have changed
2851 * Clean view:: Getting rid of leading stars in the outline
2852 * TTY keys:: Using Org-mode on a tty
2853 * FAQ:: Frequently asked questions
2854 * Interaction:: Other Emacs packages
2855 * Bugs:: Things which do not work perfectly
2856 * Acknowledgments:: These people provided feedback and more
2859 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2864 Org-mode supports in-buffer completion. This type of completion does
2865 not make use of the minibuffer. You simply type a few letters into the
2866 buffer and use the key to complete text right there.
2869 Complete word at point
2870 * At the beginning of a headline, complete TODO keywords.
2872 * After `\', complete TeX symbols supported by the exporter.
2874 * After `*', complete CamelCase versions of all headlines in the
2877 * After `:', complete tags used elsewhere in the buffer.
2879 * After `#+', complete the special keywords like `TYP_TODO' or
2880 `OPTIONS' which set file-specific options for Org-mode. When
2881 the option keyword is already complete, pressing `M-<TAB>'
2882 again will insert example settings for this keyword.
2884 * Elsewhere, complete dictionary words using ispell.
2887 File: org, Node: Customization, Next: Updating settings, Prev: Completion, Up: Miscellaneous
2892 There are more than 100 variables that can be used to customize
2893 Org-mode. For the sake of compactness of the manual, we are not
2894 describing the variables here. A structured overview of customization
2895 variables is available with `M-x org-customize'. Or select `Browse Org
2896 Group' from the `Org->Customization' menu.
2899 File: org, Node: Updating settings, Next: Clean view, Prev: Customization, Up: Miscellaneous
2901 10.3 Updating settings after changes
2902 ====================================
2904 Org-mode uses special lines in the buffer to set file-local values for a
2905 number of user options. When such settings are changed, you need to
2906 inform Org-mode that something has be modified and that it should
2907 recheck the buffer for setting. This is done with the command `C-c
2908 C-c' in the following situations:
2910 * After changing any of the special buffer lines starting with `#+',
2911 for example `#+STARTUP', `#+CATEGORY'. Org-mode will then read
2912 these settings and activate them (see *Note Visibility cycling::,
2913 *Note Narrow columns::, *Note Clean view::, *Note Per file
2914 keywords::, *Note Categories::)
2916 * After editing by hand a `#+TBLFM' line containing formulas for a
2917 table. When pressing `C-c C-c' in that line, all formulas are
2918 re-applied to the entire table (*note Editing/debugging
2921 * In a table, `C-c C-c' does force a re-align, even if the table
2922 editor is turned off (*note Built-in table editor::)
2924 * In an ordered plain list, `C-c C-c' forces a renumbering of the
2925 list (*note Plain Lists::).
2927 * After adding a new radio target `<<<New target>>>', `C-c C-c' must
2928 be used with the cursor on that target to activate it throughout
2932 File: org, Node: Clean view, Next: TTY keys, Prev: Updating settings, Up: Miscellaneous
2934 10.4 A cleaner outline view
2935 ===========================
2937 Some people find it noisy and distracting that the Org-mode headlines
2938 are starting with a potentially large number of stars. For example the
2939 tree from *Note Headlines:::
2941 * Top level headline
2947 * Another top level headline
2949 Unfortunately this is deeply ingrained into the code of Org-mode and
2950 cannot be easily changed. You can, however, modify the display in such
2951 a way that all leading stars become invisible and the outline more easy
2952 to read. To do this, customize the variable `org-hide-leading-stars'
2955 (setq org-hide-leading-stars t)
2957 or change this on a per-file basis with one of the lines (anywhere in
2960 #+STARTUP: showstars
2961 #+STARTUP: hidestars
2963 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
2966 With stars hidden, the tree becomes:
2968 * Top level headline
2974 * Another top level headline
2976 Note that the leading stars are not truly replaced by whitespace, they
2977 are only fontified with the face `org-hide' that uses the background
2978 color as font color. If are are not using either white or black
2979 background, you may have to customize this face to get the wanted
2980 effect. Another possibility is to set this font such that the extra
2981 stars are almost invisible, for example using the color `grey90' on a
2984 Things become cleaner still if you skip all the even levels and use
2985 only odd levels 1, 3, 5..., effectively adding two stars to go from one
2986 outline level to the next:
2988 * Top level headline
2994 * Another top level headline
2996 In order to make the structure editing and export commands handle this
2997 convention correctly, use
2999 (setq org-odd-levels-only t)
3001 or set this on a per-file basis with one of the following lines (don't
3002 forget to press `C-c C-c' with the cursor in the startup line to
3003 activate changes immediately).
3008 You can convert an Org-mode file from single-star-per-level to the
3009 double-star-per-level convention with `M-x org-convert-to-odd-levels
3010 RET' in that file. There is no command for the back conversion because
3011 such a command might merge levels and in this way destroy the structure
3015 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
3017 10.5 Using org-mode on a tty
3018 ============================
3020 Org-mode uses a number of keys that are not accessible on a tty. This
3021 applies to most special keys like cursor keys, <TAB> and <RET>, when
3022 these are combined with modifier keys like <Meta> and/or <Shift>.
3023 Org-mode uses these bindings because it needs to provide keys for a
3024 large number of commands, and because these keys appeared particularly
3025 easy to remember. In order to still be able to access the core
3026 functionality of Org-mode on a tty, alternative bindings are provided.
3027 Here is a complete list of these bindings, which are obviously more
3028 cumbersome to use. Note that sometimes a work-around can be better.
3029 For example changing a time stamp is really only fun with `S-<cursor>'
3030 keys. On a tty you would rather use `C-c .' to re-insert the
3033 Default Alternative 1 Alternative 2
3034 `S-<TAB>' `C-u <TAB>'
3035 `M-<left>' `C-c C-x l' `<Esc> <left>'
3036 `M-S-<left>'`C-c C-x L'
3037 `M-<right>' `C-c C-x r' `<Esc>
3039 `M-S-<right>'`C-c C-x R'
3040 `M-<up>' `C-c C-x u' `<Esc> <up>'
3041 `M-S-<up>' `C-c C-x U'
3042 `M-<down>' `C-c C-x d' `<Esc> <down>'
3043 `M-S-<down>'`C-c C-x D'
3044 `S-<RET>' `C-c C-x c'
3045 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3046 `M-S-<RET>' `C-c C-x M'
3049 `S-<right>' `C-c C-x
3057 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3059 10.6 Frequently asked questions
3060 ===============================
3062 1. Org-mode seems to be a useful default mode for the various
3063 `README' files I have scattered through my directories. How do I
3064 turn it on for all `README' files?
3065 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3067 2. Some of my links stopped working after I upgraded to a version
3068 4.20 or later. Why is this, and how can I fix it?
3069 These must be links in plain text, containing white space, such as
3070 `bbdb:Richard Stallman'. You need to protect these links by
3071 putting double brackets around them, like `[[bbdb:Richard
3074 3. I see that Org-mode now creates links using the double bracket
3075 convention that hides the link part and the brackets, only showing
3076 the description part. How can I convert my old links to this new
3078 Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3079 The replaces angular brackets with the link format.
3081 4. I don't care if you find the new bracket links great, I am
3082 attached to the old style using angular brackets and no hiding of
3083 the link text. Please give them back to me, don't tell me it is
3085 Would I let you down like that? If you must (even if I don't
3086 understand why), you can do this
3087 (setq org-link-style 'plain
3088 org-link-format "<%s>")
3090 5. When I am executing shell links I always get a confirmation prompt
3091 and need to type `yes <RET>', thats 4 key presses! Can I get rid
3093 The confirmation is there to protect you from unwantingly execute
3094 potentially dangerous commands. For example, imagine a link
3095 `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
3096 command would look like `Google Search', but really it would remove
3097 your home directory. If you wish, you can make it easier to
3098 respond to the query by setting `org-confirm-shell-links' to
3099 `y-or-n-p'. Then a single `y' keypress will be enough to confirm
3100 shell links. It is also possible to turn off this check entirely,
3101 but I do not recommend to do this. Be warned.
3103 6. All these stars are driving me mad, I just find the Emacs outlines
3104 unreadable. Can't you just put white space and a single star as a
3105 starter for headlines?
3106 See *Note Clean view::.
3108 7. I would like to have two windows on the same Org-mode file, but
3109 with different outline visibility. Is that possible?
3110 In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3111 See the documentation on the command `make-indirect-buffer'. In
3112 XEmacs, this is currently not possible because of the different
3113 outline implementation.
3115 8. When I export my TODO list, every TODO item becomes a separate
3116 section. How do I enforce these items to be exported as an
3118 If you plan to use ASCII or HTML export, make sure things you want
3119 to be exported as item lists are level 4 at least, even if that
3120 does mean there is a level jump. For example:
3122 * Todays top priorities
3123 **** TODO write a letter to xyz
3124 **** TODO Finish the paper
3125 **** Pick up kids at the school
3127 Alternatively, if you need a specific value for the heading/item
3128 transition in a particular file, use the `+OPTIONS' line to
3129 configure the `H' switch.
3133 9. I would like to export only a subtree of my file to HTML. How?
3134 If you want to export a subtree, mark the subtree as region and
3135 then export. Marking can be done with `C-c @ C-x C-x', for
3138 10. Org-mode takes over the S-cursor keys. I also want to use
3139 CUA-mode, is there a way to fix this conflict?
3140 Yes, see *Note Interaction::.
3142 11. One of my table columns has started to fill up with `#ERROR'.
3144 Org-mode tried to compute the column from other fields using a
3145 formula stored in the `#+TBLFM:' line just below the table, and
3146 the evaluation of the formula fails. Fix the fields used in the
3147 formula, or fix the formula, or remove it!
3149 12. When I am in the last column of a table and just above a
3150 horizontal line in the table, pressing TAB creates a new table line
3151 before the horizontal line. How can I quickly move to the line
3152 below the horizontal line instead?
3153 Press <down> (to get on the separator line) and then <TAB>. Or
3154 configure the variable `org-table-tab-jumps-over-hlines'.
3156 13. How can I change the indentation of an entire table without fixing
3158 The indentation of a table is set by the first line. So just fix
3159 the indentation of the first line and realign with <TAB>.
3161 14. Is it possible to include entries from org-mode files into my
3163 Since the org-mode agenda is much more powerful and can contain the
3164 diary (*note Calendar/Diary integration::), you should think twice
3165 before deciding to do this. Integrating Org-mode information into
3166 the diary is, however, possible. The following steps are
3167 necessary: Autoload the function `org-diary' as shown above under
3168 *Note Installation and activation::. You also need to use _fancy
3169 diary display_ by setting in `.emacs':
3171 (add-hook 'diary-display-hook 'fancy-diary-display)
3173 Then include the following line into your `~/diary' file, in order
3174 to get the entries from all files listed in the variable
3178 You may also select specific files with
3180 &%%(org-diary) ~/path/to/some/org-file.org
3181 &%%(org-diary) ~/path/to/another/org-file.org
3183 If you now launch the calendar and press `d' to display a diary,
3184 the headlines of entries containing a timestamp, date range,
3185 schedule, or deadline referring to the selected date will be
3186 listed. Just like in Org-mode's agenda view, the diary for
3187 _today_ contains additional entries for overdue deadlines and
3188 scheduled items. See also the documentation of the `org-diary'
3193 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3195 10.7 Interaction with other packages
3196 ====================================
3198 Org-mode can cooperate with the following packages:
3200 `org-mouse.el' by Piotr Zielinski
3201 This package implements extended mouse functionality for Org-mode.
3202 It allows you to cycle visibility and to edit the document
3203 structure with the mouse. It also provides a context-sensitive
3204 menu that changes depending on the context of a mouse-click. Use
3205 a search engine to find this package on the web.
3207 `table.el' by Takaaki Ota
3208 Org mode cooperates with table.el, see *Note table.el::.
3209 `table.el' is part of Emacs 22.
3211 `calc.el' by Dave Gillespie
3212 Org-mode uses the calc package for implementing spreadsheet
3213 functionality in its tables (*note Table calculations::).
3214 Org-modes checks for the availability of calc by looking for the
3215 function `calc-eval' which should be autoloaded in your setup if
3216 calc has been installed properly. As of Emacs 22, calc is part of
3217 the Emacs distribution. Another possibility for interaction
3218 between the two packages is using calc for embedded calculations.
3219 *Note Embedded Mode: (calc)Embedded Mode.
3221 `constants.el' by Carsten Dominik
3222 In a table formula (*note Table calculations::), it is possible to
3223 use names for natural constants or units. Instead of defining
3224 your own constants in the variable `org-table-formula-constants',
3225 install the `constants' package which defines a large number of
3226 constants and units, and lets you use unit prefixes like `M' for
3227 `Mega' etc. You will need version 2.0 of this package, available
3228 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3229 the function `constants-get', which has to be autoloaded in your
3230 setup. See the installation instructions in the file
3233 `CUA.el' by Kim. F. Storm
3234 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3235 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3236 select and extend the region. If you want to use one of these
3237 packages along with Org-mode, configure the variable
3238 `org-CUA-compatible'. When set, Org-mode will move the following
3239 keybindings in org-mode files, and in the agenda buffer (but not
3240 during date selection).
3242 S-UP -> M-p S-DOWN -> M-n
3243 S-LEFT -> M-- S-RIGHT -> M-+
3246 Yes, these are unfortunately more difficult to remember. If you
3247 want to have other replacement keys, look at the variable
3248 `org-disputed-keys'.
3250 `remember.el' by John Wiegley
3251 Org mode cooperates with remember, see *Note Remember::.
3252 `Remember.el' is not part of Emacs, find it on the web.
3255 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3260 Here is a list of things that should work differently, but which I have
3261 found too hard to fix.
3263 * If a table field starts with a link, and if the corresponding table
3264 column is narrowed (*note Narrow columns::) to a width too small to
3265 display the link, the field would look entirely empty even though
3266 it is not. To prevent this, Org-mode throws an error. The
3267 work-around is to make the column wide enough to fit the link, or
3268 to add some text (at least 2 characters) before the link in the
3271 * Narrowing table columns does not work on XEmacs, because the
3272 `format' function does not transport text properties.
3274 * Text in an entry protected with the `QUOTE' keyword should not
3277 * When the application called by `C-c C-o' to open a file link fails
3278 (for example because the application does not exits or refuses to
3279 open the file), it does so silently. No error message is
3282 * Plain list items should be able to hold a TODO item.
3283 Unfortunately this has so many technical problems that I will only
3284 consider this change for the next major release (5.0).
3286 * The remote-editing commands in the agenda buffer cannot be undone
3287 with `undo' called from within the agenda buffer. But you can go
3288 to the corresponding buffer (using <TAB> or <RET> and execute
3291 * Recalculating a table line applies the formulas from left to right.
3292 If a formula uses _calculated_ fields further down the row,
3293 multiple recalculation may be needed to get all fields consistent.
3295 * Under XEmacs, if Org-mode entries are included into the diary, it
3296 is not possible to jump back from the diary to the org file.
3297 Apparently, the text properties are lost when the
3298 fancy-diary-display is used. However, from Org-mode's timeline
3299 and agenda buffers (created with `C-c C-r' and `C-c a'), things do
3302 * You can only make a single word boldface or italic. To emphasize
3303 several words in a row, each must have the emphasize markers, like
3304 in `*three* *bold* *words*'.
3306 * The exporters work well, but could be made more efficient.
3309 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3311 10.9 Acknowledgments
3312 ====================
3314 Org-mode was written by Carsten Dominik, who still maintains it at the
3315 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3316 following people (in alphabetic order) have helped the development
3317 along with ideas, suggestions and patches. Many thanks to all of you,
3318 Org-mode would not be what it is without your input.
3320 * Thomas Baumann contributed the code for links to the MH-E email
3323 * Alex Bochannek provided a patch for rounding time stamps.
3325 * Charles Caves' suggestion sparked the implementation of templates
3328 * Pavel Chalmoviansky influenced the agenda treatment of items with
3331 * Sacha Chua suggested to copy some linking code from Planner.
3333 * Christian Egli converted the documentation into TeXInfo format,
3334 patched CSS formatting into the HTML exporter, and inspired the
3337 * Nic Ferrier contributed mailcap and XML support.
3339 * Kai Grossjohann pointed out key-binding conflicts caused by
3342 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3345 * Tim O'Callaghan suggested in-file links, search options for
3346 general file links, and TAGS.
3348 * Oliver Oppitz suggested multi-state TODO items.
3350 * Scott Otterson sparked the introduction of descriptive text for
3351 links, among other things.
3353 * Pete Phillips helped the development of the TAGS feature.
3355 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3358 * Kevin Rogers contributed code to access VM files on remote hosts.
3360 * Philip Rooke created the Org-mode reference card and provided lots
3363 * Christian Schlauer proposed angular brackets around links, among
3366 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3367 `organizer-mode.el'.
3369 * Ju"rgen Vollmer contributed code generating the table of contents
3372 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3374 * David Wainberg suggested archiving, and improvements to the linking
3377 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
3378 development of Org-mode was fully independent, and both systems are
3379 really different beasts in their basic ideas and implementation
3380 details. However, I have later looked at John's code and learned
3381 from his implementation of (i) links where the link itself is
3382 hidden and only a description is shown, and (ii) popping up a
3383 calendar to select a date.
3385 * Carsten Wimmer suggested some changes and helped fix a bug in
3388 * Roland Winkler requested additional keybindings to make Org-mode
3391 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3395 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3403 * acknowledgments: Acknowledgments. (line 6)
3404 * active region <1>: HTML export. (line 10)
3405 * active region <2>: ASCII export. (line 6)
3406 * active region <3>: Built-in table editor.
3408 * active region: Structure editing. (line 46)
3409 * agenda: Weekly/Daily Agenda. (line 6)
3410 * agenda commands, custom: Agenda dispatcher. (line 6)
3411 * agenda dispatcher: Agenda dispatcher. (line 6)
3412 * agenda files, removing buffers: Agenda commands. (line 187)
3413 * agenda views: Agenda Views. (line 6)
3414 * agenda, for single file: Timeline. (line 6)
3415 * angular brackets, around links: External links. (line 35)
3416 * applescript, for calendar update: iCalendar export. (line 38)
3417 * archive locations: Archiving. (line 13)
3418 * archiving: Archiving. (line 6)
3419 * ASCII export: ASCII export. (line 6)
3420 * author: Feedback. (line 6)
3421 * autoload: Installation and activation.
3423 * BBDB links: External links. (line 6)
3424 * bold text: HTML formatting. (line 13)
3425 * bug reports: Feedback. (line 6)
3426 * bugs: Bugs. (line 6)
3427 * calc package: Table calculations. (line 6)
3428 * calc.el: Interaction. (line 17)
3429 * calculations, in tables <1>: Table calculations. (line 6)
3430 * calculations, in tables: Built-in table editor.
3432 * calendar integration: Calendar/Diary integration.
3434 * calendar, for selecting date: Creating timestamps. (line 68)
3435 * CamelCase link completion: Completion. (line 6)
3436 * CamelCase links: Internal links. (line 6)
3437 * CamelCase links, completion of: CamelCase links. (line 6)
3438 * category: Categories. (line 6)
3439 * children, subtree visibility state: Visibility cycling. (line 10)
3440 * clean outline view: Clean view. (line 6)
3441 * column formula: Column formulas. (line 6)
3442 * commands, in agenda buffer: Agenda commands. (line 6)
3443 * comment lines: Comment lines. (line 6)
3444 * completion, of CamelCase links <1>: Completion. (line 6)
3445 * completion, of CamelCase links: CamelCase links. (line 6)
3446 * completion, of dictionary words: Completion. (line 6)
3447 * completion, of file names: Managing links. (line 36)
3448 * completion, of links: Managing links. (line 23)
3449 * completion, of option keywords <1>: Completion. (line 6)
3450 * completion, of option keywords: Export options. (line 6)
3451 * Completion, of option keywords: Per file keywords. (line 17)
3452 * completion, of tags <1>: Completion. (line 6)
3453 * completion, of tags: Setting tags. (line 12)
3454 * completion, of TeX symbols <1>: Completion. (line 6)
3455 * completion, of TeX symbols: HTML formatting. (line 17)
3456 * completion, of TODO keywords <1>: Completion. (line 6)
3457 * completion, of TODO keywords: Workflow states. (line 12)
3458 * constants, in calculations: Formula syntax. (line 26)
3459 * constants.el: Interaction. (line 27)
3460 * contents, global visibility state: Visibility cycling. (line 19)
3461 * copying, of subtrees: Structure editing. (line 6)
3462 * creating timestamps: Creating timestamps. (line 6)
3463 * CUA.el: Interaction. (line 39)
3464 * custom agenda commands: Agenda dispatcher. (line 6)
3465 * customization: Customization. (line 6)
3466 * cutting, of subtrees: Structure editing. (line 6)
3467 * cycling, of TODO states: TODO basics. (line 13)
3468 * cycling, visibility: Visibility cycling. (line 6)
3469 * dangerous commands: FAQ. (line 37)
3470 * date stamps: Time stamps. (line 6)
3471 * date, reading in minibuffer: Creating timestamps. (line 68)
3472 * DEADLINE keyword: Time stamps. (line 27)
3473 * deadlines: Time stamps. (line 6)
3474 * demotion, of subtrees: Structure editing. (line 6)
3475 * diary entries, creating from agenda: Agenda commands. (line 145)
3476 * diary integration: Calendar/Diary integration.
3478 * dictionary word completion: Completion. (line 6)
3479 * dispatching agenda commands: Agenda dispatcher. (line 6)
3480 * document structure: Document Structure. (line 6)
3481 * DONE, final TODO keyword: Per file keywords. (line 20)
3482 * editing tables: Tables. (line 6)
3483 * editing, of table formulas: Editing/debugging formulas.
3485 * emphasized text: Export options. (line 22)
3486 * evaluate time range: Creating timestamps. (line 63)
3487 * exporting: Exporting. (line 6)
3488 * exporting a subtree: FAQ. (line 78)
3489 * exporting, not: Comment lines. (line 6)
3490 * extended TODO keywords: TODO extensions. (line 6)
3491 * external links: External links. (line 6)
3492 * FAQ: FAQ. (line 6)
3493 * feedback: Feedback. (line 6)
3494 * file links: External links. (line 6)
3495 * file links, searching: Search Options. (line 6)
3496 * file name completion: Managing links. (line 36)
3497 * files, adding to agenda list: Agenda files. (line 12)
3498 * filing subtrees: Archiving. (line 6)
3499 * fixed width: HTML formatting. (line 28)
3500 * fixed-width sections: Export options. (line 22)
3501 * folded, subtree visibility state: Visibility cycling. (line 10)
3502 * folding, sparse trees: Sparse trees. (line 6)
3503 * following links: Managing links. (line 50)
3504 * format specifier: Formula syntax. (line 34)
3505 * format, of links: Link format. (line 6)
3506 * formula editing: Editing/debugging formulas.
3508 * formula syntax: Formula syntax. (line 6)
3509 * formula, for named table field: Named-field formulas.
3511 * formula, for table column: Column formulas. (line 6)
3512 * formula, in tables: Built-in table editor.
3514 * global keybindings: Installation and activation.
3516 * global TODO list: Global TODO list. (line 6)
3517 * global visibility states: Visibility cycling. (line 19)
3518 * GNUS links: External links. (line 6)
3519 * hand-formatted lists: HTML formatting. (line 9)
3520 * headline levels: Export options. (line 22)
3521 * headline levels, for exporting <1>: HTML export. (line 22)
3522 * headline levels, for exporting: ASCII export. (line 12)
3523 * headline navigation: Motion. (line 6)
3524 * headline tagging: Tags. (line 6)
3525 * headline, promotion and demotion: Structure editing. (line 6)
3526 * headlines: Headlines. (line 6)
3527 * hide text: Visibility cycling. (line 6)
3528 * hiding leading stars: Clean view. (line 6)
3529 * HTML export: HTML export. (line 6)
3530 * HTML tags: HTML formatting. (line 33)
3531 * hyperlinks: Hyperlinks. (line 6)
3532 * iCalendar export: iCalendar export. (line 6)
3533 * indentation, of tables: FAQ. (line 102)
3534 * indirect buffers: FAQ. (line 54)
3535 * inheritance, of tags: Tag inheritance. (line 6)
3536 * inserting links: Managing links. (line 23)
3537 * installation: Installation and activation.
3539 * internal links: Internal links. (line 6)
3540 * introduction: Introduction. (line 6)
3541 * italic text: HTML formatting. (line 13)
3542 * jumping, to headlines: Motion. (line 6)
3543 * keybindings, global: Installation and activation.
3545 * keyword options: Per file keywords. (line 6)
3546 * linebreak preservation: Export options. (line 22)
3547 * link completion: Managing links. (line 23)
3548 * link format: Link format. (line 6)
3549 * links, external: External links. (line 6)
3550 * links, internal: Internal links. (line 6)
3551 * links, returning to: Managing links. (line 76)
3552 * lists, hand-formatted: HTML formatting. (line 9)
3553 * lists, ordered: Plain Lists. (line 6)
3554 * lists, plain: Plain Lists. (line 6)
3555 * logging, of progress: Progress logging. (line 6)
3556 * maintainer: Feedback. (line 6)
3557 * make-indirect-buffer: FAQ. (line 54)
3558 * mark ring: Managing links. (line 72)
3559 * marking characters, tables: Advanced features. (line 34)
3560 * matching, of tags: Matching headline tags.
3562 * matching, tags: Tags. (line 6)
3563 * MH-E links: External links. (line 6)
3564 * minor mode for tables: orgtbl-mode. (line 6)
3565 * mode, for calc: Formula syntax. (line 34)
3566 * motion, between headlines: Motion. (line 6)
3567 * name, of column or field: Formula syntax. (line 26)
3568 * named field formula: Named-field formulas.
3570 * names as TODO keywords: TODO types. (line 6)
3571 * narrow columns in tables: Narrow columns. (line 6)
3572 * occur, command: Sparse trees. (line 6)
3573 * option keyword completion: Completion. (line 6)
3574 * options, for customization: Customization. (line 6)
3575 * options, for export: Export options. (line 6)
3576 * ordered lists: Plain Lists. (line 6)
3577 * org-agenda, command: Weekly/Daily Agenda. (line 9)
3578 * org-mode, turning on: Installation and activation.
3580 * org-mouse.el: Interaction. (line 8)
3581 * orgtbl-mode: orgtbl-mode. (line 6)
3582 * outline tree: Headlines. (line 6)
3583 * outline-mode: Outlines. (line 6)
3584 * outlines: Outlines. (line 6)
3585 * overview, global visibility state: Visibility cycling. (line 19)
3586 * packages, interaction with other: Interaction. (line 6)
3587 * pasting, of subtrees: Structure editing. (line 6)
3588 * per file keywords: Per file keywords. (line 6)
3589 * plain lists: Plain Lists. (line 6)
3590 * plain text external links: External links. (line 35)
3591 * printing sparse trees: Sparse trees. (line 39)
3592 * priorities: Priorities. (line 6)
3593 * priorities, of agenda items: Sorting of agenda items.
3595 * progress logging: Progress logging. (line 6)
3596 * promotion, of subtrees: Structure editing. (line 6)
3597 * quoted html tags: Export options. (line 22)
3598 * ranges, time: Time stamps. (line 6)
3599 * recomputing table fields: Column formulas. (line 27)
3600 * region, active <1>: HTML export. (line 10)
3601 * region, active <2>: ASCII export. (line 6)
3602 * region, active <3>: Built-in table editor.
3604 * region, active: Structure editing. (line 46)
3605 * remember.el <1>: Interaction. (line 39)
3606 * remember.el: Remember. (line 6)
3607 * RMAIL links: External links. (line 6)
3608 * SCHEDULED keyword: Time stamps. (line 39)
3609 * scheduling: Time stamps. (line 6)
3610 * search option in file links: Search Options. (line 6)
3611 * section-numbers: Export options. (line 22)
3612 * setting tags: Setting tags. (line 6)
3613 * SHELL links: External links. (line 6)
3614 * shell links, confirmation: FAQ. (line 37)
3615 * show all, command: Visibility cycling. (line 27)
3616 * show all, global visibility state: Visibility cycling. (line 19)
3617 * show hidden text: Visibility cycling. (line 6)
3618 * single file summary: Timeline. (line 6)
3619 * sorting, of agenda items: Sorting of agenda items.
3621 * sparse tree, for deadlines: Creating timestamps. (line 38)
3622 * sparse tree, for TODO: TODO basics. (line 20)
3623 * sparse tree, tag based: Tags. (line 6)
3624 * sparse trees: Sparse trees. (line 6)
3625 * spreadsheet capabilities: Table calculations. (line 6)
3626 * storing links: Managing links. (line 9)
3627 * structure editing: Structure editing. (line 6)
3628 * structure of document: Document Structure. (line 6)
3629 * subtree visibility states: Visibility cycling. (line 10)
3630 * subtree, cut and paste: Structure editing. (line 6)
3631 * subtree, subtree visibility state: Visibility cycling. (line 10)
3632 * subtrees, cut and paste: Structure editing. (line 6)
3633 * summary: Summary. (line 6)
3634 * syntax, of formulas: Formula syntax. (line 6)
3635 * table editor, builtin: Built-in table editor.
3637 * table editor, table.el: table.el. (line 6)
3638 * table of contents: Export options. (line 22)
3639 * table.el <1>: Interaction. (line 13)
3640 * table.el: table.el. (line 6)
3641 * tables <1>: Export options. (line 22)
3642 * tables: Tables. (line 6)
3643 * tables, export to HTML: HTML formatting. (line 24)
3644 * tag completion: Completion. (line 6)
3645 * tag searches: Tag searches. (line 6)
3646 * tags: Tags. (line 6)
3647 * tags view: Matching headline tags.
3649 * templates, for remember: Remember. (line 26)
3650 * TeX interpretation: HTML formatting. (line 15)
3651 * TeX macros: Export options. (line 22)
3652 * TeX symbol completion: Completion. (line 6)
3653 * TeX-like syntax for sub- and superscripts: Export options. (line 22)
3654 * thanks: Acknowledgments. (line 6)
3655 * time stamps: Time stamps. (line 6)
3656 * time, reading in minibuffer: Creating timestamps. (line 68)
3657 * time-sorted view: Timeline. (line 6)
3658 * timeline, single file: Timeline. (line 6)
3659 * timerange: Time stamps. (line 18)
3660 * timestamp: Time stamps. (line 12)
3661 * timestamps, creating: Creating timestamps. (line 6)
3662 * TODO items: TODO items. (line 6)
3663 * TODO keywords completion: Completion. (line 6)
3664 * TODO list, global: Global TODO list. (line 6)
3665 * TODO types: TODO types. (line 6)
3666 * TODO workflow: Workflow states. (line 6)
3667 * transient-mark-mode <1>: HTML export. (line 10)
3668 * transient-mark-mode <2>: ASCII export. (line 6)
3669 * transient-mark-mode <3>: Built-in table editor.
3671 * transient-mark-mode: Structure editing. (line 46)
3672 * trees, sparse: Sparse trees. (line 6)
3673 * trees, visibility: Visibility cycling. (line 6)
3674 * tty keybindings: TTY keys. (line 6)
3675 * types as TODO keywords: TODO types. (line 6)
3676 * underlined text: HTML formatting. (line 13)
3677 * updating, after setting changes: Updating settings. (line 6)
3678 * URL links: External links. (line 6)
3679 * USENET links: External links. (line 6)
3680 * variables, for customization: Customization. (line 6)
3681 * vectors, in table calculations: Formula syntax. (line 23)
3682 * visibility cycling: Visibility cycling. (line 6)
3683 * visible text, printing: Sparse trees. (line 39)
3684 * VM links: External links. (line 6)
3685 * WANDERLUST links: External links. (line 6)
3686 * workflow states as TODO keywords: Workflow states. (line 6)
3689 File: org, Node: Key Index, Prev: Index, Up: Top
3697 * +: Agenda commands. (line 118)
3698 * ,: Agenda commands. (line 110)
3699 * -: Agenda commands. (line 124)
3700 * .: Agenda commands. (line 89)
3701 * :: Agenda commands. (line 107)
3702 * <: Creating timestamps. (line 75)
3703 * <left>: Agenda commands. (line 86)
3704 * <RET> <1>: Agenda commands. (line 41)
3705 * <RET> <2>: Creating timestamps. (line 100)
3706 * <RET>: Built-in table editor.
3708 * <right>: Agenda commands. (line 81)
3709 * <SPC>: Agenda commands. (line 28)
3710 * <TAB> <1>: Agenda commands. (line 35)
3711 * <TAB> <2>: Built-in table editor.
3713 * <TAB> <3>: Plain Lists. (line 37)
3714 * <TAB>: Visibility cycling. (line 10)
3715 * > <1>: Agenda commands. (line 140)
3716 * >: Creating timestamps. (line 76)
3717 * C: Agenda commands. (line 170)
3718 * c: Agenda commands. (line 154)
3719 * C-#: Built-in table editor.
3721 * C-,: Agenda files. (line 18)
3722 * C-c !: Creating timestamps. (line 21)
3723 * C-c $: Archiving. (line 9)
3724 * C-c %: Managing links. (line 72)
3725 * C-c &: Managing links. (line 76)
3726 * C-c ' <1>: Editing/debugging formulas.
3728 * C-c ': Built-in table editor.
3730 * C-c *: Built-in table editor.
3732 * C-c +: Built-in table editor.
3734 * C-c ,: Priorities. (line 18)
3735 * C-c -: Built-in table editor.
3737 * C-c .: Creating timestamps. (line 10)
3738 * C-c /: Sparse trees. (line 15)
3739 * C-c :: HTML export. (line 17)
3740 * C-c ;: Comment lines. (line 12)
3741 * C-c <: Creating timestamps. (line 25)
3742 * C-c <TAB>: Built-in table editor.
3744 * C-c =: Built-in table editor.
3746 * C-c >: Creating timestamps. (line 29)
3747 * C-c ? <1>: Editing/debugging formulas.
3749 * C-c ?: Built-in table editor.
3751 * C-c [: Agenda files. (line 12)
3752 * C-c \: Tag searches. (line 9)
3753 * C-c ]: Agenda files. (line 15)
3754 * C-c ^: Built-in table editor.
3756 * C-c `: Built-in table editor.
3758 * C-c a a: Weekly/Daily Agenda. (line 9)
3759 * C-c a C: Agenda dispatcher. (line 30)
3760 * C-c a M: Matching headline tags.
3762 * C-c a m: Matching headline tags.
3764 * C-c a M: Tag searches. (line 14)
3765 * C-c a m: Tag searches. (line 10)
3766 * C-c a T: Global TODO list. (line 15)
3767 * C-c a t <1>: Global TODO list. (line 9)
3768 * C-c a t: TODO basics. (line 27)
3769 * C-c C-a: Visibility cycling. (line 27)
3770 * C-c C-b: Motion. (line 15)
3771 * C-c C-c <1>: Updating settings. (line 6)
3772 * C-c C-c <2>: Setting tags. (line 11)
3773 * C-c C-c <3>: table.el. (line 6)
3774 * C-c C-c <4>: Editing/debugging formulas.
3776 * C-c C-c <5>: Built-in table editor.
3778 * C-c C-c: Plain Lists. (line 61)
3779 * C-c C-d: Creating timestamps. (line 37)
3780 * C-c C-f: Motion. (line 12)
3781 * C-c C-j: Motion. (line 21)
3782 * C-c C-l: Managing links. (line 23)
3783 * C-c C-n: Motion. (line 8)
3784 * C-c C-o <1>: Creating timestamps. (line 33)
3785 * C-c C-o: Managing links. (line 50)
3786 * C-c C-p: Motion. (line 9)
3787 * C-c C-q <1>: Editing/debugging formulas.
3789 * C-c C-q: Built-in table editor.
3791 * C-c C-r: Timeline. (line 13)
3792 * C-c C-s: Creating timestamps. (line 47)
3793 * C-c C-t: TODO basics. (line 13)
3794 * C-c C-u: Motion. (line 18)
3795 * C-c C-v: TODO basics. (line 20)
3796 * C-c C-w: Creating timestamps. (line 38)
3797 * C-c C-x a: ASCII export. (line 6)
3798 * C-c C-x b: HTML export. (line 11)
3799 * C-c C-x c: iCalendar export. (line 20)
3800 * C-c C-x C-c: Agenda commands. (line 177)
3801 * C-c C-x C-i: iCalendar export. (line 15)
3802 * C-c C-x C-k: Structure editing. (line 31)
3803 * C-c C-x C-w <1>: Built-in table editor.
3805 * C-c C-x C-w: Structure editing. (line 31)
3806 * C-c C-x C-y <1>: Built-in table editor.
3808 * C-c C-x C-y: Structure editing. (line 38)
3809 * C-c C-x h: HTML export. (line 10)
3810 * C-c C-x i: iCalendar export. (line 13)
3811 * C-c C-x M-w <1>: Built-in table editor.
3813 * C-c C-x M-w: Structure editing. (line 35)
3814 * C-c C-x t: HTML export. (line 14)
3815 * C-c C-x v: Sparse trees. (line 39)
3816 * C-c C-y: Creating timestamps. (line 63)
3817 * C-c l: Managing links. (line 9)
3818 * C-c |: Built-in table editor.
3820 * C-c ~: table.el. (line 18)
3821 * C-u C-c .: Creating timestamps. (line 16)
3822 * C-u C-c =: Built-in table editor.
3824 * C-u C-c C-l: Managing links. (line 36)
3825 * D: Agenda commands. (line 66)
3826 * d: Agenda commands. (line 63)
3827 * f: Agenda commands. (line 44)
3828 * g: Agenda commands. (line 70)
3829 * H: Agenda commands. (line 174)
3830 * i: Agenda commands. (line 145)
3831 * l: Agenda commands. (line 49)
3832 * L: Agenda commands. (line 32)
3833 * M: Agenda commands. (line 161)
3834 * M-<down>: Built-in table editor.
3836 * M-<left> <1>: Built-in table editor.
3838 * M-<left>: Structure editing. (line 13)
3839 * M-<RET> <1>: Plain Lists. (line 42)
3840 * M-<RET>: Structure editing. (line 6)
3841 * M-<right> <1>: Built-in table editor.
3843 * M-<right>: Structure editing. (line 16)
3844 * M-<TAB> <1>: Completion. (line 10)
3845 * M-<TAB> <2>: Setting tags. (line 6)
3846 * M-<TAB>: Per file keywords. (line 17)
3847 * M-<up>: Built-in table editor.
3849 * M-S-<down> <1>: Built-in table editor.
3851 * M-S-<down> <2>: Plain Lists. (line 46)
3852 * M-S-<down>: Structure editing. (line 28)
3853 * M-S-<left> <1>: Creating timestamps. (line 97)
3854 * M-S-<left> <2>: Built-in table editor.
3856 * M-S-<left> <3>: Plain Lists. (line 52)
3857 * M-S-<left>: Structure editing. (line 19)
3858 * M-S-<RET>: Structure editing. (line 10)
3859 * M-S-<right> <1>: Creating timestamps. (line 94)
3860 * M-S-<right> <2>: Built-in table editor.
3862 * M-S-<right> <3>: Plain Lists. (line 52)
3863 * M-S-<right>: Structure editing. (line 22)
3864 * M-S-<up> <1>: Built-in table editor.
3866 * M-S-<up> <2>: Plain Lists. (line 46)
3867 * M-S-<up>: Structure editing. (line 25)
3868 * mouse-1 <1>: Agenda commands. (line 35)
3869 * mouse-1 <2>: Creating timestamps. (line 79)
3870 * mouse-1: Managing links. (line 64)
3871 * mouse-2 <1>: Agenda commands. (line 35)
3872 * mouse-2: Managing links. (line 64)
3873 * mouse-3 <1>: Agenda commands. (line 28)
3874 * mouse-3: Managing links. (line 69)
3875 * n: Agenda commands. (line 19)
3876 * o: Agenda commands. (line 57)
3877 * P: Agenda commands. (line 115)
3878 * p: Agenda commands. (line 20)
3879 * q: Agenda commands. (line 184)
3880 * r <1>: Agenda commands. (line 74)
3881 * r: Global TODO list. (line 21)
3882 * S: Agenda commands. (line 165)
3883 * S-<down> <1>: Agenda commands. (line 124)
3884 * S-<down> <2>: Creating timestamps. (line 55)
3885 * S-<down>: Priorities. (line 25)
3886 * S-<left> <1>: Agenda commands. (line 136)
3887 * S-<left>: Creating timestamps. (line 50)
3888 * S-<RET>: Built-in table editor.
3890 * S-<right> <1>: Agenda commands. (line 128)
3891 * S-<right>: Creating timestamps. (line 50)
3892 * S-<TAB> <1>: Built-in table editor.
3894 * S-<TAB>: Visibility cycling. (line 19)
3895 * S-<up> <1>: Agenda commands. (line 118)
3896 * S-<up> <2>: Creating timestamps. (line 55)
3897 * S-<up>: Priorities. (line 25)
3898 * T: Agenda commands. (line 102)
3899 * t: Agenda commands. (line 98)
3900 * w: Agenda commands. (line 60)
3901 * x: Agenda commands. (line 187)
3907 Node: Introduction
\x7f7259
3908 Node: Summary
\x7f7573
3909 Node: Installation and activation
\x7f9685
3910 Node: Feedback
\x7f11354
3911 Node: Document Structure
\x7f12140
3912 Node: Outlines
\x7f12906
3913 Node: Headlines
\x7f13566
3914 Node: Visibility cycling
\x7f14189
3915 Node: Motion
\x7f15380
3916 Node: Structure editing
\x7f16164
3917 Node: Archiving
\x7f17907
3918 Node: Sparse trees
\x7f18767
3919 Ref: Sparse trees-Footnote-1
\x7f20796
3920 Ref: Sparse trees-Footnote-2
\x7f20888
3921 Node: Plain Lists
\x7f21002
3922 Ref: Plain Lists-Footnote-1
\x7f23758
3923 Node: Tables
\x7f24115
3924 Node: Built-in table editor
\x7f24663
3925 Node: Narrow columns
\x7f32277
3926 Ref: Narrow columns-Footnote-1
\x7f34210
3927 Node: Table calculations
\x7f34256
3928 Node: Formula syntax
\x7f35432
3929 Ref: Formula syntax-Footnote-1
\x7f38366
3930 Node: Column formulas
\x7f38665
3931 Node: Advanced features
\x7f40427
3932 Node: Named-field formulas
\x7f43682
3933 Node: Editing/debugging formulas
\x7f44322
3934 Node: Appetizer
\x7f46080
3935 Node: orgtbl-mode
\x7f47182
3936 Node: table.el
\x7f47673
3937 Node: Hyperlinks
\x7f48650
3938 Node: Link format
\x7f49284
3939 Node: Internal links
\x7f50581
3940 Node: Radio targets
\x7f52471
3941 Node: CamelCase links
\x7f53186
3942 Node: External links
\x7f53684
3943 Node: Managing links
\x7f55609
3944 Node: Search Options
\x7f59593
3945 Ref: Search Options-Footnote-1
\x7f60913
3946 Node: Remember
\x7f60994
3947 Ref: Remember-Footnote-1
\x7f64860
3948 Node: TODO items
\x7f64984
3949 Node: TODO basics
\x7f65907
3950 Node: Progress logging
\x7f67422
3951 Node: TODO extensions
\x7f68208
3952 Node: Workflow states
\x7f69008
3953 Node: TODO types
\x7f69876
3954 Ref: TODO types-Footnote-1
\x7f71534
3955 Node: Per file keywords
\x7f71616
3956 Ref: Per file keywords-Footnote-1
\x7f73069
3957 Node: Priorities
\x7f73297
3958 Node: Timestamps
\x7f74506
3959 Node: Time stamps
\x7f74827
3960 Node: Creating timestamps
\x7f76842
3962 Node: Tag inheritance
\x7f80706
3963 Node: Setting tags
\x7f81643
3964 Node: Tag searches
\x7f82605
3965 Node: Agenda Views
\x7f83814
3966 Node: Agenda files
\x7f85353
3967 Ref: Agenda files-Footnote-1
\x7f86313
3968 Ref: Agenda files-Footnote-2
\x7f86462
3969 Node: Agenda dispatcher
\x7f86654
3970 Node: Weekly/Daily Agenda
\x7f88784
3971 Node: Categories
\x7f89919
3972 Node: Time-of-day specifications
\x7f90567
3973 Node: Calendar/Diary integration
\x7f92543
3974 Node: Sorting of agenda items
\x7f93920
3975 Node: Global TODO list
\x7f94752
3976 Node: Matching headline tags
\x7f96167
3977 Node: Timeline
\x7f97110
3978 Node: Agenda commands
\x7f97983
3979 Node: Exporting
\x7f103239
3980 Node: ASCII export
\x7f103811
3981 Node: HTML export
\x7f104646
3982 Node: HTML formatting
\x7f105762
3983 Node: Export options
\x7f107394
3984 Node: Comment lines
\x7f109716
3985 Node: iCalendar export
\x7f110186
3986 Node: Miscellaneous
\x7f111981
3987 Node: Completion
\x7f112688
3988 Node: Customization
\x7f113684
3989 Node: Updating settings
\x7f114139
3990 Node: Clean view
\x7f115547
3991 Node: TTY keys
\x7f118191
3993 Node: Interaction
\x7f126026
3994 Node: Bugs
\x7f128867
3995 Node: Acknowledgments
\x7f131176
3996 Node: Index
\x7f134106
3997 Node: Key Index
\x7f154821