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.51).
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.51).
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 * Embedded LaTeX:: LaTeX fragments and formulas
57 * Exporting:: Sharing and publishing of notes
58 * Publishing:: Create a web site of linked Org-mode files
59 * Miscellaneous:: All the rest which did not fit elsewhere
60 * Extensions and Hacking:: It is possible to write add-on code
61 * History and Acknowledgments:: How Org-mode came into being
62 * Index:: The fast road to specific information
63 * Key Index:: Key bindings and where they are described
65 --- The Detailed Node Listing ---
69 * Summary:: Brief summary of what Org-mode does
70 * Installation:: How to install a downloaded version of Org-mode
71 * Activation:: How to activate Org-mode for certain buffers.
72 * Feedback:: Bug reports, ideas, patches etc.
76 * Outlines:: Org-mode is based on outline-mode
77 * Headlines:: How to typeset org-tree headlines
78 * Visibility cycling:: Show and hide, much simplified
79 * Motion:: Jumping to other headlines
80 * Structure editing:: Changing sequence and level of headlines
81 * Archiving:: Move done task trees to a different place
82 * Sparse trees:: Matches embedded in context
83 * Plain lists:: Additional structure within an entry
87 * ARCHIVE tag:: Marking a tree as inactive
88 * Moving subtrees:: Moving a tree to an archive file
92 * Built-in table editor:: Simple tables
93 * Narrow columns:: Stop wasting space in tables
94 * Table calculations:: Compute a field from other fields
95 * orgtbl-mode:: The table editor as minor mode
96 * table.el:: Complex tables
98 Calculations in tables
100 * Formula syntax:: How to write a formula
101 * Lisp formulas:: An alternative way to write formulas
102 * Column formulas:: Formulas valid for all fields in a column
103 * Advanced features:: Field names, parameters and automatic recalc
104 * Named-field formulas:: Formulas valid in single fields
105 * Editing/debugging formulas:: Changing a stored formula
106 * Appetizer:: Taste the power of calc
110 * Link format:: How links in Org-mode are formatted
111 * Internal links:: Links to other places in the current file
112 * External links:: URL-like links to the world
113 * Handling links:: Creating, inserting and following
114 * Link abbreviations:: Shortcuts for writing complex links
115 * Search options:: Linking to a specific location
116 * Custom searches:: When the default search is not enough
117 * Remember:: Org-trees store quick notes
121 * Radio targets:: Make targets trigger links in plain text.
122 * CamelCase links:: Activating CamelCase words as links
126 * TODO basics:: Marking and displaying TODO entries
127 * TODO extensions:: Workflow and assignments
128 * Priorities:: Some things are more important than others
129 * Breaking down tasks:: Splitting a task into managable pieces
130 * Checkboxes:: Tick-off lists
132 Extended use of TODO keywords
134 * Workflow states:: From TODO to DONE in steps
135 * TODO types:: I do this, Fred the rest
136 * Per file keywords:: Different files, different requirements
140 * Time stamps:: Assigning a time to a tree entry
141 * Creating timestamps:: Commands which insert timestamps
142 * Progress logging:: Documenting when what work was done.
146 * The date/time prompt::
150 * Closing items:: When was this entry marked DONE?
151 * Clocking work time:: When exactly did you work on this item?
155 * Tag inheritance:: Tags use the tree structure of the outline
156 * Setting tags:: How to assign tags to a headline
157 * Tag searches:: Searching for combinations of tags
161 * Agenda files:: Files being searched for agenda information
162 * Agenda dispatcher:: Keyboard access to agenda views
163 * Weekly/Daily agenda:: The calendar page with current tasks
164 * Global TODO list:: All unfinished action items
165 * Matching headline tags:: Structured information with fine-tuned search
166 * Timeline:: Time-sorted view for single file
167 * Presentation and sorting:: How agenda items are prepared for display
168 * Agenda commands:: Remote editing of org trees
169 * Custom agenda views:: Defining special searches and views
171 The weekly/daily agenda
173 * Calendar/Diary integration:: Integrating Anniversaries and more
175 Presentation and sorting
177 * Categories:: Not all tasks are equal
178 * Time-of-day specifications:: How the agenda knows the time
179 * Sorting of agenda items:: The order of things
183 * Storing searches:: Type once, use often
184 * Block agenda:: All the stuff you need in a single buffer
185 * Setting Options:: Changing the rules
186 * Batch processing:: Agenda views from the command line
190 * Math symbols:: TeX macros for symbols and Greek letters
191 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
192 * LaTeX fragments:: Complex formulas made easy
193 * Processing LaTeX fragments:: Previewing LaTeX processing
194 * CDLaTeX mode:: Speed up entering of formulas
198 * ASCII export:: Exporting to plain ASCII
199 * HTML export:: Exporting to HTML
200 * XOXO export:: Exporting to XOXO
201 * iCalendar export:: Exporting in iCalendar format
202 * Text interpretation:: How the exporter looks at the file
204 Text interpretation by the exporter
206 * Comment lines:: Some lines will not be exported
207 * Enhancing text:: Subscripts, symbols and more
208 * Export options:: How to influence the export settings
212 * Configuration:: Defining projects
213 * Sample configuration:: Example projects
214 * Triggering publication:: Publication commands
218 * Project alist:: The central configuration variable
219 * Sources and destinations:: From here to there
220 * Selecting files:: What files are part of the project?
221 * Publishing action:: Setting the function doing the publishing
222 * Publishing options:: Tweaking HTML export
223 * Publishing links:: Which links keep working after publishing?
224 * Project page index:: Publishing a list of project files
228 * Simple example:: One-component publishing
229 * Complex example:: A multi-component publishing example
233 * Completion:: M-TAB knows what you need
234 * Customization:: Adapting Org-mode to your taste
235 * In-buffer settings:: Overview of the #+KEYWORDS
236 * The very busy C-c C-c key:: When in doubt, press C-c C-c
237 * Clean view:: Getting rid of leading stars in the outline
238 * TTY keys:: Using Org-mode on a tty
239 * Interaction:: Other Emacs packages
240 * Bugs:: Things which do not work perfectly
242 Interaction with other packages
244 * Cooperation:: Packages Org-mode cooperates with
245 * Conflicts:: Packages that lead to conflicts
247 Extensions, Hooks and Hacking
249 * Extensions:: Existing 3rd-part extensions
250 * Dynamic blocks:: Automatically filled blocks
253 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
260 * Summary:: Brief summary of what Org-mode does
261 * Installation:: How to install a downloaded version of Org-mode
262 * Activation:: How to activate Org-mode for certain buffers.
263 * Feedback:: Bug reports, ideas, patches etc.
266 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
271 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
272 project planning with a fast and effective plain-text system.
274 Org-mode develops organizational tasks around NOTES files that
275 contain information about projects as plain text. Org-mode is
276 implemented on top of outline-mode, which makes it possible to keep the
277 content of large files well structured. Visibility cycling and
278 structure editing help to work with the tree. Tables are easily
279 created with a built-in table editor. Org-mode supports ToDo items,
280 deadlines, time stamps, and scheduling. It dynamically compiles
281 entries into an agenda that utilizes and smoothly integrates much of
282 the Emacs calendar and diary. Plain text URL-like links connect to
283 websites, emails, Usenet messages, BBDB entries, and any files related
284 to the projects. For printing and sharing of notes, an Org-mode file
285 can be exported as a structured ASCII file, as HTML, or (todo and
286 agenda items only) as an iCalendar file. It can also serve as a
287 publishing tool for a set of linked webpages.
289 Org-mode keeps simple things simple. When first fired up, it should
290 feel like a straightforward, easy to use outliner. Complexity is not
291 imposed, but a large amount of functionality is available when you need
292 it. Org-mode can be used on different levels and in different ways, for
295 * as an outline extension with visibility cycling and structure editing
296 * as an ASCII system and table editor for taking structured notes
297 * as an ASCII table editor with spreadsheet-like capabilities
298 * as a TODO list editor
299 * as a full agenda and planner with deadlines and work scheduling
300 * as a simple hypertext system, with HTML export
301 * as a publishing tool to create a set of interlinked webpages
303 The Org-mode table editor can be integrated into any major mode by
304 activating the minor Orgtbl-mode.
306 There is a website for Org-mode which provides links to the newest
307 version of Org-mode, as well as additional information, frequently asked
308 questions (FAQ), links to tutorials etc. This page is located at
309 `http://www.astro.uva.nl/~dominik/Tools/org/'.
312 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
317 Important: If Org-mode is part of the Emacs distribution or an XEmacs
318 package, please skip this section and go directly to *Note Activation::.
320 If you have downloaded Org-mode from the Web, you must take the
321 following steps to install it: Go into the Org-mode distribution
322 directory and edit the top section of the file `Makefile'. You must
323 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
324 and the paths to the directories where local Lisp and Info files are
325 kept. If you don't have access to the system-wide directories, create
326 your own two directories for these files, enter them into the Makefile,
327 and make sure Emacs finds the Lisp files by adding the following line
330 (setq load-path (cons "~/path/to/lispdir" load-path))
332 XEmacs users now need to install the file `noutline.el' from the
333 `xemacs' subdirectory of the Org-mode distribution. Use the command:
335 make install-noutline
337 Now byte-compile and install the Lisp files with the shell commands:
342 If you want to install the info documentation, use this command:
346 Then add to `.emacs':
348 ;; This line only if org-mode is not part of the X/Emacs distribution.
349 (require 'org-install)
352 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
357 Add the following lines to your `.emacs' file. The last two lines
358 define _global_ keys for the commands `org-store-link' and `org-agenda'
359 - please choose suitable keys yourself.
361 ;; The following lines are always needed. Choose your own keys.
362 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
363 (define-key global-map "\C-cl" 'org-store-link)
364 (define-key global-map "\C-ca" 'org-agenda)
366 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
367 because significant functionality depends on font-locking being active.
368 You can do this with either one of the following two lines (XEmacs
369 user must use the second option):
370 (global-font-lock-mode 1) ; for all buffers
371 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
373 With this setup, all files with extension `.org' will be put into
374 Org-mode. As an alternative, make the first line of a file look like
377 MY PROJECTS -*- mode: org; -*-
379 which will select Org-mode for this buffer no matter what the file's
380 name is. See also the variable `org-insert-mode-line-in-empty-file'.
383 File: org, Node: Feedback, Prev: Activation, Up: Introduction
388 If you find problems with Org-mode, or if you have questions, remarks,
389 or ideas about it, please contact the maintainer Carsten Dominik at
390 <dominik@science.uva.nl>.
392 For bug reports, please provide as much information as possible,
393 including the version information of Emacs (`C-h v emacs-version
394 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
395 Org-mode related setup in `.emacs'. If an error occurs, a traceback
396 can be very useful. Often a small example file helps, along with clear
399 1. What exactly did you do?
401 2. What did you expect to happen?
403 3. What happened instead?
404 Thank you for helping to improve this mode.
407 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
412 Org-mode is based on outline mode and provides flexible commands to
413 edit the structure of the document.
417 * Outlines:: Org-mode is based on outline-mode
418 * Headlines:: How to typeset org-tree headlines
419 * Visibility cycling:: Show and hide, much simplified
420 * Motion:: Jumping to other headlines
421 * Structure editing:: Changing sequence and level of headlines
422 * Archiving:: Move done task trees to a different place
423 * Sparse trees:: Matches embedded in context
424 * Plain lists:: Additional structure within an entry
427 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
432 Org-mode is implemented on top of outline-mode. Outlines allow to
433 organize a document in a hierarchical structure, which (at least for
434 me) is the best representation of notes and thoughts. Overview over
435 this structure is achieved by folding (hiding) large parts of the
436 document to show only the general document structure and the parts
437 currently being worked on. Org-mode greatly simplifies the use of
438 outlines by compressing the entire show/hide functionality into a
439 single command `org-cycle', which is bound to the <TAB> key.
442 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
447 Headlines define the structure of an outline tree. The headlines in
448 Org-mode start with one or more stars, on the left margin. For example:
456 * Another top level headline
458 Some people find the many stars too noisy and would prefer an outline
459 that has whitespace followed by a single star as headline starters.
460 *Note Clean view:: describes a setup to realize this.
463 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
465 2.3 Visibility cycling
466 ======================
468 Outlines make it possible to hide parts of the text in the buffer.
469 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
470 the visibility in the buffer.
473 _Subtree cycling_: Rotate current subtree between the states
475 ,-> FOLDED -> CHILDREN -> SUBTREE --.
476 '-----------------------------------'
478 The cursor must be on a headline for this to work(1). When the
479 cursor is at the beginning of the buffer and the first line is not
480 a headline, then <TAB> actually runs global cycling (see
481 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
482 global cycling is invoked.
486 _Global cycling_: Rotate the entire buffer between the states
488 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
489 '--------------------------------------'
491 Note that inside tables, `S-<TAB>' jumps to the previous field.
496 When Emacs first visits an Org-mode file, the global state is set to
497 OVERVIEW, i.e. only the top level headlines are visible. This can be
498 configured through the variable `org-startup-folded', or on a per-file
499 basis by adding one of the following lines anywhere in the buffer:
505 ---------- Footnotes ----------
507 (1) see, however, the option `org-cycle-emulate-tab'.
509 (2) see the option `org-cycle-global-at-bob'.
512 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
517 The following commands jump to other headlines in the buffer.
526 Next heading same level.
529 Previous heading same level.
532 Backward to higher level heading.
535 Jump to a different place without changing the current outline
536 visibility. Shows the document structure in a temporary buffer,
537 where you can use visibility cycling (<TAB>) to find your
538 destination. After pressing <RET>, the cursor moves to the
539 selected location in the original buffer, and the headings
540 hierarchy above it is made visible.
543 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
545 2.5 Structure editing
546 =====================
549 Insert new heading with same level as current. If the cursor is
550 in a plain list item, a new item is created (*note Plain lists::).
551 To force creation of a new headline, use a prefix arg, or first
552 press <RET> to get to the beginning of the next line. When this
553 command is used in the middle of a line, the line is split and the
554 rest of the line becomes the new headline. If the command is used
555 at the beginning of a headline, the new headline is created before
556 the current line. If at the beginning of any other line, the
557 content of that line is made the new heading.
560 Insert new TODO entry with same level as current heading.
563 Promote current heading by one level.
566 Demote current heading by one level.
569 Promote the current subtree by one level.
572 Demote the current subtree by one level.
575 Move subtree up (swap with previous subtree of same level).
578 Move subtree down (swap with next subtree of same level).
582 Kill subtree, i.e. remove it from buffer but save in kill ring.
585 Copy subtree to kill ring.
588 Yank subtree from kill ring. This does modify the level of the
589 subtree to make sure the tree fits in nicely at the yank position.
590 The yank level can also be specified with a prefix arg, or by
591 yanking after a headline marker like `****'.
593 When there is an active region (transient-mark-mode), promotion and
594 demotion work on all headlines in the region. To select a region of
595 headlines, it is best to place both point and mark at the beginning of a
596 line, mark at the beginning of the first headline, and point at the line
597 just after the last headline to change. Note that when the cursor is
598 inside a table (*note Tables::), the Meta-Cursor keys have different
602 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
607 When a project represented by a (sub)tree is finished, you may want to
608 move the tree out of the way and to stop it from contributing to the
609 agenda. Org-mode knows two ways of archiving. You can mark a tree with
610 the ARCHIVE tag, or you can move an entire (sub)tree to a different
615 * ARCHIVE tag:: Marking a tree as inactive
616 * Moving subtrees:: Moving a tree to an archive file
619 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
621 2.6.1 The ARCHIVE tag
622 ---------------------
624 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
625 its location in the outline tree, but behaves in the following way:
626 - It does not open when you attempt to do so with a visibility
627 cycling command (*note Visibility cycling::). You can force
628 cycling archived subtrees with `C-<TAB>', or by setting the option
629 `org-cycle-open-archived-trees'. Also normal outline commands like
630 `show-all' will open archived subtrees.
632 - During sparse tree construction (*note Sparse trees::), matches in
633 archived subtrees are not exposed, unless you configure the option
634 `org-sparse-tree-open-archived-trees'.
636 - During agenda view construction (*note Agenda views::), the
637 content of archived trees is ignored unless you configure the
638 option `org-agenda-skip-archived-trees'.
640 - Archived trees are not exported (*note Exporting::), only the
641 headline is. Configure the details using the variable
642 `org-export-with-archived-trees'.
644 The following commands help managing the ARCHIVE tag:
647 Toggle the ARCHIVE tag for the current headline. When the tag is
648 set, the headline changes to a shadowish face, and the subtree
652 Check if any direct children of the current headline should be
653 archived. To do this, each subtree is checked for open TODO
654 entries. If none are found, the command offers to set the ARCHIVE
655 tag for the child. If the cursor is _not_ on a headline when this
656 command is invoked, the level 1 trees will be checked.
659 Cycle a tree even if it is tagged with ARCHIVE.
662 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
664 2.6.2 Moving subtrees
665 ---------------------
667 Once an entire project is finished, you may want to move it to a
668 different location, either in the current file, or even in a different
669 file, the archive file.
672 Archive the subtree starting at the cursor position to the location
673 given by `org-archive-location'.
676 Check if any direct children of the current headline could be
677 moved to the archive. To do this, each subtree is checked for
678 open TODO entries. If none are found, the command offers to move
679 it to the archive location. If the cursor is _not_ on a headline
680 when this command is invoked, the level 1 trees will be checked.
682 The default archive location is a file in the same directory as the
683 current file, with the name derived by appending `_archive' to the
684 current file name. For information and examples on how to change this,
685 see the documentation string of the variable `org-archive-location'.
688 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
693 An important feature of Org-mode is the ability to construct _sparse
694 trees_ for selected information in an outline tree. A sparse tree
695 means that the entire document is folded as much as possible, but the
696 selected information is made visible along with the headline structure
697 above it(1). Just try it out and you will see immediately how it works.
699 Org-mode contains several commands creating such trees. The most
700 basic one is `org-occur':
703 Occur. Prompts for a regexp and shows a sparse tree with all
704 matches. If the match is in a headline, the headline is made
705 visible. If the match is in the body of an entry, headline and
706 body are made visible. In order to provide minimal context, also
707 the full hierarchy of headlines above the match is shown, as well
708 as the headline following the match. Each match is also
709 highlighted; the highlights disappear when the bufer is changes an
710 editing command, or by pressing `C-c C-c'. When called with a
711 `C-u' prefix argument, previous highlights are kept, so several
712 calls to this command can be stacked.
713 For frequently used sparse trees of specific search strings, you can
714 use the variable `org-agenda-custom-commands' to define fast keyboard
715 access to specific sparse trees. These commands will then be
716 accessible through the agenda dispatcher (*note Agenda dispatcher::).
719 (setq org-agenda-custom-commands
720 '(("f" occur-tree "FIXME")))
722 will define the key `C-c a f' as a shortcut for creating a sparse tree
723 matching the string `FIXME'.
725 Other commands use sparse trees as well. For example `C-c C-v'
726 creates a sparse TODO tree (*note TODO basics::).
728 To print a sparse tree, you can use the Emacs command
729 `ps-print-buffer-with-faces' which does not print invisible parts of
730 the document (2). Or you can use the command `C-c C-e v' to export
731 only the visible part of the document and print the resulting file.
733 ---------- Footnotes ----------
735 (1) See also the variables `org-show-hierarchy-above' and
736 `org-show-following-heading'.
738 (2) This does not work under XEmacs, because XEmacs uses selective
739 display for outlining, not text properties.
742 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
747 Within an entry of the outline tree, hand-formatted lists can provide
748 additional structure. They also provide a way to create lists of
749 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
750 and the HTML exporter (*note Exporting::) does parse and format them.
752 Org-mode knows ordered and unordered lists. Unordered list items
753 start with `-', `+', or `*'(1) as bullets. Ordered list items start
754 with `1.' or `1)'. Items belonging to the same list must have the same
755 indentation on the first line. In particular, if an ordered list
756 reaches number `10.', then the 2-digit numbers must be written
757 left-aligned with the other numbers in the list. Indentation also
758 determines the end of a list item. It ends before the next line that
759 is indented like the bullet/number, or less. For example:
762 My favorite scenes are (in this order)
763 1. The attack of the Rohirrim
764 2. Eowyns fight with the witch king
765 + this was already my favorite scene in the book
766 + I really like Miranda Otto.
767 3. Peter Jackson being shot by Legolas
769 He makes a really funny face when it happens.
770 But in the end, not individual scenes matter but the film as a whole.
772 Org-mode supports these lists by tuning filling and wrapping
773 commands to deal with them correctly(2).
775 The following commands act on items when the cursor is in the first
776 line of an item (the line with the bullet or number).
779 Items can be folded just like headline levels if you set the
780 variable `org-cycle-include-plain-lists'. The level of an item is
781 then given by the indentation of the bullet/number. Items are
782 always subordinate to real headlines, however; the hierarchies
783 remain completely separated.
786 Insert new item at current level. With prefix arg, force a new
787 heading (*note Structure editing::). If this command is used in
788 the middle of a line, the line is _split_ and the rest of the line
789 becomes the new item. If this command is executed in the
790 _whitespace before a bullet or number_, the new item is created
791 _before_ the current item. If the command is executed in the
792 white space before the text that is part of an item but does not
793 contain the bullet, a bullet is added to the current line.
796 Insert a new item with a checkbox (*note Checkboxes::).
800 Jump to the previous/next item in the current list.
804 Move the item including subitems up/down (swap with previous/next
805 item of same indentation). If the list is ordered, renumbering is
810 Decrease/increase the indentation of the item, including subitems.
811 Initially, the item tree is selected based on current indentation.
812 When these commands are executed several times in direct
813 succession, the initially selected region is used, even if the new
814 indentation would imply a different hierarchy. To use the new
815 hierarchy, break the command chain with a cursor motion or so.
818 If there is a checkbox (*note Checkboxes::) in the item line,
819 toggle the state of the checkbox. Otherwise, if this is an
820 ordered list, renumber the ordered list at the cursor.
822 ---------- Footnotes ----------
824 (1) When using `*' as a bullet, lines must be indented or they will
825 be seen as top-level headlines. Also, when you are hiding leading
826 stars to get a clean outline view, plain list items starting with a
827 star are visually indistinguishable from true headlines. In short:
828 even though `*' is supported, it may be better not to use it for plain
831 (2) Org-mode only changes the filling settings for Emacs. For
832 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn is on,
837 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
842 Org-mode has a very fast and intuitive table editor built-in.
843 Spreadsheet-like calculations are supported in connection with the
844 Emacs `calc' package.
848 * Built-in table editor:: Simple tables
849 * Narrow columns:: Stop wasting space in tables
850 * Table calculations:: Compute a field from other fields
851 * orgtbl-mode:: The table editor as minor mode
852 * table.el:: Complex tables
855 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
857 3.1 The built-in table editor
858 =============================
860 Org-mode makes it easy to format tables in plain ASCII. Any line with
861 `|' as the first non-white character is considered part of a table.
862 `|' is also the column separator. A table might look like this:
864 | Name | Phone | Age |
865 |-------+-------+-----|
866 | Peter | 1234 | 17 |
869 A table is re-aligned automatically each time you press <TAB> or
870 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
871 field (<RET> to the next row) and creates new table rows at the end of
872 the table or before horizontal lines. The indentation of the table is
873 set by the first line. Any line starting with `|-' is considered as a
874 horizontal separator line and will be expanded on the next re-align to
875 span the whole table width. So, to create the above table, you would
881 and then press <TAB> to align the table and start filling in fields.
883 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
884 and all character keys in a special way, so that inserting and deleting
885 avoids shifting other fields. Also, when typing _immediately after the
886 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
887 the field is automatically made blank. If this behavior is too
888 unpredictable for you, configure the variables
889 `org-enable-table-editor' and `org-table-auto-blank-field'.
891 Creation and conversion
892 .......................
895 Convert the active region to table. If every line contains at
896 least one TAB character, the function assumes that the material is
897 tab separated. If not, lines are split at whitespace into fields.
898 You can use a prefix argument to indicate the minimum number of
899 consecutive spaces required to identify a field separator
901 If there is no active region, this command creates an empty
902 Org-mode table. But it's easier just to start typing, like
903 `|Name|Phone|Age <RET> |- <TAB>'.
905 Re-aligning and field motion
906 ............................
909 Re-align the table without moving the cursor.
912 Re-align the table, move to the next field. Creates a new row if
916 Re-align, move to previous field.
919 Re-align the table and move down to next row. Creates a new row if
920 necessary. At the beginning or end of a line, <RET> still does
921 NEWLINE, so it can be used to split a table.
923 Column and row editing
924 ......................
928 Move the current column left/right.
931 Kill the current column.
934 Insert a new column to the left of the cursor position.
938 Move the current row up/down.
941 Kill the current row or horizontal line.
944 Insert a new row above (with arg: below) the current row.
947 Insert a horizontal line below current row. With prefix arg, the
948 line is created above the current line.
951 Sort the table lines in the region. Point and mark must be in the
952 first and last line to be included, and must be in the column that
953 should be used for sorting. The command prompts for numerical
954 versus alphanumerical sorting.
960 Copy a rectangular region from a table to a special clipboard.
961 Point and mark determine edge fields of the rectangle. The
962 process ignores horizontal separator lines.
965 Copy a rectangular region from a table to a special clipboard, and
966 blank all fields in the rectangle. So this is the "cut" operation.
969 Paste a rectangular region into a table. The upper right corner
970 ends up in the current field. All involved fields will be
971 overwritten. If the rectangle does not fit into the present table,
972 the table is enlarged as needed. The process ignores horizontal
976 Wrap several fields in a column like a paragraph. If there is an
977 active region, and both point and mark are in the same column, the
978 text in the column is wrapped to minimum width for the given
979 number of lines. A prefix ARG may be used to change the number of
980 desired lines. If there is no region, the current field is split
981 at the cursor position and the text fragment to the right of the
982 cursor is prepended to the field one line down. If there is no
983 region, but you specify a prefix ARG, the current field is made
984 blank, and the content is appended to the field above.
990 Install a new formula for the current column and replace current
991 field with the result of the formula.
994 Install a new formula for the current field, which must be a named
995 field. Evaluate the formula and replace the field content with the
999 Edit all formulas associated with the current table in a separate
1003 Recalculate the current row by applying the stored formulas from
1004 left to right. When called with a `C-u' prefix, recalculate the
1005 entire table, starting with the first non-header line (i.e. below
1006 the first horizontal separator line). For details, see *Note
1007 Table calculations::.
1010 Rotate the calculation mark in first column through the states `',
1011 `#', `*', `!', `$'. For the meaning of these marks see *Note
1012 Advanced features::. When there is an active region, change all
1013 marks in the region.
1016 Which table column is the cursor in? Displays number >0 in echo
1020 Sum the numbers in the current column, or in the rectangle defined
1021 by the active region. The result is shown in the echo area and can
1022 be inserted with `C-y'.
1025 When current field is empty, copy from first non-empty field above.
1026 When not empty, copy current field down to next row and move cursor
1027 along with it. Depending on the variable
1028 `org-table-copy-increment', integer field values will be
1029 incremented during copy. This key is also used by CUA-mode (*note
1036 Edit the current field in a separate window. This is useful for
1037 fields that are not fully visible (*note Narrow columns::). When
1038 called with a `C-u' prefix, just make the full field visible, so
1039 that it can be edited in place.
1042 This is an alias for `C-u C-c `' to make the current field fully
1045 `M-x org-table-import'
1046 Import a file as a table. The table should be TAB- or whitespace
1047 separated. Useful, for example, to import an Excel table or data
1048 from a database, because these programs generally can write
1049 TAB-separated text files. This command works by inserting the
1050 file into the buffer and then converting the region to a table.
1051 Any prefix argument is passed on to the converter, which uses it
1052 to determine the separator.
1054 `M-x org-table-export'
1055 Export the table as a TAB-separated file. Useful for data
1056 exchange with, for example, Excel or database programs.
1059 If you don't like the automatic table editor because it gets in your
1060 way on lines which you would like to start with `|', you can turn it
1063 (setq org-enable-table-editor nil)
1065 Then the only table command that still works is `C-c C-c' to do a
1069 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
1074 The width of columns is automatically determined by the table editor.
1075 Sometimes a single field or a few fields need to carry more text,
1076 leading to inconveniently wide columns. To limit(1) the width of a
1077 column, one field anywhere in the column may contain just the string
1078 `<N>' where `N' is an integer specifying the width of the column in
1079 characters. The next re-align will then set the width of this column
1080 to no more than this value.
1082 |---+------------------------------| |---+--------|
1084 | 1 | one | | 1 | one |
1085 | 2 | two | ----\ | 2 | two |
1086 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1087 | 4 | four | | 4 | four |
1088 |---+------------------------------| |---+--------|
1090 Fields that are wider become clipped and end in the string `=>'. Note
1091 that the full text is still in the buffer, it is only invisible. To
1092 see the full text, hold the mouse over the field - a tooltip window
1093 will show the full content. To edit such a field, use the command `C-c
1094 `' (that is `C-c' followed by the backquote). This will open a new
1095 window with the full field. Edit it and finish with `C-c C-c'.
1097 When visiting a file containing a table with narrowed columns, the
1098 necessary character hiding has not yet happened, and the table needs to
1099 be aligned before it looks nice. Setting the option
1100 `org-startup-align-all-tables' will realign all tables in a file upon
1101 visiting, but also slow down startup. You can also set this option on
1102 a per-file basis with:
1107 ---------- Footnotes ----------
1109 (1) This feature does not work on XEmacs.
1112 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1114 3.3 Calculations in tables
1115 ==========================
1117 The table editor makes use of the Emacs `calc' package to implement
1118 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1119 derive fields from other fields. Org-mode has two levels of complexity
1120 for table calculations. On the basic level, tables do only horizontal
1121 computations, so a field can be computed from other fields _in the same
1122 row_, and Org-mode assumes that there is only one formula for each
1123 column. This is very efficient to work with and enough for many tasks.
1124 On the complex level, columns and individual fields can be named for
1125 easier referencing in formulas, individual named fields can have their
1126 own formula associated with them, and recalculation can be automated.
1130 * Formula syntax:: How to write a formula
1131 * Lisp formulas:: An alternative way to write formulas
1132 * Column formulas:: Formulas valid for all fields in a column
1133 * Advanced features:: Field names, parameters and automatic recalc
1134 * Named-field formulas:: Formulas valid in single fields
1135 * Editing/debugging formulas:: Changing a stored formula
1136 * Appetizer:: Taste the power of calc
1139 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1141 3.3.1 Formula syntax
1142 --------------------
1144 A formula can be any algebraic expression understood by the Emacs
1145 `calc' package. Note that `calc' has the slightly non-standard
1146 convention that `/' has lower precedence than `*', so that `a/b*c' is
1147 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1148 calc-eval: (calc)Calling Calc from Your Programs.), variable
1149 substitution takes place:
1151 $ refers to the current field
1152 $3 refers to the field in column 3 of the current row
1153 $3..$7 a vector of the fields in columns 3-7 of current row
1154 $P1..$P3 vector of column range, using column names
1155 &2 second data field above the current, in same column
1156 &5-2 vector from fifth to second field above current
1157 &III-II vector of fields between 2nd and 3rd hline above
1158 &III vector of fields between third hline above and current field
1159 $name a named field, parameter or constant
1161 The range vectors can be directly fed into the calc vector functions
1162 like `vmean' and `vsum'.
1164 `$name' is interpreted as the name of a column, parameter or
1165 constant. Constants are defined globally through the variable
1166 `org-table-formula-constants'. If you have the `constants.el' package,
1167 it will also be used to resolve constants, including natural constants
1168 like `$h' for Planck's constant, and units like `$km' for kilometers.
1169 Column names and parameters can be specified in special table lines.
1170 These are described below, see *Note Advanced features::.
1172 A formula can contain an optional mode string after a semicolon.
1173 This string consists of flags to influence calc's modes(1) during
1174 execution, e.g. `p20' to switch the internal precision to 20 digits,
1175 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1176 or fixed display format, respectively, and `D', `R', `F', and `S' to
1177 turn on degrees, radians, fraction and symbolic modes, respectively.
1178 In addition, you may provide a `printf' format specifier to reformat
1179 the final result. A few examples:
1181 $1+$2 Sum of first and second field
1182 $1+$2;%.2f Same, format result to two decimals
1183 exp($2)+exp($1) Math functions can be used
1184 $;%.1f Reformat current cell to 1 decimal
1185 ($3-32)*5/9 Degrees F -> C conversion
1186 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1187 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1188 sin($1);Dp3%.1e Same, but use printf specifier for display
1189 vmean($2..$7) Compute column range mean, using vector function
1190 vsum(&III) Sum numbers from 3rd hline above, up to here
1191 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1193 ---------- Footnotes ----------
1195 (1) By default, Org-mode uses the standard calc modes (precision 12,
1196 angular units degrees, fraction and symbolic modes off). The display
1197 format, however, has been changed to `(float 5)' to keep tables compact.
1198 The default settings can be configured using the variable
1199 `org-calc-default-modes'.
1202 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1204 3.3.2 Emacs Lisp forms as formulas
1205 ----------------------------------
1207 It is also possible to write a formula in Emacs lisp; this can be useful
1208 for string manipulation and control structures. If a formula starts
1209 with a single quote followed by an opening parenthesis, then it is
1210 evaluated as a lisp form. The evaluation should return either a string
1211 or a number. Just as with `calc' formulas, you can provide a format
1212 specifier after a semicolon. A few examples:
1214 swap the first two characters of the content of column 1
1215 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1216 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1220 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1222 3.3.3 Column formulas
1223 ---------------------
1225 To apply a formula to a field, type it directly into the field,
1226 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1227 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1228 be stored as the formula for the current column, evaluated and the
1229 current field replaced with the result. If the field contains only
1230 `=', the previously stored formula for this column is used.
1232 For each column, Org-mode will remember the most recently used
1233 formula. The information is stored in a special line starting with
1234 `#+TBLFM' directly below the table. When adding/deleting/moving
1235 columns with the appropriate commands, the stored equations will be
1236 modified accordingly. When a column used in a calculation is removed,
1237 references to this column become invalid and will cause an error upon
1238 applying the equation.
1240 Instead of typing an equation into the field, you may also use the
1241 command `C-c ='. It prompts for a formula (with default taken from the
1242 `#+TBLFM:' line) and applies it to the current field. A numerical
1243 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1244 in the current column.
1246 To recompute all the fields in a line, use the command `C-c *'. It
1247 re-applies all stored equations to the current row, from left to right.
1248 With a `C-u' prefix, this will be done to every line in the table, so
1249 use this command it you want to make sure the entire table is
1250 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1251 Global updating does not touch the line(s) above the first horizontal
1252 separator line, assuming that this is the table header.
1255 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1257 3.3.4 Advanced features
1258 -----------------------
1260 If you want the recalculation of fields to happen automatically, or if
1261 you want to be able to assign a formula to an individual field (instead
1262 of an entire column) you need to reserve the first column of the table
1263 for special marking characters. Here is an example of a table that
1264 collects exam results of students and makes use of these features:
1266 |---+---------+--------+--------+--------+-------+------|
1267 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1268 |---+---------+--------+--------+--------+-------+------|
1269 | ! | | P1 | P2 | P3 | Tot | |
1270 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1271 | ^ | | m1 | m2 | m3 | mt | |
1272 |---+---------+--------+--------+--------+-------+------|
1273 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1274 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1275 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1276 |---+---------+--------+--------+--------+-------+------|
1277 | | Average | | | | 29.7 | |
1278 | ^ | | | | | at | |
1279 | $ | max=50 | | | | | |
1280 |---+---------+--------+--------+--------+-------+------|
1281 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1283 Important: Please note that for these special tables, recalculating the
1284 table with `C-u C-c *' will only affect rows that are marked `#' or
1285 `*', and named fields. The column formulas are not applied in rows
1286 with empty first field.
1288 The marking characters have the following meaning:
1290 The fields in this line define names for the columns, so that you
1291 may refer to a column as `$Tot' instead of `$6'.
1294 This row defines names for the fields _above_ the row. With such
1295 a definition, any formula in the table may use `$m1' to refer to
1296 the value `10'. Also, named fields can have their own formula
1297 associated with them.
1300 Similar to `^', but defines names for the fields in the row
1304 Fields in this row can define _parameters_ for formulas. For
1305 example, if a field in a `$' row contains `max=50', then formulas
1306 in this table can refer to the value 50 using `$max'. Parameters
1307 work exactly like constants, only that they can be defined on a
1308 per-table basis. Changing a parameter and then recalculating the
1309 table can be useful.
1312 Fields in this row are automatically recalculated when pressing
1313 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1314 selected for a global recalculation with `C-u C-c *'. Unmarked
1315 lines will be left alone by this command.
1318 Selects this line for global recalculation with `C-u C-c *', but
1319 not for automatic recalculation. Use this when automatic
1320 recalculation slows down editing too much.
1323 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1324 All lines that should be recalculated should be marked with `#' or
1328 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1330 3.3.5 Named-field formulas
1331 --------------------------
1333 A named field can have its own formula associated with it. In the
1334 example above, this is used for the `at' field that contains the
1335 average result of the students. To enter a formula for a named field,
1336 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1337 This equation will be stored below the table like `$name=...'. Any
1338 recalculation in the table (even if only requested for the current
1339 line) will also update all named field formulas.
1342 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1344 3.3.6 Editing and debugging formulas
1345 ------------------------------------
1347 To edit a column or field formula, use the commands `C-c =' and `C-u
1348 C-c =', respectively. The currently active expression is then
1349 presented as default in the minibuffer, where it may be edited.
1351 Note that making a table field blank does not remove the formula
1352 associated with the field - during the next recalculation the field
1353 will be filled again. To remove a formula from a field, you have to
1354 give an empty reply when prompted for the formula, or to edit the
1357 You may edit the `#+TBLFM' directly and re-apply the changed
1358 equations with `C-c C-c' in that line, or with the normal recalculation
1359 commands in the table.
1361 In particular for large tables with many formulas, it is convenient
1362 to use the command `C-c '' to edit the formulas of the current table in
1363 a separate buffer. That buffer will show the formulas one per line,
1364 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1365 `$...' expression to get information about its interpretation.
1366 Exiting the buffer with `C-c C-c' only stores the modified formulas
1367 below the table. Exiting with `C-u C-c C-c' also applies them to the
1368 entire table. `C-c C-q' exits without installing the changes.
1370 When the evaluation of a formula leads to an error, the field content
1371 becomes the string `#ERROR'. If you would like see what is going on
1372 during variable substitution and calculation in order to find a bug,
1373 turn on formula debugging in the menu and repeat the calculation, for
1374 example by pressing `C-c = <RET>' in a field. Detailed information
1378 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1383 Finally, just to whet your appetite on what can be done with the
1384 fantastic `calc' package, here is a table that computes the Taylor
1385 series for a couple of functions (homework: try that with Excel :-)
1387 |---+-------------+---+-----+--------------------------------------|
1388 | | Func | n | x | Result |
1389 |---+-------------+---+-----+--------------------------------------|
1390 | # | exp(x) | 1 | x | 1 + x |
1391 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1392 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1393 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1394 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1395 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1396 |---+-------------+---+-----+--------------------------------------|
1397 #+TBLFM: $5=taylor($2,$4,$3);n3
1400 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1402 3.4 The Orgtbl minor mode
1403 =========================
1405 If you like the intuitive way the Org-mode table editor works, you
1406 might also want to use it in other modes like text-mode or mail-mode.
1407 The minor mode Orgtbl-mode makes this possible. You can always toggle
1408 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1411 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1414 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1416 3.5 The `table.el' package
1417 ==========================
1419 Complex ASCII tables with automatic line wrapping, column- and
1420 row-spanning, and alignment can be created using the Emacs table
1421 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1422 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1423 table, Org-mode will call `table-recognize-table' and move the cursor
1424 into the table. Inside a table, the keymap of Org-mode is inactive.
1425 In order to execute Org-mode-related commands, leave the table.
1428 Recognize `table.el' table. Works when the cursor is in a
1432 Insert a table.el table. If there is already a table at point,
1433 this command converts it between the table.el format and the
1434 Org-mode format. See the documentation string of the command
1435 `org-convert-table' for the restrictions under which this is
1439 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1444 Just like HTML, Org-mode provides links inside a file, and external
1445 links to other files, Usenet articles, emails, and much more.
1449 * Link format:: How links in Org-mode are formatted
1450 * Internal links:: Links to other places in the current file
1451 * External links:: URL-like links to the world
1452 * Handling links:: Creating, inserting and following
1453 * Link abbreviations:: Shortcuts for writing complex links
1454 * Search options:: Linking to a specific location
1455 * Custom searches:: When the default search is not enough
1456 * Remember:: Org-trees store quick notes
1459 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1464 Org-mode will recognize plain URL-like links and activate them as
1465 clickable links. The general link format, however, looks like this:
1467 [[link][description]] or alternatively [[link]]
1469 Once a link in the buffer is complete (all brackets present),
1470 Org-mode will change the display so that `description' is displayed
1471 instead of `[[link][description]]' and `link' is displayed instead of
1472 `[[link]]'. Links will be highlighted in the face `org-link', which by
1473 default is an underlined face. You can directly edit the visible part
1474 of a link. Note that this can be either the `link' part (if there is
1475 no description) or the `description' part. To edit also the invisible
1476 `link' part, use `C-c C-l' with the cursor on the link.
1478 If you place the cursor at the beginning or just behind the end of
1479 the displayed text and press <BACKSPACE>, you will remove the
1480 (invisible) bracket at that location. This makes the link incomplete
1481 and the internals are again displayed as plain text. Inserting the
1482 missing bracket hides the link internals again. To show the internal
1483 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1487 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1492 If the link does not look like a URL, it is considered to be internal in
1493 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1494 my target]]' lead to a text search in the current file. The link can
1495 be followed with `C-c C-o' when the cursor is on the link, or with a
1496 mouse click (*note Handling links::). The preferred match for such a
1497 link is a dedicated target: the same string in double angular brackets.
1498 Targets may be located anywhere; often it is convenient to put them
1499 into a comment line. For example
1503 In HTML export (*note HTML export::), such targets will become named
1504 anchors for direct access through `http' links(1).
1506 If no dedicated target exists, Org-mode will search for the words in
1507 the link. In the above example the search would be for `my target'.
1508 Links starting with a star like `*My Target' restrict the search to
1509 headlines. When searching, Org-mode will first try an exact match, but
1510 then move on to more and more lenient searches. For example, the link
1511 `[[*My Targets]]' will find any of the following:
1514 ** TODO my targets are bright
1515 ** my 20 targets are
1517 To insert a link targeting a headline, in-buffer completion can be
1518 used. Just type a star followed by a few optional letters into the
1519 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1520 offered as completions. *Note Handling links::, for more commands
1523 Following a link pushes a mark onto Org-mode's own mark ring. You
1524 can return to the previous position with `C-c &'. Using this command
1525 several times in direct succession goes back to positions recorded
1530 * Radio targets:: Make targets trigger links in plain text.
1531 * CamelCase links:: Activating CamelCase words as links
1533 ---------- Footnotes ----------
1535 (1) Note that text before the first headline will never be exported,
1536 so the first such target must be after the first headline.
1539 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1544 You can configure Org-mode to link any occurrences of certain target
1545 names in normal text. So without explicitly creating a link, the text
1546 connects to the target radioing its position. Radio targets are
1547 enclosed by triple angular brackets. For example, a target `<<<My
1548 Target>>>' causes each occurrence of `my target' in normal text to
1549 become activated as a link. The Org-mode file is scanned automatically
1550 for radio targets only when the file is first loaded into Emacs. To
1551 update the target list during editing, press `C-c C-c' with the cursor
1555 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1557 4.2.2 CamelCase words as links
1558 ------------------------------
1560 Org-mode also supports CamelCase words as links. This feature is not
1561 turned on by default because of the inconsistencies this system suffers
1562 from. It is also possible that this feature will disappear entirely in
1563 a future version of Org-mode. To activate CamelCase words as links, you
1564 need to customize the option `org-activate-links'. A CamelCase word
1565 then leads to a text search such that `CamelCaseLink' is equivalent to
1566 `[[camel case link]]'.
1569 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1574 Org-mode supports links to files, websites, Usenet and email messages,
1575 and BBDB database entries. External links are URL-like locators. They
1576 start with a short identifying string followed by a colon. There can be
1577 no space after the colon. The following list shows examples for each
1580 http://www.astro.uva.nl/~dominik on the web
1581 file:/home/dominik/images/jupiter.jpg file, absolute path
1582 file:papers/last.pdf file, relative path
1583 news:comp.emacs Usenet link
1584 mailto:adent@galaxy.net Mail link
1585 vm:folder VM folder link
1586 vm:folder#id VM message link
1587 vm://myself@some.where.org/folder#id VM on remote machine
1588 wl:folder WANDERLUST folder link
1589 wl:folder#id WANDERLUST message link
1590 mhe:folder MH-E folder link
1591 mhe:folder#id MH-E message link
1592 rmail:folder RMAIL folder link
1593 rmail:folder#id RMAIL message link
1594 gnus:group GNUS group link
1595 gnus:group#id GNUS article link
1596 bbdb:Richard Stallman BBDB link
1597 shell:ls *.org A shell command
1598 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1600 A link should be enclosed in double brackets and may contain a
1601 descriptive text to be displayed instead of the url (*note Link
1602 format::), for example:
1604 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1606 Org-mode also finds external links in the normal text and activates
1607 them as links. If spaces must be part of the link (for example in
1608 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1609 end of the link, enclose them in angular brackets.
1612 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1617 Org-mode provides methods to create a link in the correct syntax, to
1618 insert it into an org-mode file, and to follow the link.
1621 Store a link to the current location. This is a _global_ command
1622 which can be used in any buffer to create a link. The link will be
1623 stored for later insertion into an Org-mode buffer (see below).
1624 For Org-mode files, if there is a `<<target>>' at the cursor, the
1625 link points to the target. Otherwise it points to the current
1626 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1627 the link will indicate the current article/entry. For W3 and W3M
1628 buffers, the link goes to the current URL. For any other files,
1629 the link will point to the file, with a search string (*note
1630 Search options::) pointing to the contents of the current line.
1631 If there is an active region, the selected words will form the
1632 basis of the search string. If the automatically created link is
1633 not working correctly or accurately enough, you can write custom
1634 functions to select the search string and to do the search for
1635 particular file types - see *Note Custom searches::. The key
1636 binding `C-c l' is only a suggestion - see *Note Installation::.
1639 Insert a link. This prompts for a link to be inserted into the
1640 buffer. You can just type a link, using text for an internal
1641 link, or one of the link type prefixes mentioned in the examples
1642 above. Through completion, all links stored during the current
1643 session can be accessed(1). The link will be inserted into the
1644 buffer, along with a descriptive text. Note that you don't have
1645 to use this command to insert a link. Links in Org-mode are plain
1646 text, and you can type or paste them straight into the buffer. By
1647 using this command, the links are automatically enclosed in double
1648 brackets, and you will be asked for the optional descriptive text.
1649 If the link is a `file:' link and the linked file is located in
1650 the same directory as the current file or a subdirectory of it, the
1651 path of the file will be inserted relative to the current
1655 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1656 file will be inserted and you may use file name completion to
1657 select the name of the file. The path to the file is inserted
1658 relative to the directory of the current org file, if the linked
1659 file is in the current directory or in a subdirectory of it, or if
1660 the path is written relative to the current directory using `../'.
1661 Otherwise an absolute path is used, if possible with `~/' for
1662 your home directory. You can force an absolute path with two
1665 `C-c C-l with cursor on existing link'
1666 When the cursor is on an existing link, `C-c C-l' allows you to
1667 edit the link and description parts of the link.
1670 Open link at point. This will launch a web browser for URLs (using
1671 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1672 the corresponding links, and execute the command in a shell link.
1673 When the cursor is on an internal link, this commands runs the
1674 corresponding search. When the cursor is on a TAG list in a
1675 headline, it creates the corresponding TAGS view. If the cursor
1676 is on a time stamp, it compiles the agenda for that date.
1677 Furthermore, it will visit text and remote files in `file:' links
1678 with Emacs and select a suitable application for local non-text
1679 files. Classification of files is based on file extension only.
1680 See option `org-file-apps'. If you want to override the default
1681 application and visit the file with Emacs, use a `C-u' prefix.
1685 On links, `mouse-2' will open the link just as `C-c C-o' would.
1686 Under Emacs 22, also `mouse-1' will follow a link.
1689 Like `mouse-2', but force file links to be opened with Emacs, and
1690 internal links to be displayed in another window(2).
1693 Push the current position onto the mark ring, to be able to return
1694 easily. Commands following an internal link do this automatically.
1697 Jump back to a recorded position. A position is recorded by the
1698 commands following internal links, and by `C-c %'. Using this
1699 command several times in direct succession moves through a ring of
1700 previously recorded positions.
1702 ---------- Footnotes ----------
1704 (1) After insertion of a stored link, the link will be removed from
1705 the list of stored links. To keep it in the list later use, use a
1706 triple `C-u' prefix to `C-c C-l', or configure the option
1707 `org-keep-stored-link-after-insertion'.
1709 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1712 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1714 4.5 Link abbreviatons
1715 =====================
1717 Long URLs can be cumbersome to type, and often many similar links are
1718 needed in a document. For this you can use link abbreviations. An
1719 abbreviated link looks like this
1721 [[linkword::tag][description]]
1723 where the tag is optional. Such abbreviations are resolved according to
1724 the information in the variable `org-link-abbrev-alist' that relates
1725 the linkwords to replacement text. Here is an example:
1727 (setq org-link-abbrev-alist
1728 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1729 ("google" . "http://www.google.com/search?q=")
1730 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
1731 nph-abs_connect?author=%s&db_key=AST")))
1733 If the replacement text contains the string `%s', it will be
1734 replaced with the tag. Otherwise the tag will be appended to the string
1735 in order to create the link. You may also specify a function that will
1736 be called with the tag as the only argument to create the link.
1738 With the above setting, you could link to a specific bug with
1739 `[[bugzilla::129]]', search the web for OrgMode with
1740 `[[google::OrgMode]]' and find out what the Org-mode author is doing
1741 besides Emacs hacking with `[[ads::Dominik,C]]'.
1743 If you need special abbreviations just for a single Org-mode buffer,
1744 you can define them in the file with
1746 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
1747 #+LINK: google http://www.google.com/search?q=%s
1749 In-buffer completion *note Completion:: can be used after `[' to
1750 complete link abbreviations.
1753 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
1755 4.6 Search options in file links
1756 ================================
1758 File links can contain additional information to make Emacs jump to a
1759 particular location in the file when following a link. This can be a
1760 line number or a search option after a double(1) colon. For example,
1761 when the command `C-c l' creates a link (*note Handling links::) to a
1762 file, it encodes the words in the current line as a search string that
1763 can be used to find this line back later when following the link with
1766 Here is the syntax of the different ways to attach a search to a file
1767 link, together with an explanation:
1769 [[file:~/code/main.c::255]]
1770 [[file:~/xx.org::My Target]]
1771 [[file:~/xx.org::*My Target]]
1772 [[file:~/xx.org::/regexp/]]
1778 Search for a link target `<<My Target>>', or do a text search for
1779 `my target', similar to the search in internal links, see *Note
1780 Internal links::. In HTML export (*note HTML export::), such a
1781 file link will become an HTML reference to the corresponding named
1782 anchor in the linked file.
1785 In an Org-mode file, restrict search to headlines.
1788 Do a regular expression search for `regexp'. This uses the Emacs
1789 command `occur' to list all matches in a separate window. If the
1790 target file is in Org-mode, `org-occur' is used to create a sparse
1791 tree with the matches.
1793 As a degenerate case, a file link with an empty file name can be used
1794 to search the current file. For example, `<file:::find me>' does a
1795 search for `find me' in the current file, just as `[[find me]]' would.
1797 ---------- Footnotes ----------
1799 (1) For backward compatibility, line numbers can also follow a
1803 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1808 The default mechanism for creating search strings and for doing the
1809 actual search related to a file link may not work correctly in all
1810 cases. For example, BibTeX database files have many entries like
1811 `year="1993"' which would not result in good search strings, because
1812 the only unique identification for a BibTeX entry is the citation key.
1814 If you come across such a problem, you can write custom functions to
1815 set the right search string for a particular file type, and to do the
1816 search for the string in the file. Using `add-hook', these functions
1817 need to be added to the hook variables
1818 `org-create-file-search-functions' and
1819 `org-execute-file-search-functions'. See the docstring for these
1820 variables for more information. Org-mode actually uses this mechanism
1821 for BibTeX database files, and you can use the corresponding code as an
1822 implementation example. Search for `BibTeX links' in the source file.
1825 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1830 Another way to create org entries with links to other files is through
1831 the _Remember_ package by John Wiegley. _Remember_ lets you store
1832 quick notes with little interruption of your work flow. See
1833 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1834 information. The notes produced by _Remember_ can be stored in
1835 different ways, and Org-mode files are a good target. Org-mode allows
1836 you to file away notes either to a default file, or directly to the
1837 correct location in your Org-mode outline tree. The following
1838 customization will tell _Remember_ to use org files as target, and to
1839 create annotations compatible with Org-mode links.
1841 (setq org-directory "~/path/to/my/orgfiles/")
1842 (setq org-default-notes-file "~/.notes")
1843 (setq remember-annotation-functions '(org-remember-annotation))
1844 (setq remember-handler-functions '(org-remember-handler))
1845 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1847 In combination with Org-mode, you can use templates to generate
1848 different types of remember notes. For example, if you would like to
1849 use one template to create general TODO entries, and another one for
1850 journal entries, you could use:
1852 (setq org-remember-templates
1853 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1854 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1856 In these entries, the character specifies how to select the template,
1857 the first string specifies the template, and the (optional) second
1858 string specifies a default file (overruling `org-default-notes-file')
1859 as a target for this note.
1861 When you call `M-x remember' to remember something, org will prompt
1862 for a key to select the template and then prepare the buffer like
1864 <file:link to where you called remember>
1868 * [2006-03-21 Tue 15:37]
1870 <file:link to where you called remember>
1872 See the variable `org-remember-templates' for more details.
1874 When you are finished composing a note with remember, you have to
1875 press `C-c C-c' to file the note away. The handler first prompts for a
1876 target file - if you press <RET>, the value of `org-default-notes-file'
1877 is used. Then the command offers the headings tree of the selected
1878 file. You can either immediately press <RET> to get the note appended
1879 to the file. Or you can use vertical cursor motion (<up> and <down>)
1880 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1881 or <left> or <right> leads to the following result.
1883 Cursor Key Note gets inserted
1885 buffer-start <RET> as level 2 heading at end of file
1886 on headline <RET> as sublevel of the heading at cursor
1887 <left> as same level, before current heading
1888 <right> as same level, after current heading
1889 not on <RET> at cursor position, level taken from context.
1890 headline Or use prefix arg to specify level
1893 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1894 append it to the default file. Even shorter would be `C-u C-c C-c',
1895 which does the same without even showing the tree. But with little
1896 extra effort, you can push it directly to the correct location.
1898 Before inserting the text into a tree, the function ensures that the
1899 text has a headline, i.e. a first line that starts with a `*'. If not,
1900 a headline is constructed from the current date and some additional
1901 data. If the variable `org-adapt-indentation' is non-nil, the entire
1902 text is also indented so that it starts in the same column as the
1903 headline (after the asterisks).
1906 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1911 Org-mode does not maintain TODO lists as a separate document. TODO
1912 items are an integral part of the notes file, because TODO items
1913 usually come up while taking notes! With Org-mode, you simply mark any
1914 entry in a tree as being a TODO item. In this way, the information is
1915 not duplicated, and the entire context from which the item emerged is
1916 always present when you check.
1918 Of course, this technique causes TODO items to be scattered
1919 throughout your file. Org-mode provides methods to give you an
1920 overview over all things you have to do.
1924 * TODO basics:: Marking and displaying TODO entries
1925 * TODO extensions:: Workflow and assignments
1926 * Priorities:: Some things are more important than others
1927 * Breaking down tasks:: Splitting a task into managable pieces
1928 * Checkboxes:: Tick-off lists
1931 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
1933 5.1 Basic TODO functionality
1934 ============================
1936 Any headline can become a TODO item by starting it with the word TODO,
1939 *** TODO Write letter to Sam Fortune
1941 The most important commands to work with TODO entries are:
1944 Rotate the TODO state of the current item between
1946 ,-> (unmarked) -> TODO -> DONE --.
1947 '--------------------------------'
1949 The same rotation can also be done "remotely" from the timeline and
1950 agenda buffers with the `t' command key (*note Agenda commands::).
1954 Select the following/preceding TODO state, similar to cycling.
1955 Mostly useful if more than two TODO states are possible (*note
1959 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1960 the entire buffer, but shows all TODO items and the headings
1961 hierarchy above them. With prefix arg, show also the DONE
1962 entries. With numerical prefix N, show the tree for the Nth
1963 keyword in the variable `org-todo-keywords'.
1966 Show the global TODO list. This collects the TODO items from all
1967 agenda files (*note Agenda views::) into a single buffer. The
1968 buffer is in `agenda-mode', so there are commands to examine and
1969 manipulate the TODO entries directly from that buffer (*note
1970 Agenda commands::). *Note Global TODO list::, for more
1974 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
1976 5.2 Extended use of TODO keywords
1977 =================================
1979 The default implementation of TODO entries is just two states: TODO and
1980 DONE. You can, however, use the TODO feature for more complicated
1981 things by configuring the variables `org-todo-keywords' and
1982 `org-todo-interpretation'. Using special setup, you can even use TODO
1983 keywords in different ways in different org files.
1985 Note that tags are another way to classify headlines in general and
1986 TODO items in particular (*note Tags::).
1990 * Workflow states:: From TODO to DONE in steps
1991 * TODO types:: I do this, Fred the rest
1992 * Per file keywords:: Different files, different requirements
1995 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1997 5.2.1 TODO keywords as workflow states
1998 --------------------------------------
2000 You can use TODO keywords to indicate different states in the process
2001 of working on an item, for example:
2003 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2004 org-todo-interpretation 'sequence)
2006 Changing these variables only becomes effective in a new Emacs
2007 session. With this setup, the command `C-c C-t' will cycle an entry
2008 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
2009 also use a prefix argument to quickly select a specific state. For
2010 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
2011 you define many keywords, you can use in-buffer completion (see *Note
2012 Completion::) to insert these words into the buffer.
2015 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
2017 5.2.2 TODO keywords as types
2018 ----------------------------
2020 The second possibility is to use TODO keywords to indicate different
2021 types of action items. For example, you might want to indicate that
2022 items are for "work" or "home". If you are into David Allen's _Getting
2023 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2024 `MAYBE'. Or, when you work with several people on a single project,
2025 you might want to assign action items directly to persons, by using
2026 their names as TODO keywords. This would be set up like this:
2028 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2029 org-todo-interpretation 'type)
2031 In this case, different keywords do not indicate a sequence, but
2032 rather different types. So it is normally not useful to change from
2033 one type to another. Therefore, in this case the behavior of the
2034 command `C-c C-t' is changed slightly(1). When used several times in
2035 succession, it will still cycle through all names. But when you return
2036 to the item after some time and execute `C-c C-t' again, it will switch
2037 from each name directly to DONE. Use prefix arguments or completion to
2038 quickly select a specific name. You can also review the items of a
2039 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2040 C-v'. For example, to see all things Lucy has to do, you would use
2041 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2042 single buffer, you would use the prefix arg as well when creating the
2043 global todo list: `C-3 C-c t'.
2045 ---------- Footnotes ----------
2047 (1) This is also true for the `t' command in the timeline and agenda
2051 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2053 5.2.3 Setting up TODO keywords for individual files
2054 ---------------------------------------------------
2056 It can be very useful to use different aspects of the TODO mechanism in
2057 different files, which is not possible with the global settings
2058 described above. For file-local settings, you need to add special
2059 lines to the file which set the keywords and interpretation for that
2060 file only. For example, to set one of the two examples discussed
2061 above, you need one of the following lines, starting in column zero
2062 anywhere in the file:
2064 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2065 #+TYP_TODO: Fred Sara Lucy Mike DONE
2067 To make sure you are using the correct keyword, type `#+' into the
2068 buffer and then use `M-<TAB>' completion.
2070 Remember that the last keyword must always mean that the item is DONE
2071 (although you may use a different word). Also note that in each file,
2072 only one of the two aspects of TODO keywords can be used. After
2073 changing one of these lines, use `C-c C-c' with the cursor still in the
2074 line to make the changes known to Org-mode(1).
2076 If you want to use very many keywords, for example when working with
2077 a large group of people, you may split the names over several lines:
2079 #+TYP_TODO: Fred Sara Lucy Mike
2080 #+TYP_TODO: Luis George Jules Jessica
2081 #+TYP_TODO: Kim Arnold Peter
2084 ---------- Footnotes ----------
2086 (1) Org-mode parses these lines only when Org-mode is activated
2087 after visiting a file. `C-c C-c' with the cursor in a line starting
2088 with `#+' is simply restarting Org-mode for the current buffer.
2091 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2096 If you use Org-mode extensively to organize your work, you may end up
2097 with a number of TODO entries so large that you'd like to prioritize
2098 them. This can be done by placing a _priority cookie_ into the
2101 *** TODO [#A] Write letter to Sam Fortune
2103 With its standard setup, Org-mode supports priorities `A', `B', and
2104 `C'. `A' is the highest priority. An entry without a cookie is
2105 treated as priority `B'. Priorities make a difference only in the
2106 agenda (*note Weekly/Daily agenda::).
2109 Set the priority of the current headline. The command prompts for
2110 a priority character `A', `B' or `C'. When you press <SPC>
2111 instead, the priority cookie is removed from the headline. The
2112 priorities can also be changed "remotely" from the timeline and
2113 agenda buffer with the `,' command (*note Agenda commands::).
2117 Increase/decrease priority of current headline. Note that these
2118 keys are also used to modify time stamps (*note Creating
2119 timestamps::). Furthermore, these keys are also used by CUA-mode
2120 (*note Conflicts::).
2123 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2125 5.4 Breaking tasks down into subtasks
2126 =====================================
2128 It is often advisable to break down large tasks into smaller, managable
2129 subtasks. You can do this by creating an outline tree below a TODO
2130 item, with detailed subtasks on the tree(1). Another possibility is
2131 the use of checkboxes to ideantify (a hierarchy of) a large number of
2132 subtasks (*note Checkboxes::).
2134 ---------- Footnotes ----------
2136 (1) To keep subtasks out of the global TODO list, see the
2137 `org-agenda-todo-list-sublevels'.
2140 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2145 Every item in a plain list (*note Plain lists::) can be made a checkbox
2146 by starting it with the string `[ ]'. This feature is similar to TODO
2147 items (*note TODO items::), but more lightweight. Checkboxes are not
2148 included into the global TODO list, so they are often great to split a
2149 task into a number of simple steps. Or you can use them in a shopping
2150 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2151 `org-mouse.el'. Here is an example of a checkbox list.
2153 * TODO Organize party [3/6]
2159 - [ ] think about what music to play
2160 - [X] talk to the neighbors
2162 The `[3/6]' and `[1/3]' in the first and second line are cookies
2163 indicating how many checkboxes are present in this entry, and how many
2164 of them have been checked off. This can give you an idea on how many
2165 checkboxes remain, even without opening a folded entry. The cookies
2166 can be placed into a headline or into (the first line of) a plain list
2167 item. Each cookie covers all checkboxes structurally below that
2168 headline/item. You have to insert the cookie yourself by typing either
2169 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2170 the second case you get information about the percentage of checkboxes
2171 checked (in the above example, this would be `[50%]' and `[33%],
2174 The following commands work with checkboxes:
2177 Toggle checkbox at point.
2180 Toggle checkbox at point.
2181 - If there is an active region, toggle the first checkbox in
2182 the region and set all remaining boxes to the same status as
2183 the first. If you want to toggle all boxes in the region
2184 independently, use a prefix argument.
2186 - If the cursor is in a headline, toggle checkboxes in the
2187 region between this headline and the next (so _not_ the
2190 - If no active region, just toggle the checkbox at point.
2193 Insert a new item with a checkbox. This works only if the cursor
2194 is already in a plain list item (*note Plain lists::).
2197 Update the checkbox statistics in the current outline entry. When
2198 called with a `C-u' prefix, update the entire file. Checkbox
2199 statistic cookies are updated automatically if you toggle
2200 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2201 you delete boxes or add/change them by hand, use this command to
2202 get things back into synch. Or simply toggle any checkbox twice
2206 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2211 Items can be labeled with timestamps to make them useful for project
2216 * Time stamps:: Assigning a time to a tree entry
2217 * Creating timestamps:: Commands which insert timestamps
2218 * Progress logging:: Documenting when what work was done.
2221 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2223 6.1 Time stamps, deadlines and scheduling
2224 =========================================
2226 A time stamp is a specification of a date (possibly with time) in a
2227 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
2228 A time stamp can appear anywhere in the headline or body of an org-tree
2229 entry. Its presence allows entries to be shown on specific dates in
2230 the agenda (*note Weekly/Daily agenda::). We distinguish:
2233 A simple time stamp just assigns a date/time to an item. This is
2234 just like writing down an appointment in a paper agenda, or like
2235 writing down an event in a diary, when you want to take note of
2236 when something happened. In the timeline and agenda displays, the
2237 headline of an entry associated with a plain time stamp will be
2238 shown exactly on that date.
2241 Two time stamps connected by `--' denote a time range. The
2242 headline will be shown on the first and last day of the range, and
2243 on any dates that are displayed and fall in the range. Here is an
2246 ** Meeting in Amsterdam
2247 <2004-08-23 Mon>--<2004-08-26 Thu>
2249 TIME STAMP WITH SCHEDULED KEYWORD
2250 If a time stamp is preceded by the word `SCHEDULED:', it means you
2251 are planning to start working on that task on the given date. So
2252 this is not about recording an event, but about planning your
2253 work. The headline will be listed under the given date. In
2254 addition, a reminder that the scheduled date has passed will be
2255 present in the compilation for _today_, until the entry is marked
2256 DONE. I.e., the task will automatically be forwarded until
2259 *** TODO Call Trillian for a date on New Years Eve.
2260 SCHEDULED: <2004-12-25 Sat>
2262 TIME STAMP WITH DEADLINE KEYWORD
2263 If a time stamp is preceded by the word `DEADLINE:', the task
2264 (most likely a TODO item) is supposed to be finished on that date,
2265 and it will be listed then. In addition, the compilation for
2266 _today_ will carry a warning about the approaching or missed
2267 deadline, starting `org-deadline-warning-days' before the due
2268 date, and continuing until the entry is marked DONE. An example:
2270 *** TODO write article about the Earth for the Guide
2271 The editor in charge is <bbdb:Ford Prefect>
2272 DEADLINE: <2004-02-29 Sun>
2274 TIME STAMP WITH CLOSED KEYWORD
2275 When `org-log-done' is non-nil, Org-mode will automatically insert
2276 a special time stamp each time a TODO entry is marked done (*note
2277 Progress logging::). This time stamp is enclosed in square
2278 brackets instead of angular brackets.
2280 TIME RANGE WITH CLOCK KEYWORD
2281 When using the clock to time the work that is being done on
2282 specific items, time ranges preceded by the CLOCK keyword are
2283 inserted automatically into the file. The time stamps are
2284 enclosed in square brackets instead of angular brackets. *Note
2285 Clocking work time::.
2288 File: org, Node: Creating timestamps, Next: Progress logging, Prev: Time stamps, Up: Timestamps
2290 6.2 Creating timestamps
2291 =======================
2293 For Org-mode to recognize time stamps, they need to be in the specific
2294 format. All commands listed below produce time stamps in the correct
2298 Prompt for a date and insert a corresponding time stamp. When the
2299 cursor is at a previously used time stamp, it is updated to NOW.
2300 When this command is used twice in succession, a time range is
2304 Like `C-c .', but use the alternative format which contains date
2305 and time. The default time can be rounded to multiples of 5
2306 minutes, see the option `org-time-stamp-rounding-minutes'.
2309 Like `C-c .', but insert an inactive time stamp not triggering the
2313 Insert a time stamp corresponding to the cursor date in the
2317 Access the Emacs calendar for the current date. If there is a
2318 timestamp in the current line, goto the corresponding date instead.
2321 Access the agenda for the date given by the time stamp at point
2322 (*note Weekly/Daily agenda::).
2325 Insert `DEADLINE' keyword along with a stamp. The insertion will
2326 happen in the line directly following the headline.
2329 Create a sparse tree with all deadlines that are either past-due,
2330 or which will become due within `org-deadline-warning-days'. With
2331 `C-u' prefix, show all deadlines in the file. With a numeric
2332 prefix, check that many days. For example, `C-1 C-c C-w' shows
2333 all deadlines due tomorrow.
2336 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2337 happen in the line directly following the headline. Any CLOSED
2338 timestamp will be removed.
2342 Change date at cursor by one day. These key bindings conflict with
2343 CUA-mode (*note Conflicts::).
2347 Change the item under the cursor in a timestamp. The cursor can
2348 be on a year, month, day, hour or minute. Note that if the cursor
2349 is not at a time stamp, these same keys modify the priority of an
2350 item. (*note Priorities::). The key bindings also conflict with
2351 CUA-mode (*note Conflicts::).
2354 Evaluate a time range by computing the difference between start and
2355 end. With prefix arg, insert result after the time range (in a
2356 table: into the following column).
2360 * The date/time prompt::
2363 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2365 6.2.1 The date/time prompt
2366 --------------------------
2368 When Org-mode prompts for a date/time, the prompt suggests to enter an
2369 ISO date. But it will in fact accept any string containing some date
2370 and/or time information. You can, for example, use `C-y' to paste a
2371 (possibly multi-line) string copied from an email message. Org-mode
2372 will find whatever information is in there and will replace anything not
2373 specified with the current date and time. For example:
2375 3-2-5 --> 2003-02-05
2376 feb 15 --> currentyear-02-15
2377 sep 12 9 --> 2009-09-12
2378 12:45 --> today 12:45
2379 22 sept 0:34 --> currentyear-09-22 0:34
2380 12 --> currentyear-currentmonth-12
2381 Fri --> nearest Friday (today or later)
2383 The function understands English month and weekday abbreviations. If
2384 you want to use unabbreviated names and/or other languages, configure
2385 the variables `parse-time-months' and `parse-time-weekdays'.
2387 Parallel to the minibuffer prompt, a calendar is popped up(1). You
2388 can control the calendar fully from the minibuffer:
2391 Scroll calendar backwards by one month.
2394 Scroll calendar forwards by one month.
2397 Select date by clicking on it.
2418 Choose date in calendar (only if nothing typed into minibuffer).
2420 ---------- Footnotes ----------
2422 (1) If you don't need/want the calendar, configure the variable
2423 `org-popup-calendar-for-date-prompt'.
2426 File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
2428 6.3 Progress Logging
2429 ====================
2431 Org-mode can automatically record a time stamp when you mark a TODO item
2432 as DONE. You can also measure precisely the time you spent on specific
2433 items in a project by starting and stopping a clock when you start and
2434 stop working on an aspect of a project.
2438 * Closing items:: When was this entry marked DONE?
2439 * Clocking work time:: When exactly did you work on this item?
2442 File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
2447 If you want to keep track of _when_ a certain TODO item was finished,
2448 turn on logging with
2450 (setq org-log-done t)
2452 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2453 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2454 [timestamp]' will be inserted just after the headline. If you turn the
2455 entry back into a TODO item again through further state cycling, that
2456 line will be removed again. In the timeline (*note Timeline::) and in
2457 the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
2458 to display the TODO items closed on each day, giving you an overview of
2459 what has been done on a day. See the variable `org-log-done' for the
2460 possibility to record an additional note together with a timestamp.
2463 File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
2465 6.3.2 Clocking work time
2466 ------------------------
2468 Org-mode allows you to clock the time you spent on specific tasks in a
2469 project. When you start working on an item, you can start the clock.
2470 When you stop working on that task, or when you mark the task done, the
2471 clock is stopped and the corresponding time interval is recorded. It
2472 also computes the total time spent on each subtree of a project.
2475 Start the clock on the current item (clock-in). This inserts the
2476 CLOCK keyword together with a timestamp.
2479 Stop the clock (clock-out). The inserts another timestamp at the
2480 same location where the clock was last started. It also directly
2481 computes the resulting time in inserts it after the time range as
2485 Recompute the time interval after changing one of the time stamps.
2486 This is only necessary if you edit the time stamps directly. If
2487 you change them with `S-<cursor>' keys, the update is automatic.
2490 Changing the TODO state of an item to DONE automatically stops the
2491 clock if it is running in this same item.
2494 Cancel the current clock. This is useful if a clock was started by
2495 mistake, or if you ended up working on something else.
2498 Display time summaries for each subtree in the current buffer.
2499 This puts overlays at the end of each headline, showing the total
2500 time recorded under that heading, including the time of any
2501 subheadings. You can use visibility cycling to study the tree, but
2502 the overlays disappear automatically when the buffer is changed.
2505 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2506 report as an org-mode table into the current file.
2507 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2510 If such a block already exists, its content is replaced by the new
2511 table. The `BEGIN' line can specify options:
2512 :maxlevels Maximum level depth to which times are listed in the table.
2513 :emphasize When `t', emphasize level one and level two items
2514 :block The time block to consider. This block is specified relative
2515 to the current time and may be any of these keywords:
2516 `today', `yesterday', `thisweek', `lastweek',
2517 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2518 :tstart A time string specifying when to start considering times
2519 :tend A time string specifying when to stop considering times
2520 So to get a clock summary for the current day, you could write
2521 #+BEGIN: clocktable :maxlevel 2 :block today
2524 and to use a specific time range you could write(1)
2525 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2526 :tend "<2006-08-10 Thu 12:00>"
2531 Update all dynamic blocks (*note Dynamic blocks::). This is
2532 useful if you have several clocktable blocks in a buffer.
2534 The `l' key may be used in the timeline (*note Timeline::) and in
2535 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2536 worked on or closed during a day.
2538 See the variable `org-log-done' for the possibility to record an
2539 additional note together with a the clock-out time stamp.
2541 ---------- Footnotes ----------
2543 (1) Note that all parameters must be specified in a single line -
2544 the line is broken here only to fit it onto the manual.
2547 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2552 If you wish to implement a system of labels and contexts for
2553 cross-correlating information, an excellent way is to assign tags to
2554 headlines. Org-mode has extensive support for using tags.
2556 Every headline can contain a list of tags, at the end of the
2557 headline. Tags are normal words containing letters, numbers, `_', and
2558 `@'. Tags must be preceded and followed by a single colon; like
2559 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2563 * Tag inheritance:: Tags use the tree structure of the outline
2564 * Setting tags:: How to assign tags to a headline
2565 * Tag searches:: Searching for combinations of tags
2568 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2573 Tags make use of the hierarchical structure of outline trees. If a
2574 heading has a certain tag, all subheadings will inherit the tag as
2575 well. For example, in the list
2577 * Meeting with the French group :WORK:
2578 ** Summary by Frank :BOSS:NOTES:
2579 *** TODO Prepare slides for him :ACTION:
2581 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2582 `:ACTION:'. When executing tag searches and Org-mode finds that a
2583 certain headline matches the search criterion, it will not check any
2584 sublevel headline, assuming that these likely also match, and that the
2585 list of matches can become very long. This may not be what you want,
2586 however, and you can influence inheritance and searching using the
2587 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2590 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2595 Tags can simply be typed into the buffer at the end of a headline.
2596 After a colon, `M-<TAB>' offers completion on tags. There is also a
2597 special command for inserting tags:
2600 Enter new tags for the current headline. Org-mode will either
2601 offer completion or a special single-key interface for setting
2602 tags, see below. After pressing <RET>, the tags will be inserted
2603 and aligned to `org-tags-column'. When called with a `C-u'
2604 prefix, all tags in the current buffer will be aligned to that
2605 column, just to make things look nice. TAGS are automatically
2606 realigned after promotion, demotion, and TODO state changes (*note
2609 Org will support tag insertion based on a _list of tags_. By
2610 default this list is constructed dynamically, containing all tags
2611 currently used in the buffer. You may also globally specify a hard list
2612 of tags with the variable `org-tag-alist'. Finally you can set the
2613 allowed tags for a given file with lines like
2615 #+TAGS: @WORK @HOME @TENNISCLUB
2616 #+TAGS: Laptop Car PC Sailboat
2618 The default support method is minibuffer completion. However,
2619 Org-mode also implements a much better method: _fast tag selection_.
2620 This method allows to select and deselect tags with a single key per
2621 tag. To function efficiently, you should assign unique keys to all
2622 tags. This can be done globally with
2624 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2626 or on a per-file basis with
2628 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2630 You can also group together tags that are mutually exclusive. With
2633 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2635 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2638 Don't forget to press `C-c C-c' with the cursor in one of these lines
2639 to activate any changes.
2641 If at least one tag has a selection key, pressing `C-c C-c' will
2642 automatically present you with a special interface, listing inherited
2643 tags, the tags of the current headline, and a list of all legal tags
2644 with corresponding keys(2). Pressing keys for the tags will add or
2645 remove them from the list of tags in the current line. Selecting a tag
2646 in a group of mutually exclusive tags will turn off any other tags from
2647 that group. <SPC> clears all tags for this line, `RET' accepts the
2648 modified set, and `C-g' aborts without installing changes. This method
2649 lets you assign tags to a headline with very few keys. With the above
2650 setup, you could clear the current tags and set `@HOME', `Laptop' and
2651 `PC' tags with just the following keys: `C-c C-c <SPC> h l p <RET>'.
2652 Switching from `@HOME' to `@WORK' would be done with `C-c C-c w <RET>'.
2654 What if you have globally defined your preferred set of tags using
2655 the variable `org-tag-alist', but would like to use a dynamic tag list
2656 in a specific file? Just add an empty TAGS option line to that file:
2660 ---------- Footnotes ----------
2662 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2663 respectively. Several groups are allowed.
2665 (2) Keys will automatically assigned to tags which have no
2669 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2674 Once a tags system has been set up, it can be used to collect related
2675 information into special lists.
2678 Create a sparse tree with all headlines matching a tags search.
2681 Create a global list of tag matches from all agenda files. *Note
2682 Matching headline tags::.
2685 Create a global list of tag matches from all agenda files, but
2686 check only TODO items and force checking subitems (see variable
2687 `org-tags-match-list-sublevels').
2689 A tags search string can use Boolean operators `&' for AND and `|'
2690 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2691 not implemented. A tag may also be preceded by `-', to select against
2692 it, and `+' is syntactic sugar for positive selection. The AND
2693 operator `&' is optional when `+' or `-' is present. For example,
2694 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2695 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2696 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2697 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2701 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
2706 Due to the way Org-mode works, TODO items, time-stamped items, and
2707 tagged headlines can be scattered throughout a file or even a number of
2708 files. To get an overview over open action items, or over events that
2709 are important for a particular date, this information must be collected,
2710 sorted and displayed in an organized way.
2712 Org-mode can select items based on various criteria, and display them
2713 in a separate buffer. Five different view types are provided:
2715 * an _agenda_ that is like a calendar and shows information for
2718 * a _TODO list_ that covers all unfinished action items,
2720 * a _tags view_ that shows information based on the tags associated
2721 with headlines in the outline tree,
2723 * a _timeline view_ that shows all events in a single Org-mode file,
2726 * _custom views_ that are special tag and keyword searches and
2727 combinations of different views.
2729 The extracted information is displayed in a special _agenda buffer_.
2730 This buffer is read-only, but provides commands to visit the
2731 corresponding locations in the original Org-mode files, and even to
2732 edit these files remotely.
2734 Two variables control how the agenda buffer is displayed and whether
2735 the window configuration is restored when the agenda exits:
2736 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
2740 * Agenda files:: Files being searched for agenda information
2741 * Agenda dispatcher:: Keyboard access to agenda views
2742 * Weekly/Daily agenda:: The calendar page with current tasks
2743 * Global TODO list:: All unfinished action items
2744 * Matching headline tags:: Structured information with fine-tuned search
2745 * Timeline:: Time-sorted view for single file
2746 * Presentation and sorting:: How agenda items are prepared for display
2747 * Agenda commands:: Remote editing of org trees
2748 * Custom agenda views:: Defining special searches and views
2751 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2756 The information to be shown is collected from all _agenda files_, the
2757 files listed in the variable `org-agenda-files'(1). Thus even if you
2758 only work with a single Org-mode file, this file should be put into
2759 that list(2). You can customize `org-agenda-files', but the easiest
2760 way to maintain it is through the following commands
2763 Add current file to the list of agenda files. The file is added to
2764 the front of the list. If it was already in the list, it is moved
2765 to the front. With prefix arg, file is added/moved to the end.
2768 Remove current file from the list of agenda files.
2771 Cycle through agenda file list, visiting one file after the other.
2773 The Org menu contains the current list of files and can be used to
2776 ---------- Footnotes ----------
2778 (1) If the value of that variable is not a list, but a single file
2779 name, then the list of agenda files will be maintained in that external
2782 (2) When using the dispatcher, pressing `1' before selecting a
2783 command will actually limit the command to the current file, and ignore
2784 `org-agenda-files' until the next dispatcher command.
2787 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2789 8.2 The agenda dispatcher
2790 =========================
2792 The views are created through a dispatcher that should be bound to a
2793 global key, for example `C-c a' (*note Installation::). In the
2794 following we will assume that `C-c a' is indeed how the dispatcher is
2795 accessed and list keyboard access to commands accordingly. After
2796 pressing `C-c a', an additional letter is required to execute a
2797 command. The dispatcher offers the following default commands:
2799 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2802 Create a list of all TODO items (*note Global TODO list::).
2805 Create a list of headlines matching a TAGS expression (*note
2806 Matching headline tags::).
2809 Create the timeline view for the current buffer (*note Timeline::).
2812 Restrict an agenda command to the current buffer. After pressing
2813 `1', you still need to press the character selecting the command.
2816 If there is an active region, restrict the following agenda
2817 command to the region. Otherwise, restrict it to the current
2818 subtree. After pressing `0', you still need to press the
2819 character selecting the command.
2821 You can also define custom commands that will be accessible through
2822 the dispatcher, just like the default commands. This includes the
2823 possibility to create extended agenda buffers that contain several
2824 blocks together, for example the weekly agenda, the global TODO list and
2825 a number of special tags matches. *Note Custom agenda views::.
2828 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
2830 8.3 The weekly/daily agenda
2831 ===========================
2833 The purpose of the weekly/daily _agenda_ is to act like a page of a
2834 paper agenda, showing all the tasks for the current week or day.
2837 Compile an agenda for the current week from a list of org files.
2838 The agenda shows the entries for each day. With a `C-u' prefix (or
2839 when the variable `org-agenda-include-all-todo' is `t'), all
2840 unfinished TODO items (including those without a date) are also
2841 listed at the beginning of the buffer, before the first date.
2843 Remote editing from the agenda buffer means, for example, that you
2844 can change the dates of deadlines and appointments from the agenda
2845 buffer. The commands available in the Agenda buffer are listed in
2846 *Note Agenda commands::.
2850 * Calendar/Diary integration:: Integrating Anniversaries and more
2853 File: org, Node: Calendar/Diary integration, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
2855 8.3.1 Calendar/Diary integration
2856 --------------------------------
2858 Emacs contains the calendar and diary by Edward M. Reingold. The
2859 calendar displays a three-month calendar with holidays from different
2860 countries and cultures. The diary allows you to keep track of
2861 anniversaries, lunar phases, sunrise/set, recurrent appointments
2862 (weekly, monthly) and more. In this way, it is quite complementary to
2863 Org-mode. It can be very useful to combine output from Org-mode with
2866 In order to include entries from the Emacs diary into Org-mode's
2867 agenda, you only need to customize the variable
2869 (setq org-agenda-include-diary t)
2871 After that, everything will happen automatically. All diary entries
2872 including holidays, anniversaries etc will be included in the agenda
2873 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2874 the agenda buffer to jump to the diary file in order to edit existing
2875 diary entries. The `i' command to insert new entries for the current
2876 date works in the agenda buffer, as well as the commands `S', `M', and
2877 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2878 to other calendars, respectively. `c' can be used to switch back and
2879 forth between calendar and agenda.
2882 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
2884 8.4 The global TODO list
2885 ========================
2887 The global TODO list contains all unfinished TODO items, formatted and
2888 collected into a single place.
2891 Show the global TODO list. This collects the TODO items from all
2892 agenda files (*note Agenda views::) into a single buffer. The
2893 buffer is in `agenda-mode', so there are commands to examine and
2894 manipulate the TODO entries directly from that buffer (*note
2898 Like the above, but allows selection of a specific TODO keyword.
2899 You can also do this by specifying a prefix argument to `C-c a t'.
2900 With a `C-u' prefix you are prompted for a keyword. With a
2901 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2902 `r' key in the agenda buffer regenerates it, and you can give a
2903 prefix argument to this command to change the selected TODO
2904 keyword, for example `3 r'. If you often need a search for a
2905 specific keyword, define a custom command for it (*note Agenda
2908 Remote editing of TODO items means that you can change the state of a
2909 TODO entry with a single key press. The commands available in the TODO
2910 list are described in *Note Agenda commands::.
2912 Normally the global todo list simply shows all headlines with TODO
2913 keywords. This list can become very long. There are two ways to keep
2915 - Some people view a TODO item that has been _scheduled_ for
2916 execution (*note Time stamps::) as no longer _open_. Configure the
2917 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
2918 items from the global TODO list.
2920 - TODO items may have sublevels to break up the task into subtasks.
2921 In such cases it may be enough to list only the highest level TODO
2922 headline and omit the sublevels from the global list. Configure
2923 the variable `org-agenda-todo-list-sublevels' to get this behavior.
2926 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
2928 8.5 Matching headline tags
2929 ==========================
2931 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2932 you can select headlines based on the tags that apply to them and
2933 collect them into an agenda buffer.
2936 Produce a list of all headlines that match a given set of tags.
2937 The command prompts for a selection criterion, which is a boolean
2938 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2939 `WORK|HOME' (*note Tags::). If you often need a specific search,
2940 define a custom command for it (*note Agenda dispatcher::).
2943 Like `C-c a m', but only select headlines that are also TODO items
2944 and force checking subitems (see variable
2945 `org-tags-match-list-sublevels').
2947 The commands available in the tags list are described in *Note
2951 File: org, Node: Timeline, Next: Presentation and sorting, Prev: Matching headline tags, Up: Agenda views
2953 8.6 Timeline for a single file
2954 ==============================
2956 The timeline summarizes all time-stamped items from a single Org-mode
2957 file in a _time-sorted view_. The main purpose of this command is to
2958 give an overview over events in a project.
2961 Show a time-sorted view of the org file, with all time-stamped
2962 items. When called with a `C-u' prefix, all unfinished TODO
2963 entries (scheduled or not) are also listed under the current date.
2965 The commands available in the timeline buffer are listed in *Note
2969 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Timeline, Up: Agenda views
2971 8.7 Presentation and sorting
2972 ============================
2974 Before displaying items in an agenda view, Org-mode visually prepares
2975 the items and sorts them. Each item occupies a single line. The line
2976 starts with a _prefix_ that contains the _category_ (*note
2977 Categories::) of the item and other important information. You can
2978 customize the prefix using the option `org-agenda-prefix-format'. The
2979 prefix is followed by a cleaned-up version of the outline headline
2980 associated with the item.
2984 * Categories:: Not all tasks are equal
2985 * Time-of-day specifications:: How the agenda knows the time
2986 * Sorting of agenda items:: The order of things
2989 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
2994 The category is a broad label assigned to each agenda item. By default,
2995 the category is simply derived from the file name, but you can also
2996 specify it with a special line in the buffer, like this:
3000 If there are several such lines in a file, each specifies the
3001 category for the text below it (but the first category also applies to
3002 any text before the first CATEGORY line). The display in the agenda
3003 buffer looks best if the category is not longer than 10 characters.
3006 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3008 8.7.2 Time-of-Day Specifications
3009 --------------------------------
3011 Org-mode checks each agenda item for a time-of-day specification. The
3012 time can be part of the time stamp that triggered inclusion into the
3013 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3014 specified with two time stamps, like
3015 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3017 In the headline of the entry itself, a time(range) may also appear as
3018 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3019 Emacs diary (*note Calendar/Diary integration::), time specifications
3020 in diary entries are recognized as well.
3022 For agenda display, Org-mode extracts the time and displays it in a
3023 standard 24 hour format as part of the prefix. The example times in
3024 the previous paragraphs would end up in the agenda like this:
3026 8:30-13:00 Arthur Dent lies in front of the bulldozer
3027 12:45...... Ford Prefect arrives and takes Arthur to the pub
3028 19:00...... The Vogon reads his poem
3029 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3031 If the agenda is in single-day mode, or for the display of today, the
3032 timed entries are embedded in a time grid, like
3034 8:00...... ------------------
3035 8:30-13:00 Arthur Dent lies in front of the bulldozer
3036 10:00...... ------------------
3037 12:00...... ------------------
3038 12:45...... Ford Prefect arrives and takes Arthur to the pub
3039 14:00...... ------------------
3040 16:00...... ------------------
3041 18:00...... ------------------
3042 19:00...... The Vogon reads his poem
3043 20:00...... ------------------
3044 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3046 The time grid can be turned on and off with the variable
3047 `org-agenda-use-time-grid', and can be configured with
3048 `org-agenda-time-grid'.
3051 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3053 8.7.3 Sorting of agenda items
3054 -----------------------------
3056 Before being inserted into a view, the items are sorted. How this is
3057 done depends on the type of view.
3058 * For the daily/weekly agenda, the items for each day are sorted.
3059 The default order is to first collect all items containing an
3060 explicit time-of-day specification. These entries will be shown
3061 at the beginning of the list, as a _schedule_ for the day. After
3062 that, items remain grouped in categories, in the sequence given by
3063 `org-agenda-files'. Within each category, items are sorted by
3064 priority (*note Priorities::), which is composed of the base
3065 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3066 plus additional increments for overdue scheduled or deadline items.
3068 * For the TODO list, items remain in the order of categories, but
3069 within each category, sorting takes place according to priority
3070 (*note Priorities::).
3072 * For tags matches, items are not sorted at all, but just appear in
3073 the sequence in which they are found in the agenda files.
3075 Sorting can be customized using the variable
3076 `org-agenda-sorting-strategy'.
3079 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3081 8.8 Commands in the agenda buffer
3082 =================================
3084 Entries in the agenda buffer are linked back to the org file or diary
3085 file where they originate. You are not allowed to edit the agenda
3086 buffer itself, but commands are provided to show and jump to the
3087 original entry location, and to edit the org-files "remotely" from the
3088 agenda buffer. In this way, all information is stored only once,
3089 removing the risk that your agenda and note files may diverge.
3091 Some commands can be executed with mouse clicks on agenda lines. For
3092 the other commands, the cursor needs to be in the desired line.
3098 Next line (same as <up>).
3101 Previous line (same as <down>).
3108 Display the original location of the item in another window.
3111 Display original location and recenter that window.
3116 Go to the original location of the item in another window. Under
3117 Emacs 22, `mouse-1' will also works for this.
3120 Go to the original location of the item and delete other windows.
3123 Toggle Follow mode. In Follow mode, as you move the cursor through
3124 the agenda buffer, the other window always shows the corresponding
3125 location in the org file. The initial setting for this mode in new
3126 agenda buffers can be set with the variable
3127 `org-agenda-start-with-follow-mode'.
3130 Toggle Logbook mode. In Logbook mode, entries that where marked
3131 DONE while logging was on (variable `org-log-done') are shown in
3132 the agenda, as are entries that have been clocked on that day.
3138 Delete other windows.
3141 Switch to weekly view (7 days displayed together).
3144 Switch to daily view (just one day displayed).
3147 Toggle the inclusion of diary entries. See *Note Calendar/Diary
3151 Toggle the time grid on and off. See also the variables
3152 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3155 Recreate the agenda buffer, for example to reflect the changes
3156 after modification of the time stamps of items with S-<left> and
3157 S-<right>. When the buffer is the global todo list, a prefix
3158 argument is interpreted to create a selective list for a specific
3162 Save all Org-mode buffers in the current Emacs session.
3165 Display the following `org-agenda-ndays' days. For example, if
3166 the display covers a week, switch to the following week. With
3167 prefix arg, go forward that many times `org-agenda-ndays' days.
3170 Display the previous dates.
3182 Change the TODO state of the item, both in the agenda and in the
3186 Show all tags associated with the current item. Because of
3187 inheritance, this may be more than the tags listed in the line
3191 Set tags for the current headline.
3194 Toggle the ARCHIVE tag for the current headline.
3197 Set the priority for the current item. Org-mode prompts for the
3198 priority character. If you reply with <SPC>, the priority cookie
3199 is removed from the entry.
3202 Display weighted priority of current item.
3206 Increase the priority of the current item. The priority is
3207 changed in the original buffer, but the agenda is not resorted.
3208 Use the `r' key for this.
3212 Decrease the priority of the current item.
3218 Set a deadline for this item.
3221 Change the time stamp associated with the current line by one day
3222 into the future. With prefix argument, change it by that many
3223 days. For example, `3 6 5 S-<right>' will change it by a year.
3224 The stamp is changed in the original org file, but the change is
3225 not directly reflected in the agenda buffer. Use the `r' key to
3229 Change the time stamp associated with the current line by one day
3233 Change the time stamp associated with the current line to today.
3234 The key `>' has been chosen, because it is the same as `S-.' on my
3238 Start the clock on the current item. If a clock is running
3239 already, it is stopped first.
3242 Stop the previously started clock.
3245 Cancel the currently running clock.
3251 Open the Emacs calendar and move to the date at the agenda cursor.
3254 When in the calendar, compute and show the Org-mode agenda for the
3258 Insert a new entry into the diary. Prompts for the type of entry
3259 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3260 new entry in the diary, just as `i d' etc. would do in the
3261 calendar. The date is taken from the cursor position.
3264 Show the phases of the moon for the three months around current
3268 Show sunrise and sunset times. The geographical location must be
3269 set with calendar variables, see documentation of the Emacs
3273 Convert the date at cursor into many other cultural and historic
3277 Show holidays for three month around the cursor date.
3280 Export a single iCalendar file containing entries from all agenda
3287 Quit agenda, remove the agenda buffer.
3290 Exit agenda, remove the agenda buffer and all buffers loaded by
3291 Emacs for the compilation of the agenda. Buffers created by the
3292 user to visit org files will not be removed.
3296 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3298 8.9 Custom agenda views
3299 =======================
3301 Custom agenda commands serve two purposes: to store and quickly access
3302 frequently used TODO and tags searches, and to create special composite
3303 agenda buffers. Custom agenda commands will be accessible through the
3304 dispatcher (*note Agenda dispatcher::), just like the default commands.
3308 * Storing searches:: Type once, use often
3309 * Block agenda:: All the stuff you need in a single buffer
3310 * Setting Options:: Changing the rules
3311 * Batch processing:: Agenda views from the command line
3314 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3316 8.9.1 Storing searches
3317 ----------------------
3319 The first application of custom searches is the definition of keyboard
3320 shortcuts for frequently used searches, either creating an agenda
3321 buffer, or a sparse tree (the latter covering of course only the current
3322 buffer). Custom commands are configured in the variable
3323 `org-agenda-custom-commands'. You can customize this variable, for
3324 example by pressing `C-c a C'. You can also directly set it with Emacs
3325 Lisp in `.emacs'. The following example contains all valid search
3328 (setq org-agenda-custom-commands
3329 '(("w" todo "WAITING")
3330 ("W" todo-tree "WAITING")
3331 ("u" tags "+BOSS-URGENT")
3332 ("v" tags-todo "+BOSS-URGENT")
3333 ("U" tags-tree "+BOSS-URGENT")
3334 ("f" occur-tree "\\<FIXME\\>")))
3336 The initial single-character string in each entry defines the character
3337 you have to press after the dispatcher command `C-c a' in order to
3338 access the command. The second parameter is the search type, followed
3339 by the string or regular expression to be used for the matching. The
3340 example above will therefore define:
3343 as a global search for TODO entries with `WAITING' as the TODO
3347 as the same search, but only in the current buffer and displaying
3348 the results as a sparse tree
3351 as a global tags search for headlines marked `:BOSS:' but not
3355 as the same search as `C-c a u', but limiting the search to
3356 headlines that are also TODO items
3359 as the same search as `C-c a u', but only in the current buffer and
3360 displaying the result as a sparse tree
3363 to create a sparse tree (again: current buffer only) with all
3364 entries containing the word `FIXME'.
3367 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3372 Another possibility is the construction of agenda views that comprise
3373 the results of _several_ commands, each of which creates a block in the
3374 agenda buffer. The available commands include `agenda' for the daily
3375 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3376 todo list (as constructed with `C-c a t'), and the matching commands
3377 discussed above: `todo', `tags', and `tags-todo'. Here are two
3380 (setq org-agenda-custom-commands
3381 '(("h" "Agenda and Home-related tasks"
3385 ("o" "Agenda and Office-related tasks"
3390 This will define `C-c a h' to create a multi-block view for stuff you
3391 need to attend to at home. The resulting agenda buffer will contain
3392 your agenda for the current week, all TODO items that carry the tag
3393 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3394 `C-c a o' provides a similar view for office tasks.
3397 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3399 8.9.3 Setting Options for custom commands
3400 -----------------------------------------
3402 Org-mode contains a number of variables regulating agenda construction
3403 and display. The global variables define the behavior for all agenda
3404 commands, including the custom commands. However, if you want to change
3405 some settings just for a single custom view, you can do so. Setting
3406 options requires inserting a list of variable names and values at the
3407 right spot in `org-agenda-custom-commands'. For example:
3409 (setq org-agenda-custom-commands
3410 '(("w" todo "WAITING"
3411 ((org-agenda-sorting-strategy '(priority-down))
3412 (org-agenda-prefix-format " Mixed: ")))
3413 ("U" tags-tree "+BOSS-URGENT"
3414 ((org-show-following-heading nil)
3415 (org-show-hierarchy-above nil)))))
3417 Now the `C-c a w' command will sort the collected entries only by
3418 priority, and the prefix format is modified to just say ` Mixed:'
3419 instead of giving the category of the entry. The sparse tags tree of
3420 `C-c a U' will now turn out ultra-compact, because neither the headline
3421 hierarchy above the match, nor the headline following the match will be
3424 For command sets creating a block agenda,
3425 `org-agenda-custom-commands' has two separate spots for setting
3426 options. You can add options that should be valid for just a single
3427 command in the set, and options that should be valid for all commands in
3428 the set. The former are just added to the command entry, the latter
3429 must come after the list of command entries. Going back to the block
3430 agenda example (*note Block agenda::), let's change the sorting strategy
3431 for the `C-c a h' commands to `priority-down', but let's sort the
3432 results for GARDEN tags query in the opposite order, `priority-up'.
3433 This would look like this:
3435 (setq org-agenda-custom-commands
3436 '(("h" "Agenda and Home-related tasks"
3439 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
3440 ((org-agenda-sorting-strategy '(priority-down))))
3441 ("o" "Agenda and Office-related tasks"
3446 As you see, the values and parenthesis setting is a little complex.
3447 When in doubt, use the customize interface to set this variable - it
3448 fully supports its structure. Just one caveat: When setting options in
3449 this interface, the _values_ are just lisp expressions. So if the
3450 value is a string, you need to add the double quotes around the value
3454 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
3456 8.9.4 Creating agenda views in batch processing
3457 -----------------------------------------------
3459 If you want to print or otherwise reprocess agenda views, it can be
3460 useful to create an agenda from the command line. This is the purpose
3461 of the function `org-batch-agenda'. It takes as a parameter one of the
3462 strings that are the keys in `org-agenda-custom-commands'. For
3463 example, to directly print the current TODO list, you could use
3465 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
3467 You may also modify parameters on the fly like this:
3469 emacs -batch -l ~/.emacs \
3470 -eval '(org-batch-agenda "a" \
3471 org-agenda-ndays 300 \
3472 org-agenda-include-diary nil \
3473 org-agenda-files (quote ("~/org/project.org")))' \
3476 which will produce a 300 day agenda, fully restricted to the Org file
3477 `~/org/projects.org', not even including the diary.
3480 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
3485 Plain ASCII is normally sufficient for almost all note taking. One
3486 exception, however, are scientific notes which need to be able to
3487 contain mathematical symbols and the occasional formula. LaTeX(1) is
3488 widely used to typeset scientific documents. Org-mode supports
3489 embedding LaTeX code into its files, because many academics are used to
3490 read LaTeX source code, and because it can be readily processed into
3491 images for HTML production.
3493 It is not necessary to mark LaTeX macros and code in any special way.
3494 If you observe a few conventions, Org-mode knows how to find it and what
3499 * Math symbols:: TeX macros for symbols and Greek letters
3500 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
3501 * LaTeX fragments:: Complex formulas made easy
3502 * Processing LaTeX fragments:: Previewing LaTeX processing
3503 * CDLaTeX mode:: Speed up entering of formulas
3505 ---------- Footnotes ----------
3507 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3508 Many of the features described here as "LaTeX" are really from TeX, but
3509 for simplicity I am blurring this distinction.
3512 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
3517 You can use LaTeX macros to insert special symbols like `\alpha' to
3518 indicate the Greek letter, or `\to' to indicate an arrow. Completion
3519 for these macros is available, just type `\' and maybe a few letters,
3520 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
3521 Org-mode allows these macros to be present without surrounding math
3522 delimiters, for example:
3524 Angles are written as Greek letters \alpha, \beta and \gamma.
3526 During HTML export (*note HTML export::), these symbols are
3527 translated into the proper syntax for HTML, for the above examples this
3528 is `α' and `→', respectively.
3531 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
3533 9.2 Subscripts and Superscripts
3534 ===============================
3536 Just like in LaTeX, `^' and `_' are used to indicate super- and
3537 subscripts. Again, these can be used without embedding them in
3538 math-mode delimiters. To increase the readability of ASCII text, it is
3539 not necessary (but OK) to surround multi-character sub- and superscripts
3540 with curly braces. For example
3542 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
3543 the sun is R_{sun} = 6.96 x 10^8 m.
3545 To avoid interpretation as raised or lowered text, you can quote `^'
3546 and `_' with a backslash: `\_' and `\^'.
3548 During HTML export (*note HTML export::), subscript and superscripts
3549 are surrounded with `<sub>' and `<sup>' tags, respectively.
3552 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
3557 With symbols, sub- and superscripts, HTML is pretty much at its end when
3558 it comes to representing mathematical formulas(1). More complex
3559 expressions need a dedicated formula processor. To this end, Org-mode
3560 can contain arbitrary LaTeX fragments. It provides commands to preview
3561 the typeset result of these fragments, and upon export to HTML, all
3562 fragments will be converted to images and inlined into the HTML
3563 document. For this to work you need to be on a system with a working
3564 LaTeX installation. You also need the `dvipng' program, available at
3565 `http://sourceforge.net/projects/dvipng/'.
3567 LaTeX fragments don't need any special marking at all. The following
3568 snippets will be identified as LaTeX source code:
3569 * Environments of any kind. The only requirement is that the
3570 `\begin' statement appears on a new line, preceded by only
3573 * Text within the usual LaTeX math delimiters. To avoid conflicts
3574 with currency specifications, single `$' characters are only
3575 recognized as math delimiters if the enclosed text contains at
3576 most two line breaks, is directly attached to the `$' characters
3577 with no whitespace in between, and if the closing `$' is followed
3578 by whitespace or punctuation. For the other delimiters, there is
3579 no such restriction, so when in doubt, use `\(...\)' as inline
3584 \begin{equation} % arbitrary environments,
3585 x=\sqrt{b} % even tables, figures
3586 \end{equation} % etc
3588 If $a^2=b$ and \( b=2 \), then the solution must be
3589 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
3591 If you need any of the delimiter ASCII sequences for other purposes, you
3592 can configure the option `org-format-latex-options' to deselect the
3593 ones you do not wish to have interpreted by the LaTeX converter.
3595 ---------- Footnotes ----------
3597 (1) Yes, there is MathML, but that is not yet fully supported by
3598 many browsers, and there is no decent converter for turning LaTeX of
3599 ASCII representations of formulas into MathML. So for the time being,
3600 converting formulas into images seems the way to go.
3603 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
3605 9.4 Processing LaTeX fragments
3606 ==============================
3608 LaTeX fragments can be processed to produce a preview images of the
3609 typeset expressions:
3612 Produce a preview image of the LaTeX fragment at point and overlay
3613 it over the source code. If there is no fragment at point,
3614 process all fragments in the current entry (between two
3615 headlines). When called with a prefix argument, process the
3616 entire subtree. When called with two prefix arguments, or when
3617 the cursor is before the first headline, process the entire buffer.
3620 Remove the overlay preview images.
3622 During HTML export (*note HTML export::), all LaTeX fragments are
3623 converted into images and inlined into the document if the following
3626 (setq org-export-with-LaTeX-fragments t)
3629 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
3631 9.5 Using CDLaTeX to enter math
3632 ===============================
3634 CDLaTeX-mode is a minor mode that is normally used in combination with a
3635 major LaTeX mode like AUCTeX in order to speed-up insertion of
3636 environments and math templates. Inside Org-mode, you can make use of
3637 some of the features of cdlatex-mode. You need to install `cdlatex.el'
3638 and `texmathp.el' (the latter comes also with AUCTeX) from
3639 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
3640 cdlatex-mode itself under Org-mode, but use the light version
3641 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
3642 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
3645 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
3647 When this mode is enabled, the following features are present (for
3648 more details see the documentation of cdlatex-mode):
3649 * Environment templates can be inserted with `C-c {'.
3651 * The <TAB> key will do template expansion if the cursor is inside a
3652 LaTeX fragment(1). For example, <TAB> will expand `fr' to
3653 `\frac{}{}' and position the cursor correctly inside the first
3654 brace. Another <TAB> will get you into the second brace. Even
3655 outside fragments, <TAB> will expand environment abbreviations at
3656 the beginning of a line. For example, if you write `equ' at the
3657 beginning of a line and press <TAB>, this abbreviation will be
3658 expanded to an `equation' environment. To get a list of all
3659 abbreviations, type `M-x cdlatex-command-help'.
3661 * Pressing `_' and `^' inside a LaTeX fragment will insert these
3662 characters together with a pair of braces. If you use <TAB> to
3663 move out of the braces, and if the braces surround only a single
3664 character or macro, they are removed again (depending on the
3665 variable `cdlatex-simplify-sub-super-scripts').
3667 * Pressing the backquote ``' followed by a character inserts math
3668 macros, also outside LaTeX fragments. If you wait more than 1.5
3669 seconds after the backquote, a help window will pop up.
3671 * Pressing the normal quote `'' followed by another character
3672 modifies the symbol before point with an accent or a font. If you
3673 wait more than 1.5 seconds after the backquote, a help window will
3674 pop up. Character modification will work only inside LaTeX
3675 fragments, outside the quote is normal.
3677 ---------- Footnotes ----------
3679 (1) Org-mode has a method to test if the cursor is inside such a
3680 fragment, see the documentation of the function
3681 `org-inside-LaTeX-fragment-p'.
3684 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
3689 Org-mode documents can be exported into a variety of other formats. For
3690 printing and sharing of notes, ASCII export produces a readable and
3691 simple version of an Org-mode file. HTML export allows you to publish a
3692 notes file on the web, while the XOXO format provides a solid base for
3693 exchange with a broad range of other applications. To incorporate
3694 entries with associated times like deadlines or appointments into a
3695 desktop calendar program like iCal, Org-mode can also produce extracts
3696 in the iCalendar format. Currently Org-mode only supports export, not
3697 import of these different formats.
3699 When exporting, Org-mode uses special conventions to enrich the
3700 output produced. *Note Text interpretation::, for more details.
3703 Dispatcher for export and publishing commands. Displays a
3704 help-window listing the additional key(s) needed to launch an
3705 export or publishing command.
3709 * ASCII export:: Exporting to plain ASCII
3710 * HTML export:: Exporting to HTML
3711 * XOXO export:: Exporting to XOXO
3712 * iCalendar export:: Exporting in iCalendar format
3713 * Text interpretation:: How the exporter looks at the file
3716 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
3721 ASCII export produces a simple and very readable version of an Org-mode
3725 Export as ASCII file. If there is an active region, only the
3726 region will be exported. For an org file `myfile.org', the ASCII
3727 file will be `myfile.txt'. The file will be overwritten without
3731 Export only the visible part of the document.
3733 In the exported version, the first 3 outline levels will become
3734 headlines, defining a general document structure. Additional levels
3735 will be exported as itemized lists. If you want that transition to
3736 occur at a different level, specify it with a prefix argument. For
3741 creates only top level headlines and does the rest as items. When
3742 headlines are converted to items, the indentation of the text following
3743 the headline is changed to fit nicely under the item. This is done with
3744 the assumption that the first bodyline indicates the base indentation of
3745 the body text. Any indentation larger than this is adjusted to preserve
3746 the layout relative to the first line. Should there be lines with less
3747 indentation than the first, these are left alone.
3750 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
3755 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
3756 HTML formatting, in ways similar to John Grubers _markdown_ language,
3757 but with additional support for tables.
3760 Export as HTML file `myfile.html'.
3763 Export as HTML file and open it with a browser.
3768 Export only the visible part of the document.
3770 In the exported version, the first 3 outline levels will become
3771 headlines, defining a general document structure. Additional levels
3772 will be exported as itemized lists. If you want that transition to
3773 occur at a different level, specify it with a prefix argument. For
3778 creates two levels of headings and does the rest as items.
3780 If you want to include HTML tags which should be interpreted as such,
3781 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
3782 always transformed to `<' and `>' in HTML export.
3784 Internal links (*note Internal links::) will continue to work in HTML
3785 files only if they match a dedicated `<<target>>'. Automatic links
3786 created by radio targets (*note Radio targets::) will also work in the
3787 HTML file. Links to external files will still work if the HTML file is
3788 in the same directory as the Org-mode file. Links to other `.org'
3789 files will be translated into HTML links under the assumption that an
3790 HTML version also exists of the linked file. For information related to
3791 linking files while publishing them to a publishing directory see *Note
3794 You can also give style information for the exported file. The HTML
3795 exporter assigns the following CSS classes to appropriate parts of the
3796 document - your style specifications may change these:
3798 .done the DONE keyword
3799 .timestamp time stamp
3800 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
3801 .tag tag in a headline
3802 .target target for links
3804 The default style specification can be configured through the option
3805 `org-export-html-style'. If you want to use a file-local style, you
3806 may use file variables, best wrapped into a COMMENT section at the end
3807 of the outline tree. For example:
3809 * COMMENT HTML style specifications
3812 # org-export-html-style: " <style type=\"text/css\">
3813 # p {font-weight: normal; color: gray; }
3814 # h1 {color: black; }
3818 Remember to execute `M-x normal-mode' after changing this to make
3819 the new style visible to Emacs. This command restarts org-mode for the
3820 current buffer and forces Emacs to re-evaluate the local variables
3821 section in the buffer.
3824 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
3829 Org-mode contains an exporter that produces XOXO-style output.
3830 Currently, this exporter only handles the general outline structure and
3831 does not interpret any additional Org-mode features.
3834 Export as XOXO file `myfile.html'.
3837 Export only the visible part of the document.
3840 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
3842 10.4 iCalendar export
3843 =====================
3845 Some people like to use Org-mode for keeping track of projects, but
3846 still prefer a standard calendar application for anniversaries and
3847 appointments. In this case it can be useful to have deadlines and
3848 other time-stamped items in Org-mode files show up in the calendar
3849 application. Org-mode can export calendar information in the standard
3853 Create iCalendar entries for the current file and store them in
3854 the same directory, using a file extension `.ics'.
3857 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
3858 For each of these files, a separate iCalendar file will be
3862 Create a single large iCalendar file from all files in
3863 `org-agenda-files' and write it to the file given by
3864 `org-combined-agenda-icalendar-file'.
3866 How this calendar is best read and updated, depends on the
3867 application you are using. For example, when using iCal under Apple
3868 MacOS X, you could create a new calendar `OrgMode' (the default name
3869 for the calendar created by `C-c C-e c', see the variables
3870 `org-icalendar-combined-name' and
3871 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
3872 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
3873 use AppleScript to make iCal re-read the calendar files each time a new
3874 version of `OrgMode.ics' is produced. Here is the setup needed for
3877 (setq org-combined-agenda-icalendar-file
3878 "~/Library/Calendars/OrgMode.ics")
3879 (add-hook 'org-after-save-iCalendar-file-hook
3882 "osascript -e 'tell application \"iCal\" to reload calendars'")))
3885 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
3887 10.5 Text interpretation by the exporter
3888 ========================================
3890 The exporter backends interpret additional structure in the Org-mode
3891 file in order to produce better output.
3895 * Comment lines:: Some lines will not be exported
3896 * Enhancing text:: Subscripts, symbols and more
3897 * Export options:: How to influence the export settings
3900 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
3902 10.5.1 Comment lines
3903 --------------------
3905 Lines starting with `#' in column zero are treated as comments and will
3906 never be exported. Also entire subtrees starting with the word
3907 `COMMENT' will never be exported. Finally, any text before the first
3908 headline will not be exported either.
3911 Toggle the COMMENT keyword at the beginning of an entry.
3914 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
3916 10.5.2 Enhancing text for export
3917 --------------------------------
3919 Some of the export backends of Org-mode allow for sophisticated text
3920 formatting, this is true in particular for the HTML backend. Org-mode
3921 has a number of typing conventions that allow to produce a richly
3924 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
3925 enumerator will be recognized and transformed if the backend
3926 supports lists. See *Note Plain lists::.
3928 * You can make words *bold*, /italic/, _underlined_, `=code=', and
3931 * Many TeX macros and entire LaTeX fragments are converted into HTML
3932 entities or images (*note Embedded LaTeX::).
3934 * Tables are transformed into native tables under the exporter, if
3935 the export backend supports this. Data fields before the first
3936 horizontal separator line will be formatted as table header fields.
3938 * If a headline starts with the word `QUOTE', the text below the
3939 headline will be typeset as fixed-width, to allow quoting of
3940 computer codes etc. Lines starting with `:' are also typeset in
3943 Toggle fixed-width for entry (QUOTE) or region, see below.
3945 * A double backslash _at the end of a line_ enforces a line break at
3948 If these conversions conflict with your habits of typing ASCII text,
3949 they can all be turned off with corresponding variables (see the
3950 customization group `org-export-general', and the following section
3951 which explains how to set export options with special lines in a buffer.
3954 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
3956 10.5.3 Export options
3957 ---------------------
3959 The exporter recognizes special lines in the buffer which provide
3960 additional information. These lines may be put anywhere in the file.
3961 The whole set of lines can be inserted into the buffer with `C-c C-e
3962 t'. For individual lines, a good way to make sure the keyword is
3963 correct is to type `#+' and then use `M-<TAB>' completion (*note
3967 Insert template with export options, see example below.
3969 #+TITLE: the title to be shown (default is the buffer name)
3970 #+AUTHOR: the author (default taken from `user-full-name')
3971 #+EMAIL: his/her email address (default from `user-mail-address')
3972 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
3973 #+TEXT: Some descriptive text to be inserted at the beginning.
3974 #+TEXT: Several lines may be given.
3975 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
3977 The OPTIONS line is a compact form to specify export settings. Here
3979 H: set the number of headline levels for export
3980 num: turn on/off section-numbers
3981 toc: turn on/off table of contents
3982 \n: turn on/off linebreak-preservation
3983 @: turn on/off quoted HTML tags
3984 :: turn on/off fixed-width sections
3985 |: turn on/off tables
3986 ^: turn on/off TeX-like syntax for sub- and superscripts.
3987 *: turn on/off emphasized text (bold, italic, underlined)
3988 TeX: turn on/off simple TeX macros in plain text
3989 LaTeX: turn on/off LaTeX fragments
3992 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
3997 Org-mode includes(1) a publishing management system that allows you to
3998 configure automatic HTML conversion of _projects_ composed of
3999 interlinked org files. This system is called _org-publish_. You can
4000 also configure org-publish to automatically upload your exported HTML
4001 pages and related attachments, such as images and source code files, to
4002 a web server. Org-publish turns org-mode into a web-site authoring
4005 Org-publish has been contributed to Org-mode by David O'Toole.
4009 * Configuration:: Defining projects
4010 * Sample configuration:: Example projects
4011 * Triggering publication:: Publication commands
4013 ---------- Footnotes ----------
4015 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4016 `org.el' as it comes with Emacs, you need to download this file
4017 separately. Also make sure org.el is at least version 4.27.
4020 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4025 Publishing needs significant configuration to specify files, destination
4026 and many other properties of a project.
4030 * Project alist:: The central configuration variable
4031 * Sources and destinations:: From here to there
4032 * Selecting files:: What files are part of the project?
4033 * Publishing action:: Setting the function doing the publishing
4034 * Publishing options:: Tweaking HTML export
4035 * Publishing links:: Which links keep working after publishing?
4036 * Project page index:: Publishing a list of project files
4039 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4041 11.1.1 The variable `org-publish-project-alist'
4042 -----------------------------------------------
4044 Org-publish is configured almost entirely through setting the value of
4045 one variable, called `org-publish-project-alist'. Each element of the
4046 list configures one project, and may be in one of the two following
4049 ("project-name" :property value :property value ...)
4053 ("project-name" :components ("project-name" "project-name" ...))
4055 In both cases, projects are configured by specifying property values.
4056 A project defines the set of files that will be published, as well as
4057 the publishing configuration to use when publishing those files. When
4058 a project takes the second form listed above, the individual members of
4059 the "components" property are taken to be components of the project,
4060 which group together files requiring different publishing options. When
4061 you publish such a "meta-project" all the components will also publish.
4064 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4066 11.1.2 Sources and destinations for files
4067 -----------------------------------------
4069 Most properties are optional, but some should always be set. In
4070 particular, org-publish needs to know where to look for source files,
4071 and where to put published files.
4073 `:base-directory' Directory containing publishing source files
4074 `:publishing-directory'Directory (possibly remote) where output files
4076 `:preparation-function'Function called before starting publishing
4077 process, for example to run `make' for updating
4078 files to be published.
4081 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4083 11.1.3 Selecting files
4084 ----------------------
4086 By default, all files with extension `.org' in the base directory are
4087 considered part of the project. This can be modified by setting the
4089 `:base-extension' Extension (without the dot!) of source files. This
4090 actually is a regular expression.
4091 `:exclude' Regular expression to match file names that should
4092 not be published, even though they have been selected
4093 on the basis of their extension.
4094 `:include' List of files to be included regardless of
4095 `:base-extension' and `:exclude'.
4098 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4100 11.1.4 Publishing Action
4101 ------------------------
4103 Publishing means that a file is copied to the destination directory and
4104 possibly transformed in the process. The default transformation is to
4105 export Org-mode files as HTML files, and this is done by the function
4106 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4107 export::). Other files like images only need to be copied to the
4108 publishing destination. For non-Org-mode files, you need to specify
4109 the publishing function.
4111 `:publishing-function' Function executing the publication of a file.
4112 This may also be a list of functions, which will
4113 all be called in turn.
4115 The function must accept two arguments: a property list containing at
4116 least a `:publishing-directory' property, and the name of the file to
4117 be published. It should take the specified file, make the necessary
4118 transformation (if any) and place the result into the destination
4119 folder. You can write your own publishing function, but `org-publish'
4120 provides one for attachments (files that only need to be copied):
4121 `org-publish-attachment'.
4124 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4126 11.1.5 Options for the HTML exporter
4127 ------------------------------------
4129 The property list can be used to set many export options for the HTML
4130 exporter. In most cases, these properties correspond to user variables
4131 in Org-mode. The table below lists these properties along with the
4132 variable they belong to. See the documentation string for the
4133 respective variable for details.
4135 `:language' `org-export-default-language'
4136 `:headline-levels' `org-export-headline-levels'
4137 `:section-numbers' `org-export-with-section-numbers'
4138 `:table-of-contents' `org-export-with-toc'
4139 `:archived-trees' `org-export-with-archived-trees'
4140 `:emphasize' `org-export-with-emphasize'
4141 `:sub-superscript' `org-export-with-sub-superscripts'
4142 `:TeX-macros' `org-export-with-TeX-macros'
4143 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4144 `:fixed-width' `org-export-with-fixed-width'
4145 `:timestamps' `org-export-with-timestamps'
4147 `:tags' `org-export-with-tags'
4149 `:tables' `org-export-with-tables'
4150 `:table-auto-headline' `org-export-highlight-first-table-line'
4151 `:style' `org-export-html-style'
4152 `:convert-org-links' `org-export-html-link-org-files-as-html'
4153 `:inline-images' `org-export-html-inline-images'
4154 `:expand-quoted-html' `org-export-html-expand'
4155 `:timestamp' `org-export-html-with-timestamp'
4156 `:publishing-directory'`org-export-publishing-directory'
4157 `:preamble' `org-export-html-preamble'
4158 `:postamble' `org-export-html-postamble'
4159 `:auto-preamble' `org-export-html-auto-preamble'
4160 `:auto-postamble' `org-export-html-auto-postamble'
4161 `:author' `user-full-name'
4162 `:email' `user-mail-address'
4164 When a property is given a value in org-publish-project-alist, its
4165 setting overrides the value of the corresponding user variable (if any)
4166 during publishing. options set within a file (*note Export options::),
4167 however, override everything.
4170 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4172 11.1.6 Links between published files
4173 ------------------------------------
4175 To create a link from one Org-mode file to another, you would use
4176 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4177 (*note Hyperlinks::). Upon publishing this link becomes a link to
4178 `foo.html'. In this way, you can interlink the pages of your "org web"
4179 project and the links will work as expected when you publish them to
4182 You may also link to related files, such as images. Provided you are
4183 careful with relative pathnames, and provided you have also configured
4184 org-publish to upload the related files, these links will work too.
4185 *Note Complex example:: for an example of this usage.
4187 Sometime an Org-mode file to be published may contain links that are
4188 only valid in your production environment, but not in the publishing
4189 location. In this case, use the property
4191 `:link-validation-function' Function to validate links
4193 to define a function for checking link validity. This function must
4194 accept two arguments, the file name and a directory relative to which
4195 the file name is interpreted in the production environment. If this
4196 function returns `nil', then the HTML generator will only insert a
4197 description into the HTML file, but no link. One option for this
4198 function is `org-publish-validate-link' which checks if the given file
4199 is part of any project in `org-publish-project-alist'.
4202 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4204 11.1.7 Project page index
4205 -------------------------
4207 The following properties may be used to control publishing of an index
4208 of files or summary page for a given project.
4210 `:auto-index' When non-nil, publish an index during
4211 org-publish-current-project or org-publish-all.
4212 `:index-filename' Filename for output of index. Defaults to `index.org'
4213 (which becomes `index.html').
4214 `:index-title' Title of index page. Defaults to name of file.
4215 `:index-function' Plugin function to use for generation of index.
4216 Defaults to `org-publish-org-index', which generates
4217 a plain list of links to all files in the project.
4220 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4222 11.2 Sample configuration
4223 =========================
4225 Below we provide two example configurations. The first one is a simple
4226 project publishing only a set of Org-mode files. The second example is
4227 more complex, with a multi-component project.
4231 * Simple example:: One-component publishing
4232 * Complex example:: A multi-component publishing example
4235 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4237 11.2.1 Example: simple publishing configuration
4238 -----------------------------------------------
4240 This example publishes a set of Org-mode files to the `public_html'
4241 directory on the local machine.
4243 (setq org-publish-project-alist
4245 :base-directory "~/org/"
4246 :publishing-directory "~/public_html"
4247 :section-numbers nil
4248 :table-of-contents nil
4249 :style "<link rel=stylesheet
4250 href=\"../other/mystyle.css\"
4251 type=\"text/css\">")))
4254 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4256 11.2.2 Example: complex publishing configuration
4257 ------------------------------------------------
4259 This more complicated example publishes an entire website, including
4260 org files converted to HTML, image files, emacs lisp source code, and
4261 stylesheets. The publishing-directory is remote and private files are
4264 To ensure that links are preserved, care should be taken to replicate
4265 your directory structure on the web server, and to use relative file
4266 paths. For example, if your org files are kept in `~/org' and your
4267 publishable images in `~/images', you'd link to an image with
4268 file:../images/myimage.png
4269 On the web server, the relative path to the image should be the
4270 same. You can accomplish this by setting up an "images" folder in the
4271 right place on the webserver, and publishing images to it.
4273 (setq org-publish-project-alist
4275 :base-directory "~/org/"
4276 :base-extension "org"
4277 :publishing-directory "/ssh:user@host:~/html/notebook/"
4278 :publishing-function org-publish-org-to-html
4279 :exclude "PrivatePage.org" ;; regexp
4281 :section-numbers nil
4282 :table-of-contents nil
4283 :style "<link rel=stylesheet
4284 href=\"../other/mystyle.css\" type=\"text/css\">"
4286 :auto-postamble nil)
4289 :base-directory "~/images/"
4290 :base-extension "jpg\\|gif\\|png"
4291 :publishing-directory "/ssh:user@host:~/html/images/"
4292 :publishing-function org-publish-attachment)
4295 :base-directory "~/other/"
4296 :base-extension "css\\|el"
4297 :publishing-directory "/ssh:user@host:~/html/other/"
4298 :publishing-function org-publish-attachment)
4299 ("website" :components ("orgfiles" "images" "other"))))
4302 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4304 11.3 Triggering publication
4305 ===========================
4307 Once org-publish is properly configured, you can publish with the
4308 following functions:
4311 Prompt for a specific project and publish all files that belong to
4315 Publish the project containing the current file.
4318 Publish only the current file.
4321 Publish all projects.
4323 Org uses timestamps to track when a file has changed. The above
4324 functions normally only publish changed files. You can override this and
4325 force publishing of all files by giving a prefix argument.
4328 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4335 * Completion:: M-TAB knows what you need
4336 * Customization:: Adapting Org-mode to your taste
4337 * In-buffer settings:: Overview of the #+KEYWORDS
4338 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4339 * Clean view:: Getting rid of leading stars in the outline
4340 * TTY keys:: Using Org-mode on a tty
4341 * Interaction:: Other Emacs packages
4342 * Bugs:: Things which do not work perfectly
4345 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
4350 Org-mode supports in-buffer completion. This type of completion does
4351 not make use of the minibuffer. You simply type a few letters into the
4352 buffer and use the key to complete text right there.
4355 Complete word at point
4356 * At the beginning of a headline, complete TODO keywords.
4358 * After `\', complete TeX symbols supported by the exporter.
4360 * After `*', complete headlines in the current buffer so that
4361 they can be used in search links like `[[*find this
4364 * After `:', complete tags. The list of tags is taken from the
4365 variable `org-tag-alist' (possibly set through the `#+TAGS'
4366 in-buffer option, *note Setting tags::), or it is created
4367 dynamically from all tags used in the current buffer.
4369 * After `[', complete link abbreviations (*note Link
4372 * After `#+', complete the special keywords like `TYP_TODO' or
4373 `OPTIONS' which set file-specific options for Org-mode. When
4374 the option keyword is already complete, pressing `M-<TAB>'
4375 again will insert example settings for this keyword.
4377 * In the line after `#+STARTUP: ', complete startup keywords,
4378 i.e. valid keys for this line.
4380 * Elsewhere, complete dictionary words using ispell.
4383 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
4388 There are more than 100 variables that can be used to customize
4389 Org-mode. For the sake of compactness of the manual, we are not
4390 describing the variables here. A structured overview of customization
4391 variables is available with `M-x org-customize'. Or select `Browse Org
4392 Group' from the `Org->Customization' menu. Many settings can also be
4393 activated on a per-file basis, by putting special lines into the buffer
4394 (*note In-buffer settings::).
4397 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
4399 12.3 Summary of in-buffer settings
4400 ==================================
4402 Org-mode uses special lines in the buffer to define settings on a
4403 per-file basis. These lines start with a `#+' followed by a keyword, a
4404 colon, and then individual words defining a setting. Several setting
4405 words can be in the same line, but you can also have multiple lines for
4406 the keyword. While these settings are described throughout the manual,
4407 here is a summary. After changing any of those lines in the buffer,
4408 press `C-c C-c' with the cursor still in the line to activate the
4409 changes immediately. Otherwise they become effective only when the
4410 file is visited again in a new Emacs session.
4413 This line sets options to be used at startup of org-mode, when an
4414 Org-mode file is being visited. The first set of options deals
4415 with the initial visibility of the outline tree. The
4416 corresponding variable for global default settings is
4417 `org-startup-folded', with a default value `t', which means
4419 overview top-level headlines only
4420 content all headlines
4421 showall no folding at all, show everything
4422 Then there are options for aligning tables upon visiting a file.
4423 This is useful in files containing narrowed table columns. The
4424 corresponding variable is `org-startup-align-all-tables', with a
4425 default value `nil'.
4426 align align all tables
4427 noalign don't align tables on startup
4428 Logging when a TODO item is marked DONE (variable `org-log-done')
4429 can be configured using these options.
4430 logging record a timestamp when an item is marked DONE
4431 nologging don't record when items are marked DONE
4432 Here are the options for hiding leading stars in outline headings.
4433 The corresponding variables are `org-hide-leading-stars' and
4434 `org-odd-levels-only', both with a default setting `nil' (meaning
4435 `showstars' and `oddeven').
4436 hidestars make all but one of the stars starting a headline invisible.
4437 showstars show all stars starting a headline
4438 odd allow only odd outline levels (1,3,...)
4439 oddeven allow all outline levels
4441 `#+SEQ_TODO: #+TYP_TODO:'
4442 These lines set the TODO keywords and their interpretation in the
4443 current file. The corresponding variables are `org-todo-keywords'
4444 and `org-todo-interpretation'.
4446 `#+TAGS: TAG1(c1) TAG2(c2)'
4447 These lines (several such lines are allowed) specify the legal
4448 tags in this file, and (potentially) the corresponding _fast tag
4449 selection_ keys. The corresponding variable is `org-tag-alist'.
4451 `#+LINK: linkword replace'
4452 These lines (several are allowed) specify link abbreviations.
4453 *Note Link abbreviations::. The corresponding variable is
4454 `org-link-abbrev-alist'.
4457 This line sets the category for the agenda file. The category
4458 applies for all subsequent lines until the next `#+CATEGORY' line,
4459 or the end of the file.
4462 This line contains the formulas for the table directly above the
4465 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
4466 These lines provide settings for exporting files. For more
4467 details see *Note Export options::.
4470 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
4472 12.4 The very busy C-c C-c key
4473 ==============================
4475 The key `C-c C-c' has many purposes in org-mode, which are all
4476 mentioned scattered throughout this manual. One specific function of
4477 this key is to add _tags_ to a headline (*note Tags::). In many other
4478 circumstances it means something like _Hey Org-mode, look here and
4479 update according to what you see here_. Here is a summary of what this
4480 means in different contexts.
4482 - If there are highlights in the buffer from the creation of a sparse
4483 tree, or from clock display, remove these highlights.
4485 - If the cursor is in one of the special `#+KEYWORD' lines, this
4486 triggers scanning the buffer for these lines and updating the
4489 - If the cursor is inside a table, realign the table. This command
4490 works even if the automatic table editor has been turned off.
4492 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
4495 - If the cursor is inside a table created by the `table.el' package,
4496 activate that table.
4498 - If the current buffer is a remember buffer, close the note and
4499 file it. With a prefix argument, file it, without further
4500 interaction, to the default location.
4502 - If the cursor is on a `<<<target>>>', update radio targets and
4503 corresponding links in this buffer.
4505 - If the cursor is in a plain list item with a checkbox, toggle the
4506 status of the checkbox.
4508 - If the cursor is on a numbered item in a plain list, renumber the
4512 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
4514 12.5 A cleaner outline view
4515 ===========================
4517 Some people find it noisy and distracting that the Org-mode headlines
4518 are starting with a potentially large number of stars. For example the
4519 tree from *Note Headlines:::
4521 * Top level headline
4527 * Another top level headline
4529 Unfortunately this is deeply ingrained into the code of Org-mode and
4530 cannot be easily changed. You can, however, modify the display in such
4531 a way that all leading stars become invisible and the outline more easy
4532 to read. To do this, customize the variable `org-hide-leading-stars'
4535 (setq org-hide-leading-stars t)
4537 or change this on a per-file basis with one of the lines (anywhere in
4540 #+STARTUP: showstars
4541 #+STARTUP: hidestars
4543 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
4546 With stars hidden, the tree becomes:
4548 * Top level headline
4554 * Another top level headline
4556 Note that the leading stars are not truly replaced by whitespace, they
4557 are only fontified with the face `org-hide' that uses the background
4558 color as font color. If are are not using either white or black
4559 background, you may have to customize this face to get the wanted
4560 effect. Another possibility is to set this font such that the extra
4561 stars are almost invisible, for example using the color `grey90' on a
4564 Things become cleaner still if you skip all the even levels and use
4565 only odd levels 1, 3, 5..., effectively adding two stars to go from one
4566 outline level to the next:
4568 * Top level headline
4574 * Another top level headline
4576 In order to make the structure editing and export commands handle this
4577 convention correctly, use
4579 (setq org-odd-levels-only t)
4581 or set this on a per-file basis with one of the following lines (don't
4582 forget to press `C-c C-c' with the cursor in the startup line to
4583 activate changes immediately).
4588 You can convert an Org-mode file from single-star-per-level to the
4589 double-star-per-level convention with `M-x org-convert-to-odd-levels
4590 RET' in that file. The reverse operation is `M-x
4591 org-convert-to-oddeven-levels'.
4594 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
4596 12.6 Using org-mode on a tty
4597 ============================
4599 Org-mode uses a number of keys that are not accessible on a tty. This
4600 applies to most special keys like cursor keys, <TAB> and <RET>, when
4601 these are combined with modifier keys like <Meta> and/or <Shift>.
4602 Org-mode uses these bindings because it needs to provide keys for a
4603 large number of commands, and because these keys appeared particularly
4604 easy to remember. In order to still be able to access the core
4605 functionality of Org-mode on a tty, alternative bindings are provided.
4606 Here is a complete list of these bindings, which are obviously more
4607 cumbersome to use. Note that sometimes a work-around can be better.
4608 For example changing a time stamp is really only fun with `S-<cursor>'
4609 keys. On a tty you would rather use `C-c .' to re-insert the
4612 Default Alternative 1 Alternative 2
4613 `S-<TAB>' `C-u <TAB>'
4614 `M-<left>' `C-c C-x l' `<Esc> <left>'
4615 `M-S-<left>'`C-c C-x L'
4616 `M-<right>' `C-c C-x r' `<Esc>
4618 `M-S-<right>'`C-c C-x R'
4619 `M-<up>' `C-c C-x u' `<Esc> <up>'
4620 `M-S-<up>' `C-c C-x U'
4621 `M-<down>' `C-c C-x d' `<Esc> <down>'
4622 `M-S-<down>'`C-c C-x D'
4623 `S-<RET>' `C-c C-x c'
4624 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
4625 `M-S-<RET>' `C-c C-x M'
4628 `S-<right>' `C-c C-x
4636 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
4638 12.7 Interaction with other packages
4639 ====================================
4641 Org-mode lives in the world of GNU Emacs and interacts in various ways
4642 with other code out there.
4646 * Cooperation:: Packages Org-mode cooperates with
4647 * Conflicts:: Packages that lead to conflicts
4650 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
4652 12.7.1 Packages that Org-mode cooperates with
4653 ---------------------------------------------
4655 `calc.el' by Dave Gillespie
4656 Org-mode uses the calc package for implementing spreadsheet
4657 functionality in its tables (*note Table calculations::).
4658 Org-modes checks for the availability of calc by looking for the
4659 function `calc-eval' which should be autoloaded in your setup if
4660 calc has been installed properly. As of Emacs 22, calc is part of
4661 the Emacs distribution. Another possibility for interaction
4662 between the two packages is using calc for embedded calculations.
4663 *Note Embedded Mode: (calc)Embedded Mode.
4665 `constants.el' by Carsten Dominik
4666 In a table formula (*note Table calculations::), it is possible to
4667 use names for natural constants or units. Instead of defining
4668 your own constants in the variable `org-table-formula-constants',
4669 install the `constants' package which defines a large number of
4670 constants and units, and lets you use unit prefixes like `M' for
4671 `Mega' etc. You will need version 2.0 of this package, available
4672 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
4673 the function `constants-get', which has to be autoloaded in your
4674 setup. See the installation instructions in the file
4677 `cdlatex.el' by Carsten Dominik
4678 Org-mode can make use of the cdlatex package to efficiently enter
4679 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
4681 `remember.el' by John Wiegley
4682 Org mode cooperates with remember, see *Note Remember::.
4683 `Remember.el' is not part of Emacs, find it on the web.
4685 `table.el' by Takaaki Ota
4686 Org mode cooperates with table.el, see *Note table.el::.
4687 `table.el' is part of Emacs 22.
4690 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
4692 12.7.2 Packages that lead to conflicts with Org-mode
4693 ----------------------------------------------------
4695 `allout.el' by Ken Manheimer
4696 Startup of Org-mode may fail with the error message
4697 `(wrong-type-argument keymapp nil)' when there is an outdated
4698 version `allout.el' on the load path, for example the version
4699 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
4700 will disappear. If for some reason you cannot do this, make sure
4701 that org.el is loaded _before_ `allout.el', for example by putting
4702 `(require 'org)' early enough into your `.emacs' file.
4704 `CUA.el' by Kim. F. Storm
4705 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4706 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4707 select and extend the region. If you want to use one of these
4708 packages along with Org-mode, configure the variable
4709 `org-CUA-compatible'. When set, Org-mode will move the following
4710 keybindings in org-mode files, and in the agenda buffer (but not
4711 during date selection).
4713 S-UP -> M-p S-DOWN -> M-n
4714 S-LEFT -> M-- S-RIGHT -> M-+
4717 Yes, these are unfortunately more difficult to remember. If you
4718 want to have other replacement keys, look at the variable
4719 `org-disputed-keys'.
4721 `windmove.el' by Hovav Shacham
4722 Also this package uses the `S-<cursor>' keys, so everything written
4723 in the paragraph above about CUA mode also applies here.
4726 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
4731 Here is a list of things that should work differently, but which I have
4732 found too hard to fix.
4734 * If a table field starts with a link, and if the corresponding table
4735 column is narrowed (*note Narrow columns::) to a width too small to
4736 display the link, the field would look entirely empty even though
4737 it is not. To prevent this, Org-mode throws an error. The
4738 work-around is to make the column wide enough to fit the link, or
4739 to add some text (at least 2 characters) before the link in the
4742 * Narrowing table columns does not work on XEmacs, because the
4743 `format' function does not transport text properties.
4745 * Text in an entry protected with the `QUOTE' keyword should not
4748 * When the application called by `C-c C-o' to open a file link fails
4749 (for example because the application does not exist or refuses to
4750 open the file), it does so silently. No error message is
4753 * The remote-editing commands in the agenda buffer cannot be undone
4754 with `undo' called from within the agenda buffer. But you can go
4755 to the corresponding buffer (using <TAB> or <RET> and execute
4758 * Recalculating a table line applies the formulas from left to right.
4759 If a formula uses _calculated_ fields further down the row,
4760 multiple recalculation may be needed to get all fields consistent.
4762 * A single letter cannot be made bold, for example `*a*'.
4764 * The exporters work well, but could be made more efficient.
4767 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
4769 Appendix A Extensions, Hooks and Hacking
4770 ****************************************
4772 This appendix lists extensions for Org-mode written by other authors.
4773 It also covers some aspects where users can easily extend the
4774 functionality of Org-mode.
4778 * Extensions:: Existing 3rd-part extensions
4779 * Dynamic blocks:: Automatically filled blocks
4782 File: org, Node: Extensions, Next: Dynamic blocks, Prev: Extensions and Hacking, Up: Extensions and Hacking
4784 A.1 Third-party extensions for Org-mode
4785 =======================================
4787 The following extensions for Org-mode have been written by other people:
4789 `org-mouse.el' by Piotr Zielinski
4790 This package implements extended mouse functionality for Org-mode.
4791 It allows you to cycle visibility and to edit the document
4792 structure with the mouse. Best of all, it provides a
4793 context-sensitive menu on <mouse-3> that changes depending on the
4794 context of a mouse-click. `org-mouse.el' is freely available at
4795 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
4797 `org-publish.el' by David O'Toole
4798 This package provides facilities for publishing related sets of
4799 Org-mode files together with linked files like images as a
4800 webpages. It is highly configurable and can be used for other
4801 publishing purposes as well. As of Org-mode version 4.30,
4802 `org-publish.el' is part of the Org-mode distribution. It is not
4803 yet part of Emacs, however, a delay caused by the preparations for
4804 the 22.1 release. In the mean time, `org-publish.el' can be
4805 downloaded from David's site:
4806 `http://dto.freeshell.org/e/org-publish.el'.
4808 `org-blog.el' by David O'Toole
4809 A blogging plug-in for `org-publish.el'.
4810 `http://dto.freeshell.org/notebook/OrgMode.html'.
4812 `org-blogging.el' by Bastien Guerry
4813 Publish Org-mode files as blogs.
4814 `http://www.cognition.ens.fr/~guerry/org-blogging.html'.
4817 File: org, Node: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
4822 Org-mode documents can contain _dynamic blocks_. These are specially
4823 marked regions that are updated by some user-written function. A good
4824 example for such a block is the clock table inserted by the command
4825 `C-c C-x C-r' (*note Clocking work time::).
4827 Dynamic block are enclosed by a BEGIN-END structure that assigns a
4828 name to the block and can also specify parameters for the function
4829 producing the content of the block.
4831 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
4835 Dynamic blocks are updated with the following commands
4838 Update dynamic block at point.
4841 Update all dynamic blocks in the current file.
4843 Updating a dynamic block means to remove all the text between BEGIN
4844 and END, parse the BEGIN line for parameters and then call the specific
4845 writer function for this block to insert the new content. For a block
4846 with name `myblock', the writer function is `org-dblock-write:myblock'
4847 with as only parameter a property list with the parameters given in the
4848 begin line. Here is a trivial example of a block that keeps track of
4849 when the block update function was last run:
4851 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
4855 The corresponding block writer function could look like this:
4857 (defun org-dblock-write:block-update-time (params)
4858 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
4859 (insert "Last block update at: "
4860 (format-time-string fmt (current-time)))))
4862 If you want to make sure that all dynamic blocks are always
4863 up-to-date, you could add the function `org-update-all-dblocks' to a
4864 hook, for example `before-save-hook'. `org-update-all-dblocks' is
4865 written in a way that is does nothing in buffers that are not in
4869 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
4871 Appendix B History and Acknowledgments
4872 **************************************
4874 Org-mode was borne in 2003, out of frustration over the user interface
4875 of the Emacs outline-mode. All I wanted was to make working with an
4876 outline tree possible without having to remember more than 10 commands
4877 just for hiding and unhiding parts of the outline tree, and to allow to
4878 restructure a tree easily. Visibility cycling and structure editing
4879 were originally implemented in the package `outline-magic.el', but
4880 quickly moved to the more general `org.el'. TODO entries, basic time
4881 stamps, and table support were added next, and highlight the two main
4882 goals that Org-mode still has today: To create a new, outline-based,
4883 plain text mode with innovative and intuitive editing features, and to
4884 incorporate project planning functionality directly into a notes file.
4886 Since the first release, hundreds of emails to me or on
4887 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
4888 feedback, new ideas, and sometimes even patches and add-on code. Many
4889 thanks to everyone who has helped to improve this package. I am trying
4890 to keep here a list of the people who had significant influence in
4891 shaping one or more aspects of Org-mode. The list may not be complete,
4892 if I have forgotten someone, please accept my apologies and let me know.
4894 * Thomas Baumann contributed the code for links to the MH-E email
4897 * Alex Bochannek provided a patch for rounding time stamps.
4899 * Charles Cave's suggestion sparked the implementation of templates
4902 * Pavel Chalmoviansky influenced the agenda treatment of items with
4905 * Gregory Chernov patched support for lisp forms into table
4906 calculations and improved XEmacs compatibility, in particular by
4907 porting `nouline.el' to XEmacs.
4909 * Sacha Chua suggested to copy some linking code from Planner.
4911 * Eddward DeVilla proposed and tested checkbox statistics.
4913 * Kees Dullemond inspired the use of narrowed tabled columns.
4915 * Christian Egli converted the documentation into TeXInfo format,
4916 patched CSS formatting into the HTML exporter, and inspired the
4919 * Nic Ferrier contributed mailcap and XOXO support.
4921 * Niels Giessen had the idea to automatically archive DONE trees.
4923 * Bastien Guerry provided extensive feedback.
4925 * Kai Grossjohann pointed out key-binding conflicts with other
4928 * Leon Liu asked for embedded LaTeX and tested it.
4930 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
4933 * Todd Neal provided patches for links to Info files and elisp forms.
4935 * Tim O'Callaghan suggested in-file links, search options for general
4936 file links, and TAGS.
4938 * Oliver Oppitz suggested multi-state TODO items.
4940 * Scott Otterson sparked the introduction of descriptive text for
4941 links, among other things.
4943 * Pete Phillips helped during the development of the TAGS feature,
4944 and provided frequent feedback.
4946 * T.V. Raman reported bugs and suggested improvements.
4948 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
4951 * Kevin Rogers contributed code to access VM files on remote hosts.
4953 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
4954 conflict with `allout.el'.
4956 * Jason Riedy sent a patch to fix a bug with export of TODO keywerds.
4958 * Philip Rooke created the Org-mode reference card and provided lots
4961 * Christian Schlauer proposed angular brackets around links, among
4964 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
4965 `organizer-mode.el'.
4967 * Daniel Sinder came up with the idea of internal archiving by
4970 * Dale Smith proposed link abbreviations.
4972 * David O'Toole wrote `org-publish.el' and drafted the manual
4973 chapter about publishing.
4975 * Ju"rgen Vollmer contributed code generating the table of contents
4978 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
4980 * David Wainberg suggested archiving, and improvements to the linking
4983 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
4984 development of Org-mode was fully independent, and both systems are
4985 really different beasts in their basic ideas and implementation
4986 details. I later looked at John's code, however, and learned from
4987 his implementation of (i) links where the link itself is hidden
4988 and only a description is shown, and (ii) popping up a calendar to
4991 * Carsten Wimmer suggested some changes and helped fix a bug in
4994 * Roland Winkler requested additional keybindings to make Org-mode
4997 * Piotr Zielinski wrote `org-mouse.el', proposed angenda blocks and
4998 contributed various ideas and code snippets.
5001 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
5009 * abbreviation, links: Link abbreviations. (line 6)
5010 * acknowledgments: History and Acknowledgments.
5012 * action, for publishing: Publishing action. (line 6)
5013 * activation: Activation. (line 6)
5014 * active region <1>: HTML export. (line 10)
5015 * active region <2>: ASCII export. (line 9)
5016 * active region <3>: Built-in table editor.
5018 * active region: Structure editing. (line 51)
5019 * agenda: Weekly/Daily agenda. (line 6)
5020 * agenda dispatcher: Agenda dispatcher. (line 6)
5021 * agenda files: Agenda files. (line 6)
5022 * agenda files, removing buffers: Agenda commands. (line 211)
5023 * agenda views: Agenda views. (line 6)
5024 * agenda views, custom: Custom agenda views. (line 6)
5025 * agenda, batch production: Batch processing. (line 6)
5026 * agenda, with block views: Block agenda. (line 6)
5027 * allout.el: Conflicts. (line 6)
5028 * angular brackets, around links: External links. (line 38)
5029 * applescript, for calendar update: iCalendar export. (line 38)
5030 * archive locations: Moving subtrees. (line 21)
5031 * archiving: Archiving. (line 6)
5032 * ASCII export: ASCII export. (line 6)
5033 * author: Feedback. (line 6)
5034 * autoload: Activation. (line 6)
5035 * BBDB links: External links. (line 6)
5036 * block agenda: Block agenda. (line 6)
5037 * bold text: Enhancing text. (line 15)
5038 * bug reports: Feedback. (line 6)
5039 * bugs: Bugs. (line 6)
5040 * C-c C-c, overview: The very busy C-c C-c key.
5042 * calc package: Table calculations. (line 6)
5043 * calc.el: Cooperation. (line 6)
5044 * calculations, in tables <1>: Table calculations. (line 6)
5045 * calculations, in tables: Built-in table editor.
5047 * calendar commands, from agenda: Agenda commands. (line 172)
5048 * calendar integration: Calendar/Diary integration.
5050 * calendar, for selecting date: The date/time prompt.
5052 * CamelCase link completion: Completion. (line 6)
5053 * CamelCase links: Internal links. (line 6)
5054 * CamelCase links, completion of: CamelCase links. (line 6)
5055 * category: Categories. (line 6)
5056 * CDLaTeX: CDLaTeX mode. (line 6)
5057 * cdlatex.el: Cooperation. (line 29)
5058 * checkbox statistics: Checkboxes. (line 23)
5059 * checkboxes: Checkboxes. (line 6)
5060 * children, subtree visibility state: Visibility cycling. (line 10)
5061 * clean outline view: Clean view. (line 6)
5062 * CLOCK keyword: Time stamps. (line 61)
5063 * CLOSED keyword: Time stamps. (line 55)
5064 * column formula: Column formulas. (line 6)
5065 * commands, in agenda buffer: Agenda commands. (line 6)
5066 * comment lines: Comment lines. (line 6)
5067 * completion, of CamelCase links <1>: Completion. (line 6)
5068 * completion, of CamelCase links: CamelCase links. (line 6)
5069 * completion, of dictionary words: Completion. (line 6)
5070 * completion, of file names: Handling links. (line 43)
5071 * completion, of links: Handling links. (line 27)
5072 * completion, of option keywords <1>: Completion. (line 6)
5073 * completion, of option keywords: Export options. (line 6)
5074 * Completion, of option keywords: Per file keywords. (line 17)
5075 * completion, of tags <1>: Completion. (line 6)
5076 * completion, of tags: Setting tags. (line 11)
5077 * completion, of TeX symbols: Completion. (line 6)
5078 * completion, of TODO keywords <1>: Completion. (line 6)
5079 * completion, of TODO keywords: Workflow states. (line 12)
5080 * constants, in calculations: Formula syntax. (line 26)
5081 * constants.el: Cooperation. (line 14)
5082 * contents, global visibility state: Visibility cycling. (line 22)
5083 * copying, of subtrees: Structure editing. (line 6)
5084 * creating timestamps: Creating timestamps. (line 6)
5085 * CUA.el: Conflicts. (line 15)
5086 * custom agenda views: Custom agenda views. (line 6)
5087 * custom search strings: Custom searches. (line 6)
5088 * customization: Customization. (line 6)
5089 * cutting, of subtrees: Structure editing. (line 6)
5090 * cycling, of TODO states: TODO basics. (line 13)
5091 * cycling, visibility: Visibility cycling. (line 6)
5092 * daily agenda: Weekly/Daily agenda. (line 6)
5093 * date stamps <1>: Time stamps. (line 6)
5094 * date stamps: Timestamps. (line 6)
5095 * date, reading in minibuffer: The date/time prompt.
5097 * DEADLINE keyword: Time stamps. (line 43)
5098 * deadlines: Time stamps. (line 6)
5099 * demotion, of subtrees: Structure editing. (line 6)
5100 * diary entries, creating from agenda: Agenda commands. (line 179)
5101 * diary integration: Calendar/Diary integration.
5103 * dictionary word completion: Completion. (line 6)
5104 * directories, for publishing: Sources and destinations.
5106 * dispatching agenda commands: Agenda dispatcher. (line 6)
5107 * display changing, in agenda: Agenda commands. (line 59)
5108 * document structure: Document structure. (line 6)
5109 * DONE, final TODO keyword: Per file keywords. (line 20)
5110 * editing tables: Tables. (line 6)
5111 * editing, of table formulas: Editing/debugging formulas.
5113 * elisp links: External links. (line 6)
5114 * emphasized text: Export options. (line 25)
5115 * enhancing text: Enhancing text. (line 6)
5116 * evaluate time range: Creating timestamps. (line 66)
5117 * exporting: Exporting. (line 6)
5118 * exporting, not: Comment lines. (line 6)
5119 * extended TODO keywords: TODO extensions. (line 6)
5120 * external archiving: Moving subtrees. (line 6)
5121 * external links: External links. (line 6)
5122 * external links, in HTML export: HTML export. (line 35)
5123 * FAQ: Summary. (line 41)
5124 * feedback: Feedback. (line 6)
5125 * file links: External links. (line 6)
5126 * file links, searching: Search options. (line 6)
5127 * file name completion: Handling links. (line 43)
5128 * files for agenda: Agenda files. (line 6)
5129 * files, adding to agenda list: Agenda files. (line 12)
5130 * files, selecting for publishing: Selecting files. (line 6)
5131 * fixed width: Enhancing text. (line 25)
5132 * fixed-width sections: Export options. (line 25)
5133 * folded, subtree visibility state: Visibility cycling. (line 10)
5134 * folding, sparse trees: Sparse trees. (line 6)
5135 * following links: Handling links. (line 58)
5136 * format specifier: Formula syntax. (line 34)
5137 * format, of links: Link format. (line 6)
5138 * formula editing: Editing/debugging formulas.
5140 * formula syntax: Formula syntax. (line 6)
5141 * formula, for named table field: Named-field formulas.
5143 * formula, for table column: Column formulas. (line 6)
5144 * formula, in tables: Built-in table editor.
5146 * global cycling: Visibility cycling. (line 22)
5147 * global keybindings: Activation. (line 6)
5148 * global TODO list: Global TODO list. (line 6)
5149 * global visibility states: Visibility cycling. (line 22)
5150 * GNUS links: External links. (line 6)
5151 * hand-formatted lists: Enhancing text. (line 11)
5152 * headline levels: Export options. (line 25)
5153 * headline levels, for exporting <1>: HTML export. (line 21)
5154 * headline levels, for exporting: ASCII export. (line 18)
5155 * headline navigation: Motion. (line 6)
5156 * headline tagging: Tags. (line 6)
5157 * headline, promotion and demotion: Structure editing. (line 6)
5158 * headlines: Headlines. (line 6)
5159 * hide text: Visibility cycling. (line 6)
5160 * hiding leading stars: Clean view. (line 6)
5161 * history: History and Acknowledgments.
5163 * HTML export: HTML export. (line 6)
5164 * hyperlinks: Hyperlinks. (line 6)
5165 * iCalendar export: iCalendar export. (line 6)
5166 * in-buffer settings: In-buffer settings. (line 6)
5167 * index, of published pages: Project page index. (line 6)
5168 * Info links: External links. (line 6)
5169 * inheritance, of tags: Tag inheritance. (line 6)
5170 * inserting links: Handling links. (line 27)
5171 * installation: Installation. (line 6)
5172 * internal archiving: ARCHIVE tag. (line 6)
5173 * internal links: Internal links. (line 6)
5174 * internal links, in HTML export: HTML export. (line 35)
5175 * introduction: Introduction. (line 6)
5176 * italic text: Enhancing text. (line 15)
5177 * jumping, to headlines: Motion. (line 6)
5178 * keybindings, global: Activation. (line 6)
5179 * keyword options: Per file keywords. (line 6)
5180 * LaTeX fragments <1>: Export options. (line 25)
5181 * LaTeX fragments: LaTeX fragments. (line 6)
5182 * LaTeX fragments, export: Enhancing text. (line 18)
5183 * LaTeX fragments, preview: Processing LaTeX fragments.
5185 * LaTeX interpretation: Embedded LaTeX. (line 6)
5186 * linebreak preservation: Export options. (line 25)
5187 * linebreak, forced: Enhancing text. (line 32)
5188 * link abbreviations: Link abbreviations. (line 6)
5189 * link completion: Handling links. (line 27)
5190 * link format: Link format. (line 6)
5191 * links, external: External links. (line 6)
5192 * links, handling: Handling links. (line 6)
5193 * links, in HTML export: HTML export. (line 35)
5194 * links, internal: Internal links. (line 6)
5195 * links, publishing: Publishing links. (line 6)
5196 * links, radio targets: Radio targets. (line 6)
5197 * links, returning to: Handling links. (line 85)
5198 * Lisp forms, as table formulas: Lisp formulas. (line 6)
5199 * lists, hand-formatted: Enhancing text. (line 11)
5200 * lists, ordered: Plain lists. (line 6)
5201 * lists, plain: Plain lists. (line 6)
5202 * logging, of progress: Progress logging. (line 6)
5203 * maintainer: Feedback. (line 6)
5204 * mark ring: Handling links. (line 81)
5205 * marking characters, tables: Advanced features. (line 34)
5206 * matching, of tags: Matching headline tags.
5208 * matching, tags: Tags. (line 6)
5209 * math symbols: Math symbols. (line 6)
5210 * MH-E links: External links. (line 6)
5211 * minor mode for tables: orgtbl-mode. (line 6)
5212 * mode, for calc: Formula syntax. (line 34)
5213 * motion commands in agenda: Agenda commands. (line 19)
5214 * motion, between headlines: Motion. (line 6)
5215 * name, of column or field: Formula syntax. (line 26)
5216 * named field formula: Named-field formulas.
5218 * names as TODO keywords: TODO types. (line 6)
5219 * narrow columns in tables: Narrow columns. (line 6)
5220 * occur, command: Sparse trees. (line 6)
5221 * option keyword completion: Completion. (line 6)
5222 * options, for custom agenda views: Setting Options. (line 6)
5223 * options, for customization: Customization. (line 6)
5224 * options, for export: Export options. (line 6)
5225 * options, for publishing: Publishing options. (line 6)
5226 * ordered lists: Plain lists. (line 6)
5227 * org-agenda, command: Weekly/Daily agenda. (line 9)
5228 * org-blog.el: Extensions. (line 25)
5229 * org-blogging.el: Extensions. (line 29)
5230 * org-mode, turning on: Activation. (line 22)
5231 * org-mouse.el: Extensions. (line 8)
5232 * org-publish-project-alist: Project alist. (line 6)
5233 * org-publish.el: Extensions. (line 14)
5234 * orgtbl-mode: orgtbl-mode. (line 6)
5235 * outline tree: Headlines. (line 6)
5236 * outline-mode: Outlines. (line 6)
5237 * outlines: Outlines. (line 6)
5238 * overview, global visibility state: Visibility cycling. (line 22)
5239 * packages, interaction with other: Interaction. (line 6)
5240 * pasting, of subtrees: Structure editing. (line 6)
5241 * per file keywords: Per file keywords. (line 6)
5242 * plain lists: Plain lists. (line 6)
5243 * plain text external links: External links. (line 38)
5244 * presentation, of agenda items: Presentation and sorting.
5246 * printing sparse trees: Sparse trees. (line 41)
5247 * priorities: Priorities. (line 6)
5248 * priorities, of agenda items: Sorting of agenda items.
5250 * progress logging: Progress logging. (line 6)
5251 * projects, for publishing: Project alist. (line 6)
5252 * promotion, of subtrees: Structure editing. (line 6)
5253 * publishing: Publishing. (line 6)
5254 * quoted HTML tags: Export options. (line 25)
5255 * radio targets: Radio targets. (line 6)
5256 * ranges, time: Time stamps. (line 6)
5257 * recomputing table fields: Column formulas. (line 27)
5258 * region, active <1>: HTML export. (line 10)
5259 * region, active <2>: ASCII export. (line 9)
5260 * region, active <3>: Built-in table editor.
5262 * region, active: Structure editing. (line 51)
5263 * remember.el <1>: Cooperation. (line 33)
5264 * remember.el: Remember. (line 6)
5265 * remote editing, from agenda: Agenda commands. (line 100)
5266 * richer text: Enhancing text. (line 6)
5267 * RMAIL links: External links. (line 6)
5268 * SCHEDULED keyword: Time stamps. (line 30)
5269 * scheduling: Time stamps. (line 6)
5270 * search option in file links: Search options. (line 6)
5271 * search strings, custom: Custom searches. (line 6)
5272 * searching for tags: Tag searches. (line 6)
5273 * section-numbers: Export options. (line 25)
5274 * setting tags: Setting tags. (line 6)
5275 * SHELL links: External links. (line 6)
5276 * show all, command: Visibility cycling. (line 31)
5277 * show all, global visibility state: Visibility cycling. (line 22)
5278 * show hidden text: Visibility cycling. (line 6)
5279 * sorting, of agenda items: Sorting of agenda items.
5281 * sparse tree, for deadlines: Creating timestamps. (line 41)
5282 * sparse tree, for TODO: TODO basics. (line 26)
5283 * sparse tree, tag based: Tags. (line 6)
5284 * sparse trees: Sparse trees. (line 6)
5285 * special keywords: In-buffer settings. (line 6)
5286 * spreadsheet capabilities: Table calculations. (line 6)
5287 * statistics, for checkboxes: Checkboxes. (line 23)
5288 * storing links: Handling links. (line 9)
5289 * structure editing: Structure editing. (line 6)
5290 * structure of document: Document structure. (line 6)
5291 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
5292 * sublevels, inclusion into todo list: Global TODO list. (line 31)
5293 * subscript: Subscripts and Superscripts.
5295 * subtree cycling: Visibility cycling. (line 10)
5296 * subtree visibility states: Visibility cycling. (line 10)
5297 * subtree, cut and paste: Structure editing. (line 6)
5298 * subtree, subtree visibility state: Visibility cycling. (line 10)
5299 * subtrees, cut and paste: Structure editing. (line 6)
5300 * summary: Summary. (line 6)
5301 * superscript: Subscripts and Superscripts.
5303 * syntax, of formulas: Formula syntax. (line 6)
5304 * table editor, builtin: Built-in table editor.
5306 * table editor, table.el: table.el. (line 6)
5307 * table of contents: Export options. (line 25)
5308 * table.el <1>: Cooperation. (line 34)
5309 * table.el: table.el. (line 6)
5310 * tables <1>: Export options. (line 25)
5311 * tables: Tables. (line 6)
5312 * tables, export: Enhancing text. (line 21)
5313 * tag completion: Completion. (line 6)
5314 * tag searches: Tag searches. (line 6)
5315 * tags: Tags. (line 6)
5316 * tags view: Matching headline tags.
5318 * tags, setting: Setting tags. (line 6)
5319 * targets, for links: Internal links. (line 6)
5320 * targets, radio: Radio targets. (line 6)
5321 * tasks, breaking down: Breaking down tasks. (line 6)
5322 * templates, for remember: Remember. (line 23)
5323 * TeX interpretation: Embedded LaTeX. (line 6)
5324 * TeX macros <1>: Export options. (line 25)
5325 * TeX macros: Math symbols. (line 6)
5326 * TeX macros, export: Enhancing text. (line 18)
5327 * TeX symbol completion: Completion. (line 6)
5328 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
5329 * thanks: History and Acknowledgments.
5331 * time grid: Time-of-day specifications.
5333 * time stamps <1>: Time stamps. (line 6)
5334 * time stamps: Timestamps. (line 6)
5335 * time, reading in minibuffer: The date/time prompt.
5337 * time-of-day specification: Time-of-day specifications.
5339 * time-sorted view: Timeline. (line 6)
5340 * timeline, single file: Timeline. (line 6)
5341 * timerange: Time stamps. (line 21)
5342 * timestamp: Time stamps. (line 13)
5343 * timestamps, creating: Creating timestamps. (line 6)
5344 * TODO items: TODO items. (line 6)
5345 * TODO keywords completion: Completion. (line 6)
5346 * TODO list, global: Global TODO list. (line 6)
5347 * TODO types: TODO types. (line 6)
5348 * TODO workflow: Workflow states. (line 6)
5349 * transient-mark-mode <1>: HTML export. (line 10)
5350 * transient-mark-mode <2>: ASCII export. (line 9)
5351 * transient-mark-mode <3>: Built-in table editor.
5353 * transient-mark-mode: Structure editing. (line 51)
5354 * trees, sparse: Sparse trees. (line 6)
5355 * trees, visibility: Visibility cycling. (line 6)
5356 * tty keybindings: TTY keys. (line 6)
5357 * types as TODO keywords: TODO types. (line 6)
5358 * underlined text: Enhancing text. (line 15)
5359 * URL links: External links. (line 6)
5360 * USENET links: External links. (line 6)
5361 * variables, for customization: Customization. (line 6)
5362 * vectors, in table calculations: Formula syntax. (line 23)
5363 * visibility cycling: Visibility cycling. (line 6)
5364 * visible text, printing: Sparse trees. (line 41)
5365 * VM links: External links. (line 6)
5366 * WANDERLUST links: External links. (line 6)
5367 * weekly agenda: Weekly/Daily agenda. (line 6)
5368 * windmove.el: Conflicts. (line 33)
5369 * workflow states as TODO keywords: Workflow states. (line 6)
5370 * XEmacs: Installation. (line 6)
5371 * XOXO export: XOXO export. (line 6)
5374 File: org, Node: Key Index, Prev: Index, Up: Top
5382 * ': CDLaTeX mode. (line 43)
5383 * +: Agenda commands. (line 126)
5384 * ,: Agenda commands. (line 118)
5385 * -: Agenda commands. (line 132)
5386 * .: Agenda commands. (line 94)
5387 * :: Agenda commands. (line 112)
5388 * <: The date/time prompt.
5390 * <left>: Agenda commands. (line 91)
5391 * <RET> <1>: Agenda commands. (line 41)
5392 * <RET> <2>: The date/time prompt.
5394 * <RET>: Built-in table editor.
5396 * <right>: Agenda commands. (line 86)
5397 * <SPC>: Agenda commands. (line 28)
5398 * <TAB> <1>: CDLaTeX mode. (line 23)
5399 * <TAB> <2>: Agenda commands. (line 35)
5400 * <TAB> <3>: Built-in table editor.
5402 * <TAB> <4>: Plain lists. (line 37)
5403 * <TAB>: Visibility cycling. (line 10)
5404 * > <1>: Agenda commands. (line 154)
5405 * >: The date/time prompt.
5407 * ^: CDLaTeX mode. (line 33)
5408 * _: CDLaTeX mode. (line 33)
5409 * `: CDLaTeX mode. (line 39)
5410 * a: Agenda commands. (line 115)
5411 * C: Agenda commands. (line 194)
5412 * c: Agenda commands. (line 172)
5413 * C-#: Built-in table editor.
5415 * C-,: Agenda files. (line 18)
5416 * C-a a L: Timeline. (line 10)
5417 * C-c !: Creating timestamps. (line 21)
5418 * C-c #: Checkboxes. (line 55)
5419 * C-c $: Moving subtrees. (line 10)
5420 * C-c %: Handling links. (line 81)
5421 * C-c &: Handling links. (line 85)
5422 * C-c ' <1>: Editing/debugging formulas.
5424 * C-c ': Built-in table editor.
5426 * C-c *: Built-in table editor.
5428 * C-c +: Built-in table editor.
5430 * C-c ,: Priorities. (line 18)
5431 * C-c -: Built-in table editor.
5433 * C-c .: Creating timestamps. (line 10)
5434 * C-c /: Sparse trees. (line 15)
5435 * C-c :: Enhancing text. (line 29)
5436 * C-c ;: Comment lines. (line 11)
5437 * C-c <: Creating timestamps. (line 25)
5438 * C-c <TAB>: Built-in table editor.
5440 * C-c =: Built-in table editor.
5442 * C-c >: Creating timestamps. (line 29)
5443 * C-c ? <1>: Editing/debugging formulas.
5445 * C-c ?: Built-in table editor.
5447 * C-c [: Agenda files. (line 12)
5448 * C-c \: Tag searches. (line 9)
5449 * C-c ]: Agenda files. (line 15)
5450 * C-c ^: Built-in table editor.
5452 * C-c `: Built-in table editor.
5454 * C-c a a: Weekly/Daily agenda. (line 9)
5455 * C-c a C: Storing searches. (line 9)
5456 * C-c a M: Matching headline tags.
5458 * C-c a m: Matching headline tags.
5460 * C-c a M: Tag searches. (line 14)
5461 * C-c a m: Tag searches. (line 10)
5462 * C-c a T: Global TODO list. (line 14)
5463 * C-c a t <1>: Global TODO list. (line 9)
5464 * C-c a t: TODO basics. (line 33)
5465 * C-c C-a: Visibility cycling. (line 31)
5466 * C-c C-b: Motion. (line 15)
5467 * C-c C-c <1>: The very busy C-c C-c key.
5469 * C-c C-c <2>: Processing LaTeX fragments.
5471 * C-c C-c <3>: Setting tags. (line 10)
5472 * C-c C-c <4>: Checkboxes. (line 37)
5473 * C-c C-c <5>: table.el. (line 6)
5474 * C-c C-c <6>: Editing/debugging formulas.
5476 * C-c C-c <7>: Built-in table editor.
5478 * C-c C-c: Plain lists. (line 74)
5479 * C-c C-d <1>: Agenda commands. (line 139)
5480 * C-c C-d: Creating timestamps. (line 37)
5481 * C-c C-e: Exporting. (line 19)
5482 * C-c C-e a: ASCII export. (line 9)
5483 * C-c C-e b: HTML export. (line 11)
5484 * C-c C-e c: iCalendar export. (line 20)
5485 * C-c C-e h: HTML export. (line 10)
5486 * C-c C-e I: iCalendar export. (line 15)
5487 * C-c C-e i: iCalendar export. (line 13)
5488 * C-c C-e t: Export options. (line 13)
5489 * C-c C-e v <1>: XOXO export. (line 11)
5490 * C-c C-e v: Sparse trees. (line 41)
5491 * C-c C-e v a: ASCII export. (line 13)
5492 * C-c C-e v b: HTML export. (line 14)
5493 * C-c C-e v h: HTML export. (line 14)
5494 * C-c C-e x: XOXO export. (line 10)
5495 * C-c C-f: Motion. (line 12)
5496 * C-c C-j: Motion. (line 21)
5497 * C-c C-l: Handling links. (line 27)
5498 * C-c C-n: Motion. (line 8)
5499 * C-c C-o <1>: Creating timestamps. (line 33)
5500 * C-c C-o: Handling links. (line 58)
5501 * C-c C-p: Motion. (line 9)
5502 * C-c C-q <1>: Editing/debugging formulas.
5504 * C-c C-q: Built-in table editor.
5506 * C-c C-s <1>: Agenda commands. (line 136)
5507 * C-c C-s: Creating timestamps. (line 48)
5508 * C-c C-t <1>: Clocking work time. (line 25)
5509 * C-c C-t: TODO basics. (line 13)
5510 * C-c C-u: Motion. (line 18)
5511 * C-c C-v: TODO basics. (line 26)
5512 * C-c C-w: Creating timestamps. (line 41)
5513 * C-c C-x C-a: ARCHIVE tag. (line 28)
5514 * C-c C-x C-b: Checkboxes. (line 38)
5515 * C-c C-x C-c: Agenda commands. (line 201)
5516 * C-c C-x C-d: Clocking work time. (line 33)
5517 * C-c C-x C-i: Clocking work time. (line 12)
5518 * C-c C-x C-k: Structure editing. (line 36)
5519 * C-c C-x C-l: Processing LaTeX fragments.
5521 * C-c C-x C-o: Clocking work time. (line 14)
5522 * C-c C-x C-r: Clocking work time. (line 40)
5523 * C-c C-x C-u: Dynamic blocks. (line 21)
5524 * C-c C-x C-w <1>: Built-in table editor.
5526 * C-c C-x C-w: Structure editing. (line 36)
5527 * C-c C-x C-x: Clocking work time. (line 29)
5528 * C-c C-x C-y <1>: Built-in table editor.
5530 * C-c C-x C-y: Structure editing. (line 43)
5531 * C-c C-x M-w <1>: Built-in table editor.
5533 * C-c C-x M-w: Structure editing. (line 40)
5534 * C-c C-y <1>: Clocking work time. (line 20)
5535 * C-c C-y: Creating timestamps. (line 66)
5536 * C-c l: Handling links. (line 9)
5537 * C-c {: CDLaTeX mode. (line 21)
5538 * C-c |: Built-in table editor.
5540 * C-c ~: table.el. (line 18)
5541 * C-TAB: ARCHIVE tag. (line 38)
5542 * C-u C-c $: Moving subtrees. (line 12)
5543 * C-u C-c .: Creating timestamps. (line 16)
5544 * C-u C-c =: Built-in table editor.
5546 * C-u C-c C-l: Handling links. (line 43)
5547 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
5548 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
5549 * C-u C-c C-x C-u: Clocking work time. (line 67)
5550 * D: Agenda commands. (line 68)
5551 * d: Agenda commands. (line 65)
5552 * f: Agenda commands. (line 44)
5553 * g: Agenda commands. (line 72)
5554 * H: Agenda commands. (line 198)
5555 * i: Agenda commands. (line 179)
5556 * I: Agenda commands. (line 159)
5557 * l: Agenda commands. (line 51)
5558 * L: Agenda commands. (line 32)
5559 * M: Agenda commands. (line 185)
5560 * M-<down>: Built-in table editor.
5562 * M-<left> <1>: Built-in table editor.
5564 * M-<left>: Structure editing. (line 18)
5565 * M-<RET> <1>: Plain lists. (line 42)
5566 * M-<RET>: Structure editing. (line 6)
5567 * M-<right> <1>: Built-in table editor.
5569 * M-<right>: Structure editing. (line 21)
5570 * M-<TAB> <1>: Completion. (line 10)
5571 * M-<TAB> <2>: Setting tags. (line 6)
5572 * M-<TAB>: Per file keywords. (line 17)
5573 * M-<up>: Built-in table editor.
5575 * M-S-<down> <1>: Built-in table editor.
5577 * M-S-<down> <2>: Plain lists. (line 59)
5578 * M-S-<down>: Structure editing. (line 33)
5579 * M-S-<left> <1>: The date/time prompt.
5581 * M-S-<left> <2>: Built-in table editor.
5583 * M-S-<left> <3>: Plain lists. (line 65)
5584 * M-S-<left>: Structure editing. (line 24)
5585 * M-S-<RET> <1>: Checkboxes. (line 52)
5586 * M-S-<RET> <2>: Plain lists. (line 52)
5587 * M-S-<RET>: Structure editing. (line 15)
5588 * M-S-<right> <1>: The date/time prompt.
5590 * M-S-<right> <2>: Built-in table editor.
5592 * M-S-<right> <3>: Plain lists. (line 65)
5593 * M-S-<right>: Structure editing. (line 27)
5594 * M-S-<up> <1>: Built-in table editor.
5596 * M-S-<up> <2>: Plain lists. (line 59)
5597 * M-S-<up>: Structure editing. (line 30)
5598 * mouse-1 <1>: Agenda commands. (line 35)
5599 * mouse-1 <2>: The date/time prompt.
5601 * mouse-1: Handling links. (line 72)
5602 * mouse-2 <1>: Agenda commands. (line 35)
5603 * mouse-2: Handling links. (line 72)
5604 * mouse-3 <1>: Agenda commands. (line 28)
5605 * mouse-3: Handling links. (line 77)
5606 * n: Agenda commands. (line 19)
5607 * O: Agenda commands. (line 161)
5608 * o: Agenda commands. (line 59)
5609 * P: Agenda commands. (line 123)
5610 * p: Agenda commands. (line 20)
5611 * q: Agenda commands. (line 208)
5612 * r <1>: Agenda commands. (line 76)
5613 * r: Global TODO list. (line 20)
5614 * S: Agenda commands. (line 189)
5615 * s: Agenda commands. (line 83)
5616 * S-<down> <1>: Agenda commands. (line 132)
5617 * S-<down> <2>: The date/time prompt.
5619 * S-<down> <3>: Creating timestamps. (line 58)
5620 * S-<down> <4>: Priorities. (line 25)
5621 * S-<down>: Plain lists. (line 55)
5622 * S-<left> <1>: Agenda commands. (line 150)
5623 * S-<left> <2>: The date/time prompt.
5625 * S-<left> <3>: Creating timestamps. (line 53)
5626 * S-<left>: TODO basics. (line 20)
5627 * S-<RET>: Built-in table editor.
5629 * S-<right> <1>: Agenda commands. (line 142)
5630 * S-<right> <2>: The date/time prompt.
5632 * S-<right> <3>: Creating timestamps. (line 53)
5633 * S-<right>: TODO basics. (line 20)
5634 * S-<TAB> <1>: Built-in table editor.
5636 * S-<TAB>: Visibility cycling. (line 22)
5637 * S-<up> <1>: Agenda commands. (line 126)
5638 * S-<up> <2>: The date/time prompt.
5640 * S-<up> <3>: Creating timestamps. (line 58)
5641 * S-<up> <4>: Priorities. (line 25)
5642 * S-<up>: Plain lists. (line 55)
5643 * T: Agenda commands. (line 107)
5644 * t: Agenda commands. (line 103)
5645 * w: Agenda commands. (line 62)
5646 * x: Agenda commands. (line 211)
5647 * X: Agenda commands. (line 164)
5653 Node: Introduction
\x7f10239
5654 Node: Summary
\x7f10654
5655 Node: Installation
\x7f12921
5656 Node: Activation
\x7f14299
5657 Node: Feedback
\x7f15548
5658 Node: Document structure
\x7f16317
5659 Node: Outlines
\x7f17091
5660 Node: Headlines
\x7f17751
5661 Node: Visibility cycling
\x7f18374
5662 Ref: Visibility cycling-Footnote-1
\x7f19849
5663 Ref: Visibility cycling-Footnote-2
\x7f19907
5664 Node: Motion
\x7f19957
5665 Node: Structure editing
\x7f20741
5666 Node: Archiving
\x7f22850
5667 Node: ARCHIVE tag
\x7f23408
5668 Node: Moving subtrees
\x7f25201
5669 Node: Sparse trees
\x7f26242
5670 Ref: Sparse trees-Footnote-1
\x7f28373
5671 Ref: Sparse trees-Footnote-2
\x7f28465
5672 Node: Plain lists
\x7f28580
5673 Ref: Plain lists-Footnote-1
\x7f32105
5674 Ref: Plain lists-Footnote-2
\x7f32462
5675 Node: Tables
\x7f32644
5676 Node: Built-in table editor
\x7f33192
5677 Node: Narrow columns
\x7f40800
5678 Ref: Narrow columns-Footnote-1
\x7f42739
5679 Node: Table calculations
\x7f42785
5680 Node: Formula syntax
\x7f44105
5681 Ref: Formula syntax-Footnote-1
\x7f47010
5682 Node: Lisp formulas
\x7f47310
5683 Node: Column formulas
\x7f48099
5684 Node: Advanced features
\x7f49861
5685 Node: Named-field formulas
\x7f53115
5686 Node: Editing/debugging formulas
\x7f53755
5687 Node: Appetizer
\x7f55513
5688 Node: orgtbl-mode
\x7f56616
5689 Node: table.el
\x7f57107
5690 Node: Hyperlinks
\x7f58084
5691 Node: Link format
\x7f58857
5692 Node: Internal links
\x7f60150
5693 Ref: Internal links-Footnote-1
\x7f62139
5694 Node: Radio targets
\x7f62271
5695 Node: CamelCase links
\x7f62986
5696 Node: External links
\x7f63580
5697 Node: Handling links
\x7f65711
5698 Ref: Handling links-Footnote-1
\x7f70363
5699 Ref: Handling links-Footnote-2
\x7f70600
5700 Node: Link abbreviations
\x7f70674
5701 Node: Search options
\x7f72353
5702 Ref: Search options-Footnote-1
\x7f74131
5703 Node: Custom searches
\x7f74212
5704 Node: Remember
\x7f75260
5705 Node: TODO items
\x7f78950
5706 Node: TODO basics
\x7f79932
5707 Node: TODO extensions
\x7f81459
5708 Node: Workflow states
\x7f82254
5709 Node: TODO types
\x7f83122
5710 Ref: TODO types-Footnote-1
\x7f84780
5711 Node: Per file keywords
\x7f84862
5712 Ref: Per file keywords-Footnote-1
\x7f86316
5713 Node: Priorities
\x7f86517
5714 Node: Breaking down tasks
\x7f87761
5715 Ref: Breaking down tasks-Footnote-1
\x7f88281
5716 Node: Checkboxes
\x7f88377
5717 Node: Timestamps
\x7f91113
5718 Node: Time stamps
\x7f91503
5719 Node: Creating timestamps
\x7f94600
5720 Node: The date/time prompt
\x7f97143
5721 Ref: The date/time prompt-Footnote-1
\x7f98827
5722 Node: Progress logging
\x7f98933
5723 Node: Closing items
\x7f99463
5724 Node: Clocking work time
\x7f100367
5725 Ref: Clocking work time-Footnote-1
\x7f103930
5726 Node: Tags
\x7f104056
5727 Node: Tag inheritance
\x7f104818
5728 Node: Setting tags
\x7f105755
5729 Ref: Setting tags-Footnote-1
\x7f108887
5730 Ref: Setting tags-Footnote-2
\x7f108999
5731 Node: Tag searches
\x7f109079
5732 Node: Agenda views
\x7f110288
5733 Node: Agenda files
\x7f112381
5734 Ref: Agenda files-Footnote-1
\x7f113341
5735 Ref: Agenda files-Footnote-2
\x7f113490
5736 Node: Agenda dispatcher
\x7f113683
5737 Node: Weekly/Daily agenda
\x7f115300
5738 Node: Calendar/Diary integration
\x7f116265
5739 Node: Global TODO list
\x7f117603
5740 Node: Matching headline tags
\x7f119655
5741 Node: Timeline
\x7f120599
5742 Node: Presentation and sorting
\x7f121262
5743 Node: Categories
\x7f122040
5744 Node: Time-of-day specifications
\x7f122704
5745 Node: Sorting of agenda items
\x7f124682
5746 Node: Agenda commands
\x7f125964
5747 Node: Custom agenda views
\x7f131852
5748 Node: Storing searches
\x7f132527
5749 Node: Block agenda
\x7f134439
5750 Node: Setting Options
\x7f135669
5751 Node: Batch processing
\x7f138381
5752 Node: Embedded LaTeX
\x7f139511
5753 Ref: Embedded LaTeX-Footnote-1
\x7f140603
5754 Node: Math symbols
\x7f140793
5755 Node: Subscripts and Superscripts
\x7f141558
5756 Node: LaTeX fragments
\x7f142402
5757 Ref: LaTeX fragments-Footnote-1
\x7f144510
5758 Node: Processing LaTeX fragments
\x7f144772
5759 Node: CDLaTeX mode
\x7f145718
5760 Ref: CDLaTeX mode-Footnote-1
\x7f148202
5761 Node: Exporting
\x7f148350
5762 Node: ASCII export
\x7f149664
5763 Node: HTML export
\x7f150954
5764 Node: XOXO export
\x7f153790
5765 Node: iCalendar export
\x7f154229
5766 Node: Text interpretation
\x7f156052
5767 Node: Comment lines
\x7f156531
5768 Node: Enhancing text
\x7f157002
5769 Node: Export options
\x7f158694
5770 Node: Publishing
\x7f160361
5771 Ref: Publishing-Footnote-1
\x7f161157
5772 Node: Configuration
\x7f161353
5773 Node: Project alist
\x7f162071
5774 Node: Sources and destinations
\x7f163137
5775 Node: Selecting files
\x7f163867
5776 Node: Publishing action
\x7f164615
5777 Node: Publishing options
\x7f165848
5778 Node: Publishing links
\x7f168000
5779 Node: Project page index
\x7f169513
5780 Node: Sample configuration
\x7f170291
5781 Node: Simple example
\x7f170783
5782 Node: Complex example
\x7f171456
5783 Node: Triggering publication
\x7f173532
5784 Node: Miscellaneous
\x7f174217
5785 Node: Completion
\x7f174851
5786 Node: Customization
\x7f176322
5787 Node: In-buffer settings
\x7f176907
5788 Node: The very busy C-c C-c key
\x7f180328
5789 Node: Clean view
\x7f181972
5790 Node: TTY keys
\x7f184549
5791 Node: Interaction
\x7f186158
5792 Node: Cooperation
\x7f186555
5793 Node: Conflicts
\x7f188422
5794 Node: Bugs
\x7f190014
5795 Node: Extensions and Hacking
\x7f191637
5796 Node: Extensions
\x7f192123
5797 Node: Dynamic blocks
\x7f193693
5798 Node: History and Acknowledgments
\x7f195620
5799 Node: Index
\x7f200628
5800 Node: Key Index
\x7f227059