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.23).
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.23).
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:: Exporting to plain ASCII
155 * HTML export:: Exporting to HTML
156 * XML export:: Exporting to XML
157 * iCalendar export:: Exporting in iCalendar format
158 * Text interpretation:: How the exporter looks at the file
160 Text interpretation by the exporter
162 * Comment lines:: Some lines will not be exported
163 * Enhancing text:: Subscripts, symbols and more
164 * Export options:: How to influence the export settings
168 * Completion:: M-TAB knows what you need
169 * Customization:: Adapting Org-mode to your taste
170 * Summary of in-buffer settings:: Using special lines to set options
171 * The very busy C-c C-c key:: When in doubt, press C-c C-c
172 * Clean view:: Getting rid of leading stars in the outline
173 * TTY keys:: Using Org-mode on a tty
174 * FAQ:: Frequently asked questions
175 * Interaction:: Other Emacs packages
176 * Bugs:: Things which do not work perfectly
177 * Acknowledgments:: These people provided feedback and more
180 File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
187 * Summary:: Brief summary of what Org-mode does
188 * Installation and activation:: How to install Org-mode
189 * Feedback:: Bug reports, ideas, patches etc.
192 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
197 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
198 project planning with a fast and effective plain-text system.
200 Org-mode develops organizational tasks around NOTES files that
201 contain information about projects as plain text. Org-mode is
202 implemented on top of outline-mode, which makes it possible to keep the
203 content of large files well structured. Visibility cycling and
204 structure editing help to work with the tree. Tables are easily
205 created with a built-in table editor. Org-mode supports ToDo items,
206 deadlines, time stamps, and scheduling. It dynamically compiles
207 entries into an agenda that utilizes and smoothly integrates much of
208 the Emacs calendar and diary. Plain text URL-like links connect to
209 websites, emails, Usenet messages, BBDB entries, and any files related
210 to the projects. For printing and sharing of notes, an Org-mode file
211 can be exported as a structured ASCII file, as HTML, or (todo and
212 agenda items only) as an iCalendar file.
214 Org-mode keeps simple things simple. When first fired up, it should
215 feel like a simple but easy to use outliner. Complexity is not
216 imposed, but a large amount of functionality is available when you need
217 it. Org-mode can be used on different levels and in different ways,
220 * as an outline extension with visibility cycling and structure editing
221 * as an ASCII system and table editor for taking structured notes
222 * as an ASCII table editor with spreadsheet-like capabilities
223 * as a simple hypertext system, with HTML export
224 * as a TODO list editor
225 * as a full agenda and planner with deadlines and work scheduling
227 The Org-mode table editor can be integrated into any major mode by
228 activating the minor Orgtbl-mode.
230 There is a website for Org-mode which provides links to the newest
231 version of Org-mode, as well as additional information, screen shots
232 and example files. This page is located at
233 `http://www.astro.uva.nl/~dominik/Tools/org/'.
236 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
238 1.2 Installation and Activation
239 ===============================
241 If Org-mode is part of the Emacs distribution or an XEmacs package, you
242 only need to copy the following lines to your `.emacs' file. The last
243 two lines define _global_ keys for the commands `org-store-link' and
244 `org-agenda' - please choose suitable keys yourself.
246 ;; The following lines are always needed. Choose your own keys.
247 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
248 (define-key global-map "\C-cl" 'org-store-link)
249 (define-key global-map "\C-ca" 'org-agenda)
251 If you have downloaded Org-mode from the Web, you must byte-compile
252 `org.el' and put it on your load path. In addition to the Emacs Lisp
253 lines above, you also need to add the following lines to `.emacs':
255 ;; These lines only if org-mode is not part of the X/Emacs distribution.
256 (autoload 'org-mode "org" "Org mode" t)
257 (autoload 'org-diary "org" "Diary entries from Org mode")
258 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
259 (autoload 'org-store-link "org" "Store a link to the current location" t)
260 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
261 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
263 With this setup, all files with extension `.org' will be put into
264 Org-mode. As an alternative, make the first line of a file look like
267 MY PROJECTS -*- mode: org; -*-
269 which will select Org-mode for this buffer no matter what the file's
270 name is. See also the variable `org-insert-mode-line-in-empty-file'.
273 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
278 If you find problems with Org-mode, or if you have questions, remarks,
279 or ideas about it, please contact the maintainer Carsten Dominik at
280 <dominik@science.uva.nl>.
282 For bug reports, please provide as much information as possible,
283 including the version information of Emacs (`C-h v emacs-version
284 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
285 Org-mode related setup in `.emacs'. If an error occurs, a traceback
286 can be very useful. Often a small example file helps, along with clear
289 1. What exactly did you do?
291 2. What did you expect to happen?
293 3. What happened instead?
294 Thank you for helping to improve this mode.
297 File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
302 Org-mode is based on outline mode and provides flexible commands to
303 edit the structure of the document.
307 * Outlines:: Org-mode is based on outline-mode
308 * Headlines:: How to typeset org-tree headlines
309 * Visibility cycling:: Show and hide, much simplified
310 * Motion:: Jumping to other headlines
311 * Structure editing:: Changing sequence and level of headlines
312 * Archiving:: Move done task trees to a different place
313 * Sparse trees:: Matches embedded in context
314 * Plain Lists:: Editing hand-formatted lists
317 File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
322 Org-mode is implemented on top of outline-mode. Outlines allow to
323 organize a document in a hierarchical structure, which (at least for
324 me) is the best representation of notes and thoughts. Overview over
325 this structure is achieved by folding (hiding) large parts of the
326 document to show only the general document structure and the parts
327 currently being worked on. Org-mode greatly simplifies the use of
328 outlines by compressing the entire show/hide functionality into a
329 single command `org-cycle', which is bound to the <TAB> key.
332 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
337 Headlines define the structure of an outline tree. The headlines in
338 Org-mode start with one or more stars, on the left margin. For example:
346 * Another top level headline
348 Some people find the many stars too noisy and would prefer an outline
349 that has whitespace followed by a single star as headline starters.
350 *Note Clean view:: describes a setup to realize this.
353 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
355 2.3 Visibility cycling
356 ======================
358 Outlines make it possible to hide parts of the text in the buffer.
359 Org-mode uses a single command bound to the <TAB> key to change the
360 visibility in the buffer.
363 Rotate current subtree between the states
365 ,-> FOLDED -> CHILDREN -> SUBTREE --.
366 '-----------------------------------'
368 At the beginning of the buffer (or when called with `C-u'), this
369 does the same as the command `S-<TAB>' below.
372 Rotate the entire buffer between the states
374 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
375 '--------------------------------------'
377 Note that inside tables, `S-<TAB>' jumps to the previous field.
382 When Emacs first visits an Org-mode file, the global state is set to
383 OVERVIEW, i.e. only the top level headlines are visible. This can be
384 configured through the variable `org-startup-folded', or on a per-file
385 basis by adding one of the following lines anywhere in the buffer:
392 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
397 The following commands jump to other headlines in the buffer.
406 Next heading same level.
409 Previous heading same level.
412 Backward to higher level heading.
415 Jump to a different place without changing the current outline
416 visibility. Shows the document structure in a temporary buffer,
417 where you can use visibility cycling (<TAB>) to find your
418 destination. After pressing <RET>, the cursor moves to the
419 selected location in the original buffer, and the headings
420 hierarchy above it is made visible.
423 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document Structure
425 2.5 Structure editing
426 =====================
429 Insert new heading with same level as current. If the cursor is
430 in a plain list item, a new item is created. To force creation of
431 a new headline, use a prefix arg, or first press <RET> to get to
432 the beginning of the next line.
435 Insert new TODO entry with same level as current heading.
438 Promote current heading by one level.
441 Demote current heading by one level.
444 Promote the current subtree by one level.
447 Demote the current subtree by one level.
450 Move subtree up (swap with previous subtree of same level).
453 Move subtree down (swap with next subtree of same level).
457 Kill subtree, i.e. remove it from buffer but save in kill ring.
460 Copy subtree to kill ring.
463 Yank subtree from kill ring. This does modify the level of the
464 subtree to make sure the tree fits in nicely at the yank position.
465 The yank level can also be specified with a prefix arg, or by
466 yanking after a headline marker like `****'.
468 When there is an active region (transient-mark-mode), promotion and
469 demotion work on all headlines in the region. To select a region of
470 headlines, it is best to place both point and mark at the beginning of a
471 line, mark at the beginning of the first headline, and point at the line
472 just after the last headline to change. Note that when the cursor is
473 inside a table (*note Tables::), the Meta-Cursor keys have different
477 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document Structure
482 When a project represented by a (sub)tree is finished, you may want to
483 move the tree to an archive place, either in the same file under a
484 special top-level heading, or even to a different file.
486 Archive the subtree starting at the cursor position to the location
487 given by `org-archive-location'.
489 The default archive is a file in the same directory as the current
490 file, with the name derived by appending `_archive' to the current file
491 name. For information and examples on how to change this, see the
492 documentation string of the variable `org-archive-location'. If you
493 are also using the Org-mode agenda, archiving to a different file is a
494 good way to keep archived trees from contributing agenda items.
497 File: org, Node: Sparse trees, Next: Plain Lists, Prev: Archiving, Up: Document Structure
502 An important feature of Org-mode is the ability to construct _sparse
503 trees_ for selected information in an outline tree. A sparse tree
504 means that the entire document is folded as much as possible, but the
505 selected information is made visible along with the headline structure
506 above it(1). Just try it out and you will see immediately how it works.
508 Org-mode contains several commands creating such trees. The most
509 basic one is `org-occur':
512 Occur. Prompts for a regexp and shows a sparse tree with all
513 matches. If the match is in a headline, the headline is made
514 visible. If the match is in the body of an entry, headline and
515 body are made visible. In order to provide minimal context, also
516 the full hierarchy of headlines above the match is shown, as well
517 as the headline following the match. Each match is also
518 highlighted, the highlights disappear when the buffer is changed
519 with an editing command.
520 For frequently used sparse trees of specific search strings, you can
521 use the variable `org-agenda-custom-commands' to define fast keyboard
522 access to specific sparse trees. These commands will then be
523 accessible through the agenda dispatcher (*note Agenda dispatcher::).
526 (setq org-agenda-custom-commands
527 '(("f" occur-tree "FIXME")))
529 will define the key `C-c a f' as a shortcut for creating a sparse tree
530 matching the string `FIXME'.
532 Other commands are using sparse trees as well. For example `C-c
533 C-v' creates a sparse TODO tree (*note TODO basics::).
535 To print a sparse tree, you can use the Emacs command
536 `ps-print-buffer-with-faces' which does not print invisible parts of
537 the document (2). Or you can use the command `C-c C-x v' to copy the
538 visible part of the document to another file (extension `.txt') which
539 can then be printed in any desired way.
541 ---------- Footnotes ----------
543 (1) See also the variables `org-show-hierarchy-above' and
544 `org-show-following-heading'.
546 (2) This does not work under XEmacs, because XEmacs uses selective
547 display for outlining, not text properties
550 File: org, Node: Plain Lists, Prev: Sparse trees, Up: Document Structure
555 Headlines define both the structure of the Org-mode file, and also lists
556 (for example, TODO items (*note TODO items::) should be created using
557 headline levels). However, when taking notes, the plain text is
558 sometimes easier to read with hand-formatted lists. Org-mode supports
559 editing such lists, and the HTML exporter (*note Exporting::) does
560 parse and format them.
562 Org-mode knows ordered and unordered lists. Unordered list items
563 start with `-', `+', or `*'(1) as bullets. Ordered list items start
564 with `1.' or `1)'. Items belonging to the same list must have the same
565 indentation on the first line. In particular, if an ordered list
566 reaches number `10.', then the 2-digit numbers must be written
567 left-aligned with the other numbers in the list. Indentation also
568 determines the end of a list item. It ends before the next line that
569 is indented like the bullet/number, or less. For example:
572 My favorite scenes are (in this order)
573 1. Eowyns fight with the witch king
574 + this was already my favorite scene in the book
575 + I really like Miranda Otto.
576 2. The attack of the Rohirrim
577 3. Peter Jackson being shot by Legolas
579 He makes a really funny face when it happens.
581 Org-mode supports these lists by tuning filling and wrapping commands
582 to correctly deal with them. Furthermore, the following commands act
583 on items when the cursor is in the first line of an item (the line with
584 the bullet or number).
587 Items can be folded just like headline levels if you set the
588 variable `org-cycle-include-plain-lists'. The level of an item is
589 then given by the indentation of the bullet/number. However,
590 items are always subordinate to real headlines, the hierarchies
591 remain completely separated.
594 Insert new item at current level. With prefix arg, for a new
599 Move the item including subitems up/down (swap with previous/next
600 item of same indentation). If the list is ordered, renumbering is
605 Decrease/increase the indentation of the item, including subitems.
606 Initially, the item tree is selected based on current indentation.
607 When these commands are executed several times in direct
608 succession, the initially selected region is used, even if the new
609 indentation would imply a different hierarchy. To use the new
610 hierarchy, break the command chain with a cursor motion or so.
613 Renumber the ordered list at the cursor.
615 ---------- Footnotes ----------
617 (1) When using `*' as a bullet, lines must be indented or they will
618 be seen as top-level headlines. Also, when you are hiding leading
619 stars to get a clean outline view, plain list items starting with a
620 star are visually indistinguishable from true headlines. In short:
621 even though `*' is supported, it may be better to not use it for plain
625 File: org, Node: Tables, Next: Hyperlinks, Prev: Document Structure, Up: Top
630 Org-mode has a very fast and intuitive table editor built-in.
631 Spreadsheet-like calculations are supported in connection with the
632 Emacs `calc' package.
636 * Built-in table editor:: Simple tables
637 * Narrow columns:: Stop wasting space in tables
638 * Table calculations:: Compute a field from other fields
639 * orgtbl-mode:: The table editor as minor mode
640 * table.el:: Complex tables
643 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
645 3.1 The built-in table editor
646 =============================
648 Org-mode makes it easy to format tables in plain ASCII. Any line with
649 `|' as the first non-white character is considered part of a table.
650 `|' is also the column separator. A table might look like this:
652 | Name | Phone | Age |
653 |-------+-------+-----|
654 | Peter | 1234 | 17 |
657 A table is re-aligned automatically each time you press <TAB> or
658 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
659 field (<RET> to the next row) and creates new table rows at the end of
660 the table or before horizontal lines. The indentation of the table is
661 set by the first line. Any line starting with `|-' is considered as a
662 horizontal separator line and will be expanded on the next re-align to
663 span the whole table width. So, to create the above table, you would
669 and then press <TAB> to align the table and start filling in fields.
671 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
672 and all character keys in a special way, so that inserting and deleting
673 avoids shifting other fields. Also, when typing _immediately after the
674 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
675 the field is automatically made blank. If this behavior is too
676 unpredictable for you, configure the variables
677 `org-enable-table-editor' and `org-table-auto-blank-field'.
679 Creation and conversion
680 .......................
683 Convert the active region to table. If every line contains at
684 least one TAB character, the function assumes that the material is
685 tab separated. If not, lines are split at whitespace into fields.
686 You can use a prefix argument to indicate the minimum number of
687 consecutive spaces required to identify a field separator
689 If there is no active region, this command creates an empty
690 Org-mode table. However, it's easier to just start typing, like
691 `|Name|Phone|Age <RET> |- <TAB>'.
693 Re-aligning and field motion
694 ............................
697 Re-align the table without moving the cursor.
700 Re-align the table, move to the next field. Creates a new row if
704 Re-align, move to previous field.
707 Re-align the table and move down to next row. Creates a new row if
708 necessary. At the beginning or end of a line, <RET> still does
709 NEWLINE, so it can be used to split a table.
711 Column and row editing
712 ......................
716 Move the current column left/right.
719 Kill the current column.
722 Insert a new column to the left of the cursor position.
726 Move the current row up/down.
729 Kill the current row or horizontal line.
732 Insert a new row above (with arg: below) the current row.
735 Insert a horizontal line below current row. With prefix arg, the
736 line is created above the current line.
739 Sort the table lines in the region. Point and mark must be in the
740 first and last line to be included, and must be in the column that
741 should be used for sorting. The command prompts for numerical
742 versus alphanumerical sorting.
748 Copy a rectangular region from a table to a special clipboard.
749 Point and mark determine edge fields of the rectangle. The
750 process ignores horizontal separator lines.
753 Copy a rectangular region from a table to a special clipboard, and
754 blank all fields in the rectangle. So this is the "cut" operation.
757 Paste a rectangular region into a table. The upper right corner
758 ends up in the current field. All involved fields will be
759 overwritten. If the rectangle does not fit into the present table,
760 the table is enlarged as needed. The process ignores horizontal
764 Wrap several fields in a column like a paragraph. If there is an
765 active region, and both point and mark are in the same column, the
766 text in the column is wrapped to minimum width for the given
767 number of lines. A prefix ARG may be used to change the number of
768 desired lines. If there is no region, the current field is split
769 at the cursor position and the text fragment to the right of the
770 cursor is prepended to the field one line down. If there is no
771 region, but you specify a prefix ARG, the current field is made
772 blank, and the content is appended to the field above.
778 Install a new formula for the current column and replace current
779 field with the result of the formula.
782 Install a new formula for the current field, which must be a named
783 field. Evaluate the formula and replace the field content with the
787 Edit all formulas associated with the current table in a separate
791 Recalculate the current row by applying the stored formulas from
792 left to right. When called with a `C-u' prefix, recalculate the
793 entire table, starting with the first non-header line (i.e. below
794 the first horizontal separator line). For details, see *Note
795 Table calculations::.
798 Rotate the calculation mark in first column through the states `',
799 `#', `*', `!', `$'. For the meaning of these marks see *Note
800 Advanced features::. When there is an active region, change all
804 Which table column is the cursor in? Displays number >0 in echo
808 Sum the numbers in the current column, or in the rectangle defined
809 by the active region. The result is shown in the echo area and can
810 be inserted with `C-y'.
813 When current field is empty, copy from first non-empty field above.
814 When not empty, copy current field down to next row and move cursor
815 along with it. Depending on the variable
816 `org-table-copy-increment', integer field values will be
817 incremented during copy. This key is also used by CUA-mode (*note
824 Edit the current field in a separate window. This is useful for
825 fields that are not fully visible (*note Narrow columns::). When
826 called with a `C-u' prefix, just make the full field visible, so
827 that it can be edited in place.
830 This is an alias for `C-u C-c `' to make the current field fully
833 `M-x org-table-import'
834 Import a file as a table. The table should be TAB- or whitespace
835 separated. Useful, for example, to import an Excel table or data
836 from a database, because these programs generally can write
837 TAB-separated text files. This command works by inserting the
838 file into the buffer and then converting the region to a table.
839 Any prefix argument is passed on to the converter, which uses it
840 to determine the separator.
842 `M-x org-table-export'
843 Export the table as a TAB-separated file. Useful for data
844 exchange with, for example, Excel or database programs.
847 If you don't like the automatic table editor because it gets in your
848 way on lines which you would like to start with `|', you can turn it
851 (setq org-enable-table-editor nil)
853 The only table command which then still works is `C-c C-c' to do a
857 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
862 The width of columns is automatically determined by the table editor.
863 Sometimes a single field or a few fields need to carry more text,
864 leading to inconveniently wide columns. To limit(1) the width of a
865 column, one field anywhere in the column must carry the string `<N>'
866 where `N' is an integer specifying the width of the column in
867 characters. The next re-align will then set the width of this column
868 to no more than this value.
870 |---+------------------------------| |---+--------|
872 | 1 | one | | 1 | one |
873 | 2 | two | ----\ | 2 | two |
874 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
875 | 4 | four | | 4 | four |
876 |---+------------------------------| |---+--------|
878 Fields that are wider become clipped and end in the string `=>'. Note
879 that the full text is still in the buffer, it is only invisible. To
880 see the full text, hold the mouse over the field - a tooltip window
881 will show the full content. To edit such a field, use the command `C-c
882 `' (that is `C-c' followed by the backquote). This will open a new
883 window with the full field. Edit it and finish with `C-c C-c'.
885 When visiting a file containing a table with narrowed columns, the
886 necessary character hiding has not yet happened, and the table needs to
887 be aligned before it looks nice. Setting the option
888 `org-startup-align-all-tables' will realign all tables in a file upon
889 visiting, but also slow down startup. You can also set this option on
890 a per-file basis with:
895 ---------- Footnotes ----------
897 (1) This feature does not work on XEmacs.
900 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
902 3.3 Calculations in tables
903 ==========================
905 The table editor makes use of the Emacs `calc' package to implement
906 spreadsheet-like capabilities. Org-mode has two levels of complexity
907 for table calculations. On the basic level, tables do only horizontal
908 computations, so a field can be computed from other fields _in the same
909 row_, and Org-mode assumes that there is only one formula for each
910 column. This is very efficient to work with and enough for many tasks.
911 On the complex level, columns and individual fields can be named for
912 easier referencing in formulas, individual named fields can have their
913 own formula associated with them, and recalculation can be automated.
917 * Formula syntax:: How to write a formula
918 * Column formulas:: Formulas valid for all fields in a column
919 * Advanced features:: Field names, parameters and automatic recalc
920 * Named-field formulas:: Formulas valid in single fields
921 * Editing/debugging formulas:: Changing a stored formula
922 * Appetizer:: Taste the power of calc
925 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
930 A formula can be any algebraic expression understood by the Emacs
931 `calc' package. Note that `calc' has the slightly non-standard
932 convention that `/' has lower precedence than `*', so that `a/b*c' is
933 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
934 calc-eval: (calc)Calling Calc from Your Lisp Programs.), variable
935 substitution takes place:
937 $ refers to the current field
938 $3 refers to the field in column 3 of the current row
939 $3..$7 a vector of the fields in columns 3-7 of current row
940 $P1..$P3 vector of column range, using column names
941 &2 second data field above the current, in same column
942 &5-2 vector from fifth to second field above current
943 &III-II vector of fields between 2nd and 3rd hline above
944 &III vector of fields between third hline above and current field
945 $name a named field, parameter or constant
947 The range vectors can be directly fed into the calc vector functions
948 like `vmean' and `vsum'.
950 `$name' is interpreted as the name of a column, parameter or
951 constant. Constants are defined globally through the variable
952 `org-table-formula-constants'. If you have the `constants.el' package,
953 it will also be used to resolve constants, including natural constants
954 like `$h' for Planck's constant, and units like `$km' for kilometers.
955 Column names and parameters can be specified in special table lines.
956 These are described below, see *Note Advanced features::.
958 A formula can contain an optional mode string after a semicolon.
959 This string consists of flags to influence calc's modes(1) during
960 execution, e.g. `p20' to switch the internal precision to 20 digits,
961 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
962 or fixed display format, respectively, and `D', `R', `F', and `S' to
963 turn on degrees, radians, fraction and symbolic modes, respectively.
964 In addition, you may provide a `printf' format specifier to reformat
965 the final result. A few examples:
967 $1+$2 Sum of first and second field
968 $1+$2;%.2f Same, format result to two decimals
969 exp($2)+exp($1) Math functions can be used
970 $;%.1f Reformat current cell to 1 decimal
971 ($3-32)*5/9 Degrees F -> C conversion
972 $c/$1/$cm Hz -> cm conversion, using `constants.el'
973 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
974 sin($1);Dp3%.1e Same, but use printf specifier for display
975 vmean($2..$7) Compute column range mean, using vector function
976 vsum(&III) Sum numbers from 3rd hline above, up to here
977 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
979 ---------- Footnotes ----------
981 (1) By default, Org-mode uses the standard calc modes (precision 12,
982 angular units degrees, fraction and symbolic modes off). However, the
983 display format has been changed to `(float 5)' to keep tables compact.
984 The default settings can be configured using the variable
985 `org-calc-default-modes'.
988 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
990 3.3.2 Column formulas
991 ---------------------
993 To apply a formula to a field, type it directly into the field,
994 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
995 <RET> or `C-c C-c' with the cursor still in the field, the formula will
996 be stored as the formula for the current column, evaluated and the
997 current field replaced with the result. If the field contains only
998 `=', the previously stored formula for this column is used.
1000 For each column, Org-mode will remember the most recently used
1001 formula. The information is stored in a special line starting with
1002 `#+TBLFM' directly below the table. When adding/deleting/moving
1003 columns with the appropriate commands, the stored equations will be
1004 modified accordingly. When a column used in a calculation is removed,
1005 references to this column become invalid and will cause an error upon
1006 applying the equation.
1008 Instead of typing an equation into the field, you may also use the
1009 command `C-c ='. It prompts for a formula (with default taken from the
1010 `#+TBLFM:' line) and applies it to the current field. A numerical
1011 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1012 in the current column.
1014 To recompute all the fields in a line, use the command `C-c *'. It
1015 re-applies all stored equations to the current row, from left to right.
1016 With a `C-u' prefix, this will be done to every line in the table, so
1017 use this command it you want to make sure the entire table is
1018 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1019 Global updating does not touch the line(s) above the first horizontal
1020 separator line, assuming that this is the table header.
1023 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1025 3.3.3 Advanced features
1026 -----------------------
1028 If you want the recalculation of fields to happen automatically, or if
1029 you want to be able to assign a formula to an individual field (instead
1030 of an entire column) you need to reserve the first column of the table
1031 for special marking characters. Here is an example of a table that
1032 collects exam results of students and makes use of these features:
1034 |---+---------+--------+--------+--------+-------+------|
1035 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1036 |---+---------+--------+--------+--------+-------+------|
1037 | ! | | P1 | P2 | P3 | Tot | |
1038 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1039 | ^ | | m1 | m2 | m3 | mt | |
1040 |---+---------+--------+--------+--------+-------+------|
1041 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1042 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1043 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1044 |---+---------+--------+--------+--------+-------+------|
1045 | | Average | | | | 29.7 | |
1046 | ^ | | | | | at | |
1047 | $ | max=50 | | | | | |
1048 |---+---------+--------+--------+--------+-------+------|
1049 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1051 Important: Please note that for these special tables, recalculating the
1052 table with `C-u C-c *' will only affect rows which are marked `#' or
1053 `*', and named fields. The column formulas are not applied in rows
1054 with empty first field.
1056 The marking characters have the following meaning:
1058 The fields in this line define names for the columns, so that you
1059 may refer to a column as `$Tot' instead of `$6'.
1062 This row defines names for the fields _above_ the row. With such
1063 a definition, any formula in the table may use `$m1' to refer to
1064 the value `10'. Also, named fields can have their own formula
1065 associated with them.
1068 Similar to `^', but defines names for the fields in the row
1072 Fields in this row can define _parameters_ for formulas. For
1073 example, if a field in a `$' row contains `max=50', then formulas
1074 in this table can refer to the value 50 using `$max'. Parameters
1075 work exactly like constants, only that they can be defined on a
1076 per-table basis. Changing a parameter and then recalculating the
1077 table can be useful.
1080 Fields in this row are automatically recalculated when pressing
1081 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1082 selected for a global recalculation with `C-u C-c *'. Unmarked
1083 lines will be left alone by this command.
1086 Selects this line for global recalculation with `C-u C-c *', but
1087 not for automatic recalculation. Use this when automatic
1088 recalculation slows down editing too much.
1091 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1092 All lines that should be recalculated should be marked with `#' or
1096 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1098 3.3.4 Named-field formulas
1099 --------------------------
1101 A named field can have its own formula associated with it. In the
1102 example above, this is used for the `at' field that contains the
1103 average result of the students. To enter a formula for a named field,
1104 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1105 This equation will be stored below the table like `$name=...'. Any
1106 recalculation in the table (even if only requested for the current
1107 line) will also update all named field formulas.
1110 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1112 3.3.5 Editing and debugging formulas
1113 ------------------------------------
1115 To edit a column or field formula, use the commands `C-c =' and `C-u
1116 C-c =', respectively. The currently active expression is then
1117 presented as default in the minibuffer, where it may be edited.
1119 Note that making a table field blank does not remove the formula
1120 associated with the field - during the next recalculation the field
1121 will be filled again. To remove a formula from a field, you have to
1122 give an empty reply when prompted for the formula, or to edit the
1125 You may edit the `#+TBLFM' directly and re-apply the changed
1126 equations with `C-c C-c' in that line, or with the normal recalculation
1127 commands in the table.
1129 In particular for large tables with many formulas, it is convenient
1130 to use the command `C-c '' to edit the formulas of the current table in
1131 a separate buffer. That buffer will show the formulas one per line,
1132 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1133 `$...' expression to get information about its interpretation.
1134 Exiting the buffer with `C-c C-c' only stores the modified formulas
1135 below the table. Exiting with `C-u C-c C-c' also applies them to the
1136 entire table. `C-c C-q' exits without installing the changes.
1138 When the evaluation of a formula leads to an error, the field content
1139 becomes the string `#ERROR'. If you would like see what is going on
1140 during variable substitution and calculation in order to find a bug,
1141 turn on formula debugging in the menu and repeat the calculation, for
1142 example by pressing `C-c = <RET>' in a field. Detailed information
1146 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1151 Finally, just to wet your appetite on what can be done with the
1152 fantastic `calc' package, here is a table that computes the Taylor
1153 series for a couple of functions (homework: try that with Excel :-)
1155 |---+-------------+---+-----+--------------------------------------|
1156 | | Func | n | x | Result |
1157 |---+-------------+---+-----+--------------------------------------|
1158 | # | exp(x) | 1 | x | 1 + x |
1159 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1160 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1161 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1162 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1163 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1164 |---+-------------+---+-----+--------------------------------------|
1165 #+TBLFM: $5=taylor($2,$4,$3);n3
1168 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1170 3.4 The Orgtbl minor mode
1171 =========================
1173 If you like the intuitive way the Org-mode table editor works, you
1174 might want to use it also in other modes like text-mode or mail-mode.
1175 The minor mode Orgtbl-mode makes this possible. You can always toggle
1176 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1179 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1182 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1184 3.5 The `table.el' package
1185 ==========================
1187 Complex ASCII tables with automatic line wrapping, column- and
1188 row-spanning, and alignment can be created using the Emacs table
1189 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1190 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1191 table, Org-mode will call `table-recognize-table' and move the cursor
1192 into the table. Inside a table, the keymap of Org-mode is inactive.
1193 In order to execute Org-mode-related commands, leave the table.
1196 Recognize `table.el' table. Works when the cursor is in a
1200 Insert a table.el table. If there is already a table at point,
1201 this command converts it between the table.el format and the
1202 Org-mode format. See the documentation string of the command
1203 `org-convert-table' for the restrictions under which this is
1207 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1212 Just like HMTL, Org-mode provides links inside a file, and external
1213 links to other files, Usenet articles, emails and much more.
1217 * Link format:: How links in Org-mode are formatted
1218 * Internal links:: Links to other places in the current file
1219 * External links:: URL-like links to the world
1220 * Managing links:: Creating, inserting and following
1221 * Search Options:: Linking to a specific location
1222 * Remember:: Org-trees store quick notes
1225 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1230 Org-mode will recognize plain URL-like links and activate them as
1231 clickable links. However, the general link format looks like this:
1233 [[link][description]] or alternatively [[link]]
1235 Once a link in the buffer is complete (all brackets present),
1236 Org-mode will change the display so that `description' is displayed
1237 instead of `[[link][description]]' and `link' is displayed instead of
1238 `[[link]]'. Links will be highlighted in the face `org-link', which by
1239 default is an underlined face. You can directly edit the visible part
1240 of a link. Note that this can be either the `link' part (if there is
1241 not description) or the `description' part. To edit also the invisible
1242 `link' part, use `C-c C-l' with the cursor on the link.
1244 If you place the cursor at the beginning or just behind the end of
1245 the displayed text and press <BACKSPACE>, you will remove the
1246 (invisible) bracket at that location. This makes the link incomplete
1247 and the internals are again displayed as plain text. Inserting the
1248 missing bracket does hide the link internals again. To show the
1249 internal structure of all links, use the menu entry
1250 `Org->Hyperlinks->Literal links'.
1253 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1258 If the link text does not look like a URL, links are considered to be
1259 internal in the current file. Links such as `[[My Target]]' or `[[My
1260 Target][Find my target]]' lead to a text search in the current file.
1261 The link can be followed with `C-c C-o' when the cursor is on the link,
1262 or with a mouse click (*note Managing links::). The preferred match
1263 for such a link is a dedicated target: The same string in double
1264 angular brackets. Targets may be located anywhere, often it is
1265 convenient to put them into a comment line, for example
1269 If no dedicated target exists, Org-mode will search for the words in
1270 the link, often removing the need for a dedicated target. In the above
1271 example the search would be for `my target'. Links starting with a
1272 star like `*My Target' restrict the search to headlines. When
1273 searching, Org-mode will first try an exact match, but then move on to
1274 more and more lenient searches. For example, the link `[[*My
1275 Targets]]' will find any of the following:
1278 ** TODO my targets are bright
1279 ** my 20 targets are
1281 To insert a link targeting a headline, in-buffer completion can be
1282 used. Just type a star followed by a few optional letters into the
1283 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1284 offered as completions. *Note Managing links::, for more commands
1287 Following a link pushes a mark onto Org-mode's own mark ring. You
1288 can return to the previous position with `C-c &'. Using this command
1289 several times in direct succession goes back to positions recorded
1294 * Radio targets:: Make targets trigger links in plain text.
1295 * CamelCase links:: Activating CamelCase words as links
1298 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1303 You can configure Org-mode to link any occurrences of certain target
1304 names in normal text. So without explicitly creating a link, the text
1305 connects to the target radioing its position. Radio targets are
1306 enclosed by triple angular brackets. For example, a target `<<<My
1307 Target>>>' causes each occurrence of `my target' in normal text to
1308 become activated as a link. The Org-mode file is scanned automatically
1309 for radio targets only when the file is first loaded into Emacs. To
1310 update the target list during editing, press `C-c C-c' with the cursor
1314 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1316 4.2.2 CamelCase words as links
1317 ------------------------------
1319 Org-mode also supports CamelCase words as links. This feature is not
1320 turned on by default because of the inconsistencies this system suffers
1321 from. To activate CamelCase words as links, you need to customize the
1322 option `org-activate-links'. A CamelCase word then leads to a text
1323 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1326 File: org, Node: External links, Next: Managing links, Prev: Internal links, Up: Hyperlinks
1331 Org-mode supports links to files, websites, Usenet and email messages;
1332 and BBDB database entries. External links are URL-like locators. The
1333 following list shows examples for each link type.
1335 http://www.astro.uva.nl/~dominik on the web
1336 file:/home/dominik/images/jupiter.jpg file, absolute path
1337 file:papers/last.pdf file, relative path
1338 news:comp.emacs Usenet link
1339 mailto:adent@galaxy.net Mail link
1340 vm:folder VM folder link
1341 vm:folder#id VM message link
1342 vm://myself@some.where.org/folder#id VM on remote machine
1343 wl:folder WANDERLUST folder link
1344 wl:folder#id WANDERLUST message link
1345 mhe:folder MH-E folder link
1346 mhe:folder#id MH-E message link
1347 rmail:folder RMAIL folder link
1348 rmail:folder#id RMAIL message link
1349 gnus:group GNUS group link
1350 gnus:group#id GNUS article link
1351 bbdb:Richard Stallman BBDB link
1352 shell:ls *.org A shell command
1354 A link should be enclosed in double brackets and may contain a
1355 descriptive text to be displayed instead of the url (*note Link
1356 format::), for example:
1358 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1360 Org-mode also finds external links in the normal text and activates
1361 them as links. If spaces must be part of the link (for example in
1362 `bbdb:Richard Stallman') or to remove ambiguities about the end of the
1363 link, enclose them in angular brackets.
1366 File: org, Node: Managing links, Next: Search Options, Prev: External links, Up: Hyperlinks
1371 Org-mode provides methods to create a link in the correct syntax, to
1372 insert it into an org-mode file, and to follow the link.
1375 Store a link to the current location. This is a _global_ command
1376 which can be used in any buffer to create a link. The link will be
1377 stored for later insertion into an Org-mode buffer (see below).
1378 For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link
1379 will point to the current article/entry. For W3 and W3M buffers,
1380 the link goes to the current URL. For Org-mode files, the current
1381 headline is targeted. For any other files, the link will point to
1382 the file, with a search string (*note Search Options::) pointing
1383 to the contents of the current line. If there is an active
1384 region, the selected words will form the basis of the search
1385 string. The key binding `C-c l' is only a suggestion - see *Note
1386 Installation and activation::.
1389 Insert a link. This prompts for a link to be inserted into the
1390 buffer. You can just type a link, using text for an internal
1391 link, or one of the link type prefixes mentioned in the examples
1392 above. Through completion, all links stored during the current
1393 session can be accessed. The link will be formatted as given in
1394 the variable `org-link-format' and inserted into the buffer, along
1395 with a descriptive text. Note that you don't have to use this
1396 command to insert a link. Links in Org-mode are plain text, and
1397 you can type or paste them straight into the buffer. By using
1398 this command, the links are automatically enclosed in double
1399 brackets, and you will be asked for the optional descriptive text.
1402 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1403 file will be inserted and you may use file name completion to
1404 select the name of the file. The path to the file is inserted
1405 relative to the directory of the current org file, if the linked
1406 file is in the current directory or in a subdirectory of it.
1407 Otherwise an absolute path, if possible with `~/' for your home
1408 directory is used. You can force an absolute path with two `C-u'
1411 `C-c C-l with cursor on existing link'
1412 When the cursor is on an existing link, `C-c C-l' allows to edit
1413 the link and description parts of the link.
1416 Open link at point. This will launch a web browser for URLs (using
1417 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1418 the corresponding links, and execute the command in a shell link.
1419 When the cursor is on an internal link, this commands runs the
1420 corresponding search. When the cursor is on a TAGS list in a
1421 headline, it creates the corresponding TAGS view. If the cursor
1422 is on a time stamp, it compiles the agenda for that date.
1423 Furthermore, it will visit text files in `file:' links with Emacs
1424 and select a suitable application for non-text files.
1425 Classification of files is based on file extension only. See
1426 option `org-file-apps'. If you want to override the default
1427 application and visit the file with Emacs, use a `C-u' prefix.
1431 On links, `mouse-2' will open the link just like `C-c C-o' would.
1432 Under Emacs 22, also `mouse-1' will follow a link.
1435 Like `mouse-2', but force file links to be opened with Emacs.
1438 Push the current position onto the mark ring, to be able to return
1439 easily. Commands following an internal link do this automatically.
1442 Jump back to a recorded position. A position is recorded by the
1443 commands following internal links, and by `C-c %'. Using this
1444 command several times in direct succession moves through a ring of
1445 previously recorded positions.
1448 File: org, Node: Search Options, Next: Remember, Prev: Managing links, Up: Hyperlinks
1450 4.5 Search options in file links
1451 ================================
1453 File links can contain additional information to make Emacs jump to a
1454 particular location in the file when following a link. This can be a
1455 line number or a search option after a double(1) colon. For example:
1457 [[file:~/code/main.c::255]]
1458 [[file:~/xx.org::My Target]]
1459 [[file:~/xx.org::*My Target]]
1460 [[file:~/xx.org::/regexp/]]
1462 Here is what these options do.
1468 Search for a link target `<<My Target>>', or do a text search for
1469 `my target', similar to the search in internal links, see *Note
1473 In an Org-mode file, restrict search to headlines.
1476 Do a regular expression search for `regexp'. This uses the Emacs
1477 command `occur' to list all matches in a separate window. If the
1478 target file is in Org-mode, `org-occur' is used to create a sparse
1479 tree with the matches.
1481 As a degenerate case, a file link with an empty file name can be used
1482 to search the current file. For example, `<file:::find me>' does a
1483 search for `find me' in the current file, just like `[[find me]]' would.
1485 ---------- Footnotes ----------
1487 (1) For backward compatibility, line numbers can also follow a
1491 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1496 Another way to create org entries with links to other files is through
1497 the _Remember_ package by John Wiegley. _Remember_ lets you store
1498 quick notes with little interruption of your work flow. See
1499 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1500 information. The notes produced by _Remember_ can be stored in
1501 different ways, and Org-mode files are a good target. Org-mode allows
1502 to file away notes either to a default file, or directly to the correct
1503 location in your Org-mode outline tree. The following customization(1)
1504 will tell _Remember_ to use org files as target, and to create
1505 annotations compatible with Org-mode links.
1507 (setq org-directory "~/path/to/my/orgfiles/")
1508 (setq org-default-notes-file "~/.notes")
1509 (autoload 'org-remember-annotation "org")
1510 (autoload 'org-remember-apply-template "org")
1511 (autoload 'org-remember-handler "org")
1512 (setq remember-annotation-functions '(org-remember-annotation))
1513 (setq remember-handler-functions '(org-remember-handler))
1514 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1516 In combination with Org-mode, you can use templates to generate
1517 different types of remember notes. For example, if you would like to
1518 use one template to create general TODO entries, and another one for
1519 journal entries, you could use:
1521 (setq org-remember-templates
1522 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1523 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1525 In these entries, the character specifies how to select the template,
1526 the first string specifies the template, and the (optional) second
1527 string specifies a default file (overruling `org-default-notes-file')
1528 as a target for this note.
1530 When you call `M-x remember' to remember something, org will prompt
1531 for a key to select the template and then prepare the buffer like
1533 <file:link to where you called remember>
1537 * [2006-03-21 Tue 15:37]
1539 <file:link to where you called remember>
1541 See the variable `org-remember-templates' for more details.
1543 When you are finished composing a note with remember, you have to
1544 press `C-c C-c' to file the note away. The handler first prompts for a
1545 target file - if you press <RET>, the value of `org-default-notes-file'
1546 is used. Then the command offers the headings tree of the selected
1547 file. You can either immediately press <RET> to get the note appended
1548 to the file. Or you can use vertical cursor motion (<up> and <down>)
1549 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1550 or <left> or <right> leads to the following result.
1552 Cursor Key Note gets inserted
1554 buffer-start <RET> as level 2 heading at end of file
1555 on headline <RET> as sublevel of the heading at cursor
1556 <left> as same level, before current heading
1557 <right> as same level, after current heading
1558 not on <RET> at cursor position, level taken from context.
1559 headline Or use prefix arg to specify level
1562 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1563 append it to the default file. Even shorter would be `C-u C-c C-c',
1564 which does the same without even showing the tree. But with little
1565 extra effort, you can push it directly to the correct location.
1567 Before inserting the text into a tree, the function ensures that the
1568 text has a headline, i.e. a first line that starts with a `*'. If not,
1569 a headline is constructed from the current date and some additional
1570 data. If the variable `org-adapt-indentation' is non-nil, the entire
1571 text is also indented so that it starts in the same column as the
1572 headline (after the asterisks).
1574 ---------- Footnotes ----------
1576 (1) The three autoload forms are only necessary if `org.el' is not
1577 part of the Emacs distribution or an XEmacs package.
1580 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1585 Org-mode does not maintain TODO lists as a separate document. TODO
1586 items are an integral part of the notes file, because TODO items
1587 usually come up while taking notes! With Org-mode, you simply mark any
1588 entry in a tree as being a TODO item. In this way, the information is
1589 not duplicated, and the entire context from which the item emerged is
1590 always present when you check.
1592 Of course, this technique causes TODO items to be scattered
1593 throughout your file. Org-mode provides methods to give you an
1594 overview over all things you have to do.
1598 * TODO basics:: Marking and displaying TODO entries
1599 * Progress logging:: Document your productivity
1600 * TODO extensions:: Workflow and assignments
1601 * Priorities:: Some things are more important than others
1604 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1606 5.1 Basic TODO functionality
1607 ============================
1609 Any headline can become a TODO item by starting it with the word TODO,
1612 *** TODO Write letter to Sam Fortune
1614 The most important commands to work with TODO entries are:
1617 Rotate the TODO state of the current item between
1619 ,-> (unmarked) -> TODO -> DONE --.
1620 '--------------------------------'
1622 The same rotation can also be done "remotely" from the timeline and
1623 agenda buffers with the `t' command key (*note Agenda commands::).
1626 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1627 the entire buffer, but shows all TODO items and the headings
1628 hierarchy above them. With prefix arg, show also the DONE
1629 entries. With numerical prefix N, show the tree for the Nth
1630 keyword in the variable `org-todo-keywords'.
1633 Show the global TODO list. This collects the TODO items from all
1634 agenda files (*note Agenda Views::) into a single buffer. The
1635 buffer is in `agenda-mode', so there are commands to examine and
1636 manipulate the TODO entries directly from that buffer (*note
1637 Agenda commands::). *Note Global TODO list::, for more
1640 ``org-agenda-include-all-todo''
1641 If you would like to have all your TODO items listed as part of
1642 your agenda, customize the variable `org-agenda-include-all-todo'.
1645 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1647 5.2 Progress Logging
1648 ====================
1650 If you want to keep track of _when_ a certain TODO item was finished,
1651 turn on logging with
1653 (setq org-log-done t)
1655 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1656 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1657 [timestamp]' will be inserted just after the headline. If you turn the
1658 entry back into a TODO item again through further state cycling, that
1659 line will be removed again. In the timeline (*note Timeline::) and in
1660 the agenda (*note Weekly/Daily Agenda::), you can then use the `L' key
1661 to display the TODO items closed on each day, giving you an overview of
1662 what has been done on a day.
1665 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1667 5.3 Extended use of TODO keywords
1668 =================================
1670 The default implementation of TODO entries is just two states: TODO and
1671 DONE. You can, however, use the TODO feature for more complicated
1672 things by configuring the variables `org-todo-keywords' and
1673 `org-todo-interpretation'. Using special setup, you can even use TODO
1674 keywords in different ways in different org files.
1676 Note that tags are another way to classify headlines in general and
1677 TODO items in particular (*note Tags::).
1681 * Workflow states:: From TODO to DONE in steps
1682 * TODO types:: I do this, Fred the rest
1683 * Per file keywords:: Different files, different requirements
1686 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1688 5.3.1 TODO keywords as workflow states
1689 --------------------------------------
1691 You can use TODO keywords to indicate different states in the process
1692 of working on an item, for example:
1694 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1695 org-todo-interpretation 'sequence)
1697 Changing these variables becomes only effective in a new Emacs
1698 session. With this setup, the command `C-c C-t' will cycle an entry
1699 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1700 also use a prefix argument to quickly select a specific state. For
1701 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1702 you define many keywords, you can use in-buffer completion (see *Note
1703 Completion::) to insert these words into the buffer.
1706 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1708 5.3.2 TODO keywords as types
1709 ----------------------------
1711 The second possibility is to use TODO keywords to indicate different
1712 types of action items. For example, you might want to indicate that
1713 items are for "work" or "home". If you are into David Allen's _Getting
1714 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1715 `MAYBE'. Or, when you work with several people on a single project,
1716 you might want to assign action items directly to persons, by using
1717 their names as TODO keywords. This would be set up like this:
1719 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1720 org-todo-interpretation 'type)
1722 In this case, different keywords do not indicate a sequence, but
1723 rather different types. So it is normally not useful to change from
1724 one type to another. Therefore, in this case the behavior of the
1725 command `C-c C-t' is changed slightly(1). When used several times in
1726 succession, it will still cycle through all names. But when you return
1727 to the item after some time and execute `C-c C-t' again, it will switch
1728 from each name directly to DONE. Use prefix arguments or completion to
1729 quickly select a specific name. You can also review the items of a
1730 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1731 C-v'. For example, to see all things Lucy has to do, you would use
1732 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1733 single buffer, you would use the prefix arg as well when creating the
1734 global todo list: `C-3 C-c t'.
1736 ---------- Footnotes ----------
1738 (1) This is also true for the `t' command in the timeline and agenda
1742 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1744 5.3.3 Setting up TODO keywords for individual files
1745 ---------------------------------------------------
1747 It can be very useful to use different aspects of the TODO mechanism in
1748 different files, which is not possible with the global settings
1749 described above. For file-local settings, you need to add special
1750 lines to the file which set the keywords and interpretation for that
1751 file only. For example, to set one of the two examples discussed
1752 above, you need one of the following lines, starting in column zero
1753 anywhere in the file:
1755 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1756 #+TYP_TODO: Fred Sara Lucy Mike DONE
1758 To make sure you are using the correct keyword, type `#+' into the
1759 buffer and then use `M-<TAB>' completion.
1761 Remember that the last keyword must always mean that the item is DONE
1762 (you may use a different word, though). Also note that in each file,
1763 only one of the two aspects of TODO keywords can be used. After
1764 changing one of these lines, use `C-c C-c' with the cursor still in the
1765 line to make the changes known to Org-mode(1).
1767 If you want to use very many keywords, for example when working with
1768 a large group of people, you may split the names over several lines:
1770 #+TYP_TODO: Fred Sara Lucy Mike
1771 #+TYP_TODO: Luis George Jules Jessica
1772 #+TYP_TODO: Kim Arnold Peter
1775 ---------- Footnotes ----------
1777 (1) Org-mode parses these lines only when Org-mode is activated
1778 after visiting a file. `C-c C-c' with the cursor in a line starting
1779 with `#+' is simply restarting Org-mode, making sure that these changes
1783 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1788 If you use Org-mode extensively to organize your work, you may end up
1789 with a number of TODO entries so large that you'd like to prioritize
1790 them. This can be done by placing a _priority cookie_ into the
1793 *** TODO [#A] Write letter to Sam Fortune
1795 With its standard setup, Org-mode supports priorities `A', `B', and
1796 `C'. `A' is the highest priority. An entry without a cookie is
1797 treated as priority `B'. Priorities make a difference only in the
1798 agenda (*note Weekly/Daily Agenda::).
1801 Set the priority of the current item. The command prompts for a
1802 priority character `A', `B' or `C'. When you press <SPC> instead,
1803 the priority cookie is removed from the headline. The priorities
1804 can also be changed "remotely" from the timeline and agenda buffer
1805 with the `,' command (*note Agenda commands::).
1809 Increase/decrease priority of current item. Note that these keys
1810 are also used to modify time stamps (*note Creating timestamps::).
1811 Furthermore, these keys are also used by CUA-mode (*note
1815 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1820 Items can be labeled with timestamps to make them useful for project
1825 * Time stamps:: Assigning a time to a tree entry
1826 * Creating timestamps:: Commands which insert timestamps
1829 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1831 6.1 Time stamps, deadlines and scheduling
1832 =========================================
1834 A time stamp is a specification of a date (possibly with time) in a
1835 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1836 A time stamp can appear anywhere in the headline or body of an org-tree
1837 entry. Its presence allows entries to be shown on specific dates in
1838 the agenda (*note Weekly/Daily Agenda::). We distinguish:
1841 A simple time stamp just assigns a date/time to an item. In the
1842 timeline and agenda displays, the headline of the entry will be
1843 shown exactly on that date.
1846 Two time stamps connected by `--' denote a time range. The
1847 headline will be shown on the first and last day of the range, and
1848 on any dates that are displayed and fall in the range. Here is an
1851 ** Meeting in Amsterdam
1852 <2004-08-23 Mon>--<2004-08-26 Thu>
1855 If a time stamp is preceded by the word `DEADLINE:', the task
1856 (most likely a TODO item) is supposed to be finished on that date,
1857 and it will be listed then. In addition, the compilation for
1858 _today_ will carry a warning about the approaching or missed
1859 deadline, starting `org-deadline-warning-days' before the due
1860 date, and continuing until the entry is marked DONE. An example:
1862 *** TODO write article about the Earth for the Guide
1863 The editor in charge is <bbdb:Ford Prefect>
1864 DEADLINE: <2004-02-29 Sun>
1867 If a time stamp is preceded by the word `SCHEDULED:', it means you
1868 are planning to start working on that task on the given date. The
1869 headline will be listed under the given date. In addition, a
1870 reminder that the scheduled date has passed will be present in the
1871 compilation for _today_, until the entry is marked DONE. I.e., the
1872 task will automatically be forwarded.
1875 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1877 6.2 Creating timestamps
1878 =======================
1880 For Org-mode to recognize time stamps, they need to be in the specific
1881 format. All commands listed below produce time stamps in the correct
1885 Prompt for a date and insert a corresponding time stamp. When the
1886 cursor is at a previously used time stamp, it is updated to NOW.
1887 When this command is used twice in succession, a time range is
1891 Like `C-c .', but use the alternative format which contains date
1892 and time. The default time can be rounded to multiples of 5
1893 minutes, see the option `org-time-stamp-rounding-minutes'.
1896 Like `C-c .', but insert an inactive time stamp not triggering the
1900 Insert a time stamp corresponding to the cursor date in the
1904 Access the Emacs calendar for the current date. If there is a
1905 timestamp in the current line, goto the corresponding date instead.
1908 Access the agenda for the date given by the time stamp at point
1909 (*note Weekly/Daily Agenda::).
1912 Insert `DEADLINE' keyword along with a stamp.
1915 Create a sparse tree with all deadlines that are either past-due,
1916 or which will become due within `org-deadline-warning-days'. With
1917 `C-u' prefix, show all deadlines in the file. With a numeric
1918 prefix, check that many days. For example, `C-1 C-c C-w' shows
1919 all deadlines due tomorrow.
1922 Insert `SCHEDULED' keyword along with a stamp.
1926 Change date at cursor by one day. These key bindings conflict with
1927 CUA-mode (*note Interaction::).
1931 Change the item under the cursor in a timestamp. The cursor can
1932 be on a year, month, day, hour or minute. Note that if the cursor
1933 is not at a time stamp, these same keys modify the priority of an
1934 item. (*note Priorities::). The key bindings also conflict with
1935 CUA-mode (*note Interaction::).
1938 Evaluate a time range by computing the difference between start and
1939 end. With prefix arg, insert result after the time range (in a
1940 table: into the following column).
1942 When Org-mode prompts for a date/time, the function reading your
1943 input will replace anything you choose not to specify with the current
1944 date and time. For details, see the documentation string of
1945 `org-read-date'. Also, a calender will pop up to allow selecting a
1946 date. The calendar can be fully controlled from the minibuffer, and a
1947 date can be selected with the following commands:
1950 Scroll calendar backwards by one month.
1953 Scroll calendar forwards by one month.
1956 Select date by clicking on it.
1977 Choose date in calendar (only if nothing typed into minibuffer).
1980 File: org, Node: Tags, Next: Agenda Views, Prev: Timestamps, Up: Top
1985 If you wish to implement a system to cross-correlate information, an
1986 excellent way is to assign tags to headline. Org-mode has extensive
1987 support for using tags.
1989 Every headline can contain a list of tags, at the end of the
1990 headline. Tags are normal words containing letters, numbers, `_', and
1991 `@'. Tags must be preceded and followed by a single colon; like
1992 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
1996 * Tag inheritance:: Tags use the tree structure of the outline
1997 * Setting tags:: How to assign tags to a headline
1998 * Tag searches:: Searching for combinations of tags
2001 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2006 Tags make use of the hierarchical structure of outline trees. If a
2007 heading has a certain tag, all subheadings will inherit the tag as
2008 well. For example, in the list
2010 * Meeting with the French group :WORK:
2011 ** Summary by Frank :BOSS:NOTES:
2012 *** TODO Prepare slides for him :ACTION:
2014 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2015 `:ACTION:'. When executing tag searches and Org-mode finds that a
2016 certain headline matches the search criterion, it will not check any
2017 sublevel headline, assuming that these likely also match, and that the
2018 list of matches can become very long. However, this may not be what
2019 you want, and you can influence inheritance and searching using the
2020 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2023 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2028 As Org-mode deals with plain text files, tags can simply be typed into
2029 the buffer. After a colon, `M-<TAB>' offers completion on all tags
2030 being used in the current buffer. There is also a special command for
2034 Enter new tags for the current headline. The minibuffer will
2035 prompt for a list of tags and offer completion with respect to all
2036 other tags used in the current buffer. Several tags, separated by
2037 colons, may be specified at the prompt. After pressing <RET>, the
2038 tags will be inserted and aligned to `org-tags-column'. When
2039 called with a `C-u' prefix, all tags in the current buffer will be
2040 aligned to that column, just to make things look nice. TAGS are
2041 automatically realigned after promotion, demotion, and TODO state
2042 changes (*note TODO basics::).
2045 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2050 Once a tags system has been set up, it can be used to collect related
2051 information into special lists.
2054 Create a sparse tree with all headlines matching a tags search.
2057 Create a global list of tag matches from all agenda files. *Note
2058 Matching headline tags::.
2061 Create a global list of tag matches from all agenda files, but
2062 check only TODO items and force checking subitems (see variable
2063 `org-tags-match-list-sublevels').
2065 A tags search string can use Boolean operators `&' for AND and `|'
2066 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2067 not implemented. A tag may also be preceded by `-', to select against
2068 it, and `+' is syntactic sugar for positive selection. The AND
2069 operator `&' is optional when `+' or `-' is present. For example,
2070 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2071 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2072 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2073 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2077 File: org, Node: Agenda Views, Next: Exporting, Prev: Tags, Up: Top
2082 Due to the way Org-mode works, TODO items, time-stamped items, and
2083 tagged headlines can be scattered throughout a file or even a number of
2084 files. To get an overview over open action items, or over events that
2085 are important for a particular date, this information must be collected,
2086 sorted and displayed in an organized way.
2088 Org-mode can select items based on various criteria, and display them
2089 in a separate buffer. Three different views are provided:
2091 * an _agenda_ that is like a calendar and shows information for
2094 * a _TODO list_ that covers all unfinished action items, and
2096 * a _tags view_ that shows information based on the tags associated
2097 with headlines in the outline tree.
2099 The extracted information is displayed in a special _agenda buffer_.
2100 This buffer is read-only, but provides commands to visit the
2101 corresponding locations in the original Org-mode files, and even to
2102 edit these files remotely.
2106 * Agenda files:: Files being searched for agenda information
2107 * Agenda dispatcher:: Keyboard access to agenda views
2108 * Weekly/Daily Agenda:: The calendar page with current tasks
2109 * Global TODO list:: All unfinished action items
2110 * Matching headline tags:: Structured information with fine-tuned search
2111 * Timeline:: Time-sorted view for single file
2112 * Agenda commands:: Remote editing of org trees
2115 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda Views, Up: Agenda Views
2120 The information to be shown is collected from all _agenda files_, the
2121 files listed in the variable `org-agenda-files'(1). Thus even if you
2122 only work with a single Org-mode file, this file should be put into
2123 that list(2). You can customize `org-agenda-files', but the easiest
2124 way to maintain it is through the following commands
2127 Add current file to the list of agenda files. The file is added to
2128 the front of the list. If it was already in the list, it is moved
2129 to the front. With prefix arg, file is added/moved to the end.
2132 Remove current file from the list of agenda files.
2135 Cycle through agenda file list, visiting one file after the other.
2137 The Org menu contains the current list of files and can be used to
2140 ---------- Footnotes ----------
2142 (1) If the value of that variable is not a list, but a single file
2143 name, then the list of agenda files will be maintained in that external
2146 (2) When using the dispatcher pressing `1' before selecting a
2147 command will actually limit the command to the current file, and ignore
2148 `org-agenda-files' until the next dispatcher command.
2151 File: org, Node: Agenda dispatcher, Next: Weekly/Daily Agenda, Prev: Agenda files, Up: Agenda Views
2153 8.2 The agenda dispatcher
2154 =========================
2156 The views are created through a dispatcher that should be bound to a
2157 global key, for example `C-c a' (*note Installation and activation::).
2158 In the following we will assume that `C-c a' is indeed how the
2159 dispatcher is accessed and list keyboard access to commands
2160 accordingly. After pressing `C-c a', an additional letter is required
2161 to execute a command. The dispatcher offers the following default
2164 Create the calendar-like agenda (*note Weekly/Daily Agenda::).
2167 Create a list of all TODO items (*note Global TODO list::).
2170 Create a list of headlines matching a TAGS expression (*note
2171 Matching headline tags::).
2173 You can also define custom commands that will be accessible through
2174 the dispatcher, just like the default commands. Custom commands are
2175 global searches for tags and specific TODO keywords, or a variety of
2176 sparse tree creating commands (*note Sparse trees::). As sparse trees
2177 are only defined for a single org-mode file, these latter commands act
2178 on the current buffer instead of the list of agenda files.
2180 Custom commands are configured in the variable
2181 `org-agenda-custom-commands'. You can customize this variable, for
2182 example by pressing `C-c a C'. You can also directly set it with Emacs
2183 Lisp in `.emacs'. For example:
2185 (setq org-agenda-custom-commands
2186 '(("w" todo "WAITING")
2187 ("u" tags "+BOSS-URGENT")
2188 ("U" tags-tree "+BOSS-URGENT")
2189 ("f" occur-tree "\\<FIXME\\>")))
2191 will define `C-c a w' as a global search for TODO entries with
2192 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2193 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2194 search but only in the current buffer and display the result as a
2195 sparse tree, and `C-c a f' to create a sparse tree with all entries
2196 containing the word `FIXME'. For more information, look at the
2197 documentation string of the variable `org-agenda-custom-commands'.
2200 File: org, Node: Weekly/Daily Agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda Views
2202 8.3 The weekly/daily agenda
2203 ===========================
2205 The purpose of the weekly/daily _agenda_ is to act like a page of a
2206 paper agenda, showing all the tasks for the current week or day.
2209 Compile an agenda for the current week from a list of org files.
2210 The agenda shows the entries for each day. With a `C-u' prefix (or
2211 when the variable `org-agenda-include-all-todo' is `t'), all
2212 unfinished TODO items (including those without a date) are also
2213 listed at the beginning of the buffer, before the first date.
2215 Remote editing from the agenda buffer means, for example, that you
2216 can change the dates of deadlines and appointments from the agenda
2217 buffer. The commands available in the Agenda buffer are listed in
2218 *Note Agenda commands::.
2222 * Categories:: Not all tasks are equal
2223 * Time-of-day specifications:: How the agenda knows the time
2224 * Calendar/Diary integration:: Integrating Anniversaries and more
2225 * Sorting of agenda items:: The order of things
2228 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily Agenda, Up: Weekly/Daily Agenda
2233 In the agenda buffer, each entry is preceded by a _category_, which is
2234 derived from the file name. The category can also be set with a
2235 special line anywhere in the buffer, looking like this:
2239 If there are several such lines in a file, each specifies the
2240 category for the text below it (but the first category also applies to
2241 any text before the first CATEGORY line). The display in the agenda
2242 buffer looks best if the category is not longer than 10 characters.
2245 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily Agenda
2247 8.3.2 Time-of-Day Specifications
2248 --------------------------------
2250 Org-mode checks each agenda item for a time-of-day specification. The
2251 time can be part of the time stamp that triggered inclusion into the
2252 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2253 specified with two time stamps, like
2254 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2256 In the headline of the entry itself, a time(range) may also appear as
2257 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2258 Emacs diary (*note Calendar/Diary integration::), time specifications
2259 in diary entries are recognized as well.
2261 For agenda display, Org-mode extracts the time and displays it in a
2262 standard 24 hour format as part of the prefix. The example times in
2263 the previous paragraphs would end up in the agenda like this:
2265 8:30-13:00 Arthur Dent lies in front of the bulldozer
2266 12:45...... Ford Prefect arrives and takes Arthur to the pub
2267 19:00...... The Vogon reads his poem
2268 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2270 If the agenda is in single-day mode, or for the display of today, the
2271 timed entries are embedded in a time grid, like
2273 8:00...... ------------------
2274 8:30-13:00 Arthur Dent lies in front of the bulldozer
2275 10:00...... ------------------
2276 12:00...... ------------------
2277 12:45...... Ford Prefect arrives and takes Arthur to the pub
2278 14:00...... ------------------
2279 16:00...... ------------------
2280 18:00...... ------------------
2281 19:00...... The Vogon reads his poem
2282 20:00...... ------------------
2283 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2285 The time grid can be turned on and off with the variable
2286 `org-agenda-use-time-grid', and can be configured with
2287 `org-agenda-time-grid'.
2290 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily Agenda
2292 8.3.3 Calendar/Diary integration
2293 --------------------------------
2295 Emacs contains the calendar and diary by Edward M. Reingold. The
2296 calendar displays a three-month calendar with holidays from different
2297 countries and cultures. The diary allows you to keep track of
2298 anniversaries, lunar phases, sunrise/set, recurrent appointments
2299 (weekly, monthly) and more. In this way, it is quite complementary to
2300 Org-mode. It can be very useful to combine output from Org-mode with
2303 In order to include entries from the Emacs diary into Org-mode's
2304 agenda, you only need to customize the variable
2306 (setq org-agenda-include-diary t)
2308 After that, everything will happen automatically. All diary entries
2309 including holidays, anniversaries etc will be included in the agenda
2310 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2311 the agenda buffer to jump to the diary file in order to edit existing
2312 diary entries. The `i' command to insert new entries for the current
2313 date works in the agenda buffer, as well as the commands `S', `M', and
2314 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2315 to other calendars, respectively. `c' can be used to switch back and
2316 forth between calendar and agenda.
2319 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily Agenda
2321 8.3.4 Sorting of agenda items
2322 -----------------------------
2324 The entries for each day are sorted. The default order is to first
2325 collect all items containing an explicit time-of-day specification.
2326 These entries will be shown at the beginning of the list, as a
2327 _schedule_ for the day. After that, items remain grouped in
2328 categories, in the sequence given by `org-agenda-files'. Within each
2329 category, items are sorted by priority (*note Priorities::).
2331 The priority is a numerical quantity composed of the base priority
2332 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2333 increments for overdue scheduled or deadline items.
2335 Sorting can be customized using the variable
2336 `org-agenda-sorting-strategy'.
2339 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily Agenda, Up: Agenda Views
2341 8.4 The global TODO list
2342 ========================
2344 The global TODO list contains all unfinished TODO items, formatted and
2345 collected into a single place.
2348 Show the global TODO list. This collects the TODO items from all
2349 agenda files (*note Agenda Views::) into a single buffer. The
2350 buffer is in `agenda-mode', so there are commands to examine and
2351 manipulate the TODO entries directly from that buffer (*note
2352 Agenda commands::). *Note Global TODO list::, for more
2356 Like the above, but allows selection of a specific TODO keyword.
2357 You can also do this by specifying a prefix argument to `C-c a t'.
2358 With a `C-u' prefix you are prompted for a keyword. With a
2359 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2360 `r' key in the agenda buffer regenerates it, and you can give a
2361 prefix argument to this command to change the selected TODO
2362 keyword, for example `3 r'. If you often need a search for a
2363 specific keyword, define a custom command for it (*note Agenda
2366 Remote editing of TODO items means that you can change the state of a
2367 TODO entry with a single key press. The commands available in the TODO
2368 list are described in *Note Agenda commands::.
2371 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda Views
2373 8.5 Matching headline tags
2374 ==========================
2376 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2377 you can select headlines based on the tags that apply to them and
2378 collect them into an agenda buffer.
2381 Produce a list of all headlines that match a given set of tags.
2382 The command prompts for a selection criterion, which is a boolean
2383 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2384 `WORK|HOME' (*note Tags::). If you often need a specific search,
2385 define a custom command for it (*note Agenda dispatcher::).
2388 Like `C-c a m', but only select headlines that are also TODO items
2389 and force checking subitems (see variable
2390 `org-tags-match-list-sublevels'.
2392 The commands available in the tags list are described in *Note
2396 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda Views
2398 8.6 Timeline for a single file
2399 ==============================
2401 The timeline is not really an agenda view, because it only summarizes
2402 items from a single Org-mode file. But it also uses the agenda buffer
2403 and provides similar commands, so we discuss it here. The timeline
2404 shows all time-stamped items in a single Org-mode file (or the selected
2405 part of it), in a _time-sorted view_. The main purpose of this command
2406 is to give an overview over events in a project.
2409 Show a time-sorted view of the org file, with all time-stamped
2410 items. When called with a `C-u' prefix, all unfinished TODO
2411 entries (scheduled or not) are also listed under the current date.
2413 The commands available in the timeline buffer are listed in *Note
2417 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda Views
2419 8.7 Commands in the agenda buffer
2420 =================================
2422 Entries in the agenda buffer are linked back to the org file or diary
2423 file where they originate. You are not allowed to edit the agenda
2424 buffer itself, but commands are provided to show and jump to the
2425 original entry location, and to edit the org-files "remotely" from the
2426 agenda buffer. In this way, all information is stored only once,
2427 removing the risk that your agenda and note files may diverge.
2429 Some commands can be executed with mouse clicks on agenda lines. For
2430 the other commands, the cursor needs to be in the desired line.
2436 Next line (same as <up>).
2439 Previous line (same as <down>).
2446 Display the original location of the item in another window.
2449 Display original location and recenter that window.
2454 Go to the original location of the item in another window. Under
2455 Emacs 22, `mouse-1' will also works for this.
2458 Go to the original location of the item and delete other windows.
2461 Toggle Follow mode. In Follow mode, as you move the cursor through
2462 the agenda buffer, the other window always shows the corresponding
2463 location in the org file.
2466 Toggle Logbook mode. In Logbook mode, entries that where marked
2467 DONE while logging was on (variable `org-log-done') are shown in
2474 Delete other windows.
2477 Switch to weekly view (7 days displayed together).
2480 Switch to daily view (just one day displayed).
2483 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2487 Toggle the time grid on and off. See also the variables
2488 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2491 Recreate the agenda buffer, for example to reflect the changes
2492 after modification of the time stamps of items with S-<left> and
2493 S-<right>. When the buffer is the global todo list, a prefix
2494 argument is interpreted to create a selective list for a specific
2498 Display the following `org-agenda-ndays' days. For example, if
2499 the display covers a week, switch to the following week. With
2500 prefix arg, go forward that many times `org-agenda-ndays' days.
2503 Display the previous dates.
2515 Change the TODO state of the item, both in the agenda and in the
2519 Show all tags associated with the current item. Because of
2520 inheritance, this may be more than the tags listed in the line
2524 Set tags for the current headline.
2527 Set the priority for the current item. Org-mode prompts for the
2528 priority character. If you reply with <SPC>, the priority cookie
2529 is removed from the entry.
2532 Display weighted priority of current item.
2536 Increase the priority of the current item. The priority is
2537 changed in the original buffer, but the agenda is not resorted.
2538 Use the `r' key for this.
2542 Decrease the priority of the current item.
2545 Change the time stamp associated with the current line by one day
2546 into the future. With prefix argument, change it by that many
2547 days. For example, `3 6 5 S-<right>' will change it by a year.
2548 The stamp is changed in the original org file, but the change is
2549 not directly reflected in the agenda buffer. Use the `r' key to
2553 Change the time stamp associated with the current line by one day
2557 Change the time stamp associated with the current line to today.
2558 The key `>' has been chosen, because it is the same as `S-.' on my
2562 Insert a new entry into the diary. Prompts for the type of entry
2563 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2564 new entry in the diary, just like `i d' etc. would do in the
2565 calendar. The date is taken from the cursor position.
2571 Open the Emacs calendar and move to the date at the agenda cursor.
2574 When in the calendar, compute and show the Org-mode agenda for the
2578 Show the phases of the moon for the three months around current
2582 Show sunrise and sunset times. The geographical location must be
2583 set with calendar variables, see documentation of the Emacs
2587 Convert the date at cursor into many other cultural and historic
2591 Show holidays for three month around the cursor date.
2594 Export a single iCalendar file containing entries from all agenda
2601 Quit agenda, remove the agenda buffer.
2604 Exit agenda, remove the agenda buffer and all buffers loaded by
2605 Emacs for the compilation of the agenda. Buffers created by the
2606 user to visit org files will not be removed.
2610 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda Views, Up: Top
2615 Org-mode documents can be exported into a variety of other formats. For
2616 printing and sharing of notes, ASCII export produces a readable and
2617 simple version of an Org-mode file. HTML export allows to publish a
2618 notes file on the web, while the XML format provides a solid base for
2619 exchange with a broad range of other applications. To incorporate
2620 entries with associated times like deadlines or appointments into a
2621 desktop calendar program like iCal, Org-mode can also produce extracts
2622 in the iCalendar format. Currently Org-mode only supports export, not
2623 import of these different formats.
2625 When exporting, Org-mode uses special conventions to enrich the
2626 output produced. *Note Text interpretation::, for more details.
2630 * ASCII export:: Exporting to plain ASCII
2631 * HTML export:: Exporting to HTML
2632 * XML export:: Exporting to XML
2633 * iCalendar export:: Exporting in iCalendar format
2634 * Text interpretation:: How the exporter looks at the file
2637 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2642 ASCII export produces an simple and very readable version of an Org-mode
2646 Export as ASCII file. If there is an active region, only the
2647 region will be exported. For an org file `myfile.org', the ASCII
2648 file will be `myfile.txt'. The file will be overwritten without
2651 In the exported version, the first 3 outline levels will become
2652 headlines, defining a general document structure. Additional levels
2653 will be exported as itemized lists. If you want that transition to
2654 occur at a different level, specify it with a prefix argument. For
2657 C-1 C-c C-x a org-export-as-ascii
2659 creates only top level headlines and does the rest as items.
2662 File: org, Node: HTML export, Next: XML export, Prev: ASCII export, Up: Exporting
2667 Org-mode contains an HTML exporter with extensive HTML formatting, in
2668 ways similar to John Grubers _markdown_ language, but with additional
2672 Export as HTML file `myfile.html'.
2675 Export as HTML file and open it with a browser.
2677 In the exported version, the first 3 outline levels will become
2678 headlines, defining a general document structure. Additional levels
2679 will be exported as itemized lists. If you want that transition to
2680 occur at a different level, specify it with a prefix argument. For
2685 creates two levels of headings and does the rest as items.
2687 If you want to include HTML tags which should be interpreted as such,
2688 mark them with a `@' like in `@<b>bold text@</b>'. Plain `<' and `>'
2689 are always transformed to `<' and `>' in HTML export.
2691 You can also give style information for the exported file. The
2692 default specification can be configured through the option
2693 `org-export-html-style'. If you want to use a file-local style, you
2694 may use file variables, best wrapped into a COMMENT section at the end
2695 of the outline tree. For example:
2697 * COMMENT HTML style specifications
2700 # org-export-html-style: " <style type=\"text/css\">
2701 p {font-weight: normal; color: gray; }
2706 Remember to execute `M-x normal-mode' after changing this to make
2707 the new style visible to Emacs. This command restarts org-mode for the
2708 current buffer and forces Emacs to re-evaluate the local variables
2709 section in the buffer.
2712 File: org, Node: XML export, Next: iCalendar export, Prev: HTML export, Up: Exporting
2717 Org-mode contains an XML exporter that produces XOXO-style XML.
2718 Currently, this exporter only handles the general outline structure and
2719 does not interpret any additional Org-mode features.
2722 Export as XML file `myfile.xml'.
2725 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XML export, Up: Exporting
2727 9.4 iCalendar export
2728 ====================
2730 Some people like to use Org-mode for keeping track of projects, but
2731 still prefer a standard calendar application for anniversaries and
2732 appointments. In this case it can be useful to have deadlines and
2733 other time-stamped items in Org-mode files show up in the calendar
2734 application. Org-mode can export calendar information in the standard
2738 Create iCalendar entries for the current file and store them in
2739 the same directory, using a file extension `.ics'.
2742 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2743 For each of these files, a separate iCalendar file will be
2747 Create a single large iCalendar file from all files in
2748 `org-agenda-files' and write it to the file given by
2749 `org-combined-agenda-icalendar-file'.
2751 How this calendar is best read and updated, depends on the
2752 application you are using. For example, when using iCal under Apple
2753 MacOS X, you could create a new calendar `OrgMode' (the default name
2754 for the calendar created by `C-c C-x c', see the variables
2755 `org-icalendar-combined-name' and
2756 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2757 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2758 use AppleScript to make iCal re-read the calendar files each time a new
2759 version of `OrgMode.ics' is produced. Here is the setup needed for
2762 (setq org-combined-agenda-icalendar-file
2763 "~/Library/Calendars/OrgMode.ics")
2764 (add-hook 'org-after-save-iCalendar-file-hook
2767 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2770 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
2772 9.5 Text interpretation by the exporter
2773 =======================================
2775 The exporter backends interpret additional structure in the Org-mode
2776 file in order to produce better output.
2780 * Comment lines:: Some lines will not be exported
2781 * Enhancing text:: Subscripts, symbols and more
2782 * Export options:: How to influence the export settings
2785 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
2790 Lines starting with `#' in column zero are treated as comments and will
2791 never be exported. Also entire subtrees starting with the word
2792 `COMMENT' will never be exported. Finally, any text before the first
2793 headline will not be exported either.
2796 Toggle the COMMENT keyword at the beginning of an entry.
2799 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
2801 9.5.2 Enhancing text for export
2802 -------------------------------
2804 Some of the export backends of Org-mode allow for sophisticated text
2805 formatting, this is true in particular for the HTML backend. Org-mode
2806 has a number of typing conventions that allow to produce a richly
2809 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
2810 enumerator will be recognized and transformed if the backend
2811 supports lists. See *Note Plain Lists::.
2813 * You can make words *bold*, /italic/, and _underlined_
2815 * Simple TeX-like math constructs are interpreted:
2817 - `10^22' and `J_n' are super- and subscripts. You can quote
2818 `^' and `_' with a backslash: `\_' and `\^'
2820 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2821 use completion for these macros, just type `\' and maybe a few
2822 letters, and press `M-<TAB>' to see possible completions.
2824 * Tables are transformed into native tables under the exporter, if
2825 the export backend supports this. Data fields before the first
2826 horizontal separator line will be formatted as table header fields.
2828 * If a headline starts with the word `QUOTE', the text below the
2829 headline will be typeset as fixed-width, to allow quoting of
2830 computer codes etc. Lines starting with `:' are also typeset in
2833 Toggle fixed-width for entry (QUOTE) or region, see below.
2835 If these conversions conflict with your habits of typing ASCII text,
2836 they can all be turned off with corresponding variables (see the
2837 customization group `org-export-general', and the following section
2838 which explains how to set export options with special lines in a buffer.
2841 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
2843 9.5.3 Export options
2844 --------------------
2846 The exporter recognizes special lines in the buffer which provide
2847 additional information. These lines may be put anywhere in the file.
2848 The whole set of lines can be inserted into the buffer with `C-c C-x
2849 t'. For individual lines, a good way to make sure the keyword is
2850 correct is to type `#+' and then use `M-<TAB>' completion (*note
2854 Insert template with export options, see example below.
2856 #+TITLE: the title to be shown (default is the buffer name)
2857 #+AUTHOR: the author (default taken from `user-full-name')
2858 #+EMAIL: his/her email address (default from `user-mail-address')
2859 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2860 #+TEXT: Some descriptive text to be inserted at the beginning.
2861 #+TEXT: Several lines may be given.
2862 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2864 The OPTIONS line is a compact form to specify export settings. Here
2866 H: set the number of headline levels for export
2867 num: turn on/off section-numbers
2868 toc: turn on/off table of contents
2869 \n: turn on/off linebreak-preservation
2870 @: turn on/off quoted html tags
2871 :: turn on/off fixed-width sections
2872 |: turn on/off tables
2873 ^: turn on/off TeX-like syntax for sub- and superscripts.
2874 *: turn on/off emphasized text (bold, italic, underlined)
2875 TeX: turn on/off TeX macros
2878 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2885 * Completion:: M-TAB knows what you need
2886 * Customization:: Adapting Org-mode to your taste
2887 * Summary of in-buffer settings:: Using special lines to set options
2888 * The very busy C-c C-c key:: When in doubt, press C-c C-c
2889 * Clean view:: Getting rid of leading stars in the outline
2890 * TTY keys:: Using Org-mode on a tty
2891 * FAQ:: Frequently asked questions
2892 * Interaction:: Other Emacs packages
2893 * Bugs:: Things which do not work perfectly
2894 * Acknowledgments:: These people provided feedback and more
2897 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2902 Org-mode supports in-buffer completion. This type of completion does
2903 not make use of the minibuffer. You simply type a few letters into the
2904 buffer and use the key to complete text right there.
2907 Complete word at point
2908 * At the beginning of a headline, complete TODO keywords.
2910 * After `\', complete TeX symbols supported by the exporter.
2912 * After `*', complete CamelCase versions of all headlines in the
2915 * After `:', complete tags used elsewhere in the buffer.
2917 * After `#+', complete the special keywords like `TYP_TODO' or
2918 `OPTIONS' which set file-specific options for Org-mode. When
2919 the option keyword is already complete, pressing `M-<TAB>'
2920 again will insert example settings for this keyword.
2922 * Elsewhere, complete dictionary words using ispell.
2925 File: org, Node: Customization, Next: Summary of in-buffer settings, Prev: Completion, Up: Miscellaneous
2930 There are more than 100 variables that can be used to customize
2931 Org-mode. For the sake of compactness of the manual, we are not
2932 describing the variables here. A structured overview of customization
2933 variables is available with `M-x org-customize'. Or select `Browse Org
2934 Group' from the `Org->Customization' menu. Many settings can also be
2935 activated on a per-file basis, by putting special lines into the buffer
2936 (*note Summary of in-buffer settings::).
2939 File: org, Node: Summary of in-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
2941 10.3 Summary of in-buffer settings
2942 ==================================
2944 Org-mode uses special lines in the buffer to define settings on a
2945 per-file basis. These lines start with a `#+' followed by a keyword, a
2946 colon, and then individual words defining a setting. Several settings
2947 words con be in the same line, but you can also have multiple lines for
2948 the keyword. While these settings are described throughout the manual,
2949 here is a summary. After changing any of those lines in the buffer,
2950 press `C-c C-c' with the cursor still in the line to activate the
2951 changes immediately. Otherwise they become effective only when the
2952 file is visited again in a new Emacs session.
2955 This line sets options to be used at startup of org-mode, when an
2956 Org-mode file is being visited. The first set of options deals
2957 with the initial visibility of the outline tree. The
2958 corresponding variable for global default settings is
2959 `org-startup-folded', with a default value `t', which means
2961 overview top-level headlines only
2962 content all headlines
2963 showall no folding at all, show everything
2964 Then there are options for aligning tables upon visiting a file.
2965 This is useful in files containing narrowed table columns. The
2966 corresponding variable is `org-startup-align-all-tables', with a
2967 default value `nil'.
2968 align align all tables
2969 noalign don't align table on startup
2970 Here are the options for hiding leading stars in outline headings.
2971 The corresponding variables are `org-hide-leading-stars' and
2972 `org-odd-levels-only', both with a default setting `nil' (meaning
2973 `showstars' and `oddeven').
2974 hidestars make all but one of the stars starting a headline invisible.
2975 showstars show all stars starting a headline
2976 odd allow only odd outline levels (1,3,...)
2977 oddeven allow all outline levels
2979 `#+SEQ_TODO: #+TYP_TODO:'
2980 These lines that the TODO keywords and their interpretation in the
2981 current file. The corresponding variables are `org-todo-keywords'
2982 and `org-todo-interpretation'.
2985 This line sets the category for the agenda file. The category
2986 applies for all subsequent lines until the next `#+CATEGORY' line,
2987 or the end of the file.
2990 This line contains the formulas for the table directly above the
2993 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
2994 These line provide setting for exporting files. For more details
2995 see *Note Export options::.
2998 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: Summary of in-buffer settings, Up: Miscellaneous
3000 10.4 The very busy C-c C-c key
3001 ==============================
3003 The key `C-c C-c' has many purposes in org-mode, which are all
3004 mentioned scattered throughout this manual. One specific function of
3005 this key is to add _tags_ to a headline (*note Tags::). In many other
3006 circumstances it means something like _Hey Org-mode, look here and
3007 update according to what you see here_. Here is a summary what this
3008 means in different contexts.
3010 - If the cursor is in one of the special #+KEYWORD lines, this
3011 triggers scanning the buffer for these lines and updating the
3014 - If the cursor is inside a table, realign the table. This command
3015 works even if the automatic table editor has been turned off.
3017 - If the cursor is on a #+TBLFM line, re-apply the formulas to the
3020 - If the cursor is inside a table created by the `table.el' package,
3021 activate that table.
3023 - If the current buffer is a remember buffer, close note and file it.
3024 with a prefix argument, file it without further interaction to the
3027 - If the cursor is on a <<<target>>>, update radio targets and
3028 corresponding links in this buffer.
3030 - If the cursor is on a numbered item in a plain list, renumber the
3034 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
3036 10.5 A cleaner outline view
3037 ===========================
3039 Some people find it noisy and distracting that the Org-mode headlines
3040 are starting with a potentially large number of stars. For example the
3041 tree from *Note Headlines:::
3043 * Top level headline
3049 * Another top level headline
3051 Unfortunately this is deeply ingrained into the code of Org-mode and
3052 cannot be easily changed. You can, however, modify the display in such
3053 a way that all leading stars become invisible and the outline more easy
3054 to read. To do this, customize the variable `org-hide-leading-stars'
3057 (setq org-hide-leading-stars t)
3059 or change this on a per-file basis with one of the lines (anywhere in
3062 #+STARTUP: showstars
3063 #+STARTUP: hidestars
3065 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
3068 With stars hidden, the tree becomes:
3070 * Top level headline
3076 * Another top level headline
3078 Note that the leading stars are not truly replaced by whitespace, they
3079 are only fontified with the face `org-hide' that uses the background
3080 color as font color. If are are not using either white or black
3081 background, you may have to customize this face to get the wanted
3082 effect. Another possibility is to set this font such that the extra
3083 stars are almost invisible, for example using the color `grey90' on a
3086 Things become cleaner still if you skip all the even levels and use
3087 only odd levels 1, 3, 5..., effectively adding two stars to go from one
3088 outline level to the next:
3090 * Top level headline
3096 * Another top level headline
3098 In order to make the structure editing and export commands handle this
3099 convention correctly, use
3101 (setq org-odd-levels-only t)
3103 or set this on a per-file basis with one of the following lines (don't
3104 forget to press `C-c C-c' with the cursor in the startup line to
3105 activate changes immediately).
3110 You can convert an Org-mode file from single-star-per-level to the
3111 double-star-per-level convention with `M-x org-convert-to-odd-levels
3112 RET' in that file. The reverse operation is `M-x
3113 org-convert-to-oddeven-levels'.
3116 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
3118 10.6 Using org-mode on a tty
3119 ============================
3121 Org-mode uses a number of keys that are not accessible on a tty. This
3122 applies to most special keys like cursor keys, <TAB> and <RET>, when
3123 these are combined with modifier keys like <Meta> and/or <Shift>.
3124 Org-mode uses these bindings because it needs to provide keys for a
3125 large number of commands, and because these keys appeared particularly
3126 easy to remember. In order to still be able to access the core
3127 functionality of Org-mode on a tty, alternative bindings are provided.
3128 Here is a complete list of these bindings, which are obviously more
3129 cumbersome to use. Note that sometimes a work-around can be better.
3130 For example changing a time stamp is really only fun with `S-<cursor>'
3131 keys. On a tty you would rather use `C-c .' to re-insert the
3134 Default Alternative 1 Alternative 2
3135 `S-<TAB>' `C-u <TAB>'
3136 `M-<left>' `C-c C-x l' `<Esc> <left>'
3137 `M-S-<left>'`C-c C-x L'
3138 `M-<right>' `C-c C-x r' `<Esc>
3140 `M-S-<right>'`C-c C-x R'
3141 `M-<up>' `C-c C-x u' `<Esc> <up>'
3142 `M-S-<up>' `C-c C-x U'
3143 `M-<down>' `C-c C-x d' `<Esc> <down>'
3144 `M-S-<down>'`C-c C-x D'
3145 `S-<RET>' `C-c C-x c'
3146 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3147 `M-S-<RET>' `C-c C-x M'
3150 `S-<right>' `C-c C-x
3158 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3160 10.7 Frequently asked questions
3161 ===============================
3163 1. Org-mode seems to be a useful default mode for the various
3164 `README' files I have scattered through my directories. How do I
3165 turn it on for all `README' files?
3166 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3168 2. Some of my links stopped working after I upgraded to a version
3169 4.20 or later. Why is this, and how can I fix it?
3170 These must be links in plain text, containing white space, such as
3171 `bbdb:Richard Stallman'. You need to protect these links by
3172 putting double brackets around them, like `[[bbdb:Richard
3175 3. I see that Org-mode now creates links using the double bracket
3176 convention that hides the link part and the brackets, only showing
3177 the description part. How can I convert my old links to this new
3179 Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3180 The replaces angular brackets with the link format.
3182 4. I don't care if you find the new bracket links great, I am
3183 attached to the old style using angular brackets and no hiding of
3184 the link text. Please give them back to me, don't tell me it is
3186 Would I let you down like that? If you must, you can do this
3188 (setq org-link-style 'plain
3189 org-link-format "<%s>")
3191 5. When I am executing shell links I always get a confirmation prompt
3192 and need to type `yes <RET>', thats 4 key presses! Can I get rid
3194 The confirmation is there to protect you from unwantingly execute
3195 potentially dangerous commands. For example, imagine a link
3196 `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
3197 command would look like `Google Search', but really it would remove
3198 your home directory. If you wish, you can make it easier to
3199 respond to the query by setting `org-confirm-shell-links' to
3200 `y-or-n-p'. Then a single `y' keypress will be enough to confirm
3201 shell links. It is also possible to turn off this check entirely,
3202 but I do not recommend to do this. Be warned.
3204 6. All these stars are driving me mad, I just find the Emacs outlines
3205 unreadable. Can't you just put white space and a single star as a
3206 starter for headlines?
3207 See *Note Clean view::.
3209 7. I would like to have two windows on the same Org-mode file, but
3210 with different outline visibility. Is that possible?
3211 In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3212 See the documentation on the command `make-indirect-buffer'. In
3213 XEmacs, this is currently not possible because of the different
3214 outline implementation.
3216 8. When I export my TODO list, every TODO item becomes a separate
3217 section. How do I enforce these items to be exported as an
3219 If you plan to use ASCII or HTML export, make sure things you want
3220 to be exported as item lists are level 4 at least, even if that
3221 does mean there is a level jump. For example:
3223 * Todays top priorities
3224 **** TODO write a letter to xyz
3225 **** TODO Finish the paper
3226 **** Pick up kids at the school
3228 Alternatively, if you need a specific value for the heading/item
3229 transition in a particular file, use the `+OPTIONS' line to
3230 configure the `H' switch.
3234 9. I would like to export only a subtree of my file to HTML. How?
3235 If you want to export a subtree, mark the subtree as region and
3236 then export. Marking can be done with `C-c @ C-x C-x', for
3239 10. Org-mode takes over the S-cursor keys. I also want to use
3240 CUA-mode, is there a way to fix this conflict?
3241 Yes, see *Note Interaction::.
3243 11. One of my table columns has started to fill up with `#ERROR'.
3245 Org-mode tried to compute the column from other fields using a
3246 formula stored in the `#+TBLFM:' line just below the table, and
3247 the evaluation of the formula fails. Fix the fields used in the
3248 formula, or fix the formula, or remove it!
3250 12. When I am in the last column of a table and just above a
3251 horizontal line in the table, pressing TAB creates a new table line
3252 before the horizontal line. How can I quickly move to the line
3253 below the horizontal line instead?
3254 Press <down> (to get on the separator line) and then <TAB>. Or
3255 configure the variable `org-table-tab-jumps-over-hlines'.
3257 13. How can I change the indentation of an entire table without fixing
3259 The indentation of a table is set by the first line. So just fix
3260 the indentation of the first line and realign with <TAB>.
3262 14. Is it possible to include entries from org-mode files into my
3264 Since the org-mode agenda is much more powerful and can contain the
3265 diary (*note Calendar/Diary integration::), you should think twice
3266 before deciding to do this. Integrating Org-mode information into
3267 the diary is, however, possible. The following steps are
3268 necessary: Autoload the function `org-diary' as shown above under
3269 *Note Installation and activation::. You also need to use _fancy
3270 diary display_ by setting in `.emacs':
3272 (add-hook 'diary-display-hook 'fancy-diary-display)
3274 Then include the following line into your `~/diary' file, in order
3275 to get the entries from all files listed in the variable
3279 You may also select specific files with
3281 &%%(org-diary) ~/path/to/some/org-file.org
3282 &%%(org-diary) ~/path/to/another/org-file.org
3284 If you now launch the calendar and press `d' to display a diary,
3285 the headlines of entries containing a timestamp, date range,
3286 schedule, or deadline referring to the selected date will be
3287 listed. Just like in Org-mode's agenda view, the diary for
3288 _today_ contains additional entries for overdue deadlines and
3289 scheduled items. See also the documentation of the `org-diary'
3290 function. Under XEmacs, it is not possible to jump back from the
3291 diary to the org, this works only in the agenda buffer.
3295 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3297 10.8 Interaction with other packages
3298 ====================================
3300 Org-mode can cooperate with the following packages:
3302 `org-mouse.el' by Piotr Zielinski
3303 This package implements extended mouse functionality for Org-mode.
3304 It allows you to cycle visibility and to edit the document
3305 structure with the mouse. Best of all, it provides a
3306 context-sensitive menu on <mouse-3> that changes depending on the
3307 context of a mouse-click. Use a search engine to find this
3310 `table.el' by Takaaki Ota
3311 Org mode cooperates with table.el, see *Note table.el::.
3312 `table.el' is part of Emacs 22.
3314 `calc.el' by Dave Gillespie
3315 Org-mode uses the calc package for implementing spreadsheet
3316 functionality in its tables (*note Table calculations::).
3317 Org-modes checks for the availability of calc by looking for the
3318 function `calc-eval' which should be autoloaded in your setup if
3319 calc has been installed properly. As of Emacs 22, calc is part of
3320 the Emacs distribution. Another possibility for interaction
3321 between the two packages is using calc for embedded calculations.
3322 *Note Embedded Mode: (calc)Embedded Mode.
3324 `constants.el' by Carsten Dominik
3325 In a table formula (*note Table calculations::), it is possible to
3326 use names for natural constants or units. Instead of defining
3327 your own constants in the variable `org-table-formula-constants',
3328 install the `constants' package which defines a large number of
3329 constants and units, and lets you use unit prefixes like `M' for
3330 `Mega' etc. You will need version 2.0 of this package, available
3331 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3332 the function `constants-get', which has to be autoloaded in your
3333 setup. See the installation instructions in the file
3336 `CUA.el' by Kim. F. Storm
3337 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3338 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3339 select and extend the region. If you want to use one of these
3340 packages along with Org-mode, configure the variable
3341 `org-CUA-compatible'. When set, Org-mode will move the following
3342 keybindings in org-mode files, and in the agenda buffer (but not
3343 during date selection).
3345 S-UP -> M-p S-DOWN -> M-n
3346 S-LEFT -> M-- S-RIGHT -> M-+
3349 Yes, these are unfortunately more difficult to remember. If you
3350 want to have other replacement keys, look at the variable
3351 `org-disputed-keys'.
3353 `remember.el' by John Wiegley
3354 Org mode cooperates with remember, see *Note Remember::.
3355 `Remember.el' is not part of Emacs, find it on the web.
3358 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3363 Here is a list of things that should work differently, but which I have
3364 found too hard to fix.
3366 * If a table field starts with a link, and if the corresponding table
3367 column is narrowed (*note Narrow columns::) to a width too small to
3368 display the link, the field would look entirely empty even though
3369 it is not. To prevent this, Org-mode throws an error. The
3370 work-around is to make the column wide enough to fit the link, or
3371 to add some text (at least 2 characters) before the link in the
3374 * Narrowing table columns does not work on XEmacs, because the
3375 `format' function does not transport text properties.
3377 * Text in an entry protected with the `QUOTE' keyword should not
3380 * When the application called by `C-c C-o' to open a file link fails
3381 (for example because the application does not exits or refuses to
3382 open the file), it does so silently. No error message is
3385 * Plain list items should be able to hold a TODO item.
3386 Unfortunately this has so many technical problems that I will only
3387 consider this change for the next major release (5.0).
3389 * The remote-editing commands in the agenda buffer cannot be undone
3390 with `undo' called from within the agenda buffer. But you can go
3391 to the corresponding buffer (using <TAB> or <RET> and execute
3394 * Recalculating a table line applies the formulas from left to right.
3395 If a formula uses _calculated_ fields further down the row,
3396 multiple recalculation may be needed to get all fields consistent.
3398 * You can only make a single word boldface or italic. To emphasize
3399 several words in a row, each must have the emphasize markers, like
3400 in `*three* *bold* *words*'.
3402 * The exporters work well, but could be made more efficient.
3405 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3407 10.10 Acknowledgments
3408 =====================
3410 Org-mode was written by Carsten Dominik, who still maintains it at the
3411 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3412 following people (in alphabetic order) have helped the development
3413 along with ideas, suggestions and patches. Many thanks to all of you,
3414 Org-mode would not be what it is without your input.
3416 * Thomas Baumann contributed the code for links to the MH-E email
3419 * Alex Bochannek provided a patch for rounding time stamps.
3421 * Charles Caves' suggestion sparked the implementation of templates
3424 * Pavel Chalmoviansky influenced the agenda treatment of items with
3427 * Sacha Chua suggested to copy some linking code from Planner.
3429 * Christian Egli converted the documentation into TeXInfo format,
3430 patched CSS formatting into the HTML exporter, and inspired the
3433 * Nic Ferrier contributed mailcap and XML support.
3435 * Kai Grossjohann pointed out key-binding conflicts caused by
3438 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3441 * Tim O'Callaghan suggested in-file links, search options for
3442 general file links, and TAGS.
3444 * Oliver Oppitz suggested multi-state TODO items.
3446 * Scott Otterson sparked the introduction of descriptive text for
3447 links, among other things.
3449 * Pete Phillips helped the development of the TAGS feature.
3451 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3454 * Kevin Rogers contributed code to access VM files on remote hosts.
3456 * Philip Rooke created the Org-mode reference card and provided lots
3459 * Christian Schlauer proposed angular brackets around links, among
3462 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3463 `organizer-mode.el'.
3465 * Ju"rgen Vollmer contributed code generating the table of contents
3468 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3470 * David Wainberg suggested archiving, and improvements to the linking
3473 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
3474 development of Org-mode was fully independent, and both systems are
3475 really different beasts in their basic ideas and implementation
3476 details. However, I have later looked at John's code and learned
3477 from his implementation of (i) links where the link itself is
3478 hidden and only a description is shown, and (ii) popping up a
3479 calendar to select a date.
3481 * Carsten Wimmer suggested some changes and helped fix a bug in
3484 * Roland Winkler requested additional keybindings to make Org-mode
3487 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3491 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3499 * acknowledgments: Acknowledgments. (line 6)
3500 * active region <1>: HTML export. (line 10)
3501 * active region <2>: ASCII export. (line 9)
3502 * active region <3>: Built-in table editor.
3504 * active region: Structure editing. (line 46)
3505 * agenda: Weekly/Daily Agenda. (line 6)
3506 * agenda commands, custom: Agenda dispatcher. (line 6)
3507 * agenda dispatcher: Agenda dispatcher. (line 6)
3508 * agenda files, removing buffers: Agenda commands. (line 187)
3509 * agenda views: Agenda Views. (line 6)
3510 * agenda, for single file: Timeline. (line 6)
3511 * angular brackets, around links: External links. (line 35)
3512 * applescript, for calendar update: iCalendar export. (line 38)
3513 * archive locations: Archiving. (line 13)
3514 * archiving: Archiving. (line 6)
3515 * ASCII export: ASCII export. (line 6)
3516 * author: Feedback. (line 6)
3517 * autoload: Installation and activation.
3519 * BBDB links: External links. (line 6)
3520 * bold text: Enhancing text. (line 15)
3521 * bug reports: Feedback. (line 6)
3522 * bugs: Bugs. (line 6)
3523 * calc package: Table calculations. (line 6)
3524 * calc.el: Interaction. (line 18)
3525 * calculations, in tables <1>: Table calculations. (line 6)
3526 * calculations, in tables: Built-in table editor.
3528 * calendar integration: Calendar/Diary integration.
3530 * calendar, for selecting date: Creating timestamps. (line 68)
3531 * CamelCase link completion: Completion. (line 6)
3532 * CamelCase links: Internal links. (line 6)
3533 * CamelCase links, completion of: CamelCase links. (line 6)
3534 * category: Categories. (line 6)
3535 * children, subtree visibility state: Visibility cycling. (line 10)
3536 * clean outline view: Clean view. (line 6)
3537 * column formula: Column formulas. (line 6)
3538 * commands, in agenda buffer: Agenda commands. (line 6)
3539 * comment lines: Comment lines. (line 6)
3540 * completion, of CamelCase links <1>: Completion. (line 6)
3541 * completion, of CamelCase links: CamelCase links. (line 6)
3542 * completion, of dictionary words: Completion. (line 6)
3543 * completion, of file names: Managing links. (line 36)
3544 * completion, of links: Managing links. (line 23)
3545 * completion, of option keywords <1>: Completion. (line 6)
3546 * completion, of option keywords: Export options. (line 6)
3547 * Completion, of option keywords: Per file keywords. (line 17)
3548 * completion, of tags <1>: Completion. (line 6)
3549 * completion, of tags: Setting tags. (line 12)
3550 * completion, of TeX symbols <1>: Completion. (line 6)
3551 * completion, of TeX symbols: Enhancing text. (line 19)
3552 * completion, of TODO keywords <1>: Completion. (line 6)
3553 * completion, of TODO keywords: Workflow states. (line 12)
3554 * constants, in calculations: Formula syntax. (line 26)
3555 * constants.el: Interaction. (line 28)
3556 * contents, global visibility state: Visibility cycling. (line 19)
3557 * copying, of subtrees: Structure editing. (line 6)
3558 * creating timestamps: Creating timestamps. (line 6)
3559 * CUA.el: Interaction. (line 40)
3560 * custom agenda commands: Agenda dispatcher. (line 6)
3561 * customization: Customization. (line 6)
3562 * cutting, of subtrees: Structure editing. (line 6)
3563 * cycling, of TODO states: TODO basics. (line 13)
3564 * cycling, visibility: Visibility cycling. (line 6)
3565 * dangerous commands: FAQ. (line 37)
3566 * date stamps: Time stamps. (line 6)
3567 * date, reading in minibuffer: Creating timestamps. (line 68)
3568 * DEADLINE keyword: Time stamps. (line 27)
3569 * deadlines: Time stamps. (line 6)
3570 * demotion, of subtrees: Structure editing. (line 6)
3571 * diary entries, creating from agenda: Agenda commands. (line 145)
3572 * diary integration: Calendar/Diary integration.
3574 * dictionary word completion: Completion. (line 6)
3575 * dispatching agenda commands: Agenda dispatcher. (line 6)
3576 * document structure: Document Structure. (line 6)
3577 * DONE, final TODO keyword: Per file keywords. (line 20)
3578 * editing tables: Tables. (line 6)
3579 * editing, of table formulas: Editing/debugging formulas.
3581 * emphasized text: Export options. (line 25)
3582 * enhancing text: Enhancing text. (line 6)
3583 * evaluate time range: Creating timestamps. (line 63)
3584 * exporting: Exporting. (line 6)
3585 * exporting a subtree: FAQ. (line 78)
3586 * exporting, not: Comment lines. (line 6)
3587 * extended TODO keywords: TODO extensions. (line 6)
3588 * external links: External links. (line 6)
3589 * FAQ: FAQ. (line 6)
3590 * feedback: Feedback. (line 6)
3591 * file links: External links. (line 6)
3592 * file links, searching: Search Options. (line 6)
3593 * file name completion: Managing links. (line 36)
3594 * files, adding to agenda list: Agenda files. (line 12)
3595 * filing subtrees: Archiving. (line 6)
3596 * fixed width: Enhancing text. (line 30)
3597 * fixed-width sections: Export options. (line 25)
3598 * folded, subtree visibility state: Visibility cycling. (line 10)
3599 * folding, sparse trees: Sparse trees. (line 6)
3600 * following links: Managing links. (line 50)
3601 * format specifier: Formula syntax. (line 34)
3602 * format, of links: Link format. (line 6)
3603 * formula editing: Editing/debugging formulas.
3605 * formula syntax: Formula syntax. (line 6)
3606 * formula, for named table field: Named-field formulas.
3608 * formula, for table column: Column formulas. (line 6)
3609 * formula, in tables: Built-in table editor.
3611 * global keybindings: Installation and activation.
3613 * global TODO list: Global TODO list. (line 6)
3614 * global visibility states: Visibility cycling. (line 19)
3615 * GNUS links: External links. (line 6)
3616 * hand-formatted lists: Enhancing text. (line 11)
3617 * headline levels: Export options. (line 25)
3618 * headline levels, for exporting <1>: HTML export. (line 16)
3619 * headline levels, for exporting: ASCII export. (line 15)
3620 * headline navigation: Motion. (line 6)
3621 * headline tagging: Tags. (line 6)
3622 * headline, promotion and demotion: Structure editing. (line 6)
3623 * headlines: Headlines. (line 6)
3624 * hide text: Visibility cycling. (line 6)
3625 * hiding leading stars: Clean view. (line 6)
3626 * HTML export: HTML export. (line 6)
3627 * hyperlinks: Hyperlinks. (line 6)
3628 * iCalendar export: iCalendar export. (line 6)
3629 * in-buffer settings: Summary of in-buffer settings.
3631 * indentation, of tables: FAQ. (line 102)
3632 * indirect buffers: FAQ. (line 54)
3633 * inheritance, of tags: Tag inheritance. (line 6)
3634 * inserting links: Managing links. (line 23)
3635 * installation: Installation and activation.
3637 * internal links: Internal links. (line 6)
3638 * introduction: Introduction. (line 6)
3639 * italic text: Enhancing text. (line 15)
3640 * jumping, to headlines: Motion. (line 6)
3641 * keybindings, global: Installation and activation.
3643 * keyword options: Per file keywords. (line 6)
3644 * linebreak preservation: Export options. (line 25)
3645 * link completion: Managing links. (line 23)
3646 * link format: Link format. (line 6)
3647 * links, external: External links. (line 6)
3648 * links, internal: Internal links. (line 6)
3649 * links, returning to: Managing links. (line 76)
3650 * lists, hand-formatted: Enhancing text. (line 11)
3651 * lists, ordered: Plain Lists. (line 6)
3652 * lists, plain: Plain Lists. (line 6)
3653 * logging, of progress: Progress logging. (line 6)
3654 * maintainer: Feedback. (line 6)
3655 * make-indirect-buffer: FAQ. (line 54)
3656 * mark ring: Managing links. (line 72)
3657 * marking characters, tables: Advanced features. (line 34)
3658 * matching, of tags: Matching headline tags.
3660 * matching, tags: Tags. (line 6)
3661 * MH-E links: External links. (line 6)
3662 * minor mode for tables: orgtbl-mode. (line 6)
3663 * mode, for calc: Formula syntax. (line 34)
3664 * motion, between headlines: Motion. (line 6)
3665 * name, of column or field: Formula syntax. (line 26)
3666 * named field formula: Named-field formulas.
3668 * names as TODO keywords: TODO types. (line 6)
3669 * narrow columns in tables: Narrow columns. (line 6)
3670 * occur, command: Sparse trees. (line 6)
3671 * option keyword completion: Completion. (line 6)
3672 * options, for customization: Customization. (line 6)
3673 * options, for export: Export options. (line 6)
3674 * ordered lists: Plain Lists. (line 6)
3675 * org-agenda, command: Weekly/Daily Agenda. (line 9)
3676 * org-mode, turning on: Installation and activation.
3678 * org-mouse.el: Interaction. (line 8)
3679 * orgtbl-mode: orgtbl-mode. (line 6)
3680 * outline tree: Headlines. (line 6)
3681 * outline-mode: Outlines. (line 6)
3682 * outlines: Outlines. (line 6)
3683 * overview, global visibility state: Visibility cycling. (line 19)
3684 * packages, interaction with other: Interaction. (line 6)
3685 * pasting, of subtrees: Structure editing. (line 6)
3686 * per file keywords: Per file keywords. (line 6)
3687 * plain lists: Plain Lists. (line 6)
3688 * plain text external links: External links. (line 35)
3689 * printing sparse trees: Sparse trees. (line 39)
3690 * priorities: Priorities. (line 6)
3691 * priorities, of agenda items: Sorting of agenda items.
3693 * progress logging: Progress logging. (line 6)
3694 * promotion, of subtrees: Structure editing. (line 6)
3695 * quoted html tags: Export options. (line 25)
3696 * ranges, time: Time stamps. (line 6)
3697 * recomputing table fields: Column formulas. (line 27)
3698 * region, active <1>: HTML export. (line 10)
3699 * region, active <2>: ASCII export. (line 9)
3700 * region, active <3>: Built-in table editor.
3702 * region, active: Structure editing. (line 46)
3703 * remember.el <1>: Interaction. (line 40)
3704 * remember.el: Remember. (line 6)
3705 * richer text: Enhancing text. (line 6)
3706 * RMAIL links: External links. (line 6)
3707 * SCHEDULED keyword: Time stamps. (line 39)
3708 * scheduling: Time stamps. (line 6)
3709 * search option in file links: Search Options. (line 6)
3710 * section-numbers: Export options. (line 25)
3711 * setting tags: Setting tags. (line 6)
3712 * SHELL links: External links. (line 6)
3713 * shell links, confirmation: FAQ. (line 37)
3714 * show all, command: Visibility cycling. (line 27)
3715 * show all, global visibility state: Visibility cycling. (line 19)
3716 * show hidden text: Visibility cycling. (line 6)
3717 * single file summary: Timeline. (line 6)
3718 * sorting, of agenda items: Sorting of agenda items.
3720 * sparse tree, for deadlines: Creating timestamps. (line 38)
3721 * sparse tree, for TODO: TODO basics. (line 20)
3722 * sparse tree, tag based: Tags. (line 6)
3723 * sparse trees: Sparse trees. (line 6)
3724 * special keywords: Summary of in-buffer settings.
3726 * spreadsheet capabilities: Table calculations. (line 6)
3727 * storing links: Managing links. (line 9)
3728 * structure editing: Structure editing. (line 6)
3729 * structure of document: Document Structure. (line 6)
3730 * subtree visibility states: Visibility cycling. (line 10)
3731 * subtree, cut and paste: Structure editing. (line 6)
3732 * subtree, subtree visibility state: Visibility cycling. (line 10)
3733 * subtrees, cut and paste: Structure editing. (line 6)
3734 * summary: Summary. (line 6)
3735 * syntax, of formulas: Formula syntax. (line 6)
3736 * table editor, builtin: Built-in table editor.
3738 * table editor, table.el: table.el. (line 6)
3739 * table of contents: Export options. (line 25)
3740 * table.el <1>: Interaction. (line 14)
3741 * table.el: table.el. (line 6)
3742 * tables <1>: Export options. (line 25)
3743 * tables: Tables. (line 6)
3744 * tables, export: Enhancing text. (line 26)
3745 * tag completion: Completion. (line 6)
3746 * tag searches: Tag searches. (line 6)
3747 * tags: Tags. (line 6)
3748 * tags view: Matching headline tags.
3750 * templates, for remember: Remember. (line 26)
3751 * TeX interpretation: Enhancing text. (line 17)
3752 * TeX macros: Export options. (line 25)
3753 * TeX symbol completion: Completion. (line 6)
3754 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
3755 * thanks: Acknowledgments. (line 6)
3756 * time stamps: Time stamps. (line 6)
3757 * time, reading in minibuffer: Creating timestamps. (line 68)
3758 * time-sorted view: Timeline. (line 6)
3759 * timeline, single file: Timeline. (line 6)
3760 * timerange: Time stamps. (line 18)
3761 * timestamp: Time stamps. (line 12)
3762 * timestamps, creating: Creating timestamps. (line 6)
3763 * TODO items: TODO items. (line 6)
3764 * TODO keywords completion: Completion. (line 6)
3765 * TODO list, global: Global TODO list. (line 6)
3766 * TODO types: TODO types. (line 6)
3767 * TODO workflow: Workflow states. (line 6)
3768 * transient-mark-mode <1>: HTML export. (line 10)
3769 * transient-mark-mode <2>: ASCII export. (line 9)
3770 * transient-mark-mode <3>: Built-in table editor.
3772 * transient-mark-mode: Structure editing. (line 46)
3773 * trees, sparse: Sparse trees. (line 6)
3774 * trees, visibility: Visibility cycling. (line 6)
3775 * tty keybindings: TTY keys. (line 6)
3776 * types as TODO keywords: TODO types. (line 6)
3777 * underlined text: Enhancing text. (line 15)
3778 * URL links: External links. (line 6)
3779 * USENET links: External links. (line 6)
3780 * variables, for customization: Customization. (line 6)
3781 * vectors, in table calculations: Formula syntax. (line 23)
3782 * visibility cycling: Visibility cycling. (line 6)
3783 * visible text, printing: Sparse trees. (line 39)
3784 * VM links: External links. (line 6)
3785 * WANDERLUST links: External links. (line 6)
3786 * workflow states as TODO keywords: Workflow states. (line 6)
3787 * XML export: XML export. (line 6)
3790 File: org, Node: Key Index, Prev: Index, Up: Top
3798 * +: Agenda commands. (line 118)
3799 * ,: Agenda commands. (line 110)
3800 * -: Agenda commands. (line 124)
3801 * .: Agenda commands. (line 89)
3802 * :: Agenda commands. (line 107)
3803 * <: Creating timestamps. (line 75)
3804 * <left>: Agenda commands. (line 86)
3805 * <RET> <1>: Agenda commands. (line 41)
3806 * <RET> <2>: Creating timestamps. (line 100)
3807 * <RET>: Built-in table editor.
3809 * <right>: Agenda commands. (line 81)
3810 * <SPC>: Agenda commands. (line 28)
3811 * <TAB> <1>: Agenda commands. (line 35)
3812 * <TAB> <2>: Built-in table editor.
3814 * <TAB> <3>: Plain Lists. (line 37)
3815 * <TAB>: Visibility cycling. (line 10)
3816 * > <1>: Agenda commands. (line 140)
3817 * >: Creating timestamps. (line 76)
3818 * C: Agenda commands. (line 170)
3819 * c: Agenda commands. (line 154)
3820 * C-#: Built-in table editor.
3822 * C-,: Agenda files. (line 18)
3823 * C-c !: Creating timestamps. (line 21)
3824 * C-c $: Archiving. (line 9)
3825 * C-c %: Managing links. (line 72)
3826 * C-c &: Managing links. (line 76)
3827 * C-c ' <1>: Editing/debugging formulas.
3829 * C-c ': Built-in table editor.
3831 * C-c *: Built-in table editor.
3833 * C-c +: Built-in table editor.
3835 * C-c ,: Priorities. (line 18)
3836 * C-c -: Built-in table editor.
3838 * C-c .: Creating timestamps. (line 10)
3839 * C-c /: Sparse trees. (line 15)
3840 * C-c :: Enhancing text. (line 34)
3841 * C-c ;: Comment lines. (line 11)
3842 * C-c <: Creating timestamps. (line 25)
3843 * C-c <TAB>: Built-in table editor.
3845 * C-c =: Built-in table editor.
3847 * C-c >: Creating timestamps. (line 29)
3848 * C-c ? <1>: Editing/debugging formulas.
3850 * C-c ?: Built-in table editor.
3852 * C-c [: Agenda files. (line 12)
3853 * C-c \: Tag searches. (line 9)
3854 * C-c ]: Agenda files. (line 15)
3855 * C-c ^: Built-in table editor.
3857 * C-c `: Built-in table editor.
3859 * C-c a a: Weekly/Daily Agenda. (line 9)
3860 * C-c a C: Agenda dispatcher. (line 30)
3861 * C-c a M: Matching headline tags.
3863 * C-c a m: Matching headline tags.
3865 * C-c a M: Tag searches. (line 14)
3866 * C-c a m: Tag searches. (line 10)
3867 * C-c a T: Global TODO list. (line 15)
3868 * C-c a t <1>: Global TODO list. (line 9)
3869 * C-c a t: TODO basics. (line 27)
3870 * C-c C-a: Visibility cycling. (line 27)
3871 * C-c C-b: Motion. (line 15)
3872 * C-c C-c <1>: The very busy C-c C-c key.
3874 * C-c C-c <2>: Setting tags. (line 11)
3875 * C-c C-c <3>: table.el. (line 6)
3876 * C-c C-c <4>: Editing/debugging formulas.
3878 * C-c C-c <5>: Built-in table editor.
3880 * C-c C-c: Plain Lists. (line 61)
3881 * C-c C-d: Creating timestamps. (line 37)
3882 * C-c C-f: Motion. (line 12)
3883 * C-c C-j: Motion. (line 21)
3884 * C-c C-l: Managing links. (line 23)
3885 * C-c C-n: Motion. (line 8)
3886 * C-c C-o <1>: Creating timestamps. (line 33)
3887 * C-c C-o: Managing links. (line 50)
3888 * C-c C-p: Motion. (line 9)
3889 * C-c C-q <1>: Editing/debugging formulas.
3891 * C-c C-q: Built-in table editor.
3893 * C-c C-r: Timeline. (line 13)
3894 * C-c C-s: Creating timestamps. (line 47)
3895 * C-c C-t: TODO basics. (line 13)
3896 * C-c C-u: Motion. (line 18)
3897 * C-c C-v: TODO basics. (line 20)
3898 * C-c C-w: Creating timestamps. (line 38)
3899 * C-c C-x a: ASCII export. (line 9)
3900 * C-c C-x b: HTML export. (line 11)
3901 * C-c C-x c: iCalendar export. (line 20)
3902 * C-c C-x C-c: Agenda commands. (line 177)
3903 * C-c C-x C-i: iCalendar export. (line 15)
3904 * C-c C-x C-k: Structure editing. (line 31)
3905 * C-c C-x C-w <1>: Built-in table editor.
3907 * C-c C-x C-w: Structure editing. (line 31)
3908 * C-c C-x C-x: XML export. (line 10)
3909 * C-c C-x C-y <1>: Built-in table editor.
3911 * C-c C-x C-y: Structure editing. (line 38)
3912 * C-c C-x h: HTML export. (line 10)
3913 * C-c C-x i: iCalendar export. (line 13)
3914 * C-c C-x M-w <1>: Built-in table editor.
3916 * C-c C-x M-w: Structure editing. (line 35)
3917 * C-c C-x t: Export options. (line 13)
3918 * C-c C-x v: Sparse trees. (line 39)
3919 * C-c C-y: Creating timestamps. (line 63)
3920 * C-c l: Managing links. (line 9)
3921 * C-c |: Built-in table editor.
3923 * C-c ~: table.el. (line 18)
3924 * C-u C-c .: Creating timestamps. (line 16)
3925 * C-u C-c =: Built-in table editor.
3927 * C-u C-c C-l: Managing links. (line 36)
3928 * D: Agenda commands. (line 66)
3929 * d: Agenda commands. (line 63)
3930 * f: Agenda commands. (line 44)
3931 * g: Agenda commands. (line 70)
3932 * H: Agenda commands. (line 174)
3933 * i: Agenda commands. (line 145)
3934 * l: Agenda commands. (line 49)
3935 * L: Agenda commands. (line 32)
3936 * M: Agenda commands. (line 161)
3937 * M-<down>: Built-in table editor.
3939 * M-<left> <1>: Built-in table editor.
3941 * M-<left>: Structure editing. (line 13)
3942 * M-<RET> <1>: Plain Lists. (line 42)
3943 * M-<RET>: Structure editing. (line 6)
3944 * M-<right> <1>: Built-in table editor.
3946 * M-<right>: Structure editing. (line 16)
3947 * M-<TAB> <1>: Completion. (line 10)
3948 * M-<TAB> <2>: Setting tags. (line 6)
3949 * M-<TAB>: Per file keywords. (line 17)
3950 * M-<up>: Built-in table editor.
3952 * M-S-<down> <1>: Built-in table editor.
3954 * M-S-<down> <2>: Plain Lists. (line 46)
3955 * M-S-<down>: Structure editing. (line 28)
3956 * M-S-<left> <1>: Creating timestamps. (line 97)
3957 * M-S-<left> <2>: Built-in table editor.
3959 * M-S-<left> <3>: Plain Lists. (line 52)
3960 * M-S-<left>: Structure editing. (line 19)
3961 * M-S-<RET>: Structure editing. (line 10)
3962 * M-S-<right> <1>: Creating timestamps. (line 94)
3963 * M-S-<right> <2>: Built-in table editor.
3965 * M-S-<right> <3>: Plain Lists. (line 52)
3966 * M-S-<right>: Structure editing. (line 22)
3967 * M-S-<up> <1>: Built-in table editor.
3969 * M-S-<up> <2>: Plain Lists. (line 46)
3970 * M-S-<up>: Structure editing. (line 25)
3971 * mouse-1 <1>: Agenda commands. (line 35)
3972 * mouse-1 <2>: Creating timestamps. (line 79)
3973 * mouse-1: Managing links. (line 64)
3974 * mouse-2 <1>: Agenda commands. (line 35)
3975 * mouse-2: Managing links. (line 64)
3976 * mouse-3 <1>: Agenda commands. (line 28)
3977 * mouse-3: Managing links. (line 69)
3978 * n: Agenda commands. (line 19)
3979 * o: Agenda commands. (line 57)
3980 * P: Agenda commands. (line 115)
3981 * p: Agenda commands. (line 20)
3982 * q: Agenda commands. (line 184)
3983 * r <1>: Agenda commands. (line 74)
3984 * r: Global TODO list. (line 21)
3985 * S: Agenda commands. (line 165)
3986 * S-<down> <1>: Agenda commands. (line 124)
3987 * S-<down> <2>: Creating timestamps. (line 55)
3988 * S-<down>: Priorities. (line 25)
3989 * S-<left> <1>: Agenda commands. (line 136)
3990 * S-<left>: Creating timestamps. (line 50)
3991 * S-<RET>: Built-in table editor.
3993 * S-<right> <1>: Agenda commands. (line 128)
3994 * S-<right>: Creating timestamps. (line 50)
3995 * S-<TAB> <1>: Built-in table editor.
3997 * S-<TAB>: Visibility cycling. (line 19)
3998 * S-<up> <1>: Agenda commands. (line 118)
3999 * S-<up> <2>: Creating timestamps. (line 55)
4000 * S-<up>: Priorities. (line 25)
4001 * T: Agenda commands. (line 102)
4002 * t: Agenda commands. (line 98)
4003 * w: Agenda commands. (line 60)
4004 * x: Agenda commands. (line 187)
4010 Node: Introduction
\x7f7444
4011 Node: Summary
\x7f7758
4012 Node: Installation and activation
\x7f9870
4013 Node: Feedback
\x7f11539
4014 Node: Document Structure
\x7f12325
4015 Node: Outlines
\x7f13091
4016 Node: Headlines
\x7f13751
4017 Node: Visibility cycling
\x7f14374
4018 Node: Motion
\x7f15570
4019 Node: Structure editing
\x7f16354
4020 Node: Archiving
\x7f18097
4021 Node: Sparse trees
\x7f18957
4022 Ref: Sparse trees-Footnote-1
\x7f20986
4023 Ref: Sparse trees-Footnote-2
\x7f21078
4024 Node: Plain Lists
\x7f21192
4025 Ref: Plain Lists-Footnote-1
\x7f23948
4026 Node: Tables
\x7f24305
4027 Node: Built-in table editor
\x7f24853
4028 Node: Narrow columns
\x7f32466
4029 Ref: Narrow columns-Footnote-1
\x7f34399
4030 Node: Table calculations
\x7f34445
4031 Node: Formula syntax
\x7f35621
4032 Ref: Formula syntax-Footnote-1
\x7f38555
4033 Node: Column formulas
\x7f38854
4034 Node: Advanced features
\x7f40616
4035 Node: Named-field formulas
\x7f43871
4036 Node: Editing/debugging formulas
\x7f44511
4037 Node: Appetizer
\x7f46269
4038 Node: orgtbl-mode
\x7f47371
4039 Node: table.el
\x7f47862
4040 Node: Hyperlinks
\x7f48839
4041 Node: Link format
\x7f49473
4042 Node: Internal links
\x7f50770
4043 Node: Radio targets
\x7f52660
4044 Node: CamelCase links
\x7f53375
4045 Node: External links
\x7f53873
4046 Node: Managing links
\x7f55798
4047 Node: Search Options
\x7f59782
4048 Ref: Search Options-Footnote-1
\x7f61102
4049 Node: Remember
\x7f61183
4050 Ref: Remember-Footnote-1
\x7f65049
4051 Node: TODO items
\x7f65173
4052 Node: TODO basics
\x7f66096
4053 Node: Progress logging
\x7f67611
4054 Node: TODO extensions
\x7f68397
4055 Node: Workflow states
\x7f69197
4056 Node: TODO types
\x7f70065
4057 Ref: TODO types-Footnote-1
\x7f71723
4058 Node: Per file keywords
\x7f71805
4059 Ref: Per file keywords-Footnote-1
\x7f73258
4060 Node: Priorities
\x7f73486
4061 Node: Timestamps
\x7f74695
4062 Node: Time stamps
\x7f75016
4063 Node: Creating timestamps
\x7f77031
4065 Node: Tag inheritance
\x7f80895
4066 Node: Setting tags
\x7f81832
4067 Node: Tag searches
\x7f82794
4068 Node: Agenda Views
\x7f84003
4069 Node: Agenda files
\x7f85542
4070 Ref: Agenda files-Footnote-1
\x7f86502
4071 Ref: Agenda files-Footnote-2
\x7f86651
4072 Node: Agenda dispatcher
\x7f86843
4073 Node: Weekly/Daily Agenda
\x7f88973
4074 Node: Categories
\x7f90108
4075 Node: Time-of-day specifications
\x7f90756
4076 Node: Calendar/Diary integration
\x7f92732
4077 Node: Sorting of agenda items
\x7f94109
4078 Node: Global TODO list
\x7f94941
4079 Node: Matching headline tags
\x7f96356
4080 Node: Timeline
\x7f97299
4081 Node: Agenda commands
\x7f98172
4082 Node: Exporting
\x7f103428
4083 Node: ASCII export
\x7f104558
4084 Node: HTML export
\x7f105380
4085 Node: XML export
\x7f107128
4086 Node: iCalendar export
\x7f107495
4087 Node: Text interpretation
\x7f109317
4088 Node: Comment lines
\x7f109794
4089 Node: Enhancing text
\x7f110263
4090 Node: Export options
\x7f112094
4091 Node: Miscellaneous
\x7f113696
4092 Node: Completion
\x7f114454
4093 Node: Customization
\x7f115450
4094 Node: Summary of in-buffer settings
\x7f116057
4095 Node: The very busy C-c C-c key
\x7f118816
4096 Node: Clean view
\x7f120221
4097 Node: TTY keys
\x7f122798
4099 Node: Interaction
\x7f130713
4100 Node: Bugs
\x7f133580
4101 Node: Acknowledgments
\x7f135534
4102 Node: Index
\x7f138466
4103 Node: Key Index
\x7f159544