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.50).
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.50).
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 * Search options:: Linking to a specific location
115 * Custom searches:: When the default search is not enough
116 * Remember:: Org-trees store quick notes
120 * Radio targets:: Make targets trigger links in plain text.
121 * CamelCase links:: Activating CamelCase words as links
125 * TODO basics:: Marking and displaying TODO entries
126 * TODO extensions:: Workflow and assignments
127 * Priorities:: Some things are more important than others
128 * Breaking down tasks:: Splitting a task into managable pieces
129 * Checkboxes:: Tick-off lists
131 Extended use of TODO keywords
133 * Workflow states:: From TODO to DONE in steps
134 * TODO types:: I do this, Fred the rest
135 * Per file keywords:: Different files, different requirements
139 * Time stamps:: Assigning a time to a tree entry
140 * Creating timestamps:: Commands which insert timestamps
141 * Progress logging:: Documenting when what work was done.
145 * Closing items:: When was this entry marked DONE?
146 * Clocking work time:: When exactly did you work on this item?
150 * Tag inheritance:: Tags use the tree structure of the outline
151 * Setting tags:: How to assign tags to a headline
152 * Tag searches:: Searching for combinations of tags
156 * Agenda files:: Files being searched for agenda information
157 * Agenda dispatcher:: Keyboard access to agenda views
158 * Weekly/Daily agenda:: The calendar page with current tasks
159 * Global TODO list:: All unfinished action items
160 * Matching headline tags:: Structured information with fine-tuned search
161 * Timeline:: Time-sorted view for single file
162 * Presentation and sorting:: How agenda items are prepared for display
163 * Agenda commands:: Remote editing of org trees
164 * Custom agenda views:: Defining special searches and views
166 The weekly/daily agenda
168 * Calendar/Diary integration:: Integrating Anniversaries and more
170 Presentation and sorting
172 * Categories:: Not all tasks are equal
173 * Time-of-day specifications:: How the agenda knows the time
174 * Sorting of agenda items:: The order of things
178 * Storing searches:: Type once, use often
179 * Block agenda:: All the stuff you need in a single buffer
180 * Setting Options:: Changing the rules
181 * Batch processing:: Agenda views from the command line
185 * Math symbols:: TeX macros for symbols and Greek letters
186 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
187 * LaTeX fragments:: Complex formulas made easy
188 * Processing LaTeX fragments:: Previewing LaTeX processing
189 * CDLaTeX mode:: Speed up entering of formulas
193 * ASCII export:: Exporting to plain ASCII
194 * HTML export:: Exporting to HTML
195 * XOXO export:: Exporting to XOXO
196 * iCalendar export:: Exporting in iCalendar format
197 * Text interpretation:: How the exporter looks at the file
199 Text interpretation by the exporter
201 * Comment lines:: Some lines will not be exported
202 * Enhancing text:: Subscripts, symbols and more
203 * Export options:: How to influence the export settings
207 * Configuration:: Defining projects
208 * Sample configuration:: Example projects
209 * Triggering publication:: Publication commands
213 * Project alist:: The central configuration variable
214 * Sources and destinations:: From here to there
215 * Selecting files:: What files are part of the project?
216 * Publishing action:: Setting the function doing the publishing
217 * Publishing options:: Tweaking HTML export
218 * Publishing links:: Which links keep working after publishing?
219 * Project page index:: Publishing a list of project files
223 * Simple example:: One-component publishing
224 * Complex example:: A multi-component publishing example
228 * Completion:: M-TAB knows what you need
229 * Customization:: Adapting Org-mode to your taste
230 * In-buffer settings:: Overview of the #+KEYWORDS
231 * The very busy C-c C-c key:: When in doubt, press C-c C-c
232 * Clean view:: Getting rid of leading stars in the outline
233 * TTY keys:: Using Org-mode on a tty
234 * Interaction:: Other Emacs packages
235 * Bugs:: Things which do not work perfectly
237 Interaction with other packages
239 * Cooperation:: Packages Org-mode cooperates with
240 * Conflicts:: Packages that lead to conflicts
242 Extensions, Hooks and Hacking
244 * Extensions:: Existing 3rd-part extensions
245 * Dynamic blocks:: Automatically filled blocks
248 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
255 * Summary:: Brief summary of what Org-mode does
256 * Installation:: How to install a downloaded version of Org-mode
257 * Activation:: How to activate Org-mode for certain buffers.
258 * Feedback:: Bug reports, ideas, patches etc.
261 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
266 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
267 project planning with a fast and effective plain-text system.
269 Org-mode develops organizational tasks around NOTES files that
270 contain information about projects as plain text. Org-mode is
271 implemented on top of outline-mode, which makes it possible to keep the
272 content of large files well structured. Visibility cycling and
273 structure editing help to work with the tree. Tables are easily
274 created with a built-in table editor. Org-mode supports ToDo items,
275 deadlines, time stamps, and scheduling. It dynamically compiles
276 entries into an agenda that utilizes and smoothly integrates much of
277 the Emacs calendar and diary. Plain text URL-like links connect to
278 websites, emails, Usenet messages, BBDB entries, and any files related
279 to the projects. For printing and sharing of notes, an Org-mode file
280 can be exported as a structured ASCII file, as HTML, or (todo and
281 agenda items only) as an iCalendar file. It can also serve as a
282 publishing tool for a set of linked webpages.
284 Org-mode keeps simple things simple. When first fired up, it should
285 feel like a straightforward, easy to use outliner. Complexity is not
286 imposed, but a large amount of functionality is available when you need
287 it. Org-mode can be used on different levels and in different ways, for
290 * as an outline extension with visibility cycling and structure editing
291 * as an ASCII system and table editor for taking structured notes
292 * as an ASCII table editor with spreadsheet-like capabilities
293 * as a TODO list editor
294 * as a full agenda and planner with deadlines and work scheduling
295 * as a simple hypertext system, with HTML export
296 * as a publishing tool to create a set of interlinked webpages
298 The Org-mode table editor can be integrated into any major mode by
299 activating the minor Orgtbl-mode.
301 There is a website for Org-mode which provides links to the newest
302 version of Org-mode, as well as additional information, frequently asked
303 questions (FAQ), links to tutorials etc. This page is located at
304 `http://www.astro.uva.nl/~dominik/Tools/org/'.
307 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
312 Important: If Org-mode is part of the Emacs distribution or an XEmacs
313 package, please skip this section and go directly to *Note Activation::.
315 If you have downloaded Org-mode from the Web, you must take the
316 following steps to install it: Go into the Org-mode distribution
317 directory and edit the top section of the file `Makefile'. You must
318 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
319 and the paths to the directories where local Lisp and Info files are
320 kept. If you don't have access to the system-wide directories, create
321 your own two directories for these files, enter them into the Makefile,
322 and make sure Emacs finds the Lisp files by adding the following line
325 (setq load-path (cons "~/path/to/lispdir" load-path))
327 XEmacs users now need to install the file `noutline.el' from the
328 `xemacs' subdirectory of the Org-mode distribution. Use the command:
330 make install-noutline
332 Now byte-compile and install the Lisp files with the shell commands:
337 If you want to install the info documentation, use this command:
341 Then add to `.emacs':
343 ;; This line only if org-mode is not part of the X/Emacs distribution.
344 (require 'org-install)
347 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
352 Add the following lines to your `.emacs' file. The last two lines
353 define _global_ keys for the commands `org-store-link' and `org-agenda'
354 - please choose suitable keys yourself.
356 ;; The following lines are always needed. Choose your own keys.
357 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
358 (define-key global-map "\C-cl" 'org-store-link)
359 (define-key global-map "\C-ca" 'org-agenda)
361 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
362 because significant functionality depends on font-locking being active.
363 You can do this with either one of the following two lines (XEmacs
364 user must use the second option):
365 (global-font-lock-mode 1) ; for all buffers
366 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
368 With this setup, all files with extension `.org' will be put into
369 Org-mode. As an alternative, make the first line of a file look like
372 MY PROJECTS -*- mode: org; -*-
374 which will select Org-mode for this buffer no matter what the file's
375 name is. See also the variable `org-insert-mode-line-in-empty-file'.
378 File: org, Node: Feedback, Prev: Activation, Up: Introduction
383 If you find problems with Org-mode, or if you have questions, remarks,
384 or ideas about it, please contact the maintainer Carsten Dominik at
385 <dominik@science.uva.nl>.
387 For bug reports, please provide as much information as possible,
388 including the version information of Emacs (`C-h v emacs-version
389 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
390 Org-mode related setup in `.emacs'. If an error occurs, a traceback
391 can be very useful. Often a small example file helps, along with clear
394 1. What exactly did you do?
396 2. What did you expect to happen?
398 3. What happened instead?
399 Thank you for helping to improve this mode.
402 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
407 Org-mode is based on outline mode and provides flexible commands to
408 edit the structure of the document.
412 * Outlines:: Org-mode is based on outline-mode
413 * Headlines:: How to typeset org-tree headlines
414 * Visibility cycling:: Show and hide, much simplified
415 * Motion:: Jumping to other headlines
416 * Structure editing:: Changing sequence and level of headlines
417 * Archiving:: Move done task trees to a different place
418 * Sparse trees:: Matches embedded in context
419 * Plain lists:: Additional structure within an entry
422 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
427 Org-mode is implemented on top of outline-mode. Outlines allow to
428 organize a document in a hierarchical structure, which (at least for
429 me) is the best representation of notes and thoughts. Overview over
430 this structure is achieved by folding (hiding) large parts of the
431 document to show only the general document structure and the parts
432 currently being worked on. Org-mode greatly simplifies the use of
433 outlines by compressing the entire show/hide functionality into a
434 single command `org-cycle', which is bound to the <TAB> key.
437 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
442 Headlines define the structure of an outline tree. The headlines in
443 Org-mode start with one or more stars, on the left margin. For example:
451 * Another top level headline
453 Some people find the many stars too noisy and would prefer an outline
454 that has whitespace followed by a single star as headline starters.
455 *Note Clean view:: describes a setup to realize this.
458 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
460 2.3 Visibility cycling
461 ======================
463 Outlines make it possible to hide parts of the text in the buffer.
464 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
465 the visibility in the buffer.
468 _Subtree cycling_: Rotate current subtree between the states
470 ,-> FOLDED -> CHILDREN -> SUBTREE --.
471 '-----------------------------------'
473 The cursor must be on a headline for this to work(1). When the
474 cursor is at the beginning of the buffer and the first line is not
475 a headline, then <TAB> actually runs global cycling (see
476 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
477 global cycling is invoked.
481 _Global cycling_: Rotate the entire buffer between the states
483 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
484 '--------------------------------------'
486 Note that inside tables, `S-<TAB>' jumps to the previous field.
491 When Emacs first visits an Org-mode file, the global state is set to
492 OVERVIEW, i.e. only the top level headlines are visible. This can be
493 configured through the variable `org-startup-folded', or on a per-file
494 basis by adding one of the following lines anywhere in the buffer:
500 ---------- Footnotes ----------
502 (1) see, however, the option `org-cycle-emulate-tab'.
504 (2) see the option `org-cycle-global-at-bob'.
507 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
512 The following commands jump to other headlines in the buffer.
521 Next heading same level.
524 Previous heading same level.
527 Backward to higher level heading.
530 Jump to a different place without changing the current outline
531 visibility. Shows the document structure in a temporary buffer,
532 where you can use visibility cycling (<TAB>) to find your
533 destination. After pressing <RET>, the cursor moves to the
534 selected location in the original buffer, and the headings
535 hierarchy above it is made visible.
538 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
540 2.5 Structure editing
541 =====================
544 Insert new heading with same level as current. If the cursor is
545 in a plain list item, a new item is created (*note Plain lists::).
546 To force creation of a new headline, use a prefix arg, or first
547 press <RET> to get to the beginning of the next line. When this
548 command is used in the middle of a line, the line is split and the
549 rest of the line becomes the new headline. If the command is used
550 at the beginning of a headline, the new headline is created before
551 the current line. If at the beginning of any other line, the
552 content of that line is made the new heading.
555 Insert new TODO entry with same level as current heading.
558 Promote current heading by one level.
561 Demote current heading by one level.
564 Promote the current subtree by one level.
567 Demote the current subtree by one level.
570 Move subtree up (swap with previous subtree of same level).
573 Move subtree down (swap with next subtree of same level).
577 Kill subtree, i.e. remove it from buffer but save in kill ring.
580 Copy subtree to kill ring.
583 Yank subtree from kill ring. This does modify the level of the
584 subtree to make sure the tree fits in nicely at the yank position.
585 The yank level can also be specified with a prefix arg, or by
586 yanking after a headline marker like `****'.
588 When there is an active region (transient-mark-mode), promotion and
589 demotion work on all headlines in the region. To select a region of
590 headlines, it is best to place both point and mark at the beginning of a
591 line, mark at the beginning of the first headline, and point at the line
592 just after the last headline to change. Note that when the cursor is
593 inside a table (*note Tables::), the Meta-Cursor keys have different
597 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
602 When a project represented by a (sub)tree is finished, you may want to
603 move the tree out of the way and to stop it from contributing to the
604 agenda. Org-mode knows two ways of archiving. You can mark a tree with
605 the ARCHIVE tag, or you can move an entire (sub)tree to a different
610 * ARCHIVE tag:: Marking a tree as inactive
611 * Moving subtrees:: Moving a tree to an archive file
614 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
616 2.6.1 The ARCHIVE tag
617 ---------------------
619 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
620 its location in the outline tree, but behaves in the following way:
621 - It does not open when you attempt to do so with a visibility
622 cycling command (*note Visibility cycling::). You can force
623 cycling archived subtrees with `C-<TAB>', or by setting the option
624 `org-cycle-open-archived-trees'. Also normal outline commands like
625 `show-all' will open archived subtrees.
627 - During sparse tree construction (*note Sparse trees::), matches in
628 archived subtrees are not exposed, unless you configure the option
629 `org-sparse-tree-open-archived-trees'.
631 - During agenda view construction (*note Agenda views::), the
632 content of archived trees is ignored unless you configure the
633 option `org-agenda-skip-archived-trees'.
635 - Archived trees are not exported (*note Exporting::), only the
636 headline is. Configure the details using the variable
637 `org-export-with-archived-trees'.
639 The following commands help managing the ARCHIVE tag:
642 Toggle the ARCHIVE tag for the current headline. When the tag is
643 set, the headline changes to a shadowish face, and the subtree
647 Check if any direct children of the current headline should be
648 archived. To do this, each subtree is checked for open TODO
649 entries. If none are found, the command offers to set the ARCHIVE
650 tag for the child. If the cursor is _not_ on a headline when this
651 command is invoked, the level 1 trees will be checked.
654 Cycle a tree even if it is tagged with ARCHIVE.
657 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
659 2.6.2 Moving subtrees
660 ---------------------
662 Once an entire project is finished, you may want to move it to a
663 different location, either in the current file, or even in a different
664 file, the archive file.
667 Archive the subtree starting at the cursor position to the location
668 given by `org-archive-location'.
671 Check if any direct children of the current headline could be
672 moved to the archive. To do this, each subtree is checked for
673 open TODO entries. If none are found, the command offers to move
674 it to the archive location. If the cursor is _not_ on a headline
675 when this command is invoked, the level 1 trees will be checked.
677 The default archive location is a file in the same directory as the
678 current file, with the name derived by appending `_archive' to the
679 current file name. For information and examples on how to change this,
680 see the documentation string of the variable `org-archive-location'.
683 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
688 An important feature of Org-mode is the ability to construct _sparse
689 trees_ for selected information in an outline tree. A sparse tree
690 means that the entire document is folded as much as possible, but the
691 selected information is made visible along with the headline structure
692 above it(1). Just try it out and you will see immediately how it works.
694 Org-mode contains several commands creating such trees. The most
695 basic one is `org-occur':
698 Occur. Prompts for a regexp and shows a sparse tree with all
699 matches. If the match is in a headline, the headline is made
700 visible. If the match is in the body of an entry, headline and
701 body are made visible. In order to provide minimal context, also
702 the full hierarchy of headlines above the match is shown, as well
703 as the headline following the match. Each match is also
704 highlighted; the highlights disappear when the bufer is changes an
705 editing command, or by pressing `C-c C-c'. When called with a
706 `C-u' prefix argument, previous highlights are kept, so several
707 calls to this command can be stacked.
708 For frequently used sparse trees of specific search strings, you can
709 use the variable `org-agenda-custom-commands' to define fast keyboard
710 access to specific sparse trees. These commands will then be
711 accessible through the agenda dispatcher (*note Agenda dispatcher::).
714 (setq org-agenda-custom-commands
715 '(("f" occur-tree "FIXME")))
717 will define the key `C-c a f' as a shortcut for creating a sparse tree
718 matching the string `FIXME'.
720 Other commands use sparse trees as well. For example `C-c C-v'
721 creates a sparse TODO tree (*note TODO basics::).
723 To print a sparse tree, you can use the Emacs command
724 `ps-print-buffer-with-faces' which does not print invisible parts of
725 the document (2). Or you can use the command `C-c C-e v' to export
726 only the visible part of the document and print the resulting file.
728 ---------- Footnotes ----------
730 (1) See also the variables `org-show-hierarchy-above' and
731 `org-show-following-heading'.
733 (2) This does not work under XEmacs, because XEmacs uses selective
734 display for outlining, not text properties.
737 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
742 Within an entry of the outline tree, hand-formatted lists can provide
743 additional structure. They also provide a way to create lists of
744 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
745 and the HTML exporter (*note Exporting::) does parse and format them.
747 Org-mode knows ordered and unordered lists. Unordered list items
748 start with `-', `+', or `*'(1) as bullets. Ordered list items start
749 with `1.' or `1)'. Items belonging to the same list must have the same
750 indentation on the first line. In particular, if an ordered list
751 reaches number `10.', then the 2-digit numbers must be written
752 left-aligned with the other numbers in the list. Indentation also
753 determines the end of a list item. It ends before the next line that
754 is indented like the bullet/number, or less. For example:
757 My favorite scenes are (in this order)
758 1. The attack of the Rohirrim
759 2. Eowyns fight with the witch king
760 + this was already my favorite scene in the book
761 + I really like Miranda Otto.
762 3. Peter Jackson being shot by Legolas
764 He makes a really funny face when it happens.
765 But in the end, not individual scenes matter but the film as a whole.
767 Org-mode supports these lists by tuning filling and wrapping
768 commands to deal with them correctly(2).
770 The following commands act on items when the cursor is in the first
771 line of an item (the line with the bullet or number).
774 Items can be folded just like headline levels if you set the
775 variable `org-cycle-include-plain-lists'. The level of an item is
776 then given by the indentation of the bullet/number. Items are
777 always subordinate to real headlines, however; the hierarchies
778 remain completely separated.
781 Insert new item at current level. With prefix arg, force a new
782 heading (*note Structure editing::). If this command is used in
783 the middle of a line, the line is _split_ and the rest of the line
784 becomes the new item. If this command is executed in the
785 _whitespace before a bullet or number_, the new item is created
786 _before_ the current item. If the command is executed in the
787 white space before the text that is part of an item but does not
788 contain the bullet, a bullet is added to the current line.
791 Insert a new item with a checkbox (*note Checkboxes::).
795 Jump to the previous/next item in the current list.
799 Move the item including subitems up/down (swap with previous/next
800 item of same indentation). If the list is ordered, renumbering is
805 Decrease/increase the indentation of the item, including subitems.
806 Initially, the item tree is selected based on current indentation.
807 When these commands are executed several times in direct
808 succession, the initially selected region is used, even if the new
809 indentation would imply a different hierarchy. To use the new
810 hierarchy, break the command chain with a cursor motion or so.
813 If there is a checkbox (*note Checkboxes::) in the item line,
814 toggle the state of the checkbox. Otherwise, if this is an
815 ordered list, renumber the ordered list at the cursor.
817 ---------- Footnotes ----------
819 (1) When using `*' as a bullet, lines must be indented or they will
820 be seen as top-level headlines. Also, when you are hiding leading
821 stars to get a clean outline view, plain list items starting with a
822 star are visually indistinguishable from true headlines. In short:
823 even though `*' is supported, it may be better not to use it for plain
826 (2) Org-mode only changes the filling settings for Emacs. For
827 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn is on,
832 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
837 Org-mode has a very fast and intuitive table editor built-in.
838 Spreadsheet-like calculations are supported in connection with the
839 Emacs `calc' package.
843 * Built-in table editor:: Simple tables
844 * Narrow columns:: Stop wasting space in tables
845 * Table calculations:: Compute a field from other fields
846 * orgtbl-mode:: The table editor as minor mode
847 * table.el:: Complex tables
850 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
852 3.1 The built-in table editor
853 =============================
855 Org-mode makes it easy to format tables in plain ASCII. Any line with
856 `|' as the first non-white character is considered part of a table.
857 `|' is also the column separator. A table might look like this:
859 | Name | Phone | Age |
860 |-------+-------+-----|
861 | Peter | 1234 | 17 |
864 A table is re-aligned automatically each time you press <TAB> or
865 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
866 field (<RET> to the next row) and creates new table rows at the end of
867 the table or before horizontal lines. The indentation of the table is
868 set by the first line. Any line starting with `|-' is considered as a
869 horizontal separator line and will be expanded on the next re-align to
870 span the whole table width. So, to create the above table, you would
876 and then press <TAB> to align the table and start filling in fields.
878 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
879 and all character keys in a special way, so that inserting and deleting
880 avoids shifting other fields. Also, when typing _immediately after the
881 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
882 the field is automatically made blank. If this behavior is too
883 unpredictable for you, configure the variables
884 `org-enable-table-editor' and `org-table-auto-blank-field'.
886 Creation and conversion
887 .......................
890 Convert the active region to table. If every line contains at
891 least one TAB character, the function assumes that the material is
892 tab separated. If not, lines are split at whitespace into fields.
893 You can use a prefix argument to indicate the minimum number of
894 consecutive spaces required to identify a field separator
896 If there is no active region, this command creates an empty
897 Org-mode table. But it's easier just to start typing, like
898 `|Name|Phone|Age <RET> |- <TAB>'.
900 Re-aligning and field motion
901 ............................
904 Re-align the table without moving the cursor.
907 Re-align the table, move to the next field. Creates a new row if
911 Re-align, move to previous field.
914 Re-align the table and move down to next row. Creates a new row if
915 necessary. At the beginning or end of a line, <RET> still does
916 NEWLINE, so it can be used to split a table.
918 Column and row editing
919 ......................
923 Move the current column left/right.
926 Kill the current column.
929 Insert a new column to the left of the cursor position.
933 Move the current row up/down.
936 Kill the current row or horizontal line.
939 Insert a new row above (with arg: below) the current row.
942 Insert a horizontal line below current row. With prefix arg, the
943 line is created above the current line.
946 Sort the table lines in the region. Point and mark must be in the
947 first and last line to be included, and must be in the column that
948 should be used for sorting. The command prompts for numerical
949 versus alphanumerical sorting.
955 Copy a rectangular region from a table to a special clipboard.
956 Point and mark determine edge fields of the rectangle. The
957 process ignores horizontal separator lines.
960 Copy a rectangular region from a table to a special clipboard, and
961 blank all fields in the rectangle. So this is the "cut" operation.
964 Paste a rectangular region into a table. The upper right corner
965 ends up in the current field. All involved fields will be
966 overwritten. If the rectangle does not fit into the present table,
967 the table is enlarged as needed. The process ignores horizontal
971 Wrap several fields in a column like a paragraph. If there is an
972 active region, and both point and mark are in the same column, the
973 text in the column is wrapped to minimum width for the given
974 number of lines. A prefix ARG may be used to change the number of
975 desired lines. If there is no region, the current field is split
976 at the cursor position and the text fragment to the right of the
977 cursor is prepended to the field one line down. If there is no
978 region, but you specify a prefix ARG, the current field is made
979 blank, and the content is appended to the field above.
985 Install a new formula for the current column and replace current
986 field with the result of the formula.
989 Install a new formula for the current field, which must be a named
990 field. Evaluate the formula and replace the field content with the
994 Edit all formulas associated with the current table in a separate
998 Recalculate the current row by applying the stored formulas from
999 left to right. When called with a `C-u' prefix, recalculate the
1000 entire table, starting with the first non-header line (i.e. below
1001 the first horizontal separator line). For details, see *Note
1002 Table calculations::.
1005 Rotate the calculation mark in first column through the states `',
1006 `#', `*', `!', `$'. For the meaning of these marks see *Note
1007 Advanced features::. When there is an active region, change all
1008 marks in the region.
1011 Which table column is the cursor in? Displays number >0 in echo
1015 Sum the numbers in the current column, or in the rectangle defined
1016 by the active region. The result is shown in the echo area and can
1017 be inserted with `C-y'.
1020 When current field is empty, copy from first non-empty field above.
1021 When not empty, copy current field down to next row and move cursor
1022 along with it. Depending on the variable
1023 `org-table-copy-increment', integer field values will be
1024 incremented during copy. This key is also used by CUA-mode (*note
1031 Edit the current field in a separate window. This is useful for
1032 fields that are not fully visible (*note Narrow columns::). When
1033 called with a `C-u' prefix, just make the full field visible, so
1034 that it can be edited in place.
1037 This is an alias for `C-u C-c `' to make the current field fully
1040 `M-x org-table-import'
1041 Import a file as a table. The table should be TAB- or whitespace
1042 separated. Useful, for example, to import an Excel table or data
1043 from a database, because these programs generally can write
1044 TAB-separated text files. This command works by inserting the
1045 file into the buffer and then converting the region to a table.
1046 Any prefix argument is passed on to the converter, which uses it
1047 to determine the separator.
1049 `M-x org-table-export'
1050 Export the table as a TAB-separated file. Useful for data
1051 exchange with, for example, Excel or database programs.
1054 If you don't like the automatic table editor because it gets in your
1055 way on lines which you would like to start with `|', you can turn it
1058 (setq org-enable-table-editor nil)
1060 Then the only table command that still works is `C-c C-c' to do a
1064 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
1069 The width of columns is automatically determined by the table editor.
1070 Sometimes a single field or a few fields need to carry more text,
1071 leading to inconveniently wide columns. To limit(1) the width of a
1072 column, one field anywhere in the column may contain just the string
1073 `<N>' where `N' is an integer specifying the width of the column in
1074 characters. The next re-align will then set the width of this column
1075 to no more than this value.
1077 |---+------------------------------| |---+--------|
1079 | 1 | one | | 1 | one |
1080 | 2 | two | ----\ | 2 | two |
1081 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1082 | 4 | four | | 4 | four |
1083 |---+------------------------------| |---+--------|
1085 Fields that are wider become clipped and end in the string `=>'. Note
1086 that the full text is still in the buffer, it is only invisible. To
1087 see the full text, hold the mouse over the field - a tooltip window
1088 will show the full content. To edit such a field, use the command `C-c
1089 `' (that is `C-c' followed by the backquote). This will open a new
1090 window with the full field. Edit it and finish with `C-c C-c'.
1092 When visiting a file containing a table with narrowed columns, the
1093 necessary character hiding has not yet happened, and the table needs to
1094 be aligned before it looks nice. Setting the option
1095 `org-startup-align-all-tables' will realign all tables in a file upon
1096 visiting, but also slow down startup. You can also set this option on
1097 a per-file basis with:
1102 ---------- Footnotes ----------
1104 (1) This feature does not work on XEmacs.
1107 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1109 3.3 Calculations in tables
1110 ==========================
1112 The table editor makes use of the Emacs `calc' package to implement
1113 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1114 derive fields from other fields. Org-mode has two levels of complexity
1115 for table calculations. On the basic level, tables do only horizontal
1116 computations, so a field can be computed from other fields _in the same
1117 row_, and Org-mode assumes that there is only one formula for each
1118 column. This is very efficient to work with and enough for many tasks.
1119 On the complex level, columns and individual fields can be named for
1120 easier referencing in formulas, individual named fields can have their
1121 own formula associated with them, and recalculation can be automated.
1125 * Formula syntax:: How to write a formula
1126 * Lisp formulas:: An alternative way to write formulas
1127 * Column formulas:: Formulas valid for all fields in a column
1128 * Advanced features:: Field names, parameters and automatic recalc
1129 * Named-field formulas:: Formulas valid in single fields
1130 * Editing/debugging formulas:: Changing a stored formula
1131 * Appetizer:: Taste the power of calc
1134 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1136 3.3.1 Formula syntax
1137 --------------------
1139 A formula can be any algebraic expression understood by the Emacs
1140 `calc' package. Note that `calc' has the slightly non-standard
1141 convention that `/' has lower precedence than `*', so that `a/b*c' is
1142 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1143 calc-eval: (calc)Calling Calc from Your Programs.), variable
1144 substitution takes place:
1146 $ refers to the current field
1147 $3 refers to the field in column 3 of the current row
1148 $3..$7 a vector of the fields in columns 3-7 of current row
1149 $P1..$P3 vector of column range, using column names
1150 &2 second data field above the current, in same column
1151 &5-2 vector from fifth to second field above current
1152 &III-II vector of fields between 2nd and 3rd hline above
1153 &III vector of fields between third hline above and current field
1154 $name a named field, parameter or constant
1156 The range vectors can be directly fed into the calc vector functions
1157 like `vmean' and `vsum'.
1159 `$name' is interpreted as the name of a column, parameter or
1160 constant. Constants are defined globally through the variable
1161 `org-table-formula-constants'. If you have the `constants.el' package,
1162 it will also be used to resolve constants, including natural constants
1163 like `$h' for Planck's constant, and units like `$km' for kilometers.
1164 Column names and parameters can be specified in special table lines.
1165 These are described below, see *Note Advanced features::.
1167 A formula can contain an optional mode string after a semicolon.
1168 This string consists of flags to influence calc's modes(1) during
1169 execution, e.g. `p20' to switch the internal precision to 20 digits,
1170 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1171 or fixed display format, respectively, and `D', `R', `F', and `S' to
1172 turn on degrees, radians, fraction and symbolic modes, respectively.
1173 In addition, you may provide a `printf' format specifier to reformat
1174 the final result. A few examples:
1176 $1+$2 Sum of first and second field
1177 $1+$2;%.2f Same, format result to two decimals
1178 exp($2)+exp($1) Math functions can be used
1179 $;%.1f Reformat current cell to 1 decimal
1180 ($3-32)*5/9 Degrees F -> C conversion
1181 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1182 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1183 sin($1);Dp3%.1e Same, but use printf specifier for display
1184 vmean($2..$7) Compute column range mean, using vector function
1185 vsum(&III) Sum numbers from 3rd hline above, up to here
1186 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1188 ---------- Footnotes ----------
1190 (1) By default, Org-mode uses the standard calc modes (precision 12,
1191 angular units degrees, fraction and symbolic modes off). The display
1192 format, however, has been changed to `(float 5)' to keep tables compact.
1193 The default settings can be configured using the variable
1194 `org-calc-default-modes'.
1197 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1199 3.3.2 Emacs Lisp forms as formulas
1200 ----------------------------------
1202 It is also possible to write a formula in Emacs lisp; this can be useful
1203 for string manipulation and control structures. If a formula starts
1204 with a single quote followed by an opening parenthesis, then it is
1205 evaluated as a lisp form. The evaluation should return either a string
1206 or a number. Just as with `calc' formulas, you can provide a format
1207 specifier after a semicolon. A few examples:
1209 swap the first two characters of the content of column 1
1210 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1211 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1215 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1217 3.3.3 Column formulas
1218 ---------------------
1220 To apply a formula to a field, type it directly into the field,
1221 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1222 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1223 be stored as the formula for the current column, evaluated and the
1224 current field replaced with the result. If the field contains only
1225 `=', the previously stored formula for this column is used.
1227 For each column, Org-mode will remember the most recently used
1228 formula. The information is stored in a special line starting with
1229 `#+TBLFM' directly below the table. When adding/deleting/moving
1230 columns with the appropriate commands, the stored equations will be
1231 modified accordingly. When a column used in a calculation is removed,
1232 references to this column become invalid and will cause an error upon
1233 applying the equation.
1235 Instead of typing an equation into the field, you may also use the
1236 command `C-c ='. It prompts for a formula (with default taken from the
1237 `#+TBLFM:' line) and applies it to the current field. A numerical
1238 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1239 in the current column.
1241 To recompute all the fields in a line, use the command `C-c *'. It
1242 re-applies all stored equations to the current row, from left to right.
1243 With a `C-u' prefix, this will be done to every line in the table, so
1244 use this command it you want to make sure the entire table is
1245 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1246 Global updating does not touch the line(s) above the first horizontal
1247 separator line, assuming that this is the table header.
1250 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1252 3.3.4 Advanced features
1253 -----------------------
1255 If you want the recalculation of fields to happen automatically, or if
1256 you want to be able to assign a formula to an individual field (instead
1257 of an entire column) you need to reserve the first column of the table
1258 for special marking characters. Here is an example of a table that
1259 collects exam results of students and makes use of these features:
1261 |---+---------+--------+--------+--------+-------+------|
1262 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1263 |---+---------+--------+--------+--------+-------+------|
1264 | ! | | P1 | P2 | P3 | Tot | |
1265 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1266 | ^ | | m1 | m2 | m3 | mt | |
1267 |---+---------+--------+--------+--------+-------+------|
1268 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1269 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1270 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1271 |---+---------+--------+--------+--------+-------+------|
1272 | | Average | | | | 29.7 | |
1273 | ^ | | | | | at | |
1274 | $ | max=50 | | | | | |
1275 |---+---------+--------+--------+--------+-------+------|
1276 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1278 Important: Please note that for these special tables, recalculating the
1279 table with `C-u C-c *' will only affect rows that are marked `#' or
1280 `*', and named fields. The column formulas are not applied in rows
1281 with empty first field.
1283 The marking characters have the following meaning:
1285 The fields in this line define names for the columns, so that you
1286 may refer to a column as `$Tot' instead of `$6'.
1289 This row defines names for the fields _above_ the row. With such
1290 a definition, any formula in the table may use `$m1' to refer to
1291 the value `10'. Also, named fields can have their own formula
1292 associated with them.
1295 Similar to `^', but defines names for the fields in the row
1299 Fields in this row can define _parameters_ for formulas. For
1300 example, if a field in a `$' row contains `max=50', then formulas
1301 in this table can refer to the value 50 using `$max'. Parameters
1302 work exactly like constants, only that they can be defined on a
1303 per-table basis. Changing a parameter and then recalculating the
1304 table can be useful.
1307 Fields in this row are automatically recalculated when pressing
1308 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1309 selected for a global recalculation with `C-u C-c *'. Unmarked
1310 lines will be left alone by this command.
1313 Selects this line for global recalculation with `C-u C-c *', but
1314 not for automatic recalculation. Use this when automatic
1315 recalculation slows down editing too much.
1318 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1319 All lines that should be recalculated should be marked with `#' or
1323 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1325 3.3.5 Named-field formulas
1326 --------------------------
1328 A named field can have its own formula associated with it. In the
1329 example above, this is used for the `at' field that contains the
1330 average result of the students. To enter a formula for a named field,
1331 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1332 This equation will be stored below the table like `$name=...'. Any
1333 recalculation in the table (even if only requested for the current
1334 line) will also update all named field formulas.
1337 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1339 3.3.6 Editing and debugging formulas
1340 ------------------------------------
1342 To edit a column or field formula, use the commands `C-c =' and `C-u
1343 C-c =', respectively. The currently active expression is then
1344 presented as default in the minibuffer, where it may be edited.
1346 Note that making a table field blank does not remove the formula
1347 associated with the field - during the next recalculation the field
1348 will be filled again. To remove a formula from a field, you have to
1349 give an empty reply when prompted for the formula, or to edit the
1352 You may edit the `#+TBLFM' directly and re-apply the changed
1353 equations with `C-c C-c' in that line, or with the normal recalculation
1354 commands in the table.
1356 In particular for large tables with many formulas, it is convenient
1357 to use the command `C-c '' to edit the formulas of the current table in
1358 a separate buffer. That buffer will show the formulas one per line,
1359 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1360 `$...' expression to get information about its interpretation.
1361 Exiting the buffer with `C-c C-c' only stores the modified formulas
1362 below the table. Exiting with `C-u C-c C-c' also applies them to the
1363 entire table. `C-c C-q' exits without installing the changes.
1365 When the evaluation of a formula leads to an error, the field content
1366 becomes the string `#ERROR'. If you would like see what is going on
1367 during variable substitution and calculation in order to find a bug,
1368 turn on formula debugging in the menu and repeat the calculation, for
1369 example by pressing `C-c = <RET>' in a field. Detailed information
1373 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1378 Finally, just to whet your appetite on what can be done with the
1379 fantastic `calc' package, here is a table that computes the Taylor
1380 series for a couple of functions (homework: try that with Excel :-)
1382 |---+-------------+---+-----+--------------------------------------|
1383 | | Func | n | x | Result |
1384 |---+-------------+---+-----+--------------------------------------|
1385 | # | exp(x) | 1 | x | 1 + x |
1386 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1387 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1388 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1389 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1390 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1391 |---+-------------+---+-----+--------------------------------------|
1392 #+TBLFM: $5=taylor($2,$4,$3);n3
1395 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1397 3.4 The Orgtbl minor mode
1398 =========================
1400 If you like the intuitive way the Org-mode table editor works, you
1401 might also want to use it in other modes like text-mode or mail-mode.
1402 The minor mode Orgtbl-mode makes this possible. You can always toggle
1403 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1406 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1409 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1411 3.5 The `table.el' package
1412 ==========================
1414 Complex ASCII tables with automatic line wrapping, column- and
1415 row-spanning, and alignment can be created using the Emacs table
1416 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1417 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1418 table, Org-mode will call `table-recognize-table' and move the cursor
1419 into the table. Inside a table, the keymap of Org-mode is inactive.
1420 In order to execute Org-mode-related commands, leave the table.
1423 Recognize `table.el' table. Works when the cursor is in a
1427 Insert a table.el table. If there is already a table at point,
1428 this command converts it between the table.el format and the
1429 Org-mode format. See the documentation string of the command
1430 `org-convert-table' for the restrictions under which this is
1434 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1439 Just like HTML, Org-mode provides links inside a file, and external
1440 links to other files, Usenet articles, emails, and much more.
1444 * Link format:: How links in Org-mode are formatted
1445 * Internal links:: Links to other places in the current file
1446 * External links:: URL-like links to the world
1447 * Handling links:: Creating, inserting and following
1448 * Search options:: Linking to a specific location
1449 * Custom searches:: When the default search is not enough
1450 * Remember:: Org-trees store quick notes
1453 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1458 Org-mode will recognize plain URL-like links and activate them as
1459 clickable links. The general link format, however, looks like this:
1461 [[link][description]] or alternatively [[link]]
1463 Once a link in the buffer is complete (all brackets present),
1464 Org-mode will change the display so that `description' is displayed
1465 instead of `[[link][description]]' and `link' is displayed instead of
1466 `[[link]]'. Links will be highlighted in the face `org-link', which by
1467 default is an underlined face. You can directly edit the visible part
1468 of a link. Note that this can be either the `link' part (if there is
1469 no description) or the `description' part. To edit also the invisible
1470 `link' part, use `C-c C-l' with the cursor on the link.
1472 If you place the cursor at the beginning or just behind the end of
1473 the displayed text and press <BACKSPACE>, you will remove the
1474 (invisible) bracket at that location. This makes the link incomplete
1475 and the internals are again displayed as plain text. Inserting the
1476 missing bracket hides the link internals again. To show the internal
1477 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1481 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1486 If the link does not look like a URL, it is considered to be internal in
1487 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1488 my target]]' lead to a text search in the current file. The link can
1489 be followed with `C-c C-o' when the cursor is on the link, or with a
1490 mouse click (*note Handling links::). The preferred match for such a
1491 link is a dedicated target: the same string in double angular brackets.
1492 Targets may be located anywhere; often it is convenient to put them
1493 into a comment line. For example
1497 In HTML export (*note HTML export::), such targets will become named
1498 anchors for direct access through `http' links(1).
1500 If no dedicated target exists, Org-mode will search for the words in
1501 the link. In the above example the search would be for `my target'.
1502 Links starting with a star like `*My Target' restrict the search to
1503 headlines. When searching, Org-mode will first try an exact match, but
1504 then move on to more and more lenient searches. For example, the link
1505 `[[*My Targets]]' will find any of the following:
1508 ** TODO my targets are bright
1509 ** my 20 targets are
1511 To insert a link targeting a headline, in-buffer completion can be
1512 used. Just type a star followed by a few optional letters into the
1513 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1514 offered as completions. *Note Handling links::, for more commands
1517 Following a link pushes a mark onto Org-mode's own mark ring. You
1518 can return to the previous position with `C-c &'. Using this command
1519 several times in direct succession goes back to positions recorded
1524 * Radio targets:: Make targets trigger links in plain text.
1525 * CamelCase links:: Activating CamelCase words as links
1527 ---------- Footnotes ----------
1529 (1) Note that text before the first headline will never be exported,
1530 so the first such target must be after the first headline.
1533 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1538 You can configure Org-mode to link any occurrences of certain target
1539 names in normal text. So without explicitly creating a link, the text
1540 connects to the target radioing its position. Radio targets are
1541 enclosed by triple angular brackets. For example, a target `<<<My
1542 Target>>>' causes each occurrence of `my target' in normal text to
1543 become activated as a link. The Org-mode file is scanned automatically
1544 for radio targets only when the file is first loaded into Emacs. To
1545 update the target list during editing, press `C-c C-c' with the cursor
1549 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1551 4.2.2 CamelCase words as links
1552 ------------------------------
1554 Org-mode also supports CamelCase words as links. This feature is not
1555 turned on by default because of the inconsistencies this system suffers
1556 from. To activate CamelCase words as links, you need to customize the
1557 option `org-activate-links'. A CamelCase word then leads to a text
1558 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1561 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1566 Org-mode supports links to files, websites, Usenet and email messages,
1567 and BBDB database entries. External links are URL-like locators. They
1568 start with a short identifying string followed by a colon. There can be
1569 no space after the colon. The following list shows examples for each
1572 http://www.astro.uva.nl/~dominik on the web
1573 file:/home/dominik/images/jupiter.jpg file, absolute path
1574 file:papers/last.pdf file, relative path
1575 news:comp.emacs Usenet link
1576 mailto:adent@galaxy.net Mail link
1577 vm:folder VM folder link
1578 vm:folder#id VM message link
1579 vm://myself@some.where.org/folder#id VM on remote machine
1580 wl:folder WANDERLUST folder link
1581 wl:folder#id WANDERLUST message link
1582 mhe:folder MH-E folder link
1583 mhe:folder#id MH-E message link
1584 rmail:folder RMAIL folder link
1585 rmail:folder#id RMAIL message link
1586 gnus:group GNUS group link
1587 gnus:group#id GNUS article link
1588 bbdb:Richard Stallman BBDB link
1589 shell:ls *.org A shell command
1590 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1592 A link should be enclosed in double brackets and may contain a
1593 descriptive text to be displayed instead of the url (*note Link
1594 format::), for example:
1596 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1598 Org-mode also finds external links in the normal text and activates
1599 them as links. If spaces must be part of the link (for example in
1600 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1601 end of the link, enclose them in angular brackets.
1604 File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
1609 Org-mode provides methods to create a link in the correct syntax, to
1610 insert it into an org-mode file, and to follow the link.
1613 Store a link to the current location. This is a _global_ command
1614 which can be used in any buffer to create a link. The link will be
1615 stored for later insertion into an Org-mode buffer (see below).
1616 For Org-mode files, if there is a `<<target>>' at the cursor, the
1617 link points to the target. Otherwise it points to the current
1618 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1619 the link will indicate the current article/entry. For W3 and W3M
1620 buffers, the link goes to the current URL. For any other files,
1621 the link will point to the file, with a search string (*note
1622 Search options::) pointing to the contents of the current line.
1623 If there is an active region, the selected words will form the
1624 basis of the search string. If the automatically created link is
1625 not working correctly or accurately enough, you can write custom
1626 functions to select the search string and to do the search for
1627 particular file types - see *Note Custom searches::. The key
1628 binding `C-c l' is only a suggestion - see *Note Installation::.
1631 Insert a link. This prompts for a link to be inserted into the
1632 buffer. You can just type a link, using text for an internal
1633 link, or one of the link type prefixes mentioned in the examples
1634 above. Through completion, all links stored during the current
1635 session can be accessed(1). The link will be inserted into the
1636 buffer, along with a descriptive text. Note that you don't have
1637 to use this command to insert a link. Links in Org-mode are plain
1638 text, and you can type or paste them straight into the buffer. By
1639 using this command, the links are automatically enclosed in double
1640 brackets, and you will be asked for the optional descriptive text.
1641 If the link is a `file:' link and the linked file is located in
1642 the same directory as the current file or a subdirectory of it, the
1643 path of the file will be inserted relative to the current
1647 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1648 file will be inserted and you may use file name completion to
1649 select the name of the file. The path to the file is inserted
1650 relative to the directory of the current org file, if the linked
1651 file is in the current directory or in a subdirectory of it, or if
1652 the path is written relative to the current directory using `../'.
1653 Otherwise an absolute path is used, if possible with `~/' for
1654 your home directory. You can force an absolute path with two
1657 `C-c C-l with cursor on existing link'
1658 When the cursor is on an existing link, `C-c C-l' allows you to
1659 edit the link and description parts of the link.
1662 Open link at point. This will launch a web browser for URLs (using
1663 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1664 the corresponding links, and execute the command in a shell link.
1665 When the cursor is on an internal link, this commands runs the
1666 corresponding search. When the cursor is on a TAG list in a
1667 headline, it creates the corresponding TAGS view. If the cursor
1668 is on a time stamp, it compiles the agenda for that date.
1669 Furthermore, it will visit text and remote files in `file:' links
1670 with Emacs and select a suitable application for local non-text
1671 files. Classification of files is based on file extension only.
1672 See option `org-file-apps'. If you want to override the default
1673 application and visit the file with Emacs, use a `C-u' prefix.
1677 On links, `mouse-2' will open the link just as `C-c C-o' would.
1678 Under Emacs 22, also `mouse-1' will follow a link.
1681 Like `mouse-2', but force file links to be opened with Emacs.
1684 Push the current position onto the mark ring, to be able to return
1685 easily. Commands following an internal link do this automatically.
1688 Jump back to a recorded position. A position is recorded by the
1689 commands following internal links, and by `C-c %'. Using this
1690 command several times in direct succession moves through a ring of
1691 previously recorded positions.
1693 ---------- Footnotes ----------
1695 (1) After insertion of a stored link, the link will be removed from
1696 the list of stored links. To keep it in the list later use, use a
1697 triple `C-u' prefix to `C-c C-l', or configure the option
1698 `org-keep-stored-link-after-insertion'.
1701 File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
1703 4.5 Search options in file links
1704 ================================
1706 File links can contain additional information to make Emacs jump to a
1707 particular location in the file when following a link. This can be a
1708 line number or a search option after a double(1) colon. For example,
1709 when the command `C-c l' creates a link (*note Handling links::) to a
1710 file, it encodes the words in the current line as a search string that
1711 can be used to find this line back later when following the link with
1714 Here is the syntax of the different ways to attach a search to a file
1715 link, together with an explanation:
1717 [[file:~/code/main.c::255]]
1718 [[file:~/xx.org::My Target]]
1719 [[file:~/xx.org::*My Target]]
1720 [[file:~/xx.org::/regexp/]]
1726 Search for a link target `<<My Target>>', or do a text search for
1727 `my target', similar to the search in internal links, see *Note
1728 Internal links::. In HTML export (*note HTML export::), such a
1729 file link will become an HTML reference to the corresponding named
1730 anchor in the linked file.
1733 In an Org-mode file, restrict search to headlines.
1736 Do a regular expression search for `regexp'. This uses the Emacs
1737 command `occur' to list all matches in a separate window. If the
1738 target file is in Org-mode, `org-occur' is used to create a sparse
1739 tree with the matches.
1741 As a degenerate case, a file link with an empty file name can be used
1742 to search the current file. For example, `<file:::find me>' does a
1743 search for `find me' in the current file, just as `[[find me]]' would.
1745 ---------- Footnotes ----------
1747 (1) For backward compatibility, line numbers can also follow a
1751 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1756 The default mechanism for creating search strings and for doing the
1757 actual search related to a file link may not work correctly in all
1758 cases. For example, BibTeX database files have many entries like
1759 `year="1993"' which would not result in good search strings, because
1760 the only unique identification for a BibTeX entry is the citation key.
1762 If you come across such a problem, you can write custom functions to
1763 set the right search string for a particular file type, and to do the
1764 search for the string in the file. Using `add-hook', these functions
1765 need to be added to the hook variables
1766 `org-create-file-search-functions' and
1767 `org-execute-file-search-functions'. See the docstring for these
1768 variables for more information. Org-mode actually uses this mechanism
1769 for BibTeX database files, and you can use the corresponding code as an
1770 implementation example. Search for `BibTeX links' in the source file.
1773 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1778 Another way to create org entries with links to other files is through
1779 the _Remember_ package by John Wiegley. _Remember_ lets you store
1780 quick notes with little interruption of your work flow. See
1781 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1782 information. The notes produced by _Remember_ can be stored in
1783 different ways, and Org-mode files are a good target. Org-mode allows
1784 you to file away notes either to a default file, or directly to the
1785 correct location in your Org-mode outline tree. The following
1786 customization will tell _Remember_ to use org files as target, and to
1787 create annotations compatible with Org-mode links.
1789 (setq org-directory "~/path/to/my/orgfiles/")
1790 (setq org-default-notes-file "~/.notes")
1791 (setq remember-annotation-functions '(org-remember-annotation))
1792 (setq remember-handler-functions '(org-remember-handler))
1793 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1795 In combination with Org-mode, you can use templates to generate
1796 different types of remember notes. For example, if you would like to
1797 use one template to create general TODO entries, and another one for
1798 journal entries, you could use:
1800 (setq org-remember-templates
1801 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1802 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1804 In these entries, the character specifies how to select the template,
1805 the first string specifies the template, and the (optional) second
1806 string specifies a default file (overruling `org-default-notes-file')
1807 as a target for this note.
1809 When you call `M-x remember' to remember something, org will prompt
1810 for a key to select the template and then prepare the buffer like
1812 <file:link to where you called remember>
1816 * [2006-03-21 Tue 15:37]
1818 <file:link to where you called remember>
1820 See the variable `org-remember-templates' for more details.
1822 When you are finished composing a note with remember, you have to
1823 press `C-c C-c' to file the note away. The handler first prompts for a
1824 target file - if you press <RET>, the value of `org-default-notes-file'
1825 is used. Then the command offers the headings tree of the selected
1826 file. You can either immediately press <RET> to get the note appended
1827 to the file. Or you can use vertical cursor motion (<up> and <down>)
1828 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1829 or <left> or <right> leads to the following result.
1831 Cursor Key Note gets inserted
1833 buffer-start <RET> as level 2 heading at end of file
1834 on headline <RET> as sublevel of the heading at cursor
1835 <left> as same level, before current heading
1836 <right> as same level, after current heading
1837 not on <RET> at cursor position, level taken from context.
1838 headline Or use prefix arg to specify level
1841 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1842 append it to the default file. Even shorter would be `C-u C-c C-c',
1843 which does the same without even showing the tree. But with little
1844 extra effort, you can push it directly to the correct location.
1846 Before inserting the text into a tree, the function ensures that the
1847 text has a headline, i.e. a first line that starts with a `*'. If not,
1848 a headline is constructed from the current date and some additional
1849 data. If the variable `org-adapt-indentation' is non-nil, the entire
1850 text is also indented so that it starts in the same column as the
1851 headline (after the asterisks).
1854 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1859 Org-mode does not maintain TODO lists as a separate document. TODO
1860 items are an integral part of the notes file, because TODO items
1861 usually come up while taking notes! With Org-mode, you simply mark any
1862 entry in a tree as being a TODO item. In this way, the information is
1863 not duplicated, and the entire context from which the item emerged is
1864 always present when you check.
1866 Of course, this technique causes TODO items to be scattered
1867 throughout your file. Org-mode provides methods to give you an
1868 overview over all things you have to do.
1872 * TODO basics:: Marking and displaying TODO entries
1873 * TODO extensions:: Workflow and assignments
1874 * Priorities:: Some things are more important than others
1875 * Breaking down tasks:: Splitting a task into managable pieces
1876 * Checkboxes:: Tick-off lists
1879 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
1881 5.1 Basic TODO functionality
1882 ============================
1884 Any headline can become a TODO item by starting it with the word TODO,
1887 *** TODO Write letter to Sam Fortune
1889 The most important commands to work with TODO entries are:
1892 Rotate the TODO state of the current item between
1894 ,-> (unmarked) -> TODO -> DONE --.
1895 '--------------------------------'
1897 The same rotation can also be done "remotely" from the timeline and
1898 agenda buffers with the `t' command key (*note Agenda commands::).
1902 Select the following/preceding TODO state, similar to cycling.
1903 Mostly useful if more than two TODO states are possible (*note
1907 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1908 the entire buffer, but shows all TODO items and the headings
1909 hierarchy above them. With prefix arg, show also the DONE
1910 entries. With numerical prefix N, show the tree for the Nth
1911 keyword in the variable `org-todo-keywords'.
1914 Show the global TODO list. This collects the TODO items from all
1915 agenda files (*note Agenda views::) into a single buffer. The
1916 buffer is in `agenda-mode', so there are commands to examine and
1917 manipulate the TODO entries directly from that buffer (*note
1918 Agenda commands::). *Note Global TODO list::, for more
1922 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
1924 5.2 Extended use of TODO keywords
1925 =================================
1927 The default implementation of TODO entries is just two states: TODO and
1928 DONE. You can, however, use the TODO feature for more complicated
1929 things by configuring the variables `org-todo-keywords' and
1930 `org-todo-interpretation'. Using special setup, you can even use TODO
1931 keywords in different ways in different org files.
1933 Note that tags are another way to classify headlines in general and
1934 TODO items in particular (*note Tags::).
1938 * Workflow states:: From TODO to DONE in steps
1939 * TODO types:: I do this, Fred the rest
1940 * Per file keywords:: Different files, different requirements
1943 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1945 5.2.1 TODO keywords as workflow states
1946 --------------------------------------
1948 You can use TODO keywords to indicate different states in the process
1949 of working on an item, for example:
1951 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1952 org-todo-interpretation 'sequence)
1954 Changing these variables only becomes effective in a new Emacs
1955 session. With this setup, the command `C-c C-t' will cycle an entry
1956 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1957 also use a prefix argument to quickly select a specific state. For
1958 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1959 you define many keywords, you can use in-buffer completion (see *Note
1960 Completion::) to insert these words into the buffer.
1963 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1965 5.2.2 TODO keywords as types
1966 ----------------------------
1968 The second possibility is to use TODO keywords to indicate different
1969 types of action items. For example, you might want to indicate that
1970 items are for "work" or "home". If you are into David Allen's _Getting
1971 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1972 `MAYBE'. Or, when you work with several people on a single project,
1973 you might want to assign action items directly to persons, by using
1974 their names as TODO keywords. This would be set up like this:
1976 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1977 org-todo-interpretation 'type)
1979 In this case, different keywords do not indicate a sequence, but
1980 rather different types. So it is normally not useful to change from
1981 one type to another. Therefore, in this case the behavior of the
1982 command `C-c C-t' is changed slightly(1). When used several times in
1983 succession, it will still cycle through all names. But when you return
1984 to the item after some time and execute `C-c C-t' again, it will switch
1985 from each name directly to DONE. Use prefix arguments or completion to
1986 quickly select a specific name. You can also review the items of a
1987 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1988 C-v'. For example, to see all things Lucy has to do, you would use
1989 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1990 single buffer, you would use the prefix arg as well when creating the
1991 global todo list: `C-3 C-c t'.
1993 ---------- Footnotes ----------
1995 (1) This is also true for the `t' command in the timeline and agenda
1999 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2001 5.2.3 Setting up TODO keywords for individual files
2002 ---------------------------------------------------
2004 It can be very useful to use different aspects of the TODO mechanism in
2005 different files, which is not possible with the global settings
2006 described above. For file-local settings, you need to add special
2007 lines to the file which set the keywords and interpretation for that
2008 file only. For example, to set one of the two examples discussed
2009 above, you need one of the following lines, starting in column zero
2010 anywhere in the file:
2012 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2013 #+TYP_TODO: Fred Sara Lucy Mike DONE
2015 To make sure you are using the correct keyword, type `#+' into the
2016 buffer and then use `M-<TAB>' completion.
2018 Remember that the last keyword must always mean that the item is DONE
2019 (although you may use a different word). Also note that in each file,
2020 only one of the two aspects of TODO keywords can be used. After
2021 changing one of these lines, use `C-c C-c' with the cursor still in the
2022 line to make the changes known to Org-mode(1).
2024 If you want to use very many keywords, for example when working with
2025 a large group of people, you may split the names over several lines:
2027 #+TYP_TODO: Fred Sara Lucy Mike
2028 #+TYP_TODO: Luis George Jules Jessica
2029 #+TYP_TODO: Kim Arnold Peter
2032 ---------- Footnotes ----------
2034 (1) Org-mode parses these lines only when Org-mode is activated
2035 after visiting a file. `C-c C-c' with the cursor in a line starting
2036 with `#+' is simply restarting Org-mode for the current buffer.
2039 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2044 If you use Org-mode extensively to organize your work, you may end up
2045 with a number of TODO entries so large that you'd like to prioritize
2046 them. This can be done by placing a _priority cookie_ into the
2049 *** TODO [#A] Write letter to Sam Fortune
2051 With its standard setup, Org-mode supports priorities `A', `B', and
2052 `C'. `A' is the highest priority. An entry without a cookie is
2053 treated as priority `B'. Priorities make a difference only in the
2054 agenda (*note Weekly/Daily agenda::).
2057 Set the priority of the current headline. The command prompts for
2058 a priority character `A', `B' or `C'. When you press <SPC>
2059 instead, the priority cookie is removed from the headline. The
2060 priorities can also be changed "remotely" from the timeline and
2061 agenda buffer with the `,' command (*note Agenda commands::).
2065 Increase/decrease priority of current headline. Note that these
2066 keys are also used to modify time stamps (*note Creating
2067 timestamps::). Furthermore, these keys are also used by CUA-mode
2068 (*note Conflicts::).
2071 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2073 5.4 Breaking tasks down into subtasks
2074 =====================================
2076 It is often advisable to break down large tasks into smaller, managable
2077 subtasks. You can do this by creating an outline tree below a TODO
2078 item, with detailed subtasks on the tree(1). Another possibility is
2079 the use of checkboxes to ideantify (a hierarchy of) a large number of
2080 subtasks (*note Checkboxes::).
2082 ---------- Footnotes ----------
2084 (1) To keep subtasks out of the global TODO list, see the
2085 `org-agenda-todo-list-sublevels'.
2088 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2093 Every item in a plain list (*note Plain lists::) can be made a checkbox
2094 by starting it with the string `[ ]'. This feature is similar to TODO
2095 items (*note TODO items::), but more lightweight. Checkboxes are not
2096 included into the global TODO list, so they are often great to split a
2097 task into a number of simple steps. Or you can use them in a shopping
2098 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2099 `org-mouse.el'. Here is an example of a checkbox list.
2101 * TODO Organize party [3/6]
2107 - [ ] think about what music to play
2108 - [X] talk to the neighbors
2110 The `[3/6]' and `[1/3]' in the first and second line are cookies
2111 indicating how many checkboxes are present in this entry, and how many
2112 of them have been checked off. This can give you an idea on how many
2113 checkboxes remain, even without opening a folded entry. The cookies
2114 can be placed into a headline or into (the first line of) a plain list
2115 item. Each cookie covers all checkboxes structurally below that
2116 headline/item. You have to insert the cookie yourself by typing either
2117 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2118 the second case you get information about the percentage of checkboxes
2119 checked (in the above example, this would be `[50%]' and `[33%],
2122 The following commands work with checkboxes:
2125 Toggle checkbox at point.
2128 Toggle checkbox at point.
2129 - If there is an active region, toggle the first checkbox in
2130 the region and set all remaining boxes to the same status as
2131 the first. If you want to toggle all boxes in the region
2132 independently, use a prefix argument.
2134 - If the cursor is in a headline, toggle checkboxes in the
2135 region between this headline and the next (so _not_ the
2138 - If no active region, just toggle the checkbox at point.
2141 Insert a new item with a checkbox. This works only if the cursor
2142 is already in a plain list item (*note Plain lists::).
2145 Update the checkbox statistics in the current outline entry. When
2146 called with a `C-u' prefix, update the entire file. Checkbox
2147 statistic cookies are updated automatically if you toggle
2148 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2149 you delete boxes or add/change them by hand, use this command to
2150 get things back into synch. Or simply toggle any checkbox twice
2154 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2159 Items can be labeled with timestamps to make them useful for project
2164 * Time stamps:: Assigning a time to a tree entry
2165 * Creating timestamps:: Commands which insert timestamps
2166 * Progress logging:: Documenting when what work was done.
2169 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2171 6.1 Time stamps, deadlines and scheduling
2172 =========================================
2174 A time stamp is a specification of a date (possibly with time) in a
2175 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
2176 A time stamp can appear anywhere in the headline or body of an org-tree
2177 entry. Its presence allows entries to be shown on specific dates in
2178 the agenda (*note Weekly/Daily agenda::). We distinguish:
2181 A simple time stamp just assigns a date/time to an item. This is
2182 just like writing down an appointment in a paper agenda, or like
2183 writing down an event in a diary, when you want to take note of
2184 when something happened. In the timeline and agenda displays, the
2185 headline of an entry associated with a plain time stamp will be
2186 shown exactly on that date.
2189 Two time stamps connected by `--' denote a time range. The
2190 headline will be shown on the first and last day of the range, and
2191 on any dates that are displayed and fall in the range. Here is an
2194 ** Meeting in Amsterdam
2195 <2004-08-23 Mon>--<2004-08-26 Thu>
2197 TIME STAMP WITH SCHEDULED KEYWORD
2198 If a time stamp is preceded by the word `SCHEDULED:', it means you
2199 are planning to start working on that task on the given date. So
2200 this is not about recording an event, but about planning your
2201 work. The headline will be listed under the given date. In
2202 addition, a reminder that the scheduled date has passed will be
2203 present in the compilation for _today_, until the entry is marked
2204 DONE. I.e., the task will automatically be forwarded until
2207 *** TODO Call Trillian for a date on New Years Eve.
2208 SCHEDULED: <2004-12-25 Sat>
2210 TIME STAMP WITH DEADLINE KEYWORD
2211 If a time stamp is preceded by the word `DEADLINE:', the task
2212 (most likely a TODO item) is supposed to be finished on that date,
2213 and it will be listed then. In addition, the compilation for
2214 _today_ will carry a warning about the approaching or missed
2215 deadline, starting `org-deadline-warning-days' before the due
2216 date, and continuing until the entry is marked DONE. An example:
2218 *** TODO write article about the Earth for the Guide
2219 The editor in charge is <bbdb:Ford Prefect>
2220 DEADLINE: <2004-02-29 Sun>
2222 TIME STAMP WITH CLOSED KEYWORD
2223 When `org-log-done' is non-nil, Org-mode will automatically insert
2224 a special time stamp each time a TODO entry is marked done (*note
2225 Progress logging::). This time stamp is enclosed in square
2226 brackets instead of angular brackets.
2228 TIME RANGE WITH CLOCK KEYWORD
2229 When using the clock to time the work that is being done on
2230 specific items, time ranges preceded by the CLOCK keyword are
2231 inserted automatically into the file. The time stamps are
2232 enclosed in square brackets instead of angular brackets. *Note
2233 Clocking work time::.
2236 File: org, Node: Creating timestamps, Next: Progress logging, Prev: Time stamps, Up: Timestamps
2238 6.2 Creating timestamps
2239 =======================
2241 For Org-mode to recognize time stamps, they need to be in the specific
2242 format. All commands listed below produce time stamps in the correct
2246 Prompt for a date and insert a corresponding time stamp. When the
2247 cursor is at a previously used time stamp, it is updated to NOW.
2248 When this command is used twice in succession, a time range is
2252 Like `C-c .', but use the alternative format which contains date
2253 and time. The default time can be rounded to multiples of 5
2254 minutes, see the option `org-time-stamp-rounding-minutes'.
2257 Like `C-c .', but insert an inactive time stamp not triggering the
2261 Insert a time stamp corresponding to the cursor date in the
2265 Access the Emacs calendar for the current date. If there is a
2266 timestamp in the current line, goto the corresponding date instead.
2269 Access the agenda for the date given by the time stamp at point
2270 (*note Weekly/Daily agenda::).
2273 Insert `DEADLINE' keyword along with a stamp. The insertion will
2274 happen in the line directly following the headline.
2277 Create a sparse tree with all deadlines that are either past-due,
2278 or which will become due within `org-deadline-warning-days'. With
2279 `C-u' prefix, show all deadlines in the file. With a numeric
2280 prefix, check that many days. For example, `C-1 C-c C-w' shows
2281 all deadlines due tomorrow.
2284 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2285 happen in the line directly following the headline. Any CLOSED
2286 timestamp will be removed.
2290 Change date at cursor by one day. These key bindings conflict with
2291 CUA-mode (*note Conflicts::).
2295 Change the item under the cursor in a timestamp. The cursor can
2296 be on a year, month, day, hour or minute. Note that if the cursor
2297 is not at a time stamp, these same keys modify the priority of an
2298 item. (*note Priorities::). The key bindings also conflict with
2299 CUA-mode (*note Conflicts::).
2302 Evaluate a time range by computing the difference between start and
2303 end. With prefix arg, insert result after the time range (in a
2304 table: into the following column).
2306 When Org-mode prompts for a date/time, the function reading your
2307 input will replace anything you choose not to specify with the current
2308 date and time. For details, see the documentation string of
2309 `org-read-date'. Also, a calender will pop up to allow selecting a
2310 date. The calendar can be fully controlled from the minibuffer, and a
2311 date can be selected with the following commands:
2314 Scroll calendar backwards by one month.
2317 Scroll calendar forwards by one month.
2320 Select date by clicking on it.
2341 Choose date in calendar (only if nothing typed into minibuffer).
2344 File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
2346 6.3 Progress Logging
2347 ====================
2349 Org-mode can automatically record a time stamp when you mark a TODO item
2350 as DONE. You can also measure precisely the time you spent on specific
2351 items in a project by starting and stopping a clock when you start and
2352 stop working on an aspect of a project.
2356 * Closing items:: When was this entry marked DONE?
2357 * Clocking work time:: When exactly did you work on this item?
2360 File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
2365 If you want to keep track of _when_ a certain TODO item was finished,
2366 turn on logging with
2368 (setq org-log-done t)
2370 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2371 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2372 [timestamp]' will be inserted just after the headline. If you turn the
2373 entry back into a TODO item again through further state cycling, that
2374 line will be removed again. In the timeline (*note Timeline::) and in
2375 the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
2376 to display the TODO items closed on each day, giving you an overview of
2377 what has been done on a day. See the variable `org-log-done' for the
2378 possibility to record an additional note together with a timestamp.
2381 File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
2383 6.3.2 Clocking work time
2384 ------------------------
2386 Org-mode allows you to clock the time you spent on specific tasks in a
2387 project. When you start working on an item, you can start the clock.
2388 When you stop working on that task, or when you mark the task done, the
2389 clock is stopped and the corresponding time interval is recorded. It
2390 also computes the total time spent on each subtree of a project.
2393 Start the clock on the current item (clock-in). This inserts the
2394 CLOCK keyword together with a timestamp.
2397 Stop the clock (clock-out). The inserts another timestamp at the
2398 same location where the clock was last started. It also directly
2399 computes the resulting time in inserts it after the time range as
2403 Recompute the time interval after changing one of the time stamps.
2404 This is only necessary if you edit the time stamps directly. If
2405 you change them with `S-<cursor>' keys, the update is automatic.
2408 Changing the TODO state of an item to DONE automatically stops the
2409 clock if it is running in this same item.
2412 Cancel the current clock. This is useful if a clock was started by
2413 mistake, or if you ended up working on something else.
2416 Display time summaries for each subtree in the current buffer.
2417 This puts overlays at the end of each headline, showing the total
2418 time recorded under that heading, including the time of any
2419 subheadings. You can use visibility cycling to study the tree, but
2420 the overlays disappear automatically when the buffer is changed.
2423 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2424 report as an org-mode table into the current file.
2425 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2428 If such a block already exists, its content is replaced by the new
2429 table. The `BEGIN' line can specify options:
2430 :maxlevels Maximum level depth to which times are listed in the table.
2431 :emphasize When `t', emphasize level one and level two items
2432 :block The time block to consider. This block is specified relative
2433 to the current time and may be any of these keywords:
2434 `today', `yesterday', `thisweek', `lastweek',
2435 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2436 :tstart A time string specifying when to start considering times
2437 :tend A time string specifying when to stop considering times
2438 So to get a clock summary for the current day, you could write
2439 #+BEGIN: clocktable :maxlevel 2 :block today
2442 and to use a specific time range you could write(1)
2443 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2444 :tend "<2006-08-10 Thu 12:00>"
2449 Update all dynamic blocks (*note Dynamic blocks::). This is
2450 useful if you have several clocktable blocks in a buffer.
2452 The `l' key may be used in the timeline (*note Timeline::) and in
2453 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2454 worked on or closed during a day.
2456 See the variable `org-log-done' for the possibility to record an
2457 additional note together with a the clock-out time stamp.
2459 ---------- Footnotes ----------
2461 (1) Note that all parameters must be specified in a single line -
2462 the line is broken here only to fit it onto the manual.
2465 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2470 If you wish to implement a system of labels and contexts for
2471 cross-correlating information, an excellent way is to assign tags to
2472 headlines. Org-mode has extensive support for using tags.
2474 Every headline can contain a list of tags, at the end of the
2475 headline. Tags are normal words containing letters, numbers, `_', and
2476 `@'. Tags must be preceded and followed by a single colon; like
2477 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2481 * Tag inheritance:: Tags use the tree structure of the outline
2482 * Setting tags:: How to assign tags to a headline
2483 * Tag searches:: Searching for combinations of tags
2486 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2491 Tags make use of the hierarchical structure of outline trees. If a
2492 heading has a certain tag, all subheadings will inherit the tag as
2493 well. For example, in the list
2495 * Meeting with the French group :WORK:
2496 ** Summary by Frank :BOSS:NOTES:
2497 *** TODO Prepare slides for him :ACTION:
2499 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2500 `:ACTION:'. When executing tag searches and Org-mode finds that a
2501 certain headline matches the search criterion, it will not check any
2502 sublevel headline, assuming that these likely also match, and that the
2503 list of matches can become very long. This may not be what you want,
2504 however, and you can influence inheritance and searching using the
2505 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2508 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2513 Tags can simply be typed into the buffer at the end of a headline.
2514 After a colon, `M-<TAB>' offers completion on tags. There is also a
2515 special command for inserting tags:
2518 Enter new tags for the current headline. Org-mode will either
2519 offer completion or a special single-key interface for setting
2520 tags, see below. After pressing <RET>, the tags will be inserted
2521 and aligned to `org-tags-column'. When called with a `C-u'
2522 prefix, all tags in the current buffer will be aligned to that
2523 column, just to make things look nice. TAGS are automatically
2524 realigned after promotion, demotion, and TODO state changes (*note
2527 Org will support tag insertion based on a _list of tags_. By
2528 default this list is constructed dynamically, containing all tags
2529 currently used in the buffer. You may also globally specify a hard list
2530 of tags with the variable `org-tag-alist'. Finally you can set the
2531 allowed tags for a given file with lines like
2533 #+TAGS: @WORK @HOME @TENNISCLUB
2534 #+TAGS: Laptop Car PC Sailboat
2536 The default support method is minibuffer completion. However,
2537 Org-mode also implements a much better method: _fast tag selection_.
2538 This method allows to select and deselect tags with a single key per
2539 tag. To function efficiently, you should assign unique keys to all
2540 tags. This can be done globally with
2542 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2544 or on a per-file basis with
2546 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2548 You can also group together tags that are mutually exclusive. With
2551 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2553 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2556 Don't forget to press `C-c C-c' with the cursor in one of these lines
2557 to activate any changes.
2559 If at least one tag has a selection key, pressing `C-c C-c' will
2560 automatically present you with a special interface, listing inherited
2561 tags, the tags of the current headline, and a list of all legal tags
2562 with corresponding keys(2). Pressing keys for the tags will add or
2563 remove them from the list of tags in the current line. Selecting a tag
2564 in a group of mutually exclusive tags will turn off any other tags from
2565 that group. <SPC> clears all tags for this line, `RET' accepts the
2566 modified set, and `C-g' aborts without installing changes. This method
2567 lets you assign tags to a headline with very few keys. With the above
2568 setup, you could clear the current tags and set `@HOME', `Laptop' and
2569 `PC' tags with just the following keys: `C-c C-c <SPC> h l p <RET>'.
2570 Switching from `@HOME' to `@WORK' would be done with `C-c C-c w <RET>'.
2572 What if you have globally defined your preferred set of tags using
2573 the variable `org-tag-alist', but would like to use a dynamic tag list
2574 in a specific file? Just add an empty TAGS option line to that file:
2578 ---------- Footnotes ----------
2580 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2581 respectively. Several groups are allowed.
2583 (2) Keys will automatically assigned to tags which have no
2587 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2592 Once a tags system has been set up, it can be used to collect related
2593 information into special lists.
2596 Create a sparse tree with all headlines matching a tags search.
2599 Create a global list of tag matches from all agenda files. *Note
2600 Matching headline tags::.
2603 Create a global list of tag matches from all agenda files, but
2604 check only TODO items and force checking subitems (see variable
2605 `org-tags-match-list-sublevels').
2607 A tags search string can use Boolean operators `&' for AND and `|'
2608 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2609 not implemented. A tag may also be preceded by `-', to select against
2610 it, and `+' is syntactic sugar for positive selection. The AND
2611 operator `&' is optional when `+' or `-' is present. For example,
2612 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2613 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2614 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2615 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2619 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
2624 Due to the way Org-mode works, TODO items, time-stamped items, and
2625 tagged headlines can be scattered throughout a file or even a number of
2626 files. To get an overview over open action items, or over events that
2627 are important for a particular date, this information must be collected,
2628 sorted and displayed in an organized way.
2630 Org-mode can select items based on various criteria, and display them
2631 in a separate buffer. Five different view types are provided:
2633 * an _agenda_ that is like a calendar and shows information for
2636 * a _TODO list_ that covers all unfinished action items,
2638 * a _tags view_ that shows information based on the tags associated
2639 with headlines in the outline tree,
2641 * a _timeline view_ that shows all events in a single Org-mode file,
2644 * _custom views_ that are special tag and keyword searches and
2645 combinations of different views.
2647 The extracted information is displayed in a special _agenda buffer_.
2648 This buffer is read-only, but provides commands to visit the
2649 corresponding locations in the original Org-mode files, and even to
2650 edit these files remotely.
2654 * Agenda files:: Files being searched for agenda information
2655 * Agenda dispatcher:: Keyboard access to agenda views
2656 * Weekly/Daily agenda:: The calendar page with current tasks
2657 * Global TODO list:: All unfinished action items
2658 * Matching headline tags:: Structured information with fine-tuned search
2659 * Timeline:: Time-sorted view for single file
2660 * Presentation and sorting:: How agenda items are prepared for display
2661 * Agenda commands:: Remote editing of org trees
2662 * Custom agenda views:: Defining special searches and views
2665 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2670 The information to be shown is collected from all _agenda files_, the
2671 files listed in the variable `org-agenda-files'(1). Thus even if you
2672 only work with a single Org-mode file, this file should be put into
2673 that list(2). You can customize `org-agenda-files', but the easiest
2674 way to maintain it is through the following commands
2677 Add current file to the list of agenda files. The file is added to
2678 the front of the list. If it was already in the list, it is moved
2679 to the front. With prefix arg, file is added/moved to the end.
2682 Remove current file from the list of agenda files.
2685 Cycle through agenda file list, visiting one file after the other.
2687 The Org menu contains the current list of files and can be used to
2690 ---------- Footnotes ----------
2692 (1) If the value of that variable is not a list, but a single file
2693 name, then the list of agenda files will be maintained in that external
2696 (2) When using the dispatcher, pressing `1' before selecting a
2697 command will actually limit the command to the current file, and ignore
2698 `org-agenda-files' until the next dispatcher command.
2701 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2703 8.2 The agenda dispatcher
2704 =========================
2706 The views are created through a dispatcher that should be bound to a
2707 global key, for example `C-c a' (*note Installation::). In the
2708 following we will assume that `C-c a' is indeed how the dispatcher is
2709 accessed and list keyboard access to commands accordingly. After
2710 pressing `C-c a', an additional letter is required to execute a
2711 command. The dispatcher offers the following default commands:
2713 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2716 Create a list of all TODO items (*note Global TODO list::).
2719 Create a list of headlines matching a TAGS expression (*note
2720 Matching headline tags::).
2723 Create the timeline view for the current buffer (*note Timeline::).
2726 Restrict an agenda command to the current buffer. After pressing
2727 `1', you still need to press the character selecting the command.
2730 If there is an active region, restrict the following agenda
2731 command to the region. Otherwise, restrict it to the current
2732 subtree. After pressing `0', you still need to press the
2733 character selecting the command.
2735 You can also define custom commands that will be accessible through
2736 the dispatcher, just like the default commands. This includes the
2737 possibility to create extended agenda buffers that contain several
2738 blocks together, for example the weekly agenda, the global TODO list and
2739 a number of special tags matches. *Note Custom agenda views::.
2742 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
2744 8.3 The weekly/daily agenda
2745 ===========================
2747 The purpose of the weekly/daily _agenda_ is to act like a page of a
2748 paper agenda, showing all the tasks for the current week or day.
2751 Compile an agenda for the current week from a list of org files.
2752 The agenda shows the entries for each day. With a `C-u' prefix (or
2753 when the variable `org-agenda-include-all-todo' is `t'), all
2754 unfinished TODO items (including those without a date) are also
2755 listed at the beginning of the buffer, before the first date.
2757 Remote editing from the agenda buffer means, for example, that you
2758 can change the dates of deadlines and appointments from the agenda
2759 buffer. The commands available in the Agenda buffer are listed in
2760 *Note Agenda commands::.
2764 * Calendar/Diary integration:: Integrating Anniversaries and more
2767 File: org, Node: Calendar/Diary integration, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
2769 8.3.1 Calendar/Diary integration
2770 --------------------------------
2772 Emacs contains the calendar and diary by Edward M. Reingold. The
2773 calendar displays a three-month calendar with holidays from different
2774 countries and cultures. The diary allows you to keep track of
2775 anniversaries, lunar phases, sunrise/set, recurrent appointments
2776 (weekly, monthly) and more. In this way, it is quite complementary to
2777 Org-mode. It can be very useful to combine output from Org-mode with
2780 In order to include entries from the Emacs diary into Org-mode's
2781 agenda, you only need to customize the variable
2783 (setq org-agenda-include-diary t)
2785 After that, everything will happen automatically. All diary entries
2786 including holidays, anniversaries etc will be included in the agenda
2787 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2788 the agenda buffer to jump to the diary file in order to edit existing
2789 diary entries. The `i' command to insert new entries for the current
2790 date works in the agenda buffer, as well as the commands `S', `M', and
2791 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2792 to other calendars, respectively. `c' can be used to switch back and
2793 forth between calendar and agenda.
2796 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
2798 8.4 The global TODO list
2799 ========================
2801 The global TODO list contains all unfinished TODO items, formatted and
2802 collected into a single place.
2805 Show the global TODO list. This collects the TODO items from all
2806 agenda files (*note Agenda views::) into a single buffer. The
2807 buffer is in `agenda-mode', so there are commands to examine and
2808 manipulate the TODO entries directly from that buffer (*note
2812 Like the above, but allows selection of a specific TODO keyword.
2813 You can also do this by specifying a prefix argument to `C-c a t'.
2814 With a `C-u' prefix you are prompted for a keyword. With a
2815 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2816 `r' key in the agenda buffer regenerates it, and you can give a
2817 prefix argument to this command to change the selected TODO
2818 keyword, for example `3 r'. If you often need a search for a
2819 specific keyword, define a custom command for it (*note Agenda
2822 Remote editing of TODO items means that you can change the state of a
2823 TODO entry with a single key press. The commands available in the TODO
2824 list are described in *Note Agenda commands::.
2826 Normally the global todo list simply shows all headlines with TODO
2827 keywords. This list can become very long. There are two ways to keep
2829 - Some people view a TODO item that has been _scheduled_ for
2830 execution (*note Time stamps::) as no longer _open_. Configure the
2831 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
2832 items from the global TODO list.
2834 - TODO items may have sublevels to break up the task into subtasks.
2835 In such cases it may be enough to list only the highest level TODO
2836 headline and omit the sublevels from the global list. Configure
2837 the variable `org-agenda-todo-list-sublevels' to get this behavior.
2840 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
2842 8.5 Matching headline tags
2843 ==========================
2845 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2846 you can select headlines based on the tags that apply to them and
2847 collect them into an agenda buffer.
2850 Produce a list of all headlines that match a given set of tags.
2851 The command prompts for a selection criterion, which is a boolean
2852 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2853 `WORK|HOME' (*note Tags::). If you often need a specific search,
2854 define a custom command for it (*note Agenda dispatcher::).
2857 Like `C-c a m', but only select headlines that are also TODO items
2858 and force checking subitems (see variable
2859 `org-tags-match-list-sublevels').
2861 The commands available in the tags list are described in *Note
2865 File: org, Node: Timeline, Next: Presentation and sorting, Prev: Matching headline tags, Up: Agenda views
2867 8.6 Timeline for a single file
2868 ==============================
2870 The timeline summarizes all time-stamped items from a single Org-mode
2871 file in a _time-sorted view_. The main purpose of this command is to
2872 give an overview over events in a project.
2875 Show a time-sorted view of the org file, with all time-stamped
2876 items. When called with a `C-u' prefix, all unfinished TODO
2877 entries (scheduled or not) are also listed under the current date.
2879 The commands available in the timeline buffer are listed in *Note
2883 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Timeline, Up: Agenda views
2885 8.7 Presentation and sorting
2886 ============================
2888 Before displaying items in an agenda view, Org-mode visually prepares
2889 the items and sorts them. Each item occupies a single line. The line
2890 starts with a _prefix_ that contains the _category_ (*note
2891 Categories::) of the item and other important information. You can
2892 customize the prefix using the option `org-agenda-prefix-format'. The
2893 prefix is followed by a cleaned-up version of the outline headline
2894 associated with the item.
2898 * Categories:: Not all tasks are equal
2899 * Time-of-day specifications:: How the agenda knows the time
2900 * Sorting of agenda items:: The order of things
2903 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
2908 The category is a broad label assigned to each agenda item. By default,
2909 the category is simply derived from the file name, but you can also
2910 specify it with a special line in the buffer, like this:
2914 If there are several such lines in a file, each specifies the
2915 category for the text below it (but the first category also applies to
2916 any text before the first CATEGORY line). The display in the agenda
2917 buffer looks best if the category is not longer than 10 characters.
2920 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
2922 8.7.2 Time-of-Day Specifications
2923 --------------------------------
2925 Org-mode checks each agenda item for a time-of-day specification. The
2926 time can be part of the time stamp that triggered inclusion into the
2927 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2928 specified with two time stamps, like
2929 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2931 In the headline of the entry itself, a time(range) may also appear as
2932 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2933 Emacs diary (*note Calendar/Diary integration::), time specifications
2934 in diary entries are recognized as well.
2936 For agenda display, Org-mode extracts the time and displays it in a
2937 standard 24 hour format as part of the prefix. The example times in
2938 the previous paragraphs would end up in the agenda like this:
2940 8:30-13:00 Arthur Dent lies in front of the bulldozer
2941 12:45...... Ford Prefect arrives and takes Arthur to the pub
2942 19:00...... The Vogon reads his poem
2943 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2945 If the agenda is in single-day mode, or for the display of today, the
2946 timed entries are embedded in a time grid, like
2948 8:00...... ------------------
2949 8:30-13:00 Arthur Dent lies in front of the bulldozer
2950 10:00...... ------------------
2951 12:00...... ------------------
2952 12:45...... Ford Prefect arrives and takes Arthur to the pub
2953 14:00...... ------------------
2954 16:00...... ------------------
2955 18:00...... ------------------
2956 19:00...... The Vogon reads his poem
2957 20:00...... ------------------
2958 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2960 The time grid can be turned on and off with the variable
2961 `org-agenda-use-time-grid', and can be configured with
2962 `org-agenda-time-grid'.
2965 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
2967 8.7.3 Sorting of agenda items
2968 -----------------------------
2970 Before being inserted into a view, the items are sorted. How this is
2971 done depends on the type of view.
2972 * For the daily/weekly agenda, the items for each day are sorted.
2973 The default order is to first collect all items containing an
2974 explicit time-of-day specification. These entries will be shown
2975 at the beginning of the list, as a _schedule_ for the day. After
2976 that, items remain grouped in categories, in the sequence given by
2977 `org-agenda-files'. Within each category, items are sorted by
2978 priority (*note Priorities::), which is composed of the base
2979 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
2980 plus additional increments for overdue scheduled or deadline items.
2982 * For the TODO list, items remain in the order of categories, but
2983 within each category, sorting takes place according to priority
2984 (*note Priorities::).
2986 * For tags matches, items are not sorted at all, but just appear in
2987 the sequence in which they are found in the agenda files.
2989 Sorting can be customized using the variable
2990 `org-agenda-sorting-strategy'.
2993 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
2995 8.8 Commands in the agenda buffer
2996 =================================
2998 Entries in the agenda buffer are linked back to the org file or diary
2999 file where they originate. You are not allowed to edit the agenda
3000 buffer itself, but commands are provided to show and jump to the
3001 original entry location, and to edit the org-files "remotely" from the
3002 agenda buffer. In this way, all information is stored only once,
3003 removing the risk that your agenda and note files may diverge.
3005 Some commands can be executed with mouse clicks on agenda lines. For
3006 the other commands, the cursor needs to be in the desired line.
3012 Next line (same as <up>).
3015 Previous line (same as <down>).
3022 Display the original location of the item in another window.
3025 Display original location and recenter that window.
3030 Go to the original location of the item in another window. Under
3031 Emacs 22, `mouse-1' will also works for this.
3034 Go to the original location of the item and delete other windows.
3037 Toggle Follow mode. In Follow mode, as you move the cursor through
3038 the agenda buffer, the other window always shows the corresponding
3039 location in the org file. The initial setting for this mode in new
3040 agenda buffers can be set with the variable
3041 `org-agenda-start-with-follow-mode'.
3044 Toggle Logbook mode. In Logbook mode, entries that where marked
3045 DONE while logging was on (variable `org-log-done') are shown in
3046 the agenda, as are entries that have been clocked on that day.
3052 Delete other windows.
3055 Switch to weekly view (7 days displayed together).
3058 Switch to daily view (just one day displayed).
3061 Toggle the inclusion of diary entries. See *Note Calendar/Diary
3065 Toggle the time grid on and off. See also the variables
3066 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3069 Recreate the agenda buffer, for example to reflect the changes
3070 after modification of the time stamps of items with S-<left> and
3071 S-<right>. When the buffer is the global todo list, a prefix
3072 argument is interpreted to create a selective list for a specific
3076 Save all Org-mode buffers in the current Emacs session.
3079 Display the following `org-agenda-ndays' days. For example, if
3080 the display covers a week, switch to the following week. With
3081 prefix arg, go forward that many times `org-agenda-ndays' days.
3084 Display the previous dates.
3096 Change the TODO state of the item, both in the agenda and in the
3100 Show all tags associated with the current item. Because of
3101 inheritance, this may be more than the tags listed in the line
3105 Set tags for the current headline.
3108 Toggle the ARCHIVE tag for the current headline.
3111 Set the priority for the current item. Org-mode prompts for the
3112 priority character. If you reply with <SPC>, the priority cookie
3113 is removed from the entry.
3116 Display weighted priority of current item.
3120 Increase the priority of the current item. The priority is
3121 changed in the original buffer, but the agenda is not resorted.
3122 Use the `r' key for this.
3126 Decrease the priority of the current item.
3132 Set a deadline for this item.
3135 Change the time stamp associated with the current line by one day
3136 into the future. With prefix argument, change it by that many
3137 days. For example, `3 6 5 S-<right>' will change it by a year.
3138 The stamp is changed in the original org file, but the change is
3139 not directly reflected in the agenda buffer. Use the `r' key to
3143 Change the time stamp associated with the current line by one day
3147 Change the time stamp associated with the current line to today.
3148 The key `>' has been chosen, because it is the same as `S-.' on my
3152 Start the clock on the current item. If a clock is running
3153 already, it is stopped first.
3156 Stop the previously started clock.
3159 Cancel the currently running clock.
3165 Open the Emacs calendar and move to the date at the agenda cursor.
3168 When in the calendar, compute and show the Org-mode agenda for the
3172 Insert a new entry into the diary. Prompts for the type of entry
3173 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3174 new entry in the diary, just as `i d' etc. would do in the
3175 calendar. The date is taken from the cursor position.
3178 Show the phases of the moon for the three months around current
3182 Show sunrise and sunset times. The geographical location must be
3183 set with calendar variables, see documentation of the Emacs
3187 Convert the date at cursor into many other cultural and historic
3191 Show holidays for three month around the cursor date.
3194 Export a single iCalendar file containing entries from all agenda
3201 Quit agenda, remove the agenda buffer.
3204 Exit agenda, remove the agenda buffer and all buffers loaded by
3205 Emacs for the compilation of the agenda. Buffers created by the
3206 user to visit org files will not be removed.
3210 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3212 8.9 Custom agenda views
3213 =======================
3215 Custom agenda commands serve two purposes: to store and quickly access
3216 frequently used TODO and tags searches, and to create special composite
3217 agenda buffers. Custom agenda commands will be accessible through the
3218 dispatcher (*note Agenda dispatcher::), just like the default commands.
3222 * Storing searches:: Type once, use often
3223 * Block agenda:: All the stuff you need in a single buffer
3224 * Setting Options:: Changing the rules
3225 * Batch processing:: Agenda views from the command line
3228 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3230 8.9.1 Storing searches
3231 ----------------------
3233 The first application of custom searches is the definition of keyboard
3234 shortcuts for frequently used searches, either creating an agenda
3235 buffer, or a sparse tree (the latter covering of course only the current
3236 buffer). Custom commands are configured in the variable
3237 `org-agenda-custom-commands'. You can customize this variable, for
3238 example by pressing `C-c a C'. You can also directly set it with Emacs
3239 Lisp in `.emacs'. The following example contains all valid search
3242 (setq org-agenda-custom-commands
3243 '(("w" todo "WAITING")
3244 ("W" todo-tree "WAITING")
3245 ("u" tags "+BOSS-URGENT")
3246 ("v" tags-todo "+BOSS-URGENT")
3247 ("U" tags-tree "+BOSS-URGENT")
3248 ("f" occur-tree "\\<FIXME\\>")))
3250 The initial single-character string in each entry defines the character
3251 you have to press after the dispatcher command `C-c a' in order to
3252 access the command. The second parameter is the search type, followed
3253 by the string or regular expression to be used for the matching. The
3254 example above will therefore define:
3257 as a global search for TODO entries with `WAITING' as the TODO
3261 as the same search, but only in the current buffer and displaying
3262 the results as a sparse tree
3265 as a global tags search for headlines marked `:BOSS:' but not
3269 as the same search as `C-c a u', but limiting the search to
3270 headlines that are also TODO items
3273 as the same search as `C-c a u', but only in the current buffer and
3274 displaying the result as a sparse tree
3277 to create a sparse tree (again: current buffer only) with all
3278 entries containing the word `FIXME'.
3281 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3286 Another possibility is the construction of agenda views that comprise
3287 the results of _several_ commands, each of which creates a block in the
3288 agenda buffer. The available commands include `agenda' for the daily
3289 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3290 todo list (as constructed with `C-c a t'), and the matching commands
3291 discussed above: `todo', `tags', and `tags-todo'. Here are two
3294 (setq org-agenda-custom-commands
3295 '(("h" "Agenda and Home-related tasks"
3299 ("o" "Agenda and Office-related tasks"
3304 This will define `C-c a h' to create a multi-block view for stuff you
3305 need to attend to at home. The resulting agenda buffer will contain
3306 your agenda for the current week, all TODO items that carry the tag
3307 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3308 `C-c a o' provides a similar view for office tasks.
3311 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3313 8.9.3 Setting Options for custom commands
3314 -----------------------------------------
3316 Org-mode contains a number of variables regulating agenda construction
3317 and display. The global variables define the behavior for all agenda
3318 commands, including the custom commands. However, if you want to change
3319 some settings just for a single custom view, you can do so. Setting
3320 options requires inserting a list of variable names and values at the
3321 right spot in `org-agenda-custom-commands'. For example:
3323 (setq org-agenda-custom-commands
3324 '(("w" todo "WAITING"
3325 ((org-agenda-sorting-strategy '(priority-down))
3326 (org-agenda-prefix-format " Mixed: ")))
3327 ("U" tags-tree "+BOSS-URGENT"
3328 ((org-show-following-heading nil)
3329 (org-show-hierarchy-above nil)))))
3331 Now the `C-c a w' command will sort the collected entries only by
3332 priority, and the prefix format is modified to just say ` Mixed:'
3333 instead of giving the category of the entry. The sparse tags tree of
3334 `C-c a U' will now turn out ultra-compact, because neither the headline
3335 hierarchy above the match, nor the headline following the match will be
3338 For command sets creating a block agenda,
3339 `org-agenda-custom-commands' has two separate spots for setting
3340 options. You can add options that should be valid for just a single
3341 command in the set, and options that should be valid for all commands in
3342 the set. The former are just added to the command entry, the latter
3343 must come after the list of command entries. Going back to the block
3344 agenda example (*note Block agenda::), let's change the sorting strategy
3345 for the `C-c a h' commands to `priority-down', but let's sort the
3346 results for GARDEN tags query in the opposite order, `priority-up'.
3347 This would look like this:
3349 (setq org-agenda-custom-commands
3350 '(("h" "Agenda and Home-related tasks"
3353 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
3354 ((org-agenda-sorting-strategy '(priority-down))))
3355 ("o" "Agenda and Office-related tasks"
3360 As you see, the values and parenthesis setting is a little complex.
3361 When in doubt, use the customize interface to set this variable - it
3362 fully supports its structure. Just one caveat: When setting options in
3363 this interface, the _values_ are just lisp expressions. So if the
3364 value is a string, you need to add the double quotes around the value
3368 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
3370 8.9.4 Creating agenda views in batch processing
3371 -----------------------------------------------
3373 If you want to print or otherwise reprocess agenda views, it can be
3374 useful to create an agenda from the command line. This is the purpose
3375 of the function `org-batch-agenda'. It takes as a parameter one of the
3376 strings that are the keys in `org-agenda-custom-commands'. For
3377 example, to directly print the current TODO list, you could use
3379 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
3381 You may also modify parameters on the fly like this:
3383 emacs -batch -l ~/.emacs \
3384 -eval '(org-batch-agenda "a" \
3385 org-agenda-ndays 300 \
3386 org-agenda-include-diary nil \
3387 org-agenda-files (quote ("~/org/project.org")))' \
3390 which will produce a 300 day agenda, fully restricted to the Org file
3391 `~/org/projects.org', not even including the diary.
3394 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
3399 Plain ASCII is normally sufficient for almost all note taking. One
3400 exception, however, are scientific notes which need to be able to
3401 contain mathematical symbols and the occasional formula. LaTeX(1) is
3402 widely used to typeset scientific documents. Org-mode supports
3403 embedding LaTeX code into its files, because many academics are used to
3404 read LaTeX source code, and because it can be readily processed into
3405 images for HTML production.
3407 It is not necessary to mark LaTeX macros and code in any special way.
3408 If you observe a few conventions, Org-mode knows how to find it and what
3413 * Math symbols:: TeX macros for symbols and Greek letters
3414 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
3415 * LaTeX fragments:: Complex formulas made easy
3416 * Processing LaTeX fragments:: Previewing LaTeX processing
3417 * CDLaTeX mode:: Speed up entering of formulas
3419 ---------- Footnotes ----------
3421 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3422 Many of the features described here as "LaTeX" are really from TeX, but
3423 for simplicity I am blurring this distinction.
3426 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
3431 You can use LaTeX macros to insert special symbols like `\alpha' to
3432 indicate the Greek letter, or `\to' to indicate an arrow. Completion
3433 for these macros is available, just type `\' and maybe a few letters,
3434 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
3435 Org-mode allows these macros to be present without surrounding math
3436 delimiters, for example:
3438 Angles are written as Greek letters \alpha, \beta and \gamma.
3440 During HTML export (*note HTML export::), these symbols are
3441 translated into the proper syntax for HTML, for the above examples this
3442 is `α' and `→', respectively.
3445 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
3447 9.2 Subscripts and Superscripts
3448 ===============================
3450 Just like in LaTeX, `^' and `_' are used to indicate super- and
3451 subscripts. Again, these can be used without embedding them in
3452 math-mode delimiters. To increase the readability of ASCII text, it is
3453 not necessary (but OK) to surround multi-character sub- and superscripts
3454 with curly braces. For example
3456 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
3457 the sun is R_{sun} = 6.96 x 10^8 m.
3459 To avoid interpretation as raised or lowered text, you can quote `^'
3460 and `_' with a backslash: `\_' and `\^'.
3462 During HTML export (*note HTML export::), subscript and superscripts
3463 are surrounded with `<sub>' and `<sup>' tags, respectively.
3466 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
3471 With symbols, sub- and superscripts, HTML is pretty much at its end when
3472 it comes to representing mathematical formulas(1). More complex
3473 expressions need a dedicated formula processor. To this end, Org-mode
3474 can contain arbitrary LaTeX fragments. It provides commands to preview
3475 the typeset result of these fragments, and upon export to HTML, all
3476 fragments will be converted to images and inlined into the HTML
3477 document. For this to work you need to be on a system with a working
3478 LaTeX installation. You also need the `dvipng' program, available at
3479 `http://sourceforge.net/projects/dvipng/'.
3481 LaTeX fragments don't need any special marking at all. The following
3482 snippets will be identified as LaTeX source code:
3483 * Environments of any kind. The only requirement is that the
3484 `\begin' statement appears on a new line, preceded by only
3487 * Text within the usual LaTeX math delimiters. To avoid conflicts
3488 with currency specifications, single `$' characters are only
3489 recognized as math delimiters if the enclosed text contains at
3490 most two line breaks, is directly attached to the `$' characters
3491 with no whitespace in between, and if the closing `$' is followed
3492 by whitespace or punctuation. For the other delimiters, there is
3493 no such restriction, so when in doubt, use `\(...\)' as inline
3498 \begin{equation} % arbitrary environments,
3499 x=\sqrt{b} % even tables, figures
3500 \end{equation} % etc
3502 If $a^2=b$ and \( b=2 \), then the solution must be
3503 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
3505 If you need any of the delimiter ASCII sequences for other purposes, you
3506 can configure the option `org-format-latex-options' to deselect the
3507 ones you do not wish to have interpreted by the LaTeX converter.
3509 ---------- Footnotes ----------
3511 (1) Yes, there is MathML, but that is not yet fully supported by
3512 many browsers, and there is no decent converter for turning LaTeX of
3513 ASCII representations of formulas into MathML. So for the time being,
3514 converting formulas into images seems the way to go.
3517 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
3519 9.4 Processing LaTeX fragments
3520 ==============================
3522 LaTeX fragments can be processed to produce a preview images of the
3523 typeset expressions:
3526 Produce a preview image of the LaTeX fragment at point and overlay
3527 it over the source code. If there is no fragment at point,
3528 process all fragments in the current entry (between two
3529 headlines). When called with a prefix argument, process the
3530 entire subtree. When called with two prefix arguments, or when
3531 the cursor is before the first headline, process the entire buffer.
3534 Remove the overlay preview images.
3536 During HTML export (*note HTML export::), all LaTeX fragments are
3537 converted into images and inlined into the document if the following
3540 (setq org-export-with-LaTeX-fragments t)
3543 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
3545 9.5 Using CDLaTeX to enter math
3546 ===============================
3548 CDLaTeX-mode is a minor mode that is normally used in combination with a
3549 major LaTeX mode like AUCTeX in order to speed-up insertion of
3550 environments and math templates. Inside Org-mode, you can make use of
3551 some of the features of cdlatex-mode. You need to install `cdlatex.el'
3552 and `texmathp.el' (the latter comes also with AUCTeX) from
3553 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
3554 cdlatex-mode itself under Org-mode, but use the light version
3555 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
3556 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
3559 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
3561 When this mode is enabled, the following features are present (for
3562 more details see the documentation of cdlatex-mode):
3563 * Environment templates can be inserted with `C-c {'.
3565 * The <TAB> key will do template expansion if the cursor is inside a
3566 LaTeX fragment(1). For example, <TAB> will expand `fr' to
3567 `\frac{}{}' and position the cursor correctly inside the first
3568 brace. Another <TAB> will get you into the second brace. Even
3569 outside fragments, <TAB> will expand environment abbreviations at
3570 the beginning of a line. For example, if you write `equ' at the
3571 beginning of a line and press <TAB>, this abbreviation will be
3572 expanded to an `equation' environment. To get a list of all
3573 abbreviations, type `M-x cdlatex-command-help'.
3575 * Pressing `_' and `^' inside a LaTeX fragment will insert these
3576 characters together with a pair of braces. If you use <TAB> to
3577 move out of the braces, and if the braces surround only a single
3578 character or macro, they are removed again (depending on the
3579 variable `cdlatex-simplify-sub-super-scripts').
3581 * Pressing the backquote ``' followed by a character inserts math
3582 macros, also outside LaTeX fragments. If you wait more than 1.5
3583 seconds after the backquote, a help window will pop up.
3585 * Pressing the normal quote `'' followed by another character
3586 modifies the symbol before point with an accent or a font. If you
3587 wait more than 1.5 seconds after the backquote, a help window will
3588 pop up. Character modification will work only inside LaTeX
3589 fragments, outside the quote is normal.
3591 ---------- Footnotes ----------
3593 (1) Org-mode has a method to test if the cursor is inside such a
3594 fragment, see the documentation of the function
3595 `org-inside-LaTeX-fragment-p'.
3598 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
3603 Org-mode documents can be exported into a variety of other formats. For
3604 printing and sharing of notes, ASCII export produces a readable and
3605 simple version of an Org-mode file. HTML export allows you to publish a
3606 notes file on the web, while the XOXO format provides a solid base for
3607 exchange with a broad range of other applications. To incorporate
3608 entries with associated times like deadlines or appointments into a
3609 desktop calendar program like iCal, Org-mode can also produce extracts
3610 in the iCalendar format. Currently Org-mode only supports export, not
3611 import of these different formats.
3613 When exporting, Org-mode uses special conventions to enrich the
3614 output produced. *Note Text interpretation::, for more details.
3617 Dispatcher for export and publishing commands. Displays a
3618 help-window listing the additional key(s) needed to launch an
3619 export or publishing command.
3623 * ASCII export:: Exporting to plain ASCII
3624 * HTML export:: Exporting to HTML
3625 * XOXO export:: Exporting to XOXO
3626 * iCalendar export:: Exporting in iCalendar format
3627 * Text interpretation:: How the exporter looks at the file
3630 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
3635 ASCII export produces a simple and very readable version of an Org-mode
3639 Export as ASCII file. If there is an active region, only the
3640 region will be exported. For an org file `myfile.org', the ASCII
3641 file will be `myfile.txt'. The file will be overwritten without
3645 Export only the visible part of the document.
3647 In the exported version, the first 3 outline levels will become
3648 headlines, defining a general document structure. Additional levels
3649 will be exported as itemized lists. If you want that transition to
3650 occur at a different level, specify it with a prefix argument. For
3655 creates only top level headlines and does the rest as items. When
3656 headlines are converted to items, the indentation of the text following
3657 the headline is changed to fit nicely under the item. This is done with
3658 the assumption that the first bodyline indicates the base indentation of
3659 the body text. Any indentation larger than this is adjusted to preserve
3660 the layout relative to the first line. Should there be lines with less
3661 indentation than the first, these are left alone.
3664 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
3669 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
3670 HTML formatting, in ways similar to John Grubers _markdown_ language,
3671 but with additional support for tables.
3674 Export as HTML file `myfile.html'.
3677 Export as HTML file and open it with a browser.
3682 Export only the visible part of the document.
3684 In the exported version, the first 3 outline levels will become
3685 headlines, defining a general document structure. Additional levels
3686 will be exported as itemized lists. If you want that transition to
3687 occur at a different level, specify it with a prefix argument. For
3692 creates two levels of headings and does the rest as items.
3694 If you want to include HTML tags which should be interpreted as such,
3695 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
3696 always transformed to `<' and `>' in HTML export.
3698 Internal links (*note Internal links::) will continue to work in HTML
3699 files only if they match a dedicated `<<target>>'. Automatic links
3700 created by radio targets (*note Radio targets::) will also work in the
3701 HTML file. Links to external files will still work if the HTML file is
3702 in the same directory as the Org-mode file. Links to other `.org'
3703 files will be translated into HTML links under the assumption that an
3704 HTML version also exists of the linked file. For information related to
3705 linking files while publishing them to a publishing directory see *Note
3708 You can also give style information for the exported file. The HTML
3709 exporter assigns the following CSS classes to appropriate parts of the
3710 document - your style specifications may change these:
3712 .done the DONE keyword
3713 .timestamp time stamp
3714 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
3715 .tag tag in a headline
3716 .target target for links
3718 The default style specification can be configured through the option
3719 `org-export-html-style'. If you want to use a file-local style, you
3720 may use file variables, best wrapped into a COMMENT section at the end
3721 of the outline tree. For example:
3723 * COMMENT HTML style specifications
3726 # org-export-html-style: " <style type=\"text/css\">
3727 # p {font-weight: normal; color: gray; }
3728 # h1 {color: black; }
3732 Remember to execute `M-x normal-mode' after changing this to make
3733 the new style visible to Emacs. This command restarts org-mode for the
3734 current buffer and forces Emacs to re-evaluate the local variables
3735 section in the buffer.
3738 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
3743 Org-mode contains an exporter that produces XOXO-style output.
3744 Currently, this exporter only handles the general outline structure and
3745 does not interpret any additional Org-mode features.
3748 Export as XOXO file `myfile.html'.
3751 Export only the visible part of the document.
3754 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
3756 10.4 iCalendar export
3757 =====================
3759 Some people like to use Org-mode for keeping track of projects, but
3760 still prefer a standard calendar application for anniversaries and
3761 appointments. In this case it can be useful to have deadlines and
3762 other time-stamped items in Org-mode files show up in the calendar
3763 application. Org-mode can export calendar information in the standard
3767 Create iCalendar entries for the current file and store them in
3768 the same directory, using a file extension `.ics'.
3771 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
3772 For each of these files, a separate iCalendar file will be
3776 Create a single large iCalendar file from all files in
3777 `org-agenda-files' and write it to the file given by
3778 `org-combined-agenda-icalendar-file'.
3780 How this calendar is best read and updated, depends on the
3781 application you are using. For example, when using iCal under Apple
3782 MacOS X, you could create a new calendar `OrgMode' (the default name
3783 for the calendar created by `C-c C-e c', see the variables
3784 `org-icalendar-combined-name' and
3785 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
3786 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
3787 use AppleScript to make iCal re-read the calendar files each time a new
3788 version of `OrgMode.ics' is produced. Here is the setup needed for
3791 (setq org-combined-agenda-icalendar-file
3792 "~/Library/Calendars/OrgMode.ics")
3793 (add-hook 'org-after-save-iCalendar-file-hook
3796 "osascript -e 'tell application \"iCal\" to reload calendars'")))
3799 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
3801 10.5 Text interpretation by the exporter
3802 ========================================
3804 The exporter backends interpret additional structure in the Org-mode
3805 file in order to produce better output.
3809 * Comment lines:: Some lines will not be exported
3810 * Enhancing text:: Subscripts, symbols and more
3811 * Export options:: How to influence the export settings
3814 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
3816 10.5.1 Comment lines
3817 --------------------
3819 Lines starting with `#' in column zero are treated as comments and will
3820 never be exported. Also entire subtrees starting with the word
3821 `COMMENT' will never be exported. Finally, any text before the first
3822 headline will not be exported either.
3825 Toggle the COMMENT keyword at the beginning of an entry.
3828 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
3830 10.5.2 Enhancing text for export
3831 --------------------------------
3833 Some of the export backends of Org-mode allow for sophisticated text
3834 formatting, this is true in particular for the HTML backend. Org-mode
3835 has a number of typing conventions that allow to produce a richly
3838 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
3839 enumerator will be recognized and transformed if the backend
3840 supports lists. See *Note Plain lists::.
3842 * You can make words *bold*, /italic/, _underlined_, `=code=', and
3845 * Many TeX macros and entire LaTeX fragments are converted into HTML
3846 entities or images (*note Embedded LaTeX::).
3848 * Tables are transformed into native tables under the exporter, if
3849 the export backend supports this. Data fields before the first
3850 horizontal separator line will be formatted as table header fields.
3852 * If a headline starts with the word `QUOTE', the text below the
3853 headline will be typeset as fixed-width, to allow quoting of
3854 computer codes etc. Lines starting with `:' are also typeset in
3857 Toggle fixed-width for entry (QUOTE) or region, see below.
3859 * A double backslash _at the end of a line_ enforces a line break at
3862 If these conversions conflict with your habits of typing ASCII text,
3863 they can all be turned off with corresponding variables (see the
3864 customization group `org-export-general', and the following section
3865 which explains how to set export options with special lines in a buffer.
3868 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
3870 10.5.3 Export options
3871 ---------------------
3873 The exporter recognizes special lines in the buffer which provide
3874 additional information. These lines may be put anywhere in the file.
3875 The whole set of lines can be inserted into the buffer with `C-c C-e
3876 t'. For individual lines, a good way to make sure the keyword is
3877 correct is to type `#+' and then use `M-<TAB>' completion (*note
3881 Insert template with export options, see example below.
3883 #+TITLE: the title to be shown (default is the buffer name)
3884 #+AUTHOR: the author (default taken from `user-full-name')
3885 #+EMAIL: his/her email address (default from `user-mail-address')
3886 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
3887 #+TEXT: Some descriptive text to be inserted at the beginning.
3888 #+TEXT: Several lines may be given.
3889 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
3891 The OPTIONS line is a compact form to specify export settings. Here
3893 H: set the number of headline levels for export
3894 num: turn on/off section-numbers
3895 toc: turn on/off table of contents
3896 \n: turn on/off linebreak-preservation
3897 @: turn on/off quoted HTML tags
3898 :: turn on/off fixed-width sections
3899 |: turn on/off tables
3900 ^: turn on/off TeX-like syntax for sub- and superscripts.
3901 *: turn on/off emphasized text (bold, italic, underlined)
3902 TeX: turn on/off simple TeX macros in plain text
3903 LaTeX: turn on/off LaTeX fragments
3906 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
3911 Org-mode includes(1) a publishing management system that allows you to
3912 configure automatic HTML conversion of _projects_ composed of
3913 interlinked org files. This system is called _org-publish_. You can
3914 also configure org-publish to automatically upload your exported HTML
3915 pages and related attachments, such as images and source code files, to
3916 a web server. Org-publish turns org-mode into a web-site authoring
3919 Org-publish has been contributed to Org-mode by David O'Toole.
3923 * Configuration:: Defining projects
3924 * Sample configuration:: Example projects
3925 * Triggering publication:: Publication commands
3927 ---------- Footnotes ----------
3929 (1) `org-publish.el' is not yet part of Emacs, so if you are using
3930 `org.el' as it comes with Emacs, you need to download this file
3931 separately. Also make sure org.el is at least version 4.27.
3934 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
3939 Publishing needs significant configuration to specify files, destination
3940 and many other properties of a project.
3944 * Project alist:: The central configuration variable
3945 * Sources and destinations:: From here to there
3946 * Selecting files:: What files are part of the project?
3947 * Publishing action:: Setting the function doing the publishing
3948 * Publishing options:: Tweaking HTML export
3949 * Publishing links:: Which links keep working after publishing?
3950 * Project page index:: Publishing a list of project files
3953 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
3955 11.1.1 The variable `org-publish-project-alist'
3956 -----------------------------------------------
3958 Org-publish is configured almost entirely through setting the value of
3959 one variable, called `org-publish-project-alist'. Each element of the
3960 list configures one project, and may be in one of the two following
3963 ("project-name" :property value :property value ...)
3967 ("project-name" :components ("project-name" "project-name" ...))
3969 In both cases, projects are configured by specifying property values.
3970 A project defines the set of files that will be published, as well as
3971 the publishing configuration to use when publishing those files. When
3972 a project takes the second form listed above, the individual members of
3973 the "components" property are taken to be components of the project,
3974 which group together files requiring different publishing options. When
3975 you publish such a "meta-project" all the components will also publish.
3978 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
3980 11.1.2 Sources and destinations for files
3981 -----------------------------------------
3983 Most properties are optional, but some should always be set. In
3984 particular, org-publish needs to know where to look for source files,
3985 and where to put published files.
3987 `:base-directory' Directory containing publishing source files
3988 `:publishing-directory'Directory (possibly remote) where output files
3990 `:preparation-function'Function called before starting publishing
3991 process, for example to run `make' for updating
3992 files to be published.
3995 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
3997 11.1.3 Selecting files
3998 ----------------------
4000 By default, all files with extension `.org' in the base directory are
4001 considered part of the project. This can be modified by setting the
4003 `:base-extension' Extension (without the dot!) of source files. This
4004 actually is a regular expression.
4005 `:exclude' Regular expression to match file names that should
4006 not be published, even though they have been selected
4007 on the basis of their extension.
4008 `:include' List of files to be included regardless of
4009 `:base-extension' and `:exclude'.
4012 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4014 11.1.4 Publishing Action
4015 ------------------------
4017 Publishing means that a file is copied to the destination directory and
4018 possibly transformed in the process. The default transformation is to
4019 export Org-mode files as HTML files, and this is done by the function
4020 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4021 export::). Other files like images only need to be copied to the
4022 publishing destination. For non-Org-mode files, you need to specify
4023 the publishing function.
4025 `:publishing-function' Function executing the publication of a file.
4026 This may also be a list of functions, which will
4027 all be called in turn.
4029 The function must accept two arguments: a property list containing at
4030 least a `:publishing-directory' property, and the name of the file to
4031 be published. It should take the specified file, make the necessary
4032 transformation (if any) and place the result into the destination
4033 folder. You can write your own publishing function, but `org-publish'
4034 provides one for attachments (files that only need to be copied):
4035 `org-publish-attachment'.
4038 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4040 11.1.5 Options for the HTML exporter
4041 ------------------------------------
4043 The property list can be used to set many export options for the HTML
4044 exporter. In most cases, these properties correspond to user variables
4045 in Org-mode. The table below lists these properties along with the
4046 variable they belong to. See the documentation string for the
4047 respective variable for details.
4049 `:language' `org-export-default-language'
4050 `:headline-levels' `org-export-headline-levels'
4051 `:section-numbers' `org-export-with-section-numbers'
4052 `:table-of-contents' `org-export-with-toc'
4053 `:archived-trees' `org-export-with-archived-trees'
4054 `:emphasize' `org-export-with-emphasize'
4055 `:sub-superscript' `org-export-with-sub-superscripts'
4056 `:TeX-macros' `org-export-with-TeX-macros'
4057 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4058 `:fixed-width' `org-export-with-fixed-width'
4059 `:timestamps' `org-export-with-timestamps'
4061 `:tags' `org-export-with-tags'
4063 `:tables' `org-export-with-tables'
4064 `:table-auto-headline' `org-export-highlight-first-table-line'
4065 `:style' `org-export-html-style'
4066 `:convert-org-links' `org-export-html-link-org-files-as-html'
4067 `:inline-images' `org-export-html-inline-images'
4068 `:expand-quoted-html' `org-export-html-expand'
4069 `:timestamp' `org-export-html-with-timestamp'
4070 `:publishing-directory'`org-export-publishing-directory'
4071 `:preamble' `org-export-html-preamble'
4072 `:postamble' `org-export-html-postamble'
4073 `:auto-preamble' `org-export-html-auto-preamble'
4074 `:auto-postamble' `org-export-html-auto-postamble'
4075 `:author' `user-full-name'
4076 `:email' `user-mail-address'
4078 When a property is given a value in org-publish-project-alist, its
4079 setting overrides the value of the corresponding user variable (if any)
4080 during publishing. options set within a file (*note Export options::),
4081 however, override everything.
4084 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4086 11.1.6 Links between published files
4087 ------------------------------------
4089 To create a link from one Org-mode file to another, you would use
4090 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4091 (*note Hyperlinks::). Upon publishing this link becomes a link to
4092 `foo.html'. In this way, you can interlink the pages of your "org web"
4093 project and the links will work as expected when you publish them to
4096 You may also link to related files, such as images. Provided you are
4097 careful with relative pathnames, and provided you have also configured
4098 org-publish to upload the related files, these links will work too.
4099 *Note Complex example:: for an example of this usage.
4101 Sometime an Org-mode file to be published may contain links that are
4102 only valid in your production environment, but not in the publishing
4103 location. In this case, use the property
4105 `:link-validation-function' Function to validate links
4107 to define a function for checking link validity. This function must
4108 accept two arguments, the file name and a directory relative to which
4109 the file name is interpreted in the production environment. If this
4110 function returns `nil', then the HTML generator will only insert a
4111 description into the HTML file, but no link. One option for this
4112 function is `org-publish-validate-link' which checks if the given file
4113 is part of any project in `org-publish-project-alist'.
4116 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4118 11.1.7 Project page index
4119 -------------------------
4121 The following properties may be used to control publishing of an index
4122 of files or summary page for a given project.
4124 `:auto-index' When non-nil, publish an index during
4125 org-publish-current-project or org-publish-all.
4126 `:index-filename' Filename for output of index. Defaults to `index.org'
4127 (which becomes `index.html').
4128 `:index-title' Title of index page. Defaults to name of file.
4129 `:index-function' Plugin function to use for generation of index.
4130 Defaults to `org-publish-org-index', which generates
4131 a plain list of links to all files in the project.
4134 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4136 11.2 Sample configuration
4137 =========================
4139 Below we provide two example configurations. The first one is a simple
4140 project publishing only a set of Org-mode files. The second example is
4141 more complex, with a multi-component project.
4145 * Simple example:: One-component publishing
4146 * Complex example:: A multi-component publishing example
4149 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4151 11.2.1 Example: simple publishing configuration
4152 -----------------------------------------------
4154 This example publishes a set of Org-mode files to the `public_html'
4155 directory on the local machine.
4157 (setq org-publish-project-alist
4159 :base-directory "~/org/"
4160 :publishing-directory "~/public_html"
4161 :section-numbers nil
4162 :table-of-contents nil
4163 :style "<link rel=stylesheet
4164 href=\"../other/mystyle.css\"
4165 type=\"text/css\">")))
4168 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4170 11.2.2 Example: complex publishing configuration
4171 ------------------------------------------------
4173 This more complicated example publishes an entire website, including
4174 org files converted to HTML, image files, emacs lisp source code, and
4175 stylesheets. The publishing-directory is remote and private files are
4178 To ensure that links are preserved, care should be taken to replicate
4179 your directory structure on the web server, and to use relative file
4180 paths. For example, if your org files are kept in `~/org' and your
4181 publishable images in `~/images', you'd link to an image with
4182 file:../images/myimage.png
4183 On the web server, the relative path to the image should be the
4184 same. You can accomplish this by setting up an "images" folder in the
4185 right place on the webserver, and publishing images to it.
4187 (setq org-publish-project-alist
4189 :base-directory "~/org/"
4190 :base-extension "org"
4191 :publishing-directory "/ssh:user@host:~/html/notebook/"
4192 :publishing-function org-publish-org-to-html
4193 :exclude "PrivatePage.org" ;; regexp
4195 :section-numbers nil
4196 :table-of-contents nil
4197 :style "<link rel=stylesheet
4198 href=\"../other/mystyle.css\" type=\"text/css\">"
4200 :auto-postamble nil)
4203 :base-directory "~/images/"
4204 :base-extension "jpg\\|gif\\|png"
4205 :publishing-directory "/ssh:user@host:~/html/images/"
4206 :publishing-function org-publish-attachment)
4209 :base-directory "~/other/"
4210 :base-extension "css\\|el"
4211 :publishing-directory "/ssh:user@host:~/html/other/"
4212 :publishing-function org-publish-attachment)
4213 ("website" :components ("orgfiles" "images" "other"))))
4216 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4218 11.3 Triggering publication
4219 ===========================
4221 Once org-publish is properly configured, you can publish with the
4222 following functions:
4225 Prompt for a specific project and publish all files that belong to
4229 Publish the project containing the current file.
4232 Publish only the current file.
4235 Publish all projects.
4237 Org uses timestamps to track when a file has changed. The above
4238 functions normally only publish changed files. You can override this and
4239 force publishing of all files by giving a prefix argument.
4242 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4249 * Completion:: M-TAB knows what you need
4250 * Customization:: Adapting Org-mode to your taste
4251 * In-buffer settings:: Overview of the #+KEYWORDS
4252 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4253 * Clean view:: Getting rid of leading stars in the outline
4254 * TTY keys:: Using Org-mode on a tty
4255 * Interaction:: Other Emacs packages
4256 * Bugs:: Things which do not work perfectly
4259 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
4264 Org-mode supports in-buffer completion. This type of completion does
4265 not make use of the minibuffer. You simply type a few letters into the
4266 buffer and use the key to complete text right there.
4269 Complete word at point
4270 * At the beginning of a headline, complete TODO keywords.
4272 * After `\', complete TeX symbols supported by the exporter.
4274 * After `*', complete headlines in the current buffer so that
4275 they can be used in search links like `[[*find this
4278 * After `:', complete tags. The list of tags is taken from the
4279 variable `org-tag-alist' (possibly set through the `#+TAGS'
4280 in-buffer option, *note Setting tags::), or it is created
4281 dynamically from all tags used in the current buffer.
4283 * After `#+', complete the special keywords like `TYP_TODO' or
4284 `OPTIONS' which set file-specific options for Org-mode. When
4285 the option keyword is already complete, pressing `M-<TAB>'
4286 again will insert example settings for this keyword.
4288 * In the line after `#+STARTUP: ', complete startup keywords,
4289 i.e. valid keys for this line.
4291 * Elsewhere, complete dictionary words using ispell.
4294 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
4299 There are more than 100 variables that can be used to customize
4300 Org-mode. For the sake of compactness of the manual, we are not
4301 describing the variables here. A structured overview of customization
4302 variables is available with `M-x org-customize'. Or select `Browse Org
4303 Group' from the `Org->Customization' menu. Many settings can also be
4304 activated on a per-file basis, by putting special lines into the buffer
4305 (*note In-buffer settings::).
4308 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
4310 12.3 Summary of in-buffer settings
4311 ==================================
4313 Org-mode uses special lines in the buffer to define settings on a
4314 per-file basis. These lines start with a `#+' followed by a keyword, a
4315 colon, and then individual words defining a setting. Several setting
4316 words can be in the same line, but you can also have multiple lines for
4317 the keyword. While these settings are described throughout the manual,
4318 here is a summary. After changing any of those lines in the buffer,
4319 press `C-c C-c' with the cursor still in the line to activate the
4320 changes immediately. Otherwise they become effective only when the
4321 file is visited again in a new Emacs session.
4324 This line sets options to be used at startup of org-mode, when an
4325 Org-mode file is being visited. The first set of options deals
4326 with the initial visibility of the outline tree. The
4327 corresponding variable for global default settings is
4328 `org-startup-folded', with a default value `t', which means
4330 overview top-level headlines only
4331 content all headlines
4332 showall no folding at all, show everything
4333 Then there are options for aligning tables upon visiting a file.
4334 This is useful in files containing narrowed table columns. The
4335 corresponding variable is `org-startup-align-all-tables', with a
4336 default value `nil'.
4337 align align all tables
4338 noalign don't align tables on startup
4339 Logging when a TODO item is marked DONE (variable `org-log-done')
4340 can be configured using these options.
4341 logging record a timestamp when an item is marked DONE
4342 nologging don't record when items are marked DONE
4343 Here are the options for hiding leading stars in outline headings.
4344 The corresponding variables are `org-hide-leading-stars' and
4345 `org-odd-levels-only', both with a default setting `nil' (meaning
4346 `showstars' and `oddeven').
4347 hidestars make all but one of the stars starting a headline invisible.
4348 showstars show all stars starting a headline
4349 odd allow only odd outline levels (1,3,...)
4350 oddeven allow all outline levels
4352 `#+SEQ_TODO: #+TYP_TODO:'
4353 These lines set the TODO keywords and their interpretation in the
4354 current file. The corresponding variables are `org-todo-keywords'
4355 and `org-todo-interpretation'.
4357 `#+TAGS: TAG1(c1) TAG2(c2)'
4358 These lines (several such lines are allowed) specify the legal
4359 tags in this file, and (potentially) the corresponding _fast tag
4360 selection_ keys. The corresponding variable is `org-tag-alist'.
4363 This line sets the category for the agenda file. The category
4364 applies for all subsequent lines until the next `#+CATEGORY' line,
4365 or the end of the file.
4368 This line contains the formulas for the table directly above the
4371 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
4372 These lines provide settings for exporting files. For more
4373 details see *Note Export options::.
4376 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
4378 12.4 The very busy C-c C-c key
4379 ==============================
4381 The key `C-c C-c' has many purposes in org-mode, which are all
4382 mentioned scattered throughout this manual. One specific function of
4383 this key is to add _tags_ to a headline (*note Tags::). In many other
4384 circumstances it means something like _Hey Org-mode, look here and
4385 update according to what you see here_. Here is a summary of what this
4386 means in different contexts.
4388 - If there are highlights in the buffer from the creation of a sparse
4389 tree, or from clock display, remove these highlights.
4391 - If the cursor is in one of the special `#+KEYWORD' lines, this
4392 triggers scanning the buffer for these lines and updating the
4395 - If the cursor is inside a table, realign the table. This command
4396 works even if the automatic table editor has been turned off.
4398 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
4401 - If the cursor is inside a table created by the `table.el' package,
4402 activate that table.
4404 - If the current buffer is a remember buffer, close the note and
4405 file it. With a prefix argument, file it, without further
4406 interaction, to the default location.
4408 - If the cursor is on a `<<<target>>>', update radio targets and
4409 corresponding links in this buffer.
4411 - If the cursor is in a plain list item with a checkbox, toggle the
4412 status of the checkbox.
4414 - If the cursor is on a numbered item in a plain list, renumber the
4418 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
4420 12.5 A cleaner outline view
4421 ===========================
4423 Some people find it noisy and distracting that the Org-mode headlines
4424 are starting with a potentially large number of stars. For example the
4425 tree from *Note Headlines:::
4427 * Top level headline
4433 * Another top level headline
4435 Unfortunately this is deeply ingrained into the code of Org-mode and
4436 cannot be easily changed. You can, however, modify the display in such
4437 a way that all leading stars become invisible and the outline more easy
4438 to read. To do this, customize the variable `org-hide-leading-stars'
4441 (setq org-hide-leading-stars t)
4443 or change this on a per-file basis with one of the lines (anywhere in
4446 #+STARTUP: showstars
4447 #+STARTUP: hidestars
4449 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
4452 With stars hidden, the tree becomes:
4454 * Top level headline
4460 * Another top level headline
4462 Note that the leading stars are not truly replaced by whitespace, they
4463 are only fontified with the face `org-hide' that uses the background
4464 color as font color. If are are not using either white or black
4465 background, you may have to customize this face to get the wanted
4466 effect. Another possibility is to set this font such that the extra
4467 stars are almost invisible, for example using the color `grey90' on a
4470 Things become cleaner still if you skip all the even levels and use
4471 only odd levels 1, 3, 5..., effectively adding two stars to go from one
4472 outline level to the next:
4474 * Top level headline
4480 * Another top level headline
4482 In order to make the structure editing and export commands handle this
4483 convention correctly, use
4485 (setq org-odd-levels-only t)
4487 or set this on a per-file basis with one of the following lines (don't
4488 forget to press `C-c C-c' with the cursor in the startup line to
4489 activate changes immediately).
4494 You can convert an Org-mode file from single-star-per-level to the
4495 double-star-per-level convention with `M-x org-convert-to-odd-levels
4496 RET' in that file. The reverse operation is `M-x
4497 org-convert-to-oddeven-levels'.
4500 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
4502 12.6 Using org-mode on a tty
4503 ============================
4505 Org-mode uses a number of keys that are not accessible on a tty. This
4506 applies to most special keys like cursor keys, <TAB> and <RET>, when
4507 these are combined with modifier keys like <Meta> and/or <Shift>.
4508 Org-mode uses these bindings because it needs to provide keys for a
4509 large number of commands, and because these keys appeared particularly
4510 easy to remember. In order to still be able to access the core
4511 functionality of Org-mode on a tty, alternative bindings are provided.
4512 Here is a complete list of these bindings, which are obviously more
4513 cumbersome to use. Note that sometimes a work-around can be better.
4514 For example changing a time stamp is really only fun with `S-<cursor>'
4515 keys. On a tty you would rather use `C-c .' to re-insert the
4518 Default Alternative 1 Alternative 2
4519 `S-<TAB>' `C-u <TAB>'
4520 `M-<left>' `C-c C-x l' `<Esc> <left>'
4521 `M-S-<left>'`C-c C-x L'
4522 `M-<right>' `C-c C-x r' `<Esc>
4524 `M-S-<right>'`C-c C-x R'
4525 `M-<up>' `C-c C-x u' `<Esc> <up>'
4526 `M-S-<up>' `C-c C-x U'
4527 `M-<down>' `C-c C-x d' `<Esc> <down>'
4528 `M-S-<down>'`C-c C-x D'
4529 `S-<RET>' `C-c C-x c'
4530 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
4531 `M-S-<RET>' `C-c C-x M'
4534 `S-<right>' `C-c C-x
4542 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
4544 12.7 Interaction with other packages
4545 ====================================
4547 Org-mode lives in the world of GNU Emacs and interacts in various ways
4548 with other code out there.
4552 * Cooperation:: Packages Org-mode cooperates with
4553 * Conflicts:: Packages that lead to conflicts
4556 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
4558 12.7.1 Packages that Org-mode cooperates with
4559 ---------------------------------------------
4561 `calc.el' by Dave Gillespie
4562 Org-mode uses the calc package for implementing spreadsheet
4563 functionality in its tables (*note Table calculations::).
4564 Org-modes checks for the availability of calc by looking for the
4565 function `calc-eval' which should be autoloaded in your setup if
4566 calc has been installed properly. As of Emacs 22, calc is part of
4567 the Emacs distribution. Another possibility for interaction
4568 between the two packages is using calc for embedded calculations.
4569 *Note Embedded Mode: (calc)Embedded Mode.
4571 `constants.el' by Carsten Dominik
4572 In a table formula (*note Table calculations::), it is possible to
4573 use names for natural constants or units. Instead of defining
4574 your own constants in the variable `org-table-formula-constants',
4575 install the `constants' package which defines a large number of
4576 constants and units, and lets you use unit prefixes like `M' for
4577 `Mega' etc. You will need version 2.0 of this package, available
4578 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
4579 the function `constants-get', which has to be autoloaded in your
4580 setup. See the installation instructions in the file
4583 `cdlatex.el' by Carsten Dominik
4584 Org-mode can make use of the cdlatex package to efficiently enter
4585 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
4587 `remember.el' by John Wiegley
4588 Org mode cooperates with remember, see *Note Remember::.
4589 `Remember.el' is not part of Emacs, find it on the web.
4591 `table.el' by Takaaki Ota
4592 Org mode cooperates with table.el, see *Note table.el::.
4593 `table.el' is part of Emacs 22.
4596 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
4598 12.7.2 Packages that lead to conflicts with Org-mode
4599 ----------------------------------------------------
4601 `allout.el' by Ken Manheimer
4602 Startup of Org-mode may fail with the error message
4603 `(wrong-type-argument keymapp nil)' when there is an outdated
4604 version `allout.el' on the load path, for example the version
4605 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
4606 will disappear. If for some reason you cannot do this, make sure
4607 that org.el is loaded _before_ `allout.el', for example by putting
4608 `(require 'org)' early enough into your `.emacs' file.
4610 `CUA.el' by Kim. F. Storm
4611 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4612 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4613 select and extend the region. If you want to use one of these
4614 packages along with Org-mode, configure the variable
4615 `org-CUA-compatible'. When set, Org-mode will move the following
4616 keybindings in org-mode files, and in the agenda buffer (but not
4617 during date selection).
4619 S-UP -> M-p S-DOWN -> M-n
4620 S-LEFT -> M-- S-RIGHT -> M-+
4623 Yes, these are unfortunately more difficult to remember. If you
4624 want to have other replacement keys, look at the variable
4625 `org-disputed-keys'.
4627 `windmove.el' by Hovav Shacham
4628 Also this package uses the `S-<cursor>' keys, so everything written
4629 in the paragraph above about CUA mode also applies here.
4632 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
4637 Here is a list of things that should work differently, but which I have
4638 found too hard to fix.
4640 * If a table field starts with a link, and if the corresponding table
4641 column is narrowed (*note Narrow columns::) to a width too small to
4642 display the link, the field would look entirely empty even though
4643 it is not. To prevent this, Org-mode throws an error. The
4644 work-around is to make the column wide enough to fit the link, or
4645 to add some text (at least 2 characters) before the link in the
4648 * Narrowing table columns does not work on XEmacs, because the
4649 `format' function does not transport text properties.
4651 * Text in an entry protected with the `QUOTE' keyword should not
4654 * When the application called by `C-c C-o' to open a file link fails
4655 (for example because the application does not exist or refuses to
4656 open the file), it does so silently. No error message is
4659 * The remote-editing commands in the agenda buffer cannot be undone
4660 with `undo' called from within the agenda buffer. But you can go
4661 to the corresponding buffer (using <TAB> or <RET> and execute
4664 * Recalculating a table line applies the formulas from left to right.
4665 If a formula uses _calculated_ fields further down the row,
4666 multiple recalculation may be needed to get all fields consistent.
4668 * A single letter cannot be made bold, for example `*a*'.
4670 * The exporters work well, but could be made more efficient.
4673 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
4675 Appendix A Extensions, Hooks and Hacking
4676 ****************************************
4678 This appendix lists extensions for Org-mode written by other authors.
4679 It also covers some aspects where users can easily extend the
4680 functionality of Org-mode.
4684 * Extensions:: Existing 3rd-part extensions
4685 * Dynamic blocks:: Automatically filled blocks
4688 File: org, Node: Extensions, Next: Dynamic blocks, Prev: Extensions and Hacking, Up: Extensions and Hacking
4690 A.1 Third-party extensions for Org-mode
4691 =======================================
4693 The following extensions for Org-mode have been written by other people:
4695 `org-mouse.el' by Piotr Zielinski
4696 This package implements extended mouse functionality for Org-mode.
4697 It allows you to cycle visibility and to edit the document
4698 structure with the mouse. Best of all, it provides a
4699 context-sensitive menu on <mouse-3> that changes depending on the
4700 context of a mouse-click. `org-mouse.el' is freely available at
4701 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
4703 `org-publish.el' by David O'Toole
4704 This package provides facilities for publishing related sets of
4705 Org-mode files together with linked files like images as a
4706 webpages. It is highly configurable and can be used for other
4707 publishing purposes as well. As of Org-mode version 4.30,
4708 `org-publish.el' is part of the Org-mode distribution. It is not
4709 yet part of Emacs, however, a delay caused by the preparations for
4710 the 22.1 release. In the mean time, `org-publish.el' can be
4711 downloaded from David's site:
4712 `http://dto.freeshell.org/e/org-publish.el'.
4714 `org-blog.el' by David O'Toole
4715 A blogging plug-in for `org-publish.el'.
4716 `http://dto.freeshell.org/notebook/OrgMode.html'.
4718 `org-blogging.el' by Bastien Guerry
4719 Publish Org-mode files as blogs.
4720 `http://www.cognition.ens.fr/~guerry/org-blogging.html'.
4723 File: org, Node: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
4728 Org-mode documents can contain _dynamic blocks_. These are specially
4729 marked regions that are updated by some user-written function. A good
4730 example for such a block is the clock table inserted by the command
4731 `C-c C-x C-r' (*note Clocking work time::).
4733 Dynamic block are enclosed by a BEGIN-END structure that assigns a
4734 name to the block and can also specify parameters for the function
4735 producing the content of the block.
4737 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
4741 Dynamic blocks are updated with the following commands
4744 Update dynamic block at point.
4747 Update all dynamic blocks in the current file.
4749 Updating a dynamic block means to remove all the text between BEGIN
4750 and END, parse the BEGIN line for parameters and then call the specific
4751 writer function for this block to insert the new content. For a block
4752 with name `myblock', the writer function is `org-dblock-write:myblock'
4753 with as only parameter a property list with the parameters given in the
4754 begin line. Here is a trivial example of a block that keeps track of
4755 when the block update function was last run:
4757 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
4761 The corresponding block writer function could look like this:
4763 (defun org-dblock-write:block-update-time (params)
4764 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
4765 (insert "Last block update at: "
4766 (format-time-string fmt (current-time)))))
4768 If you want to make sure that all dynamic blocks are always
4769 up-to-date, you could add the function `org-update-all-dblocks' to a
4770 hook, for example `before-save-hook'. `org-update-all-dblocks' is
4771 written in a way that is does nothing in buffers that are not in
4775 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
4777 Appendix B History and Acknowledgments
4778 **************************************
4780 Org-mode was borne in 2003, out of frustration over the user interface
4781 of the Emacs outline-mode. All I wanted was to make working with an
4782 outline tree possible without having to remember more than 10 commands
4783 just for hiding and unhiding parts of the outline tree, and to allow to
4784 restructure a tree easily. Visibility cycling and structure editing
4785 were originally implemented in the package `outline-magic.el', but
4786 quickly moved to the more general `org.el'. TODO entries, basic time
4787 stamps, and table support were added next, and highlight the two main
4788 goals that Org-mode still has today: To create a new, outline-based,
4789 plain text mode with innovative and intuitive editing features, and to
4790 incorporate project planning functionality directly into a notes file.
4792 Since the first release, hundreds of emails to me or on
4793 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
4794 feedback, new ideas, and sometimes even patches and add-on code. Many
4795 thanks to everyone who has helped to improve this package. I am trying
4796 to keep here a list of the people who had significant influence in
4797 shaping one or more aspects of Org-mode. The list may not be complete,
4798 if I have forgotten someone, please accept my apologies and let me know.
4800 * Thomas Baumann contributed the code for links to the MH-E email
4803 * Alex Bochannek provided a patch for rounding time stamps.
4805 * Charles Cave's suggestion sparked the implementation of templates
4808 * Pavel Chalmoviansky influenced the agenda treatment of items with
4811 * Gregory Chernov patched support for lisp forms into table
4812 calculations and improved XEmacs compatibility, in particular by
4813 porting `nouline.el' to XEmacs.
4815 * Sacha Chua suggested to copy some linking code from Planner.
4817 * Eddward DeVilla proposed and tested checkbox statistics.
4819 * Kees Dullemond inspired the use of narrowed tabled columns.
4821 * Christian Egli converted the documentation into TeXInfo format,
4822 patched CSS formatting into the HTML exporter, and inspired the
4825 * Nic Ferrier contributed mailcap and XOXO support.
4827 * Niels Giessen had the idea to automatically archive DONE trees.
4829 * Bastien Guerry provided extensive feedback.
4831 * Kai Grossjohann pointed out key-binding conflicts with other
4834 * Leon Liu asked for embedded LaTeX and tested it.
4836 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
4839 * Todd Neal provided patches for links to Info files and elisp forms.
4841 * Tim O'Callaghan suggested in-file links, search options for general
4842 file links, and TAGS.
4844 * Oliver Oppitz suggested multi-state TODO items.
4846 * Scott Otterson sparked the introduction of descriptive text for
4847 links, among other things.
4849 * Pete Phillips helped during the development of the TAGS feature,
4850 and provided frequent feedback.
4852 * T.V. Raman reported bugs and suggested improvements.
4854 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
4857 * Kevin Rogers contributed code to access VM files on remote hosts.
4859 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
4860 conflict with `allout.el'.
4862 * Jason Riedy sent a patch to fix a bug with export of TODO keywerds.
4864 * Philip Rooke created the Org-mode reference card and provided lots
4867 * Christian Schlauer proposed angular brackets around links, among
4870 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
4871 `organizer-mode.el'.
4873 * Daniel Sinder came up with the idea of internal archiving by
4876 * David O'Toole wrote `org-publish.el' and drafted the manual
4877 chapter about publishing.
4879 * Ju"rgen Vollmer contributed code generating the table of contents
4882 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
4884 * David Wainberg suggested archiving, and improvements to the linking
4887 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
4888 development of Org-mode was fully independent, and both systems are
4889 really different beasts in their basic ideas and implementation
4890 details. I later looked at John's code, however, and learned from
4891 his implementation of (i) links where the link itself is hidden
4892 and only a description is shown, and (ii) popping up a calendar to
4895 * Carsten Wimmer suggested some changes and helped fix a bug in
4898 * Roland Winkler requested additional keybindings to make Org-mode
4901 * Piotr Zielinski wrote `org-mouse.el', proposed angenda blocks and
4902 contributed various ideas and code snippets.
4905 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
4913 * acknowledgments: History and Acknowledgments.
4915 * action, for publishing: Publishing action. (line 6)
4916 * activation: Activation. (line 6)
4917 * active region <1>: HTML export. (line 10)
4918 * active region <2>: ASCII export. (line 9)
4919 * active region <3>: Built-in table editor.
4921 * active region: Structure editing. (line 51)
4922 * agenda: Weekly/Daily agenda. (line 6)
4923 * agenda dispatcher: Agenda dispatcher. (line 6)
4924 * agenda files: Agenda files. (line 6)
4925 * agenda files, removing buffers: Agenda commands. (line 211)
4926 * agenda views: Agenda views. (line 6)
4927 * agenda views, custom: Custom agenda views. (line 6)
4928 * agenda, with block views: Block agenda. (line 6)
4929 * allout.el: Conflicts. (line 6)
4930 * angular brackets, around links: External links. (line 38)
4931 * applescript, for calendar update: iCalendar export. (line 38)
4932 * archive locations: Moving subtrees. (line 21)
4933 * archiving: Archiving. (line 6)
4934 * ASCII export: ASCII export. (line 6)
4935 * author: Feedback. (line 6)
4936 * autoload: Activation. (line 6)
4937 * BBDB links: External links. (line 6)
4938 * block agenda: Block agenda. (line 6)
4939 * bold text: Enhancing text. (line 15)
4940 * bug reports: Feedback. (line 6)
4941 * bugs: Bugs. (line 6)
4942 * calc package: Table calculations. (line 6)
4943 * calc.el: Cooperation. (line 6)
4944 * calculations, in tables <1>: Table calculations. (line 6)
4945 * calculations, in tables: Built-in table editor.
4947 * calendar commands, from agenda: Agenda commands. (line 172)
4948 * calendar integration: Calendar/Diary integration.
4950 * calendar, for selecting date: Creating timestamps. (line 71)
4951 * CamelCase link completion: Completion. (line 6)
4952 * CamelCase links: Internal links. (line 6)
4953 * CamelCase links, completion of: CamelCase links. (line 6)
4954 * category: Categories. (line 6)
4955 * cdlatex.el: Cooperation. (line 29)
4956 * checkbox statistics: Checkboxes. (line 23)
4957 * checkboxes: Checkboxes. (line 6)
4958 * children, subtree visibility state: Visibility cycling. (line 10)
4959 * clean outline view: Clean view. (line 6)
4960 * CLOCK keyword: Time stamps. (line 61)
4961 * CLOSED keyword: Time stamps. (line 55)
4962 * column formula: Column formulas. (line 6)
4963 * commands, in agenda buffer: Agenda commands. (line 6)
4964 * comment lines: Comment lines. (line 6)
4965 * completion, of CamelCase links <1>: Completion. (line 6)
4966 * completion, of CamelCase links: CamelCase links. (line 6)
4967 * completion, of dictionary words: Completion. (line 6)
4968 * completion, of file names: Handling links. (line 43)
4969 * completion, of links: Handling links. (line 27)
4970 * completion, of option keywords <1>: Completion. (line 6)
4971 * completion, of option keywords: Export options. (line 6)
4972 * Completion, of option keywords: Per file keywords. (line 17)
4973 * completion, of tags <1>: Completion. (line 6)
4974 * completion, of tags: Setting tags. (line 11)
4975 * completion, of TeX symbols: Completion. (line 6)
4976 * completion, of TODO keywords <1>: Completion. (line 6)
4977 * completion, of TODO keywords: Workflow states. (line 12)
4978 * constants, in calculations: Formula syntax. (line 26)
4979 * constants.el: Cooperation. (line 14)
4980 * contents, global visibility state: Visibility cycling. (line 22)
4981 * copying, of subtrees: Structure editing. (line 6)
4982 * creating timestamps: Creating timestamps. (line 6)
4983 * CUA.el: Conflicts. (line 15)
4984 * custom agenda views: Custom agenda views. (line 6)
4985 * custom search strings: Custom searches. (line 6)
4986 * customization: Customization. (line 6)
4987 * cutting, of subtrees: Structure editing. (line 6)
4988 * cycling, of TODO states: TODO basics. (line 13)
4989 * cycling, visibility: Visibility cycling. (line 6)
4990 * daily agenda: Weekly/Daily agenda. (line 6)
4991 * date stamps: Time stamps. (line 6)
4992 * date, reading in minibuffer: Creating timestamps. (line 71)
4993 * DEADLINE keyword: Time stamps. (line 43)
4994 * deadlines: Time stamps. (line 6)
4995 * demotion, of subtrees: Structure editing. (line 6)
4996 * diary entries, creating from agenda: Agenda commands. (line 179)
4997 * diary integration: Calendar/Diary integration.
4999 * dictionary word completion: Completion. (line 6)
5000 * directories, for publishing: Sources and destinations.
5002 * dispatching agenda commands: Agenda dispatcher. (line 6)
5003 * display changing, in agenda: Agenda commands. (line 59)
5004 * document structure: Document structure. (line 6)
5005 * DONE, final TODO keyword: Per file keywords. (line 20)
5006 * editing tables: Tables. (line 6)
5007 * editing, of table formulas: Editing/debugging formulas.
5009 * elisp links: External links. (line 6)
5010 * emphasized text: Export options. (line 25)
5011 * enhancing text: Enhancing text. (line 6)
5012 * evaluate time range: Creating timestamps. (line 66)
5013 * exporting: Exporting. (line 6)
5014 * exporting, not: Comment lines. (line 6)
5015 * extended TODO keywords: TODO extensions. (line 6)
5016 * external archiving: Moving subtrees. (line 6)
5017 * external links: External links. (line 6)
5018 * external links, in HTML export: HTML export. (line 35)
5019 * FAQ: Summary. (line 41)
5020 * feedback: Feedback. (line 6)
5021 * file links: External links. (line 6)
5022 * file links, searching: Search options. (line 6)
5023 * file name completion: Handling links. (line 43)
5024 * files, adding to agenda list: Agenda files. (line 12)
5025 * files, selecting for publishing: Selecting files. (line 6)
5026 * fixed width: Enhancing text. (line 25)
5027 * fixed-width sections: Export options. (line 25)
5028 * folded, subtree visibility state: Visibility cycling. (line 10)
5029 * folding, sparse trees: Sparse trees. (line 6)
5030 * following links: Handling links. (line 58)
5031 * format specifier: Formula syntax. (line 34)
5032 * format, of links: Link format. (line 6)
5033 * formula editing: Editing/debugging formulas.
5035 * formula syntax: Formula syntax. (line 6)
5036 * formula, for named table field: Named-field formulas.
5038 * formula, for table column: Column formulas. (line 6)
5039 * formula, in tables: Built-in table editor.
5041 * global cycling: Visibility cycling. (line 22)
5042 * global keybindings: Activation. (line 6)
5043 * global TODO list: Global TODO list. (line 6)
5044 * global visibility states: Visibility cycling. (line 22)
5045 * GNUS links: External links. (line 6)
5046 * hand-formatted lists: Enhancing text. (line 11)
5047 * headline levels: Export options. (line 25)
5048 * headline levels, for exporting <1>: HTML export. (line 21)
5049 * headline levels, for exporting: ASCII export. (line 18)
5050 * headline navigation: Motion. (line 6)
5051 * headline tagging: Tags. (line 6)
5052 * headline, promotion and demotion: Structure editing. (line 6)
5053 * headlines: Headlines. (line 6)
5054 * hide text: Visibility cycling. (line 6)
5055 * hiding leading stars: Clean view. (line 6)
5056 * history: History and Acknowledgments.
5058 * HTML export: HTML export. (line 6)
5059 * hyperlinks: Hyperlinks. (line 6)
5060 * iCalendar export: iCalendar export. (line 6)
5061 * in-buffer settings: In-buffer settings. (line 6)
5062 * index, of published pages: Project page index. (line 6)
5063 * Info links: External links. (line 6)
5064 * inheritance, of tags: Tag inheritance. (line 6)
5065 * inserting links: Handling links. (line 27)
5066 * installation: Installation. (line 6)
5067 * internal archiving: ARCHIVE tag. (line 6)
5068 * internal links: Internal links. (line 6)
5069 * internal links, in HTML export: HTML export. (line 35)
5070 * introduction: Introduction. (line 6)
5071 * italic text: Enhancing text. (line 15)
5072 * jumping, to headlines: Motion. (line 6)
5073 * keybindings, global: Activation. (line 6)
5074 * keyword options: Per file keywords. (line 6)
5075 * LaTeX fragments: Export options. (line 25)
5076 * LaTeX fragments, export: Enhancing text. (line 18)
5077 * LaTeX interpretation: Embedded LaTeX. (line 6)
5078 * linebreak preservation: Export options. (line 25)
5079 * linebreak, forced: Enhancing text. (line 32)
5080 * link completion: Handling links. (line 27)
5081 * link format: Link format. (line 6)
5082 * links, external: External links. (line 6)
5083 * links, in HTML export: HTML export. (line 35)
5084 * links, internal: Internal links. (line 6)
5085 * links, publishing: Publishing links. (line 6)
5086 * links, returning to: Handling links. (line 84)
5087 * Lisp forms, as table formulas: Lisp formulas. (line 6)
5088 * lists, hand-formatted: Enhancing text. (line 11)
5089 * lists, ordered: Plain lists. (line 6)
5090 * lists, plain: Plain lists. (line 6)
5091 * logging, of progress: Progress logging. (line 6)
5092 * maintainer: Feedback. (line 6)
5093 * mark ring: Handling links. (line 80)
5094 * marking characters, tables: Advanced features. (line 34)
5095 * matching, of tags: Matching headline tags.
5097 * matching, tags: Tags. (line 6)
5098 * MH-E links: External links. (line 6)
5099 * minor mode for tables: orgtbl-mode. (line 6)
5100 * mode, for calc: Formula syntax. (line 34)
5101 * motion commands in agenda: Agenda commands. (line 19)
5102 * motion, between headlines: Motion. (line 6)
5103 * name, of column or field: Formula syntax. (line 26)
5104 * named field formula: Named-field formulas.
5106 * names as TODO keywords: TODO types. (line 6)
5107 * narrow columns in tables: Narrow columns. (line 6)
5108 * occur, command: Sparse trees. (line 6)
5109 * option keyword completion: Completion. (line 6)
5110 * options, for custom agenda views: Setting Options. (line 6)
5111 * options, for customization: Customization. (line 6)
5112 * options, for export: Export options. (line 6)
5113 * options, for publishing: Publishing options. (line 6)
5114 * ordered lists: Plain lists. (line 6)
5115 * org-agenda, command: Weekly/Daily agenda. (line 9)
5116 * org-blog.el: Extensions. (line 25)
5117 * org-blogging.el: Extensions. (line 29)
5118 * org-mode, turning on: Activation. (line 22)
5119 * org-mouse.el: Extensions. (line 8)
5120 * org-publish-project-alist: Project alist. (line 6)
5121 * org-publish.el: Extensions. (line 14)
5122 * orgtbl-mode: orgtbl-mode. (line 6)
5123 * outline tree: Headlines. (line 6)
5124 * outline-mode: Outlines. (line 6)
5125 * outlines: Outlines. (line 6)
5126 * overview, global visibility state: Visibility cycling. (line 22)
5127 * packages, interaction with other: Interaction. (line 6)
5128 * pasting, of subtrees: Structure editing. (line 6)
5129 * per file keywords: Per file keywords. (line 6)
5130 * plain lists: Plain lists. (line 6)
5131 * plain text external links: External links. (line 38)
5132 * presentation, of agenda items: Presentation and sorting.
5134 * printing sparse trees: Sparse trees. (line 41)
5135 * priorities: Priorities. (line 6)
5136 * priorities, of agenda items: Sorting of agenda items.
5138 * progress logging: Progress logging. (line 6)
5139 * projects, for publishing: Project alist. (line 6)
5140 * promotion, of subtrees: Structure editing. (line 6)
5141 * publishing: Publishing. (line 6)
5142 * quoted HTML tags: Export options. (line 25)
5143 * ranges, time: Time stamps. (line 6)
5144 * recomputing table fields: Column formulas. (line 27)
5145 * region, active <1>: HTML export. (line 10)
5146 * region, active <2>: ASCII export. (line 9)
5147 * region, active <3>: Built-in table editor.
5149 * region, active: Structure editing. (line 51)
5150 * remember.el <1>: Cooperation. (line 33)
5151 * remember.el: Remember. (line 6)
5152 * remote editing, from agenda: Agenda commands. (line 100)
5153 * richer text: Enhancing text. (line 6)
5154 * RMAIL links: External links. (line 6)
5155 * SCHEDULED keyword: Time stamps. (line 30)
5156 * scheduling: Time stamps. (line 6)
5157 * search option in file links: Search options. (line 6)
5158 * section-numbers: Export options. (line 25)
5159 * setting tags: Setting tags. (line 6)
5160 * SHELL links: External links. (line 6)
5161 * show all, command: Visibility cycling. (line 31)
5162 * show all, global visibility state: Visibility cycling. (line 22)
5163 * show hidden text: Visibility cycling. (line 6)
5164 * sorting, of agenda items: Sorting of agenda items.
5166 * sparse tree, for deadlines: Creating timestamps. (line 41)
5167 * sparse tree, for TODO: TODO basics. (line 26)
5168 * sparse tree, tag based: Tags. (line 6)
5169 * sparse trees: Sparse trees. (line 6)
5170 * special keywords: In-buffer settings. (line 6)
5171 * spreadsheet capabilities: Table calculations. (line 6)
5172 * statistics, for checkboxes: Checkboxes. (line 23)
5173 * storing links: Handling links. (line 9)
5174 * structure editing: Structure editing. (line 6)
5175 * structure of document: Document structure. (line 6)
5176 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
5177 * sublevels, inclusion into todo list: Global TODO list. (line 31)
5178 * subtree cycling: Visibility cycling. (line 10)
5179 * subtree visibility states: Visibility cycling. (line 10)
5180 * subtree, cut and paste: Structure editing. (line 6)
5181 * subtree, subtree visibility state: Visibility cycling. (line 10)
5182 * subtrees, cut and paste: Structure editing. (line 6)
5183 * summary: Summary. (line 6)
5184 * syntax, of formulas: Formula syntax. (line 6)
5185 * table editor, builtin: Built-in table editor.
5187 * table editor, table.el: table.el. (line 6)
5188 * table of contents: Export options. (line 25)
5189 * table.el <1>: Cooperation. (line 34)
5190 * table.el: table.el. (line 6)
5191 * tables <1>: Export options. (line 25)
5192 * tables: Tables. (line 6)
5193 * tables, export: Enhancing text. (line 21)
5194 * tag completion: Completion. (line 6)
5195 * tag searches: Tag searches. (line 6)
5196 * tags: Tags. (line 6)
5197 * tags view: Matching headline tags.
5199 * tasks, breaking down: Breaking down tasks. (line 6)
5200 * templates, for remember: Remember. (line 23)
5201 * TeX interpretation: Embedded LaTeX. (line 6)
5202 * TeX macros: Export options. (line 25)
5203 * TeX macros, export: Enhancing text. (line 18)
5204 * TeX symbol completion: Completion. (line 6)
5205 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
5206 * thanks: History and Acknowledgments.
5208 * time grid: Time-of-day specifications.
5210 * time stamps: Time stamps. (line 6)
5211 * time, reading in minibuffer: Creating timestamps. (line 71)
5212 * time-of-day specification: Time-of-day specifications.
5214 * time-sorted view: Timeline. (line 6)
5215 * timeline, single file: Timeline. (line 6)
5216 * timerange: Time stamps. (line 21)
5217 * timestamp: Time stamps. (line 13)
5218 * timestamps, creating: Creating timestamps. (line 6)
5219 * TODO items: TODO items. (line 6)
5220 * TODO keywords completion: Completion. (line 6)
5221 * TODO list, global: Global TODO list. (line 6)
5222 * TODO types: TODO types. (line 6)
5223 * TODO workflow: Workflow states. (line 6)
5224 * transient-mark-mode <1>: HTML export. (line 10)
5225 * transient-mark-mode <2>: ASCII export. (line 9)
5226 * transient-mark-mode <3>: Built-in table editor.
5228 * transient-mark-mode: Structure editing. (line 51)
5229 * trees, sparse: Sparse trees. (line 6)
5230 * trees, visibility: Visibility cycling. (line 6)
5231 * tty keybindings: TTY keys. (line 6)
5232 * types as TODO keywords: TODO types. (line 6)
5233 * underlined text: Enhancing text. (line 15)
5234 * URL links: External links. (line 6)
5235 * USENET links: External links. (line 6)
5236 * variables, for customization: Customization. (line 6)
5237 * vectors, in table calculations: Formula syntax. (line 23)
5238 * visibility cycling: Visibility cycling. (line 6)
5239 * visible text, printing: Sparse trees. (line 41)
5240 * VM links: External links. (line 6)
5241 * WANDERLUST links: External links. (line 6)
5242 * weekly agenda: Weekly/Daily agenda. (line 6)
5243 * windmove.el: Conflicts. (line 33)
5244 * workflow states as TODO keywords: Workflow states. (line 6)
5245 * XEmacs: Installation. (line 6)
5246 * XOXO export: XOXO export. (line 6)
5249 File: org, Node: Key Index, Prev: Index, Up: Top
5257 * ': CDLaTeX mode. (line 43)
5258 * +: Agenda commands. (line 126)
5259 * ,: Agenda commands. (line 118)
5260 * -: Agenda commands. (line 132)
5261 * .: Agenda commands. (line 94)
5262 * :: Agenda commands. (line 112)
5263 * <: Creating timestamps. (line 78)
5264 * <left>: Agenda commands. (line 91)
5265 * <RET> <1>: Agenda commands. (line 41)
5266 * <RET> <2>: Creating timestamps. (line 103)
5267 * <RET>: Built-in table editor.
5269 * <right>: Agenda commands. (line 86)
5270 * <SPC>: Agenda commands. (line 28)
5271 * <TAB> <1>: CDLaTeX mode. (line 23)
5272 * <TAB> <2>: Agenda commands. (line 35)
5273 * <TAB> <3>: Built-in table editor.
5275 * <TAB> <4>: Plain lists. (line 37)
5276 * <TAB>: Visibility cycling. (line 10)
5277 * > <1>: Agenda commands. (line 154)
5278 * >: Creating timestamps. (line 79)
5279 * ^: CDLaTeX mode. (line 33)
5280 * _: CDLaTeX mode. (line 33)
5281 * `: CDLaTeX mode. (line 39)
5282 * a: Agenda commands. (line 115)
5283 * C: Agenda commands. (line 194)
5284 * c: Agenda commands. (line 172)
5285 * C-#: Built-in table editor.
5287 * C-,: Agenda files. (line 18)
5288 * C-a a L: Timeline. (line 10)
5289 * C-c !: Creating timestamps. (line 21)
5290 * C-c #: Checkboxes. (line 55)
5291 * C-c $: Moving subtrees. (line 10)
5292 * C-c %: Handling links. (line 80)
5293 * C-c &: Handling links. (line 84)
5294 * C-c ' <1>: Editing/debugging formulas.
5296 * C-c ': Built-in table editor.
5298 * C-c *: Built-in table editor.
5300 * C-c +: Built-in table editor.
5302 * C-c ,: Priorities. (line 18)
5303 * C-c -: Built-in table editor.
5305 * C-c .: Creating timestamps. (line 10)
5306 * C-c /: Sparse trees. (line 15)
5307 * C-c :: Enhancing text. (line 29)
5308 * C-c ;: Comment lines. (line 11)
5309 * C-c <: Creating timestamps. (line 25)
5310 * C-c <TAB>: Built-in table editor.
5312 * C-c =: Built-in table editor.
5314 * C-c >: Creating timestamps. (line 29)
5315 * C-c ? <1>: Editing/debugging formulas.
5317 * C-c ?: Built-in table editor.
5319 * C-c [: Agenda files. (line 12)
5320 * C-c \: Tag searches. (line 9)
5321 * C-c ]: Agenda files. (line 15)
5322 * C-c ^: Built-in table editor.
5324 * C-c `: Built-in table editor.
5326 * C-c a a: Weekly/Daily agenda. (line 9)
5327 * C-c a C: Storing searches. (line 9)
5328 * C-c a M: Matching headline tags.
5330 * C-c a m: Matching headline tags.
5332 * C-c a M: Tag searches. (line 14)
5333 * C-c a m: Tag searches. (line 10)
5334 * C-c a T: Global TODO list. (line 14)
5335 * C-c a t <1>: Global TODO list. (line 9)
5336 * C-c a t: TODO basics. (line 33)
5337 * C-c C-a: Visibility cycling. (line 31)
5338 * C-c C-b: Motion. (line 15)
5339 * C-c C-c <1>: The very busy C-c C-c key.
5341 * C-c C-c <2>: Processing LaTeX fragments.
5343 * C-c C-c <3>: Setting tags. (line 10)
5344 * C-c C-c <4>: Checkboxes. (line 37)
5345 * C-c C-c <5>: table.el. (line 6)
5346 * C-c C-c <6>: Editing/debugging formulas.
5348 * C-c C-c <7>: Built-in table editor.
5350 * C-c C-c: Plain lists. (line 74)
5351 * C-c C-d <1>: Agenda commands. (line 139)
5352 * C-c C-d: Creating timestamps. (line 37)
5353 * C-c C-e: Exporting. (line 19)
5354 * C-c C-e a: ASCII export. (line 9)
5355 * C-c C-e b: HTML export. (line 11)
5356 * C-c C-e c: iCalendar export. (line 20)
5357 * C-c C-e h: HTML export. (line 10)
5358 * C-c C-e I: iCalendar export. (line 15)
5359 * C-c C-e i: iCalendar export. (line 13)
5360 * C-c C-e t: Export options. (line 13)
5361 * C-c C-e v <1>: XOXO export. (line 11)
5362 * C-c C-e v: Sparse trees. (line 41)
5363 * C-c C-e v a: ASCII export. (line 13)
5364 * C-c C-e v b: HTML export. (line 14)
5365 * C-c C-e v h: HTML export. (line 14)
5366 * C-c C-e x: XOXO export. (line 10)
5367 * C-c C-f: Motion. (line 12)
5368 * C-c C-j: Motion. (line 21)
5369 * C-c C-l: Handling links. (line 27)
5370 * C-c C-n: Motion. (line 8)
5371 * C-c C-o <1>: Creating timestamps. (line 33)
5372 * C-c C-o: Handling links. (line 58)
5373 * C-c C-p: Motion. (line 9)
5374 * C-c C-q <1>: Editing/debugging formulas.
5376 * C-c C-q: Built-in table editor.
5378 * C-c C-s <1>: Agenda commands. (line 136)
5379 * C-c C-s: Creating timestamps. (line 48)
5380 * C-c C-t <1>: Clocking work time. (line 25)
5381 * C-c C-t: TODO basics. (line 13)
5382 * C-c C-u: Motion. (line 18)
5383 * C-c C-v: TODO basics. (line 26)
5384 * C-c C-w: Creating timestamps. (line 41)
5385 * C-c C-x C-a: ARCHIVE tag. (line 28)
5386 * C-c C-x C-b: Checkboxes. (line 38)
5387 * C-c C-x C-c: Agenda commands. (line 201)
5388 * C-c C-x C-d: Clocking work time. (line 33)
5389 * C-c C-x C-i: Clocking work time. (line 12)
5390 * C-c C-x C-k: Structure editing. (line 36)
5391 * C-c C-x C-l: Processing LaTeX fragments.
5393 * C-c C-x C-o: Clocking work time. (line 14)
5394 * C-c C-x C-r: Clocking work time. (line 40)
5395 * C-c C-x C-u: Dynamic blocks. (line 21)
5396 * C-c C-x C-w <1>: Built-in table editor.
5398 * C-c C-x C-w: Structure editing. (line 36)
5399 * C-c C-x C-x: Clocking work time. (line 29)
5400 * C-c C-x C-y <1>: Built-in table editor.
5402 * C-c C-x C-y: Structure editing. (line 43)
5403 * C-c C-x M-w <1>: Built-in table editor.
5405 * C-c C-x M-w: Structure editing. (line 40)
5406 * C-c C-y <1>: Clocking work time. (line 20)
5407 * C-c C-y: Creating timestamps. (line 66)
5408 * C-c l: Handling links. (line 9)
5409 * C-c {: CDLaTeX mode. (line 21)
5410 * C-c |: Built-in table editor.
5412 * C-c ~: table.el. (line 18)
5413 * C-TAB: ARCHIVE tag. (line 38)
5414 * C-u C-c $: Moving subtrees. (line 12)
5415 * C-u C-c .: Creating timestamps. (line 16)
5416 * C-u C-c =: Built-in table editor.
5418 * C-u C-c C-l: Handling links. (line 43)
5419 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
5420 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
5421 * C-u C-c C-x C-u: Clocking work time. (line 67)
5422 * D: Agenda commands. (line 68)
5423 * d: Agenda commands. (line 65)
5424 * f: Agenda commands. (line 44)
5425 * g: Agenda commands. (line 72)
5426 * H: Agenda commands. (line 198)
5427 * i: Agenda commands. (line 179)
5428 * I: Agenda commands. (line 159)
5429 * l: Agenda commands. (line 51)
5430 * L: Agenda commands. (line 32)
5431 * M: Agenda commands. (line 185)
5432 * M-<down>: Built-in table editor.
5434 * M-<left> <1>: Built-in table editor.
5436 * M-<left>: Structure editing. (line 18)
5437 * M-<RET> <1>: Plain lists. (line 42)
5438 * M-<RET>: Structure editing. (line 6)
5439 * M-<right> <1>: Built-in table editor.
5441 * M-<right>: Structure editing. (line 21)
5442 * M-<TAB> <1>: Completion. (line 10)
5443 * M-<TAB> <2>: Setting tags. (line 6)
5444 * M-<TAB>: Per file keywords. (line 17)
5445 * M-<up>: Built-in table editor.
5447 * M-S-<down> <1>: Built-in table editor.
5449 * M-S-<down> <2>: Plain lists. (line 59)
5450 * M-S-<down>: Structure editing. (line 33)
5451 * M-S-<left> <1>: Creating timestamps. (line 100)
5452 * M-S-<left> <2>: Built-in table editor.
5454 * M-S-<left> <3>: Plain lists. (line 65)
5455 * M-S-<left>: Structure editing. (line 24)
5456 * M-S-<RET> <1>: Checkboxes. (line 52)
5457 * M-S-<RET> <2>: Plain lists. (line 52)
5458 * M-S-<RET>: Structure editing. (line 15)
5459 * M-S-<right> <1>: Creating timestamps. (line 97)
5460 * M-S-<right> <2>: Built-in table editor.
5462 * M-S-<right> <3>: Plain lists. (line 65)
5463 * M-S-<right>: Structure editing. (line 27)
5464 * M-S-<up> <1>: Built-in table editor.
5466 * M-S-<up> <2>: Plain lists. (line 59)
5467 * M-S-<up>: Structure editing. (line 30)
5468 * mouse-1 <1>: Agenda commands. (line 35)
5469 * mouse-1 <2>: Creating timestamps. (line 82)
5470 * mouse-1: Handling links. (line 72)
5471 * mouse-2 <1>: Agenda commands. (line 35)
5472 * mouse-2: Handling links. (line 72)
5473 * mouse-3 <1>: Agenda commands. (line 28)
5474 * mouse-3: Handling links. (line 77)
5475 * n: Agenda commands. (line 19)
5476 * O: Agenda commands. (line 161)
5477 * o: Agenda commands. (line 59)
5478 * P: Agenda commands. (line 123)
5479 * p: Agenda commands. (line 20)
5480 * q: Agenda commands. (line 208)
5481 * r <1>: Agenda commands. (line 76)
5482 * r: Global TODO list. (line 20)
5483 * S: Agenda commands. (line 189)
5484 * s: Agenda commands. (line 83)
5485 * S-<down> <1>: Agenda commands. (line 132)
5486 * S-<down> <2>: Creating timestamps. (line 58)
5487 * S-<down> <3>: Priorities. (line 25)
5488 * S-<down>: Plain lists. (line 55)
5489 * S-<left> <1>: Agenda commands. (line 150)
5490 * S-<left> <2>: Creating timestamps. (line 53)
5491 * S-<left>: TODO basics. (line 20)
5492 * S-<RET>: Built-in table editor.
5494 * S-<right> <1>: Agenda commands. (line 142)
5495 * S-<right> <2>: Creating timestamps. (line 53)
5496 * S-<right>: TODO basics. (line 20)
5497 * S-<TAB> <1>: Built-in table editor.
5499 * S-<TAB>: Visibility cycling. (line 22)
5500 * S-<up> <1>: Agenda commands. (line 126)
5501 * S-<up> <2>: Creating timestamps. (line 58)
5502 * S-<up> <3>: Priorities. (line 25)
5503 * S-<up>: Plain lists. (line 55)
5504 * T: Agenda commands. (line 107)
5505 * t: Agenda commands. (line 103)
5506 * w: Agenda commands. (line 62)
5507 * x: Agenda commands. (line 211)
5508 * X: Agenda commands. (line 164)
5514 Node: Introduction
\x7f10124
5515 Node: Summary
\x7f10539
5516 Node: Installation
\x7f12806
5517 Node: Activation
\x7f14184
5518 Node: Feedback
\x7f15433
5519 Node: Document structure
\x7f16202
5520 Node: Outlines
\x7f16976
5521 Node: Headlines
\x7f17636
5522 Node: Visibility cycling
\x7f18259
5523 Ref: Visibility cycling-Footnote-1
\x7f19734
5524 Ref: Visibility cycling-Footnote-2
\x7f19792
5525 Node: Motion
\x7f19842
5526 Node: Structure editing
\x7f20626
5527 Node: Archiving
\x7f22735
5528 Node: ARCHIVE tag
\x7f23293
5529 Node: Moving subtrees
\x7f25086
5530 Node: Sparse trees
\x7f26127
5531 Ref: Sparse trees-Footnote-1
\x7f28258
5532 Ref: Sparse trees-Footnote-2
\x7f28350
5533 Node: Plain lists
\x7f28465
5534 Ref: Plain lists-Footnote-1
\x7f31990
5535 Ref: Plain lists-Footnote-2
\x7f32347
5536 Node: Tables
\x7f32529
5537 Node: Built-in table editor
\x7f33077
5538 Node: Narrow columns
\x7f40685
5539 Ref: Narrow columns-Footnote-1
\x7f42624
5540 Node: Table calculations
\x7f42670
5541 Node: Formula syntax
\x7f43990
5542 Ref: Formula syntax-Footnote-1
\x7f46895
5543 Node: Lisp formulas
\x7f47195
5544 Node: Column formulas
\x7f47984
5545 Node: Advanced features
\x7f49746
5546 Node: Named-field formulas
\x7f53000
5547 Node: Editing/debugging formulas
\x7f53640
5548 Node: Appetizer
\x7f55398
5549 Node: orgtbl-mode
\x7f56501
5550 Node: table.el
\x7f56992
5551 Node: Hyperlinks
\x7f57969
5552 Node: Link format
\x7f58674
5553 Node: Internal links
\x7f59967
5554 Ref: Internal links-Footnote-1
\x7f61956
5555 Node: Radio targets
\x7f62088
5556 Node: CamelCase links
\x7f62803
5557 Node: External links
\x7f63301
5558 Node: Handling links
\x7f65432
5559 Ref: Handling links-Footnote-1
\x7f70018
5560 Node: Search options
\x7f70255
5561 Ref: Search options-Footnote-1
\x7f72029
5562 Node: Custom searches
\x7f72110
5563 Node: Remember
\x7f73158
5564 Node: TODO items
\x7f76848
5565 Node: TODO basics
\x7f77830
5566 Node: TODO extensions
\x7f79357
5567 Node: Workflow states
\x7f80152
5568 Node: TODO types
\x7f81020
5569 Ref: TODO types-Footnote-1
\x7f82678
5570 Node: Per file keywords
\x7f82760
5571 Ref: Per file keywords-Footnote-1
\x7f84214
5572 Node: Priorities
\x7f84415
5573 Node: Breaking down tasks
\x7f85659
5574 Ref: Breaking down tasks-Footnote-1
\x7f86179
5575 Node: Checkboxes
\x7f86275
5576 Node: Timestamps
\x7f89011
5577 Node: Time stamps
\x7f89401
5578 Node: Creating timestamps
\x7f92498
5579 Node: Progress logging
\x7f95844
5580 Node: Closing items
\x7f96374
5581 Node: Clocking work time
\x7f97278
5582 Ref: Clocking work time-Footnote-1
\x7f100841
5583 Node: Tags
\x7f100967
5584 Node: Tag inheritance
\x7f101729
5585 Node: Setting tags
\x7f102666
5586 Ref: Setting tags-Footnote-1
\x7f105798
5587 Ref: Setting tags-Footnote-2
\x7f105910
5588 Node: Tag searches
\x7f105990
5589 Node: Agenda views
\x7f107199
5590 Node: Agenda files
\x7f109088
5591 Ref: Agenda files-Footnote-1
\x7f110048
5592 Ref: Agenda files-Footnote-2
\x7f110197
5593 Node: Agenda dispatcher
\x7f110390
5594 Node: Weekly/Daily agenda
\x7f112007
5595 Node: Calendar/Diary integration
\x7f112972
5596 Node: Global TODO list
\x7f114310
5597 Node: Matching headline tags
\x7f116362
5598 Node: Timeline
\x7f117306
5599 Node: Presentation and sorting
\x7f117969
5600 Node: Categories
\x7f118747
5601 Node: Time-of-day specifications
\x7f119411
5602 Node: Sorting of agenda items
\x7f121389
5603 Node: Agenda commands
\x7f122671
5604 Node: Custom agenda views
\x7f128559
5605 Node: Storing searches
\x7f129234
5606 Node: Block agenda
\x7f131146
5607 Node: Setting Options
\x7f132376
5608 Node: Batch processing
\x7f135088
5609 Node: Embedded LaTeX
\x7f136218
5610 Ref: Embedded LaTeX-Footnote-1
\x7f137310
5611 Node: Math symbols
\x7f137500
5612 Node: Subscripts and Superscripts
\x7f138265
5613 Node: LaTeX fragments
\x7f139109
5614 Ref: LaTeX fragments-Footnote-1
\x7f141217
5615 Node: Processing LaTeX fragments
\x7f141479
5616 Node: CDLaTeX mode
\x7f142425
5617 Ref: CDLaTeX mode-Footnote-1
\x7f144909
5618 Node: Exporting
\x7f145057
5619 Node: ASCII export
\x7f146371
5620 Node: HTML export
\x7f147661
5621 Node: XOXO export
\x7f150497
5622 Node: iCalendar export
\x7f150936
5623 Node: Text interpretation
\x7f152759
5624 Node: Comment lines
\x7f153238
5625 Node: Enhancing text
\x7f153709
5626 Node: Export options
\x7f155401
5627 Node: Publishing
\x7f157068
5628 Ref: Publishing-Footnote-1
\x7f157864
5629 Node: Configuration
\x7f158060
5630 Node: Project alist
\x7f158778
5631 Node: Sources and destinations
\x7f159844
5632 Node: Selecting files
\x7f160574
5633 Node: Publishing action
\x7f161322
5634 Node: Publishing options
\x7f162555
5635 Node: Publishing links
\x7f164707
5636 Node: Project page index
\x7f166220
5637 Node: Sample configuration
\x7f166998
5638 Node: Simple example
\x7f167490
5639 Node: Complex example
\x7f168163
5640 Node: Triggering publication
\x7f170239
5641 Node: Miscellaneous
\x7f170924
5642 Node: Completion
\x7f171558
5643 Node: Customization
\x7f172939
5644 Node: In-buffer settings
\x7f173524
5645 Node: The very busy C-c C-c key
\x7f176755
5646 Node: Clean view
\x7f178399
5647 Node: TTY keys
\x7f180976
5648 Node: Interaction
\x7f182585
5649 Node: Cooperation
\x7f182982
5650 Node: Conflicts
\x7f184849
5651 Node: Bugs
\x7f186441
5652 Node: Extensions and Hacking
\x7f188064
5653 Node: Extensions
\x7f188550
5654 Node: Dynamic blocks
\x7f190120
5655 Node: History and Acknowledgments
\x7f192047
5656 Node: Index
\x7f197009
5657 Node: Key Index
\x7f221368