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.65).
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.65).
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.
122 * CamelCase links:: Activating CamelCase words as links
126 * Setting up remember:: Some code for .emacs to get things going
127 * Remember templates:: Define the outline of different note types
128 * Storing notes:: Directly get the note to where it belongs
132 * TODO basics:: Marking and displaying TODO entries
133 * TODO extensions:: Workflow and assignments
134 * Priorities:: Some things are more important than others
135 * Breaking down tasks:: Splitting a task into managable pieces
136 * Checkboxes:: Tick-off lists
138 Extended use of TODO keywords
140 * Workflow states:: From TODO to DONE in steps
141 * TODO types:: I do this, Fred the rest
142 * Per file keywords:: Different files, different requirements
146 * Time stamps:: Assigning a time to a tree entry
147 * Creating timestamps:: Commands which insert timestamps
148 * Custom time format:: If you cannot work with the ISO format
149 * Repeating items:: Deadlines that come back again and again
150 * Progress logging:: Documenting when what work was done.
154 * The date/time prompt:: How org-mode helps you entering date and time
158 * Closing items:: When was this entry marked DONE?
159 * Tracking TODO state changes:: When did the status change?
160 * Clocking work time:: When exactly did you work on this item?
164 * Tag inheritance:: Tags use the tree structure of the outline
165 * Setting tags:: How to assign tags to a headline
166 * Tag searches:: Searching for combinations of tags
170 * Agenda files:: Files being searched for agenda information
171 * Agenda dispatcher:: Keyboard access to agenda views
172 * Built-in agenda views:: What is available out of the box?
173 * Presentation and sorting:: How agenda items are prepared for display
174 * Agenda commands:: Remote editing of org trees
175 * Custom agenda views:: Defining special searches and views
177 The built-in agenda views
179 * Weekly/Daily agenda:: The calendar page with current tasks
180 * Global TODO list:: All unfinished action items
181 * Matching headline tags:: Structured information with fine-tuned search
182 * Timeline:: Time-sorted view for single file
183 * Stuck projects:: Find projects you need to review
185 Presentation and sorting
187 * Categories:: Not all tasks are equal
188 * Time-of-day specifications:: How the agenda knows the time
189 * Sorting of agenda items:: The order of things
193 * Storing searches:: Type once, use often
194 * Block agenda:: All the stuff you need in a single buffer
195 * Setting Options:: Changing the rules
196 * Batch processing:: Agenda views from the command line
200 * Math symbols:: TeX macros for symbols and Greek letters
201 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
202 * LaTeX fragments:: Complex formulas made easy
203 * Processing LaTeX fragments:: Previewing LaTeX processing
204 * CDLaTeX mode:: Speed up entering of formulas
208 * ASCII export:: Exporting to plain ASCII
209 * HTML export:: Exporting to HTML
210 * XOXO export:: Exporting to XOXO
211 * iCalendar export:: Exporting in iCalendar format
212 * Text interpretation:: How the exporter looks at the file
216 * Export commands:: How to invode HTML export
217 * Quoting HTML tags:: Using direct HTML in Org-mode
218 * Links:: How hyperlinks get transferred to HTML
219 * Images:: To inline or not to inline?
220 * CSS support:: Style specifications
222 Text interpretation by the exporter
224 * Comment lines:: Some lines will not be exported
225 * Enhancing text:: Subscripts, symbols and more
226 * Export options:: How to influence the export settings
230 * Configuration:: Defining projects
231 * Sample configuration:: Example projects
232 * Triggering publication:: Publication commands
236 * Project alist:: The central configuration variable
237 * Sources and destinations:: From here to there
238 * Selecting files:: What files are part of the project?
239 * Publishing action:: Setting the function doing the publishing
240 * Publishing options:: Tweaking HTML export
241 * Publishing links:: Which links keep working after publishing?
242 * Project page index:: Publishing a list of project files
246 * Simple example:: One-component publishing
247 * Complex example:: A multi-component publishing example
251 * Completion:: M-TAB knows what you need
252 * Customization:: Adapting Org-mode to your taste
253 * In-buffer settings:: Overview of the #+KEYWORDS
254 * The very busy C-c C-c key:: When in doubt, press C-c C-c
255 * Clean view:: Getting rid of leading stars in the outline
256 * TTY keys:: Using Org-mode on a tty
257 * Interaction:: Other Emacs packages
258 * Bugs:: Things which do not work perfectly
260 Interaction with other packages
262 * Cooperation:: Packages Org-mode cooperates with
263 * Conflicts:: Packages that lead to conflicts
265 Extensions, Hooks and Hacking
267 * Extensions:: Existing 3rd-part extensions
268 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
269 * Dynamic blocks:: Automatically filled blocks
270 * Special agenda views:: Customized views
272 Tables in arbitrary syntax
274 * Radio tables:: Sending and receiving
275 * A LaTeX example:: Step by step, almost a tutorial
276 * Translator functions:: Copy and modify
279 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
286 * Summary:: Brief summary of what Org-mode does
287 * Installation:: How to install a downloaded version of Org-mode
288 * Activation:: How to activate Org-mode for certain buffers.
289 * Feedback:: Bug reports, ideas, patches etc.
292 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
297 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
298 project planning with a fast and effective plain-text system.
300 Org-mode develops organizational tasks around NOTES files that
301 contain lists or information about projects as plain text. Org-mode is
302 implemented on top of outline-mode, which makes it possible to keep the
303 content of large files well structured. Visibility cycling and
304 structure editing help to work with the tree. Tables are easily created
305 with a built-in table editor. Org-mode supports ToDo items, deadlines,
306 time stamps, and scheduling. It dynamically compiles entries into an
307 agenda that utilizes and smoothly integrates much of the Emacs calendar
308 and diary. Plain text URL-like links connect to websites, emails,
309 Usenet messages, BBDB entries, and any files related to the projects.
310 For printing and sharing of notes, an Org-mode file can be exported as a
311 structured ASCII file, as HTML, or (todo and agenda items only) as an
312 iCalendar file. It can also serve as a publishing tool for a set of
315 An important design aspect that distinguishes Org-mode from for
316 example Planner/Muse is that it encourages to store every piece of
317 information only once. In Planner, you have project pages, day pages
318 and possibly other files, duplicating some information such as tasks.
319 In Org-mode, you only have notes files. In your notes you mark entries
320 as tasks, label them with tags and timestamps. All necessary lists
321 like a schedule for the day, the agenda for a meeting, tasks lists
322 selected by tags etc are created dynamically when you need them.
324 Org-mode keeps simple things simple. When first fired up, it should
325 feel like a straightforward, easy to use outliner. Complexity is not
326 imposed, but a large amount of functionality is available when you need
327 it. Org-mode can be used on different levels and in different ways, for
330 * outline extension with visibility cycling and structure editing
331 * ASCII system and table editor for taking structured notes
332 * ASCII table editor with spreadsheet-like capabilities
334 * full agenda and planner with deadlines and work scheduling
335 * environment to implement David Allen's GTD system
336 * simple hypertext system, with HTML export
337 * publishing tool to create a set of interlinked webpages
339 Org-mode's automatic, context sensitive table editor with spreadsheet
340 capabilities can be integrated into any major mode by activating the
341 minor Orgtbl-mode. Using a translation step, it can be used to maintain
342 tables in arbitray file types, for example in LaTeX.
344 There is a website for Org-mode which provides links to the newest
345 version of Org-mode, as well as additional information, frequently asked
346 questions (FAQ), links to tutorials etc. This page is located at
347 `http://www.astro.uva.nl/~dominik/Tools/org/'.
350 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
355 Important: If Org-mode is part of the Emacs distribution or an XEmacs
356 package, please skip this section and go directly to *Note Activation::.
358 If you have downloaded Org-mode from the Web, you must take the
359 following steps to install it: Go into the Org-mode distribution
360 directory and edit the top section of the file `Makefile'. You must
361 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
362 and the paths to the directories where local Lisp and Info files are
363 kept. If you don't have access to the system-wide directories, create
364 your own two directories for these files, enter them into the Makefile,
365 and make sure Emacs finds the Lisp files by adding the following line
368 (setq load-path (cons "~/path/to/lispdir" load-path))
370 XEmacs users now need to install the file `noutline.el' from the
371 `xemacs' subdirectory of the Org-mode distribution. Use the command:
373 make install-noutline
375 Now byte-compile and install the Lisp files with the shell commands:
380 If you want to install the info documentation, use this command:
384 Then add to `.emacs':
386 ;; This line only if org-mode is not part of the X/Emacs distribution.
387 (require 'org-install)
390 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
395 Add the following lines to your `.emacs' file. The last two lines
396 define _global_ keys for the commands `org-store-link' and `org-agenda'
397 - please choose suitable keys yourself.
399 ;; The following lines are always needed. Choose your own keys.
400 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
401 (define-key global-map "\C-cl" 'org-store-link)
402 (define-key global-map "\C-ca" 'org-agenda)
404 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
405 because significant functionality depends on font-locking being active.
406 You can do this with either one of the following two lines (XEmacs
407 user must use the second option):
408 (global-font-lock-mode 1) ; for all buffers
409 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
411 With this setup, all files with extension `.org' will be put into
412 Org-mode. As an alternative, make the first line of a file look like
415 MY PROJECTS -*- mode: org; -*-
417 which will select Org-mode for this buffer no matter what the file's
418 name is. See also the variable `org-insert-mode-line-in-empty-file'.
421 File: org, Node: Feedback, Prev: Activation, Up: Introduction
426 If you find problems with Org-mode, or if you have questions, remarks,
427 or ideas about it, please contact the maintainer Carsten Dominik at
428 <dominik at science dot uva dot nl>.
430 For bug reports, please provide as much information as possible,
431 including the version information of Emacs (`C-h v emacs-version
432 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
433 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
434 can be very useful (see below on how to create one). Often a small
435 example file helps, along with clear information about:
437 1. What exactly did you do?
439 2. What did you expect to happen?
441 3. What happened instead?
442 Thank you for helping to improve this mode.
444 How to create a useful backtrace
445 ................................
447 If working with Org-mode produces an error with a message you don't
448 understand, you may have hit a bug. The best way to report this is by
449 providing, in addition to what was mentioned above, a _Backtrace_.
450 This is information from the built-in debugger about where and how the
451 error occurred. Here is how to produce a useful backtrace:
453 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
454 original Lisp code in `org.el' instead of the compiled version in
455 `org.elc'. The backtrace contains much more information if it is
456 produced with uncompiled code. To do this, either rename `org.elc'
457 to something else before starting Emacs, or ask Emacs explicitly
458 to load `org.el' by using the command line
459 emacs -l /path/to/org.el
461 2. Go to the `Options' menu and select `Enter Debugger on Error'
462 (XEmacs has this option in the `Troubleshooting' sub-menu).
464 3. Do whatever you have to do to hit the error. Don't forget to
465 document the steps you take.
467 4. When you hit the error, a `*Backtrace*' buffer will appear on the
468 screen. Save this buffer to a file (for example using `C-x C-w')
469 and attach it to your bug report.
472 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
477 Org-mode is based on outline mode and provides flexible commands to
478 edit the structure of the document.
482 * Outlines:: Org-mode is based on outline-mode
483 * Headlines:: How to typeset org-tree headlines
484 * Visibility cycling:: Show and hide, much simplified
485 * Motion:: Jumping to other headlines
486 * Structure editing:: Changing sequence and level of headlines
487 * Archiving:: Move done task trees to a different place
488 * Sparse trees:: Matches embedded in context
489 * Plain lists:: Additional structure within an entry
492 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
497 Org-mode is implemented on top of outline-mode. Outlines allow to
498 organize a document in a hierarchical structure, which (at least for
499 me) is the best representation of notes and thoughts. Overview over
500 this structure is achieved by folding (hiding) large parts of the
501 document to show only the general document structure and the parts
502 currently being worked on. Org-mode greatly simplifies the use of
503 outlines by compressing the entire show/hide functionality into a
504 single command `org-cycle', which is bound to the <TAB> key.
507 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
512 Headlines define the structure of an outline tree. The headlines in
513 Org-mode start with one or more stars, on the left margin. For example:
521 * Another top level headline
523 Some people find the many stars too noisy and would prefer an outline
524 that has whitespace followed by a single star as headline starters.
525 *Note Clean view:: describes a setup to realize this.
528 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
530 2.3 Visibility cycling
531 ======================
533 Outlines make it possible to hide parts of the text in the buffer.
534 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
535 the visibility in the buffer.
538 _Subtree cycling_: Rotate current subtree between the states
540 ,-> FOLDED -> CHILDREN -> SUBTREE --.
541 '-----------------------------------'
543 The cursor must be on a headline for this to work(1). When the
544 cursor is at the beginning of the buffer and the first line is not
545 a headline, then <TAB> actually runs global cycling (see
546 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
547 global cycling is invoked.
551 _Global cycling_: Rotate the entire buffer between the states
553 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
554 '--------------------------------------'
556 Note that inside tables, `S-<TAB>' jumps to the previous field.
562 Reveal context around point, showing the current entry, the
563 following heading and the hierarchy above. Useful for working
564 near a location exposed by a sparse tree command (*note Sparse
565 trees::) or an agenda command (*note Agenda commands::). With
566 prefix arg show, on each level, all sibling headings.
569 Show the current subtree in an indirect buffer(3). With numerical
570 prefix ARG, go up to this level and then take that tree. If ARG
571 is negative, go up that many levels. With `C-u' prefix, do not
572 remove the previously used indirect buffer.
574 When Emacs first visits an Org-mode file, the global state is set to
575 OVERVIEW, i.e. only the top level headlines are visible. This can be
576 configured through the variable `org-startup-folded', or on a per-file
577 basis by adding one of the following lines anywhere in the buffer:
583 ---------- Footnotes ----------
585 (1) see, however, the option `org-cycle-emulate-tab'.
587 (2) see the option `org-cycle-global-at-bob'.
589 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
590 Buffers.) will contain the entire buffer, but will be narrowed to the
591 current tree. Editing the indirect buffer will also change the
592 original buffer, but without affecting visibility in that buffer.
595 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
600 The following commands jump to other headlines in the buffer.
609 Next heading same level.
612 Previous heading same level.
615 Backward to higher level heading.
618 Jump to a different place without changing the current outline
619 visibility. Shows the document structure in a temporary buffer,
620 where you can use visibility cycling (<TAB>) to find your
621 destination. After pressing <RET>, the cursor moves to the
622 selected location in the original buffer, and the headings
623 hierarchy above it is made visible.
626 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
628 2.5 Structure editing
629 =====================
632 Insert new heading with same level as current. If the cursor is
633 in a plain list item, a new item is created (*note Plain lists::).
634 To force creation of a new headline, use a prefix arg, or first
635 press <RET> to get to the beginning of the next line. When this
636 command is used in the middle of a line, the line is split and the
637 rest of the line becomes the new headline. If the command is used
638 at the beginning of a headline, the new headline is created before
639 the current line. If at the beginning of any other line, the
640 content of that line is made the new heading. If the command is
641 used at the end of a folded subtree (i.e. behind the ellipses at
642 the end of a headline), then a headline like the current one will
643 be inserted after the end of the subtree.
646 Insert new TODO entry with same level as current heading.
649 Promote current heading by one level.
652 Demote current heading by one level.
655 Promote the current subtree by one level.
658 Demote the current subtree by one level.
661 Move subtree up (swap with previous subtree of same level).
664 Move subtree down (swap with next subtree of same level).
668 Kill subtree, i.e. remove it from buffer but save in kill ring.
671 Copy subtree to kill ring.
674 Yank subtree from kill ring. This does modify the level of the
675 subtree to make sure the tree fits in nicely at the yank position.
676 The yank level can also be specified with a prefix arg, or by
677 yanking after a headline marker like `****'.
680 Sort same-level entries. When there is an active region, all
681 entries in the region will be sorted. Otherwise the children of
682 the current headline are sorted. The command prompts for the
683 sorting method, which can be alphabetically, numerically, by time
684 (using the first time stamp in each entry), and each of these in
685 reverse order. With a `C-u' prefix, sorting will be
686 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
687 will also be removed.
689 When there is an active region (transient-mark-mode), promotion and
690 demotion work on all headlines in the region. To select a region of
691 headlines, it is best to place both point and mark at the beginning of a
692 line, mark at the beginning of the first headline, and point at the line
693 just after the last headline to change. Note that when the cursor is
694 inside a table (*note Tables::), the Meta-Cursor keys have different
698 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
703 When a project represented by a (sub)tree is finished, you may want to
704 move the tree out of the way and to stop it from contributing to the
705 agenda. Org-mode knows two ways of archiving. You can mark a tree with
706 the ARCHIVE tag, or you can move an entire (sub)tree to a different
711 * ARCHIVE tag:: Marking a tree as inactive
712 * Moving subtrees:: Moving a tree to an archive file
715 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
717 2.6.1 The ARCHIVE tag
718 ---------------------
720 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
721 its location in the outline tree, but behaves in the following way:
722 - It does not open when you attempt to do so with a visibility
723 cycling command (*note Visibility cycling::). You can force
724 cycling archived subtrees with `C-<TAB>', or by setting the option
725 `org-cycle-open-archived-trees'. Also normal outline commands like
726 `show-all' will open archived subtrees.
728 - During sparse tree construction (*note Sparse trees::), matches in
729 archived subtrees are not exposed, unless you configure the option
730 `org-sparse-tree-open-archived-trees'.
732 - During agenda view construction (*note Agenda views::), the
733 content of archived trees is ignored unless you configure the
734 option `org-agenda-skip-archived-trees'.
736 - Archived trees are not exported (*note Exporting::), only the
737 headline is. Configure the details using the variable
738 `org-export-with-archived-trees'.
740 The following commands help managing the ARCHIVE tag:
743 Toggle the ARCHIVE tag for the current headline. When the tag is
744 set, the headline changes to a shadowish face, and the subtree
748 Check if any direct children of the current headline should be
749 archived. To do this, each subtree is checked for open TODO
750 entries. If none are found, the command offers to set the ARCHIVE
751 tag for the child. If the cursor is _not_ on a headline when this
752 command is invoked, the level 1 trees will be checked.
755 Cycle a tree even if it is tagged with ARCHIVE.
758 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
760 2.6.2 Moving subtrees
761 ---------------------
763 Once an entire project is finished, you may want to move it to a
764 different location, either in the current file, or even in a different
765 file, the archive file.
768 Archive the subtree starting at the cursor position to the location
769 given by `org-archive-location'.
772 Check if any direct children of the current headline could be
773 moved to the archive. To do this, each subtree is checked for
774 open TODO entries. If none are found, the command offers to move
775 it to the archive location. If the cursor is _not_ on a headline
776 when this command is invoked, the level 1 trees will be checked.
778 The default archive location is a file in the same directory as the
779 current file, with the name derived by appending `_archive' to the
780 current file name. For information and examples on how to change this,
781 see the documentation string of the variable `org-archive-location'.
782 There is also an in-buffer option for setting this variable, for example
786 You may have several such lines in the buffer, they will then be valid
787 for the entries following the line (the first will also apply to any
791 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
796 An important feature of Org-mode is the ability to construct _sparse
797 trees_ for selected information in an outline tree. A sparse tree
798 means that the entire document is folded as much as possible, but the
799 selected information is made visible along with the headline structure
800 above it(1). Just try it out and you will see immediately how it works.
802 Org-mode contains several commands creating such trees. The most
803 basic one is `org-occur':
806 Occur. Prompts for a regexp and shows a sparse tree with all
807 matches. If the match is in a headline, the headline is made
808 visible. If the match is in the body of an entry, headline and
809 body are made visible. In order to provide minimal context, also
810 the full hierarchy of headlines above the match is shown, as well
811 as the headline following the match. Each match is also
812 highlighted; the highlights disappear when the buffer is changes
813 an editing command, or by pressing `C-c C-c'. When called with a
814 `C-u' prefix argument, previous highlights are kept, so several
815 calls to this command can be stacked.
816 For frequently used sparse trees of specific search strings, you can
817 use the variable `org-agenda-custom-commands' to define fast keyboard
818 access to specific sparse trees. These commands will then be
819 accessible through the agenda dispatcher (*note Agenda dispatcher::).
822 (setq org-agenda-custom-commands
823 '(("f" occur-tree "FIXME")))
825 will define the key `C-c a f' as a shortcut for creating a sparse tree
826 matching the string `FIXME'.
828 Other commands use sparse trees as well. For example `C-c C-v'
829 creates a sparse TODO tree (*note TODO basics::).
831 To print a sparse tree, you can use the Emacs command
832 `ps-print-buffer-with-faces' which does not print invisible parts of
833 the document (2). Or you can use the command `C-c C-e v' to export
834 only the visible part of the document and print the resulting file.
836 ---------- Footnotes ----------
838 (1) See also the variables `org-show-hierarchy-above',
839 `org-show-following-heading', and `org-show-siblings' for detailed
840 control on how much context is shown around each match.
842 (2) This does not work under XEmacs, because XEmacs uses selective
843 display for outlining, not text properties.
846 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
851 Within an entry of the outline tree, hand-formatted lists can provide
852 additional structure. They also provide a way to create lists of
853 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
854 and the HTML exporter (*note Exporting::) does parse and format them.
856 Org-mode knows ordered and unordered lists. Unordered list items
857 start with `-', `+', or `*'(1) as bullets. Ordered list items start
858 with `1.' or `1)'. Items belonging to the same list must have the same
859 indentation on the first line. In particular, if an ordered list
860 reaches number `10.', then the 2-digit numbers must be written
861 left-aligned with the other numbers in the list. Indentation also
862 determines the end of a list item. It ends before the next line that
863 is indented like the bullet/number, or less. For example:
866 My favorite scenes are (in this order)
867 1. The attack of the Rohirrim
868 2. Eowyns fight with the witch king
869 + this was already my favorite scene in the book
870 + I really like Miranda Otto.
871 3. Peter Jackson being shot by Legolas
873 He makes a really funny face when it happens.
874 But in the end, not individual scenes matter but the film as a whole.
876 Org-mode supports these lists by tuning filling and wrapping
877 commands to deal with them correctly(2).
879 The following commands act on items when the cursor is in the first
880 line of an item (the line with the bullet or number).
883 Items can be folded just like headline levels if you set the
884 variable `org-cycle-include-plain-lists'. The level of an item is
885 then given by the indentation of the bullet/number. Items are
886 always subordinate to real headlines, however; the hierarchies
887 remain completely separated.
890 Insert new item at current level. With prefix arg, force a new
891 heading (*note Structure editing::). If this command is used in
892 the middle of a line, the line is _split_ and the rest of the line
893 becomes the new item. If this command is executed in the
894 _whitespace before a bullet or number_, the new item is created
895 _before_ the current item. If the command is executed in the
896 white space before the text that is part of an item but does not
897 contain the bullet, a bullet is added to the current line.
900 Insert a new item with a checkbox (*note Checkboxes::).
904 Jump to the previous/next item in the current list.
908 Move the item including subitems up/down (swap with previous/next
909 item of same indentation). If the list is ordered, renumbering is
914 Decrease/increase the indentation of the item, including subitems.
915 Initially, the item tree is selected based on current indentation.
916 When these commands are executed several times in direct
917 succession, the initially selected region is used, even if the new
918 indentation would imply a different hierarchy. To use the new
919 hierarchy, break the command chain with a cursor motion or so.
922 If there is a checkbox (*note Checkboxes::) in the item line,
923 toggle the state of the checkbox. Otherwise, if this is an
924 ordered list, renumber the ordered list at the cursor.
926 ---------- Footnotes ----------
928 (1) When using `*' as a bullet, lines must be indented or they will
929 be seen as top-level headlines. Also, when you are hiding leading
930 stars to get a clean outline view, plain list items starting with a
931 star are visually indistinguishable from true headlines. In short:
932 even though `*' is supported, it may be better not to use it for plain
935 (2) Org-mode only changes the filling settings for Emacs. For
936 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
941 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
946 Org-mode has a very fast and intuitive table editor built-in.
947 Spreadsheet-like calculations are supported in connection with the
948 Emacs `calc' package.
952 * Built-in table editor:: Simple tables
953 * Narrow columns:: Stop wasting space in tables
954 * orgtbl-mode:: The table editor as minor mode
955 * The spreadsheet:: The table editor has spreadsheet capabilities.
958 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
960 3.1 The built-in table editor
961 =============================
963 Org-mode makes it easy to format tables in plain ASCII. Any line with
964 `|' as the first non-white character is considered part of a table.
965 `|' is also the column separator. A table might look like this:
967 | Name | Phone | Age |
968 |-------+-------+-----|
969 | Peter | 1234 | 17 |
972 A table is re-aligned automatically each time you press <TAB> or
973 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
974 field (<RET> to the next row) and creates new table rows at the end of
975 the table or before horizontal lines. The indentation of the table is
976 set by the first line. Any line starting with `|-' is considered as a
977 horizontal separator line and will be expanded on the next re-align to
978 span the whole table width. So, to create the above table, you would
984 and then press <TAB> to align the table and start filling in fields.
986 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
987 and all character keys in a special way, so that inserting and deleting
988 avoids shifting other fields. Also, when typing _immediately after the
989 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
990 the field is automatically made blank. If this behavior is too
991 unpredictable for you, configure the variables
992 `org-enable-table-editor' and `org-table-auto-blank-field'.
994 Creation and conversion
995 .......................
998 Convert the active region to table. If every line contains at
999 least one TAB character, the function assumes that the material is
1000 tab separated. If not, lines are split at whitespace into fields.
1001 You can use a prefix argument to indicate the minimum number of
1002 consecutive spaces required to identify a field separator
1003 (default: just one).
1004 If there is no active region, this command creates an empty
1005 Org-mode table. But it's easier just to start typing, like
1006 `|Name|Phone|Age <RET> |- <TAB>'.
1008 Re-aligning and field motion
1009 ............................
1012 Re-align the table without moving the cursor.
1015 Re-align the table, move to the next field. Creates a new row if
1019 Re-align, move to previous field.
1022 Re-align the table and move down to next row. Creates a new row if
1023 necessary. At the beginning or end of a line, <RET> still does
1024 NEWLINE, so it can be used to split a table.
1026 Column and row editing
1027 ......................
1031 Move the current column left/right.
1034 Kill the current column.
1037 Insert a new column to the left of the cursor position.
1041 Move the current row up/down.
1044 Kill the current row or horizontal line.
1047 Insert a new row above (with arg: below) the current row.
1050 Insert a horizontal line below current row. With prefix arg, the
1051 line is created above the current line.
1054 Sort the table lines in the region. The position of point
1055 indicates the column to be used for sorting, and the range of
1056 lines is the range between the nearest horizontal separator lines,
1057 or the entire table. If point is before the first column, you
1058 will be prompted for the sorting column. If there is an active
1059 region, the mark specifies the first line and the sorting column,
1060 while point should be in the last line to be included into the
1061 sorting. The command prompts for the sorting type
1062 (alphabetically, numerically, or by time). When called with a
1063 prefix argument, alphabetic sorting will be case-sensitive.
1069 Copy a rectangular region from a table to a special clipboard.
1070 Point and mark determine edge fields of the rectangle. The
1071 process ignores horizontal separator lines.
1074 Copy a rectangular region from a table to a special clipboard, and
1075 blank all fields in the rectangle. So this is the "cut" operation.
1078 Paste a rectangular region into a table. The upper right corner
1079 ends up in the current field. All involved fields will be
1080 overwritten. If the rectangle does not fit into the present table,
1081 the table is enlarged as needed. The process ignores horizontal
1085 Wrap several fields in a column like a paragraph. If there is an
1086 active region, and both point and mark are in the same column, the
1087 text in the column is wrapped to minimum width for the given
1088 number of lines. A prefix ARG may be used to change the number of
1089 desired lines. If there is no region, the current field is split
1090 at the cursor position and the text fragment to the right of the
1091 cursor is prepended to the field one line down. If there is no
1092 region, but you specify a prefix ARG, the current field is made
1093 blank, and the content is appended to the field above.
1099 Sum the numbers in the current column, or in the rectangle defined
1100 by the active region. The result is shown in the echo area and can
1101 be inserted with `C-y'.
1104 When current field is empty, copy from first non-empty field above.
1105 When not empty, copy current field down to next row and move cursor
1106 along with it. Depending on the variable
1107 `org-table-copy-increment', integer field values will be
1108 incremented during copy. This key is also used by CUA-mode (*note
1115 Edit the current field in a separate window. This is useful for
1116 fields that are not fully visible (*note Narrow columns::). When
1117 called with a `C-u' prefix, just make the full field visible, so
1118 that it can be edited in place.
1121 This is an alias for `C-u C-c `' to make the current field fully
1124 `M-x org-table-import'
1125 Import a file as a table. The table should be TAB- or whitespace
1126 separated. Useful, for example, to import an Excel table or data
1127 from a database, because these programs generally can write
1128 TAB-separated text files. This command works by inserting the
1129 file into the buffer and then converting the region to a table.
1130 Any prefix argument is passed on to the converter, which uses it
1131 to determine the separator.
1133 `M-x org-table-export'
1134 Export the table as a TAB-separated file. Useful for data
1135 exchange with, for example, Excel or database programs.
1138 If you don't like the automatic table editor because it gets in your
1139 way on lines which you would like to start with `|', you can turn it
1142 (setq org-enable-table-editor nil)
1144 Then the only table command that still works is `C-c C-c' to do a
1148 File: org, Node: Narrow columns, Next: orgtbl-mode, Prev: Built-in table editor, Up: Tables
1153 The width of columns is automatically determined by the table editor.
1154 Sometimes a single field or a few fields need to carry more text,
1155 leading to inconveniently wide columns. To limit(1) the width of a
1156 column, one field anywhere in the column may contain just the string
1157 `<N>' where `N' is an integer specifying the width of the column in
1158 characters. The next re-align will then set the width of this column
1159 to no more than this value.
1161 |---+------------------------------| |---+--------|
1163 | 1 | one | | 1 | one |
1164 | 2 | two | ----\ | 2 | two |
1165 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1166 | 4 | four | | 4 | four |
1167 |---+------------------------------| |---+--------|
1169 Fields that are wider become clipped and end in the string `=>'. Note
1170 that the full text is still in the buffer, it is only invisible. To
1171 see the full text, hold the mouse over the field - a tooltip window
1172 will show the full content. To edit such a field, use the command `C-c
1173 `' (that is `C-c' followed by the backquote). This will open a new
1174 window with the full field. Edit it and finish with `C-c C-c'.
1176 When visiting a file containing a table with narrowed columns, the
1177 necessary character hiding has not yet happened, and the table needs to
1178 be aligned before it looks nice. Setting the option
1179 `org-startup-align-all-tables' will realign all tables in a file upon
1180 visiting, but also slow down startup. You can also set this option on
1181 a per-file basis with:
1186 ---------- Footnotes ----------
1188 (1) This feature does not work on XEmacs.
1191 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Narrow columns, Up: Tables
1193 3.3 The Orgtbl minor mode
1194 =========================
1196 If you like the intuitive way the Org-mode table editor works, you
1197 might also want to use it in other modes like text-mode or mail-mode.
1198 The minor mode Orgtbl-mode makes this possible. You can always toggle
1199 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1202 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1204 Furthermore, with some special setup, it is possible to maintain
1205 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1206 possible to construct LaTeX tables with the underlying ease and power of
1207 Orgtbl-mode, including spreadsheet capabulities. For details, see
1208 *Note Tables in arbitrary syntax::.
1211 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1216 The table editor makes use of the Emacs `calc' package to implement
1217 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1218 derive fields from other fields.
1222 * References:: How to refer to another field or range
1223 * Formula syntax for Calc:: Using Calc to compute stuff
1224 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1225 * Field formulas:: Formulas valid for a single field
1226 * Column formulas:: Formulas valid for an entire column
1227 * Editing and debugging formulas:: Fixing formulas
1228 * Updating the table:: Recomputing all dependent fields
1229 * Advanced features:: Field names, parameters and automatic recalc
1232 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1237 To compute fields in the table from other fields, formulas must
1238 reference other fields or ranges. In Org-mode, fields can be referenced
1239 by name, by absolute coordinates, and by relative coordinates. To find
1240 out what the coordinates of a field are, press `C-c ?' in that field.
1245 Formulas can reference the value of another field with the operator
1248 Column references can be absolute like `1', `2',...`N', or relative
1249 to the current column like `+1' or `-2'.
1251 The row specification only counts data lines and ignores horizontal
1252 separator lines (hlines). You can use absolute row numbers `1'...`N',
1253 and row numbers relative to the current row like `+3' or `-1'. Or
1254 specify the row relative to one of the hlines: `I' refers to the first
1255 hline, `II' to the second etc. `-I' refers to the first such line
1256 above the current line, `+I' to the first such line below the current
1257 line. You can also write `III+2' which is the second data line after
1258 the third hline in the table. Relative row numbers like `-3' will not
1259 cross hlines if the current line is too close to the hline. Instead,
1260 the value directly at the hline is used.
1262 `0' refers to the current row and column. Also, if you omit either
1263 the column or the row part of the reference, the current row/column is
1264 implied. Here are a few examples:
1266 @2$3 2nd row, 3rd column
1267 $5 column 5 in the current row
1268 @2 current column, row 2
1269 @-1$-3 the field one row up, three columns to the left
1270 @-I$2 field just under hline above current row, column 2
1275 You may reference a rectangular range of fields by specifying two field
1276 references connected by two dots `..'. If both fields are in the
1277 current row, you may simply use `$2..$7', but if at least one field is
1278 in a different row, you need to use the general `@row$column' format at
1279 least for the first field (i.e the reference must start with `@' in
1280 order to be interpreted correctly). Examples:
1282 $1..$3 First three fields in the current row.
1283 $P..$Q Range, using column names (see under Advanced)
1284 @2$1..@4$3 6 fields between these two fields.
1285 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1287 Range references return a vector of values that can be fed into Calc
1288 vector functions. Empty fields in ranges are normally suppressed, so
1289 that the vector contains only the non-empty fields (but see the `E'
1290 mode switch below). If there are no non-empty fields, `[0]' is
1291 returned to avoid syntax errors in formulas.
1296 `$name' is interpreted as the name of a column, parameter or constant.
1297 Constants are defined globally through the variable
1298 `org-table-formula-constants'. If you have the `constants.el' package,
1299 it will also be used to resolve constants, including natural constants
1300 like `$h' for Planck's constant, and units like `$km' for kilometers.
1301 Column names and parameters can be specified in special table lines.
1302 These are described below, see *Note Advanced features::.
1305 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1307 3.4.2 Formula syntax for Calc
1308 -----------------------------
1310 A formula can be any algebraic expression understood by the Emacs
1311 `Calc' package. Note that `calc' has the slightly non-standard
1312 convention that `/' has lower precedence than `*', so that `a/b*c' is
1313 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1314 calc-eval: (calc)Calling Calc from Your Programs.), variable
1315 substitution takes place according to the rules described above. The
1316 range vectors can be directly fed into the calc vector functions like
1319 A formula can contain an optional mode string after a semicolon.
1320 This string consists of flags to influence Calc and other modes during
1321 execution. By default, Org-mode uses the standard calc modes (precision
1322 12, angular units degrees, fraction and symbolic modes off. The display
1323 format, however, has been changed to `(float 5)' to keep tables
1324 compact. The default settings can be configured using the variable
1325 `org-calc-default-modes'.
1327 p20 switch the internal precision to 20 digits
1328 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1329 D R angle modes: degrees, radians
1330 F S fraction and symbolic modes
1331 N interpret all fields as numbers, use 0 for non-numbers
1332 T force text interpretation
1333 E keep empty fields in ranges
1335 In addition, you may provide a `printf' format specifier to reformat
1336 the final result. A few examples:
1338 $1+$2 Sum of first and second field
1339 $1+$2;%.2f Same, format result to two decimals
1340 exp($2)+exp($1) Math functions can be used
1341 $;%.1f Reformat current cell to 1 decimal
1342 ($3-32)*5/9 Degrees F -> C conversion
1343 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1344 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1345 sin($1);Dp3%.1e Same, but use printf specifier for display
1346 vmean($2..$7) Compute column range mean, using vector function
1347 vmean($2..$7);EN Same, but treat empty fields as 0
1348 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1351 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1353 3.4.3 Emacs Lisp forms as formulas
1354 ----------------------------------
1356 It is also possible to write a formula in Emacs Lisp; this can be useful
1357 for string manipulation and control structures. If a formula starts
1358 with a single quote followed by an opening parenthesis, then it is
1359 evaluated as a lisp form. The evaluation should return either a string
1360 or a number. Just as with `calc' formulas, you can specify modes and a
1361 printf format after a semicolon. A reference will be replaced with a
1362 string (in double quotes) containing the field. If you provide the `N'
1363 mode switch, all referenced elements will be numbers. Ranges are
1364 inserted as space-separated fields, so you can embed them in list or
1365 vector syntax. A few examples, note how the `N' mode is used when we
1366 do computations in lisp.
1368 Swap the first two characters of the content of column 1
1369 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1370 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1372 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1373 '(apply '+ '($1..$4));N
1376 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1378 3.4.4 Field formulas
1379 --------------------
1381 To assign a formula to a particular field, type it directly into the
1382 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1383 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1384 will be stored as the formula for this field, evaluated, and the
1385 current field replaced with the result.
1387 Formulas are stored in a special line starting with `#+TBLFM:'
1388 directly below the table. If you typed the equation in the 4th field of
1389 the 3rd data line in the table, the formula will look like
1390 `@3$2=$1+$2'. When inserting/deleting/swapping column and rows with
1391 the appropriate commands, absolute references (but not relative ones)
1392 in stored formulas are modified in order to still reference the same
1393 field. Of cause this is not true if you edit the table structure with
1394 normal editing commands - then you must go and fix equations yourself.
1396 Instead of typing an equation into the field, you may also use the
1400 Install a new formula for the current field. The command prompts
1401 for a formula, with default taken from the `#+TBLFM:' line, applies
1402 it to the current field and stores it.
1405 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1407 3.4.5 Column formulas
1408 ---------------------
1410 Often in a table, the same formula should be used for all fields in a
1411 particular column. Instead of having to copy the formula to all fields
1412 in that column, org-mode allows to assign a single formula to an entire
1415 To assign a formula to a column, type it directly into any field in
1416 the column, preceded by an equal sign, like `=$1+$2'. When you press
1417 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1418 formula will be stored as the formula for the current column, evaluated
1419 and the current field replaced with the result. If the field contains
1420 only `=', the previously stored formula for this column is used. For
1421 each column, Org-mode will only remember the most recently used
1422 formula. In the `TBLFM:' line, column formulas will look like
1425 Instead of typing an equation into the field, you may also use the
1429 Install a new formula for the current column and replace current
1430 field with the result of the formula. The command prompts for a
1431 formula, with default taken from the `#+TBLFM' line, applies it to
1432 the current field and stores it. With a numerical prefix (e.g.
1433 `C-5 C-c =') will apply it to that many consecutive fields in the
1437 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1439 3.4.6 Editing and Debugging formulas
1440 ------------------------------------
1442 You can edit individual formulas in the minibuffer or directly in the
1443 field. Org-mode can also prepare a special buffer with all active
1444 formulas of a table.
1448 Edit the formula associated with the current column/field in the
1449 minibuffer. See *Note Column formulas:: and *Note Field
1453 Re-insert the active formula (either a field formula, or a column
1454 formula) into the current field, so that you can edit it directly
1455 in the field. The advantage over editing in the minibuffer is
1456 that you can use the command `C-c ?'.
1459 While editing a formula in a table field, highlight the field(s)
1460 referenced by the reference at the cursor position in the formula.
1463 Edit all formulas for the current table in a special buffer, where
1464 the formulas will be displayed one per line. While inside the
1465 special buffer, Org-mode will automatically highlight any field or
1466 range reference at the cursor position. You may edit, remove and
1467 add formulas, and use the following commands:
1469 Exit the buffer and store the modified formulas. With `C-u'
1470 prefix, also apply the new formulas to the entire table.
1473 Exit the buffer without installing changes.
1476 Pretty-print or indent lisp formula at point. When in a line
1477 containing a lisp formula, format the formula according to
1478 Emacs Lisp rules. Another <TAB> collapses the formula back
1479 again. In the open formula, <TAB> re-indents just like in
1483 Complete Lisp symbols, just like in Emacs-lisp-mode.
1486 Move the reference line in the Org-mode buffer up and down.
1487 This is important for highlighting the references of column
1488 formulas for different rows.
1491 Scroll the window displaying the table.
1493 Making a table field blank does not remove the formula associated
1494 with the field, because that is stored in a different line (the `TBLFM'
1495 line) - during the next recalculation the field will be filled again.
1496 To remove a formula from a field, you have to give an empty reply when
1497 prompted for the formula, or to edit the `#+TBLFM' line.
1499 You may edit the `#+TBLFM' directly and re-apply the changed
1500 equations with `C-c C-c' in that line, or with the normal recalculation
1501 commands in the table.
1506 When the evaluation of a formula leads to an error, the field content
1507 becomes the string `#ERROR'. If you would like see what is going on
1508 during variable substitution and calculation in order to find a bug,
1509 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1510 for example by pressing `C-c = <RET>' in a field. Detailed information
1514 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1516 3.4.7 Updating the Table
1517 ------------------------
1519 Recalculation of a table is normally not automatic, but needs to be
1520 triggered by a command. See *Note Advanced features:: for a way to make
1521 recalculation at least semi-automatically.
1523 In order to recalculate a line of a table or the entire table, use
1524 the following commands:
1527 Recalculate the current row by first applying the stored column
1528 formulas from left to right, and all field formulas in the current
1533 Recompute the entire table, line by line. Any lines before the
1534 first hline are left alone, assuming that these are part of the
1538 Iterate the table by recomputing it until no further changes occur.
1539 This may be necessary if some computed fields use the value of
1540 other fields that are computed later in the calculation sequence.
1543 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1545 3.4.8 Advanced features
1546 -----------------------
1548 If you want the recalculation of fields to happen automatically, or if
1549 you want to be able to assign names to fields and columns, you need to
1550 reserve the first column of the table for special marking characters.
1552 Rotate the calculation mark in first column through the states `',
1553 `#', `*', `!', `$'. The meaning of these characters is discussed
1554 below. When there is an active region, change all marks in the
1557 Here is an example of a table that collects exam results of students
1558 and makes use of these features:
1560 |---+---------+--------+--------+--------+-------+------|
1561 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1562 |---+---------+--------+--------+--------+-------+------|
1563 | ! | | P1 | P2 | P3 | Tot | |
1564 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1565 | ^ | | m1 | m2 | m3 | mt | |
1566 |---+---------+--------+--------+--------+-------+------|
1567 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1568 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1569 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1570 |---+---------+--------+--------+--------+-------+------|
1571 | | Average | | | | 29.7 | |
1572 | ^ | | | | | at | |
1573 | $ | max=50 | | | | | |
1574 |---+---------+--------+--------+--------+-------+------|
1575 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1577 Important: Please note that for these special tables, recalculating the
1578 table with `C-u C-c *' will only affect rows that are marked `#' or
1579 `*', and fields that have a formula assigned to the field itself. The
1580 column formulas are not applied in rows with empty first field.
1582 The marking characters have the following meaning:
1584 The fields in this line define names for the columns, so that you
1585 may refer to a column as `$Tot' instead of `$6'.
1588 This row defines names for the fields _above_ the row. With such
1589 a definition, any formula in the table may use `$m1' to refer to
1590 the value `10'. Also, if you assign a formula to a names field, it
1591 will be stored as `$name=...'.
1594 Similar to `^', but defines names for the fields in the row
1598 Fields in this row can define _parameters_ for formulas. For
1599 example, if a field in a `$' row contains `max=50', then formulas
1600 in this table can refer to the value 50 using `$max'. Parameters
1601 work exactly like constants, only that they can be defined on a
1605 Fields in this row are automatically recalculated when pressing
1606 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1607 selected for a global recalculation with `C-u C-c *'. Unmarked
1608 lines will be left alone by this command.
1611 Selects this line for global recalculation with `C-u C-c *', but
1612 not for automatic recalculation. Use this when automatic
1613 recalculation slows down editing too much.
1616 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1617 All lines that should be recalculated should be marked with `#' or
1621 Do not export this line. Useful for lines that contain the
1622 narrowing `<N>' markers.
1624 Finally, just to whet your appetite on what can be done with the
1625 fantastic `calc' package, here is a table that computes the Taylor
1626 series of degree `n' at location `x' for a couple of functions
1627 (homework: try that with Excel :-)
1629 |---+-------------+---+-----+--------------------------------------|
1630 | | Func | n | x | Result |
1631 |---+-------------+---+-----+--------------------------------------|
1632 | # | exp(x) | 1 | x | 1 + x |
1633 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1634 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1635 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1636 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1637 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1638 |---+-------------+---+-----+--------------------------------------|
1639 #+TBLFM: $5=taylor($2,$4,$3);n3
1642 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1647 Just like HTML, Org-mode provides links inside a file, and external
1648 links to other files, Usenet articles, emails, and much more.
1652 * Link format:: How links in Org-mode are formatted
1653 * Internal links:: Links to other places in the current file
1654 * External links:: URL-like links to the world
1655 * Handling links:: Creating, inserting and following
1656 * Link abbreviations:: Shortcuts for writing complex links
1657 * Search options:: Linking to a specific location
1658 * Custom searches:: When the default search is not enough
1659 * Remember:: Org-trees store quick notes
1662 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1667 Org-mode will recognize plain URL-like links and activate them as
1668 clickable links. The general link format, however, looks like this:
1670 [[link][description]] or alternatively [[link]]
1672 Once a link in the buffer is complete (all brackets present),
1673 Org-mode will change the display so that `description' is displayed
1674 instead of `[[link][description]]' and `link' is displayed instead of
1675 `[[link]]'. Links will be highlighted in the face `org-link', which by
1676 default is an underlined face. You can directly edit the visible part
1677 of a link. Note that this can be either the `link' part (if there is
1678 no description) or the `description' part. To edit also the invisible
1679 `link' part, use `C-c C-l' with the cursor on the link.
1681 If you place the cursor at the beginning or just behind the end of
1682 the displayed text and press <BACKSPACE>, you will remove the
1683 (invisible) bracket at that location. This makes the link incomplete
1684 and the internals are again displayed as plain text. Inserting the
1685 missing bracket hides the link internals again. To show the internal
1686 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1690 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1695 If the link does not look like a URL, it is considered to be internal in
1696 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1697 my target]]' lead to a text search in the current file. The link can
1698 be followed with `C-c C-o' when the cursor is on the link, or with a
1699 mouse click (*note Handling links::). The preferred match for such a
1700 link is a dedicated target: the same string in double angular brackets.
1701 Targets may be located anywhere; often it is convenient to put them
1702 into a comment line. For example
1706 In HTML export (*note HTML export::), such targets will become named
1707 anchors for direct access through `http' links(1).
1709 If no dedicated target exists, Org-mode will search for the words in
1710 the link. In the above example the search would be for `my target'.
1711 Links starting with a star like `*My Target' restrict the search to
1712 headlines. When searching, Org-mode will first try an exact match, but
1713 then move on to more and more lenient searches. For example, the link
1714 `[[*My Targets]]' will find any of the following:
1717 ** TODO my targets are bright
1718 ** my 20 targets are
1720 To insert a link targeting a headline, in-buffer completion can be
1721 used. Just type a star followed by a few optional letters into the
1722 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1723 offered as completions. *Note Handling links::, for more commands
1726 Following a link pushes a mark onto Org-mode's own mark ring. You
1727 can return to the previous position with `C-c &'. Using this command
1728 several times in direct succession goes back to positions recorded
1733 * Radio targets:: Make targets trigger links in plain text.
1734 * CamelCase links:: Activating CamelCase words as links
1736 ---------- Footnotes ----------
1738 (1) Note that text before the first headline will never be exported,
1739 so the first such target must be after the first headline.
1742 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1747 You can configure Org-mode to link any occurrences of certain target
1748 names in normal text. So without explicitly creating a link, the text
1749 connects to the target radioing its position. Radio targets are
1750 enclosed by triple angular brackets. For example, a target `<<<My
1751 Target>>>' causes each occurrence of `my target' in normal text to
1752 become activated as a link. The Org-mode file is scanned automatically
1753 for radio targets only when the file is first loaded into Emacs. To
1754 update the target list during editing, press `C-c C-c' with the cursor
1758 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1760 4.2.2 CamelCase words as links
1761 ------------------------------
1763 Org-mode also supports CamelCase words as links. This feature is not
1764 turned on by default because of the inconsistencies this system suffers
1765 from. It is also possible that this feature will disappear entirely in
1766 a future version of Org-mode. To activate CamelCase words as links, you
1767 need to customize the option `org-activate-links'. A CamelCase word
1768 then leads to a text search such that `CamelCaseLink' is equivalent to
1769 `[[camel case link]]'.
1772 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1777 Org-mode supports links to files, websites, Usenet and email messages,
1778 and BBDB database entries. External links are URL-like locators. They
1779 start with a short identifying string followed by a colon. There can be
1780 no space after the colon. The following list shows examples for each
1783 http://www.astro.uva.nl/~dominik on the web
1784 file:/home/dominik/images/jupiter.jpg file, absolute path
1785 file:papers/last.pdf file, relative path
1786 news:comp.emacs Usenet link
1787 mailto:adent@galaxy.net Mail link
1788 vm:folder VM folder link
1789 vm:folder#id VM message link
1790 vm://myself@some.where.org/folder#id VM on remote machine
1791 wl:folder WANDERLUST folder link
1792 wl:folder#id WANDERLUST message link
1793 mhe:folder MH-E folder link
1794 mhe:folder#id MH-E message link
1795 rmail:folder RMAIL folder link
1796 rmail:folder#id RMAIL message link
1797 gnus:group GNUS group link
1798 gnus:group#id GNUS article link
1799 bbdb:Richard Stallman BBDB link
1800 shell:ls *.org A shell command
1801 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1803 A link should be enclosed in double brackets and may contain a
1804 descriptive text to be displayed instead of the url (*note Link
1805 format::), for example:
1807 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1809 If the description is a file name or URL that points to an image, HTML
1810 export (*note HTML export::) will inline the image as a clickable
1811 button. If there is no description at all and the link points to an
1812 image, that image will be inlined into the exported HTML file.
1814 Org-mode also finds external links in the normal text and activates
1815 them as links. If spaces must be part of the link (for example in
1816 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1817 the end of the link, enclose them in angular brackets.
1820 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1825 Org-mode provides methods to create a link in the correct syntax, to
1826 insert it into an org-mode file, and to follow the link.
1829 Store a link to the current location. This is a _global_ command
1830 which can be used in any buffer to create a link. The link will be
1831 stored for later insertion into an Org-mode buffer (see below).
1832 For Org-mode files, if there is a `<<target>>' at the cursor, the
1833 link points to the target. Otherwise it points to the current
1834 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1835 the link will indicate the current article/entry. For W3 and W3M
1836 buffers, the link goes to the current URL. For any other files,
1837 the link will point to the file, with a search string (*note
1838 Search options::) pointing to the contents of the current line.
1839 If there is an active region, the selected words will form the
1840 basis of the search string. If the automatically created link is
1841 not working correctly or accurately enough, you can write custom
1842 functions to select the search string and to do the search for
1843 particular file types - see *Note Custom searches::. The key
1844 binding `C-c l' is only a suggestion - see *Note Installation::.
1847 Insert a link. This prompts for a link to be inserted into the
1848 buffer. You can just type a link, using text for an internal
1849 link, or one of the link type prefixes mentioned in the examples
1850 above. All links stored during the current session are part of
1851 the history for this prompt, so you can access them with <up> and
1852 <down>, or with completion(1). The link will be inserted into the
1853 buffer, along with a descriptive text. If some text was selected
1854 when this command is called, the selected text becomes the default
1856 Note that you don't have to use this command to insert a link.
1857 Links in Org-mode are plain text, and you can type or paste them
1858 straight into the buffer. By using this command, the links are
1859 automatically enclosed in double brackets, and you will be asked
1860 for the optional descriptive text.
1863 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1864 file will be inserted and you may use file name completion to
1865 select the name of the file. The path to the file is inserted
1866 relative to the directory of the current org file, if the linked
1867 file is in the current directory or in a subdirectory of it, or if
1868 the path is written relative to the current directory using `../'.
1869 Otherwise an absolute path is used, if possible with `~/' for
1870 your home directory. You can force an absolute path with two
1873 `C-c C-l with cursor on existing link'
1874 When the cursor is on an existing link, `C-c C-l' allows you to
1875 edit the link and description parts of the link.
1878 Open link at point. This will launch a web browser for URLs (using
1879 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1880 the corresponding links, and execute the command in a shell link.
1881 When the cursor is on an internal link, this commands runs the
1882 corresponding search. When the cursor is on a TAG list in a
1883 headline, it creates the corresponding TAGS view. If the cursor
1884 is on a time stamp, it compiles the agenda for that date.
1885 Furthermore, it will visit text and remote files in `file:' links
1886 with Emacs and select a suitable application for local non-text
1887 files. Classification of files is based on file extension only.
1888 See option `org-file-apps'. If you want to override the default
1889 application and visit the file with Emacs, use a `C-u' prefix.
1893 On links, `mouse-2' will open the link just as `C-c C-o' would.
1894 Under Emacs 22, also `mouse-1' will follow a link.
1897 Like `mouse-2', but force file links to be opened with Emacs, and
1898 internal links to be displayed in another window(2).
1901 Push the current position onto the mark ring, to be able to return
1902 easily. Commands following an internal link do this automatically.
1905 Jump back to a recorded position. A position is recorded by the
1906 commands following internal links, and by `C-c %'. Using this
1907 command several times in direct succession moves through a ring of
1908 previously recorded positions.
1912 Move forward/backward to the next link in the buffer. At the
1913 limit of the buffer, the search fails once, and then wraps around.
1914 The key bindings for this are really too long, you might want to
1915 bind this also to `C-n' and `C-p'
1916 (add-hook 'org-load-hook
1918 (define-key 'org-mode-map "\C-n" 'org-next-link)
1919 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
1921 ---------- Footnotes ----------
1923 (1) After insertion of a stored link, the link will be removed from
1924 the list of stored links. To keep it in the list later use, use a
1925 triple `C-u' prefix to `C-c C-l', or configure the option
1926 `org-keep-stored-link-after-insertion'.
1928 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1931 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1933 4.5 Link abbreviations
1934 ======================
1936 Long URLs can be cumbersome to type, and often many similar links are
1937 needed in a document. For this you can use link abbreviations. An
1938 abbreviated link looks like this
1940 [[linkword:tag][description]]
1942 where the tag is optional. Such abbreviations are resolved according to
1943 the information in the variable `org-link-abbrev-alist' that relates
1944 the linkwords to replacement text. Here is an example:
1946 (setq org-link-abbrev-alist
1947 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1948 ("google" . "http://www.google.com/search?q=")
1949 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
1950 nph-abs_connect?author=%s&db_key=AST")))
1952 If the replacement text contains the string `%s', it will be
1953 replaced with the tag. Otherwise the tag will be appended to the string
1954 in order to create the link. You may also specify a function that will
1955 be called with the tag as the only argument to create the link.
1957 With the above setting, you could link to a specific bug with
1958 `[[bugzilla:129]]', search the web for `OrgMode' with
1959 `[[google:OrgMode]]' and find out what the Org-mode author is doing
1960 besides Emacs hacking with `[[ads:Dominik,C]]'.
1962 If you need special abbreviations just for a single Org-mode buffer,
1963 you can define them in the file with
1965 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
1966 #+LINK: google http://www.google.com/search?q=%s
1968 In-buffer completion *note Completion:: can be used after `[' to
1969 complete link abbreviations.
1972 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
1974 4.6 Search options in file links
1975 ================================
1977 File links can contain additional information to make Emacs jump to a
1978 particular location in the file when following a link. This can be a
1979 line number or a search option after a double(1) colon. For example,
1980 when the command `C-c l' creates a link (*note Handling links::) to a
1981 file, it encodes the words in the current line as a search string that
1982 can be used to find this line back later when following the link with
1985 Here is the syntax of the different ways to attach a search to a file
1986 link, together with an explanation:
1988 [[file:~/code/main.c::255]]
1989 [[file:~/xx.org::My Target]]
1990 [[file:~/xx.org::*My Target]]
1991 [[file:~/xx.org::/regexp/]]
1997 Search for a link target `<<My Target>>', or do a text search for
1998 `my target', similar to the search in internal links, see *Note
1999 Internal links::. In HTML export (*note HTML export::), such a
2000 file link will become an HTML reference to the corresponding named
2001 anchor in the linked file.
2004 In an Org-mode file, restrict search to headlines.
2007 Do a regular expression search for `regexp'. This uses the Emacs
2008 command `occur' to list all matches in a separate window. If the
2009 target file is in Org-mode, `org-occur' is used to create a sparse
2010 tree with the matches.
2012 As a degenerate case, a file link with an empty file name can be used
2013 to search the current file. For example, `[[file:::find me]]' does a
2014 search for `find me' in the current file, just as `[[find me]]' would.
2016 ---------- Footnotes ----------
2018 (1) For backward compatibility, line numbers can also follow a
2022 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
2027 The default mechanism for creating search strings and for doing the
2028 actual search related to a file link may not work correctly in all
2029 cases. For example, BibTeX database files have many entries like
2030 `year="1993"' which would not result in good search strings, because
2031 the only unique identification for a BibTeX entry is the citation key.
2033 If you come across such a problem, you can write custom functions to
2034 set the right search string for a particular file type, and to do the
2035 search for the string in the file. Using `add-hook', these functions
2036 need to be added to the hook variables
2037 `org-create-file-search-functions' and
2038 `org-execute-file-search-functions'. See the docstring for these
2039 variables for more information. Org-mode actually uses this mechanism
2040 for BibTeX database files, and you can use the corresponding code as an
2041 implementation example. Search for `BibTeX links' in the source file.
2044 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
2049 Another way to create org entries with links to other files is through
2050 the remember package by John Wiegley. Remember lets you store quick
2051 notes with little interruption of your work flow. See
2052 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2053 information. The notes produced by Remember can be stored in different
2054 ways, and Org-mode files are a good target. Org-mode significantly
2055 expands the possibilities of remember: You may define templates for
2056 different note types, and to associate target files and headlines with
2057 specific templates. It also allows you to select the location where a
2058 note should be stored interactively, on the fly.
2062 * Setting up remember:: Some code for .emacs to get things going
2063 * Remember templates:: Define the outline of different note types
2064 * Storing notes:: Directly get the note to where it belongs
2067 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
2069 4.8.1 Setting up remember
2070 -------------------------
2072 The following customization will tell remember to use org files as
2073 target, and to create annotations compatible with Org-mode links.
2075 (setq org-directory "~/path/to/my/orgfiles/")
2076 (setq org-default-notes-file "~/.notes")
2077 (setq remember-annotation-functions '(org-remember-annotation))
2078 (setq remember-handler-functions '(org-remember-handler))
2079 (add-hook 'remember-mode-hook 'org-remember-apply-template)
2082 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
2084 4.8.2 Remember templates
2085 ------------------------
2087 In combination with Org-mode, you can use templates to generate
2088 different types of remember notes. For example, if you would like to
2089 use one template to create general TODO entries, another one for
2090 journal entries, and a third one for collecting random ideas, you could
2093 (setq org-remember-templates
2094 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
2095 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
2096 (?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
2098 In these entries, the character specifies how to select the template.
2099 The first string specifies the template. Two more (optional) strings
2100 give the file in which, and the headline under which the new note
2101 should be stored. The file defaults to `org-default-notes-file', the
2102 heading to `org-remember-default-headline'. Both defaults help to get
2103 to the storing location quickly, but you can change the location
2104 interactively while storing the note.
2106 When you call `M-x remember' (or `M-x org-remember') to remember
2107 something, org will prompt for a key to select the template (if you have
2108 more than one template) and then prepare the buffer like
2110 [[file:link to where you called remember]]
2114 * [2006-03-21 Tue 15:37]
2116 [[file:link to where you called remember]]
2118 During expansion of the template, special `%'-escapes allow dynamic
2119 insertion of content:
2120 %^{prompt} prompt the user for a string and replace this sequence with it.
2121 %t time stamp, date only
2122 %T time stamp with date and time
2123 %u, %U like the above, but inactive time stamps
2124 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
2125 You may define a prompt like `%^{Birthday}t'
2126 %n user name (taken from `user-full-name')
2127 %a annotation, normally the link created with `org-store-link'
2128 %i initial content, the region when remember is called with C-u.
2129 The entire text will be indented like `%i' itself.
2130 %:keyword specific information for certain link types, see below
2132 For specific link types, the following keywords will be defined:
2134 Link type | Available keywords
2135 -------------------+----------------------------------------------
2136 bbdb | %:name %:company
2137 vm, wl, mh, rmail | %:type %:subject %:message-id
2138 | %:from %:fromname %:fromaddress
2139 | %:to %:toname %:toaddress
2140 | %:fromto (either "to NAME" or "from NAME")(1)
2141 gnus | %:group, for messages also all email fields
2143 info | %:file %:node
2146 If you would like to have the cursor in a specific position after the
2147 template has been expanded:
2149 %? After completing the template, position cursor here.
2151 If you change you mind about which template to use, call `org-remember'
2152 in the remember buffer. You may then select a new template that will
2153 be filled with the previoous context information.
2155 ---------- Footnotes ----------
2157 (1) This will always be the other, not the user. See the variable
2158 `org-from-is-user-regexp'.
2161 File: org, Node: Storing notes, Prev: Remember templates, Up: Remember
2166 When you are finished preparing a note with remember, you have to press
2167 `C-c C-c' to file the note away. The handler first prompts for a
2168 target file - if you press <RET>, the value specified for the template
2169 is used. Then the command offers the headings tree of the selected
2170 file, with the cursor position at the default headline (if you had
2171 specified one in the template). You can either immediately press <RET>
2172 to get the note placed there. Or you can use vertical cursor motion
2173 (<up> and <down>) and visibility cycling (<TAB>) to find a better
2174 place. Pressing <RET> or <left> or <right> then leads to the following
2177 Cursor Key Note gets inserted
2179 buffer-start <RET> as level 2 heading at end of file
2180 on headline <RET> as sublevel of the heading at cursor
2181 <left> as same level, before current heading
2182 <right> as same level, after current heading
2183 not on <RET> at cursor position, level taken from context.
2184 headline Or use prefix arg to specify level
2187 So a fast way to store the note to its default location is to press
2188 `C-c C-c <RET> <RET>'. Even shorter would be `C-u C-c C-c', which does
2189 the same without even asking for a file or showing the tree.
2191 Before inserting the text into a tree, the function ensures that the
2192 text has a headline, i.e. a first line that starts with a `*'. If not,
2193 a headline is constructed from the current date and some additional
2194 data. If the variable `org-adapt-indentation' is non-nil, the entire
2195 text is also indented so that it starts in the same column as the
2196 headline (after the asterisks).
2199 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
2204 Org-mode does not maintain TODO lists as a separate document. TODO
2205 items are an integral part of the notes file, because TODO items
2206 usually come up while taking notes! With Org-mode, you simply mark any
2207 entry in a tree as being a TODO item. In this way, the information is
2208 not duplicated, and the entire context from which the item emerged is
2209 always present when you check.
2211 Of course, this technique causes TODO items to be scattered
2212 throughout your file. Org-mode provides methods to give you an
2213 overview over all things you have to do.
2217 * TODO basics:: Marking and displaying TODO entries
2218 * TODO extensions:: Workflow and assignments
2219 * Priorities:: Some things are more important than others
2220 * Breaking down tasks:: Splitting a task into managable pieces
2221 * Checkboxes:: Tick-off lists
2224 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2226 5.1 Basic TODO functionality
2227 ============================
2229 Any headline can become a TODO item by starting it with the word TODO,
2232 *** TODO Write letter to Sam Fortune
2234 The most important commands to work with TODO entries are:
2237 Rotate the TODO state of the current item between
2239 ,-> (unmarked) -> TODO -> DONE --.
2240 '--------------------------------'
2242 The same rotation can also be done "remotely" from the timeline and
2243 agenda buffers with the `t' command key (*note Agenda commands::).
2247 Select the following/preceding TODO state, similar to cycling.
2248 Mostly useful if more than two TODO states are possible (*note
2252 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2253 the entire buffer, but shows all TODO items and the headings
2254 hierarchy above them. With prefix arg, show also the DONE
2255 entries. With numerical prefix N, show the tree for the Nth
2256 keyword in the variable `org-todo-keywords'.
2259 Show the global TODO list. This collects the TODO items from all
2260 agenda files (*note Agenda views::) into a single buffer. The
2261 buffer is in `agenda-mode', so there are commands to examine and
2262 manipulate the TODO entries directly from that buffer (*note
2263 Agenda commands::). *Note Global TODO list::, for more
2267 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2269 5.2 Extended use of TODO keywords
2270 =================================
2272 The default implementation of TODO entries is just two states: TODO and
2273 DONE. You can, however, use the TODO feature for more complicated
2274 things by configuring the variables `org-todo-keywords' and
2275 `org-todo-interpretation'. Using special setup, you can even use TODO
2276 keywords in different ways in different org files.
2278 Note that tags are another way to classify headlines in general and
2279 TODO items in particular (*note Tags::).
2283 * Workflow states:: From TODO to DONE in steps
2284 * TODO types:: I do this, Fred the rest
2285 * Per file keywords:: Different files, different requirements
2288 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2290 5.2.1 TODO keywords as workflow states
2291 --------------------------------------
2293 You can use TODO keywords to indicate different states in the process
2294 of working on an item, for example:
2296 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2297 org-todo-interpretation 'sequence)
2299 Changing these variables only becomes effective in a new Emacs
2300 session. With this setup, the command `C-c C-t' will cycle an entry
2301 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
2302 also use a prefix argument to quickly select a specific state. For
2303 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
2304 you define many keywords, you can use in-buffer completion (see *Note
2305 Completion::) to insert these words into the buffer. Changing a todo
2306 state can be logged with a timestamp, see *Note Tracking TODO state
2307 changes:: for more information.
2310 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
2312 5.2.2 TODO keywords as types
2313 ----------------------------
2315 The second possibility is to use TODO keywords to indicate different
2316 types of action items. For example, you might want to indicate that
2317 items are for "work" or "home". If you are into David Allen's _Getting
2318 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2319 `MAYBE'. Or, when you work with several people on a single project,
2320 you might want to assign action items directly to persons, by using
2321 their names as TODO keywords. This would be set up like this:
2323 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2324 org-todo-interpretation 'type)
2326 In this case, different keywords do not indicate a sequence, but
2327 rather different types. So it is normally not useful to change from
2328 one type to another. Therefore, in this case the behavior of the
2329 command `C-c C-t' is changed slightly(1). When used several times in
2330 succession, it will still cycle through all names. But when you return
2331 to the item after some time and execute `C-c C-t' again, it will switch
2332 from each name directly to DONE. Use prefix arguments or completion to
2333 quickly select a specific name. You can also review the items of a
2334 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2335 C-v'. For example, to see all things Lucy has to do, you would use
2336 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2337 single buffer, you would use the prefix arg as well when creating the
2338 global todo list: `C-3 C-c t'.
2340 ---------- Footnotes ----------
2342 (1) This is also true for the `t' command in the timeline and agenda
2346 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2348 5.2.3 Setting up TODO keywords for individual files
2349 ---------------------------------------------------
2351 It can be very useful to use different aspects of the TODO mechanism in
2352 different files, which is not possible with the global settings
2353 described above. For file-local settings, you need to add special
2354 lines to the file which set the keywords and interpretation for that
2355 file only. For example, to set one of the two examples discussed
2356 above, you need one of the following lines, starting in column zero
2357 anywhere in the file:
2359 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2360 #+TYP_TODO: Fred Sara Lucy Mike DONE
2362 To make sure you are using the correct keyword, type `#+' into the
2363 buffer and then use `M-<TAB>' completion.
2365 Remember that the last keyword must always mean that the item is DONE
2366 (although you may use a different word). Also note that in each file,
2367 only one of the two aspects of TODO keywords can be used. After
2368 changing one of these lines, use `C-c C-c' with the cursor still in the
2369 line to make the changes known to Org-mode(1).
2371 If you want to use very many keywords, for example when working with
2372 a large group of people, you may split the names over several lines:
2374 #+TYP_TODO: Fred Sara Lucy Mike
2375 #+TYP_TODO: Luis George Jules Jessica
2376 #+TYP_TODO: Kim Arnold Peter
2379 ---------- Footnotes ----------
2381 (1) Org-mode parses these lines only when Org-mode is activated
2382 after visiting a file. `C-c C-c' with the cursor in a line starting
2383 with `#+' is simply restarting Org-mode for the current buffer.
2386 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2391 If you use Org-mode extensively to organize your work, you may end up
2392 with a number of TODO entries so large that you'd like to prioritize
2393 them. This can be done by placing a _priority cookie_ into the
2396 *** TODO [#A] Write letter to Sam Fortune
2398 With its standard setup, Org-mode supports priorities `A', `B', and
2399 `C'. `A' is the highest priority. An entry without a cookie is
2400 treated as priority `B'. Priorities make a difference only in the
2401 agenda (*note Weekly/Daily agenda::).
2404 Set the priority of the current headline. The command prompts for
2405 a priority character `A', `B' or `C'. When you press <SPC>
2406 instead, the priority cookie is removed from the headline. The
2407 priorities can also be changed "remotely" from the timeline and
2408 agenda buffer with the `,' command (*note Agenda commands::).
2412 Increase/decrease priority of current headline. Note that these
2413 keys are also used to modify time stamps (*note Creating
2414 timestamps::). Furthermore, these keys are also used by CUA-mode
2415 (*note Conflicts::).
2418 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2420 5.4 Breaking tasks down into subtasks
2421 =====================================
2423 It is often advisable to break down large tasks into smaller, managable
2424 subtasks. You can do this by creating an outline tree below a TODO
2425 item, with detailed subtasks on the tree(1). Another possibility is
2426 the use of checkboxes to identify (a hierarchy of) a large number of
2427 subtasks (*note Checkboxes::).
2429 ---------- Footnotes ----------
2431 (1) To keep subtasks out of the global TODO list, see the
2432 `org-agenda-todo-list-sublevels'.
2435 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2440 Every item in a plain list (*note Plain lists::) can be made a checkbox
2441 by starting it with the string `[ ]'. This feature is similar to TODO
2442 items (*note TODO items::), but more lightweight. Checkboxes are not
2443 included into the global TODO list, so they are often great to split a
2444 task into a number of simple steps. Or you can use them in a shopping
2445 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2446 `org-mouse.el'. Here is an example of a checkbox list.
2448 * TODO Organize party [3/6]
2454 - [ ] think about what music to play
2455 - [X] talk to the neighbors
2457 The `[3/6]' and `[1/3]' in the first and second line are cookies
2458 indicating how many checkboxes are present in this entry, and how many
2459 of them have been checked off. This can give you an idea on how many
2460 checkboxes remain, even without opening a folded entry. The cookies
2461 can be placed into a headline or into (the first line of) a plain list
2462 item. Each cookie covers all checkboxes structurally below that
2463 headline/item. You have to insert the cookie yourself by typing either
2464 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2465 the second case you get information about the percentage of checkboxes
2466 checked (in the above example, this would be `[50%]' and `[33%],
2469 The following commands work with checkboxes:
2472 Toggle checkbox at point.
2475 Toggle checkbox at point.
2476 - If there is an active region, toggle the first checkbox in
2477 the region and set all remaining boxes to the same status as
2478 the first. If you want to toggle all boxes in the region
2479 independently, use a prefix argument.
2481 - If the cursor is in a headline, toggle checkboxes in the
2482 region between this headline and the next (so _not_ the
2485 - If there is no active region, just toggle the checkbox at
2489 Insert a new item with a checkbox. This works only if the cursor
2490 is already in a plain list item (*note Plain lists::).
2493 Update the checkbox statistics in the current outline entry. When
2494 called with a `C-u' prefix, update the entire file. Checkbox
2495 statistic cookies are updated automatically if you toggle
2496 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2497 you delete boxes or add/change them by hand, use this command to
2498 get things back into synch. Or simply toggle any checkbox twice
2502 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2507 Items can be labeled with timestamps to make them useful for project
2512 * Time stamps:: Assigning a time to a tree entry
2513 * Creating timestamps:: Commands which insert timestamps
2514 * Custom time format:: If you cannot work with the ISO format
2515 * Repeating items:: Deadlines that come back again and again
2516 * Progress logging:: Documenting when what work was done.
2519 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2521 6.1 Time stamps, deadlines and scheduling
2522 =========================================
2524 A time stamp is a specification of a date (possibly with time) in a
2525 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2526 09:39>'(1). A time stamp can appear anywhere in the headline or body
2527 of an org-tree entry. Its presence allows entries to be shown on
2528 specific dates in the agenda (*note Weekly/Daily agenda::). We
2532 A simple time stamp just assigns a date/time to an item. This is
2533 just like writing down an appointment in a paper agenda, or like
2534 writing down an event in a diary, when you want to take note of
2535 when something happened. In the timeline and agenda displays, the
2536 headline of an entry associated with a plain time stamp will be
2537 shown exactly on that date.
2539 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2542 Just like a plain time stamp, but with square brackets instead of
2543 angular ones. These time stamps are inactive in the sense that
2544 they do _not_ trigger an entry to show up in the agenda.
2546 * Gillian comes late for the fifth time [2006-11-01 Wed]
2549 Two time stamps connected by `--' denote a time range. The
2550 headline will be shown on the first and last day of the range, and
2551 on any dates that are displayed and fall in the range. Here is an
2554 ** Meeting in Amsterdam
2555 <2004-08-23 Mon>--<2004-08-26 Thu>
2557 TIME STAMP WITH SCHEDULED KEYWORD
2558 If a time stamp is preceded by the word `SCHEDULED:', it means you
2559 are planning to start working on that task on the given date. So
2560 this is not about recording an event, but about planning your
2561 work. The headline will be listed under the given date(2). In
2562 addition, a reminder that the scheduled date has passed will be
2563 present in the compilation for _today_, until the entry is marked
2564 DONE. I.e., the task will automatically be forwarded until
2567 *** TODO Call Trillian for a date on New Years Eve.
2568 SCHEDULED: <2004-12-25 Sat>
2570 TIME STAMP WITH DEADLINE KEYWORD
2571 If a time stamp is preceded by the word `DEADLINE:', the task
2572 (most likely a TODO item) is supposed to be finished on that date,
2573 and it will be listed then. In addition, the compilation for
2574 _today_ will carry a warning about the approaching or missed
2575 deadline, starting `org-deadline-warning-days' before the due
2576 date, and continuing until the entry is marked DONE. An example:
2578 *** TODO write article about the Earth for the Guide
2579 The editor in charge is [[bbdb:Ford Prefect]]
2580 DEADLINE: <2004-02-29 Sun>
2582 TIME STAMP WITH CLOSED KEYWORD
2583 When `org-log-done' is non-nil, Org-mode will automatically insert
2584 a special time stamp each time a TODO entry is marked done (*note
2585 Progress logging::). This time stamp is enclosed in square
2586 brackets instead of angular brackets.
2588 TIME RANGE WITH CLOCK KEYWORD
2589 When using the clock to time the work that is being done on
2590 specific items, time ranges preceded by the CLOCK keyword are
2591 inserted automatically into the file. The time stamps are
2592 enclosed in square brackets instead of angular brackets. *Note
2593 Clocking work time::.
2595 ---------- Footnotes ----------
2597 (1) This is the standard ISO date/time format. If you cannot get
2598 used to these, see *Note Custom time format::
2600 (2) It will still be listed on that date after it has been marked
2601 DONE. If you don't like this, set the variable
2602 `org-agenda-skip-scheduled-if-done'.
2605 File: org, Node: Creating timestamps, Next: Custom time format, Prev: Time stamps, Up: Timestamps
2607 6.2 Creating timestamps
2608 =======================
2610 For Org-mode to recognize time stamps, they need to be in the specific
2611 format. All commands listed below produce time stamps in the correct
2615 Prompt for a date and insert a corresponding time stamp. When the
2616 cursor is at a previously used time stamp, it is updated to NOW.
2617 When this command is used twice in succession, a time range is
2621 Like `C-c .', but use the alternative format which contains date
2622 and time. The default time can be rounded to multiples of 5
2623 minutes, see the option `org-time-stamp-rounding-minutes'.
2626 Like `C-c .', but insert an inactive time stamp not triggering the
2630 Insert a time stamp corresponding to the cursor date in the
2634 Access the Emacs calendar for the current date. If there is a
2635 timestamp in the current line, goto the corresponding date instead.
2638 Access the agenda for the date given by the time stamp or -range at
2639 point (*note Weekly/Daily agenda::).
2642 Insert `DEADLINE' keyword along with a stamp. The insertion will
2643 happen in the line directly following the headline.
2646 Create a sparse tree with all deadlines that are either past-due,
2647 or which will become due within `org-deadline-warning-days'. With
2648 `C-u' prefix, show all deadlines in the file. With a numeric
2649 prefix, check that many days. For example, `C-1 C-c C-w' shows
2650 all deadlines due tomorrow.
2653 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2654 happen in the line directly following the headline. Any CLOSED
2655 timestamp will be removed.
2659 Change date at cursor by one day. These key bindings conflict with
2660 CUA-mode (*note Conflicts::).
2664 Change the item under the cursor in a timestamp. The cursor can
2665 be on a year, month, day, hour or minute. Note that if the cursor
2666 is in a headline and not at a time stamp, these same keys modify
2667 the priority of an item. (*note Priorities::). The key bindings
2668 also conflict with CUA-mode (*note Conflicts::).
2671 Evaluate a time range by computing the difference between start and
2672 end. With prefix arg, insert result after the time range (in a
2673 table: into the following column).
2677 * The date/time prompt:: How org-mode helps you entering date and time
2680 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2682 6.2.1 The date/time prompt
2683 --------------------------
2685 When Org-mode prompts for a date/time, the prompt suggests to enter an
2686 ISO date. But it will in fact accept any string containing some date
2687 and/or time information. You can, for example, use `C-y' to paste a
2688 (possibly multi-line) string copied from an email message. Org-mode
2689 will find whatever information is in there and will replace anything not
2690 specified with the current date and time. For example:
2692 3-2-5 --> 2003-02-05
2693 feb 15 --> currentyear-02-15
2694 sep 12 9 --> 2009-09-12
2695 12:45 --> today 12:45
2696 22 sept 0:34 --> currentyear-09-22 0:34
2697 12 --> currentyear-currentmonth-12
2698 Fri --> nearest Friday (today or later)
2699 +4 --> 4 days from now (if +N is the only thing given)
2701 The function understands English month and weekday abbreviations. If
2702 you want to use unabbreviated names and/or other languages, configure
2703 the variables `parse-time-months' and `parse-time-weekdays'.
2705 Parallel to the minibuffer prompt, a calendar is popped up(1). You
2706 can control the calendar fully from the minibuffer:
2709 Scroll calendar backwards by one month.
2712 Scroll calendar forwards by one month.
2715 Select date by clicking on it.
2736 Choose date in calendar (only if nothing was typed into
2739 ---------- Footnotes ----------
2741 (1) If you don't need/want the calendar, configure the variable
2742 `org-popup-calendar-for-date-prompt'.
2745 File: org, Node: Custom time format, Next: Repeating items, Prev: Creating timestamps, Up: Timestamps
2747 6.3 Custom time format
2748 ======================
2750 Org-mode uses the standard ISO notation for dates and times as it is
2751 defined in ISO 8601. If you cannot get used to this and require another
2752 representation of date and time to keep you happy, you can get it by
2753 customizing the variables `org-display-custom-times' and
2754 `org-time-stamp-custom-formats'.
2757 Toggle the display of custom formats for dates and times.
2759 Org-mode needs the default format for scanning, so the custom date/time
2760 format does not _replace_ the default format - instead it is put _over_
2761 the default format using text properties. This has the following
2763 * You cannot place the cursor onto a time stamp anymore, only before
2766 * The `S-<up>/<down>' keys can no longer be used to adjust each
2767 component of a time stamp. If the cursor is at the beginning of
2768 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2769 like `S-<left>/<right>'. At the end of the stamp, the time will
2770 be changed by one minute.
2772 * When you delete a time stamp character-by-character, it will only
2773 disappear from the buffer after _all_ (invisible) characters
2774 belonging to the ISO timestamp have been removed.
2776 * If the custom time stamp format is longer than the default and you
2777 are using dates in tables, table alignment will be messed up. If
2778 the custom format is shorter, things do work as expected.
2781 File: org, Node: Repeating items, Next: Progress logging, Prev: Custom time format, Up: Timestamps
2786 Org-mode integrates with the Emacs calendar and diary to display cyclic
2787 appointments, anniversaries and other special entries in the agenda
2788 (*note Weekly/Daily agenda::). However, it can be useful to have
2789 certain deadlines and scheduling items to auto-repeat. The advantage of
2790 a deadline or scheduled item is that the they produce warnings ahead of
2791 time and automatically forward themselves in the agenda until they are
2792 done. The abstract difference is therefore between cyclic appointments
2793 and cyclic action items. For appointments you should use the diary,
2794 for actions you can uses an org-mode deadline or scheduling time stamp
2795 together with a REPEAT cookie. For example:
2797 * TODO Replace batteries in smoke detector REPEAT(+18m)
2798 SCHEDULED: <2007-01-01 Mon>
2800 * TODO Get dentist appointment REPEAT(+6m)
2801 SCHEDULED: <2006-12-19 Tue>
2803 * TODO Tax report to IRS REPEAT(+1y)
2804 DEADLINE: <2007-04-01 Sun>
2806 Each time you try to mark one of these entries DONE using `C-c C-t',
2807 they will automatically switch back to the state TODO, and the
2808 deadline/scheduling will be shifted accordingly. The time units
2809 recognized by org-mode are year (y), month (m), week (w), and day (d).
2810 Org-mode will also prompt you for a note and record the fact that you
2811 have closed this item in a note under the headline.
2813 One unusual property of these repeating items is that only one
2814 instance of each exist at any given time. So if you look back or ahead
2815 in the agenda, you will not find past and future instances, only the
2816 current one will show up. Use a cyclic diary entry if you need all
2817 past and future instances to be visible in the agenda.
2820 File: org, Node: Progress logging, Prev: Repeating items, Up: Timestamps
2822 6.5 Progress Logging
2823 ====================
2825 Org-mode can automatically record a time stamp when you mark a TODO item
2826 as DONE, or even each time when you change the state of a TODO item.
2827 You can also measure precisely the time you spent on specific items in a
2828 project by starting and stopping a clock when you start and stop working
2829 on an aspect of a project.
2833 * Closing items:: When was this entry marked DONE?
2834 * Tracking TODO state changes:: When did the status change?
2835 * Clocking work time:: When exactly did you work on this item?
2838 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
2843 If you want to keep track of _when_ a certain TODO item was finished,
2844 turn on logging with(1)
2846 (setq org-log-done t)
2848 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2849 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2850 [timestamp]' will be inserted just after the headline. If you turn the
2851 entry back into a TODO item through further state cycling, that line
2852 will be removed again. In the timeline (*note Timeline::) and in the
2853 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
2854 display the TODO items closed on each day, giving you an overview of
2855 what has been done on a day. If you want to record a note along with
2856 the timestamp, use(2)
2858 (setq org-log-done '(done))
2860 ---------- Footnotes ----------
2862 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
2864 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
2867 File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
2869 6.5.2 Tracking TODO state changes
2870 ---------------------------------
2872 When TODO keywords are used as workflow states (*note Workflow
2873 states::), you might want to keep track of when a state change occurred,
2874 and you may even want to attach notes to that state change. With the
2877 (setq org-log-done '(state))
2879 each state change will prompt you for a note that will be attached to
2880 the current headline. Very likely you do not want this verbose tracking
2881 all the time, so it is probably better to configure this behavior with
2882 in-buffer options. For example, if you are tracking purchases, put
2883 these into a separate file that starts with:
2885 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
2886 #+STARTUP: lognotestate
2889 File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
2891 6.5.3 Clocking work time
2892 ------------------------
2894 Org-mode allows you to clock the time you spent on specific tasks in a
2895 project. When you start working on an item, you can start the clock.
2896 When you stop working on that task, or when you mark the task done, the
2897 clock is stopped and the corresponding time interval is recorded. It
2898 also computes the total time spent on each subtree of a project.
2901 Start the clock on the current item (clock-in). This inserts the
2902 CLOCK keyword together with a timestamp.
2905 Stop the clock (clock-out). The inserts another timestamp at the
2906 same location where the clock was last started. It also directly
2907 computes the resulting time in inserts it after the time range as
2908 `=> HH:MM'. See the variable `org-log-done' for the possibility to
2909 record an additional note together with the clock-out time
2913 Recompute the time interval after changing one of the time stamps.
2914 This is only necessary if you edit the time stamps directly. If
2915 you change them with `S-<cursor>' keys, the update is automatic.
2918 Changing the TODO state of an item to DONE automatically stops the
2919 clock if it is running in this same item.
2922 Cancel the current clock. This is useful if a clock was started by
2923 mistake, or if you ended up working on something else.
2926 Display time summaries for each subtree in the current buffer.
2927 This puts overlays at the end of each headline, showing the total
2928 time recorded under that heading, including the time of any
2929 subheadings. You can use visibility cycling to study the tree, but
2930 the overlays disappear when you change the buffer (see variable
2931 `org-remove-highlights-with-change') or press `C-c C-c'.
2934 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2935 report as an org-mode table into the current file.
2936 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2939 If such a block already exists, its content is replaced by the new
2940 table. The `BEGIN' line can specify options:
2941 :maxlevels Maximum level depth to which times are listed in the table.
2942 :emphasize When `t', emphasize level one and level two items
2943 :block The time block to consider. This block is specified relative
2944 to the current time and may be any of these keywords:
2945 `today', `yesterday', `thisweek', `lastweek',
2946 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2947 :tstart A time string specifying when to start considering times
2948 :tend A time string specifying when to stop considering times
2949 So to get a clock summary for the current day, you could write
2950 #+BEGIN: clocktable :maxlevel 2 :block today
2953 and to use a specific time range you could write(2)
2954 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2955 :tend "<2006-08-10 Thu 12:00>"
2960 Update all dynamic blocks (*note Dynamic blocks::). This is
2961 useful if you have several clocktable blocks in a buffer.
2963 The `l' key may be used in the timeline (*note Timeline::) and in
2964 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2965 worked on or closed during a day.
2967 ---------- Footnotes ----------
2969 (1) The corresponding in-buffer setting is: `#+STARTUP:
2972 (2) Note that all parameters must be specified in a single line -
2973 the line is broken here only to fit it onto the manual.
2976 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2981 If you wish to implement a system of labels and contexts for
2982 cross-correlating information, an excellent way is to assign tags to
2983 headlines. Org-mode has extensive support for using tags.
2985 Every headline can contain a list of tags, at the end of the
2986 headline. Tags are normal words containing letters, numbers, `_', and
2987 `@'. Tags must be preceded and followed by a single colon; like
2988 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2992 * Tag inheritance:: Tags use the tree structure of the outline
2993 * Setting tags:: How to assign tags to a headline
2994 * Tag searches:: Searching for combinations of tags
2997 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
3002 Tags make use of the hierarchical structure of outline trees. If a
3003 heading has a certain tag, all subheadings will inherit the tag as
3004 well. For example, in the list
3006 * Meeting with the French group :WORK:
3007 ** Summary by Frank :BOSS:NOTES:
3008 *** TODO Prepare slides for him :ACTION:
3010 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
3011 `:ACTION:'. When executing tag searches and Org-mode finds that a
3012 certain headline matches the search criterion, it will not check any
3013 sublevel headline, assuming that these likely also match, and that the
3014 list of matches can become very long. This may not be what you want,
3015 however, and you can influence inheritance and searching using the
3016 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
3019 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
3024 Tags can simply be typed into the buffer at the end of a headline.
3025 After a colon, `M-<TAB>' offers completion on tags. There is also a
3026 special command for inserting tags:
3029 Enter new tags for the current headline. Org-mode will either
3030 offer completion or a special single-key interface for setting
3031 tags, see below. After pressing <RET>, the tags will be inserted
3032 and aligned to `org-tags-column'. When called with a `C-u'
3033 prefix, all tags in the current buffer will be aligned to that
3034 column, just to make things look nice. TAGS are automatically
3035 realigned after promotion, demotion, and TODO state changes (*note
3038 Org will support tag insertion based on a _list of tags_. By
3039 default this list is constructed dynamically, containing all tags
3040 currently used in the buffer. You may also globally specify a hard list
3041 of tags with the variable `org-tag-alist'. Finally you can set the
3042 default tags for a given file with lines like
3044 #+TAGS: @WORK @HOME @TENNISCLUB
3045 #+TAGS: Laptop Car PC Sailboat
3047 If you have globally defined your preferred set of tags using the
3048 variable `org-tag-alist', but would like to use a dynamic tag list in a
3049 specific file: Just add an empty TAGS option line to that file:
3053 The default support method for entering tags is minibuffer
3054 completion. However, Org-mode also implements a much better method:
3055 _fast tag selection_. This method allows to select and deselect tags
3056 with a single key per tag. To function efficiently, you should assign
3057 unique keys to most tags. This can be done globally with
3059 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
3061 or on a per-file basis with
3063 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
3065 You can also group together tags that are mutually exclusive. With
3068 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
3070 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
3073 Don't forget to press `C-c C-c' with the cursor in one of these lines
3074 to activate any changes.
3076 If at least one tag has a selection key, pressing `C-c C-c' will
3077 automatically present you with a special interface, listing inherited
3078 tags, the tags of the current headline, and a list of all legal tags
3079 with corresponding keys(2). In this interface, you can use the
3083 Pressing keys assigned to tags will add or remove them from the
3084 list of tags in the current line. Selecting a tag in a group of
3085 mutually exclusive tags will turn off any other tags from that
3089 Enter a tag in the minibuffer, even if the tag is not in the
3090 predefined list. You will be able to complete on all tags present
3094 Clear all tags for this line.
3097 Accept the modified set.
3100 Abort without installing changes.
3103 If `q' is not assigned to a tag, it aborts like `C-g'.
3106 Turn off groups of mutually exclusive tags. Use this to (as an
3107 exception) assign several tags from such a group.
3110 Toggle auto-exit after the next change (see below).
3112 This method lets you assign tags to a headline with very few keys. With
3113 the above setup, you could clear the current tags and set `@HOME',
3114 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
3115 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
3116 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
3117 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3120 If you find that most of the time, you need only a single keypress to
3121 modify your list of tags, set the variable
3122 `org-fast-tag-selection-single-key'. Then you no longer have to press
3123 <RET> to exit fast tag selection - it will immediately exit after the
3124 first change. If you then occasionally need more keys, press `C-c' to
3125 turn off auto-exit for the current tag selection process.
3127 ---------- Footnotes ----------
3129 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3130 respectively. Several groups are allowed.
3132 (2) Keys will automatically be assigned to tags which have no
3136 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
3141 Once a tags system has been set up, it can be used to collect related
3142 information into special lists.
3145 Create a sparse tree with all headlines matching a tags search.
3146 With a `C-u' prefix argument, ignore headlines that are not a TODO
3150 Create a global list of tag matches from all agenda files. *Note
3151 Matching headline tags::.
3154 Create a global list of tag matches from all agenda files, but
3155 check only TODO items and force checking subitems (see variable
3156 `org-tags-match-list-sublevels').
3158 A tags search string can use Boolean operators `&' for AND and `|'
3159 for OR. `&' binds more strongly than `|'. Parenthesis are currently
3160 not implemented. A tag may also be preceded by `-', to select against
3161 it, and `+' is syntactic sugar for positive selection. The AND
3162 operator `&' is optional when `+' or `-' is present. Examples:
3165 Select headlines tagged `:WORK:', but discard those also tagged
3169 Selects lines tagged `:WORK:' or `:LAPTOP:'.
3172 Like before, but require the `:LAPTOP:' lines to be tagged also
3175 If you are using multi-state TODO keywords (*note TODO
3176 extensions::), it can be useful to also match on the TODO keyword.
3177 This can be done by adding a condition after a slash to a tags match.
3178 The syntax is similar to the tag matches, but should be applied with
3179 consideration: For example, a positive selection on several TODO
3180 keywords can not meaningfully be combined with boolean AND. However,
3181 _negative selection_ combined with AND can be meaningful. To make sure
3182 that only lines are checked that actually have any TODO keyword, use
3183 `C-c a M', or equivalently start the todo part after the slash with `!'.
3187 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3190 `WORK/!-WAITING-NEXT'
3191 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3194 `WORK/+WAITING|+NEXT'
3195 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3198 Any element of the tag/todo match can be a regular expression - in
3199 this case it must be enclosed in curly braces. For example,
3200 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3201 tag starting with `BOSS'.
3203 You can also require a headline to be of a certain level, by writing
3204 instead of any TAG an expression like `LEVEL=3'. For example, a search
3205 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3206 BOSS and are _not_ marked with the todo keyword DONE.
3209 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
3214 Due to the way Org-mode works, TODO items, time-stamped items, and
3215 tagged headlines can be scattered throughout a file or even a number of
3216 files. To get an overview over open action items, or over events that
3217 are important for a particular date, this information must be collected,
3218 sorted and displayed in an organized way.
3220 Org-mode can select items based on various criteria, and display them
3221 in a separate buffer. Six different view types are provided:
3223 * an _agenda_ that is like a calendar and shows information for
3226 * a _TODO list_ that covers all unfinished action items,
3228 * a _tags view_, showings headlines based on the tags associated
3231 * a _timeline view_ that shows all events in a single Org-mode file,
3232 in time-sorted view,
3234 * a _stuck projects view_ showing projects that currently don't move
3237 * _custom views_ that are special tag/keyword searches and
3238 combinations of different views.
3240 The extracted information is displayed in a special _agenda buffer_.
3241 This buffer is read-only, but provides commands to visit the
3242 corresponding locations in the original Org-mode files, and even to
3243 edit these files remotely.
3245 Two variables control how the agenda buffer is displayed and whether
3246 the window configuration is restored when the agenda exits:
3247 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3251 * Agenda files:: Files being searched for agenda information
3252 * Agenda dispatcher:: Keyboard access to agenda views
3253 * Built-in agenda views:: What is available out of the box?
3254 * Presentation and sorting:: How agenda items are prepared for display
3255 * Agenda commands:: Remote editing of org trees
3256 * Custom agenda views:: Defining special searches and views
3259 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
3264 The information to be shown is collected from all _agenda files_, the
3265 files listed in the variable `org-agenda-files'(1). Thus even if you
3266 only work with a single Org-mode file, this file should be put into
3267 that list(2). You can customize `org-agenda-files', but the easiest
3268 way to maintain it is through the following commands
3271 Add current file to the list of agenda files. The file is added to
3272 the front of the list. If it was already in the list, it is moved
3273 to the front. With prefix arg, file is added/moved to the end.
3276 Remove current file from the list of agenda files.
3280 Cycle through agenda file list, visiting one file after the other.
3282 The Org menu contains the current list of files and can be used to
3285 ---------- Footnotes ----------
3287 (1) If the value of that variable is not a list, but a single file
3288 name, then the list of agenda files will be maintained in that external
3291 (2) When using the dispatcher, pressing `1' before selecting a
3292 command will actually limit the command to the current file, and ignore
3293 `org-agenda-files' until the next dispatcher command.
3296 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3298 8.2 The agenda dispatcher
3299 =========================
3301 The views are created through a dispatcher that should be bound to a
3302 global key, for example `C-c a' (*note Installation::). In the
3303 following we will assume that `C-c a' is indeed how the dispatcher is
3304 accessed and list keyboard access to commands accordingly. After
3305 pressing `C-c a', an additional letter is required to execute a
3306 command. The dispatcher offers the following default commands:
3308 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3311 Create a list of all TODO items (*note Global TODO list::).
3314 Create a list of headlines matching a TAGS expression (*note
3315 Matching headline tags::).
3318 Create the timeline view for the current buffer (*note Timeline::).
3321 Create a list of stuck projects (*note Stuck projects::).
3324 Restrict an agenda command to the current buffer. After pressing
3325 `1', you still need to press the character selecting the command.
3328 If there is an active region, restrict the following agenda
3329 command to the region. Otherwise, restrict it to the current
3330 subtree. After pressing `0', you still need to press the
3331 character selecting the command.
3333 You can also define custom commands that will be accessible through
3334 the dispatcher, just like the default commands. This includes the
3335 possibility to create extended agenda buffers that contain several
3336 blocks together, for example the weekly agenda, the global TODO list and
3337 a number of special tags matches. *Note Custom agenda views::.
3340 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3342 8.3 The built-in agenda views
3343 =============================
3345 In this section we describe the built-in views.
3349 * Weekly/Daily agenda:: The calendar page with current tasks
3350 * Global TODO list:: All unfinished action items
3351 * Matching headline tags:: Structured information with fine-tuned search
3352 * Timeline:: Time-sorted view for single file
3353 * Stuck projects:: Find projects you need to review
3356 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3358 8.3.1 The weekly/daily agenda
3359 -----------------------------
3361 The purpose of the weekly/daily _agenda_ is to act like a page of a
3362 paper agenda, showing all the tasks for the current week or day.
3365 Compile an agenda for the current week from a list of org files.
3366 The agenda shows the entries for each day. With a `C-u' prefix (or
3367 when the variable `org-agenda-include-all-todo' is `t'), all
3368 unfinished TODO items (including those without a date) are also
3369 listed at the beginning of the buffer, before the first date.
3371 Remote editing from the agenda buffer means, for example, that you
3372 can change the dates of deadlines and appointments from the agenda
3373 buffer. The commands available in the Agenda buffer are listed in
3374 *Note Agenda commands::.
3376 Calendar/Diary integration
3377 ..........................
3379 Emacs contains the calendar and diary by Edward M. Reingold. The
3380 calendar displays a three-month calendar with holidays from different
3381 countries and cultures. The diary allows you to keep track of
3382 anniversaries, lunar phases, sunrise/set, recurrent appointments
3383 (weekly, monthly) and more. In this way, it is quite complementary to
3384 Org-mode. It can be very useful to combine output from Org-mode with
3387 In order to include entries from the Emacs diary into Org-mode's
3388 agenda, you only need to customize the variable
3390 (setq org-agenda-include-diary t)
3392 After that, everything will happen automatically. All diary entries
3393 including holidays, anniversaries etc will be included in the agenda
3394 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3395 the agenda buffer to jump to the diary file in order to edit existing
3396 diary entries. The `i' command to insert new entries for the current
3397 date works in the agenda buffer, as well as the commands `S', `M', and
3398 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3399 to other calendars, respectively. `c' can be used to switch back and
3400 forth between calendar and agenda.
3403 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3405 8.3.2 The global TODO list
3406 --------------------------
3408 The global TODO list contains all unfinished TODO items, formatted and
3409 collected into a single place.
3412 Show the global TODO list. This collects the TODO items from all
3413 agenda files (*note Agenda views::) into a single buffer. The
3414 buffer is in `agenda-mode', so there are commands to examine and
3415 manipulate the TODO entries directly from that buffer (*note
3419 Like the above, but allows selection of a specific TODO keyword.
3420 You can also do this by specifying a prefix argument to `C-c a t'.
3421 With a `C-u' prefix you are prompted for a keyword. With a
3422 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
3423 `r' key in the agenda buffer regenerates it, and you can give a
3424 prefix argument to this command to change the selected TODO
3425 keyword, for example `3 r'. If you often need a search for a
3426 specific keyword, define a custom command for it (*note Agenda
3428 Matching specific TODO keywords can also be done as part of a tags
3429 search (*note Tag searches::).
3431 Remote editing of TODO items means that you can change the state of a
3432 TODO entry with a single key press. The commands available in the TODO
3433 list are described in *Note Agenda commands::.
3435 Normally the global todo list simply shows all headlines with TODO
3436 keywords. This list can become very long. There are two ways to keep
3438 - Some people view a TODO item that has been _scheduled_ for
3439 execution (*note Time stamps::) as no longer _open_. Configure the
3440 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3441 items from the global TODO list.
3443 - TODO items may have sublevels to break up the task into subtasks.
3444 In such cases it may be enough to list only the highest level TODO
3445 headline and omit the sublevels from the global list. Configure
3446 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3449 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3451 8.3.3 Matching headline tags
3452 ----------------------------
3454 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3455 you can select headlines based on the tags that apply to them and
3456 collect them into an agenda buffer.
3459 Produce a list of all headlines that match a given set of tags.
3460 The command prompts for a selection criterion, which is a boolean
3461 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3462 `WORK|HOME' (*note Tags::). If you often need a specific search,
3463 define a custom command for it (*note Agenda dispatcher::).
3466 Like `C-c a m', but only select headlines that are also TODO items
3467 and force checking subitems (see variable
3468 `org-tags-match-list-sublevels'). Matching specific todo keywords
3469 together with a tags match is also possible, see *Note Tag
3472 The commands available in the tags list are described in *Note
3476 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3478 8.3.4 Timeline for a single file
3479 --------------------------------
3481 The timeline summarizes all time-stamped items from a single Org-mode
3482 file in a _time-sorted view_. The main purpose of this command is to
3483 give an overview over events in a project.
3486 Show a time-sorted view of the org file, with all time-stamped
3487 items. When called with a `C-u' prefix, all unfinished TODO
3488 entries (scheduled or not) are also listed under the current date.
3490 The commands available in the timeline buffer are listed in *Note
3494 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3496 8.3.5 Stuck projects
3497 --------------------
3499 If you are following a system like David Allen's GTD to organize your
3500 work, one of the "duties" you have is a regular review to make sure
3501 that all projects move along. A _stuck_ project is a project that has
3502 no defined next actions, so it will never show up in the TODO lists
3503 Org-mode produces. During the review, you need to identify such
3504 projects and define next actions for them.
3507 List projects that are stuck.
3510 Customize the variable `org-stuck-projects' to define what a stuck
3511 project is and how to find it.
3513 You almost certainly will have to configure this view before it will
3514 work for you. The built-in default assumes that all your projects are
3515 level-2 headlines, and that a project is not stuck if it has at least
3516 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3518 Lets assume that you, in your own way of using Org-mode, identify
3519 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3520 indicate a project that should not be considered yet. Lets further
3521 assume that the todo keyword DONE marks finished projects, and that NEXT
3522 and TODO indicate next actions. Finally, the tag @SHOP indicates
3523 shopping and is a next action even without the NEXT tag. In this case
3524 you would start by identifying eligible projects with a tags/todo match
3525 `+PROJECT/-MAYBE-DONE', and then check for TODO, NEXT and @SHOP in the
3526 subtree to identify projects that are not stuck. The correct
3527 customization for this is
3529 (setq org-stuck-projects
3530 ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")))
3533 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3535 8.4 Presentation and sorting
3536 ============================
3538 Before displaying items in an agenda view, Org-mode visually prepares
3539 the items and sorts them. Each item occupies a single line. The line
3540 starts with a _prefix_ that contains the _category_ (*note
3541 Categories::) of the item and other important information. You can
3542 customize the prefix using the option `org-agenda-prefix-format'. The
3543 prefix is followed by a cleaned-up version of the outline headline
3544 associated with the item.
3548 * Categories:: Not all tasks are equal
3549 * Time-of-day specifications:: How the agenda knows the time
3550 * Sorting of agenda items:: The order of things
3553 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3558 The category is a broad label assigned to each agenda item. By default,
3559 the category is simply derived from the file name, but you can also
3560 specify it with a special line in the buffer, like this:
3564 If there are several such lines in a file, each specifies the
3565 category for the text below it (but the first category also applies to
3566 any text before the first CATEGORY line). The display in the agenda
3567 buffer looks best if the category is not longer than 10 characters.
3570 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3572 8.4.2 Time-of-Day Specifications
3573 --------------------------------
3575 Org-mode checks each agenda item for a time-of-day specification. The
3576 time can be part of the time stamp that triggered inclusion into the
3577 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3578 specified with two time stamps, like
3579 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3581 In the headline of the entry itself, a time(range) may also appear as
3582 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3583 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3584 entries are recognized as well.
3586 For agenda display, Org-mode extracts the time and displays it in a
3587 standard 24 hour format as part of the prefix. The example times in
3588 the previous paragraphs would end up in the agenda like this:
3590 8:30-13:00 Arthur Dent lies in front of the bulldozer
3591 12:45...... Ford Prefect arrives and takes Arthur to the pub
3592 19:00...... The Vogon reads his poem
3593 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3595 If the agenda is in single-day mode, or for the display of today, the
3596 timed entries are embedded in a time grid, like
3598 8:00...... ------------------
3599 8:30-13:00 Arthur Dent lies in front of the bulldozer
3600 10:00...... ------------------
3601 12:00...... ------------------
3602 12:45...... Ford Prefect arrives and takes Arthur to the pub
3603 14:00...... ------------------
3604 16:00...... ------------------
3605 18:00...... ------------------
3606 19:00...... The Vogon reads his poem
3607 20:00...... ------------------
3608 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3610 The time grid can be turned on and off with the variable
3611 `org-agenda-use-time-grid', and can be configured with
3612 `org-agenda-time-grid'.
3615 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3617 8.4.3 Sorting of agenda items
3618 -----------------------------
3620 Before being inserted into a view, the items are sorted. How this is
3621 done depends on the type of view.
3622 * For the daily/weekly agenda, the items for each day are sorted.
3623 The default order is to first collect all items containing an
3624 explicit time-of-day specification. These entries will be shown
3625 at the beginning of the list, as a _schedule_ for the day. After
3626 that, items remain grouped in categories, in the sequence given by
3627 `org-agenda-files'. Within each category, items are sorted by
3628 priority (*note Priorities::), which is composed of the base
3629 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3630 plus additional increments for overdue scheduled or deadline items.
3632 * For the TODO list, items remain in the order of categories, but
3633 within each category, sorting takes place according to priority
3634 (*note Priorities::).
3636 * For tags matches, items are not sorted at all, but just appear in
3637 the sequence in which they are found in the agenda files.
3639 Sorting can be customized using the variable
3640 `org-agenda-sorting-strategy'.
3643 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3645 8.5 Commands in the agenda buffer
3646 =================================
3648 Entries in the agenda buffer are linked back to the org file or diary
3649 file where they originate. You are not allowed to edit the agenda
3650 buffer itself, but commands are provided to show and jump to the
3651 original entry location, and to edit the org-files "remotely" from the
3652 agenda buffer. In this way, all information is stored only once,
3653 removing the risk that your agenda and note files may diverge.
3655 Some commands can be executed with mouse clicks on agenda lines. For
3656 the other commands, the cursor needs to be in the desired line.
3662 Next line (same as <up>).
3665 Previous line (same as <down>).
3672 Display the original location of the item in another window.
3675 Display original location and recenter that window.
3680 Go to the original location of the item in another window. Under
3681 Emacs 22, `mouse-1' will also works for this.
3684 Go to the original location of the item and delete other windows.
3687 Toggle Follow mode. In Follow mode, as you move the cursor through
3688 the agenda buffer, the other window always shows the corresponding
3689 location in the org file. The initial setting for this mode in new
3690 agenda buffers can be set with the variable
3691 `org-agenda-start-with-follow-mode'.
3694 Display the entire subtree of the current item in an indirect
3695 buffer. With numerical prefix ARG, go up to this level and then
3696 take that tree. If ARG is negative, go up that many levels. With
3697 `C-u' prefix, do not remove the previously used indirect buffer.
3700 Toggle Logbook mode. In Logbook mode, entries that where marked
3701 DONE while logging was on (variable `org-log-done') are shown in
3702 the agenda, as are entries that have been clocked on that day.
3708 Delete other windows.
3711 Switch to weekly view (7 days displayed together).
3714 Switch to daily view (just one day displayed).
3717 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3721 Toggle the time grid on and off. See also the variables
3722 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3725 Recreate the agenda buffer, for example to reflect the changes
3726 after modification of the time stamps of items with S-<left> and
3727 S-<right>. When the buffer is the global todo list, a prefix
3728 argument is interpreted to create a selective list for a specific
3732 Save all Org-mode buffers in the current Emacs session.
3735 Display the following `org-agenda-ndays' days. For example, if
3736 the display covers a week, switch to the following week. With
3737 prefix arg, go forward that many times `org-agenda-ndays' days.
3740 Display the previous dates.
3752 Undo a change due to a remote editing command. The change is
3753 undone both in the agenda buffer and in the remote buffer.
3756 Change the TODO state of the item, both in the agenda and in the
3760 Delete the current agenda item along with the entire subtree
3761 belonging to it in the original Org-mode file. If the text to be
3762 deleted remotely is longer than one line, the kill needs to be
3763 confirmed by the user. See variable `org-agenda-confirm-kill'.
3766 Archive the subtree corresponding to the current headline.
3769 Show all tags associated with the current item. Because of
3770 inheritance, this may be more than the tags listed in the line
3774 Set tags for the current headline.
3777 Toggle the ARCHIVE tag for the current headline.
3780 Set the priority for the current item. Org-mode prompts for the
3781 priority character. If you reply with <SPC>, the priority cookie
3782 is removed from the entry.
3785 Display weighted priority of current item.
3789 Increase the priority of the current item. The priority is
3790 changed in the original buffer, but the agenda is not resorted.
3791 Use the `r' key for this.
3795 Decrease the priority of the current item.
3801 Set a deadline for this item.
3804 Change the time stamp associated with the current line by one day
3805 into the future. With prefix argument, change it by that many
3806 days. For example, `3 6 5 S-<right>' will change it by a year.
3807 The stamp is changed in the original org file, but the change is
3808 not directly reflected in the agenda buffer. Use the `r' key to
3812 Change the time stamp associated with the current line by one day
3816 Change the time stamp associated with the current line to today.
3817 The key `>' has been chosen, because it is the same as `S-.' on my
3821 Start the clock on the current item. If a clock is running
3822 already, it is stopped first.
3825 Stop the previously started clock.
3828 Cancel the currently running clock.
3834 Open the Emacs calendar and move to the date at the agenda cursor.
3837 When in the calendar, compute and show the Org-mode agenda for the
3841 Insert a new entry into the diary. Prompts for the type of entry
3842 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3843 new entry in the diary, just as `i d' etc. would do in the
3844 calendar. The date is taken from the cursor position.
3847 Show the phases of the moon for the three months around current
3851 Show sunrise and sunset times. The geographical location must be
3852 set with calendar variables, see documentation of the Emacs
3856 Convert the date at cursor into many other cultural and historic
3860 Show holidays for three month around the cursor date.
3863 Export a single iCalendar file containing entries from all agenda
3870 Quit agenda, remove the agenda buffer.
3873 Exit agenda, remove the agenda buffer and all buffers loaded by
3874 Emacs for the compilation of the agenda. Buffers created by the
3875 user to visit org files will not be removed.
3879 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3881 8.6 Custom agenda views
3882 =======================
3884 Custom agenda commands serve two purposes: to store and quickly access
3885 frequently used TODO and tags searches, and to create special composite
3886 agenda buffers. Custom agenda commands will be accessible through the
3887 dispatcher (*note Agenda dispatcher::), just like the default commands.
3891 * Storing searches:: Type once, use often
3892 * Block agenda:: All the stuff you need in a single buffer
3893 * Setting Options:: Changing the rules
3894 * Batch processing:: Agenda views from the command line
3897 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3899 8.6.1 Storing searches
3900 ----------------------
3902 The first application of custom searches is the definition of keyboard
3903 shortcuts for frequently used searches, either creating an agenda
3904 buffer, or a sparse tree (the latter covering of course only the current
3905 buffer). Custom commands are configured in the variable
3906 `org-agenda-custom-commands'. You can customize this variable, for
3907 example by pressing `C-c a C'. You can also directly set it with Emacs
3908 Lisp in `.emacs'. The following example contains all valid search
3911 (setq org-agenda-custom-commands
3912 '(("w" todo "WAITING")
3913 ("W" todo-tree "WAITING")
3914 ("u" tags "+BOSS-URGENT")
3915 ("v" tags-todo "+BOSS-URGENT")
3916 ("U" tags-tree "+BOSS-URGENT")
3917 ("f" occur-tree "\\<FIXME\\>")))
3919 The initial single-character string in each entry defines the character
3920 you have to press after the dispatcher command `C-c a' in order to
3921 access the command. The second parameter is the search type, followed
3922 by the string or regular expression to be used for the matching. The
3923 example above will therefore define:
3926 as a global search for TODO entries with `WAITING' as the TODO
3930 as the same search, but only in the current buffer and displaying
3931 the results as a sparse tree
3934 as a global tags search for headlines marked `:BOSS:' but not
3938 as the same search as `C-c a u', but limiting the search to
3939 headlines that are also TODO items
3942 as the same search as `C-c a u', but only in the current buffer and
3943 displaying the result as a sparse tree
3946 to create a sparse tree (again: current buffer only) with all
3947 entries containing the word `FIXME'.
3950 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3955 Another possibility is the construction of agenda views that comprise
3956 the results of _several_ commands, each of which creates a block in the
3957 agenda buffer. The available commands include `agenda' for the daily
3958 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3959 todo list (as constructed with `C-c a t'), and the matching commands
3960 discussed above: `todo', `tags', and `tags-todo'. Here are two
3963 (setq org-agenda-custom-commands
3964 '(("h" "Agenda and Home-related tasks"
3968 ("o" "Agenda and Office-related tasks"
3973 This will define `C-c a h' to create a multi-block view for stuff you
3974 need to attend to at home. The resulting agenda buffer will contain
3975 your agenda for the current week, all TODO items that carry the tag
3976 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3977 `C-c a o' provides a similar view for office tasks.
3980 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3982 8.6.3 Setting Options for custom commands
3983 -----------------------------------------
3985 Org-mode contains a number of variables regulating agenda construction
3986 and display. The global variables define the behavior for all agenda
3987 commands, including the custom commands. However, if you want to change
3988 some settings just for a single custom view, you can do so. Setting
3989 options requires inserting a list of variable names and values at the
3990 right spot in `org-agenda-custom-commands'. For example:
3992 (setq org-agenda-custom-commands
3993 '(("w" todo "WAITING"
3994 ((org-agenda-sorting-strategy '(priority-down))
3995 (org-agenda-prefix-format " Mixed: ")))
3996 ("U" tags-tree "+BOSS-URGENT"
3997 ((org-show-following-heading nil)
3998 (org-show-hierarchy-above nil)))))
4000 Now the `C-c a w' command will sort the collected entries only by
4001 priority, and the prefix format is modified to just say ` Mixed:'
4002 instead of giving the category of the entry. The sparse tags tree of
4003 `C-c a U' will now turn out ultra-compact, because neither the headline
4004 hierarchy above the match, nor the headline following the match will be
4007 For command sets creating a block agenda,
4008 `org-agenda-custom-commands' has two separate spots for setting
4009 options. You can add options that should be valid for just a single
4010 command in the set, and options that should be valid for all commands in
4011 the set. The former are just added to the command entry, the latter
4012 must come after the list of command entries. Going back to the block
4013 agenda example (*note Block agenda::), let's change the sorting strategy
4014 for the `C-c a h' commands to `priority-down', but let's sort the
4015 results for GARDEN tags query in the opposite order, `priority-up'.
4016 This would look like this:
4018 (setq org-agenda-custom-commands
4019 '(("h" "Agenda and Home-related tasks"
4022 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
4023 ((org-agenda-sorting-strategy '(priority-down))))
4024 ("o" "Agenda and Office-related tasks"
4029 As you see, the values and parenthesis setting is a little complex.
4030 When in doubt, use the customize interface to set this variable - it
4031 fully supports its structure. Just one caveat: When setting options in
4032 this interface, the _values_ are just lisp expressions. So if the
4033 value is a string, you need to add the double quotes around the value
4037 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
4039 8.6.4 Creating agenda views in batch processing
4040 -----------------------------------------------
4042 If you want to print or otherwise reprocess agenda views, it can be
4043 useful to create an agenda from the command line. This is the purpose
4044 of the function `org-batch-agenda'. It takes as a parameter one of the
4045 strings that are the keys in `org-agenda-custom-commands'. For
4046 example, to directly print the current TODO list, you could use
4048 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4050 You may also modify parameters on the fly like this:
4052 emacs -batch -l ~/.emacs \
4053 -eval '(org-batch-agenda "a" \
4054 org-agenda-ndays 300 \
4055 org-agenda-include-diary nil \
4056 org-agenda-files (quote ("~/org/project.org")))' \
4059 which will produce a 300 day agenda, fully restricted to the Org file
4060 `~/org/projects.org', not even including the diary.
4063 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
4068 Plain ASCII is normally sufficient for almost all note taking. One
4069 exception, however, are scientific notes which need to be able to
4070 contain mathematical symbols and the occasional formula. LaTeX(1) is
4071 widely used to typeset scientific documents. Org-mode supports
4072 embedding LaTeX code into its files, because many academics are used to
4073 read LaTeX source code, and because it can be readily processed into
4074 images for HTML production.
4076 It is not necessary to mark LaTeX macros and code in any special way.
4077 If you observe a few conventions, Org-mode knows how to find it and what
4082 * Math symbols:: TeX macros for symbols and Greek letters
4083 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
4084 * LaTeX fragments:: Complex formulas made easy
4085 * Processing LaTeX fragments:: Previewing LaTeX processing
4086 * CDLaTeX mode:: Speed up entering of formulas
4088 ---------- Footnotes ----------
4090 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4091 Many of the features described here as "LaTeX" are really from TeX, but
4092 for simplicity I am blurring this distinction.
4095 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
4100 You can use LaTeX macros to insert special symbols like `\alpha' to
4101 indicate the Greek letter, or `\to' to indicate an arrow. Completion
4102 for these macros is available, just type `\' and maybe a few letters,
4103 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
4104 Org-mode allows these macros to be present without surrounding math
4105 delimiters, for example:
4107 Angles are written as Greek letters \alpha, \beta and \gamma.
4109 During HTML export (*note HTML export::), these symbols are
4110 translated into the proper syntax for HTML, for the above examples this
4111 is `α' and `→', respectively.
4114 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
4116 9.2 Subscripts and Superscripts
4117 ===============================
4119 Just like in LaTeX, `^' and `_' are used to indicate super- and
4120 subscripts. Again, these can be used without embedding them in
4121 math-mode delimiters. To increase the readability of ASCII text, it is
4122 not necessary (but OK) to surround multi-character sub- and superscripts
4123 with curly braces. For example
4125 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
4126 the sun is R_{sun} = 6.96 x 10^8 m.
4128 To avoid interpretation as raised or lowered text, you can quote `^'
4129 and `_' with a backslash: `\_' and `\^'.
4131 During HTML export (*note HTML export::), subscript and superscripts
4132 are surrounded with `<sub>' and `<sup>' tags, respectively.
4135 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
4140 With symbols, sub- and superscripts, HTML is pretty much at its end when
4141 it comes to representing mathematical formulas(1). More complex
4142 expressions need a dedicated formula processor. To this end, Org-mode
4143 can contain arbitrary LaTeX fragments. It provides commands to preview
4144 the typeset result of these fragments, and upon export to HTML, all
4145 fragments will be converted to images and inlined into the HTML
4146 document. For this to work you need to be on a system with a working
4147 LaTeX installation. You also need the `dvipng' program, available at
4148 `http://sourceforge.net/projects/dvipng/'.
4150 LaTeX fragments don't need any special marking at all. The following
4151 snippets will be identified as LaTeX source code:
4152 * Environments of any kind. The only requirement is that the
4153 `\begin' statement appears on a new line, preceded by only
4156 * Text within the usual LaTeX math delimiters. To avoid conflicts
4157 with currency specifications, single `$' characters are only
4158 recognized as math delimiters if the enclosed text contains at
4159 most two line breaks, is directly attached to the `$' characters
4160 with no whitespace in between, and if the closing `$' is followed
4161 by whitespace or punctuation. For the other delimiters, there is
4162 no such restriction, so when in doubt, use `\(...\)' as inline
4167 \begin{equation} % arbitrary environments,
4168 x=\sqrt{b} % even tables, figures
4169 \end{equation} % etc
4171 If $a^2=b$ and \( b=2 \), then the solution must be
4172 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4174 If you need any of the delimiter ASCII sequences for other purposes, you
4175 can configure the option `org-format-latex-options' to deselect the
4176 ones you do not wish to have interpreted by the LaTeX converter.
4178 ---------- Footnotes ----------
4180 (1) Yes, there is MathML, but that is not yet fully supported by
4181 many browsers, and there is no decent converter for turning LaTeX of
4182 ASCII representations of formulas into MathML. So for the time being,
4183 converting formulas into images seems the way to go.
4186 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
4188 9.4 Processing LaTeX fragments
4189 ==============================
4191 LaTeX fragments can be processed to produce a preview images of the
4192 typeset expressions:
4195 Produce a preview image of the LaTeX fragment at point and overlay
4196 it over the source code. If there is no fragment at point,
4197 process all fragments in the current entry (between two
4198 headlines). When called with a prefix argument, process the
4199 entire subtree. When called with two prefix arguments, or when
4200 the cursor is before the first headline, process the entire buffer.
4203 Remove the overlay preview images.
4205 During HTML export (*note HTML export::), all LaTeX fragments are
4206 converted into images and inlined into the document if the following
4209 (setq org-export-with-LaTeX-fragments t)
4212 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
4214 9.5 Using CDLaTeX to enter math
4215 ===============================
4217 CDLaTeX-mode is a minor mode that is normally used in combination with a
4218 major LaTeX mode like AUCTeX in order to speed-up insertion of
4219 environments and math templates. Inside Org-mode, you can make use of
4220 some of the features of cdlatex-mode. You need to install `cdlatex.el'
4221 and `texmathp.el' (the latter comes also with AUCTeX) from
4222 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
4223 cdlatex-mode itself under Org-mode, but use the light version
4224 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
4225 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4228 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4230 When this mode is enabled, the following features are present (for
4231 more details see the documentation of cdlatex-mode):
4232 * Environment templates can be inserted with `C-c {'.
4234 * The <TAB> key will do template expansion if the cursor is inside a
4235 LaTeX fragment(1). For example, <TAB> will expand `fr' to
4236 `\frac{}{}' and position the cursor correctly inside the first
4237 brace. Another <TAB> will get you into the second brace. Even
4238 outside fragments, <TAB> will expand environment abbreviations at
4239 the beginning of a line. For example, if you write `equ' at the
4240 beginning of a line and press <TAB>, this abbreviation will be
4241 expanded to an `equation' environment. To get a list of all
4242 abbreviations, type `M-x cdlatex-command-help'.
4244 * Pressing `_' and `^' inside a LaTeX fragment will insert these
4245 characters together with a pair of braces. If you use <TAB> to
4246 move out of the braces, and if the braces surround only a single
4247 character or macro, they are removed again (depending on the
4248 variable `cdlatex-simplify-sub-super-scripts').
4250 * Pressing the backquote ``' followed by a character inserts math
4251 macros, also outside LaTeX fragments. If you wait more than 1.5
4252 seconds after the backquote, a help window will pop up.
4254 * Pressing the normal quote `'' followed by another character
4255 modifies the symbol before point with an accent or a font. If you
4256 wait more than 1.5 seconds after the backquote, a help window will
4257 pop up. Character modification will work only inside LaTeX
4258 fragments, outside the quote is normal.
4260 ---------- Footnotes ----------
4262 (1) Org-mode has a method to test if the cursor is inside such a
4263 fragment, see the documentation of the function
4264 `org-inside-LaTeX-fragment-p'.
4267 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
4272 Org-mode documents can be exported into a variety of other formats. For
4273 printing and sharing of notes, ASCII export produces a readable and
4274 simple version of an Org-mode file. HTML export allows you to publish a
4275 notes file on the web, while the XOXO format provides a solid base for
4276 exchange with a broad range of other applications. To incorporate
4277 entries with associated times like deadlines or appointments into a
4278 desktop calendar program like iCal, Org-mode can also produce extracts
4279 in the iCalendar format. Currently Org-mode only supports export, not
4280 import of these different formats.
4282 When exporting, Org-mode uses special conventions to enrich the
4283 output produced. *Note Text interpretation::, for more details.
4286 Dispatcher for export and publishing commands. Displays a
4287 help-window listing the additional key(s) needed to launch an
4288 export or publishing command.
4292 * ASCII export:: Exporting to plain ASCII
4293 * HTML export:: Exporting to HTML
4294 * XOXO export:: Exporting to XOXO
4295 * iCalendar export:: Exporting in iCalendar format
4296 * Text interpretation:: How the exporter looks at the file
4299 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4304 ASCII export produces a simple and very readable version of an Org-mode
4308 Export as ASCII file. If there is an active region, only the
4309 region will be exported. For an org file `myfile.org', the ASCII
4310 file will be `myfile.txt'. The file will be overwritten without
4314 Export only the visible part of the document.
4316 In the exported version, the first 3 outline levels will become
4317 headlines, defining a general document structure. Additional levels
4318 will be exported as itemized lists. If you want that transition to
4319 occur at a different level, specify it with a prefix argument. For
4324 creates only top level headlines and does the rest as items. When
4325 headlines are converted to items, the indentation of the text following
4326 the headline is changed to fit nicely under the item. This is done with
4327 the assumption that the first bodyline indicates the base indentation of
4328 the body text. Any indentation larger than this is adjusted to preserve
4329 the layout relative to the first line. Should there be lines with less
4330 indentation than the first, these are left alone.
4333 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4338 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4339 HTML formatting, in ways similar to John Grubers _markdown_ language,
4340 but with additional support for tables.
4344 * Export commands:: How to invode HTML export
4345 * Quoting HTML tags:: Using direct HTML in Org-mode
4346 * Links:: How hyperlinks get transferred to HTML
4347 * Images:: To inline or not to inline?
4348 * CSS support:: Style specifications
4351 File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
4353 10.2.1 HTML export commands
4354 ---------------------------
4357 Export as HTML file `myfile.html'.
4360 Export as HTML file and open it with a browser.
4365 Export only the visible part of the document.
4367 In the exported version, the first 3 outline levels will become
4368 headlines, defining a general document structure. Additional levels
4369 will be exported as itemized lists. If you want that transition to
4370 occur at a different level, specify it with a prefix argument. For
4375 creates two levels of headings and does the rest as items.
4378 File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
4380 10.2.2 Quoting HTML tags
4381 ------------------------
4383 If you want to include HTML tags which should be interpreted as such,
4384 mark them with `@' as in `@<b>bold text@</b>'. Note that this wirks
4385 only for simple tags, but not for complex ones like a `<span>' that
4386 contains, for example a link. Plain `<' and `>' are always transformed
4387 to `<' and `>' in HTML export.
4390 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
4395 Internal links (*note Internal links::) will continue to work in HTML
4396 files only if they match a dedicated `<<target>>'. Automatic links
4397 created by radio targets (*note Radio targets::) will also work in the
4398 HTML file. Links to external files will still work if the HTML file is
4399 in the same directory as the Org-mode file. Links to other `.org'
4400 files will be translated into HTML links under the assumption that an
4401 HTML version also exists of the linked file. For information related to
4402 linking files while publishing them to a publishing directory see *Note
4406 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
4411 HTML export can inline images given as links in the Org-mode file, and
4412 it can make an image the clickable part of a link. By default(1),
4413 images are inlined if a link does not have a description. So
4414 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4415 image]]' will just produce a link `the image' that points to the image.
4416 If the description part itself is a `file:' link or a `http:' URL
4417 pointing to an image, this image will be inlined and activated so that
4418 clicking on the image will activate the link. For example, to include
4419 a thumbnail that will link to a high resolution version of the image,
4422 [[file:highres.jpg][file:thumb.jpg]]
4424 and you could use `http' addresses just as well.
4426 ---------- Footnotes ----------
4428 (1) but see the variable `org-export-html-inline-images'
4431 File: org, Node: CSS support, Prev: Images, Up: HTML export
4436 You can also give style information for the exported file. The HTML
4437 exporter assigns the following CSS classes to appropriate parts of the
4438 document - your style specifications may change these:
4440 .done the DONE keyword
4441 .timestamp time stamp
4442 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4443 .tag tag in a headline
4444 .target target for links
4446 The default style specification can be configured through the option
4447 `org-export-html-style'. If you want to use a file-local style, you
4448 may use file variables, best wrapped into a COMMENT section at the end
4449 of the outline tree. For example(1):
4451 * COMMENT html style specifications
4454 # org-export-html-style: " <style type=\"text/css\">
4455 # p {font-weight: normal; color: gray; }
4456 # h1 {color: black; }
4460 Remember to execute `M-x normal-mode' after changing this to make
4461 the new style visible to Emacs. This command restarts org-mode for the
4462 current buffer and forces Emacs to re-evaluate the local variables
4463 section in the buffer.
4465 ---------- Footnotes ----------
4467 (1) Under Emacs 21, the continuation lines for a variable value
4468 should have no `#' at the start of the line.
4471 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4476 Org-mode contains an exporter that produces XOXO-style output.
4477 Currently, this exporter only handles the general outline structure and
4478 does not interpret any additional Org-mode features.
4481 Export as XOXO file `myfile.html'.
4484 Export only the visible part of the document.
4487 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4489 10.4 iCalendar export
4490 =====================
4492 Some people like to use Org-mode for keeping track of projects, but
4493 still prefer a standard calendar application for anniversaries and
4494 appointments. In this case it can be useful to have deadlines and
4495 other time-stamped items in Org-mode files show up in the calendar
4496 application. Org-mode can export calendar information in the standard
4500 Create iCalendar entries for the current file and store them in
4501 the same directory, using a file extension `.ics'.
4504 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4505 For each of these files, a separate iCalendar file will be
4509 Create a single large iCalendar file from all files in
4510 `org-agenda-files' and write it to the file given by
4511 `org-combined-agenda-icalendar-file'.
4513 How this calendar is best read and updated, depends on the
4514 application you are using. The FAQ covers this issue.
4517 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4519 10.5 Text interpretation by the exporter
4520 ========================================
4522 The exporter backends interpret additional structure in the Org-mode
4523 file in order to produce better output.
4527 * Comment lines:: Some lines will not be exported
4528 * Enhancing text:: Subscripts, symbols and more
4529 * Export options:: How to influence the export settings
4532 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
4534 10.5.1 Comment lines
4535 --------------------
4537 Lines starting with `#' in column zero are treated as comments and will
4538 never be exported. Also entire subtrees starting with the word
4539 `COMMENT' will never be exported. Finally, any text before the first
4540 headline will not be exported either.
4543 Toggle the COMMENT keyword at the beginning of an entry.
4546 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
4548 10.5.2 Enhancing text for export
4549 --------------------------------
4551 Some of the export backends of Org-mode allow for sophisticated text
4552 formatting, this is true in particular for the HTML backend. Org-mode
4553 has a number of typing conventions that allow to produce a richly
4556 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4557 enumerator will be recognized and transformed if the backend
4558 supports lists. See *Note Plain lists::.
4560 * You can make words *bold*, /italic/, _underlined_, `=code=', and
4563 * A line consisting of only dashes, and at least 5 of them, will be
4564 exported as a horizontal line (`<hr/>' in HTML).
4566 * Many TeX macros and entire LaTeX fragments are converted into HTML
4567 entities or images (*note Embedded LaTeX::).
4569 * Tables are transformed into native tables under the exporter, if
4570 the export backend supports this. Data fields before the first
4571 horizontal separator line will be formatted as table header fields.
4573 * If a headline starts with the word `QUOTE', the text below the
4574 headline will be typeset as fixed-width, to allow quoting of
4575 computer codes etc. Lines starting with `:' are also typeset in
4578 Toggle fixed-width for entry (QUOTE) or region, see below.
4580 * A double backslash _at the end of a line_ enforces a line break at
4583 If these conversions conflict with your habits of typing ASCII text,
4584 they can all be turned off with corresponding variables (see the
4585 customization group `org-export-general', and the following section
4586 which explains how to set export options with special lines in a buffer.
4589 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
4591 10.5.3 Export options
4592 ---------------------
4594 The exporter recognizes special lines in the buffer which provide
4595 additional information. These lines may be put anywhere in the file.
4596 The whole set of lines can be inserted into the buffer with `C-c C-e
4597 t'. For individual lines, a good way to make sure the keyword is
4598 correct is to type `#+' and then use `M-<TAB>' completion (*note
4602 Insert template with export options, see example below.
4604 #+TITLE: the title to be shown (default is the buffer name)
4605 #+AUTHOR: the author (default taken from `user-full-name')
4606 #+EMAIL: his/her email address (default from `user-mail-address')
4607 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
4608 #+TEXT: Some descriptive text to be inserted at the beginning.
4609 #+TEXT: Several lines may be given.
4610 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
4612 The OPTIONS line is a compact form to specify export settings. Here
4614 H: set the number of headline levels for export
4615 num: turn on/off section-numbers
4616 toc: turn on/off table of contents
4617 \n: turn on/off linebreak-preservation
4618 @: turn on/off quoted HTML tags
4619 :: turn on/off fixed-width sections
4620 |: turn on/off tables
4621 ^: turn on/off TeX-like syntax for sub- and superscripts.
4622 *: turn on/off emphasized text (bold, italic, underlined)
4623 TeX: turn on/off simple TeX macros in plain text
4624 LaTeX: turn on/off LaTeX fragments
4627 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
4632 Org-mode includes(1) a publishing management system that allows you to
4633 configure automatic HTML conversion of _projects_ composed of
4634 interlinked org files. This system is called _org-publish_. You can
4635 also configure org-publish to automatically upload your exported HTML
4636 pages and related attachments, such as images and source code files, to
4637 a web server. Org-publish turns org-mode into a web-site authoring
4640 Org-publish has been contributed to Org-mode by David O'Toole.
4644 * Configuration:: Defining projects
4645 * Sample configuration:: Example projects
4646 * Triggering publication:: Publication commands
4648 ---------- Footnotes ----------
4650 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4651 `org.el' as it comes with Emacs, you need to download this file
4652 separately. Also make sure org.el is at least version 4.27.
4655 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4660 Publishing needs significant configuration to specify files, destination
4661 and many other properties of a project.
4665 * Project alist:: The central configuration variable
4666 * Sources and destinations:: From here to there
4667 * Selecting files:: What files are part of the project?
4668 * Publishing action:: Setting the function doing the publishing
4669 * Publishing options:: Tweaking HTML export
4670 * Publishing links:: Which links keep working after publishing?
4671 * Project page index:: Publishing a list of project files
4674 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4676 11.1.1 The variable `org-publish-project-alist'
4677 -----------------------------------------------
4679 Org-publish is configured almost entirely through setting the value of
4680 one variable, called `org-publish-project-alist'. Each element of the
4681 list configures one project, and may be in one of the two following
4684 ("project-name" :property value :property value ...)
4688 ("project-name" :components ("project-name" "project-name" ...))
4690 In both cases, projects are configured by specifying property values.
4691 A project defines the set of files that will be published, as well as
4692 the publishing configuration to use when publishing those files. When
4693 a project takes the second form listed above, the individual members of
4694 the "components" property are taken to be components of the project,
4695 which group together files requiring different publishing options. When
4696 you publish such a "meta-project" all the components will also publish.
4699 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4701 11.1.2 Sources and destinations for files
4702 -----------------------------------------
4704 Most properties are optional, but some should always be set. In
4705 particular, org-publish needs to know where to look for source files,
4706 and where to put published files.
4708 `:base-directory' Directory containing publishing source files
4709 `:publishing-directory'Directory (possibly remote) where output files
4711 `:preparation-function'Function called before starting publishing
4712 process, for example to run `make' for updating
4713 files to be published.
4716 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4718 11.1.3 Selecting files
4719 ----------------------
4721 By default, all files with extension `.org' in the base directory are
4722 considered part of the project. This can be modified by setting the
4724 `:base-extension' Extension (without the dot!) of source files. This
4725 actually is a regular expression.
4726 `:exclude' Regular expression to match file names that should
4727 not be published, even though they have been selected
4728 on the basis of their extension.
4729 `:include' List of files to be included regardless of
4730 `:base-extension' and `:exclude'.
4733 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4735 11.1.4 Publishing Action
4736 ------------------------
4738 Publishing means that a file is copied to the destination directory and
4739 possibly transformed in the process. The default transformation is to
4740 export Org-mode files as HTML files, and this is done by the function
4741 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4742 export::). Other files like images only need to be copied to the
4743 publishing destination. For non-Org-mode files, you need to specify
4744 the publishing function.
4746 `:publishing-function' Function executing the publication of a file.
4747 This may also be a list of functions, which will
4748 all be called in turn.
4750 The function must accept two arguments: a property list containing at
4751 least a `:publishing-directory' property, and the name of the file to
4752 be published. It should take the specified file, make the necessary
4753 transformation (if any) and place the result into the destination
4754 folder. You can write your own publishing function, but `org-publish'
4755 provides one for attachments (files that only need to be copied):
4756 `org-publish-attachment'.
4759 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4761 11.1.5 Options for the HTML exporter
4762 ------------------------------------
4764 The property list can be used to set many export options for the HTML
4765 exporter. In most cases, these properties correspond to user variables
4766 in Org-mode. The table below lists these properties along with the
4767 variable they belong to. See the documentation string for the
4768 respective variable for details.
4770 `:language' `org-export-default-language'
4771 `:headline-levels' `org-export-headline-levels'
4772 `:section-numbers' `org-export-with-section-numbers'
4773 `:table-of-contents' `org-export-with-toc'
4774 `:archived-trees' `org-export-with-archived-trees'
4775 `:emphasize' `org-export-with-emphasize'
4776 `:sub-superscript' `org-export-with-sub-superscripts'
4777 `:TeX-macros' `org-export-with-TeX-macros'
4778 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4779 `:fixed-width' `org-export-with-fixed-width'
4780 `:timestamps' `org-export-with-timestamps'
4782 `:tags' `org-export-with-tags'
4784 `:tables' `org-export-with-tables'
4785 `:table-auto-headline' `org-export-highlight-first-table-line'
4786 `:style' `org-export-html-style'
4787 `:convert-org-links' `org-export-html-link-org-files-as-html'
4788 `:inline-images' `org-export-html-inline-images'
4789 `:expand-quoted-html' `org-export-html-expand'
4790 `:timestamp' `org-export-html-with-timestamp'
4791 `:publishing-directory'`org-export-publishing-directory'
4792 `:preamble' `org-export-html-preamble'
4793 `:postamble' `org-export-html-postamble'
4794 `:auto-preamble' `org-export-html-auto-preamble'
4795 `:auto-postamble' `org-export-html-auto-postamble'
4796 `:author' `user-full-name'
4797 `:email' `user-mail-address'
4799 When a property is given a value in org-publish-project-alist, its
4800 setting overrides the value of the corresponding user variable (if any)
4801 during publishing. options set within a file (*note Export options::),
4802 however, override everything.
4805 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4807 11.1.6 Links between published files
4808 ------------------------------------
4810 To create a link from one Org-mode file to another, you would use
4811 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4812 (*note Hyperlinks::). Upon publishing this link becomes a link to
4813 `foo.html'. In this way, you can interlink the pages of your "org web"
4814 project and the links will work as expected when you publish them to
4817 You may also link to related files, such as images. Provided you are
4818 careful with relative pathnames, and provided you have also configured
4819 org-publish to upload the related files, these links will work too.
4820 *Note Complex example:: for an example of this usage.
4822 Sometime an Org-mode file to be published may contain links that are
4823 only valid in your production environment, but not in the publishing
4824 location. In this case, use the property
4826 `:link-validation-function' Function to validate links
4828 to define a function for checking link validity. This function must
4829 accept two arguments, the file name and a directory relative to which
4830 the file name is interpreted in the production environment. If this
4831 function returns `nil', then the HTML generator will only insert a
4832 description into the HTML file, but no link. One option for this
4833 function is `org-publish-validate-link' which checks if the given file
4834 is part of any project in `org-publish-project-alist'.
4837 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4839 11.1.7 Project page index
4840 -------------------------
4842 The following properties may be used to control publishing of an index
4843 of files or summary page for a given project.
4845 `:auto-index' When non-nil, publish an index during
4846 org-publish-current-project or org-publish-all.
4847 `:index-filename' Filename for output of index. Defaults to `index.org'
4848 (which becomes `index.html').
4849 `:index-title' Title of index page. Defaults to name of file.
4850 `:index-function' Plugin function to use for generation of index.
4851 Defaults to `org-publish-org-index', which generates
4852 a plain list of links to all files in the project.
4855 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4857 11.2 Sample configuration
4858 =========================
4860 Below we provide two example configurations. The first one is a simple
4861 project publishing only a set of Org-mode files. The second example is
4862 more complex, with a multi-component project.
4866 * Simple example:: One-component publishing
4867 * Complex example:: A multi-component publishing example
4870 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4872 11.2.1 Example: simple publishing configuration
4873 -----------------------------------------------
4875 This example publishes a set of Org-mode files to the `public_html'
4876 directory on the local machine.
4878 (setq org-publish-project-alist
4880 :base-directory "~/org/"
4881 :publishing-directory "~/public_html"
4882 :section-numbers nil
4883 :table-of-contents nil
4884 :style "<link rel=stylesheet
4885 href=\"../other/mystyle.css\"
4886 type=\"text/css\">")))
4889 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4891 11.2.2 Example: complex publishing configuration
4892 ------------------------------------------------
4894 This more complicated example publishes an entire website, including
4895 org files converted to HTML, image files, emacs lisp source code, and
4896 stylesheets. The publishing-directory is remote and private files are
4899 To ensure that links are preserved, care should be taken to replicate
4900 your directory structure on the web server, and to use relative file
4901 paths. For example, if your org files are kept in `~/org' and your
4902 publishable images in `~/images', you'd link to an image with
4903 file:../images/myimage.png
4904 On the web server, the relative path to the image should be the
4905 same. You can accomplish this by setting up an "images" folder in the
4906 right place on the webserver, and publishing images to it.
4908 (setq org-publish-project-alist
4910 :base-directory "~/org/"
4911 :base-extension "org"
4912 :publishing-directory "/ssh:user@host:~/html/notebook/"
4913 :publishing-function org-publish-org-to-html
4914 :exclude "PrivatePage.org" ;; regexp
4916 :section-numbers nil
4917 :table-of-contents nil
4918 :style "<link rel=stylesheet
4919 href=\"../other/mystyle.css\" type=\"text/css\">"
4921 :auto-postamble nil)
4924 :base-directory "~/images/"
4925 :base-extension "jpg\\|gif\\|png"
4926 :publishing-directory "/ssh:user@host:~/html/images/"
4927 :publishing-function org-publish-attachment)
4930 :base-directory "~/other/"
4931 :base-extension "css\\|el"
4932 :publishing-directory "/ssh:user@host:~/html/other/"
4933 :publishing-function org-publish-attachment)
4934 ("website" :components ("orgfiles" "images" "other"))))
4937 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4939 11.3 Triggering publication
4940 ===========================
4942 Once org-publish is properly configured, you can publish with the
4943 following functions:
4946 Prompt for a specific project and publish all files that belong to
4950 Publish the project containing the current file.
4953 Publish only the current file.
4956 Publish all projects.
4958 Org uses timestamps to track when a file has changed. The above
4959 functions normally only publish changed files. You can override this and
4960 force publishing of all files by giving a prefix argument.
4963 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4970 * Completion:: M-TAB knows what you need
4971 * Customization:: Adapting Org-mode to your taste
4972 * In-buffer settings:: Overview of the #+KEYWORDS
4973 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4974 * Clean view:: Getting rid of leading stars in the outline
4975 * TTY keys:: Using Org-mode on a tty
4976 * Interaction:: Other Emacs packages
4977 * Bugs:: Things which do not work perfectly
4980 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
4985 Org-mode supports in-buffer completion. This type of completion does
4986 not make use of the minibuffer. You simply type a few letters into the
4987 buffer and use the key to complete text right there.
4990 Complete word at point
4991 * At the beginning of a headline, complete TODO keywords.
4993 * After `\', complete TeX symbols supported by the exporter.
4995 * After `*', complete headlines in the current buffer so that
4996 they can be used in search links like `[[*find this
4999 * After `:', complete tags. The list of tags is taken from the
5000 variable `org-tag-alist' (possibly set through the `#+TAGS'
5001 in-buffer option, *note Setting tags::), or it is created
5002 dynamically from all tags used in the current buffer.
5004 * After `[', complete link abbreviations (*note Link
5007 * After `#+', complete the special keywords like `TYP_TODO' or
5008 `OPTIONS' which set file-specific options for Org-mode. When
5009 the option keyword is already complete, pressing `M-<TAB>'
5010 again will insert example settings for this keyword.
5012 * In the line after `#+STARTUP: ', complete startup keywords,
5013 i.e. valid keys for this line.
5015 * Elsewhere, complete dictionary words using ispell.
5018 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
5023 There are more than 180 variables that can be used to customize
5024 Org-mode. For the sake of compactness of the manual, I am not
5025 describing the variables here. A structured overview of customization
5026 variables is available with `M-x org-customize'. Or select `Browse Org
5027 Group' from the `Org->Customization' menu. Many settings can also be
5028 activated on a per-file basis, by putting special lines into the buffer
5029 (*note In-buffer settings::).
5032 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
5034 12.3 Summary of in-buffer settings
5035 ==================================
5037 Org-mode uses special lines in the buffer to define settings on a
5038 per-file basis. These lines start with a `#+' followed by a keyword, a
5039 colon, and then individual words defining a setting. Several setting
5040 words can be in the same line, but you can also have multiple lines for
5041 the keyword. While these settings are described throughout the manual,
5042 here is a summary. After changing any of those lines in the buffer,
5043 press `C-c C-c' with the cursor still in the line to activate the
5044 changes immediately. Otherwise they become effective only when the
5045 file is visited again in a new Emacs session.
5048 This line sets options to be used at startup of org-mode, when an
5049 Org-mode file is being visited. The first set of options deals
5050 with the initial visibility of the outline tree. The
5051 corresponding variable for global default settings is
5052 `org-startup-folded', with a default value `t', which means
5054 overview top-level headlines only
5055 content all headlines
5056 showall no folding at all, show everything
5057 Then there are options for aligning tables upon visiting a file.
5058 This is useful in files containing narrowed table columns. The
5059 corresponding variable is `org-startup-align-all-tables', with a
5060 default value `nil'.
5061 align align all tables
5062 noalign don't align tables on startup
5063 Logging TODO state changes and clock intervals (variable
5064 `org-log-done') can be configured using these options.
5065 logging record a timestamp when an item is marked DONE
5066 nologging don't record when items are marked DONE
5067 lognotedone record timestamp and a note when DONE
5068 lognotestate record timestamp, note when TODO state changes
5069 lognoteclock-out record timestamp and a note when clocking out
5070 Here are the options for hiding leading stars in outline headings.
5071 The corresponding variables are `org-hide-leading-stars' and
5072 `org-odd-levels-only', both with a default setting `nil' (meaning
5073 `showstars' and `oddeven').
5074 hidestars make all but one of the stars starting a headline invisible.
5075 showstars show all stars starting a headline
5076 odd allow only odd outline levels (1,3,...)
5077 oddeven allow all outline levels
5078 To turn on custom format overlays over time stamps (variables
5079 `org-put-time-stamp-overlays' and
5080 `org-time-stamp-overlay-formats'), use
5081 customtime overlay custom time format
5083 `#+SEQ_TODO: #+TYP_TODO:'
5084 These lines set the TODO keywords and their interpretation in the
5085 current file. The corresponding variables are `org-todo-keywords'
5086 and `org-todo-interpretation'.
5088 `#+TAGS: TAG1(c1) TAG2(c2)'
5089 These lines (several such lines are allowed) specify the legal
5090 tags in this file, and (potentially) the corresponding _fast tag
5091 selection_ keys. The corresponding variable is `org-tag-alist'.
5093 `#+LINK: linkword replace'
5094 These lines (several are allowed) specify link abbreviations.
5095 *Note Link abbreviations::. The corresponding variable is
5096 `org-link-abbrev-alist'.
5099 This line sets the category for the agenda file. The category
5100 applies for all subsequent lines until the next `#+CATEGORY' line,
5101 or the end of the file. The first such line also applies to any
5104 `#+ARCHIVE: %s_done::'
5105 This line sets the archive location for the agenda file. It
5106 applies for all subsequent lines until the next `#+CATEGORY' line,
5107 or the end of the file. The first such line also applies to any
5108 entries before it. The corresponding variable is
5109 `org-archive-location'.
5112 This line contains the formulas for the table directly above the
5115 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5116 These lines provide settings for exporting files. For more
5117 details see *Note Export options::.
5120 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
5122 12.4 The very busy C-c C-c key
5123 ==============================
5125 The key `C-c C-c' has many purposes in org-mode, which are all
5126 mentioned scattered throughout this manual. One specific function of
5127 this key is to add _tags_ to a headline (*note Tags::). In many other
5128 circumstances it means something like _Hey Org-mode, look here and
5129 update according to what you see here_. Here is a summary of what this
5130 means in different contexts.
5132 - If there are highlights in the buffer from the creation of a sparse
5133 tree, or from clock display, remove these highlights.
5135 - If the cursor is in one of the special `#+KEYWORD' lines, this
5136 triggers scanning the buffer for these lines and updating the
5139 - If the cursor is inside a table, realign the table. This command
5140 works even if the automatic table editor has been turned off.
5142 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5145 - If the cursor is inside a table created by the `table.el' package,
5146 activate that table.
5148 - If the current buffer is a remember buffer, close the note and
5149 file it. With a prefix argument, file it, without further
5150 interaction, to the default location.
5152 - If the cursor is on a `<<<target>>>', update radio targets and
5153 corresponding links in this buffer.
5155 - If the cursor is in a plain list item with a checkbox, toggle the
5156 status of the checkbox.
5158 - If the cursor is on a numbered item in a plain list, renumber the
5162 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
5164 12.5 A cleaner outline view
5165 ===========================
5167 Some people find it noisy and distracting that the Org-mode headlines
5168 are starting with a potentially large number of stars. For example the
5169 tree from *Note Headlines:::
5171 * Top level headline
5177 * Another top level headline
5179 Unfortunately this is deeply ingrained into the code of Org-mode and
5180 cannot be easily changed. You can, however, modify the display in such
5181 a way that all leading stars become invisible and the outline more easy
5182 to read. To do this, customize the variable `org-hide-leading-stars'
5185 (setq org-hide-leading-stars t)
5187 or change this on a per-file basis with one of the lines (anywhere in
5190 #+STARTUP: showstars
5191 #+STARTUP: hidestars
5193 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5196 With stars hidden, the tree becomes:
5198 * Top level headline
5204 * Another top level headline
5206 Note that the leading stars are not truly replaced by whitespace, they
5207 are only fontified with the face `org-hide' that uses the background
5208 color as font color. If you are not using either white or black
5209 background, you may have to customize this face to get the wanted
5210 effect. Another possibility is to set this font such that the extra
5211 stars are almost invisible, for example using the color `grey90' on a
5214 Things become cleaner still if you skip all the even levels and use
5215 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5216 outline level to the next:
5218 * Top level headline
5224 * Another top level headline
5226 In order to make the structure editing and export commands handle this
5227 convention correctly, use
5229 (setq org-odd-levels-only t)
5231 or set this on a per-file basis with one of the following lines (don't
5232 forget to press `C-c C-c' with the cursor in the startup line to
5233 activate changes immediately).
5238 You can convert an Org-mode file from single-star-per-level to the
5239 double-star-per-level convention with `M-x org-convert-to-odd-levels
5240 RET' in that file. The reverse operation is `M-x
5241 org-convert-to-oddeven-levels'.
5244 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
5246 12.6 Using org-mode on a tty
5247 ============================
5249 Org-mode uses a number of keys that are not accessible on a tty. This
5250 applies to most special keys like cursor keys, <TAB> and <RET>, when
5251 these are combined with modifier keys like <Meta> and/or <Shift>.
5252 Org-mode uses these bindings because it needs to provide keys for a
5253 large number of commands, and because these keys appeared particularly
5254 easy to remember. In order to still be able to access the core
5255 functionality of Org-mode on a tty, alternative bindings are provided.
5256 Here is a complete list of these bindings, which are obviously more
5257 cumbersome to use. Note that sometimes a work-around can be better.
5258 For example changing a time stamp is really only fun with `S-<cursor>'
5259 keys. On a tty you would rather use `C-c .' to re-insert the
5262 Default Alternative 1 Alternative 2
5263 `S-<TAB>' `C-u <TAB>'
5264 `M-<left>' `C-c C-x l' `<Esc> <left>'
5265 `M-S-<left>'`C-c C-x L'
5266 `M-<right>' `C-c C-x r' `<Esc>
5268 `M-S-<right>'`C-c C-x R'
5269 `M-<up>' `C-c C-x u' `<Esc> <up>'
5270 `M-S-<up>' `C-c C-x U'
5271 `M-<down>' `C-c C-x d' `<Esc> <down>'
5272 `M-S-<down>'`C-c C-x D'
5273 `S-<RET>' `C-c C-x c'
5274 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
5275 `M-S-<RET>' `C-c C-x M'
5278 `S-<right>' `C-c C-x
5286 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
5288 12.7 Interaction with other packages
5289 ====================================
5291 Org-mode lives in the world of GNU Emacs and interacts in various ways
5292 with other code out there.
5296 * Cooperation:: Packages Org-mode cooperates with
5297 * Conflicts:: Packages that lead to conflicts
5300 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
5302 12.7.1 Packages that Org-mode cooperates with
5303 ---------------------------------------------
5305 `calc.el' by Dave Gillespie
5306 Org-mode uses the calc package for implementing spreadsheet
5307 functionality in its tables (*note The spreadsheet::). Org-mode
5308 checks for the availability of calc by looking for the function
5309 `calc-eval' which should be autoloaded in your setup if calc has
5310 been installed properly. As of Emacs 22, calc is part of the Emacs
5311 distribution. Another possibility for interaction between the two
5312 packages is using calc for embedded calculations. *Note Embedded
5313 Mode: (calc)Embedded Mode.
5315 `constants.el' by Carsten Dominik
5316 In a table formula (*note The spreadsheet::), it is possible to use
5317 names for natural constants or units. Instead of defining your own
5318 constants in the variable `org-table-formula-constants', install
5319 the `constants' package which defines a large number of constants
5320 and units, and lets you use unit prefixes like `M' for `Mega' etc.
5321 You will need version 2.0 of this package, available at
5322 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5323 function `constants-get', which has to be autoloaded in your
5324 setup. See the installation instructions in the file
5327 `cdlatex.el' by Carsten Dominik
5328 Org-mode can make use of the cdlatex package to efficiently enter
5329 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5331 `remember.el' by John Wiegley
5332 Org mode cooperates with remember, see *Note Remember::.
5333 `Remember.el' is not part of Emacs, find it on the web.
5335 `table.el' by Takaaki Ota
5336 Complex ASCII tables with automatic line wrapping, column- and
5337 row-spanning, and alignment can be created using the Emacs table
5338 package by Takaaki Ota (`http://sourceforge.net/projects/table',
5339 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
5340 such a table, Org-mode will call `table-recognize-table' and move
5341 the cursor into the table. Inside a table, the keymap of Org-mode
5342 is inactive. In order to execute Org-mode-related commands, leave
5346 Recognize `table.el' table. Works when the cursor is in a
5350 Insert a table.el table. If there is already a table at
5351 point, this command converts it between the table.el format
5352 and the Org-mode format. See the documentation string of the
5353 command `org-convert-table' for the restrictions under which
5355 `table.el' is part of Emacs 22.
5358 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
5360 12.7.2 Packages that lead to conflicts with Org-mode
5361 ----------------------------------------------------
5363 `allout.el' by Ken Manheimer
5364 Startup of Org-mode may fail with the error message
5365 `(wrong-type-argument keymapp nil)' when there is an outdated
5366 version `allout.el' on the load path, for example the version
5367 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
5368 will disappear. If for some reason you cannot do this, make sure
5369 that org.el is loaded _before_ `allout.el', for example by putting
5370 `(require 'org)' early enough into your `.emacs' file.
5372 `CUA.el' by Kim. F. Storm
5373 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5374 by CUA-mode (as well as pc-select-mode and s-region-mode) to
5375 select and extend the region. If you want to use one of these
5376 packages along with Org-mode, configure the variable
5377 `org-CUA-compatible'. When set, Org-mode will move the following
5378 keybindings in org-mode files, and in the agenda buffer (but not
5379 during date selection).
5381 S-UP -> M-p S-DOWN -> M-n
5382 S-LEFT -> M-- S-RIGHT -> M-+
5385 Yes, these are unfortunately more difficult to remember. If you
5386 want to have other replacement keys, look at the variable
5387 `org-disputed-keys'.
5389 `windmove.el' by Hovav Shacham
5390 Also this package uses the `S-<cursor>' keys, so everything written
5391 in the paragraph above about CUA mode also applies here.
5394 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5399 Here is a list of things that should work differently, but which I have
5400 found too hard to fix.
5402 * If a table field starts with a link, and if the corresponding table
5403 column is narrowed (*note Narrow columns::) to a width too small to
5404 display the link, the field would look entirely empty even though
5405 it is not. To prevent this, Org-mode throws an error. The
5406 work-around is to make the column wide enough to fit the link, or
5407 to add some text (at least 2 characters) before the link in the
5410 * Narrowing table columns does not work on XEmacs, because the
5411 `format' function does not transport text properties.
5413 * Text in an entry protected with the `QUOTE' keyword should not
5416 * When the application called by `C-c C-o' to open a file link fails
5417 (for example because the application does not exist or refuses to
5418 open the file), it does so silently. No error message is
5421 * Recalculating a table line applies the formulas from left to right.
5422 If a formula uses _calculated_ fields further down the row,
5423 multiple recalculation may be needed to get all fields consistent.
5424 You may use the command `org-table-iterate' (`C-u C-c *') to
5425 recalculate until convergence.
5427 * A single letter cannot be made bold, for example `*a*'.
5429 * The exporters work well, but could be made more efficient.
5432 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5434 Appendix A Extensions, Hooks and Hacking
5435 ****************************************
5437 This appendix lists extensions for Org-mode written by other authors.
5438 It also covers some aspects where users can extend the functionality of
5443 * Extensions:: Existing 3rd-part extensions
5444 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
5445 * Dynamic blocks:: Automatically filled blocks
5446 * Special agenda views:: Customized views
5449 File: org, Node: Extensions, Next: Tables in arbitrary syntax, Prev: Extensions and Hacking, Up: Extensions and Hacking
5451 A.1 Third-party extensions for Org-mode
5452 =======================================
5454 The following extensions for Org-mode have been written by other people:
5456 `org-publish.el' by David O'Toole
5457 This package provides facilities for publishing related sets of
5458 Org-mode files together with linked files like images as webpages.
5459 It is highly configurable and can be used for other publishing
5460 purposes as well. As of Org-mode version 4.30, `org-publish.el'
5461 is part of the Org-mode distribution. It is not yet part of
5462 Emacs, however, a delay caused by the preparations for the 22.1
5463 release. In the mean time, `org-publish.el' can be downloaded
5464 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
5466 `org-mouse.el' by Piotr Zielinski
5467 This package implements extended mouse functionality for Org-mode.
5468 It allows you to cycle visibility and to edit the document
5469 structure with the mouse. Best of all, it provides a
5470 context-sensitive menu on <mouse-3> that changes depending on the
5471 context of a mouse-click. As of Org-mode version 4.53,
5472 `org-mouse.el' is part of the Org-mode distribution. It is not
5473 yet part of Emacs, however, a delay caused by the preparations for
5474 the 22.1 release. In the mean time, `org-mouse.el' can be
5475 downloaded from Piotr's site:
5476 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
5478 `org-blog.el' by David O'Toole
5479 A blogging plug-in for `org-publish.el'.
5480 `http://dto.freeshell.org/notebook/OrgMode.html'.
5482 `blorg.el' by Bastien Guerry
5483 Publish Org-mode files as blogs.
5484 `http://www.cognition.ens.fr/~guerry/blorg.html'.
5486 `org2rem.el' by Bastien Guerry
5487 Translates Org-mode files into something readable by Remind.
5488 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
5491 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
5493 A.2 Tables in arbitrary syntax
5494 ==============================
5496 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
5497 frequent feature request has been to make it work with native tables in
5498 specific languages, for example LaTeX. However, this is extremely hard
5499 to do in a general way, would lead to a customization nightmare, and
5500 would take away much of the simplicity of the Orgtbl-mode table editor.
5502 This appendix describes different approach. We keep the Orgtbl-mode
5503 table in its native format (the source table), and use a custom
5504 function to translate the table to the correct syntax, and to install
5505 it in the right location (the target table). This puts the burden of
5506 writing conversion functions on the user, but it allows for a very
5511 * Radio tables:: Sending and receiving
5512 * A LaTeX example:: Step by step, almost a tutorial
5513 * Translator functions:: Copy and modify
5516 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
5521 To define the location of the target table, you first need to create two
5522 lines that are comments in the current mode, but contain magic words for
5523 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
5524 between these lines, replacing whatever was there before. For example:
5526 /* BEGIN RECEIVE ORGTBL table_name */
5527 /* END RECEIVE ORGTBL table_name */
5529 Just above the source table, we put a special line that tells
5530 Orgtbl-mode how to translate this table and where to install it. For
5532 #+ORGTBL: SEND table_name translation_function arguments....
5534 `table_name' is the reference name for the table that is also used in
5535 the receiver lines. `translation_function' is the Lisp function that
5536 does the translation. Furthermore, the line can contain a list of
5537 arguments (alternating key and value) at the end. The arguments will be
5538 passed as a property list to the translation function for
5539 interpretation. However, a few standard parameters are already
5540 recognized and acted upon before the translation function is called:
5543 Skip the first N lines of the table. Hlines do count!
5545 `:skipcols (n1 n2 ...)'
5546 List of columns that should be skipped. If the table has a column
5547 with calculation marks, that column is automatically discarded as
5548 well. Please note that the translator function sees the table
5549 _after_ the removal of these columns, the function never knows
5550 that there have been additional columns.
5552 The one problem remaining is how to keep the source table in the buffer
5553 without disturbing the normal workings of the file, for example during
5554 compilation of a C file or processing of a LaTeX file. There are a
5555 number of different solutions:
5557 * The table could be placed in a block comment if that is supported
5558 by the language. For example, in C-mode you could wrap the table
5559 between `/*' and `*/' lines.
5561 * Sometimes it is possible to put the table after some kind of END
5562 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
5564 * If all else fails(1), you can just comment the table line by line
5565 whenever you want to process the file, and uncomment it whenever
5566 you need to edit the table. The command `M-x
5567 orgtbl-toggle-comment' does make this a viable option, in
5568 particular if you bind it to a key.
5570 ---------- Footnotes ----------
5572 (1) In principle the source table could also be in a separate file,
5573 but so far this is not implemented.
5576 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
5578 A.2.2 A LaTeX example
5579 ---------------------
5581 The best way to wrap the source table in LaTeX is to use the `comment'
5582 environment provided by `comment.sty'. It has to be activated by
5583 placing `\usepackage{comment}' into the document header. Orgtbl-mode
5584 can insert a radio table skeleton(1) with the command `M-x
5585 orgtbl-insert-radio-table'. You will be prompted for a table name,
5586 lets say we use `salesfigures'. You will then get the following
5589 % BEGIN RECEIVE ORGTBL salesfigures
5590 % END RECEIVE ORGTBL salesfigures
5592 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5596 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
5597 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
5598 the receiver location with name `salesfigures'. You may now fill in
5599 the table, feel free to use the spreadsheet features(2):
5601 % BEGIN RECEIVE ORGTBL salesfigures
5602 % END RECEIVE ORGTBL salesfigures
5604 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5605 | Month | Days | Nr sold | per day |
5606 |-------+------+---------+---------|
5607 | Jan | 23 | 55 | 2.4 |
5608 | Feb | 21 | 16 | 0.8 |
5609 | March | 22 | 278 | 12.6 |
5610 #+TBLFM: $4=$3/$2;%.1f
5611 % $ (optional extra dollar to keep font-lock happy, see footnote)
5614 When you are done, press `C-c C-c' in the table to get the converted
5615 table inserted between the two marker lines.
5617 Now lets assume you want to make the table header by hand, because
5618 you want to control how columns are aligned etc. In this case we make
5619 sure that the table translator does skip the first 2 lines, and tell the
5620 command to work as a splice, i.e. to not produce header and footer
5621 commands of the table:
5623 \begin{tabular}{lrrr}
5624 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
5625 % BEGIN RECEIVE ORGTBL salesfigures
5626 % END RECEIVE ORGTBL salesfigures
5630 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
5631 | Month | Days | Nr sold | per day |
5632 |-------+------+---------+---------|
5633 | Jan | 23 | 55 | 2.4 |
5634 | Feb | 21 | 16 | 0.8 |
5635 | March | 22 | 278 | 12.6 |
5636 #+TBLFM: $4=$3/$2;%.1f
5639 The LaTeX translator function `orgtbl-to-latex' is already part of
5640 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
5641 marks horizontal lines with `\hline'. Furthermore, it interprets the
5642 following parameters:
5645 When set to t, return only table body lines, don't wrap them into a
5646 tabular environment. Default is nil.
5649 A format to be used to wrap the field, should contain `%s' for the
5650 original field value. For example, to wrap each field value in
5651 dollars, you could use `:fmt "$%s$"'. This may also be a property
5652 list with column numbers and formats. for example `:fmt (2 "$%s$"
5656 Use this format to print numbers with exponentials. The format
5657 should have `%s' twice for inserting mantissa and exponent, for
5658 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
5659 may also be a property list with column numbers and formats, for
5660 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
5661 After `efmt' has been applied to a value, `fmt' will also be
5664 ---------- Footnotes ----------
5666 (1) By default this works only for LaTeX, HTML, and TeXInfo.
5667 Configure the variable `orgtbl-radio-tables' to install templates for
5670 (2) If the `#+TBLFM' line contains an odd number of dollar
5671 characters, this may cause problems with font-lock in latex-mode. As
5672 shown in the example you can fix this by adding an extra line inside the
5673 `comment' environment that is used to balance the dollar expressions.
5674 If you are using AUCTeX with the font-latex library, a much better
5675 solution is to add the `comment' environment to the variable
5676 `LaTeX-verbatim-environments'.
5679 File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in arbitrary syntax
5681 A.2.3 Translator functions
5682 --------------------------
5684 Orgtbl-mode has several translator functions built-in:
5685 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. For
5686 deatils on each of them, please check the corresponding documentation
5689 In order to write your own translator function, start by looking at
5690 `orgtbl-to-latex' which is well documented. Basically you have to
5691 write a function that takes two arguments. The first argument is the
5692 table, a list of lines, each line either the symbol `hline' or a list
5693 of fields. The second argument is a property list that will contain
5694 all parameters specified in the `#+ORGTBL: SEND' line. Orgtbl-mode
5695 always handles the `:skip' and `:skipcols' parameters, but your
5696 translator function may use any number of additional parameters. If
5697 you write a generally useful translator, please post it on
5698 `emacs-orgmode@gnu.org' so that others can benefit from your work.
5701 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
5706 Org-mode documents can contain _dynamic blocks_. These are specially
5707 marked regions that are updated by some user-written function. A good
5708 example for such a block is the clock table inserted by the command
5709 `C-c C-x C-r' (*note Clocking work time::).
5711 Dynamic block are enclosed by a BEGIN-END structure that assigns a
5712 name to the block and can also specify parameters for the function
5713 producing the content of the block.
5715 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5719 Dynamic blocks are updated with the following commands
5722 Update dynamic block at point.
5725 Update all dynamic blocks in the current file.
5727 Updating a dynamic block means to remove all the text between BEGIN
5728 and END, parse the BEGIN line for parameters and then call the specific
5729 writer function for this block to insert the new content. For a block
5730 with name `myblock', the writer function is `org-dblock-write:myblock'
5731 with as only parameter a property list with the parameters given in the
5732 begin line. Here is a trivial example of a block that keeps track of
5733 when the block update function was last run:
5735 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5739 The corresponding block writer function could look like this:
5741 (defun org-dblock-write:block-update-time (params)
5742 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5743 (insert "Last block update at: "
5744 (format-time-string fmt (current-time)))))
5746 If you want to make sure that all dynamic blocks are always
5747 up-to-date, you could add the function `org-update-all-dblocks' to a
5748 hook, for example `before-save-hook'. `org-update-all-dblocks' is
5749 written in a way that is does nothing in buffers that are not in
5753 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
5755 A.4 Special Agenda Views
5756 ========================
5758 Org-mode provides a special hook that can be used to narrow down the
5759 selection made by any of the agenda views. You may specify a function
5760 that is used at each match to verify if the match should indeed be part
5761 of the agenda view, and if not, how much should be skipped.
5763 Let's say you want to produce a list of projects that contain a
5764 WAITING tag anywhere in the project tree. Let's further assume that
5765 you have marked all tree headings that define a project with the todo
5766 keyword PROJECT. In this case you would run a todo search for the
5767 keyword PROJECT, but skip the match unless there is a WAITING tag
5768 anywhere in the subtree belonging to the project line.
5770 To achieve this, you must write a function that searches the subtree
5771 for the tag. If the tag is found, the function must return `nil' to
5772 indicate that this match should not be skipped. If there is no such
5773 tag, return the location of the end of the subtree, to indicate that
5774 search should continue from there.
5776 (defun my-skip-unless-waiting ()
5777 "Skip trees that are not waiting"
5778 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
5779 (if (re-search-forward ":WAITING:" subtree-end t)
5780 nil ; tag found, do not skip
5781 subtree-end))) ; tag not found, continue after end of subtree
5783 Furthermore you must write a command that uses `let' to temporarily
5784 put this function into the variable `org-agenda-skip-function', sets
5785 the header string for the agenda buffer, and calls the todo-list
5786 generator while asking for the specific TODO keyword PROJECT. The
5787 function must also accept one argument MATCH, but it can choose to
5788 ignore it(1) (as we do in the example below). Here is the example:
5790 (defun my-org-waiting-projects (&optional match)
5791 "Produce a list of projects that contain a WAITING tag.
5792 MATCH is being ignored."
5794 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
5795 (org-agenda-overriding-header "Projects waiting for something: "))
5797 (org-todo-list "PROJECT")))
5799 ---------- Footnotes ----------
5801 (1) MATCH must be present in case you want to define a custom
5802 command for producing this special list. Custom commands always supply
5803 the MATCH argument, but it can be empty if you do not specify it while
5804 defining the command(*note Custom agenda views::).
5807 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
5809 Appendix B History and Acknowledgments
5810 **************************************
5812 Org-mode was borne in 2003, out of frustration over the user interface
5813 of the Emacs outline-mode. I was trying to organize my notes and
5814 projects, and using Emacs seemed to be the natural way to go. However,
5815 having to remember eleven different commands with two or three keys per
5816 command, only to hide and unhide parts of the outline tree, that seemed
5817 entirely unacceptable to me. Also, when using outlines to take notes, I
5818 constantly want to restructure the tree, organizing it parallel to my
5819 thoughts and plans. _Visibility cycling_ and _structure editing_ were
5820 originally implemented in the package `outline-magic.el', but quickly
5821 moved to the more general `org.el'. As this environment became
5822 comfortable for project planning, the next step was adding _TODO
5823 entries_, basic _time stamps_, and _table support_. These areas
5824 highlight the two main goals that Org-mode still has today: To create a
5825 new, outline-based, plain text mode with innovative and intuitive
5826 editing features, and to incorporate project planning functionality
5827 directly into a notes file.
5829 Since the first release, hundreds of emails to me or on
5830 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
5831 feedback, new ideas, and sometimes patches and add-on code. Many
5832 thanks to everyone who has helped to improve this package. I am trying
5833 to keep here a list of the people who had significant influence in
5834 shaping one or more aspects of Org-mode. The list may not be complete,
5835 if I have forgotten someone, please accept my apologies and let me know.
5837 * Thomas Baumann contributed the code for links to the MH-E email
5840 * Alex Bochannek provided a patch for rounding time stamps.
5842 * Charles Cave's suggestion sparked the implementation of templates
5845 * Pavel Chalmoviansky influenced the agenda treatment of items with
5848 * Gregory Chernov patched support for lisp forms into table
5849 calculations and improved XEmacs compatibility, in particular by
5850 porting `nouline.el' to XEmacs.
5852 * Sacha Chua suggested to copy some linking code from Planner.
5854 * Eddward DeVilla proposed and tested checkbox statistics.
5856 * Kees Dullemond used to edit projects lists directly in HTML and so
5857 inspired some of the early development, including HTML export. He
5858 also asked for a way to narrow wide table columns.
5860 * Christian Egli converted the documentation into TeXInfo format,
5861 patched CSS formatting into the HTML exporter, and inspired the
5864 * Nic Ferrier contributed mailcap and XOXO support.
5866 * John Foerch figured out how to make incremental search show context
5867 around a match in a hidden outline tree.
5869 * Niels Giessen had the idea to automatically archive DONE trees.
5871 * Bastien Guerry provided extensive feedback and some patches, and
5872 translated David O'Toole's tutorial into French.
5874 * Kai Grossjohann pointed out key-binding conflicts with other
5877 * Shidai Liu ("Leo") provided extensive feedback and some patches.
5879 * Leon Liu asked for embedded LaTeX and tested it.
5881 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
5884 * Todd Neal provided patches for links to Info files and elisp forms.
5886 * Tim O'Callaghan suggested in-file links, search options for general
5887 file links, and TAGS.
5889 * Takeshi Okano translated the manual and David O'Toole's tutorial
5892 * Oliver Oppitz suggested multi-state TODO items.
5894 * Scott Otterson sparked the introduction of descriptive text for
5895 links, among other things.
5897 * Pete Phillips helped during the development of the TAGS feature,
5898 and provided frequent feedback.
5900 * T.V. Raman reported bugs and suggested improvements.
5902 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
5905 * Kevin Rogers contributed code to access VM files on remote hosts.
5907 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
5908 conflict with `allout.el'.
5910 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
5912 * Philip Rooke created the Org-mode reference card and provided lots
5915 * Christian Schlauer proposed angular brackets around links, among
5918 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
5919 `organizer-mode.el'.
5921 * Daniel Sinder came up with the idea of internal archiving by
5924 * Dale Smith proposed link abbreviations.
5926 * David O'Toole wrote `org-publish.el' and drafted the manual
5927 chapter about publishing.
5929 * Ju"rgen Vollmer contributed code generating the table of contents
5932 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
5934 * David Wainberg suggested archiving, and improvements to the linking
5937 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
5938 development of Org-mode was fully independent, and both systems are
5939 really different beasts in their basic ideas and implementation
5940 details. I later looked at John's code, however, and learned from
5941 his implementation of (i) links where the link itself is hidden
5942 and only a description is shown, and (ii) popping up a calendar to
5945 * Carsten Wimmer suggested some changes and helped fix a bug in
5948 * Roland Winkler requested additional keybindings to make Org-mode
5951 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
5952 contributed various ideas and code snippets.
5955 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
5963 * abbreviation, links: Link abbreviations. (line 6)
5964 * acknowledgments: History and Acknowledgments.
5966 * action, for publishing: Publishing action. (line 6)
5967 * activation: Activation. (line 6)
5968 * active region <1>: Export commands. (line 6)
5969 * active region <2>: ASCII export. (line 9)
5970 * active region <3>: Built-in table editor.
5972 * active region: Structure editing. (line 64)
5973 * agenda: Weekly/Daily agenda. (line 6)
5974 * agenda dispatcher: Agenda dispatcher. (line 6)
5975 * agenda files: Agenda files. (line 6)
5976 * agenda files, removing buffers: Agenda commands. (line 230)
5977 * agenda views: Agenda views. (line 6)
5978 * agenda views, custom: Custom agenda views. (line 6)
5979 * agenda views, user-defined: Special agenda views.
5981 * agenda, batch production: Batch processing. (line 6)
5982 * agenda, with block views: Block agenda. (line 6)
5983 * align, STARTUP keyword: In-buffer settings. (line 29)
5984 * allout.el: Conflicts. (line 6)
5985 * angular brackets, around links: External links. (line 43)
5986 * archive locations: Moving subtrees. (line 21)
5987 * archiving: Archiving. (line 6)
5988 * ASCII export: ASCII export. (line 6)
5989 * author: Feedback. (line 6)
5990 * autoload: Activation. (line 6)
5991 * backtrace of an error: Feedback. (line 27)
5992 * BBDB links: External links. (line 6)
5993 * block agenda: Block agenda. (line 6)
5994 * blorg.el: Extensions. (line 32)
5995 * bold text: Enhancing text. (line 15)
5996 * Boolean logic, for tag searches: Tag searches. (line 23)
5997 * bug reports: Feedback. (line 6)
5998 * bugs: Bugs. (line 6)
5999 * C-c C-c, overview: The very busy C-c C-c key.
6001 * calc package: The spreadsheet. (line 6)
6002 * calc.el: Cooperation. (line 6)
6003 * calculations, in tables <1>: The spreadsheet. (line 6)
6004 * calculations, in tables: Built-in table editor.
6006 * calendar commands, from agenda: Agenda commands. (line 191)
6007 * calendar integration: Weekly/Daily agenda. (line 24)
6008 * calendar, for selecting date: The date/time prompt.
6010 * CamelCase link completion: Completion. (line 6)
6011 * CamelCase links: Internal links. (line 6)
6012 * CamelCase links, completion of: CamelCase links. (line 6)
6013 * category: Categories. (line 6)
6014 * CDLaTeX: CDLaTeX mode. (line 6)
6015 * cdlatex.el: Cooperation. (line 29)
6016 * checkbox statistics: Checkboxes. (line 23)
6017 * checkboxes: Checkboxes. (line 6)
6018 * children, subtree visibility state: Visibility cycling. (line 10)
6019 * clean outline view: Clean view. (line 6)
6020 * CLOCK keyword: Time stamps. (line 71)
6021 * CLOSED keyword: Time stamps. (line 65)
6022 * column formula: Column formulas. (line 6)
6023 * commands, in agenda buffer: Agenda commands. (line 6)
6024 * comment lines: Comment lines. (line 6)
6025 * completion, of CamelCase links <1>: Completion. (line 6)
6026 * completion, of CamelCase links: CamelCase links. (line 6)
6027 * completion, of dictionary words: Completion. (line 6)
6028 * completion, of file names: Handling links. (line 43)
6029 * completion, of link abbreviations: Completion. (line 6)
6030 * completion, of links: Handling links. (line 27)
6031 * completion, of option keywords <1>: Completion. (line 6)
6032 * completion, of option keywords <2>: Export options. (line 6)
6033 * completion, of option keywords: Per file keywords. (line 17)
6034 * completion, of tags <1>: Completion. (line 6)
6035 * completion, of tags: Setting tags. (line 11)
6036 * completion, of TeX symbols: Completion. (line 6)
6037 * completion, of TODO keywords <1>: Completion. (line 6)
6038 * completion, of TODO keywords: Workflow states. (line 12)
6039 * constants, in calculations: References. (line 65)
6040 * constants.el: Cooperation. (line 14)
6041 * content, STARTUP keyword: In-buffer settings. (line 22)
6042 * contents, global visibility state: Visibility cycling. (line 22)
6043 * copying, of subtrees: Structure editing. (line 6)
6044 * creating timestamps: Creating timestamps. (line 6)
6045 * CUA.el: Conflicts. (line 15)
6046 * custom agenda views: Custom agenda views. (line 6)
6047 * custom date/time format: Custom time format. (line 6)
6048 * custom search strings: Custom searches. (line 6)
6049 * customization: Customization. (line 6)
6050 * customtime, STARTUP keyword: In-buffer settings. (line 49)
6051 * cutting, of subtrees: Structure editing. (line 6)
6052 * cycling, of TODO states: TODO basics. (line 13)
6053 * cycling, visibility: Visibility cycling. (line 6)
6054 * daily agenda: Weekly/Daily agenda. (line 6)
6055 * date format, custom: Custom time format. (line 6)
6056 * date stamps <1>: Time stamps. (line 6)
6057 * date stamps: Timestamps. (line 6)
6058 * date, reading in minibuffer: The date/time prompt.
6060 * DEADLINE keyword: Time stamps. (line 53)
6061 * deadlines: Time stamps. (line 6)
6062 * deadlines, repeating: Repeating items. (line 6)
6063 * debugging, of table formulas: Editing and debugging formulas.
6065 * demotion, of subtrees: Structure editing. (line 6)
6066 * diary entries, creating from agenda: Agenda commands. (line 198)
6067 * diary integration: Weekly/Daily agenda. (line 24)
6068 * dictionary word completion: Completion. (line 6)
6069 * directories, for publishing: Sources and destinations.
6071 * dispatching agenda commands: Agenda dispatcher. (line 6)
6072 * display changing, in agenda: Agenda commands. (line 65)
6073 * document structure: Document structure. (line 6)
6074 * DONE, final TODO keyword: Per file keywords. (line 20)
6075 * dynamic blocks: Dynamic blocks. (line 6)
6076 * editing tables: Tables. (line 6)
6077 * editing, of table formulas: Editing and debugging formulas.
6079 * elisp links: External links. (line 6)
6080 * emphasized text: Export options. (line 25)
6081 * enhancing text: Enhancing text. (line 6)
6082 * evaluate time range: Creating timestamps. (line 66)
6083 * even, STARTUP keyword: In-buffer settings. (line 42)
6084 * exporting: Exporting. (line 6)
6085 * exporting, not: Comment lines. (line 6)
6086 * extended TODO keywords: TODO extensions. (line 6)
6087 * extension, third-party: Extensions. (line 6)
6088 * external archiving: Moving subtrees. (line 6)
6089 * external links: External links. (line 6)
6090 * external links, in HTML export: Links. (line 6)
6091 * FAQ: Summary. (line 53)
6092 * feedback: Feedback. (line 6)
6093 * field formula: Field formulas. (line 6)
6094 * field references: References. (line 14)
6095 * file links: External links. (line 6)
6096 * file links, searching: Search options. (line 6)
6097 * file name completion: Handling links. (line 43)
6098 * files for agenda: Agenda files. (line 6)
6099 * files, adding to agenda list: Agenda files. (line 12)
6100 * files, selecting for publishing: Selecting files. (line 6)
6101 * fixed width: Enhancing text. (line 28)
6102 * fixed-width sections: Export options. (line 25)
6103 * folded, subtree visibility state: Visibility cycling. (line 10)
6104 * folding, sparse trees: Sparse trees. (line 6)
6105 * following links: Handling links. (line 58)
6106 * format specifier: Formula syntax for Calc.
6108 * format, of links: Link format. (line 6)
6109 * formula debugging: Editing and debugging formulas.
6111 * formula editing: Editing and debugging formulas.
6113 * formula syntax, Calc: Formula syntax for Calc.
6115 * formula, for individual table field: Field formulas. (line 6)
6116 * formula, for table column: Column formulas. (line 6)
6117 * formula, in tables: Built-in table editor.
6119 * global cycling: Visibility cycling. (line 22)
6120 * global keybindings: Activation. (line 6)
6121 * global TODO list: Global TODO list. (line 6)
6122 * global visibility states: Visibility cycling. (line 22)
6123 * GNUS links: External links. (line 6)
6124 * hand-formatted lists: Enhancing text. (line 11)
6125 * headline levels: Export options. (line 25)
6126 * headline levels, for exporting <1>: Export commands. (line 17)
6127 * headline levels, for exporting: ASCII export. (line 18)
6128 * headline navigation: Motion. (line 6)
6129 * headline tagging: Tags. (line 6)
6130 * headline, promotion and demotion: Structure editing. (line 6)
6131 * headlines: Headlines. (line 6)
6132 * hide text: Visibility cycling. (line 6)
6133 * hidestars, STARTUP keyword: In-buffer settings. (line 42)
6134 * hiding leading stars: Clean view. (line 6)
6135 * history: History and Acknowledgments.
6137 * horizontal rules, in exported files: Enhancing text. (line 18)
6138 * HTML export: HTML export. (line 6)
6139 * HTML, and orgtbl-mode: Translator functions.
6141 * hyperlinks: Hyperlinks. (line 6)
6142 * iCalendar export: iCalendar export. (line 6)
6143 * images, inline in HTML: Images. (line 6)
6144 * in-buffer settings: In-buffer settings. (line 6)
6145 * inactive timestamp: Time stamps. (line 24)
6146 * index, of published pages: Project page index. (line 6)
6147 * Info links: External links. (line 6)
6148 * inheritance, of tags: Tag inheritance. (line 6)
6149 * inlining images in HTML: Images. (line 6)
6150 * inserting links: Handling links. (line 27)
6151 * installation: Installation. (line 6)
6152 * internal archiving: ARCHIVE tag. (line 6)
6153 * internal links: Internal links. (line 6)
6154 * internal links, in HTML export: Links. (line 6)
6155 * introduction: Introduction. (line 6)
6156 * italic text: Enhancing text. (line 15)
6157 * jumping, to headlines: Motion. (line 6)
6158 * keybindings, global: Activation. (line 6)
6159 * keyword options: Per file keywords. (line 6)
6160 * LaTeX fragments <1>: Export options. (line 25)
6161 * LaTeX fragments: LaTeX fragments. (line 6)
6162 * LaTeX fragments, export: Enhancing text. (line 21)
6163 * LaTeX fragments, preview: Processing LaTeX fragments.
6165 * LaTeX interpretation: Embedded LaTeX. (line 6)
6166 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
6167 * level, require for tags match: Tag searches. (line 68)
6168 * linebreak preservation: Export options. (line 25)
6169 * linebreak, forced: Enhancing text. (line 35)
6170 * link abbreviations: Link abbreviations. (line 6)
6171 * link abbreviations, completion of: Completion. (line 6)
6172 * link completion: Handling links. (line 27)
6173 * link format: Link format. (line 6)
6174 * links, external: External links. (line 6)
6175 * links, finding next/previous: Handling links. (line 91)
6176 * links, handling: Handling links. (line 6)
6177 * links, in HTML export: Links. (line 6)
6178 * links, internal: Internal links. (line 6)
6179 * links, publishing: Publishing links. (line 6)
6180 * links, radio targets: Radio targets. (line 6)
6181 * links, returning to: Handling links. (line 85)
6182 * Lisp forms, as table formulas: Formula syntax for Lisp.
6184 * lists, hand-formatted: Enhancing text. (line 11)
6185 * lists, ordered: Plain lists. (line 6)
6186 * lists, plain: Plain lists. (line 6)
6187 * logdone, STARTUP keyword: In-buffer settings. (line 33)
6188 * logging, of progress: Progress logging. (line 6)
6189 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
6190 * lognotedone, STARTUP keyword: In-buffer settings. (line 33)
6191 * lognotestate, STARTUP keyword: In-buffer settings. (line 33)
6192 * maintainer: Feedback. (line 6)
6193 * mark ring: Handling links. (line 81)
6194 * marking characters, tables: Advanced features. (line 40)
6195 * matching, of tags: Matching headline tags.
6197 * matching, tags: Tags. (line 6)
6198 * math symbols: Math symbols. (line 6)
6199 * MH-E links: External links. (line 6)
6200 * minor mode for tables: orgtbl-mode. (line 6)
6201 * mode, for calc: Formula syntax for Calc.
6203 * motion commands in agenda: Agenda commands. (line 19)
6204 * motion, between headlines: Motion. (line 6)
6205 * name, of column or field: References. (line 65)
6206 * named references: References. (line 65)
6207 * names as TODO keywords: TODO types. (line 6)
6208 * narrow columns in tables: Narrow columns. (line 6)
6209 * noalign, STARTUP keyword: In-buffer settings. (line 29)
6210 * nologging, STARTUP keyword: In-buffer settings. (line 33)
6211 * occur, command: Sparse trees. (line 6)
6212 * odd, STARTUP keyword: In-buffer settings. (line 42)
6213 * option keyword completion: Completion. (line 6)
6214 * options, for custom agenda views: Setting Options. (line 6)
6215 * options, for customization: Customization. (line 6)
6216 * options, for export: Export options. (line 6)
6217 * options, for publishing: Publishing options. (line 6)
6218 * ordered lists: Plain lists. (line 6)
6219 * org-agenda, command: Weekly/Daily agenda. (line 9)
6220 * org-blog.el: Extensions. (line 28)
6221 * org-mode, turning on: Activation. (line 22)
6222 * org-mouse.el: Extensions. (line 16)
6223 * org-publish-project-alist: Project alist. (line 6)
6224 * org-publish.el: Extensions. (line 8)
6225 * org2rem.el: Extensions. (line 36)
6226 * orgtbl-mode <1>: Tables in arbitrary syntax.
6228 * orgtbl-mode: orgtbl-mode. (line 6)
6229 * outline tree: Headlines. (line 6)
6230 * outline-mode: Outlines. (line 6)
6231 * outlines: Outlines. (line 6)
6232 * overview, global visibility state: Visibility cycling. (line 22)
6233 * overview, STARTUP keyword: In-buffer settings. (line 22)
6234 * packages, interaction with other: Interaction. (line 6)
6235 * pasting, of subtrees: Structure editing. (line 6)
6236 * per file keywords: Per file keywords. (line 6)
6237 * plain lists: Plain lists. (line 6)
6238 * plain text external links: External links. (line 43)
6239 * presentation, of agenda items: Presentation and sorting.
6241 * printing sparse trees: Sparse trees. (line 41)
6242 * priorities: Priorities. (line 6)
6243 * priorities, of agenda items: Sorting of agenda items.
6245 * progress logging: Progress logging. (line 6)
6246 * projects, for publishing: Project alist. (line 6)
6247 * promotion, of subtrees: Structure editing. (line 6)
6248 * publishing: Publishing. (line 6)
6249 * quoted HTML tags: Export options. (line 25)
6250 * radio tables: Radio tables. (line 6)
6251 * radio targets: Radio targets. (line 6)
6252 * range references: References. (line 44)
6253 * ranges, time: Time stamps. (line 6)
6254 * recomputing table fields: Updating the table. (line 6)
6255 * references: References. (line 6)
6256 * references, named: References. (line 65)
6257 * references, to fields: References. (line 14)
6258 * references, to ranges: References. (line 44)
6259 * region, active <1>: Export commands. (line 6)
6260 * region, active <2>: ASCII export. (line 9)
6261 * region, active <3>: Built-in table editor.
6263 * region, active: Structure editing. (line 64)
6264 * regular expressions, with tags search: Tag searches. (line 63)
6265 * remember.el <1>: Cooperation. (line 33)
6266 * remember.el: Remember. (line 6)
6267 * remote editing, from agenda: Agenda commands. (line 106)
6268 * remote editing, undo: Agenda commands. (line 109)
6269 * richer text: Enhancing text. (line 6)
6270 * RMAIL links: External links. (line 6)
6271 * SCHEDULED keyword: Time stamps. (line 40)
6272 * scheduling: Time stamps. (line 6)
6273 * scheduling, repeating: Repeating items. (line 6)
6274 * search option in file links: Search options. (line 6)
6275 * search strings, custom: Custom searches. (line 6)
6276 * searching for tags: Tag searches. (line 6)
6277 * section-numbers: Export options. (line 25)
6278 * setting tags: Setting tags. (line 6)
6279 * SHELL links: External links. (line 6)
6280 * show all, command: Visibility cycling. (line 31)
6281 * show all, global visibility state: Visibility cycling. (line 22)
6282 * show hidden text: Visibility cycling. (line 6)
6283 * showall, STARTUP keyword: In-buffer settings. (line 22)
6284 * showstars, STARTUP keyword: In-buffer settings. (line 42)
6285 * sorting, of agenda items: Sorting of agenda items.
6287 * sparse tree, for deadlines: Creating timestamps. (line 41)
6288 * sparse tree, for TODO: TODO basics. (line 26)
6289 * sparse tree, tag based: Tags. (line 6)
6290 * sparse trees: Sparse trees. (line 6)
6291 * special keywords: In-buffer settings. (line 6)
6292 * spreadsheet capabilities: The spreadsheet. (line 6)
6293 * statistics, for checkboxes: Checkboxes. (line 23)
6294 * storing links: Handling links. (line 9)
6295 * structure editing: Structure editing. (line 6)
6296 * structure of document: Document structure. (line 6)
6297 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
6298 * sublevels, inclusion into todo list: Global TODO list. (line 33)
6299 * subscript: Subscripts and Superscripts.
6301 * subtree cycling: Visibility cycling. (line 10)
6302 * subtree visibility states: Visibility cycling. (line 10)
6303 * subtree, cut and paste: Structure editing. (line 6)
6304 * subtree, subtree visibility state: Visibility cycling. (line 10)
6305 * subtrees, cut and paste: Structure editing. (line 6)
6306 * summary: Summary. (line 6)
6307 * superscript: Subscripts and Superscripts.
6309 * syntax, of formulas: Formula syntax for Calc.
6311 * table editor, built-in: Built-in table editor.
6313 * table editor, table.el: Cooperation. (line 37)
6314 * table of contents: Export options. (line 25)
6315 * table.el: Cooperation. (line 34)
6316 * tables <1>: Export options. (line 25)
6317 * tables: Tables. (line 6)
6318 * tables, export: Enhancing text. (line 24)
6319 * tables, in other modes: Tables in arbitrary syntax.
6321 * tag completion: Completion. (line 6)
6322 * tag searches: Tag searches. (line 6)
6323 * tags: Tags. (line 6)
6324 * tags view: Matching headline tags.
6326 * tags, setting: Setting tags. (line 6)
6327 * targets, for links: Internal links. (line 6)
6328 * targets, radio: Radio targets. (line 6)
6329 * tasks, breaking down: Breaking down tasks. (line 6)
6330 * templates, for remember: Remember templates. (line 6)
6331 * TeX interpretation: Embedded LaTeX. (line 6)
6332 * TeX macros <1>: Export options. (line 25)
6333 * TeX macros: Math symbols. (line 6)
6334 * TeX macros, export: Enhancing text. (line 21)
6335 * TeX symbol completion: Completion. (line 6)
6336 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
6337 * thanks: History and Acknowledgments.
6339 * time format, custom: Custom time format. (line 6)
6340 * time grid: Time-of-day specifications.
6342 * time stamps <1>: Time stamps. (line 6)
6343 * time stamps: Timestamps. (line 6)
6344 * time, reading in minibuffer: The date/time prompt.
6346 * time-of-day specification: Time-of-day specifications.
6348 * time-sorted view: Timeline. (line 6)
6349 * timeline, single file: Timeline. (line 6)
6350 * timerange: Time stamps. (line 31)
6351 * timestamp: Time stamps. (line 14)
6352 * timestamp, inactive: Time stamps. (line 24)
6353 * timestamps, creating: Creating timestamps. (line 6)
6354 * TODO items: TODO items. (line 6)
6355 * TODO items, repeating: Repeating items. (line 6)
6356 * TODO keyword matching: Global TODO list. (line 17)
6357 * TODO keyword matching, with tags search: Tag searches. (line 40)
6358 * TODO keywords completion: Completion. (line 6)
6359 * TODO list, global: Global TODO list. (line 6)
6360 * TODO types: TODO types. (line 6)
6361 * TODO workflow: Workflow states. (line 6)
6362 * transient-mark-mode <1>: Export commands. (line 6)
6363 * transient-mark-mode <2>: ASCII export. (line 9)
6364 * transient-mark-mode <3>: Built-in table editor.
6366 * transient-mark-mode: Structure editing. (line 64)
6367 * translator function: Translator functions.
6369 * trees, sparse: Sparse trees. (line 6)
6370 * trees, visibility: Visibility cycling. (line 6)
6371 * tty keybindings: TTY keys. (line 6)
6372 * types as TODO keywords: TODO types. (line 6)
6373 * underlined text: Enhancing text. (line 15)
6374 * undoing remote-editing events: Agenda commands. (line 109)
6375 * updating, table: Updating the table. (line 6)
6376 * URL links: External links. (line 6)
6377 * USENET links: External links. (line 6)
6378 * variables, for customization: Customization. (line 6)
6379 * vectors, in table calculations: Formula syntax for Calc.
6381 * visibility cycling: Visibility cycling. (line 6)
6382 * visible text, printing: Sparse trees. (line 41)
6383 * VM links: External links. (line 6)
6384 * WANDERLUST links: External links. (line 6)
6385 * weekly agenda: Weekly/Daily agenda. (line 6)
6386 * windmove.el: Conflicts. (line 33)
6387 * workflow states as TODO keywords: Workflow states. (line 6)
6388 * XEmacs: Installation. (line 6)
6389 * XOXO export: XOXO export. (line 6)
6392 File: org, Node: Key Index, Prev: Index, Up: Top
6400 * $: Agenda commands. (line 123)
6401 * ': CDLaTeX mode. (line 43)
6402 * +: Agenda commands. (line 145)
6403 * ,: Agenda commands. (line 137)
6404 * -: Agenda commands. (line 151)
6405 * .: Agenda commands. (line 100)
6406 * :: Agenda commands. (line 131)
6407 * <: The date/time prompt.
6409 * <left>: Agenda commands. (line 97)
6410 * <RET> <1>: Agenda commands. (line 41)
6411 * <RET> <2>: Setting tags. (line 76)
6412 * <RET> <3>: The date/time prompt.
6414 * <RET>: Built-in table editor.
6416 * <right>: Agenda commands. (line 92)
6417 * <SPC> <1>: Agenda commands. (line 28)
6418 * <SPC>: Setting tags. (line 73)
6419 * <TAB> <1>: CDLaTeX mode. (line 23)
6420 * <TAB> <2>: Agenda commands. (line 35)
6421 * <TAB> <3>: Setting tags. (line 68)
6422 * <TAB> <4>: Editing and debugging formulas.
6424 * <TAB> <5>: Built-in table editor.
6426 * <TAB> <6>: Plain lists. (line 37)
6427 * <TAB>: Visibility cycling. (line 10)
6428 * > <1>: Agenda commands. (line 173)
6429 * >: The date/time prompt.
6431 * ^: CDLaTeX mode. (line 33)
6432 * _: CDLaTeX mode. (line 33)
6433 * `: CDLaTeX mode. (line 39)
6434 * a: Agenda commands. (line 134)
6435 * b: Agenda commands. (line 51)
6436 * C: Agenda commands. (line 213)
6437 * c: Agenda commands. (line 191)
6438 * C-#: Advanced features. (line 9)
6439 * C-': Agenda files. (line 18)
6440 * C-,: Agenda files. (line 18)
6441 * C-_: Agenda commands. (line 109)
6442 * C-a a L: Timeline. (line 10)
6443 * C-c !: Creating timestamps. (line 21)
6444 * C-c #: Checkboxes. (line 56)
6445 * C-c %: Handling links. (line 81)
6446 * C-c &: Handling links. (line 85)
6447 * C-c ': Editing and debugging formulas.
6449 * C-c *: Updating the table. (line 13)
6450 * C-c +: Built-in table editor.
6452 * C-c ,: Priorities. (line 18)
6453 * C-c -: Built-in table editor.
6455 * C-c .: Creating timestamps. (line 10)
6456 * C-c /: Sparse trees. (line 15)
6457 * C-c :: Enhancing text. (line 32)
6458 * C-c ;: Comment lines. (line 11)
6459 * C-c <: Creating timestamps. (line 25)
6460 * C-c <TAB>: Built-in table editor.
6462 * C-c = <1>: Editing and debugging formulas.
6464 * C-c =: Column formulas. (line 24)
6465 * C-c >: Creating timestamps. (line 29)
6466 * C-c ?: Editing and debugging formulas.
6468 * C-c [: Agenda files. (line 12)
6469 * C-c \: Tag searches. (line 9)
6470 * C-c ]: Agenda files. (line 15)
6471 * C-c ^ <1>: Built-in table editor.
6473 * C-c ^: Structure editing. (line 52)
6474 * C-c `: Built-in table editor.
6476 * C-c a !: Stuck projects. (line 14)
6477 * C-c a #: Stuck projects. (line 13)
6478 * C-c a a: Weekly/Daily agenda. (line 9)
6479 * C-c a C: Storing searches. (line 9)
6480 * C-c a M: Matching headline tags.
6482 * C-c a m: Matching headline tags.
6484 * C-c a M: Tag searches. (line 16)
6485 * C-c a m: Tag searches. (line 12)
6486 * C-c a T: Global TODO list. (line 14)
6487 * C-c a t <1>: Global TODO list. (line 9)
6488 * C-c a t: TODO basics. (line 33)
6489 * C-c C-a: Visibility cycling. (line 31)
6490 * C-c C-b: Motion. (line 15)
6491 * C-c C-c <1>: Cooperation. (line 37)
6492 * C-c C-c <2>: The very busy C-c C-c key.
6494 * C-c C-c <3>: Processing LaTeX fragments.
6496 * C-c C-c <4>: Setting tags. (line 10)
6497 * C-c C-c <5>: Checkboxes. (line 37)
6498 * C-c C-c <6>: Editing and debugging formulas.
6500 * C-c C-c <7>: Built-in table editor.
6502 * C-c C-c: Plain lists. (line 74)
6503 * C-c C-d <1>: Agenda commands. (line 158)
6504 * C-c C-d: Creating timestamps. (line 37)
6505 * C-c C-e: Exporting. (line 19)
6506 * C-c C-e a: ASCII export. (line 9)
6507 * C-c C-e b: Export commands. (line 7)
6508 * C-c C-e c: iCalendar export. (line 20)
6509 * C-c C-e h: Export commands. (line 6)
6510 * C-c C-e I: iCalendar export. (line 15)
6511 * C-c C-e i: iCalendar export. (line 13)
6512 * C-c C-e t: Export options. (line 13)
6513 * C-c C-e v <1>: XOXO export. (line 11)
6514 * C-c C-e v: Sparse trees. (line 41)
6515 * C-c C-e v a: ASCII export. (line 13)
6516 * C-c C-e v b: Export commands. (line 10)
6517 * C-c C-e v h: Export commands. (line 10)
6518 * C-c C-e x: XOXO export. (line 10)
6519 * C-c C-f: Motion. (line 12)
6520 * C-c C-j: Motion. (line 21)
6521 * C-c C-l: Handling links. (line 27)
6522 * C-c C-n: Motion. (line 8)
6523 * C-c C-o <1>: Creating timestamps. (line 33)
6524 * C-c C-o: Handling links. (line 58)
6525 * C-c C-p: Motion. (line 9)
6526 * C-c C-q <1>: Editing and debugging formulas.
6528 * C-c C-q: Built-in table editor.
6530 * C-c C-r: Visibility cycling. (line 32)
6531 * C-c C-s <1>: Agenda commands. (line 155)
6532 * C-c C-s: Creating timestamps. (line 48)
6533 * C-c C-t <1>: Clocking work time. (line 27)
6534 * C-c C-t: TODO basics. (line 13)
6535 * C-c C-u: Motion. (line 18)
6536 * C-c C-v: TODO basics. (line 26)
6537 * C-c C-w: Creating timestamps. (line 41)
6538 * C-c C-x b: Visibility cycling. (line 39)
6539 * C-c C-x C-a: ARCHIVE tag. (line 28)
6540 * C-c C-x C-b: Checkboxes. (line 38)
6541 * C-c C-x C-c: Agenda commands. (line 220)
6542 * C-c C-x C-d: Clocking work time. (line 35)
6543 * C-c C-x C-i: Clocking work time. (line 12)
6544 * C-c C-x C-k: Structure editing. (line 39)
6545 * C-c C-x C-l: Processing LaTeX fragments.
6547 * C-c C-x C-n: Handling links. (line 91)
6548 * C-c C-x C-o: Clocking work time. (line 14)
6549 * C-c C-x C-p: Handling links. (line 91)
6550 * C-c C-x C-r: Clocking work time. (line 43)
6551 * C-c C-x C-s: Moving subtrees. (line 10)
6552 * C-c C-x C-t: Custom time format. (line 12)
6553 * C-c C-x C-u: Dynamic blocks. (line 21)
6554 * C-c C-x C-w <1>: Built-in table editor.
6556 * C-c C-x C-w: Structure editing. (line 39)
6557 * C-c C-x C-x: Clocking work time. (line 31)
6558 * C-c C-x C-y <1>: Built-in table editor.
6560 * C-c C-x C-y: Structure editing. (line 46)
6561 * C-c C-x M-w <1>: Built-in table editor.
6563 * C-c C-x M-w: Structure editing. (line 43)
6564 * C-c C-y <1>: Clocking work time. (line 22)
6565 * C-c C-y: Creating timestamps. (line 66)
6566 * C-c l: Handling links. (line 9)
6567 * C-c {: CDLaTeX mode. (line 21)
6568 * C-c |: Built-in table editor.
6570 * C-c ~: Cooperation. (line 50)
6571 * C-k: Agenda commands. (line 117)
6572 * C-TAB: ARCHIVE tag. (line 38)
6573 * C-u C-c *: Updating the table. (line 18)
6574 * C-u C-c .: Creating timestamps. (line 16)
6575 * C-u C-c = <1>: Editing and debugging formulas.
6577 * C-u C-c =: Field formulas. (line 24)
6578 * C-u C-c C-c: Updating the table. (line 19)
6579 * C-u C-c C-l: Handling links. (line 43)
6580 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
6581 * C-u C-c C-x C-s: Moving subtrees. (line 12)
6582 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
6583 * C-u C-c C-x C-u: Clocking work time. (line 70)
6584 * C-u C-u C-c *: Updating the table. (line 24)
6585 * C-u C-u C-c =: Editing and debugging formulas.
6587 * D: Agenda commands. (line 74)
6588 * d: Agenda commands. (line 71)
6589 * f: Agenda commands. (line 44)
6590 * g: Agenda commands. (line 78)
6591 * H: Agenda commands. (line 217)
6592 * i: Agenda commands. (line 198)
6593 * I: Agenda commands. (line 178)
6594 * l: Agenda commands. (line 57)
6595 * L: Agenda commands. (line 32)
6596 * M: Agenda commands. (line 204)
6597 * M-<down> <1>: Editing and debugging formulas.
6599 * M-<down>: Built-in table editor.
6601 * M-<left> <1>: Built-in table editor.
6603 * M-<left>: Structure editing. (line 21)
6604 * M-<RET> <1>: Plain lists. (line 42)
6605 * M-<RET>: Structure editing. (line 6)
6606 * M-<right> <1>: Built-in table editor.
6608 * M-<right>: Structure editing. (line 24)
6609 * M-<TAB> <1>: Completion. (line 10)
6610 * M-<TAB> <2>: Setting tags. (line 6)
6611 * M-<TAB> <3>: Per file keywords. (line 17)
6612 * M-<TAB>: Editing and debugging formulas.
6614 * M-<up> <1>: Editing and debugging formulas.
6616 * M-<up>: Built-in table editor.
6618 * M-S-<down> <1>: Built-in table editor.
6620 * M-S-<down> <2>: Plain lists. (line 59)
6621 * M-S-<down>: Structure editing. (line 36)
6622 * M-S-<left> <1>: The date/time prompt.
6624 * M-S-<left> <2>: Built-in table editor.
6626 * M-S-<left> <3>: Plain lists. (line 65)
6627 * M-S-<left>: Structure editing. (line 27)
6628 * M-S-<RET> <1>: Checkboxes. (line 53)
6629 * M-S-<RET> <2>: Plain lists. (line 52)
6630 * M-S-<RET>: Structure editing. (line 18)
6631 * M-S-<right> <1>: The date/time prompt.
6633 * M-S-<right> <2>: Built-in table editor.
6635 * M-S-<right> <3>: Plain lists. (line 65)
6636 * M-S-<right>: Structure editing. (line 30)
6637 * M-S-<up> <1>: Built-in table editor.
6639 * M-S-<up> <2>: Plain lists. (line 59)
6640 * M-S-<up>: Structure editing. (line 33)
6641 * mouse-1 <1>: Agenda commands. (line 35)
6642 * mouse-1 <2>: The date/time prompt.
6644 * mouse-1: Handling links. (line 72)
6645 * mouse-2 <1>: Agenda commands. (line 35)
6646 * mouse-2: Handling links. (line 72)
6647 * mouse-3 <1>: Agenda commands. (line 28)
6648 * mouse-3: Handling links. (line 77)
6649 * n: Agenda commands. (line 19)
6650 * O: Agenda commands. (line 180)
6651 * o: Agenda commands. (line 65)
6652 * P: Agenda commands. (line 142)
6653 * p: Agenda commands. (line 20)
6654 * q: Agenda commands. (line 227)
6655 * r <1>: Agenda commands. (line 82)
6656 * r: Global TODO list. (line 20)
6657 * S: Agenda commands. (line 208)
6658 * s: Agenda commands. (line 89)
6659 * S-<down> <1>: Agenda commands. (line 151)
6660 * S-<down> <2>: The date/time prompt.
6662 * S-<down> <3>: Creating timestamps. (line 58)
6663 * S-<down> <4>: Priorities. (line 25)
6664 * S-<down> <5>: Editing and debugging formulas.
6666 * S-<down>: Plain lists. (line 55)
6667 * S-<left> <1>: Agenda commands. (line 169)
6668 * S-<left> <2>: The date/time prompt.
6670 * S-<left> <3>: Creating timestamps. (line 53)
6671 * S-<left>: TODO basics. (line 20)
6672 * S-<RET>: Built-in table editor.
6674 * S-<right> <1>: Agenda commands. (line 161)
6675 * S-<right> <2>: The date/time prompt.
6677 * S-<right> <3>: Creating timestamps. (line 53)
6678 * S-<right>: TODO basics. (line 20)
6679 * S-<TAB> <1>: Built-in table editor.
6681 * S-<TAB>: Visibility cycling. (line 22)
6682 * S-<up> <1>: Agenda commands. (line 145)
6683 * S-<up> <2>: The date/time prompt.
6685 * S-<up> <3>: Creating timestamps. (line 58)
6686 * S-<up> <4>: Priorities. (line 25)
6687 * S-<up> <5>: Editing and debugging formulas.
6689 * S-<up>: Plain lists. (line 55)
6690 * T: Agenda commands. (line 126)
6691 * t: Agenda commands. (line 113)
6692 * w: Agenda commands. (line 68)
6693 * x: Agenda commands. (line 230)
6694 * X: Agenda commands. (line 183)
6700 Node: Introduction
\x7f11466
6701 Node: Summary
\x7f11881
6702 Node: Installation
\x7f14889
6703 Node: Activation
\x7f16267
6704 Node: Feedback
\x7f17516
6705 Node: Document structure
\x7f19592
6706 Node: Outlines
\x7f20366
6707 Node: Headlines
\x7f21026
6708 Node: Visibility cycling
\x7f21649
6709 Ref: Visibility cycling-Footnote-1
\x7f23740
6710 Ref: Visibility cycling-Footnote-2
\x7f23798
6711 Ref: Visibility cycling-Footnote-3
\x7f23848
6712 Node: Motion
\x7f24117
6713 Node: Structure editing
\x7f24901
6714 Node: Archiving
\x7f27727
6715 Node: ARCHIVE tag
\x7f28285
6716 Node: Moving subtrees
\x7f30078
6717 Node: Sparse trees
\x7f31389
6718 Ref: Sparse trees-Footnote-1
\x7f33521
6719 Ref: Sparse trees-Footnote-2
\x7f33703
6720 Node: Plain lists
\x7f33818
6721 Ref: Plain lists-Footnote-1
\x7f37343
6722 Ref: Plain lists-Footnote-2
\x7f37700
6723 Node: Tables
\x7f37884
6724 Node: Built-in table editor
\x7f38398
6725 Node: Narrow columns
\x7f45394
6726 Ref: Narrow columns-Footnote-1
\x7f47326
6727 Node: orgtbl-mode
\x7f47372
6728 Node: The spreadsheet
\x7f48176
6729 Node: References
\x7f48994
6730 Node: Formula syntax for Calc
\x7f52251
6731 Node: Formula syntax for Lisp
\x7f54568
6732 Node: Field formulas
\x7f55796
6733 Node: Column formulas
\x7f57107
6734 Node: Editing and debugging formulas
\x7f58530
6735 Node: Updating the table
\x7f61640
6736 Node: Advanced features
\x7f62671
6737 Node: Hyperlinks
\x7f67196
6738 Node: Link format
\x7f67969
6739 Node: Internal links
\x7f69262
6740 Ref: Internal links-Footnote-1
\x7f71251
6741 Node: Radio targets
\x7f71383
6742 Node: CamelCase links
\x7f72098
6743 Node: External links
\x7f72692
6744 Node: Handling links
\x7f75096
6745 Ref: Handling links-Footnote-1
\x7f80188
6746 Ref: Handling links-Footnote-2
\x7f80425
6747 Node: Link abbreviations
\x7f80499
6748 Node: Search options
\x7f82178
6749 Ref: Search options-Footnote-1
\x7f83958
6750 Node: Custom searches
\x7f84039
6751 Node: Remember
\x7f85087
6752 Node: Setting up remember
\x7f86074
6753 Node: Remember templates
\x7f86656
6754 Ref: Remember templates-Footnote-1
\x7f89971
6755 Node: Storing notes
\x7f90069
6756 Node: TODO items
\x7f91877
6757 Node: TODO basics
\x7f92859
6758 Node: TODO extensions
\x7f94386
6759 Node: Workflow states
\x7f95181
6760 Node: TODO types
\x7f96166
6761 Ref: TODO types-Footnote-1
\x7f97824
6762 Node: Per file keywords
\x7f97906
6763 Ref: Per file keywords-Footnote-1
\x7f99360
6764 Node: Priorities
\x7f99561
6765 Node: Breaking down tasks
\x7f100805
6766 Ref: Breaking down tasks-Footnote-1
\x7f101324
6767 Node: Checkboxes
\x7f101420
6768 Node: Timestamps
\x7f104175
6769 Node: Time stamps
\x7f104709
6770 Ref: Time stamps-Footnote-1
\x7f108203
6771 Ref: Time stamps-Footnote-2
\x7f108319
6772 Node: Creating timestamps
\x7f108474
6773 Node: The date/time prompt
\x7f111100
6774 Ref: The date/time prompt-Footnote-1
\x7f112866
6775 Node: Custom time format
\x7f112972
6776 Node: Repeating items
\x7f114530
6777 Node: Progress logging
\x7f116340
6778 Node: Closing items
\x7f116986
6779 Ref: Closing items-Footnote-1
\x7f117920
6780 Ref: Closing items-Footnote-2
\x7f117989
6781 Node: Tracking TODO state changes
\x7f118062
6782 Node: Clocking work time
\x7f118918
6783 Ref: Clocking work time-Footnote-1
\x7f122564
6784 Ref: Clocking work time-Footnote-2
\x7f122642
6785 Node: Tags
\x7f122768
6786 Node: Tag inheritance
\x7f123530
6787 Node: Setting tags
\x7f124467
6788 Ref: Setting tags-Footnote-1
\x7f128666
6789 Ref: Setting tags-Footnote-2
\x7f128778
6790 Node: Tag searches
\x7f128861
6791 Node: Agenda views
\x7f131572
6792 Node: Agenda files
\x7f133517
6793 Ref: Agenda files-Footnote-1
\x7f134483
6794 Ref: Agenda files-Footnote-2
\x7f134632
6795 Node: Agenda dispatcher
\x7f134825
6796 Node: Built-in agenda views
\x7f136516
6797 Node: Weekly/Daily agenda
\x7f137094
6798 Node: Global TODO list
\x7f139223
6799 Node: Matching headline tags
\x7f141396
6800 Node: Timeline
\x7f142467
6801 Node: Stuck projects
\x7f143133
6802 Node: Presentation and sorting
\x7f144832
6803 Node: Categories
\x7f145623
6804 Node: Time-of-day specifications
\x7f146287
6805 Node: Sorting of agenda items
\x7f148258
6806 Node: Agenda commands
\x7f149540
6807 Node: Custom agenda views
\x7f156193
6808 Node: Storing searches
\x7f156868
6809 Node: Block agenda
\x7f158780
6810 Node: Setting Options
\x7f160010
6811 Node: Batch processing
\x7f162722
6812 Node: Embedded LaTeX
\x7f163852
6813 Ref: Embedded LaTeX-Footnote-1
\x7f164944
6814 Node: Math symbols
\x7f165134
6815 Node: Subscripts and Superscripts
\x7f165899
6816 Node: LaTeX fragments
\x7f166743
6817 Ref: LaTeX fragments-Footnote-1
\x7f168851
6818 Node: Processing LaTeX fragments
\x7f169113
6819 Node: CDLaTeX mode
\x7f170059
6820 Ref: CDLaTeX mode-Footnote-1
\x7f172543
6821 Node: Exporting
\x7f172691
6822 Node: ASCII export
\x7f174005
6823 Node: HTML export
\x7f175295
6824 Node: Export commands
\x7f175914
6825 Node: Quoting HTML tags
\x7f176638
6826 Node: Links
\x7f177101
6827 Node: Images
\x7f177798
6828 Ref: Images-Footnote-1
\x7f178669
6829 Node: CSS support
\x7f178730
6830 Ref: CSS support-Footnote-1
\x7f180049
6831 Node: XOXO export
\x7f180162
6832 Node: iCalendar export
\x7f180601
6833 Node: Text interpretation
\x7f181704
6834 Node: Comment lines
\x7f182183
6835 Node: Enhancing text
\x7f182654
6836 Node: Export options
\x7f184472
6837 Node: Publishing
\x7f186139
6838 Ref: Publishing-Footnote-1
\x7f186935
6839 Node: Configuration
\x7f187131
6840 Node: Project alist
\x7f187849
6841 Node: Sources and destinations
\x7f188915
6842 Node: Selecting files
\x7f189645
6843 Node: Publishing action
\x7f190393
6844 Node: Publishing options
\x7f191626
6845 Node: Publishing links
\x7f193778
6846 Node: Project page index
\x7f195291
6847 Node: Sample configuration
\x7f196069
6848 Node: Simple example
\x7f196561
6849 Node: Complex example
\x7f197234
6850 Node: Triggering publication
\x7f199310
6851 Node: Miscellaneous
\x7f199995
6852 Node: Completion
\x7f200629
6853 Node: Customization
\x7f202100
6854 Node: In-buffer settings
\x7f202683
6855 Node: The very busy C-c C-c key
\x7f206923
6856 Node: Clean view
\x7f208567
6857 Node: TTY keys
\x7f211144
6858 Node: Interaction
\x7f212753
6859 Node: Cooperation
\x7f213150
6860 Node: Conflicts
\x7f215890
6861 Node: Bugs
\x7f217482
6862 Node: Extensions and Hacking
\x7f218978
6863 Node: Extensions
\x7f219574
6864 Node: Tables in arbitrary syntax
\x7f221521
6865 Node: Radio tables
\x7f222596
6866 Ref: Radio tables-Footnote-1
\x7f225128
6867 Node: A LaTeX example
\x7f225236
6868 Ref: A LaTeX example-Footnote-1
\x7f228852
6869 Ref: A LaTeX example-Footnote-2
\x7f229000
6870 Node: Translator functions
\x7f229435
6871 Node: Dynamic blocks
\x7f230466
6872 Node: Special agenda views
\x7f232438
6873 Ref: Special agenda views-Footnote-1
\x7f234717
6874 Node: History and Acknowledgments
\x7f234977
6875 Node: Index
\x7f240766
6876 Node: Key Index
\x7f271825