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.19b).
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.19b).
32 Copyright (C) 2004, 2005, 2006 Free Software Foundation
34 Permission is granted to copy, distribute and/or modify this
35 document under the terms of the GNU Free Documentation License,
36 Version 1.1 or any later version published by the Free Software
37 Foundation; with no Invariant Sections, with the Front-Cover texts
38 being "A GNU Manual," and with the Back-Cover Texts as in (a)
39 below. A copy of the license is included in the section entitled
40 "GNU Free Documentation License."
42 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
43 modify this GNU Manual, like GNU software. Copies published by
44 the Free Software Foundation raise funds for GNU development."
48 * Introduction:: Getting started
49 * Document Structure:: A tree works like your brain
50 * Tables:: Pure magic for quick formatting
51 * Hyperlinks:: Notes in context
52 * TODO items:: Every tree branch can be a TODO item
53 * Timestamps:: Assign date and time to items
54 * Tags:: Tagging headlines and matching sets of tags
55 * Agenda Views:: Collecting information into views
56 * Exporting:: Sharing and publishing of notes
57 * Miscellaneous:: All the rest which did not fit elsewhere
58 * Index:: The fast road to specific information
59 * Key Index:: Key bindings and where they are described
61 --- The Detailed Node Listing ---
65 * Summary:: Brief summary of what Org-mode does
66 * Installation and activation:: How to install Org-mode
67 * Feedback:: Bug reports, ideas, patches etc.
71 * Outlines:: Org-mode is based on outline-mode
72 * Headlines:: How to typeset org-tree headlines
73 * Visibility cycling:: Show and hide, much simplified
74 * Motion:: Jumping to other headlines
75 * Structure editing:: Changing sequence and level of headlines
76 * Archiving:: Move done task trees to a different place
77 * Sparse trees:: Matches embedded in context
78 * Plain Lists:: Editing hand-formatted lists
82 * Built-in table editor:: Simple tables
83 * Narrow columns:: Stop wasting space in tables
84 * Table calculations:: Compute a field from other fields
85 * orgtbl-mode:: The table editor as minor mode
86 * table.el:: Complex tables
88 Calculations in tables
90 * Formula syntax:: How to write a formula
91 * Column formulas:: Formulas valid for all fields in a column
92 * Advanced features:: Field names, parameters and automatic recalc
93 * Named-field formulas:: Formulas valid in single fields
94 * Editing/debugging formulas:: Changing a stored formula
95 * Appetizer:: Taste the power of calc
99 * Link format:: How links in Org-mode are formatted
100 * Internal links:: Links to other places in the current file
101 * External links:: URL-like links to the world
102 * Managing links:: Creating, inserting and following
103 * Search Options:: Linking to a specific location
104 * Remember:: Org-trees store quick notes
108 * Radio targets:: Make targets trigger links in plain text.
109 * CamelCase links:: Activating CamelCase words as links
113 * TODO basics:: Marking and displaying TODO entries
114 * Progress logging:: Document your productivity
115 * TODO extensions:: Workflow and assignments
116 * Priorities:: Some things are more important than others
118 Extended use of TODO keywords
120 * Workflow states:: From TODO to DONE in steps
121 * TODO types:: I do this, Fred the rest
122 * Per file keywords:: Different files, different requirements
126 * Time stamps:: Assigning a time to a tree entry
127 * Creating timestamps:: Commands which insert timestamps
131 * Tag inheritance:: Tags use the tree structure of the outline
132 * Setting tags:: How to assign tags to a headline
133 * Tag searches:: Searching for combinations of tags
137 * Agenda files:: Files being searched for agenda information
138 * Agenda dispatcher:: Keyboard access to agenda views
139 * Weekly/Daily Agenda:: The calendar page with current tasks
140 * Global TODO list:: All unfinished action items
141 * Matching headline tags:: Structured information with fine-tuned search
142 * Timeline:: Time-sorted view for single file
143 * Agenda commands:: Remote editing of org trees
145 The weekly/daily agenda
147 * Categories:: Not all tasks are equal
148 * Time-of-day specifications:: How the agenda knows the time
149 * Calendar/Diary integration:: Integrating Anniversaries and more
150 * Sorting of agenda items:: The order of things
154 * ASCII export:: Export as a structured ASCII file
155 * HTML export:: Export as an HTML file
156 * iCalendar export:: Create calendar entries.
160 * HTML formatting:: Interpretation of the buffer content
161 * Export options:: How to influence exports
162 * Comment lines:: Lines which will not be exported
166 * Completion:: M-TAB knows what you need
167 * Customization:: Adapting Org-mode to your taste
168 * Clean view:: Getting rid of leading stars in the outline
169 * TTY keys:: Using Org-mode on a tty
170 * FAQ:: Frequently asked questions
171 * Interaction:: Other Emacs packages
172 * Bugs:: Things which do not work perfectly
173 * Acknowledgments:: These people provided feedback and more
176 File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
183 * Summary:: Brief summary of what Org-mode does
184 * Installation and activation:: How to install Org-mode
185 * Feedback:: Bug reports, ideas, patches etc.
188 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
193 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
194 project planning with a fast and effective plain-text system.
196 Org-mode develops organizational tasks around NOTES files that
197 contain information about projects as plain text. Org-mode is
198 implemented on top of outline-mode, which makes it possible to keep the
199 content of large files well structured. Visibility cycling and
200 structure editing help to work with the tree. Tables are easily
201 created with a built-in table editor. Org-mode supports ToDo items,
202 deadlines, time stamps, and scheduling. It dynamically compiles
203 entries into an agenda that utilizes and smoothly integrates much of
204 the Emacs calendar and diary. Plain text URL-like links connect to
205 websites, emails, Usenet messages, BBDB entries, and any files related
206 to the projects. For printing and sharing of notes, an Org-mode file
207 can be exported as a structured ASCII file, as HTML, or (todo and
208 agenda items only) as an iCalendar file.
210 Org-mode keeps simple things simple. When first fired up, it should
211 feel like a simple but easy to use outliner. Complexity is not
212 imposed, but a large amount of functionality is available when you need
213 it. Org-mode can be used on different levels and in different ways,
216 * as an outline extension with visibility cycling and structure editing
217 * as an ASCII system and table editor for taking structured notes
218 * as an ASCII table editor with spreadsheet-like capabilities
219 * as a simple hypertext system, with HTML export
220 * as a TODO list editor
221 * as a full agenda and planner with deadlines and work scheduling
223 The Org-mode table editor can be integrated into any major mode by
224 activating the minor Orgtbl-mode.
226 There is a website for Org-mode which provides links to the newest
227 version of Org-mode, as well as additional information, screen shots
228 and example files. This page is located at
229 `http://www.astro.uva.nl/~dominik/Tools/org/'.
232 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
234 1.2 Installation and Activation
235 ===============================
237 If Org-mode is part of the Emacs distribution or an XEmacs package, you
238 only need to copy the following lines to your `.emacs' file. The last
239 two lines define _global_ keys for the commands `org-store-link' and
240 `org-agenda' - please choose suitable keys yourself.
242 ;; The following lines are always needed. Choose your own keys.
243 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
244 (define-key global-map "\C-cl" 'org-store-link)
245 (define-key global-map "\C-ca" 'org-agenda)
247 If you have downloaded Org-mode from the Web, you must byte-compile
248 `org.el' and put it on your load path. In addition to the Emacs Lisp
249 lines above, you also need to add the following lines to `.emacs':
251 ;; These lines only if org-mode is not part of the X/Emacs distribution.
252 (autoload 'org-mode "org" "Org mode" t)
253 (autoload 'org-diary "org" "Diary entries from Org mode")
254 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
255 (autoload 'org-store-link "org" "Store a link to the current location" t)
256 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
257 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
259 With this setup, all files with extension `.org' will be put into
260 Org-mode. As an alternative, make the first line of a file look like
263 MY PROJECTS -*- mode: org; -*-
265 which will select Org-mode for this buffer no matter what the file's
266 name is. See also the variable `org-insert-mode-line-in-empty-file'.
268 If you are upgrading to version 4.20 or later from a version 4.14 or
269 earlier, some links may stop working. These are links containing space
270 characters. To make such links work again, and also to transform all
271 links from the old `<link>' format to the new `[[link]]' format,
272 execute once in each file: `M-x org-upgrade-old-links'.
275 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
280 If you find problems with Org-mode, or if you have questions, remarks,
281 or ideas about it, please contact the maintainer Carsten Dominik at
282 <dominik@science.uva.nl>.
284 For bug reports, please provide as much information as possible,
285 including the version information of Emacs (`C-h v emacs-version
286 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
287 Org-mode related setup in `.emacs'. If an error occurs, a traceback
288 can be very useful. Often a small example file helps, along with clear
291 1. What exactly did you do?
293 2. What did you expect to happen?
295 3. What happened instead?
296 Thank you for helping to improve this mode.
299 File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
304 Org-mode is based on outline mode and provides flexible commands to
305 edit the structure of the document.
309 * Outlines:: Org-mode is based on outline-mode
310 * Headlines:: How to typeset org-tree headlines
311 * Visibility cycling:: Show and hide, much simplified
312 * Motion:: Jumping to other headlines
313 * Structure editing:: Changing sequence and level of headlines
314 * Archiving:: Move done task trees to a different place
315 * Sparse trees:: Matches embedded in context
316 * Plain Lists:: Editing hand-formatted lists
319 File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
324 Org-mode is implemented on top of outline-mode. Outlines allow to
325 organize a document in a hierarchical structure, which (at least for
326 me) is the best representation of notes and thoughts. Overview over
327 this structure is achieved by folding (hiding) large parts of the
328 document to show only the general document structure and the parts
329 currently being worked on. Org-mode greatly simplifies the use of
330 outlines by compressing the entire show/hide functionality into a
331 single command `org-cycle', which is bound to the <TAB> key.
334 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
339 Headlines define the structure of an outline tree. The headlines in
340 Org-mode start with one or more stars, on the left margin. For example:
348 * Another top level headline
350 Some people find the many stars too noisy and would prefer an outline
351 that has whitespace followed by a single star as headline starters.
352 *Note Clean view:: describes a setup to realize this.
355 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
357 2.3 Visibility cycling
358 ======================
360 Outlines make it possible to hide parts of the text in the buffer.
361 Org-mode uses a single command bound to the <TAB> key to change the
362 visibility in the buffer.
365 Rotate current subtree between the states
367 ,-> FOLDED -> CHILDREN -> SUBTREE --.
368 '-----------------------------------'
370 At the beginning of the buffer (or when called with `C-u'), this
371 does the same as the command `S-<TAB>' below.
374 Rotate the entire buffer between the states
376 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
377 '--------------------------------------'
379 Note that inside tables, `S-<TAB>' jumps to the previous field.
384 When Emacs first visits an Org-mode file, the global state is set to
385 OVERVIEW, i.e. only the top level headlines are visible. This can be
386 configured through the variable `org-startup-folded', or on a per-file
387 basis by adding one of the following lines anywhere in the buffer:
394 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
399 The following commands jump to other headlines in the buffer.
408 Next heading same level.
411 Previous heading same level.
414 Backward to higher level heading.
417 Jump to a different place without changing the current outline
418 visibility. Shows the document structure in a temporary buffer,
419 where you can use visibility cycling (<TAB>) to find your
420 destination. After pressing <RET>, the cursor moves to the
421 selected location in the original buffer, and the headings
422 hierarchy above it is made visible.
425 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document Structure
427 2.5 Structure editing
428 =====================
431 Insert new heading with same level as current. If the cursor is
432 in a plain list item, a new item is created. To force creation of
433 a new headline, use a prefix arg, or first press <RET> to get to
434 the beginning of the next line.
437 Insert new TODO entry with same level as current heading.
440 Promote current heading by one level.
443 Demote current heading by one level.
446 Promote the current subtree by one level.
449 Demote the current subtree by one level.
452 Move subtree up (swap with previous subtree of same level).
455 Move subtree down (swap with next subtree of same level).
459 Kill subtree, i.e. remove it from buffer but save in kill ring.
462 Copy subtree to kill ring.
465 Yank subtree from kill ring. This does modify the level of the
466 subtree to make sure the tree fits in nicely at the yank position.
467 The yank level can also be specified with a prefix arg, or by
468 yanking after a headline marker like `****'.
470 When there is an active region (transient-mark-mode), promotion and
471 demotion work on all headlines in the region. To select a region of
472 headlines, it is best to place both point and mark at the beginning of a
473 line, mark at the beginning of the first headline, and point at the line
474 just after the last headline to change. Note that when the cursor is
475 inside a table (*note Tables::), the Meta-Cursor keys have different
479 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document Structure
484 When a project represented by a (sub)tree is finished, you may want to
485 move the tree to an archive place, either in the same file under a
486 special top-level heading, or even to a different file.
488 Archive the subtree starting at the cursor position to the location
489 given by `org-archive-location'.
491 The default archive is a file in the same directory as the current
492 file, with the name derived by appending `_archive' to the current file
493 name. For information and examples on how to change this, see the
494 documentation string of the variable `org-archive-location'. If you
495 are also using the Org-mode agenda, archiving to a different file is a
496 good way to keep archived trees from contributing agenda items.
499 File: org, Node: Sparse trees, Next: Plain Lists, Prev: Archiving, Up: Document Structure
504 An important feature of Org-mode is the ability to construct _sparse
505 trees_ for selected information in an outline tree. A sparse tree
506 means that the entire document is folded as much as possible, but the
507 selected information is made visible along with the headline structure
508 above it(1). Just try it out and you will see immediately how it works.
510 Org-mode contains several commands creating such trees. The most
511 basic one is `org-occur':
514 Occur. Prompts for a regexp and shows a sparse tree with all
515 matches. If the match is in a headline, the headline is made
516 visible. If the match is in the body of an entry, headline and
517 body are made visible. In order to provide minimal context, also
518 the full hierarchy of headlines above the match is shown, as well
519 as the headline following the match. Each match is also
520 highlighted, the highlights disappear when the buffer is changed
521 with an editing command.
522 For frequently used sparse trees of specific search strings, you can
523 use the variable `org-agenda-custom-commands' to define fast keyboard
524 access to specific sparse trees. These commands will then be
525 accessible through the agenda dispatcher (*note Agenda dispatcher::).
528 (setq org-agenda-custom-commands
529 '(("f" occur-tree "FIXME")))
531 will define the key `C-c a f' as a shortcut for creating a sparse tree
532 matching the string `FIXME'.
534 Other commands are using sparse trees as well. For example `C-c
535 C-v' creates a sparse TODO tree (*note TODO basics::).
537 To print a sparse tree, you can use the Emacs command
538 `ps-print-buffer-with-faces' which does not print invisible parts of
539 the document (2). Or you can use the command `C-c C-x v' to copy the
540 visible part of the document to another file (extension `.txt') which
541 can then be printed in any desired way.
543 ---------- Footnotes ----------
545 (1) See also the variables `org-show-hierarchy-above' and
546 `org-show-following-heading'.
548 (2) This does not work under XEmacs, because XEmacs uses selective
549 display for outlining, not text properties
552 File: org, Node: Plain Lists, Prev: Sparse trees, Up: Document Structure
557 Headlines define both the structure of the Org-mode file, and also lists
558 (for example, TODO items (*note TODO items::) should be created using
559 headline levels). However, when taking notes, the plain text is
560 sometimes easier to read with hand-formatted lists. Org-mode supports
561 editing such lists, and the HTML exporter (*note Exporting::) does
562 parse and format them.
564 Org-mode knows ordered and unordered lists. Unordered list items
565 start with `-', `+', or `*'(1) as bullets. Ordered list items start
566 with `1.' or `1)'. Items belonging to the same list must have the same
567 indentation on the first line. In particular, if an ordered list
568 reaches number `10.', then the 2-digit numbers must be written
569 left-aligned with the other numbers in the list. Indentation also
570 determines the end of a list item. It ends before the next line that
571 is indented like the bullet/number, or less. For example:
574 My favorite scenes are (in this order)
575 1. Eowyns fight with the witch king
576 + this was already my favorite scene in the book
577 + I really like Miranda Otto.
578 2. The attack of the Rohirrim
579 3. Peter Jackson being shot by Legolas
581 He makes a really funny face when it happens.
583 Org-mode supports these lists by tuning filling and wrapping commands
584 to correctly deal with them. Furthermore, the following commands act
585 on items when the cursor is in the first line of an item (the line with
586 the bullet or number).
589 Items can be folded just like headline levels if you set the
590 variable `org-cycle-include-plain-lists'. The level of an item is
591 then given by the indentation of the bullet/number. However,
592 items are always subordinate to real headlines, the hierarchies
593 remain completely separated.
596 Insert new item at current level. With prefix arg, for a new
601 Move the item including subitems up/down (swap with previous/next
602 item of same indentation). If the list is ordered, renumbering is
607 Decrease/increase the indentation of the item, including subitems.
608 Initially, the item tree is selected based on current indentation.
609 When these commands are executed several times in direct
610 succession, the initially selected region is used, even if the new
611 indentation would imply a different hierarchy. To use the new
612 hierarchy, break the command chain with a cursor motion or so.
615 Renumber the ordered list at the cursor.
617 ---------- Footnotes ----------
619 (1) When using `*' as a bullet, lines must be indented or they will
620 be seen as top-level headlines. Also, when you are hiding leading
621 stars to get a clean outline view, plain list items starting with a
622 star are visually indistinguishable from true headlines. In short:
623 even though `*' is supported, it may be better to not use it for plain
627 File: org, Node: Tables, Next: Hyperlinks, Prev: Document Structure, Up: Top
632 Org-mode has a very fast and intuitive table editor built-in.
633 Spreadsheet-like calculations are supported in connection with the
634 Emacs `calc' package.
638 * Built-in table editor:: Simple tables
639 * Narrow columns:: Stop wasting space in tables
640 * Table calculations:: Compute a field from other fields
641 * orgtbl-mode:: The table editor as minor mode
642 * table.el:: Complex tables
645 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
647 3.1 The built-in table editor
648 =============================
650 Org-mode makes it easy to format tables in plain ASCII. Any line with
651 `|' as the first non-white character is considered part of a table.
652 `|' is also the column separator. A table might look like this:
654 | Name | Phone | Age |
655 |-------+-------+-----|
656 | Peter | 1234 | 17 |
659 A table is re-aligned automatically each time you press <TAB> or
660 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
661 field (<RET> to the next row) and creates new table rows at the end of
662 the table or before horizontal lines. The indentation of the table is
663 set by the first line. Any line starting with `|-' is considered as a
664 horizontal separator line and will be expanded on the next re-align to
665 span the whole table width. So, to create the above table, you would
671 and then press <TAB> to align the table and start filling in fields.
673 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
674 and all character keys in a special way, so that inserting and deleting
675 avoids shifting other fields. Also, when typing _immediately after the
676 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
677 the field is automatically made blank. If this behavior is too
678 unpredictable for you, configure the variables
679 `org-enable-table-editor' and `org-table-auto-blank-field'.
681 Creation and conversion
682 .......................
684 `M-x org-table-create'
685 Creates an empty Org-mode table. However, it is much easier to
686 just start typing, like `|Name|Phone|Age <RET> |- <TAB>'
689 Convert region to table. Works when the cursor is not in an
690 existing table, and when there is a region defined. If every line
691 contains at least one TAB character, the function assumes that the
692 material is tab separated. If not, lines are split at whitespace
693 into fields. You can use a prefix argument to indicate the
694 minimum number of consequtive spaces required to indentify a field
695 separator (default: just one).
697 Re-aligning and field motion
698 ............................
701 Re-align the table without moving the cursor.
704 Re-align the table, move to the next field. Creates a new row if
708 Re-align, move to previous field.
711 Re-align the table and move down to next row. Creates a new row if
712 necessary. At the beginning or end of a line, <RET> still does
713 NEWLINE, so it can be used to split a table.
715 Column and row editing
716 ......................
720 Move the current column left/right.
723 Kill the current column.
726 Insert a new column to the left of the cursor position.
730 Move the current row up/down.
733 Kill the current row or horizontal line.
736 Insert a new row above (with arg: below) the current row.
739 Insert a horizontal line below current row. With prefix arg, the
740 line is created above the current line.
743 Sort the table lines in the region. Point and mark must be in the
744 first and last line to be included, and must be in the column that
745 should be used for sorting. The command prompts for numerical
746 versus alphanumerical sorting.
752 Copy a rectangular region from a table to a special clipboard.
753 Point and mark determine edge fields of the rectangle. The
754 process ignores horizontal separator lines.
757 Copy a rectangular region from a table to a special clipboard, and
758 blank all fields in the rectangle. So this is the "cut" operation.
761 Paste a rectangular region into a table. The upper right corner
762 ends up in the current field. All involved fields will be
763 overwritten. If the rectangle does not fit into the present table,
764 the table is enlarged as needed. The process ignores horizontal
768 Wrap several fields in a column like a paragraph. If there is an
769 active region, and both point and mark are in the same column, the
770 text in the column is wrapped to minimum width for the given
771 number of lines. A prefix ARG may be used to change the number of
772 desired lines. If there is no region, the current field is split
773 at the cursor position and the text fragment to the right of the
774 cursor is prepended to the field one line down. If there is no
775 region, but you specify a prefix ARG, the current field is made
776 blank, and the content is appended to the field above.
782 Install a new formula for the current column and replace current
783 field with the result of the formula.
786 Install a new formula for the current field, which must be a named
787 field. Evaluate the formula and replace the field content with the
791 Edit all formulas associated with the current table in a separate
795 Recalculate the current row by applying the stored formulas from
796 left to right. When called with a `C-u' prefix, recalculate the
797 entire table, starting with the first non-header line (i.e. below
798 the first horizontal separator line). For details, see *Note
799 Table calculations::.
802 Rotate the calculation mark in first column through the states `',
803 `#', `*', `!', `$'. For the meaning of these marks see *Note
804 Advanced features::. When there is an active region, change all
808 Which table column is the cursor in? Displays number >0 in echo
812 Sum the numbers in the current column, or in the rectangle defined
813 by the active region. The result is shown in the echo area and can
814 be inserted with `C-y'.
817 When current field is empty, copy from first non-empty field above.
818 When not empty, copy current field down to next row and move cursor
819 along with it. Depending on the variable
820 `org-table-copy-increment', integer field values will be
821 incremented during copy. This key is also used by CUA-mode (*note
828 Edit the current field in a separate window. This is useful for
829 fields that are not fully visible (*note Narrow columns::). When
830 called with a `C-u' prefix, just make the full field visible, so
831 that it can be edited in place.
834 This is an alias for `C-u C-c `' to make the current field fully
838 Toggle the visibility of vertical lines in tables. The lines are
839 still there, only made invisible with a text property. Any `|'
840 added by hand will become invisible on the next align.
842 `M-x org-table-import'
843 Import a file as a table. The table should be TAB- or whitespace
844 separated. Useful, for example, to import an Excel table or data
845 from a database, because these programs generally can write
846 TAB-separated text files. This command works by inserting the
847 file into the buffer and then converting the region to a table.
848 Any prefix argument is passed on to the converter, which uses it
849 to determine the separator.
851 `M-x org-table-export'
852 Export the table as a TAB-separated file. Useful for data
853 exchange with, for example, Excel or database programs.
856 If you don't like the automatic table editor because it gets in your
857 way on lines which you would like to start with `|', you can turn it
860 (setq org-enable-table-editor nil)
862 The only table command which then still works is `C-c C-c' to do a
866 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
871 The width of columns is automatically determined by the table editor.
872 Sometimes a single field or a few fields need to carry more text,
873 leading to unconveniently wide columns. To limit(1) the width of a
874 column, one field anywhere in the column must carry the string `<N>'
875 where `N' is an integer specifying the width of the column in
876 characters. The next re-align will then set the width of this column
877 to no more than this value.
879 |---+------------------------------| |---+--------|
881 | 1 | one | | 1 | one |
882 | 2 | two | ----\ | 2 | two |
883 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
884 | 4 | four | | 4 | four |
885 |---+------------------------------| |---+--------|
887 Fields that are wider become clipped and end in the string `=>'. Note
888 that the full text is still in the buffer, it is only invisible. To
889 see the full text, hold the mouse over the field - a tooltip window
890 will show the full content. To edit such a field, use the command `C-c
891 `' (that is `C-c' followed by the backquote). This will open a new
892 window with the full field. Edit it and finish with `C-c C-c'.
894 When visiting a file containing a table with narrowed columns, the
895 necessary character hiding has not yet happened, and the table needs to
896 be aligned before it looks nice. Setting the option
897 `org-startup-align-all-tables' will realign all tables in a file upon
898 visiting, but also slow down startup. You can also set this option on
899 a per-file basis with:
904 ---------- Footnotes ----------
906 (1) This feature does not work on XEmacs.
909 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
911 3.3 Calculations in tables
912 ==========================
914 The table editor makes use of the Emacs `calc' package to implement
915 spreadsheet-like capabilities. Org-mode has two levels of complexity
916 for table calculations. On the basic level, tables do only horizontal
917 computations, so a field can be computed from other fields _in the same
918 row_, and Org-mode assumes that there is only one formula for each
919 column. This is very efficient to work with and enough for many tasks.
920 On the complex level, columns and individual fields can be named for
921 easier referencing in formulas, individual named fields can have their
922 own formula associated with them, and recalculation can be automated.
926 * Formula syntax:: How to write a formula
927 * Column formulas:: Formulas valid for all fields in a column
928 * Advanced features:: Field names, parameters and automatic recalc
929 * Named-field formulas:: Formulas valid in single fields
930 * Editing/debugging formulas:: Changing a stored formula
931 * Appetizer:: Taste the power of calc
934 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
939 A formula can be any algebraic expression understood by the Emacs
940 `calc' package. Note that `calc' has the slightly non-standard
941 convention that `/' has lower precedence than `*', so that `a/b*c' is
942 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
943 calc-eval: (calc)Calling Calc from Your Lisp Programs.), variable
944 substitution takes place:
946 $ refers to the current field
947 $3 refers to the field in column 3 of the current row
948 $3..$7 a vector of the fields in columns 3-7 of current row
949 $P1..$P3 vector of column range, using column names
950 &2 second data field above the current, in same column
951 &5-2 vector from fifth to second field above current
952 &III-II vector of fields between 2nd and 3rd hline above
953 &III vector of fields between third hline above and current field
954 $name a named field, parameter or constant
956 The range vectors can be directly fed into the calc vector functions
957 like `vmean' and `vsum'.
959 `$name' is interpreted as the name of a column, parameter or
960 constant. Constants are defined globally through the variable
961 `org-table-formula-constants'. If you have the `constants.el' package,
962 it will also be used to resolve constants, including natural constants
963 like `$h' for Planck's constant, and units like `$km' for kilometers.
964 Column names and parameters can be specified in special table lines.
965 These are described below, see *Note Advanced features::.
967 A formula can contain an optional mode string after a semicolon.
968 This string consists of flags to influence calc's modes(1) during
969 execution, e.g. `p20' to switch the internal precision to 20 digits,
970 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
971 or fixed display format, respectively, and `D', `R', `F', and `S' to
972 turn on degrees, radians, fraction and symbolic modes, respectively.
973 In addition, you may provide a `printf' format specifier to reformat
974 the final result. A few examples:
976 $1+$2 Sum of first and second field
977 $1+$2;%.2f Same, format result to two decimals
978 exp($2)+exp($1) Math functions can be used
979 $;%.1f Reformat current cell to 1 decimal
980 ($3-32)*5/9 Degrees F -> C conversion
981 $c/$1/$cm Hz -> cm conversion, using `constants.el'
982 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
983 sin($1);Dp3%.1e Same, but use printf specifier for display
984 vmean($2..$7) Compute column range mean, using vector function
985 vsum(&III) Sum numbers from 3rd hline above, up to here
986 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
988 ---------- Footnotes ----------
990 (1) By default, Org-mode uses the standard calc modes (precision 12,
991 angular units degrees, fraction and symbolic modes off). However, the
992 display format has been changed to `(float 5)' to keep tables compact.
993 The default settings can be configured using the variable
994 `org-calc-default-modes'.
997 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
999 3.3.2 Column formulas
1000 ---------------------
1002 To apply a formula to a field, type it directly into the field,
1003 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1004 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1005 be stored as the formula for the current column, evaluated and the
1006 current field replaced with the result. If the field contains only
1007 `=', the previously stored formula for this column is used.
1009 For each column, Org-mode will remember the most recently used
1010 formula. The information is stored in a special line starting with
1011 `#+TBLFM' directly below the table. When adding/deleting/moving
1012 columns with the appropriate commands, the stored equations will be
1013 modified accordingly. When a column used in a calculation is removed,
1014 references to this column become invalid and will cause an error upon
1015 applying the equation.
1017 Instead of typing an equation into the field, you may also use the
1018 command `C-c ='. It prompts for a formula (with default taken from the
1019 `#+TBLFM:' line) and applies it to the current field. A numerical
1020 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1021 in the current column.
1023 To recompute all the fields in a line, use the command `C-c *'. It
1024 re-applies all stored equations to the current row, from left to right.
1025 With a `C-u' prefix, this will be done to every line in the table, so
1026 use this command it you want to make sure the entire table is
1027 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1028 Global updating does not touch the line(s) above the first horizontal
1029 separator line, assuming that this is the table header.
1032 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1034 3.3.3 Advanced features
1035 -----------------------
1037 If you want the recalculation of fields to happen automatically, or if
1038 you want to be able to assign a formula to an individual field (instead
1039 of an entire column) you need to reserve the first column of the table
1040 for special marking characters. Here is an example of a table that
1041 collects exam results of students and makes use of these features:
1043 |---+---------+--------+--------+--------+-------+------|
1044 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1045 |---+---------+--------+--------+--------+-------+------|
1046 | ! | | P1 | P2 | P3 | Tot | |
1047 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1048 | ^ | | m1 | m2 | m3 | mt | |
1049 |---+---------+--------+--------+--------+-------+------|
1050 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1051 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1052 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1053 |---+---------+--------+--------+--------+-------+------|
1054 | | Average | | | | 29.7 | |
1055 | ^ | | | | | at | |
1056 | $ | max=50 | | | | | |
1057 |---+---------+--------+--------+--------+-------+------|
1058 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1060 Important: Please note that for these special tables, recalculating the
1061 table with `C-u C-c *' will only affect rows which are marked `#' or
1062 `*', and named fields. The column formulas are not applied in rows
1063 with empty first field.
1065 The marking characters have the following meaning:
1067 The fields in this line define names for the columns, so that you
1068 may refer to a column as `$Tot' instead of `$6'.
1071 This row defines names for the fields _above_ the row. With such
1072 a definition, any formula in the table may use `$m1' to refer to
1073 the value `10'. Also, named fields can have their own formula
1074 associated with them.
1077 Similar to `^', but defines names for the fields in the row
1081 Fields in this row can define _parameters_ for formulas. For
1082 example, if a field in a `$' row contains `max=50', then formulas
1083 in this table can refer to the value 50 using `$max'. Parameters
1084 work exactly like constants, only that they can be defined on a
1085 per-table basis. Changing a parameter and then recalculating the
1086 table can be useful.
1089 Fields in this row are automatically recalculated when pressing
1090 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1091 selected for a global recalculation with `C-u C-c *'. Unmarked
1092 lines will be left alone by this command.
1095 Selects this line for global recalculation with `C-u C-c *', but
1096 not for automatic recalculation. Use this when automatic
1097 recalculation slows down editing too much.
1100 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1101 All lines that should be recalculated should be marked with `#' or
1105 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1107 3.3.4 Named-field formulas
1108 --------------------------
1110 A named field can have its own formula associated with it. In the
1111 example above, this is used for the `at' field that contains the
1112 average result of the students. To enter a formula for a named field,
1113 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1114 This equation will be stored below the table like `$name=...'. Any
1115 recalculation in the table (even if only requested for the current
1116 line) will also update all named field formulas.
1119 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1121 3.3.5 Editing and debugging formulas
1122 ------------------------------------
1124 To edit a column or field formula, use the commands `C-c =' and `C-u
1125 C-c =', respectively. The currently active expression is then
1126 presented as default in the minibuffer, where it may be edited.
1128 Note that making a table field blank does not remove the formula
1129 associated with the field - during the next recalculation the field
1130 will be filled again. To remove a formula from a field, you have to
1131 give an empty reply when prompted for the formula, or to edit the
1134 You may edit the `#+TBLFM' directly and re-apply the changed
1135 equations with `C-c C-c' in that line, or with the normal recalculation
1136 commands in the table.
1138 In particular for large tables with many formulas, it is convenient
1139 to use the command `C-c '' to edit the formulas of the current table in
1140 a separate buffer. That buffer will show the formulas one per line,
1141 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1142 `$...' expression to get information about its interpretation.
1143 Exiting the buffer with `C-c C-c' only stores the modified formulas
1144 below the table. Exiting with `C-u C-c C-c' also applies them to the
1145 entire table. `C-c C-q' exits without installing the changes.
1147 When the evaluation of a formula leads to an error, the field content
1148 becomes the string `#ERROR'. If you would like see what is going on
1149 during variable substitution and calculation in order to find a bug,
1150 turn on formula debugging in the menu and repeat the calculation, for
1151 example by pressing `C-c = <RET>' in a field. Detailed information
1155 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1160 Finally, just to wet your appetite on what can be done with the
1161 fantastic `calc' package, here is a table that computes the Taylor
1162 series for a couple of functions (homework: try that with Excel :-)
1164 |---+-------------+---+-----+--------------------------------------|
1165 | | Func | n | x | Result |
1166 |---+-------------+---+-----+--------------------------------------|
1167 | # | exp(x) | 1 | x | 1 + x |
1168 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1169 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1170 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1171 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1172 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1173 |---+-------------+---+-----+--------------------------------------|
1174 #+TBLFM: $5=taylor($2,$4,$3);n3
1177 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1179 3.4 The Orgtbl minor mode
1180 =========================
1182 If you like the intuitive way the Org-mode table editor works, you
1183 might want to use it also in other modes like text-mode or mail-mode.
1184 The minor mode Orgtbl-mode makes this possible. You can always toggle
1185 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1188 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1191 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1193 3.5 The `table.el' package
1194 ==========================
1196 Complex ASCII tables with automatic line wrapping, column- and
1197 row-spanning, and alignment can be created using the Emacs table
1198 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1199 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1200 table, Org-mode will call `table-recognize-table' and move the cursor
1201 into the table. Inside a table, the keymap of Org-mode is inactive.
1202 In order to execute Org-mode-related commands, leave the table.
1205 Recognize `table.el' table. Works when the cursor is in a
1209 Insert a table.el table. If there is already a table at point,
1210 this command converts it between the table.el format and the
1211 Org-mode format. See the documentation string of the command
1212 `org-convert-table' for the restrictions under which this is
1216 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1221 Just like HMTL, Org-mode provides links inside a file, and external
1222 links to other files, Usenet articles, emails and much more.
1226 * Link format:: How links in Org-mode are formatted
1227 * Internal links:: Links to other places in the current file
1228 * External links:: URL-like links to the world
1229 * Managing links:: Creating, inserting and following
1230 * Search Options:: Linking to a specific location
1231 * Remember:: Org-trees store quick notes
1234 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1239 Org-mode will recognize plain URL-like links in the buffer and activate
1240 them as clickable links. However, the general linkformat looks like
1243 [[link][description]] or alternatively [[link]]
1245 The description part is optional. Once a link in the buffer is
1246 complete, Org-mode will change the display so that `description'( is
1247 displayed instead of `[[link][description]]' and `link' is displayed
1248 instead of `[[link]]'. Links will be highlighted in the face
1249 `org-link', which by default is an underlined face. You can directly
1250 edit the visible part of a link. To edit the invisible part, use `C-c
1251 C-l' with the cursor on the link. If you place the cursor at the
1252 beginning of end of the displayed text and press <BACKSPACE>, you will
1253 remove the (invisible) bracket at that location. This makes the link
1254 incomplete and the internals are again displayed as plain text.
1255 Inserting the missing bracket does hide the link internal again.
1256 Finally, you may also use the menu entry `Org->Hperlinks->Literal
1257 links' to unhide all links.
1260 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1265 If the link text does not look like a URL, links are considered to be
1266 internal in the current file. Links such as `[[My Target]]' or `[[My
1267 Target][Find my target]]' lead to a text search in the current file.
1268 The link can be followed with `C-c C-o' when the cursor is on the link,
1269 or with a mouse click (*note Managing links::). The preferred match
1270 for such a link is a dedicated target: The same string in double
1271 angular brackets. Targets may be located anywhere, often it is
1272 convenient to put them into a comment line, for example
1276 If no dedicated target exists, Org-mode will search for the words in
1277 the link, often removing the need for a dedicated target. In the above
1278 example the search would be for `my target'. Links starting with a
1279 star like `*My Target' restrict the search to headlines. When
1280 searching, Org-mode will first try an exact match, but then move on to
1281 more and more lenient searches. For example, the link `[[*My
1282 Targets]]' will find any of the following:
1285 ** TODO my targets are bright
1286 ** my 20 targets are
1288 To insert a link targeting a headline, in-buffer completion can be
1289 used. Just type a star followed by a few optional letters into the
1290 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1291 offered as completions. *Note Managing links::, for more commands
1294 Following a link pushes a mark onto Org-mode's own mark ring. You
1295 can return to the previous position with `C-c &'. Using this command
1296 several times in direct succession goes back to positions recorded
1301 * Radio targets:: Make targets trigger links in plain text.
1302 * CamelCase links:: Activating CamelCase words as links
1305 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1310 You can configure Org-mode to link any occurrences of certain target
1311 names in normal text. So without explicitly creating a link, the text
1312 connects to the target radioing its position. Radio targets are
1313 enclosed by triple angular brackets. For example, a target `<<<My
1314 Target>>>' causes each occurrence of `my target' in normal text to
1315 become activated as a link. The Org-mode file is scanned automatically
1316 for radio targets only when the file is first loaded into Emacs. To
1317 update the target list during editing, press `C-c C-c' with the cursor
1321 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1323 4.2.2 CamelCase words as links
1324 ------------------------------
1326 Org-mode also supports CamelCase words as links. This feature is not
1327 turned on by default because of the inconsistencies this system suffers
1328 from. It is mainly kept for backward compatibility, but the use is
1329 deprecated. To activate CamelCase words as links, and to make headline
1330 completion offer CamelCase version of headlines, the following
1331 customization is needed:
1333 (setq org-activate-camels t
1334 org-file-link-context-use-camel-case t)
1337 File: org, Node: External links, Next: Managing links, Prev: Internal links, Up: Hyperlinks
1342 Org-mode supports links to files, websites, Usenet and email messages;
1343 and BBDB database entries. External links are URL-like locators. The
1344 following list shows examples for each link type.
1346 http://www.astro.uva.nl/~dominik on the web
1347 file:/home/dominik/images/jupiter.jpg file, absolute path
1348 file:papers/last.pdf file, relative path
1349 news:comp.emacs Usenet link
1350 mailto:adent@galaxy.net Mail link
1351 vm:folder VM folder link
1352 vm:folder#id VM message link
1353 vm://myself@some.where.org/folder#id VM on remote machine
1354 wl:folder WANDERLUST folder link
1355 wl:folder#id WANDERLUST message link
1356 mhe:folder MH-E folder link
1357 mhe:folder#id MH-E message link
1358 rmail:folder RMAIL folder link
1359 rmail:folder#id RMAIL message link
1360 gnus:group GNUS group link
1361 gnus:group#id GNUS article link
1362 bbdb:Richard Stallman BBDB link
1363 shell:ls *.org(1) A shell command
1365 A link should be enclosed in double brackets and may contain a
1366 descriptive text to be displayed instead of the url (*note Link
1367 format::), for example:
1369 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1371 Org-mode also finds external links in the normal text and activates
1372 them as links. Plain text links cannot contain spaces. To remove
1373 ambiguities about the end of the link, enclose them in angular brackets.
1375 ---------- Footnotes ----------
1377 (1) Note that `<' and `>' cannot be part of a link, and therefore of
1378 a shell command. If you need redirection, use @{ and @} instead.
1381 File: org, Node: Managing links, Next: Search Options, Prev: External links, Up: Hyperlinks
1386 Org-mode provides methods to create a link in the correct syntax, to
1387 insert it into an org-mode file, and to follow the link.
1390 Store a link to the current location. This is a _global_ command
1391 which can be used in any buffer to create a link. The link will be
1392 stored for later insertion into an Org-mode buffer (see below).
1393 For VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will
1394 point to the current article/entry. For W3 and W3M buffers, the
1395 link goes to the current URL. For Org-mode files, the current
1396 headline is targeted. For any other files, the link will point to
1397 the file, with a search string (*note Search Options::) pointing
1398 to the contents of the current line. If there is an active
1399 region, the selected words will form the basis of the search
1400 string. The key binding `C-c l' is only a suggestion - see *Note
1401 Installation and activation::.
1404 Insert a link. This prompts for a link to be inserted into the
1405 buffer. You can just type a link, using text for an internal
1406 link, or one of the link type prefixes mentioned in the examples
1407 above. Through completion, all links stored during the current
1408 session can be accessed. The link will be formatted as given in
1409 the variable `org-link-format' and inserted into the buffer, along
1410 with a descriptive text. Note that you don't have to use this
1411 command to insert a link. Links in Org-mode are plain text, and
1412 you can type or paste them straight into the buffer. By using
1413 this command, the links are automatically enclosed in double
1414 brackets, and you will be asked for the optional descriptive text.
1417 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1418 file will be inserted and you may use file name completion to
1419 select the name of the file. The path to the file is inserted
1420 relative to the directory of the current org file, if the linked
1421 file is in the current directory or in a subdirectory of it.
1422 Otherwise an absolute path, if possible with `~/' for your home
1423 directory is used. You can force an absolute path with two `C-u'
1426 `C-c C-l with cursor on existing link'
1427 When the cursor is on an existing link, `C-c C-l' allows to edit
1428 the link and description parts of the link.
1431 Open link at point. This will launch a web browser for URLs (using
1432 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1433 the corresponding links, and execute the command in a shell link.
1434 When the cursor is on an internal link, this commands runs the
1435 corresponding search. When the cursor is on a TAGS list in a
1436 headline, it creates the corresponding TAGS view. If the cursor
1437 is on a time stamp, it compiles the agenda for that date.
1438 Furthermore, it will visit text files in `file:' links with Emacs
1439 and select a suitable application for non-text files.
1440 Classification of files is based on file extension only. See
1441 option `org-file-apps'. If you want to override the default
1442 application and visit the file with Emacs, use a `C-u' prefix.
1446 On links, `mouse-2' will open the link just like `C-c C-o' would.
1447 Under Emacs 22, also `mouse-1' will follow a link.
1450 Like `mouse-2', but force file links to be opened with Emacs.
1453 Push the current position onto the mark ring, to be able to return
1454 easily. Commands following an internal link do this automatically.
1457 Jump back to a recorded position. A position is recorded by the
1458 commands following internal links, and by `C-c %'. Using this
1459 command several times in direct succession moves through a ring of
1460 previously recorded positions.
1463 File: org, Node: Search Options, Next: Remember, Prev: Managing links, Up: Hyperlinks
1465 4.5 Search options in file links
1466 ================================
1468 File links can contain additional information to make Emacs jump to a
1469 particular location in the file when following a link. This can be a
1470 line number or a search option after a double(1) colon. For example:
1472 [[file:~/code/main.c::255]]
1473 [[file:~/xx.org::My Target]]
1474 [[file:~/xx.org::*My Target]]
1475 [[file:~/xx.org::/regexp/]]
1477 Here is what these options do.
1483 Search for a link target `<<My Target>>', or do a text search for
1484 `my target', similar to the search in internal links, see *Note
1488 In an Org-mode file, restrict search to headlines.
1491 Do a regular expression search for `regexp'. This uses the Emacs
1492 command `occur' to list all matches in a separate window. If the
1493 target file is in Org-mode, `org-occur' is used to create a sparse
1494 tree with the matches.
1496 As a degenerate case, a file link with an empty file name can be used
1497 to search the current file. For example, `<file:::find me>' does a
1498 search for `find me' in the current file, just like `[[find me]]' would.
1500 ---------- Footnotes ----------
1502 (1) For backward compatibility, line numbers can also follow a
1506 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1511 Another way to create org entries with links to other files is through
1512 the _Remember_ package by John Wiegley. _Remember_ lets you store
1513 quick notes with little interruption of your work flow. See
1514 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1515 information. The notes produced by _Remember_ can be stored in
1516 different ways, and Org-mode files are a good target. Org-mode allows
1517 to file away notes either to a default file, or directly to the correct
1518 location in your Org-mode outline tree. The following customization(1)
1519 will tell _Remember_ to use org files as target, and to create
1520 annotations compatible with Org-mode links.
1522 (autoload 'org-remember-annotation "org")
1523 (autoload 'org-remember-apply-template "org")
1524 (autoload 'org-remember-handler "org")
1525 (setq org-directory "~/path/to/my/orgfiles/")
1526 (setq org-default-notes-file "~/.notes")
1527 (setq remember-annotation-functions '(org-remember-annotation))
1528 (setq remember-handler-functions '(org-remember-handler))
1529 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1531 In combination with Org-mode, you can use templates to generate
1532 different types of remember notes. For example, if you would like to
1533 use one template to create general TODO entries, and another one for
1534 journal entries, you could use:
1536 (setq org-remember-templates
1537 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1538 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1540 In these entries, the character specifies how to select the template,
1541 the first string specifies the template, and the second string
1542 specifies a default file (overruling `org-default-notes-file') as a
1543 target for this note.
1545 When you call `M-x remember' to remember something, org will prompt
1546 for a key to select the template and then prepare the buffer like
1548 <file:link to where you called remember>
1552 * [2006-03-21 Tue 15:37]
1554 <file:link to where you called remember>
1556 See the variable `org-remember-templates' for more details.
1558 When you are finished composing a note with remember, you have to
1559 press `C-c C-c' to exit remember-mode and to file the note away. The
1560 handler first prompts for a target file - if you press <RET>, the value
1561 of `org-default-notes-file' is used. Then the command offers the
1562 headings tree of the selected file. You can either immediately press
1563 <RET> to get the note appended to the file. Or you can use vertical
1564 cursor motion (<up> and <down>) and visibility cycling (<TAB>) to find
1565 a better place. Pressing <RET> or <left> or <right> leads to the
1568 Cursor Key Note gets inserted
1570 buffer-start <RET> as level 2 heading at end of file
1571 on headline <RET> as sublevel of the heading at cursor
1572 <left> as same level, before current heading
1573 <right> as same level, after current heading
1574 not on <RET> at cursor position, level taken from context.
1575 headline Or use prefix arg to specify level
1578 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1579 append it to the default file. Even shorter would be `C-u C-c C-c',
1580 which does the same without even showing the tree. But with little
1581 extra effort, you can push it directly to the correct location.
1583 Before inserting the text into a tree, the function ensures that the
1584 text has a headline, i.e. a first line that starts with a `*'. If not,
1585 a headline is constructed from the current date and some additional
1586 data. If the variable `org-adapt-indentation' is non-nil, the entire
1587 text is also indented so that it starts in the same column as the
1588 headline (after the asterisks).
1590 ---------- Footnotes ----------
1592 (1) The three autoload forms are only necessary if `org.el' is not
1593 part of the Emacs distribution or an XEmacs package.
1596 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1601 Org-mode does not maintain TODO lists as a separate document. TODO
1602 items are an integral part of the notes file, because TODO items
1603 usually come up while taking notes! With Org-mode, you simply mark any
1604 entry in a tree as being a TODO item. In this way, the information is
1605 not duplicated, and the entire context from which the item emerged is
1606 always present when you check.
1608 Of course, this technique causes TODO items to be scattered
1609 throughout your file. Org-mode provides methods to give you an
1610 overview over all things you have to do.
1614 * TODO basics:: Marking and displaying TODO entries
1615 * Progress logging:: Document your productivity
1616 * TODO extensions:: Workflow and assignments
1617 * Priorities:: Some things are more important than others
1620 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1622 5.1 Basic TODO functionality
1623 ============================
1625 Any headline can become a TODO item by starting it with the word TODO,
1628 *** TODO Write letter to Sam Fortune
1630 The most important commands to work with TODO entries are:
1633 Rotate the TODO state of the current item between
1635 ,-> (unmarked) -> TODO -> DONE --.
1636 '--------------------------------'
1638 The same rotation can also be done "remotely" from the timeline and
1639 agenda buffers with the `t' command key (*note Agenda commands::).
1642 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1643 the entire buffer, but shows all TODO items and the headings
1644 hierarchy above them. With prefix arg, show also the DONE
1645 entries. With numerical prefix N, show the tree for the Nth
1646 keyword in the variable `org-todo-keywords'.
1649 Show the global TODO list. This collects the TODO items from all
1650 agenda files (*note Agenda Views::) into a single buffer. The
1651 buffer is in `agenda-mode', so there are commands to examine and
1652 manipulate the TODO entries directly from that buffer (*note
1653 Agenda commands::). *Note Global TODO list::, for more
1656 ``org-agenda-include-all-todo''
1657 If you would like to have all your TODO items listed as part of
1658 your agenda, customize the variable `org-agenda-include-all-todo'.
1661 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1663 5.2 Progress Logging
1664 ====================
1666 If you want to keep track of _when_ a certain TODO item was finished,
1667 turn on logging with
1669 (setq org-log-done t)
1671 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1672 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1673 [timestamp]' will be inserted just after the headline. If you turn the
1674 entry back into a TODO item again through further state cycling, that
1675 line will be removed again. In the timeline (*note Timeline::) and in
1676 the agenda (*note Weekly/Daily Agenda::), you can then use the `L' key
1677 to display the TODO items closed on each day, giving you an overview of
1678 what has been done on a day.
1681 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1683 5.3 Extended use of TODO keywords
1684 =================================
1686 The default implementation of TODO entries is just two states: TODO and
1687 DONE. You can, however, use the TODO feature for more complicated
1688 things by configuring the variables `org-todo-keywords' and
1689 `org-todo-interpretation'. Using special setup, you can even use TODO
1690 keywords in different ways in different org files.
1692 Note that tags are another way to classify headlines in general and
1693 TODO items in particular (*note Tags::).
1697 * Workflow states:: From TODO to DONE in steps
1698 * TODO types:: I do this, Fred the rest
1699 * Per file keywords:: Different files, different requirements
1702 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1704 5.3.1 TODO keywords as workflow states
1705 --------------------------------------
1707 You can use TODO keywords to indicate different states in the process
1708 of working on an item, for example:
1710 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1711 org-todo-interpretation 'sequence)
1713 Changing these variables becomes only effective in a new Emacs
1714 session. With this setup, the command `C-c C-t' will cycle an entry
1715 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1716 also use a prefix argument to quickly select a specific state. For
1717 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1718 you define many keywords, you can use in-buffer completion (see *Note
1719 Completion::) to insert these words into the buffer.
1722 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1724 5.3.2 TODO keywords as types
1725 ----------------------------
1727 The second possibility is to use TODO keywords to indicate different
1728 types of action items. For example, you might want to indicate that
1729 items are for "work" or "home". If you are into David Allen's _Getting
1730 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1731 `MAYBE'. Or, when you work with several people on a single project,
1732 you might want to assign action items directly to persons, by using
1733 their names as TODO keywords. This would be set up like this:
1735 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1736 org-todo-interpretation 'type)
1738 In this case, different keywords do not indicate a sequence, but
1739 rather different types. So it is normally not useful to change from
1740 one type to another. Therefore, in this case the behavior of the
1741 command `C-c C-t' is changed slightly(1). When used several times in
1742 succession, it will still cycle through all names. But when you return
1743 to the item after some time and execute `C-c C-t' again, it will switch
1744 from each name directly to DONE. Use prefix arguments or completion to
1745 quickly select a specific name. You can also review the items of a
1746 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1747 C-v'. For example, to see all things Lucy has to do, you would use
1748 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1749 single buffer, you would use the prefix arg as well when creating the
1750 global todo list: `C-3 C-c t'.
1752 ---------- Footnotes ----------
1754 (1) This is also true for the `t' command in the timeline and agenda
1758 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1760 5.3.3 Setting up TODO keywords for individual files
1761 ---------------------------------------------------
1763 It can be very useful to use different aspects of the TODO mechanism in
1764 different files, which is not possible with the global settings
1765 described above. For file-local settings, you need to add special
1766 lines to the file which set the keywords and interpretation for that
1767 file only. For example, to set one of the two examples discussed
1768 above, you need one of the following lines, starting in column zero
1769 anywhere in the file:
1771 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1772 #+TYP_TODO: Fred Sara Lucy Mike DONE
1774 To make sure you are using the correct keyword, type `#+' into the
1775 buffer and then use `M-<TAB>' completion.
1777 Remember that the last keyword must always mean that the item is DONE
1778 (you may use a different word, though). Also note that in each file,
1779 only one of the two aspects of TODO keywords can be used. After
1780 changing one of these lines, use `C-c C-c' with the cursor still in the
1781 line to make the changes known to Org-mode(1).
1783 If you want to use very many keywords, for example when working with
1784 a large group of people, you may split the names over several lines:
1786 #+TYP_TODO: Fred Sara Lucy Mike
1787 #+TYP_TODO: Luis George Jules Jessica
1788 #+TYP_TODO: Kim Arnold Peter
1791 ---------- Footnotes ----------
1793 (1) Org-mode parses these lines only when Org-mode is activated
1794 after visiting a file. `C-c C-c' with the cursor in a line starting
1795 with `#+' is simply restarting Org-mode, making sure that these changes
1799 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1804 If you use Org-mode extensively to organize your work, you may end up
1805 with a number of TODO entries so large that you'd like to prioritize
1806 them. This can be done by placing a _priority cookie_ into the
1809 *** TODO [#A] Write letter to Sam Fortune
1811 With its standard setup, Org-mode supports priorities `A', `B', and
1812 `C'. `A' is the highest priority. An entry without a cookie is
1813 treated as priority `B'. Priorities make a difference only in the
1814 agenda (*note Weekly/Daily Agenda::).
1817 Set the priority of the current item. The command prompts for a
1818 priority character `A', `B' or `C'. When you press <SPC> instead,
1819 the priority cookie is removed from the headline. The priorities
1820 can also be changed "remotely" from the timeline and agenda buffer
1821 with the `,' command (*note Agenda commands::).
1825 Increase/decrease priority of current item. Note that these keys
1826 are also used to modify time stamps (*note Creating timestamps::).
1827 Furthermore, these keys are also used by CUA-mode (*note
1831 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1836 Items can be labeled with timestamps to make them useful for project
1841 * Time stamps:: Assigning a time to a tree entry
1842 * Creating timestamps:: Commands which insert timestamps
1845 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1847 6.1 Time stamps, deadlines and scheduling
1848 =========================================
1850 A time stamp is a specification of a date (possibly with time) in a
1851 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1852 A time stamp can appear anywhere in the headline or body of an org-tree
1853 entry. Its presence allows entries to be shown on specific dates in
1854 the agenda (*note Weekly/Daily Agenda::). We distinguish:
1857 A simple time stamp just assigns a date/time to an item. In the
1858 timeline and agenda displays, the headline of the entry will be
1859 shown exactly on that date.
1862 Two time stamps connected by `--' denote a time range. The
1863 headline will be shown on the first and last day of the range, and
1864 on any dates that are displayed and fall in the range. Here is an
1867 ** Meeting in Amsterdam
1868 <2004-08-23 Mon>--<2004-08-26 Thu>
1871 If a time stamp is preceded by the word `DEADLINE:', the task
1872 (most likely a TODO item) is supposed to be finished on that date,
1873 and it will be listed then. In addition, the compilation for
1874 _today_ will carry a warning about the approaching or missed
1875 deadline, starting `org-deadline-warning-days' before the due
1876 date, and continuing until the entry is marked DONE. An example:
1878 *** TODO write article about the Earth for the Guide
1879 The editor in charge is <bbdb:Ford Prefect>
1880 DEADLINE: <2004-02-29 Sun>
1883 If a time stamp is preceded by the word `SCHEDULED:', it means you
1884 are planning to start working on that task on the given date. The
1885 headline will be listed under the given date. In addition, a
1886 reminder that the scheduled date has passed will be present in the
1887 compilation for _today_, until the entry is marked DONE. I.e., the
1888 task will automatically be forwarded.
1891 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1893 6.2 Creating timestamps
1894 =======================
1896 For Org-mode to recognize time stamps, they need to be in the specific
1897 format. All commands listed below produce time stamps in the correct
1901 Prompt for a date and insert a corresponding time stamp. When the
1902 cursor is at a previously used time stamp, it is updated to NOW.
1903 When this command is used twice in succession, a time range is
1907 Like `C-c .', but use the alternative format which contains date
1908 and time. The default time can be rounded to multiples of 5
1909 minutes, see the option `org-time-stamp-rounding-minutes'.
1912 Like `C-c .', but insert an inactive time stamp not triggering the
1916 Insert a time stamp corresponding to the cursor date in the
1920 Access the Emacs calendar for the current date. If there is a
1921 timestamp in the current line, goto the corresponding date instead.
1924 Access the agenda for the date given by the time stamp at point
1925 (*note Weekly/Daily Agenda::).
1928 Insert `DEADLINE' keyword along with a stamp.
1931 Create a sparse tree with all deadlines that are either past-due,
1932 or which will become due within `org-deadline-warning-days'. With
1933 `C-u' prefix, show all deadlines in the file. With a numeric
1934 prefix, check that many days. For example, `C-1 C-c C-w' shows
1935 all deadlines due tomorrow.
1938 Insert `SCHEDULED' keyword along with a stamp.
1942 Change date at cursor by one day. These key bindings conflict with
1943 CUA-mode (*note Interaction::).
1947 Change the item under the cursor in a timestamp. The cursor can
1948 be on a year, month, day, hour or minute. Note that if the cursor
1949 is not at a time stamp, these same keys modify the priority of an
1950 item. (*note Priorities::). The key bindings also conflict with
1951 CUA-mode (*note Interaction::).
1954 Evaluate a time range by computing the difference between start and
1955 end. With prefix arg, insert result after the time range (in a
1956 table: into the following column).
1958 When Org-mode prompts for a date/time, the function reading your
1959 input will replace anything you choose not to specify with the current
1960 date and time. For details, see the documentation string of
1961 `org-read-date'. Also, a calender will pop up to allow selecting a
1962 date. The calendar can be fully controlled from the minibuffer, and a
1963 date can be selected with the following commands:
1966 Scroll calendar backwards by one month.
1969 Scroll calendar forwards by one month.
1972 Select date by clicking on it.
1993 Choose date in calendar (only if nothing typed into minibuffer).
1996 File: org, Node: Tags, Next: Agenda Views, Prev: Timestamps, Up: Top
2001 If you wish to implement a system to cross-correlate information, an
2002 excellent way is to assign tags to headline. Org-mode has extensive
2003 support for using tags.
2005 Every headline can contain a list of tags, at the end of the
2006 headline. Tags are normal words containing letters, numbers, `_', and
2007 `@'. Tags must be preceded and followed by a single colon; like
2008 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2012 * Tag inheritance:: Tags use the tree structure of the outline
2013 * Setting tags:: How to assign tags to a headline
2014 * Tag searches:: Searching for combinations of tags
2017 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2022 Tags make use of the hierarchical structure of outline trees. If a
2023 heading has a certain tag, all subheadings will inherit the tag as
2024 well. For example, in the list
2026 * Meeting with the French group :WORK:
2027 ** Summary by Frank :BOSS:NOTES:
2028 *** TODO Prepare slides for him :ACTION:
2030 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2031 `:ACTION:'. When executing tag searches and Org-mode finds that a
2032 certain headline matches the search criterion, it will not check any
2033 sublevel headline, assuming that these likely also match, and that the
2034 list of matches can become very long. However, this may not be what
2035 you want, and you can influence inheritance and searching using the
2036 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2039 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2044 As Org-mode deals with plain text files, tags can simply be typed into
2045 the buffer. After a colon, `M-<TAB>' offers completion on all tags
2046 being used in the current buffer. There is also a special command for
2050 Enter new tags for the current headline. The minibuffer will
2051 prompt for a list of tags and offer completion with respect to all
2052 other tags used in the current buffer. Several tags, separated by
2053 colons, may be specified at the prompt. After pressing <RET>, the
2054 tags will be inserted and aligned to `org-tags-column'. When
2055 called with a `C-u' prefix, all tags in the current buffer will be
2056 aligned to that column, just to make things look nice. TAGS are
2057 automatically realigned after promotion, demotion, and TODO state
2058 changes (*note TODO basics::).
2061 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2066 Once a tags system has been set up, it can be used to collect related
2067 information into special lists.
2070 Create a sparse tree with all headlines matching a tags search.
2073 Create a global list of tag matches from all agenda files. *Note
2074 Matching headline tags::.
2077 Create a global list of tag matches from all agenda files, but
2078 check only TODO items and force checking subitems (see variable
2079 `org-tags-match-list-sublevels').
2081 A tags search string can use Boolean operators `&' for AND and `|'
2082 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2083 not implemented. A tag may also be preceded by `-', to select against
2084 it, and `+' is syntactic sugar for positive selection. The AND
2085 operator `&' is optional when `+' or `-' is present. For example,
2086 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2087 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2088 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2089 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2093 File: org, Node: Agenda Views, Next: Exporting, Prev: Tags, Up: Top
2098 Due to the way Org-mode works, TODO items, time-stamped items, and
2099 tagged headlines can be scattered throughout a file or even a number of
2100 files. To get an overview over open action items, or over events that
2101 are important for a particular date, this information must be collected,
2102 sorted and displayed in an organized way.
2104 Org-mode can select items based on various criteria, and display them
2105 in a separate buffer. Three different views are provided:
2107 * an _agenda_ that is like a calendar and shows information for
2110 * a _TODO list_ that covers all unfinished action items, and
2112 * a _tags view_ that shows information based on the tags associated
2113 with headlines in the outline tree.
2115 The extracted information is displayed in a special _agenda buffer_.
2116 This buffer is read-only, but provides commands to visit the
2117 corresponding locations in the original Org-mode files, and even to
2118 edit these files remotely.
2122 * Agenda files:: Files being searched for agenda information
2123 * Agenda dispatcher:: Keyboard access to agenda views
2124 * Weekly/Daily Agenda:: The calendar page with current tasks
2125 * Global TODO list:: All unfinished action items
2126 * Matching headline tags:: Structured information with fine-tuned search
2127 * Timeline:: Time-sorted view for single file
2128 * Agenda commands:: Remote editing of org trees
2131 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda Views, Up: Agenda Views
2136 The information to be shown is collected from all _agenda files_, the
2137 files listed in the variable `org-agenda-files'(1). Thus even if you
2138 only work with a single Org-mode file, this file should be put into
2139 that list(2). You can customize `org-agenda-files', but the easiest
2140 way to maintain it is through the following commands
2143 Add current file to the list of agenda files. The file is added to
2144 the front of the list. If it was already in the list, it is moved
2145 to the front. With prefix arg, file is added/moved to the end.
2148 Remove current file from the list of agenda files.
2151 Cycle through agenda file list, visiting one file after the other.
2153 The Org menu contains the current list of files and can be used to
2156 ---------- Footnotes ----------
2158 (1) If the value of that variable is not a list, but a single file
2159 name, then the list of agenda files will be maintained in that external
2162 (2) When using the dispatcher pressing `1' before selecting a
2163 command will actually limit the command to the current file, and ignore
2164 `org-agenda-files' until the next dispatcher command.
2167 File: org, Node: Agenda dispatcher, Next: Weekly/Daily Agenda, Prev: Agenda files, Up: Agenda Views
2169 8.2 The agenda dispatcher
2170 =========================
2172 The views are created through a dispatcher that should be bound to a
2173 global key, for example `C-c a' (*note Installation and activation::).
2174 In the following we will assume that `C-c a' is indeed how the
2175 dispatcher is accessed and list keyboard access to commands
2176 accordingly. After pressing `C-c a', an additional letter is required
2177 to execute a command. The dispatcher offers the following default
2180 Create the calendar-like agenda (*note Weekly/Daily Agenda::).
2183 Create a list of all TODO items (*note Global TODO list::).
2186 Create a list of headlines matching a TAGS expression (*note
2187 Matching headline tags::).
2189 You can also define custom commands that will be accessible through
2190 the dispatcher, just like the default commands. Custom commands are
2191 global searches for tags and specific TODO keywords, or a variety of
2192 sparse tree creating commands (*note Sparse trees::). As sparse trees
2193 are only defined for a single org-mode file, these latter commands act
2194 on the current buffer instead of the list of agenda files.
2196 Custom commands are configured in the variable
2197 `org-agenda-custom-commands'. You can customize this variable, for
2198 example by pressing `C-c a C'. You can also directly set it with Emacs
2199 Lisp in `.emacs'. For example:
2201 (setq org-agenda-custom-commands
2202 '(("w" todo "WAITING")
2203 ("u" tags "+BOSS-URGENT")
2204 ("U" tags-tree "+BOSS-URGENT")
2205 ("f" occur-tree "\\<FIXME\\>")))
2207 will define `C-c a w' as a global search for TODO entries with
2208 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2209 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2210 search but only in the current buffer and display the result as a
2211 sparse tree, and `C-c a f' to create a sparse tree with all entries
2212 containing the word `FIXME'. For more information, look at the
2213 documentation string of the variable `org-agenda-custom-commands'.
2216 File: org, Node: Weekly/Daily Agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda Views
2218 8.3 The weekly/daily agenda
2219 ===========================
2221 The purpose of the weekly/daily _agenda_ is to act like a page of a
2222 paper agenda, showing all the tasks for the current week or day.
2225 Compile an agenda for the current week from a list of org files.
2226 The agenda shows the entries for each day. With a `C-u' prefix (or
2227 when the variable `org-agenda-include-all-todo' is `t'), all
2228 unfinished TODO items (including those without a date) are also
2229 listed at the beginning of the buffer, before the first date.
2231 Remote editing from the agenda buffer means, for example, that you
2232 can change the dates of deadlines and appointments from the agenda
2233 buffer. The commands available in the Agenda buffer are listed in
2234 *Note Agenda commands::.
2238 * Categories:: Not all tasks are equal
2239 * Time-of-day specifications:: How the agenda knows the time
2240 * Calendar/Diary integration:: Integrating Anniversaries and more
2241 * Sorting of agenda items:: The order of things
2244 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily Agenda, Up: Weekly/Daily Agenda
2249 In the agenda buffer, each entry is preceded by a _category_, which is
2250 derived from the file name. The category can also be set with a
2251 special line anywhere in the buffer, looking like this:
2255 If there are several such lines in a file, each specifies the
2256 category for the text below it (but the first category also applies to
2257 any text before the first CATEGORY line). The display in the agenda
2258 buffer looks best if the category is not longer than 10 characters.
2261 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily Agenda
2263 8.3.2 Time-of-Day Specifications
2264 --------------------------------
2266 Org-mode checks each agenda item for a time-of-day specification. The
2267 time can be part of the time stamp that triggered inclusion into the
2268 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2269 specified with two time stamps, like
2270 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2272 In the headline of the entry itself, a time(range) may also appear as
2273 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2274 Emacs diary (*note Calendar/Diary integration::), time specifications
2275 in diary entries are recognized as well.
2277 For agenda display, Org-mode extracts the time and displays it in a
2278 standard 24 hour format as part of the prefix. The example times in
2279 the previous paragraphs would end up in the agenda like this:
2281 8:30-13:00 Arthur Dent lies in front of the bulldozer
2282 12:45...... Ford Prefect arrives and takes Arthur to the pub
2283 19:00...... The Vogon reads his poem
2284 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2286 If the agenda is in single-day mode, or for the display of today, the
2287 timed entries are embedded in a time grid, like
2289 8:00...... ------------------
2290 8:30-13:00 Arthur Dent lies in front of the bulldozer
2291 10:00...... ------------------
2292 12:00...... ------------------
2293 12:45...... Ford Prefect arrives and takes Arthur to the pub
2294 14:00...... ------------------
2295 16:00...... ------------------
2296 18:00...... ------------------
2297 19:00...... The Vogon reads his poem
2298 20:00...... ------------------
2299 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2301 The time grid can be turned on and off with the variable
2302 `org-agenda-use-time-grid', and can be configured with
2303 `org-agenda-time-grid'.
2306 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily Agenda
2308 8.3.3 Calendar/Diary integration
2309 --------------------------------
2311 Emacs contains the calendar and diary by Edward M. Reingold. The
2312 calendar displays a three-month calendar with holidays from different
2313 countries and cultures. The diary allows you to keep track of
2314 anniversaries, lunar phases, sunrise/set, recurrent appointments
2315 (weekly, monthly) and more. In this way, it is quite complementary to
2316 Org-mode. It can be very useful to combine output from Org-mode with
2319 In order to include entries from the Emacs diary into Org-mode's
2320 agenda, you only need to customize the variable
2322 (setq org-agenda-include-diary t)
2324 After that, everything will happen automatically. All diary entries
2325 including holidays, anniversaries etc will be included in the agenda
2326 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2327 the agenda buffer to jump to the diary file in order to edit existing
2328 diary entries. The `i' command to insert new entries for the current
2329 date works in the agenda buffer, as well as the commands `S', `M', and
2330 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2331 to other calendars, respectively. `c' can be used to switch back and
2332 forth between calendar and agenda.
2335 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily Agenda
2337 8.3.4 Sorting of agenda items
2338 -----------------------------
2340 The entries for each day are sorted. The default order is to first
2341 collect all items containing an explicit time-of-day specification.
2342 These entries will be shown at the beginning of the list, as a
2343 _schedule_ for the day. After that, items remain grouped in
2344 categories, in the sequence given by `org-agenda-files'. Within each
2345 category, items are sorted by priority (*note Priorities::).
2347 The priority is a numerical quantity composed of the base priority
2348 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2349 increments for overdue scheduled or deadline items.
2351 Sorting can be customized using the variable
2352 `org-agenda-sorting-strategy'.
2355 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily Agenda, Up: Agenda Views
2357 8.4 The global TODO list
2358 ========================
2360 The global TODO list contains all unfinished TODO items, formatted and
2361 collected into a single place.
2364 Show the global TODO list. This collects the TODO items from all
2365 agenda files (*note Agenda Views::) into a single buffer. The
2366 buffer is in `agenda-mode', so there are commands to examine and
2367 manipulate the TODO entries directly from that buffer (*note
2368 Agenda commands::). *Note Global TODO list::, for more
2372 Like the above, but allows selection of a specific TODO keyword.
2373 You can also do this by specifying a prefix argument to `C-c a t'.
2374 With a `C-u' prefix you are prompted for a keyword. With a
2375 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2376 `r' key in the agenda buffer regenerates it, and you can give a
2377 prefix argument to this command to change the selected TODO
2378 keyword, for example `3 r'. If you often need a search for a
2379 specific keyword, define a custom command for it (*note Agenda
2382 Remote editing of TODO items means that you can change the state of a
2383 TODO entry with a single key press. The commands available in the TODO
2384 list are described in *Note Agenda commands::.
2387 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda Views
2389 8.5 Matching headline tags
2390 ==========================
2392 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2393 you can select headlines based on the tags that apply to them and
2394 collect them into an agenda buffer.
2397 Produce a list of all headlines that match a given set of tags.
2398 The command prompts for a selection criterion, which is a boolean
2399 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2400 `WORK|HOME' (*note Tags::). If you often need a specific search,
2401 define a custom command for it (*note Agenda dispatcher::).
2404 Like `C-c a m', but only select headlines that are also TODO items
2405 and force checking subitems (see variable
2406 `org-tags-match-list-sublevels'.
2408 The commands available in the tags list are described in *Note
2412 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda Views
2414 8.6 Timeline for a single file
2415 ==============================
2417 The timeline is not really an agenda view, because it only summarizes
2418 items from a single Org-mode file. But it also uses the agenda buffer
2419 and provides similar commands, so we discuss it here. The timeline
2420 shows all time-stamped items in a single Org-mode file (or the selected
2421 part of it), in a _time-sorted view_. The main purpose of this command
2422 is to give an overview over events in a project.
2425 Show a time-sorted view of the org file, with all time-stamped
2426 items. When called with a `C-u' prefix, all unfinished TODO
2427 entries (scheduled or not) are also listed under the current date.
2429 The commands available in the timeline buffer are listed in *Note
2433 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda Views
2435 8.7 Commands in the agenda buffer
2436 =================================
2438 Entries in the agenda buffer are linked back to the org file or diary
2439 file where they originate. You are not allowed to edit the agenda
2440 buffer itself, but commands are provided to show and jump to the
2441 original entry location, and to edit the org-files "remotely" from the
2442 agenda buffer. In this way, all information is stored only once,
2443 removing the risk that your agenda and note files may diverge.
2445 Some commands can be executed with mouse clicks on agenda lines. For
2446 the other commands, the cursor needs to be in the desired line.
2452 Next line (same as <up>).
2455 Previous line (same as <down>).
2462 Display the original location of the item in another window.
2465 Display original location and recenter that window.
2470 Go to the original location of the item in another window. Under
2471 Emacs 22, `mouse-1' will also works for this.
2474 Go to the original location of the item and delete other windows.
2477 Toggle Follow mode. In Follow mode, as you move the cursor through
2478 the agenda buffer, the other window always shows the corresponding
2479 location in the org file.
2482 Toggle Logbook mode. In Logbook mode, entries that where marked
2483 DONE while logging was on (variable `org-log-done') are shown in
2490 Delete other windows.
2493 Switch to weekly view (7 days displayed together).
2496 Switch to daily view (just one day displayed).
2499 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2503 Toggle the time grid on and off. See also the variables
2504 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2507 Recreate the agenda buffer, for example to reflect the changes
2508 after modification of the time stamps of items with S-<left> and
2509 S-<right>. When the buffer is the global todo list, a prefix
2510 argument is interpreted to create a selective list for a specific
2514 Display the following `org-agenda-ndays' days. For example, if
2515 the display covers a week, switch to the following week. With
2516 prefix arg, go forward that many times `org-agenda-ndays' days.
2519 Display the previous dates.
2531 Change the TODO state of the item, both in the agenda and in the
2535 Show all tags assiciated with the current item. Because of
2536 inheritance, this may be more than the tags listed in the line
2540 Set tags for the current headline.
2543 Set the priority for the current item. Org-mode prompts for the
2544 priority character. If you reply with <SPC>, the priority cookie
2545 is removed from the entry.
2548 Display weighted priority of current item.
2552 Increase the priority of the current item. The priority is
2553 changed in the original buffer, but the agenda is not resorted.
2554 Use the `r' key for this.
2558 Decrease the priority of the current item.
2561 Change the time stamp associated with the current line by one day
2562 into the future. With prefix argument, change it by that many
2563 days. For example, `3 6 5 S-<right>' will change it by a year.
2564 The stamp is changed in the original org file, but the change is
2565 not directly reflected in the agenda buffer. Use the `r' key to
2569 Change the time stamp associated with the current line by one day
2573 Change the time stamp associated with the current line to today.
2574 The key `>' has been chosen, because it is the same as `S-.' on my
2578 Insert a new entry into the diary. Prompts for the type of entry
2579 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2580 new entry in the diary, just like `i d' etc. would do in the
2581 calendar. The date is taken from the cursor position.
2587 Open the Emacs calendar and move to the date at the agenda cursor.
2590 When in the calendar, compute and show the Org-mode agenda for the
2594 Show the phases of the moon for the three month around current
2598 Show sunrise and sunset times. The geographical location must be
2599 set with calendar variables, see documentation of the Emacs
2603 Convert the date at cursor into many other cultural and historic
2607 Show holidays for three month around the cursor date.
2610 Export a single iCalendar file containing entries from all agenda
2617 Quit agenda, remove the agenda buffer.
2620 Exit agenda, remove the agenda buffer and all buffers loaded by
2621 Emacs for the compilation of the agenda. Buffers created by the
2622 user to visit org files will not be removed.
2626 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda Views, Up: Top
2631 For printing and sharing of notes, Org-mode documents can be exported
2632 as ASCII or HTML files. To incorporate entries with associated times
2633 like deadlines or appointments into a desktop calendar program like
2634 iCal, Org-mode can also produce extracts in the iCalendar format.
2638 * ASCII export:: Export as a structured ASCII file
2639 * HTML export:: Export as an HTML file
2640 * iCalendar export:: Create calendar entries.
2643 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2649 Export as ASCII file. If there is an active region, only the
2650 region will be exported. For an org file `myfile.org', the ASCII
2651 file will be `myfile.txt'. The file will be overwritten without
2654 In the exported version, the first 3 outline levels will become
2655 headlines, defining a general document structure. Additional levels
2656 will be exported as itemized lists. If you want that transition to
2657 occur at a different level, specify it with a prefix argument. For
2660 C-1 C-c C-x a org-export-as-ascii
2662 creates only top level headlines and does the rest as items. Lines
2663 starting with `#' and subtrees starting with the word `COMMENT' will
2667 File: org, Node: HTML export, Next: iCalendar export, Prev: ASCII export, Up: Exporting
2672 Org-mode contains an HTML exporter with extensive HTML formatting, in
2673 ways similar to John Grubers _markdown_ language, but with additional
2677 Export as HTML file `myfile.html'.
2680 Export as HTML file and open it with a browser.
2683 Insert template with export options, see below.
2686 Toggle fixed-width for entry (QUOTE) or region, see below.
2688 In the exported version, the first 3 outline levels will become
2689 headlines, defining a general document structure. Additional levels
2690 will be exported as itemized lists. If you want that transition to
2691 occur at a different level, specify it with a prefix argument. For
2696 creates two levels of headings and does the rest as items.
2700 * HTML formatting:: Interpretation of the buffer content
2701 * Export options:: How to influence exports
2702 * Comment lines:: Lines which will not be exported
2705 File: org, Node: HTML formatting, Next: Export options, Prev: HTML export, Up: HTML export
2707 9.2.1 HTML formatting
2708 ---------------------
2710 Not all text is transferred literally to the exported HTML file. The
2711 exporter implements the following interpretation:
2713 * Hand-formatted lists with `-', `*' or `+' as bullet, or with `1.'
2714 or `2)' as enumerator will be recognized and transformed into HTML
2715 lists. See *Note Plain Lists::.
2717 * You can make words *bold*, /italic/, and _underlined_
2719 * Simple TeX-like math constructs are interpreted:
2721 - `10^22' and `J_n' are super- and subscripts. You can quote
2722 `^' and `_' with a backslash: `\_' and `\^'
2724 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2725 use completion for these macros, just type `\' and maybe a few
2726 letters, and press `M-<TAB>' to see possible completions.
2728 * Tables are transformed into HTML tables. Data fields before the
2729 first horizontal separator line will be formatted as table header
2732 * If a headline starts with the word `QUOTE', the text below the
2733 headline will be typeset as fixed-width, to allow quoting of
2734 computer codes etc. Lines starting with `:' are also typeset in
2737 * If you want to include HTML tags which should be interpreted as
2738 such, mark them with a `@' like in `@<b>bold text@</b>'. Plain
2739 `<' and `>' are always transformed to `<' and `>' in HTML
2742 If these conversions conflict with your habits of typing ASCII text,
2743 they can all be turned off with corresponding variables.
2746 File: org, Node: Export options, Next: Comment lines, Prev: HTML formatting, Up: HTML export
2748 9.2.2 Export options
2749 --------------------
2751 The exporter recognizes special lines in the buffer which provide
2752 additional information. These lines may be put anywhere in the file.
2753 The whole set of lines can be inserted into the buffer with `C-c C-x
2754 t'. For individual lines, a good way to make sure the keyword is
2755 correct is to type `#+' and then use `M-<TAB>' completion (*note
2758 #+TITLE: the title to be shown (default is the buffer name)
2759 #+AUTHOR: the author (default taken from `user-full-name')
2760 #+EMAIL: his/her email address (default from `user-mail-address')
2761 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2762 #+TEXT: Some descriptive text to be inserted at the beginning.
2763 #+TEXT: Several lines may be given.
2764 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2766 The OPTIONS line is a compact form to specify export settings. Here
2768 H: set the number of headline levels for export
2769 num: turn on/off section-numbers
2770 toc: turn on/off table of contents
2771 \n: turn on/off linebreak-preservation
2772 @: turn on/off quoted html tags
2773 :: turn on/off fixed-width sections
2774 |: turn on/off tables
2775 ^: turn on/off TeX-like syntax for sub- and superscripts.
2776 *: turn on/off emphasized text (bold, italic, underlined)
2777 TeX: turn on/off TeX macros
2779 You can also give style information for the exported file. The
2780 default specification can be configured through the option
2781 `org-export-html-style'. If you want to use a file-local style, you
2782 may use file variables, best wrapped into a COMMENT section at the end
2783 of the outline tree. For example:
2785 * COMMENT HTML style specifications
2788 # org-export-html-style: " <style type=\"text/css\">
2789 p {font-weight: normal; color: gray; }
2794 Remember to execute `M-x normal-mode' after changing this to make
2795 the new style visible to Emacs.
2798 File: org, Node: Comment lines, Prev: Export options, Up: HTML export
2803 Lines starting with `#' in column zero are treated as comments and will
2804 never be exported. Also entire subtrees starting with the word
2805 `COMMENT' will never be exported. Finally, any text before the first
2806 headline will not be exported either. This applies also for ASCII
2810 Toggle the COMMENT keyword at the beginning of an entry.
2813 File: org, Node: iCalendar export, Prev: HTML export, Up: Exporting
2815 9.3 iCalendar export
2816 ====================
2818 Some people like to use Org-mode for keeping track of projects, but
2819 still prefer a standard calendar application for anniversaries and
2820 appointments. In this case it can be useful to have deadlines and
2821 other time-stamped items in Org-mode files show up in the calendar
2822 application. Org-mode can export calendar information in the standard
2826 Create iCalendar entries for the current file and store them in
2827 the same directory, using a file extension `.ics'.
2830 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2831 For each of these files, a separate iCalendar file will be
2835 Create a single large iCalendar file from all files in
2836 `org-agenda-files' and write it to the file given by
2837 `org-combined-agenda-icalendar-file'.
2839 How this calendar is best read and updated, depends on the
2840 application you are using. For example, when using iCal under Apple
2841 MacOS X, you could create a new calendar `OrgMode' (the default name
2842 for the calendar created by `C-c C-x c', see the variables
2843 `org-icalendar-combined-name' and
2844 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2845 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2846 use AppleScript to make iCal re-read the calendar files each time a new
2847 version of `OrgMode.ics' is produced. Here is the setup needed for
2850 (setq org-combined-agenda-icalendar-file
2851 "~/Library/Calendars/OrgMode.ics")
2852 (add-hook 'org-after-save-iCalendar-file-hook
2855 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2858 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2865 * Completion:: M-TAB knows what you need
2866 * Customization:: Adapting Org-mode to your taste
2867 * Clean view:: Getting rid of leading stars in the outline
2868 * TTY keys:: Using Org-mode on a tty
2869 * FAQ:: Frequently asked questions
2870 * Interaction:: Other Emacs packages
2871 * Bugs:: Things which do not work perfectly
2872 * Acknowledgments:: These people provided feedback and more
2875 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2880 Org-mode supports in-buffer completion. This type of completion does
2881 not make use of the minibuffer. You simply type a few letters into the
2882 buffer and use the key to complete text right there.
2885 Complete word at point
2886 * At the beginning of a headline, complete TODO keywords.
2888 * After `\', complete TeX symbols supported by the exporter.
2890 * After `*', complete CamelCase versions of all headlines in the
2893 * After `:', complete tags used elsewhere in the buffer.
2895 * After `#+', complete the special keywords like `TYP_TODO' or
2896 `OPTIONS' which set file-specific options for Org-mode. When
2897 the option keyword is already complete, pressing `M-<TAB>'
2898 again will insert example settings for this keyword.
2900 * Elsewhere, complete dictionary words using ispell.
2903 File: org, Node: Customization, Next: Clean view, Prev: Completion, Up: Miscellaneous
2908 There are more than 100 variables that can be used to customize
2909 Org-mode. For the sake of compactness of the manual, we are not
2910 describing the variables here. A structured overview of customization
2911 variables is available with `M-x org-customize'. Or select `Browse Org
2912 Group' from the `Org->Customization' menu.
2915 File: org, Node: Clean view, Next: TTY keys, Prev: Customization, Up: Miscellaneous
2917 10.3 A cleaner outline view
2918 ===========================
2920 Some people find it noisy and distracting that the Org-mode headlines
2921 are starting with a potentially large number of stars. For example the
2922 tree from *Note Headlines:::
2924 * Top level headline
2930 * Another top level headline
2932 Unfortunately this is deeply ingrained into the code of Org-mode and
2933 cannot be easily changed. You can, however, modify the display in such
2934 a way that all leading stars become invisible and the outline more easy
2935 to read. To do this, customize the variable `org-hide-leading-stars'
2938 (setq org-hide-leading-stars t)
2940 or change this on a per-file basis with one of the lines (anywhere in
2943 #+STARTUP: showstars
2944 #+STARTUP: hidestars
2946 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
2949 With stars hidden, the tree becomes:
2951 * Top level headline
2957 * Another top level headline
2959 Note that the leading stars are not truly replaced by whitespace, they
2960 are only fontified with the face `org-hide' that uses the background
2961 color as font color. If are are not using either white or black
2962 background, you may have to customize this face to get the wanted
2963 effect. Another possibility is to set this font such that the extra
2964 stars are almost invisible, for example using the color `grey90' on a
2967 Things become cleaner still if you skip all the even levels and use
2968 only odd levels 1, 3, 5..., effectively adding two stars to go from one
2969 outline level to the next:
2971 * Top level headline
2977 * Another top level headline
2979 In order to make the structure editing and export commands handle this
2980 convention correctly, use
2982 (setq org-odd-levels-only t)
2984 or set this on a per-file basis with one of the following lines (don't
2985 forget to press `C-c C-c' with the cursor in the startup line to
2986 activate changes immediately).
2991 You can convert an Org-mode file from single-star-per-level to the
2992 double-star-per-level convention with `M-x org-convert-to-odd-levels
2993 RET' in that file. There is no command for the back conversion because
2994 such a command might merge levels and in this way destroy the structure
2998 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
3000 10.4 Using org-mode on a tty
3001 ============================
3003 Org-mode uses a number of keys that are not accessible on a tty. This
3004 applies to most special keys like cursor keys, <TAB> and <RET>, when
3005 these are combined with modifier keys like <Meta> and/or <Shift>.
3006 Org-mode uses these bindings because it needs to provide keys for a
3007 large number of commands, and because these keys appeared particularly
3008 easy to remember. In order to still be able to access the core
3009 functionality of Org-mode on a tty, alternative bindings are provided.
3010 Here is a complete list of these bindings, which are obviously more
3011 cumbersome to use. Note that sometimes a work-around can be better.
3012 For example changing a time stamp is really only fun with `S-<cursor>'
3013 keys. On a tty you would rather use `C-c .' to re-insert the
3016 Default Alternative 1 Alternative 2
3017 `S-<TAB>' `C-u <TAB>'
3018 `M-<left>' `C-c C-x l' `<Esc> <left>'
3019 `M-S-<left>'`C-c C-x L'
3020 `M-<right>' `C-c C-x r' `<Esc>
3022 `M-S-<right>'`C-c C-x R'
3023 `M-<up>' `C-c C-x u' `<Esc> <up>'
3024 `M-S-<up>' `C-c C-x U'
3025 `M-<down>' `C-c C-x d' `<Esc> <down>'
3026 `M-S-<down>'`C-c C-x D'
3027 `S-<RET>' `C-c C-x c'
3028 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3029 `M-S-<RET>' `C-c C-x M'
3032 `S-<right>' `C-c C-x
3040 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3042 10.5 Frequently asked questions
3043 ===============================
3045 1. Org-mode seems to be a useful default mode for the various
3046 `README' files I have scattered through my directories. How do I
3047 turn it on for all `README' files?
3048 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3050 2. Some of my links stopped working after I upgraded to a version
3051 4.20 or later. Why is this, and how can I fix it?
3052 The newer versions of Org-mode have a better link system and no
3053 longer allow unescaped space characters as part of a link. To fix
3054 these links, and also to move all `<link>' style links to the new
3055 `[[link]]' system, execute once in each Org-mode file: `M-x
3056 org-upgrade-old-links'.
3058 3. I really like the old style links with angular brackets better.
3059 Please give them back to me, don't tell me it is not possible!
3060 Would I let you down like that? If you must (even if I don't
3061 understand why), you can do this
3062 (setq org-allow-space-in-plain-links t
3063 org-link-style 'plain
3064 org-link-format "<%s>")
3066 4. All these stars are driving me mad, I just find the Emacs outlines
3067 unreadable. Can't you just put white space and a single star as a
3068 starter for headlines?
3069 See *Note Clean view::.
3071 5. I would like to have two windows on the same Org-mode file, but
3072 with different outline visibility. Is that possible?
3073 In GNU Emacs, you may use _indirect buffers_ which do exactly
3074 this. See the documentation on the command
3075 `make-indirect-buffer'. In XEmacs, this is currently not possible
3076 because of the different outline implementation.
3078 6. When I export my TODO list, every TODO item becomes a separate
3079 section. How do I enforce these items to be exported as an
3081 If you plan to use ASCII or HTML export, make sure things you want
3082 to be exported as item lists are level 4 at least, even if that
3083 does mean there is a level jump. For example:
3085 * Todays top priorities
3086 **** TODO write a letter to xyz
3087 **** TODO Finish the paper
3088 **** Pick up kids at the school
3090 Alternatively, if you need a specific value for the heading/item
3091 transition in a particular file, use the `+OPTIONS' line to
3092 configure the `H' switch.
3096 7. I would like to export only a subtree of my file to HTML. How?
3097 If you want to export a subtree, mark the subtree as region and
3098 then export. Marking can be done with `C-c @ C-x C-x', for
3101 8. Org-mode takes over the S-cursor keys. I also want to use
3102 CUA-mode, is there a way to fix this conflict?
3103 Yes, see *Note Interaction::.
3105 9. Is there an easy way to insert an empty table template with a
3106 default number of rows and columns?
3107 To insert an empty table template, just type `|-' and use <TAB>.
3108 The default size can be changed with the variable
3109 `org-table-default-size'. However, just starting to type the
3110 first line is usually much easier.
3112 10. One of my table columns has started to fill up with `#ERROR'.
3114 Org-mode tried to compute the column from other fields using a
3115 formula stored in the `#+TBLFMT:' line just below the table, and
3116 the evaluation of the formula fails. Fix the fields used in the
3117 formula, or fix the formula, or remove it!
3119 11. When I am in the last column of a table and just above a
3120 horizontal line in the table, pressing TAB creates a new table line
3121 before the horizontal line. How can I quickly move to the line
3122 below the horizontal line instead?
3123 Press <down> (to get on the separator line) and then <TAB>. Or
3124 configure the variable `org-table-tab-jumps-over-hlines'.
3126 12. How can I change the indentation of an entire table without fixing
3128 The indentation of a table is set by the first line. So just fix
3129 the indentation of the first line and realign with <TAB>.
3131 13. Is it possible to include entries from org-mode files into my
3133 Since the org-mode agenda is much more powerful and can contain the
3134 diary (*note Calendar/Diary integration::), you should think twice
3135 before deciding to do this. Integrating Org-mode information into
3136 the diary is, however, possible. The following steps are
3137 necessary: Autoload the function `org-diary' as shown above under
3138 *Note Installation and activation::. You also need to use _fancy
3139 diary display_ by setting in `.emacs':
3141 (add-hook 'diary-display-hook 'fancy-diary-display)
3143 Then include the following line into your `~/diary' file, in order
3144 to get the entries from all files listed in the variable
3148 You may also select specific files with
3150 &%%(org-diary) ~/path/to/some/org-file.org
3151 &%%(org-diary) ~/path/to/another/org-file.org
3153 If you now launch the calendar and press `d' to display a diary,
3154 the headlines of entries containing a timestamp, date range,
3155 schedule, or deadline referring to the selected date will be
3156 listed. Just like in Org-mode's agenda view, the diary for
3157 _today_ contains additional entries for overdue deadlines and
3158 scheduled items. See also the documentation of the `org-diary'
3163 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3165 10.6 Interaction with other packages
3166 ====================================
3168 Org-mode can cooperate with the following packages:
3170 `org-mouse.el' by Piotr Zielinski
3171 This package implements extended mouse functionality for Org-mode.
3172 It allows you to cycle visibility and to edit the document
3173 structure with the mouse. It also provides a context-sensitive
3174 menu that changes depending on the context of a mouse-click. Use
3175 a search engine to find this package on the web.
3177 `table.el' by Takaaki Ota
3178 Org mode cooperates with table.el, see *Note table.el::.
3179 `table.el' is part of Emacs 22.
3181 `calc.el' by Dave Gillespie
3182 Org-mode uses the calc package for implementing spreadsheet
3183 functionality in its tables (*note Table calculations::).
3184 Org-modes checks for the availability of calc by looking for the
3185 function `calc-eval' which should be autoloaded in your setup if
3186 calc has been installed properly. As of Emacs 22, calc is part of
3187 the Emacs distribution. Another possibility for interaction
3188 between the two packages is using calc for embedded calculations.
3189 *Note Embedded Mode: (calc)Embedded Mode.
3191 `constants.el' by Carsten Dominik
3192 In a table formula (*note Table calculations::), it is possible to
3193 use names for natural constants or units. Instead of defining
3194 your own constants in the variable `org-table-formula-constants',
3195 install the `constants' package which defines a large number of
3196 constants and units, and lets you use unit prefixes like `M' for
3197 `Mega' etc. You will need version 2.0 of this package, available
3198 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3199 the function `constants-get', which has to be autoloaded in your
3200 setup. See the installation instructions in the file
3203 `CUA.el' by Kim. F. Storm
3204 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3205 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3206 select and extend the region. If you want to use one of these
3207 packages along with Org-mode, configure the variable
3208 `org-CUA-compatible'. When set, Org-mode will move the following
3209 keybindings in org-mode files, and in the agenda buffer (but not
3210 during date selection).
3212 S-UP -> M-p S-DOWN -> M-n
3213 S-LEFT -> M-- S-RIGHT -> M-+
3216 Yes, these are unfortunately more difficult to remember. If you
3217 want to have other replacement keys, look at the variable
3218 `org-disputed-keys'.
3220 `remember.el' by John Wiegley
3221 Org mode cooperates with remember, see *Note Remember::.
3222 `Remember.el' is not part of Emacs, find it on the web.
3225 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3230 Here is a list of things that should work differently, but which I have
3231 found too hard to fix.
3233 * If a table field starts with a link, and if the corresponding table
3234 column is narrowed (*note Narrow columns::) to a width too small to
3235 display the link, the field would look entirely empty even though
3236 it is not. To prevent this, Org-mode throws an error. The
3237 work-around is to make the column wide enough to fit the link, or
3238 to add some text (at least 2 characters) before the link in the
3241 * Narrowing table columns does not work on XEmacs, because the
3242 `format' function does not transport text properties.
3244 * Text in an entry protected with the `QUOTE' keyword should not
3247 * When the application called by `C-c C-o' to open a file link fails
3248 (for example because the application does not exits or refuses to
3249 open the file), it does so silently. No error message is
3252 * Plain list items should be able to hold a TODO item.
3253 Unfortunately this has so many technical problems that I will only
3254 consider this change for the next major release (5.0).
3256 * The remote-editing commands in the agenda buffer cannot be undone
3257 with `undo' called from within the agenda buffer. But you can go
3258 to the corresponding buffer (using <TAB> or <RET> and execute
3261 * Recalculating a table line applies the formulas from left to right.
3262 If a formula uses _calculated_ fields further down the row,
3263 multiple recalculation may be needed to get all fields consistent.
3265 * Under XEmacs, if Org-mode entries are included into the diary, it
3266 is not possible to jump back from the diary to the org file.
3267 Apparently, the text properties are lost when the
3268 fancy-diary-display is used. However, from Org-mode's timeline
3269 and agenda buffers (created with `C-c C-r' and `C-c a'), things do
3272 * You can only make a single word boldface or italic. To emphasize
3273 several words in a row, each must have the emphasize markers, like
3274 in `*three* *bold* *words*'.
3276 * The exporters work well, but could be made more efficient.
3279 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3281 10.8 Acknowledgments
3282 ====================
3284 Org-mode was written by Carsten Dominik, who still maintains it at the
3285 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3286 following people (in alphabetic order) have helped the development
3287 along with ideas, suggestions and patches. Many thanks to all of you,
3288 Org-mode would not be what it is without your input.
3290 * Thomas Baumann contributed the code for links to the MH-E email
3293 * Alex Bochannek provided a patch for rounding time stamps.
3295 * Charles Caves' suggestion sparked the implementation of templates
3298 * Pavel Chalmoviansky influenced the agenda treatment of items with
3301 * Sacha Chua suggested to copy some linking code from Planner.
3303 * Christian Egli converted the documentation into TeXInfo format,
3304 patched CSS formatting into the HTML exporter, and inspired the
3307 * Nic Ferrier contributed mailcap and XML support.
3309 * Kai Grossjohann pointed out key-binding conflicts caused by
3312 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3315 * Tim O'Callaghan suggested in-file links, search options for
3316 general file links, and TAGS.
3318 * Oliver Oppitz suggested multi-state TODO items.
3320 * Scott Otterson sparked the introduction of descriptive text for
3321 links, among other things.
3323 * Pete Phillips helped the development of the TAGS feature.
3325 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3328 * Kevin Rogers contributed code to access VM files on remote hosts.
3330 * Philip Rooke created the Org-mode reference card and provided lots
3333 * Christian Schlauer proposed angular brackets around links, among
3336 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3337 `organizer-mode.el'.
3339 * Ju"rgen Vollmer contributed code generating the table of contents
3342 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3344 * David Wainberg suggested archiving, and improvements to the linking
3347 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
3348 development of Org-mode was fully independent, and both systems are
3349 really different beasts in their basic ideas and implementation
3350 details. However, I have later looked at John's code and learned
3351 from his implementation of (i) links where the link itself is
3352 hidden and only a description is shown, and (ii) popping up a
3353 calendar to select a date.
3355 * Carsten Wimmer suggested some changes and helped fix a bug in
3358 * Roland Winkler requested additional keybindings to make Org-mode
3361 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3365 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3373 * acknowledgments: Acknowledgments. (line 6)
3374 * active region <1>: HTML export. (line 10)
3375 * active region <2>: ASCII export. (line 6)
3376 * active region <3>: Built-in table editor.
3378 * active region: Structure editing. (line 46)
3379 * agenda: Weekly/Daily Agenda. (line 6)
3380 * agenda commands, custom: Agenda dispatcher. (line 6)
3381 * agenda dispatcher: Agenda dispatcher. (line 6)
3382 * agenda files, removing buffers: Agenda commands. (line 187)
3383 * agenda views: Agenda Views. (line 6)
3384 * agenda, for single file: Timeline. (line 6)
3385 * angular brackets, around links: External links. (line 35)
3386 * applescript, for calendar update: iCalendar export. (line 38)
3387 * archive locations: Archiving. (line 13)
3388 * archiving: Archiving. (line 6)
3389 * ASCII export: ASCII export. (line 6)
3390 * author: Feedback. (line 6)
3391 * autoload: Installation and activation.
3393 * BBDB links: External links. (line 6)
3394 * bold text: HTML formatting. (line 13)
3395 * bug reports: Feedback. (line 6)
3396 * bugs: Bugs. (line 6)
3397 * calc package: Table calculations. (line 6)
3398 * calc.el: Interaction. (line 17)
3399 * calculations, in tables <1>: Table calculations. (line 6)
3400 * calculations, in tables: Built-in table editor.
3402 * calendar integration: Calendar/Diary integration.
3404 * calendar, for selecting date: Creating timestamps. (line 68)
3405 * CamelCase link completion: Completion. (line 6)
3406 * CamelCase links: Internal links. (line 6)
3407 * CamelCase links, completion of: CamelCase links. (line 6)
3408 * category: Categories. (line 6)
3409 * children, subtree visibility state: Visibility cycling. (line 10)
3410 * clean outline view: Clean view. (line 6)
3411 * column formula: Column formulas. (line 6)
3412 * commands, in agenda buffer: Agenda commands. (line 6)
3413 * comment lines: Comment lines. (line 6)
3414 * completion, of CamelCase links <1>: Completion. (line 6)
3415 * completion, of CamelCase links: CamelCase links. (line 6)
3416 * completion, of dictionary words: Completion. (line 6)
3417 * completion, of file names: Managing links. (line 36)
3418 * completion, of links: Managing links. (line 23)
3419 * completion, of option keywords <1>: Completion. (line 6)
3420 * completion, of option keywords: Export options. (line 6)
3421 * Completion, of option keywords: Per file keywords. (line 17)
3422 * completion, of tags <1>: Completion. (line 6)
3423 * completion, of tags: Setting tags. (line 12)
3424 * completion, of TeX symbols <1>: Completion. (line 6)
3425 * completion, of TeX symbols: HTML formatting. (line 17)
3426 * completion, of TODO keywords <1>: Completion. (line 6)
3427 * completion, of TODO keywords: Workflow states. (line 12)
3428 * constants, in calculations: Formula syntax. (line 26)
3429 * constants.el: Interaction. (line 27)
3430 * contents, global visibility state: Visibility cycling. (line 19)
3431 * copying, of subtrees: Structure editing. (line 6)
3432 * creating timestamps: Creating timestamps. (line 6)
3433 * CUA.el: Interaction. (line 39)
3434 * custom agenda commands: Agenda dispatcher. (line 6)
3435 * customization: Customization. (line 6)
3436 * cutting, of subtrees: Structure editing. (line 6)
3437 * cycling, of TODO states: TODO basics. (line 13)
3438 * cycling, visibility: Visibility cycling. (line 6)
3439 * date stamps: Time stamps. (line 6)
3440 * date, reading in minibuffer: Creating timestamps. (line 68)
3441 * DEADLINE keyword: Time stamps. (line 27)
3442 * deadlines: Time stamps. (line 6)
3443 * demotion, of subtrees: Structure editing. (line 6)
3444 * diary entries, creating from agenda: Agenda commands. (line 145)
3445 * diary integration: Calendar/Diary integration.
3447 * dictionary word completion: Completion. (line 6)
3448 * dispatching agenda commands: Agenda dispatcher. (line 6)
3449 * document structure: Document Structure. (line 6)
3450 * DONE, final TODO keyword: Per file keywords. (line 20)
3451 * editing tables: Tables. (line 6)
3452 * editing, of table formulas: Editing/debugging formulas.
3454 * emphasized text: Export options. (line 22)
3455 * evaluate time range: Creating timestamps. (line 63)
3456 * exporting: Exporting. (line 6)
3457 * exporting a subtree: FAQ. (line 58)
3458 * exporting, not: Comment lines. (line 6)
3459 * extended TODO keywords: TODO extensions. (line 6)
3460 * external links: External links. (line 6)
3461 * FAQ: FAQ. (line 6)
3462 * feedback: Feedback. (line 6)
3463 * file links: External links. (line 6)
3464 * file links, searching: Search Options. (line 6)
3465 * file name completion: Managing links. (line 36)
3466 * files, adding to agenda list: Agenda files. (line 12)
3467 * filing subtrees: Archiving. (line 6)
3468 * fixed width: HTML formatting. (line 28)
3469 * fixed-width sections: Export options. (line 22)
3470 * folded, subtree visibility state: Visibility cycling. (line 10)
3471 * folding, sparse trees: Sparse trees. (line 6)
3472 * following links: Managing links. (line 50)
3473 * format specifier: Formula syntax. (line 34)
3474 * format, of links: Link format. (line 6)
3475 * formula editing: Editing/debugging formulas.
3477 * formula syntax: Formula syntax. (line 6)
3478 * formula, for named table field: Named-field formulas.
3480 * formula, for table column: Column formulas. (line 6)
3481 * formula, in tables: Built-in table editor.
3483 * global keybindings: Installation and activation.
3485 * global TODO list: Global TODO list. (line 6)
3486 * global visibility states: Visibility cycling. (line 19)
3487 * GNUS links: External links. (line 6)
3488 * hand-formatted lists: HTML formatting. (line 9)
3489 * headline levels: Export options. (line 22)
3490 * headline levels, for exporting <1>: HTML export. (line 22)
3491 * headline levels, for exporting: ASCII export. (line 12)
3492 * headline navigation: Motion. (line 6)
3493 * headline tagging: Tags. (line 6)
3494 * headline, promotion and demotion: Structure editing. (line 6)
3495 * headlines: Headlines. (line 6)
3496 * hide text: Visibility cycling. (line 6)
3497 * hiding leading stars: Clean view. (line 6)
3498 * HTML export: HTML export. (line 6)
3499 * HTML tags: HTML formatting. (line 33)
3500 * hyperlinks: Hyperlinks. (line 6)
3501 * iCalendar export: iCalendar export. (line 6)
3502 * indentation, of tables: FAQ. (line 89)
3503 * indirect buffers: FAQ. (line 34)
3504 * inheritance, of tags: Tag inheritance. (line 6)
3505 * inserting links: Managing links. (line 23)
3506 * installation: Installation and activation.
3508 * internal links: Internal links. (line 6)
3509 * introduction: Introduction. (line 6)
3510 * italic text: HTML formatting. (line 13)
3511 * jumping, to headlines: Motion. (line 6)
3512 * keybindings, global: Installation and activation.
3514 * keyword options: Per file keywords. (line 6)
3515 * linebreak preservation: Export options. (line 22)
3516 * link completion: Managing links. (line 23)
3517 * link format: Link format. (line 6)
3518 * links, external: External links. (line 6)
3519 * links, internal: Internal links. (line 6)
3520 * links, returning to: Managing links. (line 76)
3521 * lists, hand-formatted: HTML formatting. (line 9)
3522 * lists, ordered: Plain Lists. (line 6)
3523 * lists, plain: Plain Lists. (line 6)
3524 * logging, of progress: Progress logging. (line 6)
3525 * maintainer: Feedback. (line 6)
3526 * make-indirect-buffer: FAQ. (line 34)
3527 * mark ring: Managing links. (line 72)
3528 * marking characters, tables: Advanced features. (line 34)
3529 * matching, of tags: Matching headline tags.
3531 * matching, tags: Tags. (line 6)
3532 * MH-E links: External links. (line 6)
3533 * minor mode for tables: orgtbl-mode. (line 6)
3534 * mode, for calc: Formula syntax. (line 34)
3535 * motion, between headlines: Motion. (line 6)
3536 * name, of column or field: Formula syntax. (line 26)
3537 * named field formula: Named-field formulas.
3539 * names as TODO keywords: TODO types. (line 6)
3540 * narrow columns in tables: Narrow columns. (line 6)
3541 * occur, command: Sparse trees. (line 6)
3542 * option keyword completion: Completion. (line 6)
3543 * options, for customization: Customization. (line 6)
3544 * options, for export: Export options. (line 6)
3545 * ordered lists: Plain Lists. (line 6)
3546 * org-agenda, command: Weekly/Daily Agenda. (line 9)
3547 * org-mode, turning on: Installation and activation.
3549 * org-mouse.el: Interaction. (line 8)
3550 * orgtbl-mode: orgtbl-mode. (line 6)
3551 * outline tree: Headlines. (line 6)
3552 * outline-mode: Outlines. (line 6)
3553 * outlines: Outlines. (line 6)
3554 * overview, global visibility state: Visibility cycling. (line 19)
3555 * packages, interaction with other: Interaction. (line 6)
3556 * pasting, of subtrees: Structure editing. (line 6)
3557 * per file keywords: Per file keywords. (line 6)
3558 * plain lists: Plain Lists. (line 6)
3559 * plain text external links: External links. (line 35)
3560 * printing sparse trees: Sparse trees. (line 39)
3561 * priorities: Priorities. (line 6)
3562 * priorities, of agenda items: Sorting of agenda items.
3564 * progress logging: Progress logging. (line 6)
3565 * promotion, of subtrees: Structure editing. (line 6)
3566 * quoted html tags: Export options. (line 22)
3567 * ranges, time: Time stamps. (line 6)
3568 * recomputing table fields: Column formulas. (line 27)
3569 * region, active <1>: HTML export. (line 10)
3570 * region, active <2>: ASCII export. (line 6)
3571 * region, active <3>: Built-in table editor.
3573 * region, active: Structure editing. (line 46)
3574 * remember.el <1>: Interaction. (line 39)
3575 * remember.el: Remember. (line 6)
3576 * RMAIL links: External links. (line 6)
3577 * SCHEDULED keyword: Time stamps. (line 39)
3578 * scheduling: Time stamps. (line 6)
3579 * search option in file links: Search Options. (line 6)
3580 * section-numbers: Export options. (line 22)
3581 * setting tags: Setting tags. (line 6)
3582 * SHELL links: External links. (line 6)
3583 * show all, command: Visibility cycling. (line 27)
3584 * show all, global visibility state: Visibility cycling. (line 19)
3585 * show hidden text: Visibility cycling. (line 6)
3586 * single file summary: Timeline. (line 6)
3587 * sorting, of agenda items: Sorting of agenda items.
3589 * sparse tree, for deadlines: Creating timestamps. (line 38)
3590 * sparse tree, for TODO: TODO basics. (line 20)
3591 * sparse tree, tag based: Tags. (line 6)
3592 * sparse trees: Sparse trees. (line 6)
3593 * spreadsheet capabilities: Table calculations. (line 6)
3594 * storing links: Managing links. (line 9)
3595 * structure editing: Structure editing. (line 6)
3596 * structure of document: Document Structure. (line 6)
3597 * subtree visibility states: Visibility cycling. (line 10)
3598 * subtree, cut and paste: Structure editing. (line 6)
3599 * subtree, subtree visibility state: Visibility cycling. (line 10)
3600 * subtrees, cut and paste: Structure editing. (line 6)
3601 * summary: Summary. (line 6)
3602 * syntax, of formulas: Formula syntax. (line 6)
3603 * table editor, builtin: Built-in table editor.
3605 * table editor, table.el: table.el. (line 6)
3606 * table of contents: Export options. (line 22)
3607 * table, empty template: FAQ. (line 68)
3608 * table.el <1>: Interaction. (line 13)
3609 * table.el: table.el. (line 6)
3610 * tables <1>: Export options. (line 22)
3611 * tables: Tables. (line 6)
3612 * tables, export to HTML: HTML formatting. (line 24)
3613 * tag completion: Completion. (line 6)
3614 * tag searches: Tag searches. (line 6)
3615 * tags: Tags. (line 6)
3616 * tags view: Matching headline tags.
3618 * templates, for remember: Remember. (line 26)
3619 * TeX interpretation: HTML formatting. (line 15)
3620 * TeX macros: Export options. (line 22)
3621 * TeX symbol completion: Completion. (line 6)
3622 * TeX-like syntax for sub- and superscripts: Export options. (line 22)
3623 * thanks: Acknowledgments. (line 6)
3624 * time stamps: Time stamps. (line 6)
3625 * time, reading in minibuffer: Creating timestamps. (line 68)
3626 * time-sorted view: Timeline. (line 6)
3627 * timeline, single file: Timeline. (line 6)
3628 * timerange: Time stamps. (line 18)
3629 * timestamp: Time stamps. (line 12)
3630 * timestamps, creating: Creating timestamps. (line 6)
3631 * TODO items: TODO items. (line 6)
3632 * TODO keywords completion: Completion. (line 6)
3633 * TODO list, global: Global TODO list. (line 6)
3634 * TODO types: TODO types. (line 6)
3635 * TODO workflow: Workflow states. (line 6)
3636 * transient-mark-mode <1>: HTML export. (line 10)
3637 * transient-mark-mode <2>: ASCII export. (line 6)
3638 * transient-mark-mode <3>: Built-in table editor.
3640 * transient-mark-mode: Structure editing. (line 46)
3641 * trees, sparse: Sparse trees. (line 6)
3642 * trees, visibility: Visibility cycling. (line 6)
3643 * tty keybindings: TTY keys. (line 6)
3644 * types as TODO keywords: TODO types. (line 6)
3645 * underlined text: HTML formatting. (line 13)
3646 * URL links: External links. (line 6)
3647 * USENET links: External links. (line 6)
3648 * variables, for customization: Customization. (line 6)
3649 * vectors, in table calculations: Formula syntax. (line 23)
3650 * visibility cycling: Visibility cycling. (line 6)
3651 * visible text, printing: Sparse trees. (line 39)
3652 * VM links: External links. (line 6)
3653 * WANDERLUST links: External links. (line 6)
3654 * workflow states as TODO keywords: Workflow states. (line 6)
3657 File: org, Node: Key Index, Prev: Index, Up: Top
3665 * +: Agenda commands. (line 118)
3666 * ,: Agenda commands. (line 110)
3667 * -: Agenda commands. (line 124)
3668 * .: Agenda commands. (line 89)
3669 * :: Agenda commands. (line 107)
3670 * <: Creating timestamps. (line 75)
3671 * <left>: Agenda commands. (line 86)
3672 * <RET> <1>: Agenda commands. (line 41)
3673 * <RET> <2>: Creating timestamps. (line 100)
3674 * <RET>: Built-in table editor.
3676 * <right>: Agenda commands. (line 81)
3677 * <SPC>: Agenda commands. (line 28)
3678 * <TAB> <1>: Agenda commands. (line 35)
3679 * <TAB> <2>: Built-in table editor.
3681 * <TAB> <3>: Plain Lists. (line 37)
3682 * <TAB>: Visibility cycling. (line 10)
3683 * > <1>: Agenda commands. (line 140)
3684 * >: Creating timestamps. (line 76)
3685 * C: Agenda commands. (line 170)
3686 * c: Agenda commands. (line 154)
3687 * C-#: Built-in table editor.
3689 * C-,: Agenda files. (line 18)
3690 * C-c !: Creating timestamps. (line 21)
3691 * C-c $: Archiving. (line 9)
3692 * C-c %: Managing links. (line 72)
3693 * C-c &: Managing links. (line 76)
3694 * C-c ' <1>: Editing/debugging formulas.
3696 * C-c ': Built-in table editor.
3698 * C-c *: Built-in table editor.
3700 * C-c +: Built-in table editor.
3702 * C-c ,: Priorities. (line 18)
3703 * C-c -: Built-in table editor.
3705 * C-c .: Creating timestamps. (line 10)
3706 * C-c /: Sparse trees. (line 15)
3707 * C-c :: HTML export. (line 17)
3708 * C-c ;: Comment lines. (line 12)
3709 * C-c <: Creating timestamps. (line 25)
3710 * C-c <TAB>: Built-in table editor.
3712 * C-c =: Built-in table editor.
3714 * C-c >: Creating timestamps. (line 29)
3715 * C-c ? <1>: Editing/debugging formulas.
3717 * C-c ?: Built-in table editor.
3719 * C-c [: Agenda files. (line 12)
3720 * C-c \: Tag searches. (line 9)
3721 * C-c ]: Agenda files. (line 15)
3722 * C-c ^: Built-in table editor.
3724 * C-c `: Built-in table editor.
3726 * C-c a a: Weekly/Daily Agenda. (line 9)
3727 * C-c a C: Agenda dispatcher. (line 30)
3728 * C-c a M: Matching headline tags.
3730 * C-c a m: Matching headline tags.
3732 * C-c a M: Tag searches. (line 14)
3733 * C-c a m: Tag searches. (line 10)
3734 * C-c a T: Global TODO list. (line 15)
3735 * C-c a t <1>: Global TODO list. (line 9)
3736 * C-c a t: TODO basics. (line 27)
3737 * C-c C-a: Visibility cycling. (line 27)
3738 * C-c C-b: Motion. (line 15)
3739 * C-c C-c <1>: Setting tags. (line 11)
3740 * C-c C-c <2>: table.el. (line 6)
3741 * C-c C-c <3>: Editing/debugging formulas.
3743 * C-c C-c <4>: Built-in table editor.
3745 * C-c C-c: Plain Lists. (line 61)
3746 * C-c C-d: Creating timestamps. (line 37)
3747 * C-c C-f: Motion. (line 12)
3748 * C-c C-j: Motion. (line 21)
3749 * C-c C-l: Managing links. (line 23)
3750 * C-c C-n: Motion. (line 8)
3751 * C-c C-o <1>: Creating timestamps. (line 33)
3752 * C-c C-o: Managing links. (line 50)
3753 * C-c C-p: Motion. (line 9)
3754 * C-c C-q <1>: Editing/debugging formulas.
3756 * C-c C-q: Built-in table editor.
3758 * C-c C-r: Timeline. (line 13)
3759 * C-c C-s: Creating timestamps. (line 47)
3760 * C-c C-t: TODO basics. (line 13)
3761 * C-c C-u: Motion. (line 18)
3762 * C-c C-v: TODO basics. (line 20)
3763 * C-c C-w: Creating timestamps. (line 38)
3764 * C-c C-x a: ASCII export. (line 6)
3765 * C-c C-x b: HTML export. (line 11)
3766 * C-c C-x c: iCalendar export. (line 20)
3767 * C-c C-x C-c: Agenda commands. (line 177)
3768 * C-c C-x C-i: iCalendar export. (line 15)
3769 * C-c C-x C-k: Structure editing. (line 31)
3770 * C-c C-x C-w <1>: Built-in table editor.
3772 * C-c C-x C-w: Structure editing. (line 31)
3773 * C-c C-x C-y <1>: Built-in table editor.
3775 * C-c C-x C-y: Structure editing. (line 38)
3776 * C-c C-x h: HTML export. (line 10)
3777 * C-c C-x i: iCalendar export. (line 13)
3778 * C-c C-x M-w <1>: Built-in table editor.
3780 * C-c C-x M-w: Structure editing. (line 35)
3781 * C-c C-x t: HTML export. (line 14)
3782 * C-c C-x v: Sparse trees. (line 39)
3783 * C-c C-y: Creating timestamps. (line 63)
3784 * C-c l: Managing links. (line 9)
3785 * C-c |: Built-in table editor.
3787 * C-c ~: table.el. (line 18)
3788 * C-u C-c .: Creating timestamps. (line 16)
3789 * C-u C-c =: Built-in table editor.
3791 * C-u C-c C-l: Managing links. (line 36)
3792 * D: Agenda commands. (line 66)
3793 * d: Agenda commands. (line 63)
3794 * f: Agenda commands. (line 44)
3795 * g: Agenda commands. (line 70)
3796 * H: Agenda commands. (line 174)
3797 * i: Agenda commands. (line 145)
3798 * l: Agenda commands. (line 49)
3799 * L: Agenda commands. (line 32)
3800 * M: Agenda commands. (line 161)
3801 * M-<down>: Built-in table editor.
3803 * M-<left> <1>: Built-in table editor.
3805 * M-<left>: Structure editing. (line 13)
3806 * M-<RET> <1>: Plain Lists. (line 42)
3807 * M-<RET>: Structure editing. (line 6)
3808 * M-<right> <1>: Built-in table editor.
3810 * M-<right>: Structure editing. (line 16)
3811 * M-<TAB> <1>: Completion. (line 10)
3812 * M-<TAB> <2>: Setting tags. (line 6)
3813 * M-<TAB>: Per file keywords. (line 17)
3814 * M-<up>: Built-in table editor.
3816 * M-S-<down> <1>: Built-in table editor.
3818 * M-S-<down> <2>: Plain Lists. (line 46)
3819 * M-S-<down>: Structure editing. (line 28)
3820 * M-S-<left> <1>: Creating timestamps. (line 97)
3821 * M-S-<left> <2>: Built-in table editor.
3823 * M-S-<left> <3>: Plain Lists. (line 52)
3824 * M-S-<left>: Structure editing. (line 19)
3825 * M-S-<RET>: Structure editing. (line 10)
3826 * M-S-<right> <1>: Creating timestamps. (line 94)
3827 * M-S-<right> <2>: Built-in table editor.
3829 * M-S-<right> <3>: Plain Lists. (line 52)
3830 * M-S-<right>: Structure editing. (line 22)
3831 * M-S-<up> <1>: Built-in table editor.
3833 * M-S-<up> <2>: Plain Lists. (line 46)
3834 * M-S-<up>: Structure editing. (line 25)
3835 * mouse-1 <1>: Agenda commands. (line 35)
3836 * mouse-1 <2>: Creating timestamps. (line 79)
3837 * mouse-1: Managing links. (line 64)
3838 * mouse-2 <1>: Agenda commands. (line 35)
3839 * mouse-2: Managing links. (line 64)
3840 * mouse-3 <1>: Agenda commands. (line 28)
3841 * mouse-3: Managing links. (line 69)
3842 * n: Agenda commands. (line 19)
3843 * o: Agenda commands. (line 57)
3844 * P: Agenda commands. (line 115)
3845 * p: Agenda commands. (line 20)
3846 * q: Agenda commands. (line 184)
3847 * r <1>: Agenda commands. (line 74)
3848 * r: Global TODO list. (line 21)
3849 * S: Agenda commands. (line 165)
3850 * S-<down> <1>: Agenda commands. (line 124)
3851 * S-<down> <2>: Creating timestamps. (line 55)
3852 * S-<down>: Priorities. (line 25)
3853 * S-<left> <1>: Agenda commands. (line 136)
3854 * S-<left>: Creating timestamps. (line 50)
3855 * S-<RET>: Built-in table editor.
3857 * S-<right> <1>: Agenda commands. (line 128)
3858 * S-<right>: Creating timestamps. (line 50)
3859 * S-<TAB> <1>: Built-in table editor.
3861 * S-<TAB>: Visibility cycling. (line 19)
3862 * S-<up> <1>: Agenda commands. (line 118)
3863 * S-<up> <2>: Creating timestamps. (line 55)
3864 * S-<up>: Priorities. (line 25)
3865 * T: Agenda commands. (line 102)
3866 * t: Agenda commands. (line 98)
3867 * w: Agenda commands. (line 60)
3868 * x: Agenda commands. (line 187)
3874 Node: Introduction
\x7f7181
3875 Node: Summary
\x7f7495
3876 Node: Installation and activation
\x7f9607
3877 Node: Feedback
\x7f11612
3878 Node: Document Structure
\x7f12398
3879 Node: Outlines
\x7f13164
3880 Node: Headlines
\x7f13824
3881 Node: Visibility cycling
\x7f14447
3882 Node: Motion
\x7f15638
3883 Node: Structure editing
\x7f16422
3884 Node: Archiving
\x7f18165
3885 Node: Sparse trees
\x7f19025
3886 Ref: Sparse trees-Footnote-1
\x7f21054
3887 Ref: Sparse trees-Footnote-2
\x7f21146
3888 Node: Plain Lists
\x7f21260
3889 Ref: Plain Lists-Footnote-1
\x7f24016
3890 Node: Tables
\x7f24373
3891 Node: Built-in table editor
\x7f24921
3892 Node: Narrow columns
\x7f32811
3893 Ref: Narrow columns-Footnote-1
\x7f34744
3894 Node: Table calculations
\x7f34790
3895 Node: Formula syntax
\x7f35966
3896 Ref: Formula syntax-Footnote-1
\x7f38900
3897 Node: Column formulas
\x7f39199
3898 Node: Advanced features
\x7f40961
3899 Node: Named-field formulas
\x7f44216
3900 Node: Editing/debugging formulas
\x7f44856
3901 Node: Appetizer
\x7f46614
3902 Node: orgtbl-mode
\x7f47716
3903 Node: table.el
\x7f48207
3904 Node: Hyperlinks
\x7f49184
3905 Node: Link format
\x7f49818
3906 Node: Internal links
\x7f51000
3907 Node: Radio targets
\x7f52890
3908 Node: CamelCase links
\x7f53605
3909 Node: External links
\x7f54204
3910 Ref: External links-Footnote-1
\x7f56129
3911 Node: Managing links
\x7f56268
3912 Node: Search Options
\x7f60246
3913 Ref: Search Options-Footnote-1
\x7f61566
3914 Node: Remember
\x7f61647
3915 Ref: Remember-Footnote-1
\x7f65528
3916 Node: TODO items
\x7f65652
3917 Node: TODO basics
\x7f66575
3918 Node: Progress logging
\x7f68090
3919 Node: TODO extensions
\x7f68876
3920 Node: Workflow states
\x7f69676
3921 Node: TODO types
\x7f70544
3922 Ref: TODO types-Footnote-1
\x7f72202
3923 Node: Per file keywords
\x7f72284
3924 Ref: Per file keywords-Footnote-1
\x7f73737
3925 Node: Priorities
\x7f73965
3926 Node: Timestamps
\x7f75174
3927 Node: Time stamps
\x7f75495
3928 Node: Creating timestamps
\x7f77510
3930 Node: Tag inheritance
\x7f81374
3931 Node: Setting tags
\x7f82311
3932 Node: Tag searches
\x7f83273
3933 Node: Agenda Views
\x7f84482
3934 Node: Agenda files
\x7f86021
3935 Ref: Agenda files-Footnote-1
\x7f86981
3936 Ref: Agenda files-Footnote-2
\x7f87130
3937 Node: Agenda dispatcher
\x7f87322
3938 Node: Weekly/Daily Agenda
\x7f89452
3939 Node: Categories
\x7f90587
3940 Node: Time-of-day specifications
\x7f91235
3941 Node: Calendar/Diary integration
\x7f93211
3942 Node: Sorting of agenda items
\x7f94588
3943 Node: Global TODO list
\x7f95420
3944 Node: Matching headline tags
\x7f96835
3945 Node: Timeline
\x7f97778
3946 Node: Agenda commands
\x7f98651
3947 Node: Exporting
\x7f103906
3948 Node: ASCII export
\x7f104478
3949 Node: HTML export
\x7f105313
3950 Node: HTML formatting
\x7f106429
3951 Node: Export options
\x7f108061
3952 Node: Comment lines
\x7f110252
3953 Node: iCalendar export
\x7f110722
3954 Node: Miscellaneous
\x7f112517
3955 Node: Completion
\x7f113144
3956 Node: Customization
\x7f114140
3957 Node: Clean view
\x7f114588
3958 Node: TTY keys
\x7f117228
3960 Node: Interaction
\x7f124335
3961 Node: Bugs
\x7f127176
3962 Node: Acknowledgments
\x7f129485
3963 Node: Index
\x7f132415
3964 Node: Key Index
\x7f152984