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.67).
10 Copyright (C) 2004, 2005, 2006, 2007 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.67).
32 Copyright (C) 2004, 2005, 2006, 2007 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 * orgtbl-mode:: The table editor as minor mode
95 * The spreadsheet:: The table editor has spreadsheet capabilities.
99 * References:: How to refer to another field or range
100 * Formula syntax for Calc:: Using Calc to compute stuff
101 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
102 * Field formulas:: Formulas valid for a single field
103 * Column formulas:: Formulas valid for an entire column
104 * Editing and debugging formulas:: Fixing formulas
105 * Updating the table:: Recomputing all dependent fields
106 * Advanced features:: Field names, parameters and automatic recalc
110 * Link format:: How links in Org-mode are formatted
111 * Internal links:: Links to other places in the current file
112 * External links:: URL-like links to the world
113 * Handling links:: Creating, inserting and following
114 * Link abbreviations:: Shortcuts for writing complex links
115 * Search options:: Linking to a specific location
116 * Custom searches:: When the default search is not enough
117 * Remember:: Org-trees store quick notes
121 * Radio targets:: Make targets trigger links in plain text.
125 * Setting up remember:: Some code for .emacs to get things going
126 * Remember templates:: Define the outline of different note types
127 * Storing notes:: Directly get the note to where it belongs
131 * TODO basics:: Marking and displaying TODO entries
132 * TODO extensions:: Workflow and assignments
133 * Priorities:: Some things are more important than others
134 * Breaking down tasks:: Splitting a task into managable pieces
135 * Checkboxes:: Tick-off lists
137 Extended use of TODO keywords
139 * Workflow states:: From TODO to DONE in steps
140 * TODO types:: I do this, Fred the rest
141 * Per file keywords:: Different files, different requirements
145 * Time stamps:: Assigning a time to a tree entry
146 * Creating timestamps:: Commands which insert timestamps
147 * Custom time format:: If you cannot work with the ISO format
148 * Repeating items:: Deadlines that come back again and again
149 * Progress logging:: Documenting when what work was done.
153 * The date/time prompt:: How org-mode helps you entering date and time
157 * Closing items:: When was this entry marked DONE?
158 * Tracking TODO state changes:: When did the status change?
159 * Clocking work time:: When exactly did you work on this item?
163 * Tag inheritance:: Tags use the tree structure of the outline
164 * Setting tags:: How to assign tags to a headline
165 * Tag searches:: Searching for combinations of tags
169 * Agenda files:: Files being searched for agenda information
170 * Agenda dispatcher:: Keyboard access to agenda views
171 * Built-in agenda views:: What is available out of the box?
172 * Presentation and sorting:: How agenda items are prepared for display
173 * Agenda commands:: Remote editing of org trees
174 * Custom agenda views:: Defining special searches and views
176 The built-in agenda views
178 * Weekly/Daily agenda:: The calendar page with current tasks
179 * Global TODO list:: All unfinished action items
180 * Matching headline tags:: Structured information with fine-tuned search
181 * Timeline:: Time-sorted view for single file
182 * Stuck projects:: Find projects you need to review
184 Presentation and sorting
186 * Categories:: Not all tasks are equal
187 * Time-of-day specifications:: How the agenda knows the time
188 * Sorting of agenda items:: The order of things
192 * Storing searches:: Type once, use often
193 * Block agenda:: All the stuff you need in a single buffer
194 * Setting Options:: Changing the rules
195 * Batch processing:: Agenda views from the command line
199 * Math symbols:: TeX macros for symbols and Greek letters
200 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
201 * LaTeX fragments:: Complex formulas made easy
202 * Processing LaTeX fragments:: Previewing LaTeX processing
203 * CDLaTeX mode:: Speed up entering of formulas
207 * ASCII export:: Exporting to plain ASCII
208 * HTML export:: Exporting to HTML
209 * XOXO export:: Exporting to XOXO
210 * iCalendar export:: Exporting in iCalendar format
211 * Text interpretation:: How the exporter looks at the file
215 * Export commands:: How to invode HTML export
216 * Quoting HTML tags:: Using direct HTML in Org-mode
217 * Links:: How hyperlinks get transferred to HTML
218 * Images:: To inline or not to inline?
219 * CSS support:: Style specifications
221 Text interpretation by the exporter
223 * Comment lines:: Some lines will not be exported
224 * Enhancing text:: Subscripts, symbols and more
225 * Export options:: How to influence the export settings
229 * Configuration:: Defining projects
230 * Sample configuration:: Example projects
231 * Triggering publication:: Publication commands
235 * Project alist:: The central configuration variable
236 * Sources and destinations:: From here to there
237 * Selecting files:: What files are part of the project?
238 * Publishing action:: Setting the function doing the publishing
239 * Publishing options:: Tweaking HTML export
240 * Publishing links:: Which links keep working after publishing?
241 * Project page index:: Publishing a list of project files
245 * Simple example:: One-component publishing
246 * Complex example:: A multi-component publishing example
250 * Completion:: M-TAB knows what you need
251 * Customization:: Adapting Org-mode to your taste
252 * In-buffer settings:: Overview of the #+KEYWORDS
253 * The very busy C-c C-c key:: When in doubt, press C-c C-c
254 * Clean view:: Getting rid of leading stars in the outline
255 * TTY keys:: Using Org-mode on a tty
256 * Interaction:: Other Emacs packages
257 * Bugs:: Things which do not work perfectly
259 Interaction with other packages
261 * Cooperation:: Packages Org-mode cooperates with
262 * Conflicts:: Packages that lead to conflicts
264 Extensions, Hooks and Hacking
266 * Extensions:: Existing 3rd-part extensions
267 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
268 * Dynamic blocks:: Automatically filled blocks
269 * Special agenda views:: Customized views
271 Tables in arbitrary syntax
273 * Radio tables:: Sending and receiving
274 * A LaTeX example:: Step by step, almost a tutorial
275 * Translator functions:: Copy and modify
278 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
285 * Summary:: Brief summary of what Org-mode does
286 * Installation:: How to install a downloaded version of Org-mode
287 * Activation:: How to activate Org-mode for certain buffers.
288 * Feedback:: Bug reports, ideas, patches etc.
291 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
296 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
297 project planning with a fast and effective plain-text system.
299 Org-mode develops organizational tasks around NOTES files that
300 contain lists or information about projects as plain text. Org-mode is
301 implemented on top of outline-mode, which makes it possible to keep the
302 content of large files well structured. Visibility cycling and
303 structure editing help to work with the tree. Tables are easily created
304 with a built-in table editor. Org-mode supports ToDo items, deadlines,
305 time stamps, and scheduling. It dynamically compiles entries into an
306 agenda that utilizes and smoothly integrates much of the Emacs calendar
307 and diary. Plain text URL-like links connect to websites, emails,
308 Usenet messages, BBDB entries, and any files related to the projects.
309 For printing and sharing of notes, an Org-mode file can be exported as a
310 structured ASCII file, as HTML, or (todo and agenda items only) as an
311 iCalendar file. It can also serve as a publishing tool for a set of
314 An important design aspect that distinguishes Org-mode from for
315 example Planner/Muse is that it encourages to store every piece of
316 information only once. In Planner, you have project pages, day pages
317 and possibly other files, duplicating some information such as tasks.
318 In Org-mode, you only have notes files. In your notes you mark entries
319 as tasks, label them with tags and timestamps. All necessary lists
320 like a schedule for the day, the agenda for a meeting, tasks lists
321 selected by tags etc are created dynamically when you need them.
323 Org-mode keeps simple things simple. When first fired up, it should
324 feel like a straightforward, easy to use outliner. Complexity is not
325 imposed, but a large amount of functionality is available when you need
326 it. Org-mode can be used on different levels and in different ways, for
329 * outline extension with visibility cycling and structure editing
330 * ASCII system and table editor for taking structured notes
331 * ASCII table editor with spreadsheet-like capabilities
333 * full agenda and planner with deadlines and work scheduling
334 * environment to implement David Allen's GTD system
335 * simple hypertext system, with HTML export
336 * publishing tool to create a set of interlinked webpages
338 Org-mode's automatic, context sensitive table editor with spreadsheet
339 capabilities can be integrated into any major mode by activating the
340 minor Orgtbl-mode. Using a translation step, it can be used to maintain
341 tables in arbitray file types, for example in LaTeX.
343 There is a website for Org-mode which provides links to the newest
344 version of Org-mode, as well as additional information, frequently asked
345 questions (FAQ), links to tutorials etc. This page is located at
346 `http://www.astro.uva.nl/~dominik/Tools/org/'.
349 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
354 Important: If Org-mode is part of the Emacs distribution or an XEmacs
355 package, please skip this section and go directly to *Note Activation::.
357 If you have downloaded Org-mode from the Web, you must take the
358 following steps to install it: Go into the Org-mode distribution
359 directory and edit the top section of the file `Makefile'. You must
360 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
361 and the paths to the directories where local Lisp and Info files are
362 kept. If you don't have access to the system-wide directories, create
363 your own two directories for these files, enter them into the Makefile,
364 and make sure Emacs finds the Lisp files by adding the following line
367 (setq load-path (cons "~/path/to/lispdir" load-path))
369 XEmacs users now need to install the file `noutline.el' from the
370 `xemacs' subdirectory of the Org-mode distribution. Use the command:
372 make install-noutline
374 Now byte-compile and install the Lisp files with the shell commands:
379 If you want to install the info documentation, use this command:
383 Then add to `.emacs':
385 ;; This line only if org-mode is not part of the X/Emacs distribution.
386 (require 'org-install)
389 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
394 Add the following lines to your `.emacs' file. The last two lines
395 define _global_ keys for the commands `org-store-link' and `org-agenda'
396 - please choose suitable keys yourself.
398 ;; The following lines are always needed. Choose your own keys.
399 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
400 (define-key global-map "\C-cl" 'org-store-link)
401 (define-key global-map "\C-ca" 'org-agenda)
403 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
404 because significant functionality depends on font-locking being active.
405 You can do this with either one of the following two lines (XEmacs
406 user must use the second option):
407 (global-font-lock-mode 1) ; for all buffers
408 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
410 With this setup, all files with extension `.org' will be put into
411 Org-mode. As an alternative, make the first line of a file look like
414 MY PROJECTS -*- mode: org; -*-
416 which will select Org-mode for this buffer no matter what the file's
417 name is. See also the variable `org-insert-mode-line-in-empty-file'.
420 File: org, Node: Feedback, Prev: Activation, Up: Introduction
425 If you find problems with Org-mode, or if you have questions, remarks,
426 or ideas about it, please contact the maintainer Carsten Dominik at
427 <dominik at science dot uva dot nl>.
429 For bug reports, please provide as much information as possible,
430 including the version information of Emacs (`C-h v emacs-version
431 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
432 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
433 can be very useful (see below on how to create one). Often a small
434 example file helps, along with clear information about:
436 1. What exactly did you do?
438 2. What did you expect to happen?
440 3. What happened instead?
441 Thank you for helping to improve this mode.
443 How to create a useful backtrace
444 ................................
446 If working with Org-mode produces an error with a message you don't
447 understand, you may have hit a bug. The best way to report this is by
448 providing, in addition to what was mentioned above, a _Backtrace_.
449 This is information from the built-in debugger about where and how the
450 error occurred. Here is how to produce a useful backtrace:
452 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
453 original Lisp code in `org.el' instead of the compiled version in
454 `org.elc'. The backtrace contains much more information if it is
455 produced with uncompiled code. To do this, either rename `org.elc'
456 to something else before starting Emacs, or ask Emacs explicitly
457 to load `org.el' by using the command line
458 emacs -l /path/to/org.el
460 2. Go to the `Options' menu and select `Enter Debugger on Error'
461 (XEmacs has this option in the `Troubleshooting' sub-menu).
463 3. Do whatever you have to do to hit the error. Don't forget to
464 document the steps you take.
466 4. When you hit the error, a `*Backtrace*' buffer will appear on the
467 screen. Save this buffer to a file (for example using `C-x C-w')
468 and attach it to your bug report.
471 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
476 Org-mode is based on outline mode and provides flexible commands to
477 edit the structure of the document.
481 * Outlines:: Org-mode is based on outline-mode
482 * Headlines:: How to typeset org-tree headlines
483 * Visibility cycling:: Show and hide, much simplified
484 * Motion:: Jumping to other headlines
485 * Structure editing:: Changing sequence and level of headlines
486 * Archiving:: Move done task trees to a different place
487 * Sparse trees:: Matches embedded in context
488 * Plain lists:: Additional structure within an entry
491 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
496 Org-mode is implemented on top of outline-mode. Outlines allow to
497 organize a document in a hierarchical structure, which (at least for
498 me) is the best representation of notes and thoughts. Overview over
499 this structure is achieved by folding (hiding) large parts of the
500 document to show only the general document structure and the parts
501 currently being worked on. Org-mode greatly simplifies the use of
502 outlines by compressing the entire show/hide functionality into a
503 single command `org-cycle', which is bound to the <TAB> key.
506 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
511 Headlines define the structure of an outline tree. The headlines in
512 Org-mode start with one or more stars, on the left margin. For example:
520 * Another top level headline
522 Some people find the many stars too noisy and would prefer an outline
523 that has whitespace followed by a single star as headline starters.
524 *Note Clean view:: describes a setup to realize this.
527 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
529 2.3 Visibility cycling
530 ======================
532 Outlines make it possible to hide parts of the text in the buffer.
533 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
534 the visibility in the buffer.
537 _Subtree cycling_: Rotate current subtree between the states
539 ,-> FOLDED -> CHILDREN -> SUBTREE --.
540 '-----------------------------------'
542 The cursor must be on a headline for this to work(1). When the
543 cursor is at the beginning of the buffer and the first line is not
544 a headline, then <TAB> actually runs global cycling (see
545 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
546 global cycling is invoked.
550 _Global cycling_: Rotate the entire buffer between the states
552 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
553 '--------------------------------------'
555 When `S-<TAB>' is called with a numerical prefix N, the CONTENTS
556 view up to headlines of level N will be shown. Note that inside
557 tables, `S-<TAB>' jumps to the previous field.
563 Reveal context around point, showing the current entry, the
564 following heading and the hierarchy above. Useful for working
565 near a location exposed by a sparse tree command (*note Sparse
566 trees::) or an agenda command (*note Agenda commands::). With
567 prefix arg show, on each level, all sibling headings.
570 Show the current subtree in an indirect buffer(3). With numerical
571 prefix ARG, go up to this level and then take that tree. If ARG
572 is negative, go up that many levels. With `C-u' prefix, do not
573 remove the previously used indirect buffer.
575 When Emacs first visits an Org-mode file, the global state is set to
576 OVERVIEW, i.e. only the top level headlines are visible. This can be
577 configured through the variable `org-startup-folded', or on a per-file
578 basis by adding one of the following lines anywhere in the buffer:
584 ---------- Footnotes ----------
586 (1) see, however, the option `org-cycle-emulate-tab'.
588 (2) see the option `org-cycle-global-at-bob'.
590 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
591 Buffers.) will contain the entire buffer, but will be narrowed to the
592 current tree. Editing the indirect buffer will also change the
593 original buffer, but without affecting visibility in that buffer.
596 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
601 The following commands jump to other headlines in the buffer.
610 Next heading same level.
613 Previous heading same level.
616 Backward to higher level heading.
619 Jump to a different place without changing the current outline
620 visibility. Shows the document structure in a temporary buffer,
621 where you can use visibility cycling (<TAB>) to find your
622 destination. After pressing <RET>, the cursor moves to the
623 selected location in the original buffer, and the headings
624 hierarchy above it is made visible.
627 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
629 2.5 Structure editing
630 =====================
633 Insert new heading with same level as current. If the cursor is
634 in a plain list item, a new item is created (*note Plain lists::).
635 To force creation of a new headline, use a prefix arg, or first
636 press <RET> to get to the beginning of the next line. When this
637 command is used in the middle of a line, the line is split and the
638 rest of the line becomes the new headline. If the command is used
639 at the beginning of a headline, the new headline is created before
640 the current line. If at the beginning of any other line, the
641 content of that line is made the new heading. If the command is
642 used at the end of a folded subtree (i.e. behind the ellipses at
643 the end of a headline), then a headline like the current one will
644 be inserted after the end of the subtree.
647 Insert new TODO entry with same level as current heading.
650 Promote current heading by one level.
653 Demote current heading by one level.
656 Promote the current subtree by one level.
659 Demote the current subtree by one level.
662 Move subtree up (swap with previous subtree of same level).
665 Move subtree down (swap with next subtree of same level).
669 Kill subtree, i.e. remove it from buffer but save in kill ring.
672 Copy subtree to kill ring.
675 Yank subtree from kill ring. This does modify the level of the
676 subtree to make sure the tree fits in nicely at the yank position.
677 The yank level can also be specified with a prefix arg, or by
678 yanking after a headline marker like `****'.
681 Sort same-level entries. When there is an active region, all
682 entries in the region will be sorted. Otherwise the children of
683 the current headline are sorted. The command prompts for the
684 sorting method, which can be alphabetically, numerically, by time
685 (using the first time stamp in each entry), and each of these in
686 reverse order. With a `C-u' prefix, sorting will be
687 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
688 will also be removed.
690 When there is an active region (transient-mark-mode), promotion and
691 demotion work on all headlines in the region. To select a region of
692 headlines, it is best to place both point and mark at the beginning of a
693 line, mark at the beginning of the first headline, and point at the line
694 just after the last headline to change. Note that when the cursor is
695 inside a table (*note Tables::), the Meta-Cursor keys have different
699 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
704 When a project represented by a (sub)tree is finished, you may want to
705 move the tree out of the way and to stop it from contributing to the
706 agenda. Org-mode knows two ways of archiving. You can mark a tree with
707 the ARCHIVE tag, or you can move an entire (sub)tree to a different
712 * ARCHIVE tag:: Marking a tree as inactive
713 * Moving subtrees:: Moving a tree to an archive file
716 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
718 2.6.1 The ARCHIVE tag
719 ---------------------
721 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
722 its location in the outline tree, but behaves in the following way:
723 - It does not open when you attempt to do so with a visibility
724 cycling command (*note Visibility cycling::). You can force
725 cycling archived subtrees with `C-<TAB>', or by setting the option
726 `org-cycle-open-archived-trees'. Also normal outline commands like
727 `show-all' will open archived subtrees.
729 - During sparse tree construction (*note Sparse trees::), matches in
730 archived subtrees are not exposed, unless you configure the option
731 `org-sparse-tree-open-archived-trees'.
733 - During agenda view construction (*note Agenda views::), the
734 content of archived trees is ignored unless you configure the
735 option `org-agenda-skip-archived-trees'.
737 - Archived trees are not exported (*note Exporting::), only the
738 headline is. Configure the details using the variable
739 `org-export-with-archived-trees'.
741 The following commands help managing the ARCHIVE tag:
744 Toggle the ARCHIVE tag for the current headline. When the tag is
745 set, the headline changes to a shadowish face, and the subtree
749 Check if any direct children of the current headline should be
750 archived. To do this, each subtree is checked for open TODO
751 entries. If none are found, the command offers to set the ARCHIVE
752 tag for the child. If the cursor is _not_ on a headline when this
753 command is invoked, the level 1 trees will be checked.
756 Cycle a tree even if it is tagged with ARCHIVE.
759 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
761 2.6.2 Moving subtrees
762 ---------------------
764 Once an entire project is finished, you may want to move it to a
765 different location, either in the current file, or even in a different
766 file, the archive file.
769 Archive the subtree starting at the cursor position to the location
770 given by `org-archive-location'.
773 Check if any direct children of the current headline could be
774 moved to the archive. To do this, each subtree is checked for
775 open TODO entries. If none are found, the command offers to move
776 it to the archive location. If the cursor is _not_ on a headline
777 when this command is invoked, the level 1 trees will be checked.
779 The default archive location is a file in the same directory as the
780 current file, with the name derived by appending `_archive' to the
781 current file name. For information and examples on how to change this,
782 see the documentation string of the variable `org-archive-location'.
783 There is also an in-buffer option for setting this variable, for example
787 You may have several such lines in the buffer, they will then be valid
788 for the entries following the line (the first will also apply to any
792 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
797 An important feature of Org-mode is the ability to construct _sparse
798 trees_ for selected information in an outline tree. A sparse tree
799 means that the entire document is folded as much as possible, but the
800 selected information is made visible along with the headline structure
801 above it(1). Just try it out and you will see immediately how it works.
803 Org-mode contains several commands creating such trees. The most
804 basic one is `org-occur':
807 Occur. Prompts for a regexp and shows a sparse tree with all
808 matches. If the match is in a headline, the headline is made
809 visible. If the match is in the body of an entry, headline and
810 body are made visible. In order to provide minimal context, also
811 the full hierarchy of headlines above the match is shown, as well
812 as the headline following the match. Each match is also
813 highlighted; the highlights disappear when the buffer is changes
814 an editing command, or by pressing `C-c C-c'. When called with a
815 `C-u' prefix argument, previous highlights are kept, so several
816 calls to this command can be stacked.
817 For frequently used sparse trees of specific search strings, you can
818 use the variable `org-agenda-custom-commands' to define fast keyboard
819 access to specific sparse trees. These commands will then be
820 accessible through the agenda dispatcher (*note Agenda dispatcher::).
823 (setq org-agenda-custom-commands
824 '(("f" occur-tree "FIXME")))
826 will define the key `C-c a f' as a shortcut for creating a sparse tree
827 matching the string `FIXME'.
829 Other commands use sparse trees as well. For example `C-c C-v'
830 creates a sparse TODO tree (*note TODO basics::).
832 To print a sparse tree, you can use the Emacs command
833 `ps-print-buffer-with-faces' which does not print invisible parts of
834 the document (2). Or you can use the command `C-c C-e v' to export
835 only the visible part of the document and print the resulting file.
837 ---------- Footnotes ----------
839 (1) See also the variables `org-show-hierarchy-above',
840 `org-show-following-heading', and `org-show-siblings' for detailed
841 control on how much context is shown around each match.
843 (2) This does not work under XEmacs, because XEmacs uses selective
844 display for outlining, not text properties.
847 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
852 Within an entry of the outline tree, hand-formatted lists can provide
853 additional structure. They also provide a way to create lists of
854 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
855 and the HTML exporter (*note Exporting::) does parse and format them.
857 Org-mode knows ordered and unordered lists. Unordered list items
858 start with `-', `+', or `*'(1) as bullets. Ordered list items start
859 with `1.' or `1)'. Items belonging to the same list must have the same
860 indentation on the first line. In particular, if an ordered list
861 reaches number `10.', then the 2-digit numbers must be written
862 left-aligned with the other numbers in the list. Indentation also
863 determines the end of a list item. It ends before the next line that
864 is indented like the bullet/number, or less. For example:
867 My favorite scenes are (in this order)
868 1. The attack of the Rohirrim
869 2. Eowyns fight with the witch king
870 + this was already my favorite scene in the book
871 + I really like Miranda Otto.
872 3. Peter Jackson being shot by Legolas
874 He makes a really funny face when it happens.
875 But in the end, not individual scenes matter but the film as a whole.
877 Org-mode supports these lists by tuning filling and wrapping
878 commands to deal with them correctly(2).
880 The following commands act on items when the cursor is in the first
881 line of an item (the line with the bullet or number).
884 Items can be folded just like headline levels if you set the
885 variable `org-cycle-include-plain-lists'. The level of an item is
886 then given by the indentation of the bullet/number. Items are
887 always subordinate to real headlines, however; the hierarchies
888 remain completely separated.
891 Insert new item at current level. With prefix arg, force a new
892 heading (*note Structure editing::). If this command is used in
893 the middle of a line, the line is _split_ and the rest of the line
894 becomes the new item. If this command is executed in the
895 _whitespace before a bullet or number_, the new item is created
896 _before_ the current item. If the command is executed in the
897 white space before the text that is part of an item but does not
898 contain the bullet, a bullet is added to the current line.
901 Insert a new item with a checkbox (*note Checkboxes::).
905 Jump to the previous/next item in the current list.
909 Move the item including subitems up/down (swap with previous/next
910 item of same indentation). If the list is ordered, renumbering is
915 Decrease/increase the indentation of the item, including subitems.
916 Initially, the item tree is selected based on current indentation.
917 When these commands are executed several times in direct
918 succession, the initially selected region is used, even if the new
919 indentation would imply a different hierarchy. To use the new
920 hierarchy, break the command chain with a cursor motion or so.
923 If there is a checkbox (*note Checkboxes::) in the item line,
924 toggle the state of the checkbox. Otherwise, if this is an
925 ordered list, renumber the ordered list at the cursor.
927 ---------- Footnotes ----------
929 (1) When using `*' as a bullet, lines must be indented or they will
930 be seen as top-level headlines. Also, when you are hiding leading
931 stars to get a clean outline view, plain list items starting with a
932 star are visually indistinguishable from true headlines. In short:
933 even though `*' is supported, it may be better not to use it for plain
936 (2) Org-mode only changes the filling settings for Emacs. For
937 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
942 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
947 Org-mode has a very fast and intuitive table editor built-in.
948 Spreadsheet-like calculations are supported in connection with the
949 Emacs `calc' package.
953 * Built-in table editor:: Simple tables
954 * Narrow columns:: Stop wasting space in tables
955 * orgtbl-mode:: The table editor as minor mode
956 * The spreadsheet:: The table editor has spreadsheet capabilities.
959 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
961 3.1 The built-in table editor
962 =============================
964 Org-mode makes it easy to format tables in plain ASCII. Any line with
965 `|' as the first non-white character is considered part of a table.
966 `|' is also the column separator. A table might look like this:
968 | Name | Phone | Age |
969 |-------+-------+-----|
970 | Peter | 1234 | 17 |
973 A table is re-aligned automatically each time you press <TAB> or
974 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
975 field (<RET> to the next row) and creates new table rows at the end of
976 the table or before horizontal lines. The indentation of the table is
977 set by the first line. Any line starting with `|-' is considered as a
978 horizontal separator line and will be expanded on the next re-align to
979 span the whole table width. So, to create the above table, you would
985 and then press <TAB> to align the table and start filling in fields.
987 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
988 and all character keys in a special way, so that inserting and deleting
989 avoids shifting other fields. Also, when typing _immediately after the
990 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
991 the field is automatically made blank. If this behavior is too
992 unpredictable for you, configure the variables
993 `org-enable-table-editor' and `org-table-auto-blank-field'.
995 Creation and conversion
996 .......................
999 Convert the active region to table. If every line contains at
1000 least one TAB character, the function assumes that the material is
1001 tab separated. If not, lines are split at whitespace into fields.
1002 You can use a prefix argument to indicate the minimum number of
1003 consecutive spaces required to identify a field separator
1004 (default: just one).
1005 If there is no active region, this command creates an empty
1006 Org-mode table. But it's easier just to start typing, like
1007 `|Name|Phone|Age <RET> |- <TAB>'.
1009 Re-aligning and field motion
1010 ............................
1013 Re-align the table without moving the cursor.
1016 Re-align the table, move to the next field. Creates a new row if
1020 Re-align, move to previous field.
1023 Re-align the table and move down to next row. Creates a new row if
1024 necessary. At the beginning or end of a line, <RET> still does
1025 NEWLINE, so it can be used to split a table.
1027 Column and row editing
1028 ......................
1032 Move the current column left/right.
1035 Kill the current column.
1038 Insert a new column to the left of the cursor position.
1042 Move the current row up/down.
1045 Kill the current row or horizontal line.
1048 Insert a new row above (with arg: below) the current row.
1051 Insert a horizontal line below current row. With prefix arg, the
1052 line is created above the current line.
1055 Sort the table lines in the region. The position of point
1056 indicates the column to be used for sorting, and the range of
1057 lines is the range between the nearest horizontal separator lines,
1058 or the entire table. If point is before the first column, you
1059 will be prompted for the sorting column. If there is an active
1060 region, the mark specifies the first line and the sorting column,
1061 while point should be in the last line to be included into the
1062 sorting. The command prompts for the sorting type
1063 (alphabetically, numerically, or by time). When called with a
1064 prefix argument, alphabetic sorting will be case-sensitive.
1070 Copy a rectangular region from a table to a special clipboard.
1071 Point and mark determine edge fields of the rectangle. The
1072 process ignores horizontal separator lines.
1075 Copy a rectangular region from a table to a special clipboard, and
1076 blank all fields in the rectangle. So this is the "cut" operation.
1079 Paste a rectangular region into a table. The upper right corner
1080 ends up in the current field. All involved fields will be
1081 overwritten. If the rectangle does not fit into the present table,
1082 the table is enlarged as needed. The process ignores horizontal
1086 Wrap several fields in a column like a paragraph. If there is an
1087 active region, and both point and mark are in the same column, the
1088 text in the column is wrapped to minimum width for the given
1089 number of lines. A prefix ARG may be used to change the number of
1090 desired lines. If there is no region, the current field is split
1091 at the cursor position and the text fragment to the right of the
1092 cursor is prepended to the field one line down. If there is no
1093 region, but you specify a prefix ARG, the current field is made
1094 blank, and the content is appended to the field above.
1100 Sum the numbers in the current column, or in the rectangle defined
1101 by the active region. The result is shown in the echo area and can
1102 be inserted with `C-y'.
1105 When current field is empty, copy from first non-empty field above.
1106 When not empty, copy current field down to next row and move cursor
1107 along with it. Depending on the variable
1108 `org-table-copy-increment', integer field values will be
1109 incremented during copy. This key is also used by CUA-mode (*note
1116 Edit the current field in a separate window. This is useful for
1117 fields that are not fully visible (*note Narrow columns::). When
1118 called with a `C-u' prefix, just make the full field visible, so
1119 that it can be edited in place.
1122 This is an alias for `C-u C-c `' to make the current field fully
1125 `M-x org-table-import'
1126 Import a file as a table. The table should be TAB- or whitespace
1127 separated. Useful, for example, to import an Excel table or data
1128 from a database, because these programs generally can write
1129 TAB-separated text files. This command works by inserting the
1130 file into the buffer and then converting the region to a table.
1131 Any prefix argument is passed on to the converter, which uses it
1132 to determine the separator.
1134 `M-x org-table-export'
1135 Export the table as a TAB-separated file. Useful for data
1136 exchange with, for example, Excel or database programs.
1139 If you don't like the automatic table editor because it gets in your
1140 way on lines which you would like to start with `|', you can turn it
1143 (setq org-enable-table-editor nil)
1145 Then the only table command that still works is `C-c C-c' to do a
1149 File: org, Node: Narrow columns, Next: orgtbl-mode, Prev: Built-in table editor, Up: Tables
1154 The width of columns is automatically determined by the table editor.
1155 Sometimes a single field or a few fields need to carry more text,
1156 leading to inconveniently wide columns. To limit(1) the width of a
1157 column, one field anywhere in the column may contain just the string
1158 `<N>' where `N' is an integer specifying the width of the column in
1159 characters. The next re-align will then set the width of this column
1160 to no more than this value.
1162 |---+------------------------------| |---+--------|
1164 | 1 | one | | 1 | one |
1165 | 2 | two | ----\ | 2 | two |
1166 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1167 | 4 | four | | 4 | four |
1168 |---+------------------------------| |---+--------|
1170 Fields that are wider become clipped and end in the string `=>'. Note
1171 that the full text is still in the buffer, it is only invisible. To
1172 see the full text, hold the mouse over the field - a tooltip window
1173 will show the full content. To edit such a field, use the command `C-c
1174 `' (that is `C-c' followed by the backquote). This will open a new
1175 window with the full field. Edit it and finish with `C-c C-c'.
1177 When visiting a file containing a table with narrowed columns, the
1178 necessary character hiding has not yet happened, and the table needs to
1179 be aligned before it looks nice. Setting the option
1180 `org-startup-align-all-tables' will realign all tables in a file upon
1181 visiting, but also slow down startup. You can also set this option on
1182 a per-file basis with:
1187 ---------- Footnotes ----------
1189 (1) This feature does not work on XEmacs.
1192 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Narrow columns, Up: Tables
1194 3.3 The Orgtbl minor mode
1195 =========================
1197 If you like the intuitive way the Org-mode table editor works, you
1198 might also want to use it in other modes like text-mode or mail-mode.
1199 The minor mode Orgtbl-mode makes this possible. You can always toggle
1200 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1203 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1205 Furthermore, with some special setup, it is possible to maintain
1206 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1207 possible to construct LaTeX tables with the underlying ease and power of
1208 Orgtbl-mode, including spreadsheet capabulities. For details, see
1209 *Note Tables in arbitrary syntax::.
1212 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1217 The table editor makes use of the Emacs `calc' package to implement
1218 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1219 derive fields from other fields.
1223 * References:: How to refer to another field or range
1224 * Formula syntax for Calc:: Using Calc to compute stuff
1225 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1226 * Field formulas:: Formulas valid for a single field
1227 * Column formulas:: Formulas valid for an entire column
1228 * Editing and debugging formulas:: Fixing formulas
1229 * Updating the table:: Recomputing all dependent fields
1230 * Advanced features:: Field names, parameters and automatic recalc
1233 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1238 To compute fields in the table from other fields, formulas must
1239 reference other fields or ranges. In Org-mode, fields can be referenced
1240 by name, by absolute coordinates, and by relative coordinates. To find
1241 out what the coordinates of a field are, press `C-c ?' in that field.
1246 Formulas can reference the value of another field with the operator
1249 Column references can be absolute like `1', `2',...`N', or relative
1250 to the current column like `+1' or `-2'.
1252 The row specification only counts data lines and ignores horizontal
1253 separator lines (hlines). You can use absolute row numbers `1'...`N',
1254 and row numbers relative to the current row like `+3' or `-1'. Or
1255 specify the row relative to one of the hlines: `I' refers to the first
1256 hline, `II' to the second etc. `-I' refers to the first such line
1257 above the current line, `+I' to the first such line below the current
1258 line. You can also write `III+2' which is the second data line after
1259 the third hline in the table. Relative row numbers like `-3' will not
1260 cross hlines if the current line is too close to the hline. Instead,
1261 the value directly at the hline is used.
1263 `0' refers to the current row and column. Also, if you omit either
1264 the column or the row part of the reference, the current row/column is
1267 Org-mode's references with _positive_ numbers correspond to fixed
1268 references in other spreadsheet programs. For example, `@3$28'
1269 corresponds to `$AB$3'. Org-mode's references with _negative_ numbers
1270 behave similar to non-fixed references in other spreadsheet programs,
1271 because when the same formula is used in several fields, different
1272 fields are referenced each time.
1274 Here are a few examples:
1276 @2$3 2nd row, 3rd column
1277 $5 column 5 in the current row
1278 @2 current column, row 2
1279 @-1$-3 the field one row up, three columns to the left
1280 @-I$2 field just under hline above current row, column 2
1285 You may reference a rectangular range of fields by specifying two field
1286 references connected by two dots `..'. If both fields are in the
1287 current row, you may simply use `$2..$7', but if at least one field is
1288 in a different row, you need to use the general `@row$column' format at
1289 least for the first field (i.e the reference must start with `@' in
1290 order to be interpreted correctly). Examples:
1292 $1..$3 First three fields in the current row.
1293 $P..$Q Range, using column names (see under Advanced)
1294 @2$1..@4$3 6 fields between these two fields.
1295 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1297 Range references return a vector of values that can be fed into Calc
1298 vector functions. Empty fields in ranges are normally suppressed, so
1299 that the vector contains only the non-empty fields (but see the `E'
1300 mode switch below). If there are no non-empty fields, `[0]' is
1301 returned to avoid syntax errors in formulas.
1306 `$name' is interpreted as the name of a column, parameter or constant.
1307 Constants are defined globally through the variable
1308 `org-table-formula-constants'. If you have the `constants.el' package,
1309 it will also be used to resolve constants, including natural constants
1310 like `$h' for Planck's constant, and units like `$km' for kilometers.
1311 Column names and parameters can be specified in special table lines.
1312 These are described below, see *Note Advanced features::.
1315 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1317 3.4.2 Formula syntax for Calc
1318 -----------------------------
1320 A formula can be any algebraic expression understood by the Emacs
1321 `Calc' package. Note that `calc' has the slightly non-standard
1322 convention that `/' has lower precedence than `*', so that `a/b*c' is
1323 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1324 calc-eval: (calc)Calling Calc from Your Programs.), variable
1325 substitution takes place according to the rules described above. The
1326 range vectors can be directly fed into the calc vector functions like
1329 A formula can contain an optional mode string after a semicolon.
1330 This string consists of flags to influence Calc and other modes during
1331 execution. By default, Org-mode uses the standard calc modes (precision
1332 12, angular units degrees, fraction and symbolic modes off. The display
1333 format, however, has been changed to `(float 5)' to keep tables
1334 compact. The default settings can be configured using the variable
1335 `org-calc-default-modes'.
1337 p20 switch the internal precision to 20 digits
1338 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1339 D R angle modes: degrees, radians
1340 F S fraction and symbolic modes
1341 N interpret all fields as numbers, use 0 for non-numbers
1342 T force text interpretation
1343 E keep empty fields in ranges
1345 In addition, you may provide a `printf' format specifier to reformat
1346 the final result. A few examples:
1348 $1+$2 Sum of first and second field
1349 $1+$2;%.2f Same, format result to two decimals
1350 exp($2)+exp($1) Math functions can be used
1351 $;%.1f Reformat current cell to 1 decimal
1352 ($3-32)*5/9 Degrees F -> C conversion
1353 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1354 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1355 sin($1);Dp3%.1e Same, but use printf specifier for display
1356 vmean($2..$7) Compute column range mean, using vector function
1357 vmean($2..$7);EN Same, but treat empty fields as 0
1358 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1361 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1363 3.4.3 Emacs Lisp forms as formulas
1364 ----------------------------------
1366 It is also possible to write a formula in Emacs Lisp; this can be useful
1367 for string manipulation and control structures. If a formula starts
1368 with a single quote followed by an opening parenthesis, then it is
1369 evaluated as a lisp form. The evaluation should return either a string
1370 or a number. Just as with `calc' formulas, you can specify modes and a
1371 printf format after a semicolon. A reference will be replaced with a
1372 string (in double quotes) containing the field. If you provide the `N'
1373 mode switch, all referenced elements will be numbers. Ranges are
1374 inserted as space-separated fields, so you can embed them in list or
1375 vector syntax. A few examples, note how the `N' mode is used when we
1376 do computations in lisp.
1378 Swap the first two characters of the content of column 1
1379 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1380 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1382 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1383 '(apply '+ '($1..$4));N
1386 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1388 3.4.4 Field formulas
1389 --------------------
1391 To assign a formula to a particular field, type it directly into the
1392 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1393 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1394 will be stored as the formula for this field, evaluated, and the
1395 current field replaced with the result.
1397 Formulas are stored in a special line starting with `#+TBLFM:'
1398 directly below the table. If you typed the equation in the 4th field of
1399 the 3rd data line in the table, the formula will look like
1400 `@3$2=$1+$2'. When inserting/deleting/swapping column and rows with
1401 the appropriate commands, absolute references (but not relative ones)
1402 in stored formulas are modified in order to still reference the same
1403 field. Of cause this is not true if you edit the table structure with
1404 normal editing commands - then you must go and fix equations yourself.
1406 Instead of typing an equation into the field, you may also use the
1410 Install a new formula for the current field. The command prompts
1411 for a formula, with default taken from the `#+TBLFM:' line, applies
1412 it to the current field and stores it.
1415 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1417 3.4.5 Column formulas
1418 ---------------------
1420 Often in a table, the same formula should be used for all fields in a
1421 particular column. Instead of having to copy the formula to all fields
1422 in that column, org-mode allows to assign a single formula to an entire
1425 To assign a formula to a column, type it directly into any field in
1426 the column, preceded by an equal sign, like `=$1+$2'. When you press
1427 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1428 formula will be stored as the formula for the current column, evaluated
1429 and the current field replaced with the result. If the field contains
1430 only `=', the previously stored formula for this column is used. For
1431 each column, Org-mode will only remember the most recently used
1432 formula. In the `TBLFM:' line, column formulas will look like
1435 Instead of typing an equation into the field, you may also use the
1439 Install a new formula for the current column and replace current
1440 field with the result of the formula. The command prompts for a
1441 formula, with default taken from the `#+TBLFM' line, applies it to
1442 the current field and stores it. With a numerical prefix (e.g.
1443 `C-5 C-c =') will apply it to that many consecutive fields in the
1447 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1449 3.4.6 Editing and Debugging formulas
1450 ------------------------------------
1452 You can edit individual formulas in the minibuffer or directly in the
1453 field. Org-mode can also prepare a special buffer with all active
1454 formulas of a table.
1458 Edit the formula associated with the current column/field in the
1459 minibuffer. See *Note Column formulas:: and *Note Field
1463 Re-insert the active formula (either a field formula, or a column
1464 formula) into the current field, so that you can edit it directly
1465 in the field. The advantage over editing in the minibuffer is
1466 that you can use the command `C-c ?'.
1469 While editing a formula in a table field, highlight the field(s)
1470 referenced by the reference at the cursor position in the formula.
1473 Edit all formulas for the current table in a special buffer, where
1474 the formulas will be displayed one per line. While inside the
1475 special buffer, Org-mode will automatically highlight any field or
1476 range reference at the cursor position. You may edit, remove and
1477 add formulas, and use the following commands:
1479 Exit the buffer and store the modified formulas. With `C-u'
1480 prefix, also apply the new formulas to the entire table.
1483 Exit the buffer without installing changes.
1486 Pretty-print or indent lisp formula at point. When in a line
1487 containing a lisp formula, format the formula according to
1488 Emacs Lisp rules. Another <TAB> collapses the formula back
1489 again. In the open formula, <TAB> re-indents just like in
1493 Complete Lisp symbols, just like in Emacs-lisp-mode.
1496 Move the reference line in the Org-mode buffer up and down.
1497 This is important for highlighting the references of column
1498 formulas for different rows.
1501 Scroll the window displaying the table.
1504 Toggle the display of row and column numbers for a table, using
1505 overlays. These are uptated each time the table is aligned, you
1506 can force it with `C-c C-c'.
1509 Toggle the formula debugger on and off. See below.
1511 Making a table field blank does not remove the formula associated
1512 with the field, because that is stored in a different line (the `TBLFM'
1513 line) - during the next recalculation the field will be filled again.
1514 To remove a formula from a field, you have to give an empty reply when
1515 prompted for the formula, or to edit the `#+TBLFM' line.
1517 You may edit the `#+TBLFM' directly and re-apply the changed
1518 equations with `C-c C-c' in that line, or with the normal recalculation
1519 commands in the table.
1524 When the evaluation of a formula leads to an error, the field content
1525 becomes the string `#ERROR'. If you would like see what is going on
1526 during variable substitution and calculation in order to find a bug,
1527 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1528 for example by pressing `C-c = <RET>' in a field. Detailed information
1532 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1534 3.4.7 Updating the Table
1535 ------------------------
1537 Recalculation of a table is normally not automatic, but needs to be
1538 triggered by a command. See *Note Advanced features:: for a way to make
1539 recalculation at least semi-automatically.
1541 In order to recalculate a line of a table or the entire table, use
1542 the following commands:
1545 Recalculate the current row by first applying the stored column
1546 formulas from left to right, and all field formulas in the current
1551 Recompute the entire table, line by line. Any lines before the
1552 first hline are left alone, assuming that these are part of the
1556 Iterate the table by recomputing it until no further changes occur.
1557 This may be necessary if some computed fields use the value of
1558 other fields that are computed later in the calculation sequence.
1561 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1563 3.4.8 Advanced features
1564 -----------------------
1566 If you want the recalculation of fields to happen automatically, or if
1567 you want to be able to assign names to fields and columns, you need to
1568 reserve the first column of the table for special marking characters.
1570 Rotate the calculation mark in first column through the states `',
1571 `#', `*', `!', `$'. The meaning of these characters is discussed
1572 below. When there is an active region, change all marks in the
1575 Here is an example of a table that collects exam results of students
1576 and makes use of these features:
1578 |---+---------+--------+--------+--------+-------+------|
1579 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1580 |---+---------+--------+--------+--------+-------+------|
1581 | ! | | P1 | P2 | P3 | Tot | |
1582 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1583 | ^ | | m1 | m2 | m3 | mt | |
1584 |---+---------+--------+--------+--------+-------+------|
1585 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1586 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1587 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1588 |---+---------+--------+--------+--------+-------+------|
1589 | | Average | | | | 29.7 | |
1590 | ^ | | | | | at | |
1591 | $ | max=50 | | | | | |
1592 |---+---------+--------+--------+--------+-------+------|
1593 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1595 Important: Please note that for these special tables, recalculating the
1596 table with `C-u C-c *' will only affect rows that are marked `#' or
1597 `*', and fields that have a formula assigned to the field itself. The
1598 column formulas are not applied in rows with empty first field.
1600 The marking characters have the following meaning:
1602 The fields in this line define names for the columns, so that you
1603 may refer to a column as `$Tot' instead of `$6'.
1606 This row defines names for the fields _above_ the row. With such
1607 a definition, any formula in the table may use `$m1' to refer to
1608 the value `10'. Also, if you assign a formula to a names field, it
1609 will be stored as `$name=...'.
1612 Similar to `^', but defines names for the fields in the row
1616 Fields in this row can define _parameters_ for formulas. For
1617 example, if a field in a `$' row contains `max=50', then formulas
1618 in this table can refer to the value 50 using `$max'. Parameters
1619 work exactly like constants, only that they can be defined on a
1623 Fields in this row are automatically recalculated when pressing
1624 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1625 selected for a global recalculation with `C-u C-c *'. Unmarked
1626 lines will be left alone by this command.
1629 Selects this line for global recalculation with `C-u C-c *', but
1630 not for automatic recalculation. Use this when automatic
1631 recalculation slows down editing too much.
1634 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1635 All lines that should be recalculated should be marked with `#' or
1639 Do not export this line. Useful for lines that contain the
1640 narrowing `<N>' markers.
1642 Finally, just to whet your appetite on what can be done with the
1643 fantastic `calc' package, here is a table that computes the Taylor
1644 series of degree `n' at location `x' for a couple of functions
1645 (homework: try that with Excel :-)
1647 |---+-------------+---+-----+--------------------------------------|
1648 | | Func | n | x | Result |
1649 |---+-------------+---+-----+--------------------------------------|
1650 | # | exp(x) | 1 | x | 1 + x |
1651 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1652 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1653 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1654 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1655 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1656 |---+-------------+---+-----+--------------------------------------|
1657 #+TBLFM: $5=taylor($2,$4,$3);n3
1660 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1665 Just like HTML, Org-mode provides links inside a file, and external
1666 links to other files, Usenet articles, emails, and much more.
1670 * Link format:: How links in Org-mode are formatted
1671 * Internal links:: Links to other places in the current file
1672 * External links:: URL-like links to the world
1673 * Handling links:: Creating, inserting and following
1674 * Link abbreviations:: Shortcuts for writing complex links
1675 * Search options:: Linking to a specific location
1676 * Custom searches:: When the default search is not enough
1677 * Remember:: Org-trees store quick notes
1680 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1685 Org-mode will recognize plain URL-like links and activate them as
1686 clickable links. The general link format, however, looks like this:
1688 [[link][description]] or alternatively [[link]]
1690 Once a link in the buffer is complete (all brackets present),
1691 Org-mode will change the display so that `description' is displayed
1692 instead of `[[link][description]]' and `link' is displayed instead of
1693 `[[link]]'. Links will be highlighted in the face `org-link', which by
1694 default is an underlined face. You can directly edit the visible part
1695 of a link. Note that this can be either the `link' part (if there is
1696 no description) or the `description' part. To edit also the invisible
1697 `link' part, use `C-c C-l' with the cursor on the link.
1699 If you place the cursor at the beginning or just behind the end of
1700 the displayed text and press <BACKSPACE>, you will remove the
1701 (invisible) bracket at that location. This makes the link incomplete
1702 and the internals are again displayed as plain text. Inserting the
1703 missing bracket hides the link internals again. To show the internal
1704 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1708 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1713 If the link does not look like a URL, it is considered to be internal in
1714 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1715 my target]]' lead to a text search in the current file. The link can
1716 be followed with `C-c C-o' when the cursor is on the link, or with a
1717 mouse click (*note Handling links::). The preferred match for such a
1718 link is a dedicated target: the same string in double angular brackets.
1719 Targets may be located anywhere; sometimes it is convenient to put
1720 them into a comment line. For example
1724 In HTML export (*note HTML export::), such targets will become named
1725 anchors for direct access through `http' links(1).
1727 If no dedicated target exists, Org-mode will search for the words in
1728 the link. In the above example the search would be for `my target'.
1729 Links starting with a star like `*My Target' restrict the search to
1730 headlines. When searching, Org-mode will first try an exact match, but
1731 then move on to more and more lenient searches. For example, the link
1732 `[[*My Targets]]' will find any of the following:
1735 ** TODO my targets are bright
1736 ** my 20 targets are
1738 To insert a link targeting a headline, in-buffer completion can be
1739 used. Just type a star followed by a few optional letters into the
1740 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1741 offered as completions. *Note Handling links::, for more commands
1744 Following a link pushes a mark onto Org-mode's own mark ring. You
1745 can return to the previous position with `C-c &'. Using this command
1746 several times in direct succession goes back to positions recorded
1751 * Radio targets:: Make targets trigger links in plain text.
1753 ---------- Footnotes ----------
1755 (1) Note that text before the first headline will never be exported,
1756 so the first such target must be after the first headline.
1759 File: org, Node: Radio targets, Prev: Internal links, Up: Internal links
1764 You can configure Org-mode to link any occurrences of certain target
1765 names in normal text. So without explicitly creating a link, the text
1766 connects to the target radioing its position. Radio targets are
1767 enclosed by triple angular brackets. For example, a target `<<<My
1768 Target>>>' causes each occurrence of `my target' in normal text to
1769 become activated as a link. The Org-mode file is scanned automatically
1770 for radio targets only when the file is first loaded into Emacs. To
1771 update the target list during editing, press `C-c C-c' with the cursor
1775 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1780 Org-mode supports links to files, websites, Usenet and email messages,
1781 and BBDB database entries. External links are URL-like locators. They
1782 start with a short identifying string followed by a colon. There can be
1783 no space after the colon. The following list shows examples for each
1786 http://www.astro.uva.nl/~dominik on the web
1787 file:/home/dominik/images/jupiter.jpg file, absolute path
1788 file:papers/last.pdf file, relative path
1789 news:comp.emacs Usenet link
1790 mailto:adent@galaxy.net Mail link
1791 vm:folder VM folder link
1792 vm:folder#id VM message link
1793 vm://myself@some.where.org/folder#id VM on remote machine
1794 wl:folder WANDERLUST folder link
1795 wl:folder#id WANDERLUST message link
1796 mhe:folder MH-E folder link
1797 mhe:folder#id MH-E message link
1798 rmail:folder RMAIL folder link
1799 rmail:folder#id RMAIL message link
1800 gnus:group GNUS group link
1801 gnus:group#id GNUS article link
1802 bbdb:Richard Stallman BBDB link
1803 shell:ls *.org A shell command
1804 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1806 A link should be enclosed in double brackets and may contain a
1807 descriptive text to be displayed instead of the url (*note Link
1808 format::), for example:
1810 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1812 If the description is a file name or URL that points to an image, HTML
1813 export (*note HTML export::) will inline the image as a clickable
1814 button. If there is no description at all and the link points to an
1815 image, that image will be inlined into the exported HTML file.
1817 Org-mode also finds external links in the normal text and activates
1818 them as links. If spaces must be part of the link (for example in
1819 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1820 the end of the link, enclose them in angular brackets.
1823 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1828 Org-mode provides methods to create a link in the correct syntax, to
1829 insert it into an org-mode file, and to follow the link.
1832 Store a link to the current location. This is a _global_ command
1833 which can be used in any buffer to create a link. The link will be
1834 stored for later insertion into an Org-mode buffer (see below).
1835 For Org-mode files, if there is a `<<target>>' at the cursor, the
1836 link points to the target. Otherwise it points to the current
1837 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1838 the link will indicate the current article/entry. For W3 and W3M
1839 buffers, the link goes to the current URL. For any other files,
1840 the link will point to the file, with a search string (*note
1841 Search options::) pointing to the contents of the current line.
1842 If there is an active region, the selected words will form the
1843 basis of the search string. If the automatically created link is
1844 not working correctly or accurately enough, you can write custom
1845 functions to select the search string and to do the search for
1846 particular file types - see *Note Custom searches::. The key
1847 binding `C-c l' is only a suggestion - see *Note Installation::.
1850 Insert a link. This prompts for a link to be inserted into the
1851 buffer. You can just type a link, using text for an internal
1852 link, or one of the link type prefixes mentioned in the examples
1853 above. All links stored during the current session are part of
1854 the history for this prompt, so you can access them with <up> and
1855 <down>, or with completion(1). The link will be inserted into the
1856 buffer, along with a descriptive text. If some text was selected
1857 when this command is called, the selected text becomes the default
1859 Note that you don't have to use this command to insert a link.
1860 Links in Org-mode are plain text, and you can type or paste them
1861 straight into the buffer. By using this command, the links are
1862 automatically enclosed in double brackets, and you will be asked
1863 for the optional descriptive text.
1866 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1867 file will be inserted and you may use file name completion to
1868 select the name of the file. The path to the file is inserted
1869 relative to the directory of the current org file, if the linked
1870 file is in the current directory or in a subdirectory of it, or if
1871 the path is written relative to the current directory using `../'.
1872 Otherwise an absolute path is used, if possible with `~/' for
1873 your home directory. You can force an absolute path with two
1876 `C-c C-l with cursor on existing link'
1877 When the cursor is on an existing link, `C-c C-l' allows you to
1878 edit the link and description parts of the link.
1881 Open link at point. This will launch a web browser for URLs (using
1882 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1883 the corresponding links, and execute the command in a shell link.
1884 When the cursor is on an internal link, this commands runs the
1885 corresponding search. When the cursor is on a TAG list in a
1886 headline, it creates the corresponding TAGS view. If the cursor
1887 is on a time stamp, it compiles the agenda for that date.
1888 Furthermore, it will visit text and remote files in `file:' links
1889 with Emacs and select a suitable application for local non-text
1890 files. Classification of files is based on file extension only.
1891 See option `org-file-apps'. If you want to override the default
1892 application and visit the file with Emacs, use a `C-u' prefix.
1896 On links, `mouse-2' will open the link just as `C-c C-o' would.
1897 Under Emacs 22, also `mouse-1' will follow a link.
1900 Like `mouse-2', but force file links to be opened with Emacs, and
1901 internal links to be displayed in another window(2).
1904 Push the current position onto the mark ring, to be able to return
1905 easily. Commands following an internal link do this automatically.
1908 Jump back to a recorded position. A position is recorded by the
1909 commands following internal links, and by `C-c %'. Using this
1910 command several times in direct succession moves through a ring of
1911 previously recorded positions.
1915 Move forward/backward to the next link in the buffer. At the
1916 limit of the buffer, the search fails once, and then wraps around.
1917 The key bindings for this are really too long, you might want to
1918 bind this also to `C-n' and `C-p'
1919 (add-hook 'org-load-hook
1921 (define-key 'org-mode-map "\C-n" 'org-next-link)
1922 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
1924 ---------- Footnotes ----------
1926 (1) After insertion of a stored link, the link will be removed from
1927 the list of stored links. To keep it in the list later use, use a
1928 triple `C-u' prefix to `C-c C-l', or configure the option
1929 `org-keep-stored-link-after-insertion'.
1931 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1934 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1936 4.5 Link abbreviations
1937 ======================
1939 Long URLs can be cumbersome to type, and often many similar links are
1940 needed in a document. For this you can use link abbreviations. An
1941 abbreviated link looks like this
1943 [[linkword:tag][description]]
1945 where the tag is optional. Such abbreviations are resolved according to
1946 the information in the variable `org-link-abbrev-alist' that relates
1947 the linkwords to replacement text. Here is an example:
1949 (setq org-link-abbrev-alist
1950 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1951 ("google" . "http://www.google.com/search?q=")
1952 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
1953 nph-abs_connect?author=%s&db_key=AST")))
1955 If the replacement text contains the string `%s', it will be
1956 replaced with the tag. Otherwise the tag will be appended to the string
1957 in order to create the link. You may also specify a function that will
1958 be called with the tag as the only argument to create the link.
1960 With the above setting, you could link to a specific bug with
1961 `[[bugzilla:129]]', search the web for `OrgMode' with
1962 `[[google:OrgMode]]' and find out what the Org-mode author is doing
1963 besides Emacs hacking with `[[ads:Dominik,C]]'.
1965 If you need special abbreviations just for a single Org-mode buffer,
1966 you can define them in the file with
1968 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
1969 #+LINK: google http://www.google.com/search?q=%s
1971 In-buffer completion *note Completion:: can be used after `[' to
1972 complete link abbreviations.
1975 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
1977 4.6 Search options in file links
1978 ================================
1980 File links can contain additional information to make Emacs jump to a
1981 particular location in the file when following a link. This can be a
1982 line number or a search option after a double(1) colon. For example,
1983 when the command `C-c l' creates a link (*note Handling links::) to a
1984 file, it encodes the words in the current line as a search string that
1985 can be used to find this line back later when following the link with
1988 Here is the syntax of the different ways to attach a search to a file
1989 link, together with an explanation:
1991 [[file:~/code/main.c::255]]
1992 [[file:~/xx.org::My Target]]
1993 [[file:~/xx.org::*My Target]]
1994 [[file:~/xx.org::/regexp/]]
2000 Search for a link target `<<My Target>>', or do a text search for
2001 `my target', similar to the search in internal links, see *Note
2002 Internal links::. In HTML export (*note HTML export::), such a
2003 file link will become an HTML reference to the corresponding named
2004 anchor in the linked file.
2007 In an Org-mode file, restrict search to headlines.
2010 Do a regular expression search for `regexp'. This uses the Emacs
2011 command `occur' to list all matches in a separate window. If the
2012 target file is in Org-mode, `org-occur' is used to create a sparse
2013 tree with the matches.
2015 As a degenerate case, a file link with an empty file name can be used
2016 to search the current file. For example, `[[file:::find me]]' does a
2017 search for `find me' in the current file, just as `[[find me]]' would.
2019 ---------- Footnotes ----------
2021 (1) For backward compatibility, line numbers can also follow a
2025 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
2030 The default mechanism for creating search strings and for doing the
2031 actual search related to a file link may not work correctly in all
2032 cases. For example, BibTeX database files have many entries like
2033 `year="1993"' which would not result in good search strings, because
2034 the only unique identification for a BibTeX entry is the citation key.
2036 If you come across such a problem, you can write custom functions to
2037 set the right search string for a particular file type, and to do the
2038 search for the string in the file. Using `add-hook', these functions
2039 need to be added to the hook variables
2040 `org-create-file-search-functions' and
2041 `org-execute-file-search-functions'. See the docstring for these
2042 variables for more information. Org-mode actually uses this mechanism
2043 for BibTeX database files, and you can use the corresponding code as an
2044 implementation example. Search for `BibTeX links' in the source file.
2047 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
2052 Another way to create org entries with links to other files is through
2053 the remember package by John Wiegley. Remember lets you store quick
2054 notes with little interruption of your work flow. See
2055 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2056 information. The notes produced by Remember can be stored in different
2057 ways, and Org-mode files are a good target. Org-mode significantly
2058 expands the possibilities of remember: You may define templates for
2059 different note types, and to associate target files and headlines with
2060 specific templates. It also allows you to select the location where a
2061 note should be stored interactively, on the fly.
2065 * Setting up remember:: Some code for .emacs to get things going
2066 * Remember templates:: Define the outline of different note types
2067 * Storing notes:: Directly get the note to where it belongs
2070 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
2072 4.8.1 Setting up remember
2073 -------------------------
2075 The following customization will tell remember to use org files as
2076 target, and to create annotations compatible with Org-mode links.
2078 (setq org-directory "~/path/to/my/orgfiles/")
2079 (setq org-default-notes-file "~/.notes")
2080 (setq remember-annotation-functions '(org-remember-annotation))
2081 (setq remember-handler-functions '(org-remember-handler))
2082 (add-hook 'remember-mode-hook 'org-remember-apply-template)
2085 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
2087 4.8.2 Remember templates
2088 ------------------------
2090 In combination with Org-mode, you can use templates to generate
2091 different types of remember notes. For example, if you would like to
2092 use one template to create general TODO entries, another one for
2093 journal entries, and a third one for collecting random ideas, you could
2096 (setq org-remember-templates
2097 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
2098 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
2099 (?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
2101 In these entries, the character specifies how to select the template.
2102 The first string specifies the template. Two more (optional) strings
2103 give the file in which, and the headline under which the new note
2104 should be stored. The file defaults to `org-default-notes-file', the
2105 heading to `org-remember-default-headline'. Both defaults help to get
2106 to the storing location quickly, but you can change the location
2107 interactively while storing the note.
2109 When you call `M-x remember' (or `M-x org-remember') to remember
2110 something, org will prompt for a key to select the template (if you have
2111 more than one template) and then prepare the buffer like
2113 [[file:link to where you called remember]]
2117 * [2006-03-21 Tue 15:37]
2119 [[file:link to where you called remember]]
2121 During expansion of the template, special `%'-escapes allow dynamic
2122 insertion of content:
2123 %^{prompt} prompt the user for a string and replace this sequence with it.
2124 %t time stamp, date only
2125 %T time stamp with date and time
2126 %u, %U like the above, but inactive time stamps
2127 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
2128 You may define a prompt like `%^{Birthday}t'
2129 %n user name (taken from `user-full-name')
2130 %a annotation, normally the link created with `org-store-link'
2131 %i initial content, the region when remember is called with C-u.
2132 The entire text will be indented like `%i' itself.
2133 %:keyword specific information for certain link types, see below
2135 For specific link types, the following keywords will be defined:
2137 Link type | Available keywords
2138 -------------------+----------------------------------------------
2139 bbdb | %:name %:company
2140 vm, wl, mh, rmail | %:type %:subject %:message-id
2141 | %:from %:fromname %:fromaddress
2142 | %:to %:toname %:toaddress
2143 | %:fromto (either "to NAME" or "from NAME")(1)
2144 gnus | %:group, for messages also all email fields
2146 info | %:file %:node
2149 If you would like to have the cursor in a specific position after the
2150 template has been expanded:
2152 %? After completing the template, position cursor here.
2154 If you change you mind about which template to use, call `org-remember'
2155 in the remember buffer. You may then select a new template that will
2156 be filled with the previoous context information.
2158 ---------- Footnotes ----------
2160 (1) This will always be the other, not the user. See the variable
2161 `org-from-is-user-regexp'.
2164 File: org, Node: Storing notes, Prev: Remember templates, Up: Remember
2169 When you are finished preparing a note with remember, you have to press
2170 `C-c C-c' to file the note away. The handler first prompts for a
2171 target file - if you press <RET>, the value specified for the template
2172 is used. Then the command offers the headings tree of the selected
2173 file, with the cursor position at the default headline (if you had
2174 specified one in the template). You can either immediately press <RET>
2175 to get the note placed there. Or you can use vertical cursor motion
2176 (<up> and <down>) and visibility cycling (<TAB>) to find a better
2177 place. Pressing <RET> or <left> or <right> then leads to the following
2180 Cursor Key Note gets inserted
2182 buffer-start <RET> as level 2 heading at end of file
2183 on headline <RET> as sublevel of the heading at cursor
2184 <left> as same level, before current heading
2185 <right> as same level, after current heading
2186 not on <RET> at cursor position, level taken from context.
2187 headline Or use prefix arg to specify level
2190 So a fast way to store the note to its default location is to press
2191 `C-c C-c <RET> <RET>'. Even shorter would be `C-u C-c C-c', which does
2192 the same without even asking for a file or showing the tree.
2194 Before inserting the text into a tree, the function ensures that the
2195 text has a headline, i.e. a first line that starts with a `*'. If not,
2196 a headline is constructed from the current date and some additional
2197 data. If the variable `org-adapt-indentation' is non-nil, the entire
2198 text is also indented so that it starts in the same column as the
2199 headline (after the asterisks).
2202 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
2207 Org-mode does not maintain TODO lists as a separate document. TODO
2208 items are an integral part of the notes file, because TODO items
2209 usually come up while taking notes! With Org-mode, you simply mark any
2210 entry in a tree as being a TODO item. In this way, the information is
2211 not duplicated, and the entire context from which the item emerged is
2212 always present when you check.
2214 Of course, this technique causes TODO items to be scattered
2215 throughout your file. Org-mode provides methods to give you an
2216 overview over all things you have to do.
2220 * TODO basics:: Marking and displaying TODO entries
2221 * TODO extensions:: Workflow and assignments
2222 * Priorities:: Some things are more important than others
2223 * Breaking down tasks:: Splitting a task into managable pieces
2224 * Checkboxes:: Tick-off lists
2227 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2229 5.1 Basic TODO functionality
2230 ============================
2232 Any headline can become a TODO item by starting it with the word TODO,
2235 *** TODO Write letter to Sam Fortune
2237 The most important commands to work with TODO entries are:
2240 Rotate the TODO state of the current item between
2242 ,-> (unmarked) -> TODO -> DONE --.
2243 '--------------------------------'
2245 The same rotation can also be done "remotely" from the timeline and
2246 agenda buffers with the `t' command key (*note Agenda commands::).
2250 Select the following/preceding TODO state, similar to cycling.
2251 Mostly useful if more than two TODO states are possible (*note
2255 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2256 the entire buffer, but shows all TODO items and the headings
2257 hierarchy above them. With prefix arg, show also the DONE
2258 entries. With numerical prefix N, show the tree for the Nth
2259 keyword in the variable `org-todo-keywords'.
2262 Show the global TODO list. This collects the TODO items from all
2263 agenda files (*note Agenda views::) into a single buffer. The
2264 buffer is in `agenda-mode', so there are commands to examine and
2265 manipulate the TODO entries directly from that buffer (*note
2266 Agenda commands::). *Note Global TODO list::, for more
2270 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2272 5.2 Extended use of TODO keywords
2273 =================================
2275 The default implementation of TODO entries is just two states: TODO and
2276 DONE. You can, however, use the TODO feature for more complicated
2277 things by configuring the variables `org-todo-keywords' and
2278 `org-todo-interpretation'. Using special setup, you can even use TODO
2279 keywords in different ways in different org files.
2281 Note that tags are another way to classify headlines in general and
2282 TODO items in particular (*note Tags::).
2286 * Workflow states:: From TODO to DONE in steps
2287 * TODO types:: I do this, Fred the rest
2288 * Per file keywords:: Different files, different requirements
2291 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2293 5.2.1 TODO keywords as workflow states
2294 --------------------------------------
2296 You can use TODO keywords to indicate different states in the process
2297 of working on an item, for example:
2299 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2300 org-todo-interpretation 'sequence)
2302 Changing these variables only becomes effective in a new Emacs
2303 session. With this setup, the command `C-c C-t' will cycle an entry
2304 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
2305 also use a prefix argument to quickly select a specific state. For
2306 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
2307 you define many keywords, you can use in-buffer completion (see *Note
2308 Completion::) to insert these words into the buffer. Changing a todo
2309 state can be logged with a timestamp, see *Note Tracking TODO state
2310 changes:: for more information.
2313 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
2315 5.2.2 TODO keywords as types
2316 ----------------------------
2318 The second possibility is to use TODO keywords to indicate different
2319 types of action items. For example, you might want to indicate that
2320 items are for "work" or "home". If you are into David Allen's _Getting
2321 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2322 `MAYBE'. Or, when you work with several people on a single project,
2323 you might want to assign action items directly to persons, by using
2324 their names as TODO keywords. This would be set up like this:
2326 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2327 org-todo-interpretation 'type)
2329 In this case, different keywords do not indicate a sequence, but
2330 rather different types. So it is normally not useful to change from
2331 one type to another. Therefore, in this case the behavior of the
2332 command `C-c C-t' is changed slightly(1). When used several times in
2333 succession, it will still cycle through all names. But when you return
2334 to the item after some time and execute `C-c C-t' again, it will switch
2335 from each name directly to DONE. Use prefix arguments or completion to
2336 quickly select a specific name. You can also review the items of a
2337 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2338 C-v'. For example, to see all things Lucy has to do, you would use
2339 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2340 single buffer, you would use the prefix arg as well when creating the
2341 global todo list: `C-3 C-c t'.
2343 ---------- Footnotes ----------
2345 (1) This is also true for the `t' command in the timeline and agenda
2349 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2351 5.2.3 Setting up TODO keywords for individual files
2352 ---------------------------------------------------
2354 It can be very useful to use different aspects of the TODO mechanism in
2355 different files, which is not possible with the global settings
2356 described above. For file-local settings, you need to add special
2357 lines to the file which set the keywords and interpretation for that
2358 file only. For example, to set one of the two examples discussed
2359 above, you need one of the following lines, starting in column zero
2360 anywhere in the file:
2362 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2363 #+TYP_TODO: Fred Sara Lucy Mike DONE
2365 To make sure you are using the correct keyword, type `#+' into the
2366 buffer and then use `M-<TAB>' completion.
2368 Remember that the last keyword must always mean that the item is DONE
2369 (although you may use a different word). Also note that in each file,
2370 only one of the two aspects of TODO keywords can be used. After
2371 changing one of these lines, use `C-c C-c' with the cursor still in the
2372 line to make the changes known to Org-mode(1).
2374 If you want to use very many keywords, for example when working with
2375 a large group of people, you may split the names over several lines:
2377 #+TYP_TODO: Fred Sara Lucy Mike
2378 #+TYP_TODO: Luis George Jules Jessica
2379 #+TYP_TODO: Kim Arnold Peter
2382 ---------- Footnotes ----------
2384 (1) Org-mode parses these lines only when Org-mode is activated
2385 after visiting a file. `C-c C-c' with the cursor in a line starting
2386 with `#+' is simply restarting Org-mode for the current buffer.
2389 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2394 If you use Org-mode extensively to organize your work, you may end up
2395 with a number of TODO entries so large that you'd like to prioritize
2396 them. This can be done by placing a _priority cookie_ into the
2399 *** TODO [#A] Write letter to Sam Fortune
2401 With its standard setup, Org-mode supports priorities `A', `B', and
2402 `C'. `A' is the highest priority. An entry without a cookie is
2403 treated as priority `B'. Priorities make a difference only in the
2404 agenda (*note Weekly/Daily agenda::).
2407 Set the priority of the current headline. The command prompts for
2408 a priority character `A', `B' or `C'. When you press <SPC>
2409 instead, the priority cookie is removed from the headline. The
2410 priorities can also be changed "remotely" from the timeline and
2411 agenda buffer with the `,' command (*note Agenda commands::).
2415 Increase/decrease priority of current headline. Note that these
2416 keys are also used to modify time stamps (*note Creating
2417 timestamps::). Furthermore, these keys are also used by CUA-mode
2418 (*note Conflicts::).
2421 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2423 5.4 Breaking tasks down into subtasks
2424 =====================================
2426 It is often advisable to break down large tasks into smaller, managable
2427 subtasks. You can do this by creating an outline tree below a TODO
2428 item, with detailed subtasks on the tree(1). Another possibility is
2429 the use of checkboxes to identify (a hierarchy of) a large number of
2430 subtasks (*note Checkboxes::).
2432 ---------- Footnotes ----------
2434 (1) To keep subtasks out of the global TODO list, see the
2435 `org-agenda-todo-list-sublevels'.
2438 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2443 Every item in a plain list (*note Plain lists::) can be made a checkbox
2444 by starting it with the string `[ ]'. This feature is similar to TODO
2445 items (*note TODO items::), but more lightweight. Checkboxes are not
2446 included into the global TODO list, so they are often great to split a
2447 task into a number of simple steps. Or you can use them in a shopping
2448 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2449 `org-mouse.el'. Here is an example of a checkbox list.
2451 * TODO Organize party [3/6]
2457 - [ ] think about what music to play
2458 - [X] talk to the neighbors
2460 The `[3/6]' and `[1/3]' in the first and second line are cookies
2461 indicating how many checkboxes are present in this entry, and how many
2462 of them have been checked off. This can give you an idea on how many
2463 checkboxes remain, even without opening a folded entry. The cookies
2464 can be placed into a headline or into (the first line of) a plain list
2465 item. Each cookie covers all checkboxes structurally below that
2466 headline/item. You have to insert the cookie yourself by typing either
2467 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2468 the second case you get information about the percentage of checkboxes
2469 checked (in the above example, this would be `[50%]' and `[33%],
2472 The following commands work with checkboxes:
2475 Toggle checkbox at point.
2478 Toggle checkbox at point.
2479 - If there is an active region, toggle the first checkbox in
2480 the region and set all remaining boxes to the same status as
2481 the first. If you want to toggle all boxes in the region
2482 independently, use a prefix argument.
2484 - If the cursor is in a headline, toggle checkboxes in the
2485 region between this headline and the next (so _not_ the
2488 - If there is no active region, just toggle the checkbox at
2492 Insert a new item with a checkbox. This works only if the cursor
2493 is already in a plain list item (*note Plain lists::).
2496 Update the checkbox statistics in the current outline entry. When
2497 called with a `C-u' prefix, update the entire file. Checkbox
2498 statistic cookies are updated automatically if you toggle
2499 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2500 you delete boxes or add/change them by hand, use this command to
2501 get things back into synch. Or simply toggle any checkbox twice
2505 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2510 Items can be labeled with timestamps to make them useful for project
2515 * Time stamps:: Assigning a time to a tree entry
2516 * Creating timestamps:: Commands which insert timestamps
2517 * Custom time format:: If you cannot work with the ISO format
2518 * Repeating items:: Deadlines that come back again and again
2519 * Progress logging:: Documenting when what work was done.
2522 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2524 6.1 Time stamps, deadlines and scheduling
2525 =========================================
2527 A time stamp is a specification of a date (possibly with time) in a
2528 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2529 09:39>'(1). A time stamp can appear anywhere in the headline or body
2530 of an org-tree entry. Its presence allows entries to be shown on
2531 specific dates in the agenda (*note Weekly/Daily agenda::). We
2535 A simple time stamp just assigns a date/time to an item. This is
2536 just like writing down an appointment in a paper agenda, or like
2537 writing down an event in a diary, when you want to take note of
2538 when something happened. In the timeline and agenda displays, the
2539 headline of an entry associated with a plain time stamp will be
2540 shown exactly on that date.
2542 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2545 Just like a plain time stamp, but with square brackets instead of
2546 angular ones. These time stamps are inactive in the sense that
2547 they do _not_ trigger an entry to show up in the agenda.
2549 * Gillian comes late for the fifth time [2006-11-01 Wed]
2552 Two time stamps connected by `--' denote a time range. The
2553 headline will be shown on the first and last day of the range, and
2554 on any dates that are displayed and fall in the range. Here is an
2557 ** Meeting in Amsterdam
2558 <2004-08-23 Mon>--<2004-08-26 Thu>
2560 TIME STAMP WITH SCHEDULED KEYWORD
2561 If a time stamp is preceded by the word `SCHEDULED:', it means you
2562 are planning to start working on that task on the given date. So
2563 this is not about recording an event, but about planning your
2564 work. The headline will be listed under the given date(2). In
2565 addition, a reminder that the scheduled date has passed will be
2566 present in the compilation for _today_, until the entry is marked
2567 DONE. I.e., the task will automatically be forwarded until
2570 *** TODO Call Trillian for a date on New Years Eve.
2571 SCHEDULED: <2004-12-25 Sat>
2573 TIME STAMP WITH DEADLINE KEYWORD
2574 If a time stamp is preceded by the word `DEADLINE:', the task
2575 (most likely a TODO item) is supposed to be finished on that date,
2576 and it will be listed then. In addition, the compilation for
2577 _today_ will carry a warning about the approaching or missed
2578 deadline, starting `org-deadline-warning-days' before the due
2579 date, and continuing until the entry is marked DONE. An example:
2581 *** TODO write article about the Earth for the Guide
2582 The editor in charge is [[bbdb:Ford Prefect]]
2583 DEADLINE: <2004-02-29 Sun>
2585 TIME STAMP WITH CLOSED KEYWORD
2586 When `org-log-done' is non-nil, Org-mode will automatically insert
2587 a special time stamp each time a TODO entry is marked done (*note
2588 Progress logging::). This time stamp is enclosed in square
2589 brackets instead of angular brackets.
2591 TIME RANGE WITH CLOCK KEYWORD
2592 When using the clock to time the work that is being done on
2593 specific items, time ranges preceded by the CLOCK keyword are
2594 inserted automatically into the file. The time stamps are
2595 enclosed in square brackets instead of angular brackets. *Note
2596 Clocking work time::.
2598 ---------- Footnotes ----------
2600 (1) This is the standard ISO date/time format. If you cannot get
2601 used to these, see *Note Custom time format::
2603 (2) It will still be listed on that date after it has been marked
2604 DONE. If you don't like this, set the variable
2605 `org-agenda-skip-scheduled-if-done'.
2608 File: org, Node: Creating timestamps, Next: Custom time format, Prev: Time stamps, Up: Timestamps
2610 6.2 Creating timestamps
2611 =======================
2613 For Org-mode to recognize time stamps, they need to be in the specific
2614 format. All commands listed below produce time stamps in the correct
2618 Prompt for a date and insert a corresponding time stamp. When the
2619 cursor is at a previously used time stamp, it is updated to NOW.
2620 When this command is used twice in succession, a time range is
2624 Like `C-c .', but use the alternative format which contains date
2625 and time. The default time can be rounded to multiples of 5
2626 minutes, see the option `org-time-stamp-rounding-minutes'.
2629 Like `C-c .', but insert an inactive time stamp not triggering the
2633 Insert a time stamp corresponding to the cursor date in the
2637 Access the Emacs calendar for the current date. If there is a
2638 timestamp in the current line, goto the corresponding date instead.
2641 Access the agenda for the date given by the time stamp or -range at
2642 point (*note Weekly/Daily agenda::).
2645 Insert `DEADLINE' keyword along with a stamp. The insertion will
2646 happen in the line directly following the headline.
2649 Create a sparse tree with all deadlines that are either past-due,
2650 or which will become due within `org-deadline-warning-days'. With
2651 `C-u' prefix, show all deadlines in the file. With a numeric
2652 prefix, check that many days. For example, `C-1 C-c C-w' shows
2653 all deadlines due tomorrow.
2656 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2657 happen in the line directly following the headline. Any CLOSED
2658 timestamp will be removed.
2662 Change date at cursor by one day. These key bindings conflict with
2663 CUA-mode (*note Conflicts::).
2667 Change the item under the cursor in a timestamp. The cursor can
2668 be on a year, month, day, hour or minute. Note that if the cursor
2669 is in a headline and not at a time stamp, these same keys modify
2670 the priority of an item. (*note Priorities::). The key bindings
2671 also conflict with CUA-mode (*note Conflicts::).
2674 Evaluate a time range by computing the difference between start and
2675 end. With prefix arg, insert result after the time range (in a
2676 table: into the following column).
2680 * The date/time prompt:: How org-mode helps you entering date and time
2683 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2685 6.2.1 The date/time prompt
2686 --------------------------
2688 When Org-mode prompts for a date/time, the prompt suggests to enter an
2689 ISO date. But it will in fact accept any string containing some date
2690 and/or time information. You can, for example, use `C-y' to paste a
2691 (possibly multi-line) string copied from an email message. Org-mode
2692 will find whatever information is in there and will replace anything not
2693 specified with the current date and time. For example:
2695 3-2-5 --> 2003-02-05
2696 feb 15 --> currentyear-02-15
2697 sep 12 9 --> 2009-09-12
2698 12:45 --> today 12:45
2699 22 sept 0:34 --> currentyear-09-22 0:34
2700 12 --> currentyear-currentmonth-12
2701 Fri --> nearest Friday (today or later)
2702 +4 --> 4 days from now (if +N is the only thing given)
2704 The function understands English month and weekday abbreviations. If
2705 you want to use unabbreviated names and/or other languages, configure
2706 the variables `parse-time-months' and `parse-time-weekdays'.
2708 Parallel to the minibuffer prompt, a calendar is popped up(1). When
2709 you exit the date prompt, either by clicking on a date in the calendar,
2710 or by pressing <RET>, the date selected in the calendar will be
2711 combined with the information entered at the prompt. You can control
2712 the calendar fully from the minibuffer:
2715 Scroll calendar backwards by one month.
2718 Scroll calendar forwards by one month.
2721 Select date by clicking on it.
2742 Choose date in calendar (only if nothing was typed into
2745 ---------- Footnotes ----------
2747 (1) If you don't need/want the calendar, configure the variable
2748 `org-popup-calendar-for-date-prompt'.
2751 File: org, Node: Custom time format, Next: Repeating items, Prev: Creating timestamps, Up: Timestamps
2753 6.3 Custom time format
2754 ======================
2756 Org-mode uses the standard ISO notation for dates and times as it is
2757 defined in ISO 8601. If you cannot get used to this and require another
2758 representation of date and time to keep you happy, you can get it by
2759 customizing the variables `org-display-custom-times' and
2760 `org-time-stamp-custom-formats'.
2763 Toggle the display of custom formats for dates and times.
2765 Org-mode needs the default format for scanning, so the custom date/time
2766 format does not _replace_ the default format - instead it is put _over_
2767 the default format using text properties. This has the following
2769 * You cannot place the cursor onto a time stamp anymore, only before
2772 * The `S-<up>/<down>' keys can no longer be used to adjust each
2773 component of a time stamp. If the cursor is at the beginning of
2774 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2775 like `S-<left>/<right>'. At the end of the stamp, the time will
2776 be changed by one minute.
2778 * When you delete a time stamp character-by-character, it will only
2779 disappear from the buffer after _all_ (invisible) characters
2780 belonging to the ISO timestamp have been removed.
2782 * If the custom time stamp format is longer than the default and you
2783 are using dates in tables, table alignment will be messed up. If
2784 the custom format is shorter, things do work as expected.
2787 File: org, Node: Repeating items, Next: Progress logging, Prev: Custom time format, Up: Timestamps
2792 Org-mode integrates with the Emacs calendar and diary to display cyclic
2793 appointments, anniversaries and other special entries in the agenda
2794 (*note Weekly/Daily agenda::). However, it can be useful to have
2795 certain deadlines and scheduling items to auto-repeat. The advantage of
2796 a deadline or scheduled item is that the they produce warnings ahead of
2797 time and automatically forward themselves in the agenda until they are
2798 done. The abstract difference is therefore between cyclic appointments
2799 and cyclic action items. For appointments you should use the diary,
2800 for actions you can uses an org-mode deadline or scheduling time stamp
2801 together with a REPEAT cookie. For example:
2803 * TODO Replace batteries in smoke detector REPEAT(+18m)
2804 SCHEDULED: <2007-01-01 Mon>
2806 * TODO Get dentist appointment REPEAT(+6m)
2807 SCHEDULED: <2006-12-19 Tue>
2809 * TODO Tax report to IRS REPEAT(+1y)
2810 DEADLINE: <2007-04-01 Sun>
2812 Each time you try to mark one of these entries DONE using `C-c C-t',
2813 they will automatically switch back to the state TODO, and the
2814 deadline/scheduling will be shifted accordingly. The time units
2815 recognized by org-mode are year (y), month (m), week (w), and day (d).
2816 Org-mode will also prompt you for a note and record the fact that you
2817 have closed this item in a note under the headline.
2819 One unusual property of these repeating items is that only one
2820 instance of each exist at any given time. So if you look back or ahead
2821 in the agenda, you will not find past and future instances, only the
2822 current one will show up. Use a cyclic diary entry if you need all
2823 past and future instances to be visible in the agenda.
2826 File: org, Node: Progress logging, Prev: Repeating items, Up: Timestamps
2828 6.5 Progress Logging
2829 ====================
2831 Org-mode can automatically record a time stamp when you mark a TODO item
2832 as DONE, or even each time when you change the state of a TODO item.
2833 You can also measure precisely the time you spent on specific items in a
2834 project by starting and stopping a clock when you start and stop working
2835 on an aspect of a project.
2839 * Closing items:: When was this entry marked DONE?
2840 * Tracking TODO state changes:: When did the status change?
2841 * Clocking work time:: When exactly did you work on this item?
2844 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
2849 If you want to keep track of _when_ a certain TODO item was finished,
2850 turn on logging with(1)
2852 (setq org-log-done t)
2854 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2855 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2856 [timestamp]' will be inserted just after the headline. If you turn the
2857 entry back into a TODO item through further state cycling, that line
2858 will be removed again. In the timeline (*note Timeline::) and in the
2859 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
2860 display the TODO items closed on each day, giving you an overview of
2861 what has been done on a day. If you want to record a note along with
2862 the timestamp, use(2)
2864 (setq org-log-done '(done))
2866 ---------- Footnotes ----------
2868 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
2870 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
2873 File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
2875 6.5.2 Tracking TODO state changes
2876 ---------------------------------
2878 When TODO keywords are used as workflow states (*note Workflow
2879 states::), you might want to keep track of when a state change occurred,
2880 and you may even want to attach notes to that state change. With the
2883 (setq org-log-done '(state))
2885 each state change will prompt you for a note that will be attached to
2886 the current headline. Very likely you do not want this verbose tracking
2887 all the time, so it is probably better to configure this behavior with
2888 in-buffer options. For example, if you are tracking purchases, put
2889 these into a separate file that starts with:
2891 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
2892 #+STARTUP: lognotestate
2895 File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
2897 6.5.3 Clocking work time
2898 ------------------------
2900 Org-mode allows you to clock the time you spent on specific tasks in a
2901 project. When you start working on an item, you can start the clock.
2902 When you stop working on that task, or when you mark the task done, the
2903 clock is stopped and the corresponding time interval is recorded. It
2904 also computes the total time spent on each subtree of a project.
2907 Start the clock on the current item (clock-in). This inserts the
2908 CLOCK keyword together with a timestamp.
2911 Stop the clock (clock-out). The inserts another timestamp at the
2912 same location where the clock was last started. It also directly
2913 computes the resulting time in inserts it after the time range as
2914 `=> HH:MM'. See the variable `org-log-done' for the possibility to
2915 record an additional note together with the clock-out time
2919 Recompute the time interval after changing one of the time stamps.
2920 This is only necessary if you edit the time stamps directly. If
2921 you change them with `S-<cursor>' keys, the update is automatic.
2924 Changing the TODO state of an item to DONE automatically stops the
2925 clock if it is running in this same item.
2928 Cancel the current clock. This is useful if a clock was started by
2929 mistake, or if you ended up working on something else.
2932 Display time summaries for each subtree in the current buffer.
2933 This puts overlays at the end of each headline, showing the total
2934 time recorded under that heading, including the time of any
2935 subheadings. You can use visibility cycling to study the tree, but
2936 the overlays disappear when you change the buffer (see variable
2937 `org-remove-highlights-with-change') or press `C-c C-c'.
2940 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2941 report as an org-mode table into the current file.
2942 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2945 If such a block already exists, its content is replaced by the new
2946 table. The `BEGIN' line can specify options:
2947 :maxlevels Maximum level depth to which times are listed in the table.
2948 :emphasize When `t', emphasize level one and level two items
2949 :block The time block to consider. This block is specified relative
2950 to the current time and may be any of these keywords:
2951 `today', `yesterday', `thisweek', `lastweek',
2952 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2953 :tstart A time string specifying when to start considering times
2954 :tend A time string specifying when to stop considering times
2955 So to get a clock summary for the current day, you could write
2956 #+BEGIN: clocktable :maxlevel 2 :block today
2959 and to use a specific time range you could write(2)
2960 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2961 :tend "<2006-08-10 Thu 12:00>"
2966 Update all dynamic blocks (*note Dynamic blocks::). This is
2967 useful if you have several clocktable blocks in a buffer.
2969 The `l' key may be used in the timeline (*note Timeline::) and in
2970 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2971 worked on or closed during a day.
2973 ---------- Footnotes ----------
2975 (1) The corresponding in-buffer setting is: `#+STARTUP:
2978 (2) Note that all parameters must be specified in a single line -
2979 the line is broken here only to fit it onto the manual.
2982 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2987 If you wish to implement a system of labels and contexts for
2988 cross-correlating information, an excellent way is to assign tags to
2989 headlines. Org-mode has extensive support for using tags.
2991 Every headline can contain a list of tags, at the end of the
2992 headline. Tags are normal words containing letters, numbers, `_', and
2993 `@'. Tags must be preceded and followed by a single colon; like
2994 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2998 * Tag inheritance:: Tags use the tree structure of the outline
2999 * Setting tags:: How to assign tags to a headline
3000 * Tag searches:: Searching for combinations of tags
3003 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
3008 Tags make use of the hierarchical structure of outline trees. If a
3009 heading has a certain tag, all subheadings will inherit the tag as
3010 well. For example, in the list
3012 * Meeting with the French group :WORK:
3013 ** Summary by Frank :BOSS:NOTES:
3014 *** TODO Prepare slides for him :ACTION:
3016 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
3017 `:ACTION:'. When executing tag searches and Org-mode finds that a
3018 certain headline matches the search criterion, it will not check any
3019 sublevel headline, assuming that these likely also match, and that the
3020 list of matches can become very long. This may not be what you want,
3021 however, and you can influence inheritance and searching using the
3022 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
3025 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
3030 Tags can simply be typed into the buffer at the end of a headline.
3031 After a colon, `M-<TAB>' offers completion on tags. There is also a
3032 special command for inserting tags:
3035 Enter new tags for the current headline. Org-mode will either
3036 offer completion or a special single-key interface for setting
3037 tags, see below. After pressing <RET>, the tags will be inserted
3038 and aligned to `org-tags-column'. When called with a `C-u'
3039 prefix, all tags in the current buffer will be aligned to that
3040 column, just to make things look nice. TAGS are automatically
3041 realigned after promotion, demotion, and TODO state changes (*note
3044 Org will support tag insertion based on a _list of tags_. By
3045 default this list is constructed dynamically, containing all tags
3046 currently used in the buffer. You may also globally specify a hard list
3047 of tags with the variable `org-tag-alist'. Finally you can set the
3048 default tags for a given file with lines like
3050 #+TAGS: @WORK @HOME @TENNISCLUB
3051 #+TAGS: Laptop Car PC Sailboat
3053 If you have globally defined your preferred set of tags using the
3054 variable `org-tag-alist', but would like to use a dynamic tag list in a
3055 specific file: Just add an empty TAGS option line to that file:
3059 The default support method for entering tags is minibuffer
3060 completion. However, Org-mode also implements a much better method:
3061 _fast tag selection_. This method allows to select and deselect tags
3062 with a single key per tag. To function efficiently, you should assign
3063 unique keys to most tags. This can be done globally with
3065 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
3067 or on a per-file basis with
3069 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
3071 You can also group together tags that are mutually exclusive. With
3074 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
3076 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
3079 Don't forget to press `C-c C-c' with the cursor in one of these lines
3080 to activate any changes.
3082 If at least one tag has a selection key, pressing `C-c C-c' will
3083 automatically present you with a special interface, listing inherited
3084 tags, the tags of the current headline, and a list of all legal tags
3085 with corresponding keys(2). In this interface, you can use the
3089 Pressing keys assigned to tags will add or remove them from the
3090 list of tags in the current line. Selecting a tag in a group of
3091 mutually exclusive tags will turn off any other tags from that
3095 Enter a tag in the minibuffer, even if the tag is not in the
3096 predefined list. You will be able to complete on all tags present
3100 Clear all tags for this line.
3103 Accept the modified set.
3106 Abort without installing changes.
3109 If `q' is not assigned to a tag, it aborts like `C-g'.
3112 Turn off groups of mutually exclusive tags. Use this to (as an
3113 exception) assign several tags from such a group.
3116 Toggle auto-exit after the next change (see below). If you are
3117 using expert mode, the first `C-c' will display the selection
3120 This method lets you assign tags to a headline with very few keys. With
3121 the above setup, you could clear the current tags and set `@HOME',
3122 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
3123 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
3124 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
3125 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3128 If you find that most of the time, you need only a single keypress to
3129 modify your list of tags, set the variable
3130 `org-fast-tag-selection-single-key'. Then you no longer have to press
3131 <RET> to exit fast tag selection - it will immediately exit after the
3132 first change. If you then occasionally need more keys, press `C-c' to
3133 turn off auto-exit for the current tag selection process (in effect:
3134 start selection with `C-c C-c C-c' instead of `C-c C-c'). If you set
3135 the variable to the value `expert', the special window is not even
3136 shown for single-key tag selection, it comes up only when you press an
3139 ---------- Footnotes ----------
3141 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3142 respectively. Several groups are allowed.
3144 (2) Keys will automatically be assigned to tags which have no
3148 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
3153 Once a tags system has been set up, it can be used to collect related
3154 information into special lists.
3157 Create a sparse tree with all headlines matching a tags search.
3158 With a `C-u' prefix argument, ignore headlines that are not a TODO
3162 Create a global list of tag matches from all agenda files. *Note
3163 Matching headline tags::.
3166 Create a global list of tag matches from all agenda files, but
3167 check only TODO items and force checking subitems (see variable
3168 `org-tags-match-list-sublevels').
3170 A tags search string can use Boolean operators `&' for AND and `|'
3171 for OR. `&' binds more strongly than `|'. Parenthesis are currently
3172 not implemented. A tag may also be preceded by `-', to select against
3173 it, and `+' is syntactic sugar for positive selection. The AND
3174 operator `&' is optional when `+' or `-' is present. Examples:
3177 Select headlines tagged `:WORK:', but discard those also tagged
3181 Selects lines tagged `:WORK:' or `:LAPTOP:'.
3184 Like before, but require the `:LAPTOP:' lines to be tagged also
3187 If you are using multi-state TODO keywords (*note TODO
3188 extensions::), it can be useful to also match on the TODO keyword.
3189 This can be done by adding a condition after a slash to a tags match.
3190 The syntax is similar to the tag matches, but should be applied with
3191 consideration: For example, a positive selection on several TODO
3192 keywords can not meaningfully be combined with boolean AND. However,
3193 _negative selection_ combined with AND can be meaningful. To make sure
3194 that only lines are checked that actually have any TODO keyword, use
3195 `C-c a M', or equivalently start the todo part after the slash with `!'.
3199 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3202 `WORK/!-WAITING-NEXT'
3203 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3206 `WORK/+WAITING|+NEXT'
3207 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3210 Any element of the tag/todo match can be a regular expression - in
3211 this case it must be enclosed in curly braces. For example,
3212 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3213 tag starting with `BOSS'.
3215 You can also require a headline to be of a certain level, by writing
3216 instead of any TAG an expression like `LEVEL=3'. For example, a search
3217 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3218 BOSS and are _not_ marked with the todo keyword DONE.
3221 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
3226 Due to the way Org-mode works, TODO items, time-stamped items, and
3227 tagged headlines can be scattered throughout a file or even a number of
3228 files. To get an overview over open action items, or over events that
3229 are important for a particular date, this information must be collected,
3230 sorted and displayed in an organized way.
3232 Org-mode can select items based on various criteria, and display them
3233 in a separate buffer. Six different view types are provided:
3235 * an _agenda_ that is like a calendar and shows information for
3238 * a _TODO list_ that covers all unfinished action items,
3240 * a _tags view_, showings headlines based on the tags associated
3243 * a _timeline view_ that shows all events in a single Org-mode file,
3244 in time-sorted view,
3246 * a _stuck projects view_ showing projects that currently don't move
3249 * _custom views_ that are special tag/keyword searches and
3250 combinations of different views.
3252 The extracted information is displayed in a special _agenda buffer_.
3253 This buffer is read-only, but provides commands to visit the
3254 corresponding locations in the original Org-mode files, and even to
3255 edit these files remotely.
3257 Two variables control how the agenda buffer is displayed and whether
3258 the window configuration is restored when the agenda exits:
3259 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3263 * Agenda files:: Files being searched for agenda information
3264 * Agenda dispatcher:: Keyboard access to agenda views
3265 * Built-in agenda views:: What is available out of the box?
3266 * Presentation and sorting:: How agenda items are prepared for display
3267 * Agenda commands:: Remote editing of org trees
3268 * Custom agenda views:: Defining special searches and views
3271 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
3276 The information to be shown is collected from all _agenda files_, the
3277 files listed in the variable `org-agenda-files'(1). Thus even if you
3278 only work with a single Org-mode file, this file should be put into
3279 that list(2). You can customize `org-agenda-files', but the easiest
3280 way to maintain it is through the following commands
3283 Add current file to the list of agenda files. The file is added to
3284 the front of the list. If it was already in the list, it is moved
3285 to the front. With prefix arg, file is added/moved to the end.
3288 Remove current file from the list of agenda files.
3292 Cycle through agenda file list, visiting one file after the other.
3294 The Org menu contains the current list of files and can be used to
3297 ---------- Footnotes ----------
3299 (1) If the value of that variable is not a list, but a single file
3300 name, then the list of agenda files will be maintained in that external
3303 (2) When using the dispatcher, pressing `1' before selecting a
3304 command will actually limit the command to the current file, and ignore
3305 `org-agenda-files' until the next dispatcher command.
3308 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3310 8.2 The agenda dispatcher
3311 =========================
3313 The views are created through a dispatcher that should be bound to a
3314 global key, for example `C-c a' (*note Installation::). In the
3315 following we will assume that `C-c a' is indeed how the dispatcher is
3316 accessed and list keyboard access to commands accordingly. After
3317 pressing `C-c a', an additional letter is required to execute a
3318 command. The dispatcher offers the following default commands:
3320 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3323 Create a list of all TODO items (*note Global TODO list::).
3326 Create a list of headlines matching a TAGS expression (*note
3327 Matching headline tags::).
3330 Create the timeline view for the current buffer (*note Timeline::).
3333 Create a list of stuck projects (*note Stuck projects::).
3336 Restrict an agenda command to the current buffer. After pressing
3337 `1', you still need to press the character selecting the command.
3340 If there is an active region, restrict the following agenda
3341 command to the region. Otherwise, restrict it to the current
3342 subtree. After pressing `0', you still need to press the
3343 character selecting the command.
3345 You can also define custom commands that will be accessible through
3346 the dispatcher, just like the default commands. This includes the
3347 possibility to create extended agenda buffers that contain several
3348 blocks together, for example the weekly agenda, the global TODO list and
3349 a number of special tags matches. *Note Custom agenda views::.
3352 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3354 8.3 The built-in agenda views
3355 =============================
3357 In this section we describe the built-in views.
3361 * Weekly/Daily agenda:: The calendar page with current tasks
3362 * Global TODO list:: All unfinished action items
3363 * Matching headline tags:: Structured information with fine-tuned search
3364 * Timeline:: Time-sorted view for single file
3365 * Stuck projects:: Find projects you need to review
3368 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3370 8.3.1 The weekly/daily agenda
3371 -----------------------------
3373 The purpose of the weekly/daily _agenda_ is to act like a page of a
3374 paper agenda, showing all the tasks for the current week or day.
3377 Compile an agenda for the current week from a list of org files.
3378 The agenda shows the entries for each day. With a `C-u' prefix (or
3379 when the variable `org-agenda-include-all-todo' is `t'), all
3380 unfinished TODO items (including those without a date) are also
3381 listed at the beginning of the buffer, before the first date.
3383 Remote editing from the agenda buffer means, for example, that you
3384 can change the dates of deadlines and appointments from the agenda
3385 buffer. The commands available in the Agenda buffer are listed in
3386 *Note Agenda commands::.
3388 Calendar/Diary integration
3389 ..........................
3391 Emacs contains the calendar and diary by Edward M. Reingold. The
3392 calendar displays a three-month calendar with holidays from different
3393 countries and cultures. The diary allows you to keep track of
3394 anniversaries, lunar phases, sunrise/set, recurrent appointments
3395 (weekly, monthly) and more. In this way, it is quite complementary to
3396 Org-mode. It can be very useful to combine output from Org-mode with
3399 In order to include entries from the Emacs diary into Org-mode's
3400 agenda, you only need to customize the variable
3402 (setq org-agenda-include-diary t)
3404 After that, everything will happen automatically. All diary entries
3405 including holidays, anniversaries etc will be included in the agenda
3406 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3407 the agenda buffer to jump to the diary file in order to edit existing
3408 diary entries. The `i' command to insert new entries for the current
3409 date works in the agenda buffer, as well as the commands `S', `M', and
3410 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3411 to other calendars, respectively. `c' can be used to switch back and
3412 forth between calendar and agenda.
3415 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3417 8.3.2 The global TODO list
3418 --------------------------
3420 The global TODO list contains all unfinished TODO items, formatted and
3421 collected into a single place.
3424 Show the global TODO list. This collects the TODO items from all
3425 agenda files (*note Agenda views::) into a single buffer. The
3426 buffer is in `agenda-mode', so there are commands to examine and
3427 manipulate the TODO entries directly from that buffer (*note
3431 Like the above, but allows selection of a specific TODO keyword.
3432 You can also do this by specifying a prefix argument to `C-c a t'.
3433 With a `C-u' prefix you are prompted for a keyword. With a
3434 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
3435 `r' key in the agenda buffer regenerates it, and you can give a
3436 prefix argument to this command to change the selected TODO
3437 keyword, for example `3 r'. If you often need a search for a
3438 specific keyword, define a custom command for it (*note Agenda
3440 Matching specific TODO keywords can also be done as part of a tags
3441 search (*note Tag searches::).
3443 Remote editing of TODO items means that you can change the state of a
3444 TODO entry with a single key press. The commands available in the TODO
3445 list are described in *Note Agenda commands::.
3447 Normally the global todo list simply shows all headlines with TODO
3448 keywords. This list can become very long. There are two ways to keep
3450 - Some people view a TODO item that has been _scheduled_ for
3451 execution (*note Time stamps::) as no longer _open_. Configure the
3452 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3453 items from the global TODO list.
3455 - TODO items may have sublevels to break up the task into subtasks.
3456 In such cases it may be enough to list only the highest level TODO
3457 headline and omit the sublevels from the global list. Configure
3458 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3461 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3463 8.3.3 Matching headline tags
3464 ----------------------------
3466 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3467 you can select headlines based on the tags that apply to them and
3468 collect them into an agenda buffer.
3471 Produce a list of all headlines that match a given set of tags.
3472 The command prompts for a selection criterion, which is a boolean
3473 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3474 `WORK|HOME' (*note Tags::). If you often need a specific search,
3475 define a custom command for it (*note Agenda dispatcher::).
3478 Like `C-c a m', but only select headlines that are also TODO items
3479 and force checking subitems (see variable
3480 `org-tags-match-list-sublevels'). Matching specific todo keywords
3481 together with a tags match is also possible, see *Note Tag
3484 The commands available in the tags list are described in *Note
3488 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3490 8.3.4 Timeline for a single file
3491 --------------------------------
3493 The timeline summarizes all time-stamped items from a single Org-mode
3494 file in a _time-sorted view_. The main purpose of this command is to
3495 give an overview over events in a project.
3498 Show a time-sorted view of the org file, with all time-stamped
3499 items. When called with a `C-u' prefix, all unfinished TODO
3500 entries (scheduled or not) are also listed under the current date.
3502 The commands available in the timeline buffer are listed in *Note
3506 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3508 8.3.5 Stuck projects
3509 --------------------
3511 If you are following a system like David Allen's GTD to organize your
3512 work, one of the "duties" you have is a regular review to make sure
3513 that all projects move along. A _stuck_ project is a project that has
3514 no defined next actions, so it will never show up in the TODO lists
3515 Org-mode produces. During the review, you need to identify such
3516 projects and define next actions for them.
3519 List projects that are stuck.
3522 Customize the variable `org-stuck-projects' to define what a stuck
3523 project is and how to find it.
3525 You almost certainly will have to configure this view before it will
3526 work for you. The built-in default assumes that all your projects are
3527 level-2 headlines, and that a project is not stuck if it has at least
3528 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3530 Lets assume that you, in your own way of using Org-mode, identify
3531 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3532 indicate a project that should not be considered yet. Lets further
3533 assume that the todo keyword DONE marks finished projects, and that NEXT
3534 and TODO indicate next actions. Finally, the tag @SHOP indicates
3535 shopping and is a next action even without the NEXT tag. In this case
3536 you would start by identifying eligible projects with a tags/todo match
3537 `+PROJECT/-MAYBE-DONE', and then check for TODO, NEXT and @SHOP in the
3538 subtree to identify projects that are not stuck. The correct
3539 customization for this is
3541 (setq org-stuck-projects
3542 ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")))
3545 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3547 8.4 Presentation and sorting
3548 ============================
3550 Before displaying items in an agenda view, Org-mode visually prepares
3551 the items and sorts them. Each item occupies a single line. The line
3552 starts with a _prefix_ that contains the _category_ (*note
3553 Categories::) of the item and other important information. You can
3554 customize the prefix using the option `org-agenda-prefix-format'. The
3555 prefix is followed by a cleaned-up version of the outline headline
3556 associated with the item.
3560 * Categories:: Not all tasks are equal
3561 * Time-of-day specifications:: How the agenda knows the time
3562 * Sorting of agenda items:: The order of things
3565 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3570 The category is a broad label assigned to each agenda item. By default,
3571 the category is simply derived from the file name, but you can also
3572 specify it with a special line in the buffer, like this:
3576 If there are several such lines in a file, each specifies the
3577 category for the text below it (but the first category also applies to
3578 any text before the first CATEGORY line). The display in the agenda
3579 buffer looks best if the category is not longer than 10 characters.
3582 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3584 8.4.2 Time-of-Day Specifications
3585 --------------------------------
3587 Org-mode checks each agenda item for a time-of-day specification. The
3588 time can be part of the time stamp that triggered inclusion into the
3589 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3590 specified with two time stamps, like
3591 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3593 In the headline of the entry itself, a time(range) may also appear as
3594 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3595 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3596 entries are recognized as well.
3598 For agenda display, Org-mode extracts the time and displays it in a
3599 standard 24 hour format as part of the prefix. The example times in
3600 the previous paragraphs would end up in the agenda like this:
3602 8:30-13:00 Arthur Dent lies in front of the bulldozer
3603 12:45...... Ford Prefect arrives and takes Arthur to the pub
3604 19:00...... The Vogon reads his poem
3605 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3607 If the agenda is in single-day mode, or for the display of today, the
3608 timed entries are embedded in a time grid, like
3610 8:00...... ------------------
3611 8:30-13:00 Arthur Dent lies in front of the bulldozer
3612 10:00...... ------------------
3613 12:00...... ------------------
3614 12:45...... Ford Prefect arrives and takes Arthur to the pub
3615 14:00...... ------------------
3616 16:00...... ------------------
3617 18:00...... ------------------
3618 19:00...... The Vogon reads his poem
3619 20:00...... ------------------
3620 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3622 The time grid can be turned on and off with the variable
3623 `org-agenda-use-time-grid', and can be configured with
3624 `org-agenda-time-grid'.
3627 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3629 8.4.3 Sorting of agenda items
3630 -----------------------------
3632 Before being inserted into a view, the items are sorted. How this is
3633 done depends on the type of view.
3634 * For the daily/weekly agenda, the items for each day are sorted.
3635 The default order is to first collect all items containing an
3636 explicit time-of-day specification. These entries will be shown
3637 at the beginning of the list, as a _schedule_ for the day. After
3638 that, items remain grouped in categories, in the sequence given by
3639 `org-agenda-files'. Within each category, items are sorted by
3640 priority (*note Priorities::), which is composed of the base
3641 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3642 plus additional increments for overdue scheduled or deadline items.
3644 * For the TODO list, items remain in the order of categories, but
3645 within each category, sorting takes place according to priority
3646 (*note Priorities::).
3648 * For tags matches, items are not sorted at all, but just appear in
3649 the sequence in which they are found in the agenda files.
3651 Sorting can be customized using the variable
3652 `org-agenda-sorting-strategy'.
3655 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3657 8.5 Commands in the agenda buffer
3658 =================================
3660 Entries in the agenda buffer are linked back to the org file or diary
3661 file where they originate. You are not allowed to edit the agenda
3662 buffer itself, but commands are provided to show and jump to the
3663 original entry location, and to edit the org-files "remotely" from the
3664 agenda buffer. In this way, all information is stored only once,
3665 removing the risk that your agenda and note files may diverge.
3667 Some commands can be executed with mouse clicks on agenda lines. For
3668 the other commands, the cursor needs to be in the desired line.
3674 Next line (same as <up>).
3677 Previous line (same as <down>).
3684 Display the original location of the item in another window.
3687 Display original location and recenter that window.
3692 Go to the original location of the item in another window. Under
3693 Emacs 22, `mouse-1' will also works for this.
3696 Go to the original location of the item and delete other windows.
3699 Toggle Follow mode. In Follow mode, as you move the cursor through
3700 the agenda buffer, the other window always shows the corresponding
3701 location in the org file. The initial setting for this mode in new
3702 agenda buffers can be set with the variable
3703 `org-agenda-start-with-follow-mode'.
3706 Display the entire subtree of the current item in an indirect
3707 buffer. With numerical prefix ARG, go up to this level and then
3708 take that tree. If ARG is negative, go up that many levels. With
3709 `C-u' prefix, do not remove the previously used indirect buffer.
3712 Toggle Logbook mode. In Logbook mode, entries that where marked
3713 DONE while logging was on (variable `org-log-done') are shown in
3714 the agenda, as are entries that have been clocked on that day.
3720 Delete other windows.
3723 Switch to weekly view (7 days displayed together).
3726 Switch to daily view (just one day displayed).
3729 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3733 Toggle the time grid on and off. See also the variables
3734 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3737 Recreate the agenda buffer, for example to reflect the changes
3738 after modification of the time stamps of items with S-<left> and
3739 S-<right>. When the buffer is the global todo list, a prefix
3740 argument is interpreted to create a selective list for a specific
3744 Save all Org-mode buffers in the current Emacs session.
3747 Display the following `org-agenda-ndays' days. For example, if
3748 the display covers a week, switch to the following week. With
3749 prefix arg, go forward that many times `org-agenda-ndays' days.
3752 Display the previous dates.
3764 Undo a change due to a remote editing command. The change is
3765 undone both in the agenda buffer and in the remote buffer.
3768 Change the TODO state of the item, both in the agenda and in the
3772 Delete the current agenda item along with the entire subtree
3773 belonging to it in the original Org-mode file. If the text to be
3774 deleted remotely is longer than one line, the kill needs to be
3775 confirmed by the user. See variable `org-agenda-confirm-kill'.
3778 Archive the subtree corresponding to the current headline.
3781 Show all tags associated with the current item. Because of
3782 inheritance, this may be more than the tags listed in the line
3786 Set tags for the current headline.
3789 Toggle the ARCHIVE tag for the current headline.
3792 Set the priority for the current item. Org-mode prompts for the
3793 priority character. If you reply with <SPC>, the priority cookie
3794 is removed from the entry.
3797 Display weighted priority of current item.
3801 Increase the priority of the current item. The priority is
3802 changed in the original buffer, but the agenda is not resorted.
3803 Use the `r' key for this.
3807 Decrease the priority of the current item.
3813 Set a deadline for this item.
3816 Change the time stamp associated with the current line by one day
3817 into the future. With prefix argument, change it by that many
3818 days. For example, `3 6 5 S-<right>' will change it by a year.
3819 The stamp is changed in the original org file, but the change is
3820 not directly reflected in the agenda buffer. Use the `r' key to
3824 Change the time stamp associated with the current line by one day
3828 Change the time stamp associated with the current line to today.
3829 The key `>' has been chosen, because it is the same as `S-.' on my
3833 Start the clock on the current item. If a clock is running
3834 already, it is stopped first.
3837 Stop the previously started clock.
3840 Cancel the currently running clock.
3846 Open the Emacs calendar and move to the date at the agenda cursor.
3849 When in the calendar, compute and show the Org-mode agenda for the
3853 Insert a new entry into the diary. Prompts for the type of entry
3854 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3855 new entry in the diary, just as `i d' etc. would do in the
3856 calendar. The date is taken from the cursor position.
3859 Show the phases of the moon for the three months around current
3863 Show sunrise and sunset times. The geographical location must be
3864 set with calendar variables, see documentation of the Emacs
3868 Convert the date at cursor into many other cultural and historic
3872 Show holidays for three month around the cursor date.
3875 Export a single iCalendar file containing entries from all agenda
3882 Quit agenda, remove the agenda buffer.
3885 Exit agenda, remove the agenda buffer and all buffers loaded by
3886 Emacs for the compilation of the agenda. Buffers created by the
3887 user to visit org files will not be removed.
3891 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3893 8.6 Custom agenda views
3894 =======================
3896 Custom agenda commands serve two purposes: to store and quickly access
3897 frequently used TODO and tags searches, and to create special composite
3898 agenda buffers. Custom agenda commands will be accessible through the
3899 dispatcher (*note Agenda dispatcher::), just like the default commands.
3903 * Storing searches:: Type once, use often
3904 * Block agenda:: All the stuff you need in a single buffer
3905 * Setting Options:: Changing the rules
3906 * Batch processing:: Agenda views from the command line
3909 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3911 8.6.1 Storing searches
3912 ----------------------
3914 The first application of custom searches is the definition of keyboard
3915 shortcuts for frequently used searches, either creating an agenda
3916 buffer, or a sparse tree (the latter covering of course only the current
3917 buffer). Custom commands are configured in the variable
3918 `org-agenda-custom-commands'. You can customize this variable, for
3919 example by pressing `C-c a C'. You can also directly set it with Emacs
3920 Lisp in `.emacs'. The following example contains all valid search
3923 (setq org-agenda-custom-commands
3924 '(("w" todo "WAITING")
3925 ("W" todo-tree "WAITING")
3926 ("u" tags "+BOSS-URGENT")
3927 ("v" tags-todo "+BOSS-URGENT")
3928 ("U" tags-tree "+BOSS-URGENT")
3929 ("f" occur-tree "\\<FIXME\\>")))
3931 The initial single-character string in each entry defines the character
3932 you have to press after the dispatcher command `C-c a' in order to
3933 access the command. The second parameter is the search type, followed
3934 by the string or regular expression to be used for the matching. The
3935 example above will therefore define:
3938 as a global search for TODO entries with `WAITING' as the TODO
3942 as the same search, but only in the current buffer and displaying
3943 the results as a sparse tree
3946 as a global tags search for headlines marked `:BOSS:' but not
3950 as the same search as `C-c a u', but limiting the search to
3951 headlines that are also TODO items
3954 as the same search as `C-c a u', but only in the current buffer and
3955 displaying the result as a sparse tree
3958 to create a sparse tree (again: current buffer only) with all
3959 entries containing the word `FIXME'.
3962 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3967 Another possibility is the construction of agenda views that comprise
3968 the results of _several_ commands, each of which creates a block in the
3969 agenda buffer. The available commands include `agenda' for the daily
3970 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3971 todo list (as constructed with `C-c a t'), and the matching commands
3972 discussed above: `todo', `tags', and `tags-todo'. Here are two
3975 (setq org-agenda-custom-commands
3976 '(("h" "Agenda and Home-related tasks"
3980 ("o" "Agenda and Office-related tasks"
3985 This will define `C-c a h' to create a multi-block view for stuff you
3986 need to attend to at home. The resulting agenda buffer will contain
3987 your agenda for the current week, all TODO items that carry the tag
3988 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3989 `C-c a o' provides a similar view for office tasks.
3992 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3994 8.6.3 Setting Options for custom commands
3995 -----------------------------------------
3997 Org-mode contains a number of variables regulating agenda construction
3998 and display. The global variables define the behavior for all agenda
3999 commands, including the custom commands. However, if you want to change
4000 some settings just for a single custom view, you can do so. Setting
4001 options requires inserting a list of variable names and values at the
4002 right spot in `org-agenda-custom-commands'. For example:
4004 (setq org-agenda-custom-commands
4005 '(("w" todo "WAITING"
4006 ((org-agenda-sorting-strategy '(priority-down))
4007 (org-agenda-prefix-format " Mixed: ")))
4008 ("U" tags-tree "+BOSS-URGENT"
4009 ((org-show-following-heading nil)
4010 (org-show-hierarchy-above nil)))))
4012 Now the `C-c a w' command will sort the collected entries only by
4013 priority, and the prefix format is modified to just say ` Mixed:'
4014 instead of giving the category of the entry. The sparse tags tree of
4015 `C-c a U' will now turn out ultra-compact, because neither the headline
4016 hierarchy above the match, nor the headline following the match will be
4019 For command sets creating a block agenda,
4020 `org-agenda-custom-commands' has two separate spots for setting
4021 options. You can add options that should be valid for just a single
4022 command in the set, and options that should be valid for all commands in
4023 the set. The former are just added to the command entry, the latter
4024 must come after the list of command entries. Going back to the block
4025 agenda example (*note Block agenda::), let's change the sorting strategy
4026 for the `C-c a h' commands to `priority-down', but let's sort the
4027 results for GARDEN tags query in the opposite order, `priority-up'.
4028 This would look like this:
4030 (setq org-agenda-custom-commands
4031 '(("h" "Agenda and Home-related tasks"
4034 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
4035 ((org-agenda-sorting-strategy '(priority-down))))
4036 ("o" "Agenda and Office-related tasks"
4041 As you see, the values and parenthesis setting is a little complex.
4042 When in doubt, use the customize interface to set this variable - it
4043 fully supports its structure. Just one caveat: When setting options in
4044 this interface, the _values_ are just lisp expressions. So if the
4045 value is a string, you need to add the double quotes around the value
4049 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
4051 8.6.4 Creating agenda views in batch processing
4052 -----------------------------------------------
4054 If you want to print or otherwise reprocess agenda views, it can be
4055 useful to create an agenda from the command line. This is the purpose
4056 of the function `org-batch-agenda'. It takes as a parameter one of the
4057 strings that are the keys in `org-agenda-custom-commands'. For
4058 example, to directly print the current TODO list, you could use
4060 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4062 You may also modify parameters on the fly like this:
4064 emacs -batch -l ~/.emacs \
4065 -eval '(org-batch-agenda "a" \
4066 org-agenda-ndays 300 \
4067 org-agenda-include-diary nil \
4068 org-agenda-files (quote ("~/org/project.org")))' \
4071 which will produce a 300 day agenda, fully restricted to the Org file
4072 `~/org/projects.org', not even including the diary.
4075 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
4080 Plain ASCII is normally sufficient for almost all note taking. One
4081 exception, however, are scientific notes which need to be able to
4082 contain mathematical symbols and the occasional formula. LaTeX(1) is
4083 widely used to typeset scientific documents. Org-mode supports
4084 embedding LaTeX code into its files, because many academics are used to
4085 read LaTeX source code, and because it can be readily processed into
4086 images for HTML production.
4088 It is not necessary to mark LaTeX macros and code in any special way.
4089 If you observe a few conventions, Org-mode knows how to find it and what
4094 * Math symbols:: TeX macros for symbols and Greek letters
4095 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
4096 * LaTeX fragments:: Complex formulas made easy
4097 * Processing LaTeX fragments:: Previewing LaTeX processing
4098 * CDLaTeX mode:: Speed up entering of formulas
4100 ---------- Footnotes ----------
4102 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4103 Many of the features described here as "LaTeX" are really from TeX, but
4104 for simplicity I am blurring this distinction.
4107 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
4112 You can use LaTeX macros to insert special symbols like `\alpha' to
4113 indicate the Greek letter, or `\to' to indicate an arrow. Completion
4114 for these macros is available, just type `\' and maybe a few letters,
4115 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
4116 Org-mode allows these macros to be present without surrounding math
4117 delimiters, for example:
4119 Angles are written as Greek letters \alpha, \beta and \gamma.
4121 During HTML export (*note HTML export::), these symbols are
4122 translated into the proper syntax for HTML, for the above examples this
4123 is `α' and `→', respectively.
4126 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
4128 9.2 Subscripts and Superscripts
4129 ===============================
4131 Just like in LaTeX, `^' and `_' are used to indicate super- and
4132 subscripts. Again, these can be used without embedding them in
4133 math-mode delimiters. To increase the readability of ASCII text, it is
4134 not necessary (but OK) to surround multi-character sub- and superscripts
4135 with curly braces. For example
4137 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
4138 the sun is R_{sun} = 6.96 x 10^8 m.
4140 To avoid interpretation as raised or lowered text, you can quote `^'
4141 and `_' with a backslash: `\_' and `\^'.
4143 During HTML export (*note HTML export::), subscript and superscripts
4144 are surrounded with `<sub>' and `<sup>' tags, respectively.
4147 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
4152 With symbols, sub- and superscripts, HTML is pretty much at its end when
4153 it comes to representing mathematical formulas(1). More complex
4154 expressions need a dedicated formula processor. To this end, Org-mode
4155 can contain arbitrary LaTeX fragments. It provides commands to preview
4156 the typeset result of these fragments, and upon export to HTML, all
4157 fragments will be converted to images and inlined into the HTML
4158 document. For this to work you need to be on a system with a working
4159 LaTeX installation. You also need the `dvipng' program, available at
4160 `http://sourceforge.net/projects/dvipng/'.
4162 LaTeX fragments don't need any special marking at all. The following
4163 snippets will be identified as LaTeX source code:
4164 * Environments of any kind. The only requirement is that the
4165 `\begin' statement appears on a new line, preceded by only
4168 * Text within the usual LaTeX math delimiters. To avoid conflicts
4169 with currency specifications, single `$' characters are only
4170 recognized as math delimiters if the enclosed text contains at
4171 most two line breaks, is directly attached to the `$' characters
4172 with no whitespace in between, and if the closing `$' is followed
4173 by whitespace or punctuation. For the other delimiters, there is
4174 no such restriction, so when in doubt, use `\(...\)' as inline
4179 \begin{equation} % arbitrary environments,
4180 x=\sqrt{b} % even tables, figures
4181 \end{equation} % etc
4183 If $a^2=b$ and \( b=2 \), then the solution must be
4184 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4186 If you need any of the delimiter ASCII sequences for other purposes, you
4187 can configure the option `org-format-latex-options' to deselect the
4188 ones you do not wish to have interpreted by the LaTeX converter.
4190 ---------- Footnotes ----------
4192 (1) Yes, there is MathML, but that is not yet fully supported by
4193 many browsers, and there is no decent converter for turning LaTeX of
4194 ASCII representations of formulas into MathML. So for the time being,
4195 converting formulas into images seems the way to go.
4198 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
4200 9.4 Processing LaTeX fragments
4201 ==============================
4203 LaTeX fragments can be processed to produce a preview images of the
4204 typeset expressions:
4207 Produce a preview image of the LaTeX fragment at point and overlay
4208 it over the source code. If there is no fragment at point,
4209 process all fragments in the current entry (between two
4210 headlines). When called with a prefix argument, process the
4211 entire subtree. When called with two prefix arguments, or when
4212 the cursor is before the first headline, process the entire buffer.
4215 Remove the overlay preview images.
4217 During HTML export (*note HTML export::), all LaTeX fragments are
4218 converted into images and inlined into the document if the following
4221 (setq org-export-with-LaTeX-fragments t)
4224 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
4226 9.5 Using CDLaTeX to enter math
4227 ===============================
4229 CDLaTeX-mode is a minor mode that is normally used in combination with a
4230 major LaTeX mode like AUCTeX in order to speed-up insertion of
4231 environments and math templates. Inside Org-mode, you can make use of
4232 some of the features of cdlatex-mode. You need to install `cdlatex.el'
4233 and `texmathp.el' (the latter comes also with AUCTeX) from
4234 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
4235 cdlatex-mode itself under Org-mode, but use the light version
4236 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
4237 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4240 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4242 When this mode is enabled, the following features are present (for
4243 more details see the documentation of cdlatex-mode):
4244 * Environment templates can be inserted with `C-c {'.
4246 * The <TAB> key will do template expansion if the cursor is inside a
4247 LaTeX fragment(1). For example, <TAB> will expand `fr' to
4248 `\frac{}{}' and position the cursor correctly inside the first
4249 brace. Another <TAB> will get you into the second brace. Even
4250 outside fragments, <TAB> will expand environment abbreviations at
4251 the beginning of a line. For example, if you write `equ' at the
4252 beginning of a line and press <TAB>, this abbreviation will be
4253 expanded to an `equation' environment. To get a list of all
4254 abbreviations, type `M-x cdlatex-command-help'.
4256 * Pressing `_' and `^' inside a LaTeX fragment will insert these
4257 characters together with a pair of braces. If you use <TAB> to
4258 move out of the braces, and if the braces surround only a single
4259 character or macro, they are removed again (depending on the
4260 variable `cdlatex-simplify-sub-super-scripts').
4262 * Pressing the backquote ``' followed by a character inserts math
4263 macros, also outside LaTeX fragments. If you wait more than 1.5
4264 seconds after the backquote, a help window will pop up.
4266 * Pressing the normal quote `'' followed by another character
4267 modifies the symbol before point with an accent or a font. If you
4268 wait more than 1.5 seconds after the backquote, a help window will
4269 pop up. Character modification will work only inside LaTeX
4270 fragments, outside the quote is normal.
4272 ---------- Footnotes ----------
4274 (1) Org-mode has a method to test if the cursor is inside such a
4275 fragment, see the documentation of the function
4276 `org-inside-LaTeX-fragment-p'.
4279 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
4284 Org-mode documents can be exported into a variety of other formats. For
4285 printing and sharing of notes, ASCII export produces a readable and
4286 simple version of an Org-mode file. HTML export allows you to publish a
4287 notes file on the web, while the XOXO format provides a solid base for
4288 exchange with a broad range of other applications. To incorporate
4289 entries with associated times like deadlines or appointments into a
4290 desktop calendar program like iCal, Org-mode can also produce extracts
4291 in the iCalendar format. Currently Org-mode only supports export, not
4292 import of these different formats.
4294 When exporting, Org-mode uses special conventions to enrich the
4295 output produced. *Note Text interpretation::, for more details.
4298 Dispatcher for export and publishing commands. Displays a
4299 help-window listing the additional key(s) needed to launch an
4300 export or publishing command.
4304 * ASCII export:: Exporting to plain ASCII
4305 * HTML export:: Exporting to HTML
4306 * XOXO export:: Exporting to XOXO
4307 * iCalendar export:: Exporting in iCalendar format
4308 * Text interpretation:: How the exporter looks at the file
4311 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4316 ASCII export produces a simple and very readable version of an Org-mode
4320 Export as ASCII file. If there is an active region, only the
4321 region will be exported. For an org file `myfile.org', the ASCII
4322 file will be `myfile.txt'. The file will be overwritten without
4326 Export only the visible part of the document.
4328 In the exported version, the first 3 outline levels will become
4329 headlines, defining a general document structure. Additional levels
4330 will be exported as itemized lists. If you want that transition to
4331 occur at a different level, specify it with a prefix argument. For
4336 creates only top level headlines and does the rest as items. When
4337 headlines are converted to items, the indentation of the text following
4338 the headline is changed to fit nicely under the item. This is done with
4339 the assumption that the first bodyline indicates the base indentation of
4340 the body text. Any indentation larger than this is adjusted to preserve
4341 the layout relative to the first line. Should there be lines with less
4342 indentation than the first, these are left alone.
4345 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4350 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4351 HTML formatting, in ways similar to John Grubers _markdown_ language,
4352 but with additional support for tables.
4356 * Export commands:: How to invode HTML export
4357 * Quoting HTML tags:: Using direct HTML in Org-mode
4358 * Links:: How hyperlinks get transferred to HTML
4359 * Images:: To inline or not to inline?
4360 * CSS support:: Style specifications
4363 File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
4365 10.2.1 HTML export commands
4366 ---------------------------
4369 Export as HTML file `myfile.html'.
4372 Export as HTML file and open it with a browser.
4377 Export only the visible part of the document.
4379 In the exported version, the first 3 outline levels will become
4380 headlines, defining a general document structure. Additional levels
4381 will be exported as itemized lists. If you want that transition to
4382 occur at a different level, specify it with a prefix argument. For
4387 creates two levels of headings and does the rest as items.
4390 File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
4392 10.2.2 Quoting HTML tags
4393 ------------------------
4395 Plain `<' and `>' are always transformed to `<' and `>' in HTML
4396 export. If you want to include simple HTML tags which should be
4397 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
4398 Note that this really works only for simple tags. For more extensive
4399 HTML that should be copied verbatim to the exported file use either
4401 #+HTML: Literal HTML code for export
4406 All lines between these markers are exported literally
4410 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
4415 Internal links (*note Internal links::) will continue to work in HTML
4416 files only if they match a dedicated `<<target>>'. Automatic links
4417 created by radio targets (*note Radio targets::) will also work in the
4418 HTML file. Links to external files will still work if the HTML file is
4419 in the same directory as the Org-mode file. Links to other `.org'
4420 files will be translated into HTML links under the assumption that an
4421 HTML version also exists of the linked file. For information related to
4422 linking files while publishing them to a publishing directory see *Note
4426 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
4431 HTML export can inline images given as links in the Org-mode file, and
4432 it can make an image the clickable part of a link. By default(1),
4433 images are inlined if a link does not have a description. So
4434 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4435 image]]' will just produce a link `the image' that points to the image.
4436 If the description part itself is a `file:' link or a `http:' URL
4437 pointing to an image, this image will be inlined and activated so that
4438 clicking on the image will activate the link. For example, to include
4439 a thumbnail that will link to a high resolution version of the image,
4442 [[file:highres.jpg][file:thumb.jpg]]
4444 and you could use `http' addresses just as well.
4446 ---------- Footnotes ----------
4448 (1) but see the variable `org-export-html-inline-images'
4451 File: org, Node: CSS support, Prev: Images, Up: HTML export
4456 You can also give style information for the exported file. The HTML
4457 exporter assigns the following CSS classes to appropriate parts of the
4458 document - your style specifications may change these:
4460 .done the DONE keyword
4461 .timestamp time stamp
4462 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4463 .tag tag in a headline
4464 .target target for links
4466 The default style specification can be configured through the option
4467 `org-export-html-style'. If you want to use a file-local style, you
4468 may use file variables, best wrapped into a COMMENT section at the end
4469 of the outline tree. For example(1):
4471 * COMMENT html style specifications
4474 # org-export-html-style: " <style type=\"text/css\">
4475 # p {font-weight: normal; color: gray; }
4476 # h1 {color: black; }
4480 Remember to execute `M-x normal-mode' after changing this to make
4481 the new style visible to Emacs. This command restarts org-mode for the
4482 current buffer and forces Emacs to re-evaluate the local variables
4483 section in the buffer.
4485 ---------- Footnotes ----------
4487 (1) Under Emacs 21, the continuation lines for a variable value
4488 should have no `#' at the start of the line.
4491 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4496 Org-mode contains an exporter that produces XOXO-style output.
4497 Currently, this exporter only handles the general outline structure and
4498 does not interpret any additional Org-mode features.
4501 Export as XOXO file `myfile.html'.
4504 Export only the visible part of the document.
4507 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4509 10.4 iCalendar export
4510 =====================
4512 Some people like to use Org-mode for keeping track of projects, but
4513 still prefer a standard calendar application for anniversaries and
4514 appointments. In this case it can be useful to have deadlines and
4515 other time-stamped items in Org-mode files show up in the calendar
4516 application. Org-mode can export calendar information in the standard
4517 iCalendar format. If you also want to have TODO entries included in the
4518 export, configure the variable `org-icalendar-include-todo'.
4521 Create iCalendar entries for the current file and store them in
4522 the same directory, using a file extension `.ics'.
4525 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4526 For each of these files, a separate iCalendar file will be
4530 Create a single large iCalendar file from all files in
4531 `org-agenda-files' and write it to the file given by
4532 `org-combined-agenda-icalendar-file'.
4534 How this calendar is best read and updated, depends on the
4535 application you are using. The FAQ covers this issue.
4538 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4540 10.5 Text interpretation by the exporter
4541 ========================================
4543 The exporter backends interpret additional structure in the Org-mode
4544 file in order to produce better output.
4548 * Comment lines:: Some lines will not be exported
4549 * Enhancing text:: Subscripts, symbols and more
4550 * Export options:: How to influence the export settings
4553 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
4555 10.5.1 Comment lines
4556 --------------------
4558 Lines starting with `#' in column zero are treated as comments and will
4559 never be exported. Also entire subtrees starting with the word
4560 `COMMENT' will never be exported. Finally, any text before the first
4561 headline will not be exported either.
4564 Toggle the COMMENT keyword at the beginning of an entry.
4567 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
4569 10.5.2 Enhancing text for export
4570 --------------------------------
4572 Some of the export backends of Org-mode allow for sophisticated text
4573 formatting, this is true in particular for the HTML backend. Org-mode
4574 has a number of typing conventions that allow to produce a richly
4577 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4578 enumerator will be recognized and transformed if the backend
4579 supports lists. See *Note Plain lists::.
4581 * You can make words *bold*, /italic/, _underlined_, `=code=', and
4584 * A line consisting of only dashes, and at least 5 of them, will be
4585 exported as a horizontal line (`<hr/>' in HTML).
4587 * Many TeX macros and entire LaTeX fragments are converted into HTML
4588 entities or images (*note Embedded LaTeX::).
4590 * Tables are transformed into native tables under the exporter, if
4591 the export backend supports this. Data fields before the first
4592 horizontal separator line will be formatted as table header fields.
4594 * If a headline starts with the word `QUOTE', the text below the
4595 headline will be typeset as fixed-width, to allow quoting of
4596 computer codes etc. Lines starting with `:' are also typeset in
4599 Toggle fixed-width for entry (QUOTE) or region, see below.
4601 * A double backslash _at the end of a line_ enforces a line break at
4604 If these conversions conflict with your habits of typing ASCII text,
4605 they can all be turned off with corresponding variables (see the
4606 customization group `org-export-general', and the following section
4607 which explains how to set export options with special lines in a buffer.
4610 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
4612 10.5.3 Export options
4613 ---------------------
4615 The exporter recognizes special lines in the buffer which provide
4616 additional information. These lines may be put anywhere in the file.
4617 The whole set of lines can be inserted into the buffer with `C-c C-e
4618 t'. For individual lines, a good way to make sure the keyword is
4619 correct is to type `#+' and then use `M-<TAB>' completion (*note
4623 Insert template with export options, see example below.
4625 #+TITLE: the title to be shown (default is the buffer name)
4626 #+AUTHOR: the author (default taken from `user-full-name')
4627 #+EMAIL: his/her email address (default from `user-mail-address')
4628 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
4629 #+TEXT: Some descriptive text to be inserted at the beginning.
4630 #+TEXT: Several lines may be given.
4631 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
4633 The OPTIONS line is a compact form to specify export settings. Here
4635 H: set the number of headline levels for export
4636 num: turn on/off section-numbers
4637 toc: turn on/off table of contents, or set level limit (integer)
4638 \n: turn on/off linebreak-preservation
4639 @: turn on/off quoted HTML tags
4640 :: turn on/off fixed-width sections
4641 |: turn on/off tables
4642 ^: turn on/off TeX-like syntax for sub- and superscripts.
4643 *: turn on/off emphasized text (bold, italic, underlined)
4644 TeX: turn on/off simple TeX macros in plain text
4645 LaTeX: turn on/off LaTeX fragments
4648 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
4653 Org-mode includes(1) a publishing management system that allows you to
4654 configure automatic HTML conversion of _projects_ composed of
4655 interlinked org files. This system is called _org-publish_. You can
4656 also configure org-publish to automatically upload your exported HTML
4657 pages and related attachments, such as images and source code files, to
4658 a web server. Org-publish turns org-mode into a web-site authoring
4661 Org-publish has been contributed to Org-mode by David O'Toole.
4665 * Configuration:: Defining projects
4666 * Sample configuration:: Example projects
4667 * Triggering publication:: Publication commands
4669 ---------- Footnotes ----------
4671 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4672 `org.el' as it comes with Emacs, you need to download this file
4673 separately. Also make sure org.el is at least version 4.27.
4676 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4681 Publishing needs significant configuration to specify files, destination
4682 and many other properties of a project.
4686 * Project alist:: The central configuration variable
4687 * Sources and destinations:: From here to there
4688 * Selecting files:: What files are part of the project?
4689 * Publishing action:: Setting the function doing the publishing
4690 * Publishing options:: Tweaking HTML export
4691 * Publishing links:: Which links keep working after publishing?
4692 * Project page index:: Publishing a list of project files
4695 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4697 11.1.1 The variable `org-publish-project-alist'
4698 -----------------------------------------------
4700 Org-publish is configured almost entirely through setting the value of
4701 one variable, called `org-publish-project-alist'. Each element of the
4702 list configures one project, and may be in one of the two following
4705 ("project-name" :property value :property value ...)
4709 ("project-name" :components ("project-name" "project-name" ...))
4711 In both cases, projects are configured by specifying property values.
4712 A project defines the set of files that will be published, as well as
4713 the publishing configuration to use when publishing those files. When
4714 a project takes the second form listed above, the individual members of
4715 the "components" property are taken to be components of the project,
4716 which group together files requiring different publishing options. When
4717 you publish such a "meta-project" all the components will also publish.
4720 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4722 11.1.2 Sources and destinations for files
4723 -----------------------------------------
4725 Most properties are optional, but some should always be set. In
4726 particular, org-publish needs to know where to look for source files,
4727 and where to put published files.
4729 `:base-directory' Directory containing publishing source files
4730 `:publishing-directory'Directory (possibly remote) where output files
4732 `:preparation-function'Function called before starting publishing
4733 process, for example to run `make' for updating
4734 files to be published.
4737 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4739 11.1.3 Selecting files
4740 ----------------------
4742 By default, all files with extension `.org' in the base directory are
4743 considered part of the project. This can be modified by setting the
4745 `:base-extension' Extension (without the dot!) of source files. This
4746 actually is a regular expression.
4747 `:exclude' Regular expression to match file names that should
4748 not be published, even though they have been selected
4749 on the basis of their extension.
4750 `:include' List of files to be included regardless of
4751 `:base-extension' and `:exclude'.
4754 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4756 11.1.4 Publishing Action
4757 ------------------------
4759 Publishing means that a file is copied to the destination directory and
4760 possibly transformed in the process. The default transformation is to
4761 export Org-mode files as HTML files, and this is done by the function
4762 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4763 export::). Other files like images only need to be copied to the
4764 publishing destination. For non-Org-mode files, you need to specify
4765 the publishing function.
4767 `:publishing-function' Function executing the publication of a file.
4768 This may also be a list of functions, which will
4769 all be called in turn.
4771 The function must accept two arguments: a property list containing at
4772 least a `:publishing-directory' property, and the name of the file to
4773 be published. It should take the specified file, make the necessary
4774 transformation (if any) and place the result into the destination
4775 folder. You can write your own publishing function, but `org-publish'
4776 provides one for attachments (files that only need to be copied):
4777 `org-publish-attachment'.
4780 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4782 11.1.5 Options for the HTML exporter
4783 ------------------------------------
4785 The property list can be used to set many export options for the HTML
4786 exporter. In most cases, these properties correspond to user variables
4787 in Org-mode. The table below lists these properties along with the
4788 variable they belong to. See the documentation string for the
4789 respective variable for details.
4791 `:language' `org-export-default-language'
4792 `:headline-levels' `org-export-headline-levels'
4793 `:section-numbers' `org-export-with-section-numbers'
4794 `:table-of-contents' `org-export-with-toc'
4795 `:archived-trees' `org-export-with-archived-trees'
4796 `:emphasize' `org-export-with-emphasize'
4797 `:sub-superscript' `org-export-with-sub-superscripts'
4798 `:TeX-macros' `org-export-with-TeX-macros'
4799 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4800 `:fixed-width' `org-export-with-fixed-width'
4801 `:timestamps' `org-export-with-timestamps'
4803 `:tags' `org-export-with-tags'
4805 `:tables' `org-export-with-tables'
4806 `:table-auto-headline' `org-export-highlight-first-table-line'
4807 `:style' `org-export-html-style'
4808 `:convert-org-links' `org-export-html-link-org-files-as-html'
4809 `:inline-images' `org-export-html-inline-images'
4810 `:expand-quoted-html' `org-export-html-expand'
4811 `:timestamp' `org-export-html-with-timestamp'
4812 `:publishing-directory'`org-export-publishing-directory'
4813 `:preamble' `org-export-html-preamble'
4814 `:postamble' `org-export-html-postamble'
4815 `:auto-preamble' `org-export-html-auto-preamble'
4816 `:auto-postamble' `org-export-html-auto-postamble'
4817 `:author' `user-full-name'
4818 `:email' `user-mail-address'
4820 When a property is given a value in org-publish-project-alist, its
4821 setting overrides the value of the corresponding user variable (if any)
4822 during publishing. options set within a file (*note Export options::),
4823 however, override everything.
4826 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4828 11.1.6 Links between published files
4829 ------------------------------------
4831 To create a link from one Org-mode file to another, you would use
4832 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4833 (*note Hyperlinks::). Upon publishing this link becomes a link to
4834 `foo.html'. In this way, you can interlink the pages of your "org web"
4835 project and the links will work as expected when you publish them to
4838 You may also link to related files, such as images. Provided you are
4839 careful with relative pathnames, and provided you have also configured
4840 org-publish to upload the related files, these links will work too.
4841 *Note Complex example:: for an example of this usage.
4843 Sometime an Org-mode file to be published may contain links that are
4844 only valid in your production environment, but not in the publishing
4845 location. In this case, use the property
4847 `:link-validation-function' Function to validate links
4849 to define a function for checking link validity. This function must
4850 accept two arguments, the file name and a directory relative to which
4851 the file name is interpreted in the production environment. If this
4852 function returns `nil', then the HTML generator will only insert a
4853 description into the HTML file, but no link. One option for this
4854 function is `org-publish-validate-link' which checks if the given file
4855 is part of any project in `org-publish-project-alist'.
4858 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4860 11.1.7 Project page index
4861 -------------------------
4863 The following properties may be used to control publishing of an index
4864 of files or summary page for a given project.
4866 `:auto-index' When non-nil, publish an index during
4867 org-publish-current-project or org-publish-all.
4868 `:index-filename' Filename for output of index. Defaults to `index.org'
4869 (which becomes `index.html').
4870 `:index-title' Title of index page. Defaults to name of file.
4871 `:index-function' Plugin function to use for generation of index.
4872 Defaults to `org-publish-org-index', which generates
4873 a plain list of links to all files in the project.
4876 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4878 11.2 Sample configuration
4879 =========================
4881 Below we provide two example configurations. The first one is a simple
4882 project publishing only a set of Org-mode files. The second example is
4883 more complex, with a multi-component project.
4887 * Simple example:: One-component publishing
4888 * Complex example:: A multi-component publishing example
4891 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4893 11.2.1 Example: simple publishing configuration
4894 -----------------------------------------------
4896 This example publishes a set of Org-mode files to the `public_html'
4897 directory on the local machine.
4899 (setq org-publish-project-alist
4901 :base-directory "~/org/"
4902 :publishing-directory "~/public_html"
4903 :section-numbers nil
4904 :table-of-contents nil
4905 :style "<link rel=stylesheet
4906 href=\"../other/mystyle.css\"
4907 type=\"text/css\">")))
4910 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4912 11.2.2 Example: complex publishing configuration
4913 ------------------------------------------------
4915 This more complicated example publishes an entire website, including
4916 org files converted to HTML, image files, emacs lisp source code, and
4917 stylesheets. The publishing-directory is remote and private files are
4920 To ensure that links are preserved, care should be taken to replicate
4921 your directory structure on the web server, and to use relative file
4922 paths. For example, if your org files are kept in `~/org' and your
4923 publishable images in `~/images', you'd link to an image with
4924 file:../images/myimage.png
4925 On the web server, the relative path to the image should be the
4926 same. You can accomplish this by setting up an "images" folder in the
4927 right place on the webserver, and publishing images to it.
4929 (setq org-publish-project-alist
4931 :base-directory "~/org/"
4932 :base-extension "org"
4933 :publishing-directory "/ssh:user@host:~/html/notebook/"
4934 :publishing-function org-publish-org-to-html
4935 :exclude "PrivatePage.org" ;; regexp
4937 :section-numbers nil
4938 :table-of-contents nil
4939 :style "<link rel=stylesheet
4940 href=\"../other/mystyle.css\" type=\"text/css\">"
4942 :auto-postamble nil)
4945 :base-directory "~/images/"
4946 :base-extension "jpg\\|gif\\|png"
4947 :publishing-directory "/ssh:user@host:~/html/images/"
4948 :publishing-function org-publish-attachment)
4951 :base-directory "~/other/"
4952 :base-extension "css\\|el"
4953 :publishing-directory "/ssh:user@host:~/html/other/"
4954 :publishing-function org-publish-attachment)
4955 ("website" :components ("orgfiles" "images" "other"))))
4958 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4960 11.3 Triggering publication
4961 ===========================
4963 Once org-publish is properly configured, you can publish with the
4964 following functions:
4967 Prompt for a specific project and publish all files that belong to
4971 Publish the project containing the current file.
4974 Publish only the current file.
4977 Publish all projects.
4979 Org uses timestamps to track when a file has changed. The above
4980 functions normally only publish changed files. You can override this and
4981 force publishing of all files by giving a prefix argument.
4984 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4991 * Completion:: M-TAB knows what you need
4992 * Customization:: Adapting Org-mode to your taste
4993 * In-buffer settings:: Overview of the #+KEYWORDS
4994 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4995 * Clean view:: Getting rid of leading stars in the outline
4996 * TTY keys:: Using Org-mode on a tty
4997 * Interaction:: Other Emacs packages
4998 * Bugs:: Things which do not work perfectly
5001 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
5006 Org-mode supports in-buffer completion. This type of completion does
5007 not make use of the minibuffer. You simply type a few letters into the
5008 buffer and use the key to complete text right there.
5011 Complete word at point
5012 * At the beginning of a headline, complete TODO keywords.
5014 * After `\', complete TeX symbols supported by the exporter.
5016 * After `*', complete headlines in the current buffer so that
5017 they can be used in search links like `[[*find this
5020 * After `:', complete tags. The list of tags is taken from the
5021 variable `org-tag-alist' (possibly set through the `#+TAGS'
5022 in-buffer option, *note Setting tags::), or it is created
5023 dynamically from all tags used in the current buffer.
5025 * After `[', complete link abbreviations (*note Link
5028 * After `#+', complete the special keywords like `TYP_TODO' or
5029 `OPTIONS' which set file-specific options for Org-mode. When
5030 the option keyword is already complete, pressing `M-<TAB>'
5031 again will insert example settings for this keyword.
5033 * In the line after `#+STARTUP: ', complete startup keywords,
5034 i.e. valid keys for this line.
5036 * Elsewhere, complete dictionary words using ispell.
5039 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
5044 There are more than 180 variables that can be used to customize
5045 Org-mode. For the sake of compactness of the manual, I am not
5046 describing the variables here. A structured overview of customization
5047 variables is available with `M-x org-customize'. Or select `Browse Org
5048 Group' from the `Org->Customization' menu. Many settings can also be
5049 activated on a per-file basis, by putting special lines into the buffer
5050 (*note In-buffer settings::).
5053 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
5055 12.3 Summary of in-buffer settings
5056 ==================================
5058 Org-mode uses special lines in the buffer to define settings on a
5059 per-file basis. These lines start with a `#+' followed by a keyword, a
5060 colon, and then individual words defining a setting. Several setting
5061 words can be in the same line, but you can also have multiple lines for
5062 the keyword. While these settings are described throughout the manual,
5063 here is a summary. After changing any of those lines in the buffer,
5064 press `C-c C-c' with the cursor still in the line to activate the
5065 changes immediately. Otherwise they become effective only when the
5066 file is visited again in a new Emacs session.
5069 This line sets options to be used at startup of org-mode, when an
5070 Org-mode file is being visited. The first set of options deals
5071 with the initial visibility of the outline tree. The
5072 corresponding variable for global default settings is
5073 `org-startup-folded', with a default value `t', which means
5075 overview top-level headlines only
5076 content all headlines
5077 showall no folding at all, show everything
5078 Then there are options for aligning tables upon visiting a file.
5079 This is useful in files containing narrowed table columns. The
5080 corresponding variable is `org-startup-align-all-tables', with a
5081 default value `nil'.
5082 align align all tables
5083 noalign don't align tables on startup
5084 Logging TODO state changes and clock intervals (variable
5085 `org-log-done') can be configured using these options.
5086 logging record a timestamp when an item is marked DONE
5087 nologging don't record when items are marked DONE
5088 lognotedone record timestamp and a note when DONE
5089 lognotestate record timestamp, note when TODO state changes
5090 lognoteclock-out record timestamp and a note when clocking out
5091 Here are the options for hiding leading stars in outline headings.
5092 The corresponding variables are `org-hide-leading-stars' and
5093 `org-odd-levels-only', both with a default setting `nil' (meaning
5094 `showstars' and `oddeven').
5095 hidestars make all but one of the stars starting a headline invisible.
5096 showstars show all stars starting a headline
5097 odd allow only odd outline levels (1,3,...)
5098 oddeven allow all outline levels
5099 To turn on custom format overlays over time stamps (variables
5100 `org-put-time-stamp-overlays' and
5101 `org-time-stamp-overlay-formats'), use
5102 customtime overlay custom time format
5104 `#+SEQ_TODO: #+TYP_TODO:'
5105 These lines set the TODO keywords and their interpretation in the
5106 current file. The corresponding variables are `org-todo-keywords'
5107 and `org-todo-interpretation'.
5109 `#+TAGS: TAG1(c1) TAG2(c2)'
5110 These lines (several such lines are allowed) specify the legal
5111 tags in this file, and (potentially) the corresponding _fast tag
5112 selection_ keys. The corresponding variable is `org-tag-alist'.
5114 `#+LINK: linkword replace'
5115 These lines (several are allowed) specify link abbreviations.
5116 *Note Link abbreviations::. The corresponding variable is
5117 `org-link-abbrev-alist'.
5120 This line sets the category for the agenda file. The category
5121 applies for all subsequent lines until the next `#+CATEGORY' line,
5122 or the end of the file. The first such line also applies to any
5125 `#+ARCHIVE: %s_done::'
5126 This line sets the archive location for the agenda file. It
5127 applies for all subsequent lines until the next `#+CATEGORY' line,
5128 or the end of the file. The first such line also applies to any
5129 entries before it. The corresponding variable is
5130 `org-archive-location'.
5133 This line contains the formulas for the table directly above the
5136 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5137 These lines provide settings for exporting files. For more
5138 details see *Note Export options::.
5141 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
5143 12.4 The very busy C-c C-c key
5144 ==============================
5146 The key `C-c C-c' has many purposes in org-mode, which are all
5147 mentioned scattered throughout this manual. One specific function of
5148 this key is to add _tags_ to a headline (*note Tags::). In many other
5149 circumstances it means something like _Hey Org-mode, look here and
5150 update according to what you see here_. Here is a summary of what this
5151 means in different contexts.
5153 - If there are highlights in the buffer from the creation of a sparse
5154 tree, or from clock display, remove these highlights.
5156 - If the cursor is in one of the special `#+KEYWORD' lines, this
5157 triggers scanning the buffer for these lines and updating the
5160 - If the cursor is inside a table, realign the table. This command
5161 works even if the automatic table editor has been turned off.
5163 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5166 - If the cursor is inside a table created by the `table.el' package,
5167 activate that table.
5169 - If the current buffer is a remember buffer, close the note and
5170 file it. With a prefix argument, file it, without further
5171 interaction, to the default location.
5173 - If the cursor is on a `<<<target>>>', update radio targets and
5174 corresponding links in this buffer.
5176 - If the cursor is in a plain list item with a checkbox, toggle the
5177 status of the checkbox.
5179 - If the cursor is on a numbered item in a plain list, renumber the
5183 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
5185 12.5 A cleaner outline view
5186 ===========================
5188 Some people find it noisy and distracting that the Org-mode headlines
5189 are starting with a potentially large number of stars. For example the
5190 tree from *Note Headlines:::
5192 * Top level headline
5198 * Another top level headline
5200 Unfortunately this is deeply ingrained into the code of Org-mode and
5201 cannot be easily changed. You can, however, modify the display in such
5202 a way that all leading stars become invisible and the outline more easy
5203 to read. To do this, customize the variable `org-hide-leading-stars'
5206 (setq org-hide-leading-stars t)
5208 or change this on a per-file basis with one of the lines (anywhere in
5211 #+STARTUP: showstars
5212 #+STARTUP: hidestars
5214 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5217 With stars hidden, the tree becomes:
5219 * Top level headline
5225 * Another top level headline
5227 Note that the leading stars are not truly replaced by whitespace, they
5228 are only fontified with the face `org-hide' that uses the background
5229 color as font color. If you are not using either white or black
5230 background, you may have to customize this face to get the wanted
5231 effect. Another possibility is to set this font such that the extra
5232 stars are almost invisible, for example using the color `grey90' on a
5235 Things become cleaner still if you skip all the even levels and use
5236 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5237 outline level to the next:
5239 * Top level headline
5245 * Another top level headline
5247 In order to make the structure editing and export commands handle this
5248 convention correctly, use
5250 (setq org-odd-levels-only t)
5252 or set this on a per-file basis with one of the following lines (don't
5253 forget to press `C-c C-c' with the cursor in the startup line to
5254 activate changes immediately).
5259 You can convert an Org-mode file from single-star-per-level to the
5260 double-star-per-level convention with `M-x org-convert-to-odd-levels
5261 RET' in that file. The reverse operation is `M-x
5262 org-convert-to-oddeven-levels'.
5265 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
5267 12.6 Using org-mode on a tty
5268 ============================
5270 Org-mode uses a number of keys that are not accessible on a tty. This
5271 applies to most special keys like cursor keys, <TAB> and <RET>, when
5272 these are combined with modifier keys like <Meta> and/or <Shift>.
5273 Org-mode uses these bindings because it needs to provide keys for a
5274 large number of commands, and because these keys appeared particularly
5275 easy to remember. In order to still be able to access the core
5276 functionality of Org-mode on a tty, alternative bindings are provided.
5277 Here is a complete list of these bindings, which are obviously more
5278 cumbersome to use. Note that sometimes a work-around can be better.
5279 For example changing a time stamp is really only fun with `S-<cursor>'
5280 keys. On a tty you would rather use `C-c .' to re-insert the
5283 Default Alternative 1 Alternative 2
5284 `S-<TAB>' `C-u <TAB>'
5285 `M-<left>' `C-c C-x l' `<Esc> <left>'
5286 `M-S-<left>'`C-c C-x L'
5287 `M-<right>' `C-c C-x r' `<Esc>
5289 `M-S-<right>'`C-c C-x R'
5290 `M-<up>' `C-c C-x u' `<Esc> <up>'
5291 `M-S-<up>' `C-c C-x U'
5292 `M-<down>' `C-c C-x d' `<Esc> <down>'
5293 `M-S-<down>'`C-c C-x D'
5294 `S-<RET>' `C-c C-x c'
5295 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
5296 `M-S-<RET>' `C-c C-x M'
5299 `S-<right>' `C-c C-x
5307 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
5309 12.7 Interaction with other packages
5310 ====================================
5312 Org-mode lives in the world of GNU Emacs and interacts in various ways
5313 with other code out there.
5317 * Cooperation:: Packages Org-mode cooperates with
5318 * Conflicts:: Packages that lead to conflicts
5321 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
5323 12.7.1 Packages that Org-mode cooperates with
5324 ---------------------------------------------
5326 `calc.el' by Dave Gillespie
5327 Org-mode uses the calc package for implementing spreadsheet
5328 functionality in its tables (*note The spreadsheet::). Org-mode
5329 checks for the availability of calc by looking for the function
5330 `calc-eval' which should be autoloaded in your setup if calc has
5331 been installed properly. As of Emacs 22, calc is part of the Emacs
5332 distribution. Another possibility for interaction between the two
5333 packages is using calc for embedded calculations. *Note Embedded
5334 Mode: (calc)Embedded Mode.
5336 `constants.el' by Carsten Dominik
5337 In a table formula (*note The spreadsheet::), it is possible to use
5338 names for natural constants or units. Instead of defining your own
5339 constants in the variable `org-table-formula-constants', install
5340 the `constants' package which defines a large number of constants
5341 and units, and lets you use unit prefixes like `M' for `Mega' etc.
5342 You will need version 2.0 of this package, available at
5343 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5344 function `constants-get', which has to be autoloaded in your
5345 setup. See the installation instructions in the file
5348 `cdlatex.el' by Carsten Dominik
5349 Org-mode can make use of the cdlatex package to efficiently enter
5350 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5352 `remember.el' by John Wiegley
5353 Org mode cooperates with remember, see *Note Remember::.
5354 `Remember.el' is not part of Emacs, find it on the web.
5356 `table.el' by Takaaki Ota
5357 Complex ASCII tables with automatic line wrapping, column- and
5358 row-spanning, and alignment can be created using the Emacs table
5359 package by Takaaki Ota (`http://sourceforge.net/projects/table',
5360 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
5361 such a table, Org-mode will call `table-recognize-table' and move
5362 the cursor into the table. Inside a table, the keymap of Org-mode
5363 is inactive. In order to execute Org-mode-related commands, leave
5367 Recognize `table.el' table. Works when the cursor is in a
5371 Insert a table.el table. If there is already a table at
5372 point, this command converts it between the table.el format
5373 and the Org-mode format. See the documentation string of the
5374 command `org-convert-table' for the restrictions under which
5376 `table.el' is part of Emacs 22.
5379 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
5381 12.7.2 Packages that lead to conflicts with Org-mode
5382 ----------------------------------------------------
5384 `allout.el' by Ken Manheimer
5385 Startup of Org-mode may fail with the error message
5386 `(wrong-type-argument keymapp nil)' when there is an outdated
5387 version `allout.el' on the load path, for example the version
5388 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
5389 will disappear. If for some reason you cannot do this, make sure
5390 that org.el is loaded _before_ `allout.el', for example by putting
5391 `(require 'org)' early enough into your `.emacs' file.
5393 `CUA.el' by Kim. F. Storm
5394 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5395 by CUA-mode (as well as pc-select-mode and s-region-mode) to
5396 select and extend the region. If you want to use one of these
5397 packages along with Org-mode, configure the variable
5398 `org-CUA-compatible'. When set, Org-mode will move the following
5399 keybindings in org-mode files, and in the agenda buffer (but not
5400 during date selection).
5402 S-UP -> M-p S-DOWN -> M-n
5403 S-LEFT -> M-- S-RIGHT -> M-+
5406 Yes, these are unfortunately more difficult to remember. If you
5407 want to have other replacement keys, look at the variable
5408 `org-disputed-keys'.
5410 `windmove.el' by Hovav Shacham
5411 Also this package uses the `S-<cursor>' keys, so everything written
5412 in the paragraph above about CUA mode also applies here.
5415 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5420 Here is a list of things that should work differently, but which I have
5421 found too hard to fix.
5423 * If a table field starts with a link, and if the corresponding table
5424 column is narrowed (*note Narrow columns::) to a width too small to
5425 display the link, the field would look entirely empty even though
5426 it is not. To prevent this, Org-mode throws an error. The
5427 work-around is to make the column wide enough to fit the link, or
5428 to add some text (at least 2 characters) before the link in the
5431 * Narrowing table columns does not work on XEmacs, because the
5432 `format' function does not transport text properties.
5434 * Text in an entry protected with the `QUOTE' keyword should not
5437 * When the application called by `C-c C-o' to open a file link fails
5438 (for example because the application does not exist or refuses to
5439 open the file), it does so silently. No error message is
5442 * Recalculating a table line applies the formulas from left to right.
5443 If a formula uses _calculated_ fields further down the row,
5444 multiple recalculation may be needed to get all fields consistent.
5445 You may use the command `org-table-iterate' (`C-u C-c *') to
5446 recalculate until convergence.
5448 * A single letter cannot be made bold, for example `*a*'.
5450 * The exporters work well, but could be made more efficient.
5453 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5455 Appendix A Extensions, Hooks and Hacking
5456 ****************************************
5458 This appendix lists extensions for Org-mode written by other authors.
5459 It also covers some aspects where users can extend the functionality of
5464 * Extensions:: Existing 3rd-part extensions
5465 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
5466 * Dynamic blocks:: Automatically filled blocks
5467 * Special agenda views:: Customized views
5470 File: org, Node: Extensions, Next: Tables in arbitrary syntax, Prev: Extensions and Hacking, Up: Extensions and Hacking
5472 A.1 Third-party extensions for Org-mode
5473 =======================================
5475 The following extensions for Org-mode have been written by other people:
5477 `org-publish.el' by David O'Toole
5478 This package provides facilities for publishing related sets of
5479 Org-mode files together with linked files like images as webpages.
5480 It is highly configurable and can be used for other publishing
5481 purposes as well. As of Org-mode version 4.30, `org-publish.el'
5482 is part of the Org-mode distribution. It is not yet part of
5483 Emacs, however, a delay caused by the preparations for the 22.1
5484 release. In the mean time, `org-publish.el' can be downloaded
5485 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
5487 `org-mouse.el' by Piotr Zielinski
5488 This package implements extended mouse functionality for Org-mode.
5489 It allows you to cycle visibility and to edit the document
5490 structure with the mouse. Best of all, it provides a
5491 context-sensitive menu on <mouse-3> that changes depending on the
5492 context of a mouse-click. As of Org-mode version 4.53,
5493 `org-mouse.el' is part of the Org-mode distribution. It is not
5494 yet part of Emacs, however, a delay caused by the preparations for
5495 the 22.1 release. In the mean time, `org-mouse.el' can be
5496 downloaded from Piotr's site:
5497 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
5499 `org-blog.el' by David O'Toole
5500 A blogging plug-in for `org-publish.el'.
5501 `http://dto.freeshell.org/notebook/OrgMode.html'.
5503 `blorg.el' by Bastien Guerry
5504 Publish Org-mode files as blogs.
5505 `http://www.cognition.ens.fr/~guerry/blorg.html'.
5507 `org2rem.el' by Bastien Guerry
5508 Translates Org-mode files into something readable by Remind.
5509 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
5512 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
5514 A.2 Tables in arbitrary syntax
5515 ==============================
5517 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
5518 frequent feature request has been to make it work with native tables in
5519 specific languages, for example LaTeX. However, this is extremely hard
5520 to do in a general way, would lead to a customization nightmare, and
5521 would take away much of the simplicity of the Orgtbl-mode table editor.
5523 This appendix describes a different approach. We keep the
5524 Orgtbl-mode table in its native format (the source table), and use a
5525 custom function to translate the table to the correct syntax, and to
5526 install it in the right location (the target table). This puts the
5527 burden of writing conversion functions on the user, but it allows for a
5528 very flexible system.
5532 * Radio tables:: Sending and receiving
5533 * A LaTeX example:: Step by step, almost a tutorial
5534 * Translator functions:: Copy and modify
5537 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
5542 To define the location of the target table, you first need to create two
5543 lines that are comments in the current mode, but contain magic words for
5544 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
5545 between these lines, replacing whatever was there before. For example:
5547 /* BEGIN RECEIVE ORGTBL table_name */
5548 /* END RECEIVE ORGTBL table_name */
5550 Just above the source table, we put a special line that tells
5551 Orgtbl-mode how to translate this table and where to install it. For
5553 #+ORGTBL: SEND table_name translation_function arguments....
5555 `table_name' is the reference name for the table that is also used in
5556 the receiver lines. `translation_function' is the Lisp function that
5557 does the translation. Furthermore, the line can contain a list of
5558 arguments (alternating key and value) at the end. The arguments will be
5559 passed as a property list to the translation function for
5560 interpretation. A few standard parameters are already recognized and
5561 acted upon before the translation function is called:
5564 Skip the first N lines of the table. Hlines do count!
5566 `:skipcols (n1 n2 ...)'
5567 List of columns that should be skipped. If the table has a column
5568 with calculation marks, that column is automatically discarded as
5569 well. Please note that the translator function sees the table
5570 _after_ the removal of these columns, the function never knows
5571 that there have been additional columns.
5573 The one problem remaining is how to keep the source table in the buffer
5574 without disturbing the normal workings of the file, for example during
5575 compilation of a C file or processing of a LaTeX file. There are a
5576 number of different solutions:
5578 * The table could be placed in a block comment if that is supported
5579 by the language. For example, in C-mode you could wrap the table
5580 between `/*' and `*/' lines.
5582 * Sometimes it is possible to put the table after some kind of END
5583 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
5585 * You can just comment the table line by line whenever you want to
5586 process the file, and uncomment it whenever you need to edit the
5587 table. This only sounds tedious - the command `M-x
5588 orgtbl-toggle-comment' does make this comment-toggling very easy,
5589 in particular if you bind it to a key.
5592 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
5594 A.2.2 A LaTeX example
5595 ---------------------
5597 The best way to wrap the source table in LaTeX is to use the `comment'
5598 environment provided by `comment.sty'. It has to be activated by
5599 placing `\usepackage{comment}' into the document header. Orgtbl-mode
5600 can insert a radio table skeleton(1) with the command `M-x
5601 orgtbl-insert-radio-table'. You will be prompted for a table name,
5602 lets say we use `salesfigures'. You will then get the following
5605 % BEGIN RECEIVE ORGTBL salesfigures
5606 % END RECEIVE ORGTBL salesfigures
5608 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5612 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
5613 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
5614 the receiver location with name `salesfigures'. You may now fill in
5615 the table, feel free to use the spreadsheet features(2):
5617 % BEGIN RECEIVE ORGTBL salesfigures
5618 % END RECEIVE ORGTBL salesfigures
5620 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5621 | Month | Days | Nr sold | per day |
5622 |-------+------+---------+---------|
5623 | Jan | 23 | 55 | 2.4 |
5624 | Feb | 21 | 16 | 0.8 |
5625 | March | 22 | 278 | 12.6 |
5626 #+TBLFM: $4=$3/$2;%.1f
5627 % $ (optional extra dollar to keep font-lock happy, see footnote)
5630 When you are done, press `C-c C-c' in the table to get the converted
5631 table inserted between the two marker lines.
5633 Now lets assume you want to make the table header by hand, because
5634 you want to control how columns are aligned etc. In this case we make
5635 sure that the table translator does skip the first 2 lines of the source
5636 table, and tell the command to work as a splice, i.e. to not produce
5637 header and footer commands of the target table:
5639 \begin{tabular}{lrrr}
5640 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
5641 % BEGIN RECEIVE ORGTBL salesfigures
5642 % END RECEIVE ORGTBL salesfigures
5646 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
5647 | Month | Days | Nr sold | per day |
5648 |-------+------+---------+---------|
5649 | Jan | 23 | 55 | 2.4 |
5650 | Feb | 21 | 16 | 0.8 |
5651 | March | 22 | 278 | 12.6 |
5652 #+TBLFM: $4=$3/$2;%.1f
5655 The LaTeX translator function `orgtbl-to-latex' is already part of
5656 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
5657 marks horizontal lines with `\hline'. Furthermore, it interprets the
5658 following parameters:
5661 When set to t, return only table body lines, don't wrap them into a
5662 tabular environment. Default is nil.
5665 A format to be used to wrap each field, should contain `%s' for the
5666 original field value. For example, to wrap each field value in
5667 dollars, you could use `:fmt "$%s$"'. This may also be a property
5668 list with column numbers and formats. for example `:fmt (2 "$%s$"
5672 Use this format to print numbers with exponentials. The format
5673 should have `%s' twice for inserting mantissa and exponent, for
5674 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
5675 may also be a property list with column numbers and formats, for
5676 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
5677 After `efmt' has been applied to a value, `fmt' will also be
5680 ---------- Footnotes ----------
5682 (1) By default this works only for LaTeX, HTML, and TeXInfo.
5683 Configure the variable `orgtbl-radio-tables' to install templates for
5686 (2) If the `#+TBLFM' line contains an odd number of dollar
5687 characters, this may cause problems with font-lock in latex-mode. As
5688 shown in the example you can fix this by adding an extra line inside the
5689 `comment' environment that is used to balance the dollar expressions.
5690 If you are using AUCTeX with the font-latex library, a much better
5691 solution is to add the `comment' environment to the variable
5692 `LaTeX-verbatim-environments'.
5695 File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in arbitrary syntax
5697 A.2.3 Translator functions
5698 --------------------------
5700 Orgtbl-mode has several translator functions built-in:
5701 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. Except
5702 for `orgtbl-to-html'(1), these all use a generic translator,
5703 `orgtbl-to-generic'. For example, `orgtbl-to-latex' itself is a very
5704 short function that computes the column definitions for the `tabular'
5705 environment, defines a few field and line separators and then hands
5706 over to the generic translator. Here is the entire code:
5708 (defun orgtbl-to-latex (table params)
5709 "Convert the orgtbl-mode TABLE to LaTeX."
5710 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
5711 org-table-last-alignment ""))
5714 :tstart (concat "\\begin{tabular}{" alignment "}")
5715 :tend "\\end{tabular}"
5716 :lstart "" :lend " \\\\" :sep " & "
5717 :efmt "%s\\,(%s)" :hline "\\hline")))
5718 (orgtbl-to-generic table (org-combine-plists params2 params))))
5720 As you can see, the properties passed into the function (variable
5721 PARAMS) are combined with the ones newly defined in the function
5722 (variable PARAMS2). The ones passed into the function (i.e. the ones
5723 set by the `ORGTBL SEND' line) take precedence. So if you would like
5724 to use the LaTeX translator, but wanted the line endings to be
5725 `\\[2mm]' instead of the default `\\', you could just overrule the
5728 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
5730 For a new language, you can either write your own converter function
5731 in analogy with the LaTeX translator, or you can use the generic
5732 function directly. For example, if you have a language where a table
5733 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
5734 started with `!BL!', ended with `!EL!' and where the field separator is
5735 a TAB, you could call the generic translator like this (on a single
5738 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
5739 :lstart "!BL! " :lend " !EL!" :sep "\t"
5741 Please check the documentation string of the function
5742 `orgtbl-to-generic' for a full list of parameters understood by that
5743 function and remember that you can pass each of them into
5744 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
5745 the generic function.
5747 Of course you can also write a completely new function doing
5748 complicated things the generic translator cannot do. A translator
5749 function takes two arguments. The first argument is the table, a list
5750 of lines, each line either the symbol `hline' or a list of fields. The
5751 second argument is the property list containing all parameters
5752 specified in the `#+ORGTBL: SEND' line. The function must return a
5753 single string containing the formatted table. If you write a generally
5754 useful translator, please post it on `emacs-orgmode@gnu.org' so that
5755 others can benefit from your work.
5757 ---------- Footnotes ----------
5759 (1) The HTML translator uses the same code that produces tables
5763 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
5768 Org-mode documents can contain _dynamic blocks_. These are specially
5769 marked regions that are updated by some user-written function. A good
5770 example for such a block is the clock table inserted by the command
5771 `C-c C-x C-r' (*note Clocking work time::).
5773 Dynamic block are enclosed by a BEGIN-END structure that assigns a
5774 name to the block and can also specify parameters for the function
5775 producing the content of the block.
5777 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5781 Dynamic blocks are updated with the following commands
5784 Update dynamic block at point.
5787 Update all dynamic blocks in the current file.
5789 Updating a dynamic block means to remove all the text between BEGIN
5790 and END, parse the BEGIN line for parameters and then call the specific
5791 writer function for this block to insert the new content. For a block
5792 with name `myblock', the writer function is `org-dblock-write:myblock'
5793 with as only parameter a property list with the parameters given in the
5794 begin line. Here is a trivial example of a block that keeps track of
5795 when the block update function was last run:
5797 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5801 The corresponding block writer function could look like this:
5803 (defun org-dblock-write:block-update-time (params)
5804 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5805 (insert "Last block update at: "
5806 (format-time-string fmt (current-time)))))
5808 If you want to make sure that all dynamic blocks are always
5809 up-to-date, you could add the function `org-update-all-dblocks' to a
5810 hook, for example `before-save-hook'. `org-update-all-dblocks' is
5811 written in a way that is does nothing in buffers that are not in
5815 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
5817 A.4 Special Agenda Views
5818 ========================
5820 Org-mode provides a special hook that can be used to narrow down the
5821 selection made by any of the agenda views. You may specify a function
5822 that is used at each match to verify if the match should indeed be part
5823 of the agenda view, and if not, how much should be skipped.
5825 Let's say you want to produce a list of projects that contain a
5826 WAITING tag anywhere in the project tree. Let's further assume that
5827 you have marked all tree headings that define a project with the todo
5828 keyword PROJECT. In this case you would run a todo search for the
5829 keyword PROJECT, but skip the match unless there is a WAITING tag
5830 anywhere in the subtree belonging to the project line.
5832 To achieve this, you must write a function that searches the subtree
5833 for the tag. If the tag is found, the function must return `nil' to
5834 indicate that this match should not be skipped. If there is no such
5835 tag, return the location of the end of the subtree, to indicate that
5836 search should continue from there.
5838 (defun my-skip-unless-waiting ()
5839 "Skip trees that are not waiting"
5840 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
5841 (if (re-search-forward ":WAITING:" subtree-end t)
5842 nil ; tag found, do not skip
5843 subtree-end))) ; tag not found, continue after end of subtree
5845 Furthermore you must write a command that uses `let' to temporarily
5846 put this function into the variable `org-agenda-skip-function', sets
5847 the header string for the agenda buffer, and calls the todo-list
5848 generator while asking for the specific TODO keyword PROJECT. The
5849 function must also accept one argument MATCH, but it can choose to
5850 ignore it(1) (as we do in the example below). Here is the example:
5852 (defun my-org-waiting-projects (&optional match)
5853 "Produce a list of projects that contain a WAITING tag.
5854 MATCH is being ignored."
5856 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
5857 (org-agenda-overriding-header "Projects waiting for something: "))
5859 (org-todo-list "PROJECT")))
5861 ---------- Footnotes ----------
5863 (1) MATCH must be present in case you want to define a custom
5864 command for producing this special list. Custom commands always supply
5865 the MATCH argument, but it can be empty if you do not specify it while
5866 defining the command(*note Custom agenda views::).
5869 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
5871 Appendix B History and Acknowledgments
5872 **************************************
5874 Org-mode was borne in 2003, out of frustration over the user interface
5875 of the Emacs outline-mode. I was trying to organize my notes and
5876 projects, and using Emacs seemed to be the natural way to go. However,
5877 having to remember eleven different commands with two or three keys per
5878 command, only to hide and unhide parts of the outline tree, that seemed
5879 entirely unacceptable to me. Also, when using outlines to take notes, I
5880 constantly want to restructure the tree, organizing it parallel to my
5881 thoughts and plans. _Visibility cycling_ and _structure editing_ were
5882 originally implemented in the package `outline-magic.el', but quickly
5883 moved to the more general `org.el'. As this environment became
5884 comfortable for project planning, the next step was adding _TODO
5885 entries_, basic _time stamps_, and _table support_. These areas
5886 highlight the two main goals that Org-mode still has today: To create a
5887 new, outline-based, plain text mode with innovative and intuitive
5888 editing features, and to incorporate project planning functionality
5889 directly into a notes file.
5891 Since the first release, hundreds of emails to me or on
5892 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
5893 feedback, new ideas, and sometimes patches and add-on code. Many
5894 thanks to everyone who has helped to improve this package. I am trying
5895 to keep here a list of the people who had significant influence in
5896 shaping one or more aspects of Org-mode. The list may not be complete,
5897 if I have forgotten someone, please accept my apologies and let me know.
5899 * Thomas Baumann contributed the code for links to the MH-E email
5902 * Alex Bochannek provided a patch for rounding time stamps.
5904 * Charles Cave's suggestion sparked the implementation of templates
5907 * Pavel Chalmoviansky influenced the agenda treatment of items with
5910 * Gregory Chernov patched support for lisp forms into table
5911 calculations and improved XEmacs compatibility, in particular by
5912 porting `nouline.el' to XEmacs.
5914 * Sacha Chua suggested to copy some linking code from Planner.
5916 * Eddward DeVilla proposed and tested checkbox statistics.
5918 * Kees Dullemond used to edit projects lists directly in HTML and so
5919 inspired some of the early development, including HTML export. He
5920 also asked for a way to narrow wide table columns.
5922 * Christian Egli converted the documentation into TeXInfo format,
5923 patched CSS formatting into the HTML exporter, and inspired the
5926 * Nic Ferrier contributed mailcap and XOXO support.
5928 * John Foerch figured out how to make incremental search show context
5929 around a match in a hidden outline tree.
5931 * Niels Giessen had the idea to automatically archive DONE trees.
5933 * Bastien Guerry provided extensive feedback and some patches, and
5934 translated David O'Toole's tutorial into French.
5936 * Kai Grossjohann pointed out key-binding conflicts with other
5939 * Shidai Liu ("Leo") provided extensive feedback and some patches.
5941 * Leon Liu asked for embedded LaTeX and tested it.
5943 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
5946 * Todd Neal provided patches for links to Info files and elisp forms.
5948 * Tim O'Callaghan suggested in-file links, search options for general
5949 file links, and TAGS.
5951 * Takeshi Okano translated the manual and David O'Toole's tutorial
5954 * Oliver Oppitz suggested multi-state TODO items.
5956 * Scott Otterson sparked the introduction of descriptive text for
5957 links, among other things.
5959 * Pete Phillips helped during the development of the TAGS feature,
5960 and provided frequent feedback.
5962 * T.V. Raman reported bugs and suggested improvements.
5964 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
5967 * Kevin Rogers contributed code to access VM files on remote hosts.
5969 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
5970 conflict with `allout.el'.
5972 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
5974 * Philip Rooke created the Org-mode reference card and provided lots
5977 * Christian Schlauer proposed angular brackets around links, among
5980 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
5981 `organizer-mode.el'.
5983 * Daniel Sinder came up with the idea of internal archiving by
5986 * Dale Smith proposed link abbreviations.
5988 * David O'Toole wrote `org-publish.el' and drafted the manual
5989 chapter about publishing.
5991 * Ju"rgen Vollmer contributed code generating the table of contents
5994 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
5996 * David Wainberg suggested archiving, and improvements to the linking
5999 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
6000 development of Org-mode was fully independent, and both systems are
6001 really different beasts in their basic ideas and implementation
6002 details. I later looked at John's code, however, and learned from
6003 his implementation of (i) links where the link itself is hidden
6004 and only a description is shown, and (ii) popping up a calendar to
6007 * Carsten Wimmer suggested some changes and helped fix a bug in
6010 * Roland Winkler requested additional keybindings to make Org-mode
6013 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
6014 contributed various ideas and code snippets.
6017 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
6025 * abbreviation, links: Link abbreviations. (line 6)
6026 * acknowledgments: History and Acknowledgments.
6028 * action, for publishing: Publishing action. (line 6)
6029 * activation: Activation. (line 6)
6030 * active region <1>: Export commands. (line 6)
6031 * active region <2>: ASCII export. (line 9)
6032 * active region <3>: Built-in table editor.
6034 * active region: Structure editing. (line 64)
6035 * agenda: Weekly/Daily agenda. (line 6)
6036 * agenda dispatcher: Agenda dispatcher. (line 6)
6037 * agenda files: Agenda files. (line 6)
6038 * agenda files, removing buffers: Agenda commands. (line 230)
6039 * agenda views: Agenda views. (line 6)
6040 * agenda views, custom: Custom agenda views. (line 6)
6041 * agenda views, user-defined: Special agenda views.
6043 * agenda, batch production: Batch processing. (line 6)
6044 * agenda, with block views: Block agenda. (line 6)
6045 * align, STARTUP keyword: In-buffer settings. (line 29)
6046 * allout.el: Conflicts. (line 6)
6047 * angular brackets, around links: External links. (line 43)
6048 * archive locations: Moving subtrees. (line 21)
6049 * archiving: Archiving. (line 6)
6050 * ASCII export: ASCII export. (line 6)
6051 * author: Feedback. (line 6)
6052 * autoload: Activation. (line 6)
6053 * backtrace of an error: Feedback. (line 27)
6054 * BBDB links: External links. (line 6)
6055 * block agenda: Block agenda. (line 6)
6056 * blorg.el: Extensions. (line 32)
6057 * bold text: Enhancing text. (line 15)
6058 * Boolean logic, for tag searches: Tag searches. (line 23)
6059 * bug reports: Feedback. (line 6)
6060 * bugs: Bugs. (line 6)
6061 * C-c C-c, overview: The very busy C-c C-c key.
6063 * calc package: The spreadsheet. (line 6)
6064 * calc.el: Cooperation. (line 6)
6065 * calculations, in tables <1>: The spreadsheet. (line 6)
6066 * calculations, in tables: Built-in table editor.
6068 * calendar commands, from agenda: Agenda commands. (line 191)
6069 * calendar integration: Weekly/Daily agenda. (line 24)
6070 * calendar, for selecting date: The date/time prompt.
6072 * category: Categories. (line 6)
6073 * CDLaTeX: CDLaTeX mode. (line 6)
6074 * cdlatex.el: Cooperation. (line 29)
6075 * checkbox statistics: Checkboxes. (line 23)
6076 * checkboxes: Checkboxes. (line 6)
6077 * children, subtree visibility state: Visibility cycling. (line 10)
6078 * clean outline view: Clean view. (line 6)
6079 * CLOCK keyword: Time stamps. (line 71)
6080 * CLOSED keyword: Time stamps. (line 65)
6081 * column formula: Column formulas. (line 6)
6082 * commands, in agenda buffer: Agenda commands. (line 6)
6083 * comment lines: Comment lines. (line 6)
6084 * completion, of dictionary words: Completion. (line 6)
6085 * completion, of file names: Handling links. (line 43)
6086 * completion, of link abbreviations: Completion. (line 6)
6087 * completion, of links: Handling links. (line 27)
6088 * completion, of option keywords <1>: Completion. (line 6)
6089 * completion, of option keywords <2>: Export options. (line 6)
6090 * completion, of option keywords: Per file keywords. (line 17)
6091 * completion, of tags <1>: Completion. (line 6)
6092 * completion, of tags: Setting tags. (line 11)
6093 * completion, of TeX symbols: Completion. (line 6)
6094 * completion, of TODO keywords <1>: Completion. (line 6)
6095 * completion, of TODO keywords: Workflow states. (line 12)
6096 * constants, in calculations: References. (line 74)
6097 * constants.el: Cooperation. (line 14)
6098 * content, STARTUP keyword: In-buffer settings. (line 22)
6099 * contents, global visibility state: Visibility cycling. (line 22)
6100 * copying, of subtrees: Structure editing. (line 6)
6101 * creating timestamps: Creating timestamps. (line 6)
6102 * CUA.el: Conflicts. (line 15)
6103 * custom agenda views: Custom agenda views. (line 6)
6104 * custom date/time format: Custom time format. (line 6)
6105 * custom search strings: Custom searches. (line 6)
6106 * customization: Customization. (line 6)
6107 * customtime, STARTUP keyword: In-buffer settings. (line 49)
6108 * cutting, of subtrees: Structure editing. (line 6)
6109 * cycling, of TODO states: TODO basics. (line 13)
6110 * cycling, visibility: Visibility cycling. (line 6)
6111 * daily agenda: Weekly/Daily agenda. (line 6)
6112 * date format, custom: Custom time format. (line 6)
6113 * date stamps <1>: Time stamps. (line 6)
6114 * date stamps: Timestamps. (line 6)
6115 * date, reading in minibuffer: The date/time prompt.
6117 * DEADLINE keyword: Time stamps. (line 53)
6118 * deadlines: Time stamps. (line 6)
6119 * deadlines, repeating: Repeating items. (line 6)
6120 * debugging, of table formulas: Editing and debugging formulas.
6122 * demotion, of subtrees: Structure editing. (line 6)
6123 * diary entries, creating from agenda: Agenda commands. (line 198)
6124 * diary integration: Weekly/Daily agenda. (line 24)
6125 * dictionary word completion: Completion. (line 6)
6126 * directories, for publishing: Sources and destinations.
6128 * dispatching agenda commands: Agenda dispatcher. (line 6)
6129 * display changing, in agenda: Agenda commands. (line 65)
6130 * document structure: Document structure. (line 6)
6131 * DONE, final TODO keyword: Per file keywords. (line 20)
6132 * dynamic blocks: Dynamic blocks. (line 6)
6133 * editing tables: Tables. (line 6)
6134 * editing, of table formulas: Editing and debugging formulas.
6136 * elisp links: External links. (line 6)
6137 * emphasized text: Export options. (line 25)
6138 * enhancing text: Enhancing text. (line 6)
6139 * evaluate time range: Creating timestamps. (line 66)
6140 * even, STARTUP keyword: In-buffer settings. (line 42)
6141 * exporting: Exporting. (line 6)
6142 * exporting, not: Comment lines. (line 6)
6143 * extended TODO keywords: TODO extensions. (line 6)
6144 * extension, third-party: Extensions. (line 6)
6145 * external archiving: Moving subtrees. (line 6)
6146 * external links: External links. (line 6)
6147 * external links, in HTML export: Links. (line 6)
6148 * FAQ: Summary. (line 53)
6149 * feedback: Feedback. (line 6)
6150 * field formula: Field formulas. (line 6)
6151 * field references: References. (line 14)
6152 * file links: External links. (line 6)
6153 * file links, searching: Search options. (line 6)
6154 * file name completion: Handling links. (line 43)
6155 * files for agenda: Agenda files. (line 6)
6156 * files, adding to agenda list: Agenda files. (line 12)
6157 * files, selecting for publishing: Selecting files. (line 6)
6158 * fixed width: Enhancing text. (line 28)
6159 * fixed-width sections: Export options. (line 25)
6160 * folded, subtree visibility state: Visibility cycling. (line 10)
6161 * folding, sparse trees: Sparse trees. (line 6)
6162 * following links: Handling links. (line 58)
6163 * format specifier: Formula syntax for Calc.
6165 * format, of links: Link format. (line 6)
6166 * formula debugging: Editing and debugging formulas.
6168 * formula editing: Editing and debugging formulas.
6170 * formula syntax, Calc: Formula syntax for Calc.
6172 * formula, for individual table field: Field formulas. (line 6)
6173 * formula, for table column: Column formulas. (line 6)
6174 * formula, in tables: Built-in table editor.
6176 * global cycling: Visibility cycling. (line 22)
6177 * global keybindings: Activation. (line 6)
6178 * global TODO list: Global TODO list. (line 6)
6179 * global visibility states: Visibility cycling. (line 22)
6180 * GNUS links: External links. (line 6)
6181 * hand-formatted lists: Enhancing text. (line 11)
6182 * headline levels: Export options. (line 25)
6183 * headline levels, for exporting <1>: Export commands. (line 17)
6184 * headline levels, for exporting: ASCII export. (line 18)
6185 * headline navigation: Motion. (line 6)
6186 * headline tagging: Tags. (line 6)
6187 * headline, promotion and demotion: Structure editing. (line 6)
6188 * headlines: Headlines. (line 6)
6189 * hide text: Visibility cycling. (line 6)
6190 * hidestars, STARTUP keyword: In-buffer settings. (line 42)
6191 * hiding leading stars: Clean view. (line 6)
6192 * history: History and Acknowledgments.
6194 * horizontal rules, in exported files: Enhancing text. (line 18)
6195 * HTML export: HTML export. (line 6)
6196 * HTML, and orgtbl-mode: Translator functions.
6198 * hyperlinks: Hyperlinks. (line 6)
6199 * iCalendar export: iCalendar export. (line 6)
6200 * images, inline in HTML: Images. (line 6)
6201 * in-buffer settings: In-buffer settings. (line 6)
6202 * inactive timestamp: Time stamps. (line 24)
6203 * index, of published pages: Project page index. (line 6)
6204 * Info links: External links. (line 6)
6205 * inheritance, of tags: Tag inheritance. (line 6)
6206 * inlining images in HTML: Images. (line 6)
6207 * inserting links: Handling links. (line 27)
6208 * installation: Installation. (line 6)
6209 * internal archiving: ARCHIVE tag. (line 6)
6210 * internal links: Internal links. (line 6)
6211 * internal links, in HTML export: Links. (line 6)
6212 * introduction: Introduction. (line 6)
6213 * italic text: Enhancing text. (line 15)
6214 * jumping, to headlines: Motion. (line 6)
6215 * keybindings, global: Activation. (line 6)
6216 * keyword options: Per file keywords. (line 6)
6217 * LaTeX fragments <1>: Export options. (line 25)
6218 * LaTeX fragments: LaTeX fragments. (line 6)
6219 * LaTeX fragments, export: Enhancing text. (line 21)
6220 * LaTeX fragments, preview: Processing LaTeX fragments.
6222 * LaTeX interpretation: Embedded LaTeX. (line 6)
6223 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
6224 * level, require for tags match: Tag searches. (line 68)
6225 * linebreak preservation: Export options. (line 25)
6226 * linebreak, forced: Enhancing text. (line 35)
6227 * link abbreviations: Link abbreviations. (line 6)
6228 * link abbreviations, completion of: Completion. (line 6)
6229 * link completion: Handling links. (line 27)
6230 * link format: Link format. (line 6)
6231 * links, external: External links. (line 6)
6232 * links, finding next/previous: Handling links. (line 91)
6233 * links, handling: Handling links. (line 6)
6234 * links, in HTML export: Links. (line 6)
6235 * links, internal: Internal links. (line 6)
6236 * links, publishing: Publishing links. (line 6)
6237 * links, radio targets: Radio targets. (line 6)
6238 * links, returning to: Handling links. (line 85)
6239 * Lisp forms, as table formulas: Formula syntax for Lisp.
6241 * lists, hand-formatted: Enhancing text. (line 11)
6242 * lists, ordered: Plain lists. (line 6)
6243 * lists, plain: Plain lists. (line 6)
6244 * logdone, STARTUP keyword: In-buffer settings. (line 33)
6245 * logging, of progress: Progress logging. (line 6)
6246 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
6247 * lognotedone, STARTUP keyword: In-buffer settings. (line 33)
6248 * lognotestate, STARTUP keyword: In-buffer settings. (line 33)
6249 * maintainer: Feedback. (line 6)
6250 * mark ring: Handling links. (line 81)
6251 * marking characters, tables: Advanced features. (line 40)
6252 * matching, of tags: Matching headline tags.
6254 * matching, tags: Tags. (line 6)
6255 * math symbols: Math symbols. (line 6)
6256 * MH-E links: External links. (line 6)
6257 * minor mode for tables: orgtbl-mode. (line 6)
6258 * mode, for calc: Formula syntax for Calc.
6260 * motion commands in agenda: Agenda commands. (line 19)
6261 * motion, between headlines: Motion. (line 6)
6262 * name, of column or field: References. (line 74)
6263 * named references: References. (line 74)
6264 * names as TODO keywords: TODO types. (line 6)
6265 * narrow columns in tables: Narrow columns. (line 6)
6266 * noalign, STARTUP keyword: In-buffer settings. (line 29)
6267 * nologging, STARTUP keyword: In-buffer settings. (line 33)
6268 * occur, command: Sparse trees. (line 6)
6269 * odd, STARTUP keyword: In-buffer settings. (line 42)
6270 * option keyword completion: Completion. (line 6)
6271 * options, for custom agenda views: Setting Options. (line 6)
6272 * options, for customization: Customization. (line 6)
6273 * options, for export: Export options. (line 6)
6274 * options, for publishing: Publishing options. (line 6)
6275 * ordered lists: Plain lists. (line 6)
6276 * org-agenda, command: Weekly/Daily agenda. (line 9)
6277 * org-blog.el: Extensions. (line 28)
6278 * org-mode, turning on: Activation. (line 22)
6279 * org-mouse.el: Extensions. (line 16)
6280 * org-publish-project-alist: Project alist. (line 6)
6281 * org-publish.el: Extensions. (line 8)
6282 * org2rem.el: Extensions. (line 36)
6283 * orgtbl-mode <1>: Tables in arbitrary syntax.
6285 * orgtbl-mode: orgtbl-mode. (line 6)
6286 * outline tree: Headlines. (line 6)
6287 * outline-mode: Outlines. (line 6)
6288 * outlines: Outlines. (line 6)
6289 * overview, global visibility state: Visibility cycling. (line 22)
6290 * overview, STARTUP keyword: In-buffer settings. (line 22)
6291 * packages, interaction with other: Interaction. (line 6)
6292 * pasting, of subtrees: Structure editing. (line 6)
6293 * per file keywords: Per file keywords. (line 6)
6294 * plain lists: Plain lists. (line 6)
6295 * plain text external links: External links. (line 43)
6296 * presentation, of agenda items: Presentation and sorting.
6298 * printing sparse trees: Sparse trees. (line 41)
6299 * priorities: Priorities. (line 6)
6300 * priorities, of agenda items: Sorting of agenda items.
6302 * progress logging: Progress logging. (line 6)
6303 * projects, for publishing: Project alist. (line 6)
6304 * promotion, of subtrees: Structure editing. (line 6)
6305 * publishing: Publishing. (line 6)
6306 * quoted HTML tags: Export options. (line 25)
6307 * radio tables: Radio tables. (line 6)
6308 * radio targets: Radio targets. (line 6)
6309 * range references: References. (line 53)
6310 * ranges, time: Time stamps. (line 6)
6311 * recomputing table fields: Updating the table. (line 6)
6312 * references: References. (line 6)
6313 * references, named: References. (line 74)
6314 * references, to fields: References. (line 14)
6315 * references, to ranges: References. (line 53)
6316 * region, active <1>: Export commands. (line 6)
6317 * region, active <2>: ASCII export. (line 9)
6318 * region, active <3>: Built-in table editor.
6320 * region, active: Structure editing. (line 64)
6321 * regular expressions, with tags search: Tag searches. (line 63)
6322 * remember.el <1>: Cooperation. (line 33)
6323 * remember.el: Remember. (line 6)
6324 * remote editing, from agenda: Agenda commands. (line 106)
6325 * remote editing, undo: Agenda commands. (line 109)
6326 * richer text: Enhancing text. (line 6)
6327 * RMAIL links: External links. (line 6)
6328 * SCHEDULED keyword: Time stamps. (line 40)
6329 * scheduling: Time stamps. (line 6)
6330 * scheduling, repeating: Repeating items. (line 6)
6331 * search option in file links: Search options. (line 6)
6332 * search strings, custom: Custom searches. (line 6)
6333 * searching for tags: Tag searches. (line 6)
6334 * section-numbers: Export options. (line 25)
6335 * setting tags: Setting tags. (line 6)
6336 * SHELL links: External links. (line 6)
6337 * show all, command: Visibility cycling. (line 33)
6338 * show all, global visibility state: Visibility cycling. (line 22)
6339 * show hidden text: Visibility cycling. (line 6)
6340 * showall, STARTUP keyword: In-buffer settings. (line 22)
6341 * showstars, STARTUP keyword: In-buffer settings. (line 42)
6342 * sorting, of agenda items: Sorting of agenda items.
6344 * sparse tree, for deadlines: Creating timestamps. (line 41)
6345 * sparse tree, for TODO: TODO basics. (line 26)
6346 * sparse tree, tag based: Tags. (line 6)
6347 * sparse trees: Sparse trees. (line 6)
6348 * special keywords: In-buffer settings. (line 6)
6349 * spreadsheet capabilities: The spreadsheet. (line 6)
6350 * statistics, for checkboxes: Checkboxes. (line 23)
6351 * storing links: Handling links. (line 9)
6352 * structure editing: Structure editing. (line 6)
6353 * structure of document: Document structure. (line 6)
6354 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
6355 * sublevels, inclusion into todo list: Global TODO list. (line 33)
6356 * subscript: Subscripts and Superscripts.
6358 * subtree cycling: Visibility cycling. (line 10)
6359 * subtree visibility states: Visibility cycling. (line 10)
6360 * subtree, cut and paste: Structure editing. (line 6)
6361 * subtree, subtree visibility state: Visibility cycling. (line 10)
6362 * subtrees, cut and paste: Structure editing. (line 6)
6363 * summary: Summary. (line 6)
6364 * superscript: Subscripts and Superscripts.
6366 * syntax, of formulas: Formula syntax for Calc.
6368 * table editor, built-in: Built-in table editor.
6370 * table editor, table.el: Cooperation. (line 37)
6371 * table of contents: Export options. (line 25)
6372 * table.el: Cooperation. (line 34)
6373 * tables <1>: Export options. (line 25)
6374 * tables: Tables. (line 6)
6375 * tables, export: Enhancing text. (line 24)
6376 * tables, in other modes: Tables in arbitrary syntax.
6378 * tag completion: Completion. (line 6)
6379 * tag searches: Tag searches. (line 6)
6380 * tags: Tags. (line 6)
6381 * tags view: Matching headline tags.
6383 * tags, setting: Setting tags. (line 6)
6384 * targets, for links: Internal links. (line 6)
6385 * targets, radio: Radio targets. (line 6)
6386 * tasks, breaking down: Breaking down tasks. (line 6)
6387 * templates, for remember: Remember templates. (line 6)
6388 * TeX interpretation: Embedded LaTeX. (line 6)
6389 * TeX macros <1>: Export options. (line 25)
6390 * TeX macros: Math symbols. (line 6)
6391 * TeX macros, export: Enhancing text. (line 21)
6392 * TeX symbol completion: Completion. (line 6)
6393 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
6394 * thanks: History and Acknowledgments.
6396 * time format, custom: Custom time format. (line 6)
6397 * time grid: Time-of-day specifications.
6399 * time stamps <1>: Time stamps. (line 6)
6400 * time stamps: Timestamps. (line 6)
6401 * time, reading in minibuffer: The date/time prompt.
6403 * time-of-day specification: Time-of-day specifications.
6405 * time-sorted view: Timeline. (line 6)
6406 * timeline, single file: Timeline. (line 6)
6407 * timerange: Time stamps. (line 31)
6408 * timestamp: Time stamps. (line 14)
6409 * timestamp, inactive: Time stamps. (line 24)
6410 * timestamps, creating: Creating timestamps. (line 6)
6411 * TODO items: TODO items. (line 6)
6412 * TODO items, repeating: Repeating items. (line 6)
6413 * TODO keyword matching: Global TODO list. (line 17)
6414 * TODO keyword matching, with tags search: Tag searches. (line 40)
6415 * TODO keywords completion: Completion. (line 6)
6416 * TODO list, global: Global TODO list. (line 6)
6417 * TODO types: TODO types. (line 6)
6418 * TODO workflow: Workflow states. (line 6)
6419 * transient-mark-mode <1>: Export commands. (line 6)
6420 * transient-mark-mode <2>: ASCII export. (line 9)
6421 * transient-mark-mode <3>: Built-in table editor.
6423 * transient-mark-mode: Structure editing. (line 64)
6424 * translator function: Translator functions.
6426 * trees, sparse: Sparse trees. (line 6)
6427 * trees, visibility: Visibility cycling. (line 6)
6428 * tty keybindings: TTY keys. (line 6)
6429 * types as TODO keywords: TODO types. (line 6)
6430 * underlined text: Enhancing text. (line 15)
6431 * undoing remote-editing events: Agenda commands. (line 109)
6432 * updating, table: Updating the table. (line 6)
6433 * URL links: External links. (line 6)
6434 * USENET links: External links. (line 6)
6435 * variables, for customization: Customization. (line 6)
6436 * vectors, in table calculations: Formula syntax for Calc.
6438 * visibility cycling: Visibility cycling. (line 6)
6439 * visible text, printing: Sparse trees. (line 41)
6440 * VM links: External links. (line 6)
6441 * WANDERLUST links: External links. (line 6)
6442 * weekly agenda: Weekly/Daily agenda. (line 6)
6443 * windmove.el: Conflicts. (line 33)
6444 * workflow states as TODO keywords: Workflow states. (line 6)
6445 * XEmacs: Installation. (line 6)
6446 * XOXO export: XOXO export. (line 6)
6449 File: org, Node: Key Index, Prev: Index, Up: Top
6457 * $: Agenda commands. (line 123)
6458 * ': CDLaTeX mode. (line 43)
6459 * +: Agenda commands. (line 145)
6460 * ,: Agenda commands. (line 137)
6461 * -: Agenda commands. (line 151)
6462 * .: Agenda commands. (line 100)
6463 * :: Agenda commands. (line 131)
6464 * <: The date/time prompt.
6466 * <left>: Agenda commands. (line 97)
6467 * <RET> <1>: Agenda commands. (line 41)
6468 * <RET> <2>: Setting tags. (line 76)
6469 * <RET> <3>: The date/time prompt.
6471 * <RET>: Built-in table editor.
6473 * <right>: Agenda commands. (line 92)
6474 * <SPC> <1>: Agenda commands. (line 28)
6475 * <SPC>: Setting tags. (line 73)
6476 * <TAB> <1>: CDLaTeX mode. (line 23)
6477 * <TAB> <2>: Agenda commands. (line 35)
6478 * <TAB> <3>: Setting tags. (line 68)
6479 * <TAB> <4>: Editing and debugging formulas.
6481 * <TAB> <5>: Built-in table editor.
6483 * <TAB> <6>: Plain lists. (line 37)
6484 * <TAB>: Visibility cycling. (line 10)
6485 * > <1>: Agenda commands. (line 173)
6486 * >: The date/time prompt.
6488 * ^: CDLaTeX mode. (line 33)
6489 * _: CDLaTeX mode. (line 33)
6490 * `: CDLaTeX mode. (line 39)
6491 * a: Agenda commands. (line 134)
6492 * b: Agenda commands. (line 51)
6493 * C: Agenda commands. (line 213)
6494 * c: Agenda commands. (line 191)
6495 * C-#: Advanced features. (line 9)
6496 * C-': Agenda files. (line 18)
6497 * C-,: Agenda files. (line 18)
6498 * C-_: Agenda commands. (line 109)
6499 * C-a a L: Timeline. (line 10)
6500 * C-c !: Creating timestamps. (line 21)
6501 * C-c #: Checkboxes. (line 56)
6502 * C-c %: Handling links. (line 81)
6503 * C-c &: Handling links. (line 85)
6504 * C-c ': Editing and debugging formulas.
6506 * C-c *: Updating the table. (line 13)
6507 * C-c +: Built-in table editor.
6509 * C-c ,: Priorities. (line 18)
6510 * C-c -: Built-in table editor.
6512 * C-c .: Creating timestamps. (line 10)
6513 * C-c /: Sparse trees. (line 15)
6514 * C-c :: Enhancing text. (line 32)
6515 * C-c ;: Comment lines. (line 11)
6516 * C-c <: Creating timestamps. (line 25)
6517 * C-c <TAB>: Built-in table editor.
6519 * C-c = <1>: Editing and debugging formulas.
6521 * C-c =: Column formulas. (line 24)
6522 * C-c >: Creating timestamps. (line 29)
6523 * C-c ?: Editing and debugging formulas.
6525 * C-c [: Agenda files. (line 12)
6526 * C-c \: Tag searches. (line 9)
6527 * C-c ]: Agenda files. (line 15)
6528 * C-c ^ <1>: Built-in table editor.
6530 * C-c ^: Structure editing. (line 52)
6531 * C-c `: Built-in table editor.
6533 * C-c a !: Stuck projects. (line 14)
6534 * C-c a #: Stuck projects. (line 13)
6535 * C-c a a: Weekly/Daily agenda. (line 9)
6536 * C-c a C: Storing searches. (line 9)
6537 * C-c a M: Matching headline tags.
6539 * C-c a m: Matching headline tags.
6541 * C-c a M: Tag searches. (line 16)
6542 * C-c a m: Tag searches. (line 12)
6543 * C-c a T: Global TODO list. (line 14)
6544 * C-c a t <1>: Global TODO list. (line 9)
6545 * C-c a t: TODO basics. (line 33)
6546 * C-c C-a: Visibility cycling. (line 33)
6547 * C-c C-b: Motion. (line 15)
6548 * C-c C-c <1>: Cooperation. (line 37)
6549 * C-c C-c <2>: The very busy C-c C-c key.
6551 * C-c C-c <3>: Processing LaTeX fragments.
6553 * C-c C-c <4>: Setting tags. (line 10)
6554 * C-c C-c <5>: Checkboxes. (line 37)
6555 * C-c C-c <6>: Editing and debugging formulas.
6557 * C-c C-c <7>: Built-in table editor.
6559 * C-c C-c: Plain lists. (line 74)
6560 * C-c C-d <1>: Agenda commands. (line 158)
6561 * C-c C-d: Creating timestamps. (line 37)
6562 * C-c C-e: Exporting. (line 19)
6563 * C-c C-e a: ASCII export. (line 9)
6564 * C-c C-e b: Export commands. (line 7)
6565 * C-c C-e c: iCalendar export. (line 21)
6566 * C-c C-e h: Export commands. (line 6)
6567 * C-c C-e I: iCalendar export. (line 16)
6568 * C-c C-e i: iCalendar export. (line 14)
6569 * C-c C-e t: Export options. (line 13)
6570 * C-c C-e v <1>: XOXO export. (line 11)
6571 * C-c C-e v: Sparse trees. (line 41)
6572 * C-c C-e v a: ASCII export. (line 13)
6573 * C-c C-e v b: Export commands. (line 10)
6574 * C-c C-e v h: Export commands. (line 10)
6575 * C-c C-e x: XOXO export. (line 10)
6576 * C-c C-f: Motion. (line 12)
6577 * C-c C-j: Motion. (line 21)
6578 * C-c C-l: Handling links. (line 27)
6579 * C-c C-n: Motion. (line 8)
6580 * C-c C-o <1>: Creating timestamps. (line 33)
6581 * C-c C-o: Handling links. (line 58)
6582 * C-c C-p: Motion. (line 9)
6583 * C-c C-q <1>: Editing and debugging formulas.
6585 * C-c C-q: Built-in table editor.
6587 * C-c C-r: Visibility cycling. (line 34)
6588 * C-c C-s <1>: Agenda commands. (line 155)
6589 * C-c C-s: Creating timestamps. (line 48)
6590 * C-c C-t <1>: Clocking work time. (line 27)
6591 * C-c C-t: TODO basics. (line 13)
6592 * C-c C-u: Motion. (line 18)
6593 * C-c C-v: TODO basics. (line 26)
6594 * C-c C-w: Creating timestamps. (line 41)
6595 * C-c C-x b: Visibility cycling. (line 41)
6596 * C-c C-x C-a: ARCHIVE tag. (line 28)
6597 * C-c C-x C-b: Checkboxes. (line 38)
6598 * C-c C-x C-c: Agenda commands. (line 220)
6599 * C-c C-x C-d: Clocking work time. (line 35)
6600 * C-c C-x C-i: Clocking work time. (line 12)
6601 * C-c C-x C-k: Structure editing. (line 39)
6602 * C-c C-x C-l: Processing LaTeX fragments.
6604 * C-c C-x C-n: Handling links. (line 91)
6605 * C-c C-x C-o: Clocking work time. (line 14)
6606 * C-c C-x C-p: Handling links. (line 91)
6607 * C-c C-x C-r: Clocking work time. (line 43)
6608 * C-c C-x C-s: Moving subtrees. (line 10)
6609 * C-c C-x C-t: Custom time format. (line 12)
6610 * C-c C-x C-u: Dynamic blocks. (line 21)
6611 * C-c C-x C-w <1>: Built-in table editor.
6613 * C-c C-x C-w: Structure editing. (line 39)
6614 * C-c C-x C-x: Clocking work time. (line 31)
6615 * C-c C-x C-y <1>: Built-in table editor.
6617 * C-c C-x C-y: Structure editing. (line 46)
6618 * C-c C-x M-w <1>: Built-in table editor.
6620 * C-c C-x M-w: Structure editing. (line 43)
6621 * C-c C-y <1>: Clocking work time. (line 22)
6622 * C-c C-y: Creating timestamps. (line 66)
6623 * C-c l: Handling links. (line 9)
6624 * C-c { <1>: CDLaTeX mode. (line 21)
6625 * C-c {: Editing and debugging formulas.
6627 * C-c |: Built-in table editor.
6629 * C-c }: Editing and debugging formulas.
6631 * C-c ~: Cooperation. (line 50)
6632 * C-k: Agenda commands. (line 117)
6633 * C-TAB: ARCHIVE tag. (line 38)
6634 * C-u C-c *: Updating the table. (line 18)
6635 * C-u C-c .: Creating timestamps. (line 16)
6636 * C-u C-c = <1>: Editing and debugging formulas.
6638 * C-u C-c =: Field formulas. (line 24)
6639 * C-u C-c C-c: Updating the table. (line 19)
6640 * C-u C-c C-l: Handling links. (line 43)
6641 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
6642 * C-u C-c C-x C-s: Moving subtrees. (line 12)
6643 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
6644 * C-u C-c C-x C-u: Clocking work time. (line 70)
6645 * C-u C-u C-c *: Updating the table. (line 24)
6646 * C-u C-u C-c =: Editing and debugging formulas.
6648 * D: Agenda commands. (line 74)
6649 * d: Agenda commands. (line 71)
6650 * f: Agenda commands. (line 44)
6651 * g: Agenda commands. (line 78)
6652 * H: Agenda commands. (line 217)
6653 * i: Agenda commands. (line 198)
6654 * I: Agenda commands. (line 178)
6655 * l: Agenda commands. (line 57)
6656 * L: Agenda commands. (line 32)
6657 * M: Agenda commands. (line 204)
6658 * M-<down> <1>: Editing and debugging formulas.
6660 * M-<down>: Built-in table editor.
6662 * M-<left> <1>: Built-in table editor.
6664 * M-<left>: Structure editing. (line 21)
6665 * M-<RET> <1>: Plain lists. (line 42)
6666 * M-<RET>: Structure editing. (line 6)
6667 * M-<right> <1>: Built-in table editor.
6669 * M-<right>: Structure editing. (line 24)
6670 * M-<TAB> <1>: Completion. (line 10)
6671 * M-<TAB> <2>: Setting tags. (line 6)
6672 * M-<TAB> <3>: Per file keywords. (line 17)
6673 * M-<TAB>: Editing and debugging formulas.
6675 * M-<up> <1>: Editing and debugging formulas.
6677 * M-<up>: Built-in table editor.
6679 * M-S-<down> <1>: Built-in table editor.
6681 * M-S-<down> <2>: Plain lists. (line 59)
6682 * M-S-<down>: Structure editing. (line 36)
6683 * M-S-<left> <1>: The date/time prompt.
6685 * M-S-<left> <2>: Built-in table editor.
6687 * M-S-<left> <3>: Plain lists. (line 65)
6688 * M-S-<left>: Structure editing. (line 27)
6689 * M-S-<RET> <1>: Checkboxes. (line 53)
6690 * M-S-<RET> <2>: Plain lists. (line 52)
6691 * M-S-<RET>: Structure editing. (line 18)
6692 * M-S-<right> <1>: The date/time prompt.
6694 * M-S-<right> <2>: Built-in table editor.
6696 * M-S-<right> <3>: Plain lists. (line 65)
6697 * M-S-<right>: Structure editing. (line 30)
6698 * M-S-<up> <1>: Built-in table editor.
6700 * M-S-<up> <2>: Plain lists. (line 59)
6701 * M-S-<up>: Structure editing. (line 33)
6702 * mouse-1 <1>: Agenda commands. (line 35)
6703 * mouse-1 <2>: The date/time prompt.
6705 * mouse-1: Handling links. (line 72)
6706 * mouse-2 <1>: Agenda commands. (line 35)
6707 * mouse-2: Handling links. (line 72)
6708 * mouse-3 <1>: Agenda commands. (line 28)
6709 * mouse-3: Handling links. (line 77)
6710 * n: Agenda commands. (line 19)
6711 * O: Agenda commands. (line 180)
6712 * o: Agenda commands. (line 65)
6713 * P: Agenda commands. (line 142)
6714 * p: Agenda commands. (line 20)
6715 * q: Agenda commands. (line 227)
6716 * r <1>: Agenda commands. (line 82)
6717 * r: Global TODO list. (line 20)
6718 * S: Agenda commands. (line 208)
6719 * s: Agenda commands. (line 89)
6720 * S-<down> <1>: Agenda commands. (line 151)
6721 * S-<down> <2>: The date/time prompt.
6723 * S-<down> <3>: Creating timestamps. (line 58)
6724 * S-<down> <4>: Priorities. (line 25)
6725 * S-<down> <5>: Editing and debugging formulas.
6727 * S-<down>: Plain lists. (line 55)
6728 * S-<left> <1>: Agenda commands. (line 169)
6729 * S-<left> <2>: The date/time prompt.
6731 * S-<left> <3>: Creating timestamps. (line 53)
6732 * S-<left>: TODO basics. (line 20)
6733 * S-<RET>: Built-in table editor.
6735 * S-<right> <1>: Agenda commands. (line 161)
6736 * S-<right> <2>: The date/time prompt.
6738 * S-<right> <3>: Creating timestamps. (line 53)
6739 * S-<right>: TODO basics. (line 20)
6740 * S-<TAB> <1>: Built-in table editor.
6742 * S-<TAB>: Visibility cycling. (line 22)
6743 * S-<up> <1>: Agenda commands. (line 145)
6744 * S-<up> <2>: The date/time prompt.
6746 * S-<up> <3>: Creating timestamps. (line 58)
6747 * S-<up> <4>: Priorities. (line 25)
6748 * S-<up> <5>: Editing and debugging formulas.
6750 * S-<up>: Plain lists. (line 55)
6751 * T: Agenda commands. (line 126)
6752 * t: Agenda commands. (line 113)
6753 * w: Agenda commands. (line 68)
6754 * x: Agenda commands. (line 230)
6755 * X: Agenda commands. (line 183)
6761 Node: Introduction
\x7f11398
6762 Node: Summary
\x7f11813
6763 Node: Installation
\x7f14821
6764 Node: Activation
\x7f16199
6765 Node: Feedback
\x7f17448
6766 Node: Document structure
\x7f19524
6767 Node: Outlines
\x7f20298
6768 Node: Headlines
\x7f20958
6769 Node: Visibility cycling
\x7f21581
6770 Ref: Visibility cycling-Footnote-1
\x7f23795
6771 Ref: Visibility cycling-Footnote-2
\x7f23853
6772 Ref: Visibility cycling-Footnote-3
\x7f23903
6773 Node: Motion
\x7f24172
6774 Node: Structure editing
\x7f24956
6775 Node: Archiving
\x7f27782
6776 Node: ARCHIVE tag
\x7f28340
6777 Node: Moving subtrees
\x7f30133
6778 Node: Sparse trees
\x7f31444
6779 Ref: Sparse trees-Footnote-1
\x7f33576
6780 Ref: Sparse trees-Footnote-2
\x7f33758
6781 Node: Plain lists
\x7f33873
6782 Ref: Plain lists-Footnote-1
\x7f37398
6783 Ref: Plain lists-Footnote-2
\x7f37755
6784 Node: Tables
\x7f37939
6785 Node: Built-in table editor
\x7f38453
6786 Node: Narrow columns
\x7f45449
6787 Ref: Narrow columns-Footnote-1
\x7f47381
6788 Node: orgtbl-mode
\x7f47427
6789 Node: The spreadsheet
\x7f48231
6790 Node: References
\x7f49049
6791 Node: Formula syntax for Calc
\x7f52684
6792 Node: Formula syntax for Lisp
\x7f55001
6793 Node: Field formulas
\x7f56229
6794 Node: Column formulas
\x7f57540
6795 Node: Editing and debugging formulas
\x7f58963
6796 Node: Updating the table
\x7f62328
6797 Node: Advanced features
\x7f63359
6798 Node: Hyperlinks
\x7f67884
6799 Node: Link format
\x7f68657
6800 Node: Internal links
\x7f69950
6801 Ref: Internal links-Footnote-1
\x7f71875
6802 Node: Radio targets
\x7f72007
6803 Node: External links
\x7f72698
6804 Node: Handling links
\x7f75102
6805 Ref: Handling links-Footnote-1
\x7f80194
6806 Ref: Handling links-Footnote-2
\x7f80431
6807 Node: Link abbreviations
\x7f80505
6808 Node: Search options
\x7f82184
6809 Ref: Search options-Footnote-1
\x7f83964
6810 Node: Custom searches
\x7f84045
6811 Node: Remember
\x7f85093
6812 Node: Setting up remember
\x7f86080
6813 Node: Remember templates
\x7f86662
6814 Ref: Remember templates-Footnote-1
\x7f89977
6815 Node: Storing notes
\x7f90075
6816 Node: TODO items
\x7f91883
6817 Node: TODO basics
\x7f92865
6818 Node: TODO extensions
\x7f94392
6819 Node: Workflow states
\x7f95187
6820 Node: TODO types
\x7f96172
6821 Ref: TODO types-Footnote-1
\x7f97830
6822 Node: Per file keywords
\x7f97912
6823 Ref: Per file keywords-Footnote-1
\x7f99366
6824 Node: Priorities
\x7f99567
6825 Node: Breaking down tasks
\x7f100811
6826 Ref: Breaking down tasks-Footnote-1
\x7f101330
6827 Node: Checkboxes
\x7f101426
6828 Node: Timestamps
\x7f104181
6829 Node: Time stamps
\x7f104715
6830 Ref: Time stamps-Footnote-1
\x7f108209
6831 Ref: Time stamps-Footnote-2
\x7f108325
6832 Node: Creating timestamps
\x7f108480
6833 Node: The date/time prompt
\x7f111106
6834 Ref: The date/time prompt-Footnote-1
\x7f113067
6835 Node: Custom time format
\x7f113173
6836 Node: Repeating items
\x7f114731
6837 Node: Progress logging
\x7f116541
6838 Node: Closing items
\x7f117187
6839 Ref: Closing items-Footnote-1
\x7f118121
6840 Ref: Closing items-Footnote-2
\x7f118190
6841 Node: Tracking TODO state changes
\x7f118263
6842 Node: Clocking work time
\x7f119119
6843 Ref: Clocking work time-Footnote-1
\x7f122765
6844 Ref: Clocking work time-Footnote-2
\x7f122843
6845 Node: Tags
\x7f122969
6846 Node: Tag inheritance
\x7f123731
6847 Node: Setting tags
\x7f124668
6848 Ref: Setting tags-Footnote-1
\x7f129191
6849 Ref: Setting tags-Footnote-2
\x7f129303
6850 Node: Tag searches
\x7f129386
6851 Node: Agenda views
\x7f132097
6852 Node: Agenda files
\x7f134042
6853 Ref: Agenda files-Footnote-1
\x7f135008
6854 Ref: Agenda files-Footnote-2
\x7f135157
6855 Node: Agenda dispatcher
\x7f135350
6856 Node: Built-in agenda views
\x7f137041
6857 Node: Weekly/Daily agenda
\x7f137619
6858 Node: Global TODO list
\x7f139748
6859 Node: Matching headline tags
\x7f141921
6860 Node: Timeline
\x7f142992
6861 Node: Stuck projects
\x7f143658
6862 Node: Presentation and sorting
\x7f145357
6863 Node: Categories
\x7f146148
6864 Node: Time-of-day specifications
\x7f146812
6865 Node: Sorting of agenda items
\x7f148783
6866 Node: Agenda commands
\x7f150065
6867 Node: Custom agenda views
\x7f156718
6868 Node: Storing searches
\x7f157393
6869 Node: Block agenda
\x7f159305
6870 Node: Setting Options
\x7f160535
6871 Node: Batch processing
\x7f163247
6872 Node: Embedded LaTeX
\x7f164377
6873 Ref: Embedded LaTeX-Footnote-1
\x7f165469
6874 Node: Math symbols
\x7f165659
6875 Node: Subscripts and Superscripts
\x7f166424
6876 Node: LaTeX fragments
\x7f167268
6877 Ref: LaTeX fragments-Footnote-1
\x7f169376
6878 Node: Processing LaTeX fragments
\x7f169638
6879 Node: CDLaTeX mode
\x7f170584
6880 Ref: CDLaTeX mode-Footnote-1
\x7f173068
6881 Node: Exporting
\x7f173216
6882 Node: ASCII export
\x7f174530
6883 Node: HTML export
\x7f175820
6884 Node: Export commands
\x7f176439
6885 Node: Quoting HTML tags
\x7f177163
6886 Node: Links
\x7f177793
6887 Node: Images
\x7f178490
6888 Ref: Images-Footnote-1
\x7f179361
6889 Node: CSS support
\x7f179422
6890 Ref: CSS support-Footnote-1
\x7f180741
6891 Node: XOXO export
\x7f180854
6892 Node: iCalendar export
\x7f181293
6893 Node: Text interpretation
\x7f182512
6894 Node: Comment lines
\x7f182991
6895 Node: Enhancing text
\x7f183462
6896 Node: Export options
\x7f185280
6897 Node: Publishing
\x7f186977
6898 Ref: Publishing-Footnote-1
\x7f187773
6899 Node: Configuration
\x7f187969
6900 Node: Project alist
\x7f188687
6901 Node: Sources and destinations
\x7f189753
6902 Node: Selecting files
\x7f190483
6903 Node: Publishing action
\x7f191231
6904 Node: Publishing options
\x7f192464
6905 Node: Publishing links
\x7f194616
6906 Node: Project page index
\x7f196129
6907 Node: Sample configuration
\x7f196907
6908 Node: Simple example
\x7f197399
6909 Node: Complex example
\x7f198072
6910 Node: Triggering publication
\x7f200148
6911 Node: Miscellaneous
\x7f200833
6912 Node: Completion
\x7f201467
6913 Node: Customization
\x7f202938
6914 Node: In-buffer settings
\x7f203521
6915 Node: The very busy C-c C-c key
\x7f207761
6916 Node: Clean view
\x7f209405
6917 Node: TTY keys
\x7f211982
6918 Node: Interaction
\x7f213591
6919 Node: Cooperation
\x7f213988
6920 Node: Conflicts
\x7f216728
6921 Node: Bugs
\x7f218320
6922 Node: Extensions and Hacking
\x7f219816
6923 Node: Extensions
\x7f220412
6924 Node: Tables in arbitrary syntax
\x7f222359
6925 Node: Radio tables
\x7f223436
6926 Node: A LaTeX example
\x7f225939
6927 Ref: A LaTeX example-Footnote-1
\x7f229585
6928 Ref: A LaTeX example-Footnote-2
\x7f229733
6929 Node: Translator functions
\x7f230168
6930 Ref: Translator functions-Footnote-1
\x7f233277
6931 Node: Dynamic blocks
\x7f233365
6932 Node: Special agenda views
\x7f235337
6933 Ref: Special agenda views-Footnote-1
\x7f237616
6934 Node: History and Acknowledgments
\x7f237876
6935 Node: Index
\x7f243665
6936 Node: Key Index
\x7f274359