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.26).
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.26).
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 * Handling 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, easy to use outliner. Complexity is not imposed,
216 but a large amount of functionality is available when you need it.
217 Org-mode can be used on different levels and in different ways, for
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 (*note Plain lists::).
431 To force creation of a new headline, use a prefix arg, or first
432 press <RET> to get to the beginning of the next line. When this
433 command is used in the middle of a line, the line is split and the
434 rest of the line becomes the new headline. If the command is used
435 at the beginning of a headline, the new headline is created before
436 the current line. It at the beginning of any other line, the
437 content of that line is made the new heading.
440 Insert new TODO entry with same level as current heading.
443 Promote current heading by one level.
446 Demote current heading by one level.
449 Promote the current subtree by one level.
452 Demote the current subtree by one level.
455 Move subtree up (swap with previous subtree of same level).
458 Move subtree down (swap with next subtree of same level).
462 Kill subtree, i.e. remove it from buffer but save in kill ring.
465 Copy subtree to kill ring.
468 Yank subtree from kill ring. This does modify the level of the
469 subtree to make sure the tree fits in nicely at the yank position.
470 The yank level can also be specified with a prefix arg, or by
471 yanking after a headline marker like `****'.
473 When there is an active region (transient-mark-mode), promotion and
474 demotion work on all headlines in the region. To select a region of
475 headlines, it is best to place both point and mark at the beginning of a
476 line, mark at the beginning of the first headline, and point at the line
477 just after the last headline to change. Note that when the cursor is
478 inside a table (*note Tables::), the Meta-Cursor keys have different
482 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
487 When a project represented by a (sub)tree is finished, you may want to
488 move the tree to an archive place, either in the same file under a
489 special top-level heading, or even to a different file.
491 Archive the subtree starting at the cursor position to the location
492 given by `org-archive-location'.
494 The default archive is a file in the same directory as the current
495 file, with the name derived by appending `_archive' to the current file
496 name. For information and examples on how to change this, see the
497 documentation string of the variable `org-archive-location'. If you
498 are also using the Org-mode agenda, archiving to a different file is a
499 good way to keep archived trees from contributing agenda items.
502 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
507 An important feature of Org-mode is the ability to construct _sparse
508 trees_ for selected information in an outline tree. A sparse tree
509 means that the entire document is folded as much as possible, but the
510 selected information is made visible along with the headline structure
511 above it(1). Just try it out and you will see immediately how it works.
513 Org-mode contains several commands creating such trees. The most
514 basic one is `org-occur':
517 Occur. Prompts for a regexp and shows a sparse tree with all
518 matches. If the match is in a headline, the headline is made
519 visible. If the match is in the body of an entry, headline and
520 body are made visible. In order to provide minimal context, also
521 the full hierarchy of headlines above the match is shown, as well
522 as the headline following the match. Each match is also
523 highlighted, the highlights disappear when the buffer is changed
524 with an editing command.
525 For frequently used sparse trees of specific search strings, you can
526 use the variable `org-agenda-custom-commands' to define fast keyboard
527 access to specific sparse trees. These commands will then be
528 accessible through the agenda dispatcher (*note Agenda dispatcher::).
531 (setq org-agenda-custom-commands
532 '(("f" occur-tree "FIXME")))
534 will define the key `C-c a f' as a shortcut for creating a sparse tree
535 matching the string `FIXME'.
537 Other commands are using sparse trees as well. For example `C-c
538 C-v' creates a sparse TODO tree (*note TODO basics::).
540 To print a sparse tree, you can use the Emacs command
541 `ps-print-buffer-with-faces' which does not print invisible parts of
542 the document (2). Or you can use the command `C-c C-x v' to copy the
543 visible part of the document to another file (extension `.txt') which
544 can then be printed in any desired way.
546 ---------- Footnotes ----------
548 (1) See also the variables `org-show-hierarchy-above' and
549 `org-show-following-heading'.
551 (2) This does not work under XEmacs, because XEmacs uses selective
552 display for outlining, not text properties.
555 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
560 Headlines define both the structure of the Org-mode file, and also lists
561 (for example, TODO items (*note TODO items::) should be created using
562 headline levels). However, when taking notes, the plain text is
563 sometimes easier to read with hand-formatted lists. Org-mode supports
564 editing such lists, and the HTML exporter (*note Exporting::) does
565 parse and format them.
567 Org-mode knows ordered and unordered lists. Unordered list items
568 start with `-', `+', or `*'(1) as bullets. Ordered list items start
569 with `1.' or `1)'. Items belonging to the same list must have the same
570 indentation on the first line. In particular, if an ordered list
571 reaches number `10.', then the 2-digit numbers must be written
572 left-aligned with the other numbers in the list. Indentation also
573 determines the end of a list item. It ends before the next line that
574 is indented like the bullet/number, or less. For example:
577 My favorite scenes are (in this order)
578 1. Eowyns fight with the witch king
579 + this was already my favorite scene in the book
580 + I really like Miranda Otto.
581 2. The attack of the Rohirrim
582 3. Peter Jackson being shot by Legolas
584 He makes a really funny face when it happens.
585 But in the end, not individual scenes matter but the film as a whole.
587 Org-mode supports these lists by tuning filling and wrapping commands
588 to correctly deal with them. Furthermore, the following commands act
589 on items when the cursor is in the first line of an item (the line with
590 the bullet or number).
593 Items can be folded just like headline levels if you set the
594 variable `org-cycle-include-plain-lists'. The level of an item is
595 then given by the indentation of the bullet/number. However,
596 items are always subordinate to real headlines, the hierarchies
597 remain completely separated.
600 Insert new item at current level. With prefix arg, force a new
601 heading (*note Structure editing::). If this command is used in
602 the middle of a line, the line is _split_ and the rest of the line
603 becomes the new item. If this command is executed in the
604 _whitespace before a bullet or number_, the new item is created
605 _before_ the current item. If the command is executed in the
606 white space before the text that is part of an item but does not
607 contain the bullet, a bullet is added to the current line.
611 Move the item including subitems up/down (swap with previous/next
612 item of same indentation). If the list is ordered, renumbering is
617 Decrease/increase the indentation of the item, including subitems.
618 Initially, the item tree is selected based on current indentation.
619 When these commands are executed several times in direct
620 succession, the initially selected region is used, even if the new
621 indentation would imply a different hierarchy. To use the new
622 hierarchy, break the command chain with a cursor motion or so.
625 Renumber the ordered list at the cursor.
627 ---------- Footnotes ----------
629 (1) When using `*' as a bullet, lines must be indented or they will
630 be seen as top-level headlines. Also, when you are hiding leading
631 stars to get a clean outline view, plain list items starting with a
632 star are visually indistinguishable from true headlines. In short:
633 even though `*' is supported, it may be better to not use it for plain
637 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
642 Org-mode has a very fast and intuitive table editor built-in.
643 Spreadsheet-like calculations are supported in connection with the
644 Emacs `calc' package.
648 * Built-in table editor:: Simple tables
649 * Narrow columns:: Stop wasting space in tables
650 * Table calculations:: Compute a field from other fields
651 * orgtbl-mode:: The table editor as minor mode
652 * table.el:: Complex tables
655 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
657 3.1 The built-in table editor
658 =============================
660 Org-mode makes it easy to format tables in plain ASCII. Any line with
661 `|' as the first non-white character is considered part of a table.
662 `|' is also the column separator. A table might look like this:
664 | Name | Phone | Age |
665 |-------+-------+-----|
666 | Peter | 1234 | 17 |
669 A table is re-aligned automatically each time you press <TAB> or
670 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
671 field (<RET> to the next row) and creates new table rows at the end of
672 the table or before horizontal lines. The indentation of the table is
673 set by the first line. Any line starting with `|-' is considered as a
674 horizontal separator line and will be expanded on the next re-align to
675 span the whole table width. So, to create the above table, you would
681 and then press <TAB> to align the table and start filling in fields.
683 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
684 and all character keys in a special way, so that inserting and deleting
685 avoids shifting other fields. Also, when typing _immediately after the
686 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
687 the field is automatically made blank. If this behavior is too
688 unpredictable for you, configure the variables
689 `org-enable-table-editor' and `org-table-auto-blank-field'.
691 Creation and conversion
692 .......................
695 Convert the active region to table. If every line contains at
696 least one TAB character, the function assumes that the material is
697 tab separated. If not, lines are split at whitespace into fields.
698 You can use a prefix argument to indicate the minimum number of
699 consecutive spaces required to identify a field separator
701 If there is no active region, this command creates an empty
702 Org-mode table. However, it's easier to just start typing, like
703 `|Name|Phone|Age <RET> |- <TAB>'.
705 Re-aligning and field motion
706 ............................
709 Re-align the table without moving the cursor.
712 Re-align the table, move to the next field. Creates a new row if
716 Re-align, move to previous field.
719 Re-align the table and move down to next row. Creates a new row if
720 necessary. At the beginning or end of a line, <RET> still does
721 NEWLINE, so it can be used to split a table.
723 Column and row editing
724 ......................
728 Move the current column left/right.
731 Kill the current column.
734 Insert a new column to the left of the cursor position.
738 Move the current row up/down.
741 Kill the current row or horizontal line.
744 Insert a new row above (with arg: below) the current row.
747 Insert a horizontal line below current row. With prefix arg, the
748 line is created above the current line.
751 Sort the table lines in the region. Point and mark must be in the
752 first and last line to be included, and must be in the column that
753 should be used for sorting. The command prompts for numerical
754 versus alphanumerical sorting.
760 Copy a rectangular region from a table to a special clipboard.
761 Point and mark determine edge fields of the rectangle. The
762 process ignores horizontal separator lines.
765 Copy a rectangular region from a table to a special clipboard, and
766 blank all fields in the rectangle. So this is the "cut" operation.
769 Paste a rectangular region into a table. The upper right corner
770 ends up in the current field. All involved fields will be
771 overwritten. If the rectangle does not fit into the present table,
772 the table is enlarged as needed. The process ignores horizontal
776 Wrap several fields in a column like a paragraph. If there is an
777 active region, and both point and mark are in the same column, the
778 text in the column is wrapped to minimum width for the given
779 number of lines. A prefix ARG may be used to change the number of
780 desired lines. If there is no region, the current field is split
781 at the cursor position and the text fragment to the right of the
782 cursor is prepended to the field one line down. If there is no
783 region, but you specify a prefix ARG, the current field is made
784 blank, and the content is appended to the field above.
790 Install a new formula for the current column and replace current
791 field with the result of the formula.
794 Install a new formula for the current field, which must be a named
795 field. Evaluate the formula and replace the field content with the
799 Edit all formulas associated with the current table in a separate
803 Recalculate the current row by applying the stored formulas from
804 left to right. When called with a `C-u' prefix, recalculate the
805 entire table, starting with the first non-header line (i.e. below
806 the first horizontal separator line). For details, see *Note
807 Table calculations::.
810 Rotate the calculation mark in first column through the states `',
811 `#', `*', `!', `$'. For the meaning of these marks see *Note
812 Advanced features::. When there is an active region, change all
816 Which table column is the cursor in? Displays number >0 in echo
820 Sum the numbers in the current column, or in the rectangle defined
821 by the active region. The result is shown in the echo area and can
822 be inserted with `C-y'.
825 When current field is empty, copy from first non-empty field above.
826 When not empty, copy current field down to next row and move cursor
827 along with it. Depending on the variable
828 `org-table-copy-increment', integer field values will be
829 incremented during copy. This key is also used by CUA-mode (*note
836 Edit the current field in a separate window. This is useful for
837 fields that are not fully visible (*note Narrow columns::). When
838 called with a `C-u' prefix, just make the full field visible, so
839 that it can be edited in place.
842 This is an alias for `C-u C-c `' to make the current field fully
845 `M-x org-table-import'
846 Import a file as a table. The table should be TAB- or whitespace
847 separated. Useful, for example, to import an Excel table or data
848 from a database, because these programs generally can write
849 TAB-separated text files. This command works by inserting the
850 file into the buffer and then converting the region to a table.
851 Any prefix argument is passed on to the converter, which uses it
852 to determine the separator.
854 `M-x org-table-export'
855 Export the table as a TAB-separated file. Useful for data
856 exchange with, for example, Excel or database programs.
859 If you don't like the automatic table editor because it gets in your
860 way on lines which you would like to start with `|', you can turn it
863 (setq org-enable-table-editor nil)
865 The only table command which then still works is `C-c C-c' to do a
869 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
874 The width of columns is automatically determined by the table editor.
875 Sometimes a single field or a few fields need to carry more text,
876 leading to inconveniently wide columns. To limit(1) the width of a
877 column, one field anywhere in the column may contain just the string
878 `<N>' where `N' is an integer specifying the width of the column in
879 characters. The next re-align will then set the width of this column
880 to no more than this value.
882 |---+------------------------------| |---+--------|
884 | 1 | one | | 1 | one |
885 | 2 | two | ----\ | 2 | two |
886 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
887 | 4 | four | | 4 | four |
888 |---+------------------------------| |---+--------|
890 Fields that are wider become clipped and end in the string `=>'. Note
891 that the full text is still in the buffer, it is only invisible. To
892 see the full text, hold the mouse over the field - a tooltip window
893 will show the full content. To edit such a field, use the command `C-c
894 `' (that is `C-c' followed by the backquote). This will open a new
895 window with the full field. Edit it and finish with `C-c C-c'.
897 When visiting a file containing a table with narrowed columns, the
898 necessary character hiding has not yet happened, and the table needs to
899 be aligned before it looks nice. Setting the option
900 `org-startup-align-all-tables' will realign all tables in a file upon
901 visiting, but also slow down startup. You can also set this option on
902 a per-file basis with:
907 ---------- Footnotes ----------
909 (1) This feature does not work on XEmacs.
912 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
914 3.3 Calculations in tables
915 ==========================
917 The table editor makes use of the Emacs `calc' package to implement
918 spreadsheet-like capabilities. Org-mode has two levels of complexity
919 for table calculations. On the basic level, tables do only horizontal
920 computations, so a field can be computed from other fields _in the same
921 row_, and Org-mode assumes that there is only one formula for each
922 column. This is very efficient to work with and enough for many tasks.
923 On the complex level, columns and individual fields can be named for
924 easier referencing in formulas, individual named fields can have their
925 own formula associated with them, and recalculation can be automated.
929 * Formula syntax:: How to write a formula
930 * Column formulas:: Formulas valid for all fields in a column
931 * Advanced features:: Field names, parameters and automatic recalc
932 * Named-field formulas:: Formulas valid in single fields
933 * Editing/debugging formulas:: Changing a stored formula
934 * Appetizer:: Taste the power of calc
937 File: org, Node: Formula syntax, Next: Column formulas, Prev: Table calculations, Up: Table calculations
942 A formula can be any algebraic expression understood by the Emacs
943 `calc' package. Note that `calc' has the slightly non-standard
944 convention that `/' has lower precedence than `*', so that `a/b*c' is
945 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
946 calc-eval: (calc)Calling Calc from Your Programs.), variable
947 substitution takes place:
949 $ refers to the current field
950 $3 refers to the field in column 3 of the current row
951 $3..$7 a vector of the fields in columns 3-7 of current row
952 $P1..$P3 vector of column range, using column names
953 &2 second data field above the current, in same column
954 &5-2 vector from fifth to second field above current
955 &III-II vector of fields between 2nd and 3rd hline above
956 &III vector of fields between third hline above and current field
957 $name a named field, parameter or constant
959 The range vectors can be directly fed into the calc vector functions
960 like `vmean' and `vsum'.
962 `$name' is interpreted as the name of a column, parameter or
963 constant. Constants are defined globally through the variable
964 `org-table-formula-constants'. If you have the `constants.el' package,
965 it will also be used to resolve constants, including natural constants
966 like `$h' for Planck's constant, and units like `$km' for kilometers.
967 Column names and parameters can be specified in special table lines.
968 These are described below, see *Note Advanced features::.
970 A formula can contain an optional mode string after a semicolon.
971 This string consists of flags to influence calc's modes(1) during
972 execution, e.g. `p20' to switch the internal precision to 20 digits,
973 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
974 or fixed display format, respectively, and `D', `R', `F', and `S' to
975 turn on degrees, radians, fraction and symbolic modes, respectively.
976 In addition, you may provide a `printf' format specifier to reformat
977 the final result. A few examples:
979 $1+$2 Sum of first and second field
980 $1+$2;%.2f Same, format result to two decimals
981 exp($2)+exp($1) Math functions can be used
982 $;%.1f Reformat current cell to 1 decimal
983 ($3-32)*5/9 Degrees F -> C conversion
984 $c/$1/$cm Hz -> cm conversion, using `constants.el'
985 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
986 sin($1);Dp3%.1e Same, but use printf specifier for display
987 vmean($2..$7) Compute column range mean, using vector function
988 vsum(&III) Sum numbers from 3rd hline above, up to here
989 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
991 ---------- Footnotes ----------
993 (1) By default, Org-mode uses the standard calc modes (precision 12,
994 angular units degrees, fraction and symbolic modes off). However, the
995 display format has been changed to `(float 5)' to keep tables compact.
996 The default settings can be configured using the variable
997 `org-calc-default-modes'.
1000 File: org, Node: Column formulas, Next: Advanced features, Prev: Formula syntax, Up: Table calculations
1002 3.3.2 Column formulas
1003 ---------------------
1005 To apply a formula to a field, type it directly into the field,
1006 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1007 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1008 be stored as the formula for the current column, evaluated and the
1009 current field replaced with the result. If the field contains only
1010 `=', the previously stored formula for this column is used.
1012 For each column, Org-mode will remember the most recently used
1013 formula. The information is stored in a special line starting with
1014 `#+TBLFM' directly below the table. When adding/deleting/moving
1015 columns with the appropriate commands, the stored equations will be
1016 modified accordingly. When a column used in a calculation is removed,
1017 references to this column become invalid and will cause an error upon
1018 applying the equation.
1020 Instead of typing an equation into the field, you may also use the
1021 command `C-c ='. It prompts for a formula (with default taken from the
1022 `#+TBLFM:' line) and applies it to the current field. A numerical
1023 prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
1024 in the current column.
1026 To recompute all the fields in a line, use the command `C-c *'. It
1027 re-applies all stored equations to the current row, from left to right.
1028 With a `C-u' prefix, this will be done to every line in the table, so
1029 use this command it you want to make sure the entire table is
1030 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1031 Global updating does not touch the line(s) above the first horizontal
1032 separator line, assuming that this is the table header.
1035 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1037 3.3.3 Advanced features
1038 -----------------------
1040 If you want the recalculation of fields to happen automatically, or if
1041 you want to be able to assign a formula to an individual field (instead
1042 of an entire column) you need to reserve the first column of the table
1043 for special marking characters. Here is an example of a table that
1044 collects exam results of students and makes use of these features:
1046 |---+---------+--------+--------+--------+-------+------|
1047 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1048 |---+---------+--------+--------+--------+-------+------|
1049 | ! | | P1 | P2 | P3 | Tot | |
1050 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1051 | ^ | | m1 | m2 | m3 | mt | |
1052 |---+---------+--------+--------+--------+-------+------|
1053 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1054 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1055 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1056 |---+---------+--------+--------+--------+-------+------|
1057 | | Average | | | | 29.7 | |
1058 | ^ | | | | | at | |
1059 | $ | max=50 | | | | | |
1060 |---+---------+--------+--------+--------+-------+------|
1061 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1063 Important: Please note that for these special tables, recalculating the
1064 table with `C-u C-c *' will only affect rows which are marked `#' or
1065 `*', and named fields. The column formulas are not applied in rows
1066 with empty first field.
1068 The marking characters have the following meaning:
1070 The fields in this line define names for the columns, so that you
1071 may refer to a column as `$Tot' instead of `$6'.
1074 This row defines names for the fields _above_ the row. With such
1075 a definition, any formula in the table may use `$m1' to refer to
1076 the value `10'. Also, named fields can have their own formula
1077 associated with them.
1080 Similar to `^', but defines names for the fields in the row
1084 Fields in this row can define _parameters_ for formulas. For
1085 example, if a field in a `$' row contains `max=50', then formulas
1086 in this table can refer to the value 50 using `$max'. Parameters
1087 work exactly like constants, only that they can be defined on a
1088 per-table basis. Changing a parameter and then recalculating the
1089 table can be useful.
1092 Fields in this row are automatically recalculated when pressing
1093 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1094 selected for a global recalculation with `C-u C-c *'. Unmarked
1095 lines will be left alone by this command.
1098 Selects this line for global recalculation with `C-u C-c *', but
1099 not for automatic recalculation. Use this when automatic
1100 recalculation slows down editing too much.
1103 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1104 All lines that should be recalculated should be marked with `#' or
1108 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1110 3.3.4 Named-field formulas
1111 --------------------------
1113 A named field can have its own formula associated with it. In the
1114 example above, this is used for the `at' field that contains the
1115 average result of the students. To enter a formula for a named field,
1116 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1117 This equation will be stored below the table like `$name=...'. Any
1118 recalculation in the table (even if only requested for the current
1119 line) will also update all named field formulas.
1122 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1124 3.3.5 Editing and debugging formulas
1125 ------------------------------------
1127 To edit a column or field formula, use the commands `C-c =' and `C-u
1128 C-c =', respectively. The currently active expression is then
1129 presented as default in the minibuffer, where it may be edited.
1131 Note that making a table field blank does not remove the formula
1132 associated with the field - during the next recalculation the field
1133 will be filled again. To remove a formula from a field, you have to
1134 give an empty reply when prompted for the formula, or to edit the
1137 You may edit the `#+TBLFM' directly and re-apply the changed
1138 equations with `C-c C-c' in that line, or with the normal recalculation
1139 commands in the table.
1141 In particular for large tables with many formulas, it is convenient
1142 to use the command `C-c '' to edit the formulas of the current table in
1143 a separate buffer. That buffer will show the formulas one per line,
1144 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1145 `$...' expression to get information about its interpretation.
1146 Exiting the buffer with `C-c C-c' only stores the modified formulas
1147 below the table. Exiting with `C-u C-c C-c' also applies them to the
1148 entire table. `C-c C-q' exits without installing the changes.
1150 When the evaluation of a formula leads to an error, the field content
1151 becomes the string `#ERROR'. If you would like see what is going on
1152 during variable substitution and calculation in order to find a bug,
1153 turn on formula debugging in the menu and repeat the calculation, for
1154 example by pressing `C-c = <RET>' in a field. Detailed information
1158 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1163 Finally, just to wet your appetite on what can be done with the
1164 fantastic `calc' package, here is a table that computes the Taylor
1165 series for a couple of functions (homework: try that with Excel :-)
1167 |---+-------------+---+-----+--------------------------------------|
1168 | | Func | n | x | Result |
1169 |---+-------------+---+-----+--------------------------------------|
1170 | # | exp(x) | 1 | x | 1 + x |
1171 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1172 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1173 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1174 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1175 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1176 |---+-------------+---+-----+--------------------------------------|
1177 #+TBLFM: $5=taylor($2,$4,$3);n3
1180 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1182 3.4 The Orgtbl minor mode
1183 =========================
1185 If you like the intuitive way the Org-mode table editor works, you
1186 might want to use it also in other modes like text-mode or mail-mode.
1187 The minor mode Orgtbl-mode makes this possible. You can always toggle
1188 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1191 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1194 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1196 3.5 The `table.el' package
1197 ==========================
1199 Complex ASCII tables with automatic line wrapping, column- and
1200 row-spanning, and alignment can be created using the Emacs table
1201 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1202 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1203 table, Org-mode will call `table-recognize-table' and move the cursor
1204 into the table. Inside a table, the keymap of Org-mode is inactive.
1205 In order to execute Org-mode-related commands, leave the table.
1208 Recognize `table.el' table. Works when the cursor is in a
1212 Insert a table.el table. If there is already a table at point,
1213 this command converts it between the table.el format and the
1214 Org-mode format. See the documentation string of the command
1215 `org-convert-table' for the restrictions under which this is
1219 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1224 Just like HMTL, Org-mode provides links inside a file, and external
1225 links to other files, Usenet articles, emails and much more.
1229 * Link format:: How links in Org-mode are formatted
1230 * Internal links:: Links to other places in the current file
1231 * External links:: URL-like links to the world
1232 * Handling links:: Creating, inserting and following
1233 * Search Options:: Linking to a specific location
1234 * Remember:: Org-trees store quick notes
1237 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1242 Org-mode will recognize plain URL-like links and activate them as
1243 clickable links. However, the general link format looks like this:
1245 [[link][description]] or alternatively [[link]]
1247 Once a link in the buffer is complete (all brackets present),
1248 Org-mode will change the display so that `description' is displayed
1249 instead of `[[link][description]]' and `link' is displayed instead of
1250 `[[link]]'. Links will be highlighted in the face `org-link', which by
1251 default is an underlined face. You can directly edit the visible part
1252 of a link. Note that this can be either the `link' part (if there is
1253 not description) or the `description' part. To edit also the invisible
1254 `link' part, use `C-c C-l' with the cursor on the link.
1256 If you place the cursor at the beginning or just behind the end of
1257 the displayed text and press <BACKSPACE>, you will remove the
1258 (invisible) bracket at that location. This makes the link incomplete
1259 and the internals are again displayed as plain text. Inserting the
1260 missing bracket does hide the link internals again. To show the
1261 internal structure of all links, use the menu entry
1262 `Org->Hyperlinks->Literal links'.
1265 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1270 If the link does not look like a URL, it is considered to be internal in
1271 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1272 my target]]' lead to a text search in the current file. The link can
1273 be followed with `C-c C-o' when the cursor is on the link, or with a
1274 mouse click (*note Handling links::). The preferred match for such a
1275 link is a dedicated target: The same string in double angular brackets.
1276 Targets may be located anywhere, often it is convenient to put them
1277 into a comment line, for example
1281 In HTML export (*note HTML export::), such targets will become named
1282 anchors for direct access through `http' links.
1284 If no dedicated target exists, Org-mode will search for the words in
1285 the link. In the above example the search would be for `my target'.
1286 Links starting with a star like `*My Target' restrict the search to
1287 headlines. When searching, Org-mode will first try an exact match, but
1288 then move on to more and more lenient searches. For example, the link
1289 `[[*My Targets]]' will find any of the following:
1292 ** TODO my targets are bright
1293 ** my 20 targets are
1295 To insert a link targeting a headline, in-buffer completion can be
1296 used. Just type a star followed by a few optional letters into the
1297 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1298 offered as completions. *Note Handling links::, for more commands
1301 Following a link pushes a mark onto Org-mode's own mark ring. You
1302 can return to the previous position with `C-c &'. Using this command
1303 several times in direct succession goes back to positions recorded
1308 * Radio targets:: Make targets trigger links in plain text.
1309 * CamelCase links:: Activating CamelCase words as links
1312 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1317 You can configure Org-mode to link any occurrences of certain target
1318 names in normal text. So without explicitly creating a link, the text
1319 connects to the target radioing its position. Radio targets are
1320 enclosed by triple angular brackets. For example, a target `<<<My
1321 Target>>>' causes each occurrence of `my target' in normal text to
1322 become activated as a link. The Org-mode file is scanned automatically
1323 for radio targets only when the file is first loaded into Emacs. To
1324 update the target list during editing, press `C-c C-c' with the cursor
1328 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1330 4.2.2 CamelCase words as links
1331 ------------------------------
1333 Org-mode also supports CamelCase words as links. This feature is not
1334 turned on by default because of the inconsistencies this system suffers
1335 from. To activate CamelCase words as links, you need to customize the
1336 option `org-activate-links'. A CamelCase word then leads to a text
1337 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1340 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1345 Org-mode supports links to files, websites, Usenet and email messages;
1346 and BBDB database entries. External links are URL-like locators. The
1347 following list shows examples for each link type.
1349 http://www.astro.uva.nl/~dominik on the web
1350 file:/home/dominik/images/jupiter.jpg file, absolute path
1351 file:papers/last.pdf file, relative path
1352 news:comp.emacs Usenet link
1353 mailto:adent@galaxy.net Mail link
1354 vm:folder VM folder link
1355 vm:folder#id VM message link
1356 vm://myself@some.where.org/folder#id VM on remote machine
1357 wl:folder WANDERLUST folder link
1358 wl:folder#id WANDERLUST message link
1359 mhe:folder MH-E folder link
1360 mhe:folder#id MH-E message link
1361 rmail:folder RMAIL folder link
1362 rmail:folder#id RMAIL message link
1363 gnus:group GNUS group link
1364 gnus:group#id GNUS article link
1365 bbdb:Richard Stallman BBDB link
1366 shell:ls *.org A shell command
1368 A link should be enclosed in double brackets and may contain a
1369 descriptive text to be displayed instead of the url (*note Link
1370 format::), for example:
1372 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1374 Org-mode also finds external links in the normal text and activates
1375 them as links. If spaces must be part of the link (for example in
1376 `bbdb:Richard Stallman') or to remove ambiguities about the end of the
1377 link, enclose them in angular brackets.
1380 File: org, Node: Handling links, Next: Search Options, Prev: External links, Up: Hyperlinks
1385 Org-mode provides methods to create a link in the correct syntax, to
1386 insert it into an org-mode file, and to follow the link.
1389 Store a link to the current location. This is a _global_ command
1390 which can be used in any buffer to create a link. The link will be
1391 stored for later insertion into an Org-mode buffer (see below).
1392 For Org-mode files, if there is a `<<target>>' at the cursor, the
1393 link points to the target. Otherwise it points to the current
1394 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1395 the link will indicate to the current article/entry. For W3 and
1396 W3M buffers, the link goes to the current URL. For any other
1397 files, the link will point to the file, with a search string
1398 (*note Search Options::) pointing to the contents of the current
1399 line. If there is an active region, the selected words will form
1400 the basis of the search string. The key binding `C-c l' is only a
1401 suggestion - see *Note Installation and activation::.
1404 Insert a link. This prompts for a link to be inserted into the
1405 buffer. You can just type a link, using text for an internal
1406 link, or one of the link type prefixes mentioned in the examples
1407 above. Through completion, all links stored during the current
1408 session can be accessed. The link will be inserted into the
1409 buffer, along with a descriptive text. Note that you don't have
1410 to use this command to insert a link. Links in Org-mode are plain
1411 text, and you can type or paste them straight into the buffer. By
1412 using this command, the links are automatically enclosed in double
1413 brackets, and you will be asked for the optional descriptive text.
1416 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1417 file will be inserted and you may use file name completion to
1418 select the name of the file. The path to the file is inserted
1419 relative to the directory of the current org file, if the linked
1420 file is in the current directory or in a subdirectory of it, or if
1421 the path is written relative to the current directory using `../'.
1422 Otherwise an absolute path is used, if possible with `~/' for
1423 your home directory. You can force an absolute path with two
1426 `C-c C-l with cursor on existing link'
1427 When the cursor is on an existing link, `C-c C-l' allows to edit
1428 the link and description parts of the link.
1431 Open link at point. This will launch a web browser for URLs (using
1432 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1433 the corresponding links, and execute the command in a shell link.
1434 When the cursor is on an internal link, this commands runs the
1435 corresponding search. When the cursor is on a TAGS list in a
1436 headline, it creates the corresponding TAGS view. If the cursor
1437 is on a time stamp, it compiles the agenda for that date.
1438 Furthermore, it will visit text files in `file:' links with Emacs
1439 and select a suitable application for non-text files.
1440 Classification of files is based on file extension only. See
1441 option `org-file-apps'. If you want to override the default
1442 application and visit the file with Emacs, use a `C-u' prefix.
1446 On links, `mouse-2' will open the link just like `C-c C-o' would.
1447 Under Emacs 22, also `mouse-1' will follow a link.
1450 Like `mouse-2', but force file links to be opened with Emacs.
1453 Push the current position onto the mark ring, to be able to return
1454 easily. Commands following an internal link do this automatically.
1457 Jump back to a recorded position. A position is recorded by the
1458 commands following internal links, and by `C-c %'. Using this
1459 command several times in direct succession moves through a ring of
1460 previously recorded positions.
1463 File: org, Node: Search Options, Next: Remember, Prev: Handling links, Up: Hyperlinks
1465 4.5 Search options in file links
1466 ================================
1468 File links can contain additional information to make Emacs jump to a
1469 particular location in the file when following a link. This can be a
1470 line number or a search option after a double(1) colon. For example:
1472 [[file:~/code/main.c::255]]
1473 [[file:~/xx.org::My Target]]
1474 [[file:~/xx.org::*My Target]]
1475 [[file:~/xx.org::/regexp/]]
1477 Here is what these options do.
1483 Search for a link target `<<My Target>>', or do a text search for
1484 `my target', similar to the search in internal links, see *Note
1485 Internal links::. In HTML export (*note HTML export::), such a
1486 file link will become an html reference to the corresponding named
1487 anchor in the linked file.
1490 In an Org-mode file, restrict search to headlines.
1493 Do a regular expression search for `regexp'. This uses the Emacs
1494 command `occur' to list all matches in a separate window. If the
1495 target file is in Org-mode, `org-occur' is used to create a sparse
1496 tree with the matches.
1498 As a degenerate case, a file link with an empty file name can be used
1499 to search the current file. For example, `<file:::find me>' does a
1500 search for `find me' in the current file, just like `[[find me]]' would.
1502 ---------- Footnotes ----------
1504 (1) For backward compatibility, line numbers can also follow a
1508 File: org, Node: Remember, Prev: Search Options, Up: Hyperlinks
1513 Another way to create org entries with links to other files is through
1514 the _Remember_ package by John Wiegley. _Remember_ lets you store
1515 quick notes with little interruption of your work flow. See
1516 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1517 information. The notes produced by _Remember_ can be stored in
1518 different ways, and Org-mode files are a good target. Org-mode allows
1519 to file away notes either to a default file, or directly to the correct
1520 location in your Org-mode outline tree. The following customization(1)
1521 will tell _Remember_ to use org files as target, and to create
1522 annotations compatible with Org-mode links.
1524 (setq org-directory "~/path/to/my/orgfiles/")
1525 (setq org-default-notes-file "~/.notes")
1526 (autoload 'org-remember-annotation "org")
1527 (autoload 'org-remember-apply-template "org")
1528 (autoload 'org-remember-handler "org")
1529 (setq remember-annotation-functions '(org-remember-annotation))
1530 (setq remember-handler-functions '(org-remember-handler))
1531 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1533 In combination with Org-mode, you can use templates to generate
1534 different types of remember notes. For example, if you would like to
1535 use one template to create general TODO entries, and another one for
1536 journal entries, you could use:
1538 (setq org-remember-templates
1539 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1540 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1542 In these entries, the character specifies how to select the template,
1543 the first string specifies the template, and the (optional) second
1544 string specifies a default file (overruling `org-default-notes-file')
1545 as a target for this note.
1547 When you call `M-x remember' to remember something, org will prompt
1548 for a key to select the template and then prepare the buffer like
1550 <file:link to where you called remember>
1554 * [2006-03-21 Tue 15:37]
1556 <file:link to where you called remember>
1558 See the variable `org-remember-templates' for more details.
1560 When you are finished composing a note with remember, you have to
1561 press `C-c C-c' to file the note away. The handler first prompts for a
1562 target file - if you press <RET>, the value of `org-default-notes-file'
1563 is used. Then the command offers the headings tree of the selected
1564 file. You can either immediately press <RET> to get the note appended
1565 to the file. Or you can use vertical cursor motion (<up> and <down>)
1566 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1567 or <left> or <right> leads to the following result.
1569 Cursor Key Note gets inserted
1571 buffer-start <RET> as level 2 heading at end of file
1572 on headline <RET> as sublevel of the heading at cursor
1573 <left> as same level, before current heading
1574 <right> as same level, after current heading
1575 not on <RET> at cursor position, level taken from context.
1576 headline Or use prefix arg to specify level
1579 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1580 append it to the default file. Even shorter would be `C-u C-c C-c',
1581 which does the same without even showing the tree. But with little
1582 extra effort, you can push it directly to the correct location.
1584 Before inserting the text into a tree, the function ensures that the
1585 text has a headline, i.e. a first line that starts with a `*'. If not,
1586 a headline is constructed from the current date and some additional
1587 data. If the variable `org-adapt-indentation' is non-nil, the entire
1588 text is also indented so that it starts in the same column as the
1589 headline (after the asterisks).
1591 ---------- Footnotes ----------
1593 (1) The three autoload forms are only necessary if `org.el' is not
1594 part of the Emacs distribution or an XEmacs package.
1597 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1602 Org-mode does not maintain TODO lists as a separate document. TODO
1603 items are an integral part of the notes file, because TODO items
1604 usually come up while taking notes! With Org-mode, you simply mark any
1605 entry in a tree as being a TODO item. In this way, the information is
1606 not duplicated, and the entire context from which the item emerged is
1607 always present when you check.
1609 Of course, this technique causes TODO items to be scattered
1610 throughout your file. Org-mode provides methods to give you an
1611 overview over all things you have to do.
1615 * TODO basics:: Marking and displaying TODO entries
1616 * Progress logging:: Document your productivity
1617 * TODO extensions:: Workflow and assignments
1618 * Priorities:: Some things are more important than others
1621 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1623 5.1 Basic TODO functionality
1624 ============================
1626 Any headline can become a TODO item by starting it with the word TODO,
1629 *** TODO Write letter to Sam Fortune
1631 The most important commands to work with TODO entries are:
1634 Rotate the TODO state of the current item between
1636 ,-> (unmarked) -> TODO -> DONE --.
1637 '--------------------------------'
1639 The same rotation can also be done "remotely" from the timeline and
1640 agenda buffers with the `t' command key (*note Agenda commands::).
1643 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1644 the entire buffer, but shows all TODO items and the headings
1645 hierarchy above them. With prefix arg, show also the DONE
1646 entries. With numerical prefix N, show the tree for the Nth
1647 keyword in the variable `org-todo-keywords'.
1650 Show the global TODO list. This collects the TODO items from all
1651 agenda files (*note Agenda views::) into a single buffer. The
1652 buffer is in `agenda-mode', so there are commands to examine and
1653 manipulate the TODO entries directly from that buffer (*note
1654 Agenda commands::). *Note Global TODO list::, for more
1658 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1660 5.2 Progress Logging
1661 ====================
1663 If you want to keep track of _when_ a certain TODO item was finished,
1664 turn on logging with
1666 (setq org-log-done t)
1668 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1669 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1670 [timestamp]' will be inserted just after the headline. If you turn the
1671 entry back into a TODO item again through further state cycling, that
1672 line will be removed again. In the timeline (*note Timeline::) and in
1673 the agenda (*note Weekly/Daily agenda::), you can then use the `L' key
1674 to display the TODO items closed on each day, giving you an overview of
1675 what has been done on a day.
1678 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1680 5.3 Extended use of TODO keywords
1681 =================================
1683 The default implementation of TODO entries is just two states: TODO and
1684 DONE. You can, however, use the TODO feature for more complicated
1685 things by configuring the variables `org-todo-keywords' and
1686 `org-todo-interpretation'. Using special setup, you can even use TODO
1687 keywords in different ways in different org files.
1689 Note that tags are another way to classify headlines in general and
1690 TODO items in particular (*note Tags::).
1694 * Workflow states:: From TODO to DONE in steps
1695 * TODO types:: I do this, Fred the rest
1696 * Per file keywords:: Different files, different requirements
1699 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1701 5.3.1 TODO keywords as workflow states
1702 --------------------------------------
1704 You can use TODO keywords to indicate different states in the process
1705 of working on an item, for example:
1707 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1708 org-todo-interpretation 'sequence)
1710 Changing these variables becomes only effective in a new Emacs
1711 session. With this setup, the command `C-c C-t' will cycle an entry
1712 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1713 also use a prefix argument to quickly select a specific state. For
1714 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1715 you define many keywords, you can use in-buffer completion (see *Note
1716 Completion::) to insert these words into the buffer.
1719 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1721 5.3.2 TODO keywords as types
1722 ----------------------------
1724 The second possibility is to use TODO keywords to indicate different
1725 types of action items. For example, you might want to indicate that
1726 items are for "work" or "home". If you are into David Allen's _Getting
1727 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1728 `MAYBE'. Or, when you work with several people on a single project,
1729 you might want to assign action items directly to persons, by using
1730 their names as TODO keywords. This would be set up like this:
1732 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1733 org-todo-interpretation 'type)
1735 In this case, different keywords do not indicate a sequence, but
1736 rather different types. So it is normally not useful to change from
1737 one type to another. Therefore, in this case the behavior of the
1738 command `C-c C-t' is changed slightly(1). When used several times in
1739 succession, it will still cycle through all names. But when you return
1740 to the item after some time and execute `C-c C-t' again, it will switch
1741 from each name directly to DONE. Use prefix arguments or completion to
1742 quickly select a specific name. You can also review the items of a
1743 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1744 C-v'. For example, to see all things Lucy has to do, you would use
1745 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1746 single buffer, you would use the prefix arg as well when creating the
1747 global todo list: `C-3 C-c t'.
1749 ---------- Footnotes ----------
1751 (1) This is also true for the `t' command in the timeline and agenda
1755 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1757 5.3.3 Setting up TODO keywords for individual files
1758 ---------------------------------------------------
1760 It can be very useful to use different aspects of the TODO mechanism in
1761 different files, which is not possible with the global settings
1762 described above. For file-local settings, you need to add special
1763 lines to the file which set the keywords and interpretation for that
1764 file only. For example, to set one of the two examples discussed
1765 above, you need one of the following lines, starting in column zero
1766 anywhere in the file:
1768 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1769 #+TYP_TODO: Fred Sara Lucy Mike DONE
1771 To make sure you are using the correct keyword, type `#+' into the
1772 buffer and then use `M-<TAB>' completion.
1774 Remember that the last keyword must always mean that the item is DONE
1775 (you may use a different word, though). Also note that in each file,
1776 only one of the two aspects of TODO keywords can be used. After
1777 changing one of these lines, use `C-c C-c' with the cursor still in the
1778 line to make the changes known to Org-mode(1).
1780 If you want to use very many keywords, for example when working with
1781 a large group of people, you may split the names over several lines:
1783 #+TYP_TODO: Fred Sara Lucy Mike
1784 #+TYP_TODO: Luis George Jules Jessica
1785 #+TYP_TODO: Kim Arnold Peter
1788 ---------- Footnotes ----------
1790 (1) Org-mode parses these lines only when Org-mode is activated
1791 after visiting a file. `C-c C-c' with the cursor in a line starting
1792 with `#+' is simply restarting Org-mode, making sure that these changes
1796 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1801 If you use Org-mode extensively to organize your work, you may end up
1802 with a number of TODO entries so large that you'd like to prioritize
1803 them. This can be done by placing a _priority cookie_ into the
1806 *** TODO [#A] Write letter to Sam Fortune
1808 With its standard setup, Org-mode supports priorities `A', `B', and
1809 `C'. `A' is the highest priority. An entry without a cookie is
1810 treated as priority `B'. Priorities make a difference only in the
1811 agenda (*note Weekly/Daily agenda::).
1814 Set the priority of the current item. The command prompts for a
1815 priority character `A', `B' or `C'. When you press <SPC> instead,
1816 the priority cookie is removed from the headline. The priorities
1817 can also be changed "remotely" from the timeline and agenda buffer
1818 with the `,' command (*note Agenda commands::).
1822 Increase/decrease priority of current item. Note that these keys
1823 are also used to modify time stamps (*note Creating timestamps::).
1824 Furthermore, these keys are also used by CUA-mode (*note
1828 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1833 Items can be labeled with timestamps to make them useful for project
1838 * Time stamps:: Assigning a time to a tree entry
1839 * Creating timestamps:: Commands which insert timestamps
1842 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1844 6.1 Time stamps, deadlines and scheduling
1845 =========================================
1847 A time stamp is a specification of a date (possibly with time) in a
1848 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1849 A time stamp can appear anywhere in the headline or body of an org-tree
1850 entry. Its presence allows entries to be shown on specific dates in
1851 the agenda (*note Weekly/Daily agenda::). We distinguish:
1854 A simple time stamp just assigns a date/time to an item. This is
1855 just like writing down an appointment in a paper agenda, or like
1856 writing down an event in a diary, when you want to take not of
1857 when something happened. In the timeline and agenda displays, the
1858 headline of an entry associated with a plain time stamp will be
1859 shown exactly on that date.
1862 Two time stamps connected by `--' denote a time range. The
1863 headline will be shown on the first and last day of the range, and
1864 on any dates that are displayed and fall in the range. Here is an
1867 ** Meeting in Amsterdam
1868 <2004-08-23 Mon>--<2004-08-26 Thu>
1871 If a time stamp is preceded by the word `SCHEDULED:', it means you
1872 are planning to start working on that task on the given date. So
1873 this is not about recording an event, but about planning your
1874 work. The headline will be listed under the given date. In
1875 addition, a reminder that the scheduled date has passed will be
1876 present in the compilation for _today_, until the entry is marked
1877 DONE. I.e., the task will automatically be forwarded until
1880 *** TODO Call Trillian for a date on New Years Eve.
1881 SCHEDULED: <2004-12-25 Sat>
1884 If a time stamp is preceded by the word `DEADLINE:', the task
1885 (most likely a TODO item) is supposed to be finished on that date,
1886 and it will be listed then. In addition, the compilation for
1887 _today_ will carry a warning about the approaching or missed
1888 deadline, starting `org-deadline-warning-days' before the due
1889 date, and continuing until the entry is marked DONE. An example:
1891 *** TODO write article about the Earth for the Guide
1892 The editor in charge is <bbdb:Ford Prefect>
1893 DEADLINE: <2004-02-29 Sun>
1896 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
1898 6.2 Creating timestamps
1899 =======================
1901 For Org-mode to recognize time stamps, they need to be in the specific
1902 format. All commands listed below produce time stamps in the correct
1906 Prompt for a date and insert a corresponding time stamp. When the
1907 cursor is at a previously used time stamp, it is updated to NOW.
1908 When this command is used twice in succession, a time range is
1912 Like `C-c .', but use the alternative format which contains date
1913 and time. The default time can be rounded to multiples of 5
1914 minutes, see the option `org-time-stamp-rounding-minutes'.
1917 Like `C-c .', but insert an inactive time stamp not triggering the
1921 Insert a time stamp corresponding to the cursor date in the
1925 Access the Emacs calendar for the current date. If there is a
1926 timestamp in the current line, goto the corresponding date instead.
1929 Access the agenda for the date given by the time stamp at point
1930 (*note Weekly/Daily agenda::).
1933 Insert `DEADLINE' keyword along with a stamp.
1936 Create a sparse tree with all deadlines that are either past-due,
1937 or which will become due within `org-deadline-warning-days'. With
1938 `C-u' prefix, show all deadlines in the file. With a numeric
1939 prefix, check that many days. For example, `C-1 C-c C-w' shows
1940 all deadlines due tomorrow.
1943 Insert `SCHEDULED' keyword along with a stamp.
1947 Change date at cursor by one day. These key bindings conflict with
1948 CUA-mode (*note Interaction::).
1952 Change the item under the cursor in a timestamp. The cursor can
1953 be on a year, month, day, hour or minute. Note that if the cursor
1954 is not at a time stamp, these same keys modify the priority of an
1955 item. (*note Priorities::). The key bindings also conflict with
1956 CUA-mode (*note Interaction::).
1959 Evaluate a time range by computing the difference between start and
1960 end. With prefix arg, insert result after the time range (in a
1961 table: into the following column).
1963 When Org-mode prompts for a date/time, the function reading your
1964 input will replace anything you choose not to specify with the current
1965 date and time. For details, see the documentation string of
1966 `org-read-date'. Also, a calender will pop up to allow selecting a
1967 date. The calendar can be fully controlled from the minibuffer, and a
1968 date can be selected with the following commands:
1971 Scroll calendar backwards by one month.
1974 Scroll calendar forwards by one month.
1977 Select date by clicking on it.
1998 Choose date in calendar (only if nothing typed into minibuffer).
2001 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2006 If you wish to implement a system to cross-correlate information, an
2007 excellent way is to assign tags to headline. Org-mode has extensive
2008 support for using tags.
2010 Every headline can contain a list of tags, at the end of the
2011 headline. Tags are normal words containing letters, numbers, `_', and
2012 `@'. Tags must be preceded and followed by a single colon; like
2013 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2017 * Tag inheritance:: Tags use the tree structure of the outline
2018 * Setting tags:: How to assign tags to a headline
2019 * Tag searches:: Searching for combinations of tags
2022 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2027 Tags make use of the hierarchical structure of outline trees. If a
2028 heading has a certain tag, all subheadings will inherit the tag as
2029 well. For example, in the list
2031 * Meeting with the French group :WORK:
2032 ** Summary by Frank :BOSS:NOTES:
2033 *** TODO Prepare slides for him :ACTION:
2035 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2036 `:ACTION:'. When executing tag searches and Org-mode finds that a
2037 certain headline matches the search criterion, it will not check any
2038 sublevel headline, assuming that these likely also match, and that the
2039 list of matches can become very long. However, this may not be what
2040 you want, and you can influence inheritance and searching using the
2041 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2044 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2049 As Org-mode deals with plain text files, tags can simply be typed into
2050 the buffer. After a colon, `M-<TAB>' offers completion on all tags
2051 being used in the current buffer. There is also a special command for
2055 Enter new tags for the current headline. The minibuffer will
2056 prompt for a list of tags and offer completion with respect to all
2057 other tags used in the current buffer. Several tags, separated by
2058 colons, may be specified at the prompt. After pressing <RET>, the
2059 tags will be inserted and aligned to `org-tags-column'. When
2060 called with a `C-u' prefix, all tags in the current buffer will be
2061 aligned to that column, just to make things look nice. TAGS are
2062 automatically realigned after promotion, demotion, and TODO state
2063 changes (*note TODO basics::).
2066 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2071 Once a tags system has been set up, it can be used to collect related
2072 information into special lists.
2075 Create a sparse tree with all headlines matching a tags search.
2078 Create a global list of tag matches from all agenda files. *Note
2079 Matching headline tags::.
2082 Create a global list of tag matches from all agenda files, but
2083 check only TODO items and force checking subitems (see variable
2084 `org-tags-match-list-sublevels').
2086 A tags search string can use Boolean operators `&' for AND and `|'
2087 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2088 not implemented. A tag may also be preceded by `-', to select against
2089 it, and `+' is syntactic sugar for positive selection. The AND
2090 operator `&' is optional when `+' or `-' is present. For example,
2091 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2092 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2093 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2094 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2098 File: org, Node: Agenda views, Next: Exporting, Prev: Tags, Up: Top
2103 Due to the way Org-mode works, TODO items, time-stamped items, and
2104 tagged headlines can be scattered throughout a file or even a number of
2105 files. To get an overview over open action items, or over events that
2106 are important for a particular date, this information must be collected,
2107 sorted and displayed in an organized way.
2109 Org-mode can select items based on various criteria, and display them
2110 in a separate buffer. Three different views are provided:
2112 * an _agenda_ that is like a calendar and shows information for
2115 * a _TODO list_ that covers all unfinished action items, and
2117 * a _tags view_ that shows information based on the tags associated
2118 with headlines in the outline tree.
2120 The extracted information is displayed in a special _agenda buffer_.
2121 This buffer is read-only, but provides commands to visit the
2122 corresponding locations in the original Org-mode files, and even to
2123 edit these files remotely.
2127 * Agenda files:: Files being searched for agenda information
2128 * Agenda dispatcher:: Keyboard access to agenda views
2129 * Weekly/Daily agenda:: The calendar page with current tasks
2130 * Global TODO list:: All unfinished action items
2131 * Matching headline tags:: Structured information with fine-tuned search
2132 * Timeline:: Time-sorted view for single file
2133 * Agenda commands:: Remote editing of org trees
2136 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2141 The information to be shown is collected from all _agenda files_, the
2142 files listed in the variable `org-agenda-files'(1). Thus even if you
2143 only work with a single Org-mode file, this file should be put into
2144 that list(2). You can customize `org-agenda-files', but the easiest
2145 way to maintain it is through the following commands
2148 Add current file to the list of agenda files. The file is added to
2149 the front of the list. If it was already in the list, it is moved
2150 to the front. With prefix arg, file is added/moved to the end.
2153 Remove current file from the list of agenda files.
2156 Cycle through agenda file list, visiting one file after the other.
2158 The Org menu contains the current list of files and can be used to
2161 ---------- Footnotes ----------
2163 (1) If the value of that variable is not a list, but a single file
2164 name, then the list of agenda files will be maintained in that external
2167 (2) When using the dispatcher pressing `1' before selecting a
2168 command will actually limit the command to the current file, and ignore
2169 `org-agenda-files' until the next dispatcher command.
2172 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2174 8.2 The agenda dispatcher
2175 =========================
2177 The views are created through a dispatcher that should be bound to a
2178 global key, for example `C-c a' (*note Installation and activation::).
2179 In the following we will assume that `C-c a' is indeed how the
2180 dispatcher is accessed and list keyboard access to commands
2181 accordingly. After pressing `C-c a', an additional letter is required
2182 to execute a command. The dispatcher offers the following default
2185 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2188 Create a list of all TODO items (*note Global TODO list::).
2191 Create a list of headlines matching a TAGS expression (*note
2192 Matching headline tags::).
2194 You can also define custom commands that will be accessible through
2195 the dispatcher, just like the default commands. Custom commands are
2196 global searches for tags and specific TODO keywords, or a variety of
2197 sparse tree creating commands (*note Sparse trees::). As sparse trees
2198 are only defined for a single org-mode file, these latter commands act
2199 on the current buffer instead of the list of agenda files.
2201 Custom commands are configured in the variable
2202 `org-agenda-custom-commands'. You can customize this variable, for
2203 example by pressing `C-c a C'. You can also directly set it with Emacs
2204 Lisp in `.emacs'. For example:
2206 (setq org-agenda-custom-commands
2207 '(("w" todo "WAITING")
2208 ("u" tags "+BOSS-URGENT")
2209 ("U" tags-tree "+BOSS-URGENT")
2210 ("f" occur-tree "\\<FIXME\\>")))
2212 will define `C-c a w' as a global search for TODO entries with
2213 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2214 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2215 search but only in the current buffer and display the result as a
2216 sparse tree, and `C-c a f' to create a sparse tree with all entries
2217 containing the word `FIXME'. For more information, look at the
2218 documentation string of the variable `org-agenda-custom-commands'.
2221 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
2223 8.3 The weekly/daily agenda
2224 ===========================
2226 The purpose of the weekly/daily _agenda_ is to act like a page of a
2227 paper agenda, showing all the tasks for the current week or day.
2230 Compile an agenda for the current week from a list of org files.
2231 The agenda shows the entries for each day. With a `C-u' prefix (or
2232 when the variable `org-agenda-include-all-todo' is `t'), all
2233 unfinished TODO items (including those without a date) are also
2234 listed at the beginning of the buffer, before the first date.
2236 Remote editing from the agenda buffer means, for example, that you
2237 can change the dates of deadlines and appointments from the agenda
2238 buffer. The commands available in the Agenda buffer are listed in
2239 *Note Agenda commands::.
2243 * Categories:: Not all tasks are equal
2244 * Time-of-day specifications:: How the agenda knows the time
2245 * Calendar/Diary integration:: Integrating Anniversaries and more
2246 * Sorting of agenda items:: The order of things
2249 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
2254 In the agenda buffer, each entry is preceded by a _category_, which is
2255 derived from the file name. The category can also be set with a
2256 special line anywhere in the buffer, looking like this:
2260 If there are several such lines in a file, each specifies the
2261 category for the text below it (but the first category also applies to
2262 any text before the first CATEGORY line). The display in the agenda
2263 buffer looks best if the category is not longer than 10 characters.
2266 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily agenda
2268 8.3.2 Time-of-Day Specifications
2269 --------------------------------
2271 Org-mode checks each agenda item for a time-of-day specification. The
2272 time can be part of the time stamp that triggered inclusion into the
2273 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2274 specified with two time stamps, like
2275 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2277 In the headline of the entry itself, a time(range) may also appear as
2278 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2279 Emacs diary (*note Calendar/Diary integration::), time specifications
2280 in diary entries are recognized as well.
2282 For agenda display, Org-mode extracts the time and displays it in a
2283 standard 24 hour format as part of the prefix. The example times in
2284 the previous paragraphs would end up in the agenda like this:
2286 8:30-13:00 Arthur Dent lies in front of the bulldozer
2287 12:45...... Ford Prefect arrives and takes Arthur to the pub
2288 19:00...... The Vogon reads his poem
2289 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2291 If the agenda is in single-day mode, or for the display of today, the
2292 timed entries are embedded in a time grid, like
2294 8:00...... ------------------
2295 8:30-13:00 Arthur Dent lies in front of the bulldozer
2296 10:00...... ------------------
2297 12:00...... ------------------
2298 12:45...... Ford Prefect arrives and takes Arthur to the pub
2299 14:00...... ------------------
2300 16:00...... ------------------
2301 18:00...... ------------------
2302 19:00...... The Vogon reads his poem
2303 20:00...... ------------------
2304 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2306 The time grid can be turned on and off with the variable
2307 `org-agenda-use-time-grid', and can be configured with
2308 `org-agenda-time-grid'.
2311 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily agenda
2313 8.3.3 Calendar/Diary integration
2314 --------------------------------
2316 Emacs contains the calendar and diary by Edward M. Reingold. The
2317 calendar displays a three-month calendar with holidays from different
2318 countries and cultures. The diary allows you to keep track of
2319 anniversaries, lunar phases, sunrise/set, recurrent appointments
2320 (weekly, monthly) and more. In this way, it is quite complementary to
2321 Org-mode. It can be very useful to combine output from Org-mode with
2324 In order to include entries from the Emacs diary into Org-mode's
2325 agenda, you only need to customize the variable
2327 (setq org-agenda-include-diary t)
2329 After that, everything will happen automatically. All diary entries
2330 including holidays, anniversaries etc will be included in the agenda
2331 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2332 the agenda buffer to jump to the diary file in order to edit existing
2333 diary entries. The `i' command to insert new entries for the current
2334 date works in the agenda buffer, as well as the commands `S', `M', and
2335 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2336 to other calendars, respectively. `c' can be used to switch back and
2337 forth between calendar and agenda.
2340 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily agenda
2342 8.3.4 Sorting of agenda items
2343 -----------------------------
2345 The entries for each day are sorted. The default order is to first
2346 collect all items containing an explicit time-of-day specification.
2347 These entries will be shown at the beginning of the list, as a
2348 _schedule_ for the day. After that, items remain grouped in
2349 categories, in the sequence given by `org-agenda-files'. Within each
2350 category, items are sorted by priority (*note Priorities::).
2352 The priority is a numerical quantity composed of the base priority
2353 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2354 increments for overdue scheduled or deadline items.
2356 Sorting can be customized using the variable
2357 `org-agenda-sorting-strategy'.
2360 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
2362 8.4 The global TODO list
2363 ========================
2365 The global TODO list contains all unfinished TODO items, formatted and
2366 collected into a single place.
2369 Show the global TODO list. This collects the TODO items from all
2370 agenda files (*note Agenda views::) into a single buffer. The
2371 buffer is in `agenda-mode', so there are commands to examine and
2372 manipulate the TODO entries directly from that buffer (*note
2373 Agenda commands::). *Note Global TODO list::, for more
2377 Like the above, but allows selection of a specific TODO keyword.
2378 You can also do this by specifying a prefix argument to `C-c a t'.
2379 With a `C-u' prefix you are prompted for a keyword. With a
2380 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2381 `r' key in the agenda buffer regenerates it, and you can give a
2382 prefix argument to this command to change the selected TODO
2383 keyword, for example `3 r'. If you often need a search for a
2384 specific keyword, define a custom command for it (*note Agenda
2387 Remote editing of TODO items means that you can change the state of a
2388 TODO entry with a single key press. The commands available in the TODO
2389 list are described in *Note Agenda commands::.
2392 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
2394 8.5 Matching headline tags
2395 ==========================
2397 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2398 you can select headlines based on the tags that apply to them and
2399 collect them into an agenda buffer.
2402 Produce a list of all headlines that match a given set of tags.
2403 The command prompts for a selection criterion, which is a boolean
2404 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2405 `WORK|HOME' (*note Tags::). If you often need a specific search,
2406 define a custom command for it (*note Agenda dispatcher::).
2409 Like `C-c a m', but only select headlines that are also TODO items
2410 and force checking subitems (see variable
2411 `org-tags-match-list-sublevels'.
2413 The commands available in the tags list are described in *Note
2417 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda views
2419 8.6 Timeline for a single file
2420 ==============================
2422 The timeline is not really an agenda view, because it only summarizes
2423 items from a single Org-mode file. But it also uses the agenda buffer
2424 and provides similar commands, so we discuss it here. The timeline
2425 shows all time-stamped items in a single Org-mode file (or the selected
2426 part of it), in a _time-sorted view_. The main purpose of this command
2427 is to give an overview over events in a project.
2430 Show a time-sorted view of the org file, with all time-stamped
2431 items. When called with a `C-u' prefix, all unfinished TODO
2432 entries (scheduled or not) are also listed under the current date.
2434 The commands available in the timeline buffer are listed in *Note
2438 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda views
2440 8.7 Commands in the agenda buffer
2441 =================================
2443 Entries in the agenda buffer are linked back to the org file or diary
2444 file where they originate. You are not allowed to edit the agenda
2445 buffer itself, but commands are provided to show and jump to the
2446 original entry location, and to edit the org-files "remotely" from the
2447 agenda buffer. In this way, all information is stored only once,
2448 removing the risk that your agenda and note files may diverge.
2450 Some commands can be executed with mouse clicks on agenda lines. For
2451 the other commands, the cursor needs to be in the desired line.
2457 Next line (same as <up>).
2460 Previous line (same as <down>).
2467 Display the original location of the item in another window.
2470 Display original location and recenter that window.
2475 Go to the original location of the item in another window. Under
2476 Emacs 22, `mouse-1' will also works for this.
2479 Go to the original location of the item and delete other windows.
2482 Toggle Follow mode. In Follow mode, as you move the cursor through
2483 the agenda buffer, the other window always shows the corresponding
2484 location in the org file.
2487 Toggle Logbook mode. In Logbook mode, entries that where marked
2488 DONE while logging was on (variable `org-log-done') are shown in
2495 Delete other windows.
2498 Switch to weekly view (7 days displayed together).
2501 Switch to daily view (just one day displayed).
2504 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2508 Toggle the time grid on and off. See also the variables
2509 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2512 Recreate the agenda buffer, for example to reflect the changes
2513 after modification of the time stamps of items with S-<left> and
2514 S-<right>. When the buffer is the global todo list, a prefix
2515 argument is interpreted to create a selective list for a specific
2519 Display the following `org-agenda-ndays' days. For example, if
2520 the display covers a week, switch to the following week. With
2521 prefix arg, go forward that many times `org-agenda-ndays' days.
2524 Display the previous dates.
2536 Change the TODO state of the item, both in the agenda and in the
2540 Show all tags associated with the current item. Because of
2541 inheritance, this may be more than the tags listed in the line
2545 Set tags for the current headline.
2548 Set the priority for the current item. Org-mode prompts for the
2549 priority character. If you reply with <SPC>, the priority cookie
2550 is removed from the entry.
2553 Display weighted priority of current item.
2557 Increase the priority of the current item. The priority is
2558 changed in the original buffer, but the agenda is not resorted.
2559 Use the `r' key for this.
2563 Decrease the priority of the current item.
2566 Change the time stamp associated with the current line by one day
2567 into the future. With prefix argument, change it by that many
2568 days. For example, `3 6 5 S-<right>' will change it by a year.
2569 The stamp is changed in the original org file, but the change is
2570 not directly reflected in the agenda buffer. Use the `r' key to
2574 Change the time stamp associated with the current line by one day
2578 Change the time stamp associated with the current line to today.
2579 The key `>' has been chosen, because it is the same as `S-.' on my
2583 Insert a new entry into the diary. Prompts for the type of entry
2584 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2585 new entry in the diary, just like `i d' etc. would do in the
2586 calendar. The date is taken from the cursor position.
2592 Open the Emacs calendar and move to the date at the agenda cursor.
2595 When in the calendar, compute and show the Org-mode agenda for the
2599 Show the phases of the moon for the three months around current
2603 Show sunrise and sunset times. The geographical location must be
2604 set with calendar variables, see documentation of the Emacs
2608 Convert the date at cursor into many other cultural and historic
2612 Show holidays for three month around the cursor date.
2615 Export a single iCalendar file containing entries from all agenda
2622 Quit agenda, remove the agenda buffer.
2625 Exit agenda, remove the agenda buffer and all buffers loaded by
2626 Emacs for the compilation of the agenda. Buffers created by the
2627 user to visit org files will not be removed.
2631 File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda views, Up: Top
2636 Org-mode documents can be exported into a variety of other formats. For
2637 printing and sharing of notes, ASCII export produces a readable and
2638 simple version of an Org-mode file. HTML export allows to publish a
2639 notes file on the web, while the XML format provides a solid base for
2640 exchange with a broad range of other applications. To incorporate
2641 entries with associated times like deadlines or appointments into a
2642 desktop calendar program like iCal, Org-mode can also produce extracts
2643 in the iCalendar format. Currently Org-mode only supports export, not
2644 import of these different formats.
2646 When exporting, Org-mode uses special conventions to enrich the
2647 output produced. *Note Text interpretation::, for more details.
2651 * ASCII export:: Exporting to plain ASCII
2652 * HTML export:: Exporting to HTML
2653 * XML export:: Exporting to XML
2654 * iCalendar export:: Exporting in iCalendar format
2655 * Text interpretation:: How the exporter looks at the file
2658 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2663 ASCII export produces an simple and very readable version of an Org-mode
2667 Export as ASCII file. If there is an active region, only the
2668 region will be exported. For an org file `myfile.org', the ASCII
2669 file will be `myfile.txt'. The file will be overwritten without
2672 In the exported version, the first 3 outline levels will become
2673 headlines, defining a general document structure. Additional levels
2674 will be exported as itemized lists. If you want that transition to
2675 occur at a different level, specify it with a prefix argument. For
2678 C-1 C-c C-x a org-export-as-ascii
2680 creates only top level headlines and does the rest as items.
2683 File: org, Node: HTML export, Next: XML export, Prev: ASCII export, Up: Exporting
2688 Org-mode contains an HTML exporter with extensive HTML formatting, in
2689 ways similar to John Grubers _markdown_ language, but with additional
2693 Export as HTML file `myfile.html'.
2696 Export as HTML file and open it with a browser.
2698 In the exported version, the first 3 outline levels will become
2699 headlines, defining a general document structure. Additional levels
2700 will be exported as itemized lists. If you want that transition to
2701 occur at a different level, specify it with a prefix argument. For
2706 creates two levels of headings and does the rest as items.
2708 If you want to include HTML tags which should be interpreted as such,
2709 mark them with a `@' like in `@<b>bold text@</b>'. Plain `<' and `>'
2710 are always transformed to `<' and `>' in HTML export.
2712 You can also give style information for the exported file. The
2713 default specification can be configured through the option
2714 `org-export-html-style'. If you want to use a file-local style, you
2715 may use file variables, best wrapped into a COMMENT section at the end
2716 of the outline tree. For example:
2718 * COMMENT HTML style specifications
2721 # org-export-html-style: " <style type=\"text/css\">
2722 p {font-weight: normal; color: gray; }
2727 Remember to execute `M-x normal-mode' after changing this to make
2728 the new style visible to Emacs. This command restarts org-mode for the
2729 current buffer and forces Emacs to re-evaluate the local variables
2730 section in the buffer.
2733 File: org, Node: XML export, Next: iCalendar export, Prev: HTML export, Up: Exporting
2738 Org-mode contains an XML exporter that produces XOXO-style XML.
2739 Currently, this exporter only handles the general outline structure and
2740 does not interpret any additional Org-mode features.
2743 Export as XML file `myfile.xml'.
2746 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XML export, Up: Exporting
2748 9.4 iCalendar export
2749 ====================
2751 Some people like to use Org-mode for keeping track of projects, but
2752 still prefer a standard calendar application for anniversaries and
2753 appointments. In this case it can be useful to have deadlines and
2754 other time-stamped items in Org-mode files show up in the calendar
2755 application. Org-mode can export calendar information in the standard
2759 Create iCalendar entries for the current file and store them in
2760 the same directory, using a file extension `.ics'.
2763 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2764 For each of these files, a separate iCalendar file will be
2768 Create a single large iCalendar file from all files in
2769 `org-agenda-files' and write it to the file given by
2770 `org-combined-agenda-icalendar-file'.
2772 How this calendar is best read and updated, depends on the
2773 application you are using. For example, when using iCal under Apple
2774 MacOS X, you could create a new calendar `OrgMode' (the default name
2775 for the calendar created by `C-c C-x c', see the variables
2776 `org-icalendar-combined-name' and
2777 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
2778 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
2779 use AppleScript to make iCal re-read the calendar files each time a new
2780 version of `OrgMode.ics' is produced. Here is the setup needed for
2783 (setq org-combined-agenda-icalendar-file
2784 "~/Library/Calendars/OrgMode.ics")
2785 (add-hook 'org-after-save-iCalendar-file-hook
2788 "osascript -e 'tell application \"iCal\" to reload calendars'")))
2791 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
2793 9.5 Text interpretation by the exporter
2794 =======================================
2796 The exporter backends interpret additional structure in the Org-mode
2797 file in order to produce better output.
2801 * Comment lines:: Some lines will not be exported
2802 * Enhancing text:: Subscripts, symbols and more
2803 * Export options:: How to influence the export settings
2806 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
2811 Lines starting with `#' in column zero are treated as comments and will
2812 never be exported. Also entire subtrees starting with the word
2813 `COMMENT' will never be exported. Finally, any text before the first
2814 headline will not be exported either.
2817 Toggle the COMMENT keyword at the beginning of an entry.
2820 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
2822 9.5.2 Enhancing text for export
2823 -------------------------------
2825 Some of the export backends of Org-mode allow for sophisticated text
2826 formatting, this is true in particular for the HTML backend. Org-mode
2827 has a number of typing conventions that allow to produce a richly
2830 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
2831 enumerator will be recognized and transformed if the backend
2832 supports lists. See *Note Plain lists::.
2834 * You can make words *bold*, /italic/, and _underlined_
2836 * Simple TeX-like math constructs are interpreted:
2838 - `10^22' and `J_n' are super- and subscripts. You can quote
2839 `^' and `_' with a backslash: `\_' and `\^'
2841 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
2842 use completion for these macros, just type `\' and maybe a few
2843 letters, and press `M-<TAB>' to see possible completions.
2845 * Tables are transformed into native tables under the exporter, if
2846 the export backend supports this. Data fields before the first
2847 horizontal separator line will be formatted as table header fields.
2849 * If a headline starts with the word `QUOTE', the text below the
2850 headline will be typeset as fixed-width, to allow quoting of
2851 computer codes etc. Lines starting with `:' are also typeset in
2854 Toggle fixed-width for entry (QUOTE) or region, see below.
2856 If these conversions conflict with your habits of typing ASCII text,
2857 they can all be turned off with corresponding variables (see the
2858 customization group `org-export-general', and the following section
2859 which explains how to set export options with special lines in a buffer.
2862 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
2864 9.5.3 Export options
2865 --------------------
2867 The exporter recognizes special lines in the buffer which provide
2868 additional information. These lines may be put anywhere in the file.
2869 The whole set of lines can be inserted into the buffer with `C-c C-x
2870 t'. For individual lines, a good way to make sure the keyword is
2871 correct is to type `#+' and then use `M-<TAB>' completion (*note
2875 Insert template with export options, see example below.
2877 #+TITLE: the title to be shown (default is the buffer name)
2878 #+AUTHOR: the author (default taken from `user-full-name')
2879 #+EMAIL: his/her email address (default from `user-mail-address')
2880 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
2881 #+TEXT: Some descriptive text to be inserted at the beginning.
2882 #+TEXT: Several lines may be given.
2883 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
2885 The OPTIONS line is a compact form to specify export settings. Here
2887 H: set the number of headline levels for export
2888 num: turn on/off section-numbers
2889 toc: turn on/off table of contents
2890 \n: turn on/off linebreak-preservation
2891 @: turn on/off quoted html tags
2892 :: turn on/off fixed-width sections
2893 |: turn on/off tables
2894 ^: turn on/off TeX-like syntax for sub- and superscripts.
2895 *: turn on/off emphasized text (bold, italic, underlined)
2896 TeX: turn on/off TeX macros
2899 File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
2906 * Completion:: M-TAB knows what you need
2907 * Customization:: Adapting Org-mode to your taste
2908 * Summary of in-buffer settings:: Using special lines to set options
2909 * The very busy C-c C-c key:: When in doubt, press C-c C-c
2910 * Clean view:: Getting rid of leading stars in the outline
2911 * TTY keys:: Using Org-mode on a tty
2912 * FAQ:: Frequently asked questions
2913 * Interaction:: Other Emacs packages
2914 * Bugs:: Things which do not work perfectly
2915 * Acknowledgments:: These people provided feedback and more
2918 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
2923 Org-mode supports in-buffer completion. This type of completion does
2924 not make use of the minibuffer. You simply type a few letters into the
2925 buffer and use the key to complete text right there.
2928 Complete word at point
2929 * At the beginning of a headline, complete TODO keywords.
2931 * After `\', complete TeX symbols supported by the exporter.
2933 * After `*', complete CamelCase versions of all headlines in the
2936 * After `:', complete tags used elsewhere in the buffer.
2938 * After `#+', complete the special keywords like `TYP_TODO' or
2939 `OPTIONS' which set file-specific options for Org-mode. When
2940 the option keyword is already complete, pressing `M-<TAB>'
2941 again will insert example settings for this keyword.
2943 * Elsewhere, complete dictionary words using ispell.
2946 File: org, Node: Customization, Next: Summary of in-buffer settings, Prev: Completion, Up: Miscellaneous
2951 There are more than 100 variables that can be used to customize
2952 Org-mode. For the sake of compactness of the manual, we are not
2953 describing the variables here. A structured overview of customization
2954 variables is available with `M-x org-customize'. Or select `Browse Org
2955 Group' from the `Org->Customization' menu. Many settings can also be
2956 activated on a per-file basis, by putting special lines into the buffer
2957 (*note Summary of in-buffer settings::).
2960 File: org, Node: Summary of in-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
2962 10.3 Summary of in-buffer settings
2963 ==================================
2965 Org-mode uses special lines in the buffer to define settings on a
2966 per-file basis. These lines start with a `#+' followed by a keyword, a
2967 colon, and then individual words defining a setting. Several settings
2968 words con be in the same line, but you can also have multiple lines for
2969 the keyword. While these settings are described throughout the manual,
2970 here is a summary. After changing any of those lines in the buffer,
2971 press `C-c C-c' with the cursor still in the line to activate the
2972 changes immediately. Otherwise they become effective only when the
2973 file is visited again in a new Emacs session.
2976 This line sets options to be used at startup of org-mode, when an
2977 Org-mode file is being visited. The first set of options deals
2978 with the initial visibility of the outline tree. The
2979 corresponding variable for global default settings is
2980 `org-startup-folded', with a default value `t', which means
2982 overview top-level headlines only
2983 content all headlines
2984 showall no folding at all, show everything
2985 Then there are options for aligning tables upon visiting a file.
2986 This is useful in files containing narrowed table columns. The
2987 corresponding variable is `org-startup-align-all-tables', with a
2988 default value `nil'.
2989 align align all tables
2990 noalign don't align tables on startup
2991 Here are the options for hiding leading stars in outline headings.
2992 The corresponding variables are `org-hide-leading-stars' and
2993 `org-odd-levels-only', both with a default setting `nil' (meaning
2994 `showstars' and `oddeven').
2995 hidestars make all but one of the stars starting a headline invisible.
2996 showstars show all stars starting a headline
2997 odd allow only odd outline levels (1,3,...)
2998 oddeven allow all outline levels
3000 `#+SEQ_TODO: #+TYP_TODO:'
3001 These lines that the TODO keywords and their interpretation in the
3002 current file. The corresponding variables are `org-todo-keywords'
3003 and `org-todo-interpretation'.
3006 This line sets the category for the agenda file. The category
3007 applies for all subsequent lines until the next `#+CATEGORY' line,
3008 or the end of the file.
3011 This line contains the formulas for the table directly above the
3014 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
3015 These lines provide setting for exporting files. For more details
3016 see *Note Export options::.
3019 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: Summary of in-buffer settings, Up: Miscellaneous
3021 10.4 The very busy C-c C-c key
3022 ==============================
3024 The key `C-c C-c' has many purposes in org-mode, which are all
3025 mentioned scattered throughout this manual. One specific function of
3026 this key is to add _tags_ to a headline (*note Tags::). In many other
3027 circumstances it means something like _Hey Org-mode, look here and
3028 update according to what you see here_. Here is a summary what this
3029 means in different contexts.
3031 - If the cursor is in one of the special #+KEYWORD lines, this
3032 triggers scanning the buffer for these lines and updating the
3035 - If the cursor is inside a table, realign the table. This command
3036 works even if the automatic table editor has been turned off.
3038 - If the cursor is on a #+TBLFM line, re-apply the formulas to the
3041 - If the cursor is inside a table created by the `table.el' package,
3042 activate that table.
3044 - If the current buffer is a remember buffer, close note and file it.
3045 with a prefix argument, file it without further interaction to the
3048 - If the cursor is on a <<<target>>>, update radio targets and
3049 corresponding links in this buffer.
3051 - If the cursor is on a numbered item in a plain list, renumber the
3055 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
3057 10.5 A cleaner outline view
3058 ===========================
3060 Some people find it noisy and distracting that the Org-mode headlines
3061 are starting with a potentially large number of stars. For example the
3062 tree from *Note Headlines:::
3064 * Top level headline
3070 * Another top level headline
3072 Unfortunately this is deeply ingrained into the code of Org-mode and
3073 cannot be easily changed. You can, however, modify the display in such
3074 a way that all leading stars become invisible and the outline more easy
3075 to read. To do this, customize the variable `org-hide-leading-stars'
3078 (setq org-hide-leading-stars t)
3080 or change this on a per-file basis with one of the lines (anywhere in
3083 #+STARTUP: showstars
3084 #+STARTUP: hidestars
3086 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
3089 With stars hidden, the tree becomes:
3091 * Top level headline
3097 * Another top level headline
3099 Note that the leading stars are not truly replaced by whitespace, they
3100 are only fontified with the face `org-hide' that uses the background
3101 color as font color. If are are not using either white or black
3102 background, you may have to customize this face to get the wanted
3103 effect. Another possibility is to set this font such that the extra
3104 stars are almost invisible, for example using the color `grey90' on a
3107 Things become cleaner still if you skip all the even levels and use
3108 only odd levels 1, 3, 5..., effectively adding two stars to go from one
3109 outline level to the next:
3111 * Top level headline
3117 * Another top level headline
3119 In order to make the structure editing and export commands handle this
3120 convention correctly, use
3122 (setq org-odd-levels-only t)
3124 or set this on a per-file basis with one of the following lines (don't
3125 forget to press `C-c C-c' with the cursor in the startup line to
3126 activate changes immediately).
3131 You can convert an Org-mode file from single-star-per-level to the
3132 double-star-per-level convention with `M-x org-convert-to-odd-levels
3133 RET' in that file. The reverse operation is `M-x
3134 org-convert-to-oddeven-levels'.
3137 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
3139 10.6 Using org-mode on a tty
3140 ============================
3142 Org-mode uses a number of keys that are not accessible on a tty. This
3143 applies to most special keys like cursor keys, <TAB> and <RET>, when
3144 these are combined with modifier keys like <Meta> and/or <Shift>.
3145 Org-mode uses these bindings because it needs to provide keys for a
3146 large number of commands, and because these keys appeared particularly
3147 easy to remember. In order to still be able to access the core
3148 functionality of Org-mode on a tty, alternative bindings are provided.
3149 Here is a complete list of these bindings, which are obviously more
3150 cumbersome to use. Note that sometimes a work-around can be better.
3151 For example changing a time stamp is really only fun with `S-<cursor>'
3152 keys. On a tty you would rather use `C-c .' to re-insert the
3155 Default Alternative 1 Alternative 2
3156 `S-<TAB>' `C-u <TAB>'
3157 `M-<left>' `C-c C-x l' `<Esc> <left>'
3158 `M-S-<left>'`C-c C-x L'
3159 `M-<right>' `C-c C-x r' `<Esc>
3161 `M-S-<right>'`C-c C-x R'
3162 `M-<up>' `C-c C-x u' `<Esc> <up>'
3163 `M-S-<up>' `C-c C-x U'
3164 `M-<down>' `C-c C-x d' `<Esc> <down>'
3165 `M-S-<down>'`C-c C-x D'
3166 `S-<RET>' `C-c C-x c'
3167 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3168 `M-S-<RET>' `C-c C-x M'
3171 `S-<right>' `C-c C-x
3179 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3181 10.7 Frequently asked questions
3182 ===============================
3184 1. When I try to use Org-mode, I always get `(wrong-type-argument
3186 This is a conflict with an outdated version of the `allout.el'
3187 package which pretends to be also the standard outline-mode but is
3188 not. This happens with older versions of `allout.el', for example
3189 the one distributed with Emacs 21. Upgrade to Emacs 22 and this
3190 problem will disappear. If for some reason you cannot do this,
3191 make sure that org.el is loaded _before_ `allout.el', for example
3192 by putting `(require 'org)' early enough into your `.emacs' file.
3194 2. Org-mode seems to be a useful default mode for the various
3195 `README' files I have scattered through my directories. How do I
3196 turn it on for all `README' files?
3198 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3200 3. Some of my links stopped working after I upgraded to a version
3201 4.20 or later. Why is this, and how can I fix it?
3202 These must be links in plain text, containing white space, such as
3203 `bbdb:Richard Stallman'. You need to protect these links by
3204 putting double brackets around them, like `[[bbdb:Richard
3207 4. I see that Org-mode now creates links using the double bracket
3208 convention that hides the link part and the brackets, only showing
3209 the description part. How can I convert my old links to this new
3211 Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3212 This replaces angular brackets with the new link format.
3214 5. I don't care if you find the new bracket links great, I am
3215 attached to the old style using angular brackets and no hiding of
3216 the link text. Please give them back to me, don't tell me it is
3218 Would I let you down like that? If you must, you can do this
3220 (setq org-link-style 'plain
3221 org-link-format "<%s>")
3223 6. When I am executing shell links I always get a confirmation prompt
3224 and need to type `yes <RET>', thats 4 key presses! Can I get rid
3226 The confirmation is there to protect you from unwantingly execute
3227 potentially dangerous commands. For example, imagine a link
3228 `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
3229 command would look like `Google Search', but really it would remove
3230 your home directory. If you wish, you can make it easier to
3231 respond to the query by setting `org-confirm-shell-links' to
3232 `y-or-n-p'. Then a single `y' keypress will be enough to confirm
3233 shell links. It is also possible to turn off this check entirely,
3234 but I do not recommend to do this. Be warned.
3236 7. All these stars are driving me mad, I just find the Emacs outlines
3237 unreadable. Can't you just put white space and a single star as a
3238 starter for headlines?
3239 See *Note Clean view::.
3241 8. I would like to have two windows on the same Org-mode file, but
3242 with different outline visibility. Is that possible?
3243 In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3244 See the documentation on the command `make-indirect-buffer'. In
3245 XEmacs, this is currently not possible because of the different
3246 outline implementation.
3248 9. When I export my TODO list, every TODO item becomes a separate
3249 section. How do I enforce these items to be exported as an
3251 If you plan to use ASCII or HTML export, make sure things you want
3252 to be exported as item lists are level 4 at least, even if that
3253 does mean there is a level jump. For example:
3255 * Todays top priorities
3256 **** TODO write a letter to xyz
3257 **** TODO Finish the paper
3258 **** Pick up kids at the school
3260 Alternatively, if you need a specific value for the heading/item
3261 transition in a particular file, use the `+OPTIONS' line to
3262 configure the `H' switch.
3266 10. I would like to export only a subtree of my file to HTML. How?
3267 If you want to export a subtree, mark the subtree as region and
3268 then export. Marking can be done with `C-c @ C-x C-x', for
3271 11. Org-mode takes over the S-cursor keys. I also want to use
3272 CUA-mode, is there a way to fix this conflict?
3273 Yes, see *Note Interaction::.
3275 12. One of my table columns has started to fill up with `#ERROR'.
3277 Org-mode tried to compute the column from other fields using a
3278 formula stored in the `#+TBLFM:' line just below the table, and
3279 the evaluation of the formula fails. Fix the fields used in the
3280 formula, or fix the formula, or remove it!
3282 13. When I am in the last column of a table and just above a
3283 horizontal line in the table, pressing TAB creates a new table line
3284 before the horizontal line. How can I quickly move to the line
3285 below the horizontal line instead?
3286 Press <down> (to get on the separator line) and then <TAB>. Or
3287 configure the variable `org-table-tab-jumps-over-hlines'.
3289 14. How can I change the indentation of an entire table without fixing
3291 The indentation of a table is set by the first line. So just fix
3292 the indentation of the first line and realign with <TAB>.
3294 15. Is it possible to include entries from org-mode files into my
3296 Since the org-mode agenda is much more powerful and can contain the
3297 diary (*note Calendar/Diary integration::), you should think twice
3298 before deciding to do this. Integrating Org-mode information into
3299 the diary is, however, possible. The following steps are
3300 necessary: Autoload the function `org-diary' as shown above under
3301 *Note Installation and activation::. You also need to use _fancy
3302 diary display_ by setting in `.emacs':
3304 (add-hook 'diary-display-hook 'fancy-diary-display)
3306 Then include the following line into your `~/diary' file, in order
3307 to get the entries from all files listed in the variable
3311 You may also select specific files with
3313 &%%(org-diary) ~/path/to/some/org-file.org
3314 &%%(org-diary) ~/path/to/another/org-file.org
3316 If you now launch the calendar and press `d' to display a diary,
3317 the headlines of entries containing a timestamp, date range,
3318 schedule, or deadline referring to the selected date will be
3319 listed. Just like in Org-mode's agenda view, the diary for
3320 _today_ contains additional entries for overdue deadlines and
3321 scheduled items. See also the documentation of the `org-diary'
3322 function. Under XEmacs, it is not possible to jump back from the
3323 diary to the org, this works only in the agenda buffer.
3327 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3329 10.8 Interaction with other packages
3330 ====================================
3332 Org-mode can cooperate with the following packages:
3334 `org-mouse.el' by Piotr Zielinski
3335 This package implements extended mouse functionality for Org-mode.
3336 It allows you to cycle visibility and to edit the document
3337 structure with the mouse. Best of all, it provides a
3338 context-sensitive menu on <mouse-3> that changes depending on the
3339 context of a mouse-click. Use a search engine to find this
3342 `table.el' by Takaaki Ota
3343 Org mode cooperates with table.el, see *Note table.el::.
3344 `table.el' is part of Emacs 22.
3346 `calc.el' by Dave Gillespie
3347 Org-mode uses the calc package for implementing spreadsheet
3348 functionality in its tables (*note Table calculations::).
3349 Org-modes checks for the availability of calc by looking for the
3350 function `calc-eval' which should be autoloaded in your setup if
3351 calc has been installed properly. As of Emacs 22, calc is part of
3352 the Emacs distribution. Another possibility for interaction
3353 between the two packages is using calc for embedded calculations.
3354 *Note Embedded Mode: (calc)Embedded Mode.
3356 `constants.el' by Carsten Dominik
3357 In a table formula (*note Table calculations::), it is possible to
3358 use names for natural constants or units. Instead of defining
3359 your own constants in the variable `org-table-formula-constants',
3360 install the `constants' package which defines a large number of
3361 constants and units, and lets you use unit prefixes like `M' for
3362 `Mega' etc. You will need version 2.0 of this package, available
3363 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3364 the function `constants-get', which has to be autoloaded in your
3365 setup. See the installation instructions in the file
3368 `CUA.el' by Kim. F. Storm
3369 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
3370 by CUA-mode (as well as pc-select-mode and s-region-mode) to
3371 select and extend the region. If you want to use one of these
3372 packages along with Org-mode, configure the variable
3373 `org-CUA-compatible'. When set, Org-mode will move the following
3374 keybindings in org-mode files, and in the agenda buffer (but not
3375 during date selection).
3377 S-UP -> M-p S-DOWN -> M-n
3378 S-LEFT -> M-- S-RIGHT -> M-+
3381 Yes, these are unfortunately more difficult to remember. If you
3382 want to have other replacement keys, look at the variable
3383 `org-disputed-keys'.
3385 `remember.el' by John Wiegley
3386 Org mode cooperates with remember, see *Note Remember::.
3387 `Remember.el' is not part of Emacs, find it on the web.
3390 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
3395 Here is a list of things that should work differently, but which I have
3396 found too hard to fix.
3398 * If a table field starts with a link, and if the corresponding table
3399 column is narrowed (*note Narrow columns::) to a width too small to
3400 display the link, the field would look entirely empty even though
3401 it is not. To prevent this, Org-mode throws an error. The
3402 work-around is to make the column wide enough to fit the link, or
3403 to add some text (at least 2 characters) before the link in the
3406 * Narrowing table columns does not work on XEmacs, because the
3407 `format' function does not transport text properties.
3409 * Text in an entry protected with the `QUOTE' keyword should not
3412 * When the application called by `C-c C-o' to open a file link fails
3413 (for example because the application does not exits or refuses to
3414 open the file), it does so silently. No error message is
3417 * Plain list items should be able to hold a TODO item.
3418 Unfortunately this has so many technical problems that I will only
3419 consider this change for the next major release (5.0).
3421 * The remote-editing commands in the agenda buffer cannot be undone
3422 with `undo' called from within the agenda buffer. But you can go
3423 to the corresponding buffer (using <TAB> or <RET> and execute
3426 * Recalculating a table line applies the formulas from left to right.
3427 If a formula uses _calculated_ fields further down the row,
3428 multiple recalculation may be needed to get all fields consistent.
3430 * You can only make a single word boldface or italic. To emphasize
3431 several words in a row, each must have the emphasize markers, like
3432 in `*three* *bold* *words*'.
3434 * The exporters work well, but could be made more efficient.
3437 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
3439 10.10 Acknowledgments
3440 =====================
3442 Org-mode was written by Carsten Dominik, who still maintains it at the
3443 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
3444 following people (in alphabetic order) have helped the development
3445 along with ideas, suggestions and patches. Many thanks to all of you,
3446 Org-mode would not be what it is without your input.
3448 * Thomas Baumann contributed the code for links to the MH-E email
3451 * Alex Bochannek provided a patch for rounding time stamps.
3453 * Charles Caves' suggestion sparked the implementation of templates
3456 * Pavel Chalmoviansky influenced the agenda treatment of items with
3459 * Sacha Chua suggested to copy some linking code from Planner.
3461 * Kees Dullemond inspired the use of narrowed tabled columns.
3463 * Christian Egli converted the documentation into TeXInfo format,
3464 patched CSS formatting into the HTML exporter, and inspired the
3467 * Nic Ferrier contributed mailcap and XML support.
3469 * Kai Grossjohann pointed out key-binding conflicts caused by
3472 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
3475 * Tim O'Callaghan suggested in-file links, search options for
3476 general file links, and TAGS.
3478 * Oliver Oppitz suggested multi-state TODO items.
3480 * Scott Otterson sparked the introduction of descriptive text for
3481 links, among other things.
3483 * Pete Phillips helped the development of the TAGS feature.
3485 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
3488 * Kevin Rogers contributed code to access VM files on remote hosts.
3490 * Frank Ruell solved the mystery of the `keymapp nil' bug, a conflict
3493 * Philip Rooke created the Org-mode reference card and provided lots
3496 * Christian Schlauer proposed angular brackets around links, among
3499 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
3500 `organizer-mode.el'.
3502 * Ju"rgen Vollmer contributed code generating the table of contents
3505 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
3507 * David Wainberg suggested archiving, and improvements to the linking
3510 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
3511 development of Org-mode was fully independent, and both systems are
3512 really different beasts in their basic ideas and implementation
3513 details. However, I have later looked at John's code and learned
3514 from his implementation of (i) links where the link itself is
3515 hidden and only a description is shown, and (ii) popping up a
3516 calendar to select a date.
3518 * Carsten Wimmer suggested some changes and helped fix a bug in
3521 * Roland Winkler requested additional keybindings to make Org-mode
3524 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
3528 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
3536 * acknowledgments: Acknowledgments. (line 6)
3537 * active region <1>: HTML export. (line 10)
3538 * active region <2>: ASCII export. (line 9)
3539 * active region <3>: Built-in table editor.
3541 * active region: Structure editing. (line 51)
3542 * agenda: Weekly/Daily agenda. (line 6)
3543 * agenda commands, custom: Agenda dispatcher. (line 6)
3544 * agenda dispatcher: Agenda dispatcher. (line 6)
3545 * agenda files, removing buffers: Agenda commands. (line 187)
3546 * agenda views: Agenda views. (line 6)
3547 * agenda, for single file: Timeline. (line 6)
3548 * allout.el, conflict with: FAQ. (line 6)
3549 * angular brackets, around links: External links. (line 35)
3550 * applescript, for calendar update: iCalendar export. (line 38)
3551 * archive locations: Archiving. (line 13)
3552 * archiving: Archiving. (line 6)
3553 * ASCII export: ASCII export. (line 6)
3554 * author: Feedback. (line 6)
3555 * autoload: Installation and activation.
3557 * BBDB links: External links. (line 6)
3558 * bold text: Enhancing text. (line 15)
3559 * bug reports: Feedback. (line 6)
3560 * bugs: Bugs. (line 6)
3561 * calc package: Table calculations. (line 6)
3562 * calc.el: Interaction. (line 18)
3563 * calculations, in tables <1>: Table calculations. (line 6)
3564 * calculations, in tables: Built-in table editor.
3566 * calendar integration: Calendar/Diary integration.
3568 * calendar, for selecting date: Creating timestamps. (line 68)
3569 * CamelCase link completion: Completion. (line 6)
3570 * CamelCase links: Internal links. (line 6)
3571 * CamelCase links, completion of: CamelCase links. (line 6)
3572 * category: Categories. (line 6)
3573 * children, subtree visibility state: Visibility cycling. (line 10)
3574 * clean outline view: Clean view. (line 6)
3575 * column formula: Column formulas. (line 6)
3576 * commands, in agenda buffer: Agenda commands. (line 6)
3577 * comment lines: Comment lines. (line 6)
3578 * completion, of CamelCase links <1>: Completion. (line 6)
3579 * completion, of CamelCase links: CamelCase links. (line 6)
3580 * completion, of dictionary words: Completion. (line 6)
3581 * completion, of file names: Handling links. (line 36)
3582 * completion, of links: Handling links. (line 24)
3583 * completion, of option keywords <1>: Completion. (line 6)
3584 * completion, of option keywords: Export options. (line 6)
3585 * Completion, of option keywords: Per file keywords. (line 17)
3586 * completion, of tags <1>: Completion. (line 6)
3587 * completion, of tags: Setting tags. (line 12)
3588 * completion, of TeX symbols <1>: Completion. (line 6)
3589 * completion, of TeX symbols: Enhancing text. (line 19)
3590 * completion, of TODO keywords <1>: Completion. (line 6)
3591 * completion, of TODO keywords: Workflow states. (line 12)
3592 * constants, in calculations: Formula syntax. (line 26)
3593 * constants.el: Interaction. (line 28)
3594 * contents, global visibility state: Visibility cycling. (line 19)
3595 * copying, of subtrees: Structure editing. (line 6)
3596 * creating timestamps: Creating timestamps. (line 6)
3597 * CUA.el: Interaction. (line 40)
3598 * custom agenda commands: Agenda dispatcher. (line 6)
3599 * customization: Customization. (line 6)
3600 * cutting, of subtrees: Structure editing. (line 6)
3601 * cycling, of TODO states: TODO basics. (line 13)
3602 * cycling, visibility: Visibility cycling. (line 6)
3603 * dangerous commands: FAQ. (line 48)
3604 * date stamps: Time stamps. (line 6)
3605 * date, reading in minibuffer: Creating timestamps. (line 68)
3606 * DEADLINE keyword: Time stamps. (line 43)
3607 * deadlines: Time stamps. (line 6)
3608 * demotion, of subtrees: Structure editing. (line 6)
3609 * diary entries, creating from agenda: Agenda commands. (line 145)
3610 * diary integration: Calendar/Diary integration.
3612 * dictionary word completion: Completion. (line 6)
3613 * dispatching agenda commands: Agenda dispatcher. (line 6)
3614 * document structure: Document structure. (line 6)
3615 * DONE, final TODO keyword: Per file keywords. (line 20)
3616 * editing tables: Tables. (line 6)
3617 * editing, of table formulas: Editing/debugging formulas.
3619 * emphasized text: Export options. (line 25)
3620 * enhancing text: Enhancing text. (line 6)
3621 * evaluate time range: Creating timestamps. (line 63)
3622 * exporting: Exporting. (line 6)
3623 * exporting a subtree: FAQ. (line 89)
3624 * exporting, not: Comment lines. (line 6)
3625 * extended TODO keywords: TODO extensions. (line 6)
3626 * external links: External links. (line 6)
3627 * FAQ: FAQ. (line 6)
3628 * feedback: Feedback. (line 6)
3629 * file links: External links. (line 6)
3630 * file links, searching: Search Options. (line 6)
3631 * file name completion: Handling links. (line 36)
3632 * files, adding to agenda list: Agenda files. (line 12)
3633 * filing subtrees: Archiving. (line 6)
3634 * fixed width: Enhancing text. (line 30)
3635 * fixed-width sections: Export options. (line 25)
3636 * folded, subtree visibility state: Visibility cycling. (line 10)
3637 * folding, sparse trees: Sparse trees. (line 6)
3638 * following links: Handling links. (line 51)
3639 * format specifier: Formula syntax. (line 34)
3640 * format, of links: Link format. (line 6)
3641 * formula editing: Editing/debugging formulas.
3643 * formula syntax: Formula syntax. (line 6)
3644 * formula, for named table field: Named-field formulas.
3646 * formula, for table column: Column formulas. (line 6)
3647 * formula, in tables: Built-in table editor.
3649 * global keybindings: Installation and activation.
3651 * global TODO list: Global TODO list. (line 6)
3652 * global visibility states: Visibility cycling. (line 19)
3653 * GNUS links: External links. (line 6)
3654 * hand-formatted lists: Enhancing text. (line 11)
3655 * headline levels: Export options. (line 25)
3656 * headline levels, for exporting <1>: HTML export. (line 16)
3657 * headline levels, for exporting: ASCII export. (line 15)
3658 * headline navigation: Motion. (line 6)
3659 * headline tagging: Tags. (line 6)
3660 * headline, promotion and demotion: Structure editing. (line 6)
3661 * headlines: Headlines. (line 6)
3662 * hide text: Visibility cycling. (line 6)
3663 * hiding leading stars: Clean view. (line 6)
3664 * HTML export: HTML export. (line 6)
3665 * hyperlinks: Hyperlinks. (line 6)
3666 * iCalendar export: iCalendar export. (line 6)
3667 * in-buffer settings: Summary of in-buffer settings.
3669 * indentation, of tables: FAQ. (line 113)
3670 * indirect buffers: FAQ. (line 65)
3671 * inheritance, of tags: Tag inheritance. (line 6)
3672 * inserting links: Handling links. (line 24)
3673 * installation: Installation and activation.
3675 * internal links: Internal links. (line 6)
3676 * introduction: Introduction. (line 6)
3677 * italic text: Enhancing text. (line 15)
3678 * jumping, to headlines: Motion. (line 6)
3679 * keybindings, global: Installation and activation.
3681 * keymapp nil error: FAQ. (line 6)
3682 * keyword options: Per file keywords. (line 6)
3683 * linebreak preservation: Export options. (line 25)
3684 * link completion: Handling links. (line 24)
3685 * link format: Link format. (line 6)
3686 * links, external: External links. (line 6)
3687 * links, internal: Internal links. (line 6)
3688 * links, returning to: Handling links. (line 77)
3689 * lists, hand-formatted: Enhancing text. (line 11)
3690 * lists, ordered: Plain lists. (line 6)
3691 * lists, plain: Plain lists. (line 6)
3692 * logging, of progress: Progress logging. (line 6)
3693 * maintainer: Feedback. (line 6)
3694 * make-indirect-buffer: FAQ. (line 65)
3695 * mark ring: Handling links. (line 73)
3696 * marking characters, tables: Advanced features. (line 34)
3697 * matching, of tags: Matching headline tags.
3699 * matching, tags: Tags. (line 6)
3700 * MH-E links: External links. (line 6)
3701 * minor mode for tables: orgtbl-mode. (line 6)
3702 * mode, for calc: Formula syntax. (line 34)
3703 * motion, between headlines: Motion. (line 6)
3704 * name, of column or field: Formula syntax. (line 26)
3705 * named field formula: Named-field formulas.
3707 * names as TODO keywords: TODO types. (line 6)
3708 * narrow columns in tables: Narrow columns. (line 6)
3709 * occur, command: Sparse trees. (line 6)
3710 * option keyword completion: Completion. (line 6)
3711 * options, for customization: Customization. (line 6)
3712 * options, for export: Export options. (line 6)
3713 * ordered lists: Plain lists. (line 6)
3714 * org-agenda, command: Weekly/Daily agenda. (line 9)
3715 * org-mode, turning on: Installation and activation.
3717 * org-mouse.el: Interaction. (line 8)
3718 * orgtbl-mode: orgtbl-mode. (line 6)
3719 * outline tree: Headlines. (line 6)
3720 * outline-mode: Outlines. (line 6)
3721 * outlines: Outlines. (line 6)
3722 * overview, global visibility state: Visibility cycling. (line 19)
3723 * packages, interaction with other: Interaction. (line 6)
3724 * pasting, of subtrees: Structure editing. (line 6)
3725 * per file keywords: Per file keywords. (line 6)
3726 * plain lists: Plain lists. (line 6)
3727 * plain text external links: External links. (line 35)
3728 * printing sparse trees: Sparse trees. (line 39)
3729 * priorities: Priorities. (line 6)
3730 * priorities, of agenda items: Sorting of agenda items.
3732 * progress logging: Progress logging. (line 6)
3733 * promotion, of subtrees: Structure editing. (line 6)
3734 * quoted html tags: Export options. (line 25)
3735 * ranges, time: Time stamps. (line 6)
3736 * recomputing table fields: Column formulas. (line 27)
3737 * region, active <1>: HTML export. (line 10)
3738 * region, active <2>: ASCII export. (line 9)
3739 * region, active <3>: Built-in table editor.
3741 * region, active: Structure editing. (line 51)
3742 * remember.el <1>: Interaction. (line 40)
3743 * remember.el: Remember. (line 6)
3744 * richer text: Enhancing text. (line 6)
3745 * RMAIL links: External links. (line 6)
3746 * SCHEDULED keyword: Time stamps. (line 30)
3747 * scheduling: Time stamps. (line 6)
3748 * search option in file links: Search Options. (line 6)
3749 * section-numbers: Export options. (line 25)
3750 * setting tags: Setting tags. (line 6)
3751 * SHELL links: External links. (line 6)
3752 * shell links, confirmation: FAQ. (line 48)
3753 * show all, command: Visibility cycling. (line 27)
3754 * show all, global visibility state: Visibility cycling. (line 19)
3755 * show hidden text: Visibility cycling. (line 6)
3756 * single file summary: Timeline. (line 6)
3757 * sorting, of agenda items: Sorting of agenda items.
3759 * sparse tree, for deadlines: Creating timestamps. (line 38)
3760 * sparse tree, for TODO: TODO basics. (line 20)
3761 * sparse tree, tag based: Tags. (line 6)
3762 * sparse trees: Sparse trees. (line 6)
3763 * special keywords: Summary of in-buffer settings.
3765 * spreadsheet capabilities: Table calculations. (line 6)
3766 * storing links: Handling links. (line 9)
3767 * structure editing: Structure editing. (line 6)
3768 * structure of document: Document structure. (line 6)
3769 * subtree visibility states: Visibility cycling. (line 10)
3770 * subtree, cut and paste: Structure editing. (line 6)
3771 * subtree, subtree visibility state: Visibility cycling. (line 10)
3772 * subtrees, cut and paste: Structure editing. (line 6)
3773 * summary: Summary. (line 6)
3774 * syntax, of formulas: Formula syntax. (line 6)
3775 * table editor, builtin: Built-in table editor.
3777 * table editor, table.el: table.el. (line 6)
3778 * table of contents: Export options. (line 25)
3779 * table.el <1>: Interaction. (line 14)
3780 * table.el: table.el. (line 6)
3781 * tables <1>: Export options. (line 25)
3782 * tables: Tables. (line 6)
3783 * tables, export: Enhancing text. (line 26)
3784 * tag completion: Completion. (line 6)
3785 * tag searches: Tag searches. (line 6)
3786 * tags: Tags. (line 6)
3787 * tags view: Matching headline tags.
3789 * templates, for remember: Remember. (line 26)
3790 * TeX interpretation: Enhancing text. (line 17)
3791 * TeX macros: Export options. (line 25)
3792 * TeX symbol completion: Completion. (line 6)
3793 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
3794 * thanks: Acknowledgments. (line 6)
3795 * time stamps: Time stamps. (line 6)
3796 * time, reading in minibuffer: Creating timestamps. (line 68)
3797 * time-sorted view: Timeline. (line 6)
3798 * timeline, single file: Timeline. (line 6)
3799 * timerange: Time stamps. (line 21)
3800 * timestamp: Time stamps. (line 12)
3801 * timestamps, creating: Creating timestamps. (line 6)
3802 * TODO items: TODO items. (line 6)
3803 * TODO keywords completion: Completion. (line 6)
3804 * TODO list, global: Global TODO list. (line 6)
3805 * TODO types: TODO types. (line 6)
3806 * TODO workflow: Workflow states. (line 6)
3807 * transient-mark-mode <1>: HTML export. (line 10)
3808 * transient-mark-mode <2>: ASCII export. (line 9)
3809 * transient-mark-mode <3>: Built-in table editor.
3811 * transient-mark-mode: Structure editing. (line 51)
3812 * trees, sparse: Sparse trees. (line 6)
3813 * trees, visibility: Visibility cycling. (line 6)
3814 * tty keybindings: TTY keys. (line 6)
3815 * types as TODO keywords: TODO types. (line 6)
3816 * underlined text: Enhancing text. (line 15)
3817 * URL links: External links. (line 6)
3818 * USENET links: External links. (line 6)
3819 * variables, for customization: Customization. (line 6)
3820 * vectors, in table calculations: Formula syntax. (line 23)
3821 * visibility cycling: Visibility cycling. (line 6)
3822 * visible text, printing: Sparse trees. (line 39)
3823 * VM links: External links. (line 6)
3824 * WANDERLUST links: External links. (line 6)
3825 * workflow states as TODO keywords: Workflow states. (line 6)
3826 * XML export: XML export. (line 6)
3829 File: org, Node: Key Index, Prev: Index, Up: Top
3837 * +: Agenda commands. (line 118)
3838 * ,: Agenda commands. (line 110)
3839 * -: Agenda commands. (line 124)
3840 * .: Agenda commands. (line 89)
3841 * :: Agenda commands. (line 107)
3842 * <: Creating timestamps. (line 75)
3843 * <left>: Agenda commands. (line 86)
3844 * <RET> <1>: Agenda commands. (line 41)
3845 * <RET> <2>: Creating timestamps. (line 100)
3846 * <RET>: Built-in table editor.
3848 * <right>: Agenda commands. (line 81)
3849 * <SPC>: Agenda commands. (line 28)
3850 * <TAB> <1>: Agenda commands. (line 35)
3851 * <TAB> <2>: Built-in table editor.
3853 * <TAB> <3>: Plain lists. (line 38)
3854 * <TAB>: Visibility cycling. (line 10)
3855 * > <1>: Agenda commands. (line 140)
3856 * >: Creating timestamps. (line 76)
3857 * C: Agenda commands. (line 170)
3858 * c: Agenda commands. (line 154)
3859 * C-#: Built-in table editor.
3861 * C-,: Agenda files. (line 18)
3862 * C-c !: Creating timestamps. (line 21)
3863 * C-c $: Archiving. (line 9)
3864 * C-c %: Handling links. (line 73)
3865 * C-c &: Handling links. (line 77)
3866 * C-c ' <1>: Editing/debugging formulas.
3868 * C-c ': Built-in table editor.
3870 * C-c *: Built-in table editor.
3872 * C-c +: Built-in table editor.
3874 * C-c ,: Priorities. (line 18)
3875 * C-c -: Built-in table editor.
3877 * C-c .: Creating timestamps. (line 10)
3878 * C-c /: Sparse trees. (line 15)
3879 * C-c :: Enhancing text. (line 34)
3880 * C-c ;: Comment lines. (line 11)
3881 * C-c <: Creating timestamps. (line 25)
3882 * C-c <TAB>: Built-in table editor.
3884 * C-c =: Built-in table editor.
3886 * C-c >: Creating timestamps. (line 29)
3887 * C-c ? <1>: Editing/debugging formulas.
3889 * C-c ?: Built-in table editor.
3891 * C-c [: Agenda files. (line 12)
3892 * C-c \: Tag searches. (line 9)
3893 * C-c ]: Agenda files. (line 15)
3894 * C-c ^: Built-in table editor.
3896 * C-c `: Built-in table editor.
3898 * C-c a a: Weekly/Daily agenda. (line 9)
3899 * C-c a C: Agenda dispatcher. (line 30)
3900 * C-c a M: Matching headline tags.
3902 * C-c a m: Matching headline tags.
3904 * C-c a M: Tag searches. (line 14)
3905 * C-c a m: Tag searches. (line 10)
3906 * C-c a T: Global TODO list. (line 15)
3907 * C-c a t <1>: Global TODO list. (line 9)
3908 * C-c a t: TODO basics. (line 27)
3909 * C-c C-a: Visibility cycling. (line 27)
3910 * C-c C-b: Motion. (line 15)
3911 * C-c C-c <1>: The very busy C-c C-c key.
3913 * C-c C-c <2>: Setting tags. (line 11)
3914 * C-c C-c <3>: table.el. (line 6)
3915 * C-c C-c <4>: Editing/debugging formulas.
3917 * C-c C-c <5>: Built-in table editor.
3919 * C-c C-c: Plain lists. (line 68)
3920 * C-c C-d: Creating timestamps. (line 37)
3921 * C-c C-f: Motion. (line 12)
3922 * C-c C-j: Motion. (line 21)
3923 * C-c C-l: Handling links. (line 24)
3924 * C-c C-n: Motion. (line 8)
3925 * C-c C-o <1>: Creating timestamps. (line 33)
3926 * C-c C-o: Handling links. (line 51)
3927 * C-c C-p: Motion. (line 9)
3928 * C-c C-q <1>: Editing/debugging formulas.
3930 * C-c C-q: Built-in table editor.
3932 * C-c C-r: Timeline. (line 13)
3933 * C-c C-s: Creating timestamps. (line 47)
3934 * C-c C-t: TODO basics. (line 13)
3935 * C-c C-u: Motion. (line 18)
3936 * C-c C-v: TODO basics. (line 20)
3937 * C-c C-w: Creating timestamps. (line 38)
3938 * C-c C-x a: ASCII export. (line 9)
3939 * C-c C-x b: HTML export. (line 11)
3940 * C-c C-x c: iCalendar export. (line 20)
3941 * C-c C-x C-c: Agenda commands. (line 177)
3942 * C-c C-x C-i: iCalendar export. (line 15)
3943 * C-c C-x C-k: Structure editing. (line 36)
3944 * C-c C-x C-w <1>: Built-in table editor.
3946 * C-c C-x C-w: Structure editing. (line 36)
3947 * C-c C-x C-x: XML export. (line 10)
3948 * C-c C-x C-y <1>: Built-in table editor.
3950 * C-c C-x C-y: Structure editing. (line 43)
3951 * C-c C-x h: HTML export. (line 10)
3952 * C-c C-x i: iCalendar export. (line 13)
3953 * C-c C-x M-w <1>: Built-in table editor.
3955 * C-c C-x M-w: Structure editing. (line 40)
3956 * C-c C-x t: Export options. (line 13)
3957 * C-c C-x v: Sparse trees. (line 39)
3958 * C-c C-y: Creating timestamps. (line 63)
3959 * C-c l: Handling links. (line 9)
3960 * C-c |: Built-in table editor.
3962 * C-c ~: table.el. (line 18)
3963 * C-u C-c .: Creating timestamps. (line 16)
3964 * C-u C-c =: Built-in table editor.
3966 * C-u C-c C-l: Handling links. (line 36)
3967 * D: Agenda commands. (line 66)
3968 * d: Agenda commands. (line 63)
3969 * f: Agenda commands. (line 44)
3970 * g: Agenda commands. (line 70)
3971 * H: Agenda commands. (line 174)
3972 * i: Agenda commands. (line 145)
3973 * l: Agenda commands. (line 49)
3974 * L: Agenda commands. (line 32)
3975 * M: Agenda commands. (line 161)
3976 * M-<down>: Built-in table editor.
3978 * M-<left> <1>: Built-in table editor.
3980 * M-<left>: Structure editing. (line 18)
3981 * M-<RET> <1>: Plain lists. (line 43)
3982 * M-<RET>: Structure editing. (line 6)
3983 * M-<right> <1>: Built-in table editor.
3985 * M-<right>: Structure editing. (line 21)
3986 * M-<TAB> <1>: Completion. (line 10)
3987 * M-<TAB> <2>: Setting tags. (line 6)
3988 * M-<TAB>: Per file keywords. (line 17)
3989 * M-<up>: Built-in table editor.
3991 * M-S-<down> <1>: Built-in table editor.
3993 * M-S-<down> <2>: Plain lists. (line 53)
3994 * M-S-<down>: Structure editing. (line 33)
3995 * M-S-<left> <1>: Creating timestamps. (line 97)
3996 * M-S-<left> <2>: Built-in table editor.
3998 * M-S-<left> <3>: Plain lists. (line 59)
3999 * M-S-<left>: Structure editing. (line 24)
4000 * M-S-<RET>: Structure editing. (line 15)
4001 * M-S-<right> <1>: Creating timestamps. (line 94)
4002 * M-S-<right> <2>: Built-in table editor.
4004 * M-S-<right> <3>: Plain lists. (line 59)
4005 * M-S-<right>: Structure editing. (line 27)
4006 * M-S-<up> <1>: Built-in table editor.
4008 * M-S-<up> <2>: Plain lists. (line 53)
4009 * M-S-<up>: Structure editing. (line 30)
4010 * mouse-1 <1>: Agenda commands. (line 35)
4011 * mouse-1 <2>: Creating timestamps. (line 79)
4012 * mouse-1: Handling links. (line 65)
4013 * mouse-2 <1>: Agenda commands. (line 35)
4014 * mouse-2: Handling links. (line 65)
4015 * mouse-3 <1>: Agenda commands. (line 28)
4016 * mouse-3: Handling links. (line 70)
4017 * n: Agenda commands. (line 19)
4018 * o: Agenda commands. (line 57)
4019 * P: Agenda commands. (line 115)
4020 * p: Agenda commands. (line 20)
4021 * q: Agenda commands. (line 184)
4022 * r <1>: Agenda commands. (line 74)
4023 * r: Global TODO list. (line 21)
4024 * S: Agenda commands. (line 165)
4025 * S-<down> <1>: Agenda commands. (line 124)
4026 * S-<down> <2>: Creating timestamps. (line 55)
4027 * S-<down>: Priorities. (line 25)
4028 * S-<left> <1>: Agenda commands. (line 136)
4029 * S-<left>: Creating timestamps. (line 50)
4030 * S-<RET>: Built-in table editor.
4032 * S-<right> <1>: Agenda commands. (line 128)
4033 * S-<right>: Creating timestamps. (line 50)
4034 * S-<TAB> <1>: Built-in table editor.
4036 * S-<TAB>: Visibility cycling. (line 19)
4037 * S-<up> <1>: Agenda commands. (line 118)
4038 * S-<up> <2>: Creating timestamps. (line 55)
4039 * S-<up>: Priorities. (line 25)
4040 * T: Agenda commands. (line 102)
4041 * t: Agenda commands. (line 98)
4042 * w: Agenda commands. (line 60)
4043 * x: Agenda commands. (line 187)
4049 Node: Introduction
\x7f7444
4050 Node: Summary
\x7f7758
4051 Node: Installation and activation
\x7f9866
4052 Node: Feedback
\x7f11535
4053 Node: Document structure
\x7f12321
4054 Node: Outlines
\x7f13087
4055 Node: Headlines
\x7f13747
4056 Node: Visibility cycling
\x7f14370
4057 Node: Motion
\x7f15566
4058 Node: Structure editing
\x7f16350
4059 Node: Archiving
\x7f18459
4060 Node: Sparse trees
\x7f19319
4061 Ref: Sparse trees-Footnote-1
\x7f21348
4062 Ref: Sparse trees-Footnote-2
\x7f21440
4063 Node: Plain lists
\x7f21555
4064 Ref: Plain lists-Footnote-1
\x7f24849
4065 Node: Tables
\x7f25206
4066 Node: Built-in table editor
\x7f25754
4067 Node: Narrow columns
\x7f33367
4068 Ref: Narrow columns-Footnote-1
\x7f35306
4069 Node: Table calculations
\x7f35352
4070 Node: Formula syntax
\x7f36528
4071 Ref: Formula syntax-Footnote-1
\x7f39457
4072 Node: Column formulas
\x7f39756
4073 Node: Advanced features
\x7f41518
4074 Node: Named-field formulas
\x7f44773
4075 Node: Editing/debugging formulas
\x7f45413
4076 Node: Appetizer
\x7f47171
4077 Node: orgtbl-mode
\x7f48273
4078 Node: table.el
\x7f48764
4079 Node: Hyperlinks
\x7f49741
4080 Node: Link format
\x7f50375
4081 Node: Internal links
\x7f51672
4082 Node: Radio targets
\x7f53622
4083 Node: CamelCase links
\x7f54337
4084 Node: External links
\x7f54835
4085 Node: Handling links
\x7f56760
4086 Node: Search Options
\x7f60853
4087 Ref: Search Options-Footnote-1
\x7f62323
4088 Node: Remember
\x7f62404
4089 Ref: Remember-Footnote-1
\x7f66270
4090 Node: TODO items
\x7f66394
4091 Node: TODO basics
\x7f67317
4092 Node: Progress logging
\x7f68658
4093 Node: TODO extensions
\x7f69444
4094 Node: Workflow states
\x7f70244
4095 Node: TODO types
\x7f71112
4096 Ref: TODO types-Footnote-1
\x7f72770
4097 Node: Per file keywords
\x7f72852
4098 Ref: Per file keywords-Footnote-1
\x7f74305
4099 Node: Priorities
\x7f74533
4100 Node: Timestamps
\x7f75742
4101 Node: Time stamps
\x7f76063
4102 Node: Creating timestamps
\x7f78491
4104 Node: Tag inheritance
\x7f82355
4105 Node: Setting tags
\x7f83292
4106 Node: Tag searches
\x7f84254
4107 Node: Agenda views
\x7f85463
4108 Node: Agenda files
\x7f87002
4109 Ref: Agenda files-Footnote-1
\x7f87962
4110 Ref: Agenda files-Footnote-2
\x7f88111
4111 Node: Agenda dispatcher
\x7f88303
4112 Node: Weekly/Daily agenda
\x7f90433
4113 Node: Categories
\x7f91568
4114 Node: Time-of-day specifications
\x7f92216
4115 Node: Calendar/Diary integration
\x7f94192
4116 Node: Sorting of agenda items
\x7f95569
4117 Node: Global TODO list
\x7f96401
4118 Node: Matching headline tags
\x7f97816
4119 Node: Timeline
\x7f98759
4120 Node: Agenda commands
\x7f99632
4121 Node: Exporting
\x7f104888
4122 Node: ASCII export
\x7f106018
4123 Node: HTML export
\x7f106840
4124 Node: XML export
\x7f108588
4125 Node: iCalendar export
\x7f108955
4126 Node: Text interpretation
\x7f110777
4127 Node: Comment lines
\x7f111254
4128 Node: Enhancing text
\x7f111723
4129 Node: Export options
\x7f113554
4130 Node: Miscellaneous
\x7f115156
4131 Node: Completion
\x7f115914
4132 Node: Customization
\x7f116910
4133 Node: Summary of in-buffer settings
\x7f117517
4134 Node: The very busy C-c C-c key
\x7f120278
4135 Node: Clean view
\x7f121683
4136 Node: TTY keys
\x7f124260
4138 Node: Interaction
\x7f132763
4139 Node: Bugs
\x7f135630
4140 Node: Acknowledgments
\x7f137584
4141 Node: Index
\x7f140679
4142 Node: Key Index
\x7f161903