Release 4.76
[org-mode/org-tableheadings.git] / org
blob6eb749266c1ec81341618c3c91008f6d4c7d143b
1 This is org, produced by makeinfo version 4.8 from org.texi.
3 INFO-DIR-SECTION Emacs
4 START-INFO-DIR-ENTRY
5 * Org Mode: (org).      Outline-based notes management and organizer
6 END-INFO-DIR-ENTRY
8    This manual is for Org-mode (version 4.76).
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."
24 \x1f
25 File: org,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)
27 Org Mode Manual
28 ***************
30 This manual is for Org-mode (version 4.76).
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."
46 * Menu:
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 ---
67 Introduction
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.
74 Document Structure
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
85 Archiving
87 * ARCHIVE tag::                 Marking a tree as inactive
88 * Moving subtrees::             Moving a tree to an archive file
90 Tables
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.
97 The spreadsheet
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
108 Hyperlinks
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
119 Internal links
121 * Radio targets::               Make targets trigger links in plain text.
123 Remember
125 * Setting up remember::         Some code for .emacs to get things going
126 * Remember templates::          Define the outline of different note types
127 * Storing notes::               Directly get the note to where it belongs
129 TODO items
131 * TODO basics::                 Marking and displaying TODO entries
132 * TODO extensions::             Workflow and assignments
133 * Priorities::                  Some things are more important than others
134 * Breaking down tasks::         Splitting a task into manageable pieces
135 * Checkboxes::                  Tick-off lists
137 Extended use of TODO keywords
139 * Workflow states::             From TODO to DONE in steps
140 * TODO types::                  I do this, Fred the rest
141 * Multiple sets in one file::   Mixing it all, and still finding your way
142 * Per file keywords::           Different files, different requirements
144 Timestamps
146 * Time stamps::                 Assigning a time to a tree entry
147 * Creating timestamps::         Commands which insert timestamps
148 * Deadlines and scheduling::    Planning your work
149 * Progress logging::            Documenting when what work was done.
151 Creating timestamps
153 * The date/time prompt::        How org-mode helps you entering date and time
154 * Custom time format::          Making dates look differently
156 Deadlines and Scheduling
158 * Inserting deadline/schedule::
159 * Repeated tasks::
161 Progress Logging
163 * Closing items::               When was this entry marked DONE?
164 * Tracking TODO state changes::  When did the status change?
165 * Clocking work time::          When exactly did you work on this item?
167 Tags
169 * Tag inheritance::             Tags use the tree structure of the outline
170 * Setting tags::                How to assign tags to a headline
171 * Tag searches::                Searching for combinations of tags
173 Agenda Views
175 * Agenda files::                Files being searched for agenda information
176 * Agenda dispatcher::           Keyboard access to agenda views
177 * Built-in agenda views::       What is available out of the box?
178 * Presentation and sorting::    How agenda items are prepared for display
179 * Agenda commands::             Remote editing of org trees
180 * Custom agenda views::         Defining special searches and views
182 The built-in agenda views
184 * Weekly/Daily agenda::         The calendar page with current tasks
185 * Global TODO list::            All unfinished action items
186 * Matching headline tags::      Structured information with fine-tuned search
187 * Timeline::                    Time-sorted view for single file
188 * Stuck projects::              Find projects you need to review
190 Presentation and sorting
192 * Categories::                  Not all tasks are equal
193 * Time-of-day specifications::  How the agenda knows the time
194 * Sorting of agenda items::     The order of things
196 Custom agenda views
198 * Storing searches::            Type once, use often
199 * Block agenda::                All the stuff you need in a single buffer
200 * Setting Options::             Changing the rules
201 * Exporting Agenda Views::      Writing agendas to files.
202 * Extracting Agenda Information for other programs::
204 Embedded LaTeX
206 * Math symbols::                TeX macros for symbols and Greek letters
207 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
208 * LaTeX fragments::             Complex formulas made easy
209 * Processing LaTeX fragments::  Previewing LaTeX processing
210 * CDLaTeX mode::                Speed up entering of formulas
212 Exporting
214 * ASCII export::                Exporting to plain ASCII
215 * HTML export::                 Exporting to HTML
216 * XOXO export::                 Exporting to XOXO
217 * iCalendar export::            Exporting in iCalendar format
218 * Text interpretation::         How the exporter looks at the file
220 HTML export
222 * Export commands::             How to invoke HTML export
223 * Quoting HTML tags::           Using direct HTML in Org-mode
224 * Links::                       How hyperlinks get transferred to HTML
225 * Images::                      To inline or not to inline?
226 * CSS support::                 Style specifications
228 Text interpretation by the exporter
230 * Comment lines::               Some lines will not be exported
231 * Initial text::                Text before the first headline
232 * Footnotes::                   Numbers like [1]
233 * Enhancing text::              Subscripts, symbols and more
234 * Export options::              How to influence the export settings
236 Publishing
238 * Configuration::               Defining projects
239 * Sample configuration::        Example projects
240 * Triggering publication::      Publication commands
242 Configuration
244 * Project alist::               The central configuration variable
245 * Sources and destinations::    From here to there
246 * Selecting files::             What files are part of the project?
247 * Publishing action::           Setting the function doing the publishing
248 * Publishing options::          Tweaking HTML export
249 * Publishing links::            Which links keep working after publishing?
250 * Project page index::          Publishing a list of project files
252 Sample configuration
254 * Simple example::              One-component publishing
255 * Complex example::             A multi-component publishing example
257 Miscellaneous
259 * Completion::                  M-TAB knows what you need
260 * Customization::               Adapting Org-mode to your taste
261 * In-buffer settings::          Overview of the #+KEYWORDS
262 * The very busy C-c C-c key::   When in doubt, press C-c C-c
263 * Clean view::                  Getting rid of leading stars in the outline
264 * TTY keys::                    Using Org-mode on a tty
265 * Interaction::                 Other Emacs packages
266 * Bugs::                        Things which do not work perfectly
268 Interaction with other packages
270 * Cooperation::                 Packages Org-mode cooperates with
271 * Conflicts::                   Packages that lead to conflicts
273 Extensions, Hooks and Hacking
275 * Extensions::                  Existing 3rd-part extensions
276 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
277 * Dynamic blocks::              Automatically filled blocks
278 * Special agenda views::        Customized views
280 Tables in arbitrary syntax
282 * Radio tables::                Sending and receiving
283 * A LaTeX example::             Step by step, almost a tutorial
284 * Translator functions::        Copy and modify
286 \x1f
287 File: org,  Node: Introduction,  Next: Document structure,  Prev: Top,  Up: Top
289 1 Introduction
290 **************
292 * Menu:
294 * Summary::                     Brief summary of what Org-mode does
295 * Installation::                How to install a downloaded version of Org-mode
296 * Activation::                  How to activate Org-mode for certain buffers.
297 * Feedback::                    Bug reports, ideas, patches etc.
299 \x1f
300 File: org,  Node: Summary,  Next: Installation,  Prev: Introduction,  Up: Introduction
302 1.1 Summary
303 ===========
305 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
306 project planning with a fast and effective plain-text system.
308    Org-mode develops organizational tasks around NOTES files that
309 contain lists or information about projects as plain text.  Org-mode is
310 implemented on top of outline-mode, which makes it possible to keep the
311 content of large files well structured.  Visibility cycling and
312 structure editing help to work with the tree.  Tables are easily created
313 with a built-in table editor.  Org-mode supports ToDo items, deadlines,
314 time stamps, and scheduling.  It dynamically compiles entries into an
315 agenda that utilizes and smoothly integrates much of the Emacs calendar
316 and diary.  Plain text URL-like links connect to websites, emails,
317 Usenet messages, BBDB entries, and any files related to the projects.
318 For printing and sharing of notes, an Org-mode file can be exported as a
319 structured ASCII file, as HTML, or (todo and agenda items only) as an
320 iCalendar file.  It can also serve as a publishing tool for a set of
321 linked webpages.
323    An important design aspect that distinguishes Org-mode from for
324 example Planner/Muse is that it encourages to store every piece of
325 information only once.  In Planner, you have project pages, day pages
326 and possibly other files, duplicating some information such as tasks.
327 In Org-mode, you only have notes files.  In your notes you mark entries
328 as tasks, label them with tags and timestamps.  All necessary lists
329 like a schedule for the day, the agenda for a meeting, tasks lists
330 selected by tags etc are created dynamically when you need them.
332    Org-mode keeps simple things simple.  When first fired up, it should
333 feel like a straightforward, easy to use outliner.  Complexity is not
334 imposed, but a large amount of functionality is available when you need
335 it.  Org-mode can be used on different levels and in different ways, for
336 example as:
338      * outline extension with visibility cycling and structure editing
339      * ASCII system and table editor for taking structured notes
340      * ASCII table editor with spreadsheet-like capabilities
341      * TODO list editor
342      * full agenda and planner with deadlines and work scheduling
343      * environment to implement David Allen's GTD system
344      * simple hypertext system, with HTML export
345      * publishing tool to create a set of interlinked webpages
347    Org-mode's automatic, context sensitive table editor with spreadsheet
348 capabilities can be integrated into any major mode by activating the
349 minor Orgtbl-mode.  Using a translation step, it can be used to maintain
350 tables in arbitrary file types, for example in LaTeX.
352    There is a website for Org-mode which provides links to the newest
353 version of Org-mode, as well as additional information, frequently asked
354 questions (FAQ), links to tutorials etc.  This page is located at
355 `http://www.astro.uva.nl/~dominik/Tools/org/'.
357 \x1f
358 File: org,  Node: Installation,  Next: Activation,  Prev: Summary,  Up: Introduction
360 1.2 Installation
361 ================
363 Important: If Org-mode is part of the Emacs distribution or an XEmacs
364 package, please skip this section and go directly to *Note Activation::.
366    If you have downloaded Org-mode from the Web, you must take the
367 following steps to install it: Go into the Org-mode distribution
368 directory and edit the top section of the file `Makefile'.  You must
369 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
370 and the paths to the directories where local Lisp and Info files are
371 kept.  If you don't have access to the system-wide directories, create
372 your own two directories for these files, enter them into the Makefile,
373 and make sure Emacs finds the Lisp files by adding the following line
374 to `.emacs':
376      (setq load-path (cons "~/path/to/lispdir" load-path))
378    XEmacs users now need to install the file `noutline.el' from the
379 `xemacs' subdirectory of the Org-mode distribution.  Use the command:
381      make install-noutline
383 Now byte-compile and install the Lisp files with the shell commands:
385      make
386      make install
388 If you want to install the info documentation, use this command:
390      make install-info
392 Then add to `.emacs':
394      ;; This line only if org-mode is not part of the X/Emacs distribution.
395      (require 'org-install)
397 \x1f
398 File: org,  Node: Activation,  Next: Feedback,  Prev: Installation,  Up: Introduction
400 1.3 Activation
401 ==============
403 Add the following lines to your `.emacs' file.  The last two lines
404 define _global_ keys for the commands `org-store-link' and `org-agenda'
405 - please choose suitable keys yourself.
407      ;; The following lines are always needed.  Choose your own keys.
408      (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
409      (define-key global-map "\C-cl" 'org-store-link)
410      (define-key global-map "\C-ca" 'org-agenda)
412    Furthermore, you must activate `font-lock-mode' in org-mode buffers,
413 because significant functionality depends on font-locking being active.
414 You can do this with either one of the following two lines (XEmacs
415 user must use the second option):
416      (global-font-lock-mode 1)                     ; for all buffers
417      (add-hook 'org-mode-hook 'turn-on-font-lock)  ; org-mode buffers only
419    With this setup, all files with extension `.org' will be put into
420 Org-mode.  As an alternative, make the first line of a file look like
421 this:
423      MY PROJECTS    -*- mode: org; -*-
425 which will select Org-mode for this buffer no matter what the file's
426 name is.  See also the variable `org-insert-mode-line-in-empty-file'.
428 \x1f
429 File: org,  Node: Feedback,  Prev: Activation,  Up: Introduction
431 1.4 Feedback
432 ============
434 If you find problems with Org-mode, or if you have questions, remarks,
435 or ideas about it, please contact the maintainer Carsten Dominik at
436 <dominik at science dot uva dot nl>.
438    For bug reports, please provide as much information as possible,
439 including the version information of Emacs (`C-h v emacs-version
440 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
441 Org-mode related setup in `.emacs'.  If an error occurs, a backtrace
442 can be very useful (see below on how to create one).  Often a small
443 example file helps, along with clear information about:
445   1. What exactly did you do?
447   2. What did you expect to happen?
449   3. What happened instead?
450         Thank you for helping to improve this mode.
452 How to create a useful backtrace
453 ................................
455 If working with Org-mode produces an error with a message you don't
456 understand, you may have hit a bug.  The best way to report this is by
457 providing, in addition to what was mentioned above, a _Backtrace_.
458 This is information from the built-in debugger about where and how the
459 error occurred.  Here is how to produce a useful backtrace:
461   1. Start a fresh Emacs or XEmacs, and make sure that it will load the
462      original Lisp code in `org.el' instead of the compiled version in
463      `org.elc'.  The backtrace contains much more information if it is
464      produced with uncompiled code.  To do this, either rename `org.elc'
465      to something else before starting Emacs, or ask Emacs explicitly
466      to load `org.el' by using the command line
467           emacs -l /path/to/org.el
469   2. Go to the `Options' menu and select `Enter Debugger on Error'
470      (XEmacs has this option in the `Troubleshooting' sub-menu).
472   3. Do whatever you have to do to hit the error.  Don't forget to
473      document the steps you take.
475   4. When you hit the error, a `*Backtrace*' buffer will appear on the
476      screen.  Save this buffer to a file (for example using `C-x C-w')
477      and attach it to your bug report.
479 \x1f
480 File: org,  Node: Document structure,  Next: Tables,  Prev: Introduction,  Up: Top
482 2 Document Structure
483 ********************
485 Org-mode is based on outline mode and provides flexible commands to
486 edit the structure of the document.
488 * Menu:
490 * Outlines::                    Org-mode is based on outline-mode
491 * Headlines::                   How to typeset org-tree headlines
492 * Visibility cycling::          Show and hide, much simplified
493 * Motion::                      Jumping to other headlines
494 * Structure editing::           Changing sequence and level of headlines
495 * Archiving::                   Move done task trees to a different place
496 * Sparse trees::                Matches embedded in context
497 * Plain lists::                 Additional structure within an entry
499 \x1f
500 File: org,  Node: Outlines,  Next: Headlines,  Prev: Document structure,  Up: Document structure
502 2.1 Outlines
503 ============
505 Org-mode is implemented on top of outline-mode.  Outlines allow to
506 organize a document in a hierarchical structure, which (at least for
507 me) is the best representation of notes and thoughts.  Overview over
508 this structure is achieved by folding (hiding) large parts of the
509 document to show only the general document structure and the parts
510 currently being worked on.  Org-mode greatly simplifies the use of
511 outlines by compressing the entire show/hide functionality into a
512 single command `org-cycle', which is bound to the <TAB> key.
514 \x1f
515 File: org,  Node: Headlines,  Next: Visibility cycling,  Prev: Outlines,  Up: Document structure
517 2.2 Headlines
518 =============
520 Headlines define the structure of an outline tree.  The headlines in
521 Org-mode start with one or more stars, on the left margin(1).  For
522 example:
524      * Top level headline
525      ** Second level
526      *** 3rd level
527          some text
528      *** 3rd level
529          more text
531      * Another top level headline
533 Some people find the many stars too noisy and would prefer an outline
534 that has whitespace followed by a single star as headline starters.
535 *Note Clean view:: describes a setup to realize this.
537    An empty line after the end of a subtree is considered part of it and
538 will be hidden when the subtree is folded.  However, if you leave at
539 least two empty lines, one empty line will remain visible after folding
540 the subtree, in order to structure the collapsed view.  See the
541 variable `org-cycle-separator-lines' for modifying this behavior.
543    ---------- Footnotes ----------
545    (1) See the variable `org-special-ctrl-a' to configure special
546 behavior of `C-a' in headlines.
548 \x1f
549 File: org,  Node: Visibility cycling,  Next: Motion,  Prev: Headlines,  Up: Document structure
551 2.3 Visibility cycling
552 ======================
554 Outlines make it possible to hide parts of the text in the buffer.
555 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
556 the visibility in the buffer.
558 `<TAB>'
559      _Subtree cycling_: Rotate current subtree among the states
561           ,-> FOLDED -> CHILDREN -> SUBTREE --.
562           '-----------------------------------'
564      The cursor must be on a headline for this to work(1).  When the
565      cursor is at the beginning of the buffer and the first line is not
566      a headline, then <TAB> actually runs global cycling (see
567      below)(2).  Also when called with a prefix argument (`C-u <TAB>'),
568      global cycling is invoked.
570 `S-<TAB>'
571 `C-u <TAB>'
572      _Global cycling_: Rotate the entire buffer among the states
574           ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
575           '--------------------------------------'
577      When `S-<TAB>' is called with a numerical prefix N, the CONTENTS
578      view up to headlines of level N will be shown.  Note that inside
579      tables, `S-<TAB>' jumps to the previous field.
581 `C-c C-a'
582      Show all.  
584 `C-c C-r'
585      Reveal context around point, showing the current entry, the
586      following heading and the hierarchy above.  Useful for working
587      near a location exposed by a sparse tree command (*note Sparse
588      trees::) or an agenda command (*note Agenda commands::).  With
589      prefix arg show, on each level, all sibling headings.  
591 `C-c C-x b'
592      Show the current subtree in an indirect buffer(3).  With numerical
593      prefix ARG, go up to this level and then take that tree.  If ARG is
594      negative, go up that many levels.  With `C-u' prefix, do not remove
595      the previously used indirect buffer.
597    When Emacs first visits an Org-mode file, the global state is set to
598 OVERVIEW, i.e. only the top level headlines are visible.  This can be
599 configured through the variable `org-startup-folded', or on a per-file
600 basis by adding one of the following lines anywhere in the buffer:
602      #+STARTUP: overview
603      #+STARTUP: content
604      #+STARTUP: showall
606    ---------- Footnotes ----------
608    (1) see, however, the option `org-cycle-emulate-tab'.
610    (2) see the option `org-cycle-global-at-bob'.
612    (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
613 Buffers.)  will contain the entire buffer, but will be narrowed to the
614 current tree.  Editing the indirect buffer will also change the
615 original buffer, but without affecting visibility in that buffer.
617 \x1f
618 File: org,  Node: Motion,  Next: Structure editing,  Prev: Visibility cycling,  Up: Document structure
620 2.4 Motion
621 ==========
623 The following commands jump to other headlines in the buffer.
625 `C-c C-n'
626      Next heading.  
628 `C-c C-p'
629      Previous heading.  
631 `C-c C-f'
632      Next heading same level.  
634 `C-c C-b'
635      Previous heading same level.  
637 `C-c C-u'
638      Backward to higher level heading.  
640 `C-c C-j'
641      Jump to a different place without changing the current outline
642      visibility.  Shows the document structure in a temporary buffer,
643      where you can use the following keys to find your destination:
644           <TAB>         Cycle visibility.
645           <down> / <up>   Next/previous visible headline.
646           n / p        Next/previous visible headline.
647           f / b        Next/previous headline same level.
648           u            One level up.
649           0-9          Digit argument.
650           <RET>         Select this location.
652 \x1f
653 File: org,  Node: Structure editing,  Next: Archiving,  Prev: Motion,  Up: Document structure
655 2.5 Structure editing
656 =====================
658 `M-<RET>'
659      Insert new heading with same level as current.  If the cursor is
660      in a plain list item, a new item is created (*note Plain lists::).
661      To force creation of a new headline, use a prefix arg, or first
662      press <RET> to get to the beginning of the next line.  When this
663      command is used in the middle of a line, the line is split and the
664      rest of the line becomes the new headline.  If the command is used
665      at the beginning of a headline, the new headline is created before
666      the current line.  If at the beginning of any other line, the
667      content of that line is made the new heading.  If the command is
668      used at the end of a folded subtree (i.e. behind the ellipses at
669      the end of a headline), then a headline like the current one will
670      be inserted after the end of the subtree.  
672 `M-S-<RET>'
673      Insert new TODO entry with same level as current heading.  
675 `M-<left>'
676      Promote current heading by one level.  
678 `M-<right>'
679      Demote current heading by one level.  
681 `M-S-<left>'
682      Promote the current subtree by one level.  
684 `M-S-<right>'
685      Demote the current subtree by one level.  
687 `M-S-<up>'
688      Move subtree up (swap with previous subtree of same level).  
690 `M-S-<down>'
691      Move subtree down (swap with next subtree of same level).  
693 `C-c C-x C-w'
694 `C-c C-x C-k'
695      Kill subtree, i.e. remove it from buffer but save in kill ring.  
697 `C-c C-x M-w'
698      Copy subtree to kill ring.  
700 `C-c C-x C-y'
701      Yank subtree from kill ring.  This does modify the level of the
702      subtree to make sure the tree fits in nicely at the yank position.
703      The yank level can also be specified with a prefix arg, or by
704      yanking after a headline marker like `****'.  
706 `C-c ^'
707      Sort same-level entries.  When there is an active region, all
708      entries in the region will be sorted.  Otherwise the children of
709      the current headline are sorted.  The command prompts for the
710      sorting method, which can be alphabetically, numerically, by time
711      (using the first time stamp in each entry), and each of these in
712      reverse order.  With a `C-u' prefix, sorting will be
713      case-sensitive.  With two `C-u C-u' prefixes, duplicate entries
714      will also be removed.
716    When there is an active region (transient-mark-mode), promotion and
717 demotion work on all headlines in the region.  To select a region of
718 headlines, it is best to place both point and mark at the beginning of a
719 line, mark at the beginning of the first headline, and point at the line
720 just after the last headline to change.  Note that when the cursor is
721 inside a table (*note Tables::), the Meta-Cursor keys have different
722 functionality.
724 \x1f
725 File: org,  Node: Archiving,  Next: Sparse trees,  Prev: Structure editing,  Up: Document structure
727 2.6 Archiving
728 =============
730 When a project represented by a (sub)tree is finished, you may want to
731 move the tree out of the way and to stop it from contributing to the
732 agenda.  Org-mode knows two ways of archiving.  You can mark a tree with
733 the ARCHIVE tag, or you can move an entire (sub)tree to a different
734 location.
736 * Menu:
738 * ARCHIVE tag::                 Marking a tree as inactive
739 * Moving subtrees::             Moving a tree to an archive file
741 \x1f
742 File: org,  Node: ARCHIVE tag,  Next: Moving subtrees,  Prev: Archiving,  Up: Archiving
744 2.6.1 The ARCHIVE tag
745 ---------------------
747 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
748 its location in the outline tree, but behaves in the following way:
749    - It does not open when you attempt to do so with a visibility
750      cycling command (*note Visibility cycling::).  You can force
751      cycling archived subtrees with `C-<TAB>', or by setting the option
752      `org-cycle-open-archived-trees'.  Also normal outline commands like
753      `show-all' will open archived subtrees.
755    - During sparse tree construction (*note Sparse trees::), matches in
756      archived subtrees are not exposed, unless you configure the option
757      `org-sparse-tree-open-archived-trees'.
759    - During agenda view construction (*note Agenda views::), the
760      content of archived trees is ignored unless you configure the
761      option `org-agenda-skip-archived-trees'.
763    - Archived trees are not exported (*note Exporting::), only the
764      headline is.  Configure the details using the variable
765      `org-export-with-archived-trees'.
767    The following commands help managing the ARCHIVE tag:
769 `C-c C-x C-a'
770      Toggle the ARCHIVE tag for the current headline.  When the tag is
771      set, the headline changes to a shadowish face, and the subtree
772      below it is hidden.  
774 `C-u C-c C-x C-a'
775      Check if any direct children of the current headline should be
776      archived.  To do this, each subtree is checked for open TODO
777      entries.  If none are found, the command offers to set the ARCHIVE
778      tag for the child.  If the cursor is _not_ on a headline when this
779      command is invoked, the level 1 trees will be checked.  
781 `C-TAB'
782      Cycle a tree even if it is tagged with ARCHIVE.
784 \x1f
785 File: org,  Node: Moving subtrees,  Prev: ARCHIVE tag,  Up: Archiving
787 2.6.2 Moving subtrees
788 ---------------------
790 Once an entire project is finished, you may want to move it to a
791 different location, either in the current file, or even in a different
792 file, the archive file.
794 `C-c C-x C-s'
795      Archive the subtree starting at the cursor position to the location
796      given by `org-archive-location'.  
798 `C-u C-c C-x C-s'
799      Check if any direct children of the current headline could be
800      moved to the archive.  To do this, each subtree is checked for
801      open TODO entries.  If none are found, the command offers to move
802      it to the archive location.  If the cursor is _not_ on a headline
803      when this command is invoked, the level 1 trees will be checked.
805    The default archive location is a file in the same directory as the
806 current file, with the name derived by appending `_archive' to the
807 current file name.  For information and examples on how to change this,
808 see the documentation string of the variable `org-archive-location'.
809 There is also an in-buffer option for setting this variable, for example
811      #+ARCHIVE: %s_done::
813 You may have several such lines in the buffer, they will then be valid
814 for the entries following the line (the first will also apply to any
815 text before it).
817 \x1f
818 File: org,  Node: Sparse trees,  Next: Plain lists,  Prev: Archiving,  Up: Document structure
820 2.7 Sparse trees
821 ================
823 An important feature of Org-mode is the ability to construct _sparse
824 trees_ for selected information in an outline tree.  A sparse tree
825 means that the entire document is folded as much as possible, but the
826 selected information is made visible along with the headline structure
827 above it(1).  Just try it out and you will see immediately how it works.
829    Org-mode contains several commands creating such trees.  The most
830 basic one is `org-occur':
832 `C-c /'
833      Occur.  Prompts for a regexp and shows a sparse tree with all
834      matches.  If the match is in a headline, the headline is made
835      visible.  If the match is in the body of an entry, headline and
836      body are made visible.  In order to provide minimal context, also
837      the full hierarchy of headlines above the match is shown, as well
838      as the headline following the match.  Each match is also
839      highlighted; the highlights disappear when the buffer is changes
840      an editing command, or by pressing `C-c C-c'.  When called with a
841      `C-u' prefix argument, previous highlights are kept, so several
842      calls to this command can be stacked.
843    For frequently used sparse trees of specific search strings, you can
844 use the variable `org-agenda-custom-commands' to define fast keyboard
845 access to specific sparse trees.  These commands will then be
846 accessible through the agenda dispatcher (*note Agenda dispatcher::).
847 For example:
849      (setq org-agenda-custom-commands
850            '(("f" occur-tree "FIXME")))
852 will define the key `C-c a f' as a shortcut for creating a sparse tree
853 matching the string `FIXME'.
855    Other commands use sparse trees as well.  For example `C-c C-v'
856 creates a sparse TODO tree (*note TODO basics::).
858    To print a sparse tree, you can use the Emacs command
859 `ps-print-buffer-with-faces' which does not print invisible parts of
860 the document (2).  Or you can use the command `C-c C-e v' to export
861 only the visible part of the document and print the resulting file.
863    ---------- Footnotes ----------
865    (1) See also the variables `org-show-hierarchy-above',
866 `org-show-following-heading', and `org-show-siblings' for detailed
867 control on how much context is shown around each match.
869    (2) This does not work under XEmacs, because XEmacs uses selective
870 display for outlining, not text properties.
872 \x1f
873 File: org,  Node: Plain lists,  Prev: Sparse trees,  Up: Document structure
875 2.8 Plain lists
876 ===============
878 Within an entry of the outline tree, hand-formatted lists can provide
879 additional structure.  They also provide a way to create lists of
880 checkboxes (*note Checkboxes::).  Org-mode supports editing such lists,
881 and the HTML exporter (*note Exporting::) does parse and format them.
883    Org-mode knows ordered and unordered lists.  Unordered list items
884 start with `-', `+', or `*'(1) as bullets.  Ordered list items start
885 with `1.' or `1)'.  Items belonging to the same list must have the same
886 indentation on the first line.  In particular, if an ordered list
887 reaches number `10.', then the 2-digit numbers must be written
888 left-aligned with the other numbers in the list.  Indentation also
889 determines the end of a list item.  It ends before the next line that
890 is indented like the bullet/number, or less.  Empty lines are part of
891 the previous item, so you can have several paragraphs in one item.  If
892 you would like an emtpy line to terminate all currently open plain
893 lists, configure the variable `org-empty-line-terminates-plain-lists'.
894 Here is an for example:
896      ** Lord of the Rings
897         My favorite scenes are (in this order)
898         1. The attack of the Rohirrim
899         2. Eowyns fight with the witch king
900            + this was already my favorite scene in the book
901            + I really like Miranda Otto.
902         3. Peter Jackson being shot by Legolas
903             - on DVD only
904            He makes a really funny face when it happens.
905         But in the end, not individual scenes matter but the film as a whole.
907    Org-mode supports these lists by tuning filling and wrapping
908 commands to deal with them correctly(2).
910    The following commands act on items when the cursor is in the first
911 line of an item (the line with the bullet or number).
913 `<TAB>'
914      Items can be folded just like headline levels if you set the
915      variable `org-cycle-include-plain-lists'.  The level of an item is
916      then given by the indentation of the bullet/number.  Items are
917      always subordinate to real headlines, however; the hierarchies
918      remain completely separated.  
920 `M-<RET>'
921      Insert new item at current level.  With prefix arg, force a new
922      heading (*note Structure editing::).  If this command is used in
923      the middle of a line, the line is _split_ and the rest of the line
924      becomes the new item.  If this command is executed in the
925      _whitespace before a bullet or number_, the new item is created
926      _before_ the current item.  If the command is executed in the
927      white space before the text that is part of an item but does not
928      contain the bullet, a bullet is added to the current line.  
930 `M-S-<RET>'
931      Insert a new item with a checkbox (*note Checkboxes::).  
933 `S-<up>'
934 `S-<down>'
935      Jump to the previous/next item in the current list.  
937 `M-S-<up>'
938 `M-S-<down>'
939      Move the item including subitems up/down (swap with previous/next
940      item of same indentation).  If the list is ordered, renumbering is
941      automatic.  
943 `M-S-<left>'
944 `M-S-<right>'
945      Decrease/increase the indentation of the item, including subitems.
946      Initially, the item tree is selected based on current indentation.
947      When these commands are executed several times in direct
948      succession, the initially selected region is used, even if the new
949      indentation would imply a different hierarchy.  To use the new
950      hierarchy, break the command chain with a cursor motion or so.  
952 `C-c C-c'
953      If there is a checkbox (*note Checkboxes::) in the item line,
954      toggle the state of the checkbox.  Otherwise, if this is an
955      ordered list, renumber the ordered list at the cursor.
957    ---------- Footnotes ----------
959    (1) When using `*' as a bullet, lines must be indented or they will
960 be seen as top-level headlines.  Also, when you are hiding leading
961 stars to get a clean outline view, plain list items starting with a
962 star are visually indistinguishable from true headlines.  In short:
963 even though `*' is supported, it may be better not to use it for plain
964 list items.
966    (2) Org-mode only changes the filling settings for Emacs.  For
967 XEmacs, you should use Kyle E. Jones' `filladapt.el'.  To turn this on,
968 put into `.emacs':
969      (require 'filladapt)
971 \x1f
972 File: org,  Node: Tables,  Next: Hyperlinks,  Prev: Document structure,  Up: Top
974 3 Tables
975 ********
977 Org-mode has a very fast and intuitive table editor built-in.
978 Spreadsheet-like calculations are supported in connection with the
979 Emacs `calc' package.
981 * Menu:
983 * Built-in table editor::       Simple tables
984 * Narrow columns::              Stop wasting space in tables
985 * orgtbl-mode::                 The table editor as minor mode
986 * The spreadsheet::             The table editor has spreadsheet capabilities.
988 \x1f
989 File: org,  Node: Built-in table editor,  Next: Narrow columns,  Prev: Tables,  Up: Tables
991 3.1 The built-in table editor
992 =============================
994 Org-mode makes it easy to format tables in plain ASCII.  Any line with
995 `|' as the first non-white character is considered part of a table.
996 `|' is also the column separator.  A table might look like this:
998      | Name  | Phone | Age |
999      |-------+-------+-----|
1000      | Peter |  1234 |  17 |
1001      | Anna  |  4321 |  25 |
1003    A table is re-aligned automatically each time you press <TAB> or
1004 <RET> or `C-c C-c' inside the table.  <TAB> also moves to the next
1005 field (<RET> to the next row) and creates new table rows at the end of
1006 the table or before horizontal lines.  The indentation of the table is
1007 set by the first line.  Any line starting with `|-' is considered as a
1008 horizontal separator line and will be expanded on the next re-align to
1009 span the whole table width.  So, to create the above table, you would
1010 only type
1012      |Name|Phone|Age|
1013      |-
1015 and then press <TAB> to align the table and start filling in fields.
1017    When typing text into a field, Org-mode treats <DEL>, <Backspace>,
1018 and all character keys in a special way, so that inserting and deleting
1019 avoids shifting other fields.  Also, when typing _immediately after the
1020 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
1021 the field is automatically made blank.  If this behavior is too
1022 unpredictable for you, configure the variables
1023 `org-enable-table-editor' and `org-table-auto-blank-field'.
1025 Creation and conversion
1026 .......................
1028 `C-c |'
1029      Convert the active region to table. If every line contains at
1030      least one TAB character, the function assumes that the material is
1031      tab separated.  If not, lines are split at whitespace into fields.
1032      You can use a prefix argument to indicate the minimum number of
1033      consecutive spaces required to identify a field separator
1034      (default: just one).
1035      If there is no active region, this command creates an empty
1036      Org-mode table.  But it's easier just to start typing, like
1037      `|Name|Phone|Age <RET> |- <TAB>'.
1039 Re-aligning and field motion
1040 ............................
1042 `C-c C-c'
1043      Re-align the table without moving the cursor.  
1045 `<TAB>'
1046      Re-align the table, move to the next field.  Creates a new row if
1047      necessary.  
1049 `S-<TAB>'
1050      Re-align, move to previous field.  
1052 `<RET>'
1053      Re-align the table and move down to next row.  Creates a new row if
1054      necessary.  At the beginning or end of a line, <RET> still does
1055      NEWLINE, so it can be used to split a table.
1057 Column and row editing
1058 ......................
1060 `M-<left>'
1061 `M-<right>'
1062      Move the current column left/right.  
1064 `M-S-<left>'
1065      Kill the current column.  
1067 `M-S-<right>'
1068      Insert a new column to the left of the cursor position.  
1070 `M-<up>'
1071 `M-<down>'
1072      Move the current row up/down.  
1074 `M-S-<up>'
1075      Kill the current row or horizontal line.  
1077 `M-S-<down>'
1078      Insert a new row above (with arg: below) the current row.  
1080 `C-c -'
1081      Insert a horizontal line below current row. With prefix arg, the
1082      line is created above the current line.  
1084 `C-c ^'
1085      Sort the table lines in the region.  The position of point
1086      indicates the column to be used for sorting, and the range of
1087      lines is the range between the nearest horizontal separator lines,
1088      or the entire table.  If point is before the first column, you
1089      will be prompted for the sorting column.  If there is an active
1090      region, the mark specifies the first line and the sorting column,
1091      while point should be in the last line to be included into the
1092      sorting.  The command prompts for the sorting type
1093      (alphabetically, numerically, or by time).  When called with a
1094      prefix argument, alphabetic sorting will be case-sensitive.
1096 Regions
1097 .......
1099 `C-c C-x M-w'
1100      Copy a rectangular region from a table to a special clipboard.
1101      Point and mark determine edge fields of the rectangle.  The
1102      process ignores horizontal separator lines.  
1104 `C-c C-x C-w'
1105      Copy a rectangular region from a table to a special clipboard, and
1106      blank all fields in the rectangle.  So this is the "cut" operation.  
1108 `C-c C-x C-y'
1109      Paste a rectangular region into a table.  The upper right corner
1110      ends up in the current field.  All involved fields will be
1111      overwritten.  If the rectangle does not fit into the present table,
1112      the table is enlarged as needed.  The process ignores horizontal
1113      separator lines.  
1115 `C-c C-q'
1116      Wrap several fields in a column like a paragraph.  If there is an
1117      active region, and both point and mark are in the same column, the
1118      text in the column is wrapped to minimum width for the given
1119      number of lines.  A prefix ARG may be used to change the number of
1120      desired lines.  If there is no region, the current field is split
1121      at the cursor position and the text fragment to the right of the
1122      cursor is prepended to the field one line down. If there is no
1123      region, but you specify a prefix ARG, the current field is made
1124      blank, and the content is appended to the field above.
1126 Calculations
1127 ............
1129 `C-c +'
1130      Sum the numbers in the current column, or in the rectangle defined
1131      by the active region.  The result is shown in the echo area and can
1132      be inserted with `C-y'.  
1134 `S-<RET>'
1135      When current field is empty, copy from first non-empty field above.
1136      When not empty, copy current field down to next row and move cursor
1137      along with it.  Depending on the variable
1138      `org-table-copy-increment', integer field values will be
1139      incremented during copy.  This key is also used by CUA-mode (*note
1140      Cooperation::).
1142 Miscellaneous
1143 .............
1145 `C-c `'
1146      Edit the current field in a separate window.  This is useful for
1147      fields that are not fully visible (*note Narrow columns::).  When
1148      called with a `C-u' prefix, just make the full field visible, so
1149      that it can be edited in place.  
1151 `C-c <TAB>'
1152      This is an alias for `C-u C-c `' to make the current field fully
1153      visible.
1155 `M-x org-table-import'
1156      Import a file as a table.  The table should be TAB- or whitespace
1157      separated.  Useful, for example, to import an Excel table or data
1158      from a database, because these programs generally can write
1159      TAB-separated text files.  This command works by inserting the
1160      file into the buffer and then converting the region to a table.
1161      Any prefix argument is passed on to the converter, which uses it
1162      to determine the separator.
1164 `C-c |'
1165      Tables can also be imported by pasting tabular text into the
1166      org-mode buffer, selecting the pasted text with `C-x C-x' and then
1167      using the `C-c |' command (see above under Creation and conversion.
1169 `M-x org-table-export'
1170      Export the table as a TAB-separated file.  Useful for data
1171      exchange with, for example, Excel or database programs.
1173    If you don't like the automatic table editor because it gets in your
1174 way on lines which you would like to start with `|', you can turn it
1175 off with
1177      (setq org-enable-table-editor nil)
1179 Then the only table command that still works is `C-c C-c' to do a
1180 manual re-align.
1182 \x1f
1183 File: org,  Node: Narrow columns,  Next: orgtbl-mode,  Prev: Built-in table editor,  Up: Tables
1185 3.2 Narrow columns
1186 ==================
1188 The width of columns is automatically determined by the table editor.
1189 Sometimes a single field or a few fields need to carry more text,
1190 leading to inconveniently wide columns.  To limit(1) the width of a
1191 column, one field anywhere in the column may contain just the string
1192 `<N>' where `N' is an integer specifying the width of the column in
1193 characters.  The next re-align will then set the width of this column
1194 to no more than this value.
1196      |---+------------------------------|               |---+--------|
1197      |   |                              |               |   | <6>    |
1198      | 1 | one                          |               | 1 | one    |
1199      | 2 | two                          |     ----\     | 2 | two    |
1200      | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
1201      | 4 | four                         |               | 4 | four   |
1202      |---+------------------------------|               |---+--------|
1204 Fields that are wider become clipped and end in the string `=>'.  Note
1205 that the full text is still in the buffer, it is only invisible.  To
1206 see the full text, hold the mouse over the field - a tool-tip window
1207 will show the full content.  To edit such a field, use the command `C-c
1208 `' (that is `C-c' followed by the backquote).  This will open a new
1209 window with the full field.  Edit it and finish with `C-c C-c'.
1211    When visiting a file containing a table with narrowed columns, the
1212 necessary character hiding has not yet happened, and the table needs to
1213 be aligned before it looks nice.  Setting the option
1214 `org-startup-align-all-tables' will realign all tables in a file upon
1215 visiting, but also slow down startup.  You can also set this option on
1216 a per-file basis with:
1218      #+STARTUP: align
1219      #+STARTUP: noalign
1221    ---------- Footnotes ----------
1223    (1) This feature does not work on XEmacs.
1225 \x1f
1226 File: org,  Node: orgtbl-mode,  Next: The spreadsheet,  Prev: Narrow columns,  Up: Tables
1228 3.3 The Orgtbl minor mode
1229 =========================
1231 If you like the intuitive way the Org-mode table editor works, you
1232 might also want to use it in other modes like text-mode or mail-mode.
1233 The minor mode Orgtbl-mode makes this possible.  You can always toggle
1234 the mode with `M-x orgtbl-mode'.  To turn it on by default, for example
1235 in mail mode, use
1237      (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1239    Furthermore, with some special setup, it is possible to maintain
1240 tables in arbitrary syntax with Orgtbl-mode.  For example, it is
1241 possible to construct LaTeX tables with the underlying ease and power of
1242 Orgtbl-mode, including spreadsheet capabilities.  For details, see
1243 *Note Tables in arbitrary syntax::.
1245 \x1f
1246 File: org,  Node: The spreadsheet,  Prev: orgtbl-mode,  Up: Tables
1248 3.4 The spreadsheet
1249 ===================
1251 The table editor makes use of the Emacs `calc' package to implement
1252 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
1253 derive fields from other fields.  While fully featured, Org-mode's
1254 implementation is not identical to other spreadsheets.  For example,
1255 Org-mode knows the concept of a _column formula_ that will be applied
1256 to all non-header fields in a column without having to copy the formula
1257 to each relevant field.
1259 * Menu:
1261 * References::                  How to refer to another field or range
1262 * Formula syntax for Calc::     Using Calc to compute stuff
1263 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
1264 * Field formulas::              Formulas valid for a single field
1265 * Column formulas::             Formulas valid for an entire column
1266 * Editing and debugging formulas::  Fixing formulas
1267 * Updating the table::          Recomputing all dependent fields
1268 * Advanced features::           Field names, parameters and automatic recalc
1270 \x1f
1271 File: org,  Node: References,  Next: Formula syntax for Calc,  Prev: The spreadsheet,  Up: The spreadsheet
1273 3.4.1 References
1274 ----------------
1276 To compute fields in the table from other fields, formulas must
1277 reference other fields or ranges.  In Org-mode, fields can be referenced
1278 by name, by absolute coordinates, and by relative coordinates.  To find
1279 out what the coordinates of a field are, press `C-c ?' in that field,
1280 or press `C-c }' to toggle the display of a grid.
1282 Field references
1283 ................
1285 Formulas can reference the value of another field in two ways.  Like in
1286 any other spreadsheet, you may reference fields with a letter/number
1287 combination like `B3', meaning the 2nd field in the 3rd row.
1289 Org-mode also uses another, more general operator that looks like this:
1290      @row$column
1292 Column references can be absolute like `1', `2',...`N', or relative to
1293 the current column like `+1' or `-2'.
1295    The row specification only counts data lines and ignores horizontal
1296 separator lines (hlines).  You can use absolute row numbers `1'...`N',
1297 and row numbers relative to the current row like `+3' or `-1'.  Or
1298 specify the row relative to one of the hlines: `I' refers to the first
1299 hline, `II' to the second etc.  `-I' refers to the first such line
1300 above the current line, `+I' to the first such line below the current
1301 line.  You can also write `III+2' which is the second data line after
1302 the third hline in the table.  Relative row numbers like `-3' will not
1303 cross hlines if the current line is too close to the hline.  Instead,
1304 the value directly at the hline is used.
1306    `0' refers to the current row and column.  Also, if you omit either
1307 the column or the row part of the reference, the current row/column is
1308 implied.
1310    Org-mode's references with _unsigned_ numbers are fixed references
1311 in the sense that if you use the same reference in the formula for two
1312 different fields, the same field will be referenced each time.
1313 Org-mode's references with _signed_ numbers are floating references
1314 because the same reference operator can reference different fields
1315 depending on the field being calculated by the formula.
1317    Here are a few examples:
1319      @2$3      2nd row, 3rd column
1320      C2        same as previous
1321      $5        column 5 in the current row
1322      E&        same as previous
1323      @2        current column, row 2
1324      @-1$-3    the field one row up, three columns to the left
1325      @-I$2     field just under hline above current row, column 2
1327 Range references
1328 ................
1330 You may reference a rectangular range of fields by specifying two field
1331 references connected by two dots `..'.  If both fields are in the
1332 current row, you may simply use `$2..$7', but if at least one field is
1333 in a different row, you need to use the general `@row$column' format at
1334 least for the first field (i.e the reference must start with `@' in
1335 order to be interpreted correctly).  Examples:
1337      $1..$3        First three fields in the current row.
1338      $P..$Q        Range, using column names (see under Advanced)
1339      @2$1..@4$3    6 fields between these two fields.
1340      A2..C4        Same as above.
1341      @-1$-2..@-1   3 numbers from the column to the left, 2 up to current row
1343 Range references return a vector of values that can be fed into Calc
1344 vector functions.  Empty fields in ranges are normally suppressed, so
1345 that the vector contains only the non-empty fields (but see the `E'
1346 mode switch below).  If there are no non-empty fields, `[0]' is
1347 returned to avoid syntax errors in formulas.
1349 Named references
1350 ................
1352 `$name' is interpreted as the name of a column, parameter or constant.
1353 Constants are defined globally through the variable
1354 `org-table-formula-constants'.  If you have the `constants.el' package,
1355 it will also be used to resolve constants, including natural constants
1356 like `$h' for Planck's constant, and units like `$km' for
1357 kilometers(1).  Column names and parameters can be specified in special
1358 table lines.  These are described below, see *Note Advanced features::.
1359 All names must start with a letter, and further consist of letters and
1360 numbers.
1362    ---------- Footnotes ----------
1364    (1) `Constant.el' can supply the values of constants in two
1365 different unit systems, `SI' and `cgs'.  Which one is used depends on
1366 the value of the variable `constants-unit-system'.  You can use the
1367 `#+STARTUP' options `constSI' and `constcgs' to set this value for the
1368 current buffer.
1370 \x1f
1371 File: org,  Node: Formula syntax for Calc,  Next: Formula syntax for Lisp,  Prev: References,  Up: The spreadsheet
1373 3.4.2 Formula syntax for Calc
1374 -----------------------------
1376 A formula can be any algebraic expression understood by the Emacs
1377 `Calc' package.  Note that `calc' has the non-standard convention that
1378 `/' has lower precedence than `*', so that `a/b*c' is interpreted as
1379 `a/(b*c)'.  Before evaluation by `calc-eval' (*note calc-eval:
1380 (calc)Calling Calc from Your Programs.), variable substitution takes
1381 place according to the rules described above.  The range vectors can be
1382 directly fed into the calc vector functions like `vmean' and `vsum'.
1384    A formula can contain an optional mode string after a semicolon.
1385 This string consists of flags to influence Calc and other modes during
1386 execution.  By default, Org-mode uses the standard calc modes (precision
1387 12, angular units degrees, fraction and symbolic modes off.  The display
1388 format, however, has been changed to `(float 5)' to keep tables
1389 compact.  The default settings can be configured using the variable
1390 `org-calc-default-modes'.
1392      p20           switch the internal precision to 20 digits
1393      n3 s3 e2 f4   normal, scientific, engineering, or fixed display format
1394      D R           angle modes: degrees, radians
1395      F S           fraction and symbolic modes
1396      N             interpret all fields as numbers, use 0 for non-numbers
1397      T             force text interpretation
1398      E             keep empty fields in ranges
1400 In addition, you may provide a `printf' format specifier to reformat
1401 the final result.  A few examples:
1403      $1+$2                Sum of first and second field
1404      $1+$2;%.2f           Same, format result to two decimals
1405      exp($2)+exp($1)      Math functions can be used
1406      $0;%.1f              Reformat current cell to 1 decimal
1407      ($3-32)*5/9          Degrees F -> C conversion
1408      $c/$1/$cm            Hz -> cm conversion, using `constants.el'
1409      tan($1);Dp3s1        Compute in degrees, precision 3, display SCI 1
1410      sin($1);Dp3%.1e      Same, but use printf specifier for display
1411      vmean($2..$7)        Compute column range mean, using vector function
1412      vmean($2..$7);EN     Same, but treat empty fields as 0
1413      taylor($3,x=7,2)     taylor series of $3, at x=7, second degree
1415    Calc also contains a complete set of logical operations.  For example
1417      if($1<20,teen,string(""))  "teen" if age $1 less than 20, else empty
1419 \x1f
1420 File: org,  Node: Formula syntax for Lisp,  Next: Field formulas,  Prev: Formula syntax for Calc,  Up: The spreadsheet
1422 3.4.3 Emacs Lisp forms as formulas
1423 ----------------------------------
1425 It is also possible to write a formula in Emacs Lisp; this can be useful
1426 for string manipulation and control structures, if the Calc's
1427 functionality is not enough.  If a formula starts with a single quote
1428 followed by an opening parenthesis, then it is evaluated as a lisp form.
1429 The evaluation should return either a string or a number.  Just as with
1430 `calc' formulas, you can specify modes and a printf format after a
1431 semicolon.  A reference will be replaced with a string (in double
1432 quotes) containing the field.  If you provide the `N' mode switch, all
1433 referenced elements will be numbers.  Ranges are inserted as
1434 space-separated fields, so you can embed them in list or vector syntax.
1435 A few examples, note how the `N' mode is used when we do computations
1436 in lisp.
1438      Swap the first two characters of the content of column 1
1439        '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1440      Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1441        '(+ $1 $2);N
1442      Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1443        '(apply '+ '($1..$4));N
1445 \x1f
1446 File: org,  Node: Field formulas,  Next: Column formulas,  Prev: Formula syntax for Lisp,  Up: The spreadsheet
1448 3.4.4 Field formulas
1449 --------------------
1451 To assign a formula to a particular field, type it directly into the
1452 field, preceded by `:=', for example `:=$1+$2'.  When you press <TAB>
1453 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1454 will be stored as the formula for this field, evaluated, and the
1455 current field replaced with the result.
1457    Formulas are stored in a special line starting with `#+TBLFM:'
1458 directly below the table.  If you typed the equation in the 4th field of
1459 the 3rd data line in the table, the formula will look like
1460 `@3$4=$1+$2'.  When inserting/deleting/swapping column and rows with
1461 the appropriate commands, absolute references (but not relative ones)
1462 in stored formulas are modified in order to still reference the same
1463 field.  Of cause this is not true if you edit the table structure with
1464 normal editing commands - then you must fix the equations yourself.
1466    Instead of typing an equation into the field, you may also use the
1467 following command
1469 `C-u C-c ='
1470      Install a new formula for the current field.  The command prompts
1471      for a formula, with default taken from the `#+TBLFM:' line, applies
1472      it to the current field and stores it.
1474 \x1f
1475 File: org,  Node: Column formulas,  Next: Editing and debugging formulas,  Prev: Field formulas,  Up: The spreadsheet
1477 3.4.5 Column formulas
1478 ---------------------
1480 Often in a table, the same formula should be used for all fields in a
1481 particular column.  Instead of having to copy the formula to all fields
1482 in that column, org-mode allows to assign a single formula to an entire
1483 column.  If the table contains horizontal separator hlines, everything
1484 before the first such line is considered part of the table _header_ and
1485 will not be modified by column formulas.
1487    To assign a formula to a column, type it directly into any field in
1488 the column, preceded by an equal sign, like `=$1+$2'.  When you press
1489 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1490 formula will be stored as the formula for the current column, evaluated
1491 and the current field replaced with the result.  If the field contains
1492 only `=', the previously stored formula for this column is used.  For
1493 each column, Org-mode will only remember the most recently used
1494 formula.  In the `TBLFM:' line, column formulas will look like
1495 `$4=$1+$2'.
1497    Instead of typing an equation into the field, you may also use the
1498 following command:
1500 `C-c ='
1501      Install a new formula for the current column and replace current
1502      field with the result of the formula.  The command prompts for a
1503      formula, with default taken from the `#+TBLFM' line, applies it to
1504      the current field and stores it.  With a numerical prefix (e.g.
1505      `C-5 C-c =') will apply it to that many consecutive fields in the
1506      current column.
1508 \x1f
1509 File: org,  Node: Editing and debugging formulas,  Next: Updating the table,  Prev: Column formulas,  Up: The spreadsheet
1511 3.4.6 Editing and Debugging formulas
1512 ------------------------------------
1514 You can edit individual formulas in the minibuffer or directly in the
1515 field.  Org-mode can also prepare a special buffer with all active
1516 formulas of a table.  When offering a formula for editing, Org-mode
1517 converts references to the standard format (like `B3' or `D&') if
1518 possible.  If you prefer to only work with the internal format (like
1519 `@3$2' or `$4'), configure the variable
1520 `org-table-use-standard-references'.
1522 `C-c ='
1523 `C-u C-c ='
1524      Edit the formula associated with the current column/field in the
1525      minibuffer.  See *Note Column formulas:: and *Note Field
1526      formulas::.  
1528 `C-u C-u C-c ='
1529      Re-insert the active formula (either a field formula, or a column
1530      formula) into the current field, so that you can edit it directly
1531      in the field.  The advantage over editing in the minibuffer is
1532      that you can use the command `C-c ?'.  
1534 `C-c ?'
1535      While editing a formula in a table field, highlight the field(s)
1536      referenced by the reference at the cursor position in the formula.  
1538 `C-c }'
1539      Toggle the display of row and column numbers for a table, using
1540      overlays.  These are updated each time the table is aligned, you
1541      can force it with `C-c C-c'.  
1543 `C-c {'
1544      Toggle the formula debugger on and off.  See below.  
1546 `C-c ''
1547      Edit all formulas for the current table in a special buffer, where
1548      the formulas will be displayed one per line.  If the current field
1549      has an active formula, the cursor in the formula editor will mark
1550      it.  While inside the special buffer, Org-mode will automatically
1551      highlight any field or range reference at the cursor position.
1552      You may edit, remove and add formulas, and use the following
1553      commands:
1554     `C-c C-c'
1555     `C-x C-s'
1556           Exit the formula editor and store the modified formulas.
1557           With `C-u' prefix, also apply the new formulas to the entire
1558           table.  
1560     `C-c C-q'
1561           Exit the formula editor without installing changes.  
1563     `C-c C-r'
1564           Toggle all references in the formula editor between standard
1565           (like `B3') and internal (like `@3$2').  
1567     `<TAB>'
1568           Pretty-print or indent lisp formula at point.  When in a line
1569           containing a lisp formula, format the formula according to
1570           Emacs Lisp rules.  Another <TAB> collapses the formula back
1571           again.  In the open formula, <TAB> re-indents just like in
1572           Emacs-lisp-mode.  
1574     `M-<TAB>'
1575           Complete Lisp symbols, just like in Emacs-lisp-mode.  
1577     `S-<up>/<down>/<left>/<right>'
1578           Shift the reference at point.  For example, if the reference
1579           is `B3' and you press `S-<right>', it will become `C3'.  This
1580           also works for relative references, and for hline references.  
1582     `M-S-<up>/<down>'
1583           Move the test line for column formulas in the Org-mode buffer
1584           up and down.  
1586     `M-<up>/<down>'
1587           Scroll the window displaying the table.  
1589     `C-c }'
1590           Turn the coordinate grid in the table on and off.
1592    Making a table field blank does not remove the formula associated
1593 with the field, because that is stored in a different line (the `TBLFM'
1594 line) - during the next recalculation the field will be filled again.
1595 To remove a formula from a field, you have to give an empty reply when
1596 prompted for the formula, or to edit the `#+TBLFM' line.
1598    You may edit the `#+TBLFM' directly and re-apply the changed
1599 equations with `C-c C-c' in that line, or with the normal recalculation
1600 commands in the table.
1602 Debugging formulas
1603 ..................
1605 When the evaluation of a formula leads to an error, the field content
1606 becomes the string `#ERROR'.  If you would like see what is going on
1607 during variable substitution and calculation in order to find a bug,
1608 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1609 for example by pressing `C-u C-u C-c = <RET>' in a field.  Detailed
1610 information will be displayed.
1612 \x1f
1613 File: org,  Node: Updating the table,  Next: Advanced features,  Prev: Editing and debugging formulas,  Up: The spreadsheet
1615 3.4.7 Updating the Table
1616 ------------------------
1618 Recalculation of a table is normally not automatic, but needs to be
1619 triggered by a command.  See *Note Advanced features:: for a way to make
1620 recalculation at least semi-automatically.
1622    In order to recalculate a line of a table or the entire table, use
1623 the following commands:
1625 `C-c *'
1626      Recalculate the current row by first applying the stored column
1627      formulas from left to right, and all field formulas in the current
1628      row.  
1630 `C-u C-c *'
1631 `C-u C-c C-c'
1632      Recompute the entire table, line by line.  Any lines before the
1633      first hline are left alone, assuming that these are part of the
1634      table header.  
1636 `C-u C-u C-c *'
1637      Iterate the table by recomputing it until no further changes occur.
1638      This may be necessary if some computed fields use the value of
1639      other fields that are computed later in the calculation sequence.
1641 \x1f
1642 File: org,  Node: Advanced features,  Prev: Updating the table,  Up: The spreadsheet
1644 3.4.8 Advanced features
1645 -----------------------
1647 If you want the recalculation of fields to happen automatically, or if
1648 you want to be able to assign names to fields and columns, you need to
1649 reserve the first column of the table for special marking characters.
1650 `C-#'
1651      Rotate the calculation mark in first column through the states `',
1652      `#', `*', `!', `$'.  The meaning of these characters is discussed
1653      below.  When there is an active region, change all marks in the
1654      region.
1656    Here is an example of a table that collects exam results of students
1657 and makes use of these features:
1659      |---+---------+--------+--------+--------+-------+------|
1660      |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1661      |---+---------+--------+--------+--------+-------+------|
1662      | ! |         |     P1 |     P2 |     P3 |   Tot |      |
1663      | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
1664      | ^ |         |     m1 |     m2 |     m3 |    mt |      |
1665      |---+---------+--------+--------+--------+-------+------|
1666      | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
1667      | # | Sara    |      6 |     14 |     19 |    39 |  7.8 |
1668      | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
1669      |---+---------+--------+--------+--------+-------+------|
1670      |   | Average |        |        |        |  29.7 |      |
1671      | ^ |         |        |        |        |    at |      |
1672      | $ | max=50  |        |        |        |       |      |
1673      |---+---------+--------+--------+--------+-------+------|
1674      #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1676 Important: Please note that for these special tables, recalculating the
1677 table with `C-u C-c *' will only affect rows that are marked `#' or
1678 `*', and fields that have a formula assigned to the field itself.  The
1679 column formulas are not applied in rows with empty first field.
1681    The marking characters have the following meaning:
1683      The fields in this line define names for the columns, so that you
1684      may refer to a column as `$Tot' instead of `$6'.
1687      This row defines names for the fields _above_ the row.  With such
1688      a definition, any formula in the table may use `$m1' to refer to
1689      the value `10'.  Also, if you assign a formula to a names field, it
1690      will be stored as `$name=...'.
1693      Similar to `^', but defines names for the fields in the row
1694      _below_.
1697      Fields in this row can define _parameters_ for formulas.  For
1698      example, if a field in a `$' row contains `max=50', then formulas
1699      in this table can refer to the value 50 using `$max'.  Parameters
1700      work exactly like constants, only that they can be defined on a
1701      per-table basis.
1704      Fields in this row are automatically recalculated when pressing
1705      <TAB> or <RET> or `S-<TAB>' in this row.  Also, this row is
1706      selected for a global recalculation with `C-u C-c *'.  Unmarked
1707      lines will be left alone by this command.
1710      Selects this line for global recalculation with `C-u C-c *', but
1711      not for automatic recalculation.  Use this when automatic
1712      recalculation slows down editing too much.
1715      Unmarked lines are exempt from recalculation with `C-u C-c *'.
1716      All lines that should be recalculated should be marked with `#' or
1717      `*'.
1720      Do not export this line.  Useful for lines that contain the
1721      narrowing `<N>' markers.
1723    Finally, just to whet your appetite on what can be done with the
1724 fantastic `calc' package, here is a table that computes the Taylor
1725 series of degree `n' at location `x' for a couple of functions
1726 (homework: try that with Excel :-)
1728      |---+-------------+---+-----+--------------------------------------|
1729      |   | Func        | n | x   | Result                               |
1730      |---+-------------+---+-----+--------------------------------------|
1731      | # | exp(x)      | 1 | x   | 1 + x                                |
1732      | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
1733      | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
1734      | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1735      | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
1736      | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
1737      |---+-------------+---+-----+--------------------------------------|
1738      #+TBLFM: $5=taylor($2,$4,$3);n3
1740 \x1f
1741 File: org,  Node: Hyperlinks,  Next: TODO items,  Prev: Tables,  Up: Top
1743 4 Hyperlinks
1744 ************
1746 Just like HTML, Org-mode provides links inside a file, and external
1747 links to other files, Usenet articles, emails, and much more.
1749 * Menu:
1751 * Link format::                 How links in Org-mode are formatted
1752 * Internal links::              Links to other places in the current file
1753 * External links::              URL-like links to the world
1754 * Handling links::              Creating, inserting and following
1755 * Link abbreviations::          Shortcuts for writing complex links
1756 * Search options::              Linking to a specific location
1757 * Custom searches::             When the default search is not enough
1758 * Remember::                    Org-trees store quick notes
1760 \x1f
1761 File: org,  Node: Link format,  Next: Internal links,  Prev: Hyperlinks,  Up: Hyperlinks
1763 4.1 Link format
1764 ===============
1766 Org-mode will recognize plain URL-like links and activate them as
1767 clickable links.  The general link format, however, looks like this:
1769      [[link][description]]       or alternatively           [[link]]
1771    Once a link in the buffer is complete (all brackets present),
1772 Org-mode will change the display so that `description' is displayed
1773 instead of `[[link][description]]' and `link' is displayed instead of
1774 `[[link]]'.  Links will be highlighted in the face `org-link', which by
1775 default is an underlined face.  You can directly edit the visible part
1776 of a link.  Note that this can be either the `link' part (if there is
1777 no description) or the `description' part.  To edit also the invisible
1778 `link' part, use `C-c C-l' with the cursor on the link.
1780    If you place the cursor at the beginning or just behind the end of
1781 the displayed text and press <BACKSPACE>, you will remove the
1782 (invisible) bracket at that location.  This makes the link incomplete
1783 and the internals are again displayed as plain text.  Inserting the
1784 missing bracket hides the link internals again.  To show the internal
1785 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1786 links'.
1788 \x1f
1789 File: org,  Node: Internal links,  Next: External links,  Prev: Link format,  Up: Hyperlinks
1791 4.2 Internal links
1792 ==================
1794 If the link does not look like a URL, it is considered to be internal in
1795 the current file.  Links such as `[[My Target]]' or `[[My Target][Find
1796 my target]]' lead to a text search in the current file.  The link can
1797 be followed with `C-c C-o' when the cursor is on the link, or with a
1798 mouse click (*note Handling links::).  The preferred match for such a
1799 link is a dedicated target: the same string in double angular brackets.
1800 Targets may be located anywhere; sometimes it is convenient to put
1801 them into a comment line. For example
1803      # <<My Target>>
1805 In HTML export (*note HTML export::), such targets will become named
1806 anchors for direct access through `http' links(1).
1808    If no dedicated target exists, Org-mode will search for the words in
1809 the link.  In the above example the search would be for `my target'.
1810 Links starting with a star like `*My Target' restrict the search to
1811 headlines.  When searching, Org-mode will first try an exact match, but
1812 then move on to more and more lenient searches.  For example, the link
1813 `[[*My Targets]]' will find any of the following:
1815      ** My targets
1816      ** TODO my targets are bright
1817      ** my 20 targets are
1819    To insert a link targeting a headline, in-buffer completion can be
1820 used.  Just type a star followed by a few optional letters into the
1821 buffer and press `M-<TAB>'.  All headlines in the current buffer will be
1822 offered as completions.  *Note Handling links::, for more commands
1823 creating links.
1825    Following a link pushes a mark onto Org-mode's own mark ring.  You
1826 can return to the previous position with `C-c &'.  Using this command
1827 several times in direct succession goes back to positions recorded
1828 earlier.
1830 * Menu:
1832 * Radio targets::               Make targets trigger links in plain text.
1834    ---------- Footnotes ----------
1836    (1) Note that text before the first headline will never be exported,
1837 so the first such target must be after the first headline.
1839 \x1f
1840 File: org,  Node: Radio targets,  Prev: Internal links,  Up: Internal links
1842 4.2.1 Radio targets
1843 -------------------
1845 You can configure Org-mode to link any occurrences of certain target
1846 names in normal text.  So without explicitly creating a link, the text
1847 connects to the target radioing its position.  Radio targets are
1848 enclosed by triple angular brackets.  For example, a target `<<<My
1849 Target>>>' causes each occurrence of `my target' in normal text to
1850 become activated as a link.  The Org-mode file is scanned automatically
1851 for radio targets only when the file is first loaded into Emacs.  To
1852 update the target list during editing, press `C-c C-c' with the cursor
1853 on or at a target.
1855 \x1f
1856 File: org,  Node: External links,  Next: Handling links,  Prev: Internal links,  Up: Hyperlinks
1858 4.3 External links
1859 ==================
1861 Org-mode supports links to files, websites, Usenet and email messages,
1862 and BBDB database entries.  External links are URL-like locators.  They
1863 start with a short identifying string followed by a colon.  There can be
1864 no space after the colon.  The following list shows examples for each
1865 link type.
1867      http://www.astro.uva.nl/~dominik          on the web
1868      file:/home/dominik/images/jupiter.jpg     file, absolute path
1869      file:papers/last.pdf                      file, relative path
1870      news:comp.emacs                           Usenet link
1871      mailto:adent@galaxy.net                   Mail link
1872      vm:folder                                 VM folder link
1873      vm:folder#id                              VM message link
1874      vm://myself@some.where.org/folder#id      VM on remote machine
1875      wl:folder                                 WANDERLUST folder link
1876      wl:folder#id                              WANDERLUST message link
1877      mhe:folder                                MH-E folder link
1878      mhe:folder#id                             MH-E message link
1879      rmail:folder                              RMAIL folder link
1880      rmail:folder#id                           RMAIL message link
1881      gnus:group                                GNUS group link
1882      gnus:group#id                             GNUS article link
1883      bbdb:Richard Stallman                     BBDB link
1884      shell:ls *.org                            A shell command
1885      elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1887    A link should be enclosed in double brackets and may contain a
1888 descriptive text to be displayed instead of the url (*note Link
1889 format::), for example:
1891      [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1893 If the description is a file name or URL that points to an image, HTML
1894 export (*note HTML export::) will inline the image as a clickable
1895 button.  If there is no description at all and the link points to an
1896 image, that image will be inlined into the exported HTML file.
1898    Org-mode also finds external links in the normal text and activates
1899 them as links.  If spaces must be part of the link (for example in
1900 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1901 the end of the link, enclose them in angular brackets.
1903 \x1f
1904 File: org,  Node: Handling links,  Next: Link abbreviations,  Prev: External links,  Up: Hyperlinks
1906 4.4 Handling links
1907 ==================
1909 Org-mode provides methods to create a link in the correct syntax, to
1910 insert it into an org-mode file, and to follow the link.
1912 `C-c l'
1913      Store a link to the current location.  This is a _global_ command
1914      which can be used in any buffer to create a link.  The link will be
1915      stored for later insertion into an Org-mode buffer (see below).
1916      For Org-mode files, if there is a `<<target>>' at the cursor, the
1917      link points to the target.  Otherwise it points to the current
1918      headline.  For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1919      the link will indicate the current article/entry.  For W3 and W3M
1920      buffers, the link goes to the current URL.  For any other files,
1921      the link will point to the file, with a search string (*note
1922      Search options::) pointing to the contents of the current line.
1923      If there is an active region, the selected words will form the
1924      basis of the search string.  If the automatically created link is
1925      not working correctly or accurately enough, you can write custom
1926      functions to select the search string and to do the search for
1927      particular file types - see *Note Custom searches::.  The key
1928      binding `C-c l' is only a suggestion - see *Note Installation::.  
1930 `C-c C-l'
1931      Insert a link.  This prompts for a link to be inserted into the
1932      buffer.  You can just type a link, using text for an internal
1933      link, or one of the link type prefixes mentioned in the examples
1934      above.  All links stored during the current session are part of
1935      the history for this prompt, so you can access them with <up> and
1936      <down>.  Completion, on the other hand, will help you to insert
1937      valid link prefixes like `http:' or `ftp:', including the prefixes
1938      defined through link abbreviations (*note Link abbreviations::).
1939      The link will be inserted into the buffer(1), along with a
1940      descriptive text.  If some text was selected when this command is
1941      called, the selected text becomes the default description.
1942      Note that you don't have to use this command to insert a link.
1943      Links in Org-mode are plain text, and you can type or paste them
1944      straight into the buffer.  By using this command, the links are
1945      automatically enclosed in double brackets, and you will be asked
1946      for the optional descriptive text.  
1948 `C-u C-c C-l'
1949      When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1950      file will be inserted and you may use file name completion to
1951      select the name of the file.  The path to the file is inserted
1952      relative to the directory of the current org file, if the linked
1953      file is in the current directory or in a subdirectory of it, or if
1954      the path is written relative to the current directory using `../'.
1955      Otherwise an absolute path is used, if possible with `~/' for
1956      your home directory.  You can force an absolute path with two
1957      `C-u' prefixes.
1959 `C-c C-l (with cursor on existing link)'
1960      When the cursor is on an existing link, `C-c C-l' allows you to
1961      edit the link and description parts of the link.  
1963 `C-c C-o'
1964      Open link at point.  This will launch a web browser for URLs (using
1965      `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1966      the corresponding links, and execute the command in a shell link.
1967      When the cursor is on an internal link, this commands runs the
1968      corresponding search.  When the cursor is on a TAG list in a
1969      headline, it creates the corresponding TAGS view.  If the cursor
1970      is on a time stamp, it compiles the agenda for that date.
1971      Furthermore, it will visit text and remote files in `file:' links
1972      with Emacs and select a suitable application for local non-text
1973      files.  Classification of files is based on file extension only.
1974      See option `org-file-apps'.  If you want to override the default
1975      application and visit the file with Emacs, use a `C-u' prefix.  
1977 `mouse-2'
1978 `mouse-1'
1979      On links, `mouse-2' will open the link just as `C-c C-o' would.
1980      Under Emacs 22, also `mouse-1' will follow a link.  
1982 `mouse-3'
1983      Like `mouse-2', but force file links to be opened with Emacs, and
1984      internal links to be displayed in another window(2).  
1986 `C-c %'
1987      Push the current position onto the mark ring, to be able to return
1988      easily. Commands following an internal link do this automatically.  
1990 `C-c &'
1991      Jump back to a recorded position.  A position is recorded by the
1992      commands following internal links, and by `C-c %'.  Using this
1993      command several times in direct succession moves through a ring of
1994      previously recorded positions.  
1996 `C-c C-x C-n'
1997 `C-c C-x C-p'
1998      Move forward/backward to the next link in the buffer.  At the
1999      limit of the buffer, the search fails once, and then wraps around.
2000      The key bindings for this are really too long, you might want to
2001      bind this also to `C-n' and `C-p'
2002           (add-hook 'org-load-hook
2003             (lambda ()
2004               (define-key 'org-mode-map "\C-n" 'org-next-link)
2005               (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2007    ---------- Footnotes ----------
2009    (1) After insertion of a stored link, the link will be removed from
2010 the list of stored links.  To keep it in the list later use, use a
2011 triple `C-u' prefix to `C-c C-l', or configure the option
2012 `org-keep-stored-link-after-insertion'.
2014    (2) See the variable `org-display-internal-link-with-indirect-buffer'
2016 \x1f
2017 File: org,  Node: Link abbreviations,  Next: Search options,  Prev: Handling links,  Up: Hyperlinks
2019 4.5 Link abbreviations
2020 ======================
2022 Long URLs can be cumbersome to type, and often many similar links are
2023 needed in a document.  For this you can use link abbreviations.  An
2024 abbreviated link looks like this
2026      [[linkword:tag][description]]
2028 where the tag is optional.  Such abbreviations are resolved according to
2029 the information in the variable `org-link-abbrev-alist' that relates
2030 the linkwords to replacement text.  Here is an example:
2032      (setq org-link-abbrev-alist
2033        '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2034          ("google"   . "http://www.google.com/search?q=")
2035          ("ads"      . "http://adsabs.harvard.edu/cgi-bin/
2036                         nph-abs_connect?author=%s&db_key=AST")))
2038    If the replacement text contains the string `%s', it will be
2039 replaced with the tag.  Otherwise the tag will be appended to the string
2040 in order to create the link.  You may also specify a function that will
2041 be called with the tag as the only argument to create the link.
2043    With the above setting, you could link to a specific bug with
2044 `[[bugzilla:129]]', search the web for `OrgMode' with
2045 `[[google:OrgMode]]' and find out what the Org-mode author is doing
2046 besides Emacs hacking with `[[ads:Dominik,C]]'.
2048    If you need special abbreviations just for a single Org-mode buffer,
2049 you can define them in the file with
2051      #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
2052      #+LINK: google    http://www.google.com/search?q=%s
2054 In-buffer completion *note Completion:: can be used after `[' to
2055 complete link abbreviations.
2057 \x1f
2058 File: org,  Node: Search options,  Next: Custom searches,  Prev: Link abbreviations,  Up: Hyperlinks
2060 4.6 Search options in file links
2061 ================================
2063 File links can contain additional information to make Emacs jump to a
2064 particular location in the file when following a link.  This can be a
2065 line number or a search option after a double(1) colon. For example,
2066 when the command `C-c l' creates a link (*note Handling links::) to a
2067 file, it encodes the words in the current line as a search string that
2068 can be used to find this line back later when following the link with
2069 `C-c C-o'.
2071    Here is the syntax of the different ways to attach a search to a file
2072 link, together with an explanation:
2074      [[file:~/code/main.c::255]]
2075      [[file:~/xx.org::My Target]]
2076      [[file:~/xx.org::*My Target]]
2077      [[file:~/xx.org::/regexp/]]
2079 `255'
2080      Jump to line 255.
2082 `My Target'
2083      Search for a link target `<<My Target>>', or do a text search for
2084      `my target', similar to the search in internal links, see *Note
2085      Internal links::.  In HTML export (*note HTML export::), such a
2086      file link will become an HTML reference to the corresponding named
2087      anchor in the linked file.
2089 `*My Target'
2090      In an Org-mode file, restrict search to headlines.
2092 `/regexp/'
2093      Do a regular expression search for `regexp'.  This uses the Emacs
2094      command `occur' to list all matches in a separate window.  If the
2095      target file is in Org-mode, `org-occur' is used to create a sparse
2096      tree with the matches.
2098    As a degenerate case, a file link with an empty file name can be used
2099 to search the current file.  For example, `[[file:::find me]]' does a
2100 search for `find me' in the current file, just as `[[find me]]' would.
2102    ---------- Footnotes ----------
2104    (1) For backward compatibility, line numbers can also follow a
2105 single colon.
2107 \x1f
2108 File: org,  Node: Custom searches,  Next: Remember,  Prev: Search options,  Up: Hyperlinks
2110 4.7 Custom Searches
2111 ===================
2113 The default mechanism for creating search strings and for doing the
2114 actual search related to a file link may not work correctly in all
2115 cases.  For example, BibTeX database files have many entries like
2116 `year="1993"' which would not result in good search strings, because
2117 the only unique identification for a BibTeX entry is the citation key.
2119    If you come across such a problem, you can write custom functions to
2120 set the right search string for a particular file type, and to do the
2121 search for the string in the file.  Using `add-hook', these functions
2122 need to be added to the hook variables
2123 `org-create-file-search-functions' and
2124 `org-execute-file-search-functions'.  See the docstring for these
2125 variables for more information.  Org-mode actually uses this mechanism
2126 for BibTeX database files, and you can use the corresponding code as an
2127 implementation example.  Search for `BibTeX links' in the source file.
2129 \x1f
2130 File: org,  Node: Remember,  Prev: Custom searches,  Up: Hyperlinks
2132 4.8 Remember
2133 ============
2135 Another way to create org entries with links to other files is through
2136 the remember package by John Wiegley.  Remember lets you store quick
2137 notes with little interruption of your work flow.  See
2138 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2139 information.  The notes produced by Remember can be stored in different
2140 ways, and Org-mode files are a good target.  Org-mode significantly
2141 expands the possibilities of remember: You may define templates for
2142 different note types, and to associate target files and headlines with
2143 specific templates.  It also allows you to select the location where a
2144 note should be stored interactively, on the fly.
2146 * Menu:
2148 * Setting up remember::         Some code for .emacs to get things going
2149 * Remember templates::          Define the outline of different note types
2150 * Storing notes::               Directly get the note to where it belongs
2152 \x1f
2153 File: org,  Node: Setting up remember,  Next: Remember templates,  Prev: Remember,  Up: Remember
2155 4.8.1 Setting up remember
2156 -------------------------
2158 The following customization will tell remember to use org files as
2159 target, and to create annotations compatible with Org-mode links.
2161      (setq org-directory "~/path/to/my/orgfiles/")
2162      (setq org-default-notes-file "~/.notes")
2163      (setq remember-annotation-functions '(org-remember-annotation))
2164      (setq remember-handler-functions '(org-remember-handler))
2165      (add-hook 'remember-mode-hook 'org-remember-apply-template)
2167 \x1f
2168 File: org,  Node: Remember templates,  Next: Storing notes,  Prev: Setting up remember,  Up: Remember
2170 4.8.2 Remember templates
2171 ------------------------
2173 In combination with Org-mode, you can use templates to generate
2174 different types of remember notes.  For example, if you would like to
2175 use one template to create general TODO entries, another one for
2176 journal entries, and a third one for collecting random ideas, you could
2177 use:
2179      (setq org-remember-templates
2180       '((?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org")
2181         (?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")
2182         (?i "* %^{Title}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
2184 In these entries, the character specifies how to select the template.
2185 The first string specifies the template.  Two more (optional) strings
2186 give the file in which, and the headline under which the new note
2187 should be stored.  The file defaults (if not present or `nil') to
2188 `org-default-notes-file', the heading to
2189 `org-remember-default-headline'.  Both defaults help to get to the
2190 storing location quickly, but you can change the location interactively
2191 while storing the note.
2193    When you call `M-x remember' (or `M-x org-remember') to remember
2194 something, org will prompt for a key to select the template (if you have
2195 more than one template) and then prepare the buffer like
2196      * TODO
2197        [[file:link to where you called remember]]
2201      * [2006-03-21 Tue 15:37]
2203        [[file:link to where you called remember]]
2205 During expansion of the template, special `%'-escapes allow dynamic
2206 insertion of content:
2207      %^{prompt}  prompt the user for a string and replace this sequence with it.
2208      %t          time stamp, date only
2209      %T          time stamp with date and time
2210      %u, %U      like the above, but inactive time stamps
2211      %^t         like `%t', but prompt for date.  Similarly `%^T', `%^u', `%^U'
2212                  You may define a prompt like `%^{Birthday}t'
2213      %n          user name (taken from `user-full-name')
2214      %a          annotation, normally the link created with `org-store-link'
2215      %i          initial content, the region when remember is called with C-u.
2216                  The entire text will be indented like `%i' itself.
2217      %:keyword   specific information for certain link types, see below
2219 For specific link types, the following keywords will be defined:
2221      Link type          |  Available keywords
2222      -------------------+----------------------------------------------
2223      bbdb               |  %:name %:company
2224      vm, wl, mh, rmail  |  %:type %:subject %:message-id
2225                         |  %:from %:fromname %:fromaddress
2226                         |  %:to   %:toname   %:toaddress
2227                         |  %:fromto (either "to NAME" or "from NAME")(1)
2228      gnus               |  %:group, for messages also all email fields
2229      w3, w3m            |  %:url
2230      info               |  %:file %:node
2231      calendar           |  %:date"
2233 To place the cursor after template expansion use:
2235      %?          After completing the template, position cursor here.
2237 If you change you mind about which template to use, call `org-remember'
2238 in the remember buffer.  You may then select a new template that will
2239 be filled with the previous context information.
2241    ---------- Footnotes ----------
2243    (1) This will always be the other, not the user.  See the variable
2244 `org-from-is-user-regexp'.
2246 \x1f
2247 File: org,  Node: Storing notes,  Prev: Remember templates,  Up: Remember
2249 4.8.3 Storing notes
2250 -------------------
2252 When you are finished preparing a note with remember, you have to press
2253 `C-c C-c' to file the note away.  The handler first prompts for a
2254 target file - if you press <RET>, the value specified for the template
2255 is used.  Then the command offers the headings tree of the selected
2256 file, with the cursor position at the default headline (if you had
2257 specified one in the template).  You can either immediately press <RET>
2258 to get the note placed there.  Or you can use the following keys to
2259 find a better location:
2260      <TAB>         Cycle visibility.
2261      <down> / <up>   Next/previous visible headline.
2262      n / p        Next/previous visible headline.
2263      f / b        Next/previous headline same level.
2264      u            One level up.
2265    Pressing <RET> or <left> or <right> then leads to the following
2266 result.
2268 Cursor         Key         Note gets inserted
2269 position                   
2270 buffer-start   <RET>       as level 2 heading at end of file
2271 on headline    <RET>       as sublevel of the heading at cursor
2272                <left>/<right>as same level, before/after current heading
2273 not on         <RET>       at cursor position, level taken from context.
2274 headline                   
2276    So a fast way to store the note to its default location is to press
2277 `C-c C-c <RET> <RET>'.  Even shorter would be `C-u C-c C-c', which does
2278 the same without even asking for a file or showing the tree.
2280    Before inserting the text into a tree, the function ensures that the
2281 text has a headline, i.e. a first line that starts with a `*'.  If not,
2282 a headline is constructed from the current date and some additional
2283 data.  If the variable `org-adapt-indentation' is non-nil, the entire
2284 text is also indented so that it starts in the same column as the
2285 headline (after the asterisks).
2287 \x1f
2288 File: org,  Node: TODO items,  Next: Timestamps,  Prev: Hyperlinks,  Up: Top
2290 5 TODO items
2291 ************
2293 Org-mode does not maintain TODO lists as a separate document.  TODO
2294 items are an integral part of the notes file, because TODO items
2295 usually come up while taking notes!  With Org-mode, you simply mark any
2296 entry in a tree as being a TODO item.  In this way, the information is
2297 not duplicated, and the entire context from which the item emerged is
2298 always present when you check.
2300    Of course, this technique causes TODO items to be scattered
2301 throughout your file.  Org-mode provides methods to give you an
2302 overview over all things you have to do.
2304 * Menu:
2306 * TODO basics::                 Marking and displaying TODO entries
2307 * TODO extensions::             Workflow and assignments
2308 * Priorities::                  Some things are more important than others
2309 * Breaking down tasks::         Splitting a task into manageable pieces
2310 * Checkboxes::                  Tick-off lists
2312 \x1f
2313 File: org,  Node: TODO basics,  Next: TODO extensions,  Prev: TODO items,  Up: TODO items
2315 5.1 Basic TODO functionality
2316 ============================
2318 Any headline can become a TODO item by starting it with the word TODO,
2319 for example:
2321      *** TODO Write letter to Sam Fortune
2323 The most important commands to work with TODO entries are:
2325 `C-c C-t'
2326      Rotate the TODO state of the current item among
2328           ,-> (unmarked) -> TODO -> DONE --.
2329           '--------------------------------'
2331      The same rotation can also be done "remotely" from the timeline and
2332      agenda buffers with the `t' command key (*note Agenda commands::).  
2334 `S-<right>'
2335 `S-<left>'
2336      Select the following/preceding TODO state, similar to cycling.
2337      Mostly useful if more than two TODO states are possible (*note
2338      TODO extensions::).  
2340 `C-c C-v'
2341      View TODO items in a _sparse tree_ (*note Sparse trees::).  Folds
2342      the entire buffer, but shows all TODO items and the headings
2343      hierarchy above them.  With prefix arg, search for a specific
2344      TODO.  You will be prompted for the keyword, and you can also give
2345      a list of keywords like `kwd1|kwd2|...'.  With numerical prefix N,
2346      show the tree for the Nth keyword in the variable
2347      `org-todo-keywords'.  With two prefix args, find all TODO and DONE
2348      entries.  
2350 `C-c a t'
2351      Show the global TODO list.  This collects the TODO items from all
2352      agenda files (*note Agenda views::) into a single buffer.  The
2353      buffer is in `agenda-mode', so there are commands to examine and
2354      manipulate the TODO entries directly from that buffer (*note
2355      Agenda commands::).  *Note Global TODO list::, for more
2356      information.
2358 \x1f
2359 File: org,  Node: TODO extensions,  Next: Priorities,  Prev: TODO basics,  Up: TODO items
2361 5.2 Extended use of TODO keywords
2362 =================================
2364 The default implementation of TODO entries is just two states: TODO and
2365 DONE.  You can use the TODO feature for more complicated things by
2366 configuring the variable `org-todo-keywords'.  With special setup, the
2367 TODO keyword system can work differently in different files.
2369    Note that tags are another way to classify headlines in general and
2370 TODO items in particular (*note Tags::).
2372 * Menu:
2374 * Workflow states::             From TODO to DONE in steps
2375 * TODO types::                  I do this, Fred the rest
2376 * Multiple sets in one file::   Mixing it all, and still finding your way
2377 * Per file keywords::           Different files, different requirements
2379 \x1f
2380 File: org,  Node: Workflow states,  Next: TODO types,  Prev: TODO extensions,  Up: TODO extensions
2382 5.2.1 TODO keywords as workflow states
2383 --------------------------------------
2385 You can use TODO keywords to indicate different _sequential_ states in
2386 the process of working on an item, for example(1):
2388      (setq org-todo-keywords
2389        '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2391    The vertical bar separates the TODO keywords (states that _need
2392 action_) from the DONE states (which need _no further action_.  If you
2393 don't provide the separator bar, the last state is used as the DONE
2394 state.  With this setup, the command `C-c C-t' will cycle an entry from
2395 TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
2396 You may also use a prefix argument to quickly select a specific state.
2397 For example `C-3 C-c C-t' will change the state immediately to VERIFY.
2398 If you define many keywords, you can use in-buffer completion (see
2399 *Note Completion::) to insert these words into the buffer.  Changing a
2400 todo state can be logged with a timestamp, see *Note Tracking TODO
2401 state changes:: for more information.
2403    ---------- Footnotes ----------
2405    (1) Changing this variable only becomes effective after restarting
2406 Org-mode in a buffer.
2408 \x1f
2409 File: org,  Node: TODO types,  Next: Multiple sets in one file,  Prev: Workflow states,  Up: TODO extensions
2411 5.2.2 TODO keywords as types
2412 ----------------------------
2414 The second possibility is to use TODO keywords to indicate different
2415 _types_ of action items.  For example, you might want to indicate that
2416 items are for "work" or "home".  Or, when you work with several people
2417 on a single project, you might want to assign action items directly to
2418 persons, by using their names as TODO keywords.  This would be set up
2419 like this:
2421      (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2423    In this case, different keywords do not indicate a sequence, but
2424 rather different types.  So the normal work flow would be to assign a
2425 task to a person, and later to mark it DONE.  Org-mode supports this
2426 style by adapting the workings of the command `C-c C-t'(1).  When used
2427 several times in succession, it will still cycle through all names, in
2428 order to first select the right type for a task.  But when you return
2429 to the item after some time and execute `C-c C-t' again, it will switch
2430 from any name directly to DONE.  Use prefix arguments or completion to
2431 quickly select a specific name.  You can also review the items of a
2432 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2433 C-v'.  For example, to see all things Lucy has to do, you would use
2434 `C-3 C-c C-v'.  To collect Lucy's items from all agenda files into a
2435 single buffer, you would use the prefix arg as well when creating the
2436 global todo list: `C-3 C-c t'.
2438    ---------- Footnotes ----------
2440    (1) This is also true for the `t' command in the timeline and agenda
2441 buffers.
2443 \x1f
2444 File: org,  Node: Multiple sets in one file,  Next: Per file keywords,  Prev: TODO types,  Up: TODO extensions
2446 5.2.3 Multiple keyword sets in one file
2447 ---------------------------------------
2449 Sometimes you may want to use different sets of TODO keywords in
2450 parallel.  For example, you may want to have the basic `TODO'/`DONE',
2451 but also a workflow for bug fixing, and a separate state indicating
2452 that an item has been canceled (so it is not DONE, but also does not
2453 require action).  Your setup would then look like this:
2455      (setq org-todo-keywords
2456            '((sequence "TODO" "|" "DONE")
2457              (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2458              (sequence "|" "CANCELED")))
2460    The keywords should all be different, this helps Org-mode to keep
2461 track of which subsequence should be used for a given entry.  In this
2462 setup, `C-c C-t' only operates within a subsequence, so it switches from
2463 `DONE' to (nothing) to `TODO', and from `FIXED' to (nothing) to
2464 `REPORT'.  Therefore you need a mechanism to initially select the
2465 correct sequence.  Besides the obvious ways like typing a keyword or
2466 using completion, you may also apply the following commands:
2468 `C-S-<right>'
2469 `C-S-<left>'
2470      These keys jump from one TODO subset to the next.  In the above
2471      example, `C-S-<right>' would jump from `TODO' or `DONE' to
2472      `REPORT', and any of the words in the second row to `CANCELED'.  
2474 `S-<right>'
2475 `S-<left>'
2476      `S-<<left>>' and `S-<<right>>' and walk through _all_ keywords
2477      from all sets, so for example `S-<<right>>' would switch from
2478      `DONE' to `REPORT' in the example above.
2480 \x1f
2481 File: org,  Node: Per file keywords,  Prev: Multiple sets in one file,  Up: TODO extensions
2483 5.2.4 Setting up keywords for individual files
2484 ----------------------------------------------
2486 It can be very useful to use different aspects of the TODO mechanism in
2487 different files.  For file-local settings, you need to add special lines
2488 to the file which set the keywords and interpretation for that file
2489 only.  For example, to set one of the two examples discussed above, you
2490 need one of the following lines, starting in column zero anywhere in the
2491 file:
2493      #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2494    or
2495      #+TYP_TODO: Fred Sara Lucy Mike | DONE
2497    A setup for using several sets in parallel would be:
2499      #+SEQ_TODO: "TODO" "|" "DONE"
2500      #+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED"
2501      #+SEQ_TODO: "|" "CANCELED"
2503 To make sure you are using the correct keyword, type `#+' into the
2504 buffer and then use `M-<TAB>' completion.
2506    Remember that the keywords after the vertical bar (or the last
2507 keyword if no bar is there) must always mean that the item is DONE
2508 (although you may use a different word).  After changing one of these
2509 lines, use `C-c C-c' with the cursor still in the line to make the
2510 changes known to Org-mode(1).
2512    ---------- Footnotes ----------
2514    (1) Org-mode parses these lines only when Org-mode is activated
2515 after visiting a file.  `C-c C-c' with the cursor in a line starting
2516 with `#+' is simply restarting Org-mode for the current buffer.
2518 \x1f
2519 File: org,  Node: Priorities,  Next: Breaking down tasks,  Prev: TODO extensions,  Up: TODO items
2521 5.3 Priorities
2522 ==============
2524 If you use Org-mode extensively to organize your work, you may end up
2525 with a number of TODO entries so large that you'd like to prioritize
2526 them.  This can be done by placing a _priority cookie_ into the
2527 headline, like this
2529      *** TODO [#A] Write letter to Sam Fortune
2531 With its standard setup, Org-mode supports priorities `A', `B', and
2532 `C'.  `A' is the highest priority.  An entry without a cookie is
2533 treated as priority `B'.  Priorities make a difference only in the
2534 agenda (*note Weekly/Daily agenda::).
2536 `C-c ,'
2537      Set the priority of the current headline.  The command prompts for
2538      a priority character `A', `B' or `C'.  When you press <SPC>
2539      instead, the priority cookie is removed from the headline.  The
2540      priorities can also be changed "remotely" from the timeline and
2541      agenda buffer with the `,' command (*note Agenda commands::).  
2543 `S-<up>'
2544 `S-<down>'
2545      Increase/decrease priority of current headline.  Note that these
2546      keys are also used to modify time stamps (*note Creating
2547      timestamps::).  Furthermore, these keys are also used by CUA-mode
2548      (*note Conflicts::).
2550    You can change the range of allowed priorities by setting the
2551 variables `org-highest-priority', `org-lowest-priority', and
2552 `org-default-priority'.  For an individual buffer, you may set these
2553 values (highest, lowest, default) like this (please make sure that the
2554 highest priority is earlier in the alphabet than the lowest priority):
2556      #+PRIORITIES: A C B
2558 \x1f
2559 File: org,  Node: Breaking down tasks,  Next: Checkboxes,  Prev: Priorities,  Up: TODO items
2561 5.4 Breaking tasks down into subtasks
2562 =====================================
2564 It is often advisable to break down large tasks into smaller, manageable
2565 subtasks.  You can do this by creating an outline tree below a TODO
2566 item, with detailed subtasks on the tree(1).  Another possibility is
2567 the use of checkboxes to identify (a hierarchy of) a large number of
2568 subtasks (*note Checkboxes::).
2570    ---------- Footnotes ----------
2572    (1) To keep subtasks out of the global TODO list, see the
2573 `org-agenda-todo-list-sublevels'.
2575 \x1f
2576 File: org,  Node: Checkboxes,  Prev: Breaking down tasks,  Up: TODO items
2578 5.5 Checkboxes
2579 ==============
2581 Every item in a plain list (*note Plain lists::) can be made a checkbox
2582 by starting it with the string `[ ]'.  This feature is similar to TODO
2583 items (*note TODO items::), but more lightweight.  Checkboxes are not
2584 included into the global TODO list, so they are often great to split a
2585 task into a number of simple steps.  Or you can use them in a shopping
2586 list.  To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2587 `org-mouse.el'.  Here is an example of a checkbox list.
2589      * TODO Organize party [3/6]
2590        - call people [1/3]
2591          - [ ] Peter
2592          - [X] Sarah
2593          - [ ] Sam
2594        - [X] order food
2595        - [ ] think about what music to play
2596        - [X] talk to the neighbors
2598    The `[3/6]' and `[1/3]' in the first and second line are cookies
2599 indicating how many checkboxes are present in this entry, and how many
2600 of them have been checked off.  This can give you an idea on how many
2601 checkboxes remain, even without opening a folded entry.  The cookies
2602 can be placed into a headline or into (the first line of) a plain list
2603 item. Each cookie covers all checkboxes structurally below that
2604 headline/item.  You have to insert the cookie yourself by typing either
2605 `[/]' or `[%]'.  In the first case you get an `n out of m' result, in
2606 the second case you get information about the percentage of checkboxes
2607 checked (in the above example, this would be `[50%]' and `[33%],
2608 respectively').
2610 The following commands work with checkboxes:
2612 `C-c C-c'
2613      Toggle checkbox at point.  
2615 `C-c C-x C-b'
2616      Toggle checkbox at point.
2617         - If there is an active region, toggle the first checkbox in
2618           the region and set all remaining boxes to the same status as
2619           the first.  If you want to toggle all boxes in the region
2620           independently, use a prefix argument.
2622         - If the cursor is in a headline, toggle checkboxes in the
2623           region between this headline and the next (so _not_ the
2624           entire subtree).
2626         - If there is no active region, just toggle the checkbox at
2627           point.
2628      
2629 `M-S-<RET>'
2630      Insert a new item with a checkbox.  This works only if the cursor
2631      is already in a plain list item (*note Plain lists::).  
2633 `C-c #'
2634      Update the checkbox statistics in the current outline entry.  When
2635      called with a `C-u' prefix, update the entire file.  Checkbox
2636      statistic cookies are updated automatically if you toggle
2637      checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'.  If
2638      you delete boxes or add/change them by hand, use this command to
2639      get things back into synch.  Or simply toggle any checkbox twice
2640      with `C-c C-c'.
2642 \x1f
2643 File: org,  Node: Timestamps,  Next: Tags,  Prev: TODO items,  Up: Top
2645 6 Timestamps
2646 ************
2648 Items can be labeled with timestamps to make them useful for project
2649 planning.
2651 * Menu:
2653 * Time stamps::                 Assigning a time to a tree entry
2654 * Creating timestamps::         Commands which insert timestamps
2655 * Deadlines and scheduling::    Planning your work
2656 * Progress logging::            Documenting when what work was done.
2658 \x1f
2659 File: org,  Node: Time stamps,  Next: Creating timestamps,  Prev: Timestamps,  Up: Timestamps
2661 6.1 Time stamps, deadlines and scheduling
2662 =========================================
2664 A time stamp is a specification of a date (possibly with time) in a
2665 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2666 09:39>'(1).  A time stamp can appear anywhere in the headline or body
2667 of an org-tree entry.  Its presence causes entries to be shown on
2668 specific dates in the agenda (*note Weekly/Daily agenda::).  We
2669 distinguish:
2671 PLAIN TIME STAMP
2672      A simple time stamp just assigns a date/time to an item.  This is
2673      just like writing down an appointment in a paper agenda, or like
2674      writing down an event in a diary, when you want to take note of
2675      when something happened.  In the timeline and agenda displays, the
2676      headline of an entry associated with a plain time stamp will be
2677      shown exactly on that date.
2679           * Meet Peter at the movies <2006-11-01 Wed 19:15>
2681 TIME STAMP WITH REPEATER INTERVAL
2682      A time stamp may contain a _repeater interval_, indicating that it
2683      applies not only on the given date, but again and again after a
2684      certain interval of N days (d), weeks (w), months(m), or years(y).
2685      The following will show up in the agenda every Wednesday:
2687           * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
2689 DIARY-STYLE SEXP ENTRIES
2690      For more complex date specifications, Org-mode supports using the
2691      special sexp diary entries implemented in the Emacs calendar/diary
2692      package.  For example
2694           * The nerd meeting on every 2nd Thursday of the month
2695             <%%(diary-float t 4 2)>
2697 TIME/DATE RANGE
2698      Two time stamps connected by `--' denote a range.  The headline
2699      will be shown on the first and last day of the range, and on any
2700      dates that are displayed and fall in the range.  Here is an
2701      example:
2703           ** Meeting in Amsterdam
2704              <2004-08-23 Mon>--<2004-08-26 Thu>
2706 INACTIVE TIME STAMP
2707      Just like a plain time stamp, but with square brackets instead of
2708      angular ones.  These time stamps are inactive in the sense that
2709      they do _not_ trigger an entry to show up in the agenda.
2711           * Gillian comes late for the fifth time [2006-11-01 Wed]
2714    ---------- Footnotes ----------
2716    (1) This is the standard ISO date/time format.  If you cannot get
2717 used to these, see *Note Custom time format::
2719 \x1f
2720 File: org,  Node: Creating timestamps,  Next: Deadlines and scheduling,  Prev: Time stamps,  Up: Timestamps
2722 6.2 Creating timestamps
2723 =======================
2725 For Org-mode to recognize time stamps, they need to be in the specific
2726 format.  All commands listed below produce time stamps in the correct
2727 format.
2729 `C-c .'
2730      Prompt for a date and insert a corresponding time stamp.  When the
2731      cursor is at a previously used time stamp, it is updated to NOW.
2732      When this command is used twice in succession, a time range is
2733      inserted.  
2735 `C-u C-c .'
2736      Like `C-c .', but use the alternative format which contains date
2737      and time.  The default time can be rounded to multiples of 5
2738      minutes, see the option `org-time-stamp-rounding-minutes'.  
2740 `C-c !'
2741      Like `C-c .', but insert an inactive time stamp that will not cause
2742      an agenda entry.  
2744 `C-c <'
2745      Insert a time stamp corresponding to the cursor date in the
2746      Calendar.  
2748 `C-c >'
2749      Access the Emacs calendar for the current date.  If there is a
2750      timestamp in the current line, goto the corresponding date instead.  
2752 `C-c C-o'
2753      Access the agenda for the date given by the time stamp or -range at
2754      point (*note Weekly/Daily agenda::).  
2756 `S-<left>'
2757 `S-<right>'
2758      Change date at cursor by one day.  These key bindings conflict with
2759      CUA-mode (*note Conflicts::).  
2761 `S-<up>'
2762 `S-<down>'
2763      Change the item under the cursor in a timestamp.  The cursor can
2764      be on a year, month, day, hour or minute.  Note that if the cursor
2765      is in a headline and not at a time stamp, these same keys modify
2766      the priority of an item.  (*note Priorities::). The key bindings
2767      also conflict with CUA-mode (*note Conflicts::).  
2769 `C-c C-y'
2770      Evaluate a time range by computing the difference between start and
2771      end.  With prefix arg, insert result after the time range (in a
2772      table: into the following column).
2774 * Menu:
2776 * The date/time prompt::        How org-mode helps you entering date and time
2777 * Custom time format::          Making dates look differently
2779 \x1f
2780 File: org,  Node: The date/time prompt,  Next: Custom time format,  Prev: Creating timestamps,  Up: Creating timestamps
2782 6.2.1 The date/time prompt
2783 --------------------------
2785 When Org-mode prompts for a date/time, the prompt suggests to enter an
2786 ISO date.  But it will in fact accept any string containing some date
2787 and/or time information.  You can, for example, use `C-y' to paste a
2788 (possibly multi-line) string copied from an email message.  Org-mode
2789 will find whatever information is in there and will replace anything not
2790 specified with the current date and time.  For example:
2792        3-2-5         --> 2003-02-05
2793        feb 15        --> currentyear-02-15
2794        sep 12 9      --> 2009-09-12
2795        12:45         --> today 12:45
2796        22 sept 0:34  --> currentyear-09-22 0:34
2797        12            --> currentyear-currentmonth-12
2798        Fri           --> nearest Friday (today or later)
2799        +4            --> 4 days from now (if +N is the only thing given)
2801    The function understands English month and weekday abbreviations.  If
2802 you want to use unabbreviated names and/or other languages, configure
2803 the variables `parse-time-months' and `parse-time-weekdays'.
2805    Parallel to the minibuffer prompt, a calendar is popped up(1).  When
2806 you exit the date prompt, either by clicking on a date in the calendar,
2807 or by pressing <RET>, the date selected in the calendar will be
2808 combined with the information entered at the prompt.  You can control
2809 the calendar fully from the minibuffer:
2812      Scroll calendar backwards by one month.  
2815      Scroll calendar forwards by one month.  
2817 `mouse-1'
2818      Select date by clicking on it.  
2820 `S-<right>'
2821      One day forward.  
2823 `S-<left>'
2824      One day back.  
2826 `S-<down>'
2827      One week forward.  
2829 `S-<up>'
2830      One week back.  
2832 `M-S-<right>'
2833      One month forward.  
2835 `M-S-<left>'
2836      One month back.  
2838 `<RET>'
2839      Choose date in calendar (only if nothing was typed into
2840      minibuffer).
2842    ---------- Footnotes ----------
2844    (1) If you don't need/want the calendar, configure the variable
2845 `org-popup-calendar-for-date-prompt'.
2847 \x1f
2848 File: org,  Node: Custom time format,  Prev: The date/time prompt,  Up: Creating timestamps
2850 6.2.2 Custom time format
2851 ------------------------
2853 Org-mode uses the standard ISO notation for dates and times as it is
2854 defined in ISO 8601.  If you cannot get used to this and require another
2855 representation of date and time to keep you happy, you can get it by
2856 customizing the variables `org-display-custom-times' and
2857 `org-time-stamp-custom-formats'.
2859 `C-c C-x C-t'
2860      Toggle the display of custom formats for dates and times.
2862 Org-mode needs the default format for scanning, so the custom date/time
2863 format does not _replace_ the default format - instead it is put _over_
2864 the default format using text properties.  This has the following
2865 consequences:
2866    * You cannot place the cursor onto a time stamp anymore, only before
2867      or after.
2869    * The `S-<up>/<down>' keys can no longer be used to adjust each
2870      component of a time stamp.  If the cursor is at the beginning of
2871      the stamp, `S-<up>/<down>' will change the stamp by one day, just
2872      like `S-<left>/<right>'.  At the end of the stamp, the time will
2873      be changed by one minute.
2875    * When you delete a time stamp character-by-character, it will only
2876      disappear from the buffer after _all_ (invisible) characters
2877      belonging to the ISO timestamp have been removed.
2879    * If the custom time stamp format is longer than the default and you
2880      are using dates in tables, table alignment will be messed up.  If
2881      the custom format is shorter, things do work as expected.
2883 \x1f
2884 File: org,  Node: Deadlines and scheduling,  Next: Progress logging,  Prev: Creating timestamps,  Up: Timestamps
2886 6.3 Deadlines and Scheduling
2887 ============================
2889 A time stamp may be preceded by special keywords to facilitate planning
2890 of work:
2892 DEADLINE
2893      The task (most likely a TODO item) is supposed to be finished on
2894      that date, and it will be listed then.  In addition, the
2895      compilation for _today_ will carry a warning about the approaching
2896      or missed deadline, starting `org-deadline-warning-days' before
2897      the due date, and continuing until the entry is marked DONE.  An
2898      example:
2900           *** TODO write article about the Earth for the Guide
2901               The editor in charge is [[bbdb:Ford Prefect]]
2902               DEADLINE: <2004-02-29 Sun>
2904 SCHEDULED
2905      You are planning to start working on that task on the given date.
2906      The headline will be listed under the given date(1).  In addition,
2907      a reminder that the scheduled date has passed will be present in
2908      the compilation for _today_, until the entry is marked DONE.
2909      I.e., the task will automatically be forwarded until completed.
2911           *** TODO Call Trillian for a date on New Years Eve.
2912               SCHEDULED: <2004-12-25 Sat>
2914 * Menu:
2916 * Inserting deadline/schedule::
2917 * Repeated tasks::
2919    ---------- Footnotes ----------
2921    (1) It will still be listed on that date after it has been marked
2922 DONE.  If you don't like this, set the variable
2923 `org-agenda-skip-scheduled-if-done'.
2925 \x1f
2926 File: org,  Node: Inserting deadline/schedule,  Next: Repeated tasks,  Prev: Deadlines and scheduling,  Up: Deadlines and scheduling
2928 6.3.1 Inserting deadline/schedule
2929 ---------------------------------
2931 The following commands allow to quickly insert a deadline or to schedule
2932 an item:
2934 `C-c C-d'
2935      Insert `DEADLINE' keyword along with a stamp.  The insertion will
2936      happen in the line directly following the headline.  
2938 `C-c C-w'
2939      Create a sparse tree with all deadlines that are either past-due,
2940      or which will become due within `org-deadline-warning-days'.  With
2941      `C-u' prefix, show all deadlines in the file.  With a numeric
2942      prefix, check that many days.  For example, `C-1 C-c C-w' shows
2943      all deadlines due tomorrow.  
2945 `C-c C-s'
2946      Insert `SCHEDULED' keyword along with a stamp.  The insertion will
2947      happen in the line directly following the headline.  Any CLOSED
2948      timestamp will be removed.
2950 \x1f
2951 File: org,  Node: Repeated tasks,  Prev: Inserting deadline/schedule,  Up: Deadlines and scheduling
2953 6.3.2 Repeated Tasks
2954 --------------------
2956 Some tasks need to be repeated again and again, and Org-mode therefore
2957 allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for
2958 example:
2959      ** TODO Pay the rent
2960         DEADLINE: <2005-10-01 Sat +1m>
2962    Deadlines and scheduled items produce entries in the agenda when they
2963 are over-due, so it is important to be able to mark such an entry as
2964 completed once you have done so.  When you mark a DEADLINE or a SCHEDULE
2965 with the todo keyword DONE, it will no longer produce entries in the
2966 agenda. The problem with this is, however, that then also the _next_
2967 instance of the repeated entry will not be active.  Org-mode deals with
2968 this in the following way: When you try to mark such an entry DONE
2969 (using `C-c C-t'), it will shift the base date of the repeating time
2970 stamp by the repeater interval, and immediately set the entry state
2971 back to TODO.  In the example above, setting the state to DONE would
2972 actually switch the date like this:
2974      ** TODO Pay the rent
2975         DEADLINE: <2005-11-01 Tue +1m>
2977    You will also be prompted for a note that will be put under the
2978 DEADLINE line to keep a record that you actually acted on the previous
2979 instance of this deadline.
2981    As a consequence of shifting the base date, this entry will no
2982 longer be visible in the agenda when checking past dates, but all
2983 future instances will be visible.
2985    You may have both scheduling and deadline information for a specific
2986 task - just make sure that the repeater intervals on both are the same.
2988 \x1f
2989 File: org,  Node: Progress logging,  Prev: Deadlines and scheduling,  Up: Timestamps
2991 6.4 Progress Logging
2992 ====================
2994 Org-mode can automatically record a time stamp when you mark a TODO item
2995 as DONE, or even each time when you change the state of a TODO item.
2996 You can also measure precisely the time you spent on specific items in a
2997 project by starting and stopping a clock when you start and stop working
2998 on an aspect of a project.
3000 * Menu:
3002 * Closing items::               When was this entry marked DONE?
3003 * Tracking TODO state changes::  When did the status change?
3004 * Clocking work time::          When exactly did you work on this item?
3006 \x1f
3007 File: org,  Node: Closing items,  Next: Tracking TODO state changes,  Prev: Progress logging,  Up: Progress logging
3009 6.4.1 Closing items
3010 -------------------
3012 If you want to keep track of _when_ a certain TODO item was finished,
3013 turn on logging with(1)
3015      (setq org-log-done t)
3017 Then each time you turn a TODO entry into DONE using either `C-c C-t'
3018 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
3019 [timestamp]' will be inserted just after the headline.  If you turn the
3020 entry back into a TODO item through further state cycling, that line
3021 will be removed again.  In the timeline (*note Timeline::) and in the
3022 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
3023 display the TODO items closed on each day, giving you an overview of
3024 what has been done on a day.  If you want to record a note along with
3025 the timestamp, use(2)
3027      (setq org-log-done '(done))
3029    ---------- Footnotes ----------
3031    (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
3033    (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
3035 \x1f
3036 File: org,  Node: Tracking TODO state changes,  Next: Clocking work time,  Prev: Closing items,  Up: Progress logging
3038 6.4.2 Tracking TODO state changes
3039 ---------------------------------
3041 When TODO keywords are used as workflow states (*note Workflow
3042 states::), you might want to keep track of when a state change occurred,
3043 and you may even want to attach notes to that state change.  With the
3044 setting
3046      (setq org-log-done '(state))
3048 each state change will prompt you for a note that will be attached to
3049 the current headline.  Very likely you do not want this verbose tracking
3050 all the time, so it is probably better to configure this behavior with
3051 in-buffer options.  For example, if you are tracking purchases, put
3052 these into a separate file that starts with:
3054      #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
3055      #+STARTUP: lognotestate
3057 \x1f
3058 File: org,  Node: Clocking work time,  Prev: Tracking TODO state changes,  Up: Progress logging
3060 6.4.3 Clocking work time
3061 ------------------------
3063 Org-mode allows you to clock the time you spent on specific tasks in a
3064 project.  When you start working on an item, you can start the clock.
3065 When you stop working on that task, or when you mark the task done, the
3066 clock is stopped and the corresponding time interval is recorded.  It
3067 also computes the total time spent on each subtree of a project.
3069 `C-c C-x C-i'
3070      Start the clock on the current item (clock-in).  This inserts the
3071      CLOCK keyword together with a timestamp.  
3073 `C-c C-x C-o'
3074      Stop the clock (clock-out).  The inserts another timestamp at the
3075      same location where the clock was last started.  It also directly
3076      computes the resulting time in inserts it after the time range as
3077      `=> HH:MM'.  See the variable `org-log-done' for the possibility to
3078      record an additional note together with the clock-out time
3079      stamp(1).  
3081 `C-c C-y'
3082      Recompute the time interval after changing one of the time stamps.
3083      This is only necessary if you edit the time stamps directly.  If
3084      you change them with `S-<cursor>' keys, the update is automatic.  
3086 `C-c C-t'
3087      Changing the TODO state of an item to DONE automatically stops the
3088      clock if it is running in this same item.  
3090 `C-c C-x C-x'
3091      Cancel the current clock.  This is useful if a clock was started by
3092      mistake, or if you ended up working on something else.  
3094 `C-c C-x C-d'
3095      Display time summaries for each subtree in the current buffer.
3096      This puts overlays at the end of each headline, showing the total
3097      time recorded under that heading, including the time of any
3098      subheadings. You can use visibility cycling to study the tree, but
3099      the overlays disappear when you change the buffer (see variable
3100      `org-remove-highlights-with-change') or press `C-c C-c'.  
3102 `C-c C-x C-r'
3103      Insert a dynamic block (*note Dynamic blocks::) containing a clock
3104      report as an org-mode table into the current file.
3105           #+BEGIN: clocktable :maxlevel 2 :emphasize nil
3107           #+END: clocktable
3108      If such a block already exists, its content is replaced by the new
3109      table.  The `BEGIN' line can specify options:
3110           :maxlevels   Maximum level depth to which times are listed in the table.
3111           :emphasize   When `t', emphasize level one and level two items
3112           :block       The time block to consider.  This block is specified relative
3113                        to the current time and may be any of these keywords:
3114                        `today', `yesterday', `thisweek', `lastweek',
3115                        `thismonth', `lastmonth', `thisyear', or `lastyear'.
3116           :tstart      A time string specifying when to start considering times
3117           :tend        A time string specifying when to stop considering times
3118      So to get a clock summary for the current day, you could write
3119           #+BEGIN: clocktable :maxlevel 2 :block today
3121           #+END: clocktable
3122      and to use a specific time range you could write(2)
3123           #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
3124                               :tend "<2006-08-10 Thu 12:00>"
3126           #+END: clocktable
3127      
3128 `C-u C-c C-x C-u'
3129      Update all dynamic blocks (*note Dynamic blocks::).  This is
3130      useful if you have several clocktable blocks in a buffer.
3132    The `l' key may be used in the timeline (*note Timeline::) and in
3133 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
3134 worked on or closed during a day.
3136    ---------- Footnotes ----------
3138    (1) The corresponding in-buffer setting is: `#+STARTUP:
3139 lognoteclock-out'
3141    (2) Note that all parameters must be specified in a single line -
3142 the line is broken here only to fit it onto the manual.
3144 \x1f
3145 File: org,  Node: Tags,  Next: Agenda views,  Prev: Timestamps,  Up: Top
3147 7 Tags
3148 ******
3150 If you wish to implement a system of labels and contexts for
3151 cross-correlating information, an excellent way is to assign tags to
3152 headlines.  Org-mode has extensive support for using tags.
3154    Every headline can contain a list of tags, at the end of the
3155 headline.  Tags are normal words containing letters, numbers, `_', and
3156 `@'.  Tags must be preceded and followed by a single colon; like
3157 `:WORK:'.  Several tags can be specified like `:WORK:URGENT:'.
3159 * Menu:
3161 * Tag inheritance::             Tags use the tree structure of the outline
3162 * Setting tags::                How to assign tags to a headline
3163 * Tag searches::                Searching for combinations of tags
3165 \x1f
3166 File: org,  Node: Tag inheritance,  Next: Setting tags,  Prev: Tags,  Up: Tags
3168 7.1 Tag inheritance
3169 ===================
3171 Tags make use of the hierarchical structure of outline trees.  If a
3172 heading has a certain tag, all subheadings will inherit the tag as
3173 well.  For example, in the list
3175      * Meeting with the French group      :WORK:
3176      ** Summary by Frank                  :BOSS:NOTES:
3177      *** TODO Prepare slides for him      :ACTION:
3179 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
3180 `:ACTION:'.  When executing tag searches and Org-mode finds that a
3181 certain headline matches the search criterion, it will not check any
3182 sublevel headline, assuming that these likely also match, and that the
3183 list of matches can become very long.  This may not be what you want,
3184 however, and you can influence inheritance and searching using the
3185 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
3187 \x1f
3188 File: org,  Node: Setting tags,  Next: Tag searches,  Prev: Tag inheritance,  Up: Tags
3190 7.2 Setting tags
3191 ================
3193 Tags can simply be typed into the buffer at the end of a headline.
3194 After a colon, `M-<TAB>' offers completion on tags.  There is also a
3195 special command for inserting tags:
3197 `C-c C-c'
3198      Enter new tags for the current headline.  Org-mode will either
3199      offer completion or a special single-key interface for setting
3200      tags, see below.  After pressing <RET>, the tags will be inserted
3201      and aligned to `org-tags-column'.  When called with a `C-u'
3202      prefix, all tags in the current buffer will be aligned to that
3203      column, just to make things look nice.  TAGS are automatically
3204      realigned after promotion, demotion, and TODO state changes (*note
3205      TODO basics::).
3207    Org will support tag insertion based on a _list of tags_.  By
3208 default this list is constructed dynamically, containing all tags
3209 currently used in the buffer.  You may also globally specify a hard list
3210 of tags with the variable `org-tag-alist'.  Finally you can set the
3211 default tags for a given file with lines like
3213      #+TAGS: @WORK @HOME @TENNISCLUB
3214      #+TAGS: Laptop Car PC Sailboat
3216    If you have globally defined your preferred set of tags using the
3217 variable `org-tag-alist', but would like to use a dynamic tag list in a
3218 specific file: Just add an empty TAGS option line to that file:
3220      #+TAGS:
3222    The default support method for entering tags is minibuffer
3223 completion.  However, Org-mode also implements a much better method:
3224 _fast tag selection_.  This method allows to select and deselect tags
3225 with a single key per tag.  To function efficiently, you should assign
3226 unique keys to most tags.  This can be done globally with
3228      (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
3230 or on a per-file basis with
3232      #+TAGS: @WORK(w)  @HOME(h)  @TENNISCLUB(t)  Laptop(l)  PC(p)
3234 You can also group together tags that are mutually exclusive.  With
3235 curly braces(1)
3237      #+TAGS: { @WORK(w)  @HOME(h)  @TENNISCLUB(t) }  Laptop(l)  PC(p)
3239 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
3240 should be selected.
3242 Don't forget to press `C-c C-c' with the cursor in one of these lines
3243 to activate any changes.
3245    If at least one tag has a selection key, pressing `C-c C-c' will
3246 automatically present you with a special interface, listing inherited
3247 tags, the tags of the current headline, and a list of all legal tags
3248 with corresponding keys(2).  In this interface, you can use the
3249 following keys:
3251 `a-z...'
3252      Pressing keys assigned to tags will add or remove them from the
3253      list of tags in the current line.  Selecting a tag in a group of
3254      mutually exclusive tags will turn off any other tags from that
3255      group.  
3257 `<TAB>'
3258      Enter a tag in the minibuffer, even if the tag is not in the
3259      predefined list.  You will be able to complete on all tags present
3260      in the buffer.  
3262 `<SPC>'
3263      Clear all tags for this line.  
3265 `<RET>'
3266      Accept the modified set.
3268 `C-g'
3269      Abort without installing changes.
3272      If `q' is not assigned to a tag, it aborts like `C-g'.
3275      Turn off groups of mutually exclusive tags.  Use this to (as an
3276      exception) assign several tags from such a group.
3278 `C-c'
3279      Toggle auto-exit after the next change (see below).  If you are
3280      using expert mode, the first `C-c' will display the selection
3281      window.
3283 This method lets you assign tags to a headline with very few keys.  With
3284 the above setup, you could clear the current tags and set `@HOME',
3285 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
3286 p <RET>'.  Switching from `@HOME' to `@WORK' would be done with `C-c
3287 C-c w <RET>' or alternatively with `C-c C-c C-c w'.  Adding the
3288 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3289 <RET> <RET>'.
3291    If you find that most of the time, you need only a single keypress to
3292 modify your list of tags, set the variable
3293 `org-fast-tag-selection-single-key'.  Then you no longer have to press
3294 <RET> to exit fast tag selection - it will immediately exit after the
3295 first change.  If you then occasionally need more keys, press `C-c' to
3296 turn off auto-exit for the current tag selection process (in effect:
3297 start selection with `C-c C-c C-c' instead of `C-c C-c').  If you set
3298 the variable to the value `expert', the special window is not even
3299 shown for single-key tag selection, it comes up only when you press an
3300 extra `C-c'.
3302    ---------- Footnotes ----------
3304    (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3305 respectively.  Several groups are allowed.
3307    (2) Keys will automatically be assigned to tags which have no
3308 configured keys.
3310 \x1f
3311 File: org,  Node: Tag searches,  Prev: Setting tags,  Up: Tags
3313 7.3 Tag searches
3314 ================
3316 Once a tags system has been set up, it can be used to collect related
3317 information into special lists.
3319 `C-c \'
3320      Create a sparse tree with all headlines matching a tags search.
3321      With a `C-u' prefix argument, ignore headlines that are not a TODO
3322      line.  
3324 `C-c a m'
3325      Create a global list of tag matches from all agenda files.  *Note
3326      Matching headline tags::.  
3328 `C-c a M'
3329      Create a global list of tag matches from all agenda files, but
3330      check only TODO items and force checking subitems (see variable
3331      `org-tags-match-list-sublevels').
3333    A tags search string can use Boolean operators `&' for AND and `|'
3334 for OR.  `&' binds more strongly than `|'.  Parenthesis are currently
3335 not implemented.  A tag may also be preceded by `-', to select against
3336 it, and `+' is syntactic sugar for positive selection.  The AND
3337 operator `&' is optional when `+' or `-' is present.  Examples:
3339 `+WORK-BOSS'
3340      Select headlines tagged `:WORK:', but discard those also tagged
3341      `:BOSS:'.
3343 `WORK|LAPTOP'
3344      Selects lines tagged `:WORK:' or `:LAPTOP:'.
3346 `WORK|LAPTOP&NIGHT'
3347      Like before, but require the `:LAPTOP:' lines to be tagged also
3348      `NIGHT'.
3350    If you are using multi-state TODO keywords (*note TODO
3351 extensions::), it can be useful to also match on the TODO keyword.
3352 This can be done by adding a condition after a slash to a tags match.
3353 The syntax is similar to the tag matches, but should be applied with
3354 consideration: For example, a positive selection on several TODO
3355 keywords can not meaningfully be combined with boolean AND.  However,
3356 _negative selection_ combined with AND can be meaningful.  To make sure
3357 that only lines are checked that actually have any TODO keyword, use
3358 `C-c a M', or equivalently start the todo part after the slash with `!'.
3359 Examples:
3361 `WORK/WAITING'
3362      Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3363      `WAITING'.
3365 `WORK/!-WAITING-NEXT'
3366      Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3367      `NEXT'
3369 `WORK/+WAITING|+NEXT'
3370      Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3371      `NEXT'.
3373    Any element of the tag/todo match can be a regular expression - in
3374 this case it must be enclosed in curly braces.  For example,
3375 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3376 tag starting with `BOSS'.
3378    You can also require a headline to be of a certain level, by writing
3379 instead of any TAG an expression like `LEVEL=3'.  For example, a search
3380 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3381 BOSS and are _not_ marked with the todo keyword DONE.
3383 \x1f
3384 File: org,  Node: Agenda views,  Next: Embedded LaTeX,  Prev: Tags,  Up: Top
3386 8 Agenda Views
3387 **************
3389 Due to the way Org-mode works, TODO items, time-stamped items, and
3390 tagged headlines can be scattered throughout a file or even a number of
3391 files.  To get an overview over open action items, or over events that
3392 are important for a particular date, this information must be collected,
3393 sorted and displayed in an organized way.
3395    Org-mode can select items based on various criteria, and display them
3396 in a separate buffer.  Six different view types are provided:
3398    * an _agenda_ that is like a calendar and shows information for
3399      specific dates,
3401    * a _TODO list_ that covers all unfinished action items,
3403    * a _tags view_, showings headlines based on the tags associated
3404      with them,
3406    * a _timeline view_ that shows all events in a single Org-mode file,
3407      in time-sorted view,
3409    * a _stuck projects view_ showing projects that currently don't move
3410      along, and
3412    * _custom views_ that are special tag/keyword searches and
3413      combinations of different views.
3415 The extracted information is displayed in a special _agenda buffer_.
3416 This buffer is read-only, but provides commands to visit the
3417 corresponding locations in the original Org-mode files, and even to
3418 edit these files remotely.
3420    Two variables control how the agenda buffer is displayed and whether
3421 the window configuration is restored when the agenda exits:
3422 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3424 * Menu:
3426 * Agenda files::                Files being searched for agenda information
3427 * Agenda dispatcher::           Keyboard access to agenda views
3428 * Built-in agenda views::       What is available out of the box?
3429 * Presentation and sorting::    How agenda items are prepared for display
3430 * Agenda commands::             Remote editing of org trees
3431 * Custom agenda views::         Defining special searches and views
3433 \x1f
3434 File: org,  Node: Agenda files,  Next: Agenda dispatcher,  Prev: Agenda views,  Up: Agenda views
3436 8.1 Agenda files
3437 ================
3439 The information to be shown is collected from all _agenda files_, the
3440 files listed in the variable `org-agenda-files'(1).  Thus even if you
3441 only work with a single Org-mode file, this file should be put into
3442 that list(2).  You can customize `org-agenda-files', but the easiest
3443 way to maintain it is through the following commands
3445 `C-c ['
3446      Add current file to the list of agenda files.  The file is added to
3447      the front of the list.  If it was already in the list, it is moved
3448      to the front.  With prefix arg, file is added/moved to the end.  
3450 `C-c ]'
3451      Remove current file from the list of agenda files.  
3453 `C-,'
3454 `C-''
3455      Cycle through agenda file list, visiting one file after the other.
3457 The Org menu contains the current list of files and can be used to
3458 visit any of them.
3460    ---------- Footnotes ----------
3462    (1) If the value of that variable is not a list, but a single file
3463 name, then the list of agenda files will be maintained in that external
3464 file.
3466    (2) When using the dispatcher, pressing `1' before selecting a
3467 command will actually limit the command to the current file, and ignore
3468 `org-agenda-files' until the next dispatcher command.
3470 \x1f
3471 File: org,  Node: Agenda dispatcher,  Next: Built-in agenda views,  Prev: Agenda files,  Up: Agenda views
3473 8.2 The agenda dispatcher
3474 =========================
3476 The views are created through a dispatcher that should be bound to a
3477 global key, for example `C-c a' (*note Installation::).  In the
3478 following we will assume that `C-c a' is indeed how the dispatcher is
3479 accessed and list keyboard access to commands accordingly.  After
3480 pressing `C-c a', an additional letter is required to execute a
3481 command.  The dispatcher offers the following default commands:
3483      Create the calendar-like agenda (*note Weekly/Daily agenda::).
3485 `t / T'
3486      Create a list of all TODO items (*note Global TODO list::).
3488 `m / M'
3489      Create a list of headlines matching a TAGS expression (*note
3490      Matching headline tags::).
3493      Create the timeline view for the current buffer (*note Timeline::).
3495 `# / !'
3496      Create a list of stuck projects (*note Stuck projects::).
3499      Restrict an agenda command to the current buffer.  After pressing
3500      `1', you still need to press the character selecting the command.
3503      If there is an active region, restrict the following agenda
3504      command to the region.  Otherwise, restrict it to the current
3505      subtree.  After pressing `0', you still need to press the
3506      character selecting the command.
3508    You can also define custom commands that will be accessible through
3509 the dispatcher, just like the default commands.  This includes the
3510 possibility to create extended agenda buffers that contain several
3511 blocks together, for example the weekly agenda, the global TODO list and
3512 a number of special tags matches.  *Note Custom agenda views::.
3514 \x1f
3515 File: org,  Node: Built-in agenda views,  Next: Presentation and sorting,  Prev: Agenda dispatcher,  Up: Agenda views
3517 8.3 The built-in agenda views
3518 =============================
3520 In this section we describe the built-in views.
3522 * Menu:
3524 * Weekly/Daily agenda::         The calendar page with current tasks
3525 * Global TODO list::            All unfinished action items
3526 * Matching headline tags::      Structured information with fine-tuned search
3527 * Timeline::                    Time-sorted view for single file
3528 * Stuck projects::              Find projects you need to review
3530 \x1f
3531 File: org,  Node: Weekly/Daily agenda,  Next: Global TODO list,  Prev: Built-in agenda views,  Up: Built-in agenda views
3533 8.3.1 The weekly/daily agenda
3534 -----------------------------
3536 The purpose of the weekly/daily _agenda_ is to act like a page of a
3537 paper agenda, showing all the tasks for the current week or day.
3539 `C-c a a'
3540      Compile an agenda for the current week from a list of org files.
3541      The agenda shows the entries for each day.  With a `C-u' prefix (or
3542      when the variable `org-agenda-include-all-todo' is `t'), all
3543      unfinished TODO items (including those without a date) are also
3544      listed at the beginning of the buffer, before the first date.
3546    Remote editing from the agenda buffer means, for example, that you
3547 can change the dates of deadlines and appointments from the agenda
3548 buffer.  The commands available in the Agenda buffer are listed in
3549 *Note Agenda commands::.
3551 Calendar/Diary integration
3552 ..........................
3554 Emacs contains the calendar and diary by Edward M. Reingold.  The
3555 calendar displays a three-month calendar with holidays from different
3556 countries and cultures.  The diary allows you to keep track of
3557 anniversaries, lunar phases, sunrise/set, recurrent appointments
3558 (weekly, monthly) and more.  In this way, it is quite complementary to
3559 Org-mode.  It can be very useful to combine output from Org-mode with
3560 the diary.
3562    In order to include entries from the Emacs diary into Org-mode's
3563 agenda, you only need to customize the variable
3565      (setq org-agenda-include-diary t)
3567 After that, everything will happen automatically.  All diary entries
3568 including holidays, anniversaries etc will be included in the agenda
3569 buffer created by Org-mode.  <SPC>, <TAB>, and <RET> can be used from
3570 the agenda buffer to jump to the diary file in order to edit existing
3571 diary entries.  The `i' command to insert new entries for the current
3572 date works in the agenda buffer, as well as the commands `S', `M', and
3573 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3574 to other calendars, respectively.  `c' can be used to switch back and
3575 forth between calendar and agenda.
3577    If you are using the diary only for sexp entries and holidays, it is
3578 faster to not use the above setting, but instead to copy or even move
3579 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
3580 entries, and does it faster because there is no overhead for first
3581 creating the diary display.  Note that the sexp entries must start at
3582 the left margin, no white space is allowed before them.  For example,
3583 the following segment of an Org-mode file will be processed and entries
3584 will be made in the agenda:
3586      * Birthdays and similar stuff
3587      #+CATEGORY: Holiday
3588      %%(org-calendar-holiday)   ; special function for holiday names
3589      #+CATEGORY: Ann
3590      %%(diary-anniversary 14  5 1956) Artur Dent %d is years old
3591      %%(diary-anniversary  2 10 1869) Mahatma Gandhi would be %d years old
3593 \x1f
3594 File: org,  Node: Global TODO list,  Next: Matching headline tags,  Prev: Weekly/Daily agenda,  Up: Built-in agenda views
3596 8.3.2 The global TODO list
3597 --------------------------
3599 The global TODO list contains all unfinished TODO items, formatted and
3600 collected into a single place.
3602 `C-c a t'
3603      Show the global TODO list.  This collects the TODO items from all
3604      agenda files (*note Agenda views::) into a single buffer.  The
3605      buffer is in `agenda-mode', so there are commands to examine and
3606      manipulate the TODO entries directly from that buffer (*note
3607      Agenda commands::).  
3609 `C-c a T'
3610      Like the above, but allows selection of a specific TODO keyword.
3611      You can also do this by specifying a prefix argument to `C-c a t'.
3612      With a `C-u' prefix you are prompted for a keyword, and you may
3613      also specify several keywords by separating them with `|' as
3614      boolean OR operator.  With a numeric prefix, the Nth keyword in
3615      `org-todo-keywords' is selected.  The `r' key in the agenda buffer
3616      regenerates it, and you can give a prefix argument to this command
3617      to change the selected TODO keyword, for example `3 r'.  If you
3618      often need a search for a specific keyword, define a custom
3619      command for it (*note Agenda dispatcher::).
3620      Matching specific TODO keywords can also be done as part of a tags
3621      search (*note Tag searches::).
3623    Remote editing of TODO items means that you can change the state of a
3624 TODO entry with a single key press.  The commands available in the TODO
3625 list are described in *Note Agenda commands::.
3627    Normally the global todo list simply shows all headlines with TODO
3628 keywords.  This list can become very long.  There are two ways to keep
3629 it more compact:
3630    - Some people view a TODO item that has been _scheduled_ for
3631      execution (*note Time stamps::) as no longer _open_.  Configure the
3632      variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3633      items from the global TODO list.
3635    - TODO items may have sublevels to break up the task into subtasks.
3636      In such cases it may be enough to list only the highest level TODO
3637      headline and omit the sublevels from the global list.  Configure
3638      the variable `org-agenda-todo-list-sublevels' to get this behavior.
3640 \x1f
3641 File: org,  Node: Matching headline tags,  Next: Timeline,  Prev: Global TODO list,  Up: Built-in agenda views
3643 8.3.3 Matching headline tags
3644 ----------------------------
3646 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3647 you can select headlines based on the tags that apply to them and
3648 collect them into an agenda buffer.
3650 `C-c a m'
3651      Produce a list of all headlines that match a given set of tags.
3652      The command prompts for a selection criterion, which is a boolean
3653      logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3654      `WORK|HOME' (*note Tags::).  If you often need a specific search,
3655      define a custom command for it (*note Agenda dispatcher::).  
3657 `C-c a M'
3658      Like `C-c a m', but only select headlines that are also TODO items
3659      and force checking subitems (see variable
3660      `org-tags-match-list-sublevels').  Matching specific todo keywords
3661      together with a tags match is also possible, see *Note Tag
3662      searches::.
3664    The commands available in the tags list are described in *Note
3665 Agenda commands::.
3667 \x1f
3668 File: org,  Node: Timeline,  Next: Stuck projects,  Prev: Matching headline tags,  Up: Built-in agenda views
3670 8.3.4 Timeline for a single file
3671 --------------------------------
3673 The timeline summarizes all time-stamped items from a single Org-mode
3674 file in a _time-sorted view_.  The main purpose of this command is to
3675 give an overview over events in a project.
3677 `C-c a L'
3678      Show a time-sorted view of the org file, with all time-stamped
3679      items.  When called with a `C-u' prefix, all unfinished TODO
3680      entries (scheduled or not) are also listed under the current date.
3682 The commands available in the timeline buffer are listed in *Note
3683 Agenda commands::.
3685 \x1f
3686 File: org,  Node: Stuck projects,  Prev: Timeline,  Up: Built-in agenda views
3688 8.3.5 Stuck projects
3689 --------------------
3691 If you are following a system like David Allen's GTD to organize your
3692 work, one of the "duties" you have is a regular review to make sure
3693 that all projects move along.  A _stuck_ project is a project that has
3694 no defined next actions, so it will never show up in the TODO lists
3695 Org-mode produces.  During the review, you need to identify such
3696 projects and define next actions for them.
3698 `C-c a #'
3699      List projects that are stuck.  
3701 `C-c a !'
3702      Customize the variable `org-stuck-projects' to define what a stuck
3703      project is and how to find it.
3705    You almost certainly will have to configure this view before it will
3706 work for you.  The built-in default assumes that all your projects are
3707 level-2 headlines, and that a project is not stuck if it has at least
3708 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3710    Lets assume that you, in your own way of using Org-mode, identify
3711 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3712 indicate a project that should not be considered yet.  Lets further
3713 assume that the todo keyword DONE marks finished projects, and that NEXT
3714 and TODO indicate next actions.  The tag @SHOP indicates shopping and
3715 is a next action even without the NEXT tag.  Finally, if the project
3716 contains the special word IGNORE anywhere, it should not be listed
3717 either.  In this case you would start by identifying eligible projects
3718 with a tags/todo match `+PROJECT/-MAYBE-DONE', and then check for TODO,
3719 NEXT, @SHOP, and IGNORE in the subtree to identify projects that are
3720 not stuck.  The correct customization for this is
3722      (setq org-stuck-projects
3723            '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")
3724                                     "\\<IGNORE\\>"))
3726 \x1f
3727 File: org,  Node: Presentation and sorting,  Next: Agenda commands,  Prev: Built-in agenda views,  Up: Agenda views
3729 8.4 Presentation and sorting
3730 ============================
3732 Before displaying items in an agenda view, Org-mode visually prepares
3733 the items and sorts them.  Each item occupies a single line.  The line
3734 starts with a _prefix_ that contains the _category_ (*note
3735 Categories::) of the item and other important information.  You can
3736 customize the prefix using the option `org-agenda-prefix-format'.  The
3737 prefix is followed by a cleaned-up version of the outline headline
3738 associated with the item.
3740 * Menu:
3742 * Categories::                  Not all tasks are equal
3743 * Time-of-day specifications::  How the agenda knows the time
3744 * Sorting of agenda items::     The order of things
3746 \x1f
3747 File: org,  Node: Categories,  Next: Time-of-day specifications,  Prev: Presentation and sorting,  Up: Presentation and sorting
3749 8.4.1 Categories
3750 ----------------
3752 The category is a broad label assigned to each agenda item.  By default,
3753 the category is simply derived from the file name, but you can also
3754 specify it with a special line in the buffer, like this:
3756      #+CATEGORY: Thesis
3758    If there are several such lines in a file, each specifies the
3759 category for the text below it (but the first category also applies to
3760 any text before the first CATEGORY line).  The display in the agenda
3761 buffer looks best if the category is not longer than 10 characters.
3763 \x1f
3764 File: org,  Node: Time-of-day specifications,  Next: Sorting of agenda items,  Prev: Categories,  Up: Presentation and sorting
3766 8.4.2 Time-of-Day Specifications
3767 --------------------------------
3769 Org-mode checks each agenda item for a time-of-day specification.  The
3770 time can be part of the time stamp that triggered inclusion into the
3771 agenda, for example as in `<2005-05-10 Tue 19:00>'.  Time ranges can be
3772 specified with two time stamps, like
3773 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3775    In the headline of the entry itself, a time(range) may also appear as
3776 plain text (like `12:45' or a `8:30-1pm'.  If the agenda integrates the
3777 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3778 entries are recognized as well.
3780    For agenda display, Org-mode extracts the time and displays it in a
3781 standard 24 hour format as part of the prefix.  The example times in
3782 the previous paragraphs would end up in the agenda like this:
3784          8:30-13:00 Arthur Dent lies in front of the bulldozer
3785         12:45...... Ford Prefect arrives and takes Arthur to the pub
3786         19:00...... The Vogon reads his poem
3787         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3789    If the agenda is in single-day mode, or for the display of today, the
3790 timed entries are embedded in a time grid, like
3792          8:00...... ------------------
3793          8:30-13:00 Arthur Dent lies in front of the bulldozer
3794         10:00...... ------------------
3795         12:00...... ------------------
3796         12:45...... Ford Prefect arrives and takes Arthur to the pub
3797         14:00...... ------------------
3798         16:00...... ------------------
3799         18:00...... ------------------
3800         19:00...... The Vogon reads his poem
3801         20:00...... ------------------
3802         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3804    The time grid can be turned on and off with the variable
3805 `org-agenda-use-time-grid', and can be configured with
3806 `org-agenda-time-grid'.
3808 \x1f
3809 File: org,  Node: Sorting of agenda items,  Prev: Time-of-day specifications,  Up: Presentation and sorting
3811 8.4.3 Sorting of agenda items
3812 -----------------------------
3814 Before being inserted into a view, the items are sorted.  How this is
3815 done depends on the type of view.
3816    * For the daily/weekly agenda, the items for each day are sorted.
3817      The default order is to first collect all items containing an
3818      explicit time-of-day specification.  These entries will be shown
3819      at the beginning of the list, as a _schedule_ for the day.  After
3820      that, items remain grouped in categories, in the sequence given by
3821      `org-agenda-files'.  Within each category, items are sorted by
3822      priority (*note Priorities::), which is composed of the base
3823      priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3824      plus additional increments for overdue scheduled or deadline items.
3826    * For the TODO list, items remain in the order of categories, but
3827      within each category, sorting takes place according to priority
3828      (*note Priorities::).
3830    * For tags matches, items are not sorted at all, but just appear in
3831      the sequence in which they are found in the agenda files.
3833    Sorting can be customized using the variable
3834 `org-agenda-sorting-strategy'.
3836 \x1f
3837 File: org,  Node: Agenda commands,  Next: Custom agenda views,  Prev: Presentation and sorting,  Up: Agenda views
3839 8.5 Commands in the agenda buffer
3840 =================================
3842 Entries in the agenda buffer are linked back to the org file or diary
3843 file where they originate.  You are not allowed to edit the agenda
3844 buffer itself, but commands are provided to show and jump to the
3845 original entry location, and to edit the org-files "remotely" from the
3846 agenda buffer.  In this way, all information is stored only once,
3847 removing the risk that your agenda and note files may diverge.
3849    Some commands can be executed with mouse clicks on agenda lines.  For
3850 the other commands, the cursor needs to be in the desired line.
3852 Motion
3853 ......
3856      Next line (same as <up>).  
3859      Previous line (same as <down>).
3861 View/GoTo org file
3862 ..................
3864 `mouse-3'
3865 `<SPC>'
3866      Display the original location of the item in another window.  
3869      Display original location and recenter that window.  
3871 `mouse-2'
3872 `mouse-1'
3873 `<TAB>'
3874      Go to the original location of the item in another window.  Under
3875      Emacs 22, `mouse-1' will also works for this.  
3877 `<RET>'
3878      Go to the original location of the item and delete other windows.  
3881      Toggle Follow mode.  In Follow mode, as you move the cursor through
3882      the agenda buffer, the other window always shows the corresponding
3883      location in the org file.  The initial setting for this mode in new
3884      agenda buffers can be set with the variable
3885      `org-agenda-start-with-follow-mode'.  
3888      Display the entire subtree of the current item in an indirect
3889      buffer.  With numerical prefix ARG, go up to this level and then
3890      take that tree.  If ARG is negative, go up that many levels.  With
3891      `C-u' prefix, do not remove the previously used indirect buffer.  
3894      Toggle Logbook mode.  In Logbook mode, entries that where marked
3895      DONE while logging was on (variable `org-log-done') are shown in
3896      the agenda, as are entries that have been clocked on that day.
3898 Change display
3899 ..............
3902      Delete other windows.  
3905      Switch to weekly view (7 days displayed together).  
3908      Switch to daily view (just one day displayed).  
3911      Toggle the inclusion of diary entries.  See *Note Weekly/Daily
3912      agenda::.  
3915      Toggle the time grid on and off.  See also the variables
3916      `org-agenda-use-time-grid' and `org-agenda-time-grid'.  
3919      Recreate the agenda buffer, for example to reflect the changes
3920      after modification of the time stamps of items with S-<left> and
3921      S-<right>.  When the buffer is the global todo list, a prefix
3922      argument is interpreted to create a selective list for a specific
3923      TODO keyword.  
3926      Save all Org-mode buffers in the current Emacs session.  
3928 `<right>'
3929      Display the following `org-agenda-ndays' days.  For example, if
3930      the display covers a week, switch to the following week.  With
3931      prefix arg, go forward that many times `org-agenda-ndays' days.  
3933 `<left>'
3934      Display the previous dates.  
3937      Goto today.
3939 Remote editing
3940 ..............
3942 `0-9'
3943      Digit argument.  
3945 `C-_'
3946      Undo a change due to a remote editing command.  The change is
3947      undone both in the agenda buffer and in the remote buffer.  
3950      Change the TODO state of the item, both in the agenda and in the
3951      original org file.  
3953 `C-k'
3954      Delete the current agenda item along with the entire subtree
3955      belonging to it in the original Org-mode file.  If the text to be
3956      deleted remotely is longer than one line, the kill needs to be
3957      confirmed by the user.  See variable `org-agenda-confirm-kill'.  
3960      Archive the subtree corresponding to the current headline.  
3963      Show all tags associated with the current item.  Because of
3964      inheritance, this may be more than the tags listed in the line
3965      itself.  
3968      Set tags for the current headline.  
3971      Toggle the ARCHIVE tag for the current headline.  
3974      Set the priority for the current item.  Org-mode prompts for the
3975      priority character. If you reply with <SPC>, the priority cookie
3976      is removed from the entry.  
3979      Display weighted priority of current item.  
3982 `S-<up>'
3983      Increase the priority of the current item.  The priority is
3984      changed in the original buffer, but the agenda is not resorted.
3985      Use the `r' key for this.  
3988 `S-<down>'
3989      Decrease the priority of the current item.  
3991 `C-c C-s'
3992      Schedule this item 
3994 `C-c C-d'
3995      Set a deadline for this item.  
3997 `S-<right>'
3998      Change the time stamp associated with the current line by one day
3999      into the future.  With prefix argument, change it by that many
4000      days.  For example, `3 6 5 S-<right>' will change it by a year.
4001      The stamp is changed in the original org file, but the change is
4002      not directly reflected in the agenda buffer.  Use the `r' key to
4003      update the buffer.  
4005 `S-<left>'
4006      Change the time stamp associated with the current line by one day
4007      into the past.  
4010      Change the time stamp associated with the current line to today.
4011      The key `>' has been chosen, because it is the same as `S-.' on my
4012      keyboard.  
4015      Start the clock on the current item.  If a clock is running
4016      already, it is stopped first.  
4019      Stop the previously started clock.  
4022      Cancel the currently running clock.
4024 Calendar commands
4025 .................
4028      Open the Emacs calendar and move to the date at the agenda cursor.
4031      When in the calendar, compute and show the Org-mode agenda for the
4032      date at the cursor.  
4035      Insert a new entry into the diary.  Prompts for the type of entry
4036      (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
4037      new entry in the diary, just as `i d' etc. would do in the
4038      calendar.  The date is taken from the cursor position.  
4041      Show the phases of the moon for the three months around current
4042      date.  
4045      Show sunrise and sunset times.  The geographical location must be
4046      set with calendar variables, see documentation of the Emacs
4047      calendar.  
4050      Convert the date at cursor into many other cultural and historic
4051      calendars.  
4054      Show holidays for three month around the cursor date.  
4056 `C-c C-x C-c'
4057      Export a single iCalendar file containing entries from all agenda
4058      files.
4060 Exporting to a file
4061 ...................
4063 `C-x C-w'
4064      Write the agenda view to a file.  Depending on the extension of the
4065      selected file name, the view will be exported as HTML (extension
4066      `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4067      (any other extension).  Use the variable
4068      `org-agenda-exporter-settings' to set options for `ps-print' and
4069      for `htmlize' to be used during export.
4071 Quit and Exit
4072 .............
4075      Quit agenda, remove the agenda buffer.  
4078      Exit agenda, remove the agenda buffer and all buffers loaded by
4079      Emacs for the compilation of the agenda.  Buffers created by the
4080      user to visit org files will not be removed.
4082 \x1f
4083 File: org,  Node: Custom agenda views,  Prev: Agenda commands,  Up: Agenda views
4085 8.6 Custom agenda views
4086 =======================
4088 Custom agenda commands serve two purposes: to store and quickly access
4089 frequently used TODO and tags searches, and to create special composite
4090 agenda buffers.  Custom agenda commands will be accessible through the
4091 dispatcher (*note Agenda dispatcher::), just like the default commands.
4093 * Menu:
4095 * Storing searches::            Type once, use often
4096 * Block agenda::                All the stuff you need in a single buffer
4097 * Setting Options::             Changing the rules
4098 * Exporting Agenda Views::      Writing agendas to files.
4099 * Extracting Agenda Information for other programs::
4101 \x1f
4102 File: org,  Node: Storing searches,  Next: Block agenda,  Prev: Custom agenda views,  Up: Custom agenda views
4104 8.6.1 Storing searches
4105 ----------------------
4107 The first application of custom searches is the definition of keyboard
4108 shortcuts for frequently used searches, either creating an agenda
4109 buffer, or a sparse tree (the latter covering of course only the current
4110 buffer).  Custom commands are configured in the variable
4111 `org-agenda-custom-commands'.  You can customize this variable, for
4112 example by pressing `C-c a C'.  You can also directly set it with Emacs
4113 Lisp in `.emacs'.  The following example contains all valid search
4114 types:
4116      (setq org-agenda-custom-commands
4117            '(("w" todo "WAITING")
4118              ("W" todo-tree "WAITING")
4119              ("u" tags "+BOSS-URGENT")
4120              ("v" tags-todo "+BOSS-URGENT")
4121              ("U" tags-tree "+BOSS-URGENT")
4122              ("f" occur-tree "\\<FIXME\\>")))
4124 The initial single-character string in each entry defines the character
4125 you have to press after the dispatcher command `C-c a' in order to
4126 access the command.   The second parameter is the search type, followed
4127 by the string or regular expression to be used for the matching.  The
4128 example above will therefore define:
4130 `C-c a w'
4131      as a global search for TODO entries with `WAITING' as the TODO
4132      keyword
4134 `C-c a W'
4135      as the same search, but only in the current buffer and displaying
4136      the results as a sparse tree
4138 `C-c a u'
4139      as a global tags search for headlines marked `:BOSS:' but not
4140      `:URGENT:'
4142 `C-c a v'
4143      as the same search as `C-c a u', but limiting the search to
4144      headlines that are also TODO items
4146 `C-c a U'
4147      as the same search as `C-c a u', but only in the current buffer and
4148      displaying the result as a sparse tree
4150 `C-c a f'
4151      to create a sparse tree (again: current buffer only) with all
4152      entries containing the word `FIXME'.
4154 \x1f
4155 File: org,  Node: Block agenda,  Next: Setting Options,  Prev: Storing searches,  Up: Custom agenda views
4157 8.6.2 Block agenda
4158 ------------------
4160 Another possibility is the construction of agenda views that comprise
4161 the results of _several_ commands, each of which creates a block in the
4162 agenda buffer.  The available commands include `agenda' for the daily
4163 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
4164 todo list (as constructed with `C-c a t'), and the matching commands
4165 discussed above: `todo', `tags', and `tags-todo'.  Here are two
4166 examples:
4168      (setq org-agenda-custom-commands
4169            '(("h" "Agenda and Home-related tasks"
4170               ((agenda)
4171                (tags-todo "HOME")
4172                (tags "GARDEN")))
4173              ("o" "Agenda and Office-related tasks"
4174               ((agenda)
4175                (tags-todo "WORK")
4176                (tags "OFFICE")))))
4178 This will define `C-c a h' to create a multi-block view for stuff you
4179 need to attend to at home.  The resulting agenda buffer will contain
4180 your agenda for the current week, all TODO items that carry the tag
4181 `HOME', and also all lines tagged with `GARDEN'.  Finally the command
4182 `C-c a o' provides a similar view for office tasks.
4184 \x1f
4185 File: org,  Node: Setting Options,  Next: Exporting Agenda Views,  Prev: Block agenda,  Up: Custom agenda views
4187 8.6.3 Setting Options for custom commands
4188 -----------------------------------------
4190 Org-mode contains a number of variables regulating agenda construction
4191 and display.  The global variables define the behavior for all agenda
4192 commands, including the custom commands.  However, if you want to change
4193 some settings just for a single custom view, you can do so.  Setting
4194 options requires inserting a list of variable names and values at the
4195 right spot in `org-agenda-custom-commands'.  For example:
4197      (setq org-agenda-custom-commands
4198            '(("w" todo "WAITING"
4199               ((org-agenda-sorting-strategy '(priority-down))
4200                (org-agenda-prefix-format "  Mixed: ")))
4201              ("U" tags-tree "+BOSS-URGENT"
4202               ((org-show-following-heading nil)
4203                (org-show-hierarchy-above nil)))))
4205 Now the `C-c a w' command will sort the collected entries only by
4206 priority, and the prefix format is modified to just say `  Mixed:'
4207 instead of giving the category of the entry.  The sparse tags tree of
4208 `C-c a U' will now turn out ultra-compact, because neither the headline
4209 hierarchy above the match, nor the headline following the match will be
4210 shown.
4212    For command sets creating a block agenda,
4213 `org-agenda-custom-commands' has two separate spots for setting
4214 options.  You can add options that should be valid for just a single
4215 command in the set, and options that should be valid for all commands in
4216 the set.  The former are just added to the command entry, the latter
4217 must come after the list of command entries.  Going back to the block
4218 agenda example (*note Block agenda::), let's change the sorting strategy
4219 for the `C-c a h' commands to `priority-down', but let's sort the
4220 results for GARDEN tags query in the opposite order, `priority-up'.
4221 This would look like this:
4223      (setq org-agenda-custom-commands
4224            '(("h" "Agenda and Home-related tasks"
4225               ((agenda)
4226                (tags-todo "HOME")
4227                (tags "GARDEN"
4228                      ((org-agenda-sorting-strategy '(priority-up)))))
4229               ((org-agenda-sorting-strategy '(priority-down))))
4230              ("o" "Agenda and Office-related tasks"
4231               ((agenda)
4232                (tags-todo "WORK")
4233                (tags "OFFICE")))))
4235    As you see, the values and parenthesis setting is a little complex.
4236 When in doubt, use the customize interface to set this variable - it
4237 fully supports its structure.  Just one caveat: When setting options in
4238 this interface, the _values_ are just lisp expressions.  So if the
4239 value is a string, you need to add the double quotes around the value
4240 yourself.
4242 \x1f
4243 File: org,  Node: Exporting Agenda Views,  Next: Extracting Agenda Information for other programs,  Prev: Setting Options,  Up: Custom agenda views
4245 8.6.4 Exporting Agenda Views
4246 ----------------------------
4248 If you are away from your computer, it can be very useful to have a
4249 printed version of some agenda views to carry around.  Org-mode can
4250 export custom agenda views as plain text, HTML(1) and postscript.  If
4251 you want to do this only occasionally, use the commend
4253 `C-x C-w'
4254      Write the agenda view to a file.  Depending on the extension of the
4255      selected file name, the view will be exported as HTML (extension
4256      `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4257      (any other extension).  Use the variable
4258      `org-agenda-exporter-settings' to set options for `ps-print' and
4259      for `htmlize' to be used during export, for example
4260           (setq org-agenda-exporter-settings
4261                 '((ps-number-of-columns 2)
4262                   (ps-landscape-mode t)
4263                   (htmlize-output-type 'css)))
4265    If you need to export certain agenda views frequently, you can
4266 associate any custom agenda command with a list of output file names
4267 (2).  Here is an example that first does define custom commands for the
4268 agenda and the global todo list, together with a number of files to
4269 which to export them.  Then we define two block agenda commands and
4270 specify filenames for them as well.  File names can be relative to the
4271 current working directory, or absolute.
4273      (setq org-agenda-custom-commands
4274            '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
4275              ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
4276              ("h" "Agenda and Home-related tasks"
4277               ((agenda)
4278                (tags-todo "HOME")
4279                (tags "GARDEN"))
4280               nil
4281               ("~/views/home.html"))
4282              ("o" "Agenda and Office-related tasks"
4283               ((agenda)
4284                (tags-todo "WORK")
4285                (tags "OFFICE"))
4286               nil
4287               ("~/views/office.ps"))))
4289    The extension of the file name determines the type of export.  If it
4290 is `.html', Org-mode will use the `htmlize.el' package to convert the
4291 buffer to HTML and save it to this file name.  If the extension is
4292 `.ps', `ps-print-buffer-with-faces' is used to produce postscript
4293 output.  Any other extension produces a plain ASCII file.
4295    The export files are _not_ created when you use one of those
4296 commands interactively.  Instead, there is a special command to produce
4297 _all_ specified files in one step:
4299 `C-c a e'
4300      Export all agenda views that have export filenames associated with
4301      them.
4303    You can use the options section of the custom agenda commands to also
4304 set options for the export commands.  For example:
4306      (setq org-agenda-custom-commands
4307            '(("X" agenda ""
4308               ((ps-number-of-columns 2)
4309                (ps-landscape-mode t)
4310                (org-agenda-prefix-format " [ ] ")
4311                (org-agenda-with-colors nil)
4312                (org-agenda-remove-tags t))
4313               ("theagenda.ps"))))
4315 This command sets two options for the postscript exporter, to make it
4316 print in two columns in landscape format - the resulting page can be cut
4317 in two and then used in a paper agenda.  The remaining settings modify
4318 the agenda prefix to omit category and scheduling information, and
4319 instead include a checkbox to check off items.  We also remove the tags
4320 to make the lines compact, and we don't want to use colors for the
4321 black-and-white printer.  Settings specified in
4322 `org-agenda-exporter-settings' will also apply, but the settings in
4323 `org-agenda-custom-commands' take precedence.
4325 From the command line you may also use
4326      emacs -f org-batch-store-agenda-views -kill
4327    or, if you need to modify some parameters
4328      emacs -eval '(org-batch-store-agenda-views                      \
4329                    org-agenda-ndays 30                               \
4330                    org-agenda-include-diary nil                      \
4331                    org-agenda-files (quote ("~/org/project.org")))'  \
4332            -kill
4333    which will create the agenda views restricted to the file
4334 `~/org/project.org', without diary entries and with 30 days extent.
4336    ---------- Footnotes ----------
4338    (1) You need to install Hrvoje Niksic' `htmlize.el'.
4340    (2) If you want to store standard views like the weekly agenda or
4341 the global TODO list as well, you need to define custom commands for
4342 them in order to be able to specify filenames.
4344 \x1f
4345 File: org,  Node: Extracting Agenda Information for other programs,  Prev: Exporting Agenda Views,  Up: Custom agenda views
4347 8.6.5 Extracting Agenda Information for other programs
4348 ------------------------------------------------------
4350 Org-mode provides commands to access agenda information for the command
4351 line in emacs batch mode.  This extracted information can be sent
4352 directly to a printer, or it can be read by a program that does further
4353 processing of the data.  The first of these commands is the function
4354 `org-batch-agenda', that produces an agenda view and sends it as ASCII
4355 text to STDOUT.  The command takes a single string as parameter.  If
4356 the string has length 1, it is used as a key to one of the commands you
4357 have configured in `org-agenda-custom-commands', basically any key you
4358 can use after `C-c a'.  For example, to directly print the current TODO
4359 list, you could use
4361      emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4363    If the parameter is a string with 2 or more characters, it is used
4364 as a tags/todo match string.  For example, to print your local shopping
4365 list (all items with the tag `shop', but excluding the tag `NewYork'),
4366 you could use
4368      emacs -batch -l ~/.emacs                                      \
4369            -eval '(org-batch-agenda "+shop-NewYork")' | lpr
4371 You may also modify parameters on the fly like this:
4373      emacs -batch -l ~/.emacs                                      \
4374         -eval '(org-batch-agenda "a"                               \
4375                  org-agenda-ndays 30                               \
4376                  org-agenda-include-diary nil                      \
4377                  org-agenda-files (quote ("~/org/project.org")))'  \
4378         | lpr
4380 which will produce a 30 day agenda, fully restricted to the Org file
4381 `~/org/projects.org', not even including the diary.
4383    If you want to process the agenda data in more sophisticated ways,
4384 you can use the command `org-batch-agenda-csv' to get a comma-separated
4385 list of values for each agenda item.  Each line in the output will
4386 contain a number of fields separated by commas.  The fields in a line
4387 are:
4389      category     The category of the item
4390      head         The headline, without TODO kwd, TAGS and PRIORITY
4391      type         The type of the agenda entry, can be
4392                      todo               selected in TODO match
4393                      tagsmatch          selected in tags match
4394                      diary              imported from diary
4395                      deadline           a deadline
4396                      scheduled          scheduled
4397                      timestamp          appointment, selected by timestamp
4398                      closed             entry was closed on date
4399                      upcoming-deadline  warning about nearing deadline
4400                      past-scheduled     forwarded scheduled item
4401                      block              entry has date block including date
4402      todo         The todo keyword, if any
4403      tags         All tags including inherited ones, separated by colons
4404      date         The relevant date, like 2007-2-14
4405      time         The time, like 15:00-16:50
4406      extra        String with extra planning info
4407      priority-l   The priority letter if any was given
4408      priority-n   The computed numerical priority
4410 Time and date will only be given if a timestamp (or deadline/scheduled)
4411 lead to the selection of the item.
4413    A CSV list like this is very easy to use in a post processing script.
4414 For example, here is a Perl program that gets the TODO list from
4415 Emacs/org-mode and prints all the items, preceded by a checkbox:
4417      #!/usr/bin/perl
4419      # define the Emacs command to run
4420      $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
4422      # run it and capture the output
4423      $agenda = qx{$cmd 2>/dev/null};
4425      # loop over all lines
4426      foreach $line (split(/\n/,$agenda)) {
4428        # get the individual values
4429        ($category,$head,$type,$todo,$tags,$date,$time,$extra,
4430         $priority_l,$priority_n) = split(/,/,$line);
4432        # proccess and print
4433        print "[ ] $head\n";
4434      }
4436 \x1f
4437 File: org,  Node: Embedded LaTeX,  Next: Exporting,  Prev: Agenda views,  Up: Top
4439 9 Embedded LaTeX
4440 ****************
4442 Plain ASCII is normally sufficient for almost all note taking.  One
4443 exception, however, are scientific notes which need to be able to
4444 contain mathematical symbols and the occasional formula.  LaTeX(1) is
4445 widely used to typeset scientific documents. Org-mode supports
4446 embedding LaTeX code into its files, because many academics are used to
4447 read LaTeX source code, and because it can be readily processed into
4448 images for HTML production.
4450    It is not necessary to mark LaTeX macros and code in any special way.
4451 If you observe a few conventions, Org-mode knows how to find it and what
4452 to do with it.
4454 * Menu:
4456 * Math symbols::                TeX macros for symbols and Greek letters
4457 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
4458 * LaTeX fragments::             Complex formulas made easy
4459 * Processing LaTeX fragments::  Previewing LaTeX processing
4460 * CDLaTeX mode::                Speed up entering of formulas
4462    ---------- Footnotes ----------
4464    (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4465 Many of the features described here as "LaTeX" are really from TeX, but
4466 for simplicity I am blurring this distinction.
4468 \x1f
4469 File: org,  Node: Math symbols,  Next: Subscripts and Superscripts,  Prev: Embedded LaTeX,  Up: Embedded LaTeX
4471 9.1 Math symbols
4472 ================
4474 You can use LaTeX macros to insert special symbols like `\alpha' to
4475 indicate the Greek letter, or `\to' to indicate an arrow.  Completion
4476 for these macros is available, just type `\' and maybe a few letters,
4477 and press `M-<TAB>' to see possible completions.  Unlike LaTeX code,
4478 Org-mode allows these macros to be present without surrounding math
4479 delimiters, for example:
4481      Angles are written as Greek letters \alpha, \beta and \gamma.
4483    During HTML export (*note HTML export::), these symbols are
4484 translated into the proper syntax for HTML, for the above examples this
4485 is `&alpha;' and `&rarr;', respectively.
4487 \x1f
4488 File: org,  Node: Subscripts and Superscripts,  Next: LaTeX fragments,  Prev: Math symbols,  Up: Embedded LaTeX
4490 9.2 Subscripts and Superscripts
4491 ===============================
4493 Just like in LaTeX, `^' and `_' are used to indicate super- and
4494 subscripts.  Again, these can be used without embedding them in
4495 math-mode delimiters.  To increase the readability of ASCII text, it is
4496 not necessary (but OK) to surround multi-character sub- and superscripts
4497 with curly braces.  For example
4499      The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
4500      the sun is R_{sun} = 6.96 x 10^8 m.
4502    To avoid interpretation as raised or lowered text, you can quote `^'
4503 and `_' with a backslash: `\_' and `\^'.
4505    During HTML export (*note HTML export::), subscript and superscripts
4506 are surrounded with `<sub>' and `<sup>' tags, respectively.
4508 \x1f
4509 File: org,  Node: LaTeX fragments,  Next: Processing LaTeX fragments,  Prev: Subscripts and Superscripts,  Up: Embedded LaTeX
4511 9.3 LaTeX fragments
4512 ===================
4514 With symbols, sub- and superscripts, HTML is pretty much at its end when
4515 it comes to representing mathematical formulas(1).  More complex
4516 expressions need a dedicated formula processor.  To this end, Org-mode
4517 can contain arbitrary LaTeX fragments.  It provides commands to preview
4518 the typeset result of these fragments, and upon export to HTML, all
4519 fragments will be converted to images and inlined into the HTML
4520 document.  For this to work you need to be on a system with a working
4521 LaTeX installation.  You also need the `dvipng' program, available at
4522 `http://sourceforge.net/projects/dvipng/'.  The LaTeX header that will
4523 be used when processing a fragment can be configured with the variable
4524 `org-format-latex-header'.
4526    LaTeX fragments don't need any special marking at all.  The following
4527 snippets will be identified as LaTeX source code:
4528    * Environments of any kind.  The only requirement is that the
4529      `\begin' statement appears on a new line, preceded by only
4530      whitespace.
4532    * Text within the usual LaTeX math delimiters.  To avoid conflicts
4533      with currency specifications, single `$' characters are only
4534      recognized as math delimiters if the enclosed text contains at
4535      most two line breaks, is directly attached to the `$' characters
4536      with no whitespace in between, and if the closing `$' is followed
4537      by whitespace or punctuation.  For the other delimiters, there is
4538      no such restriction, so when in doubt, use `\(...\)' as inline
4539      math delimiters.
4541 For example:
4543      \begin{equation}                          % arbitrary environments,
4544      x=\sqrt{b}                                % even tables, figures
4545      \end{equation}                            % etc
4547      If $a^2=b$ and \( b=2 \), then the solution must be
4548      either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4550 If you need any of the delimiter ASCII sequences for other purposes, you
4551 can configure the option `org-format-latex-options' to deselect the
4552 ones you do not wish to have interpreted by the LaTeX converter.
4554    ---------- Footnotes ----------
4556    (1) Yes, there is MathML, but that is not yet fully supported by
4557 many browsers, and there is no decent converter for turning LaTeX of
4558 ASCII representations of formulas into MathML.  So for the time being,
4559 converting formulas into images seems the way to go.
4561 \x1f
4562 File: org,  Node: Processing LaTeX fragments,  Next: CDLaTeX mode,  Prev: LaTeX fragments,  Up: Embedded LaTeX
4564 9.4 Processing LaTeX fragments
4565 ==============================
4567 LaTeX fragments can be processed to produce a preview images of the
4568 typeset expressions:
4570 `C-c C-x C-l'
4571      Produce a preview image of the LaTeX fragment at point and overlay
4572      it over the source code.  If there is no fragment at point,
4573      process all fragments in the current entry (between two
4574      headlines).  When called with a prefix argument, process the
4575      entire subtree.  When called with two prefix arguments, or when
4576      the cursor is before the first headline, process the entire buffer.  
4578 `C-c C-c'
4579      Remove the overlay preview images.
4581    During HTML export (*note HTML export::), all LaTeX fragments are
4582 converted into images and inlined into the document if the following
4583 setting is active:
4585      (setq org-export-with-LaTeX-fragments t)
4587 \x1f
4588 File: org,  Node: CDLaTeX mode,  Prev: Processing LaTeX fragments,  Up: Embedded LaTeX
4590 9.5 Using CDLaTeX to enter math
4591 ===============================
4593 CDLaTeX-mode is a minor mode that is normally used in combination with a
4594 major LaTeX mode like AUCTeX in order to speed-up insertion of
4595 environments and math templates.  Inside Org-mode, you can make use of
4596 some of the features of cdlatex-mode.  You need to install `cdlatex.el'
4597 and `texmathp.el' (the latter comes also with AUCTeX) from
4598 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'.  Don't turn
4599 cdlatex-mode itself under Org-mode, but use the light version
4600 `org-cdlatex-mode' that comes as part of Org-mode.  Turn it on for the
4601 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4602 with
4604      (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4606    When this mode is enabled, the following features are present (for
4607 more details see the documentation of cdlatex-mode):
4608    * Environment templates can be inserted with `C-c {'.
4610    * The <TAB> key will do template expansion if the cursor is inside a
4611      LaTeX fragment(1).  For example, <TAB> will expand `fr' to
4612      `\frac{}{}' and position the cursor correctly inside the first
4613      brace.  Another <TAB> will get you into the second brace.  Even
4614      outside fragments, <TAB> will expand environment abbreviations at
4615      the beginning of a line.  For example, if you write `equ' at the
4616      beginning of a line and press <TAB>, this abbreviation will be
4617      expanded to an `equation' environment.  To get a list of all
4618      abbreviations, type `M-x cdlatex-command-help'.
4620    * Pressing `_' and `^' inside a LaTeX fragment will insert these
4621      characters together with a pair of braces.  If you use <TAB> to
4622      move out of the braces, and if the braces surround only a single
4623      character or macro, they are removed again (depending on the
4624      variable `cdlatex-simplify-sub-super-scripts').
4626    * Pressing the backquote ``' followed by a character inserts math
4627      macros, also outside LaTeX fragments.  If you wait more than 1.5
4628      seconds after the backquote, a help window will pop up.
4630    * Pressing the normal quote `'' followed by another character
4631      modifies the symbol before point with an accent or a font.  If you
4632      wait more than 1.5 seconds after the backquote, a help window will
4633      pop up.  Character modification will work only inside LaTeX
4634      fragments, outside the quote is normal.
4636    ---------- Footnotes ----------
4638    (1) Org-mode has a method to test if the cursor is inside such a
4639 fragment, see the documentation of the function
4640 `org-inside-LaTeX-fragment-p'.
4642 \x1f
4643 File: org,  Node: Exporting,  Next: Publishing,  Prev: Embedded LaTeX,  Up: Top
4645 10 Exporting
4646 ************
4648 Org-mode documents can be exported into a variety of other formats.  For
4649 printing and sharing of notes, ASCII export produces a readable and
4650 simple version of an Org-mode file.  HTML export allows you to publish a
4651 notes file on the web, while the XOXO format provides a solid base for
4652 exchange with a broad range of other applications.  To incorporate
4653 entries with associated times like deadlines or appointments into a
4654 desktop calendar program like iCal, Org-mode can also produce extracts
4655 in the iCalendar format.  Currently Org-mode only supports export, not
4656 import of these different formats.
4658    When exporting, Org-mode uses special conventions to enrich the
4659 output produced.  *Note Text interpretation::, for more details.
4661 `C-c C-e'
4662      Dispatcher for export and publishing commands.  Displays a
4663      help-window listing the additional key(s) needed to launch an
4664      export or publishing command.
4666 * Menu:
4668 * ASCII export::                Exporting to plain ASCII
4669 * HTML export::                 Exporting to HTML
4670 * XOXO export::                 Exporting to XOXO
4671 * iCalendar export::            Exporting in iCalendar format
4672 * Text interpretation::         How the exporter looks at the file
4674 \x1f
4675 File: org,  Node: ASCII export,  Next: HTML export,  Prev: Exporting,  Up: Exporting
4677 10.1 ASCII export
4678 =================
4680 ASCII export produces a simple and very readable version of an Org-mode
4681 file.
4683 `C-c C-e a'
4684      Export as ASCII file.  If there is an active region, only the
4685      region will be exported.  For an org file `myfile.org', the ASCII
4686      file will be `myfile.txt'.  The file will be overwritten without
4687      warning.  
4689 `C-c C-e v a'
4690      Export only the visible part of the document.
4692    In the exported version, the first 3 outline levels will become
4693 headlines, defining a general document structure.  Additional levels
4694 will be exported as itemized lists.  If you want that transition to
4695 occur at a different level, specify it with a prefix argument.  For
4696 example,
4698      C-1 C-c C-e a
4700 creates only top level headlines and does the rest as items.  When
4701 headlines are converted to items, the indentation of the text following
4702 the headline is changed to fit nicely under the item.  This is done with
4703 the assumption that the first bodyline indicates the base indentation of
4704 the body text.  Any indentation larger than this is adjusted to preserve
4705 the layout relative to the first line.  Should there be lines with less
4706 indentation than the first, these are left alone.
4708 \x1f
4709 File: org,  Node: HTML export,  Next: XOXO export,  Prev: ASCII export,  Up: Exporting
4711 10.2 HTML export
4712 ================
4714 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4715 HTML formatting, in ways similar to John Grubers _markdown_ language,
4716 but with additional support for tables.
4718 * Menu:
4720 * Export commands::             How to invoke HTML export
4721 * Quoting HTML tags::           Using direct HTML in Org-mode
4722 * Links::                       How hyperlinks get transferred to HTML
4723 * Images::                      To inline or not to inline?
4724 * CSS support::                 Style specifications
4726 \x1f
4727 File: org,  Node: Export commands,  Next: Quoting HTML tags,  Prev: HTML export,  Up: HTML export
4729 10.2.1 HTML export commands
4730 ---------------------------
4732 `C-c C-e h'
4733      Export as HTML file `myfile.html'.  
4735 `C-c C-e b'
4736      Export as HTML file and open it with a browser.  
4738 `C-c C-e H'
4739      Export to a temporary buffer, do not create a file.  
4741 `C-c C-e H'
4742      Export the active region to a temporary buffer.  With prefix arg,
4743      do not produce file header and foot, but just the plain HTML
4744      section for the region.  This is good for cut-and-paste operations.  
4746 `C-c C-e v h'
4748 `C-c C-e v b'
4750 `C-c C-e v H'
4752 `C-c C-e v R'
4753      Export only the visible part of the document.
4755 `M-x org-export-region-as-html'
4756      Convert the region to HTML under the assumption that it was
4757      org-mode syntax before.  This is a global command that can be
4758      invoked in any buffer.
4760    In the exported version, the first 3 outline levels will become
4761 headlines, defining a general document structure.  Additional levels
4762 will be exported as itemized lists.  If you want that transition to
4763 occur at a different level, specify it with a prefix argument.  For
4764 example,
4766      C-2 C-c C-e b
4768 creates two levels of headings and does the rest as items.
4770 \x1f
4771 File: org,  Node: Quoting HTML tags,  Next: Links,  Prev: Export commands,  Up: HTML export
4773 10.2.2 Quoting HTML tags
4774 ------------------------
4776 Plain `<' and `>' are always transformed to `&lt;' and `&gt;' in HTML
4777 export.  If you want to include simple HTML tags which should be
4778 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
4779 Note that this really works only for simple tags.  For more extensive
4780 HTML that should be copied verbatim to the exported file use either
4782      #+HTML: Literal HTML code for export
4786      #+BEGIN_HTML
4787      All lines between these markers are exported literally
4788      #+END_HTML
4790 \x1f
4791 File: org,  Node: Links,  Next: Images,  Prev: Quoting HTML tags,  Up: HTML export
4793 10.2.3 Links
4794 ------------
4796 Internal links (*note Internal links::) will continue to work in HTML
4797 files only if they match a dedicated `<<target>>'.  Automatic links
4798 created by radio targets (*note Radio targets::) will also work in the
4799 HTML file.  Links to external files will still work if the HTML file is
4800 in the same directory as the Org-mode file.  Links to other `.org'
4801 files will be translated into HTML links under the assumption that an
4802 HTML version also exists of the linked file.  For information related to
4803 linking files while publishing them to a publishing directory see *Note
4804 Publishing links::.
4806 \x1f
4807 File: org,  Node: Images,  Next: CSS support,  Prev: Links,  Up: HTML export
4809 10.2.4 Images
4810 -------------
4812 HTML export can inline images given as links in the Org-mode file, and
4813 it can make an image the clickable part of a link.  By default(1),
4814 images are inlined if a link does not have a description.  So
4815 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4816 image]]' will just produce a link `the image' that points to the image.
4817 If the description part itself is a `file:' link or a `http:' URL
4818 pointing to an image, this image will be inlined and activated so that
4819 clicking on the image will activate the link.  For example, to include
4820 a thumbnail that will link to a high resolution version of the image,
4821 you could use:
4823      [[file:highres.jpg][file:thumb.jpg]]
4825 and you could use `http' addresses just as well.
4827    ---------- Footnotes ----------
4829    (1) but see the variable `org-export-html-inline-images'
4831 \x1f
4832 File: org,  Node: CSS support,  Prev: Images,  Up: HTML export
4834 10.2.5 CSS support
4835 ------------------
4837 You can also give style information for the exported file.  The HTML
4838 exporter assigns the following CSS classes to appropriate parts of the
4839 document - your style specifications may change these:
4840      .todo           TODO keywords
4841      .done           the DONE keyword
4842      .timestamp      time stamp
4843      .timestamp-kwd  keyword associated with a time stamp, like SCHEDULED
4844      .tag            tag in a headline
4845      .target         target for links
4847    The default style specification can be configured through the option
4848 `org-export-html-style'.  If you want to use a file-local style, you
4849 may use file variables, best wrapped into a COMMENT section at the end
4850 of the outline tree.  For example(1):
4852      * COMMENT html style specifications
4854      # Local Variables:
4855      # org-export-html-style: "   <style type=\"text/css\">
4856      #       p {font-weight: normal; color: gray; }
4857      #       h1 {color: black; }
4858      #   </style>"
4859      # End:
4861    Remember to execute `M-x normal-mode' after changing this to make
4862 the new style visible to Emacs.  This command restarts org-mode for the
4863 current buffer and forces Emacs to re-evaluate the local variables
4864 section in the buffer.
4866    ---------- Footnotes ----------
4868    (1) Under Emacs 21, the continuation lines for a variable value
4869 should have no `#' at the start of the line.
4871 \x1f
4872 File: org,  Node: XOXO export,  Next: iCalendar export,  Prev: HTML export,  Up: Exporting
4874 10.3 XOXO export
4875 ================
4877 Org-mode contains an exporter that produces XOXO-style output.
4878 Currently, this exporter only handles the general outline structure and
4879 does not interpret any additional Org-mode features.
4881 `C-c C-e x'
4882      Export as XOXO file `myfile.html'.  
4884 `C-c C-e v x'
4885      Export only the visible part of the document.
4887 \x1f
4888 File: org,  Node: iCalendar export,  Next: Text interpretation,  Prev: XOXO export,  Up: Exporting
4890 10.4 iCalendar export
4891 =====================
4893 Some people like to use Org-mode for keeping track of projects, but
4894 still prefer a standard calendar application for anniversaries and
4895 appointments.  In this case it can be useful to have deadlines and
4896 other time-stamped items in Org-mode files show up in the calendar
4897 application.  Org-mode can export calendar information in the standard
4898 iCalendar format.  If you also want to have TODO entries included in the
4899 export, configure the variable `org-icalendar-include-todo'.
4901 `C-c C-e i'
4902      Create iCalendar entries for the current file and store them in
4903      the same directory, using a file extension `.ics'.  
4905 `C-c C-e I'
4906      Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4907      For each of these files, a separate iCalendar file will be
4908      written.  
4910 `C-c C-e c'
4911      Create a single large iCalendar file from all files in
4912      `org-agenda-files' and write it to the file given by
4913      `org-combined-agenda-icalendar-file'.
4915    How this calendar is best read and updated, depends on the
4916 application you are using.  The FAQ covers this issue.
4918 \x1f
4919 File: org,  Node: Text interpretation,  Prev: iCalendar export,  Up: Exporting
4921 10.5 Text interpretation by the exporter
4922 ========================================
4924 The exporter backends interpret additional structure in the Org-mode
4925 file in order to produce better output.
4927 * Menu:
4929 * Comment lines::               Some lines will not be exported
4930 * Initial text::                Text before the first headline
4931 * Footnotes::                   Numbers like [1]
4932 * Enhancing text::              Subscripts, symbols and more
4933 * Export options::              How to influence the export settings
4935 \x1f
4936 File: org,  Node: Comment lines,  Next: Initial text,  Prev: Text interpretation,  Up: Text interpretation
4938 10.5.1 Comment lines
4939 --------------------
4941 Lines starting with `#' in column zero are treated as comments and will
4942 never be exported.  Also entire subtrees starting with the word
4943 `COMMENT' will never be exported.
4945 `C-c ;'
4946      Toggle the COMMENT keyword at the beginning of an entry.
4948 \x1f
4949 File: org,  Node: Initial text,  Next: Footnotes,  Prev: Comment lines,  Up: Text interpretation
4951 10.5.2 Text before the first headline
4952 -------------------------------------
4954 Org-mode normally ignores any text before the first headline when
4955 exporting, leaving this region for internal links to speed up navigation
4956 etc.  However, in publishing-oriented files, you might want to have some
4957 text before the first headline, like a small introduction, special HTML
4958 code with a navigation bar, etc.  You can ask to have this part of the
4959 file exported as well by setting the variable
4960 `org-export-skip-text-before-1st-heading' to `nil'.  On a per-file
4961 basis, you can get the same effect with
4963      #+OPTIONS: skip:nil
4965    The text before the first headline will be fully processed (*note
4966 Enhancing text::), and the first non-comment line becomes the title of
4967 the exported document.  If you need to include literal HTML, use the
4968 special constructs described in *Note Quoting HTML tags::.  The table
4969 of contents is normally inserted directly before the first headline of
4970 the file.  If you would like to get it to a different location, insert
4971 the string `[TABLE-OF-CONTENTS]' on a line by itself at the desired
4972 location.
4974    Finally, if you want to use the space before the first headline for
4975 internal purposes, but _still_ want to place something before the first
4976 headline when exporting the file, you can use the `#+TEXT' construct:
4978      #+OPTIONS: skip:t
4979      #+TEXT: This text will go before the *first* headline.
4980      #+TEXT: We place the table of contents here:
4981      #+TEXT: [TABLE-OF-CONTENTS]
4982      #+TEXT: This goes between the table of contents and the first headline
4984 \x1f
4985 File: org,  Node: Footnotes,  Next: Enhancing text,  Prev: Initial text,  Up: Text interpretation
4987 10.5.3 Footnotes
4988 ----------------
4990 Numbers in square brackets are treated as footnotes, so that you can use
4991 the Emacs package `footnote.el' to create footnotes.  For example:
4993      The org-mode homepage[1] clearly needs help from
4994      a good web designer.
4996      [1] The link is: http://www.astro.uva.nl/~dominik/Tools/org
4998 Note that the `footnote' package uses `C-c !' to invoke its commands.
4999 This binding conflicts with the org-mode command for inserting inactive
5000 time stamps.  You could use the variable `footnote-prefix' to switch
5001 footnotes commands to another key.  Or, if you are too used to this
5002 binding, you could use `org-replace-disputed-keys' and
5003 `org-disputed-keys' to change the settings in Org-mode.
5005 \x1f
5006 File: org,  Node: Enhancing text,  Next: Export options,  Prev: Footnotes,  Up: Text interpretation
5008 10.5.4 Enhancing text for export
5009 --------------------------------
5011 Some of the export backends of Org-mode allow for sophisticated text
5012 formatting, this is true in particular for the HTML backend.  Org-mode
5013 has a number of typing conventions that allow to produce a richly
5014 formatted output.
5016    * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
5017      enumerator will be recognized and transformed if the backend
5018      supports lists.  See *Note Plain lists::.
5020    * You can make words *bold*, /italic/, _underlined_, `=code=', and
5021      even `+strikethrough+'(1).
5023    * A line consisting of only dashes, and at least 5 of them, will be
5024      exported as a horizontal line (`<hr/>' in HTML).
5026    * Many TeX macros and entire LaTeX fragments are converted into HTML
5027      entities or images (*note Embedded LaTeX::).
5029    * Tables are transformed into native tables under the exporter, if
5030      the export backend supports this. Data fields before the first
5031      horizontal separator line will be formatted as table header fields.
5033    * If a headline starts with the word `QUOTE', the text below the
5034      headline will be typeset as fixed-width, to allow quoting of
5035      computer codes etc.  Lines starting with `:' are also typeset in
5036      fixed-width font.
5037     `C-c :'
5038           Toggle fixed-width for entry (QUOTE) or region, see below.
5040    * A double backslash _at the end of a line_ enforces a line break at
5041      this position.
5043    If these conversions conflict with your habits of typing ASCII text,
5044 they can all be turned off with corresponding variables.  See the
5045 customization group `org-export-general', and the following section
5046 which explains how to set export options with special lines in a buffer.
5048    ---------- Footnotes ----------
5050    (1) but remember that strikethrough is typographically evil and
5051 should never be used.
5053 \x1f
5054 File: org,  Node: Export options,  Prev: Enhancing text,  Up: Text interpretation
5056 10.5.5 Export options
5057 ---------------------
5059 The exporter recognizes special lines in the buffer which provide
5060 additional information.  These lines may be put anywhere in the file.
5061 The whole set of lines can be inserted into the buffer with `C-c C-e
5062 t'.  For individual lines, a good way to make sure the keyword is
5063 correct is to type `#+' and then use `M-<TAB>' completion (*note
5064 Completion::).
5066 `C-c C-e t'
5067      Insert template with export options, see example below.
5069      #+TITLE:     the title to be shown (default is the buffer name)
5070      #+AUTHOR:    the author (default taken from `user-full-name')
5071      #+EMAIL:     his/her email address (default from `user-mail-address')
5072      #+LANGUAGE:  language for HTML, e.g. `en' (`org-export-default-language')
5073      #+TEXT:      Some descriptive text to be inserted at the beginning.
5074      #+TEXT:      Several lines may be given.
5075      #+OPTIONS:   H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t skip:t
5077 The OPTIONS line is a compact form to specify export settings.  Here
5078 you can: 
5079      H:      set the number of headline levels for export
5080      num:    turn on/off section-numbers
5081      toc:    turn on/off table of contents, or set level limit (integer)
5082      \n:     turn on/off linebreak-preservation
5083      @:      turn on/off quoted HTML tags
5084      ::      turn on/off fixed-width sections
5085      |:      turn on/off tables
5086      ^:      turn on/off TeX-like syntax for sub- and superscripts.  If
5087              you write "^:{}", `a_{b}' will be interpreted, but
5088              the simple `a_b' will be left as it is.
5089      *:      turn on/off emphasized text (bold, italic, underlined)
5090      TeX:    turn on/off simple TeX macros in plain text
5091      LaTeX:  turn on/off LaTeX fragments
5092      skip:   turn on/off skipping the text before the first heading
5094 \x1f
5095 File: org,  Node: Publishing,  Next: Miscellaneous,  Prev: Exporting,  Up: Top
5097 11 Publishing
5098 *************
5100 Org-mode includes(1) a publishing management system that allows you to
5101 configure automatic HTML conversion of _projects_ composed of
5102 interlinked org files.  This system is called _org-publish_.  You can
5103 also configure org-publish to automatically upload your exported HTML
5104 pages and related attachments, such as images and source code files, to
5105 a web server.  Org-publish turns org-mode into a web-site authoring
5106 tool.
5108    Org-publish has been contributed to Org-mode by David O'Toole.
5110 * Menu:
5112 * Configuration::               Defining projects
5113 * Sample configuration::        Example projects
5114 * Triggering publication::      Publication commands
5116    ---------- Footnotes ----------
5118    (1) `org-publish.el' is not yet part of Emacs, so if you are using
5119 `org.el' as it comes with Emacs, you need to download this file
5120 separately.  Also make sure org.el is at least version 4.27.
5122 \x1f
5123 File: org,  Node: Configuration,  Next: Sample configuration,  Prev: Publishing,  Up: Publishing
5125 11.1 Configuration
5126 ==================
5128 Publishing needs significant configuration to specify files, destination
5129 and many other properties of a project.
5131 * Menu:
5133 * Project alist::               The central configuration variable
5134 * Sources and destinations::    From here to there
5135 * Selecting files::             What files are part of the project?
5136 * Publishing action::           Setting the function doing the publishing
5137 * Publishing options::          Tweaking HTML export
5138 * Publishing links::            Which links keep working after publishing?
5139 * Project page index::          Publishing a list of project files
5141 \x1f
5142 File: org,  Node: Project alist,  Next: Sources and destinations,  Prev: Configuration,  Up: Configuration
5144 11.1.1 The variable `org-publish-project-alist'
5145 -----------------------------------------------
5147 Org-publish is configured almost entirely through setting the value of
5148 one variable, called `org-publish-project-alist'.  Each element of the
5149 list configures one project, and may be in one of the two following
5150 forms:
5152      ("project-name"  :property value :property value ...)
5154      or
5156      ("project-name"  :components ("project-name" "project-name" ...))
5158    In both cases, projects are configured by specifying property values.
5159 A project defines the set of files that will be published, as well as
5160 the publishing configuration to use when publishing those files.  When
5161 a project takes the second form listed above, the individual members of
5162 the "components" property are taken to be components of the project,
5163 which group together files requiring different publishing options. When
5164 you publish such a "meta-project" all the components will also publish.
5166 \x1f
5167 File: org,  Node: Sources and destinations,  Next: Selecting files,  Prev: Project alist,  Up: Configuration
5169 11.1.2 Sources and destinations for files
5170 -----------------------------------------
5172 Most properties are optional, but some should always be set. In
5173 particular, org-publish needs to know where to look for source files,
5174 and where to put published files.
5176 `:base-directory'      Directory containing publishing source files
5177 `:publishing-directory'Directory (possibly remote) where output files
5178                        will be published.
5179 `:preparation-function'Function called before starting publishing
5180                        process, for example to run `make' for updating
5181                        files to be published.
5183 \x1f
5184 File: org,  Node: Selecting files,  Next: Publishing action,  Prev: Sources and destinations,  Up: Configuration
5186 11.1.3 Selecting files
5187 ----------------------
5189 By default, all files with extension `.org' in the base directory are
5190 considered part of the project.  This can be modified by setting the
5191 properties
5192 `:base-extension'  Extension (without the dot!) of source files.  This
5193                    actually is a regular expression.
5194 `:exclude'         Regular expression to match file names that should
5195                    not be published, even though they have been selected
5196                    on the basis of their extension.
5197 `:include'         List of files to be included regardless of
5198                    `:base-extension' and `:exclude'.
5200 \x1f
5201 File: org,  Node: Publishing action,  Next: Publishing options,  Prev: Selecting files,  Up: Configuration
5203 11.1.4 Publishing Action
5204 ------------------------
5206 Publishing means that a file is copied to the destination directory and
5207 possibly transformed in the process.  The default transformation is to
5208 export Org-mode files as HTML files, and this is done by the function
5209 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
5210 export::).  Other files like images only need to be copied to the
5211 publishing destination.  For non-Org-mode files, you need to specify
5212 the publishing function.
5214 `:publishing-function' Function executing the publication of a file.
5215                        This may also be a list of functions, which will
5216                        all be called in turn.
5218    The function must accept two arguments: a property list containing at
5219 least a `:publishing-directory' property, and the name of the file to
5220 be published.  It should take the specified file, make the necessary
5221 transformation (if any) and place the result into the destination
5222 folder.  You can write your own publishing function, but `org-publish'
5223 provides one for attachments (files that only need to be copied):
5224 `org-publish-attachment'.
5226 \x1f
5227 File: org,  Node: Publishing options,  Next: Publishing links,  Prev: Publishing action,  Up: Configuration
5229 11.1.5 Options for the HTML exporter
5230 ------------------------------------
5232 The property list can be used to set many export options for the HTML
5233 exporter.  In most cases, these properties correspond to user variables
5234 in Org-mode.  The table below lists these properties along with the
5235 variable they belong to.  See the documentation string for the
5236 respective variable for details.
5238 `:language'            `org-export-default-language'
5239 `:headline-levels'     `org-export-headline-levels'
5240 `:section-numbers'     `org-export-with-section-numbers'
5241 `:table-of-contents'   `org-export-with-toc'
5242 `:archived-trees'      `org-export-with-archived-trees'
5243 `:emphasize'           `org-export-with-emphasize'
5244 `:sub-superscript'     `org-export-with-sub-superscripts'
5245 `:TeX-macros'          `org-export-with-TeX-macros'
5246 `:LaTeX-fragments'     `org-export-with-LaTeX-fragments'
5247 `:fixed-width'         `org-export-with-fixed-width'
5248 `:timestamps'          `org-export-with-timestamps'
5249  .                     
5250 `:tags'                `org-export-with-tags'
5251  .                     
5252 `:tables'              `org-export-with-tables'
5253 `:table-auto-headline' `org-export-highlight-first-table-line'
5254 `:style'               `org-export-html-style'
5255 `:convert-org-links'   `org-export-html-link-org-files-as-html'
5256 `:inline-images'       `org-export-html-inline-images'
5257 `:expand-quoted-html'  `org-export-html-expand'
5258 `:timestamp'           `org-export-html-with-timestamp'
5259 `:publishing-directory'`org-export-publishing-directory'
5260 `:preamble'            `org-export-html-preamble'
5261 `:postamble'           `org-export-html-postamble'
5262 `:auto-preamble'       `org-export-html-auto-preamble'
5263 `:auto-postamble'      `org-export-html-auto-postamble'
5264 `:author'              `user-full-name'
5265 `:email'               `user-mail-address'
5267    When a property is given a value in org-publish-project-alist, its
5268 setting overrides the value of the corresponding user variable (if any)
5269 during publishing.  options set within a file (*note Export options::),
5270 however, override everything.
5272 \x1f
5273 File: org,  Node: Publishing links,  Next: Project page index,  Prev: Publishing options,  Up: Configuration
5275 11.1.6 Links between published files
5276 ------------------------------------
5278 To create a link from one Org-mode file to another, you would use
5279 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
5280 (*note Hyperlinks::).  Upon publishing this link becomes a link to
5281 `foo.html'.  In this way, you can interlink the pages of your "org web"
5282 project and the links will work as expected when you publish them to
5283 HTML.
5285    You may also link to related files, such as images. Provided you are
5286 careful with relative pathnames, and provided you have also configured
5287 org-publish to upload the related files, these links will work too.
5288 *Note Complex example:: for an example of this usage.
5290    Sometime an Org-mode file to be published may contain links that are
5291 only valid in your production environment, but not in the publishing
5292 location.  In this case, use the property
5294 `:link-validation-function'   Function to validate links
5296 to define a function for checking link validity.  This function must
5297 accept two arguments, the file name and a directory relative to which
5298 the file name is interpreted in the production environment.  If this
5299 function returns `nil', then the HTML generator will only insert a
5300 description into the HTML file, but no link.  One option for this
5301 function is `org-publish-validate-link' which checks if the given file
5302 is part of any project in `org-publish-project-alist'.
5304 \x1f
5305 File: org,  Node: Project page index,  Prev: Publishing links,  Up: Configuration
5307 11.1.7 Project page index
5308 -------------------------
5310 The following properties may be used to control publishing of an index
5311 of files or summary page for a given project.
5313 `:auto-index'      When non-nil, publish an index during
5314                    org-publish-current-project or org-publish-all.
5315 `:index-filename'  Filename for output of index. Defaults to `index.org'
5316                    (which becomes `index.html').
5317 `:index-title'     Title of index page. Defaults to name of file.
5318 `:index-function'  Plugin function to use for generation of index.
5319                    Defaults to `org-publish-org-index', which generates
5320                    a plain list of links to all files in the project.
5322 \x1f
5323 File: org,  Node: Sample configuration,  Next: Triggering publication,  Prev: Configuration,  Up: Publishing
5325 11.2 Sample configuration
5326 =========================
5328 Below we provide two example configurations.  The first one is a simple
5329 project publishing only a set of Org-mode files.  The second example is
5330 more complex, with a multi-component project.
5332 * Menu:
5334 * Simple example::              One-component publishing
5335 * Complex example::             A multi-component publishing example
5337 \x1f
5338 File: org,  Node: Simple example,  Next: Complex example,  Prev: Sample configuration,  Up: Sample configuration
5340 11.2.1 Example: simple publishing configuration
5341 -----------------------------------------------
5343 This example publishes a set of Org-mode files to the `public_html'
5344 directory on the local machine.
5346      (setq org-publish-project-alist
5347            '(("org"
5348               :base-directory "~/org/"
5349               :publishing-directory "~/public_html"
5350               :section-numbers nil
5351               :table-of-contents nil
5352               :style "<link rel=stylesheet
5353                      href=\"../other/mystyle.css\"
5354                      type=\"text/css\">")))
5356 \x1f
5357 File: org,  Node: Complex example,  Prev: Simple example,  Up: Sample configuration
5359 11.2.2 Example: complex publishing configuration
5360 ------------------------------------------------
5362 This more complicated example publishes an entire website, including
5363 org files converted to HTML, image files, emacs lisp source code, and
5364 stylesheets. The publishing-directory is remote and private files are
5365 excluded.
5367    To ensure that links are preserved, care should be taken to replicate
5368 your directory structure on the web server, and to use relative file
5369 paths. For example, if your org files are kept in `~/org' and your
5370 publishable images in `~/images', you'd link to an image with
5371      file:../images/myimage.png
5372    On the web server, the relative path to the image should be the
5373 same. You can accomplish this by setting up an "images" folder in the
5374 right place on the webserver, and publishing images to it.
5376      (setq org-publish-project-alist
5377            '(("orgfiles"
5378                :base-directory "~/org/"
5379                :base-extension "org"
5380                :publishing-directory "/ssh:user@host:~/html/notebook/"
5381                :publishing-function org-publish-org-to-html
5382                :exclude "PrivatePage.org"   ;; regexp
5383                :headline-levels 3
5384                :section-numbers nil
5385                :table-of-contents nil
5386                :style "<link rel=stylesheet
5387                        href=\"../other/mystyle.css\" type=\"text/css\">"
5388                :auto-preamble t
5389                :auto-postamble nil)
5391               ("images"
5392                :base-directory "~/images/"
5393                :base-extension "jpg\\|gif\\|png"
5394                :publishing-directory "/ssh:user@host:~/html/images/"
5395                :publishing-function org-publish-attachment)
5397               ("other"
5398                :base-directory "~/other/"
5399                :base-extension "css\\|el"
5400                :publishing-directory "/ssh:user@host:~/html/other/"
5401                :publishing-function org-publish-attachment)
5402               ("website" :components ("orgfiles" "images" "other"))))
5404 \x1f
5405 File: org,  Node: Triggering publication,  Prev: Sample configuration,  Up: Publishing
5407 11.3 Triggering publication
5408 ===========================
5410 Once org-publish is properly configured, you can publish with the
5411 following functions:
5413 `C-c C-e C'
5414      Prompt for a specific project and publish all files that belong to
5415      it.
5417 `C-c C-e P'
5418      Publish the project containing the current file.
5420 `C-c C-e F'
5421      Publish only the current file.
5423 `C-c C-e A'
5424      Publish all projects.
5426    Org uses timestamps to track when a file has changed. The above
5427 functions normally only publish changed files. You can override this and
5428 force publishing of all files by giving a prefix argument.
5430 \x1f
5431 File: org,  Node: Miscellaneous,  Next: Extensions and Hacking,  Prev: Publishing,  Up: Top
5433 12 Miscellaneous
5434 ****************
5436 * Menu:
5438 * Completion::                  M-TAB knows what you need
5439 * Customization::               Adapting Org-mode to your taste
5440 * In-buffer settings::          Overview of the #+KEYWORDS
5441 * The very busy C-c C-c key::   When in doubt, press C-c C-c
5442 * Clean view::                  Getting rid of leading stars in the outline
5443 * TTY keys::                    Using Org-mode on a tty
5444 * Interaction::                 Other Emacs packages
5445 * Bugs::                        Things which do not work perfectly
5447 \x1f
5448 File: org,  Node: Completion,  Next: Customization,  Prev: Miscellaneous,  Up: Miscellaneous
5450 12.1 Completion
5451 ===============
5453 Org-mode supports in-buffer completion.  This type of completion does
5454 not make use of the minibuffer.  You simply type a few letters into the
5455 buffer and use the key to complete text right there.
5457 `M-<TAB>'
5458      Complete word at point
5459         * At the beginning of a headline, complete TODO keywords.
5461         * After `\', complete TeX symbols supported by the exporter.
5463         * After `*', complete headlines in the current buffer so that
5464           they can be used in search links like `[[*find this
5465           headline]]'.
5467         * After `:', complete tags.  The list of tags is taken from the
5468           variable `org-tag-alist' (possibly set through the `#+TAGS'
5469           in-buffer option, *note Setting tags::), or it is created
5470           dynamically from all tags used in the current buffer.
5472         * After `[', complete link abbreviations (*note Link
5473           abbreviations::).
5475         * After `#+', complete the special keywords like `TYP_TODO' or
5476           `OPTIONS' which set file-specific options for Org-mode.  When
5477           the option keyword is already complete, pressing `M-<TAB>'
5478           again will insert example settings for this keyword.
5480         * In the line after `#+STARTUP: ', complete startup keywords,
5481           i.e. valid keys for this line.
5483         * Elsewhere, complete dictionary words using ispell.
5485 \x1f
5486 File: org,  Node: Customization,  Next: In-buffer settings,  Prev: Completion,  Up: Miscellaneous
5488 12.2 Customization
5489 ==================
5491 There are more than 180 variables that can be used to customize
5492 Org-mode.  For the sake of compactness of the manual, I am not
5493 describing the variables here.  A structured overview of customization
5494 variables is available with `M-x org-customize'.  Or select `Browse Org
5495 Group' from the `Org->Customization' menu.  Many settings can also be
5496 activated on a per-file basis, by putting special lines into the buffer
5497 (*note In-buffer settings::).
5499 \x1f
5500 File: org,  Node: In-buffer settings,  Next: The very busy C-c C-c key,  Prev: Customization,  Up: Miscellaneous
5502 12.3 Summary of in-buffer settings
5503 ==================================
5505 Org-mode uses special lines in the buffer to define settings on a
5506 per-file basis.  These lines start with a `#+' followed by a keyword, a
5507 colon, and then individual words defining a setting.  Several setting
5508 words can be in the same line, but you can also have multiple lines for
5509 the keyword.  While these settings are described throughout the manual,
5510 here is a summary.  After changing any of those lines in the buffer,
5511 press `C-c C-c' with the cursor still in the line to activate the
5512 changes immediately.  Otherwise they become effective only when the
5513 file is visited again in a new Emacs session.
5515 `#+STARTUP:'
5516      This line sets options to be used at startup of org-mode, when an
5517      Org-mode file is being visited.  The first set of options deals
5518      with the initial visibility of the outline tree.  The
5519      corresponding variable for global default settings is
5520      `org-startup-folded', with a default value `t', which means
5521      `overview'.  
5522           overview   top-level headlines only
5523           content    all headlines
5524           showall    no folding at all, show everything
5525      Then there are options for aligning tables upon visiting a file.
5526      This is useful in files containing narrowed table columns.  The
5527      corresponding variable is `org-startup-align-all-tables', with a
5528      default value `nil'.  
5529           align      align all tables
5530           noalign    don't align tables on startup
5531      Logging TODO state changes and clock intervals (variable
5532      `org-log-done') can be configured using these options.  
5533           logging          record a timestamp when an item is marked DONE
5534           nologging        don't record when items are marked DONE
5535           lognotedone      record timestamp and a note when DONE
5536           lognotestate     record timestamp, note when TODO state changes
5537           logrepeat        record a not when re-instating a repeating item
5538           nologrepeat      do not record when re-instating repeating item
5539           lognoteclock-out record timestamp and a note when clocking out
5540      Here are the options for hiding leading stars in outline headings.
5541      The corresponding variables are `org-hide-leading-stars' and
5542      `org-odd-levels-only', both with a default setting `nil' (meaning
5543      `showstars' and `oddeven').  
5544           hidestars  make all but one of the stars starting a headline invisible.
5545           showstars  show all stars starting a headline
5546           odd        allow only odd outline levels (1,3,...)
5547           oddeven    allow all outline levels
5548      To turn on custom format overlays over time stamps (variables
5549      `org-put-time-stamp-overlays' and
5550      `org-time-stamp-overlay-formats'), use 
5551           customtime overlay custom time format
5552      The following options influence the table spreadsheet (variable
5553      `constants-unit-system').  
5554           constcgs   `constants.el' should use the c-g-s unit system
5555           constSI    `constants.el' should use the SI unit system
5557 `#+SEQ_TODO:   #+TYP_TODO:'
5558      These lines set the TODO keywords and their interpretation in the
5559      current file.  The corresponding variables are `org-todo-keywords'
5560      and `org-todo-interpretation'.
5562 `#+TAGS:  TAG1(c1) TAG2(c2)'
5563      These lines (several such lines are allowed) specify the legal
5564      tags in this file, and (potentially) the corresponding _fast tag
5565      selection_ keys.  The corresponding variable is `org-tag-alist'.
5567 `#+LINK:  linkword replace'
5568      These lines (several are allowed) specify link abbreviations.
5569      *Note Link abbreviations::.  The corresponding variable is
5570      `org-link-abbrev-alist'.
5572 `#+CATEGORY:'
5573      This line sets the category for the agenda file.  The category
5574      applies for all subsequent lines until the next `#+CATEGORY' line,
5575      or the end of the file.  The first such line also applies to any
5576      entries before it.
5578 `#+ARCHIVE: %s_done::'
5579      This line sets the archive location for the agenda file.  It
5580      applies for all subsequent lines until the next `#+CATEGORY' line,
5581      or the end of the file.  The first such line also applies to any
5582      entries before it.  The corresponding variable is
5583      `org-archive-location'.
5585 `#+PRIORITIES: highest lowest default'
5586      This line sets the limits and the default for the priorities.  All
5587      three must be either letters A-Z or numbers 0-9.  The highest
5588      priority must have a lower ASCII number that the lowest priority.
5590 `#+TBLFM:'
5591      This line contains the formulas for the table directly above the
5592      line.
5594 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5595      These lines provide settings for exporting files.  For more
5596      details see *Note Export options::.
5598 \x1f
5599 File: org,  Node: The very busy C-c C-c key,  Next: Clean view,  Prev: In-buffer settings,  Up: Miscellaneous
5601 12.4 The very busy C-c C-c key
5602 ==============================
5604 The key `C-c C-c' has many purposes in org-mode, which are all
5605 mentioned scattered throughout this manual.  One specific function of
5606 this key is to add _tags_ to a headline (*note Tags::).  In many other
5607 circumstances it means something like _Hey Org-mode, look here and
5608 update according to what you see here_.  Here is a summary of what this
5609 means in different contexts.
5611    - If there are highlights in the buffer from the creation of a sparse
5612      tree, or from clock display, remove these highlights.
5614    - If the cursor is in one of the special `#+KEYWORD' lines, this
5615      triggers scanning the buffer for these lines and updating the
5616      information.
5618    - If the cursor is inside a table, realign the table.  This command
5619      works even if the automatic table editor has been turned off.
5621    - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5622      entire table.
5624    - If the cursor is inside a table created by the `table.el' package,
5625      activate that table.
5627    - If the current buffer is a remember buffer, close the note and
5628      file it.  With a prefix argument, file it, without further
5629      interaction, to the default location.
5631    - If the cursor is on a `<<<target>>>', update radio targets and
5632      corresponding links in this buffer.
5634    - If the cursor is in a plain list item with a checkbox, toggle the
5635      status of the checkbox.
5637    - If the cursor is on a numbered item in a plain list, renumber the
5638      ordered list.
5640 \x1f
5641 File: org,  Node: Clean view,  Next: TTY keys,  Prev: The very busy C-c C-c key,  Up: Miscellaneous
5643 12.5 A cleaner outline view
5644 ===========================
5646 Some people find it noisy and distracting that the Org-mode headlines
5647 are starting with a potentially large number of stars.  For example the
5648 tree from *Note Headlines:::
5650      * Top level headline
5651      ** Second level
5652      *** 3rd level
5653          some text
5654      *** 3rd level
5655          more text
5656      * Another top level headline
5658 Unfortunately this is deeply ingrained into the code of Org-mode and
5659 cannot be easily changed.  You can, however, modify the display in such
5660 a way that all leading stars become invisible and the outline more easy
5661 to read.  To do this, customize the variable `org-hide-leading-stars'
5662 like this:
5664      (setq org-hide-leading-stars t)
5666 or change this on a per-file basis with one of the lines (anywhere in
5667 the buffer)
5669      #+STARTUP: showstars
5670      #+STARTUP: hidestars
5672 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5673 modifications.
5675    With stars hidden, the tree becomes:
5677      * Top level headline
5678       * Second level
5679        * 3rd level
5680          some text
5681        * 3rd level
5682          more text
5683      * Another top level headline
5685 Note that the leading stars are not truly replaced by whitespace, they
5686 are only fontified with the face `org-hide' that uses the background
5687 color as font color.  If you are not using either white or black
5688 background, you may have to customize this face to get the wanted
5689 effect.  Another possibility is to set this font such that the extra
5690 stars are almost invisible, for example using the color `grey90' on a
5691 white background.
5693    Things become cleaner still if you skip all the even levels and use
5694 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5695 outline level to the next:
5697      * Top level headline
5698        * Second level
5699          * 3rd level
5700            some text
5701          * 3rd level
5702            more text
5703      * Another top level headline
5705 In order to make the structure editing and export commands handle this
5706 convention correctly, use
5708      (setq org-odd-levels-only t)
5710 or set this on a per-file basis with one of the following lines (don't
5711 forget to press `C-c C-c' with the cursor in the startup line to
5712 activate changes immediately).
5714      #+STARTUP: odd
5715      #+STARTUP: oddeven
5717    You can convert an Org-mode file from single-star-per-level to the
5718 double-star-per-level convention with `M-x org-convert-to-odd-levels
5719 RET' in that file.  The reverse operation is `M-x
5720 org-convert-to-oddeven-levels'.
5722 \x1f
5723 File: org,  Node: TTY keys,  Next: Interaction,  Prev: Clean view,  Up: Miscellaneous
5725 12.6 Using org-mode on a tty
5726 ============================
5728 Org-mode uses a number of keys that are not accessible on a tty.  This
5729 applies to most special keys like cursor keys, <TAB> and <RET>, when
5730 these are combined with modifier keys like <Meta> and/or <Shift>.
5731 Org-mode uses these bindings because it needs to provide keys for a
5732 large number of commands, and because these keys appeared particularly
5733 easy to remember.  In order to still be able to access the core
5734 functionality of Org-mode on a tty, alternative bindings are provided.
5735 Here is a complete list of these bindings, which are obviously more
5736 cumbersome to use.  Note that sometimes a work-around can be better.
5737 For example changing a time stamp is really only fun with `S-<cursor>'
5738 keys.  On a tty you would rather use `C-c .'  to re-insert the
5739 timestamp.
5741 Default     Alternative 1  Alternative 2
5742 `S-<TAB>'   `C-u <TAB>'    
5743 `M-<left>'  `C-c C-x l'    `<Esc> <left>'
5744 `M-S-<left>'`C-c C-x L'    
5745 `M-<right>' `C-c C-x r'    `<Esc>
5746                            <right>'
5747 `M-S-<right>'`C-c C-x R'    
5748 `M-<up>'    `C-c C-x u'    `<Esc> <up>'
5749 `M-S-<up>'  `C-c C-x U'    
5750 `M-<down>'  `C-c C-x d'    `<Esc> <down>'
5751 `M-S-<down>'`C-c C-x D'    
5752 `S-<RET>'   `C-c C-x c'    
5753 `M-<RET>'   `C-c C-x m'    `<Esc> <RET>'
5754 `M-S-<RET>' `C-c C-x M'    
5755 `S-<left>'  `C-c <left>'   
5756 `S-<right>' `C-c <right>'  
5757 `S-<up>'    `C-c <up>'     
5758 `S-<down>'  `C-c <down>'   
5759 `C-S-<left>'`C-c C-x       
5760             <left>'        
5761 `C-S-<right>'`C-c C-x       
5762             <right>'       
5764 \x1f
5765 File: org,  Node: Interaction,  Next: Bugs,  Prev: TTY keys,  Up: Miscellaneous
5767 12.7 Interaction with other packages
5768 ====================================
5770 Org-mode lives in the world of GNU Emacs and interacts in various ways
5771 with other code out there.
5773 * Menu:
5775 * Cooperation::                 Packages Org-mode cooperates with
5776 * Conflicts::                   Packages that lead to conflicts
5778 \x1f
5779 File: org,  Node: Cooperation,  Next: Conflicts,  Prev: Interaction,  Up: Interaction
5781 12.7.1 Packages that Org-mode cooperates with
5782 ---------------------------------------------
5784 `calc.el' by Dave Gillespie
5785      Org-mode uses the calc package for implementing spreadsheet
5786      functionality in its tables (*note The spreadsheet::).  Org-mode
5787      checks for the availability of calc by looking for the function
5788      `calc-eval' which should be autoloaded in your setup if calc has
5789      been installed properly.  As of Emacs 22, calc is part of the Emacs
5790      distribution.  Another possibility for interaction between the two
5791      packages is using calc for embedded calculations. *Note Embedded
5792      Mode: (calc)Embedded Mode.  
5794 `constants.el' by Carsten Dominik
5795      In a table formula (*note The spreadsheet::), it is possible to use
5796      names for natural constants or units.  Instead of defining your own
5797      constants in the variable `org-table-formula-constants', install
5798      the `constants' package which defines a large number of constants
5799      and units, and lets you use unit prefixes like `M' for `Mega' etc.
5800      You will need version 2.0 of this package, available at
5801      `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5802      function `constants-get', which has to be autoloaded in your
5803      setup.  See the installation instructions in the file
5804      `constants.el'.
5806 `cdlatex.el' by Carsten Dominik
5807      Org-mode can make use of the cdlatex package to efficiently enter
5808      LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5810 `remember.el' by John Wiegley
5811      Org mode cooperates with remember, see *Note Remember::.
5812      `Remember.el' is not part of Emacs, find it on the web.  
5814 `table.el' by Takaaki Ota
5815      Complex ASCII tables with automatic line wrapping, column- and
5816      row-spanning, and alignment can be created using the Emacs table
5817      package by Takaaki Ota (`http://sourceforge.net/projects/table',
5818      and also part of Emacs 22).  When <TAB> or `C-c C-c' is pressed in
5819      such a table, Org-mode will call `table-recognize-table' and move
5820      the cursor into the table.  Inside a table, the keymap of Org-mode
5821      is inactive.  In order to execute Org-mode-related commands, leave
5822      the table.
5824     `C-c C-c'
5825           Recognize `table.el' table.  Works when the cursor is in a
5826           table.el table.  
5828     `C-c ~'
5829           Insert a table.el table.  If there is already a table at
5830           point, this command converts it between the table.el format
5831           and the Org-mode format.  See the documentation string of the
5832           command `org-convert-table' for the restrictions under which
5833           this is possible.
5834      `table.el' is part of Emacs 22.  
5836 `footnote.el' by Steven L. Baur
5837      Org-mode recognizes numerical footnotes as provided by this package
5838      (*note Footnotes::).
5840 \x1f
5841 File: org,  Node: Conflicts,  Prev: Cooperation,  Up: Interaction
5843 12.7.2 Packages that lead to conflicts with Org-mode
5844 ----------------------------------------------------
5846 `allout.el' by Ken Manheimer
5847      Startup of Org-mode may fail with the error message
5848      `(wrong-type-argument keymapp nil)' when there is an outdated
5849      version `allout.el' on the load path, for example the version
5850      distributed with Emacs 21.x.  Upgrade to Emacs 22 and this problem
5851      will disappear.  If for some reason you cannot do this, make sure
5852      that org.el is loaded _before_ `allout.el', for example by putting
5853      `(require 'org)' early enough into your `.emacs' file.
5855 `CUA.el' by Kim. F. Storm
5856      Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5857      by CUA-mode (as well as pc-select-mode and s-region-mode) to
5858      select and extend the region.  If you want to use one of these
5859      packages along with Org-mode, configure the variable
5860      `org-CUA-compatible'.  When set, Org-mode will move the following
5861      keybindings in org-mode files, and in the agenda buffer (but not
5862      during date selection).
5864           S-UP    -> M-p             S-DOWN  -> M-n
5865           S-LEFT  -> M--             S-RIGHT -> M-+
5867      Yes, these are unfortunately more difficult to remember.  If you
5868      want to have other replacement keys, look at the variable
5869      `org-disputed-keys'.
5871 `windmove.el' by Hovav Shacham
5872      Also this package uses the `S-<cursor>' keys, so everything written
5873      in the paragraph above about CUA mode also applies here.
5875 `footnote.el' by Steven L. Baur
5876      Org-mode supports the syntax of the footnote package, but only the
5877      numerical footnote markers.  Also, the default key for footnote
5878      commands, `C-c !' is already used by org-mode.  You could use the
5879      variable `footnote-prefix' to switch footnotes commands to another
5880      key.  Or, you could use `org-replace-disputed-keys' and
5881      `org-disputed-keys' to change the settings in Org-mode.
5884 \x1f
5885 File: org,  Node: Bugs,  Prev: Interaction,  Up: Miscellaneous
5887 12.8 Bugs
5888 =========
5890 Here is a list of things that should work differently, but which I have
5891 found too hard to fix.
5893    * If a table field starts with a link, and if the corresponding table
5894      column is narrowed (*note Narrow columns::) to a width too small to
5895      display the link, the field would look entirely empty even though
5896      it is not.  To prevent this, Org-mode throws an error.  The
5897      work-around is to make the column wide enough to fit the link, or
5898      to add some text (at least 2 characters) before the link in the
5899      same field.
5901    * Narrowing table columns does not work on XEmacs, because the
5902      `format' function does not transport text properties.
5904    * Text in an entry protected with the `QUOTE' keyword should not
5905      autowrap.
5907    * When the application called by `C-c C-o' to open a file link fails
5908      (for example because the application does not exist or refuses to
5909      open the file), it does so silently.  No error message is
5910      displayed.
5912    * Recalculating a table line applies the formulas from left to right.
5913      If a formula uses _calculated_ fields further down the row,
5914      multiple recalculation may be needed to get all fields consistent.
5915      You may use the command `org-table-iterate' (`C-u C-c *') to
5916      recalculate until convergence.
5918    * A single letter cannot be made bold, for example `*a*'.
5920    * The exporters work well, but could be made more efficient.
5922 \x1f
5923 File: org,  Node: Extensions and Hacking,  Next: History and Acknowledgments,  Prev: Miscellaneous,  Up: Top
5925 Appendix A Extensions, Hooks and Hacking
5926 ****************************************
5928 This appendix lists extensions for Org-mode written by other authors.
5929 It also covers some aspects where users can extend the functionality of
5930 Org-mode.
5932 * Menu:
5934 * Extensions::                  Existing 3rd-part extensions
5935 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
5936 * Dynamic blocks::              Automatically filled blocks
5937 * Special agenda views::        Customized views
5939 \x1f
5940 File: org,  Node: Extensions,  Next: Tables in arbitrary syntax,  Prev: Extensions and Hacking,  Up: Extensions and Hacking
5942 A.1 Third-party extensions for Org-mode
5943 =======================================
5945 The following extensions for Org-mode have been written by other people:
5947 `org-publish.el' by David O'Toole
5948      This package provides facilities for publishing related sets of
5949      Org-mode files together with linked files like images as webpages.
5950      It is highly configurable and can be used for other publishing
5951      purposes as well.  As of Org-mode version 4.30, `org-publish.el'
5952      is part of the Org-mode distribution.  It is not yet part of
5953      Emacs, however, a delay caused by the preparations for the 22.1
5954      release.  In the mean time, `org-publish.el' can be downloaded
5955      from David's site: `http://dto.freeshell.org/e/org-publish.el'.  
5957 `org-mouse.el' by Piotr Zielinski
5958      This package implements extended mouse functionality for Org-mode.
5959      It allows you to cycle visibility and to edit the document
5960      structure with the mouse.  Best of all, it provides a
5961      context-sensitive menu on <mouse-3> that changes depending on the
5962      context of a mouse-click.  As of Org-mode version 4.53,
5963      `org-mouse.el' is part of the Org-mode distribution.  It is not
5964      yet part of Emacs, however, a delay caused by the preparations for
5965      the 22.1 release.  In the mean time, `org-mouse.el' can be
5966      downloaded from Piotr's site:
5967      `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.  
5969 `org-blog.el' by David O'Toole
5970      A blogging plug-in for `org-publish.el'.
5971      `http://dto.freeshell.org/notebook/OrgMode.html'.  
5973 `blorg.el' by Bastien Guerry
5974      Publish Org-mode files as blogs.
5975      `http://www.cognition.ens.fr/~guerry/blorg.html'.  
5977 `org2rem.el' by Bastien Guerry
5978      Translates Org-mode files into something readable by Remind.
5979      `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
5981 \x1f
5982 File: org,  Node: Tables in arbitrary syntax,  Next: Dynamic blocks,  Prev: Extensions,  Up: Extensions and Hacking
5984 A.2 Tables in arbitrary syntax
5985 ==============================
5987 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
5988 frequent feature request has been to make it work with native tables in
5989 specific languages, for example LaTeX.  However, this is extremely hard
5990 to do in a general way, would lead to a customization nightmare, and
5991 would take away much of the simplicity of the Orgtbl-mode table editor.
5993    This appendix describes a different approach.  We keep the
5994 Orgtbl-mode table in its native format (the source table), and use a
5995 custom function to translate the table to the correct syntax, and to
5996 install it in the right location (the target table).  This puts the
5997 burden of writing conversion functions on the user, but it allows for a
5998 very flexible system.
6000 * Menu:
6002 * Radio tables::                Sending and receiving
6003 * A LaTeX example::             Step by step, almost a tutorial
6004 * Translator functions::        Copy and modify
6006 \x1f
6007 File: org,  Node: Radio tables,  Next: A LaTeX example,  Prev: Tables in arbitrary syntax,  Up: Tables in arbitrary syntax
6009 A.2.1 Radio tables
6010 ------------------
6012 To define the location of the target table, you first need to create two
6013 lines that are comments in the current mode, but contain magic words for
6014 Orgtbl-mode to find.  Orgtbl-mode will insert the translated table
6015 between these lines, replacing whatever was there before.  For example:
6017      /* BEGIN RECEIVE ORGTBL table_name */
6018      /* END RECEIVE ORGTBL table_name */
6020 Just above the source table, we put a special line that tells
6021 Orgtbl-mode how to translate this table and where to install it.  For
6022 example:
6023      #+ORGTBL: SEND table_name translation_function arguments....
6025 `table_name' is the reference name for the table that is also used in
6026 the receiver lines. `translation_function' is the Lisp function that
6027 does the translation.  Furthermore, the line can contain a list of
6028 arguments (alternating key and value) at the end.  The arguments will be
6029 passed as a property list to the translation function for
6030 interpretation.  A few standard parameters are already recognized and
6031 acted upon before the translation function is called:
6033 `:skip N'
6034      Skip the first N lines of the table. Hlines do count!
6036 `:skipcols (n1 n2 ...)'
6037      List of columns that should be skipped.  If the table has a column
6038      with calculation marks, that column is automatically discarded as
6039      well.  Please note that the translator function sees the table
6040      _after_ the removal of these columns, the function never knows
6041      that there have been additional columns.
6043 The one problem remaining is how to keep the source table in the buffer
6044 without disturbing the normal workings of the file, for example during
6045 compilation of a C file or processing of a LaTeX file.  There are a
6046 number of different solutions:
6048    * The table could be placed in a block comment if that is supported
6049      by the language.  For example, in C-mode you could wrap the table
6050      between `/*' and `*/' lines.
6052    * Sometimes it is possible to put the table after some kind of END
6053      statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
6055    * You can just comment the table line by line whenever you want to
6056      process the file, and uncomment it whenever you need to edit the
6057      table.  This only sounds tedious - the command `M-x
6058      orgtbl-toggle-comment' does make this comment-toggling very easy,
6059      in particular if you bind it to a key.
6061 \x1f
6062 File: org,  Node: A LaTeX example,  Next: Translator functions,  Prev: Radio tables,  Up: Tables in arbitrary syntax
6064 A.2.2 A LaTeX example
6065 ---------------------
6067 The best way to wrap the source table in LaTeX is to use the `comment'
6068 environment provided by `comment.sty'.  It has to be activated by
6069 placing `\usepackage{comment}' into the document header.  Orgtbl-mode
6070 can insert a radio table skeleton(1)  with the command `M-x
6071 orgtbl-insert-radio-table'.  You will be prompted for a table name,
6072 lets say we use `salesfigures'.  You will then get the following
6073 template:
6075      % BEGIN RECEIVE ORGTBL salesfigures
6076      % END RECEIVE ORGTBL salesfigures
6077      \begin{comment}
6078      #+ORGTBL: SEND salesfigures orgtbl-to-latex
6079      | | |
6080      \end{comment}
6082 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
6083 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
6084 the receiver location with name `salesfigures'.  You may now fill in
6085 the table, feel free to use the spreadsheet features(2):
6087      % BEGIN RECEIVE ORGTBL salesfigures
6088      % END RECEIVE ORGTBL salesfigures
6089      \begin{comment}
6090      #+ORGTBL: SEND salesfigures orgtbl-to-latex
6091      | Month | Days | Nr sold | per day |
6092      |-------+------+---------+---------|
6093      | Jan   |   23 |      55 |     2.4 |
6094      | Feb   |   21 |      16 |     0.8 |
6095      | March |   22 |     278 |    12.6 |
6096      #+TBLFM: $4=$3/$2;%.1f
6097      % $ (optional extra dollar to keep font-lock happy, see footnote)
6098      \end{comment}
6100 When you are done, press `C-c C-c' in the table to get the converted
6101 table inserted between the two marker lines.
6103    Now lets assume you want to make the table header by hand, because
6104 you want to control how columns are aligned etc.  In this case we make
6105 sure that the table translator does skip the first 2 lines of the source
6106 table, and tell the command to work as a splice, i.e. to not produce
6107 header and footer commands of the target table:
6109      \begin{tabular}{lrrr}
6110      Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
6111      % BEGIN RECEIVE ORGTBL salesfigures
6112      % END RECEIVE ORGTBL salesfigures
6113      \end{tabular}
6114      %
6115      \begin{comment}
6116      #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
6117      | Month | Days | Nr sold | per day |
6118      |-------+------+---------+---------|
6119      | Jan   |   23 |      55 |     2.4 |
6120      | Feb   |   21 |      16 |     0.8 |
6121      | March |   22 |     278 |    12.6 |
6122      #+TBLFM: $4=$3/$2;%.1f
6123      \end{comment}
6125    The LaTeX translator function `orgtbl-to-latex' is already part of
6126 Orgtbl-mode.  It uses a `tabular' environment to typeset the table and
6127 marks horizontal lines with `\hline'.  Furthermore, it interprets the
6128 following parameters:
6130 `:splice nil/t'
6131      When set to t, return only table body lines, don't wrap them into a
6132      tabular environment.  Default is nil.
6134 `:fmt fmt'
6135      A format to be used to wrap each field, should contain `%s' for the
6136      original field value.  For example, to wrap each field value in
6137      dollars, you could use `:fmt "$%s$"'.  This may also be a property
6138      list with column numbers and formats. for example `:fmt (2 "$%s$"
6139      4 "%s\\%%")'.
6141 `:efmt efmt'
6142      Use this format to print numbers with exponentials.  The format
6143      should have `%s' twice for inserting mantissa and exponent, for
6144      example `"%s\\times10^{%s}"'.  The default is `"%s\\,(%s)"'.  This
6145      may also be a property list with column numbers and formats, for
6146      example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
6147      After `efmt' has been applied to a value, `fmt' will also be
6148      applied.
6150    ---------- Footnotes ----------
6152    (1) By default this works only for LaTeX, HTML, and TeXInfo.
6153 Configure the variable `orgtbl-radio-tables' to install templates for
6154 other modes.
6156    (2) If the `#+TBLFM' line contains an odd number of dollar
6157 characters, this may cause problems with font-lock in latex-mode.  As
6158 shown in the example you can fix this by adding an extra line inside the
6159 `comment' environment that is used to balance the dollar expressions.
6160 If you are using AUCTeX with the font-latex library, a much better
6161 solution is to add the `comment' environment to the variable
6162 `LaTeX-verbatim-environments'.
6164 \x1f
6165 File: org,  Node: Translator functions,  Prev: A LaTeX example,  Up: Tables in arbitrary syntax
6167 A.2.3 Translator functions
6168 --------------------------
6170 Orgtbl-mode has several translator functions built-in:
6171 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'.  Except
6172 for `orgtbl-to-html'(1), these all use a generic translator,
6173 `orgtbl-to-generic'.  For example, `orgtbl-to-latex' itself is a very
6174 short function that computes the column definitions for the `tabular'
6175 environment, defines a few field and line separators and then hands
6176 over to the generic translator.  Here is the entire code:
6178      (defun orgtbl-to-latex (table params)
6179        "Convert the orgtbl-mode TABLE to LaTeX."
6180        (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
6181                                     org-table-last-alignment ""))
6182               (params2
6183                (list
6184                 :tstart (concat "\\begin{tabular}{" alignment "}")
6185                 :tend "\\end{tabular}"
6186                 :lstart "" :lend " \\\\" :sep " & "
6187                 :efmt "%s\\,(%s)" :hline "\\hline")))
6188          (orgtbl-to-generic table (org-combine-plists params2 params))))
6190    As you can see, the properties passed into the function (variable
6191 PARAMS) are combined with the ones newly defined in the function
6192 (variable PARAMS2).  The ones passed into the function (i.e. the ones
6193 set by the `ORGTBL SEND' line) take precedence.  So if you would like
6194 to use the LaTeX translator, but wanted the line endings to be
6195 `\\[2mm]' instead of the default `\\', you could just overrule the
6196 default with
6198      #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
6200    For a new language, you can either write your own converter function
6201 in analogy with the LaTeX translator, or you can use the generic
6202 function directly.  For example, if you have a language where a table
6203 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
6204 started with `!BL!', ended with `!EL!' and where the field separator is
6205 a TAB, you could call the generic translator like this (on a single
6206 line!):
6208      #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
6209                                    :lstart "!BL! " :lend " !EL!" :sep "\t"
6211 Please check the documentation string of the function
6212 `orgtbl-to-generic' for a full list of parameters understood by that
6213 function and remember that you can pass each of them into
6214 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
6215 the generic function.
6217    Of course you can also write a completely new function doing
6218 complicated things the generic translator cannot do.  A translator
6219 function takes two arguments.  The first argument is the table, a list
6220 of lines, each line either the symbol `hline' or a list of fields.  The
6221 second argument is the property list containing all parameters
6222 specified in the `#+ORGTBL: SEND' line.  The function must return a
6223 single string containing the formatted table.  If you write a generally
6224 useful translator, please post it on `emacs-orgmode@gnu.org' so that
6225 others can benefit from your work.
6227    ---------- Footnotes ----------
6229    (1) The HTML translator uses the same code that produces tables
6230 during HTML export.
6232 \x1f
6233 File: org,  Node: Dynamic blocks,  Next: Special agenda views,  Prev: Tables in arbitrary syntax,  Up: Extensions and Hacking
6235 A.3 Dynamic blocks
6236 ==================
6238 Org-mode documents can contain _dynamic blocks_.  These are specially
6239 marked regions that are updated by some user-written function.  A good
6240 example for such a block is the clock table inserted by the command
6241 `C-c C-x C-r' (*note Clocking work time::).
6243    Dynamic block are enclosed by a BEGIN-END structure that assigns a
6244 name to the block and can also specify parameters for the function
6245 producing the content of the block.
6247      #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
6249      #+END:
6251    Dynamic blocks are updated with the following commands
6253 `C-c C-x C-u'
6254      Update dynamic block at point.  
6256 `C-u C-c C-x C-u'
6257      Update all dynamic blocks in the current file.
6259    Updating a dynamic block means to remove all the text between BEGIN
6260 and END, parse the BEGIN line for parameters and then call the specific
6261 writer function for this block to insert the new content.  For a block
6262 with name `myblock', the writer function is `org-dblock-write:myblock'
6263 with as only parameter a property list with the parameters given in the
6264 begin line.  Here is a trivial example of a block that keeps track of
6265 when the block update function was last run:
6267      #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
6269      #+END:
6271 The corresponding block writer function could look like this:
6273      (defun org-dblock-write:block-update-time (params)
6274         (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
6275           (insert "Last block update at: "
6276                   (format-time-string fmt (current-time)))))
6278    If you want to make sure that all dynamic blocks are always
6279 up-to-date, you could add the function `org-update-all-dblocks' to a
6280 hook, for example `before-save-hook'.  `org-update-all-dblocks' is
6281 written in a way that is does nothing in buffers that are not in
6282 Org-mode.
6284 \x1f
6285 File: org,  Node: Special agenda views,  Prev: Dynamic blocks,  Up: Extensions and Hacking
6287 A.4 Special Agenda Views
6288 ========================
6290 Org-mode provides a special hook that can be used to narrow down the
6291 selection made by any of the agenda views.  You may specify a function
6292 that is used at each match to verify if the match should indeed be part
6293 of the agenda view, and if not, how much should be skipped.
6295    Let's say you want to produce a list of projects that contain a
6296 WAITING tag anywhere in the project tree.  Let's further assume that
6297 you have marked all tree headings that define a project with the todo
6298 keyword PROJECT.  In this case you would run a todo search for the
6299 keyword PROJECT, but skip the match unless there is a WAITING tag
6300 anywhere in the subtree belonging to the project line.
6302    To achieve this, you must write a function that searches the subtree
6303 for the tag.  If the tag is found, the function must return `nil' to
6304 indicate that this match should not be skipped.  If there is no such
6305 tag, return the location of the end of the subtree, to indicate that
6306 search should continue from there.
6308      (defun my-skip-unless-waiting ()
6309        "Skip trees that are not waiting"
6310        (let ((subtree-end (save-excursion (org-end-of-subtree t))))
6311          (if (re-search-forward ":WAITING:" subtree-end t)
6312              nil          ; tag found, do not skip
6313            subtree-end))) ; tag not found, continue after end of subtree
6315    Furthermore you must write a command that uses `let' to temporarily
6316 put this function into the variable `org-agenda-skip-function', sets
6317 the header string for the agenda buffer, and calls the todo-list
6318 generator while asking for the specific TODO keyword PROJECT.  The
6319 function must also accept one argument MATCH, but it can choose to
6320 ignore it(1) (as we do in the example below).  Here is the example:
6322      (defun my-org-waiting-projects (&optional match)
6323        "Produce a list of projects that contain a WAITING tag.
6324      MATCH is being ignored."
6325        (interactive)
6326        (let ((org-agenda-skip-function 'my-skip-unless-waiting)
6327              (org-agenda-overriding-header "Projects waiting for something: "))
6328          ;; make the list
6329          (org-todo-list "PROJECT")))
6331    ---------- Footnotes ----------
6333    (1) MATCH must be present in case you want to define a custom
6334 command for producing this special list.  Custom commands always supply
6335 the MATCH argument, but it can be empty if you do not specify it while
6336 defining the command(*note Custom agenda views::).
6338 \x1f
6339 File: org,  Node: History and Acknowledgments,  Next: Index,  Prev: Extensions and Hacking,  Up: Top
6341 Appendix B History and Acknowledgments
6342 **************************************
6344 Org-mode was borne in 2003, out of frustration over the user interface
6345 of the Emacs outline-mode.  I was trying to organize my notes and
6346 projects, and using Emacs seemed to be the natural way to go.  However,
6347 having to remember eleven different commands with two or three keys per
6348 command, only to hide and unhide parts of the outline tree, that seemed
6349 entirely unacceptable to me.  Also, when using outlines to take notes, I
6350 constantly want to restructure the tree, organizing it parallel to my
6351 thoughts and plans.  _Visibility cycling_ and _structure editing_ were
6352 originally implemented in the package `outline-magic.el', but quickly
6353 moved to the more general `org.el'.  As this environment became
6354 comfortable for project planning, the next step was adding _TODO
6355 entries_, basic _time stamps_, and _table support_.  These areas
6356 highlight the two main goals that Org-mode still has today: To create a
6357 new, outline-based, plain text mode with innovative and intuitive
6358 editing features, and to incorporate project planning functionality
6359 directly into a notes file.
6361    Since the first release, hundreds of emails to me or on
6362 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
6363 feedback, new ideas, and sometimes patches and add-on code.  Many
6364 thanks to everyone who has helped to improve this package.  I am trying
6365 to keep here a list of the people who had significant influence in
6366 shaping one or more aspects of Org-mode.  The list may not be complete,
6367 if I have forgotten someone, please accept my apologies and let me know.
6369    * Thomas Baumann contributed the code for links to the MH-E email
6370      system.
6372    * Alex Bochannek provided a patch for rounding time stamps.
6374    * Charles Cave's suggestion sparked the implementation of templates
6375      for Remember.
6377    * Pavel Chalmoviansky influenced the agenda treatment of items with
6378      specified time.
6380    * Gregory Chernov patched support for lisp forms into table
6381      calculations and improved XEmacs compatibility, in particular by
6382      porting `nouline.el' to XEmacs.
6384    * Sacha Chua suggested to copy some linking code from Planner.
6386    * Eddward DeVilla proposed and tested checkbox statistics.
6388    * Kees Dullemond used to edit projects lists directly in HTML and so
6389      inspired some of the early development, including HTML export.  He
6390      also asked for a way to narrow wide table columns.
6392    * Christian Egli converted the documentation into TeXInfo format,
6393      patched CSS formatting into the HTML exporter, and inspired the
6394      agenda.
6396    * David Emery provided a patch for custom CSS support in exported
6397      HTML agendas.
6399    * Nic Ferrier contributed mailcap and XOXO support.
6401    * John Foerch figured out how to make incremental search show context
6402      around a match in a hidden outline tree.
6404    * Niels Giessen had the idea to automatically archive DONE trees.
6406    * Bastien Guerry provided extensive feedback and some patches, and
6407      translated David O'Toole's tutorial into French.
6409    * Kai Grossjohann pointed out key-binding conflicts with other
6410      packages.
6412    * Shidai Liu ("Leo") asked for embedded LaTeX and tested it.  He also
6413      provided frequent feedback and some patches.
6415    * Jason F. McBrayer suggested agenda export to CSV format.
6417    * Dmitri Minaev sent a patch to set priority limits on a per-file
6418      basis.
6420    * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
6421      happy.
6423    * Rick Moynihan proposed to allow multiple TODO sequences in a file.
6425    * Todd Neal provided patches for links to Info files and elisp forms.
6427    * Tim O'Callaghan suggested in-file links, search options for general
6428      file links, and TAGS.
6430    * Takeshi Okano translated the manual and David O'Toole's tutorial
6431      into Japanese.
6433    * Oliver Oppitz suggested multi-state TODO items.
6435    * Scott Otterson sparked the introduction of descriptive text for
6436      links, among other things.
6438    * Pete Phillips helped during the development of the TAGS feature,
6439      and provided frequent feedback.
6441    * T.V. Raman reported bugs and suggested improvements.
6443    * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
6444      control.
6446    * Kevin Rogers contributed code to access VM files on remote hosts.
6448    * Frank Ruell solved the mystery of the `keymapp nil' bug, a
6449      conflict with `allout.el'.
6451    * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
6453    * Philip Rooke created the Org-mode reference card and provided lots
6454      of feedback.
6456    * Christian Schlauer proposed angular brackets around links, among
6457      other things.
6459    * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
6460      `organizer-mode.el'.
6462    * Daniel Sinder came up with the idea of internal archiving by
6463      locking subtrees.
6465    * Dale Smith proposed link abbreviations.
6467    * David O'Toole wrote `org-publish.el' and drafted the manual
6468      chapter about publishing.
6470    * Ju"rgen Vollmer contributed code generating the table of contents
6471      in HTML output.
6473    * Chris Wallace provided a patch implementing the `QUOTE' keyword.
6475    * David Wainberg suggested archiving, and improvements to the linking
6476      system.
6478    * John Wiegley wrote `emacs-wiki.el' and `planner.el'.  The
6479      development of Org-mode was fully independent, and both systems are
6480      really different beasts in their basic ideas and implementation
6481      details.  I later looked at John's code, however, and learned from
6482      his implementation of (i) links where the link itself is hidden
6483      and only a description is shown, and (ii) popping up a calendar to
6484      select a date.
6486    * Carsten Wimmer suggested some changes and helped fix a bug in
6487      linking to GNUS.
6489    * Roland Winkler requested additional keybindings to make Org-mode
6490      work on a tty.
6492    * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
6493      contributed various ideas and code snippets.
6495 \x1f
6496 File: org,  Node: Index,  Next: Key Index,  Prev: History and Acknowledgments,  Up: Top
6498 Index
6499 *****
6501 \0\b[index\0\b]
6502 * Menu:
6504 * abbreviation, links:                   Link abbreviations.  (line   6)
6505 * acknowledgments:                       History and Acknowledgments.
6506                                                               (line   6)
6507 * action, for publishing:                Publishing action.   (line   6)
6508 * activation:                            Activation.          (line   6)
6509 * active region <1>:                     Export commands.     (line   6)
6510 * active region <2>:                     ASCII export.        (line   9)
6511 * active region <3>:                     Built-in table editor.
6512                                                               (line 141)
6513 * active region:                         Structure editing.   (line  64)
6514 * agenda:                                Weekly/Daily agenda. (line   6)
6515 * agenda dispatcher:                     Agenda dispatcher.   (line   6)
6516 * agenda files:                          Agenda files.        (line   6)
6517 * agenda files, removing buffers:        Agenda commands.     (line 239)
6518 * agenda views:                          Agenda views.        (line   6)
6519 * agenda views, custom:                  Custom agenda views. (line   6)
6520 * agenda views, exporting <1>:           Exporting Agenda Views.
6521                                                               (line   6)
6522 * agenda views, exporting:               Agenda commands.     (line 228)
6523 * agenda views, user-defined:            Special agenda views.
6524                                                               (line   6)
6525 * agenda, pipe:                          Extracting Agenda Information for other programs.
6526                                                               (line   6)
6527 * agenda, with block views:              Block agenda.        (line   6)
6528 * align, STARTUP keyword:                In-buffer settings.  (line  29)
6529 * allout.el:                             Conflicts.           (line   6)
6530 * angular brackets, around links:        External links.      (line  43)
6531 * archive locations:                     Moving subtrees.     (line  21)
6532 * archiving:                             Archiving.           (line   6)
6533 * ASCII export:                          ASCII export.        (line   6)
6534 * author:                                Feedback.            (line   6)
6535 * autoload:                              Activation.          (line   6)
6536 * backtrace of an error:                 Feedback.            (line  27)
6537 * BBDB links:                            External links.      (line   6)
6538 * block agenda:                          Block agenda.        (line   6)
6539 * blorg.el:                              Extensions.          (line  32)
6540 * bold text:                             Enhancing text.      (line  15)
6541 * Boolean logic, for tag searches:       Tag searches.        (line  23)
6542 * bug reports:                           Feedback.            (line   6)
6543 * bugs:                                  Bugs.                (line   6)
6544 * C-c C-c, overview:                     The very busy C-c C-c key.
6545                                                               (line   6)
6546 * calc package:                          The spreadsheet.     (line   6)
6547 * calc.el:                               Cooperation.         (line   6)
6548 * calculations, in tables <1>:           The spreadsheet.     (line   6)
6549 * calculations, in tables:               Built-in table editor.
6550                                                               (line 141)
6551 * calendar commands, from agenda:        Agenda commands.     (line 191)
6552 * calendar integration:                  Weekly/Daily agenda. (line  24)
6553 * calendar, for selecting date:          The date/time prompt.
6554                                                               (line  26)
6555 * category:                              Categories.          (line   6)
6556 * CDLaTeX:                               CDLaTeX mode.        (line   6)
6557 * cdlatex.el:                            Cooperation.         (line  29)
6558 * checkbox statistics:                   Checkboxes.          (line  23)
6559 * checkboxes:                            Checkboxes.          (line   6)
6560 * children, subtree visibility state:    Visibility cycling.  (line  10)
6561 * clean outline view:                    Clean view.          (line   6)
6562 * column formula:                        Column formulas.     (line   6)
6563 * commands, in agenda buffer:            Agenda commands.     (line   6)
6564 * comment lines:                         Comment lines.       (line   6)
6565 * completion, of dictionary words:       Completion.          (line   6)
6566 * completion, of file names:             Handling links.      (line  43)
6567 * completion, of link abbreviations:     Completion.          (line   6)
6568 * completion, of links:                  Handling links.      (line  25)
6569 * completion, of option keywords <1>:    Completion.          (line   6)
6570 * completion, of option keywords <2>:    Export options.      (line   6)
6571 * completion, of option keywords:        Per file keywords.   (line  23)
6572 * completion, of tags <1>:               Completion.          (line   6)
6573 * completion, of tags:                   Setting tags.        (line  11)
6574 * completion, of TeX symbols:            Completion.          (line   6)
6575 * completion, of TODO keywords <1>:      Completion.          (line   6)
6576 * completion, of TODO keywords:          Workflow states.     (line  15)
6577 * constants, in calculations:            References.          (line  82)
6578 * constants.el:                          Cooperation.         (line  14)
6579 * constcgs, STARTUP keyword:             In-buffer settings.  (line  54)
6580 * constSI, STARTUP keyword:              In-buffer settings.  (line  54)
6581 * content, STARTUP keyword:              In-buffer settings.  (line  22)
6582 * contents, global visibility state:     Visibility cycling.  (line  22)
6583 * copying, of subtrees:                  Structure editing.   (line   6)
6584 * creating timestamps:                   Creating timestamps. (line   6)
6585 * CUA.el:                                Conflicts.           (line  15)
6586 * custom agenda views:                   Custom agenda views. (line   6)
6587 * custom date/time format:               Custom time format.  (line   6)
6588 * custom search strings:                 Custom searches.     (line   6)
6589 * customization:                         Customization.       (line   6)
6590 * customtime, STARTUP keyword:           In-buffer settings.  (line  51)
6591 * cutting, of subtrees:                  Structure editing.   (line   6)
6592 * cycling, of TODO states:               TODO basics.         (line  13)
6593 * cycling, visibility:                   Visibility cycling.  (line   6)
6594 * daily agenda:                          Weekly/Daily agenda. (line   6)
6595 * date format, custom:                   Custom time format.  (line   6)
6596 * date range:                            Time stamps.         (line  40)
6597 * date stamps <1>:                       Time stamps.         (line   6)
6598 * date stamps:                           Timestamps.          (line   6)
6599 * date, reading in minibuffer:           The date/time prompt.
6600                                                               (line   6)
6601 * DEADLINE keyword:                      Deadlines and scheduling.
6602                                                               (line  10)
6603 * deadlines:                             Time stamps.         (line   6)
6604 * debugging, of table formulas:          Editing and debugging formulas.
6605                                                               (line  97)
6606 * demotion, of subtrees:                 Structure editing.   (line   6)
6607 * diary entries, creating from agenda:   Agenda commands.     (line 196)
6608 * diary integration:                     Weekly/Daily agenda. (line  24)
6609 * dictionary word completion:            Completion.          (line   6)
6610 * directories, for publishing:           Sources and destinations.
6611                                                               (line   6)
6612 * dispatching agenda commands:           Agenda dispatcher.   (line   6)
6613 * display changing, in agenda:           Agenda commands.     (line  65)
6614 * document structure:                    Document structure.  (line   6)
6615 * DONE, final TODO keyword:              Per file keywords.   (line  26)
6616 * dynamic blocks:                        Dynamic blocks.      (line   6)
6617 * editing tables:                        Tables.              (line   6)
6618 * editing, of table formulas:            Editing and debugging formulas.
6619                                                               (line   6)
6620 * elisp links:                           External links.      (line   6)
6621 * emphasized text:                       Export options.      (line  25)
6622 * enhancing text:                        Enhancing text.      (line   6)
6623 * evaluate time range:                   Creating timestamps. (line  48)
6624 * even, STARTUP keyword:                 In-buffer settings.  (line  44)
6625 * exporting:                             Exporting.           (line   6)
6626 * exporting agenda views <1>:            Exporting Agenda Views.
6627                                                               (line  12)
6628 * exporting agenda views:                Agenda commands.     (line 228)
6629 * exporting, not:                        Comment lines.       (line   6)
6630 * extended TODO keywords:                TODO extensions.     (line   6)
6631 * extension, third-party:                Extensions.          (line   6)
6632 * external archiving:                    Moving subtrees.     (line   6)
6633 * external links:                        External links.      (line   6)
6634 * external links, in HTML export:        Links.               (line   6)
6635 * FAQ:                                   Summary.             (line  53)
6636 * feedback:                              Feedback.            (line   6)
6637 * field formula:                         Field formulas.      (line   6)
6638 * field references:                      References.          (line  15)
6639 * file links:                            External links.      (line   6)
6640 * file links, searching:                 Search options.      (line   6)
6641 * file name completion:                  Handling links.      (line  43)
6642 * files for agenda:                      Agenda files.        (line   6)
6643 * files, adding to agenda list:          Agenda files.        (line  12)
6644 * files, selecting for publishing:       Selecting files.     (line   6)
6645 * fixed width:                           Enhancing text.      (line  28)
6646 * fixed-width sections:                  Export options.      (line  25)
6647 * folded, subtree visibility state:      Visibility cycling.  (line  10)
6648 * folding, sparse trees:                 Sparse trees.        (line   6)
6649 * following links:                       Handling links.      (line  58)
6650 * footnote.el <1>:                       Conflicts.           (line  35)
6651 * footnote.el <2>:                       Cooperation.         (line  56)
6652 * footnote.el:                           Footnotes.           (line   6)
6653 * footnotes:                             Footnotes.           (line   6)
6654 * format specifier:                      Formula syntax for Calc.
6655                                                               (line  14)
6656 * format, of links:                      Link format.         (line   6)
6657 * formula debugging:                     Editing and debugging formulas.
6658                                                               (line  97)
6659 * formula editing:                       Editing and debugging formulas.
6660                                                               (line   6)
6661 * formula syntax, Calc:                  Formula syntax for Calc.
6662                                                               (line   6)
6663 * formula, for individual table field:   Field formulas.      (line   6)
6664 * formula, for table column:             Column formulas.     (line   6)
6665 * formula, in tables:                    Built-in table editor.
6666                                                               (line 141)
6667 * global cycling:                        Visibility cycling.  (line  22)
6668 * global keybindings:                    Activation.          (line   6)
6669 * global TODO list:                      Global TODO list.    (line   6)
6670 * global visibility states:              Visibility cycling.  (line  22)
6671 * GNUS links:                            External links.      (line   6)
6672 * hand-formatted lists:                  Enhancing text.      (line  11)
6673 * headline levels:                       Export options.      (line  25)
6674 * headline levels, for exporting <1>:    Export commands.     (line  34)
6675 * headline levels, for exporting:        ASCII export.        (line  18)
6676 * headline navigation:                   Motion.              (line   6)
6677 * headline tagging:                      Tags.                (line   6)
6678 * headline, promotion and demotion:      Structure editing.   (line   6)
6679 * headlines:                             Headlines.           (line   6)
6680 * hide text:                             Visibility cycling.  (line   6)
6681 * hidestars, STARTUP keyword:            In-buffer settings.  (line  44)
6682 * hiding leading stars:                  Clean view.          (line   6)
6683 * history:                               History and Acknowledgments.
6684                                                               (line   6)
6685 * horizontal rules, in exported files:   Enhancing text.      (line  18)
6686 * HTML export:                           HTML export.         (line   6)
6687 * HTML, and orgtbl-mode:                 Translator functions.
6688                                                               (line   6)
6689 * hyperlinks:                            Hyperlinks.          (line   6)
6690 * iCalendar export:                      iCalendar export.    (line   6)
6691 * images, inline in HTML:                Images.              (line   6)
6692 * in-buffer settings:                    In-buffer settings.  (line   6)
6693 * inactive timestamp:                    Time stamps.         (line  49)
6694 * index, of published pages:             Project page index.  (line   6)
6695 * Info links:                            External links.      (line   6)
6696 * inheritance, of tags:                  Tag inheritance.     (line   6)
6697 * inlining images in HTML:               Images.              (line   6)
6698 * inserting links:                       Handling links.      (line  25)
6699 * installation:                          Installation.        (line   6)
6700 * internal archiving:                    ARCHIVE tag.         (line   6)
6701 * internal links:                        Internal links.      (line   6)
6702 * internal links, in HTML export:        Links.               (line   6)
6703 * introduction:                          Introduction.        (line   6)
6704 * italic text:                           Enhancing text.      (line  15)
6705 * jumping, to headlines:                 Motion.              (line   6)
6706 * keybindings, global:                   Activation.          (line   6)
6707 * keyword options:                       Per file keywords.   (line   6)
6708 * LaTeX fragments <1>:                   Export options.      (line  25)
6709 * LaTeX fragments:                       LaTeX fragments.     (line   6)
6710 * LaTeX fragments, export:               Enhancing text.      (line  21)
6711 * LaTeX fragments, preview:              Processing LaTeX fragments.
6712                                                               (line   6)
6713 * LaTeX interpretation:                  Embedded LaTeX.      (line   6)
6714 * LaTeX, and orgtbl-mode:                A LaTeX example.     (line   6)
6715 * level, require for tags match:         Tag searches.        (line  68)
6716 * linebreak preservation:                Export options.      (line  25)
6717 * linebreak, forced:                     Enhancing text.      (line  35)
6718 * link abbreviations:                    Link abbreviations.  (line   6)
6719 * link abbreviations, completion of:     Completion.          (line   6)
6720 * link completion:                       Handling links.      (line  25)
6721 * link format:                           Link format.         (line   6)
6722 * links, external:                       External links.      (line   6)
6723 * links, finding next/previous:          Handling links.      (line  91)
6724 * links, handling:                       Handling links.      (line   6)
6725 * links, in HTML export:                 Links.               (line   6)
6726 * links, internal:                       Internal links.      (line   6)
6727 * links, publishing:                     Publishing links.    (line   6)
6728 * links, radio targets:                  Radio targets.       (line   6)
6729 * links, returning to:                   Handling links.      (line  85)
6730 * Lisp forms, as table formulas:         Formula syntax for Lisp.
6731                                                               (line   6)
6732 * lists, hand-formatted:                 Enhancing text.      (line  11)
6733 * lists, ordered:                        Plain lists.         (line   6)
6734 * lists, plain:                          Plain lists.         (line   6)
6735 * logdone, STARTUP keyword:              In-buffer settings.  (line  33)
6736 * logging, of progress:                  Progress logging.    (line   6)
6737 * lognoteclock-out, STARTUP keyword:     In-buffer settings.  (line  33)
6738 * lognotedone, STARTUP keyword:          In-buffer settings.  (line  33)
6739 * lognotestate, STARTUP keyword:         In-buffer settings.  (line  33)
6740 * logrepeat, STARTUP keyword:            In-buffer settings.  (line  33)
6741 * maintainer:                            Feedback.            (line   6)
6742 * mark ring:                             Handling links.      (line  81)
6743 * marking characters, tables:            Advanced features.   (line  40)
6744 * matching, of tags:                     Matching headline tags.
6745                                                               (line   6)
6746 * matching, tags:                        Tags.                (line   6)
6747 * math symbols:                          Math symbols.        (line   6)
6748 * MH-E links:                            External links.      (line   6)
6749 * minor mode for tables:                 orgtbl-mode.         (line   6)
6750 * mode, for calc:                        Formula syntax for Calc.
6751                                                               (line  14)
6752 * motion commands in agenda:             Agenda commands.     (line  19)
6753 * motion, between headlines:             Motion.              (line   6)
6754 * name, of column or field:              References.          (line  82)
6755 * named references:                      References.          (line  82)
6756 * names as TODO keywords:                TODO types.          (line   6)
6757 * narrow columns in tables:              Narrow columns.      (line   6)
6758 * noalign, STARTUP keyword:              In-buffer settings.  (line  29)
6759 * nologging, STARTUP keyword:            In-buffer settings.  (line  33)
6760 * nologrepeat, STARTUP keyword:          In-buffer settings.  (line  33)
6761 * occur, command:                        Sparse trees.        (line   6)
6762 * odd, STARTUP keyword:                  In-buffer settings.  (line  44)
6763 * option keyword completion:             Completion.          (line   6)
6764 * options, for custom agenda views:      Setting Options.     (line   6)
6765 * options, for customization:            Customization.       (line   6)
6766 * options, for export:                   Export options.      (line   6)
6767 * options, for publishing:               Publishing options.  (line   6)
6768 * ordered lists:                         Plain lists.         (line   6)
6769 * org-agenda, command:                   Weekly/Daily agenda. (line   9)
6770 * org-blog.el:                           Extensions.          (line  28)
6771 * org-mode, turning on:                  Activation.          (line  22)
6772 * org-mouse.el:                          Extensions.          (line  16)
6773 * org-publish-project-alist:             Project alist.       (line   6)
6774 * org-publish.el:                        Extensions.          (line   8)
6775 * org2rem.el:                            Extensions.          (line  36)
6776 * orgtbl-mode <1>:                       Tables in arbitrary syntax.
6777                                                               (line   6)
6778 * orgtbl-mode:                           orgtbl-mode.         (line   6)
6779 * outline tree:                          Headlines.           (line   6)
6780 * outline-mode:                          Outlines.            (line   6)
6781 * outlines:                              Outlines.            (line   6)
6782 * overview, global visibility state:     Visibility cycling.  (line  22)
6783 * overview, STARTUP keyword:             In-buffer settings.  (line  22)
6784 * packages, interaction with other:      Interaction.         (line   6)
6785 * pasting, of subtrees:                  Structure editing.   (line   6)
6786 * per file keywords:                     Per file keywords.   (line   6)
6787 * plain lists:                           Plain lists.         (line   6)
6788 * plain text external links:             External links.      (line  43)
6789 * presentation, of agenda items:         Presentation and sorting.
6790                                                               (line   6)
6791 * printing sparse trees:                 Sparse trees.        (line  41)
6792 * priorities:                            Priorities.          (line   6)
6793 * priorities, of agenda items:           Sorting of agenda items.
6794                                                               (line   6)
6795 * progress logging:                      Progress logging.    (line   6)
6796 * projects, for publishing:              Project alist.       (line   6)
6797 * promotion, of subtrees:                Structure editing.   (line   6)
6798 * publishing:                            Publishing.          (line   6)
6799 * quoted HTML tags:                      Export options.      (line  25)
6800 * radio tables:                          Radio tables.        (line   6)
6801 * radio targets:                         Radio targets.       (line   6)
6802 * range references:                      References.          (line  60)
6803 * ranges, time:                          Time stamps.         (line   6)
6804 * recomputing table fields:              Updating the table.  (line   6)
6805 * references:                            References.          (line   6)
6806 * references, named:                     References.          (line  82)
6807 * references, to fields:                 References.          (line  15)
6808 * references, to ranges:                 References.          (line  60)
6809 * region, active <1>:                    Export commands.     (line   6)
6810 * region, active <2>:                    ASCII export.        (line   9)
6811 * region, active <3>:                    Built-in table editor.
6812                                                               (line 141)
6813 * region, active:                        Structure editing.   (line  64)
6814 * regular expressions, with tags search: Tag searches.        (line  63)
6815 * remember.el <1>:                       Cooperation.         (line  33)
6816 * remember.el:                           Remember.            (line   6)
6817 * remote editing, from agenda:           Agenda commands.     (line 106)
6818 * remote editing, undo:                  Agenda commands.     (line 107)
6819 * richer text:                           Enhancing text.      (line   6)
6820 * RMAIL links:                           External links.      (line   6)
6821 * SCHEDULED keyword:                     Deadlines and scheduling.
6822                                                               (line  22)
6823 * scheduling:                            Time stamps.         (line   6)
6824 * Scripts, for agenda processing:        Extracting Agenda Information for other programs.
6825                                                               (line   6)
6826 * search option in file links:           Search options.      (line   6)
6827 * search strings, custom:                Custom searches.     (line   6)
6828 * searching for tags:                    Tag searches.        (line   6)
6829 * section-numbers:                       Export options.      (line  25)
6830 * setting tags:                          Setting tags.        (line   6)
6831 * SHELL links:                           External links.      (line   6)
6832 * show all, command:                     Visibility cycling.  (line  33)
6833 * show all, global visibility state:     Visibility cycling.  (line  22)
6834 * show hidden text:                      Visibility cycling.  (line   6)
6835 * showall, STARTUP keyword:              In-buffer settings.  (line  22)
6836 * showstars, STARTUP keyword:            In-buffer settings.  (line  44)
6837 * sorting, of agenda items:              Sorting of agenda items.
6838                                                               (line   6)
6839 * sparse tree, for deadlines:            Inserting deadline/schedule.
6840                                                               (line  11)
6841 * sparse tree, for TODO:                 TODO basics.         (line  26)
6842 * sparse tree, tag based:                Tags.                (line   6)
6843 * sparse trees:                          Sparse trees.        (line   6)
6844 * special keywords:                      In-buffer settings.  (line   6)
6845 * spreadsheet capabilities:              The spreadsheet.     (line   6)
6846 * statistics, for checkboxes:            Checkboxes.          (line  23)
6847 * storing links:                         Handling links.      (line   9)
6848 * structure editing:                     Structure editing.   (line   6)
6849 * structure of document:                 Document structure.  (line   6)
6850 * sublevels, inclusion into tags match:  Tag inheritance.     (line   6)
6851 * sublevels, inclusion into todo list:   Global TODO list.    (line  34)
6852 * subscript:                             Subscripts and Superscripts.
6853                                                               (line   6)
6854 * subtree cycling:                       Visibility cycling.  (line  10)
6855 * subtree visibility states:             Visibility cycling.  (line  10)
6856 * subtree, cut and paste:                Structure editing.   (line   6)
6857 * subtree, subtree visibility state:     Visibility cycling.  (line  10)
6858 * subtrees, cut and paste:               Structure editing.   (line   6)
6859 * summary:                               Summary.             (line   6)
6860 * superscript:                           Subscripts and Superscripts.
6861                                                               (line   6)
6862 * syntax, of formulas:                   Formula syntax for Calc.
6863                                                               (line   6)
6864 * table editor, built-in:                Built-in table editor.
6865                                                               (line   6)
6866 * table editor, table.el:                Cooperation.         (line  37)
6867 * table of contents:                     Export options.      (line  25)
6868 * table.el:                              Cooperation.         (line  34)
6869 * tables <1>:                            Export options.      (line  25)
6870 * tables:                                Tables.              (line   6)
6871 * tables, export:                        Enhancing text.      (line  24)
6872 * tables, in other modes:                Tables in arbitrary syntax.
6873                                                               (line   6)
6874 * tag completion:                        Completion.          (line   6)
6875 * tag searches:                          Tag searches.        (line   6)
6876 * tags:                                  Tags.                (line   6)
6877 * tags view:                             Matching headline tags.
6878                                                               (line   6)
6879 * tags, setting:                         Setting tags.        (line   6)
6880 * targets, for links:                    Internal links.      (line   6)
6881 * targets, radio:                        Radio targets.       (line   6)
6882 * tasks, breaking down:                  Breaking down tasks. (line   6)
6883 * templates, for remember:               Remember templates.  (line   6)
6884 * TeX interpretation:                    Embedded LaTeX.      (line   6)
6885 * TeX macros <1>:                        Export options.      (line  25)
6886 * TeX macros:                            Math symbols.        (line   6)
6887 * TeX macros, export:                    Enhancing text.      (line  21)
6888 * TeX symbol completion:                 Completion.          (line   6)
6889 * TeX-like syntax for sub- and superscripts: Export options.  (line  25)
6890 * thanks:                                History and Acknowledgments.
6891                                                               (line   6)
6892 * time format, custom:                   Custom time format.  (line   6)
6893 * time grid:                             Time-of-day specifications.
6894                                                               (line  26)
6895 * time stamps <1>:                       Time stamps.         (line   6)
6896 * time stamps:                           Timestamps.          (line   6)
6897 * time, reading in minibuffer:           The date/time prompt.
6898                                                               (line   6)
6899 * time-of-day specification:             Time-of-day specifications.
6900                                                               (line   6)
6901 * time-sorted view:                      Timeline.            (line   6)
6902 * timeline, single file:                 Timeline.            (line   6)
6903 * timerange:                             Time stamps.         (line  40)
6904 * timestamp:                             Time stamps.         (line  14)
6905 * timestamp, inactive:                   Time stamps.         (line  49)
6906 * timestamp, with repeater interval:     Time stamps.         (line  24)
6907 * timestamps, creating:                  Creating timestamps. (line   6)
6908 * TODO items:                            TODO items.          (line   6)
6909 * TODO keyword matching:                 Global TODO list.    (line  17)
6910 * TODO keyword matching, with tags search: Tag searches.      (line  40)
6911 * todo keyword sets:                     Multiple sets in one file.
6912                                                               (line   6)
6913 * TODO keywords completion:              Completion.          (line   6)
6914 * TODO list, global:                     Global TODO list.    (line   6)
6915 * TODO types:                            TODO types.          (line   6)
6916 * TODO workflow:                         Workflow states.     (line   6)
6917 * transient-mark-mode <1>:               Export commands.     (line   6)
6918 * transient-mark-mode <2>:               ASCII export.        (line   9)
6919 * transient-mark-mode <3>:               Built-in table editor.
6920                                                               (line 141)
6921 * transient-mark-mode:                   Structure editing.   (line  64)
6922 * translator function:                   Translator functions.
6923                                                               (line   6)
6924 * trees, sparse:                         Sparse trees.        (line   6)
6925 * trees, visibility:                     Visibility cycling.  (line   6)
6926 * tty keybindings:                       TTY keys.            (line   6)
6927 * types as TODO keywords:                TODO types.          (line   6)
6928 * underlined text:                       Enhancing text.      (line  15)
6929 * undoing remote-editing events:         Agenda commands.     (line 107)
6930 * updating, table:                       Updating the table.  (line   6)
6931 * URL links:                             External links.      (line   6)
6932 * USENET links:                          External links.      (line   6)
6933 * variables, for customization:          Customization.       (line   6)
6934 * vectors, in table calculations:        Formula syntax for Calc.
6935                                                               (line  11)
6936 * visibility cycling:                    Visibility cycling.  (line   6)
6937 * visible text, printing:                Sparse trees.        (line  41)
6938 * VM links:                              External links.      (line   6)
6939 * WANDERLUST links:                      External links.      (line   6)
6940 * weekly agenda:                         Weekly/Daily agenda. (line   6)
6941 * windmove.el:                           Conflicts.           (line  32)
6942 * workflow states as TODO keywords:      Workflow states.     (line   6)
6943 * XEmacs:                                Installation.        (line   6)
6944 * XOXO export:                           XOXO export.         (line   6)
6946 \x1f
6947 File: org,  Node: Key Index,  Prev: Index,  Up: Top
6949 Key Index
6950 *********
6952 \0\b[index\0\b]
6953 * Menu:
6955 * $:                                     Agenda commands.     (line 121)
6956 * ':                                     CDLaTeX mode.        (line  43)
6957 * +:                                     Agenda commands.     (line 143)
6958 * ,:                                     Agenda commands.     (line 135)
6959 * -:                                     Agenda commands.     (line 149)
6960 * .:                                     Agenda commands.     (line  98)
6961 * ::                                     Agenda commands.     (line 129)
6962 * <:                                     The date/time prompt.
6963                                                               (line  32)
6964 * <left>:                                Agenda commands.     (line  95)
6965 * <RET> <1>:                             Agenda commands.     (line  39)
6966 * <RET> <2>:                             Setting tags.        (line  76)
6967 * <RET> <3>:                             The date/time prompt.
6968                                                               (line  57)
6969 * <RET>:                                 Built-in table editor.
6970                                                               (line  62)
6971 * <right>:                               Agenda commands.     (line  90)
6972 * <SPC> <1>:                             Agenda commands.     (line  28)
6973 * <SPC>:                                 Setting tags.        (line  73)
6974 * <TAB> <1>:                             CDLaTeX mode.        (line  23)
6975 * <TAB> <2>:                             Agenda commands.     (line  33)
6976 * <TAB> <3>:                             Setting tags.        (line  68)
6977 * <TAB> <4>:                             Editing and debugging formulas.
6978                                                               (line  57)
6979 * <TAB> <5>:                             Built-in table editor.
6980                                                               (line  55)
6981 * <TAB> <6>:                             Plain lists.         (line  41)
6982 * <TAB>:                                 Visibility cycling.  (line  10)
6983 * > <1>:                                 Agenda commands.     (line 171)
6984 * >:                                     The date/time prompt.
6985                                                               (line  33)
6986 * ^:                                     CDLaTeX mode.        (line  33)
6987 * _:                                     CDLaTeX mode.        (line  33)
6988 * `:                                     CDLaTeX mode.        (line  39)
6989 * a:                                     Agenda commands.     (line 132)
6990 * b:                                     Agenda commands.     (line  49)
6991 * C:                                     Agenda commands.     (line 211)
6992 * c:                                     Agenda commands.     (line 191)
6993 * C-#:                                   Advanced features.   (line   9)
6994 * C-':                                   Agenda files.        (line  18)
6995 * C-,:                                   Agenda files.        (line  18)
6996 * C-_:                                   Agenda commands.     (line 107)
6997 * C-a a L:                               Timeline.            (line  10)
6998 * C-c ! <1>:                             Footnotes.           (line  14)
6999 * C-c !:                                 Creating timestamps. (line  19)
7000 * C-c #:                                 Checkboxes.          (line  56)
7001 * C-c %:                                 Handling links.      (line  81)
7002 * C-c &:                                 Handling links.      (line  85)
7003 * C-c ':                                 Editing and debugging formulas.
7004                                                               (line  36)
7005 * C-c *:                                 Updating the table.  (line  13)
7006 * C-c +:                                 Built-in table editor.
7007                                                               (line 141)
7008 * C-c ,:                                 Priorities.          (line  18)
7009 * C-c -:                                 Built-in table editor.
7010                                                               (line  90)
7011 * C-c .:                                 Creating timestamps. (line  10)
7012 * C-c /:                                 Sparse trees.        (line  15)
7013 * C-c ::                                 Enhancing text.      (line  32)
7014 * C-c ;:                                 Comment lines.       (line  10)
7015 * C-c <:                                 Creating timestamps. (line  23)
7016 * C-c <TAB>:                             Built-in table editor.
7017                                                               (line 161)
7018 * C-c = <1>:                             Editing and debugging formulas.
7019                                                               (line  14)
7020 * C-c =:                                 Column formulas.     (line  26)
7021 * C-c >:                                 Creating timestamps. (line  27)
7022 * C-c ?:                                 Editing and debugging formulas.
7023                                                               (line  24)
7024 * C-c [:                                 Agenda files.        (line  12)
7025 * C-c \:                                 Tag searches.        (line   9)
7026 * C-c ]:                                 Agenda files.        (line  15)
7027 * C-c ^ <1>:                             Built-in table editor.
7028                                                               (line  94)
7029 * C-c ^:                                 Structure editing.   (line  52)
7030 * C-c `:                                 Built-in table editor.
7031                                                               (line 157)
7032 * C-c a !:                               Stuck projects.      (line  14)
7033 * C-c a #:                               Stuck projects.      (line  13)
7034 * C-c a a:                               Weekly/Daily agenda. (line   9)
7035 * C-c a C:                               Storing searches.    (line   9)
7036 * C-c a e:                               Exporting Agenda Views.
7037                                                               (line  57)
7038 * C-c a M:                               Matching headline tags.
7039                                                               (line  15)
7040 * C-c a m:                               Matching headline tags.
7041                                                               (line  10)
7042 * C-c a M:                               Tag searches.        (line  16)
7043 * C-c a m:                               Tag searches.        (line  12)
7044 * C-c a T:                               Global TODO list.    (line  14)
7045 * C-c a t <1>:                           Global TODO list.    (line   9)
7046 * C-c a t:                               TODO basics.         (line  36)
7047 * C-c C-a:                               Visibility cycling.  (line  33)
7048 * C-c C-b:                               Motion.              (line  15)
7049 * C-c C-c <1>:                           Cooperation.         (line  37)
7050 * C-c C-c <2>:                           The very busy C-c C-c key.
7051                                                               (line   6)
7052 * C-c C-c <3>:                           Processing LaTeX fragments.
7053                                                               (line  15)
7054 * C-c C-c <4>:                           Setting tags.        (line  10)
7055 * C-c C-c <5>:                           Checkboxes.          (line  37)
7056 * C-c C-c <6>:                           Editing and debugging formulas.
7057                                                               (line  46)
7058 * C-c C-c <7>:                           Built-in table editor.
7059                                                               (line  54)
7060 * C-c C-c:                               Plain lists.         (line  78)
7061 * C-c C-d <1>:                           Agenda commands.     (line 156)
7062 * C-c C-d:                               Inserting deadline/schedule.
7063                                                               (line   9)
7064 * C-c C-e:                               Exporting.           (line  19)
7065 * C-c C-e a:                             ASCII export.        (line   9)
7066 * C-c C-e b:                             Export commands.     (line   7)
7067 * C-c C-e c:                             iCalendar export.    (line  21)
7068 * C-c C-e H:                             Export commands.     (line  10)
7069 * C-c C-e h:                             Export commands.     (line   6)
7070 * C-c C-e I:                             iCalendar export.    (line  16)
7071 * C-c C-e i:                             iCalendar export.    (line  14)
7072 * C-c C-e R:                             Export commands.     (line  13)
7073 * C-c C-e t:                             Export options.      (line  13)
7074 * C-c C-e v <1>:                         XOXO export.         (line  11)
7075 * C-c C-e v:                             Sparse trees.        (line  41)
7076 * C-c C-e v a:                           ASCII export.        (line  13)
7077 * C-c C-e v b:                           Export commands.     (line  18)
7078 * C-c C-e v H:                           Export commands.     (line  18)
7079 * C-c C-e v h:                           Export commands.     (line  18)
7080 * C-c C-e v R:                           Export commands.     (line  18)
7081 * C-c C-e x:                             XOXO export.         (line  10)
7082 * C-c C-f:                               Motion.              (line  12)
7083 * C-c C-j:                               Motion.              (line  21)
7084 * C-c C-l:                               Handling links.      (line  25)
7085 * C-c C-n:                               Motion.              (line   8)
7086 * C-c C-o <1>:                           Creating timestamps. (line  31)
7087 * C-c C-o:                               Handling links.      (line  58)
7088 * C-c C-p:                               Motion.              (line   9)
7089 * C-c C-q <1>:                           Editing and debugging formulas.
7090                                                               (line  50)
7091 * C-c C-q:                               Built-in table editor.
7092                                                               (line 125)
7093 * C-c C-r <1>:                           Editing and debugging formulas.
7094                                                               (line  53)
7095 * C-c C-r:                               Visibility cycling.  (line  34)
7096 * C-c C-s <1>:                           Agenda commands.     (line 153)
7097 * C-c C-s:                               Inserting deadline/schedule.
7098                                                               (line  18)
7099 * C-c C-t <1>:                           Clocking work time.  (line  27)
7100 * C-c C-t:                               TODO basics.         (line  13)
7101 * C-c C-u:                               Motion.              (line  18)
7102 * C-c C-v:                               TODO basics.         (line  26)
7103 * C-c C-w:                               Inserting deadline/schedule.
7104                                                               (line  11)
7105 * C-c C-x b:                             Visibility cycling.  (line  41)
7106 * C-c C-x C-a:                           ARCHIVE tag.         (line  28)
7107 * C-c C-x C-b:                           Checkboxes.          (line  38)
7108 * C-c C-x C-c:                           Agenda commands.     (line 218)
7109 * C-c C-x C-d:                           Clocking work time.  (line  35)
7110 * C-c C-x C-i:                           Clocking work time.  (line  12)
7111 * C-c C-x C-k:                           Structure editing.   (line  39)
7112 * C-c C-x C-l:                           Processing LaTeX fragments.
7113                                                               (line   9)
7114 * C-c C-x C-n:                           Handling links.      (line  91)
7115 * C-c C-x C-o:                           Clocking work time.  (line  14)
7116 * C-c C-x C-p:                           Handling links.      (line  91)
7117 * C-c C-x C-r:                           Clocking work time.  (line  43)
7118 * C-c C-x C-s:                           Moving subtrees.     (line  10)
7119 * C-c C-x C-t:                           Custom time format.  (line  12)
7120 * C-c C-x C-u:                           Dynamic blocks.      (line  21)
7121 * C-c C-x C-w <1>:                       Built-in table editor.
7122                                                               (line 114)
7123 * C-c C-x C-w:                           Structure editing.   (line  39)
7124 * C-c C-x C-x:                           Clocking work time.  (line  31)
7125 * C-c C-x C-y <1>:                       Built-in table editor.
7126                                                               (line 118)
7127 * C-c C-x C-y:                           Structure editing.   (line  46)
7128 * C-c C-x M-w <1>:                       Built-in table editor.
7129                                                               (line 111)
7130 * C-c C-x M-w:                           Structure editing.   (line  43)
7131 * C-c C-y <1>:                           Clocking work time.  (line  22)
7132 * C-c C-y:                               Creating timestamps. (line  48)
7133 * C-c l:                                 Handling links.      (line   9)
7134 * C-c { <1>:                             CDLaTeX mode.        (line  21)
7135 * C-c {:                                 Editing and debugging formulas.
7136                                                               (line  33)
7137 * C-c |:                                 Built-in table editor.
7138                                                               (line  40)
7139 * C-c }:                                 Editing and debugging formulas.
7140                                                               (line  28)
7141 * C-c ~:                                 Cooperation.         (line  48)
7142 * C-k:                                   Agenda commands.     (line 115)
7143 * C-S-<left>:                            Multiple sets in one file.
7144                                                               (line  25)
7145 * C-S-<right>:                           Multiple sets in one file.
7146                                                               (line  25)
7147 * C-TAB:                                 ARCHIVE tag.         (line  38)
7148 * C-u C-c *:                             Updating the table.  (line  16)
7149 * C-u C-c .:                             Creating timestamps. (line  14)
7150 * C-u C-c = <1>:                         Editing and debugging formulas.
7151                                                               (line  14)
7152 * C-u C-c =:                             Field formulas.      (line  24)
7153 * C-u C-c C-c:                           Updating the table.  (line  19)
7154 * C-u C-c C-l:                           Handling links.      (line  43)
7155 * C-u C-c C-x C-a:                       ARCHIVE tag.         (line  31)
7156 * C-u C-c C-x C-s:                       Moving subtrees.     (line  12)
7157 * C-u C-c C-x C-u <1>:                   Dynamic blocks.      (line  22)
7158 * C-u C-c C-x C-u:                       Clocking work time.  (line  70)
7159 * C-u C-u C-c *:                         Updating the table.  (line  22)
7160 * C-u C-u C-c =:                         Editing and debugging formulas.
7161                                                               (line  18)
7162 * C-x C-s:                               Editing and debugging formulas.
7163                                                               (line  46)
7164 * C-x C-w <1>:                           Exporting Agenda Views.
7165                                                               (line  11)
7166 * C-x C-w:                               Agenda commands.     (line 227)
7167 * D:                                     Agenda commands.     (line  72)
7168 * d:                                     Agenda commands.     (line  69)
7169 * f:                                     Agenda commands.     (line  42)
7170 * g:                                     Agenda commands.     (line  76)
7171 * H:                                     Agenda commands.     (line 215)
7172 * i:                                     Agenda commands.     (line 196)
7173 * I:                                     Agenda commands.     (line 176)
7174 * l:                                     Agenda commands.     (line  55)
7175 * L:                                     Agenda commands.     (line  30)
7176 * M:                                     Agenda commands.     (line 202)
7177 * M-<down> <1>:                          Editing and debugging formulas.
7178                                                               (line  76)
7179 * M-<down>:                              Built-in table editor.
7180                                                               (line  80)
7181 * M-<left> <1>:                          Built-in table editor.
7182                                                               (line  72)
7183 * M-<left>:                              Structure editing.   (line  21)
7184 * M-<RET> <1>:                           Plain lists.         (line  46)
7185 * M-<RET>:                               Structure editing.   (line   6)
7186 * M-<right> <1>:                         Built-in table editor.
7187                                                               (line  72)
7188 * M-<right>:                             Structure editing.   (line  24)
7189 * M-<TAB> <1>:                           Completion.          (line  10)
7190 * M-<TAB> <2>:                           Setting tags.        (line   6)
7191 * M-<TAB> <3>:                           Per file keywords.   (line  23)
7192 * M-<TAB>:                               Editing and debugging formulas.
7193                                                               (line  64)
7194 * M-<up> <1>:                            Editing and debugging formulas.
7195                                                               (line  76)
7196 * M-<up>:                                Built-in table editor.
7197                                                               (line  80)
7198 * M-S-<down> <1>:                        Editing and debugging formulas.
7199                                                               (line  72)
7200 * M-S-<down> <2>:                        Built-in table editor.
7201                                                               (line  87)
7202 * M-S-<down> <3>:                        Plain lists.         (line  63)
7203 * M-S-<down>:                            Structure editing.   (line  36)
7204 * M-S-<left> <1>:                        The date/time prompt.
7205                                                               (line  54)
7206 * M-S-<left> <2>:                        Built-in table editor.
7207                                                               (line  74)
7208 * M-S-<left> <3>:                        Plain lists.         (line  69)
7209 * M-S-<left>:                            Structure editing.   (line  27)
7210 * M-S-<RET> <1>:                         Checkboxes.          (line  53)
7211 * M-S-<RET> <2>:                         Plain lists.         (line  56)
7212 * M-S-<RET>:                             Structure editing.   (line  18)
7213 * M-S-<right> <1>:                       The date/time prompt.
7214                                                               (line  51)
7215 * M-S-<right> <2>:                       Built-in table editor.
7216                                                               (line  77)
7217 * M-S-<right> <3>:                       Plain lists.         (line  69)
7218 * M-S-<right>:                           Structure editing.   (line  30)
7219 * M-S-<up> <1>:                          Editing and debugging formulas.
7220                                                               (line  72)
7221 * M-S-<up> <2>:                          Built-in table editor.
7222                                                               (line  84)
7223 * M-S-<up> <3>:                          Plain lists.         (line  63)
7224 * M-S-<up>:                              Structure editing.   (line  33)
7225 * mouse-1 <1>:                           Agenda commands.     (line  33)
7226 * mouse-1 <2>:                           The date/time prompt.
7227                                                               (line  36)
7228 * mouse-1:                               Handling links.      (line  72)
7229 * mouse-2 <1>:                           Agenda commands.     (line  33)
7230 * mouse-2:                               Handling links.      (line  72)
7231 * mouse-3 <1>:                           Agenda commands.     (line  28)
7232 * mouse-3:                               Handling links.      (line  77)
7233 * n:                                     Agenda commands.     (line  19)
7234 * O:                                     Agenda commands.     (line 180)
7235 * o:                                     Agenda commands.     (line  65)
7236 * P:                                     Agenda commands.     (line 140)
7237 * p:                                     Agenda commands.     (line  20)
7238 * q:                                     Agenda commands.     (line 238)
7239 * r <1>:                                 Agenda commands.     (line  80)
7240 * r:                                     Global TODO list.    (line  22)
7241 * S:                                     Agenda commands.     (line 206)
7242 * s:                                     Agenda commands.     (line  87)
7243 * S-<down> <1>:                          Agenda commands.     (line 149)
7244 * S-<down> <2>:                          The date/time prompt.
7245                                                               (line  45)
7246 * S-<down> <3>:                          Creating timestamps. (line  40)
7247 * S-<down> <4>:                          Priorities.          (line  23)
7248 * S-<down> <5>:                          Editing and debugging formulas.
7249                                                               (line  67)
7250 * S-<down>:                              Plain lists.         (line  59)
7251 * S-<left> <1>:                          Agenda commands.     (line 167)
7252 * S-<left> <2>:                          The date/time prompt.
7253                                                               (line  42)
7254 * S-<left> <3>:                          Creating timestamps. (line  35)
7255 * S-<left> <4>:                          Multiple sets in one file.
7256                                                               (line  29)
7257 * S-<left> <5>:                          TODO basics.         (line  20)
7258 * S-<left>:                              Editing and debugging formulas.
7259                                                               (line  67)
7260 * S-<RET>:                               Built-in table editor.
7261                                                               (line 144)
7262 * S-<right> <1>:                         Agenda commands.     (line 159)
7263 * S-<right> <2>:                         The date/time prompt.
7264                                                               (line  39)
7265 * S-<right> <3>:                         Creating timestamps. (line  35)
7266 * S-<right> <4>:                         Multiple sets in one file.
7267                                                               (line  29)
7268 * S-<right> <5>:                         TODO basics.         (line  20)
7269 * S-<right>:                             Editing and debugging formulas.
7270                                                               (line  67)
7271 * S-<TAB> <1>:                           Built-in table editor.
7272                                                               (line  59)
7273 * S-<TAB>:                               Visibility cycling.  (line  22)
7274 * S-<up> <1>:                            Agenda commands.     (line 143)
7275 * S-<up> <2>:                            The date/time prompt.
7276                                                               (line  48)
7277 * S-<up> <3>:                            Creating timestamps. (line  40)
7278 * S-<up> <4>:                            Priorities.          (line  23)
7279 * S-<up> <5>:                            Editing and debugging formulas.
7280                                                               (line  67)
7281 * S-<up>:                                Plain lists.         (line  59)
7282 * T:                                     Agenda commands.     (line 124)
7283 * t:                                     Agenda commands.     (line 111)
7284 * w:                                     Agenda commands.     (line  66)
7285 * x:                                     Agenda commands.     (line 239)
7286 * X:                                     Agenda commands.     (line 183)
7289 \x1f
7290 Tag Table:
7291 Node: Top\x7f970
7292 Node: Introduction\x7f11676
7293 Node: Summary\x7f12091
7294 Node: Installation\x7f15100
7295 Node: Activation\x7f16478
7296 Node: Feedback\x7f17727
7297 Node: Document structure\x7f19803
7298 Node: Outlines\x7f20577
7299 Node: Headlines\x7f21237
7300 Ref: Headlines-Footnote-1\x7f22245
7301 Node: Visibility cycling\x7f22344
7302 Ref: Visibility cycling-Footnote-1\x7f24554
7303 Ref: Visibility cycling-Footnote-2\x7f24612
7304 Ref: Visibility cycling-Footnote-3\x7f24662
7305 Node: Motion\x7f24932
7306 Node: Structure editing\x7f25886
7307 Node: Archiving\x7f28712
7308 Node: ARCHIVE tag\x7f29270
7309 Node: Moving subtrees\x7f31063
7310 Node: Sparse trees\x7f32374
7311 Ref: Sparse trees-Footnote-1\x7f34506
7312 Ref: Sparse trees-Footnote-2\x7f34688
7313 Node: Plain lists\x7f34803
7314 Ref: Plain lists-Footnote-1\x7f38572
7315 Ref: Plain lists-Footnote-2\x7f38930
7316 Node: Tables\x7f39114
7317 Node: Built-in table editor\x7f39628
7318 Node: Narrow columns\x7f46867
7319 Ref: Narrow columns-Footnote-1\x7f48800
7320 Node: orgtbl-mode\x7f48846
7321 Node: The spreadsheet\x7f49650
7322 Node: References\x7f50737
7323 Ref: References-Footnote-1\x7f54866
7324 Node: Formula syntax for Calc\x7f55155
7325 Node: Formula syntax for Lisp\x7f57612
7326 Node: Field formulas\x7f58881
7327 Node: Column formulas\x7f60189
7328 Node: Editing and debugging formulas\x7f61788
7329 Node: Updating the table\x7f65941
7330 Node: Advanced features\x7f66976
7331 Node: Hyperlinks\x7f71501
7332 Node: Link format\x7f72274
7333 Node: Internal links\x7f73567
7334 Ref: Internal links-Footnote-1\x7f75492
7335 Node: Radio targets\x7f75624
7336 Node: External links\x7f76315
7337 Node: Handling links\x7f78719
7338 Ref: Handling links-Footnote-1\x7f84006
7339 Ref: Handling links-Footnote-2\x7f84243
7340 Node: Link abbreviations\x7f84317
7341 Node: Search options\x7f85996
7342 Ref: Search options-Footnote-1\x7f87776
7343 Node: Custom searches\x7f87857
7344 Node: Remember\x7f88905
7345 Node: Setting up remember\x7f89892
7346 Node: Remember templates\x7f90474
7347 Ref: Remember templates-Footnote-1\x7f93766
7348 Node: Storing notes\x7f93864
7349 Node: TODO items\x7f95751
7350 Node: TODO basics\x7f96734
7351 Node: TODO extensions\x7f98431
7352 Node: Workflow states\x7f99250
7353 Ref: Workflow states-Footnote-1\x7f100425
7354 Node: TODO types\x7f100518
7355 Ref: TODO types-Footnote-1\x7f102101
7356 Node: Multiple sets in one file\x7f102183
7357 Node: Per file keywords\x7f103794
7358 Ref: Per file keywords-Footnote-1\x7f105083
7359 Node: Priorities\x7f105284
7360 Node: Breaking down tasks\x7f106894
7361 Ref: Breaking down tasks-Footnote-1\x7f107414
7362 Node: Checkboxes\x7f107510
7363 Node: Timestamps\x7f110265
7364 Node: Time stamps\x7f110706
7365 Ref: Time stamps-Footnote-1\x7f113011
7366 Node: Creating timestamps\x7f113127
7367 Node: The date/time prompt\x7f115201
7368 Ref: The date/time prompt-Footnote-1\x7f117189
7369 Node: Custom time format\x7f117295
7370 Node: Deadlines and scheduling\x7f118843
7371 Ref: Deadlines and scheduling-Footnote-1\x7f120193
7372 Node: Inserting deadline/schedule\x7f120348
7373 Node: Repeated tasks\x7f121286
7374 Node: Progress logging\x7f122925
7375 Node: Closing items\x7f123580
7376 Ref: Closing items-Footnote-1\x7f124514
7377 Ref: Closing items-Footnote-2\x7f124583
7378 Node: Tracking TODO state changes\x7f124656
7379 Node: Clocking work time\x7f125512
7380 Ref: Clocking work time-Footnote-1\x7f129158
7381 Ref: Clocking work time-Footnote-2\x7f129236
7382 Node: Tags\x7f129362
7383 Node: Tag inheritance\x7f130124
7384 Node: Setting tags\x7f131061
7385 Ref: Setting tags-Footnote-1\x7f135584
7386 Ref: Setting tags-Footnote-2\x7f135696
7387 Node: Tag searches\x7f135779
7388 Node: Agenda views\x7f138490
7389 Node: Agenda files\x7f140435
7390 Ref: Agenda files-Footnote-1\x7f141401
7391 Ref: Agenda files-Footnote-2\x7f141550
7392 Node: Agenda dispatcher\x7f141743
7393 Node: Built-in agenda views\x7f143434
7394 Node: Weekly/Daily agenda\x7f144012
7395 Node: Global TODO list\x7f146953
7396 Node: Matching headline tags\x7f149225
7397 Node: Timeline\x7f150296
7398 Node: Stuck projects\x7f150962
7399 Node: Presentation and sorting\x7f152813
7400 Node: Categories\x7f153604
7401 Node: Time-of-day specifications\x7f154268
7402 Node: Sorting of agenda items\x7f156239
7403 Node: Agenda commands\x7f157521
7404 Node: Custom agenda views\x7f164675
7405 Node: Storing searches\x7f165394
7406 Node: Block agenda\x7f167306
7407 Node: Setting Options\x7f168536
7408 Node: Exporting Agenda Views\x7f171275
7409 Ref: Exporting Agenda Views-Footnote-1\x7f175559
7410 Ref: Exporting Agenda Views-Footnote-2\x7f175616
7411 Node: Extracting Agenda Information for other programs\x7f175802
7412 Node: Embedded LaTeX\x7f179928
7413 Ref: Embedded LaTeX-Footnote-1\x7f181020
7414 Node: Math symbols\x7f181210
7415 Node: Subscripts and Superscripts\x7f181975
7416 Node: LaTeX fragments\x7f182819
7417 Ref: LaTeX fragments-Footnote-1\x7f185053
7418 Node: Processing LaTeX fragments\x7f185315
7419 Node: CDLaTeX mode\x7f186261
7420 Ref: CDLaTeX mode-Footnote-1\x7f188745
7421 Node: Exporting\x7f188893
7422 Node: ASCII export\x7f190207
7423 Node: HTML export\x7f191497
7424 Node: Export commands\x7f192116
7425 Node: Quoting HTML tags\x7f193360
7426 Node: Links\x7f193990
7427 Node: Images\x7f194687
7428 Ref: Images-Footnote-1\x7f195558
7429 Node: CSS support\x7f195619
7430 Ref: CSS support-Footnote-1\x7f196938
7431 Node: XOXO export\x7f197051
7432 Node: iCalendar export\x7f197490
7433 Node: Text interpretation\x7f198709
7434 Node: Comment lines\x7f199300
7435 Node: Initial text\x7f199695
7436 Node: Footnotes\x7f201364
7437 Node: Enhancing text\x7f202179
7438 Ref: Enhancing text-Footnote-1\x7f204038
7439 Node: Export options\x7f204128
7440 Node: Publishing\x7f206021
7441 Ref: Publishing-Footnote-1\x7f206817
7442 Node: Configuration\x7f207013
7443 Node: Project alist\x7f207731
7444 Node: Sources and destinations\x7f208797
7445 Node: Selecting files\x7f209527
7446 Node: Publishing action\x7f210275
7447 Node: Publishing options\x7f211508
7448 Node: Publishing links\x7f213660
7449 Node: Project page index\x7f215173
7450 Node: Sample configuration\x7f215951
7451 Node: Simple example\x7f216443
7452 Node: Complex example\x7f217116
7453 Node: Triggering publication\x7f219192
7454 Node: Miscellaneous\x7f219877
7455 Node: Completion\x7f220511
7456 Node: Customization\x7f221982
7457 Node: In-buffer settings\x7f222565
7458 Node: The very busy C-c C-c key\x7f227441
7459 Node: Clean view\x7f229085
7460 Node: TTY keys\x7f231662
7461 Node: Interaction\x7f233272
7462 Node: Cooperation\x7f233669
7463 Node: Conflicts\x7f236545
7464 Node: Bugs\x7f238548
7465 Node: Extensions and Hacking\x7f240044
7466 Node: Extensions\x7f240640
7467 Node: Tables in arbitrary syntax\x7f242587
7468 Node: Radio tables\x7f243664
7469 Node: A LaTeX example\x7f246167
7470 Ref: A LaTeX example-Footnote-1\x7f249813
7471 Ref: A LaTeX example-Footnote-2\x7f249961
7472 Node: Translator functions\x7f250396
7473 Ref: Translator functions-Footnote-1\x7f253505
7474 Node: Dynamic blocks\x7f253593
7475 Node: Special agenda views\x7f255565
7476 Ref: Special agenda views-Footnote-1\x7f257844
7477 Node: History and Acknowledgments\x7f258104
7478 Node: Index\x7f264198
7479 Node: Key Index\x7f296279
7480 \x1f
7481 End Tag Table