Release 4.62
[org-mode/org-mode-NeilSmithlineMods.git] / org
blob12b9622dbca8b5a7eef297432812de5f23e4e2a8
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.62).
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.62).
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 debuggung 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.
122 * CamelCase links::             Activating CamelCase words as links
124 TODO items
126 * TODO basics::                 Marking and displaying TODO entries
127 * TODO extensions::             Workflow and assignments
128 * Priorities::                  Some things are more important than others
129 * Breaking down tasks::         Splitting a task into managable pieces
130 * Checkboxes::                  Tick-off lists
132 Extended use of TODO keywords
134 * Workflow states::             From TODO to DONE in steps
135 * TODO types::                  I do this, Fred the rest
136 * Per file keywords::           Different files, different requirements
138 Timestamps
140 * Time stamps::                 Assigning a time to a tree entry
141 * Creating timestamps::         Commands which insert timestamps
142 * Custom time format::          If you cannot work with the ISO format
143 * Repeating items::             Deadlines that come back again and again
144 * Progress logging::            Documenting when what work was done.
146 Creating timestamps
148 * The date/time prompt::        How org-mode helps you entering date and time
150 Progress Logging
152 * Closing items::               When was this entry marked DONE?
153 * Tracking TODO state changes::  When did the status change?
154 * Clocking work time::          When exactly did you work on this item?
156 Tags
158 * Tag inheritance::             Tags use the tree structure of the outline
159 * Setting tags::                How to assign tags to a headline
160 * Tag searches::                Searching for combinations of tags
162 Agenda Views
164 * Agenda files::                Files being searched for agenda information
165 * Agenda dispatcher::           Keyboard access to agenda views
166 * Built-in agenda views::       What is available out of the box?
167 * Presentation and sorting::    How agenda items are prepared for display
168 * Agenda commands::             Remote editing of org trees
169 * Custom agenda views::         Defining special searches and views
171 The built-in agenda views
173 * Weekly/Daily agenda::         The calendar page with current tasks
174 * Global TODO list::            All unfinished action items
175 * Matching headline tags::      Structured information with fine-tuned search
176 * Timeline::                    Time-sorted view for single file
177 * Stuck projects::              Find projects you need to review
179 Presentation and sorting
181 * Categories::                  Not all tasks are equal
182 * Time-of-day specifications::  How the agenda knows the time
183 * Sorting of agenda items::     The order of things
185 Custom agenda views
187 * Storing searches::            Type once, use often
188 * Block agenda::                All the stuff you need in a single buffer
189 * Setting Options::             Changing the rules
190 * Batch processing::            Agenda views from the command line
192 Embedded LaTeX
194 * Math symbols::                TeX macros for symbols and Greek letters
195 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
196 * LaTeX fragments::             Complex formulas made easy
197 * Processing LaTeX fragments::  Previewing LaTeX processing
198 * CDLaTeX mode::                Speed up entering of formulas
200 Exporting
202 * ASCII export::                Exporting to plain ASCII
203 * HTML export::                 Exporting to HTML
204 * XOXO export::                 Exporting to XOXO
205 * iCalendar export::            Exporting in iCalendar format
206 * Text interpretation::         How the exporter looks at the file
208 HTML export
210 * Export commands::             How to invode HTML export
211 * Quoting HTML tags::           Using direct HTML in Org-mode
212 * Links::                       How hyperlinks get transferred to HTML
213 * Images::                      To inline or not to inline?
214 * CSS support::                 Style specifications
216 Text interpretation by the exporter
218 * Comment lines::               Some lines will not be exported
219 * Enhancing text::              Subscripts, symbols and more
220 * Export options::              How to influence the export settings
222 Publishing
224 * Configuration::               Defining projects
225 * Sample configuration::        Example projects
226 * Triggering publication::      Publication commands
228 Configuration
230 * Project alist::               The central configuration variable
231 * Sources and destinations::    From here to there
232 * Selecting files::             What files are part of the project?
233 * Publishing action::           Setting the function doing the publishing
234 * Publishing options::          Tweaking HTML export
235 * Publishing links::            Which links keep working after publishing?
236 * Project page index::          Publishing a list of project files
238 Sample configuration
240 * Simple example::              One-component publishing
241 * Complex example::             A multi-component publishing example
243 Miscellaneous
245 * Completion::                  M-TAB knows what you need
246 * Customization::               Adapting Org-mode to your taste
247 * In-buffer settings::          Overview of the #+KEYWORDS
248 * The very busy C-c C-c key::   When in doubt, press C-c C-c
249 * Clean view::                  Getting rid of leading stars in the outline
250 * TTY keys::                    Using Org-mode on a tty
251 * Interaction::                 Other Emacs packages
252 * Bugs::                        Things which do not work perfectly
254 Interaction with other packages
256 * Cooperation::                 Packages Org-mode cooperates with
257 * Conflicts::                   Packages that lead to conflicts
259 Extensions, Hooks and Hacking
261 * Extensions::                  Existing 3rd-part extensions
262 * Dynamic blocks::              Automatically filled blocks
263 * Special agenda views::
265 \x1f
266 File: org,  Node: Introduction,  Next: Document structure,  Prev: Top,  Up: Top
268 1 Introduction
269 **************
271 * Menu:
273 * Summary::                     Brief summary of what Org-mode does
274 * Installation::                How to install a downloaded version of Org-mode
275 * Activation::                  How to activate Org-mode for certain buffers.
276 * Feedback::                    Bug reports, ideas, patches etc.
278 \x1f
279 File: org,  Node: Summary,  Next: Installation,  Prev: Introduction,  Up: Introduction
281 1.1 Summary
282 ===========
284 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
285 project planning with a fast and effective plain-text system.
287    Org-mode develops organizational tasks around NOTES files that
288 contain lists or information about projects as plain text.  Org-mode is
289 implemented on top of outline-mode, which makes it possible to keep the
290 content of large files well structured.  Visibility cycling and
291 structure editing help to work with the tree.  Tables are easily created
292 with a built-in table editor.  Org-mode supports ToDo items, deadlines,
293 time stamps, and scheduling.  It dynamically compiles entries into an
294 agenda that utilizes and smoothly integrates much of the Emacs calendar
295 and diary.  Plain text URL-like links connect to websites, emails,
296 Usenet messages, BBDB entries, and any files related to the projects.
297 For printing and sharing of notes, an Org-mode file can be exported as a
298 structured ASCII file, as HTML, or (todo and agenda items only) as an
299 iCalendar file.  It can also serve as a publishing tool for a set of
300 linked webpages.
302    An important design aspect that distinguishes Org-mode from for
303 example Planner/Muse is that it encougages to store every piece of
304 information only once.  In Planner, you have project pages, day pages
305 and possibly other files, duplicating some information such as tasks.
306 In Org-mode, you only have notes files.  In your notes you mark entries
307 as tasks, label them with tags and timestamps.  All necessary lists
308 like a schedule for the day, the agenda for a meeting, tasks lists
309 selected by tags etc are created dynamically when you need them.
311    Org-mode keeps simple things simple.  When first fired up, it should
312 feel like a straightforward, easy to use outliner.  Complexity is not
313 imposed, but a large amount of functionality is available when you need
314 it.  Org-mode can be used on different levels and in different ways, for
315 example as:
317      * outline extension with visibility cycling and structure editing
318      * ASCII system and table editor for taking structured notes
319      * ASCII table editor with spreadsheet-like capabilities
320      * TODO list editor
321      * full agenda and planner with deadlines and work scheduling
322      * environment to implement David Allen's GTD system
323      * simple hypertext system, with HTML export
324      * publishing tool to create a set of interlinked webpages
326    Org-mode's automatic, context sensitive table editor with spreadsheet
327 capabilities can be integrated into any major mode by activating the
328 minor Orgtbl-mode.
330    There is a website for Org-mode which provides links to the newest
331 version of Org-mode, as well as additional information, frequently asked
332 questions (FAQ), links to tutorials etc.  This page is located at
333 `http://www.astro.uva.nl/~dominik/Tools/org/'.
335 \x1f
336 File: org,  Node: Installation,  Next: Activation,  Prev: Summary,  Up: Introduction
338 1.2 Installation
339 ================
341 Important: If Org-mode is part of the Emacs distribution or an XEmacs
342 package, please skip this section and go directly to *Note Activation::.
344    If you have downloaded Org-mode from the Web, you must take the
345 following steps to install it: Go into the Org-mode distribution
346 directory and edit the top section of the file `Makefile'.  You must
347 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
348 and the paths to the directories where local Lisp and Info files are
349 kept.  If you don't have access to the system-wide directories, create
350 your own two directories for these files, enter them into the Makefile,
351 and make sure Emacs finds the Lisp files by adding the following line
352 to `.emacs':
354      (setq load-path (cons "~/path/to/lispdir" load-path))
356    XEmacs users now need to install the file `noutline.el' from the
357 `xemacs' subdirectory of the Org-mode distribution.  Use the command:
359      make install-noutline
361 Now byte-compile and install the Lisp files with the shell commands:
363      make
364      make install
366 If you want to install the info documentation, use this command:
368      make install-info
370 Then add to `.emacs':
372      ;; This line only if org-mode is not part of the X/Emacs distribution.
373      (require 'org-install)
375 \x1f
376 File: org,  Node: Activation,  Next: Feedback,  Prev: Installation,  Up: Introduction
378 1.3 Activation
379 ==============
381 Add the following lines to your `.emacs' file.  The last two lines
382 define _global_ keys for the commands `org-store-link' and `org-agenda'
383 - please choose suitable keys yourself.
385      ;; The following lines are always needed.  Choose your own keys.
386      (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
387      (define-key global-map "\C-cl" 'org-store-link)
388      (define-key global-map "\C-ca" 'org-agenda)
390    Furthermore, you must activate `font-lock-mode' in org-mode buffers,
391 because significant functionality depends on font-locking being active.
392 You can do this with either one of the following two lines (XEmacs
393 user must use the second option):
394      (global-font-lock-mode 1)                     ; for all buffers
395      (add-hook 'org-mode-hook 'turn-on-font-lock)  ; org-mode buffers only
397    With this setup, all files with extension `.org' will be put into
398 Org-mode.  As an alternative, make the first line of a file look like
399 this:
401      MY PROJECTS    -*- mode: org; -*-
403 which will select Org-mode for this buffer no matter what the file's
404 name is.  See also the variable `org-insert-mode-line-in-empty-file'.
406 \x1f
407 File: org,  Node: Feedback,  Prev: Activation,  Up: Introduction
409 1.4 Feedback
410 ============
412 If you find problems with Org-mode, or if you have questions, remarks,
413 or ideas about it, please contact the maintainer Carsten Dominik at
414 <dominik at science dot uva dot nl>.
416    For bug reports, please provide as much information as possible,
417 including the version information of Emacs (`C-h v emacs-version
418 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
419 Org-mode related setup in `.emacs'.  If an error occurs, a backtrace
420 can be very useful (see below on how to create one).  Often a small
421 example file helps, along with clear information about:
423   1. What exactly did you do?
425   2. What did you expect to happen?
427   3. What happened instead?
428         Thank you for helping to improve this mode.
430 How to create a useful backtrace
431 ................................
433 If working with Org-mode produces an error with a message you don't
434 understand, you may have hit a bug.  The best way to report this is by
435 providing, in addition to what was mentioned above, a _Backtrace_.
436 This is information from the built-in debugger about where and how the
437 error occurred.  Here is how to produce a useful backtrace:
439   1. Start a fresh Emacs or XEmacs, and make sure that it will load the
440      original Lisp code in `org.el' instead of the compiled version in
441      `org.elc'.  The backtrace contains much more information if it is
442      produced with uncompiled code.  To do this, either rename `org.elc'
443      to something else before starting Emacs, or ask Emacs explicitly
444      to load `org.el' by using the command line
445           emacs -l /path/to/org.el
447   2. Go to the `Options' menu and select `Enter Debugger on Error'
448      (XEmacs has this option in the `Troubleshooting' sub-menu).
450   3. Do whatever you have to do to hit the error.  Don't forget to
451      document the steps you take.
453   4. When you hit the error, a `*Backtrace*' buffer will appear on the
454      screen.  Save this buffer to a file (for example using `C-x C-w')
455      and attach it to your bug report.
457 \x1f
458 File: org,  Node: Document structure,  Next: Tables,  Prev: Introduction,  Up: Top
460 2 Document Structure
461 ********************
463 Org-mode is based on outline mode and provides flexible commands to
464 edit the structure of the document.
466 * Menu:
468 * Outlines::                    Org-mode is based on outline-mode
469 * Headlines::                   How to typeset org-tree headlines
470 * Visibility cycling::          Show and hide, much simplified
471 * Motion::                      Jumping to other headlines
472 * Structure editing::           Changing sequence and level of headlines
473 * Archiving::                   Move done task trees to a different place
474 * Sparse trees::                Matches embedded in context
475 * Plain lists::                 Additional structure within an entry
477 \x1f
478 File: org,  Node: Outlines,  Next: Headlines,  Prev: Document structure,  Up: Document structure
480 2.1 Outlines
481 ============
483 Org-mode is implemented on top of outline-mode.  Outlines allow to
484 organize a document in a hierarchical structure, which (at least for
485 me) is the best representation of notes and thoughts.  Overview over
486 this structure is achieved by folding (hiding) large parts of the
487 document to show only the general document structure and the parts
488 currently being worked on.  Org-mode greatly simplifies the use of
489 outlines by compressing the entire show/hide functionality into a
490 single command `org-cycle', which is bound to the <TAB> key.
492 \x1f
493 File: org,  Node: Headlines,  Next: Visibility cycling,  Prev: Outlines,  Up: Document structure
495 2.2 Headlines
496 =============
498 Headlines define the structure of an outline tree.  The headlines in
499 Org-mode start with one or more stars, on the left margin.  For example:
501      * Top level headline
502      ** Second level
503      *** 3rd level
504          some text
505      *** 3rd level
506          more text
507      * Another top level headline
509 Some people find the many stars too noisy and would prefer an outline
510 that has whitespace followed by a single star as headline starters.
511 *Note Clean view:: describes a setup to realize this.
513 \x1f
514 File: org,  Node: Visibility cycling,  Next: Motion,  Prev: Headlines,  Up: Document structure
516 2.3 Visibility cycling
517 ======================
519 Outlines make it possible to hide parts of the text in the buffer.
520 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
521 the visibility in the buffer.
523 `<TAB>'
524      _Subtree cycling_: Rotate current subtree between the states
526           ,-> FOLDED -> CHILDREN -> SUBTREE --.
527           '-----------------------------------'
529      The cursor must be on a headline for this to work(1).  When the
530      cursor is at the beginning of the buffer and the first line is not
531      a headline, then <TAB> actually runs global cycling (see
532      below)(2).  Also when called with a prefix argument (`C-u <TAB>'),
533      global cycling is invoked.
535 `S-<TAB>'
536 `C-u <TAB>'
537      _Global cycling_: Rotate the entire buffer between the states
539           ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
540           '--------------------------------------'
542      Note that inside tables, `S-<TAB>' jumps to the previous field.
544 `C-c C-a'
545      Show all.  
547 `C-c C-r'
548      Reveal context around point, showing the current entry, the
549      following heading and the hierarchy above.  Useful for working
550      near a location exposed by a sparse tree command (*note Sparse
551      trees::) or an agenda command (*note Agenda commands::).  With
552      prefix arg show, on each level, all sibling headings.  
554 `C-c C-x b'
555      Show the current subtree in an indirect buffer(3).  With numerical
556      prefix ARG, go up to this level and then take that tree.  If ARG
557      is negative, go up that many levels.  With `C-u' prefix, do not
558      remove the previously used indirect buffer.
560    When Emacs first visits an Org-mode file, the global state is set to
561 OVERVIEW, i.e. only the top level headlines are visible.  This can be
562 configured through the variable `org-startup-folded', or on a per-file
563 basis by adding one of the following lines anywhere in the buffer:
565      #+STARTUP: overview
566      #+STARTUP: content
567      #+STARTUP: showall
569    ---------- Footnotes ----------
571    (1) see, however, the option `org-cycle-emulate-tab'.
573    (2) see the option `org-cycle-global-at-bob'.
575    (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
576 Buffers.) will contain the entire buffer, but will be narrowed to the
577 current tree.  Editing the indirect buffer will also change the
578 original buffer, but without affecting visibility in that buffer.
580 \x1f
581 File: org,  Node: Motion,  Next: Structure editing,  Prev: Visibility cycling,  Up: Document structure
583 2.4 Motion
584 ==========
586 The following commands jump to other headlines in the buffer.
588 `C-c C-n'
589      Next heading.  
591 `C-c C-p'
592      Previous heading.  
594 `C-c C-f'
595      Next heading same level.  
597 `C-c C-b'
598      Previous heading same level.  
600 `C-c C-u'
601      Backward to higher level heading.  
603 `C-c C-j'
604      Jump to a different place without changing the current outline
605      visibility.  Shows the document structure in a temporary buffer,
606      where you can use visibility cycling (<TAB>) to find your
607      destination.  After pressing <RET>, the cursor moves to the
608      selected location in the original buffer, and the headings
609      hierarchy above it is made visible.
611 \x1f
612 File: org,  Node: Structure editing,  Next: Archiving,  Prev: Motion,  Up: Document structure
614 2.5 Structure editing
615 =====================
617 `M-<RET>'
618      Insert new heading with same level as current.  If the cursor is
619      in a plain list item, a new item is created (*note Plain lists::).
620      To force creation of a new headline, use a prefix arg, or first
621      press <RET> to get to the beginning of the next line.  When this
622      command is used in the middle of a line, the line is split and the
623      rest of the line becomes the new headline.  If the command is used
624      at the beginning of a headline, the new headline is created before
625      the current line.  If at the beginning of any other line, the
626      content of that line is made the new heading.  If the command is
627      used at the end of a folded subtree (i.e. behind the ellipses at
628      the end of a headline), then a headline like the current one will
629      be inserted after the end of the subtree.  
631 `M-S-<RET>'
632      Insert new TODO entry with same level as current heading.  
634 `M-<left>'
635      Promote current heading by one level.  
637 `M-<right>'
638      Demote current heading by one level.  
640 `M-S-<left>'
641      Promote the current subtree by one level.  
643 `M-S-<right>'
644      Demote the current subtree by one level.  
646 `M-S-<up>'
647      Move subtree up (swap with previous subtree of same level).  
649 `M-S-<down>'
650      Move subtree down (swap with next subtree of same level).  
652 `C-c C-x C-w'
653 `C-c C-x C-k'
654      Kill subtree, i.e. remove it from buffer but save in kill ring.  
656 `C-c C-x M-w'
657      Copy subtree to kill ring.  
659 `C-c C-x C-y'
660      Yank subtree from kill ring.  This does modify the level of the
661      subtree to make sure the tree fits in nicely at the yank position.
662      The yank level can also be specified with a prefix arg, or by
663      yanking after a headline marker like `****'.  
665 `C-c ^'
666      Sort same-level entries.  When there is an active region, all
667      entries in the region will be sorted.  Otherwise the children of
668      the current headline are sorted.  The command prompts for the
669      sorting method, which can be alphabetically, numerically, by time
670      (using the first time stamp in each entry), and each of these in
671      reverse order.  With a `C-u' prefix, sorting will be
672      case-sensitive.  With two `C-u C-u' prefixes, duplicate entries
673      will also be removed.
675    When there is an active region (transient-mark-mode), promotion and
676 demotion work on all headlines in the region.  To select a region of
677 headlines, it is best to place both point and mark at the beginning of a
678 line, mark at the beginning of the first headline, and point at the line
679 just after the last headline to change.  Note that when the cursor is
680 inside a table (*note Tables::), the Meta-Cursor keys have different
681 functionality.
683 \x1f
684 File: org,  Node: Archiving,  Next: Sparse trees,  Prev: Structure editing,  Up: Document structure
686 2.6 Archiving
687 =============
689 When a project represented by a (sub)tree is finished, you may want to
690 move the tree out of the way and to stop it from contributing to the
691 agenda.  Org-mode knows two ways of archiving.  You can mark a tree with
692 the ARCHIVE tag, or you can move an entire (sub)tree to a different
693 location.
695 * Menu:
697 * ARCHIVE tag::                 Marking a tree as inactive
698 * Moving subtrees::             Moving a tree to an archive file
700 \x1f
701 File: org,  Node: ARCHIVE tag,  Next: Moving subtrees,  Prev: Archiving,  Up: Archiving
703 2.6.1 The ARCHIVE tag
704 ---------------------
706 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
707 its location in the outline tree, but behaves in the following way:
708    - It does not open when you attempt to do so with a visibility
709      cycling command (*note Visibility cycling::).  You can force
710      cycling archived subtrees with `C-<TAB>', or by setting the option
711      `org-cycle-open-archived-trees'.  Also normal outline commands like
712      `show-all' will open archived subtrees.
714    - During sparse tree construction (*note Sparse trees::), matches in
715      archived subtrees are not exposed, unless you configure the option
716      `org-sparse-tree-open-archived-trees'.
718    - During agenda view construction (*note Agenda views::), the
719      content of archived trees is ignored unless you configure the
720      option `org-agenda-skip-archived-trees'.
722    - Archived trees are not exported (*note Exporting::), only the
723      headline is.  Configure the details using the variable
724      `org-export-with-archived-trees'.
726    The following commands help managing the ARCHIVE tag:
728 `C-c C-x C-a'
729      Toggle the ARCHIVE tag for the current headline.  When the tag is
730      set, the headline changes to a shadowish face, and the subtree
731      below it is hidden.  
733 `C-u C-c C-x C-a'
734      Check if any direct children of the current headline should be
735      archived.  To do this, each subtree is checked for open TODO
736      entries.  If none are found, the command offers to set the ARCHIVE
737      tag for the child.  If the cursor is _not_ on a headline when this
738      command is invoked, the level 1 trees will be checked.  
740 `C-TAB'
741      Cycle a tree even if it is tagged with ARCHIVE.
743 \x1f
744 File: org,  Node: Moving subtrees,  Prev: ARCHIVE tag,  Up: Archiving
746 2.6.2 Moving subtrees
747 ---------------------
749 Once an entire project is finished, you may want to move it to a
750 different location, either in the current file, or even in a different
751 file, the archive file.
753 `C-c C-x C-s'
754      Archive the subtree starting at the cursor position to the location
755      given by `org-archive-location'.  
757 `C-u C-c C-x C-s'
758      Check if any direct children of the current headline could be
759      moved to the archive.  To do this, each subtree is checked for
760      open TODO entries.  If none are found, the command offers to move
761      it to the archive location.  If the cursor is _not_ on a headline
762      when this command is invoked, the level 1 trees will be checked.
764    The default archive location is a file in the same directory as the
765 current file, with the name derived by appending `_archive' to the
766 current file name.  For information and examples on how to change this,
767 see the documentation string of the variable `org-archive-location'.
768 There is also an in-buffer option for setting this variable, for example
770      #+ARCHIVE: %s_done::
772 You may have several such lines in the buffer, they will then be valid
773 for the entries following the line (the first will also apply to any
774 text before it).
776 \x1f
777 File: org,  Node: Sparse trees,  Next: Plain lists,  Prev: Archiving,  Up: Document structure
779 2.7 Sparse trees
780 ================
782 An important feature of Org-mode is the ability to construct _sparse
783 trees_ for selected information in an outline tree.  A sparse tree
784 means that the entire document is folded as much as possible, but the
785 selected information is made visible along with the headline structure
786 above it(1).  Just try it out and you will see immediately how it works.
788    Org-mode contains several commands creating such trees.  The most
789 basic one is `org-occur':
791 `C-c /'
792      Occur.  Prompts for a regexp and shows a sparse tree with all
793      matches.  If the match is in a headline, the headline is made
794      visible.  If the match is in the body of an entry, headline and
795      body are made visible.  In order to provide minimal context, also
796      the full hierarchy of headlines above the match is shown, as well
797      as the headline following the match.  Each match is also
798      highlighted; the highlights disappear when the bufer is changes an
799      editing command, or by pressing `C-c C-c'.  When called with a
800      `C-u' prefix argument, previous highlights are kept, so several
801      calls to this command can be stacked.
802    For frequently used sparse trees of specific search strings, you can
803 use the variable `org-agenda-custom-commands' to define fast keyboard
804 access to specific sparse trees.  These commands will then be
805 accessible through the agenda dispatcher (*note Agenda dispatcher::).
806 For example:
808      (setq org-agenda-custom-commands
809            '(("f" occur-tree "FIXME")))
811 will define the key `C-c a f' as a shortcut for creating a sparse tree
812 matching the string `FIXME'.
814    Other commands use sparse trees as well.  For example `C-c C-v'
815 creates a sparse TODO tree (*note TODO basics::).
817    To print a sparse tree, you can use the Emacs command
818 `ps-print-buffer-with-faces' which does not print invisible parts of
819 the document (2).  Or you can use the command `C-c C-e v' to export
820 only the visible part of the document and print the resulting file.
822    ---------- Footnotes ----------
824    (1) See also the variables `org-show-hierarchy-above',
825 `org-show-following-heading', and `org-show-siblings' for detailed
826 control on how much context is shown around each match.
828    (2) This does not work under XEmacs, because XEmacs uses selective
829 display for outlining, not text properties.
831 \x1f
832 File: org,  Node: Plain lists,  Prev: Sparse trees,  Up: Document structure
834 2.8 Plain lists
835 ===============
837 Within an entry of the outline tree, hand-formatted lists can provide
838 additional structure.  They also provide a way to create lists of
839 checkboxes (*note Checkboxes::).  Org-mode supports editing such lists,
840 and the HTML exporter (*note Exporting::) does parse and format them.
842    Org-mode knows ordered and unordered lists.  Unordered list items
843 start with `-', `+', or `*'(1) as bullets.  Ordered list items start
844 with `1.' or `1)'.  Items belonging to the same list must have the same
845 indentation on the first line.  In particular, if an ordered list
846 reaches number `10.', then the 2-digit numbers must be written
847 left-aligned with the other numbers in the list.  Indentation also
848 determines the end of a list item.  It ends before the next line that
849 is indented like the bullet/number, or less.  For example:
851      ** Lord of the Rings
852         My favorite scenes are (in this order)
853         1. The attack of the Rohirrim
854         2. Eowyns fight with the witch king
855            + this was already my favorite scene in the book
856            + I really like Miranda Otto.
857         3. Peter Jackson being shot by Legolas
858             - on DVD only
859            He makes a really funny face when it happens.
860         But in the end, not individual scenes matter but the film as a whole.
862    Org-mode supports these lists by tuning filling and wrapping
863 commands to deal with them correctly(2).
865    The following commands act on items when the cursor is in the first
866 line of an item (the line with the bullet or number).
868 `<TAB>'
869      Items can be folded just like headline levels if you set the
870      variable `org-cycle-include-plain-lists'.  The level of an item is
871      then given by the indentation of the bullet/number.  Items are
872      always subordinate to real headlines, however; the hierarchies
873      remain completely separated.  
875 `M-<RET>'
876      Insert new item at current level.  With prefix arg, force a new
877      heading (*note Structure editing::).  If this command is used in
878      the middle of a line, the line is _split_ and the rest of the line
879      becomes the new item.  If this command is executed in the
880      _whitespace before a bullet or number_, the new item is created
881      _before_ the current item.  If the command is executed in the
882      white space before the text that is part of an item but does not
883      contain the bullet, a bullet is added to the current line.  
885 `M-S-<RET>'
886      Insert a new item with a checkbox (*note Checkboxes::).  
888 `S-<up>'
889 `S-<down>'
890      Jump to the previous/next item in the current list.  
892 `M-S-<up>'
893 `M-S-<down>'
894      Move the item including subitems up/down (swap with previous/next
895      item of same indentation).  If the list is ordered, renumbering is
896      automatic.  
898 `M-S-<left>'
899 `M-S-<right>'
900      Decrease/increase the indentation of the item, including subitems.
901      Initially, the item tree is selected based on current indentation.
902      When these commands are executed several times in direct
903      succession, the initially selected region is used, even if the new
904      indentation would imply a different hierarchy.  To use the new
905      hierarchy, break the command chain with a cursor motion or so.  
907 `C-c C-c'
908      If there is a checkbox (*note Checkboxes::) in the item line,
909      toggle the state of the checkbox.  Otherwise, if this is an
910      ordered list, renumber the ordered list at the cursor.
912    ---------- Footnotes ----------
914    (1) When using `*' as a bullet, lines must be indented or they will
915 be seen as top-level headlines.  Also, when you are hiding leading
916 stars to get a clean outline view, plain list items starting with a
917 star are visually indistinguishable from true headlines.  In short:
918 even though `*' is supported, it may be better not to use it for plain
919 list items
921    (2) Org-mode only changes the filling settings for Emacs.  For
922 XEmacs, you should use Kyle E. Jones' `filladapt.el'.  To turn this on,
923 put into `.emacs':
924      (require 'filladapt)
926 \x1f
927 File: org,  Node: Tables,  Next: Hyperlinks,  Prev: Document structure,  Up: Top
929 3 Tables
930 ********
932 Org-mode has a very fast and intuitive table editor built-in.
933 Spreadsheet-like calculations are supported in connection with the
934 Emacs `calc' package.
936 * Menu:
938 * Built-in table editor::       Simple tables
939 * Narrow columns::              Stop wasting space in tables
940 * orgtbl-mode::                 The table editor as minor mode
941 * The spreadsheet::             The table editor has spreadsheet capabilities.
943 \x1f
944 File: org,  Node: Built-in table editor,  Next: Narrow columns,  Prev: Tables,  Up: Tables
946 3.1 The built-in table editor
947 =============================
949 Org-mode makes it easy to format tables in plain ASCII.  Any line with
950 `|' as the first non-white character is considered part of a table.
951 `|' is also the column separator.  A table might look like this:
953      | Name  | Phone | Age |
954      |-------+-------+-----|
955      | Peter |  1234 |  17 |
956      | Anna  |  4321 |  25 |
958    A table is re-aligned automatically each time you press <TAB> or
959 <RET> or `C-c C-c' inside the table.  <TAB> also moves to the next
960 field (<RET> to the next row) and creates new table rows at the end of
961 the table or before horizontal lines.  The indentation of the table is
962 set by the first line.  Any line starting with `|-' is considered as a
963 horizontal separator line and will be expanded on the next re-align to
964 span the whole table width.  So, to create the above table, you would
965 only type
967      |Name|Phone|Age|
968      |-
970 and then press <TAB> to align the table and start filling in fields.
972    When typing text into a field, Org-mode treats <DEL>, <Backspace>,
973 and all character keys in a special way, so that inserting and deleting
974 avoids shifting other fields.  Also, when typing _immediately after the
975 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
976 the field is automatically made blank.  If this behavior is too
977 unpredictable for you, configure the variables
978 `org-enable-table-editor' and `org-table-auto-blank-field'.
980 Creation and conversion
981 .......................
983 `C-c |'
984      Convert the active region to table. If every line contains at
985      least one TAB character, the function assumes that the material is
986      tab separated.  If not, lines are split at whitespace into fields.
987      You can use a prefix argument to indicate the minimum number of
988      consecutive spaces required to identify a field separator
989      (default: just one).
990      If there is no active region, this command creates an empty
991      Org-mode table.  But it's easier just to start typing, like
992      `|Name|Phone|Age <RET> |- <TAB>'.
994 Re-aligning and field motion
995 ............................
997 `C-c C-c'
998      Re-align the table without moving the cursor.
1000 `<TAB>'
1001      Re-align the table, move to the next field.  Creates a new row if
1002      necessary.
1004 `S-<TAB>'
1005      Re-align, move to previous field.
1007 `<RET>'
1008      Re-align the table and move down to next row.  Creates a new row if
1009      necessary.  At the beginning or end of a line, <RET> still does
1010      NEWLINE, so it can be used to split a table.
1012 Column and row editing
1013 ......................
1015 `M-<left>'
1016 `M-<right>'
1017      Move the current column left/right.
1019 `M-S-<left>'
1020      Kill the current column.
1022 `M-S-<right>'
1023      Insert a new column to the left of the cursor position.
1025 `M-<up>'
1026 `M-<down>'
1027      Move the current row up/down.
1029 `M-S-<up>'
1030      Kill the current row or horizontal line.
1032 `M-S-<down>'
1033      Insert a new row above (with arg: below) the current row.
1035 `C-c -'
1036      Insert a horizontal line below current row. With prefix arg, the
1037      line is created above the current line.
1039 `C-c ^'
1040      Sort the table lines in the region.  The position of point
1041      indicates the column to be used for sorting, and the range of
1042      lines is the range between the nearest horizontal separator lines,
1043      or the entire table.  If point is before the first column, you
1044      will be prompted for the sorting column.  If there is an active
1045      region, the mark specifies the first line and the sorting column,
1046      while point should be in the last line to be included into the
1047      sorting.  The command prompts for the sorting type
1048      (alphabetically, numerically, or by time).  When called with a
1049      prefix argument, alphabetic sorting will be case-sensitive.
1051 Regions
1052 .......
1054 `C-c C-x M-w'
1055      Copy a rectangular region from a table to a special clipboard.
1056      Point and mark determine edge fields of the rectangle.  The
1057      process ignores horizontal separator lines.  
1059 `C-c C-x C-w'
1060      Copy a rectangular region from a table to a special clipboard, and
1061      blank all fields in the rectangle.  So this is the "cut" operation.  
1063 `C-c C-x C-y'
1064      Paste a rectangular region into a table.  The upper right corner
1065      ends up in the current field.  All involved fields will be
1066      overwritten.  If the rectangle does not fit into the present table,
1067      the table is enlarged as needed.  The process ignores horizontal
1068      separator lines.  
1070 `C-c C-q'
1071      Wrap several fields in a column like a paragraph.  If there is an
1072      active region, and both point and mark are in the same column, the
1073      text in the column is wrapped to minimum width for the given
1074      number of lines.  A prefix ARG may be used to change the number of
1075      desired lines.  If there is no region, the current field is split
1076      at the cursor position and the text fragment to the right of the
1077      cursor is prepended to the field one line down. If there is no
1078      region, but you specify a prefix ARG, the current field is made
1079      blank, and the content is appended to the field above.
1081 Calculations
1082 ............
1084 `C-c +'
1085      Sum the numbers in the current column, or in the rectangle defined
1086      by the active region.  The result is shown in the echo area and can
1087      be inserted with `C-y'.
1089 `S-<RET>'
1090      When current field is empty, copy from first non-empty field above.
1091      When not empty, copy current field down to next row and move cursor
1092      along with it.  Depending on the variable
1093      `org-table-copy-increment', integer field values will be
1094      incremented during copy.  This key is also used by CUA-mode (*note
1095      Cooperation::).
1097 Miscellaneous
1098 .............
1100 `C-c `'
1101      Edit the current field in a separate window.  This is useful for
1102      fields that are not fully visible (*note Narrow columns::).  When
1103      called with a `C-u' prefix, just make the full field visible, so
1104      that it can be edited in place.
1106 `C-c <TAB>'
1107      This is an alias for `C-u C-c `' to make the current field fully
1108      visible.
1110 `M-x org-table-import'
1111      Import a file as a table.  The table should be TAB- or whitespace
1112      separated.  Useful, for example, to import an Excel table or data
1113      from a database, because these programs generally can write
1114      TAB-separated text files.  This command works by inserting the
1115      file into the buffer and then converting the region to a table.
1116      Any prefix argument is passed on to the converter, which uses it
1117      to determine the separator.
1119 `M-x org-table-export'
1120      Export the table as a TAB-separated file.  Useful for data
1121      exchange with, for example, Excel or database programs.
1124    If you don't like the automatic table editor because it gets in your
1125 way on lines which you would like to start with `|', you can turn it
1126 off with
1128      (setq org-enable-table-editor nil)
1130 Then the only table command that still works is `C-c C-c' to do a
1131 manual re-align.
1133 \x1f
1134 File: org,  Node: Narrow columns,  Next: orgtbl-mode,  Prev: Built-in table editor,  Up: Tables
1136 3.2 Narrow columns
1137 ==================
1139 The width of columns is automatically determined by the table editor.
1140 Sometimes a single field or a few fields need to carry more text,
1141 leading to inconveniently wide columns.  To limit(1) the width of a
1142 column, one field anywhere in the column may contain just the string
1143 `<N>' where `N' is an integer specifying the width of the column in
1144 characters.  The next re-align will then set the width of this column
1145 to no more than this value.
1147      |---+------------------------------|               |---+--------|
1148      |   |                              |               |   | <6>    |
1149      | 1 | one                          |               | 1 | one    |
1150      | 2 | two                          |     ----\     | 2 | two    |
1151      | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
1152      | 4 | four                         |               | 4 | four   |
1153      |---+------------------------------|               |---+--------|
1155 Fields that are wider become clipped and end in the string `=>'.  Note
1156 that the full text is still in the buffer, it is only invisible.  To
1157 see the full text, hold the mouse over the field - a tooltip window
1158 will show the full content.  To edit such a field, use the command `C-c
1159 `' (that is `C-c' followed by the backquote).  This will open a new
1160 window with the full field.  Edit it and finish with `C-c C-c'.
1162    When visiting a file containing a table with narrowed columns, the
1163 necessary character hiding has not yet happened, and the table needs to
1164 be aligned before it looks nice.  Setting the option
1165 `org-startup-align-all-tables' will realign all tables in a file upon
1166 visiting, but also slow down startup.  You can also set this option on
1167 a per-file basis with:
1169      #+STARTUP: align
1170      #+STARTUP: noalign
1172    ---------- Footnotes ----------
1174    (1) This feature does not work on XEmacs.
1176 \x1f
1177 File: org,  Node: orgtbl-mode,  Next: The spreadsheet,  Prev: Narrow columns,  Up: Tables
1179 3.3 The Orgtbl minor mode
1180 =========================
1182 If you like the intuitive way the Org-mode table editor works, you
1183 might also want to use it in other modes like text-mode or mail-mode.
1184 The minor mode Orgtbl-mode makes this possible.  You can always toggle
1185 the mode with `M-x orgtbl-mode'.  To turn it on by default, for example
1186 in mail mode, use
1188      (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1190 \x1f
1191 File: org,  Node: The spreadsheet,  Prev: orgtbl-mode,  Up: Tables
1193 3.4 The spreadsheet
1194 ===================
1196 The table editor makes use of the Emacs `calc' package to implement
1197 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
1198 derive fields from other fields.
1200 * Menu:
1202 * References::                  How to refer to another field or range
1203 * Formula syntax for Calc::     Using Calc to compute stuff
1204 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
1205 * Field formulas::              Formulas valid for a single field
1206 * Column formulas::             Formulas valid for an entire column
1207 * Editing and debuggung formulas::  Fixing formulas
1208 * Updating the table::          Recomputing all dependent fields
1209 * Advanced features::           Field names, parameters and automatic recalc
1211 \x1f
1212 File: org,  Node: References,  Next: Formula syntax for Calc,  Prev: The spreadsheet,  Up: The spreadsheet
1214 3.4.1 References
1215 ----------------
1217 To compute fields in the table from other fields, formulas must
1218 reference other fields or ranges.  In Org-mode, fields can be referenced
1219 by name, by absolute coordinates, and by relative coordinates.  To find
1220 out what the coordinates of a field are, press `C-c ?' in that field.
1222 Field references
1223 ................
1225 Formulas can reference the value of another field with the operator
1226      @row$column
1228    Column references can be absolute like `1', `2',...`N', or relative
1229 to the current column like `+1' or `-2'.
1231    The row specification only counts data lines and ignores horizontal
1232 separator lines (hlines).  You can use absolute row numbers `1'...`N',
1233 and row numbers relative to the current row like `+3' or `-1'.  Or
1234 specify the row relative to one of the hlines: `I' refers to the first
1235 hline, `II' to the second etc.  `-I' refers to the first such line
1236 above the current line, `+I' to the first such line below the current
1237 line.  You can also write `III+2' which is the second data line after
1238 the third hline in the table.  Relative row numbers like `-3' will not
1239 cross hlines if the current line is too close to the hline.  Instead,
1240 the value directly at the hline is used.
1242    `0' refers to the current row and column.  Also, if you omit either
1243 the column or the row part of the reference, the current row/column is
1244 implied.  Here are a few examples:
1246      @2$3      2nd row, 3rd column
1247      $5        column 5 in the current row
1248      @2        current column, row 2
1249      @-1$-3    the field one row up, three columns to the left
1250      @-I$2     field just under hline above current row, column 2
1252 Range references
1253 ................
1255 You may reference a rectangular range of fields by specifying two field
1256 references connected by two dots `..'.  If both fields are in the
1257 current row, you may simply use `$2..$7', but if at least one field is
1258 in a different row, you need to use the general `@row$column' format at
1259 least for the first field (i.e the reference must start with `@' in
1260 order to be interpreted correctly).  Examples:
1262      $1..$3        First three fields in the current row.
1263      $P..$Q        Range, using column names (see under Advanced)
1264      @2$1..@4$3    6 fields between these two fields.
1265      @-1$-2..@-1   3 numbers from the column to the left, 2 up to current row
1267 Range references return a vector of values that can be fed into Calc
1268 vector functions.  Empty fields in ranges are normally suppressed, so
1269 that the vector contains only the non-empty fields (but see the `E'
1270 mode switch below).  If there are no non-empty fields, `[0]' is
1271 returned to avoid syntax errors in formulas.
1273 Named references
1274 ................
1276 `$name' is interpreted as the name of a column, parameter or constant.
1277 Constants are defined globally through the variable
1278 `org-table-formula-constants'.  If you have the `constants.el' package,
1279 it will also be used to resolve constants, including natural constants
1280 like `$h' for Planck's constant, and units like `$km' for kilometers.
1281 Column names and parameters can be specified in special table lines.
1282 These are described below, see *Note Advanced features::.
1284 \x1f
1285 File: org,  Node: Formula syntax for Calc,  Next: Formula syntax for Lisp,  Prev: References,  Up: The spreadsheet
1287 3.4.2 Formula syntax for Calc
1288 -----------------------------
1290 A formula can be any algebraic expression understood by the Emacs
1291 `Calc' package.  Note that `calc' has the slightly non-standard
1292 convention that `/' has lower precedence than `*', so that `a/b*c' is
1293 interpreted as `a/(b*c)'.  Before evaluation by `calc-eval' (*note
1294 calc-eval: (calc)Calling Calc from Your Programs.), variable
1295 substitution takes place according to the rules described above.  The
1296 range vectors can be directly fed into the calc vector functions like
1297 `vmean' and `vsum'.
1299    A formula can contain an optional mode string after a semicolon.
1300 This string consists of flags to influence Calc and other modes during
1301 execution.  By default, Org-mode uses the standard calc modes (precision
1302 12, angular units degrees, fraction and symbolic modes off.  The display
1303 format, however, has been changed to `(float 5)' to keep tables
1304 compact.  The default settings can be configured using the variable
1305 `org-calc-default-modes'.
1307      p20           switch the internal precision to 20 digits
1308      n3 s3 e2 f4   normal, scientific, engineering, or fixed display format
1309      D R           angle modes: degrees, radians
1310      F S           fraction and symbolic modes
1311      N             interpret all fields as numbers, use 0 for non-numbers
1312      T             force text interpretation
1313      E             keep empty fields in ranges
1315 In addition, you may provide a `printf' format specifier to reformat
1316 the final result.  A few examples:
1318      $1+$2                Sum of first and second field
1319      $1+$2;%.2f           Same, format result to two decimals
1320      exp($2)+exp($1)      Math functions can be used
1321      $;%.1f               Reformat current cell to 1 decimal
1322      ($3-32)*5/9          Degrees F -> C conversion
1323      $c/$1/$cm            Hz -> cm conversion, using `constants.el'
1324      tan($1);Dp3s1        Compute in degrees, precision 3, display SCI 1
1325      sin($1);Dp3%.1e      Same, but use printf specifier for display
1326      vmean($2..$7)        Compute column range mean, using vector function
1327      vmean($2..$7);EN     Same, but treat empty fields as 0
1328      taylor($3,x=7,2)     taylor series of $3, at x=7, second degree
1330 \x1f
1331 File: org,  Node: Formula syntax for Lisp,  Next: Field formulas,  Prev: Formula syntax for Calc,  Up: The spreadsheet
1333 3.4.3 Emacs Lisp forms as formulas
1334 ----------------------------------
1336 It is also possible to write a formula in Emacs Lisp; this can be useful
1337 for string manipulation and control structures.  If a formula starts
1338 with a single quote followed by an opening parenthesis, then it is
1339 evaluated as a lisp form.  The evaluation should return either a string
1340 or a number.  Just as with `calc' formulas, you can specify modes and a
1341 printf format after a semicolon.  A reference will be replaced with a
1342 string (in double quotes) containing the field.  If you provide the `N'
1343 mode switch, all referenced elements will be numbers.  Ranges are
1344 inserted as space-separated fields, so you can embed them in list or
1345 vector syntax.  A few examples, note how the `N' mode is used when we
1346 do computations in lisp.
1348      Swap the first two characters of the content of column 1
1349        '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1350      Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1351        '(+ $1 $2);N
1352      Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1353        '(apply '+ '($1..$4));N
1355 \x1f
1356 File: org,  Node: Field formulas,  Next: Column formulas,  Prev: Formula syntax for Lisp,  Up: The spreadsheet
1358 3.4.4 Field formulas
1359 --------------------
1361 To assign a formula to a particular field, type it directly into the
1362 field, preceded by `=:', for example `=:$1+$2'.  When you press <TAB>
1363 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1364 will be stored as the formula for this field, evaluated, and the
1365 current field replaced with the result.
1367    Formulas are stored in a special line starting with `#+TBLFM:'
1368 directly below the table.  If you typed the equation in the 4th field of
1369 the 3rd data line in the table, the formula will look like
1370 `@3$2=$1+$2'.  When inserting/deleting/swapping column and rows with
1371 the appropriate commands, absolute references (but not relative ones)
1372 in stored formulas are modified in order to still reference the same
1373 field.  Of cause this is not true if you edit the table structure with
1374 normal editing commands - then you must go and fix equations yourself.
1376    Instead of typing an equation into the field, you may also use the
1377 following command
1379 `C-u C-c ='
1380      Install a new formula for the current field.  The command prompts
1381      for a formula, with default taken from the `#+TBLFM:' line, applies
1382      it to the current field and stores it.
1384 \x1f
1385 File: org,  Node: Column formulas,  Next: Editing and debuggung formulas,  Prev: Field formulas,  Up: The spreadsheet
1387 3.4.5 Column formulas
1388 ---------------------
1390 Often in a table, the same formula should be used for all fields in a
1391 particular column.  Instead of having to copy the formula to all fields
1392 in that column, org-mode allows to assign a single formula to an entire
1393 column.
1395    To assign a formula to a column, type it directly into any field in
1396 the column, preceded by an equal sign, like `=$1+$2'.  When you press
1397 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1398 formula will be stored as the formula for the current column, evaluated
1399 and the current field replaced with the result.  If the field contains
1400 only `=', the previously stored formula for this column is used.  For
1401 each column, Org-mode will only remember the most recently used
1402 formula.  In the `TBLFM:' line, column formulas will look like
1403 `$4=$1+$2'.
1405    Instead of typing an equation into the field, you may also use the
1406 following command:
1408 `C-c ='
1409      Install a new formula for the current column and replace current
1410      field with the result of the formula.  The command prompts for a
1411      formula, with default taken from the `#+TBLFM' line, applies it to
1412      the current field and stores it.  With a numerical prefix (e.g.
1413      `C-5 C-c =') will apply it to that many consecutive fields in the
1414      current column.
1416 \x1f
1417 File: org,  Node: Editing and debuggung formulas,  Next: Updating the table,  Prev: Column formulas,  Up: The spreadsheet
1419 3.4.6 Editing and Debugging formulas
1420 ------------------------------------
1422 You can edit individual formulas in the minibuffer or directly in the
1423 field.  Org-mode can also prepare a special buffer with all active
1424 formulas of a table.
1426 `C-c ='
1427 `C-u C-c ='
1428      Edit the formula associated with the current column/field in the
1429      minibuffer.  See *Note Column formulas:: and *Note Field
1430      formulas::.  
1432 `C-u C-u C-c ='
1433      Re-insert the active formula (either a field formula, or a column
1434      formula) into the current field, so that you can edit it directly
1435      in the field.  The advantage over editing in the minibuffer is
1436      that you can use the command `C-c ?'.  
1438 `C-c ?'
1439      While editing a formula in a table field, highlight the field(s)
1440      referenced by the reference at the cursor position in the formula.  
1442 `C-c ''
1443      Edit all formulas for the current table in a special buffer, where
1444      the formulas will be displayed one per line.  While inside the
1445      special buffer, Org-mode will automatically highlight any field or
1446      range reference at the cursor position.  You may edit, remove and
1447      add formulas, and use the following commands:
1448     `C-c C-c'
1449           Exit the buffer and store the modified formulas.  With `C-u'
1450           prefix, also apply the new formulas to the entire table.  
1452     `C-c C-q'
1453           Exit the buffer without installing changes.  
1455     `S-<up>/<down>'
1456           Move the reference line in the Org-mode buffer up and down.
1457           This is important for highlighting the references of column
1458           formulas for different rows.  
1460     `M-<up>/<down>'
1461           Scroll the window displaying the table.
1463    Making a table field blank does not remove the formula associated
1464 with the field, because that is stored in a different line (the `TBLFM'
1465 line) - during the next recalculation the field will be filled again.
1466 To remove a formula from a field, you have to give an empty reply when
1467 prompted for the formula, or to edit the `#+TBLFM' line.
1469    You may edit the `#+TBLFM' directly and re-apply the changed
1470 equations with `C-c C-c' in that line, or with the normal recalculation
1471 commands in the table.
1473 Debugging formulas
1474 ..................
1476 When the evaluation of a formula leads to an error, the field content
1477 becomes the string `#ERROR'.  If you would like see what is going on
1478 during variable substitution and calculation in order to find a bug,
1479 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1480 for example by pressing `C-c = <RET>' in a field.  Detailed information
1481 will be displayed.
1483 \x1f
1484 File: org,  Node: Updating the table,  Next: Advanced features,  Prev: Editing and debuggung formulas,  Up: The spreadsheet
1486 3.4.7 Updating the Table
1487 ------------------------
1489 Recalculation of a table is normally not automatic, but needs to be
1490 triggered by a command.  See *Note Advanced features:: for a way to make
1491 recalculation at least semi-automatically.
1493    In order to recalculate a line of a table or the entire table, use
1494 the following commands:
1496 `C-c *'
1497      Recalculate the current row by first applying the stored column
1498      formulas from left to right, and all field formulas in the current
1499      row.
1501 `C-u C-c *'
1502 `C-u C-c C-c'
1503      Recompute the entire table, line by line.  Any lines before the
1504      first hline are left alone, assuming that these are part of the
1505      table header.
1507 `C-u C-u C-c *'
1508      Iterate the table by recomputing it until no further changes occur.
1509      This may be necessary if some computed fields use the value of
1510      other fields that are computed later in the calculation sequence.
1512 \x1f
1513 File: org,  Node: Advanced features,  Prev: Updating the table,  Up: The spreadsheet
1515 3.4.8 Advanced features
1516 -----------------------
1518 If you want the recalculation of fields to happen automatically, or if
1519 you want to be able to assign names to fields and columns, you need to
1520 reserve the first column of the table for special marking characters.
1521 `C-#'
1522      Rotate the calculation mark in first column through the states `',
1523      `#', `*', `!', `$'.  The meaning of these characters is discussed
1524      below.  When there is an active region, change all marks in the
1525      region.
1527    Here is an example of a table that collects exam results of students
1528 and makes use of these features:
1530      |---+---------+--------+--------+--------+-------+------|
1531      |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1532      |---+---------+--------+--------+--------+-------+------|
1533      | ! |         |     P1 |     P2 |     P3 |   Tot |      |
1534      | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
1535      | ^ |         |     m1 |     m2 |     m3 |    mt |      |
1536      |---+---------+--------+--------+--------+-------+------|
1537      | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
1538      | # | Sara    |      6 |     14 |     19 |    39 |  7.8 |
1539      | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
1540      |---+---------+--------+--------+--------+-------+------|
1541      |   | Average |        |        |        |  29.7 |      |
1542      | ^ |         |        |        |        |    at |      |
1543      | $ | max=50  |        |        |        |       |      |
1544      |---+---------+--------+--------+--------+-------+------|
1545      #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1547 Important: Please note that for these special tables, recalculating the
1548 table with `C-u C-c *' will only affect rows that are marked `#' or
1549 `*', and fields that have a formula assigned to the field itself.  The
1550 column formulas are not applied in rows with empty first field.
1552    The marking characters have the following meaning:
1554      The fields in this line define names for the columns, so that you
1555      may refer to a column as `$Tot' instead of `$6'.
1558      This row defines names for the fields _above_ the row.  With such
1559      a definition, any formula in the table may use `$m1' to refer to
1560      the value `10'.  Also, if you assign a formula to a names field, it
1561      will be stored as `$name=...'.
1564      Similar to `^', but defines names for the fields in the row
1565      _below_.
1568      Fields in this row can define _parameters_ for formulas.  For
1569      example, if a field in a `$' row contains `max=50', then formulas
1570      in this table can refer to the value 50 using `$max'.  Parameters
1571      work exactly like constants, only that they can be defined on a
1572      per-table basis.
1575      Fields in this row are automatically recalculated when pressing
1576      <TAB> or <RET> or `S-<TAB>' in this row.  Also, this row is
1577      selected for a global recalculation with `C-u C-c *'.  Unmarked
1578      lines will be left alone by this command.
1581      Selects this line for global recalculation with `C-u C-c *', but
1582      not for automatic recalculation.  Use this when automatic
1583      recalculation slows down editing too much.
1586      Unmarked lines are exempt from recalculation with `C-u C-c *'.
1587      All lines that should be recalculated should be marked with `#' or
1588      `*'.
1590    Finally, just to whet your appetite on what can be done with the
1591 fantastic `calc' package, here is a table that computes the Taylor
1592 series of degree `n' at location `x' for a couple of functions
1593 (homework: try that with Excel :-)
1595      |---+-------------+---+-----+--------------------------------------|
1596      |   | Func        | n | x   | Result                               |
1597      |---+-------------+---+-----+--------------------------------------|
1598      | # | exp(x)      | 1 | x   | 1 + x                                |
1599      | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
1600      | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
1601      | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1602      | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
1603      | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
1604      |---+-------------+---+-----+--------------------------------------|
1605      #+TBLFM: $5=taylor($2,$4,$3);n3
1607 \x1f
1608 File: org,  Node: Hyperlinks,  Next: TODO items,  Prev: Tables,  Up: Top
1610 4 Hyperlinks
1611 ************
1613 Just like HTML, Org-mode provides links inside a file, and external
1614 links to other files, Usenet articles, emails, and much more.
1616 * Menu:
1618 * Link format::                 How links in Org-mode are formatted
1619 * Internal links::              Links to other places in the current file
1620 * External links::              URL-like links to the world
1621 * Handling links::              Creating, inserting and following
1622 * Link abbreviations::          Shortcuts for writing complex links
1623 * Search options::              Linking to a specific location
1624 * Custom searches::             When the default search is not enough
1625 * Remember::                    Org-trees store quick notes
1627 \x1f
1628 File: org,  Node: Link format,  Next: Internal links,  Prev: Hyperlinks,  Up: Hyperlinks
1630 4.1 Link format
1631 ===============
1633 Org-mode will recognize plain URL-like links and activate them as
1634 clickable links.  The general link format, however, looks like this:
1636      [[link][description]]       or alternatively           [[link]]
1638    Once a link in the buffer is complete (all brackets present),
1639 Org-mode will change the display so that `description' is displayed
1640 instead of `[[link][description]]' and `link' is displayed instead of
1641 `[[link]]'.  Links will be highlighted in the face `org-link', which by
1642 default is an underlined face.  You can directly edit the visible part
1643 of a link.  Note that this can be either the `link' part (if there is
1644 no description) or the `description' part.  To edit also the invisible
1645 `link' part, use `C-c C-l' with the cursor on the link.
1647    If you place the cursor at the beginning or just behind the end of
1648 the displayed text and press <BACKSPACE>, you will remove the
1649 (invisible) bracket at that location.  This makes the link incomplete
1650 and the internals are again displayed as plain text.  Inserting the
1651 missing bracket hides the link internals again.  To show the internal
1652 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1653 links'.
1655 \x1f
1656 File: org,  Node: Internal links,  Next: External links,  Prev: Link format,  Up: Hyperlinks
1658 4.2 Internal links
1659 ==================
1661 If the link does not look like a URL, it is considered to be internal in
1662 the current file.  Links such as `[[My Target]]' or `[[My Target][Find
1663 my target]]' lead to a text search in the current file.  The link can
1664 be followed with `C-c C-o' when the cursor is on the link, or with a
1665 mouse click (*note Handling links::).  The preferred match for such a
1666 link is a dedicated target: the same string in double angular brackets.
1667 Targets may be located anywhere; often it is convenient to put them
1668 into a comment line. For example
1670      # <<My Target>>
1672 In HTML export (*note HTML export::), such targets will become named
1673 anchors for direct access through `http' links(1).
1675    If no dedicated target exists, Org-mode will search for the words in
1676 the link.  In the above example the search would be for `my target'.
1677 Links starting with a star like `*My Target' restrict the search to
1678 headlines.  When searching, Org-mode will first try an exact match, but
1679 then move on to more and more lenient searches.  For example, the link
1680 `[[*My Targets]]' will find any of the following:
1682      ** My targets
1683      ** TODO my targets are bright
1684      ** my 20 targets are
1686    To insert a link targeting a headline, in-buffer completion can be
1687 used.  Just type a star followed by a few optional letters into the
1688 buffer and press `M-<TAB>'.  All headlines in the current buffer will be
1689 offered as completions.  *Note Handling links::, for more commands
1690 creating links.
1692    Following a link pushes a mark onto Org-mode's own mark ring.  You
1693 can return to the previous position with `C-c &'.  Using this command
1694 several times in direct succession goes back to positions recorded
1695 earlier.
1697 * Menu:
1699 * Radio targets::               Make targets trigger links in plain text.
1700 * CamelCase links::             Activating CamelCase words as links
1702    ---------- Footnotes ----------
1704    (1) Note that text before the first headline will never be exported,
1705 so the first such target must be after the first headline.
1707 \x1f
1708 File: org,  Node: Radio targets,  Next: CamelCase links,  Prev: Internal links,  Up: Internal links
1710 4.2.1 Radio targets
1711 -------------------
1713 You can configure Org-mode to link any occurrences of certain target
1714 names in normal text.  So without explicitly creating a link, the text
1715 connects to the target radioing its position.  Radio targets are
1716 enclosed by triple angular brackets.  For example, a target `<<<My
1717 Target>>>' causes each occurrence of `my target' in normal text to
1718 become activated as a link.  The Org-mode file is scanned automatically
1719 for radio targets only when the file is first loaded into Emacs.  To
1720 update the target list during editing, press `C-c C-c' with the cursor
1721 on or at a target.
1723 \x1f
1724 File: org,  Node: CamelCase links,  Prev: Radio targets,  Up: Internal links
1726 4.2.2 CamelCase words as links
1727 ------------------------------
1729 Org-mode also supports CamelCase words as links.  This feature is not
1730 turned on by default because of the inconsistencies this system suffers
1731 from.  It is also possible that this feature will disappear entirely in
1732 a future version of Org-mode.  To activate CamelCase words as links, you
1733 need to customize the option `org-activate-links'.  A CamelCase word
1734 then leads to a text search such that `CamelCaseLink' is equivalent to
1735 `[[camel case link]]'.
1737 \x1f
1738 File: org,  Node: External links,  Next: Handling links,  Prev: Internal links,  Up: Hyperlinks
1740 4.3 External links
1741 ==================
1743 Org-mode supports links to files, websites, Usenet and email messages,
1744 and BBDB database entries.  External links are URL-like locators.  They
1745 start with a short identifying string followed by a colon.  There can be
1746 no space after the colon.  The following list shows examples for each
1747 link type.
1749      http://www.astro.uva.nl/~dominik          on the web
1750      file:/home/dominik/images/jupiter.jpg     file, absolute path
1751      file:papers/last.pdf                      file, relative path
1752      news:comp.emacs                           Usenet link
1753      mailto:adent@galaxy.net                   Mail link
1754      vm:folder                                 VM folder link
1755      vm:folder#id                              VM message link
1756      vm://myself@some.where.org/folder#id      VM on remote machine
1757      wl:folder                                 WANDERLUST folder link
1758      wl:folder#id                              WANDERLUST message link
1759      mhe:folder                                MH-E folder link
1760      mhe:folder#id                             MH-E message link
1761      rmail:folder                              RMAIL folder link
1762      rmail:folder#id                           RMAIL message link
1763      gnus:group                                GNUS group link
1764      gnus:group#id                             GNUS article link
1765      bbdb:Richard Stallman                     BBDB link
1766      shell:ls *.org                            A shell command
1767      elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1769    A link should be enclosed in double brackets and may contain a
1770 descriptive text to be displayed instead of the url (*note Link
1771 format::), for example:
1773      [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1775 If the description is a file name or URL that points to an image, HTML
1776 export (*note HTML export::) will inline the image as a clickable
1777 button.  If there is no description at all and the link points to an
1778 image, that image will be inlined into the exported HTML file.
1780    Org-mode also finds external links in the normal text and activates
1781 them as links.  If spaces must be part of the link (for example in
1782 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1783 the end of the link, enclose them in angular brackets.
1785 \x1f
1786 File: org,  Node: Handling links,  Next: Link abbreviations,  Prev: External links,  Up: Hyperlinks
1788 4.4 Handling links
1789 ==================
1791 Org-mode provides methods to create a link in the correct syntax, to
1792 insert it into an org-mode file, and to follow the link.
1794 `C-c l'
1795      Store a link to the current location.  This is a _global_ command
1796      which can be used in any buffer to create a link.  The link will be
1797      stored for later insertion into an Org-mode buffer (see below).
1798      For Org-mode files, if there is a `<<target>>' at the cursor, the
1799      link points to the target.  Otherwise it points to the current
1800      headline.  For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1801      the link will indicate the current article/entry.  For W3 and W3M
1802      buffers, the link goes to the current URL.  For any other files,
1803      the link will point to the file, with a search string (*note
1804      Search options::) pointing to the contents of the current line.
1805      If there is an active region, the selected words will form the
1806      basis of the search string.  If the automatically created link is
1807      not working correctly or accurately enough, you can write custom
1808      functions to select the search string and to do the search for
1809      particular file types - see *Note Custom searches::.  The key
1810      binding `C-c l' is only a suggestion - see *Note Installation::.
1812 `C-c C-l'
1813      Insert a link.  This prompts for a link to be inserted into the
1814      buffer.  You can just type a link, using text for an internal
1815      link, or one of the link type prefixes mentioned in the examples
1816      above.  Through completion, all links stored during the current
1817      session can be accessed(1).  The link will be inserted into the
1818      buffer, along with a descriptive text.  If some text was selecten
1819      when this command is called, the selected text becomes the default
1820      description.
1821      Note that you don't have to use this command to insert a link.
1822      Links in Org-mode are plain text, and you can type or paste them
1823      straight into the buffer.  By using this command, the links are
1824      automatically enclosed in double brackets, and you will be asked
1825      for the optional descriptive text.  If the link is a `file:' link
1826      and the linked file is located in the same directory as the
1827      current file or a subdirectory of it, the path of the file will be
1828      inserted relative to the current directory.
1830 `C-u C-c C-l'
1831      When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1832      file will be inserted and you may use file name completion to
1833      select the name of the file.  The path to the file is inserted
1834      relative to the directory of the current org file, if the linked
1835      file is in the current directory or in a subdirectory of it, or if
1836      the path is written relative to the current directory using `../'.
1837      Otherwise an absolute path is used, if possible with `~/' for
1838      your home directory.  You can force an absolute path with two
1839      `C-u' prefixes.
1841 `C-c C-l with cursor on existing link'
1842      When the cursor is on an existing link, `C-c C-l' allows you to
1843      edit the link and description parts of the link.
1845 `C-c C-o'
1846      Open link at point.  This will launch a web browser for URLs (using
1847      `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1848      the corresponding links, and execute the command in a shell link.
1849      When the cursor is on an internal link, this commands runs the
1850      corresponding search.  When the cursor is on a TAG list in a
1851      headline, it creates the corresponding TAGS view.  If the cursor
1852      is on a time stamp, it compiles the agenda for that date.
1853      Furthermore, it will visit text and remote files in `file:' links
1854      with Emacs and select a suitable application for local non-text
1855      files.  Classification of files is based on file extension only.
1856      See option `org-file-apps'.  If you want to override the default
1857      application and visit the file with Emacs, use a `C-u' prefix.
1859 `mouse-2'
1860 `mouse-1'
1861      On links, `mouse-2' will open the link just as `C-c C-o' would.
1862      Under Emacs 22, also `mouse-1' will follow a link.
1864 `mouse-3'
1865      Like `mouse-2', but force file links to be opened with Emacs, and
1866      internal links to be displayed in another window(2).
1868 `C-c %'
1869      Push the current position onto the mark ring, to be able to return
1870      easily. Commands following an internal link do this automatically.
1872 `C-c &'
1873      Jump back to a recorded position.  A position is recorded by the
1874      commands following internal links, and by `C-c %'.  Using this
1875      command several times in direct succession moves through a ring of
1876      previously recorded positions.
1878    ---------- Footnotes ----------
1880    (1) After insertion of a stored link, the link will be removed from
1881 the list of stored links.  To keep it in the list later use, use a
1882 triple `C-u' prefix to `C-c C-l', or configure the option
1883 `org-keep-stored-link-after-insertion'.
1885    (2) See the variable `org-display-internal-link-with-indirect-buffer'
1887 \x1f
1888 File: org,  Node: Link abbreviations,  Next: Search options,  Prev: Handling links,  Up: Hyperlinks
1890 4.5 Link abbreviatons
1891 =====================
1893 Long URLs can be cumbersome to type, and often many similar links are
1894 needed in a document.  For this you can use link abbreviations.  An
1895 abbreviated link looks like this
1897      [[linkword::tag][description]]
1899 where the tag is optional.  Such abbreviations are resolved according to
1900 the information in the variable `org-link-abbrev-alist' that relates
1901 the linkwords to replacement text.  Here is an example:
1903      (setq org-link-abbrev-alist
1904        '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1905          ("google"   . "http://www.google.com/search?q=")
1906          ("ads"      . "http://adsabs.harvard.edu/cgi-bin/
1907                         nph-abs_connect?author=%s&db_key=AST")))
1909    If the replacement text contains the string `%s', it will be
1910 replaced with the tag.  Otherwise the tag will be appended to the string
1911 in order to create the link.  You may also specify a function that will
1912 be called with the tag as the only argument to create the link.
1914    With the above setting, you could link to a specific bug with
1915 `[[bugzilla::129]]', search the web for OrgMode with
1916 `[[google::OrgMode]]' and find out what the Org-mode author is doing
1917 besides Emacs hacking with `[[ads::Dominik,C]]'.
1919    If you need special abbreviations just for a single Org-mode buffer,
1920 you can define them in the file with
1922      #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
1923      #+LINK: google    http://www.google.com/search?q=%s
1925 In-buffer completion *note Completion:: can be used after `[' to
1926 complete link abbreviations.
1928 \x1f
1929 File: org,  Node: Search options,  Next: Custom searches,  Prev: Link abbreviations,  Up: Hyperlinks
1931 4.6 Search options in file links
1932 ================================
1934 File links can contain additional information to make Emacs jump to a
1935 particular location in the file when following a link.  This can be a
1936 line number or a search option after a double(1) colon. For example,
1937 when the command `C-c l' creates a link (*note Handling links::) to a
1938 file, it encodes the words in the current line as a search string that
1939 can be used to find this line back later when following the link with
1940 `C-c C-o'.
1942    Here is the syntax of the different ways to attach a search to a file
1943 link, together with an explanation:
1945      [[file:~/code/main.c::255]]
1946      [[file:~/xx.org::My Target]]
1947      [[file:~/xx.org::*My Target]]
1948      [[file:~/xx.org::/regexp/]]
1950 `255'
1951      Jump to line 255.
1953 `My Target'
1954      Search for a link target `<<My Target>>', or do a text search for
1955      `my target', similar to the search in internal links, see *Note
1956      Internal links::.  In HTML export (*note HTML export::), such a
1957      file link will become an HTML reference to the corresponding named
1958      anchor in the linked file.
1960 `*My Target'
1961      In an Org-mode file, restrict search to headlines.
1963 `/regexp/'
1964      Do a regular expression search for `regexp'.  This uses the Emacs
1965      command `occur' to list all matches in a separate window.  If the
1966      target file is in Org-mode, `org-occur' is used to create a sparse
1967      tree with the matches.
1969    As a degenerate case, a file link with an empty file name can be used
1970 to search the current file.  For example, `[[file:::find me]]' does a
1971 search for `find me' in the current file, just as `[[find me]]' would.
1973    ---------- Footnotes ----------
1975    (1) For backward compatibility, line numbers can also follow a
1976 single colon.
1978 \x1f
1979 File: org,  Node: Custom searches,  Next: Remember,  Prev: Search options,  Up: Hyperlinks
1981 4.7 Custom Searches
1982 ===================
1984 The default mechanism for creating search strings and for doing the
1985 actual search related to a file link may not work correctly in all
1986 cases.  For example, BibTeX database files have many entries like
1987 `year="1993"' which would not result in good search strings, because
1988 the only unique identification for a BibTeX entry is the citation key.
1990    If you come across such a problem, you can write custom functions to
1991 set the right search string for a particular file type, and to do the
1992 search for the string in the file.  Using `add-hook', these functions
1993 need to be added to the hook variables
1994 `org-create-file-search-functions' and
1995 `org-execute-file-search-functions'.  See the docstring for these
1996 variables for more information.  Org-mode actually uses this mechanism
1997 for BibTeX database files, and you can use the corresponding code as an
1998 implementation example.  Search for `BibTeX links' in the source file.
2000 \x1f
2001 File: org,  Node: Remember,  Prev: Custom searches,  Up: Hyperlinks
2003 4.8 Remember
2004 ============
2006 Another way to create org entries with links to other files is through
2007 the _Remember_ package by John Wiegley.  _Remember_ lets you store
2008 quick notes with little interruption of your work flow.  See
2009 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2010 information.  The notes produced by _Remember_ can be stored in
2011 different ways, and Org-mode files are a good target.  Org-mode allows
2012 you to file away notes either to a default file, or directly to the
2013 correct location in your Org-mode outline tree.  The following
2014 customization will tell _Remember_ to use org files as target, and to
2015 create annotations compatible with Org-mode links.
2017      (setq org-directory "~/path/to/my/orgfiles/")
2018      (setq org-default-notes-file "~/.notes")
2019      (setq remember-annotation-functions '(org-remember-annotation))
2020      (setq remember-handler-functions '(org-remember-handler))
2021      (add-hook 'remember-mode-hook 'org-remember-apply-template)
2023    In combination with Org-mode, you can use templates to generate
2024 different types of remember notes.  For example, if you would like to
2025 use one template to create general TODO entries, and another one for
2026 journal entries, you could use:
2028      (setq org-remember-templates
2029            '((?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org")
2030              (?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")))
2032 In these entries, the character specifies how to select the template,
2033 the first string specifies the template, and the (optional) second
2034 string specifies a default file (overruling `org-default-notes-file')
2035 as a target for this note.
2037    When you call `M-x remember' to remember something, org will prompt
2038 for a key to select the template and then prepare the buffer like
2039      * TODO
2040        [[file:link to where you called remember]]
2044      * [2006-03-21 Tue 15:37]
2046        [[file:link to where you called remember]]
2048 See the variable `org-remember-templates' for more details.
2050    When you are finished composing a note with remember, you have to
2051 press `C-c C-c' to file the note away.  The handler first prompts for a
2052 target file - if you press <RET>, the value of `org-default-notes-file'
2053 is used.  Then the command offers the headings tree of the selected
2054 file.  You can either immediately press <RET> to get the note appended
2055 to the file.  Or you can use vertical cursor motion (<up> and <down>)
2056 and visibility cycling (<TAB>) to find a better place.  Pressing <RET>
2057 or <left> or <right> leads to the following result.
2059 Cursor         Key     Note gets inserted
2060 position               
2061 buffer-start   <RET>   as level 2 heading at end of file
2062 on headline    <RET>   as sublevel of the heading at cursor
2063                <left>  as same level, before current heading
2064                <right> as same level, after current heading
2065 not on         <RET>   at cursor position, level taken from context.
2066 headline                      Or use prefix arg to specify level
2067                        manually.
2069    So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
2070 append it to the default file.  Even shorter would be `C-u C-c C-c',
2071 which does the same without even showing the tree.  But with little
2072 extra effort, you can push it directly to the correct location.
2074    Before inserting the text into a tree, the function ensures that the
2075 text has a headline, i.e. a first line that starts with a `*'.  If not,
2076 a headline is constructed from the current date and some additional
2077 data.  If the variable `org-adapt-indentation' is non-nil, the entire
2078 text is also indented so that it starts in the same column as the
2079 headline (after the asterisks).
2081 \x1f
2082 File: org,  Node: TODO items,  Next: Timestamps,  Prev: Hyperlinks,  Up: Top
2084 5 TODO items
2085 ************
2087 Org-mode does not maintain TODO lists as a separate document.  TODO
2088 items are an integral part of the notes file, because TODO items
2089 usually come up while taking notes!  With Org-mode, you simply mark any
2090 entry in a tree as being a TODO item.  In this way, the information is
2091 not duplicated, and the entire context from which the item emerged is
2092 always present when you check.
2094    Of course, this technique causes TODO items to be scattered
2095 throughout your file.  Org-mode provides methods to give you an
2096 overview over all things you have to do.
2098 * Menu:
2100 * TODO basics::                 Marking and displaying TODO entries
2101 * TODO extensions::             Workflow and assignments
2102 * Priorities::                  Some things are more important than others
2103 * Breaking down tasks::         Splitting a task into managable pieces
2104 * Checkboxes::                  Tick-off lists
2106 \x1f
2107 File: org,  Node: TODO basics,  Next: TODO extensions,  Prev: TODO items,  Up: TODO items
2109 5.1 Basic TODO functionality
2110 ============================
2112 Any headline can become a TODO item by starting it with the word TODO,
2113 for example:
2115      *** TODO Write letter to Sam Fortune
2117 The most important commands to work with TODO entries are:
2119 `C-c C-t'
2120      Rotate the TODO state of the current item between
2122           ,-> (unmarked) -> TODO -> DONE --.
2123           '--------------------------------'
2125      The same rotation can also be done "remotely" from the timeline and
2126      agenda buffers with the `t' command key (*note Agenda commands::).  
2128 `S-<right>'
2129 `S-<left>'
2130      Select the following/preceding TODO state, similar to cycling.
2131      Mostly useful if more than two TODO states are possible (*note
2132      TODO extensions::).  
2134 `C-c C-v'
2135      View TODO items in a _sparse tree_ (*note Sparse trees::).  Folds
2136      the entire buffer, but shows all TODO items and the headings
2137      hierarchy above them.  With prefix arg, show also the DONE
2138      entries.  With numerical prefix N, show the tree for the Nth
2139      keyword in the variable `org-todo-keywords'.  
2141 `C-c a t'
2142      Show the global TODO list.  This collects the TODO items from all
2143      agenda files (*note Agenda views::) into a single buffer.  The
2144      buffer is in `agenda-mode', so there are commands to examine and
2145      manipulate the TODO entries directly from that buffer (*note
2146      Agenda commands::).  *Note Global TODO list::, for more
2147      information.
2149 \x1f
2150 File: org,  Node: TODO extensions,  Next: Priorities,  Prev: TODO basics,  Up: TODO items
2152 5.2 Extended use of TODO keywords
2153 =================================
2155 The default implementation of TODO entries is just two states: TODO and
2156 DONE.  You can, however, use the TODO feature for more complicated
2157 things by configuring the variables `org-todo-keywords' and
2158 `org-todo-interpretation'.  Using special setup, you can even use TODO
2159 keywords in different ways in different org files.
2161    Note that tags are another way to classify headlines in general and
2162 TODO items in particular (*note Tags::).
2164 * Menu:
2166 * Workflow states::             From TODO to DONE in steps
2167 * TODO types::                  I do this, Fred the rest
2168 * Per file keywords::           Different files, different requirements
2170 \x1f
2171 File: org,  Node: Workflow states,  Next: TODO types,  Prev: TODO extensions,  Up: TODO extensions
2173 5.2.1 TODO keywords as workflow states
2174 --------------------------------------
2176 You can use TODO keywords to indicate different states in the process
2177 of working on an item, for example:
2179      (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2180            org-todo-interpretation 'sequence)
2182    Changing these variables only becomes effective in a new Emacs
2183 session.  With this setup, the command `C-c C-t' will cycle an entry
2184 from TODO to FEEDBACK, then to VERIFY, and finally to DONE.  You may
2185 also use a prefix argument to quickly select a specific state.  For
2186 example `C-3 C-c C-t' will change the state immediately to VERIFY.  If
2187 you define many keywords, you can use in-buffer completion (see *Note
2188 Completion::) to insert these words into the buffer.  Changing a todo
2189 state can be logged with a timestamp, see *Note Tracking TODO state
2190 changes:: for more information.
2192 \x1f
2193 File: org,  Node: TODO types,  Next: Per file keywords,  Prev: Workflow states,  Up: TODO extensions
2195 5.2.2 TODO keywords as types
2196 ----------------------------
2198 The second possibility is to use TODO keywords to indicate different
2199 types of action items.  For example, you might want to indicate that
2200 items are for "work" or "home".  If you are into David Allen's _Getting
2201 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2202 `MAYBE'.  Or, when you work with several people on a single project,
2203 you might want to assign action items directly to persons, by using
2204 their names as TODO keywords.  This would be set up like this:
2206      (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2207            org-todo-interpretation 'type)
2209    In this case, different keywords do not indicate a sequence, but
2210 rather different types.  So it is normally not useful to change from
2211 one type to another.  Therefore, in this case the behavior of the
2212 command `C-c C-t' is changed slightly(1).  When used several times in
2213 succession, it will still cycle through all names.  But when you return
2214 to the item after some time and execute `C-c C-t' again, it will switch
2215 from each name directly to DONE.  Use prefix arguments or completion to
2216 quickly select a specific name.  You can also review the items of a
2217 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2218 C-v'.  For example, to see all things Lucy has to do, you would use
2219 `C-3 C-c C-v'.  To collect Lucy's items from all agenda files into a
2220 single buffer, you would use the prefix arg as well when creating the
2221 global todo list: `C-3 C-c t'.
2223    ---------- Footnotes ----------
2225    (1) This is also true for the `t' command in the timeline and agenda
2226 buffers.
2228 \x1f
2229 File: org,  Node: Per file keywords,  Prev: TODO types,  Up: TODO extensions
2231 5.2.3 Setting up TODO keywords for individual files
2232 ---------------------------------------------------
2234 It can be very useful to use different aspects of the TODO mechanism in
2235 different files, which is not possible with the global settings
2236 described above.  For file-local settings, you need to add special
2237 lines to the file which set the keywords and interpretation for that
2238 file only.  For example, to set one of the two examples discussed
2239 above, you need one of the following lines, starting in column zero
2240 anywhere in the file:
2242      #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2243      #+TYP_TODO: Fred Sara Lucy Mike DONE
2245 To make sure you are using the correct keyword, type `#+' into the
2246 buffer and then use `M-<TAB>' completion.
2248    Remember that the last keyword must always mean that the item is DONE
2249 (although you may use a different word).  Also note that in each file,
2250 only one of the two aspects of TODO keywords can be used.  After
2251 changing one of these lines, use `C-c C-c' with the cursor still in the
2252 line to make the changes known to Org-mode(1).
2254    If you want to use very many keywords, for example when working with
2255 a large group of people, you may split the names over several lines:
2257      #+TYP_TODO: Fred Sara Lucy Mike
2258      #+TYP_TODO: Luis George Jules Jessica
2259      #+TYP_TODO: Kim Arnold Peter
2260      #+TYP_TODO: DONE
2262    ---------- Footnotes ----------
2264    (1) Org-mode parses these lines only when Org-mode is activated
2265 after visiting a file.  `C-c C-c' with the cursor in a line starting
2266 with `#+' is simply restarting Org-mode for the current buffer.
2268 \x1f
2269 File: org,  Node: Priorities,  Next: Breaking down tasks,  Prev: TODO extensions,  Up: TODO items
2271 5.3 Priorities
2272 ==============
2274 If you use Org-mode extensively to organize your work, you may end up
2275 with a number of TODO entries so large that you'd like to prioritize
2276 them.  This can be done by placing a _priority cookie_ into the
2277 headline, like this
2279      *** TODO [#A] Write letter to Sam Fortune
2281 With its standard setup, Org-mode supports priorities `A', `B', and
2282 `C'.  `A' is the highest priority.  An entry without a cookie is
2283 treated as priority `B'.  Priorities make a difference only in the
2284 agenda (*note Weekly/Daily agenda::).
2286 `C-c ,'
2287      Set the priority of the current headline.  The command prompts for
2288      a priority character `A', `B' or `C'.  When you press <SPC>
2289      instead, the priority cookie is removed from the headline.  The
2290      priorities can also be changed "remotely" from the timeline and
2291      agenda buffer with the `,' command (*note Agenda commands::).
2293 `S-<up>'
2294 `S-<down>'
2295      Increase/decrease priority of current headline.  Note that these
2296      keys are also used to modify time stamps (*note Creating
2297      timestamps::).  Furthermore, these keys are also used by CUA-mode
2298      (*note Conflicts::).
2300 \x1f
2301 File: org,  Node: Breaking down tasks,  Next: Checkboxes,  Prev: Priorities,  Up: TODO items
2303 5.4 Breaking tasks down into subtasks
2304 =====================================
2306 It is often advisable to break down large tasks into smaller, managable
2307 subtasks.  You can do this by creating an outline tree below a TODO
2308 item, with detailed subtasks on the tree(1).  Another possibility is
2309 the use of checkboxes to identify (a hierarchy of) a large number of
2310 subtasks (*note Checkboxes::).
2312    ---------- Footnotes ----------
2314    (1) To keep subtasks out of the global TODO list, see the
2315 `org-agenda-todo-list-sublevels'.
2317 \x1f
2318 File: org,  Node: Checkboxes,  Prev: Breaking down tasks,  Up: TODO items
2320 5.5 Checkboxes
2321 ==============
2323 Every item in a plain list (*note Plain lists::) can be made a checkbox
2324 by starting it with the string `[ ]'.  This feature is similar to TODO
2325 items (*note TODO items::), but more lightweight.  Checkboxes are not
2326 included into the global TODO list, so they are often great to split a
2327 task into a number of simple steps.  Or you can use them in a shopping
2328 list.  To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2329 `org-mouse.el'.  Here is an example of a checkbox list.
2331      * TODO Organize party [3/6]
2332        - call people [1/3]
2333          - [ ] Peter
2334          - [X] Sarah
2335          - [ ] Sam
2336        - [X] order food
2337        - [ ] think about what music to play
2338        - [X] talk to the neighbors
2340    The `[3/6]' and `[1/3]' in the first and second line are cookies
2341 indicating how many checkboxes are present in this entry, and how many
2342 of them have been checked off.  This can give you an idea on how many
2343 checkboxes remain, even without opening a folded entry.  The cookies
2344 can be placed into a headline or into (the first line of) a plain list
2345 item. Each cookie covers all checkboxes structurally below that
2346 headline/item.  You have to insert the cookie yourself by typing either
2347 `[/]' or `[%]'.  In the first case you get an `n out of m' result, in
2348 the second case you get information about the percentage of checkboxes
2349 checked (in the above example, this would be `[50%]' and `[33%],
2350 respectively').
2352 The following commands work with checkboxes:
2354 `C-c C-c'
2355      Toggle checkbox at point.  
2357 `C-c C-x C-b'
2358      Toggle checkbox at point.
2359         - If there is an active region, toggle the first checkbox in
2360           the region and set all remaining boxes to the same status as
2361           the first.  If you want to toggle all boxes in the region
2362           independently, use a prefix argument.
2364         - If the cursor is in a headline, toggle checkboxes in the
2365           region between this headline and the next (so _not_ the
2366           entire subtree).
2368         - If there is no active region, just toggle the checkbox at
2369           point.
2370      
2371 `M-S-<RET>'
2372      Insert a new item with a checkbox.  This works only if the cursor
2373      is already in a plain list item (*note Plain lists::).  
2375 `C-c #'
2376      Update the checkbox statistics in the current outline entry.  When
2377      called with a `C-u' prefix, update the entire file.  Checkbox
2378      statistic cookies are updated automatically if you toggle
2379      checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'.  If
2380      you delete boxes or add/change them by hand, use this command to
2381      get things back into synch.  Or simply toggle any checkbox twice
2382      with `C-c C-c'.
2384 \x1f
2385 File: org,  Node: Timestamps,  Next: Tags,  Prev: TODO items,  Up: Top
2387 6 Timestamps
2388 ************
2390 Items can be labeled with timestamps to make them useful for project
2391 planning.
2393 * Menu:
2395 * Time stamps::                 Assigning a time to a tree entry
2396 * Creating timestamps::         Commands which insert timestamps
2397 * Custom time format::          If you cannot work with the ISO format
2398 * Repeating items::             Deadlines that come back again and again
2399 * Progress logging::            Documenting when what work was done.
2401 \x1f
2402 File: org,  Node: Time stamps,  Next: Creating timestamps,  Prev: Timestamps,  Up: Timestamps
2404 6.1 Time stamps, deadlines and scheduling
2405 =========================================
2407 A time stamp is a specification of a date (possibly with time) in a
2408 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2409 09:39>'(1).  A time stamp can appear anywhere in the headline or body
2410 of an org-tree entry.  Its presence allows entries to be shown on
2411 specific dates in the agenda (*note Weekly/Daily agenda::).  We
2412 distinguish:
2414 PLAIN TIME STAMP
2415      A simple time stamp just assigns a date/time to an item.  This is
2416      just like writing down an appointment in a paper agenda, or like
2417      writing down an event in a diary, when you want to take note of
2418      when something happened.  In the timeline and agenda displays, the
2419      headline of an entry associated with a plain time stamp will be
2420      shown exactly on that date.
2422           * Meet Peter at the movies <2006-11-01 Wed 19:15>
2424 INACTIVE TIME STAMP
2425      Just like a plain time stamp, but with square brackets instead of
2426      angular ones.  These time stamps are inactive in the sense that
2427      they do _not_ trigger an entry to show up in the agenda.
2429           * Gillian comes late for the fifth time [2006-11-01 Wed]
2431 TIME STAMP RANGE
2432      Two time stamps connected by `--' denote a time range.  The
2433      headline will be shown on the first and last day of the range, and
2434      on any dates that are displayed and fall in the range.  Here is an
2435      example:
2437           ** Meeting in Amsterdam
2438              <2004-08-23 Mon>--<2004-08-26 Thu>
2440 TIME STAMP WITH SCHEDULED KEYWORD
2441      If a time stamp is preceded by the word `SCHEDULED:', it means you
2442      are planning to start working on that task on the given date. So
2443      this is not about recording an event, but about planning your
2444      work.  The headline will be listed under the given date(2).  In
2445      addition, a reminder that the scheduled date has passed will be
2446      present in the compilation for _today_, until the entry is marked
2447      DONE.  I.e., the task will automatically be forwarded until
2448      completed.
2450           *** TODO Call Trillian for a date on New Years Eve.
2451               SCHEDULED: <2004-12-25 Sat>
2453 TIME STAMP WITH DEADLINE KEYWORD
2454      If a time stamp is preceded by the word `DEADLINE:', the task
2455      (most likely a TODO item) is supposed to be finished on that date,
2456      and it will be listed then.  In addition, the compilation for
2457      _today_ will carry a warning about the approaching or missed
2458      deadline, starting `org-deadline-warning-days' before the due
2459      date, and continuing until the entry is marked DONE.  An example:
2461           *** TODO write article about the Earth for the Guide
2462               The editor in charge is [[bbdb:Ford Prefect]]
2463               DEADLINE: <2004-02-29 Sun>
2465 TIME STAMP WITH CLOSED KEYWORD
2466      When `org-log-done' is non-nil, Org-mode will automatically insert
2467      a special time stamp each time a TODO entry is marked done (*note
2468      Progress logging::).  This time stamp is enclosed in square
2469      brackets instead of angular brackets.
2471 TIME RANGE WITH CLOCK KEYWORD
2472      When using the clock to time the work that is being done on
2473      specific items, time ranges preceded by the CLOCK keyword are
2474      inserted automatically into the file.  The time stamps are
2475      enclosed in square brackets instead of angular brackets.  *Note
2476      Clocking work time::.
2478    ---------- Footnotes ----------
2480    (1) This is the standard ISO date/time format.  If you cannot get
2481 used to these, see *Note Custom time format::
2483    (2) It will still be listed on that date after it has been marked
2484 DONE.  If you don't like this, set the variable
2485 `org-agenda-skip-scheduled-if-done'.
2487 \x1f
2488 File: org,  Node: Creating timestamps,  Next: Custom time format,  Prev: Time stamps,  Up: Timestamps
2490 6.2 Creating timestamps
2491 =======================
2493 For Org-mode to recognize time stamps, they need to be in the specific
2494 format.  All commands listed below produce time stamps in the correct
2495 format.
2497 `C-c .'
2498      Prompt for a date and insert a corresponding time stamp.  When the
2499      cursor is at a previously used time stamp, it is updated to NOW.
2500      When this command is used twice in succession, a time range is
2501      inserted.
2503 `C-u C-c .'
2504      Like `C-c .', but use the alternative format which contains date
2505      and time.  The default time can be rounded to multiples of 5
2506      minutes, see the option `org-time-stamp-rounding-minutes'.
2508 `C-c !'
2509      Like `C-c .', but insert an inactive time stamp not triggering the
2510      agenda.
2512 `C-c <'
2513      Insert a time stamp corresponding to the cursor date in the
2514      Calendar.
2516 `C-c >'
2517      Access the Emacs calendar for the current date.  If there is a
2518      timestamp in the current line, goto the corresponding date instead.
2520 `C-c C-o'
2521      Access the agenda for the date given by the time stamp or -range at
2522      point (*note Weekly/Daily agenda::).
2524 `C-c C-d'
2525      Insert `DEADLINE' keyword along with a stamp.  The insertion will
2526      happen in the line directly following the headline.
2528 `C-c C-w'
2529      Create a sparse tree with all deadlines that are either past-due,
2530      or which will become due within `org-deadline-warning-days'.  With
2531      `C-u' prefix, show all deadlines in the file.  With a numeric
2532      prefix, check that many days.  For example, `C-1 C-c C-w' shows
2533      all deadlines due tomorrow.
2535 `C-c C-s'
2536      Insert `SCHEDULED' keyword along with a stamp.  The insertion will
2537      happen in the line directly following the headline.  Any CLOSED
2538      timestamp will be removed.
2540 `S-<left>'
2541 `S-<right>'
2542      Change date at cursor by one day.  These key bindings conflict with
2543      CUA-mode (*note Conflicts::).
2545 `S-<up>'
2546 `S-<down>'
2547      Change the item under the cursor in a timestamp.  The cursor can
2548      be on a year, month, day, hour or minute.  Note that if the cursor
2549      is in a headline and not at a time stamp, these same keys modify
2550      the priority of an item.  (*note Priorities::). The key bindings
2551      also conflict with CUA-mode (*note Conflicts::).
2553 `C-c C-y'
2554      Evaluate a time range by computing the difference between start and
2555      end.  With prefix arg, insert result after the time range (in a
2556      table: into the following column).
2558 * Menu:
2560 * The date/time prompt::        How org-mode helps you entering date and time
2562 \x1f
2563 File: org,  Node: The date/time prompt,  Prev: Creating timestamps,  Up: Creating timestamps
2565 6.2.1 The date/time prompt
2566 --------------------------
2568 When Org-mode prompts for a date/time, the prompt suggests to enter an
2569 ISO date.  But it will in fact accept any string containing some date
2570 and/or time information.  You can, for example, use `C-y' to paste a
2571 (possibly multi-line) string copied from an email message.  Org-mode
2572 will find whatever information is in there and will replace anything not
2573 specified with the current date and time.  For example:
2575        3-2-5         --> 2003-02-05
2576        feb 15        --> currentyear-02-15
2577        sep 12 9      --> 2009-09-12
2578        12:45         --> today 12:45
2579        22 sept 0:34  --> currentyear-09-22 0:34
2580        12            --> currentyear-currentmonth-12
2581        Fri           --> nearest Friday (today or later)
2582        +4            --> 4 days from now (if +N is the only thing given)
2584    The function understands English month and weekday abbreviations.  If
2585 you want to use unabbreviated names and/or other languages, configure
2586 the variables `parse-time-months' and `parse-time-weekdays'.
2588    Parallel to the minibuffer prompt, a calendar is popped up(1).  You
2589 can control the calendar fully from the minibuffer:
2592      Scroll calendar backwards by one month.  
2595      Scroll calendar forwards by one month.  
2597 `mouse-1'
2598      Select date by clicking on it.  
2600 `S-<right>'
2601      One day forward.  
2603 `S-<left>'
2604      One day back.  
2606 `S-<down>'
2607      One week forward.  
2609 `S-<up>'
2610      One week back.  
2612 `M-S-<right>'
2613      One month forward.  
2615 `M-S-<left>'
2616      One month back.  
2618 `<RET>'
2619      Choose date in calendar (only if nothing was typed into
2620      minibuffer).
2622    ---------- Footnotes ----------
2624    (1) If you don't need/want the calendar, configure the variable
2625 `org-popup-calendar-for-date-prompt'.
2627 \x1f
2628 File: org,  Node: Custom time format,  Next: Repeating items,  Prev: Creating timestamps,  Up: Timestamps
2630 6.3 Custom time format
2631 ======================
2633 Org-mode uses the standard ISO notation for dates and times as it is
2634 defined in ISO 8601.  If you cannot get used to this and require another
2635 representation of date and time to keep you happy, you can get it by
2636 customizing the variables `org-display-custom-times' and
2637 `org-time-stamp-custom-formats'.
2639 `C-c C-x C-t'
2640      Toggle the display of custom formats for dates and times.
2642 Org-mode needs the default format for scanning, so the custom date/time
2643 format does not _replace_ the default format - instead it is put _over_
2644 the default format using text properties.  This has the following
2645 consequences:
2646    * You cannot place the cursor onto a time stamp anymore, only before
2647      or after.
2649    * The `S-<up>/<down>' keys can no longer be used to adjust each
2650      component of a time stamp.  If the cursor is at the beginning of
2651      the stamp, `S-<up>/<down>' will change the stamp by one day, just
2652      like `S-<left>/<right>'.  At the end of the stamp, the time will
2653      be changed by one minute.
2655    * When you delete a time stamp character-by-character, it will only
2656      disappear from the buffer after _all_ (invisible) characters
2657      belonging to the ISO timestamp have been removed.
2659    * If the custom time stamp format is longer than the default and you
2660      are using dates in tables, table alignment will be messed up.  If
2661      the custom format is shorter, things do work as expected.
2663 \x1f
2664 File: org,  Node: Repeating items,  Next: Progress logging,  Prev: Custom time format,  Up: Timestamps
2666 6.4 Repeating items
2667 ===================
2669 Org-mode integrates with the Emacs calendar and diary to display cyclic
2670 appointments, anniversaries and other special entries in the agenda
2671 (*note Weekly/Daily agenda::).  However, it can be useful to have
2672 certain deadlines and scheduling items to auto-repeat.  The advantage of
2673 a deadline or scheduled item is that the they produce warnings ahead of
2674 time and automatically forward themselves in the agenda until they are
2675 done.  The abstract difference is therefore between cyclic appointments
2676 and cyclic action items.  For appointments you should use the diary,
2677 for actions you can uses an org-mode deadline or scheduling time stamp
2678 together with a REPEAT cookie.  For example:
2680      * TODO Replace batteries in smoke detector REPEAT(+18m)
2681        SCHEDULED: <2007-01-01 Mon>
2683      * TODO Get dentist appointment REPEAT(+6m)
2684        SCHEDULED: <2006-12-19 Tue>
2686      * TODO Tax report to IRS REPEAT(+1y)
2687        DEADLINE: <2007-04-01 Sun>
2689    Each time you try to mark one of these entries DONE using `C-c C-t',
2690 they will automatically switch back to the state TODO, and the
2691 deadline/scheduling will be shifted accordingly.  The time units
2692 recognized by org-mode are year (y), month (m), week (w), and day (d).
2693 Org-mode will also prompt you for a note and record the fact that you
2694 have closed this item in a note under the headline.
2696    One unusual property of these repeating items is that only one
2697 instance of each exist at any given time.  So if you look back or ahead
2698 in the agenda, you will not find past and future instances, only the
2699 current one will show up.  Use a cyclic diary entry if you need all
2700 past and future instances to be visible in the agenda.
2702 \x1f
2703 File: org,  Node: Progress logging,  Prev: Repeating items,  Up: Timestamps
2705 6.5 Progress Logging
2706 ====================
2708 Org-mode can automatically record a time stamp when you mark a TODO item
2709 as DONE, or even each time when you change the state of a TODO item.
2710 You can also measure precisely the time you spent on specific items in a
2711 project by starting and stopping a clock when you start and stop working
2712 on an aspect of a project.
2714 * Menu:
2716 * Closing items::               When was this entry marked DONE?
2717 * Tracking TODO state changes::  When did the status change?
2718 * Clocking work time::          When exactly did you work on this item?
2720 \x1f
2721 File: org,  Node: Closing items,  Next: Tracking TODO state changes,  Prev: Progress logging,  Up: Progress logging
2723 6.5.1 Closing items
2724 -------------------
2726 If you want to keep track of _when_ a certain TODO item was finished,
2727 turn on logging with(1)
2729      (setq org-log-done t)
2731 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2732 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2733 [timestamp]' will be inserted just after the headline.  If you turn the
2734 entry back into a TODO item through further state cycling, that line
2735 will be removed again.  In the timeline (*note Timeline::) and in the
2736 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
2737 display the TODO items closed on each day, giving you an overview of
2738 what has been done on a day.  If you want to record a note along with
2739 the timestamp, use(2)
2741      (setq org-log-done '(done))
2743    ---------- Footnotes ----------
2745    (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
2747    (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
2749 \x1f
2750 File: org,  Node: Tracking TODO state changes,  Next: Clocking work time,  Prev: Closing items,  Up: Progress logging
2752 6.5.2 Tracking TODO state changes
2753 ---------------------------------
2755 When TODO keywords are used as workflow states (*note Workflow
2756 states::), you might want to keep track of when a state change occurred,
2757 and you may even want to attach notes to that state change.  With the
2758 setting
2760      (setq org-log-done '(state))
2762 each state change will prompt you for a note that will be attached to
2763 the current headline.  Very likely you do not want this verbose tracking
2764 all the time, so it is probably better to configure this behavior with
2765 in-buffer options.  For example, if you are tracking purchases, put
2766 these into a separate file that starts with:
2768      #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
2769      #+STARTUP: lognotestate
2771 \x1f
2772 File: org,  Node: Clocking work time,  Prev: Tracking TODO state changes,  Up: Progress logging
2774 6.5.3 Clocking work time
2775 ------------------------
2777 Org-mode allows you to clock the time you spent on specific tasks in a
2778 project.  When you start working on an item, you can start the clock.
2779 When you stop working on that task, or when you mark the task done, the
2780 clock is stopped and the corresponding time interval is recorded.  It
2781 also computes the total time spent on each subtree of a project.
2783 `C-c C-x C-i'
2784      Start the clock on the current item (clock-in).  This inserts the
2785      CLOCK keyword together with a timestamp.  
2787 `C-c C-x C-o'
2788      Stop the clock (clock-out).  The inserts another timestamp at the
2789      same location where the clock was last started.  It also directly
2790      computes the resulting time in inserts it after the time range as
2791      `=> HH:MM'.  See the variable `org-log-done' for the possibility to
2792      record an additional note together with the clock-out time
2793      stamp(1).  
2795 `C-c C-y'
2796      Recompute the time interval after changing one of the time stamps.
2797      This is only necessary if you edit the time stamps directly.  If
2798      you change them with `S-<cursor>' keys, the update is automatic.  
2800 `C-c C-t'
2801      Changing the TODO state of an item to DONE automatically stops the
2802      clock if it is running in this same item.  
2804 `C-c C-x C-x'
2805      Cancel the current clock.  This is useful if a clock was started by
2806      mistake, or if you ended up working on something else.  
2808 `C-c C-x C-d'
2809      Display time summaries for each subtree in the current buffer.
2810      This puts overlays at the end of each headline, showing the total
2811      time recorded under that heading, including the time of any
2812      subheadings. You can use visibility cycling to study the tree, but
2813      the overlays disappear when you change the buffer (see variable
2814      `org-remove-highlights-with-change') or press `C-c C-c'.  
2816 `C-c C-x C-r'
2817      Insert a dynamic block (*note Dynamic blocks::) containing a clock
2818      report as an org-mode table into the current file.
2819           #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2821           #+END: clocktable
2822      If such a block already exists, its content is replaced by the new
2823      table.  The `BEGIN' line can specify options:
2824           :maxlevels   Maximum level depth to which times are listed in the table.
2825           :emphasize   When `t', emphasize level one and level two items
2826           :block       The time block to consider.  This block is specified relative
2827                        to the current time and may be any of these keywords:
2828                        `today', `yesterday', `thisweek', `lastweek',
2829                        `thismonth', `lastmonth', `thisyear', or `lastyear'.
2830           :tstart      A time string specifying when to start considering times
2831           :tend        A time string specifying when to stop considering times
2832      So to get a clock summary for the current day, you could write
2833           #+BEGIN: clocktable :maxlevel 2 :block today
2835           #+END: clocktable
2836      and to use a specific time range you could write(2)
2837           #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2838                               :tend "<2006-08-10 Thu 12:00>"
2840           #+END: clocktable
2841      
2842 `C-u C-c C-x C-u'
2843      Update all dynamic blocks (*note Dynamic blocks::).  This is
2844      useful if you have several clocktable blocks in a buffer.
2846    The `l' key may be used in the timeline (*note Timeline::) and in
2847 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2848 worked on or closed during a day.
2850    ---------- Footnotes ----------
2852    (1) The corresponding in-buffer setting is: `#+STARTUP:
2853 lognoteclock-out'
2855    (2) Note that all parameters must be specified in a single line -
2856 the line is broken here only to fit it onto the manual.
2858 \x1f
2859 File: org,  Node: Tags,  Next: Agenda views,  Prev: Timestamps,  Up: Top
2861 7 Tags
2862 ******
2864 If you wish to implement a system of labels and contexts for
2865 cross-correlating information, an excellent way is to assign tags to
2866 headlines.  Org-mode has extensive support for using tags.
2868    Every headline can contain a list of tags, at the end of the
2869 headline.  Tags are normal words containing letters, numbers, `_', and
2870 `@'.  Tags must be preceded and followed by a single colon; like
2871 `:WORK:'.  Several tags can be specified like `:WORK:URGENT:'.
2873 * Menu:
2875 * Tag inheritance::             Tags use the tree structure of the outline
2876 * Setting tags::                How to assign tags to a headline
2877 * Tag searches::                Searching for combinations of tags
2879 \x1f
2880 File: org,  Node: Tag inheritance,  Next: Setting tags,  Prev: Tags,  Up: Tags
2882 7.1 Tag inheritance
2883 ===================
2885 Tags make use of the hierarchical structure of outline trees.  If a
2886 heading has a certain tag, all subheadings will inherit the tag as
2887 well.  For example, in the list
2889      * Meeting with the French group      :WORK:
2890      ** Summary by Frank                  :BOSS:NOTES:
2891      *** TODO Prepare slides for him      :ACTION:
2893 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2894 `:ACTION:'.  When executing tag searches and Org-mode finds that a
2895 certain headline matches the search criterion, it will not check any
2896 sublevel headline, assuming that these likely also match, and that the
2897 list of matches can become very long.  This may not be what you want,
2898 however, and you can influence inheritance and searching using the
2899 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2901 \x1f
2902 File: org,  Node: Setting tags,  Next: Tag searches,  Prev: Tag inheritance,  Up: Tags
2904 7.2 Setting tags
2905 ================
2907 Tags can simply be typed into the buffer at the end of a headline.
2908 After a colon, `M-<TAB>' offers completion on tags.  There is also a
2909 special command for inserting tags:
2911 `C-c C-c'
2912      Enter new tags for the current headline.  Org-mode will either
2913      offer completion or a special single-key interface for setting
2914      tags, see below.  After pressing <RET>, the tags will be inserted
2915      and aligned to `org-tags-column'.  When called with a `C-u'
2916      prefix, all tags in the current buffer will be aligned to that
2917      column, just to make things look nice.  TAGS are automatically
2918      realigned after promotion, demotion, and TODO state changes (*note
2919      TODO basics::).
2921    Org will support tag insertion based on a _list of tags_.  By
2922 default this list is constructed dynamically, containing all tags
2923 currently used in the buffer.  You may also globally specify a hard list
2924 of tags with the variable `org-tag-alist'.  Finally you can set the
2925 default tags for a given file with lines like
2927      #+TAGS: @WORK @HOME @TENNISCLUB
2928      #+TAGS: Laptop Car PC Sailboat
2930    If you have globally defined your preferred set of tags using the
2931 variable `org-tag-alist', but would like to use a dynamic tag list in a
2932 specific file: Just add an empty TAGS option line to that file:
2934      #+TAGS:
2936    The default support method for entering tags is minibuffer
2937 completion.  However, Org-mode also implements a much better method:
2938 _fast tag selection_.  This method allows to select and deselect tags
2939 with a single key per tag.  To function efficiently, you should assign
2940 unique keys to most tags.  This can be done globally with
2942      (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2944 or on a per-file basis with
2946      #+TAGS: @WORK(w)  @HOME(h)  @TENNISCLUB(t)  Laptop(l)  PC(p)
2948 You can also group together tags that are mutually exclusive.  With
2949 curly braces(1)
2951      #+TAGS: { @WORK(w)  @HOME(h)  @TENNISCLUB(t) }  Laptop(l)  PC(p)
2953 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2954 should be selected.
2956 Don't forget to press `C-c C-c' with the cursor in one of these lines
2957 to activate any changes.
2959    If at least one tag has a selection key, pressing `C-c C-c' will
2960 automatically present you with a special interface, listing inherited
2961 tags, the tags of the current headline, and a list of all legal tags
2962 with corresponding keys(2).  In this interface, you can use the
2963 following keys:
2965 `a-z...'
2966      Pressing keys assigned to tags will add or remove them from the
2967      list of tags in the current line.  Selecting a tag in a group of
2968      mutually exclusive tags will turn off any other tags from that
2969      group.  
2971 `<TAB>'
2972      Enter a tag in the minibuffer, even if the tag is not in the
2973      predefined list.  You will be able to complete on all tags present
2974      in the buffer.  
2976 `<SPC>'
2977      Clear all tags for this line.  
2979 `<RET>'
2980      Accept the modified set.
2982 `C-g'
2983      Abort without installing changes.
2986      If `q' is not assigned to a tag, it aborts like `C-g'.
2989      Turn off groups of mutually exclusive tags.  Use this to (as an
2990      exception) assign several tags from such a group.
2992 `C-c'
2993      Toggle auto-exit after the next change (see below).
2995 This method lets you assign tags to a headline with very few keys.  With
2996 the above setup, you could clear the current tags and set `@HOME',
2997 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
2998 p <RET>'.  Switching from `@HOME' to `@WORK' would be done with `C-c
2999 C-c w <RET>' or alternatively with `C-c C-c C-c w'.  Adding the
3000 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3001 <RET> <RET>'.
3003    If you find that most of the time, you need only a single keypress to
3004 modify your list of tags, set the variable
3005 `org-fast-tag-selection-single-key'.  Then you no longer have to press
3006 <RET> to exit fast tag selection - it will immediately exit after the
3007 first change.  If you then occasionally need more keys, press `C-c' to
3008 turn off auto-exit for the current tag selection process.
3010    ---------- Footnotes ----------
3012    (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3013 respectively.  Several groups are allowed.
3015    (2) Keys will automatically be assigned to tags which have no
3016 configured keys.
3018 \x1f
3019 File: org,  Node: Tag searches,  Prev: Setting tags,  Up: Tags
3021 7.3 Tag searches
3022 ================
3024 Once a tags system has been set up, it can be used to collect related
3025 information into special lists.
3027 `C-c \'
3028      Create a sparse tree with all headlines matching a tags search.
3029      With a `C-u' prefix argument, ignore headlines that are not a TODO
3030      line.  
3032 `C-c a m'
3033      Create a global list of tag matches from all agenda files.  *Note
3034      Matching headline tags::.  
3036 `C-c a M'
3037      Create a global list of tag matches from all agenda files, but
3038      check only TODO items and force checking subitems (see variable
3039      `org-tags-match-list-sublevels').
3041    A tags search string can use Boolean operators `&' for AND and `|'
3042 for OR.  `&' binds more strongly than `|'.  Parenthesis are currently
3043 not implemented.  A tag may also be preceded by `-', to select against
3044 it, and `+' is syntactic sugar for positive selection.  The AND
3045 operator `&' is optional when `+' or `-' is present.  Examples:
3047 `+WORK-BOSS'
3048      Select headlines tagged `:WORK:', but discard those also tagged
3049      `:BOSS:'.
3051 `WORK|LAPTOP'
3052      Selects lines tagged `:WORK:' or `:LAPTOP:'.
3054 `WORK|LAPTOP&NIGHT'
3055      Like before, but require the `:LAPTOP:' lines to be tagged also
3056      `NIGHT'.
3058    If you are using multi-state TODO keywords (*note TODO
3059 extensions::), it can be useful to also match on the TODO keyword.
3060 This can be done by adding a condition after a slash to a tags match.
3061 The syntax is similar to the tag matches, but should be applied with
3062 consideration: For example, a positive selection on several TODO
3063 keywords can not meaningfully be combined with boolean AND.  However,
3064 _negative selection_ combined with AND can be meaningful.  To make sure
3065 that only lines are checked that actually have any TODO keyword, use
3066 `C-c a M', or equivalently start the todo part after the slash with `!'.
3067 Examples:
3069 `WORK/WAITING'
3070      Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3071      `WAITING'.
3073 `WORK/!-WAITING-NEXT'
3074      Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3075      `NEXT'
3077 `WORK/+WAITING|+NEXT'
3078      Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3079      `NEXT'.
3081    Any element of the tag/todo match can be a regular expression - in
3082 this case it must be enclosed in curly braces.  For example,
3083 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3084 tag starting with `BOSS'.
3086    You can also require a headline to be of a certain level, by writing
3087 instead of any TAG an expression like `LEVEL=3'.  For example, a search
3088 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3089 BOSS and are _not_ marked with the todo keyword DONE.
3091 \x1f
3092 File: org,  Node: Agenda views,  Next: Embedded LaTeX,  Prev: Tags,  Up: Top
3094 8 Agenda Views
3095 **************
3097 Due to the way Org-mode works, TODO items, time-stamped items, and
3098 tagged headlines can be scattered throughout a file or even a number of
3099 files.  To get an overview over open action items, or over events that
3100 are important for a particular date, this information must be collected,
3101 sorted and displayed in an organized way.
3103    Org-mode can select items based on various criteria, and display them
3104 in a separate buffer.  Six different view types are provided:
3106    * an _agenda_ that is like a calendar and shows information for
3107      specific dates,
3109    * a _TODO list_ that covers all unfinished action items,
3111    * a _tags view_, showings headlines based on the tags associated
3112      with them,
3114    * a _timeline view_ that shows all events in a single Org-mode file,
3115      in time-sorted view,
3117    * a _stuck projects view_ showing projects that currently don't move
3118      along, and
3120    * _custom views_ that are special tag/keyword searches and
3121      combinations of different views.
3123 The extracted information is displayed in a special _agenda buffer_.
3124 This buffer is read-only, but provides commands to visit the
3125 corresponding locations in the original Org-mode files, and even to
3126 edit these files remotely.
3128    Two variables control how the agenda buffer is displayed and whether
3129 the window configuration is restored when the agenda exits:
3130 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3132 * Menu:
3134 * Agenda files::                Files being searched for agenda information
3135 * Agenda dispatcher::           Keyboard access to agenda views
3136 * Built-in agenda views::       What is available out of the box?
3137 * Presentation and sorting::    How agenda items are prepared for display
3138 * Agenda commands::             Remote editing of org trees
3139 * Custom agenda views::         Defining special searches and views
3141 \x1f
3142 File: org,  Node: Agenda files,  Next: Agenda dispatcher,  Prev: Agenda views,  Up: Agenda views
3144 8.1 Agenda files
3145 ================
3147 The information to be shown is collected from all _agenda files_, the
3148 files listed in the variable `org-agenda-files'(1).  Thus even if you
3149 only work with a single Org-mode file, this file should be put into
3150 that list(2).  You can customize `org-agenda-files', but the easiest
3151 way to maintain it is through the following commands
3153 `C-c ['
3154      Add current file to the list of agenda files.  The file is added to
3155      the front of the list.  If it was already in the list, it is moved
3156      to the front.  With prefix arg, file is added/moved to the end.  
3158 `C-c ]'
3159      Remove current file from the list of agenda files.  
3161 `C-,'
3162 `C-''
3163      Cycle through agenda file list, visiting one file after the other.
3165 The Org menu contains the current list of files and can be used to
3166 visit any of them.
3168    ---------- Footnotes ----------
3170    (1) If the value of that variable is not a list, but a single file
3171 name, then the list of agenda files will be maintained in that external
3172 file.
3174    (2) When using the dispatcher, pressing `1' before selecting a
3175 command will actually limit the command to the current file, and ignore
3176 `org-agenda-files' until the next dispatcher command.
3178 \x1f
3179 File: org,  Node: Agenda dispatcher,  Next: Built-in agenda views,  Prev: Agenda files,  Up: Agenda views
3181 8.2 The agenda dispatcher
3182 =========================
3184 The views are created through a dispatcher that should be bound to a
3185 global key, for example `C-c a' (*note Installation::).  In the
3186 following we will assume that `C-c a' is indeed how the dispatcher is
3187 accessed and list keyboard access to commands accordingly.  After
3188 pressing `C-c a', an additional letter is required to execute a
3189 command.  The dispatcher offers the following default commands:
3191      Create the calendar-like agenda (*note Weekly/Daily agenda::).
3193 `t / T'
3194      Create a list of all TODO items (*note Global TODO list::).
3196 `m / M'
3197      Create a list of headlines matching a TAGS expression (*note
3198      Matching headline tags::).
3201      Create the timeline view for the current buffer (*note Timeline::).
3203 `# / !'
3204      Create a list of stuck projects (*note Stuck projects::).
3207      Restrict an agenda command to the current buffer.  After pressing
3208      `1', you still need to press the character selecting the command.
3211      If there is an active region, restrict the following agenda
3212      command to the region.  Otherwise, restrict it to the current
3213      subtree.  After pressing `0', you still need to press the
3214      character selecting the command.
3216    You can also define custom commands that will be accessible through
3217 the dispatcher, just like the default commands.  This includes the
3218 possibility to create extended agenda buffers that contain several
3219 blocks together, for example the weekly agenda, the global TODO list and
3220 a number of special tags matches.  *Note Custom agenda views::.
3222 \x1f
3223 File: org,  Node: Built-in agenda views,  Next: Presentation and sorting,  Prev: Agenda dispatcher,  Up: Agenda views
3225 8.3 The built-in agenda views
3226 =============================
3228 In this section we describe the built-in views.
3230 * Menu:
3232 * Weekly/Daily agenda::         The calendar page with current tasks
3233 * Global TODO list::            All unfinished action items
3234 * Matching headline tags::      Structured information with fine-tuned search
3235 * Timeline::                    Time-sorted view for single file
3236 * Stuck projects::              Find projects you need to review
3238 \x1f
3239 File: org,  Node: Weekly/Daily agenda,  Next: Global TODO list,  Prev: Built-in agenda views,  Up: Built-in agenda views
3241 8.3.1 The weekly/daily agenda
3242 -----------------------------
3244 The purpose of the weekly/daily _agenda_ is to act like a page of a
3245 paper agenda, showing all the tasks for the current week or day.
3247 `C-c a a'
3248      Compile an agenda for the current week from a list of org files.
3249      The agenda shows the entries for each day.  With a `C-u' prefix (or
3250      when the variable `org-agenda-include-all-todo' is `t'), all
3251      unfinished TODO items (including those without a date) are also
3252      listed at the beginning of the buffer, before the first date.
3254    Remote editing from the agenda buffer means, for example, that you
3255 can change the dates of deadlines and appointments from the agenda
3256 buffer.  The commands available in the Agenda buffer are listed in
3257 *Note Agenda commands::.
3259 Calendar/Diary integration
3260 ..........................
3262 Emacs contains the calendar and diary by Edward M. Reingold.  The
3263 calendar displays a three-month calendar with holidays from different
3264 countries and cultures.  The diary allows you to keep track of
3265 anniversaries, lunar phases, sunrise/set, recurrent appointments
3266 (weekly, monthly) and more.  In this way, it is quite complementary to
3267 Org-mode.  It can be very useful to combine output from Org-mode with
3268 the diary.
3270    In order to include entries from the Emacs diary into Org-mode's
3271 agenda, you only need to customize the variable
3273      (setq org-agenda-include-diary t)
3275 After that, everything will happen automatically.  All diary entries
3276 including holidays, anniversaries etc will be included in the agenda
3277 buffer created by Org-mode.  <SPC>, <TAB>, and <RET> can be used from
3278 the agenda buffer to jump to the diary file in order to edit existing
3279 diary entries.  The `i' command to insert new entries for the current
3280 date works in the agenda buffer, as well as the commands `S', `M', and
3281 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3282 to other calendars, respectively.  `c' can be used to switch back and
3283 forth between calendar and agenda.
3285 \x1f
3286 File: org,  Node: Global TODO list,  Next: Matching headline tags,  Prev: Weekly/Daily agenda,  Up: Built-in agenda views
3288 8.3.2 The global TODO list
3289 --------------------------
3291 The global TODO list contains all unfinished TODO items, formatted and
3292 collected into a single place.
3294 `C-c a t'
3295      Show the global TODO list.  This collects the TODO items from all
3296      agenda files (*note Agenda views::) into a single buffer.  The
3297      buffer is in `agenda-mode', so there are commands to examine and
3298      manipulate the TODO entries directly from that buffer (*note
3299      Agenda commands::).  
3301 `C-c a T'
3302      Like the above, but allows selection of a specific TODO keyword.
3303      You can also do this by specifying a prefix argument to `C-c a t'.
3304      With a `C-u' prefix you are prompted for a keyword.  With a
3305      numeric prefix, the Nth keyword in `org-todo-keywords' is selected.  The
3306      `r' key in the agenda buffer regenerates it, and you can give a
3307      prefix argument to this command to change the selected TODO
3308      keyword, for example `3 r'.  If you often need a search for a
3309      specific keyword, define a custom command for it (*note Agenda
3310      dispatcher::).
3311      Matching specific TODO keywords can also be done as part of a tags
3312      search (*note Tag searches::).
3314    Remote editing of TODO items means that you can change the state of a
3315 TODO entry with a single key press.  The commands available in the TODO
3316 list are described in *Note Agenda commands::.
3318    Normally the global todo list simply shows all headlines with TODO
3319 keywords.  This list can become very long.  There are two ways to keep
3320 it more compact:
3321    - Some people view a TODO item that has been _scheduled_ for
3322      execution (*note Time stamps::) as no longer _open_.  Configure the
3323      variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3324      items from the global TODO list.
3326    - TODO items may have sublevels to break up the task into subtasks.
3327      In such cases it may be enough to list only the highest level TODO
3328      headline and omit the sublevels from the global list.  Configure
3329      the variable `org-agenda-todo-list-sublevels' to get this behavior.
3331 \x1f
3332 File: org,  Node: Matching headline tags,  Next: Timeline,  Prev: Global TODO list,  Up: Built-in agenda views
3334 8.3.3 Matching headline tags
3335 ----------------------------
3337 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3338 you can select headlines based on the tags that apply to them and
3339 collect them into an agenda buffer.
3341 `C-c a m'
3342      Produce a list of all headlines that match a given set of tags.
3343      The command prompts for a selection criterion, which is a boolean
3344      logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3345      `WORK|HOME' (*note Tags::).  If you often need a specific search,
3346      define a custom command for it (*note Agenda dispatcher::).  
3348 `C-c a M'
3349      Like `C-c a m', but only select headlines that are also TODO items
3350      and force checking subitems (see variable
3351      `org-tags-match-list-sublevels').  Matching specific todo keywords
3352      together with a tags match is also possible, see *Note Tag
3353      searches::.
3355    The commands available in the tags list are described in *Note
3356 Agenda commands::.
3358 \x1f
3359 File: org,  Node: Timeline,  Next: Stuck projects,  Prev: Matching headline tags,  Up: Built-in agenda views
3361 8.3.4 Timeline for a single file
3362 --------------------------------
3364 The timeline summarizes all time-stamped items from a single Org-mode
3365 file in a _time-sorted view_.  The main purpose of this command is to
3366 give an overview over events in a project.
3368 `C-c a L'
3369      Show a time-sorted view of the org file, with all time-stamped
3370      items.  When called with a `C-u' prefix, all unfinished TODO
3371      entries (scheduled or not) are also listed under the current date.
3373 The commands available in the timeline buffer are listed in *Note
3374 Agenda commands::.
3376 \x1f
3377 File: org,  Node: Stuck projects,  Prev: Timeline,  Up: Built-in agenda views
3379 8.3.5 Stuck projects
3380 --------------------
3382 If you are following a system like David Allen's GTD to organize your
3383 work, one of the "duties" you have is a regular review to make sure
3384 that all projects move along.  A _stuck_ project is a project that has
3385 no defined next actions, so it will never show up in the TODO lists
3386 Org-mode produces.  During the review, you need to identify such
3387 projects and define next actions for them.
3389 `C-c a #'
3390      List projects that are stuck.  
3392 `C-c a !'
3393      Customize the variable `org-stuck-projects' to define what a stuck
3394      project is and how to find it.
3396    You almost certainly will have to configure this view before it will
3397 work for you.  The built-in default assumes that all your projects are
3398 level-2 headlines, and that a project is not stuck if it has at least
3399 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3401    Lets assume that you, in your own way of using Org-mode, identify
3402 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3403 indicate a project that should not be considered yet.  Lets further
3404 assume that the todo keyword DONE marks finished projects, and that NEXT
3405 and TODO indicate next actions.  Finally, the tag @SHOP indicates
3406 shopping and is a next action even without the NEXT tag.  In this case
3407 you would start by identifying elegible projects with a tags/todo match
3408 `+PROJECT/-MAYBE-DONE', and then check for TODO, NEXT and @SHOP in the
3409 subtree to identify projects that are not stuck.  The correct
3410 customization for this is
3412      (setq org-stuck-projects
3413            ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")))
3415 \x1f
3416 File: org,  Node: Presentation and sorting,  Next: Agenda commands,  Prev: Built-in agenda views,  Up: Agenda views
3418 8.4 Presentation and sorting
3419 ============================
3421 Before displaying items in an agenda view, Org-mode visually prepares
3422 the items and sorts them.  Each item occupies a single line.  The line
3423 starts with a _prefix_ that contains the _category_ (*note
3424 Categories::) of the item and other important information.  You can
3425 customize the prefix using the option `org-agenda-prefix-format'.  The
3426 prefix is followed by a cleaned-up version of the outline headline
3427 associated with the item.
3429 * Menu:
3431 * Categories::                  Not all tasks are equal
3432 * Time-of-day specifications::  How the agenda knows the time
3433 * Sorting of agenda items::     The order of things
3435 \x1f
3436 File: org,  Node: Categories,  Next: Time-of-day specifications,  Prev: Presentation and sorting,  Up: Presentation and sorting
3438 8.4.1 Categories
3439 ----------------
3441 The category is a broad label assigned to each agenda item.  By default,
3442 the category is simply derived from the file name, but you can also
3443 specify it with a special line in the buffer, like this:
3445      #+CATEGORY: Thesis
3447    If there are several such lines in a file, each specifies the
3448 category for the text below it (but the first category also applies to
3449 any text before the first CATEGORY line).  The display in the agenda
3450 buffer looks best if the category is not longer than 10 characters.
3452 \x1f
3453 File: org,  Node: Time-of-day specifications,  Next: Sorting of agenda items,  Prev: Categories,  Up: Presentation and sorting
3455 8.4.2 Time-of-Day Specifications
3456 --------------------------------
3458 Org-mode checks each agenda item for a time-of-day specification.  The
3459 time can be part of the time stamp that triggered inclusion into the
3460 agenda, for example as in `<2005-05-10 Tue 19:00>'.  Time ranges can be
3461 specified with two time stamps, like
3462 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3464    In the headline of the entry itself, a time(range) may also appear as
3465 plain text (like `12:45' or a `8:30-1pm'.  If the agenda integrates the
3466 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3467 entries are recognized as well.
3469    For agenda display, Org-mode extracts the time and displays it in a
3470 standard 24 hour format as part of the prefix.  The example times in
3471 the previous paragraphs would end up in the agenda like this:
3473          8:30-13:00 Arthur Dent lies in front of the bulldozer
3474         12:45...... Ford Prefect arrives and takes Arthur to the pub
3475         19:00...... The Vogon reads his poem
3476         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3478    If the agenda is in single-day mode, or for the display of today, the
3479 timed entries are embedded in a time grid, like
3481          8:00...... ------------------
3482          8:30-13:00 Arthur Dent lies in front of the bulldozer
3483         10:00...... ------------------
3484         12:00...... ------------------
3485         12:45...... Ford Prefect arrives and takes Arthur to the pub
3486         14:00...... ------------------
3487         16:00...... ------------------
3488         18:00...... ------------------
3489         19:00...... The Vogon reads his poem
3490         20:00...... ------------------
3491         20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3493    The time grid can be turned on and off with the variable
3494 `org-agenda-use-time-grid', and can be configured with
3495 `org-agenda-time-grid'.
3497 \x1f
3498 File: org,  Node: Sorting of agenda items,  Prev: Time-of-day specifications,  Up: Presentation and sorting
3500 8.4.3 Sorting of agenda items
3501 -----------------------------
3503 Before being inserted into a view, the items are sorted.  How this is
3504 done depends on the type of view.
3505    * For the daily/weekly agenda, the items for each day are sorted.
3506      The default order is to first collect all items containing an
3507      explicit time-of-day specification.  These entries will be shown
3508      at the beginning of the list, as a _schedule_ for the day.  After
3509      that, items remain grouped in categories, in the sequence given by
3510      `org-agenda-files'.  Within each category, items are sorted by
3511      priority (*note Priorities::), which is composed of the base
3512      priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3513      plus additional increments for overdue scheduled or deadline items.
3515    * For the TODO list, items remain in the order of categories, but
3516      within each category, sorting takes place according to priority
3517      (*note Priorities::).
3519    * For tags matches, items are not sorted at all, but just appear in
3520      the sequence in which they are found in the agenda files.
3522    Sorting can be customized using the variable
3523 `org-agenda-sorting-strategy'.
3525 \x1f
3526 File: org,  Node: Agenda commands,  Next: Custom agenda views,  Prev: Presentation and sorting,  Up: Agenda views
3528 8.5 Commands in the agenda buffer
3529 =================================
3531 Entries in the agenda buffer are linked back to the org file or diary
3532 file where they originate.  You are not allowed to edit the agenda
3533 buffer itself, but commands are provided to show and jump to the
3534 original entry location, and to edit the org-files "remotely" from the
3535 agenda buffer.  In this way, all information is stored only once,
3536 removing the risk that your agenda and note files may diverge.
3538    Some commands can be executed with mouse clicks on agenda lines.  For
3539 the other commands, the cursor needs to be in the desired line.
3541 Motion
3542 ......
3545      Next line (same as <up>).  
3548      Previous line (same as <down>).
3550 View/GoTo org file
3551 ..................
3553 `mouse-3'
3554 `<SPC>'
3555      Display the original location of the item in another window.
3558      Display original location and recenter that window.
3560 `mouse-2'
3561 `mouse-1'
3562 `<TAB>'
3563      Go to the original location of the item in another window.  Under
3564      Emacs 22, `mouse-1' will also works for this.
3566 `<RET>'
3567      Go to the original location of the item and delete other windows.
3570      Toggle Follow mode.  In Follow mode, as you move the cursor through
3571      the agenda buffer, the other window always shows the corresponding
3572      location in the org file.  The initial setting for this mode in new
3573      agenda buffers can be set with the variable
3574      `org-agenda-start-with-follow-mode'.
3577      Display the entire subtree of the current item in an indirect
3578      buffer.  With numerical prefix ARG, go up to this level and then
3579      take that tree.  If ARG is negative, go up that many levels.  With
3580      `C-u' prefix, do not remove the previously used indirect buffer.
3583      Toggle Logbook mode.  In Logbook mode, entries that where marked
3584      DONE while logging was on (variable `org-log-done') are shown in
3585      the agenda, as are entries that have been clocked on that day.
3587 Change display
3588 ..............
3591      Delete other windows.
3594      Switch to weekly view (7 days displayed together).
3597      Switch to daily view (just one day displayed).
3600      Toggle the inclusion of diary entries.  See *Note Weekly/Daily
3601      agenda::.
3604      Toggle the time grid on and off.  See also the variables
3605      `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3608      Recreate the agenda buffer, for example to reflect the changes
3609      after modification of the time stamps of items with S-<left> and
3610      S-<right>.  When the buffer is the global todo list, a prefix
3611      argument is interpreted to create a selective list for a specific
3612      TODO keyword.
3615      Save all Org-mode buffers in the current Emacs session.
3617 `<right>'
3618      Display the following `org-agenda-ndays' days.  For example, if
3619      the display covers a week, switch to the following week.  With
3620      prefix arg, go forward that many times `org-agenda-ndays' days.
3622 `<left>'
3623      Display the previous dates.
3626      Goto today.
3628 Remote editing
3629 ..............
3631 `0-9'
3632      Digit argument.
3634 `C-_'
3635      Undo a change due to a remote editing command.  The change is
3636      undone both in the agenda buffer and in the remote buffer.
3639      Change the TODO state of the item, both in the agenda and in the
3640      original org file.
3642 `C-k'
3643      Delete the current agenda item along with the entire subtree
3644      belonging to it in the original Org-mode file.  If the text to be
3645      deleted remotely is longer than one line, the kill needs to be
3646      confirmed by the user.  See variable `org-agenda-confirm-kill'.
3649      Archive the subtree corresponding to the current headline.
3652      Show all tags associated with the current item.  Because of
3653      inheritance, this may be more than the tags listed in the line
3654      itself.
3657      Set tags for the current headline.
3660      Toggle the ARCHIVE tag for the current headline.
3663      Set the priority for the current item.  Org-mode prompts for the
3664      priority character. If you reply with <SPC>, the priority cookie
3665      is removed from the entry.
3668      Display weighted priority of current item.
3671 `S-<up>'
3672      Increase the priority of the current item.  The priority is
3673      changed in the original buffer, but the agenda is not resorted.
3674      Use the `r' key for this.
3677 `S-<down>'
3678      Decrease the priority of the current item.
3680 `C-c C-s'
3681      Schedule this item
3683 `C-c C-d'
3684      Set a deadline for this item.
3686 `S-<right>'
3687      Change the time stamp associated with the current line by one day
3688      into the future.  With prefix argument, change it by that many
3689      days.  For example, `3 6 5 S-<right>' will change it by a year.
3690      The stamp is changed in the original org file, but the change is
3691      not directly reflected in the agenda buffer.  Use the `r' key to
3692      update the buffer.
3694 `S-<left>'
3695      Change the time stamp associated with the current line by one day
3696      into the past.
3699      Change the time stamp associated with the current line to today.
3700      The key `>' has been chosen, because it is the same as `S-.' on my
3701      keyboard.
3704      Start the clock on the current item.  If a clock is running
3705      already, it is stopped first.  
3708      Stop the previously started clock.  
3711      Cancel the currently running clock.
3713 Calendar commands
3714 .................
3717      Open the Emacs calendar and move to the date at the agenda cursor.
3720      When in the calendar, compute and show the Org-mode agenda for the
3721      date at the cursor.
3724      Insert a new entry into the diary.  Prompts for the type of entry
3725      (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3726      new entry in the diary, just as `i d' etc. would do in the
3727      calendar.  The date is taken from the cursor position.
3730      Show the phases of the moon for the three months around current
3731      date.
3734      Show sunrise and sunset times.  The geographical location must be
3735      set with calendar variables, see documentation of the Emacs
3736      calendar.
3739      Convert the date at cursor into many other cultural and historic
3740      calendars.
3743      Show holidays for three month around the cursor date.
3745 `C-c C-x C-c'
3746      Export a single iCalendar file containing entries from all agenda
3747      files.
3749 Quit and Exit
3750 .............
3753      Quit agenda, remove the agenda buffer.
3756      Exit agenda, remove the agenda buffer and all buffers loaded by
3757      Emacs for the compilation of the agenda.  Buffers created by the
3758      user to visit org files will not be removed.
3761 \x1f
3762 File: org,  Node: Custom agenda views,  Prev: Agenda commands,  Up: Agenda views
3764 8.6 Custom agenda views
3765 =======================
3767 Custom agenda commands serve two purposes: to store and quickly access
3768 frequently used TODO and tags searches, and to create special composite
3769 agenda buffers.  Custom agenda commands will be accessible through the
3770 dispatcher (*note Agenda dispatcher::), just like the default commands.
3772 * Menu:
3774 * Storing searches::            Type once, use often
3775 * Block agenda::                All the stuff you need in a single buffer
3776 * Setting Options::             Changing the rules
3777 * Batch processing::            Agenda views from the command line
3779 \x1f
3780 File: org,  Node: Storing searches,  Next: Block agenda,  Prev: Custom agenda views,  Up: Custom agenda views
3782 8.6.1 Storing searches
3783 ----------------------
3785 The first application of custom searches is the definition of keyboard
3786 shortcuts for frequently used searches, either creating an agenda
3787 buffer, or a sparse tree (the latter covering of course only the current
3788 buffer).  Custom commands are configured in the variable
3789 `org-agenda-custom-commands'.  You can customize this variable, for
3790 example by pressing `C-c a C'.  You can also directly set it with Emacs
3791 Lisp in `.emacs'.  The following example contains all valid search
3792 types:
3794      (setq org-agenda-custom-commands
3795            '(("w" todo "WAITING")
3796              ("W" todo-tree "WAITING")
3797              ("u" tags "+BOSS-URGENT")
3798              ("v" tags-todo "+BOSS-URGENT")
3799              ("U" tags-tree "+BOSS-URGENT")
3800              ("f" occur-tree "\\<FIXME\\>")))
3802 The initial single-character string in each entry defines the character
3803 you have to press after the dispatcher command `C-c a' in order to
3804 access the command.   The second parameter is the search type, followed
3805 by the string or regular expression to be used for the matching.  The
3806 example above will therefore define:
3808 `C-c a w'
3809      as a global search for TODO entries with `WAITING' as the TODO
3810      keyword
3812 `C-c a W'
3813      as the same search, but only in the current buffer and displaying
3814      the results as a sparse tree
3816 `C-c a u'
3817      as a global tags search for headlines marked `:BOSS:' but not
3818      `:URGENT:'
3820 `C-c a v'
3821      as the same search as `C-c a u', but limiting the search to
3822      headlines that are also TODO items
3824 `C-c a U'
3825      as the same search as `C-c a u', but only in the current buffer and
3826      displaying the result as a sparse tree
3828 `C-c a f'
3829      to create a sparse tree (again: current buffer only) with all
3830      entries containing the word `FIXME'.
3832 \x1f
3833 File: org,  Node: Block agenda,  Next: Setting Options,  Prev: Storing searches,  Up: Custom agenda views
3835 8.6.2 Block agenda
3836 ------------------
3838 Another possibility is the construction of agenda views that comprise
3839 the results of _several_ commands, each of which creates a block in the
3840 agenda buffer.  The available commands include `agenda' for the daily
3841 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3842 todo list (as constructed with `C-c a t'), and the matching commands
3843 discussed above: `todo', `tags', and `tags-todo'.  Here are two
3844 examples:
3846      (setq org-agenda-custom-commands
3847            '(("h" "Agenda and Home-related tasks"
3848               ((agenda)
3849                (tags-todo "HOME")
3850                (tags "GARDEN")))
3851              ("o" "Agenda and Office-related tasks"
3852               ((agenda)
3853                (tags-todo "WORK")
3854                (tags "OFFICE")))))
3856 This will define `C-c a h' to create a multi-block view for stuff you
3857 need to attend to at home.  The resulting agenda buffer will contain
3858 your agenda for the current week, all TODO items that carry the tag
3859 `HOME', and also all lines tagged with `GARDEN'.  Finally the command
3860 `C-c a o' provides a similar view for office tasks.
3862 \x1f
3863 File: org,  Node: Setting Options,  Next: Batch processing,  Prev: Block agenda,  Up: Custom agenda views
3865 8.6.3 Setting Options for custom commands
3866 -----------------------------------------
3868 Org-mode contains a number of variables regulating agenda construction
3869 and display.  The global variables define the behavior for all agenda
3870 commands, including the custom commands.  However, if you want to change
3871 some settings just for a single custom view, you can do so.  Setting
3872 options requires inserting a list of variable names and values at the
3873 right spot in `org-agenda-custom-commands'.  For example:
3875      (setq org-agenda-custom-commands
3876            '(("w" todo "WAITING"
3877               ((org-agenda-sorting-strategy '(priority-down))
3878                (org-agenda-prefix-format "  Mixed: ")))
3879              ("U" tags-tree "+BOSS-URGENT"
3880               ((org-show-following-heading nil)
3881                (org-show-hierarchy-above nil)))))
3883 Now the `C-c a w' command will sort the collected entries only by
3884 priority, and the prefix format is modified to just say `  Mixed:'
3885 instead of giving the category of the entry.  The sparse tags tree of
3886 `C-c a U' will now turn out ultra-compact, because neither the headline
3887 hierarchy above the match, nor the headline following the match will be
3888 shown.
3890    For command sets creating a block agenda,
3891 `org-agenda-custom-commands' has two separate spots for setting
3892 options.  You can add options that should be valid for just a single
3893 command in the set, and options that should be valid for all commands in
3894 the set.  The former are just added to the command entry, the latter
3895 must come after the list of command entries.  Going back to the block
3896 agenda example (*note Block agenda::), let's change the sorting strategy
3897 for the `C-c a h' commands to `priority-down', but let's sort the
3898 results for GARDEN tags query in the opposite order, `priority-up'.
3899 This would look like this:
3901      (setq org-agenda-custom-commands
3902            '(("h" "Agenda and Home-related tasks"
3903               ((agenda)
3904                (tags-todo "HOME")
3905                (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
3906               ((org-agenda-sorting-strategy '(priority-down))))
3907              ("o" "Agenda and Office-related tasks"
3908               ((agenda)
3909                (tags-todo "WORK")
3910                (tags "OFFICE")))))
3912    As you see, the values and parenthesis setting is a little complex.
3913 When in doubt, use the customize interface to set this variable - it
3914 fully supports its structure.  Just one caveat: When setting options in
3915 this interface, the _values_ are just lisp expressions.  So if the
3916 value is a string, you need to add the double quotes around the value
3917 yourself.
3919 \x1f
3920 File: org,  Node: Batch processing,  Prev: Setting Options,  Up: Custom agenda views
3922 8.6.4 Creating agenda views in batch processing
3923 -----------------------------------------------
3925 If you want to print or otherwise reprocess agenda views, it can be
3926 useful to create an agenda from the command line.  This is the purpose
3927 of the function `org-batch-agenda'.  It takes as a parameter one of the
3928 strings that are the keys in `org-agenda-custom-commands'.  For
3929 example, to directly print the current TODO list, you could use
3931      emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
3933 You may also modify parameters on the fly like this:
3935      emacs -batch -l ~/.emacs                                      \
3936         -eval '(org-batch-agenda "a"                               \
3937                  org-agenda-ndays 300                              \
3938                  org-agenda-include-diary nil                      \
3939                  org-agenda-files (quote ("~/org/project.org")))'  \
3940         | lpr
3942 which will produce a 300 day agenda, fully restricted to the Org file
3943 `~/org/projects.org', not even including the diary.
3945 \x1f
3946 File: org,  Node: Embedded LaTeX,  Next: Exporting,  Prev: Agenda views,  Up: Top
3948 9 Embedded LaTeX
3949 ****************
3951 Plain ASCII is normally sufficient for almost all note taking.  One
3952 exception, however, are scientific notes which need to be able to
3953 contain mathematical symbols and the occasional formula.  LaTeX(1) is
3954 widely used to typeset scientific documents. Org-mode supports
3955 embedding LaTeX code into its files, because many academics are used to
3956 read LaTeX source code, and because it can be readily processed into
3957 images for HTML production.
3959    It is not necessary to mark LaTeX macros and code in any special way.
3960 If you observe a few conventions, Org-mode knows how to find it and what
3961 to do with it.
3963 * Menu:
3965 * Math symbols::                TeX macros for symbols and Greek letters
3966 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
3967 * LaTeX fragments::             Complex formulas made easy
3968 * Processing LaTeX fragments::  Previewing LaTeX processing
3969 * CDLaTeX mode::                Speed up entering of formulas
3971    ---------- Footnotes ----------
3973    (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3974 Many of the features described here as "LaTeX" are really from TeX, but
3975 for simplicity I am blurring this distinction.
3977 \x1f
3978 File: org,  Node: Math symbols,  Next: Subscripts and Superscripts,  Prev: Embedded LaTeX,  Up: Embedded LaTeX
3980 9.1 Math symbols
3981 ================
3983 You can use LaTeX macros to insert special symbols like `\alpha' to
3984 indicate the Greek letter, or `\to' to indicate an arrow.  Completion
3985 for these macros is available, just type `\' and maybe a few letters,
3986 and press `M-<TAB>' to see possible completions.  Unlike LaTeX code,
3987 Org-mode allows these macros to be present without surrounding math
3988 delimiters, for example:
3990      Angles are written as Greek letters \alpha, \beta and \gamma.
3992    During HTML export (*note HTML export::), these symbols are
3993 translated into the proper syntax for HTML, for the above examples this
3994 is `&alpha;' and `&rarr;', respectively.
3996 \x1f
3997 File: org,  Node: Subscripts and Superscripts,  Next: LaTeX fragments,  Prev: Math symbols,  Up: Embedded LaTeX
3999 9.2 Subscripts and Superscripts
4000 ===============================
4002 Just like in LaTeX, `^' and `_' are used to indicate super- and
4003 subscripts.  Again, these can be used without embedding them in
4004 math-mode delimiters.  To increase the readability of ASCII text, it is
4005 not necessary (but OK) to surround multi-character sub- and superscripts
4006 with curly braces.  For example
4008      The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
4009      the sun is R_{sun} = 6.96 x 10^8 m.
4011    To avoid interpretation as raised or lowered text, you can quote `^'
4012 and `_' with a backslash: `\_' and `\^'.
4014    During HTML export (*note HTML export::), subscript and superscripts
4015 are surrounded with `<sub>' and `<sup>' tags, respectively.
4017 \x1f
4018 File: org,  Node: LaTeX fragments,  Next: Processing LaTeX fragments,  Prev: Subscripts and Superscripts,  Up: Embedded LaTeX
4020 9.3 LaTeX fragments
4021 ===================
4023 With symbols, sub- and superscripts, HTML is pretty much at its end when
4024 it comes to representing mathematical formulas(1).  More complex
4025 expressions need a dedicated formula processor.  To this end, Org-mode
4026 can contain arbitrary LaTeX fragments.  It provides commands to preview
4027 the typeset result of these fragments, and upon export to HTML, all
4028 fragments will be converted to images and inlined into the HTML
4029 document.  For this to work you need to be on a system with a working
4030 LaTeX installation.  You also need the `dvipng' program, available at
4031 `http://sourceforge.net/projects/dvipng/'.
4033    LaTeX fragments don't need any special marking at all.  The following
4034 snippets will be identified as LaTeX source code:
4035    * Environments of any kind.  The only requirement is that the
4036      `\begin' statement appears on a new line, preceded by only
4037      whitespace.
4039    * Text within the usual LaTeX math delimiters.  To avoid conflicts
4040      with currency specifications, single `$' characters are only
4041      recognized as math delimiters if the enclosed text contains at
4042      most two line breaks, is directly attached to the `$' characters
4043      with no whitespace in between, and if the closing `$' is followed
4044      by whitespace or punctuation.  For the other delimiters, there is
4045      no such restriction, so when in doubt, use `\(...\)' as inline
4046      math delimiters.
4048 For example:
4050      \begin{equation}                          % arbitrary environments,
4051      x=\sqrt{b}                                % even tables, figures
4052      \end{equation}                            % etc
4054      If $a^2=b$ and \( b=2 \), then the solution must be
4055      either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4057 If you need any of the delimiter ASCII sequences for other purposes, you
4058 can configure the option `org-format-latex-options' to deselect the
4059 ones you do not wish to have interpreted by the LaTeX converter.
4061    ---------- Footnotes ----------
4063    (1) Yes, there is MathML, but that is not yet fully supported by
4064 many browsers, and there is no decent converter for turning LaTeX of
4065 ASCII representations of formulas into MathML.  So for the time being,
4066 converting formulas into images seems the way to go.
4068 \x1f
4069 File: org,  Node: Processing LaTeX fragments,  Next: CDLaTeX mode,  Prev: LaTeX fragments,  Up: Embedded LaTeX
4071 9.4 Processing LaTeX fragments
4072 ==============================
4074 LaTeX fragments can be processed to produce a preview images of the
4075 typeset expressions:
4077 `C-c C-x C-l'
4078      Produce a preview image of the LaTeX fragment at point and overlay
4079      it over the source code.  If there is no fragment at point,
4080      process all fragments in the current entry (between two
4081      headlines).  When called with a prefix argument, process the
4082      entire subtree.  When called with two prefix arguments, or when
4083      the cursor is before the first headline, process the entire buffer.  
4085 `C-c C-c'
4086      Remove the overlay preview images.
4088    During HTML export (*note HTML export::), all LaTeX fragments are
4089 converted into images and inlined into the document if the following
4090 setting is active:
4092      (setq org-export-with-LaTeX-fragments t)
4094 \x1f
4095 File: org,  Node: CDLaTeX mode,  Prev: Processing LaTeX fragments,  Up: Embedded LaTeX
4097 9.5 Using CDLaTeX to enter math
4098 ===============================
4100 CDLaTeX-mode is a minor mode that is normally used in combination with a
4101 major LaTeX mode like AUCTeX in order to speed-up insertion of
4102 environments and math templates.  Inside Org-mode, you can make use of
4103 some of the features of cdlatex-mode.  You need to install `cdlatex.el'
4104 and `texmathp.el' (the latter comes also with AUCTeX) from
4105 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'.  Don't turn
4106 cdlatex-mode itself under Org-mode, but use the light version
4107 `org-cdlatex-mode' that comes as part of Org-mode.  Turn it on for the
4108 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4109 with
4111      (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4113    When this mode is enabled, the following features are present (for
4114 more details see the documentation of cdlatex-mode):
4115    * Environment templates can be inserted with `C-c {'.
4117    * The <TAB> key will do template expansion if the cursor is inside a
4118      LaTeX fragment(1).  For example, <TAB> will expand `fr' to
4119      `\frac{}{}' and position the cursor correctly inside the first
4120      brace.  Another <TAB> will get you into the second brace.  Even
4121      outside fragments, <TAB> will expand environment abbreviations at
4122      the beginning of a line.  For example, if you write `equ' at the
4123      beginning of a line and press <TAB>, this abbreviation will be
4124      expanded to an `equation' environment.  To get a list of all
4125      abbreviations, type `M-x cdlatex-command-help'.
4127    * Pressing `_' and `^' inside a LaTeX fragment will insert these
4128      characters together with a pair of braces.  If you use <TAB> to
4129      move out of the braces, and if the braces surround only a single
4130      character or macro, they are removed again (depending on the
4131      variable `cdlatex-simplify-sub-super-scripts').
4133    * Pressing the backquote ``' followed by a character inserts math
4134      macros, also outside LaTeX fragments.  If you wait more than 1.5
4135      seconds after the backquote, a help window will pop up.
4137    * Pressing the normal quote `'' followed by another character
4138      modifies the symbol before point with an accent or a font.  If you
4139      wait more than 1.5 seconds after the backquote, a help window will
4140      pop up.  Character modification will work only inside LaTeX
4141      fragments, outside the quote is normal.
4143    ---------- Footnotes ----------
4145    (1) Org-mode has a method to test if the cursor is inside such a
4146 fragment, see the documentation of the function
4147 `org-inside-LaTeX-fragment-p'.
4149 \x1f
4150 File: org,  Node: Exporting,  Next: Publishing,  Prev: Embedded LaTeX,  Up: Top
4152 10 Exporting
4153 ************
4155 Org-mode documents can be exported into a variety of other formats.  For
4156 printing and sharing of notes, ASCII export produces a readable and
4157 simple version of an Org-mode file.  HTML export allows you to publish a
4158 notes file on the web, while the XOXO format provides a solid base for
4159 exchange with a broad range of other applications.  To incorporate
4160 entries with associated times like deadlines or appointments into a
4161 desktop calendar program like iCal, Org-mode can also produce extracts
4162 in the iCalendar format.  Currently Org-mode only supports export, not
4163 import of these different formats.
4165    When exporting, Org-mode uses special conventions to enrich the
4166 output produced.  *Note Text interpretation::, for more details.
4168 `C-c C-e'
4169      Dispatcher for export and publishing commands.  Displays a
4170      help-window listing the additional key(s) needed to launch an
4171      export or publishing command.
4173 * Menu:
4175 * ASCII export::                Exporting to plain ASCII
4176 * HTML export::                 Exporting to HTML
4177 * XOXO export::                 Exporting to XOXO
4178 * iCalendar export::            Exporting in iCalendar format
4179 * Text interpretation::         How the exporter looks at the file
4181 \x1f
4182 File: org,  Node: ASCII export,  Next: HTML export,  Prev: Exporting,  Up: Exporting
4184 10.1 ASCII export
4185 =================
4187 ASCII export produces a simple and very readable version of an Org-mode
4188 file.
4190 `C-c C-e a'
4191      Export as ASCII file.  If there is an active region, only the
4192      region will be exported.  For an org file `myfile.org', the ASCII
4193      file will be `myfile.txt'.  The file will be overwritten without
4194      warning.  
4196 `C-c C-e v a'
4197      Export only the visible part of the document.
4199    In the exported version, the first 3 outline levels will become
4200 headlines, defining a general document structure.  Additional levels
4201 will be exported as itemized lists.  If you want that transition to
4202 occur at a different level, specify it with a prefix argument.  For
4203 example,
4205      C-1 C-c C-e a
4207 creates only top level headlines and does the rest as items.  When
4208 headlines are converted to items, the indentation of the text following
4209 the headline is changed to fit nicely under the item.  This is done with
4210 the assumption that the first bodyline indicates the base indentation of
4211 the body text.  Any indentation larger than this is adjusted to preserve
4212 the layout relative to the first line.  Should there be lines with less
4213 indentation than the first, these are left alone.
4215 \x1f
4216 File: org,  Node: HTML export,  Next: XOXO export,  Prev: ASCII export,  Up: Exporting
4218 10.2 HTML export
4219 ================
4221 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4222 HTML formatting, in ways similar to John Grubers _markdown_ language,
4223 but with additional support for tables.
4225 * Menu:
4227 * Export commands::             How to invode HTML export
4228 * Quoting HTML tags::           Using direct HTML in Org-mode
4229 * Links::                       How hyperlinks get transferred to HTML
4230 * Images::                      To inline or not to inline?
4231 * CSS support::                 Style specifications
4233 \x1f
4234 File: org,  Node: Export commands,  Next: Quoting HTML tags,  Prev: HTML export,  Up: HTML export
4236 10.2.1 HTML export commands
4237 ---------------------------
4239 `C-c C-e h'
4240      Export as HTML file `myfile.html'.  
4242 `C-c C-e b'
4243      Export as HTML file and open it with a browser.  
4245 `C-c C-e v h'
4247 `C-c C-e v b'
4248      Export only the visible part of the document.
4250    In the exported version, the first 3 outline levels will become
4251 headlines, defining a general document structure.  Additional levels
4252 will be exported as itemized lists.  If you want that transition to
4253 occur at a different level, specify it with a prefix argument.  For
4254 example,
4256      C-2 C-c C-e b
4258 creates two levels of headings and does the rest as items.
4260 \x1f
4261 File: org,  Node: Quoting HTML tags,  Next: Links,  Prev: Export commands,  Up: HTML export
4263 10.2.2 Quoting HTML tags
4264 ------------------------
4266 If you want to include HTML tags which should be interpreted as such,
4267 mark them with `@' as in `@<b>bold text@</b>'.  Plain `<' and `>' are
4268 always transformed to `&lt;' and `&gt;' in HTML export.
4270 \x1f
4271 File: org,  Node: Links,  Next: Images,  Prev: Quoting HTML tags,  Up: HTML export
4273 10.2.3 Links
4274 ------------
4276 Internal links (*note Internal links::) will continue to work in HTML
4277 files only if they match a dedicated `<<target>>'.  Automatic links
4278 created by radio targets (*note Radio targets::) will also work in the
4279 HTML file.  Links to external files will still work if the HTML file is
4280 in the same directory as the Org-mode file.  Links to other `.org'
4281 files will be translated into HTML links under the assumption that an
4282 HTML version also exists of the linked file.  For information related to
4283 linking files while publishing them to a publishing directory see *Note
4284 Publishing links::.
4286 \x1f
4287 File: org,  Node: Images,  Next: CSS support,  Prev: Links,  Up: HTML export
4289 10.2.4 Images
4290 -------------
4292 HTML export can inline images given as links in the Org-mode file, and
4293 it can make an image the clickable part of a link.  By default(1),
4294 images are inlined if a link does not have a description.  So
4295 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4296 image]]' will just produce a link `the image' that points to the image.
4297 If the description part itself is a `file:' link or a `http:' URL
4298 pointing to an image, this image will be inlined and activated so that
4299 clicking on the image will activate the link.  For example, to include
4300 a thumbnail that will link to a high resolution version of the image,
4301 you could use:
4303      [[file:highres.jpg][file:thumb.jpg]]
4305 and you could use `http' addresses just as well.
4307    ---------- Footnotes ----------
4309    (1) but see the variable `org-export-html-inline-images'
4311 \x1f
4312 File: org,  Node: CSS support,  Prev: Images,  Up: HTML export
4314 10.2.5 CSS support
4315 ------------------
4317 You can also give style information for the exported file.  The HTML
4318 exporter assigns the following CSS classes to appropriate parts of the
4319 document - your style specifications may change these:
4320      .todo           TODO keywords
4321      .done           the DONE keyword
4322      .timestamp      time stamp
4323      .timestamp-kwd  keyword associated with a time stamp, like SCHEDULED
4324      .tag            tag in a headline
4325      .target         target for links
4327    The default style specification can be configured through the option
4328 `org-export-html-style'.  If you want to use a file-local style, you
4329 may use file variables, best wrapped into a COMMENT section at the end
4330 of the outline tree.  For example(1):
4332      * COMMENT html style specifications
4334      # Local Variables:
4335      # org-export-html-style: "   <style type=\"text/css\">
4336      #       p {font-weight: normal; color: gray; }
4337      #       h1 {color: black; }
4338      #   </style>"
4339      # End:
4341    Remember to execute `M-x normal-mode' after changing this to make
4342 the new style visible to Emacs.  This command restarts org-mode for the
4343 current buffer and forces Emacs to re-evaluate the local variables
4344 section in the buffer.
4346    ---------- Footnotes ----------
4348    (1) Under Emacs 21, the continuation lines for a variable value
4349 should have no `#' at the start of the line.
4351 \x1f
4352 File: org,  Node: XOXO export,  Next: iCalendar export,  Prev: HTML export,  Up: Exporting
4354 10.3 XOXO export
4355 ================
4357 Org-mode contains an exporter that produces XOXO-style output.
4358 Currently, this exporter only handles the general outline structure and
4359 does not interpret any additional Org-mode features.
4361 `C-c C-e x'
4362      Export as XOXO file `myfile.html'.  
4364 `C-c C-e v x'
4365      Export only the visible part of the document.
4367 \x1f
4368 File: org,  Node: iCalendar export,  Next: Text interpretation,  Prev: XOXO export,  Up: Exporting
4370 10.4 iCalendar export
4371 =====================
4373 Some people like to use Org-mode for keeping track of projects, but
4374 still prefer a standard calendar application for anniversaries and
4375 appointments.  In this case it can be useful to have deadlines and
4376 other time-stamped items in Org-mode files show up in the calendar
4377 application.  Org-mode can export calendar information in the standard
4378 iCalendar format.
4380 `C-c C-e i'
4381      Create iCalendar entries for the current file and store them in
4382      the same directory, using a file extension `.ics'.  
4384 `C-c C-e I'
4385      Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4386      For each of these files, a separate iCalendar file will be
4387      written.  
4389 `C-c C-e c'
4390      Create a single large iCalendar file from all files in
4391      `org-agenda-files' and write it to the file given by
4392      `org-combined-agenda-icalendar-file'.
4394    How this calendar is best read and updated, depends on the
4395 application you are using.  For example, when using iCal under Apple
4396 MacOS X, you could create a new calendar `OrgMode' (the default name
4397 for the calendar created by `C-c C-e c', see the variables
4398 `org-icalendar-combined-name' and
4399 `org-combined-agenda-icalendar-file').  Then set Org-mode to overwrite
4400 the corresponding file `~/Library/Calendars/OrgMode.ics'.  You may even
4401 use AppleScript to make iCal re-read the calendar files each time a new
4402 version of `OrgMode.ics' is produced.  Here is the setup needed for
4403 this:
4405      (setq org-combined-agenda-icalendar-file
4406          "~/Library/Calendars/OrgMode.ics")
4407      (add-hook 'org-after-save-iCalendar-file-hook
4408       (lambda ()
4409        (shell-command
4410         "osascript -e 'tell application \"iCal\" to reload calendars'")))
4412 \x1f
4413 File: org,  Node: Text interpretation,  Prev: iCalendar export,  Up: Exporting
4415 10.5 Text interpretation by the exporter
4416 ========================================
4418 The exporter backends interpret additional structure in the Org-mode
4419 file in order to produce better output.
4421 * Menu:
4423 * Comment lines::               Some lines will not be exported
4424 * Enhancing text::              Subscripts, symbols and more
4425 * Export options::              How to influence the export settings
4427 \x1f
4428 File: org,  Node: Comment lines,  Next: Enhancing text,  Prev: Text interpretation,  Up: Text interpretation
4430 10.5.1 Comment lines
4431 --------------------
4433 Lines starting with `#' in column zero are treated as comments and will
4434 never be exported.  Also entire subtrees starting with the word
4435 `COMMENT' will never be exported.  Finally, any text before the first
4436 headline will not be exported either.
4438 `C-c ;'
4439      Toggle the COMMENT keyword at the beginning of an entry.
4441 \x1f
4442 File: org,  Node: Enhancing text,  Next: Export options,  Prev: Comment lines,  Up: Text interpretation
4444 10.5.2 Enhancing text for export
4445 --------------------------------
4447 Some of the export backends of Org-mode allow for sophisticated text
4448 formatting, this is true in particular for the HTML backend.  Org-mode
4449 has a number of typing conventions that allow to produce a richly
4450 formatted output.
4452    * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4453      enumerator will be recognized and transformed if the backend
4454      supports lists.  See *Note Plain lists::.
4456    * You can make words *bold*, /italic/, _underlined_, `=code=', and
4457      `+strikethrough+'.
4459    * Many TeX macros and entire LaTeX fragments are converted into HTML
4460      entities or images (*note Embedded LaTeX::).
4462    * Tables are transformed into native tables under the exporter, if
4463      the export backend supports this. Data fields before the first
4464      horizontal separator line will be formatted as table header fields.
4466    * If a headline starts with the word `QUOTE', the text below the
4467      headline will be typeset as fixed-width, to allow quoting of
4468      computer codes etc.  Lines starting with `:' are also typeset in
4469      fixed-width font.
4470     `C-c :'
4471           Toggle fixed-width for entry (QUOTE) or region, see below.
4473    * A double backslash _at the end of a line_ enforces a line break at
4474      this position.
4476    If these conversions conflict with your habits of typing ASCII text,
4477 they can all be turned off with corresponding variables (see the
4478 customization group `org-export-general', and the following section
4479 which explains how to set export options with special lines in a buffer.
4481 \x1f
4482 File: org,  Node: Export options,  Prev: Enhancing text,  Up: Text interpretation
4484 10.5.3 Export options
4485 ---------------------
4487 The exporter recognizes special lines in the buffer which provide
4488 additional information.  These lines may be put anywhere in the file.
4489 The whole set of lines can be inserted into the buffer with `C-c C-e
4490 t'.  For individual lines, a good way to make sure the keyword is
4491 correct is to type `#+' and then use `M-<TAB>' completion (*note
4492 Completion::).
4494 `C-c C-e t'
4495      Insert template with export options, see example below.
4497      #+TITLE:     the title to be shown (default is the buffer name)
4498      #+AUTHOR:    the author (default taken from `user-full-name')
4499      #+EMAIL:     his/her email address (default from `user-mail-address')
4500      #+LANGUAGE:  language for HTML, e.g. `en' (`org-export-default-language')
4501      #+TEXT:      Some descriptive text to be inserted at the beginning.
4502      #+TEXT:      Several lines may be given.
4503      #+OPTIONS:   H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
4505 The OPTIONS line is a compact form to specify export settings.  Here
4506 you can: 
4507      H:      set the number of headline levels for export
4508      num:    turn on/off section-numbers
4509      toc:    turn on/off table of contents
4510      \n:     turn on/off linebreak-preservation
4511      @:      turn on/off quoted HTML tags
4512      ::      turn on/off fixed-width sections
4513      |:      turn on/off tables
4514      ^:      turn on/off TeX-like syntax for sub- and superscripts.
4515      *:      turn on/off emphasized text (bold, italic, underlined)
4516      TeX:    turn on/off simple TeX macros in plain text
4517      LaTeX:  turn on/off LaTeX fragments
4519 \x1f
4520 File: org,  Node: Publishing,  Next: Miscellaneous,  Prev: Exporting,  Up: Top
4522 11 Publishing
4523 *************
4525 Org-mode includes(1) a publishing management system that allows you to
4526 configure automatic HTML conversion of _projects_ composed of
4527 interlinked org files.  This system is called _org-publish_.  You can
4528 also configure org-publish to automatically upload your exported HTML
4529 pages and related attachments, such as images and source code files, to
4530 a web server.  Org-publish turns org-mode into a web-site authoring
4531 tool.
4533    Org-publish has been contributed to Org-mode by David O'Toole.
4535 * Menu:
4537 * Configuration::               Defining projects
4538 * Sample configuration::        Example projects
4539 * Triggering publication::      Publication commands
4541    ---------- Footnotes ----------
4543    (1) `org-publish.el' is not yet part of Emacs, so if you are using
4544 `org.el' as it comes with Emacs, you need to download this file
4545 separately.  Also make sure org.el is at least version 4.27.
4547 \x1f
4548 File: org,  Node: Configuration,  Next: Sample configuration,  Prev: Publishing,  Up: Publishing
4550 11.1 Configuration
4551 ==================
4553 Publishing needs significant configuration to specify files, destination
4554 and many other properties of a project.
4556 * Menu:
4558 * Project alist::               The central configuration variable
4559 * Sources and destinations::    From here to there
4560 * Selecting files::             What files are part of the project?
4561 * Publishing action::           Setting the function doing the publishing
4562 * Publishing options::          Tweaking HTML export
4563 * Publishing links::            Which links keep working after publishing?
4564 * Project page index::          Publishing a list of project files
4566 \x1f
4567 File: org,  Node: Project alist,  Next: Sources and destinations,  Prev: Configuration,  Up: Configuration
4569 11.1.1 The variable `org-publish-project-alist'
4570 -----------------------------------------------
4572 Org-publish is configured almost entirely through setting the value of
4573 one variable, called `org-publish-project-alist'.  Each element of the
4574 list configures one project, and may be in one of the two following
4575 forms:
4577      ("project-name"  :property value :property value ...)
4579      or
4581      ("project-name"  :components ("project-name" "project-name" ...))
4583    In both cases, projects are configured by specifying property values.
4584 A project defines the set of files that will be published, as well as
4585 the publishing configuration to use when publishing those files.  When
4586 a project takes the second form listed above, the individual members of
4587 the "components" property are taken to be components of the project,
4588 which group together files requiring different publishing options. When
4589 you publish such a "meta-project" all the components will also publish.
4591 \x1f
4592 File: org,  Node: Sources and destinations,  Next: Selecting files,  Prev: Project alist,  Up: Configuration
4594 11.1.2 Sources and destinations for files
4595 -----------------------------------------
4597 Most properties are optional, but some should always be set. In
4598 particular, org-publish needs to know where to look for source files,
4599 and where to put published files.
4601 `:base-directory'      Directory containing publishing source files
4602 `:publishing-directory'Directory (possibly remote) where output files
4603                        will be published.
4604 `:preparation-function'Function called before starting publishing
4605                        process, for example to run `make' for updating
4606                        files to be published.
4608 \x1f
4609 File: org,  Node: Selecting files,  Next: Publishing action,  Prev: Sources and destinations,  Up: Configuration
4611 11.1.3 Selecting files
4612 ----------------------
4614 By default, all files with extension `.org' in the base directory are
4615 considered part of the project.  This can be modified by setting the
4616 properties
4617 `:base-extension'  Extension (without the dot!) of source files.  This
4618                    actually is a regular expression.
4619 `:exclude'         Regular expression to match file names that should
4620                    not be published, even though they have been selected
4621                    on the basis of their extension.
4622 `:include'         List of files to be included regardless of
4623                    `:base-extension' and `:exclude'.
4625 \x1f
4626 File: org,  Node: Publishing action,  Next: Publishing options,  Prev: Selecting files,  Up: Configuration
4628 11.1.4 Publishing Action
4629 ------------------------
4631 Publishing means that a file is copied to the destination directory and
4632 possibly transformed in the process.  The default transformation is to
4633 export Org-mode files as HTML files, and this is done by the function
4634 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4635 export::).  Other files like images only need to be copied to the
4636 publishing destination.  For non-Org-mode files, you need to specify
4637 the publishing function.
4639 `:publishing-function' Function executing the publication of a file.
4640                        This may also be a list of functions, which will
4641                        all be called in turn.
4643    The function must accept two arguments: a property list containing at
4644 least a `:publishing-directory' property, and the name of the file to
4645 be published.  It should take the specified file, make the necessary
4646 transformation (if any) and place the result into the destination
4647 folder.  You can write your own publishing function, but `org-publish'
4648 provides one for attachments (files that only need to be copied):
4649 `org-publish-attachment'.
4651 \x1f
4652 File: org,  Node: Publishing options,  Next: Publishing links,  Prev: Publishing action,  Up: Configuration
4654 11.1.5 Options for the HTML exporter
4655 ------------------------------------
4657 The property list can be used to set many export options for the HTML
4658 exporter.  In most cases, these properties correspond to user variables
4659 in Org-mode.  The table below lists these properties along with the
4660 variable they belong to.  See the documentation string for the
4661 respective variable for details.
4663 `:language'            `org-export-default-language'
4664 `:headline-levels'     `org-export-headline-levels'
4665 `:section-numbers'     `org-export-with-section-numbers'
4666 `:table-of-contents'   `org-export-with-toc'
4667 `:archived-trees'      `org-export-with-archived-trees'
4668 `:emphasize'           `org-export-with-emphasize'
4669 `:sub-superscript'     `org-export-with-sub-superscripts'
4670 `:TeX-macros'          `org-export-with-TeX-macros'
4671 `:LaTeX-fragments'     `org-export-with-LaTeX-fragments'
4672 `:fixed-width'         `org-export-with-fixed-width'
4673 `:timestamps'          `org-export-with-timestamps'
4674  .                     
4675 `:tags'                `org-export-with-tags'
4676  .                     
4677 `:tables'              `org-export-with-tables'
4678 `:table-auto-headline' `org-export-highlight-first-table-line'
4679 `:style'               `org-export-html-style'
4680 `:convert-org-links'   `org-export-html-link-org-files-as-html'
4681 `:inline-images'       `org-export-html-inline-images'
4682 `:expand-quoted-html'  `org-export-html-expand'
4683 `:timestamp'           `org-export-html-with-timestamp'
4684 `:publishing-directory'`org-export-publishing-directory'
4685 `:preamble'            `org-export-html-preamble'
4686 `:postamble'           `org-export-html-postamble'
4687 `:auto-preamble'       `org-export-html-auto-preamble'
4688 `:auto-postamble'      `org-export-html-auto-postamble'
4689 `:author'              `user-full-name'
4690 `:email'               `user-mail-address'
4692    When a property is given a value in org-publish-project-alist, its
4693 setting overrides the value of the corresponding user variable (if any)
4694 during publishing.  options set within a file (*note Export options::),
4695 however, override everything.
4697 \x1f
4698 File: org,  Node: Publishing links,  Next: Project page index,  Prev: Publishing options,  Up: Configuration
4700 11.1.6 Links between published files
4701 ------------------------------------
4703 To create a link from one Org-mode file to another, you would use
4704 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4705 (*note Hyperlinks::).  Upon publishing this link becomes a link to
4706 `foo.html'.  In this way, you can interlink the pages of your "org web"
4707 project and the links will work as expected when you publish them to
4708 HTML.
4710    You may also link to related files, such as images. Provided you are
4711 careful with relative pathnames, and provided you have also configured
4712 org-publish to upload the related files, these links will work too.
4713 *Note Complex example:: for an example of this usage.
4715    Sometime an Org-mode file to be published may contain links that are
4716 only valid in your production environment, but not in the publishing
4717 location.  In this case, use the property
4719 `:link-validation-function'   Function to validate links
4721 to define a function for checking link validity.  This function must
4722 accept two arguments, the file name and a directory relative to which
4723 the file name is interpreted in the production environment.  If this
4724 function returns `nil', then the HTML generator will only insert a
4725 description into the HTML file, but no link.  One option for this
4726 function is `org-publish-validate-link' which checks if the given file
4727 is part of any project in `org-publish-project-alist'.
4729 \x1f
4730 File: org,  Node: Project page index,  Prev: Publishing links,  Up: Configuration
4732 11.1.7 Project page index
4733 -------------------------
4735 The following properties may be used to control publishing of an index
4736 of files or summary page for a given project.
4738 `:auto-index'      When non-nil, publish an index during
4739                    org-publish-current-project or org-publish-all.
4740 `:index-filename'  Filename for output of index. Defaults to `index.org'
4741                    (which becomes `index.html').
4742 `:index-title'     Title of index page. Defaults to name of file.
4743 `:index-function'  Plugin function to use for generation of index.
4744                    Defaults to `org-publish-org-index', which generates
4745                    a plain list of links to all files in the project.
4747 \x1f
4748 File: org,  Node: Sample configuration,  Next: Triggering publication,  Prev: Configuration,  Up: Publishing
4750 11.2 Sample configuration
4751 =========================
4753 Below we provide two example configurations.  The first one is a simple
4754 project publishing only a set of Org-mode files.  The second example is
4755 more complex, with a multi-component project.
4757 * Menu:
4759 * Simple example::              One-component publishing
4760 * Complex example::             A multi-component publishing example
4762 \x1f
4763 File: org,  Node: Simple example,  Next: Complex example,  Prev: Sample configuration,  Up: Sample configuration
4765 11.2.1 Example: simple publishing configuration
4766 -----------------------------------------------
4768 This example publishes a set of Org-mode files to the `public_html'
4769 directory on the local machine.
4771      (setq org-publish-project-alist
4772            '(("org"
4773               :base-directory "~/org/"
4774               :publishing-directory "~/public_html"
4775               :section-numbers nil
4776               :table-of-contents nil
4777               :style "<link rel=stylesheet
4778                      href=\"../other/mystyle.css\"
4779                      type=\"text/css\">")))
4781 \x1f
4782 File: org,  Node: Complex example,  Prev: Simple example,  Up: Sample configuration
4784 11.2.2 Example: complex publishing configuration
4785 ------------------------------------------------
4787 This more complicated example publishes an entire website, including
4788 org files converted to HTML, image files, emacs lisp source code, and
4789 stylesheets. The publishing-directory is remote and private files are
4790 excluded.
4792    To ensure that links are preserved, care should be taken to replicate
4793 your directory structure on the web server, and to use relative file
4794 paths. For example, if your org files are kept in `~/org' and your
4795 publishable images in `~/images', you'd link to an image with
4796      file:../images/myimage.png
4797    On the web server, the relative path to the image should be the
4798 same. You can accomplish this by setting up an "images" folder in the
4799 right place on the webserver, and publishing images to it.
4801      (setq org-publish-project-alist
4802            '(("orgfiles"
4803                :base-directory "~/org/"
4804                :base-extension "org"
4805                :publishing-directory "/ssh:user@host:~/html/notebook/"
4806                :publishing-function org-publish-org-to-html
4807                :exclude "PrivatePage.org"   ;; regexp
4808                :headline-levels 3
4809                :section-numbers nil
4810                :table-of-contents nil
4811                :style "<link rel=stylesheet
4812                        href=\"../other/mystyle.css\" type=\"text/css\">"
4813                :auto-preamble t
4814                :auto-postamble nil)
4816               ("images"
4817                :base-directory "~/images/"
4818                :base-extension "jpg\\|gif\\|png"
4819                :publishing-directory "/ssh:user@host:~/html/images/"
4820                :publishing-function org-publish-attachment)
4822               ("other"
4823                :base-directory "~/other/"
4824                :base-extension "css\\|el"
4825                :publishing-directory "/ssh:user@host:~/html/other/"
4826                :publishing-function org-publish-attachment)
4827               ("website" :components ("orgfiles" "images" "other"))))
4829 \x1f
4830 File: org,  Node: Triggering publication,  Prev: Sample configuration,  Up: Publishing
4832 11.3 Triggering publication
4833 ===========================
4835 Once org-publish is properly configured, you can publish with the
4836 following functions:
4838 `C-c C-e c'
4839      Prompt for a specific project and publish all files that belong to
4840      it.
4842 `C-c C-e p'
4843      Publish the project containing the current file.
4845 `C-c C-e f'
4846      Publish only the current file.
4848 `C-c C-e a'
4849      Publish all projects.
4851    Org uses timestamps to track when a file has changed. The above
4852 functions normally only publish changed files. You can override this and
4853 force publishing of all files by giving a prefix argument.
4855 \x1f
4856 File: org,  Node: Miscellaneous,  Next: Extensions and Hacking,  Prev: Publishing,  Up: Top
4858 12 Miscellaneous
4859 ****************
4861 * Menu:
4863 * Completion::                  M-TAB knows what you need
4864 * Customization::               Adapting Org-mode to your taste
4865 * In-buffer settings::          Overview of the #+KEYWORDS
4866 * The very busy C-c C-c key::   When in doubt, press C-c C-c
4867 * Clean view::                  Getting rid of leading stars in the outline
4868 * TTY keys::                    Using Org-mode on a tty
4869 * Interaction::                 Other Emacs packages
4870 * Bugs::                        Things which do not work perfectly
4872 \x1f
4873 File: org,  Node: Completion,  Next: Customization,  Prev: Miscellaneous,  Up: Miscellaneous
4875 12.1 Completion
4876 ===============
4878 Org-mode supports in-buffer completion.  This type of completion does
4879 not make use of the minibuffer.  You simply type a few letters into the
4880 buffer and use the key to complete text right there.
4882 `M-<TAB>'
4883      Complete word at point
4884         * At the beginning of a headline, complete TODO keywords.
4886         * After `\', complete TeX symbols supported by the exporter.
4888         * After `*', complete headlines in the current buffer so that
4889           they can be used in search links like `[[*find this
4890           headline]]'.
4892         * After `:', complete tags.  The list of tags is taken from the
4893           variable `org-tag-alist' (possibly set through the `#+TAGS'
4894           in-buffer option, *note Setting tags::), or it is created
4895           dynamically from all tags used in the current buffer.
4897         * After `[', complete link abbreviations (*note Link
4898           abbreviations::).
4900         * After `#+', complete the special keywords like `TYP_TODO' or
4901           `OPTIONS' which set file-specific options for Org-mode.  When
4902           the option keyword is already complete, pressing `M-<TAB>'
4903           again will insert example settings for this keyword.
4905         * In the line after `#+STARTUP: ', complete startup keywords,
4906           i.e. valid keys for this line.
4908         * Elsewhere, complete dictionary words using ispell.
4910 \x1f
4911 File: org,  Node: Customization,  Next: In-buffer settings,  Prev: Completion,  Up: Miscellaneous
4913 12.2 Customization
4914 ==================
4916 There are more than 170 variables that can be used to customize
4917 Org-mode.  For the sake of compactness of the manual, I am not
4918 describing the variables here.  A structured overview of customization
4919 variables is available with `M-x org-customize'.  Or select `Browse Org
4920 Group' from the `Org->Customization' menu.  Many settings can also be
4921 activated on a per-file basis, by putting special lines into the buffer
4922 (*note In-buffer settings::).
4924 \x1f
4925 File: org,  Node: In-buffer settings,  Next: The very busy C-c C-c key,  Prev: Customization,  Up: Miscellaneous
4927 12.3 Summary of in-buffer settings
4928 ==================================
4930 Org-mode uses special lines in the buffer to define settings on a
4931 per-file basis.  These lines start with a `#+' followed by a keyword, a
4932 colon, and then individual words defining a setting.  Several setting
4933 words can be in the same line, but you can also have multiple lines for
4934 the keyword.  While these settings are described throughout the manual,
4935 here is a summary.  After changing any of those lines in the buffer,
4936 press `C-c C-c' with the cursor still in the line to activate the
4937 changes immediately.  Otherwise they become effective only when the
4938 file is visited again in a new Emacs session.
4940 `#+STARTUP:'
4941      This line sets options to be used at startup of org-mode, when an
4942      Org-mode file is being visited.  The first set of options deals
4943      with the initial visibility of the outline tree.  The
4944      corresponding variable for global default settings is
4945      `org-startup-folded', with a default value `t', which means
4946      `overview'.  
4947           overview   top-level headlines only
4948           content    all headlines
4949           showall    no folding at all, show everything
4950      Then there are options for aligning tables upon visiting a file.
4951      This is useful in files containing narrowed table columns.  The
4952      corresponding variable is `org-startup-align-all-tables', with a
4953      default value `nil'.  
4954           align      align all tables
4955           noalign    don't align tables on startup
4956      Logging TODO state changes and clock intervals (variable
4957      `org-log-done') can be configured using these options.  
4958           logging          record a timestamp when an item is marked DONE
4959           nologging        don't record when items are marked DONE
4960           lognotedone      record timestamp and a note when DONE
4961           lognotestate     record timestamp, note when TODO state changes
4962           lognoteclock-out record timestamp and a note when clocking out
4963      Here are the options for hiding leading stars in outline headings.
4964      The corresponding variables are `org-hide-leading-stars' and
4965      `org-odd-levels-only', both with a default setting `nil' (meaning
4966      `showstars' and `oddeven').  
4967           hidestars  make all but one of the stars starting a headline invisible.
4968           showstars  show all stars starting a headline
4969           odd        allow only odd outline levels (1,3,...)
4970           oddeven    allow all outline levels
4971      To turn on custom format overlays over time stamps (variables
4972      `org-put-time-stamp-overlays' and
4973      `org-time-stamp-overlay-formats'), use 
4974           customtime overlay custom time format
4976 `#+SEQ_TODO:   #+TYP_TODO:'
4977      These lines set the TODO keywords and their interpretation in the
4978      current file.  The corresponding variables are `org-todo-keywords'
4979      and `org-todo-interpretation'.
4981 `#+TAGS:  TAG1(c1) TAG2(c2)'
4982      These lines (several such lines are allowed) specify the legal
4983      tags in this file, and (potentially) the corresponding _fast tag
4984      selection_ keys.  The corresponding variable is `org-tag-alist'.
4986 `#+LINK:  linkword replace'
4987      These lines (several are allowed) specify link abbreviations.
4988      *Note Link abbreviations::.  The corresponding variable is
4989      `org-link-abbrev-alist'.
4991 `#+CATEGORY:'
4992      This line sets the category for the agenda file.  The category
4993      applies for all subsequent lines until the next `#+CATEGORY' line,
4994      or the end of the file.  The first such line also applies to any
4995      entries before it.
4997 `#+ARCHIVE: %s_done::'
4998      This line sets the archive location for the agenda file.  It
4999      applies for all subsequent lines until the next `#+CATEGORY' line,
5000      or the end of the file.  The first such line also applies to any
5001      entries before it.  The corresponding variable is
5002      `org-archive-location'.
5004 `#+TBLFM:'
5005      This line contains the formulas for the table directly above the
5006      line.
5008 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5009      These lines provide settings for exporting files.  For more
5010      details see *Note Export options::.
5012 \x1f
5013 File: org,  Node: The very busy C-c C-c key,  Next: Clean view,  Prev: In-buffer settings,  Up: Miscellaneous
5015 12.4 The very busy C-c C-c key
5016 ==============================
5018 The key `C-c C-c' has many purposes in org-mode, which are all
5019 mentioned scattered throughout this manual.  One specific function of
5020 this key is to add _tags_ to a headline (*note Tags::).  In many other
5021 circumstances it means something like _Hey Org-mode, look here and
5022 update according to what you see here_.  Here is a summary of what this
5023 means in different contexts.
5025    - If there are highlights in the buffer from the creation of a sparse
5026      tree, or from clock display, remove these highlights.
5028    - If the cursor is in one of the special `#+KEYWORD' lines, this
5029      triggers scanning the buffer for these lines and updating the
5030      information.
5032    - If the cursor is inside a table, realign the table.  This command
5033      works even if the automatic table editor has been turned off.
5035    - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5036      entire table.
5038    - If the cursor is inside a table created by the `table.el' package,
5039      activate that table.
5041    - If the current buffer is a remember buffer, close the note and
5042      file it.  With a prefix argument, file it, without further
5043      interaction, to the default location.
5045    - If the cursor is on a `<<<target>>>', update radio targets and
5046      corresponding links in this buffer.
5048    - If the cursor is in a plain list item with a checkbox, toggle the
5049      status of the checkbox.
5051    - If the cursor is on a numbered item in a plain list, renumber the
5052      ordered list.
5054 \x1f
5055 File: org,  Node: Clean view,  Next: TTY keys,  Prev: The very busy C-c C-c key,  Up: Miscellaneous
5057 12.5 A cleaner outline view
5058 ===========================
5060 Some people find it noisy and distracting that the Org-mode headlines
5061 are starting with a potentially large number of stars.  For example the
5062 tree from *Note Headlines:::
5064      * Top level headline
5065      ** Second level
5066      *** 3rd level
5067          some text
5068      *** 3rd level
5069          more text
5070      * Another top level headline
5072 Unfortunately this is deeply ingrained into the code of Org-mode and
5073 cannot be easily changed.  You can, however, modify the display in such
5074 a way that all leading stars become invisible and the outline more easy
5075 to read.  To do this, customize the variable `org-hide-leading-stars'
5076 like this:
5078      (setq org-hide-leading-stars t)
5080 or change this on a per-file basis with one of the lines (anywhere in
5081 the buffer)
5083      #+STARTUP: showstars
5084      #+STARTUP: hidestars
5086 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5087 modifications.
5089    With stars hidden, the tree becomes:
5091      * Top level headline
5092       * Second level
5093        * 3rd level
5094          some text
5095        * 3rd level
5096          more text
5097      * Another top level headline
5099 Note that the leading stars are not truly replaced by whitespace, they
5100 are only fontified with the face `org-hide' that uses the background
5101 color as font color.  If you are not using either white or black
5102 background, you may have to customize this face to get the wanted
5103 effect.  Another possibility is to set this font such that the extra
5104 stars are almost invisible, for example using the color `grey90' on a
5105 white background.
5107    Things become cleaner still if you skip all the even levels and use
5108 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5109 outline level to the next:
5111      * Top level headline
5112        * Second level
5113          * 3rd level
5114            some text
5115          * 3rd level
5116            more text
5117      * Another top level headline
5119 In order to make the structure editing and export commands handle this
5120 convention correctly, use
5122      (setq org-odd-levels-only t)
5124 or set this on a per-file basis with one of the following lines (don't
5125 forget to press `C-c C-c' with the cursor in the startup line to
5126 activate changes immediately).
5128      #+STARTUP: odd
5129      #+STARTUP: oddeven
5131    You can convert an Org-mode file from single-star-per-level to the
5132 double-star-per-level convention with `M-x org-convert-to-odd-levels
5133 RET' in that file.  The reverse operation is `M-x
5134 org-convert-to-oddeven-levels'.
5136 \x1f
5137 File: org,  Node: TTY keys,  Next: Interaction,  Prev: Clean view,  Up: Miscellaneous
5139 12.6 Using org-mode on a tty
5140 ============================
5142 Org-mode uses a number of keys that are not accessible on a tty.  This
5143 applies to most special keys like cursor keys, <TAB> and <RET>, when
5144 these are combined with modifier keys like <Meta> and/or <Shift>.
5145 Org-mode uses these bindings because it needs to provide keys for a
5146 large number of commands, and because these keys appeared particularly
5147 easy to remember.  In order to still be able to access the core
5148 functionality of Org-mode on a tty, alternative bindings are provided.
5149 Here is a complete list of these bindings, which are obviously more
5150 cumbersome to use.  Note that sometimes a work-around can be better.
5151 For example changing a time stamp is really only fun with `S-<cursor>'
5152 keys.  On a tty you would rather use `C-c .'  to re-insert the
5153 timestamp.
5155 Default     Alternative 1  Alternative 2
5156 `S-<TAB>'   `C-u <TAB>'    
5157 `M-<left>'  `C-c C-x l'    `<Esc> <left>'
5158 `M-S-<left>'`C-c C-x L'    
5159 `M-<right>' `C-c C-x r'    `<Esc>
5160                            <right>'
5161 `M-S-<right>'`C-c C-x R'    
5162 `M-<up>'    `C-c C-x u'    `<Esc> <up>'
5163 `M-S-<up>'  `C-c C-x U'    
5164 `M-<down>'  `C-c C-x d'    `<Esc> <down>'
5165 `M-S-<down>'`C-c C-x D'    
5166 `S-<RET>'   `C-c C-x c'    
5167 `M-<RET>'   `C-c C-x m'    `<Esc> <RET>'
5168 `M-S-<RET>' `C-c C-x M'    
5169 `S-<left>'  `C-c C-x       
5170             <left>'        
5171 `S-<right>' `C-c C-x       
5172             <right>'       
5173 `S-<up>'    `C-c C-x       
5174             <up>'          
5175 `S-<down>'  `C-c C-x       
5176             <down>'        
5178 \x1f
5179 File: org,  Node: Interaction,  Next: Bugs,  Prev: TTY keys,  Up: Miscellaneous
5181 12.7 Interaction with other packages
5182 ====================================
5184 Org-mode lives in the world of GNU Emacs and interacts in various ways
5185 with other code out there.
5187 * Menu:
5189 * Cooperation::                 Packages Org-mode cooperates with
5190 * Conflicts::                   Packages that lead to conflicts
5192 \x1f
5193 File: org,  Node: Cooperation,  Next: Conflicts,  Prev: Interaction,  Up: Interaction
5195 12.7.1 Packages that Org-mode cooperates with
5196 ---------------------------------------------
5198 `calc.el' by Dave Gillespie
5199      Org-mode uses the calc package for implementing spreadsheet
5200      functionality in its tables (*note The spreadsheet::).  Org-modes
5201      checks for the availability of calc by looking for the function
5202      `calc-eval' which should be autoloaded in your setup if calc has
5203      been installed properly.  As of Emacs 22, calc is part of the Emacs
5204      distribution.  Another possibility for interaction between the two
5205      packages is using calc for embedded calculations. *Note Embedded
5206      Mode: (calc)Embedded Mode.  
5208 `constants.el' by Carsten Dominik
5209      In a table formula (*note The spreadsheet::), it is possible to use
5210      names for natural constants or units.  Instead of defining your own
5211      constants in the variable `org-table-formula-constants', install
5212      the `constants' package which defines a large number of constants
5213      and units, and lets you use unit prefixes like `M' for `Mega' etc.
5214      You will need version 2.0 of this package, available at
5215      `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5216      function `constants-get', which has to be autoloaded in your
5217      setup.  See the installation instructions in the file
5218      `constants.el'.
5220 `cdlatex.el' by Carsten Dominik
5221      Org-mode can make use of the cdlatex package to efficiently enter
5222      LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5224 `remember.el' by John Wiegley
5225      Org mode cooperates with remember, see *Note Remember::.
5226      `Remember.el' is not part of Emacs, find it on the web.  
5228 `table.el' by Takaaki Ota
5229      Complex ASCII tables with automatic line wrapping, column- and
5230      row-spanning, and alignment can be created using the Emacs table
5231      package by Takaaki Ota (`http://sourceforge.net/projects/table',
5232      and also part of Emacs 22).  When <TAB> or `C-c C-c' is pressed in
5233      such a table, Org-mode will call `table-recognize-table' and move
5234      the cursor into the table.  Inside a table, the keymap of Org-mode
5235      is inactive.  In order to execute Org-mode-related commands, leave
5236      the table.
5238     `C-c C-c'
5239           Recognize `table.el' table.  Works when the cursor is in a
5240           table.el table.
5242     `C-c ~'
5243           Insert a table.el table.  If there is already a table at
5244           point, this command converts it between the table.el format
5245           and the Org-mode format.  See the documentation string of the
5246           command `org-convert-table' for the restrictions under which
5247           this is possible.
5248      `table.el' is part of Emacs 22.
5250 \x1f
5251 File: org,  Node: Conflicts,  Prev: Cooperation,  Up: Interaction
5253 12.7.2 Packages that lead to conflicts with Org-mode
5254 ----------------------------------------------------
5256 `allout.el' by Ken Manheimer
5257      Startup of Org-mode may fail with the error message
5258      `(wrong-type-argument keymapp nil)' when there is an outdated
5259      version `allout.el' on the load path, for example the version
5260      distributed with Emacs 21.x.  Upgrade to Emacs 22 and this problem
5261      will disappear.  If for some reason you cannot do this, make sure
5262      that org.el is loaded _before_ `allout.el', for example by putting
5263      `(require 'org)' early enough into your `.emacs' file.
5265 `CUA.el' by Kim. F. Storm
5266      Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5267      by CUA-mode (as well as pc-select-mode and s-region-mode) to
5268      select and extend the region.  If you want to use one of these
5269      packages along with Org-mode, configure the variable
5270      `org-CUA-compatible'.  When set, Org-mode will move the following
5271      keybindings in org-mode files, and in the agenda buffer (but not
5272      during date selection).
5274           S-UP    -> M-p             S-DOWN  -> M-n
5275           S-LEFT  -> M--             S-RIGHT -> M-+
5276           S-RET   -> C-S-RET
5278      Yes, these are unfortunately more difficult to remember.  If you
5279      want to have other replacement keys, look at the variable
5280      `org-disputed-keys'.
5282 `windmove.el' by Hovav Shacham
5283      Also this package uses the `S-<cursor>' keys, so everything written
5284      in the paragraph above about CUA mode also applies here.
5286 \x1f
5287 File: org,  Node: Bugs,  Prev: Interaction,  Up: Miscellaneous
5289 12.8 Bugs
5290 =========
5292 Here is a list of things that should work differently, but which I have
5293 found too hard to fix.
5295    * If a table field starts with a link, and if the corresponding table
5296      column is narrowed (*note Narrow columns::) to a width too small to
5297      display the link, the field would look entirely empty even though
5298      it is not.  To prevent this, Org-mode throws an error.  The
5299      work-around is to make the column wide enough to fit the link, or
5300      to add some text (at least 2 characters) before the link in the
5301      same field.
5303    * Narrowing table columns does not work on XEmacs, because the
5304      `format' function does not transport text properties.
5306    * Text in an entry protected with the `QUOTE' keyword should not
5307      autowrap.
5309    * When the application called by `C-c C-o' to open a file link fails
5310      (for example because the application does not exist or refuses to
5311      open the file), it does so silently.  No error message is
5312      displayed.
5314    * Recalculating a table line applies the formulas from left to right.
5315      If a formula uses _calculated_ fields further down the row,
5316      multiple recalculation may be needed to get all fields consistent.
5318    * A single letter cannot be made bold, for example `*a*'.
5320    * The exporters work well, but could be made more efficient.
5322 \x1f
5323 File: org,  Node: Extensions and Hacking,  Next: History and Acknowledgments,  Prev: Miscellaneous,  Up: Top
5325 Appendix A Extensions, Hooks and Hacking
5326 ****************************************
5328 This appendix lists extensions for Org-mode written by other authors.
5329 It also covers some aspects where users can extend the functionality of
5330 Org-mode.
5332 * Menu:
5334 * Extensions::                  Existing 3rd-part extensions
5335 * Dynamic blocks::              Automatically filled blocks
5336 * Special agenda views::
5338 \x1f
5339 File: org,  Node: Extensions,  Next: Dynamic blocks,  Prev: Extensions and Hacking,  Up: Extensions and Hacking
5341 A.1 Third-party extensions for Org-mode
5342 =======================================
5344 The following extensions for Org-mode have been written by other people:
5346 `org-publish.el' by David O'Toole
5347      This package provides facilities for publishing related sets of
5348      Org-mode files together with linked files like images as a
5349      webpages.  It is highly configurable and can be used for other
5350      publishing purposes as well.  As of Org-mode version 4.30,
5351      `org-publish.el' is part of the Org-mode distribution.  It is not
5352      yet part of Emacs, however, a delay caused by the preparations for
5353      the 22.1 release.  In the mean time, `org-publish.el' can be
5354      downloaded from David's site:
5355      `http://dto.freeshell.org/e/org-publish.el'.  
5357 `org-mouse.el' by Piotr Zielinski
5358      This package implements extended mouse functionality for Org-mode.
5359      It allows you to cycle visibility and to edit the document
5360      structure with the mouse.  Best of all, it provides a
5361      context-sensitive menu on <mouse-3> that changes depending on the
5362      context of a mouse-click.  As of Org-mode version 4.53,
5363      `org-mouse.el' is part of the Org-mode distribution.  It is not
5364      yet part of Emacs, however, a delay caused by the preparations for
5365      the 22.1 release.  In the mean time, `org-mouse.el' can be
5366      downloaded from Piotr's site:
5367      `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.  
5369 `org-blog.el' by David O'Toole
5370      A blogging plug-in for `org-publish.el'.
5371      `http://dto.freeshell.org/notebook/OrgMode.html'.  
5373 `blorg.el' by Bastien Guerry
5374      Publish Org-mode files as blogs.
5375      `http://www.cognition.ens.fr/~guerry/blorg.html'.  
5377 `org2rem.el' by Bastien Guerry
5378      Translates Org-mode files into something readable by Remind.
5379      `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
5381 \x1f
5382 File: org,  Node: Dynamic blocks,  Next: Special agenda views,  Prev: Extensions,  Up: Extensions and Hacking
5384 A.2 Dynamic blocks
5385 ==================
5387 Org-mode documents can contain _dynamic blocks_.  These are specially
5388 marked regions that are updated by some user-written function.  A good
5389 example for such a block is the clock table inserted by the command
5390 `C-c C-x C-r' (*note Clocking work time::).
5392    Dynamic block are enclosed by a BEGIN-END structure that assigns a
5393 name to the block and can also specify parameters for the function
5394 producing the content of the block.
5396      #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5398      #+END:
5400    Dynamic blocks are updated with the following commands
5402 `C-c C-x C-u'
5403      Update dynamic block at point.  
5405 `C-u C-c C-x C-u'
5406      Update all dynamic blocks in the current file.
5408    Updating a dynamic block means to remove all the text between BEGIN
5409 and END, parse the BEGIN line for parameters and then call the specific
5410 writer function for this block to insert the new content.  For a block
5411 with name `myblock', the writer function is `org-dblock-write:myblock'
5412 with as only parameter a property list with the parameters given in the
5413 begin line.  Here is a trivial example of a block that keeps track of
5414 when the block update function was last run:
5416      #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5418      #+END:
5420 The corresponding block writer function could look like this:
5422      (defun org-dblock-write:block-update-time (params)
5423         (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5424           (insert "Last block update at: "
5425                   (format-time-string fmt (current-time)))))
5427    If you want to make sure that all dynamic blocks are always
5428 up-to-date, you could add the function `org-update-all-dblocks' to a
5429 hook, for example `before-save-hook'.  `org-update-all-dblocks' is
5430 written in a way that is does nothing in buffers that are not in
5431 Org-mode.
5433 \x1f
5434 File: org,  Node: Special agenda views,  Prev: Dynamic blocks,  Up: Extensions and Hacking
5436 A.3 Special Agenda Views
5437 ========================
5439 Org-mode provides a special hook that can be used to narrow down the
5440 selection made by any of the agenda views.  You may specify a function
5441 that is used at each match to verify if the match should indeed be part
5442 of the agenda view, and if not, how much should be skipped.
5444    Let's say you want to produce a list of projects that contain a
5445 WAITING tag anywhere in the project tree.  Let's further assume that
5446 you have marked all tree headings that define a project with the todo
5447 keyword PROJECT.  In this case you would run a todo search for the
5448 keyword PROJECT, but skip the match unless there is a WAITING tag
5449 anywhere in the subtree belonging to the project line.
5451    To achieve this, you must write a function that searches the subtree
5452 for the tag.  If the tag is found, the function must return `nil' to
5453 indicate that this match should not be skipped.  If there is no such
5454 tag, return the location of the end of the subtree, to indicate that
5455 search should continue from there.
5457      (defun my-skip-unless-waiting ()
5458        "Skip trees that are not waiting"
5459        (let ((subtree-end (save-excursion (org-end-of-subtree t))))
5460          (if (re-search-forward ":WAITING:" subtree-end t)
5461              nil          ; tag found, do not skip
5462            subtree-end))) ; tag not found, continue after end of subtree
5464    Furthermore you must write a command that uses `let' to temporarily
5465 put this function into the variable `org-agenda-skip-function', sets
5466 the header string for the agenda buffer, and calls the todo-list
5467 generator while asking for the specific TODO keyword PROJECT.  The
5468 function must also accept one argument MATCH, but it can choose to
5469 ignore it(1) (as we do in the example below).  Here is the example:
5471      (defun my-org-waiting-projects (&optional match)
5472        "Produce a list of projects that contain a WAITING tag.
5473      MATCH is being ignored."
5474        (interactive)
5475        (let ((org-agenda-skip-function 'my-skip-unless-waiting)
5476              (org-agenda-overriding-header "Projects waiting for something: "))
5477          ;; make the list
5478          (org-todo-list "PROJECT")))
5480    ---------- Footnotes ----------
5482    (1) MATCH must be present in case you want to define a custom
5483 command for producing this special list.  Custom commands always supply
5484 the MATCH argument, but it can be empty if you do not specify it while
5485 defining the command(*note Custom agenda views::).
5487 \x1f
5488 File: org,  Node: History and Acknowledgments,  Next: Index,  Prev: Extensions and Hacking,  Up: Top
5490 Appendix B History and Acknowledgments
5491 **************************************
5493 Org-mode was borne in 2003, out of frustration over the user interface
5494 of the Emacs outline-mode.  All I wanted was to make working with an
5495 outline tree possible without having to remember more than 10 commands
5496 just for hiding and unhiding parts of the outline tree, and to allow to
5497 restructure a tree easily.  Visibility cycling and structure editing
5498 were originally implemented in the package `outline-magic.el', but
5499 quickly moved to the more general `org.el'.  TODO entries, basic time
5500 stamps, and table support were added next, and highlight the two main
5501 goals that Org-mode still has today: To create a new, outline-based,
5502 plain text mode with innovative and intuitive editing features, and to
5503 incorporate project planning functionality directly into a notes file.
5505    Since the first release, hundreds of emails to me or on
5506 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
5507 feedback, new ideas, and sometimes patches and add-on code.  Many
5508 thanks to everyone who has helped to improve this package.  I am trying
5509 to keep here a list of the people who had significant influence in
5510 shaping one or more aspects of Org-mode.  The list may not be complete,
5511 if I have forgotten someone, please accept my apologies and let me know.
5513    * Thomas Baumann contributed the code for links to the MH-E email
5514      system.
5516    * Alex Bochannek provided a patch for rounding time stamps.
5518    * Charles Cave's suggestion sparked the implementation of templates
5519      for Remember.
5521    * Pavel Chalmoviansky influenced the agenda treatment of items with
5522      specified time.
5524    * Gregory Chernov patched support for lisp forms into table
5525      calculations and improved XEmacs compatibility, in particular by
5526      porting `nouline.el' to XEmacs.
5528    * Sacha Chua suggested to copy some linking code from Planner.
5530    * Eddward DeVilla proposed and tested checkbox statistics.
5532    * Kees Dullemond inspired the use of narrowed tabled columns.
5534    * Christian Egli converted the documentation into TeXInfo format,
5535      patched CSS formatting into the HTML exporter, and inspired the
5536      agenda.
5538    * Nic Ferrier contributed mailcap and XOXO support.
5540    * John Foerch figured out how to make incremental search show context
5541      around a match in a hidden outline tree.
5543    * Niels Giessen had the idea to automatically archive DONE trees.
5545    * Bastien Guerry provided extensive feedback and some patches, and
5546      translated David O'Toole's tutorial into French.
5548    * Kai Grossjohann pointed out key-binding conflicts with other
5549      packages.
5551    * Shidai Liu ("Leo") provided extensive feedback and some patches.
5553    * Leon Liu asked for embedded LaTeX and tested it.
5555    * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
5556      happy.
5558    * Todd Neal provided patches for links to Info files and elisp forms.
5560    * Tim O'Callaghan suggested in-file links, search options for general
5561      file links, and TAGS.
5563    * Takeshi Okano translated the manual and David O'Toole's tutorial
5564      into Japanese.
5566    * Oliver Oppitz suggested multi-state TODO items.
5568    * Scott Otterson sparked the introduction of descriptive text for
5569      links, among other things.
5571    * Pete Phillips helped during the development of the TAGS feature,
5572      and provided frequent feedback.
5574    * T.V. Raman reported bugs and suggested improvements.
5576    * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
5577      control.
5579    * Kevin Rogers contributed code to access VM files on remote hosts.
5581    * Frank Ruell solved the mystery of the `keymapp nil' bug, a
5582      conflict with `allout.el'.
5584    * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
5586    * Philip Rooke created the Org-mode reference card and provided lots
5587      of feedback.
5589    * Christian Schlauer proposed angular brackets around links, among
5590      other things.
5592    * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
5593      `organizer-mode.el'.
5595    * Daniel Sinder came up with the idea of internal archiving by
5596      locking subtrees.
5598    * Dale Smith proposed link abbreviations.
5600    * David O'Toole wrote `org-publish.el' and drafted the manual
5601      chapter about publishing.
5603    * Ju"rgen Vollmer contributed code generating the table of contents
5604      in HTML output.
5606    * Chris Wallace provided a patch implementing the `QUOTE' keyword.
5608    * David Wainberg suggested archiving, and improvements to the linking
5609      system.
5611    * John Wiegley wrote `emacs-wiki.el' and `planner.el'.  The
5612      development of Org-mode was fully independent, and both systems are
5613      really different beasts in their basic ideas and implementation
5614      details.  I later looked at John's code, however, and learned from
5615      his implementation of (i) links where the link itself is hidden
5616      and only a description is shown, and (ii) popping up a calendar to
5617      select a date.
5619    * Carsten Wimmer suggested some changes and helped fix a bug in
5620      linking to GNUS.
5622    * Roland Winkler requested additional keybindings to make Org-mode
5623      work on a tty.
5625    * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
5626      contributed various ideas and code snippets.
5628 \x1f
5629 File: org,  Node: Index,  Next: Key Index,  Prev: History and Acknowledgments,  Up: Top
5631 Index
5632 *****
5634 \0\b[index\0\b]
5635 * Menu:
5637 * abbreviation, links:                   Link abbreviations.  (line   6)
5638 * acknowledgments:                       History and Acknowledgments.
5639                                                               (line   6)
5640 * action, for publishing:                Publishing action.   (line   6)
5641 * activation:                            Activation.          (line   6)
5642 * active region <1>:                     Export commands.     (line   6)
5643 * active region <2>:                     ASCII export.        (line   9)
5644 * active region <3>:                     Built-in table editor.
5645                                                               (line 141)
5646 * active region:                         Structure editing.   (line  64)
5647 * agenda:                                Weekly/Daily agenda. (line   6)
5648 * agenda dispatcher:                     Agenda dispatcher.   (line   6)
5649 * agenda files:                          Agenda files.        (line   6)
5650 * agenda files, removing buffers:        Agenda commands.     (line 230)
5651 * agenda views:                          Agenda views.        (line   6)
5652 * agenda views, custom:                  Custom agenda views. (line   6)
5653 * agenda, batch production:              Batch processing.    (line   6)
5654 * agenda, with block views:              Block agenda.        (line   6)
5655 * align, STARTUP keyword:                In-buffer settings.  (line  29)
5656 * allout.el:                             Conflicts.           (line   6)
5657 * angular brackets, around links:        External links.      (line  43)
5658 * applescript, for calendar update:      iCalendar export.    (line  38)
5659 * archive locations:                     Moving subtrees.     (line  21)
5660 * archiving:                             Archiving.           (line   6)
5661 * ASCII export:                          ASCII export.        (line   6)
5662 * author:                                Feedback.            (line   6)
5663 * autoload:                              Activation.          (line   6)
5664 * backtrace of an error:                 Feedback.            (line  27)
5665 * BBDB links:                            External links.      (line   6)
5666 * block agenda:                          Block agenda.        (line   6)
5667 * blorg.el:                              Extensions.          (line  33)
5668 * bold text:                             Enhancing text.      (line  15)
5669 * Boolean logic, for tag searches:       Tag searches.        (line  23)
5670 * bug reports:                           Feedback.            (line   6)
5671 * bugs:                                  Bugs.                (line   6)
5672 * C-c C-c, overview:                     The very busy C-c C-c key.
5673                                                               (line   6)
5674 * calc package:                          The spreadsheet.     (line   6)
5675 * calc.el:                               Cooperation.         (line   6)
5676 * calculations, in tables <1>:           The spreadsheet.     (line   6)
5677 * calculations, in tables:               Built-in table editor.
5678                                                               (line 141)
5679 * calendar commands, from agenda:        Agenda commands.     (line 191)
5680 * calendar integration:                  Weekly/Daily agenda. (line  24)
5681 * calendar, for selecting date:          The date/time prompt.
5682                                                               (line  26)
5683 * CamelCase link completion:             Completion.          (line   6)
5684 * CamelCase links:                       Internal links.      (line   6)
5685 * CamelCase links, completion of:        CamelCase links.     (line   6)
5686 * category:                              Categories.          (line   6)
5687 * CDLaTeX:                               CDLaTeX mode.        (line   6)
5688 * cdlatex.el:                            Cooperation.         (line  29)
5689 * checkbox statistics:                   Checkboxes.          (line  23)
5690 * checkboxes:                            Checkboxes.          (line   6)
5691 * children, subtree visibility state:    Visibility cycling.  (line  10)
5692 * clean outline view:                    Clean view.          (line   6)
5693 * CLOCK keyword:                         Time stamps.         (line  71)
5694 * CLOSED keyword:                        Time stamps.         (line  65)
5695 * column formula:                        Column formulas.     (line   6)
5696 * commands, in agenda buffer:            Agenda commands.     (line   6)
5697 * comment lines:                         Comment lines.       (line   6)
5698 * completion, of CamelCase links <1>:    Completion.          (line   6)
5699 * completion, of CamelCase links:        CamelCase links.     (line   6)
5700 * completion, of dictionary words:       Completion.          (line   6)
5701 * completion, of file names:             Handling links.      (line  45)
5702 * completion, of link abbreviations:     Completion.          (line   6)
5703 * completion, of links:                  Handling links.      (line  27)
5704 * completion, of option keywords <1>:    Completion.          (line   6)
5705 * completion, of option keywords:        Export options.      (line   6)
5706 * Completion, of option keywords:        Per file keywords.   (line  17)
5707 * completion, of tags <1>:               Completion.          (line   6)
5708 * completion, of tags:                   Setting tags.        (line  11)
5709 * completion, of TeX symbols:            Completion.          (line   6)
5710 * completion, of TODO keywords <1>:      Completion.          (line   6)
5711 * completion, of TODO keywords:          Workflow states.     (line  12)
5712 * constants, in calculations:            References.          (line  65)
5713 * constants.el:                          Cooperation.         (line  14)
5714 * content, STARTUP keyword:              In-buffer settings.  (line  22)
5715 * contents, global visibility state:     Visibility cycling.  (line  22)
5716 * copying, of subtrees:                  Structure editing.   (line   6)
5717 * creating timestamps:                   Creating timestamps. (line   6)
5718 * CUA.el:                                Conflicts.           (line  15)
5719 * custom agenda views:                   Custom agenda views. (line   6)
5720 * custom date/time format:               Custom time format.  (line   6)
5721 * custom search strings:                 Custom searches.     (line   6)
5722 * customization:                         Customization.       (line   6)
5723 * customtime, STARTUP keyword:           In-buffer settings.  (line  49)
5724 * cutting, of subtrees:                  Structure editing.   (line   6)
5725 * cycling, of TODO states:               TODO basics.         (line  13)
5726 * cycling, visibility:                   Visibility cycling.  (line   6)
5727 * daily agenda:                          Weekly/Daily agenda. (line   6)
5728 * date format, custom:                   Custom time format.  (line   6)
5729 * date stamps <1>:                       Time stamps.         (line   6)
5730 * date stamps:                           Timestamps.          (line   6)
5731 * date, reading in minibuffer:           The date/time prompt.
5732                                                               (line   6)
5733 * DEADLINE keyword:                      Time stamps.         (line  53)
5734 * deadlines:                             Time stamps.         (line   6)
5735 * Deadlines, repeating:                  Repeating items.     (line   6)
5736 * debugging, of table formulas:          Editing and debuggung formulas.
5737                                                               (line  60)
5738 * demotion, of subtrees:                 Structure editing.   (line   6)
5739 * diary entries, creating from agenda:   Agenda commands.     (line 198)
5740 * diary integration:                     Weekly/Daily agenda. (line  24)
5741 * dictionary word completion:            Completion.          (line   6)
5742 * directories, for publishing:           Sources and destinations.
5743                                                               (line   6)
5744 * dispatching agenda commands:           Agenda dispatcher.   (line   6)
5745 * display changing, in agenda:           Agenda commands.     (line  65)
5746 * document structure:                    Document structure.  (line   6)
5747 * DONE, final TODO keyword:              Per file keywords.   (line  20)
5748 * editing tables:                        Tables.              (line   6)
5749 * editing, of table formulas:            Editing and debuggung formulas.
5750                                                               (line   6)
5751 * elisp links:                           External links.      (line   6)
5752 * emphasized text:                       Export options.      (line  25)
5753 * enhancing text:                        Enhancing text.      (line   6)
5754 * evaluate time range:                   Creating timestamps. (line  66)
5755 * even, STARTUP keyword:                 In-buffer settings.  (line  42)
5756 * exporting:                             Exporting.           (line   6)
5757 * exporting, not:                        Comment lines.       (line   6)
5758 * extended TODO keywords:                TODO extensions.     (line   6)
5759 * external archiving:                    Moving subtrees.     (line   6)
5760 * external links:                        External links.      (line   6)
5761 * external links, in HTML export:        Links.               (line   6)
5762 * FAQ:                                   Summary.             (line  52)
5763 * feedback:                              Feedback.            (line   6)
5764 * field formula:                         Field formulas.      (line   6)
5765 * field references:                      References.          (line  14)
5766 * file links:                            External links.      (line   6)
5767 * file links, searching:                 Search options.      (line   6)
5768 * file name completion:                  Handling links.      (line  45)
5769 * files for agenda:                      Agenda files.        (line   6)
5770 * files, adding to agenda list:          Agenda files.        (line  12)
5771 * files, selecting for publishing:       Selecting files.     (line   6)
5772 * fixed width:                           Enhancing text.      (line  25)
5773 * fixed-width sections:                  Export options.      (line  25)
5774 * folded, subtree visibility state:      Visibility cycling.  (line  10)
5775 * folding, sparse trees:                 Sparse trees.        (line   6)
5776 * following links:                       Handling links.      (line  60)
5777 * format specifier:                      Formula syntax for Calc.
5778                                                               (line  15)
5779 * format, of links:                      Link format.         (line   6)
5780 * formula debugging:                     Editing and debuggung formulas.
5781                                                               (line  60)
5782 * formula editing:                       Editing and debuggung formulas.
5783                                                               (line   6)
5784 * formula syntax, Calc:                  Formula syntax for Calc.
5785                                                               (line   6)
5786 * formula, for individual table field:   Field formulas.      (line   6)
5787 * formula, for table column:             Column formulas.     (line   6)
5788 * formula, in tables:                    Built-in table editor.
5789                                                               (line 141)
5790 * global cycling:                        Visibility cycling.  (line  22)
5791 * global keybindings:                    Activation.          (line   6)
5792 * global TODO list:                      Global TODO list.    (line   6)
5793 * global visibility states:              Visibility cycling.  (line  22)
5794 * GNUS links:                            External links.      (line   6)
5795 * hand-formatted lists:                  Enhancing text.      (line  11)
5796 * headline levels:                       Export options.      (line  25)
5797 * headline levels, for exporting <1>:    Export commands.     (line  17)
5798 * headline levels, for exporting:        ASCII export.        (line  18)
5799 * headline navigation:                   Motion.              (line   6)
5800 * headline tagging:                      Tags.                (line   6)
5801 * headline, promotion and demotion:      Structure editing.   (line   6)
5802 * headlines:                             Headlines.           (line   6)
5803 * hide text:                             Visibility cycling.  (line   6)
5804 * hidestars, STARTUP keyword:            In-buffer settings.  (line  42)
5805 * hiding leading stars:                  Clean view.          (line   6)
5806 * history:                               History and Acknowledgments.
5807                                                               (line   6)
5808 * HTML export:                           HTML export.         (line   6)
5809 * hyperlinks:                            Hyperlinks.          (line   6)
5810 * iCalendar export:                      iCalendar export.    (line   6)
5811 * images, inline in HTML:                Images.              (line   6)
5812 * in-buffer settings:                    In-buffer settings.  (line   6)
5813 * inactive timestamp:                    Time stamps.         (line  24)
5814 * index, of published pages:             Project page index.  (line   6)
5815 * Info links:                            External links.      (line   6)
5816 * inheritance, of tags:                  Tag inheritance.     (line   6)
5817 * inlining images in HTML:               Images.              (line   6)
5818 * inserting links:                       Handling links.      (line  27)
5819 * installation:                          Installation.        (line   6)
5820 * internal archiving:                    ARCHIVE tag.         (line   6)
5821 * internal links:                        Internal links.      (line   6)
5822 * internal links, in HTML export:        Links.               (line   6)
5823 * introduction:                          Introduction.        (line   6)
5824 * italic text:                           Enhancing text.      (line  15)
5825 * jumping, to headlines:                 Motion.              (line   6)
5826 * keybindings, global:                   Activation.          (line   6)
5827 * keyword options:                       Per file keywords.   (line   6)
5828 * LaTeX fragments <1>:                   Export options.      (line  25)
5829 * LaTeX fragments:                       LaTeX fragments.     (line   6)
5830 * LaTeX fragments, export:               Enhancing text.      (line  18)
5831 * LaTeX fragments, preview:              Processing LaTeX fragments.
5832                                                               (line   6)
5833 * LaTeX interpretation:                  Embedded LaTeX.      (line   6)
5834 * level, require for tags match:         Tag searches.        (line  68)
5835 * linebreak preservation:                Export options.      (line  25)
5836 * linebreak, forced:                     Enhancing text.      (line  32)
5837 * link abbreviations:                    Link abbreviations.  (line   6)
5838 * link abbreviations, completion of:     Completion.          (line   6)
5839 * link completion:                       Handling links.      (line  27)
5840 * link format:                           Link format.         (line   6)
5841 * links, external:                       External links.      (line   6)
5842 * links, handling:                       Handling links.      (line   6)
5843 * links, in HTML export:                 Links.               (line   6)
5844 * links, internal:                       Internal links.      (line   6)
5845 * links, publishing:                     Publishing links.    (line   6)
5846 * links, radio targets:                  Radio targets.       (line   6)
5847 * links, returning to:                   Handling links.      (line  87)
5848 * Lisp forms, as table formulas:         Formula syntax for Lisp.
5849                                                               (line   6)
5850 * lists, hand-formatted:                 Enhancing text.      (line  11)
5851 * lists, ordered:                        Plain lists.         (line   6)
5852 * lists, plain:                          Plain lists.         (line   6)
5853 * logdone, STARTUP keyword:              In-buffer settings.  (line  33)
5854 * logging, of progress:                  Progress logging.    (line   6)
5855 * lognoteclock-out, STARTUP keyword:     In-buffer settings.  (line  33)
5856 * lognotedone, STARTUP keyword:          In-buffer settings.  (line  33)
5857 * lognotestate, STARTUP keyword:         In-buffer settings.  (line  33)
5858 * maintainer:                            Feedback.            (line   6)
5859 * mark ring:                             Handling links.      (line  83)
5860 * marking characters, tables:            Advanced features.   (line  40)
5861 * matching, of tags:                     Matching headline tags.
5862                                                               (line   6)
5863 * matching, tags:                        Tags.                (line   6)
5864 * math symbols:                          Math symbols.        (line   6)
5865 * MH-E links:                            External links.      (line   6)
5866 * minor mode for tables:                 orgtbl-mode.         (line   6)
5867 * mode, for calc:                        Formula syntax for Calc.
5868                                                               (line  15)
5869 * motion commands in agenda:             Agenda commands.     (line  19)
5870 * motion, between headlines:             Motion.              (line   6)
5871 * name, of column or field:              References.          (line  65)
5872 * named references:                      References.          (line  65)
5873 * names as TODO keywords:                TODO types.          (line   6)
5874 * narrow columns in tables:              Narrow columns.      (line   6)
5875 * noalign, STARTUP keyword:              In-buffer settings.  (line  29)
5876 * nologging, STARTUP keyword:            In-buffer settings.  (line  33)
5877 * occur, command:                        Sparse trees.        (line   6)
5878 * odd, STARTUP keyword:                  In-buffer settings.  (line  42)
5879 * option keyword completion:             Completion.          (line   6)
5880 * options, for custom agenda views:      Setting Options.     (line   6)
5881 * options, for customization:            Customization.       (line   6)
5882 * options, for export:                   Export options.      (line   6)
5883 * options, for publishing:               Publishing options.  (line   6)
5884 * ordered lists:                         Plain lists.         (line   6)
5885 * org-agenda, command:                   Weekly/Daily agenda. (line   9)
5886 * org-blog.el:                           Extensions.          (line  29)
5887 * org-mode, turning on:                  Activation.          (line  22)
5888 * org-mouse.el:                          Extensions.          (line  17)
5889 * org-publish-project-alist:             Project alist.       (line   6)
5890 * org-publish.el:                        Extensions.          (line   8)
5891 * org2rem.el:                            Extensions.          (line  37)
5892 * orgtbl-mode:                           orgtbl-mode.         (line   6)
5893 * outline tree:                          Headlines.           (line   6)
5894 * outline-mode:                          Outlines.            (line   6)
5895 * outlines:                              Outlines.            (line   6)
5896 * overview, global visibility state:     Visibility cycling.  (line  22)
5897 * overview, STARTUP keyword:             In-buffer settings.  (line  22)
5898 * packages, interaction with other:      Interaction.         (line   6)
5899 * pasting, of subtrees:                  Structure editing.   (line   6)
5900 * per file keywords:                     Per file keywords.   (line   6)
5901 * plain lists:                           Plain lists.         (line   6)
5902 * plain text external links:             External links.      (line  43)
5903 * presentation, of agenda items:         Presentation and sorting.
5904                                                               (line   6)
5905 * printing sparse trees:                 Sparse trees.        (line  41)
5906 * priorities:                            Priorities.          (line   6)
5907 * priorities, of agenda items:           Sorting of agenda items.
5908                                                               (line   6)
5909 * progress logging:                      Progress logging.    (line   6)
5910 * projects, for publishing:              Project alist.       (line   6)
5911 * promotion, of subtrees:                Structure editing.   (line   6)
5912 * publishing:                            Publishing.          (line   6)
5913 * quoted HTML tags:                      Export options.      (line  25)
5914 * radio targets:                         Radio targets.       (line   6)
5915 * range references:                      References.          (line  44)
5916 * ranges, time:                          Time stamps.         (line   6)
5917 * recomputing table fields:              Updating the table.  (line   6)
5918 * references:                            References.          (line   6)
5919 * references, named:                     References.          (line  65)
5920 * references, to fields:                 References.          (line  14)
5921 * references, to ranges:                 References.          (line  44)
5922 * region, active <1>:                    Export commands.     (line   6)
5923 * region, active <2>:                    ASCII export.        (line   9)
5924 * region, active <3>:                    Built-in table editor.
5925                                                               (line 141)
5926 * region, active:                        Structure editing.   (line  64)
5927 * regular expressions, with tags search: Tag searches.        (line  63)
5928 * remember.el <1>:                       Cooperation.         (line  33)
5929 * remember.el:                           Remember.            (line   6)
5930 * remote editing, from agenda:           Agenda commands.     (line 106)
5931 * remote editing, undo:                  Agenda commands.     (line 109)
5932 * richer text:                           Enhancing text.      (line   6)
5933 * RMAIL links:                           External links.      (line   6)
5934 * SCHEDULED keyword:                     Time stamps.         (line  40)
5935 * scheduling:                            Time stamps.         (line   6)
5936 * Scheduling, repeating:                 Repeating items.     (line   6)
5937 * search option in file links:           Search options.      (line   6)
5938 * search strings, custom:                Custom searches.     (line   6)
5939 * searching for tags:                    Tag searches.        (line   6)
5940 * section-numbers:                       Export options.      (line  25)
5941 * setting tags:                          Setting tags.        (line   6)
5942 * SHELL links:                           External links.      (line   6)
5943 * show all, command:                     Visibility cycling.  (line  31)
5944 * show all, global visibility state:     Visibility cycling.  (line  22)
5945 * show hidden text:                      Visibility cycling.  (line   6)
5946 * showall, STARTUP keyword:              In-buffer settings.  (line  22)
5947 * showstars, STARTUP keyword:            In-buffer settings.  (line  42)
5948 * sorting, of agenda items:              Sorting of agenda items.
5949                                                               (line   6)
5950 * sparse tree, for deadlines:            Creating timestamps. (line  41)
5951 * sparse tree, for TODO:                 TODO basics.         (line  26)
5952 * sparse tree, tag based:                Tags.                (line   6)
5953 * sparse trees:                          Sparse trees.        (line   6)
5954 * special keywords:                      In-buffer settings.  (line   6)
5955 * spreadsheet capabilities:              The spreadsheet.     (line   6)
5956 * statistics, for checkboxes:            Checkboxes.          (line  23)
5957 * storing links:                         Handling links.      (line   9)
5958 * structure editing:                     Structure editing.   (line   6)
5959 * structure of document:                 Document structure.  (line   6)
5960 * sublevels, inclusion into tags match:  Tag inheritance.     (line   6)
5961 * sublevels, inclusion into todo list:   Global TODO list.    (line  33)
5962 * subscript:                             Subscripts and Superscripts.
5963                                                               (line   6)
5964 * subtree cycling:                       Visibility cycling.  (line  10)
5965 * subtree visibility states:             Visibility cycling.  (line  10)
5966 * subtree, cut and paste:                Structure editing.   (line   6)
5967 * subtree, subtree visibility state:     Visibility cycling.  (line  10)
5968 * subtrees, cut and paste:               Structure editing.   (line   6)
5969 * summary:                               Summary.             (line   6)
5970 * superscript:                           Subscripts and Superscripts.
5971                                                               (line   6)
5972 * syntax, of formulas:                   Formula syntax for Calc.
5973                                                               (line   6)
5974 * table editor, builtin:                 Built-in table editor.
5975                                                               (line   6)
5976 * table editor, table.el:                Cooperation.         (line  37)
5977 * table of contents:                     Export options.      (line  25)
5978 * table.el:                              Cooperation.         (line  34)
5979 * tables <1>:                            Export options.      (line  25)
5980 * tables:                                Tables.              (line   6)
5981 * tables, export:                        Enhancing text.      (line  21)
5982 * tag completion:                        Completion.          (line   6)
5983 * tag searches:                          Tag searches.        (line   6)
5984 * tags:                                  Tags.                (line   6)
5985 * tags view:                             Matching headline tags.
5986                                                               (line   6)
5987 * tags, setting:                         Setting tags.        (line   6)
5988 * targets, for links:                    Internal links.      (line   6)
5989 * targets, radio:                        Radio targets.       (line   6)
5990 * tasks, breaking down:                  Breaking down tasks. (line   6)
5991 * templates, for remember:               Remember.            (line  23)
5992 * TeX interpretation:                    Embedded LaTeX.      (line   6)
5993 * TeX macros <1>:                        Export options.      (line  25)
5994 * TeX macros:                            Math symbols.        (line   6)
5995 * TeX macros, export:                    Enhancing text.      (line  18)
5996 * TeX symbol completion:                 Completion.          (line   6)
5997 * TeX-like syntax for sub- and superscripts: Export options.  (line  25)
5998 * thanks:                                History and Acknowledgments.
5999                                                               (line   6)
6000 * time format, custom:                   Custom time format.  (line   6)
6001 * time grid:                             Time-of-day specifications.
6002                                                               (line  26)
6003 * time stamps <1>:                       Time stamps.         (line   6)
6004 * time stamps:                           Timestamps.          (line   6)
6005 * time, reading in minibuffer:           The date/time prompt.
6006                                                               (line   6)
6007 * time-of-day specification:             Time-of-day specifications.
6008                                                               (line   6)
6009 * time-sorted view:                      Timeline.            (line   6)
6010 * timeline, single file:                 Timeline.            (line   6)
6011 * timerange:                             Time stamps.         (line  31)
6012 * timestamp:                             Time stamps.         (line  14)
6013 * timestamp, inactive:                   Time stamps.         (line  24)
6014 * timestamps, creating:                  Creating timestamps. (line   6)
6015 * TODO items:                            TODO items.          (line   6)
6016 * TODO items, repeating:                 Repeating items.     (line   6)
6017 * TODO keyword matching:                 Global TODO list.    (line  17)
6018 * TODO keyword matching, with tags search: Tag searches.      (line  40)
6019 * TODO keywords completion:              Completion.          (line   6)
6020 * TODO list, global:                     Global TODO list.    (line   6)
6021 * TODO types:                            TODO types.          (line   6)
6022 * TODO workflow:                         Workflow states.     (line   6)
6023 * transient-mark-mode <1>:               Export commands.     (line   6)
6024 * transient-mark-mode <2>:               ASCII export.        (line   9)
6025 * transient-mark-mode <3>:               Built-in table editor.
6026                                                               (line 141)
6027 * transient-mark-mode:                   Structure editing.   (line  64)
6028 * trees, sparse:                         Sparse trees.        (line   6)
6029 * trees, visibility:                     Visibility cycling.  (line   6)
6030 * tty keybindings:                       TTY keys.            (line   6)
6031 * types as TODO keywords:                TODO types.          (line   6)
6032 * underlined text:                       Enhancing text.      (line  15)
6033 * undoing remote-editing events:         Agenda commands.     (line 109)
6034 * updating, table:                       Updating the table.  (line   6)
6035 * URL links:                             External links.      (line   6)
6036 * USENET links:                          External links.      (line   6)
6037 * variables, for customization:          Customization.       (line   6)
6038 * vectors, in table calculations:        Formula syntax for Calc.
6039                                                               (line  11)
6040 * visibility cycling:                    Visibility cycling.  (line   6)
6041 * visible text, printing:                Sparse trees.        (line  41)
6042 * VM links:                              External links.      (line   6)
6043 * WANDERLUST links:                      External links.      (line   6)
6044 * weekly agenda:                         Weekly/Daily agenda. (line   6)
6045 * windmove.el:                           Conflicts.           (line  33)
6046 * workflow states as TODO keywords:      Workflow states.     (line   6)
6047 * XEmacs:                                Installation.        (line   6)
6048 * XOXO export:                           XOXO export.         (line   6)
6050 \x1f
6051 File: org,  Node: Key Index,  Prev: Index,  Up: Top
6053 Key Index
6054 *********
6056 \0\b[index\0\b]
6057 * Menu:
6059 * $:                                     Agenda commands.     (line 123)
6060 * ':                                     CDLaTeX mode.        (line  43)
6061 * +:                                     Agenda commands.     (line 145)
6062 * ,:                                     Agenda commands.     (line 137)
6063 * -:                                     Agenda commands.     (line 151)
6064 * .:                                     Agenda commands.     (line 100)
6065 * ::                                     Agenda commands.     (line 131)
6066 * <:                                     The date/time prompt.
6067                                                               (line  29)
6068 * <left>:                                Agenda commands.     (line  97)
6069 * <RET> <1>:                             Agenda commands.     (line  41)
6070 * <RET> <2>:                             Setting tags.        (line  76)
6071 * <RET> <3>:                             The date/time prompt.
6072                                                               (line  54)
6073 * <RET>:                                 Built-in table editor.
6074                                                               (line  64)
6075 * <right>:                               Agenda commands.     (line  92)
6076 * <SPC> <1>:                             Agenda commands.     (line  28)
6077 * <SPC>:                                 Setting tags.        (line  73)
6078 * <TAB> <1>:                             CDLaTeX mode.        (line  23)
6079 * <TAB> <2>:                             Agenda commands.     (line  35)
6080 * <TAB> <3>:                             Setting tags.        (line  68)
6081 * <TAB> <4>:                             Built-in table editor.
6082                                                               (line  57)
6083 * <TAB> <5>:                             Plain lists.         (line  37)
6084 * <TAB>:                                 Visibility cycling.  (line  10)
6085 * > <1>:                                 Agenda commands.     (line 173)
6086 * >:                                     The date/time prompt.
6087                                                               (line  30)
6088 * ^:                                     CDLaTeX mode.        (line  33)
6089 * _:                                     CDLaTeX mode.        (line  33)
6090 * `:                                     CDLaTeX mode.        (line  39)
6091 * a:                                     Agenda commands.     (line 134)
6092 * b:                                     Agenda commands.     (line  51)
6093 * C:                                     Agenda commands.     (line 213)
6094 * c:                                     Agenda commands.     (line 191)
6095 * C-#:                                   Advanced features.   (line   9)
6096 * C-':                                   Agenda files.        (line  18)
6097 * C-,:                                   Agenda files.        (line  18)
6098 * C-_:                                   Agenda commands.     (line 109)
6099 * C-a a L:                               Timeline.            (line  10)
6100 * C-c !:                                 Creating timestamps. (line  21)
6101 * C-c #:                                 Checkboxes.          (line  56)
6102 * C-c %:                                 Handling links.      (line  83)
6103 * C-c &:                                 Handling links.      (line  87)
6104 * C-c ':                                 Editing and debuggung formulas.
6105                                                               (line  24)
6106 * C-c *:                                 Updating the table.  (line  13)
6107 * C-c +:                                 Built-in table editor.
6108                                                               (line 141)
6109 * C-c ,:                                 Priorities.          (line  18)
6110 * C-c -:                                 Built-in table editor.
6111                                                               (line  92)
6112 * C-c .:                                 Creating timestamps. (line  10)
6113 * C-c /:                                 Sparse trees.        (line  15)
6114 * C-c ::                                 Enhancing text.      (line  29)
6115 * C-c ;:                                 Comment lines.       (line  11)
6116 * C-c <:                                 Creating timestamps. (line  25)
6117 * C-c <TAB>:                             Built-in table editor.
6118                                                               (line 163)
6119 * C-c = <1>:                             Editing and debuggung formulas.
6120                                                               (line  10)
6121 * C-c =:                                 Column formulas.     (line  24)
6122 * C-c >:                                 Creating timestamps. (line  29)
6123 * C-c ?:                                 Editing and debuggung formulas.
6124                                                               (line  20)
6125 * C-c [:                                 Agenda files.        (line  12)
6126 * C-c \:                                 Tag searches.        (line   9)
6127 * C-c ]:                                 Agenda files.        (line  15)
6128 * C-c ^ <1>:                             Built-in table editor.
6129                                                               (line  96)
6130 * C-c ^:                                 Structure editing.   (line  52)
6131 * C-c `:                                 Built-in table editor.
6132                                                               (line 157)
6133 * C-c a !:                               Stuck projects.      (line  14)
6134 * C-c a #:                               Stuck projects.      (line  13)
6135 * C-c a a:                               Weekly/Daily agenda. (line   9)
6136 * C-c a C:                               Storing searches.    (line   9)
6137 * C-c a M:                               Matching headline tags.
6138                                                               (line  15)
6139 * C-c a m:                               Matching headline tags.
6140                                                               (line  10)
6141 * C-c a M:                               Tag searches.        (line  16)
6142 * C-c a m:                               Tag searches.        (line  12)
6143 * C-c a T:                               Global TODO list.    (line  14)
6144 * C-c a t <1>:                           Global TODO list.    (line   9)
6145 * C-c a t:                               TODO basics.         (line  33)
6146 * C-c C-a:                               Visibility cycling.  (line  31)
6147 * C-c C-b:                               Motion.              (line  15)
6148 * C-c C-c <1>:                           Cooperation.         (line  37)
6149 * C-c C-c <2>:                           The very busy C-c C-c key.
6150                                                               (line   6)
6151 * C-c C-c <3>:                           Processing LaTeX fragments.
6152                                                               (line  15)
6153 * C-c C-c <4>:                           Setting tags.        (line  10)
6154 * C-c C-c <5>:                           Checkboxes.          (line  37)
6155 * C-c C-c <6>:                           Editing and debuggung formulas.
6156                                                               (line  32)
6157 * C-c C-c <7>:                           Built-in table editor.
6158                                                               (line  54)
6159 * C-c C-c:                               Plain lists.         (line  74)
6160 * C-c C-d <1>:                           Agenda commands.     (line 158)
6161 * C-c C-d:                               Creating timestamps. (line  37)
6162 * C-c C-e:                               Exporting.           (line  19)
6163 * C-c C-e a:                             ASCII export.        (line   9)
6164 * C-c C-e b:                             Export commands.     (line   7)
6165 * C-c C-e c:                             iCalendar export.    (line  20)
6166 * C-c C-e h:                             Export commands.     (line   6)
6167 * C-c C-e I:                             iCalendar export.    (line  15)
6168 * C-c C-e i:                             iCalendar export.    (line  13)
6169 * C-c C-e t:                             Export options.      (line  13)
6170 * C-c C-e v <1>:                         XOXO export.         (line  11)
6171 * C-c C-e v:                             Sparse trees.        (line  41)
6172 * C-c C-e v a:                           ASCII export.        (line  13)
6173 * C-c C-e v b:                           Export commands.     (line  10)
6174 * C-c C-e v h:                           Export commands.     (line  10)
6175 * C-c C-e x:                             XOXO export.         (line  10)
6176 * C-c C-f:                               Motion.              (line  12)
6177 * C-c C-j:                               Motion.              (line  21)
6178 * C-c C-l:                               Handling links.      (line  27)
6179 * C-c C-n:                               Motion.              (line   8)
6180 * C-c C-o <1>:                           Creating timestamps. (line  33)
6181 * C-c C-o:                               Handling links.      (line  60)
6182 * C-c C-p:                               Motion.              (line   9)
6183 * C-c C-q <1>:                           Editing and debuggung formulas.
6184                                                               (line  34)
6185 * C-c C-q:                               Built-in table editor.
6186                                                               (line 125)
6187 * C-c C-r:                               Visibility cycling.  (line  32)
6188 * C-c C-s <1>:                           Agenda commands.     (line 155)
6189 * C-c C-s:                               Creating timestamps. (line  48)
6190 * C-c C-t <1>:                           Clocking work time.  (line  27)
6191 * C-c C-t:                               TODO basics.         (line  13)
6192 * C-c C-u:                               Motion.              (line  18)
6193 * C-c C-v:                               TODO basics.         (line  26)
6194 * C-c C-w:                               Creating timestamps. (line  41)
6195 * C-c C-x b:                             Visibility cycling.  (line  39)
6196 * C-c C-x C-a:                           ARCHIVE tag.         (line  28)
6197 * C-c C-x C-b:                           Checkboxes.          (line  38)
6198 * C-c C-x C-c:                           Agenda commands.     (line 220)
6199 * C-c C-x C-d:                           Clocking work time.  (line  35)
6200 * C-c C-x C-i:                           Clocking work time.  (line  12)
6201 * C-c C-x C-k:                           Structure editing.   (line  39)
6202 * C-c C-x C-l:                           Processing LaTeX fragments.
6203                                                               (line   9)
6204 * C-c C-x C-o:                           Clocking work time.  (line  14)
6205 * C-c C-x C-r:                           Clocking work time.  (line  43)
6206 * C-c C-x C-s:                           Moving subtrees.     (line  10)
6207 * C-c C-x C-t:                           Custom time format.  (line  12)
6208 * C-c C-x C-u:                           Dynamic blocks.      (line  21)
6209 * C-c C-x C-w <1>:                       Built-in table editor.
6210                                                               (line 114)
6211 * C-c C-x C-w:                           Structure editing.   (line  39)
6212 * C-c C-x C-x:                           Clocking work time.  (line  31)
6213 * C-c C-x C-y <1>:                       Built-in table editor.
6214                                                               (line 118)
6215 * C-c C-x C-y:                           Structure editing.   (line  46)
6216 * C-c C-x M-w <1>:                       Built-in table editor.
6217                                                               (line 111)
6218 * C-c C-x M-w:                           Structure editing.   (line  43)
6219 * C-c C-y <1>:                           Clocking work time.  (line  22)
6220 * C-c C-y:                               Creating timestamps. (line  66)
6221 * C-c l:                                 Handling links.      (line   9)
6222 * C-c {:                                 CDLaTeX mode.        (line  21)
6223 * C-c |:                                 Built-in table editor.
6224                                                               (line  40)
6225 * C-c ~:                                 Cooperation.         (line  50)
6226 * C-k:                                   Agenda commands.     (line 117)
6227 * C-TAB:                                 ARCHIVE tag.         (line  38)
6228 * C-u C-c *:                             Updating the table.  (line  18)
6229 * C-u C-c .:                             Creating timestamps. (line  16)
6230 * C-u C-c = <1>:                         Editing and debuggung formulas.
6231                                                               (line  10)
6232 * C-u C-c =:                             Field formulas.      (line  24)
6233 * C-u C-c C-c:                           Updating the table.  (line  19)
6234 * C-u C-c C-l:                           Handling links.      (line  45)
6235 * C-u C-c C-x C-a:                       ARCHIVE tag.         (line  31)
6236 * C-u C-c C-x C-s:                       Moving subtrees.     (line  12)
6237 * C-u C-c C-x C-u <1>:                   Dynamic blocks.      (line  22)
6238 * C-u C-c C-x C-u:                       Clocking work time.  (line  70)
6239 * C-u C-u C-c *:                         Updating the table.  (line  24)
6240 * C-u C-u C-c =:                         Editing and debuggung formulas.
6241                                                               (line  14)
6242 * D:                                     Agenda commands.     (line  74)
6243 * d:                                     Agenda commands.     (line  71)
6244 * f:                                     Agenda commands.     (line  44)
6245 * g:                                     Agenda commands.     (line  78)
6246 * H:                                     Agenda commands.     (line 217)
6247 * i:                                     Agenda commands.     (line 198)
6248 * I:                                     Agenda commands.     (line 178)
6249 * l:                                     Agenda commands.     (line  57)
6250 * L:                                     Agenda commands.     (line  32)
6251 * M:                                     Agenda commands.     (line 204)
6252 * M-<down> <1>:                          Editing and debuggung formulas.
6253                                                               (line  42)
6254 * M-<down>:                              Built-in table editor.
6255                                                               (line  82)
6256 * M-<left> <1>:                          Built-in table editor.
6257                                                               (line  72)
6258 * M-<left>:                              Structure editing.   (line  21)
6259 * M-<RET> <1>:                           Plain lists.         (line  42)
6260 * M-<RET>:                               Structure editing.   (line   6)
6261 * M-<right> <1>:                         Built-in table editor.
6262                                                               (line  72)
6263 * M-<right>:                             Structure editing.   (line  24)
6264 * M-<TAB> <1>:                           Completion.          (line  10)
6265 * M-<TAB> <2>:                           Setting tags.        (line   6)
6266 * M-<TAB>:                               Per file keywords.   (line  17)
6267 * M-<up> <1>:                            Editing and debuggung formulas.
6268                                                               (line  42)
6269 * M-<up>:                                Built-in table editor.
6270                                                               (line  82)
6271 * M-S-<down> <1>:                        Built-in table editor.
6272                                                               (line  89)
6273 * M-S-<down> <2>:                        Plain lists.         (line  59)
6274 * M-S-<down>:                            Structure editing.   (line  36)
6275 * M-S-<left> <1>:                        The date/time prompt.
6276                                                               (line  51)
6277 * M-S-<left> <2>:                        Built-in table editor.
6278                                                               (line  76)
6279 * M-S-<left> <3>:                        Plain lists.         (line  65)
6280 * M-S-<left>:                            Structure editing.   (line  27)
6281 * M-S-<RET> <1>:                         Checkboxes.          (line  53)
6282 * M-S-<RET> <2>:                         Plain lists.         (line  52)
6283 * M-S-<RET>:                             Structure editing.   (line  18)
6284 * M-S-<right> <1>:                       The date/time prompt.
6285                                                               (line  48)
6286 * M-S-<right> <2>:                       Built-in table editor.
6287                                                               (line  79)
6288 * M-S-<right> <3>:                       Plain lists.         (line  65)
6289 * M-S-<right>:                           Structure editing.   (line  30)
6290 * M-S-<up> <1>:                          Built-in table editor.
6291                                                               (line  86)
6292 * M-S-<up> <2>:                          Plain lists.         (line  59)
6293 * M-S-<up>:                              Structure editing.   (line  33)
6294 * mouse-1 <1>:                           Agenda commands.     (line  35)
6295 * mouse-1 <2>:                           The date/time prompt.
6296                                                               (line  33)
6297 * mouse-1:                               Handling links.      (line  74)
6298 * mouse-2 <1>:                           Agenda commands.     (line  35)
6299 * mouse-2:                               Handling links.      (line  74)
6300 * mouse-3 <1>:                           Agenda commands.     (line  28)
6301 * mouse-3:                               Handling links.      (line  79)
6302 * n:                                     Agenda commands.     (line  19)
6303 * O:                                     Agenda commands.     (line 180)
6304 * o:                                     Agenda commands.     (line  65)
6305 * P:                                     Agenda commands.     (line 142)
6306 * p:                                     Agenda commands.     (line  20)
6307 * q:                                     Agenda commands.     (line 227)
6308 * r <1>:                                 Agenda commands.     (line  82)
6309 * r:                                     Global TODO list.    (line  20)
6310 * S:                                     Agenda commands.     (line 208)
6311 * s:                                     Agenda commands.     (line  89)
6312 * S-<down> <1>:                          Agenda commands.     (line 151)
6313 * S-<down> <2>:                          The date/time prompt.
6314                                                               (line  42)
6315 * S-<down> <3>:                          Creating timestamps. (line  58)
6316 * S-<down> <4>:                          Priorities.          (line  25)
6317 * S-<down> <5>:                          Editing and debuggung formulas.
6318                                                               (line  37)
6319 * S-<down>:                              Plain lists.         (line  55)
6320 * S-<left> <1>:                          Agenda commands.     (line 169)
6321 * S-<left> <2>:                          The date/time prompt.
6322                                                               (line  39)
6323 * S-<left> <3>:                          Creating timestamps. (line  53)
6324 * S-<left>:                              TODO basics.         (line  20)
6325 * S-<RET>:                               Built-in table editor.
6326                                                               (line 146)
6327 * S-<right> <1>:                         Agenda commands.     (line 161)
6328 * S-<right> <2>:                         The date/time prompt.
6329                                                               (line  36)
6330 * S-<right> <3>:                         Creating timestamps. (line  53)
6331 * S-<right>:                             TODO basics.         (line  20)
6332 * S-<TAB> <1>:                           Built-in table editor.
6333                                                               (line  61)
6334 * S-<TAB>:                               Visibility cycling.  (line  22)
6335 * S-<up> <1>:                            Agenda commands.     (line 145)
6336 * S-<up> <2>:                            The date/time prompt.
6337                                                               (line  45)
6338 * S-<up> <3>:                            Creating timestamps. (line  58)
6339 * S-<up> <4>:                            Priorities.          (line  25)
6340 * S-<up> <5>:                            Editing and debuggung formulas.
6341                                                               (line  37)
6342 * S-<up>:                                Plain lists.         (line  55)
6343 * T:                                     Agenda commands.     (line 126)
6344 * t:                                     Agenda commands.     (line 113)
6345 * w:                                     Agenda commands.     (line  68)
6346 * x:                                     Agenda commands.     (line 230)
6347 * X:                                     Agenda commands.     (line 183)
6350 \x1f
6351 Tag Table:
6352 Node: Top\x7f970
6353 Node: Introduction\x7f10946
6354 Node: Summary\x7f11361
6355 Node: Installation\x7f14262
6356 Node: Activation\x7f15640
6357 Node: Feedback\x7f16889
6358 Node: Document structure\x7f18965
6359 Node: Outlines\x7f19739
6360 Node: Headlines\x7f20399
6361 Node: Visibility cycling\x7f21022
6362 Ref: Visibility cycling-Footnote-1\x7f23113
6363 Ref: Visibility cycling-Footnote-2\x7f23171
6364 Ref: Visibility cycling-Footnote-3\x7f23221
6365 Node: Motion\x7f23490
6366 Node: Structure editing\x7f24274
6367 Node: Archiving\x7f27100
6368 Node: ARCHIVE tag\x7f27658
6369 Node: Moving subtrees\x7f29451
6370 Node: Sparse trees\x7f30762
6371 Ref: Sparse trees-Footnote-1\x7f32893
6372 Ref: Sparse trees-Footnote-2\x7f33075
6373 Node: Plain lists\x7f33190
6374 Ref: Plain lists-Footnote-1\x7f36715
6375 Ref: Plain lists-Footnote-2\x7f37072
6376 Node: Tables\x7f37256
6377 Node: Built-in table editor\x7f37770
6378 Node: Narrow columns\x7f44766
6379 Ref: Narrow columns-Footnote-1\x7f46698
6380 Node: orgtbl-mode\x7f46744
6381 Node: The spreadsheet\x7f47238
6382 Node: References\x7f48056
6383 Node: Formula syntax for Calc\x7f51313
6384 Node: Formula syntax for Lisp\x7f53630
6385 Node: Field formulas\x7f54858
6386 Node: Column formulas\x7f56169
6387 Node: Editing and debuggung formulas\x7f57592
6388 Node: Updating the table\x7f60300
6389 Node: Advanced features\x7f61331
6390 Node: Hyperlinks\x7f65756
6391 Node: Link format\x7f66529
6392 Node: Internal links\x7f67822
6393 Ref: Internal links-Footnote-1\x7f69811
6394 Node: Radio targets\x7f69943
6395 Node: CamelCase links\x7f70658
6396 Node: External links\x7f71252
6397 Node: Handling links\x7f73656
6398 Ref: Handling links-Footnote-1\x7f78424
6399 Ref: Handling links-Footnote-2\x7f78661
6400 Node: Link abbreviations\x7f78735
6401 Node: Search options\x7f80414
6402 Ref: Search options-Footnote-1\x7f82194
6403 Node: Custom searches\x7f82275
6404 Node: Remember\x7f83323
6405 Node: TODO items\x7f87017
6406 Node: TODO basics\x7f87999
6407 Node: TODO extensions\x7f89526
6408 Node: Workflow states\x7f90321
6409 Node: TODO types\x7f91306
6410 Ref: TODO types-Footnote-1\x7f92964
6411 Node: Per file keywords\x7f93046
6412 Ref: Per file keywords-Footnote-1\x7f94500
6413 Node: Priorities\x7f94701
6414 Node: Breaking down tasks\x7f95945
6415 Ref: Breaking down tasks-Footnote-1\x7f96464
6416 Node: Checkboxes\x7f96560
6417 Node: Timestamps\x7f99315
6418 Node: Time stamps\x7f99849
6419 Ref: Time stamps-Footnote-1\x7f103343
6420 Ref: Time stamps-Footnote-2\x7f103459
6421 Node: Creating timestamps\x7f103614
6422 Node: The date/time prompt\x7f106240
6423 Ref: The date/time prompt-Footnote-1\x7f108006
6424 Node: Custom time format\x7f108112
6425 Node: Repeating items\x7f109670
6426 Node: Progress logging\x7f111480
6427 Node: Closing items\x7f112126
6428 Ref: Closing items-Footnote-1\x7f113060
6429 Ref: Closing items-Footnote-2\x7f113129
6430 Node: Tracking TODO state changes\x7f113202
6431 Node: Clocking work time\x7f114058
6432 Ref: Clocking work time-Footnote-1\x7f117704
6433 Ref: Clocking work time-Footnote-2\x7f117782
6434 Node: Tags\x7f117908
6435 Node: Tag inheritance\x7f118670
6436 Node: Setting tags\x7f119607
6437 Ref: Setting tags-Footnote-1\x7f123806
6438 Ref: Setting tags-Footnote-2\x7f123918
6439 Node: Tag searches\x7f124001
6440 Node: Agenda views\x7f126712
6441 Node: Agenda files\x7f128657
6442 Ref: Agenda files-Footnote-1\x7f129623
6443 Ref: Agenda files-Footnote-2\x7f129772
6444 Node: Agenda dispatcher\x7f129965
6445 Node: Built-in agenda views\x7f131656
6446 Node: Weekly/Daily agenda\x7f132234
6447 Node: Global TODO list\x7f134363
6448 Node: Matching headline tags\x7f136536
6449 Node: Timeline\x7f137607
6450 Node: Stuck projects\x7f138273
6451 Node: Presentation and sorting\x7f139972
6452 Node: Categories\x7f140763
6453 Node: Time-of-day specifications\x7f141427
6454 Node: Sorting of agenda items\x7f143398
6455 Node: Agenda commands\x7f144680
6456 Node: Custom agenda views\x7f151333
6457 Node: Storing searches\x7f152008
6458 Node: Block agenda\x7f153920
6459 Node: Setting Options\x7f155150
6460 Node: Batch processing\x7f157862
6461 Node: Embedded LaTeX\x7f158992
6462 Ref: Embedded LaTeX-Footnote-1\x7f160084
6463 Node: Math symbols\x7f160274
6464 Node: Subscripts and Superscripts\x7f161039
6465 Node: LaTeX fragments\x7f161883
6466 Ref: LaTeX fragments-Footnote-1\x7f163991
6467 Node: Processing LaTeX fragments\x7f164253
6468 Node: CDLaTeX mode\x7f165199
6469 Ref: CDLaTeX mode-Footnote-1\x7f167683
6470 Node: Exporting\x7f167831
6471 Node: ASCII export\x7f169145
6472 Node: HTML export\x7f170435
6473 Node: Export commands\x7f171054
6474 Node: Quoting HTML tags\x7f171778
6475 Node: Links\x7f172121
6476 Node: Images\x7f172818
6477 Ref: Images-Footnote-1\x7f173689
6478 Node: CSS support\x7f173750
6479 Ref: CSS support-Footnote-1\x7f175069
6480 Node: XOXO export\x7f175182
6481 Node: iCalendar export\x7f175621
6482 Node: Text interpretation\x7f177444
6483 Node: Comment lines\x7f177923
6484 Node: Enhancing text\x7f178394
6485 Node: Export options\x7f180086
6486 Node: Publishing\x7f181753
6487 Ref: Publishing-Footnote-1\x7f182549
6488 Node: Configuration\x7f182745
6489 Node: Project alist\x7f183463
6490 Node: Sources and destinations\x7f184529
6491 Node: Selecting files\x7f185259
6492 Node: Publishing action\x7f186007
6493 Node: Publishing options\x7f187240
6494 Node: Publishing links\x7f189392
6495 Node: Project page index\x7f190905
6496 Node: Sample configuration\x7f191683
6497 Node: Simple example\x7f192175
6498 Node: Complex example\x7f192848
6499 Node: Triggering publication\x7f194924
6500 Node: Miscellaneous\x7f195609
6501 Node: Completion\x7f196243
6502 Node: Customization\x7f197714
6503 Node: In-buffer settings\x7f198297
6504 Node: The very busy C-c C-c key\x7f202537
6505 Node: Clean view\x7f204181
6506 Node: TTY keys\x7f206758
6507 Node: Interaction\x7f208367
6508 Node: Cooperation\x7f208764
6509 Node: Conflicts\x7f211505
6510 Node: Bugs\x7f213097
6511 Node: Extensions and Hacking\x7f214491
6512 Node: Extensions\x7f214995
6513 Node: Dynamic blocks\x7f216938
6514 Node: Special agenda views\x7f218894
6515 Ref: Special agenda views-Footnote-1\x7f221173
6516 Node: History and Acknowledgments\x7f221433
6517 Node: Index\x7f226792
6518 Node: Key Index\x7f256794
6519 \x1f
6520 End Tag Table