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.36).
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.36).
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 * Publishing:: Create a web site of linked Org-mode files
58 * Miscellaneous:: All the rest which did not fit elsewhere
59 * Index:: The fast road to specific information
60 * Key Index:: Key bindings and where they are described
62 --- The Detailed Node Listing ---
66 * Summary:: Brief summary of what Org-mode does
67 * Installation and activation:: How to install Org-mode
68 * Feedback:: Bug reports, ideas, patches etc.
72 * Outlines:: Org-mode is based on outline-mode
73 * Headlines:: How to typeset org-tree headlines
74 * Visibility cycling:: Show and hide, much simplified
75 * Motion:: Jumping to other headlines
76 * Structure editing:: Changing sequence and level of headlines
77 * Archiving:: Move done task trees to a different place
78 * Sparse trees:: Matches embedded in context
79 * Plain lists:: Editing hand-formatted lists
83 * Built-in table editor:: Simple tables
84 * Narrow columns:: Stop wasting space in tables
85 * Table calculations:: Compute a field from other fields
86 * orgtbl-mode:: The table editor as minor mode
87 * table.el:: Complex tables
89 Calculations in tables
91 * Formula syntax:: How to write a formula
92 * Lisp formulas:: An alternative way to write formulas
93 * Column formulas:: Formulas valid for all fields in a column
94 * Advanced features:: Field names, parameters and automatic recalc
95 * Named-field formulas:: Formulas valid in single fields
96 * Editing/debugging formulas:: Changing a stored formula
97 * Appetizer:: Taste the power of calc
101 * Link format:: How links in Org-mode are formatted
102 * Internal links:: Links to other places in the current file
103 * External links:: URL-like links to the world
104 * Handling links:: Creating, inserting and following
105 * Search options:: Linking to a specific location
106 * Custom searches:: When the default search is not enough
107 * Remember:: Org-trees store quick notes
111 * Radio targets:: Make targets trigger links in plain text.
112 * CamelCase links:: Activating CamelCase words as links
116 * TODO basics:: Marking and displaying TODO entries
117 * Progress logging:: Document your productivity
118 * TODO extensions:: Workflow and assignments
119 * Priorities:: Some things are more important than others
121 Extended use of TODO keywords
123 * Workflow states:: From TODO to DONE in steps
124 * TODO types:: I do this, Fred the rest
125 * Per file keywords:: Different files, different requirements
129 * Time stamps:: Assigning a time to a tree entry
130 * Creating timestamps:: Commands which insert timestamps
134 * Tag inheritance:: Tags use the tree structure of the outline
135 * Setting tags:: How to assign tags to a headline
136 * Tag searches:: Searching for combinations of tags
140 * Agenda files:: Files being searched for agenda information
141 * Agenda dispatcher:: Keyboard access to agenda views
142 * Weekly/Daily agenda:: The calendar page with current tasks
143 * Global TODO list:: All unfinished action items
144 * Matching headline tags:: Structured information with fine-tuned search
145 * Timeline:: Time-sorted view for single file
146 * Agenda commands:: Remote editing of org trees
148 The weekly/daily agenda
150 * Categories:: Not all tasks are equal
151 * Time-of-day specifications:: How the agenda knows the time
152 * Calendar/Diary integration:: Integrating Anniversaries and more
153 * Sorting of agenda items:: The order of things
157 * ASCII export:: Exporting to plain ASCII
158 * HTML export:: Exporting to HTML
159 * XOXO export:: Exporting to XOXO
160 * iCalendar export:: Exporting in iCalendar format
161 * Text interpretation:: How the exporter looks at the file
163 Text interpretation by the exporter
165 * Comment lines:: Some lines will not be exported
166 * Enhancing text:: Subscripts, symbols and more
167 * Export options:: How to influence the export settings
171 * Configuration:: Defining projects
172 * Sample configuration:: Example projects
173 * Triggering publication:: Publication commands
177 * Project alist:: The central configuration variable
178 * File sources and destinations:: From here to there
179 * Selecting files:: What files are part of the project?
180 * Publishing action:: Setting the function doing the publishing
181 * Publishing options:: Tweaking HTML export
182 * Publishing links:: Which links keep working after publishing?
183 * Project page index:: Publishing a list of project files
187 * Simple example:: One-component publishing
188 * Complex example:: A multi-component publishing example
192 * Completion:: M-TAB knows what you need
193 * Customization:: Adapting Org-mode to your taste
194 * Summary of in-buffer settings:: Using special lines to set options
195 * The very busy C-c C-c key:: When in doubt, press C-c C-c
196 * Clean view:: Getting rid of leading stars in the outline
197 * TTY keys:: Using Org-mode on a tty
198 * FAQ:: Frequently asked questions
199 * Interaction:: Other Emacs packages
200 * Bugs:: Things which do not work perfectly
201 * Acknowledgments:: These people provided feedback and more
203 Interaction with other packages
205 * Extensions:: Third-party extensions for Org-mode
206 * Cooperation:: Packages Org-mode cooperates with
207 * Conflicts:: Packages that lead to conflicts
210 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
217 * Summary:: Brief summary of what Org-mode does
218 * Installation and activation:: How to install Org-mode
219 * Feedback:: Bug reports, ideas, patches etc.
222 File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
227 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
228 project planning with a fast and effective plain-text system.
230 Org-mode develops organizational tasks around NOTES files that
231 contain information about projects as plain text. Org-mode is
232 implemented on top of outline-mode, which makes it possible to keep the
233 content of large files well structured. Visibility cycling and
234 structure editing help to work with the tree. Tables are easily
235 created with a built-in table editor. Org-mode supports ToDo items,
236 deadlines, time stamps, and scheduling. It dynamically compiles
237 entries into an agenda that utilizes and smoothly integrates much of
238 the Emacs calendar and diary. Plain text URL-like links connect to
239 websites, emails, Usenet messages, BBDB entries, and any files related
240 to the projects. For printing and sharing of notes, an Org-mode file
241 can be exported as a structured ASCII file, as HTML, or (todo and
242 agenda items only) as an iCalendar file. It can also serve as a
243 publishing tool for a set of linked webpages.
245 Org-mode keeps simple things simple. When first fired up, it should
246 feel like a straightforward, easy to use outliner. Complexity is not
247 imposed, but a large amount of functionality is available when you need
248 it. Org-mode can be used on different levels and in different ways, for
251 * as an outline extension with visibility cycling and structure editing
252 * as an ASCII system and table editor for taking structured notes
253 * as an ASCII table editor with spreadsheet-like capabilities
254 * as a TODO list editor
255 * as a full agenda and planner with deadlines and work scheduling
256 * as a simple hypertext system, with HTML export
257 * as a publishing tool to create a set of interlinked webpages
259 The Org-mode table editor can be integrated into any major mode by
260 activating the minor Orgtbl-mode.
262 There is a website for Org-mode which provides links to the newest
263 version of Org-mode, as well as additional information, screen shots
264 and example files. This page is located at
265 `http://www.astro.uva.nl/~dominik/Tools/org/'.
268 File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
270 1.2 Installation and Activation
271 ===============================
273 If Org-mode is part of the Emacs distribution or an XEmacs package, you
274 only need to copy the following lines to your `.emacs' file. The last
275 two lines define _global_ keys for the commands `org-store-link' and
276 `org-agenda' - please choose suitable keys yourself.
278 ;; The following lines are always needed. Choose your own keys.
279 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
280 (define-key global-map "\C-cl" 'org-store-link)
281 (define-key global-map "\C-ca" 'org-agenda)
283 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
284 because significant functionality depends on font-locking being active.
285 You can do this with either one of the following two lines:
286 (global-font-lock-mode 1) ; for all buffers
287 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
289 If you have downloaded Org-mode from the Web, you must take
290 additional action: Byte-compile `org.el' and `org-publish.el' and put
291 them together with `org-install.el' on your load path. Then add to
294 ;; This line only if org-mode is not part of the X/Emacs distribution.
295 (require 'org-install)
297 With this setup, all files with extension `.org' will be put into
298 Org-mode. As an alternative, make the first line of a file look like
301 MY PROJECTS -*- mode: org; -*-
303 which will select Org-mode for this buffer no matter what the file's
304 name is. See also the variable `org-insert-mode-line-in-empty-file'.
307 File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
312 If you find problems with Org-mode, or if you have questions, remarks,
313 or ideas about it, please contact the maintainer Carsten Dominik at
314 <dominik@science.uva.nl>.
316 For bug reports, please provide as much information as possible,
317 including the version information of Emacs (`C-h v emacs-version
318 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
319 Org-mode related setup in `.emacs'. If an error occurs, a traceback
320 can be very useful. Often a small example file helps, along with clear
323 1. What exactly did you do?
325 2. What did you expect to happen?
327 3. What happened instead?
328 Thank you for helping to improve this mode.
331 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
336 Org-mode is based on outline mode and provides flexible commands to
337 edit the structure of the document.
341 * Outlines:: Org-mode is based on outline-mode
342 * Headlines:: How to typeset org-tree headlines
343 * Visibility cycling:: Show and hide, much simplified
344 * Motion:: Jumping to other headlines
345 * Structure editing:: Changing sequence and level of headlines
346 * Archiving:: Move done task trees to a different place
347 * Sparse trees:: Matches embedded in context
348 * Plain lists:: Editing hand-formatted lists
351 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
356 Org-mode is implemented on top of outline-mode. Outlines allow to
357 organize a document in a hierarchical structure, which (at least for
358 me) is the best representation of notes and thoughts. Overview over
359 this structure is achieved by folding (hiding) large parts of the
360 document to show only the general document structure and the parts
361 currently being worked on. Org-mode greatly simplifies the use of
362 outlines by compressing the entire show/hide functionality into a
363 single command `org-cycle', which is bound to the <TAB> key.
366 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
371 Headlines define the structure of an outline tree. The headlines in
372 Org-mode start with one or more stars, on the left margin. For example:
380 * Another top level headline
382 Some people find the many stars too noisy and would prefer an outline
383 that has whitespace followed by a single star as headline starters.
384 *Note Clean view:: describes a setup to realize this.
387 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
389 2.3 Visibility cycling
390 ======================
392 Outlines make it possible to hide parts of the text in the buffer.
393 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
394 the visibility in the buffer.
397 _Subtree cycling_: Rotate current subtree between the states
399 ,-> FOLDED -> CHILDREN -> SUBTREE --.
400 '-----------------------------------'
402 The cursor must be on a headline for this to work(1). When the
403 cursor is at the beginning of the buffer and the first line is not
404 a headline, then <TAB> actually runs global cycling (see
405 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
406 global cycling is invoked.
410 _Global cycling_: Rotate the entire buffer between the states
412 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
413 '--------------------------------------'
415 Note that inside tables, `S-<TAB>' jumps to the previous field.
420 When Emacs first visits an Org-mode file, the global state is set to
421 OVERVIEW, i.e. only the top level headlines are visible. This can be
422 configured through the variable `org-startup-folded', or on a per-file
423 basis by adding one of the following lines anywhere in the buffer:
429 ---------- Footnotes ----------
431 (1) see, however, the option `org-cycle-emulate-tab'.
433 (2) see the option `org-cycle-global-at-bob'.
436 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
441 The following commands jump to other headlines in the buffer.
450 Next heading same level.
453 Previous heading same level.
456 Backward to higher level heading.
459 Jump to a different place without changing the current outline
460 visibility. Shows the document structure in a temporary buffer,
461 where you can use visibility cycling (<TAB>) to find your
462 destination. After pressing <RET>, the cursor moves to the
463 selected location in the original buffer, and the headings
464 hierarchy above it is made visible.
467 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
469 2.5 Structure editing
470 =====================
473 Insert new heading with same level as current. If the cursor is
474 in a plain list item, a new item is created (*note Plain lists::).
475 To force creation of a new headline, use a prefix arg, or first
476 press <RET> to get to the beginning of the next line. When this
477 command is used in the middle of a line, the line is split and the
478 rest of the line becomes the new headline. If the command is used
479 at the beginning of a headline, the new headline is created before
480 the current line. If at the beginning of any other line, the
481 content of that line is made the new heading.
484 Insert new TODO entry with same level as current heading.
487 Promote current heading by one level.
490 Demote current heading by one level.
493 Promote the current subtree by one level.
496 Demote the current subtree by one level.
499 Move subtree up (swap with previous subtree of same level).
502 Move subtree down (swap with next subtree of same level).
506 Kill subtree, i.e. remove it from buffer but save in kill ring.
509 Copy subtree to kill ring.
512 Yank subtree from kill ring. This does modify the level of the
513 subtree to make sure the tree fits in nicely at the yank position.
514 The yank level can also be specified with a prefix arg, or by
515 yanking after a headline marker like `****'.
517 When there is an active region (transient-mark-mode), promotion and
518 demotion work on all headlines in the region. To select a region of
519 headlines, it is best to place both point and mark at the beginning of a
520 line, mark at the beginning of the first headline, and point at the line
521 just after the last headline to change. Note that when the cursor is
522 inside a table (*note Tables::), the Meta-Cursor keys have different
526 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
531 When a project represented by a (sub)tree is finished, you may want to
532 move the tree to an archive place, either in the same file under a
533 special top-level heading, or even to a different file.
535 Archive the subtree starting at the cursor position to the location
536 given by `org-archive-location'.
538 The default archive is a file in the same directory as the current
539 file, with the name derived by appending `_archive' to the current file
540 name. For information and examples on how to change this, see the
541 documentation string of the variable `org-archive-location'. If you
542 are also using the Org-mode agenda, archiving to a different file is a
543 good way to keep archived trees from contributing agenda items.
546 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
551 An important feature of Org-mode is the ability to construct _sparse
552 trees_ for selected information in an outline tree. A sparse tree
553 means that the entire document is folded as much as possible, but the
554 selected information is made visible along with the headline structure
555 above it(1). Just try it out and you will see immediately how it works.
557 Org-mode contains several commands creating such trees. The most
558 basic one is `org-occur':
561 Occur. Prompts for a regexp and shows a sparse tree with all
562 matches. If the match is in a headline, the headline is made
563 visible. If the match is in the body of an entry, headline and
564 body are made visible. In order to provide minimal context, also
565 the full hierarchy of headlines above the match is shown, as well
566 as the headline following the match. Each match is also
567 highlighted; the highlights disappear when the buffer is changed
568 with an editing command.
569 For frequently used sparse trees of specific search strings, you can
570 use the variable `org-agenda-custom-commands' to define fast keyboard
571 access to specific sparse trees. These commands will then be
572 accessible through the agenda dispatcher (*note Agenda dispatcher::).
575 (setq org-agenda-custom-commands
576 '(("f" occur-tree "FIXME")))
578 will define the key `C-c a f' as a shortcut for creating a sparse tree
579 matching the string `FIXME'.
581 Other commands use sparse trees as well. For example `C-c C-v'
582 creates a sparse TODO tree (*note TODO basics::).
584 To print a sparse tree, you can use the Emacs command
585 `ps-print-buffer-with-faces' which does not print invisible parts of
586 the document (2). Or you can use the command `C-c C-x v' to export
587 only the visible part of the document and print the resulting file.
589 ---------- Footnotes ----------
591 (1) See also the variables `org-show-hierarchy-above' and
592 `org-show-following-heading'.
594 (2) This does not work under XEmacs, because XEmacs uses selective
595 display for outlining, not text properties.
598 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
603 Headlines define both the structure of the Org-mode file, and also lists
604 (for example, TODO items (*note TODO items::) should be created using
605 headline levels). When taking notes, however, the plain text is
606 sometimes easier to read with hand-formatted lists. Org-mode supports
607 editing such lists, and the HTML exporter (*note Exporting::) does
608 parse and format them.
610 Org-mode knows ordered and unordered lists. Unordered list items
611 start with `-', `+', or `*'(1) as bullets. Ordered list items start
612 with `1.' or `1)'. Items belonging to the same list must have the same
613 indentation on the first line. In particular, if an ordered list
614 reaches number `10.', then the 2-digit numbers must be written
615 left-aligned with the other numbers in the list. Indentation also
616 determines the end of a list item. It ends before the next line that
617 is indented like the bullet/number, or less. For example:
620 My favorite scenes are (in this order)
621 1. Eowyns fight with the witch king
622 + this was already my favorite scene in the book
623 + I really like Miranda Otto.
624 2. The attack of the Rohirrim
625 3. Peter Jackson being shot by Legolas
627 He makes a really funny face when it happens.
628 But in the end, not individual scenes matter but the film as a whole.
630 Org-mode supports these lists by tuning filling and wrapping commands
631 to deal with them correctly.
633 Every item in a plain list can be made a checkbox by starting it with
634 the string `[ ]'. The checkbox status can conveniently be toggled with
637 * Stupid mistakes when distributing a new version
638 - [ ] update also Emacs CVS
639 - [X] forget to update index.html on the website
640 - [X] leaving a `(debug)' form in the code
642 The following commands act on items when the cursor is in the first
643 line of an item (the line with the bullet or number).
646 Items can be folded just like headline levels if you set the
647 variable `org-cycle-include-plain-lists'. The level of an item is
648 then given by the indentation of the bullet/number. Items are
649 always subordinate to real headlines, however; the hierarchies
650 remain completely separated.
653 Insert new item at current level. With prefix arg, force a new
654 heading (*note Structure editing::). If this command is used in
655 the middle of a line, the line is _split_ and the rest of the line
656 becomes the new item. If this command is executed in the
657 _whitespace before a bullet or number_, the new item is created
658 _before_ the current item. If the command is executed in the
659 white space before the text that is part of an item but does not
660 contain the bullet, a bullet is added to the current line.
663 Insert a new item with a checkbox.
667 Jump to the previous/next item in the current list.
671 Move the item including subitems up/down (swap with previous/next
672 item of same indentation). If the list is ordered, renumbering is
677 Decrease/increase the indentation of the item, including subitems.
678 Initially, the item tree is selected based on current indentation.
679 When these commands are executed several times in direct
680 succession, the initially selected region is used, even if the new
681 indentation would imply a different hierarchy. To use the new
682 hierarchy, break the command chain with a cursor motion or so.
685 If there is a checkbox in the item line, toggle the state of the
686 checkbox. Otherwise, if this is an ordered list, renumber the
687 ordered list at the cursor.
689 ---------- Footnotes ----------
691 (1) When using `*' as a bullet, lines must be indented or they will
692 be seen as top-level headlines. Also, when you are hiding leading
693 stars to get a clean outline view, plain list items starting with a
694 star are visually indistinguishable from true headlines. In short:
695 even though `*' is supported, it may be better not to use it for plain
699 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
704 Org-mode has a very fast and intuitive table editor built-in.
705 Spreadsheet-like calculations are supported in connection with the
706 Emacs `calc' package.
710 * Built-in table editor:: Simple tables
711 * Narrow columns:: Stop wasting space in tables
712 * Table calculations:: Compute a field from other fields
713 * orgtbl-mode:: The table editor as minor mode
714 * table.el:: Complex tables
717 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
719 3.1 The built-in table editor
720 =============================
722 Org-mode makes it easy to format tables in plain ASCII. Any line with
723 `|' as the first non-white character is considered part of a table.
724 `|' is also the column separator. A table might look like this:
726 | Name | Phone | Age |
727 |-------+-------+-----|
728 | Peter | 1234 | 17 |
731 A table is re-aligned automatically each time you press <TAB> or
732 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
733 field (<RET> to the next row) and creates new table rows at the end of
734 the table or before horizontal lines. The indentation of the table is
735 set by the first line. Any line starting with `|-' is considered as a
736 horizontal separator line and will be expanded on the next re-align to
737 span the whole table width. So, to create the above table, you would
743 and then press <TAB> to align the table and start filling in fields.
745 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
746 and all character keys in a special way, so that inserting and deleting
747 avoids shifting other fields. Also, when typing _immediately after the
748 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
749 the field is automatically made blank. If this behavior is too
750 unpredictable for you, configure the variables
751 `org-enable-table-editor' and `org-table-auto-blank-field'.
753 Creation and conversion
754 .......................
757 Convert the active region to table. If every line contains at
758 least one TAB character, the function assumes that the material is
759 tab separated. If not, lines are split at whitespace into fields.
760 You can use a prefix argument to indicate the minimum number of
761 consecutive spaces required to identify a field separator
763 If there is no active region, this command creates an empty
764 Org-mode table. But it's easier just to start typing, like
765 `|Name|Phone|Age <RET> |- <TAB>'.
767 Re-aligning and field motion
768 ............................
771 Re-align the table without moving the cursor.
774 Re-align the table, move to the next field. Creates a new row if
778 Re-align, move to previous field.
781 Re-align the table and move down to next row. Creates a new row if
782 necessary. At the beginning or end of a line, <RET> still does
783 NEWLINE, so it can be used to split a table.
785 Column and row editing
786 ......................
790 Move the current column left/right.
793 Kill the current column.
796 Insert a new column to the left of the cursor position.
800 Move the current row up/down.
803 Kill the current row or horizontal line.
806 Insert a new row above (with arg: below) the current row.
809 Insert a horizontal line below current row. With prefix arg, the
810 line is created above the current line.
813 Sort the table lines in the region. Point and mark must be in the
814 first and last line to be included, and must be in the column that
815 should be used for sorting. The command prompts for numerical
816 versus alphanumerical sorting.
822 Copy a rectangular region from a table to a special clipboard.
823 Point and mark determine edge fields of the rectangle. The
824 process ignores horizontal separator lines.
827 Copy a rectangular region from a table to a special clipboard, and
828 blank all fields in the rectangle. So this is the "cut" operation.
831 Paste a rectangular region into a table. The upper right corner
832 ends up in the current field. All involved fields will be
833 overwritten. If the rectangle does not fit into the present table,
834 the table is enlarged as needed. The process ignores horizontal
838 Wrap several fields in a column like a paragraph. If there is an
839 active region, and both point and mark are in the same column, the
840 text in the column is wrapped to minimum width for the given
841 number of lines. A prefix ARG may be used to change the number of
842 desired lines. If there is no region, the current field is split
843 at the cursor position and the text fragment to the right of the
844 cursor is prepended to the field one line down. If there is no
845 region, but you specify a prefix ARG, the current field is made
846 blank, and the content is appended to the field above.
852 Install a new formula for the current column and replace current
853 field with the result of the formula.
856 Install a new formula for the current field, which must be a named
857 field. Evaluate the formula and replace the field content with the
861 Edit all formulas associated with the current table in a separate
865 Recalculate the current row by applying the stored formulas from
866 left to right. When called with a `C-u' prefix, recalculate the
867 entire table, starting with the first non-header line (i.e. below
868 the first horizontal separator line). For details, see *Note
869 Table calculations::.
872 Rotate the calculation mark in first column through the states `',
873 `#', `*', `!', `$'. For the meaning of these marks see *Note
874 Advanced features::. When there is an active region, change all
878 Which table column is the cursor in? Displays number >0 in echo
882 Sum the numbers in the current column, or in the rectangle defined
883 by the active region. The result is shown in the echo area and can
884 be inserted with `C-y'.
887 When current field is empty, copy from first non-empty field above.
888 When not empty, copy current field down to next row and move cursor
889 along with it. Depending on the variable
890 `org-table-copy-increment', integer field values will be
891 incremented during copy. This key is also used by CUA-mode (*note
898 Edit the current field in a separate window. This is useful for
899 fields that are not fully visible (*note Narrow columns::). When
900 called with a `C-u' prefix, just make the full field visible, so
901 that it can be edited in place.
904 This is an alias for `C-u C-c `' to make the current field fully
907 `M-x org-table-import'
908 Import a file as a table. The table should be TAB- or whitespace
909 separated. Useful, for example, to import an Excel table or data
910 from a database, because these programs generally can write
911 TAB-separated text files. This command works by inserting the
912 file into the buffer and then converting the region to a table.
913 Any prefix argument is passed on to the converter, which uses it
914 to determine the separator.
916 `M-x org-table-export'
917 Export the table as a TAB-separated file. Useful for data
918 exchange with, for example, Excel or database programs.
921 If you don't like the automatic table editor because it gets in your
922 way on lines which you would like to start with `|', you can turn it
925 (setq org-enable-table-editor nil)
927 Then the only table command that still works is `C-c C-c' to do a
931 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
936 The width of columns is automatically determined by the table editor.
937 Sometimes a single field or a few fields need to carry more text,
938 leading to inconveniently wide columns. To limit(1) the width of a
939 column, one field anywhere in the column may contain just the string
940 `<N>' where `N' is an integer specifying the width of the column in
941 characters. The next re-align will then set the width of this column
942 to no more than this value.
944 |---+------------------------------| |---+--------|
946 | 1 | one | | 1 | one |
947 | 2 | two | ----\ | 2 | two |
948 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
949 | 4 | four | | 4 | four |
950 |---+------------------------------| |---+--------|
952 Fields that are wider become clipped and end in the string `=>'. Note
953 that the full text is still in the buffer, it is only invisible. To
954 see the full text, hold the mouse over the field - a tooltip window
955 will show the full content. To edit such a field, use the command `C-c
956 `' (that is `C-c' followed by the backquote). This will open a new
957 window with the full field. Edit it and finish with `C-c C-c'.
959 When visiting a file containing a table with narrowed columns, the
960 necessary character hiding has not yet happened, and the table needs to
961 be aligned before it looks nice. Setting the option
962 `org-startup-align-all-tables' will realign all tables in a file upon
963 visiting, but also slow down startup. You can also set this option on
964 a per-file basis with:
969 ---------- Footnotes ----------
971 (1) This feature does not work on XEmacs.
974 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
976 3.3 Calculations in tables
977 ==========================
979 The table editor makes use of the Emacs `calc' package to implement
980 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
981 derive fields from other fields. Org-mode has two levels of complexity
982 for table calculations. On the basic level, tables do only horizontal
983 computations, so a field can be computed from other fields _in the same
984 row_, and Org-mode assumes that there is only one formula for each
985 column. This is very efficient to work with and enough for many tasks.
986 On the complex level, columns and individual fields can be named for
987 easier referencing in formulas, individual named fields can have their
988 own formula associated with them, and recalculation can be automated.
992 * Formula syntax:: How to write a formula
993 * Lisp formulas:: An alternative way to write formulas
994 * Column formulas:: Formulas valid for all fields in a column
995 * Advanced features:: Field names, parameters and automatic recalc
996 * Named-field formulas:: Formulas valid in single fields
997 * Editing/debugging formulas:: Changing a stored formula
998 * Appetizer:: Taste the power of calc
1001 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1003 3.3.1 Formula syntax
1004 --------------------
1006 A formula can be any algebraic expression understood by the Emacs
1007 `calc' package. Note that `calc' has the slightly non-standard
1008 convention that `/' has lower precedence than `*', so that `a/b*c' is
1009 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1010 calc-eval: (calc)Calling Calc from Your Programs.), variable
1011 substitution takes place:
1013 $ refers to the current field
1014 $3 refers to the field in column 3 of the current row
1015 $3..$7 a vector of the fields in columns 3-7 of current row
1016 $P1..$P3 vector of column range, using column names
1017 &2 second data field above the current, in same column
1018 &5-2 vector from fifth to second field above current
1019 &III-II vector of fields between 2nd and 3rd hline above
1020 &III vector of fields between third hline above and current field
1021 $name a named field, parameter or constant
1023 The range vectors can be directly fed into the calc vector functions
1024 like `vmean' and `vsum'.
1026 `$name' is interpreted as the name of a column, parameter or
1027 constant. Constants are defined globally through the variable
1028 `org-table-formula-constants'. If you have the `constants.el' package,
1029 it will also be used to resolve constants, including natural constants
1030 like `$h' for Planck's constant, and units like `$km' for kilometers.
1031 Column names and parameters can be specified in special table lines.
1032 These are described below, see *Note Advanced features::.
1034 A formula can contain an optional mode string after a semicolon.
1035 This string consists of flags to influence calc's modes(1) during
1036 execution, e.g. `p20' to switch the internal precision to 20 digits,
1037 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1038 or fixed display format, respectively, and `D', `R', `F', and `S' to
1039 turn on degrees, radians, fraction and symbolic modes, respectively.
1040 In addition, you may provide a `printf' format specifier to reformat
1041 the final result. A few examples:
1043 $1+$2 Sum of first and second field
1044 $1+$2;%.2f Same, format result to two decimals
1045 exp($2)+exp($1) Math functions can be used
1046 $;%.1f Reformat current cell to 1 decimal
1047 ($3-32)*5/9 Degrees F -> C conversion
1048 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1049 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1050 sin($1);Dp3%.1e Same, but use printf specifier for display
1051 vmean($2..$7) Compute column range mean, using vector function
1052 vsum(&III) Sum numbers from 3rd hline above, up to here
1053 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1055 ---------- Footnotes ----------
1057 (1) By default, Org-mode uses the standard calc modes (precision 12,
1058 angular units degrees, fraction and symbolic modes off). The display
1059 format, however, has been changed to `(float 5)' to keep tables compact.
1060 The default settings can be configured using the variable
1061 `org-calc-default-modes'.
1064 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1066 3.3.2 Emacs Lisp forms as formulas
1067 ----------------------------------
1069 It is also possible to write a formula in Emacs lisp; this can be useful
1070 for string manipulation and control structures. If a formula starts
1071 with a single quote followed by an opening parenthesis, then it is
1072 evaluated as a lisp form. The evaluation should return either a string
1073 or a number. Just as with `calc' formulas, you can provide a format
1074 specifier after a semicolon. A few examples:
1076 swap the first two characters of the content of column 1
1077 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1078 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1082 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1084 3.3.3 Column formulas
1085 ---------------------
1087 To apply a formula to a field, type it directly into the field,
1088 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1089 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1090 be stored as the formula for the current column, evaluated and the
1091 current field replaced with the result. If the field contains only
1092 `=', the previously stored formula for this column is used.
1094 For each column, Org-mode will remember the most recently used
1095 formula. The information is stored in a special line starting with
1096 `#+TBLFM' directly below the table. When adding/deleting/moving
1097 columns with the appropriate commands, the stored equations will be
1098 modified accordingly. When a column used in a calculation is removed,
1099 references to this column become invalid and will cause an error upon
1100 applying the equation.
1102 Instead of typing an equation into the field, you may also use the
1103 command `C-c ='. It prompts for a formula (with default taken from the
1104 `#+TBLFM:' line) and applies it to the current field. A numerical
1105 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1106 in the current column.
1108 To recompute all the fields in a line, use the command `C-c *'. It
1109 re-applies all stored equations to the current row, from left to right.
1110 With a `C-u' prefix, this will be done to every line in the table, so
1111 use this command it you want to make sure the entire table is
1112 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1113 Global updating does not touch the line(s) above the first horizontal
1114 separator line, assuming that this is the table header.
1117 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1119 3.3.4 Advanced features
1120 -----------------------
1122 If you want the recalculation of fields to happen automatically, or if
1123 you want to be able to assign a formula to an individual field (instead
1124 of an entire column) you need to reserve the first column of the table
1125 for special marking characters. Here is an example of a table that
1126 collects exam results of students and makes use of these features:
1128 |---+---------+--------+--------+--------+-------+------|
1129 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1130 |---+---------+--------+--------+--------+-------+------|
1131 | ! | | P1 | P2 | P3 | Tot | |
1132 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1133 | ^ | | m1 | m2 | m3 | mt | |
1134 |---+---------+--------+--------+--------+-------+------|
1135 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1136 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1137 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1138 |---+---------+--------+--------+--------+-------+------|
1139 | | Average | | | | 29.7 | |
1140 | ^ | | | | | at | |
1141 | $ | max=50 | | | | | |
1142 |---+---------+--------+--------+--------+-------+------|
1143 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1145 Important: Please note that for these special tables, recalculating the
1146 table with `C-u C-c *' will only affect rows that are marked `#' or
1147 `*', and named fields. The column formulas are not applied in rows
1148 with empty first field.
1150 The marking characters have the following meaning:
1152 The fields in this line define names for the columns, so that you
1153 may refer to a column as `$Tot' instead of `$6'.
1156 This row defines names for the fields _above_ the row. With such
1157 a definition, any formula in the table may use `$m1' to refer to
1158 the value `10'. Also, named fields can have their own formula
1159 associated with them.
1162 Similar to `^', but defines names for the fields in the row
1166 Fields in this row can define _parameters_ for formulas. For
1167 example, if a field in a `$' row contains `max=50', then formulas
1168 in this table can refer to the value 50 using `$max'. Parameters
1169 work exactly like constants, only that they can be defined on a
1170 per-table basis. Changing a parameter and then recalculating the
1171 table can be useful.
1174 Fields in this row are automatically recalculated when pressing
1175 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1176 selected for a global recalculation with `C-u C-c *'. Unmarked
1177 lines will be left alone by this command.
1180 Selects this line for global recalculation with `C-u C-c *', but
1181 not for automatic recalculation. Use this when automatic
1182 recalculation slows down editing too much.
1185 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1186 All lines that should be recalculated should be marked with `#' or
1190 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1192 3.3.5 Named-field formulas
1193 --------------------------
1195 A named field can have its own formula associated with it. In the
1196 example above, this is used for the `at' field that contains the
1197 average result of the students. To enter a formula for a named field,
1198 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1199 This equation will be stored below the table like `$name=...'. Any
1200 recalculation in the table (even if only requested for the current
1201 line) will also update all named field formulas.
1204 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1206 3.3.6 Editing and debugging formulas
1207 ------------------------------------
1209 To edit a column or field formula, use the commands `C-c =' and `C-u
1210 C-c =', respectively. The currently active expression is then
1211 presented as default in the minibuffer, where it may be edited.
1213 Note that making a table field blank does not remove the formula
1214 associated with the field - during the next recalculation the field
1215 will be filled again. To remove a formula from a field, you have to
1216 give an empty reply when prompted for the formula, or to edit the
1219 You may edit the `#+TBLFM' directly and re-apply the changed
1220 equations with `C-c C-c' in that line, or with the normal recalculation
1221 commands in the table.
1223 In particular for large tables with many formulas, it is convenient
1224 to use the command `C-c '' to edit the formulas of the current table in
1225 a separate buffer. That buffer will show the formulas one per line,
1226 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1227 `$...' expression to get information about its interpretation.
1228 Exiting the buffer with `C-c C-c' only stores the modified formulas
1229 below the table. Exiting with `C-u C-c C-c' also applies them to the
1230 entire table. `C-c C-q' exits without installing the changes.
1232 When the evaluation of a formula leads to an error, the field content
1233 becomes the string `#ERROR'. If you would like see what is going on
1234 during variable substitution and calculation in order to find a bug,
1235 turn on formula debugging in the menu and repeat the calculation, for
1236 example by pressing `C-c = <RET>' in a field. Detailed information
1240 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1245 Finally, just to whet your appetite on what can be done with the
1246 fantastic `calc' package, here is a table that computes the Taylor
1247 series for a couple of functions (homework: try that with Excel :-)
1249 |---+-------------+---+-----+--------------------------------------|
1250 | | Func | n | x | Result |
1251 |---+-------------+---+-----+--------------------------------------|
1252 | # | exp(x) | 1 | x | 1 + x |
1253 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1254 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1255 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1256 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1257 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1258 |---+-------------+---+-----+--------------------------------------|
1259 #+TBLFM: $5=taylor($2,$4,$3);n3
1262 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1264 3.4 The Orgtbl minor mode
1265 =========================
1267 If you like the intuitive way the Org-mode table editor works, you
1268 might also want to use it in other modes like text-mode or mail-mode.
1269 The minor mode Orgtbl-mode makes this possible. You can always toggle
1270 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1273 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1276 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1278 3.5 The `table.el' package
1279 ==========================
1281 Complex ASCII tables with automatic line wrapping, column- and
1282 row-spanning, and alignment can be created using the Emacs table
1283 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1284 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1285 table, Org-mode will call `table-recognize-table' and move the cursor
1286 into the table. Inside a table, the keymap of Org-mode is inactive.
1287 In order to execute Org-mode-related commands, leave the table.
1290 Recognize `table.el' table. Works when the cursor is in a
1294 Insert a table.el table. If there is already a table at point,
1295 this command converts it between the table.el format and the
1296 Org-mode format. See the documentation string of the command
1297 `org-convert-table' for the restrictions under which this is
1301 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1306 Just like HTML, Org-mode provides links inside a file, and external
1307 links to other files, Usenet articles, emails, and much more.
1311 * Link format:: How links in Org-mode are formatted
1312 * Internal links:: Links to other places in the current file
1313 * External links:: URL-like links to the world
1314 * Handling links:: Creating, inserting and following
1315 * Search options:: Linking to a specific location
1316 * Custom searches:: When the default search is not enough
1317 * Remember:: Org-trees store quick notes
1320 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1325 Org-mode will recognize plain URL-like links and activate them as
1326 clickable links. The general link format, however, looks like this:
1328 [[link][description]] or alternatively [[link]]
1330 Once a link in the buffer is complete (all brackets present),
1331 Org-mode will change the display so that `description' is displayed
1332 instead of `[[link][description]]' and `link' is displayed instead of
1333 `[[link]]'. Links will be highlighted in the face `org-link', which by
1334 default is an underlined face. You can directly edit the visible part
1335 of a link. Note that this can be either the `link' part (if there is
1336 no description) or the `description' part. To edit also the invisible
1337 `link' part, use `C-c C-l' with the cursor on the link.
1339 If you place the cursor at the beginning or just behind the end of
1340 the displayed text and press <BACKSPACE>, you will remove the
1341 (invisible) bracket at that location. This makes the link incomplete
1342 and the internals are again displayed as plain text. Inserting the
1343 missing bracket hides the link internals again. To show the internal
1344 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1348 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1353 If the link does not look like a URL, it is considered to be internal in
1354 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1355 my target]]' lead to a text search in the current file. The link can
1356 be followed with `C-c C-o' when the cursor is on the link, or with a
1357 mouse click (*note Handling links::). The preferred match for such a
1358 link is a dedicated target: the same string in double angular brackets.
1359 Targets may be located anywhere; often it is convenient to put them
1360 into a comment line. For example
1364 In HTML export (*note HTML export::), such targets will become named
1365 anchors for direct access through `http' links(1).
1367 If no dedicated target exists, Org-mode will search for the words in
1368 the link. In the above example the search would be for `my target'.
1369 Links starting with a star like `*My Target' restrict the search to
1370 headlines. When searching, Org-mode will first try an exact match, but
1371 then move on to more and more lenient searches. For example, the link
1372 `[[*My Targets]]' will find any of the following:
1375 ** TODO my targets are bright
1376 ** my 20 targets are
1378 To insert a link targeting a headline, in-buffer completion can be
1379 used. Just type a star followed by a few optional letters into the
1380 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1381 offered as completions. *Note Handling links::, for more commands
1384 Following a link pushes a mark onto Org-mode's own mark ring. You
1385 can return to the previous position with `C-c &'. Using this command
1386 several times in direct succession goes back to positions recorded
1391 * Radio targets:: Make targets trigger links in plain text.
1392 * CamelCase links:: Activating CamelCase words as links
1394 ---------- Footnotes ----------
1396 (1) Note that text before the first headline will never be exported,
1397 so the first such target must be after the first headline.
1400 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1405 You can configure Org-mode to link any occurrences of certain target
1406 names in normal text. So without explicitly creating a link, the text
1407 connects to the target radioing its position. Radio targets are
1408 enclosed by triple angular brackets. For example, a target `<<<My
1409 Target>>>' causes each occurrence of `my target' in normal text to
1410 become activated as a link. The Org-mode file is scanned automatically
1411 for radio targets only when the file is first loaded into Emacs. To
1412 update the target list during editing, press `C-c C-c' with the cursor
1416 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1418 4.2.2 CamelCase words as links
1419 ------------------------------
1421 Org-mode also supports CamelCase words as links. This feature is not
1422 turned on by default because of the inconsistencies this system suffers
1423 from. To activate CamelCase words as links, you need to customize the
1424 option `org-activate-links'. A CamelCase word then leads to a text
1425 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1428 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1433 Org-mode supports links to files, websites, Usenet and email messages,
1434 and BBDB database entries. External links are URL-like locators. They
1435 start with a short identifying string followed by a colon. There can be
1436 no space after the colon. The following list shows examples for each
1439 http://www.astro.uva.nl/~dominik on the web
1440 file:/home/dominik/images/jupiter.jpg file, absolute path
1441 file:papers/last.pdf file, relative path
1442 news:comp.emacs Usenet link
1443 mailto:adent@galaxy.net Mail link
1444 vm:folder VM folder link
1445 vm:folder#id VM message link
1446 vm://myself@some.where.org/folder#id VM on remote machine
1447 wl:folder WANDERLUST folder link
1448 wl:folder#id WANDERLUST message link
1449 mhe:folder MH-E folder link
1450 mhe:folder#id MH-E message link
1451 rmail:folder RMAIL folder link
1452 rmail:folder#id RMAIL message link
1453 gnus:group GNUS group link
1454 gnus:group#id GNUS article link
1455 bbdb:Richard Stallman BBDB link
1456 shell:ls *.org A shell command
1457 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1459 A link should be enclosed in double brackets and may contain a
1460 descriptive text to be displayed instead of the url (*note Link
1461 format::), for example:
1463 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1465 Org-mode also finds external links in the normal text and activates
1466 them as links. If spaces must be part of the link (for example in
1467 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1468 end of the link, enclose them in angular brackets.
1471 File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
1476 Org-mode provides methods to create a link in the correct syntax, to
1477 insert it into an org-mode file, and to follow the link.
1480 Store a link to the current location. This is a _global_ command
1481 which can be used in any buffer to create a link. The link will be
1482 stored for later insertion into an Org-mode buffer (see below).
1483 For Org-mode files, if there is a `<<target>>' at the cursor, the
1484 link points to the target. Otherwise it points to the current
1485 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1486 the link will indicate the current article/entry. For W3 and W3M
1487 buffers, the link goes to the current URL. For any other files,
1488 the link will point to the file, with a search string (*note
1489 Search options::) pointing to the contents of the current line.
1490 If there is an active region, the selected words will form the
1491 basis of the search string. If the automatically created link is
1492 not working correctly or accurately enough, you can write custom
1493 functions to select the search string and to do the search for
1494 particular file types - see *Note Custom searches::. The key
1495 binding `C-c l' is only a suggestion - see *Note Installation and
1499 Insert a link. This prompts for a link to be inserted into the
1500 buffer. You can just type a link, using text for an internal
1501 link, or one of the link type prefixes mentioned in the examples
1502 above. Through completion, all links stored during the current
1503 session can be accessed. The link will be inserted into the
1504 buffer, along with a descriptive text. Note that you don't have
1505 to use this command to insert a link. Links in Org-mode are plain
1506 text, and you can type or paste them straight into the buffer. By
1507 using this command, the links are automatically enclosed in double
1508 brackets, and you will be asked for the optional descriptive text.
1509 If the link is a `file:' link and the linked file is located in
1510 the same directory as the current file or a subdirectory of it, the
1511 path of the file will be inserted relative to the current
1515 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1516 file will be inserted and you may use file name completion to
1517 select the name of the file. The path to the file is inserted
1518 relative to the directory of the current org file, if the linked
1519 file is in the current directory or in a subdirectory of it, or if
1520 the path is written relative to the current directory using `../'.
1521 Otherwise an absolute path is used, if possible with `~/' for
1522 your home directory. You can force an absolute path with two
1525 `C-c C-l with cursor on existing link'
1526 When the cursor is on an existing link, `C-c C-l' allows you to
1527 edit the link and description parts of the link.
1530 Open link at point. This will launch a web browser for URLs (using
1531 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1532 the corresponding links, and execute the command in a shell link.
1533 When the cursor is on an internal link, this commands runs the
1534 corresponding search. When the cursor is on a TAG list in a
1535 headline, it creates the corresponding TAGS view. If the cursor
1536 is on a time stamp, it compiles the agenda for that date.
1537 Furthermore, it will visit text files in `file:' links with Emacs
1538 and select a suitable application for non-text files.
1539 Classification of files is based on file extension only. See
1540 option `org-file-apps'. If you want to override the default
1541 application and visit the file with Emacs, use a `C-u' prefix.
1545 On links, `mouse-2' will open the link just as `C-c C-o' would.
1546 Under Emacs 22, also `mouse-1' will follow a link.
1549 Like `mouse-2', but force file links to be opened with Emacs.
1552 Push the current position onto the mark ring, to be able to return
1553 easily. Commands following an internal link do this automatically.
1556 Jump back to a recorded position. A position is recorded by the
1557 commands following internal links, and by `C-c %'. Using this
1558 command several times in direct succession moves through a ring of
1559 previously recorded positions.
1562 File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
1564 4.5 Search options in file links
1565 ================================
1567 File links can contain additional information to make Emacs jump to a
1568 particular location in the file when following a link. This can be a
1569 line number or a search option after a double(1) colon. For example,
1570 when the command `C-c l' creates a link (*note Handling links::) to a
1571 file, it encodes the words in the current line as a search string that
1572 can be used to find this line back later when following the link with
1575 Here is the syntax of the different ways to attach a search to a file
1576 link, together with an explanation:
1578 [[file:~/code/main.c::255]]
1579 [[file:~/xx.org::My Target]]
1580 [[file:~/xx.org::*My Target]]
1581 [[file:~/xx.org::/regexp/]]
1587 Search for a link target `<<My Target>>', or do a text search for
1588 `my target', similar to the search in internal links, see *Note
1589 Internal links::. In HTML export (*note HTML export::), such a
1590 file link will become an HTML reference to the corresponding named
1591 anchor in the linked file.
1594 In an Org-mode file, restrict search to headlines.
1597 Do a regular expression search for `regexp'. This uses the Emacs
1598 command `occur' to list all matches in a separate window. If the
1599 target file is in Org-mode, `org-occur' is used to create a sparse
1600 tree with the matches.
1602 As a degenerate case, a file link with an empty file name can be used
1603 to search the current file. For example, `<file:::find me>' does a
1604 search for `find me' in the current file, just as `[[find me]]' would.
1606 ---------- Footnotes ----------
1608 (1) For backward compatibility, line numbers can also follow a
1612 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1617 The default mechanism for creating search strings and for doing the
1618 actual search related to a file link may not work correctly in all
1619 cases. For example, BibTeX database files have many entries like
1620 `year="1993"' which would not result in good search strings, because
1621 the only unique identification for a BibTeX entry is the citation key.
1623 If you come across such a problem, you can write custom functions to
1624 set the right search string for a particular file type, and to do the
1625 search for the string in the file. Using `add-hook', these functions
1626 need to be added to the hook variables
1627 `org-create-file-search-functions' and
1628 `org-execute-file-search-functions'. See the docstring for these
1629 variables for more information. Org-mode actually uses this mechanism
1630 for BibTeX database files, and you can use the corresponding code as an
1631 implementation example. Search for `BibTeX links' in the source file.
1634 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1639 Another way to create org entries with links to other files is through
1640 the _Remember_ package by John Wiegley. _Remember_ lets you store
1641 quick notes with little interruption of your work flow. See
1642 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1643 information. The notes produced by _Remember_ can be stored in
1644 different ways, and Org-mode files are a good target. Org-mode allows
1645 you to file away notes either to a default file, or directly to the
1646 correct location in your Org-mode outline tree. The following
1647 customization will tell _Remember_ to use org files as target, and to
1648 create annotations compatible with Org-mode links.
1650 (setq org-directory "~/path/to/my/orgfiles/")
1651 (setq org-default-notes-file "~/.notes")
1652 (setq remember-annotation-functions '(org-remember-annotation))
1653 (setq remember-handler-functions '(org-remember-handler))
1654 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1656 In combination with Org-mode, you can use templates to generate
1657 different types of remember notes. For example, if you would like to
1658 use one template to create general TODO entries, and another one for
1659 journal entries, you could use:
1661 (setq org-remember-templates
1662 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1663 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1665 In these entries, the character specifies how to select the template,
1666 the first string specifies the template, and the (optional) second
1667 string specifies a default file (overruling `org-default-notes-file')
1668 as a target for this note.
1670 When you call `M-x remember' to remember something, org will prompt
1671 for a key to select the template and then prepare the buffer like
1673 <file:link to where you called remember>
1677 * [2006-03-21 Tue 15:37]
1679 <file:link to where you called remember>
1681 See the variable `org-remember-templates' for more details.
1683 When you are finished composing a note with remember, you have to
1684 press `C-c C-c' to file the note away. The handler first prompts for a
1685 target file - if you press <RET>, the value of `org-default-notes-file'
1686 is used. Then the command offers the headings tree of the selected
1687 file. You can either immediately press <RET> to get the note appended
1688 to the file. Or you can use vertical cursor motion (<up> and <down>)
1689 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1690 or <left> or <right> leads to the following result.
1692 Cursor Key Note gets inserted
1694 buffer-start <RET> as level 2 heading at end of file
1695 on headline <RET> as sublevel of the heading at cursor
1696 <left> as same level, before current heading
1697 <right> as same level, after current heading
1698 not on <RET> at cursor position, level taken from context.
1699 headline Or use prefix arg to specify level
1702 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1703 append it to the default file. Even shorter would be `C-u C-c C-c',
1704 which does the same without even showing the tree. But with little
1705 extra effort, you can push it directly to the correct location.
1707 Before inserting the text into a tree, the function ensures that the
1708 text has a headline, i.e. a first line that starts with a `*'. If not,
1709 a headline is constructed from the current date and some additional
1710 data. If the variable `org-adapt-indentation' is non-nil, the entire
1711 text is also indented so that it starts in the same column as the
1712 headline (after the asterisks).
1715 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1720 Org-mode does not maintain TODO lists as a separate document. TODO
1721 items are an integral part of the notes file, because TODO items
1722 usually come up while taking notes! With Org-mode, you simply mark any
1723 entry in a tree as being a TODO item. In this way, the information is
1724 not duplicated, and the entire context from which the item emerged is
1725 always present when you check.
1727 Of course, this technique causes TODO items to be scattered
1728 throughout your file. Org-mode provides methods to give you an
1729 overview over all things you have to do.
1733 * TODO basics:: Marking and displaying TODO entries
1734 * Progress logging:: Document your productivity
1735 * TODO extensions:: Workflow and assignments
1736 * Priorities:: Some things are more important than others
1739 File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
1741 5.1 Basic TODO functionality
1742 ============================
1744 Any headline can become a TODO item by starting it with the word TODO,
1747 *** TODO Write letter to Sam Fortune
1749 The most important commands to work with TODO entries are:
1752 Rotate the TODO state of the current item between
1754 ,-> (unmarked) -> TODO -> DONE --.
1755 '--------------------------------'
1757 The same rotation can also be done "remotely" from the timeline and
1758 agenda buffers with the `t' command key (*note Agenda commands::).
1762 Select the following/preceding TODO state, similar to cycling.
1763 Mostly useful if more than two TODO states are possible (*note
1767 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1768 the entire buffer, but shows all TODO items and the headings
1769 hierarchy above them. With prefix arg, show also the DONE
1770 entries. With numerical prefix N, show the tree for the Nth
1771 keyword in the variable `org-todo-keywords'.
1774 Show the global TODO list. This collects the TODO items from all
1775 agenda files (*note Agenda views::) into a single buffer. The
1776 buffer is in `agenda-mode', so there are commands to examine and
1777 manipulate the TODO entries directly from that buffer (*note
1778 Agenda commands::). *Note Global TODO list::, for more
1782 File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
1784 5.2 Progress Logging
1785 ====================
1787 If you want to keep track of _when_ a certain TODO item was finished,
1788 turn on logging with
1790 (setq org-log-done t)
1792 Then each time you turn a TODO entry into DONE using either `C-c C-t'
1793 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
1794 [timestamp]' will be inserted just after the headline. If you turn the
1795 entry back into a TODO item again through further state cycling, that
1796 line will be removed again. In the timeline (*note Timeline::) and in
1797 the agenda (*note Weekly/Daily agenda::), you can then use the `L' key
1798 to display the TODO items closed on each day, giving you an overview of
1799 what has been done on a day.
1802 File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
1804 5.3 Extended use of TODO keywords
1805 =================================
1807 The default implementation of TODO entries is just two states: TODO and
1808 DONE. You can, however, use the TODO feature for more complicated
1809 things by configuring the variables `org-todo-keywords' and
1810 `org-todo-interpretation'. Using special setup, you can even use TODO
1811 keywords in different ways in different org files.
1813 Note that tags are another way to classify headlines in general and
1814 TODO items in particular (*note Tags::).
1818 * Workflow states:: From TODO to DONE in steps
1819 * TODO types:: I do this, Fred the rest
1820 * Per file keywords:: Different files, different requirements
1823 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1825 5.3.1 TODO keywords as workflow states
1826 --------------------------------------
1828 You can use TODO keywords to indicate different states in the process
1829 of working on an item, for example:
1831 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1832 org-todo-interpretation 'sequence)
1834 Changing these variables only becomes effective in a new Emacs
1835 session. With this setup, the command `C-c C-t' will cycle an entry
1836 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1837 also use a prefix argument to quickly select a specific state. For
1838 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1839 you define many keywords, you can use in-buffer completion (see *Note
1840 Completion::) to insert these words into the buffer.
1843 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1845 5.3.2 TODO keywords as types
1846 ----------------------------
1848 The second possibility is to use TODO keywords to indicate different
1849 types of action items. For example, you might want to indicate that
1850 items are for "work" or "home". If you are into David Allen's _Getting
1851 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1852 `MAYBE'. Or, when you work with several people on a single project,
1853 you might want to assign action items directly to persons, by using
1854 their names as TODO keywords. This would be set up like this:
1856 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1857 org-todo-interpretation 'type)
1859 In this case, different keywords do not indicate a sequence, but
1860 rather different types. So it is normally not useful to change from
1861 one type to another. Therefore, in this case the behavior of the
1862 command `C-c C-t' is changed slightly(1). When used several times in
1863 succession, it will still cycle through all names. But when you return
1864 to the item after some time and execute `C-c C-t' again, it will switch
1865 from each name directly to DONE. Use prefix arguments or completion to
1866 quickly select a specific name. You can also review the items of a
1867 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1868 C-v'. For example, to see all things Lucy has to do, you would use
1869 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1870 single buffer, you would use the prefix arg as well when creating the
1871 global todo list: `C-3 C-c t'.
1873 ---------- Footnotes ----------
1875 (1) This is also true for the `t' command in the timeline and agenda
1879 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1881 5.3.3 Setting up TODO keywords for individual files
1882 ---------------------------------------------------
1884 It can be very useful to use different aspects of the TODO mechanism in
1885 different files, which is not possible with the global settings
1886 described above. For file-local settings, you need to add special
1887 lines to the file which set the keywords and interpretation for that
1888 file only. For example, to set one of the two examples discussed
1889 above, you need one of the following lines, starting in column zero
1890 anywhere in the file:
1892 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
1893 #+TYP_TODO: Fred Sara Lucy Mike DONE
1895 To make sure you are using the correct keyword, type `#+' into the
1896 buffer and then use `M-<TAB>' completion.
1898 Remember that the last keyword must always mean that the item is DONE
1899 (although you may use a different word). Also note that in each file,
1900 only one of the two aspects of TODO keywords can be used. After
1901 changing one of these lines, use `C-c C-c' with the cursor still in the
1902 line to make the changes known to Org-mode(1).
1904 If you want to use very many keywords, for example when working with
1905 a large group of people, you may split the names over several lines:
1907 #+TYP_TODO: Fred Sara Lucy Mike
1908 #+TYP_TODO: Luis George Jules Jessica
1909 #+TYP_TODO: Kim Arnold Peter
1912 ---------- Footnotes ----------
1914 (1) Org-mode parses these lines only when Org-mode is activated
1915 after visiting a file. `C-c C-c' with the cursor in a line starting
1916 with `#+' is simply restarting Org-mode, making sure that these changes
1920 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
1925 If you use Org-mode extensively to organize your work, you may end up
1926 with a number of TODO entries so large that you'd like to prioritize
1927 them. This can be done by placing a _priority cookie_ into the
1930 *** TODO [#A] Write letter to Sam Fortune
1932 With its standard setup, Org-mode supports priorities `A', `B', and
1933 `C'. `A' is the highest priority. An entry without a cookie is
1934 treated as priority `B'. Priorities make a difference only in the
1935 agenda (*note Weekly/Daily agenda::).
1938 Set the priority of the current headline. The command prompts for
1939 a priority character `A', `B' or `C'. When you press <SPC>
1940 instead, the priority cookie is removed from the headline. The
1941 priorities can also be changed "remotely" from the timeline and
1942 agenda buffer with the `,' command (*note Agenda commands::).
1946 Increase/decrease priority of current headline. Note that these
1947 keys are also used to modify time stamps (*note Creating
1948 timestamps::). Furthermore, these keys are also used by CUA-mode
1949 (*note Conflicts::).
1952 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
1957 Items can be labeled with timestamps to make them useful for project
1962 * Time stamps:: Assigning a time to a tree entry
1963 * Creating timestamps:: Commands which insert timestamps
1966 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
1968 6.1 Time stamps, deadlines and scheduling
1969 =========================================
1971 A time stamp is a specification of a date (possibly with time) in a
1972 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
1973 A time stamp can appear anywhere in the headline or body of an org-tree
1974 entry. Its presence allows entries to be shown on specific dates in
1975 the agenda (*note Weekly/Daily agenda::). We distinguish:
1978 A simple time stamp just assigns a date/time to an item. This is
1979 just like writing down an appointment in a paper agenda, or like
1980 writing down an event in a diary, when you want to take note of
1981 when something happened. In the timeline and agenda displays, the
1982 headline of an entry associated with a plain time stamp will be
1983 shown exactly on that date.
1986 Two time stamps connected by `--' denote a time range. The
1987 headline will be shown on the first and last day of the range, and
1988 on any dates that are displayed and fall in the range. Here is an
1991 ** Meeting in Amsterdam
1992 <2004-08-23 Mon>--<2004-08-26 Thu>
1994 TIME STAMP WITH SCHEDULED KEYWORD
1995 If a time stamp is preceded by the word `SCHEDULED:', it means you
1996 are planning to start working on that task on the given date. So
1997 this is not about recording an event, but about planning your
1998 work. The headline will be listed under the given date. In
1999 addition, a reminder that the scheduled date has passed will be
2000 present in the compilation for _today_, until the entry is marked
2001 DONE. I.e., the task will automatically be forwarded until
2004 *** TODO Call Trillian for a date on New Years Eve.
2005 SCHEDULED: <2004-12-25 Sat>
2007 TIME STAMP WITH DEADLINE KEYWORD
2008 If a time stamp is preceded by the word `DEADLINE:', the task
2009 (most likely a TODO item) is supposed to be finished on that date,
2010 and it will be listed then. In addition, the compilation for
2011 _today_ will carry a warning about the approaching or missed
2012 deadline, starting `org-deadline-warning-days' before the due
2013 date, and continuing until the entry is marked DONE. An example:
2015 *** TODO write article about the Earth for the Guide
2016 The editor in charge is <bbdb:Ford Prefect>
2017 DEADLINE: <2004-02-29 Sun>
2019 TIME STAMP WITH CLOSED KEYWORD
2020 When `org-log-done' is non-nil, Org-mode will automatically insert
2021 a special time stamp each time a TODO entry is marked done (*note
2022 Progress logging::). This time stamp is enclosed in square
2023 brackets instead of angular brackets.
2026 File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
2028 6.2 Creating timestamps
2029 =======================
2031 For Org-mode to recognize time stamps, they need to be in the specific
2032 format. All commands listed below produce time stamps in the correct
2036 Prompt for a date and insert a corresponding time stamp. When the
2037 cursor is at a previously used time stamp, it is updated to NOW.
2038 When this command is used twice in succession, a time range is
2042 Like `C-c .', but use the alternative format which contains date
2043 and time. The default time can be rounded to multiples of 5
2044 minutes, see the option `org-time-stamp-rounding-minutes'.
2047 Like `C-c .', but insert an inactive time stamp not triggering the
2051 Insert a time stamp corresponding to the cursor date in the
2055 Access the Emacs calendar for the current date. If there is a
2056 timestamp in the current line, goto the corresponding date instead.
2059 Access the agenda for the date given by the time stamp at point
2060 (*note Weekly/Daily agenda::).
2063 Insert `DEADLINE' keyword along with a stamp. The insertion will
2064 happen in the line directly following the headline.
2067 Create a sparse tree with all deadlines that are either past-due,
2068 or which will become due within `org-deadline-warning-days'. With
2069 `C-u' prefix, show all deadlines in the file. With a numeric
2070 prefix, check that many days. For example, `C-1 C-c C-w' shows
2071 all deadlines due tomorrow.
2074 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2075 happen in the line directly following the headline. Any CLOSED
2076 timestamp will be removed.
2080 Change date at cursor by one day. These key bindings conflict with
2081 CUA-mode (*note Conflicts::).
2085 Change the item under the cursor in a timestamp. The cursor can
2086 be on a year, month, day, hour or minute. Note that if the cursor
2087 is not at a time stamp, these same keys modify the priority of an
2088 item. (*note Priorities::). The key bindings also conflict with
2089 CUA-mode (*note Conflicts::).
2092 Evaluate a time range by computing the difference between start and
2093 end. With prefix arg, insert result after the time range (in a
2094 table: into the following column).
2096 When Org-mode prompts for a date/time, the function reading your
2097 input will replace anything you choose not to specify with the current
2098 date and time. For details, see the documentation string of
2099 `org-read-date'. Also, a calender will pop up to allow selecting a
2100 date. The calendar can be fully controlled from the minibuffer, and a
2101 date can be selected with the following commands:
2104 Scroll calendar backwards by one month.
2107 Scroll calendar forwards by one month.
2110 Select date by clicking on it.
2131 Choose date in calendar (only if nothing typed into minibuffer).
2134 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2139 If you wish to implement a system of labels and contexts for
2140 cross-correlating information, an excellent way is to assign tags to
2141 headlines. Org-mode has extensive support for using tags.
2143 Every headline can contain a list of tags, at the end of the
2144 headline. Tags are normal words containing letters, numbers, `_', and
2145 `@'. Tags must be preceded and followed by a single colon; like
2146 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2150 * Tag inheritance:: Tags use the tree structure of the outline
2151 * Setting tags:: How to assign tags to a headline
2152 * Tag searches:: Searching for combinations of tags
2155 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2160 Tags make use of the hierarchical structure of outline trees. If a
2161 heading has a certain tag, all subheadings will inherit the tag as
2162 well. For example, in the list
2164 * Meeting with the French group :WORK:
2165 ** Summary by Frank :BOSS:NOTES:
2166 *** TODO Prepare slides for him :ACTION:
2168 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2169 `:ACTION:'. When executing tag searches and Org-mode finds that a
2170 certain headline matches the search criterion, it will not check any
2171 sublevel headline, assuming that these likely also match, and that the
2172 list of matches can become very long. This may not be what you want,
2173 however, and you can influence inheritance and searching using the
2174 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2177 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2182 Tags can simply be typed into the buffer at the end of a headline.
2183 After a colon, `M-<TAB>' offers completion on tags. There is also a
2184 special command for inserting tags:
2187 Enter new tags for the current headline. Org-mode will either
2188 offer completion or a special single-key interface for setting
2189 tags, see below. After pressing <RET>, the tags will be inserted
2190 and aligned to `org-tags-column'. When called with a `C-u'
2191 prefix, all tags in the current buffer will be aligned to that
2192 column, just to make things look nice. TAGS are automatically
2193 realigned after promotion, demotion, and TODO state changes (*note
2196 Org will support tag insertion based on a _list of tags_. By
2197 default this list is constructed dynamically, containing all tags
2198 currently used in the buffer. You may also globally specify a hard list
2199 of tags with the variable `org-tag-alist'. Finally you can set the
2200 allowed tags for a given file with lines like
2202 #+TAGS: @WORK @HOME @TENNISCLUB
2203 #+TAGS: Laptop Car PC Sailboat
2205 The default support method is minibuffer completion. However,
2206 Org-mode also implements a much better method: _fast tag selection_.
2207 This method allows to select and deselect tags with a single key per
2208 tag. To function efficiently, you should assign unique keys to all
2209 tags. This can be done globally with
2211 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2213 or on a per-file basis with
2215 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2217 You can also group together tags that are mutually exclusive. With
2220 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2222 you indicate that at most one of `@WORK', `@HOME', and `@SAILBOAT'
2225 Don't forget to press `C-c C-c' with the cursor in one of these lines
2226 to activate any changes.
2228 If at least one tag has a selection key, pressing `C-c C-c' will
2229 automatically present you with a special interface, listing inherited
2230 tags, the tags of the current headline, and a list of all legal tags
2231 with corresponding keys(2). Pressing keys for the tags will add or
2232 remove them from the list of tags in the current line. Selecting a tag
2233 in a group of mutually exclusive tags will turn off any other tags from
2234 that group. <SPC> clears all tags for this line, `RET' accepts the
2235 modified set, and `C-g' aborts without installing changes. This method
2236 lets you assign tags to a headline with very few keys. With the above
2237 setup, you could clear the current tags and set `@HOME', `Laptop' and
2238 `PC' tags with just the following keys: `C-c C-c <SPC> h l p <RET>'.
2239 Switching from `@HOME' to `@WORK' would be done with `C-c C-c w <RET>'.
2241 What if you have globally defined your preferred set of tags using
2242 the variable `org-tag-alist', but would like to use a dynamic tag list
2243 in a specific file? Just add an empty TAGS option line to that file:
2247 ---------- Footnotes ----------
2249 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2250 respectively. Several groups are allowed.
2252 (2) Keys will automatically assigned to tags which have no
2256 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2261 Once a tags system has been set up, it can be used to collect related
2262 information into special lists.
2265 Create a sparse tree with all headlines matching a tags search.
2268 Create a global list of tag matches from all agenda files. *Note
2269 Matching headline tags::.
2272 Create a global list of tag matches from all agenda files, but
2273 check only TODO items and force checking subitems (see variable
2274 `org-tags-match-list-sublevels').
2276 A tags search string can use Boolean operators `&' for AND and `|'
2277 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2278 not implemented. A tag may also be preceded by `-', to select against
2279 it, and `+' is syntactic sugar for positive selection. The AND
2280 operator `&' is optional when `+' or `-' is present. For example,
2281 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2282 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2283 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2284 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2288 File: org, Node: Agenda views, Next: Exporting, Prev: Tags, Up: Top
2293 Due to the way Org-mode works, TODO items, time-stamped items, and
2294 tagged headlines can be scattered throughout a file or even a number of
2295 files. To get an overview over open action items, or over events that
2296 are important for a particular date, this information must be collected,
2297 sorted and displayed in an organized way.
2299 Org-mode can select items based on various criteria, and display them
2300 in a separate buffer. Three different views are provided:
2302 * an _agenda_ that is like a calendar and shows information for
2305 * a _TODO list_ that covers all unfinished action items, and
2307 * a _tags view_ that shows information based on the tags associated
2308 with headlines in the outline tree.
2310 The extracted information is displayed in a special _agenda buffer_.
2311 This buffer is read-only, but provides commands to visit the
2312 corresponding locations in the original Org-mode files, and even to
2313 edit these files remotely.
2317 * Agenda files:: Files being searched for agenda information
2318 * Agenda dispatcher:: Keyboard access to agenda views
2319 * Weekly/Daily agenda:: The calendar page with current tasks
2320 * Global TODO list:: All unfinished action items
2321 * Matching headline tags:: Structured information with fine-tuned search
2322 * Timeline:: Time-sorted view for single file
2323 * Agenda commands:: Remote editing of org trees
2326 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2331 The information to be shown is collected from all _agenda files_, the
2332 files listed in the variable `org-agenda-files'(1). Thus even if you
2333 only work with a single Org-mode file, this file should be put into
2334 that list(2). You can customize `org-agenda-files', but the easiest
2335 way to maintain it is through the following commands
2338 Add current file to the list of agenda files. The file is added to
2339 the front of the list. If it was already in the list, it is moved
2340 to the front. With prefix arg, file is added/moved to the end.
2343 Remove current file from the list of agenda files.
2346 Cycle through agenda file list, visiting one file after the other.
2348 The Org menu contains the current list of files and can be used to
2351 ---------- Footnotes ----------
2353 (1) If the value of that variable is not a list, but a single file
2354 name, then the list of agenda files will be maintained in that external
2357 (2) When using the dispatcher pressing `1' before selecting a
2358 command will actually limit the command to the current file, and ignore
2359 `org-agenda-files' until the next dispatcher command.
2362 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2364 8.2 The agenda dispatcher
2365 =========================
2367 The views are created through a dispatcher that should be bound to a
2368 global key, for example `C-c a' (*note Installation and activation::).
2369 In the following we will assume that `C-c a' is indeed how the
2370 dispatcher is accessed and list keyboard access to commands
2371 accordingly. After pressing `C-c a', an additional letter is required
2372 to execute a command. The dispatcher offers the following default
2375 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2378 Create a list of all TODO items (*note Global TODO list::).
2381 Create a list of headlines matching a TAGS expression (*note
2382 Matching headline tags::).
2384 You can also define custom commands that will be accessible through
2385 the dispatcher, just like the default commands. Custom commands are
2386 global searches for tags and specific TODO keywords, or a variety of
2387 sparse tree creating commands (*note Sparse trees::). As sparse trees
2388 are only defined for a single org-mode file, these latter commands act
2389 on the current buffer instead of the list of agenda files.
2391 Custom commands are configured in the variable
2392 `org-agenda-custom-commands'. You can customize this variable, for
2393 example by pressing `C-c a C'. You can also directly set it with Emacs
2394 Lisp in `.emacs'. For example:
2396 (setq org-agenda-custom-commands
2397 '(("w" todo "WAITING")
2398 ("u" tags "+BOSS-URGENT")
2399 ("U" tags-tree "+BOSS-URGENT")
2400 ("f" occur-tree "\\<FIXME\\>")))
2402 will define `C-c a w' as a global search for TODO entries with
2403 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2404 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2405 search but only in the current buffer and display the result as a
2406 sparse tree, and `C-c a f' to create a sparse tree with all entries
2407 containing the word `FIXME'. For more information, look at the
2408 documentation string of the variable `org-agenda-custom-commands'.
2411 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
2413 8.3 The weekly/daily agenda
2414 ===========================
2416 The purpose of the weekly/daily _agenda_ is to act like a page of a
2417 paper agenda, showing all the tasks for the current week or day.
2420 Compile an agenda for the current week from a list of org files.
2421 The agenda shows the entries for each day. With a `C-u' prefix (or
2422 when the variable `org-agenda-include-all-todo' is `t'), all
2423 unfinished TODO items (including those without a date) are also
2424 listed at the beginning of the buffer, before the first date.
2426 Remote editing from the agenda buffer means, for example, that you
2427 can change the dates of deadlines and appointments from the agenda
2428 buffer. The commands available in the Agenda buffer are listed in
2429 *Note Agenda commands::.
2433 * Categories:: Not all tasks are equal
2434 * Time-of-day specifications:: How the agenda knows the time
2435 * Calendar/Diary integration:: Integrating Anniversaries and more
2436 * Sorting of agenda items:: The order of things
2439 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
2444 In the agenda buffer, each entry is preceded by a _category_, which is
2445 derived from the file name. The category can also be set with a
2446 special line anywhere in the buffer, looking like this:
2450 If there are several such lines in a file, each specifies the
2451 category for the text below it (but the first category also applies to
2452 any text before the first CATEGORY line). The display in the agenda
2453 buffer looks best if the category is not longer than 10 characters.
2456 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily agenda
2458 8.3.2 Time-of-Day Specifications
2459 --------------------------------
2461 Org-mode checks each agenda item for a time-of-day specification. The
2462 time can be part of the time stamp that triggered inclusion into the
2463 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2464 specified with two time stamps, like
2465 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2467 In the headline of the entry itself, a time(range) may also appear as
2468 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2469 Emacs diary (*note Calendar/Diary integration::), time specifications
2470 in diary entries are recognized as well.
2472 For agenda display, Org-mode extracts the time and displays it in a
2473 standard 24 hour format as part of the prefix. The example times in
2474 the previous paragraphs would end up in the agenda like this:
2476 8:30-13:00 Arthur Dent lies in front of the bulldozer
2477 12:45...... Ford Prefect arrives and takes Arthur to the pub
2478 19:00...... The Vogon reads his poem
2479 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2481 If the agenda is in single-day mode, or for the display of today, the
2482 timed entries are embedded in a time grid, like
2484 8:00...... ------------------
2485 8:30-13:00 Arthur Dent lies in front of the bulldozer
2486 10:00...... ------------------
2487 12:00...... ------------------
2488 12:45...... Ford Prefect arrives and takes Arthur to the pub
2489 14:00...... ------------------
2490 16:00...... ------------------
2491 18:00...... ------------------
2492 19:00...... The Vogon reads his poem
2493 20:00...... ------------------
2494 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2496 The time grid can be turned on and off with the variable
2497 `org-agenda-use-time-grid', and can be configured with
2498 `org-agenda-time-grid'.
2501 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily agenda
2503 8.3.3 Calendar/Diary integration
2504 --------------------------------
2506 Emacs contains the calendar and diary by Edward M. Reingold. The
2507 calendar displays a three-month calendar with holidays from different
2508 countries and cultures. The diary allows you to keep track of
2509 anniversaries, lunar phases, sunrise/set, recurrent appointments
2510 (weekly, monthly) and more. In this way, it is quite complementary to
2511 Org-mode. It can be very useful to combine output from Org-mode with
2514 In order to include entries from the Emacs diary into Org-mode's
2515 agenda, you only need to customize the variable
2517 (setq org-agenda-include-diary t)
2519 After that, everything will happen automatically. All diary entries
2520 including holidays, anniversaries etc will be included in the agenda
2521 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2522 the agenda buffer to jump to the diary file in order to edit existing
2523 diary entries. The `i' command to insert new entries for the current
2524 date works in the agenda buffer, as well as the commands `S', `M', and
2525 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2526 to other calendars, respectively. `c' can be used to switch back and
2527 forth between calendar and agenda.
2530 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily agenda
2532 8.3.4 Sorting of agenda items
2533 -----------------------------
2535 The entries for each day are sorted. The default order is to first
2536 collect all items containing an explicit time-of-day specification.
2537 These entries will be shown at the beginning of the list, as a
2538 _schedule_ for the day. After that, items remain grouped in
2539 categories, in the sequence given by `org-agenda-files'. Within each
2540 category, items are sorted by priority (*note Priorities::).
2542 The priority is a numerical quantity composed of the base priority
2543 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2544 increments for overdue scheduled or deadline items.
2546 Sorting can be customized using the variable
2547 `org-agenda-sorting-strategy'.
2550 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
2552 8.4 The global TODO list
2553 ========================
2555 The global TODO list contains all unfinished TODO items, formatted and
2556 collected into a single place.
2559 Show the global TODO list. This collects the TODO items from all
2560 agenda files (*note Agenda views::) into a single buffer. The
2561 buffer is in `agenda-mode', so there are commands to examine and
2562 manipulate the TODO entries directly from that buffer (*note
2566 Like the above, but allows selection of a specific TODO keyword.
2567 You can also do this by specifying a prefix argument to `C-c a t'.
2568 With a `C-u' prefix you are prompted for a keyword. With a
2569 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2570 `r' key in the agenda buffer regenerates it, and you can give a
2571 prefix argument to this command to change the selected TODO
2572 keyword, for example `3 r'. If you often need a search for a
2573 specific keyword, define a custom command for it (*note Agenda
2576 Remote editing of TODO items means that you can change the state of a
2577 TODO entry with a single key press. The commands available in the TODO
2578 list are described in *Note Agenda commands::.
2581 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
2583 8.5 Matching headline tags
2584 ==========================
2586 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2587 you can select headlines based on the tags that apply to them and
2588 collect them into an agenda buffer.
2591 Produce a list of all headlines that match a given set of tags.
2592 The command prompts for a selection criterion, which is a boolean
2593 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2594 `WORK|HOME' (*note Tags::). If you often need a specific search,
2595 define a custom command for it (*note Agenda dispatcher::).
2598 Like `C-c a m', but only select headlines that are also TODO items
2599 and force checking subitems (see variable
2600 `org-tags-match-list-sublevels'.
2602 The commands available in the tags list are described in *Note
2606 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda views
2608 8.6 Timeline for a single file
2609 ==============================
2611 The timeline is not really an agenda view, because it only summarizes
2612 items from a single Org-mode file. But it also uses the agenda buffer
2613 and provides similar commands, so we discuss it here. The timeline
2614 shows all time-stamped items in a single Org-mode file (or the selected
2615 part of it), in a _time-sorted view_. The main purpose of this command
2616 is to give an overview over events in a project.
2619 Show a time-sorted view of the org file, with all time-stamped
2620 items. When called with a `C-u' prefix, all unfinished TODO
2621 entries (scheduled or not) are also listed under the current date.
2623 The commands available in the timeline buffer are listed in *Note
2627 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda views
2629 8.7 Commands in the agenda buffer
2630 =================================
2632 Entries in the agenda buffer are linked back to the org file or diary
2633 file where they originate. You are not allowed to edit the agenda
2634 buffer itself, but commands are provided to show and jump to the
2635 original entry location, and to edit the org-files "remotely" from the
2636 agenda buffer. In this way, all information is stored only once,
2637 removing the risk that your agenda and note files may diverge.
2639 Some commands can be executed with mouse clicks on agenda lines. For
2640 the other commands, the cursor needs to be in the desired line.
2646 Next line (same as <up>).
2649 Previous line (same as <down>).
2656 Display the original location of the item in another window.
2659 Display original location and recenter that window.
2664 Go to the original location of the item in another window. Under
2665 Emacs 22, `mouse-1' will also works for this.
2668 Go to the original location of the item and delete other windows.
2671 Toggle Follow mode. In Follow mode, as you move the cursor through
2672 the agenda buffer, the other window always shows the corresponding
2673 location in the org file. The initial setting for this mode in new
2674 agenda buffers can be set with the variable
2675 `org-agenda-start-with-follow-mode'.
2678 Toggle Logbook mode. In Logbook mode, entries that where marked
2679 DONE while logging was on (variable `org-log-done') are shown in
2686 Delete other windows.
2689 Switch to weekly view (7 days displayed together).
2692 Switch to daily view (just one day displayed).
2695 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2699 Toggle the time grid on and off. See also the variables
2700 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2703 Recreate the agenda buffer, for example to reflect the changes
2704 after modification of the time stamps of items with S-<left> and
2705 S-<right>. When the buffer is the global todo list, a prefix
2706 argument is interpreted to create a selective list for a specific
2710 Display the following `org-agenda-ndays' days. For example, if
2711 the display covers a week, switch to the following week. With
2712 prefix arg, go forward that many times `org-agenda-ndays' days.
2715 Display the previous dates.
2727 Change the TODO state of the item, both in the agenda and in the
2731 Show all tags associated with the current item. Because of
2732 inheritance, this may be more than the tags listed in the line
2736 Set tags for the current headline.
2739 Set the priority for the current item. Org-mode prompts for the
2740 priority character. If you reply with <SPC>, the priority cookie
2741 is removed from the entry.
2744 Display weighted priority of current item.
2748 Increase the priority of the current item. The priority is
2749 changed in the original buffer, but the agenda is not resorted.
2750 Use the `r' key for this.
2754 Decrease the priority of the current item.
2760 Set a deadline for this item.
2763 Change the time stamp associated with the current line by one day
2764 into the future. With prefix argument, change it by that many
2765 days. For example, `3 6 5 S-<right>' will change it by a year.
2766 The stamp is changed in the original org file, but the change is
2767 not directly reflected in the agenda buffer. Use the `r' key to
2771 Change the time stamp associated with the current line by one day
2775 Change the time stamp associated with the current line to today.
2776 The key `>' has been chosen, because it is the same as `S-.' on my
2780 Insert a new entry into the diary. Prompts for the type of entry
2781 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
2782 new entry in the diary, just as `i d' etc. would do in the
2783 calendar. The date is taken from the cursor position.
2789 Open the Emacs calendar and move to the date at the agenda cursor.
2792 When in the calendar, compute and show the Org-mode agenda for the
2796 Show the phases of the moon for the three months around current
2800 Show sunrise and sunset times. The geographical location must be
2801 set with calendar variables, see documentation of the Emacs
2805 Convert the date at cursor into many other cultural and historic
2809 Show holidays for three month around the cursor date.
2812 Export a single iCalendar file containing entries from all agenda
2819 Quit agenda, remove the agenda buffer.
2822 Exit agenda, remove the agenda buffer and all buffers loaded by
2823 Emacs for the compilation of the agenda. Buffers created by the
2824 user to visit org files will not be removed.
2828 File: org, Node: Exporting, Next: Publishing, Prev: Agenda views, Up: Top
2833 Org-mode documents can be exported into a variety of other formats. For
2834 printing and sharing of notes, ASCII export produces a readable and
2835 simple version of an Org-mode file. HTML export allows you to publish a
2836 notes file on the web, while the XOXO format provides a solid base for
2837 exchange with a broad range of other applications. To incorporate
2838 entries with associated times like deadlines or appointments into a
2839 desktop calendar program like iCal, Org-mode can also produce extracts
2840 in the iCalendar format. Currently Org-mode only supports export, not
2841 import of these different formats.
2843 When exporting, Org-mode uses special conventions to enrich the
2844 output produced. *Note Text interpretation::, for more details.
2848 * ASCII export:: Exporting to plain ASCII
2849 * HTML export:: Exporting to HTML
2850 * XOXO export:: Exporting to XOXO
2851 * iCalendar export:: Exporting in iCalendar format
2852 * Text interpretation:: How the exporter looks at the file
2855 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
2860 ASCII export produces a simple and very readable version of an Org-mode
2864 Export as ASCII file. If there is an active region, only the
2865 region will be exported. For an org file `myfile.org', the ASCII
2866 file will be `myfile.txt'. The file will be overwritten without
2870 Export only the visible part of the document.
2872 In the exported version, the first 3 outline levels will become
2873 headlines, defining a general document structure. Additional levels
2874 will be exported as itemized lists. If you want that transition to
2875 occur at a different level, specify it with a prefix argument. For
2880 creates only top level headlines and does the rest as items. When
2881 headlines are converted to items, the indentation of the text following
2882 the headline is changed to fit nicely under the item. This is done with
2883 the assumption that the first bodyline indicates the base indenation of
2884 the body text. Any indenation larger than this is adjusted to preserve
2885 the layout relative to the first line. Should there be lines with less
2886 indentation than the first, these are left alone.
2889 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
2894 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
2895 HTML formatting, in ways similar to John Grubers _markdown_ language,
2896 but with additional support for tables.
2899 Export as HTML file `myfile.html'.
2902 Export as HTML file and open it with a browser.
2907 Export only the visible part of the document.
2909 In the exported version, the first 3 outline levels will become
2910 headlines, defining a general document structure. Additional levels
2911 will be exported as itemized lists. If you want that transition to
2912 occur at a different level, specify it with a prefix argument. For
2917 creates two levels of headings and does the rest as items.
2919 If you want to include HTML tags which should be interpreted as such,
2920 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
2921 always transformed to `<' and `>' in HTML export.
2923 Internal links (*note Internal links::) will continue to work in HTML
2924 files only if they match a dedicated `<<target>>'. Automatic links
2925 created by radio targets (*note Radio targets::) will also work in the
2926 HTML file. Links to external files will still work if the HTML file is
2927 in the same directory as the Org-mode file. Links to other `.org'
2928 files will be translated into HTML links under the assumption that an
2929 HTML version also exists of the linked file. For information related to
2930 linking files while publishing them to a publishing directory see *Note
2933 You can also give style information for the exported file. The HTML
2934 exporter assigns the following CSS classes to appropriate parts of the
2935 document - your style specifications may change these:
2937 .done the DONE keyword
2938 .timestamp time stamp
2939 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
2940 .tag tag in a headline
2941 .target target for links
2943 The default style specification can be configured through the option
2944 `org-export-html-style'. If you want to use a file-local style, you
2945 may use file variables, best wrapped into a COMMENT section at the end
2946 of the outline tree. For example:
2948 * COMMENT HTML style specifications
2951 # org-export-html-style: " <style type=\"text/css\">
2952 # p {font-weight: normal; color: gray; }
2953 # h1 {color: black; }
2957 Remember to execute `M-x normal-mode' after changing this to make
2958 the new style visible to Emacs. This command restarts org-mode for the
2959 current buffer and forces Emacs to re-evaluate the local variables
2960 section in the buffer.
2963 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
2968 Org-mode contains an exporter that produces XOXO-style output.
2969 Currently, this exporter only handles the general outline structure and
2970 does not interpret any additional Org-mode features.
2973 Export as XOXO file `myfile.html'.
2976 Export only the visible part of the document.
2979 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
2981 9.4 iCalendar export
2982 ====================
2984 Some people like to use Org-mode for keeping track of projects, but
2985 still prefer a standard calendar application for anniversaries and
2986 appointments. In this case it can be useful to have deadlines and
2987 other time-stamped items in Org-mode files show up in the calendar
2988 application. Org-mode can export calendar information in the standard
2992 Create iCalendar entries for the current file and store them in
2993 the same directory, using a file extension `.ics'.
2996 Like `C-c C-x i', but do this for all files in `org-agenda-files'.
2997 For each of these files, a separate iCalendar file will be
3001 Create a single large iCalendar file from all files in
3002 `org-agenda-files' and write it to the file given by
3003 `org-combined-agenda-icalendar-file'.
3005 How this calendar is best read and updated, depends on the
3006 application you are using. For example, when using iCal under Apple
3007 MacOS X, you could create a new calendar `OrgMode' (the default name
3008 for the calendar created by `C-c C-x c', see the variables
3009 `org-icalendar-combined-name' and
3010 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
3011 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
3012 use AppleScript to make iCal re-read the calendar files each time a new
3013 version of `OrgMode.ics' is produced. Here is the setup needed for
3016 (setq org-combined-agenda-icalendar-file
3017 "~/Library/Calendars/OrgMode.ics")
3018 (add-hook 'org-after-save-iCalendar-file-hook
3021 "osascript -e 'tell application \"iCal\" to reload calendars'")))
3024 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
3026 9.5 Text interpretation by the exporter
3027 =======================================
3029 The exporter backends interpret additional structure in the Org-mode
3030 file in order to produce better output.
3034 * Comment lines:: Some lines will not be exported
3035 * Enhancing text:: Subscripts, symbols and more
3036 * Export options:: How to influence the export settings
3039 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
3044 Lines starting with `#' in column zero are treated as comments and will
3045 never be exported. Also entire subtrees starting with the word
3046 `COMMENT' will never be exported. Finally, any text before the first
3047 headline will not be exported either.
3050 Toggle the COMMENT keyword at the beginning of an entry.
3053 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
3055 9.5.2 Enhancing text for export
3056 -------------------------------
3058 Some of the export backends of Org-mode allow for sophisticated text
3059 formatting, this is true in particular for the HTML backend. Org-mode
3060 has a number of typing conventions that allow to produce a richly
3063 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
3064 enumerator will be recognized and transformed if the backend
3065 supports lists. See *Note Plain lists::.
3067 * You can make words *bold*, /italic/, and _underlined_
3069 * Simple TeX-like math constructs are interpreted:
3071 - `10^22' and `J_n' are super- and subscripts. You can quote
3072 `^' and `_' with a backslash: `\_' and `\^'
3074 - `\alpha' indicates a Greek letter, `\to' an arrow. You can
3075 use completion for these macros, just type `\' and maybe a few
3076 letters, and press `M-<TAB>' to see possible completions.
3078 * Tables are transformed into native tables under the exporter, if
3079 the export backend supports this. Data fields before the first
3080 horizontal separator line will be formatted as table header fields.
3082 * If a headline starts with the word `QUOTE', the text below the
3083 headline will be typeset as fixed-width, to allow quoting of
3084 computer codes etc. Lines starting with `:' are also typeset in
3087 Toggle fixed-width for entry (QUOTE) or region, see below.
3089 * A double backslash _at the end of a line_ enforces a line break at
3092 If these conversions conflict with your habits of typing ASCII text,
3093 they can all be turned off with corresponding variables (see the
3094 customization group `org-export-general', and the following section
3095 which explains how to set export options with special lines in a buffer.
3098 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
3100 9.5.3 Export options
3101 --------------------
3103 The exporter recognizes special lines in the buffer which provide
3104 additional information. These lines may be put anywhere in the file.
3105 The whole set of lines can be inserted into the buffer with `C-c C-x
3106 t'. For individual lines, a good way to make sure the keyword is
3107 correct is to type `#+' and then use `M-<TAB>' completion (*note
3111 Insert template with export options, see example below.
3113 #+TITLE: the title to be shown (default is the buffer name)
3114 #+AUTHOR: the author (default taken from `user-full-name')
3115 #+EMAIL: his/her email address (default from `user-mail-address')
3116 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
3117 #+TEXT: Some descriptive text to be inserted at the beginning.
3118 #+TEXT: Several lines may be given.
3119 #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
3121 The OPTIONS line is a compact form to specify export settings. Here
3123 H: set the number of headline levels for export
3124 num: turn on/off section-numbers
3125 toc: turn on/off table of contents
3126 \n: turn on/off linebreak-preservation
3127 @: turn on/off quoted HTML tags
3128 :: turn on/off fixed-width sections
3129 |: turn on/off tables
3130 ^: turn on/off TeX-like syntax for sub- and superscripts.
3131 *: turn on/off emphasized text (bold, italic, underlined)
3132 TeX: turn on/off TeX macros
3135 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
3140 Org-mode includes(1) a publishing management system that allows you to
3141 configure automatic HTML conversion of _projects_ composed of
3142 interlinked org files. This system is called _org-publish_. You can
3143 also configure org-publish to automatically upload your exported HTML
3144 pages and related attachments, such as images and source code files, to
3145 a web server. Org-publish turns org-mode into a web-site authoring
3148 Org-publish has been contributed to Org-mode by David O'Toole.
3152 * Configuration:: Defining projects
3153 * Sample configuration:: Example projects
3154 * Triggering publication:: Publication commands
3156 ---------- Footnotes ----------
3158 (1) `org-publish.el' is not yet part of emacs, so if you are using
3159 `org.el' as it comes with Emacs, you need to download this file
3160 separately. Also make sure org.el is at least version 4.27.
3163 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
3168 Publishing needs significant configuration to specify files, destination
3169 and many other properties of a project.
3173 * Project alist:: The central configuration variable
3174 * File sources and destinations:: From here to there
3175 * Selecting files:: What files are part of the project?
3176 * Publishing action:: Setting the function doing the publishing
3177 * Publishing options:: Tweaking HTML export
3178 * Publishing links:: Which links keep working after publishing?
3179 * Project page index:: Publishing a list of project files
3182 File: org, Node: Project alist, Next: File sources and destinations, Prev: Configuration, Up: Configuration
3184 10.1.1 The variable `org-publish-project-alist'
3185 -----------------------------------------------
3187 Org-publish is configured almost entirely through setting the value of
3188 one variable, called `org-publish-project-alist'. Each element of the
3189 list configures one project, and may be in one of the two following
3192 ("project-name" :property value :property value ...)
3196 ("project-name" :components ("project-name" "project-name" ...))
3198 In both cases, projects are configured by specifying property values.
3199 A project defines the set of files that will be published, as well as
3200 the publishing configuration to use when publishing those files. When
3201 a project takes the second form listed above, the individual members of
3202 the "components" property are taken to be components of the project,
3203 which group together files requiring different publishing options. When
3204 you publish such a "meta-project" all the components will also publish.
3207 File: org, Node: File sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
3209 10.1.2 Sources and destinations for files
3210 -----------------------------------------
3212 Most properties are optional, but some should always be set. In
3213 particular, org-publish needs to know where to look for source files,
3214 and where to put published files.
3216 `:base-directory' Directory containing publishing source files
3217 `:publishing-directory'Directory (possibly remote) where output files
3221 File: org, Node: Selecting files, Next: Publishing action, Prev: File sources and destinations, Up: Configuration
3223 10.1.3 Selecting files
3224 ----------------------
3226 By default, all files with extension `.org' in the base directory are
3227 considered part of the project. This can be modified by setting the
3229 `:base-extension' Extension (without the dot!) of source files. This
3230 actually is a regular expression.
3231 `:exclude' Regular expression to match file names that should
3232 not be published, even though they have been selected
3233 on the basis of their extension.
3234 `:include' List of files to be included regardless of
3235 `:base-extension' and `:exclude'.
3238 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
3240 10.1.4 Publishing Action
3241 ------------------------
3243 Publishing means that a file is copied to the destination directory and
3244 possibly transformed in the process. The default transformation is to
3245 export Org-mode files as HTML files, and this is done by the function
3246 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
3247 export::). Other files like images only need to be copied to the
3248 publishing destination. For non-Org-mode files, you need to specify
3249 the publishing function.
3251 `:publishing-function' Function executing the publication of a file.
3253 The function must accept two arguments: a property list containing at
3254 least a `:publishing-directory' property, and the name of the file to
3255 be published. It should take the specified file, make the necessary
3256 transformation (if any) and place the result into the destination
3257 folder. You can write your own publishing function, but `org-publish'
3258 provides one for attachments (files that only need to be copied):
3259 `org-publish-attachment'.
3262 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
3264 10.1.5 Options for the HTML exporter
3265 ------------------------------------
3267 The property list can be used to set many export options for the HTML
3268 exporter. In most cases, these properties correspond to user variables
3269 in Org-mode. The table below lists these properties along with the
3270 variable they belong to. See the documentation string for the
3271 respective variable for details.
3273 `:language' `org-export-default-language'
3274 `:headline-levels' `org-export-headline-levels'
3275 `:section-numbers' `org-export-with-section-numbers'
3276 `:table-of-contents' `org-export-with-toc'
3277 `:emphasize' `org-export-with-emphasize'
3278 `:sub-superscript' `org-export-with-sub-superscripts'
3279 `:TeX-macros' `org-export-with-TeX-macros'
3280 `:fixed-width' `org-export-with-fixed-width'
3281 `:timestamps' `org-export-with-timestamps'
3283 `:tags' `org-export-with-tags'
3285 `:tables' `org-export-with-tables'
3286 `:table-auto-headline' `org-export-highlight-first-table-line'
3287 `:style' `org-export-html-style'
3288 `:convert-org-links' `org-export-html-link-org-files-as-html'
3289 `:inline-images' `org-export-html-inline-images'
3290 `:expand-quoted-html' `org-export-html-expand'
3291 `:timestamp' `org-export-html-with-timestamp'
3292 `:publishing-directory'`org-export-publishing-directory'
3293 `:preamble' `org-export-html-preamble'
3294 `:postamble' `org-export-html-postamble'
3295 `:auto-preamble' `org-export-html-auto-preamble'
3296 `:auto-postamble' `org-export-html-auto-postamble'
3297 `:author' `user-full-name'
3298 `:email' `user-mail-address'
3300 When a property is given a value in org-publish-project-alist, its
3301 setting overrides the value of the corresponding user variable (if any)
3302 during publishing. options set within a file (*note Export options::),
3303 however, override everything.
3306 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
3308 10.1.6 Links between published files
3309 ------------------------------------
3311 To create a link from one Org-mode file to another, you would use
3312 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
3313 (*note Hyperlinks::). Upon publishing this link becomes a link to
3314 `foo.html'. In this way, you can interlink the pages of your "org web"
3315 project and the links will work as expected when you publish them to
3318 You may also link to related files, such as images. Provided you are
3319 careful with relative pathnames, and provided you have also configured
3320 org-publish to upload the related files, these links will work too.
3321 *Note Complex example:: for an example of this usage.
3324 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
3326 10.1.7 Project page index
3327 -------------------------
3329 The following properties may be used to control publishing of an index
3330 of files or summary page for a given project.
3332 `:auto-index' When non-nil, publish an index during
3333 org-publish-current-project or org-publish-all.
3334 `:index-filename' Filename for output of index. Defaults to `index.org'
3335 (which becomes `index.html').
3336 `:index-title' Title of index page. Defaults to name of file.
3337 `:index-function' Plugin function to use for generation of index.
3338 Defaults to `org-publish-org-index', which generates
3339 a plain list of links to all files in the project.
3342 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
3344 10.2 Sample configuration
3345 =========================
3347 Below we provide two example configurations. The first one is a simple
3348 project publishing only a set of Org-mode files. The second example is
3349 more complex, with a multi-component project.
3353 * Simple example:: One-component publishing
3354 * Complex example:: A multi-component publishing example
3357 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
3359 10.2.1 Example: simple publishing configuration
3360 -----------------------------------------------
3362 This example publishes a set of Org-mode files to the `public_html'
3363 directory on the local machine.
3365 (setq org-publish-project-alist
3367 :base-directory "~/org/"
3368 :publishing-directory "~/public_html"
3369 :section-numbers nil
3370 :table-of-contents nil
3371 :style "<link rel=stylesheet
3372 href=\"../other/mystyle.css\"
3373 type=\"text/css\">")))
3376 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
3378 10.2.2 Example: complex publishing configuration
3379 ------------------------------------------------
3381 This more complicated example publishes an entire website, including
3382 org files converted to HTML, image files, emacs lisp source code, and
3383 stylesheets. The publishing-directory is remote and private files are
3386 To ensure that links are preserved, care should be taken to replicate
3387 your directory structure on the web server, and to use relative file
3388 paths. For example, if your org files are kept in `~/org' and your
3389 publishable images in `~/images', you'd link to an image with
3390 file:../images/myimage.png
3391 On the web server, the relative path to the image should be the
3392 same. You can accomplish this by setting up an "images" folder in the
3393 right place on the webserver, and publishing images to it.
3395 (setq org-publish-project-alist
3397 :base-directory "~/org/"
3398 :base-extension "org"
3399 :publishing-directory "/ssh:user@host:~/html/notebook/"
3400 :publishing-function org-publish-org-to-html
3401 :exclude "PrivatePage.org" ;; regexp
3403 :section-numbers nil
3404 :table-of-contents nil
3405 :style "<link rel=stylesheet
3406 href=\"../other/mystyle.css\" type=\"text/css\">"
3408 :auto-postamble nil)
3411 :base-directory "~/images/"
3412 :base-extension "jpg\\|gif\\|png"
3413 :publishing-directory "/ssh:user@host:~/html/images/"
3414 :publishing-function org-publish-attachment)
3417 :base-directory "~/other/"
3418 :base-extension "css\\|el"
3419 :publishing-directory "/ssh:user@host:~/html/other/"
3420 :publishing-function org-publish-attachment)
3421 ("website" :components ("orgfiles" "images" "other"))))
3424 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
3426 10.3 Triggering publication
3427 ===========================
3429 Once org-publish is properly configured, you can publish with the
3430 following functions:
3433 Prompts for a specific project to publish.
3436 Publishes the project the current file is part of.
3439 Publishes only the current file.
3442 Publish all projects.
3444 Org uses timestamps to track when a file has changed. The above
3445 functions normally only publish changed files. You can override this and
3446 force publishing of all files by giving a prefix argument.
3449 File: org, Node: Miscellaneous, Next: Index, Prev: Publishing, Up: Top
3456 * Completion:: M-TAB knows what you need
3457 * Customization:: Adapting Org-mode to your taste
3458 * Summary of in-buffer settings:: Using special lines to set options
3459 * The very busy C-c C-c key:: When in doubt, press C-c C-c
3460 * Clean view:: Getting rid of leading stars in the outline
3461 * TTY keys:: Using Org-mode on a tty
3462 * FAQ:: Frequently asked questions
3463 * Interaction:: Other Emacs packages
3464 * Bugs:: Things which do not work perfectly
3465 * Acknowledgments:: These people provided feedback and more
3468 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
3473 Org-mode supports in-buffer completion. This type of completion does
3474 not make use of the minibuffer. You simply type a few letters into the
3475 buffer and use the key to complete text right there.
3478 Complete word at point
3479 * At the beginning of a headline, complete TODO keywords.
3481 * After `\', complete TeX symbols supported by the exporter.
3483 * After `*', complete CamelCase versions of all headlines in the
3486 * After `:', complete tags used elsewhere in the buffer.
3488 * After `#+', complete the special keywords like `TYP_TODO' or
3489 `OPTIONS' which set file-specific options for Org-mode. When
3490 the option keyword is already complete, pressing `M-<TAB>'
3491 again will insert example settings for this keyword.
3493 * Elsewhere, complete dictionary words using ispell.
3496 File: org, Node: Customization, Next: Summary of in-buffer settings, Prev: Completion, Up: Miscellaneous
3501 There are more than 100 variables that can be used to customize
3502 Org-mode. For the sake of compactness of the manual, we are not
3503 describing the variables here. A structured overview of customization
3504 variables is available with `M-x org-customize'. Or select `Browse Org
3505 Group' from the `Org->Customization' menu. Many settings can also be
3506 activated on a per-file basis, by putting special lines into the buffer
3507 (*note Summary of in-buffer settings::).
3510 File: org, Node: Summary of in-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
3512 11.3 Summary of in-buffer settings
3513 ==================================
3515 Org-mode uses special lines in the buffer to define settings on a
3516 per-file basis. These lines start with a `#+' followed by a keyword, a
3517 colon, and then individual words defining a setting. Several setting
3518 words can be in the same line, but you can also have multiple lines for
3519 the keyword. While these settings are described throughout the manual,
3520 here is a summary. After changing any of those lines in the buffer,
3521 press `C-c C-c' with the cursor still in the line to activate the
3522 changes immediately. Otherwise they become effective only when the
3523 file is visited again in a new Emacs session.
3526 This line sets options to be used at startup of org-mode, when an
3527 Org-mode file is being visited. The first set of options deals
3528 with the initial visibility of the outline tree. The
3529 corresponding variable for global default settings is
3530 `org-startup-folded', with a default value `t', which means
3532 overview top-level headlines only
3533 content all headlines
3534 showall no folding at all, show everything
3535 Then there are options for aligning tables upon visiting a file.
3536 This is useful in files containing narrowed table columns. The
3537 corresponding variable is `org-startup-align-all-tables', with a
3538 default value `nil'.
3539 align align all tables
3540 noalign don't align tables on startup
3541 Logging when a TODO item is marked DONE (variable `org-log-done')
3542 can be configured using these options.
3543 logging record a timestamp when an item is marked DONE
3544 nologging don't record when items are marked DONE
3545 Here are the options for hiding leading stars in outline headings.
3546 The corresponding variables are `org-hide-leading-stars' and
3547 `org-odd-levels-only', both with a default setting `nil' (meaning
3548 `showstars' and `oddeven').
3549 hidestars make all but one of the stars starting a headline invisible.
3550 showstars show all stars starting a headline
3551 odd allow only odd outline levels (1,3,...)
3552 oddeven allow all outline levels
3554 `#+SEQ_TODO: #+TYP_TODO:'
3555 These lines set the TODO keywords and their interpretation in the
3556 current file. The corresponding variables are `org-todo-keywords'
3557 and `org-todo-interpretation'.
3559 `#+TAGS: TAG1(c1) TAG2(c2)'
3560 These lines (several such lines are allowed) specify the legal
3561 tags in this file, and (potentially) the corresponding _fast tag
3562 selection_ keys. The corresponding variable is `org-tag-alist'.
3565 This line sets the category for the agenda file. The category
3566 applies for all subsequent lines until the next `#+CATEGORY' line,
3567 or the end of the file.
3570 This line contains the formulas for the table directly above the
3573 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
3574 These lines provide settings for exporting files. For more
3575 details see *Note Export options::.
3578 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: Summary of in-buffer settings, Up: Miscellaneous
3580 11.4 The very busy C-c C-c key
3581 ==============================
3583 The key `C-c C-c' has many purposes in org-mode, which are all
3584 mentioned scattered throughout this manual. One specific function of
3585 this key is to add _tags_ to a headline (*note Tags::). In many other
3586 circumstances it means something like _Hey Org-mode, look here and
3587 update according to what you see here_. Here is a summary of what this
3588 means in different contexts.
3590 - If the cursor is in one of the special `#+KEYWORD' lines, this
3591 triggers scanning the buffer for these lines and updating the
3594 - If the cursor is inside a table, realign the table. This command
3595 works even if the automatic table editor has been turned off.
3597 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
3600 - If the cursor is inside a table created by the `table.el' package,
3601 activate that table.
3603 - If the current buffer is a remember buffer, close note and file it.
3604 with a prefix argument, file it without further interaction to the
3607 - If the cursor is on a `<<<target>>>', update radio targets and
3608 corresponding links in this buffer.
3610 - If the cursor is in a plain list item with a checkbox, toggle the
3611 status of the checkbox.
3613 - If the cursor is on a numbered item in a plain list, renumber the
3617 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
3619 11.5 A cleaner outline view
3620 ===========================
3622 Some people find it noisy and distracting that the Org-mode headlines
3623 are starting with a potentially large number of stars. For example the
3624 tree from *Note Headlines:::
3626 * Top level headline
3632 * Another top level headline
3634 Unfortunately this is deeply ingrained into the code of Org-mode and
3635 cannot be easily changed. You can, however, modify the display in such
3636 a way that all leading stars become invisible and the outline more easy
3637 to read. To do this, customize the variable `org-hide-leading-stars'
3640 (setq org-hide-leading-stars t)
3642 or change this on a per-file basis with one of the lines (anywhere in
3645 #+STARTUP: showstars
3646 #+STARTUP: hidestars
3648 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
3651 With stars hidden, the tree becomes:
3653 * Top level headline
3659 * Another top level headline
3661 Note that the leading stars are not truly replaced by whitespace, they
3662 are only fontified with the face `org-hide' that uses the background
3663 color as font color. If are are not using either white or black
3664 background, you may have to customize this face to get the wanted
3665 effect. Another possibility is to set this font such that the extra
3666 stars are almost invisible, for example using the color `grey90' on a
3669 Things become cleaner still if you skip all the even levels and use
3670 only odd levels 1, 3, 5..., effectively adding two stars to go from one
3671 outline level to the next:
3673 * Top level headline
3679 * Another top level headline
3681 In order to make the structure editing and export commands handle this
3682 convention correctly, use
3684 (setq org-odd-levels-only t)
3686 or set this on a per-file basis with one of the following lines (don't
3687 forget to press `C-c C-c' with the cursor in the startup line to
3688 activate changes immediately).
3693 You can convert an Org-mode file from single-star-per-level to the
3694 double-star-per-level convention with `M-x org-convert-to-odd-levels
3695 RET' in that file. The reverse operation is `M-x
3696 org-convert-to-oddeven-levels'.
3699 File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
3701 11.6 Using org-mode on a tty
3702 ============================
3704 Org-mode uses a number of keys that are not accessible on a tty. This
3705 applies to most special keys like cursor keys, <TAB> and <RET>, when
3706 these are combined with modifier keys like <Meta> and/or <Shift>.
3707 Org-mode uses these bindings because it needs to provide keys for a
3708 large number of commands, and because these keys appeared particularly
3709 easy to remember. In order to still be able to access the core
3710 functionality of Org-mode on a tty, alternative bindings are provided.
3711 Here is a complete list of these bindings, which are obviously more
3712 cumbersome to use. Note that sometimes a work-around can be better.
3713 For example changing a time stamp is really only fun with `S-<cursor>'
3714 keys. On a tty you would rather use `C-c .' to re-insert the
3717 Default Alternative 1 Alternative 2
3718 `S-<TAB>' `C-u <TAB>'
3719 `M-<left>' `C-c C-x l' `<Esc> <left>'
3720 `M-S-<left>'`C-c C-x L'
3721 `M-<right>' `C-c C-x r' `<Esc>
3723 `M-S-<right>'`C-c C-x R'
3724 `M-<up>' `C-c C-x u' `<Esc> <up>'
3725 `M-S-<up>' `C-c C-x U'
3726 `M-<down>' `C-c C-x d' `<Esc> <down>'
3727 `M-S-<down>'`C-c C-x D'
3728 `S-<RET>' `C-c C-x c'
3729 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
3730 `M-S-<RET>' `C-c C-x M'
3733 `S-<right>' `C-c C-x
3741 File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
3743 11.7 Frequently asked questions
3744 ===============================
3746 1. When I try to use Org-mode, I always get `(wrong-type-argument
3748 This is a conflict with an outdated version of the `allout.el'.
3749 See *Note Conflicts::.
3751 2. Org-mode seems to be a useful default mode for the various
3752 `README' files I have scattered through my directories. How do I
3753 turn it on for all `README' files?
3755 (add-to-list 'auto-mode-alist '("README$" . org-mode))
3757 3. I would like to use editing features of org-mode in other modes,
3759 Not really. For tables there is `orgtbl-mode' which implements the
3760 table editor as a minor mode. For other features you need to
3761 switch to Org-mode temporarily, or prepare text in a different
3764 4. Can I get the visibility-cycling features in outline-mode and
3766 Yes, these functions are written in a way that they are
3767 independent of the outline setup. The following setup provides
3768 standard Org-mode functionality in outline-mode on <TAB> and
3769 `S-<TAB>'. For outline-minor-mode, we use `C-<TAB>' instead of
3770 <TAB>, because <TAB> usually has mode-specific tasks.
3771 (add-hook 'outline-minor-mode-hook
3773 (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
3774 (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
3775 (add-hook 'outline-mode-hook
3777 (define-key outline-mode-map [(tab)] 'org-cycle)
3778 (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
3780 Or check out `outline-magic.el', which does this and also provides
3781 promotion and demotion functionality. `outline-magic.el' is
3782 available at `http://www.astro.uva.nl/~dominik/Tools/OutlineMagic'.
3784 5. Some of my links stopped working after I upgraded to a version
3785 4.20 or later. Why is this, and how can I fix it?
3786 These must be links in plain text, containing white space, such as
3787 `bbdb:Richard Stallman'. You need to protect these links by
3788 putting double brackets around them, like `[[bbdb:Richard
3791 6. I see that Org-mode now creates links using the double bracket
3792 convention that hides the link part and the brackets, only showing
3793 the description part. How can I convert my old links to this new
3795 Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
3796 This replaces angular brackets with the new link format.
3798 7. I don't care if you find the new bracket links great, I am
3799 attached to the old style using angular brackets and no hiding of
3800 the link text. Please give them back to me, don't tell me it is
3802 Would I let you down like that? If you must, you can do this
3804 (setq org-link-style 'plain
3805 org-link-format "<%s>")
3807 8. When I am executing shell/elisp links I always get a confirmation
3808 prompt and need to type `yes <RET>', that's 4 key presses! Can I
3810 The confirmation is there to protect you from unwantingly execute
3811 potentially dangerous commands. For example, imagine a link
3812 `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
3813 command would look like `Google Search', but really it would remove
3814 your home directory. If you wish, you can make it easier to
3815 respond to the query by setting `org-confirm-shell-link-function'
3816 and/or `org-confirm-elisp-link-function' to `y-or-n-p'. Then a
3817 single `y' keypress will be enough to confirm those links. It is
3818 also possible to turn off this check entirely, but I do not
3819 recommend to do this. Be warned.
3821 9. All these stars are driving me mad, I just find the Emacs outlines
3822 unreadable. Can't you just put white space and a single star as a
3823 starter for headlines?
3824 See *Note Clean view::.
3826 10. I would like to have two windows on the same Org-mode file, but
3827 with different outline visibility. Is that possible?
3828 In GNU Emacs, you may use _indirect buffers_ which do exactly this.
3829 See the documentation on the command `make-indirect-buffer'. In
3830 XEmacs, this is currently not possible because of the different
3831 outline implementation.
3833 11. When I export my TODO list, every TODO item becomes a separate
3834 section. How do I enforce these items to be exported as an
3836 If you plan to use ASCII or HTML export, make sure things you want
3837 to be exported as item lists are level 4 at least, even if that
3838 does mean there is a level jump. For example:
3840 * Todays top priorities
3841 **** TODO write a letter to xyz
3842 **** TODO Finish the paper
3843 **** Pick up kids at the school
3845 Alternatively, if you need a specific value for the heading/item
3846 transition in a particular file, use the `+OPTIONS' line to
3847 configure the `H' switch.
3851 12. I would like to export only a subtree of my file to HTML. How?
3852 If you want to export a subtree, mark the subtree as region and
3853 then export. Marking can be done with `C-c @ C-x C-x', for
3856 13. Org-mode takes over the S-cursor keys. I also want to use
3857 CUA-mode, is there a way to fix this conflict?
3858 Yes, see *Note Conflicts::.
3860 14. One of my table columns has started to fill up with `#ERROR'.
3862 Org-mode tried to compute the column from other fields using a
3863 formula stored in the `#+TBLFM:' line just below the table, and
3864 the evaluation of the formula fails. Fix the fields used in the
3865 formula, or fix the formula, or remove it!
3867 15. When I am in the last column of a table and just above a
3868 horizontal line in the table, pressing TAB creates a new table line
3869 before the horizontal line. How can I quickly move to the line
3870 below the horizontal line instead?
3871 Press <down> (to get on the separator line) and then <TAB>. Or
3872 configure the variable `org-table-tab-jumps-over-hlines'.
3874 16. How can I change the indentation of an entire table without fixing
3876 The indentation of a table is set by the first line. So just fix
3877 the indentation of the first line and realign with <TAB>.
3879 17. Is it possible to include entries from org-mode files into my
3881 Since the org-mode agenda is much more powerful and can contain the
3882 diary (*note Calendar/Diary integration::), you should think twice
3883 before deciding to do this. Integrating Org-mode information into
3884 the diary is, however, possible. You need to turn on _fancy diary
3885 display_ by setting in `.emacs':
3887 (add-hook 'diary-display-hook 'fancy-diary-display)
3889 Then include the following line into your `~/diary' file, in order
3890 to get the entries from all files listed in the variable
3894 You may also select specific files with
3896 &%%(org-diary) ~/path/to/some/org-file.org
3897 &%%(org-diary) ~/path/to/another/org-file.org
3899 If you now launch the calendar and press `d' to display a diary,
3900 the headlines of entries containing a timestamp, date range,
3901 schedule, or deadline referring to the selected date will be
3902 listed. Just like Org-mode's agenda view, the diary for _today_
3903 contains additional entries for overdue deadlines and scheduled
3904 items. See also the documentation of the `org-diary' function.
3905 Under XEmacs, it is not possible to jump back from the diary to
3906 the org, this works only in the agenda buffer.
3910 File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
3912 11.8 Interaction with other packages
3913 ====================================
3915 Org-mode lives in the world of GNU Emacs and interacts in various ways
3916 with other code out there.
3920 * Extensions:: Third-party extensions for Org-mode
3921 * Cooperation:: Packages Org-mode cooperates with
3922 * Conflicts:: Packages that lead to conflicts
3925 File: org, Node: Extensions, Next: Cooperation, Prev: Interaction, Up: Interaction
3927 11.8.1 Third-party extensions for Org-mode
3928 ------------------------------------------
3930 The following extensions for Org-mode have been written by other people:
3932 `org-mouse.el' by Piotr Zielinski
3933 This package implements extended mouse functionality for Org-mode.
3934 It allows you to cycle visibility and to edit the document
3935 structure with the mouse. Best of all, it provides a
3936 context-sensitive menu on <mouse-3> that changes depending on the
3937 context of a mouse-click. `org-mouse.el' is freely available at
3938 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
3940 `org-publish.el' by David O'Toole
3941 This package provides facilities for publishing related sets of
3942 Org-mode files together with linked files like images as a
3943 webpages. It is highly configurable and can be used for other
3944 publishing purposes as well. As of Org-mode version 4.30,
3945 `org-publish.el' is part of the Org-mode distribution. It is not
3946 yet part of Emacs, however, due to a pending copyright assignment.
3947 In the mean time, `org-publish.el' can be downloaded from David's
3948 site: `http://dto.freeshell.org/e/org-publish.el'.
3951 File: org, Node: Cooperation, Next: Conflicts, Prev: Extensions, Up: Interaction
3953 11.8.2 Packages that Org-mode cooperates with
3954 ---------------------------------------------
3956 `calc.el' by Dave Gillespie
3957 Org-mode uses the calc package for implementing spreadsheet
3958 functionality in its tables (*note Table calculations::).
3959 Org-modes checks for the availability of calc by looking for the
3960 function `calc-eval' which should be autoloaded in your setup if
3961 calc has been installed properly. As of Emacs 22, calc is part of
3962 the Emacs distribution. Another possibility for interaction
3963 between the two packages is using calc for embedded calculations.
3964 *Note Embedded Mode: (calc)Embedded Mode.
3966 `constants.el' by Carsten Dominik
3967 In a table formula (*note Table calculations::), it is possible to
3968 use names for natural constants or units. Instead of defining
3969 your own constants in the variable `org-table-formula-constants',
3970 install the `constants' package which defines a large number of
3971 constants and units, and lets you use unit prefixes like `M' for
3972 `Mega' etc. You will need version 2.0 of this package, available
3973 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
3974 the function `constants-get', which has to be autoloaded in your
3975 setup. See the installation instructions in the file
3978 `remember.el' by John Wiegley
3979 Org mode cooperates with remember, see *Note Remember::.
3980 `Remember.el' is not part of Emacs, find it on the web.
3982 `table.el' by Takaaki Ota
3983 Org mode cooperates with table.el, see *Note table.el::.
3984 `table.el' is part of Emacs 22.
3987 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
3989 11.8.3 Packages that lead to conflicts with Org-mode
3990 ----------------------------------------------------
3992 `allout.el' by Ken Manheimer
3993 Startup of Org-mode may fail with the error message
3994 `(wrong-type-argument keymapp nil)' when there is an outdated
3995 version `allout.el' on the load path, for example the version
3996 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
3997 will disappear. If for some reason you cannot do this, make sure
3998 that org.el is loaded _before_ `allout.el', for example by putting
3999 `(require 'org)' early enough into your `.emacs' file.
4001 `CUA.el' by Kim. F. Storm
4002 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4003 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4004 select and extend the region. If you want to use one of these
4005 packages along with Org-mode, configure the variable
4006 `org-CUA-compatible'. When set, Org-mode will move the following
4007 keybindings in org-mode files, and in the agenda buffer (but not
4008 during date selection).
4010 S-UP -> M-p S-DOWN -> M-n
4011 S-LEFT -> M-- S-RIGHT -> M-+
4014 Yes, these are unfortunately more difficult to remember. If you
4015 want to have other replacement keys, look at the variable
4016 `org-disputed-keys'.
4018 `windmove.el' by Hovav Shacham
4019 Also this package uses the `S-<cursor>' keys, so everything written
4020 in the paragraph above about CUA mode also applies here.
4023 File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
4028 Here is a list of things that should work differently, but which I have
4029 found too hard to fix.
4031 * If a table field starts with a link, and if the corresponding table
4032 column is narrowed (*note Narrow columns::) to a width too small to
4033 display the link, the field would look entirely empty even though
4034 it is not. To prevent this, Org-mode throws an error. The
4035 work-around is to make the column wide enough to fit the link, or
4036 to add some text (at least 2 characters) before the link in the
4039 * Narrowing table columns does not work on XEmacs, because the
4040 `format' function does not transport text properties.
4042 * Text in an entry protected with the `QUOTE' keyword should not
4045 * When the application called by `C-c C-o' to open a file link fails
4046 (for example because the application does not exist or refuses to
4047 open the file), it does so silently. No error message is
4050 * Plain list items should be able to hold a TODO item.
4051 Unfortunately this has so many technical problems that I will only
4052 consider this change for the next major release (5.0).
4054 * The remote-editing commands in the agenda buffer cannot be undone
4055 with `undo' called from within the agenda buffer. But you can go
4056 to the corresponding buffer (using <TAB> or <RET> and execute
4059 * Recalculating a table line applies the formulas from left to right.
4060 If a formula uses _calculated_ fields further down the row,
4061 multiple recalculation may be needed to get all fields consistent.
4063 * Several words in a row may *be made bold*, but this does not work
4064 if the string is distributed over two lines.
4066 * The exporters work well, but could be made more efficient.
4069 File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
4071 11.10 Acknowledgments
4072 =====================
4074 Org-mode was created by Carsten Dominik, who still maintains it at the
4075 Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
4076 following people (in alphabetic order) have helped the development
4077 along with ideas, suggestions and patches. Many thanks to all of you,
4078 Org-mode would not be what it is without your input.
4080 * Thomas Baumann contributed the code for links to the MH-E email
4083 * Alex Bochannek provided a patch for rounding time stamps.
4085 * Charles Cave's suggestion sparked the implementation of templates
4088 * Pavel Chalmoviansky influenced the agenda treatment of items with
4091 * Gregory Chenov patched support for lisp forms into table
4092 calculations and improved XEmacs compatibility.
4094 * Sacha Chua suggested to copy some linking code from Planner.
4096 * Kees Dullemond inspired the use of narrowed tabled columns.
4098 * Christian Egli converted the documentation into TeXInfo format,
4099 patched CSS formatting into the HTML exporter, and inspired the
4102 * Nic Ferrier contributed mailcap and XOXO support.
4104 * Kai Grossjohann pointed out key-binding conflicts caused by
4107 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
4110 * Todd Neal provided patches for links to Info files and elisp forms.
4112 * Tim O'Callaghan suggested in-file links, search options for general
4113 file links, and TAGS.
4115 * Oliver Oppitz suggested multi-state TODO items.
4117 * Scott Otterson sparked the introduction of descriptive text for
4118 links, among other things.
4120 * Pete Phillips helped the development of the TAGS feature.
4122 * T.V. Raman reported bugs and suggested improvements.
4124 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
4127 * Kevin Rogers contributed code to access VM files on remote hosts.
4129 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
4130 conflict with `allout.el'.
4132 * Philip Rooke created the Org-mode reference card and provided lots
4135 * Christian Schlauer proposed angular brackets around links, among
4138 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
4139 `organizer-mode.el'.
4141 * David O'Toole wrote `org-publish.el' and drafted the manual
4142 chapter about publishing.
4144 * Ju"rgen Vollmer contributed code generating the table of contents
4147 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
4149 * David Wainberg suggested archiving, and improvements to the linking
4152 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
4153 development of Org-mode was fully independent, and both systems are
4154 really different beasts in their basic ideas and implementation
4155 details. I later looked at John's code, however, and learned from
4156 his implementation of (i) links where the link itself is hidden
4157 and only a description is shown, and (ii) popping up a calendar to
4160 * Carsten Wimmer suggested some changes and helped fix a bug in
4163 * Roland Winkler requested additional keybindings to make Org-mode
4166 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow
4170 File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
4178 * acknowledgments: Acknowledgments. (line 6)
4179 * active region <1>: HTML export. (line 10)
4180 * active region <2>: ASCII export. (line 9)
4181 * active region <3>: Built-in table editor.
4183 * active region: Structure editing. (line 51)
4184 * agenda: Weekly/Daily agenda. (line 6)
4185 * agenda commands, custom: Agenda dispatcher. (line 6)
4186 * agenda dispatcher: Agenda dispatcher. (line 6)
4187 * agenda files, removing buffers: Agenda commands. (line 195)
4188 * agenda views: Agenda views. (line 6)
4189 * agenda, for single file: Timeline. (line 6)
4190 * allout.el: Conflicts. (line 6)
4191 * allout.el, conflict with: FAQ. (line 8)
4192 * angular brackets, around links: External links. (line 38)
4193 * applescript, for calendar update: iCalendar export. (line 38)
4194 * archive locations: Archiving. (line 13)
4195 * archiving: Archiving. (line 6)
4196 * ASCII export: ASCII export. (line 6)
4197 * author: Feedback. (line 6)
4198 * autoload: Installation and activation.
4200 * BBDB links: External links. (line 6)
4201 * bold text: Enhancing text. (line 15)
4202 * bug reports: Feedback. (line 6)
4203 * bugs: Bugs. (line 6)
4204 * calc package: Table calculations. (line 6)
4205 * calc.el: Cooperation. (line 6)
4206 * calculations, in tables <1>: Table calculations. (line 6)
4207 * calculations, in tables: Built-in table editor.
4209 * calendar integration: Calendar/Diary integration.
4211 * calendar, for selecting date: Creating timestamps. (line 71)
4212 * CamelCase link completion: Completion. (line 6)
4213 * CamelCase links: Internal links. (line 6)
4214 * CamelCase links, completion of: CamelCase links. (line 6)
4215 * category: Categories. (line 6)
4216 * checkboxes: Plain lists. (line 36)
4217 * children, subtree visibility state: Visibility cycling. (line 10)
4218 * clean outline view: Clean view. (line 6)
4219 * CLOSED keyword: Time stamps. (line 55)
4220 * column formula: Column formulas. (line 6)
4221 * commands, in agenda buffer: Agenda commands. (line 6)
4222 * comment lines: Comment lines. (line 6)
4223 * completion, of CamelCase links <1>: Completion. (line 6)
4224 * completion, of CamelCase links: CamelCase links. (line 6)
4225 * completion, of dictionary words: Completion. (line 6)
4226 * completion, of file names: Handling links. (line 44)
4227 * completion, of links: Handling links. (line 28)
4228 * completion, of option keywords <1>: Completion. (line 6)
4229 * completion, of option keywords: Export options. (line 6)
4230 * Completion, of option keywords: Per file keywords. (line 17)
4231 * completion, of tags <1>: Completion. (line 6)
4232 * completion, of tags: Setting tags. (line 11)
4233 * completion, of TeX symbols <1>: Completion. (line 6)
4234 * completion, of TeX symbols: Enhancing text. (line 19)
4235 * completion, of TODO keywords <1>: Completion. (line 6)
4236 * completion, of TODO keywords: Workflow states. (line 12)
4237 * constants, in calculations: Formula syntax. (line 26)
4238 * constants.el: Cooperation. (line 14)
4239 * contents, global visibility state: Visibility cycling. (line 22)
4240 * copying, of subtrees: Structure editing. (line 6)
4241 * creating timestamps: Creating timestamps. (line 6)
4242 * CUA.el: Conflicts. (line 15)
4243 * custom agenda commands: Agenda dispatcher. (line 6)
4244 * custom search strings: Custom searches. (line 6)
4245 * customization: Customization. (line 6)
4246 * cutting, of subtrees: Structure editing. (line 6)
4247 * cycling, of TODO states: TODO basics. (line 13)
4248 * cycling, visibility: Visibility cycling. (line 6)
4249 * dangerous commands: FAQ. (line 70)
4250 * date stamps: Time stamps. (line 6)
4251 * date, reading in minibuffer: Creating timestamps. (line 71)
4252 * DEADLINE keyword: Time stamps. (line 43)
4253 * deadlines: Time stamps. (line 6)
4254 * demotion, of subtrees: Structure editing. (line 6)
4255 * diary entries, creating from agenda: Agenda commands. (line 153)
4256 * diary integration: Calendar/Diary integration.
4258 * dictionary word completion: Completion. (line 6)
4259 * dispatching agenda commands: Agenda dispatcher. (line 6)
4260 * document structure: Document structure. (line 6)
4261 * DONE, final TODO keyword: Per file keywords. (line 20)
4262 * editing tables: Tables. (line 6)
4263 * editing, of table formulas: Editing/debugging formulas.
4265 * elisp links: External links. (line 6)
4266 * emphasized text: Export options. (line 25)
4267 * enhancing text: Enhancing text. (line 6)
4268 * evaluate time range: Creating timestamps. (line 66)
4269 * exporting: Exporting. (line 6)
4270 * exporting a subtree: FAQ. (line 112)
4271 * exporting, not: Comment lines. (line 6)
4272 * extended TODO keywords: TODO extensions. (line 6)
4273 * external links: External links. (line 6)
4274 * external links, in HTML export: HTML export. (line 35)
4275 * FAQ: FAQ. (line 6)
4276 * feedback: Feedback. (line 6)
4277 * file links: External links. (line 6)
4278 * file links, searching: Search options. (line 6)
4279 * file name completion: Handling links. (line 44)
4280 * files, adding to agenda list: Agenda files. (line 12)
4281 * filing subtrees: Archiving. (line 6)
4282 * fixed width: Enhancing text. (line 30)
4283 * fixed-width sections: Export options. (line 25)
4284 * folded, subtree visibility state: Visibility cycling. (line 10)
4285 * folding, sparse trees: Sparse trees. (line 6)
4286 * following links: Handling links. (line 59)
4287 * format specifier: Formula syntax. (line 34)
4288 * format, of links: Link format. (line 6)
4289 * formula editing: Editing/debugging formulas.
4291 * formula syntax: Formula syntax. (line 6)
4292 * formula, for named table field: Named-field formulas.
4294 * formula, for table column: Column formulas. (line 6)
4295 * formula, in tables: Built-in table editor.
4297 * global cycling: Visibility cycling. (line 22)
4298 * global keybindings: Installation and activation.
4300 * global TODO list: Global TODO list. (line 6)
4301 * global visibility states: Visibility cycling. (line 22)
4302 * GNUS links: External links. (line 6)
4303 * hand-formatted lists: Enhancing text. (line 11)
4304 * headline levels: Export options. (line 25)
4305 * headline levels, for exporting <1>: HTML export. (line 21)
4306 * headline levels, for exporting: ASCII export. (line 18)
4307 * headline navigation: Motion. (line 6)
4308 * headline tagging: Tags. (line 6)
4309 * headline, promotion and demotion: Structure editing. (line 6)
4310 * headlines: Headlines. (line 6)
4311 * hide text: Visibility cycling. (line 6)
4312 * hiding leading stars: Clean view. (line 6)
4313 * HTML export: HTML export. (line 6)
4314 * hyperlinks: Hyperlinks. (line 6)
4315 * iCalendar export: iCalendar export. (line 6)
4316 * in-buffer settings: Summary of in-buffer settings.
4318 * indentation, of tables: FAQ. (line 136)
4319 * indirect buffers: FAQ. (line 88)
4320 * Info links: External links. (line 6)
4321 * inheritance, of tags: Tag inheritance. (line 6)
4322 * inserting links: Handling links. (line 28)
4323 * installation: Installation and activation.
4325 * internal links: Internal links. (line 6)
4326 * internal links, in HTML export: HTML export. (line 35)
4327 * introduction: Introduction. (line 6)
4328 * italic text: Enhancing text. (line 15)
4329 * jumping, to headlines: Motion. (line 6)
4330 * keybindings, global: Installation and activation.
4332 * keymapp nil error: FAQ. (line 6)
4333 * keyword options: Per file keywords. (line 6)
4334 * linebreak preservation: Export options. (line 25)
4335 * linebreak, forced: Enhancing text. (line 37)
4336 * link completion: Handling links. (line 28)
4337 * link format: Link format. (line 6)
4338 * links, external: External links. (line 6)
4339 * links, in HTML export: HTML export. (line 35)
4340 * links, internal: Internal links. (line 6)
4341 * links, returning to: Handling links. (line 85)
4342 * Lisp forms, as table formulas: Lisp formulas. (line 6)
4343 * lists, hand-formatted: Enhancing text. (line 11)
4344 * lists, ordered: Plain lists. (line 6)
4345 * lists, plain: Plain lists. (line 6)
4346 * logging, of progress: Progress logging. (line 6)
4347 * maintainer: Feedback. (line 6)
4348 * make-indirect-buffer: FAQ. (line 88)
4349 * mark ring: Handling links. (line 81)
4350 * marking characters, tables: Advanced features. (line 34)
4351 * matching, of tags: Matching headline tags.
4353 * matching, tags: Tags. (line 6)
4354 * MH-E links: External links. (line 6)
4355 * minor mode for tables: orgtbl-mode. (line 6)
4356 * mode, for calc: Formula syntax. (line 34)
4357 * motion, between headlines: Motion. (line 6)
4358 * name, of column or field: Formula syntax. (line 26)
4359 * named field formula: Named-field formulas.
4361 * names as TODO keywords: TODO types. (line 6)
4362 * narrow columns in tables: Narrow columns. (line 6)
4363 * occur, command: Sparse trees. (line 6)
4364 * option keyword completion: Completion. (line 6)
4365 * options, for customization: Customization. (line 6)
4366 * options, for export: Export options. (line 6)
4367 * ordered lists: Plain lists. (line 6)
4368 * org-agenda, command: Weekly/Daily agenda. (line 9)
4369 * org-mode, turning on: Installation and activation.
4371 * org-mouse.el: Extensions. (line 8)
4372 * org-publish.el: Extensions. (line 14)
4373 * orgtbl-mode: orgtbl-mode. (line 6)
4374 * outline tree: Headlines. (line 6)
4375 * outline-mode: Outlines. (line 6)
4376 * outlines: Outlines. (line 6)
4377 * overview, global visibility state: Visibility cycling. (line 22)
4378 * packages, interaction with other: Interaction. (line 6)
4379 * pasting, of subtrees: Structure editing. (line 6)
4380 * per file keywords: Per file keywords. (line 6)
4381 * plain lists: Plain lists. (line 6)
4382 * plain text external links: External links. (line 38)
4383 * printing sparse trees: Sparse trees. (line 39)
4384 * priorities: Priorities. (line 6)
4385 * priorities, of agenda items: Sorting of agenda items.
4387 * progress logging: Progress logging. (line 6)
4388 * promotion, of subtrees: Structure editing. (line 6)
4389 * quoted HTML tags: Export options. (line 25)
4390 * ranges, time: Time stamps. (line 6)
4391 * recomputing table fields: Column formulas. (line 27)
4392 * region, active <1>: HTML export. (line 10)
4393 * region, active <2>: ASCII export. (line 9)
4394 * region, active <3>: Built-in table editor.
4396 * region, active: Structure editing. (line 51)
4397 * remember.el <1>: Cooperation. (line 29)
4398 * remember.el: Remember. (line 6)
4399 * richer text: Enhancing text. (line 6)
4400 * RMAIL links: External links. (line 6)
4401 * SCHEDULED keyword: Time stamps. (line 30)
4402 * scheduling: Time stamps. (line 6)
4403 * search option in file links: Search options. (line 6)
4404 * section-numbers: Export options. (line 25)
4405 * setting tags: Setting tags. (line 6)
4406 * SHELL links: External links. (line 6)
4407 * shell links, confirmation: FAQ. (line 70)
4408 * show all, command: Visibility cycling. (line 31)
4409 * show all, global visibility state: Visibility cycling. (line 22)
4410 * show hidden text: Visibility cycling. (line 6)
4411 * single file summary: Timeline. (line 6)
4412 * sorting, of agenda items: Sorting of agenda items.
4414 * sparse tree, for deadlines: Creating timestamps. (line 41)
4415 * sparse tree, for TODO: TODO basics. (line 26)
4416 * sparse tree, tag based: Tags. (line 6)
4417 * sparse trees: Sparse trees. (line 6)
4418 * special keywords: Summary of in-buffer settings.
4420 * spreadsheet capabilities: Table calculations. (line 6)
4421 * storing links: Handling links. (line 9)
4422 * structure editing: Structure editing. (line 6)
4423 * structure of document: Document structure. (line 6)
4424 * subtree cycling: Visibility cycling. (line 10)
4425 * subtree visibility states: Visibility cycling. (line 10)
4426 * subtree, cut and paste: Structure editing. (line 6)
4427 * subtree, subtree visibility state: Visibility cycling. (line 10)
4428 * subtrees, cut and paste: Structure editing. (line 6)
4429 * summary: Summary. (line 6)
4430 * syntax, of formulas: Formula syntax. (line 6)
4431 * table editor, builtin: Built-in table editor.
4433 * table editor, table.el: table.el. (line 6)
4434 * table of contents: Export options. (line 25)
4435 * table.el <1>: Cooperation. (line 30)
4436 * table.el: table.el. (line 6)
4437 * tables <1>: Export options. (line 25)
4438 * tables: Tables. (line 6)
4439 * tables, export: Enhancing text. (line 26)
4440 * tag completion: Completion. (line 6)
4441 * tag searches: Tag searches. (line 6)
4442 * tags: Tags. (line 6)
4443 * tags view: Matching headline tags.
4445 * templates, for remember: Remember. (line 23)
4446 * TeX interpretation: Enhancing text. (line 17)
4447 * TeX macros: Export options. (line 25)
4448 * TeX symbol completion: Completion. (line 6)
4449 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
4450 * thanks: Acknowledgments. (line 6)
4451 * time stamps: Time stamps. (line 6)
4452 * time, reading in minibuffer: Creating timestamps. (line 71)
4453 * time-sorted view: Timeline. (line 6)
4454 * timeline, single file: Timeline. (line 6)
4455 * timerange: Time stamps. (line 21)
4456 * timestamp: Time stamps. (line 13)
4457 * timestamps, creating: Creating timestamps. (line 6)
4458 * TODO items: TODO items. (line 6)
4459 * TODO keywords completion: Completion. (line 6)
4460 * TODO list, global: Global TODO list. (line 6)
4461 * TODO types: TODO types. (line 6)
4462 * TODO workflow: Workflow states. (line 6)
4463 * transient-mark-mode <1>: HTML export. (line 10)
4464 * transient-mark-mode <2>: ASCII export. (line 9)
4465 * transient-mark-mode <3>: Built-in table editor.
4467 * transient-mark-mode: Structure editing. (line 51)
4468 * trees, sparse: Sparse trees. (line 6)
4469 * trees, visibility: Visibility cycling. (line 6)
4470 * tty keybindings: TTY keys. (line 6)
4471 * types as TODO keywords: TODO types. (line 6)
4472 * underlined text: Enhancing text. (line 15)
4473 * URL links: External links. (line 6)
4474 * USENET links: External links. (line 6)
4475 * variables, for customization: Customization. (line 6)
4476 * vectors, in table calculations: Formula syntax. (line 23)
4477 * visibility cycling: Visibility cycling. (line 6)
4478 * visible text, printing: Sparse trees. (line 39)
4479 * VM links: External links. (line 6)
4480 * WANDERLUST links: External links. (line 6)
4481 * windmove.el: Conflicts. (line 33)
4482 * workflow states as TODO keywords: Workflow states. (line 6)
4483 * XOXO export: XOXO export. (line 6)
4486 File: org, Node: Key Index, Prev: Index, Up: Top
4494 * +: Agenda commands. (line 120)
4495 * ,: Agenda commands. (line 112)
4496 * -: Agenda commands. (line 126)
4497 * .: Agenda commands. (line 91)
4498 * :: Agenda commands. (line 109)
4499 * <: Creating timestamps. (line 78)
4500 * <left>: Agenda commands. (line 88)
4501 * <RET> <1>: Agenda commands. (line 41)
4502 * <RET> <2>: Creating timestamps. (line 103)
4503 * <RET>: Built-in table editor.
4505 * <right>: Agenda commands. (line 83)
4506 * <SPC>: Agenda commands. (line 28)
4507 * <TAB> <1>: Agenda commands. (line 35)
4508 * <TAB> <2>: Built-in table editor.
4510 * <TAB> <3>: Plain lists. (line 48)
4511 * <TAB>: Visibility cycling. (line 10)
4512 * > <1>: Agenda commands. (line 148)
4513 * >: Creating timestamps. (line 79)
4514 * C: Agenda commands. (line 178)
4515 * c: Agenda commands. (line 162)
4516 * C-#: Built-in table editor.
4518 * C-,: Agenda files. (line 18)
4519 * C-c !: Creating timestamps. (line 21)
4520 * C-c $: Archiving. (line 9)
4521 * C-c %: Handling links. (line 81)
4522 * C-c &: Handling links. (line 85)
4523 * C-c ' <1>: Editing/debugging formulas.
4525 * C-c ': Built-in table editor.
4527 * C-c *: Built-in table editor.
4529 * C-c +: Built-in table editor.
4531 * C-c ,: Priorities. (line 18)
4532 * C-c -: Built-in table editor.
4534 * C-c .: Creating timestamps. (line 10)
4535 * C-c /: Sparse trees. (line 15)
4536 * C-c :: Enhancing text. (line 34)
4537 * C-c ;: Comment lines. (line 11)
4538 * C-c <: Creating timestamps. (line 25)
4539 * C-c <TAB>: Built-in table editor.
4541 * C-c =: Built-in table editor.
4543 * C-c >: Creating timestamps. (line 29)
4544 * C-c ? <1>: Editing/debugging formulas.
4546 * C-c ?: Built-in table editor.
4548 * C-c [: Agenda files. (line 12)
4549 * C-c \: Tag searches. (line 9)
4550 * C-c ]: Agenda files. (line 15)
4551 * C-c ^: Built-in table editor.
4553 * C-c `: Built-in table editor.
4555 * C-c a a: Weekly/Daily agenda. (line 9)
4556 * C-c a C: Agenda dispatcher. (line 30)
4557 * C-c a M: Matching headline tags.
4559 * C-c a m: Matching headline tags.
4561 * C-c a M: Tag searches. (line 14)
4562 * C-c a m: Tag searches. (line 10)
4563 * C-c a T: Global TODO list. (line 14)
4564 * C-c a t <1>: Global TODO list. (line 9)
4565 * C-c a t: TODO basics. (line 33)
4566 * C-c C-a: Visibility cycling. (line 31)
4567 * C-c C-b: Motion. (line 15)
4568 * C-c C-c <1>: The very busy C-c C-c key.
4570 * C-c C-c <2>: Setting tags. (line 10)
4571 * C-c C-c <3>: table.el. (line 6)
4572 * C-c C-c <4>: Editing/debugging formulas.
4574 * C-c C-c <5>: Built-in table editor.
4576 * C-c C-c: Plain lists. (line 85)
4577 * C-c C-d <1>: Agenda commands. (line 133)
4578 * C-c C-d: Creating timestamps. (line 37)
4579 * C-c C-f: Motion. (line 12)
4580 * C-c C-j: Motion. (line 21)
4581 * C-c C-l: Handling links. (line 28)
4582 * C-c C-n: Motion. (line 8)
4583 * C-c C-o <1>: Creating timestamps. (line 33)
4584 * C-c C-o: Handling links. (line 59)
4585 * C-c C-p: Motion. (line 9)
4586 * C-c C-q <1>: Editing/debugging formulas.
4588 * C-c C-q: Built-in table editor.
4590 * C-c C-r: Timeline. (line 13)
4591 * C-c C-s <1>: Agenda commands. (line 130)
4592 * C-c C-s: Creating timestamps. (line 48)
4593 * C-c C-t: TODO basics. (line 13)
4594 * C-c C-u: Motion. (line 18)
4595 * C-c C-v: TODO basics. (line 26)
4596 * C-c C-w: Creating timestamps. (line 41)
4597 * C-c C-x a: ASCII export. (line 9)
4598 * C-c C-x b: HTML export. (line 11)
4599 * C-c C-x c: iCalendar export. (line 20)
4600 * C-c C-x C-c: Agenda commands. (line 185)
4601 * C-c C-x C-i: iCalendar export. (line 15)
4602 * C-c C-x C-k: Structure editing. (line 36)
4603 * C-c C-x C-w <1>: Built-in table editor.
4605 * C-c C-x C-w: Structure editing. (line 36)
4606 * C-c C-x C-x: XOXO export. (line 10)
4607 * C-c C-x C-y <1>: Built-in table editor.
4609 * C-c C-x C-y: Structure editing. (line 43)
4610 * C-c C-x h: HTML export. (line 10)
4611 * C-c C-x i: iCalendar export. (line 13)
4612 * C-c C-x M-w <1>: Built-in table editor.
4614 * C-c C-x M-w: Structure editing. (line 40)
4615 * C-c C-x t: Export options. (line 13)
4616 * C-c C-x v <1>: XOXO export. (line 11)
4617 * C-c C-x v: Sparse trees. (line 39)
4618 * C-c C-x v a: ASCII export. (line 13)
4619 * C-c C-x v b: HTML export. (line 14)
4620 * C-c C-x v h: HTML export. (line 14)
4621 * C-c C-y: Creating timestamps. (line 66)
4622 * C-c l: Handling links. (line 9)
4623 * C-c |: Built-in table editor.
4625 * C-c ~: table.el. (line 18)
4626 * C-u C-c .: Creating timestamps. (line 16)
4627 * C-u C-c =: Built-in table editor.
4629 * C-u C-c C-l: Handling links. (line 44)
4630 * D: Agenda commands. (line 68)
4631 * d: Agenda commands. (line 65)
4632 * f: Agenda commands. (line 44)
4633 * g: Agenda commands. (line 72)
4634 * H: Agenda commands. (line 182)
4635 * i: Agenda commands. (line 153)
4636 * l: Agenda commands. (line 51)
4637 * L: Agenda commands. (line 32)
4638 * M: Agenda commands. (line 169)
4639 * M-<down>: Built-in table editor.
4641 * M-<left> <1>: Built-in table editor.
4643 * M-<left>: Structure editing. (line 18)
4644 * M-<RET> <1>: Plain lists. (line 53)
4645 * M-<RET>: Structure editing. (line 6)
4646 * M-<right> <1>: Built-in table editor.
4648 * M-<right>: Structure editing. (line 21)
4649 * M-<TAB> <1>: Completion. (line 10)
4650 * M-<TAB> <2>: Setting tags. (line 6)
4651 * M-<TAB>: Per file keywords. (line 17)
4652 * M-<up>: Built-in table editor.
4654 * M-S-<down> <1>: Built-in table editor.
4656 * M-S-<down> <2>: Plain lists. (line 70)
4657 * M-S-<down>: Structure editing. (line 33)
4658 * M-S-<left> <1>: Creating timestamps. (line 100)
4659 * M-S-<left> <2>: Built-in table editor.
4661 * M-S-<left> <3>: Plain lists. (line 76)
4662 * M-S-<left>: Structure editing. (line 24)
4663 * M-S-<RET> <1>: Plain lists. (line 63)
4664 * M-S-<RET>: Structure editing. (line 15)
4665 * M-S-<right> <1>: Creating timestamps. (line 97)
4666 * M-S-<right> <2>: Built-in table editor.
4668 * M-S-<right> <3>: Plain lists. (line 76)
4669 * M-S-<right>: Structure editing. (line 27)
4670 * M-S-<up> <1>: Built-in table editor.
4672 * M-S-<up> <2>: Plain lists. (line 70)
4673 * M-S-<up>: Structure editing. (line 30)
4674 * mouse-1 <1>: Agenda commands. (line 35)
4675 * mouse-1 <2>: Creating timestamps. (line 82)
4676 * mouse-1: Handling links. (line 73)
4677 * mouse-2 <1>: Agenda commands. (line 35)
4678 * mouse-2: Handling links. (line 73)
4679 * mouse-3 <1>: Agenda commands. (line 28)
4680 * mouse-3: Handling links. (line 78)
4681 * n: Agenda commands. (line 19)
4682 * o: Agenda commands. (line 59)
4683 * P: Agenda commands. (line 117)
4684 * p: Agenda commands. (line 20)
4685 * q: Agenda commands. (line 192)
4686 * r <1>: Agenda commands. (line 76)
4687 * r: Global TODO list. (line 20)
4688 * S: Agenda commands. (line 173)
4689 * S-<down> <1>: Agenda commands. (line 126)
4690 * S-<down> <2>: Creating timestamps. (line 58)
4691 * S-<down> <3>: Priorities. (line 25)
4692 * S-<down>: Plain lists. (line 66)
4693 * S-<left> <1>: Agenda commands. (line 144)
4694 * S-<left> <2>: Creating timestamps. (line 53)
4695 * S-<left>: TODO basics. (line 20)
4696 * S-<RET>: Built-in table editor.
4698 * S-<right> <1>: Agenda commands. (line 136)
4699 * S-<right> <2>: Creating timestamps. (line 53)
4700 * S-<right>: TODO basics. (line 20)
4701 * S-<TAB> <1>: Built-in table editor.
4703 * S-<TAB>: Visibility cycling. (line 22)
4704 * S-<up> <1>: Agenda commands. (line 120)
4705 * S-<up> <2>: Creating timestamps. (line 58)
4706 * S-<up> <3>: Priorities. (line 25)
4707 * S-<up>: Plain lists. (line 66)
4708 * T: Agenda commands. (line 104)
4709 * t: Agenda commands. (line 100)
4710 * w: Agenda commands. (line 62)
4711 * x: Agenda commands. (line 195)
4717 Node: Introduction
\x7f8679
4718 Node: Summary
\x7f8993
4719 Node: Installation and activation
\x7f11249
4720 Node: Feedback
\x7f12907
4721 Node: Document structure
\x7f13693
4722 Node: Outlines
\x7f14459
4723 Node: Headlines
\x7f15119
4724 Node: Visibility cycling
\x7f15742
4725 Ref: Visibility cycling-Footnote-1
\x7f17217
4726 Ref: Visibility cycling-Footnote-2
\x7f17275
4727 Node: Motion
\x7f17325
4728 Node: Structure editing
\x7f18109
4729 Node: Archiving
\x7f20218
4730 Node: Sparse trees
\x7f21078
4731 Ref: Sparse trees-Footnote-1
\x7f23057
4732 Ref: Sparse trees-Footnote-2
\x7f23149
4733 Node: Plain lists
\x7f23264
4734 Ref: Plain lists-Footnote-1
\x7f27162
4735 Node: Tables
\x7f27519
4736 Node: Built-in table editor
\x7f28067
4737 Node: Narrow columns
\x7f35674
4738 Ref: Narrow columns-Footnote-1
\x7f37613
4739 Node: Table calculations
\x7f37659
4740 Node: Formula syntax
\x7f38979
4741 Ref: Formula syntax-Footnote-1
\x7f41884
4742 Node: Lisp formulas
\x7f42184
4743 Node: Column formulas
\x7f42973
4744 Node: Advanced features
\x7f44735
4745 Node: Named-field formulas
\x7f47989
4746 Node: Editing/debugging formulas
\x7f48629
4747 Node: Appetizer
\x7f50387
4748 Node: orgtbl-mode
\x7f51490
4749 Node: table.el
\x7f51981
4750 Node: Hyperlinks
\x7f52958
4751 Node: Link format
\x7f53663
4752 Node: Internal links
\x7f54956
4753 Ref: Internal links-Footnote-1
\x7f56945
4754 Node: Radio targets
\x7f57077
4755 Node: CamelCase links
\x7f57792
4756 Node: External links
\x7f58290
4757 Node: Handling links
\x7f60421
4758 Node: Search options
\x7f64971
4759 Ref: Search options-Footnote-1
\x7f66745
4760 Node: Custom searches
\x7f66826
4761 Node: Remember
\x7f67874
4762 Node: TODO items
\x7f71564
4763 Node: TODO basics
\x7f72487
4764 Node: Progress logging
\x7f74015
4765 Node: TODO extensions
\x7f74801
4766 Node: Workflow states
\x7f75601
4767 Node: TODO types
\x7f76469
4768 Ref: TODO types-Footnote-1
\x7f78127
4769 Node: Per file keywords
\x7f78209
4770 Ref: Per file keywords-Footnote-1
\x7f79663
4771 Node: Priorities
\x7f79891
4772 Node: Timestamps
\x7f81107
4773 Node: Time stamps
\x7f81428
4774 Node: Creating timestamps
\x7f84202
4776 Node: Tag inheritance
\x7f88285
4777 Node: Setting tags
\x7f89222
4778 Ref: Setting tags-Footnote-1
\x7f92352
4779 Ref: Setting tags-Footnote-2
\x7f92464
4780 Node: Tag searches
\x7f92544
4781 Node: Agenda views
\x7f93753
4782 Node: Agenda files
\x7f95292
4783 Ref: Agenda files-Footnote-1
\x7f96252
4784 Ref: Agenda files-Footnote-2
\x7f96401
4785 Node: Agenda dispatcher
\x7f96593
4786 Node: Weekly/Daily agenda
\x7f98723
4787 Node: Categories
\x7f99858
4788 Node: Time-of-day specifications
\x7f100506
4789 Node: Calendar/Diary integration
\x7f102482
4790 Node: Sorting of agenda items
\x7f103859
4791 Node: Global TODO list
\x7f104691
4792 Node: Matching headline tags
\x7f106052
4793 Node: Timeline
\x7f106995
4794 Node: Agenda commands
\x7f107868
4795 Node: Exporting
\x7f113336
4796 Node: ASCII export
\x7f114469
4797 Node: HTML export
\x7f115755
4798 Node: XOXO export
\x7f118589
4799 Node: iCalendar export
\x7f119028
4800 Node: Text interpretation
\x7f120851
4801 Node: Comment lines
\x7f121328
4802 Node: Enhancing text
\x7f121797
4803 Node: Export options
\x7f123721
4804 Node: Publishing
\x7f125323
4805 Ref: Publishing-Footnote-1
\x7f126119
4806 Node: Configuration
\x7f126315
4807 Node: Project alist
\x7f127036
4808 Node: File sources and destinations
\x7f128107
4809 Node: Selecting files
\x7f128659
4810 Node: Publishing action
\x7f129412
4811 Node: Publishing options
\x7f130527
4812 Node: Publishing links
\x7f132566
4813 Node: Project page index
\x7f133369
4814 Node: Sample configuration
\x7f134147
4815 Node: Simple example
\x7f134639
4816 Node: Complex example
\x7f135312
4817 Node: Triggering publication
\x7f137388
4818 Node: Miscellaneous
\x7f138044
4819 Node: Completion
\x7f138803
4820 Node: Customization
\x7f139799
4821 Node: Summary of in-buffer settings
\x7f140406
4822 Node: The very busy C-c C-c key
\x7f143648
4823 Node: Clean view
\x7f145163
4824 Node: TTY keys
\x7f147740
4826 Node: Interaction
\x7f157139
4827 Node: Extensions
\x7f157599
4828 Node: Cooperation
\x7f158851
4829 Node: Conflicts
\x7f160545
4830 Node: Bugs
\x7f162137
4831 Node: Acknowledgments
\x7f164035
4832 Node: Index
\x7f167473
4833 Node: Key Index
\x7f189792