1 This is org, produced by makeinfo version 4.8 from org.texi.
5 * Org Mode: (org). Outline-based notes management and organizer
8 This manual is for Org-mode (version 4.70).
10 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation
12 Permission is granted to copy, distribute and/or modify this
13 document under the terms of the GNU Free Documentation License,
14 Version 1.1 or any later version published by the Free Software
15 Foundation; with no Invariant Sections, with the Front-Cover texts
16 being "A GNU Manual," and with the Back-Cover Texts as in (a)
17 below. A copy of the license is included in the section entitled
18 "GNU Free Documentation License."
20 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
21 modify this GNU Manual, like GNU software. Copies published by
22 the Free Software Foundation raise funds for GNU development."
25 File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
30 This manual is for Org-mode (version 4.70).
32 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation
34 Permission is granted to copy, distribute and/or modify this
35 document under the terms of the GNU Free Documentation License,
36 Version 1.1 or any later version published by the Free Software
37 Foundation; with no Invariant Sections, with the Front-Cover texts
38 being "A GNU Manual," and with the Back-Cover Texts as in (a)
39 below. A copy of the license is included in the section entitled
40 "GNU Free Documentation License."
42 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
43 modify this GNU Manual, like GNU software. Copies published by
44 the Free Software Foundation raise funds for GNU development."
48 * Introduction:: Getting started
49 * Document structure:: A tree works like your brain
50 * Tables:: Pure magic for quick formatting
51 * Hyperlinks:: Notes in context
52 * TODO items:: Every tree branch can be a TODO item
53 * Timestamps:: Assign date and time to items
54 * Tags:: Tagging headlines and matching sets of tags
55 * Agenda views:: Collecting information into views
56 * Embedded LaTeX:: LaTeX fragments and formulas
57 * Exporting:: Sharing and publishing of notes
58 * Publishing:: Create a web site of linked Org-mode files
59 * Miscellaneous:: All the rest which did not fit elsewhere
60 * Extensions and Hacking:: It is possible to write add-on code
61 * History and Acknowledgments:: How Org-mode came into being
62 * Index:: The fast road to specific information
63 * Key Index:: Key bindings and where they are described
65 --- The Detailed Node Listing ---
69 * Summary:: Brief summary of what Org-mode does
70 * Installation:: How to install a downloaded version of Org-mode
71 * Activation:: How to activate Org-mode for certain buffers.
72 * Feedback:: Bug reports, ideas, patches etc.
76 * Outlines:: Org-mode is based on outline-mode
77 * Headlines:: How to typeset org-tree headlines
78 * Visibility cycling:: Show and hide, much simplified
79 * Motion:: Jumping to other headlines
80 * Structure editing:: Changing sequence and level of headlines
81 * Archiving:: Move done task trees to a different place
82 * Sparse trees:: Matches embedded in context
83 * Plain lists:: Additional structure within an entry
87 * ARCHIVE tag:: Marking a tree as inactive
88 * Moving subtrees:: Moving a tree to an archive file
92 * Built-in table editor:: Simple tables
93 * Narrow columns:: Stop wasting space in tables
94 * orgtbl-mode:: The table editor as minor mode
95 * The spreadsheet:: The table editor has spreadsheet capabilities.
99 * References:: How to refer to another field or range
100 * Formula syntax for Calc:: Using Calc to compute stuff
101 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
102 * Field formulas:: Formulas valid for a single field
103 * Column formulas:: Formulas valid for an entire column
104 * Editing and debugging formulas:: Fixing formulas
105 * Updating the table:: Recomputing all dependent fields
106 * Advanced features:: Field names, parameters and automatic recalc
110 * Link format:: How links in Org-mode are formatted
111 * Internal links:: Links to other places in the current file
112 * External links:: URL-like links to the world
113 * Handling links:: Creating, inserting and following
114 * Link abbreviations:: Shortcuts for writing complex links
115 * Search options:: Linking to a specific location
116 * Custom searches:: When the default search is not enough
117 * Remember:: Org-trees store quick notes
121 * Radio targets:: Make targets trigger links in plain text.
125 * Setting up remember:: Some code for .emacs to get things going
126 * Remember templates:: Define the outline of different note types
127 * Storing notes:: Directly get the note to where it belongs
131 * TODO basics:: Marking and displaying TODO entries
132 * TODO extensions:: Workflow and assignments
133 * Priorities:: Some things are more important than others
134 * Breaking down tasks:: Splitting a task into manageable pieces
135 * Checkboxes:: Tick-off lists
137 Extended use of TODO keywords
139 * Workflow states:: From TODO to DONE in steps
140 * TODO types:: I do this, Fred the rest
141 * Multiple sets in one file:: Mixing it all, and still finding your way
142 * Per file keywords:: Different files, different requirements
146 * Time stamps:: Assigning a time to a tree entry
147 * Creating timestamps:: Commands which insert timestamps
148 * Custom time format:: If you cannot work with the ISO format
149 * Repeating items:: Deadlines that come back again and again
150 * Progress logging:: Documenting when what work was done.
154 * The date/time prompt:: How org-mode helps you entering date and time
158 * Closing items:: When was this entry marked DONE?
159 * Tracking TODO state changes:: When did the status change?
160 * Clocking work time:: When exactly did you work on this item?
164 * Tag inheritance:: Tags use the tree structure of the outline
165 * Setting tags:: How to assign tags to a headline
166 * Tag searches:: Searching for combinations of tags
170 * Agenda files:: Files being searched for agenda information
171 * Agenda dispatcher:: Keyboard access to agenda views
172 * Built-in agenda views:: What is available out of the box?
173 * Presentation and sorting:: How agenda items are prepared for display
174 * Agenda commands:: Remote editing of org trees
175 * Custom agenda views:: Defining special searches and views
177 The built-in agenda views
179 * Weekly/Daily agenda:: The calendar page with current tasks
180 * Global TODO list:: All unfinished action items
181 * Matching headline tags:: Structured information with fine-tuned search
182 * Timeline:: Time-sorted view for single file
183 * Stuck projects:: Find projects you need to review
185 Presentation and sorting
187 * Categories:: Not all tasks are equal
188 * Time-of-day specifications:: How the agenda knows the time
189 * Sorting of agenda items:: The order of things
193 * Storing searches:: Type once, use often
194 * Block agenda:: All the stuff you need in a single buffer
195 * Setting Options:: Changing the rules
196 * Batch processing:: Agenda views from the command line
200 * Math symbols:: TeX macros for symbols and Greek letters
201 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
202 * LaTeX fragments:: Complex formulas made easy
203 * Processing LaTeX fragments:: Previewing LaTeX processing
204 * CDLaTeX mode:: Speed up entering of formulas
208 * ASCII export:: Exporting to plain ASCII
209 * HTML export:: Exporting to HTML
210 * XOXO export:: Exporting to XOXO
211 * iCalendar export:: Exporting in iCalendar format
212 * Text interpretation:: How the exporter looks at the file
216 * Export commands:: How to invoke HTML export
217 * Quoting HTML tags:: Using direct HTML in Org-mode
218 * Links:: How hyperlinks get transferred to HTML
219 * Images:: To inline or not to inline?
220 * CSS support:: Style specifications
222 Text interpretation by the exporter
224 * Comment lines:: Some lines will not be exported
225 * Initial text:: Text before the first headline
226 * Enhancing text:: Subscripts, symbols and more
227 * Export options:: How to influence the export settings
231 * Configuration:: Defining projects
232 * Sample configuration:: Example projects
233 * Triggering publication:: Publication commands
237 * Project alist:: The central configuration variable
238 * Sources and destinations:: From here to there
239 * Selecting files:: What files are part of the project?
240 * Publishing action:: Setting the function doing the publishing
241 * Publishing options:: Tweaking HTML export
242 * Publishing links:: Which links keep working after publishing?
243 * Project page index:: Publishing a list of project files
247 * Simple example:: One-component publishing
248 * Complex example:: A multi-component publishing example
252 * Completion:: M-TAB knows what you need
253 * Customization:: Adapting Org-mode to your taste
254 * In-buffer settings:: Overview of the #+KEYWORDS
255 * The very busy C-c C-c key:: When in doubt, press C-c C-c
256 * Clean view:: Getting rid of leading stars in the outline
257 * TTY keys:: Using Org-mode on a tty
258 * Interaction:: Other Emacs packages
259 * Bugs:: Things which do not work perfectly
261 Interaction with other packages
263 * Cooperation:: Packages Org-mode cooperates with
264 * Conflicts:: Packages that lead to conflicts
266 Extensions, Hooks and Hacking
268 * Extensions:: Existing 3rd-part extensions
269 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
270 * Dynamic blocks:: Automatically filled blocks
271 * Special agenda views:: Customized views
273 Tables in arbitrary syntax
275 * Radio tables:: Sending and receiving
276 * A LaTeX example:: Step by step, almost a tutorial
277 * Translator functions:: Copy and modify
280 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
287 * Summary:: Brief summary of what Org-mode does
288 * Installation:: How to install a downloaded version of Org-mode
289 * Activation:: How to activate Org-mode for certain buffers.
290 * Feedback:: Bug reports, ideas, patches etc.
293 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
298 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
299 project planning with a fast and effective plain-text system.
301 Org-mode develops organizational tasks around NOTES files that
302 contain lists or information about projects as plain text. Org-mode is
303 implemented on top of outline-mode, which makes it possible to keep the
304 content of large files well structured. Visibility cycling and
305 structure editing help to work with the tree. Tables are easily created
306 with a built-in table editor. Org-mode supports ToDo items, deadlines,
307 time stamps, and scheduling. It dynamically compiles entries into an
308 agenda that utilizes and smoothly integrates much of the Emacs calendar
309 and diary. Plain text URL-like links connect to websites, emails,
310 Usenet messages, BBDB entries, and any files related to the projects.
311 For printing and sharing of notes, an Org-mode file can be exported as a
312 structured ASCII file, as HTML, or (todo and agenda items only) as an
313 iCalendar file. It can also serve as a publishing tool for a set of
316 An important design aspect that distinguishes Org-mode from for
317 example Planner/Muse is that it encourages to store every piece of
318 information only once. In Planner, you have project pages, day pages
319 and possibly other files, duplicating some information such as tasks.
320 In Org-mode, you only have notes files. In your notes you mark entries
321 as tasks, label them with tags and timestamps. All necessary lists
322 like a schedule for the day, the agenda for a meeting, tasks lists
323 selected by tags etc are created dynamically when you need them.
325 Org-mode keeps simple things simple. When first fired up, it should
326 feel like a straightforward, easy to use outliner. Complexity is not
327 imposed, but a large amount of functionality is available when you need
328 it. Org-mode can be used on different levels and in different ways, for
331 * outline extension with visibility cycling and structure editing
332 * ASCII system and table editor for taking structured notes
333 * ASCII table editor with spreadsheet-like capabilities
335 * full agenda and planner with deadlines and work scheduling
336 * environment to implement David Allen's GTD system
337 * simple hypertext system, with HTML export
338 * publishing tool to create a set of interlinked webpages
340 Org-mode's automatic, context sensitive table editor with spreadsheet
341 capabilities can be integrated into any major mode by activating the
342 minor Orgtbl-mode. Using a translation step, it can be used to maintain
343 tables in arbitrary file types, for example in LaTeX.
345 There is a website for Org-mode which provides links to the newest
346 version of Org-mode, as well as additional information, frequently asked
347 questions (FAQ), links to tutorials etc. This page is located at
348 `http://www.astro.uva.nl/~dominik/Tools/org/'.
351 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
356 Important: If Org-mode is part of the Emacs distribution or an XEmacs
357 package, please skip this section and go directly to *Note Activation::.
359 If you have downloaded Org-mode from the Web, you must take the
360 following steps to install it: Go into the Org-mode distribution
361 directory and edit the top section of the file `Makefile'. You must
362 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
363 and the paths to the directories where local Lisp and Info files are
364 kept. If you don't have access to the system-wide directories, create
365 your own two directories for these files, enter them into the Makefile,
366 and make sure Emacs finds the Lisp files by adding the following line
369 (setq load-path (cons "~/path/to/lispdir" load-path))
371 XEmacs users now need to install the file `noutline.el' from the
372 `xemacs' subdirectory of the Org-mode distribution. Use the command:
374 make install-noutline
376 Now byte-compile and install the Lisp files with the shell commands:
381 If you want to install the info documentation, use this command:
385 Then add to `.emacs':
387 ;; This line only if org-mode is not part of the X/Emacs distribution.
388 (require 'org-install)
391 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
396 Add the following lines to your `.emacs' file. The last two lines
397 define _global_ keys for the commands `org-store-link' and `org-agenda'
398 - please choose suitable keys yourself.
400 ;; The following lines are always needed. Choose your own keys.
401 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
402 (define-key global-map "\C-cl" 'org-store-link)
403 (define-key global-map "\C-ca" 'org-agenda)
405 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
406 because significant functionality depends on font-locking being active.
407 You can do this with either one of the following two lines (XEmacs
408 user must use the second option):
409 (global-font-lock-mode 1) ; for all buffers
410 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
412 With this setup, all files with extension `.org' will be put into
413 Org-mode. As an alternative, make the first line of a file look like
416 MY PROJECTS -*- mode: org; -*-
418 which will select Org-mode for this buffer no matter what the file's
419 name is. See also the variable `org-insert-mode-line-in-empty-file'.
422 File: org, Node: Feedback, Prev: Activation, Up: Introduction
427 If you find problems with Org-mode, or if you have questions, remarks,
428 or ideas about it, please contact the maintainer Carsten Dominik at
429 <dominik at science dot uva dot nl>.
431 For bug reports, please provide as much information as possible,
432 including the version information of Emacs (`C-h v emacs-version
433 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
434 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
435 can be very useful (see below on how to create one). Often a small
436 example file helps, along with clear information about:
438 1. What exactly did you do?
440 2. What did you expect to happen?
442 3. What happened instead?
443 Thank you for helping to improve this mode.
445 How to create a useful backtrace
446 ................................
448 If working with Org-mode produces an error with a message you don't
449 understand, you may have hit a bug. The best way to report this is by
450 providing, in addition to what was mentioned above, a _Backtrace_.
451 This is information from the built-in debugger about where and how the
452 error occurred. Here is how to produce a useful backtrace:
454 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
455 original Lisp code in `org.el' instead of the compiled version in
456 `org.elc'. The backtrace contains much more information if it is
457 produced with uncompiled code. To do this, either rename `org.elc'
458 to something else before starting Emacs, or ask Emacs explicitly
459 to load `org.el' by using the command line
460 emacs -l /path/to/org.el
462 2. Go to the `Options' menu and select `Enter Debugger on Error'
463 (XEmacs has this option in the `Troubleshooting' sub-menu).
465 3. Do whatever you have to do to hit the error. Don't forget to
466 document the steps you take.
468 4. When you hit the error, a `*Backtrace*' buffer will appear on the
469 screen. Save this buffer to a file (for example using `C-x C-w')
470 and attach it to your bug report.
473 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
478 Org-mode is based on outline mode and provides flexible commands to
479 edit the structure of the document.
483 * Outlines:: Org-mode is based on outline-mode
484 * Headlines:: How to typeset org-tree headlines
485 * Visibility cycling:: Show and hide, much simplified
486 * Motion:: Jumping to other headlines
487 * Structure editing:: Changing sequence and level of headlines
488 * Archiving:: Move done task trees to a different place
489 * Sparse trees:: Matches embedded in context
490 * Plain lists:: Additional structure within an entry
493 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
498 Org-mode is implemented on top of outline-mode. Outlines allow to
499 organize a document in a hierarchical structure, which (at least for
500 me) is the best representation of notes and thoughts. Overview over
501 this structure is achieved by folding (hiding) large parts of the
502 document to show only the general document structure and the parts
503 currently being worked on. Org-mode greatly simplifies the use of
504 outlines by compressing the entire show/hide functionality into a
505 single command `org-cycle', which is bound to the <TAB> key.
508 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
513 Headlines define the structure of an outline tree. The headlines in
514 Org-mode start with one or more stars, on the left margin. For example:
522 * Another top level headline
524 Some people find the many stars too noisy and would prefer an outline
525 that has whitespace followed by a single star as headline starters.
526 *Note Clean view:: describes a setup to realize this.
529 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
531 2.3 Visibility cycling
532 ======================
534 Outlines make it possible to hide parts of the text in the buffer.
535 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
536 the visibility in the buffer.
539 _Subtree cycling_: Rotate current subtree between the states
541 ,-> FOLDED -> CHILDREN -> SUBTREE --.
542 '-----------------------------------'
544 The cursor must be on a headline for this to work(1). When the
545 cursor is at the beginning of the buffer and the first line is not
546 a headline, then <TAB> actually runs global cycling (see
547 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
548 global cycling is invoked.
552 _Global cycling_: Rotate the entire buffer between the states
554 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
555 '--------------------------------------'
557 When `S-<TAB>' is called with a numerical prefix N, the CONTENTS
558 view up to headlines of level N will be shown. Note that inside
559 tables, `S-<TAB>' jumps to the previous field.
565 Reveal context around point, showing the current entry, the
566 following heading and the hierarchy above. Useful for working
567 near a location exposed by a sparse tree command (*note Sparse
568 trees::) or an agenda command (*note Agenda commands::). With
569 prefix arg show, on each level, all sibling headings.
572 Show the current subtree in an indirect buffer(3). With numerical
573 prefix ARG, go up to this level and then take that tree. If ARG is
574 negative, go up that many levels. With `C-u' prefix, do not remove
575 the previously used indirect buffer.
577 When Emacs first visits an Org-mode file, the global state is set to
578 OVERVIEW, i.e. only the top level headlines are visible. This can be
579 configured through the variable `org-startup-folded', or on a per-file
580 basis by adding one of the following lines anywhere in the buffer:
586 ---------- Footnotes ----------
588 (1) see, however, the option `org-cycle-emulate-tab'.
590 (2) see the option `org-cycle-global-at-bob'.
592 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
593 Buffers.) will contain the entire buffer, but will be narrowed to the
594 current tree. Editing the indirect buffer will also change the
595 original buffer, but without affecting visibility in that buffer.
598 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
603 The following commands jump to other headlines in the buffer.
612 Next heading same level.
615 Previous heading same level.
618 Backward to higher level heading.
621 Jump to a different place without changing the current outline
622 visibility. Shows the document structure in a temporary buffer,
623 where you can use visibility cycling (<TAB>) to find your
624 destination. After pressing <RET>, the cursor moves to the
625 selected location in the original buffer, and the headings
626 hierarchy above it is made visible.
629 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
631 2.5 Structure editing
632 =====================
635 Insert new heading with same level as current. If the cursor is
636 in a plain list item, a new item is created (*note Plain lists::).
637 To force creation of a new headline, use a prefix arg, or first
638 press <RET> to get to the beginning of the next line. When this
639 command is used in the middle of a line, the line is split and the
640 rest of the line becomes the new headline. If the command is used
641 at the beginning of a headline, the new headline is created before
642 the current line. If at the beginning of any other line, the
643 content of that line is made the new heading. If the command is
644 used at the end of a folded subtree (i.e. behind the ellipses at
645 the end of a headline), then a headline like the current one will
646 be inserted after the end of the subtree.
649 Insert new TODO entry with same level as current heading.
652 Promote current heading by one level.
655 Demote current heading by one level.
658 Promote the current subtree by one level.
661 Demote the current subtree by one level.
664 Move subtree up (swap with previous subtree of same level).
667 Move subtree down (swap with next subtree of same level).
671 Kill subtree, i.e. remove it from buffer but save in kill ring.
674 Copy subtree to kill ring.
677 Yank subtree from kill ring. This does modify the level of the
678 subtree to make sure the tree fits in nicely at the yank position.
679 The yank level can also be specified with a prefix arg, or by
680 yanking after a headline marker like `****'.
683 Sort same-level entries. When there is an active region, all
684 entries in the region will be sorted. Otherwise the children of
685 the current headline are sorted. The command prompts for the
686 sorting method, which can be alphabetically, numerically, by time
687 (using the first time stamp in each entry), and each of these in
688 reverse order. With a `C-u' prefix, sorting will be
689 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
690 will also be removed.
692 When there is an active region (transient-mark-mode), promotion and
693 demotion work on all headlines in the region. To select a region of
694 headlines, it is best to place both point and mark at the beginning of a
695 line, mark at the beginning of the first headline, and point at the line
696 just after the last headline to change. Note that when the cursor is
697 inside a table (*note Tables::), the Meta-Cursor keys have different
701 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
706 When a project represented by a (sub)tree is finished, you may want to
707 move the tree out of the way and to stop it from contributing to the
708 agenda. Org-mode knows two ways of archiving. You can mark a tree with
709 the ARCHIVE tag, or you can move an entire (sub)tree to a different
714 * ARCHIVE tag:: Marking a tree as inactive
715 * Moving subtrees:: Moving a tree to an archive file
718 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
720 2.6.1 The ARCHIVE tag
721 ---------------------
723 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
724 its location in the outline tree, but behaves in the following way:
725 - It does not open when you attempt to do so with a visibility
726 cycling command (*note Visibility cycling::). You can force
727 cycling archived subtrees with `C-<TAB>', or by setting the option
728 `org-cycle-open-archived-trees'. Also normal outline commands like
729 `show-all' will open archived subtrees.
731 - During sparse tree construction (*note Sparse trees::), matches in
732 archived subtrees are not exposed, unless you configure the option
733 `org-sparse-tree-open-archived-trees'.
735 - During agenda view construction (*note Agenda views::), the
736 content of archived trees is ignored unless you configure the
737 option `org-agenda-skip-archived-trees'.
739 - Archived trees are not exported (*note Exporting::), only the
740 headline is. Configure the details using the variable
741 `org-export-with-archived-trees'.
743 The following commands help managing the ARCHIVE tag:
746 Toggle the ARCHIVE tag for the current headline. When the tag is
747 set, the headline changes to a shadowish face, and the subtree
751 Check if any direct children of the current headline should be
752 archived. To do this, each subtree is checked for open TODO
753 entries. If none are found, the command offers to set the ARCHIVE
754 tag for the child. If the cursor is _not_ on a headline when this
755 command is invoked, the level 1 trees will be checked.
758 Cycle a tree even if it is tagged with ARCHIVE.
761 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
763 2.6.2 Moving subtrees
764 ---------------------
766 Once an entire project is finished, you may want to move it to a
767 different location, either in the current file, or even in a different
768 file, the archive file.
771 Archive the subtree starting at the cursor position to the location
772 given by `org-archive-location'.
775 Check if any direct children of the current headline could be
776 moved to the archive. To do this, each subtree is checked for
777 open TODO entries. If none are found, the command offers to move
778 it to the archive location. If the cursor is _not_ on a headline
779 when this command is invoked, the level 1 trees will be checked.
781 The default archive location is a file in the same directory as the
782 current file, with the name derived by appending `_archive' to the
783 current file name. For information and examples on how to change this,
784 see the documentation string of the variable `org-archive-location'.
785 There is also an in-buffer option for setting this variable, for example
789 You may have several such lines in the buffer, they will then be valid
790 for the entries following the line (the first will also apply to any
794 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
799 An important feature of Org-mode is the ability to construct _sparse
800 trees_ for selected information in an outline tree. A sparse tree
801 means that the entire document is folded as much as possible, but the
802 selected information is made visible along with the headline structure
803 above it(1). Just try it out and you will see immediately how it works.
805 Org-mode contains several commands creating such trees. The most
806 basic one is `org-occur':
809 Occur. Prompts for a regexp and shows a sparse tree with all
810 matches. If the match is in a headline, the headline is made
811 visible. If the match is in the body of an entry, headline and
812 body are made visible. In order to provide minimal context, also
813 the full hierarchy of headlines above the match is shown, as well
814 as the headline following the match. Each match is also
815 highlighted; the highlights disappear when the buffer is changes
816 an editing command, or by pressing `C-c C-c'. When called with a
817 `C-u' prefix argument, previous highlights are kept, so several
818 calls to this command can be stacked.
819 For frequently used sparse trees of specific search strings, you can
820 use the variable `org-agenda-custom-commands' to define fast keyboard
821 access to specific sparse trees. These commands will then be
822 accessible through the agenda dispatcher (*note Agenda dispatcher::).
825 (setq org-agenda-custom-commands
826 '(("f" occur-tree "FIXME")))
828 will define the key `C-c a f' as a shortcut for creating a sparse tree
829 matching the string `FIXME'.
831 Other commands use sparse trees as well. For example `C-c C-v'
832 creates a sparse TODO tree (*note TODO basics::).
834 To print a sparse tree, you can use the Emacs command
835 `ps-print-buffer-with-faces' which does not print invisible parts of
836 the document (2). Or you can use the command `C-c C-e v' to export
837 only the visible part of the document and print the resulting file.
839 ---------- Footnotes ----------
841 (1) See also the variables `org-show-hierarchy-above',
842 `org-show-following-heading', and `org-show-siblings' for detailed
843 control on how much context is shown around each match.
845 (2) This does not work under XEmacs, because XEmacs uses selective
846 display for outlining, not text properties.
849 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
854 Within an entry of the outline tree, hand-formatted lists can provide
855 additional structure. They also provide a way to create lists of
856 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
857 and the HTML exporter (*note Exporting::) does parse and format them.
859 Org-mode knows ordered and unordered lists. Unordered list items
860 start with `-', `+', or `*'(1) as bullets. Ordered list items start
861 with `1.' or `1)'. Items belonging to the same list must have the same
862 indentation on the first line. In particular, if an ordered list
863 reaches number `10.', then the 2-digit numbers must be written
864 left-aligned with the other numbers in the list. Indentation also
865 determines the end of a list item. It ends before the next line that
866 is indented like the bullet/number, or less. Empty lines are part of
867 the previous item, so you can have several paragraphs in one item. If
868 you would like an emtpy line to terminate all currently open plain
869 lists, configure the variable `org-empty-line-terminates-plain-lists'.
870 Here is an for example:
873 My favorite scenes are (in this order)
874 1. The attack of the Rohirrim
875 2. Eowyns fight with the witch king
876 + this was already my favorite scene in the book
877 + I really like Miranda Otto.
878 3. Peter Jackson being shot by Legolas
880 He makes a really funny face when it happens.
881 But in the end, not individual scenes matter but the film as a whole.
883 Org-mode supports these lists by tuning filling and wrapping
884 commands to deal with them correctly(2).
886 The following commands act on items when the cursor is in the first
887 line of an item (the line with the bullet or number).
890 Items can be folded just like headline levels if you set the
891 variable `org-cycle-include-plain-lists'. The level of an item is
892 then given by the indentation of the bullet/number. Items are
893 always subordinate to real headlines, however; the hierarchies
894 remain completely separated.
897 Insert new item at current level. With prefix arg, force a new
898 heading (*note Structure editing::). If this command is used in
899 the middle of a line, the line is _split_ and the rest of the line
900 becomes the new item. If this command is executed in the
901 _whitespace before a bullet or number_, the new item is created
902 _before_ the current item. If the command is executed in the
903 white space before the text that is part of an item but does not
904 contain the bullet, a bullet is added to the current line.
907 Insert a new item with a checkbox (*note Checkboxes::).
911 Jump to the previous/next item in the current list.
915 Move the item including subitems up/down (swap with previous/next
916 item of same indentation). If the list is ordered, renumbering is
921 Decrease/increase the indentation of the item, including subitems.
922 Initially, the item tree is selected based on current indentation.
923 When these commands are executed several times in direct
924 succession, the initially selected region is used, even if the new
925 indentation would imply a different hierarchy. To use the new
926 hierarchy, break the command chain with a cursor motion or so.
929 If there is a checkbox (*note Checkboxes::) in the item line,
930 toggle the state of the checkbox. Otherwise, if this is an
931 ordered list, renumber the ordered list at the cursor.
933 ---------- Footnotes ----------
935 (1) When using `*' as a bullet, lines must be indented or they will
936 be seen as top-level headlines. Also, when you are hiding leading
937 stars to get a clean outline view, plain list items starting with a
938 star are visually indistinguishable from true headlines. In short:
939 even though `*' is supported, it may be better not to use it for plain
942 (2) Org-mode only changes the filling settings for Emacs. For
943 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
948 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
953 Org-mode has a very fast and intuitive table editor built-in.
954 Spreadsheet-like calculations are supported in connection with the
955 Emacs `calc' package.
959 * Built-in table editor:: Simple tables
960 * Narrow columns:: Stop wasting space in tables
961 * orgtbl-mode:: The table editor as minor mode
962 * The spreadsheet:: The table editor has spreadsheet capabilities.
965 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
967 3.1 The built-in table editor
968 =============================
970 Org-mode makes it easy to format tables in plain ASCII. Any line with
971 `|' as the first non-white character is considered part of a table.
972 `|' is also the column separator. A table might look like this:
974 | Name | Phone | Age |
975 |-------+-------+-----|
976 | Peter | 1234 | 17 |
979 A table is re-aligned automatically each time you press <TAB> or
980 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
981 field (<RET> to the next row) and creates new table rows at the end of
982 the table or before horizontal lines. The indentation of the table is
983 set by the first line. Any line starting with `|-' is considered as a
984 horizontal separator line and will be expanded on the next re-align to
985 span the whole table width. So, to create the above table, you would
991 and then press <TAB> to align the table and start filling in fields.
993 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
994 and all character keys in a special way, so that inserting and deleting
995 avoids shifting other fields. Also, when typing _immediately after the
996 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
997 the field is automatically made blank. If this behavior is too
998 unpredictable for you, configure the variables
999 `org-enable-table-editor' and `org-table-auto-blank-field'.
1001 Creation and conversion
1002 .......................
1005 Convert the active region to table. If every line contains at
1006 least one TAB character, the function assumes that the material is
1007 tab separated. If not, lines are split at whitespace into fields.
1008 You can use a prefix argument to indicate the minimum number of
1009 consecutive spaces required to identify a field separator
1010 (default: just one).
1011 If there is no active region, this command creates an empty
1012 Org-mode table. But it's easier just to start typing, like
1013 `|Name|Phone|Age <RET> |- <TAB>'.
1015 Re-aligning and field motion
1016 ............................
1019 Re-align the table without moving the cursor.
1022 Re-align the table, move to the next field. Creates a new row if
1026 Re-align, move to previous field.
1029 Re-align the table and move down to next row. Creates a new row if
1030 necessary. At the beginning or end of a line, <RET> still does
1031 NEWLINE, so it can be used to split a table.
1033 Column and row editing
1034 ......................
1038 Move the current column left/right.
1041 Kill the current column.
1044 Insert a new column to the left of the cursor position.
1048 Move the current row up/down.
1051 Kill the current row or horizontal line.
1054 Insert a new row above (with arg: below) the current row.
1057 Insert a horizontal line below current row. With prefix arg, the
1058 line is created above the current line.
1061 Sort the table lines in the region. The position of point
1062 indicates the column to be used for sorting, and the range of
1063 lines is the range between the nearest horizontal separator lines,
1064 or the entire table. If point is before the first column, you
1065 will be prompted for the sorting column. If there is an active
1066 region, the mark specifies the first line and the sorting column,
1067 while point should be in the last line to be included into the
1068 sorting. The command prompts for the sorting type
1069 (alphabetically, numerically, or by time). When called with a
1070 prefix argument, alphabetic sorting will be case-sensitive.
1076 Copy a rectangular region from a table to a special clipboard.
1077 Point and mark determine edge fields of the rectangle. The
1078 process ignores horizontal separator lines.
1081 Copy a rectangular region from a table to a special clipboard, and
1082 blank all fields in the rectangle. So this is the "cut" operation.
1085 Paste a rectangular region into a table. The upper right corner
1086 ends up in the current field. All involved fields will be
1087 overwritten. If the rectangle does not fit into the present table,
1088 the table is enlarged as needed. The process ignores horizontal
1092 Wrap several fields in a column like a paragraph. If there is an
1093 active region, and both point and mark are in the same column, the
1094 text in the column is wrapped to minimum width for the given
1095 number of lines. A prefix ARG may be used to change the number of
1096 desired lines. If there is no region, the current field is split
1097 at the cursor position and the text fragment to the right of the
1098 cursor is prepended to the field one line down. If there is no
1099 region, but you specify a prefix ARG, the current field is made
1100 blank, and the content is appended to the field above.
1106 Sum the numbers in the current column, or in the rectangle defined
1107 by the active region. The result is shown in the echo area and can
1108 be inserted with `C-y'.
1111 When current field is empty, copy from first non-empty field above.
1112 When not empty, copy current field down to next row and move cursor
1113 along with it. Depending on the variable
1114 `org-table-copy-increment', integer field values will be
1115 incremented during copy. This key is also used by CUA-mode (*note
1122 Edit the current field in a separate window. This is useful for
1123 fields that are not fully visible (*note Narrow columns::). When
1124 called with a `C-u' prefix, just make the full field visible, so
1125 that it can be edited in place.
1128 This is an alias for `C-u C-c `' to make the current field fully
1131 `M-x org-table-import'
1132 Import a file as a table. The table should be TAB- or whitespace
1133 separated. Useful, for example, to import an Excel table or data
1134 from a database, because these programs generally can write
1135 TAB-separated text files. This command works by inserting the
1136 file into the buffer and then converting the region to a table.
1137 Any prefix argument is passed on to the converter, which uses it
1138 to determine the separator.
1140 `M-x org-table-export'
1141 Export the table as a TAB-separated file. Useful for data
1142 exchange with, for example, Excel or database programs.
1144 If you don't like the automatic table editor because it gets in your
1145 way on lines which you would like to start with `|', you can turn it
1148 (setq org-enable-table-editor nil)
1150 Then the only table command that still works is `C-c C-c' to do a
1154 File: org, Node: Narrow columns, Next: orgtbl-mode, Prev: Built-in table editor, Up: Tables
1159 The width of columns is automatically determined by the table editor.
1160 Sometimes a single field or a few fields need to carry more text,
1161 leading to inconveniently wide columns. To limit(1) the width of a
1162 column, one field anywhere in the column may contain just the string
1163 `<N>' where `N' is an integer specifying the width of the column in
1164 characters. The next re-align will then set the width of this column
1165 to no more than this value.
1167 |---+------------------------------| |---+--------|
1169 | 1 | one | | 1 | one |
1170 | 2 | two | ----\ | 2 | two |
1171 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1172 | 4 | four | | 4 | four |
1173 |---+------------------------------| |---+--------|
1175 Fields that are wider become clipped and end in the string `=>'. Note
1176 that the full text is still in the buffer, it is only invisible. To
1177 see the full text, hold the mouse over the field - a tool-tip window
1178 will show the full content. To edit such a field, use the command `C-c
1179 `' (that is `C-c' followed by the backquote). This will open a new
1180 window with the full field. Edit it and finish with `C-c C-c'.
1182 When visiting a file containing a table with narrowed columns, the
1183 necessary character hiding has not yet happened, and the table needs to
1184 be aligned before it looks nice. Setting the option
1185 `org-startup-align-all-tables' will realign all tables in a file upon
1186 visiting, but also slow down startup. You can also set this option on
1187 a per-file basis with:
1192 ---------- Footnotes ----------
1194 (1) This feature does not work on XEmacs.
1197 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Narrow columns, Up: Tables
1199 3.3 The Orgtbl minor mode
1200 =========================
1202 If you like the intuitive way the Org-mode table editor works, you
1203 might also want to use it in other modes like text-mode or mail-mode.
1204 The minor mode Orgtbl-mode makes this possible. You can always toggle
1205 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1208 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1210 Furthermore, with some special setup, it is possible to maintain
1211 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1212 possible to construct LaTeX tables with the underlying ease and power of
1213 Orgtbl-mode, including spreadsheet capabilities. For details, see
1214 *Note Tables in arbitrary syntax::.
1217 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1222 The table editor makes use of the Emacs `calc' package to implement
1223 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1224 derive fields from other fields. While fully featured, Org-mode's
1225 implementation is not identical to other spreadsheets. For example,
1226 Org-mode knows the concept of a _column formula_ that will be applied
1227 to all non-header fields in a column without having to copy the formula
1228 to each relevant field.
1232 * References:: How to refer to another field or range
1233 * Formula syntax for Calc:: Using Calc to compute stuff
1234 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1235 * Field formulas:: Formulas valid for a single field
1236 * Column formulas:: Formulas valid for an entire column
1237 * Editing and debugging formulas:: Fixing formulas
1238 * Updating the table:: Recomputing all dependent fields
1239 * Advanced features:: Field names, parameters and automatic recalc
1242 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1247 To compute fields in the table from other fields, formulas must
1248 reference other fields or ranges. In Org-mode, fields can be referenced
1249 by name, by absolute coordinates, and by relative coordinates. To find
1250 out what the coordinates of a field are, press `C-c ?' in that field,
1251 or press `C-c }' to toggle the display of a grid.
1256 Formulas can reference the value of another field in two ways. Like in
1257 any other spreadsheet, you may reference fields with a letter/number
1258 combination like `B3', meaning the 2nd field in the 3rd row.
1260 Org-mode also uses another, more general operator that looks like this:
1263 Column references can be absolute like `1', `2',...`N', or relative to
1264 the current column like `+1' or `-2'.
1266 The row specification only counts data lines and ignores horizontal
1267 separator lines (hlines). You can use absolute row numbers `1'...`N',
1268 and row numbers relative to the current row like `+3' or `-1'. Or
1269 specify the row relative to one of the hlines: `I' refers to the first
1270 hline, `II' to the second etc. `-I' refers to the first such line
1271 above the current line, `+I' to the first such line below the current
1272 line. You can also write `III+2' which is the second data line after
1273 the third hline in the table. Relative row numbers like `-3' will not
1274 cross hlines if the current line is too close to the hline. Instead,
1275 the value directly at the hline is used.
1277 `0' refers to the current row and column. Also, if you omit either
1278 the column or the row part of the reference, the current row/column is
1281 Org-mode's references with _unsigned_ numbers are fixed references
1282 in the sense that if you use the same reference in the formula for two
1283 different fields, the same field will be referenced each time.
1284 Org-mode's references with _signed_ numbers are floating references
1285 because the same reference operator can reference different fields
1286 depending on the field being calculated by the formula.
1288 Here are a few examples:
1290 @2$3 2nd row, 3rd column
1292 $5 column 5 in the current row
1294 @2 current column, row 2
1295 @-1$-3 the field one row up, three columns to the left
1296 @-I$2 field just under hline above current row, column 2
1301 You may reference a rectangular range of fields by specifying two field
1302 references connected by two dots `..'. If both fields are in the
1303 current row, you may simply use `$2..$7', but if at least one field is
1304 in a different row, you need to use the general `@row$column' format at
1305 least for the first field (i.e the reference must start with `@' in
1306 order to be interpreted correctly). Examples:
1308 $1..$3 First three fields in the current row.
1309 $P..$Q Range, using column names (see under Advanced)
1310 @2$1..@4$3 6 fields between these two fields.
1311 A2..C4 Same as above.
1312 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1314 Range references return a vector of values that can be fed into Calc
1315 vector functions. Empty fields in ranges are normally suppressed, so
1316 that the vector contains only the non-empty fields (but see the `E'
1317 mode switch below). If there are no non-empty fields, `[0]' is
1318 returned to avoid syntax errors in formulas.
1323 `$name' is interpreted as the name of a column, parameter or constant.
1324 Constants are defined globally through the variable
1325 `org-table-formula-constants'. If you have the `constants.el' package,
1326 it will also be used to resolve constants, including natural constants
1327 like `$h' for Planck's constant, and units like `$km' for
1328 kilometers(1). Column names and parameters can be specified in special
1329 table lines. These are described below, see *Note Advanced features::.
1330 All names must start with a letter, and further consist of letters and
1333 ---------- Footnotes ----------
1335 (1) `Constant.el' can supply the values of constants in two
1336 different unit systems, `SI' and `cgs'. Which one is used depends on
1337 the value of the variable `constants-unit-system'. You can use the
1338 `#+STARTUP' options `constSI' and `constcgs' to set this value for the
1342 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1344 3.4.2 Formula syntax for Calc
1345 -----------------------------
1347 A formula can be any algebraic expression understood by the Emacs
1348 `Calc' package. Note that `calc' has the slightly non-standard
1349 convention that `/' has lower precedence than `*', so that `a/b*c' is
1350 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1351 calc-eval: (calc)Calling Calc from Your Programs.), variable
1352 substitution takes place according to the rules described above. The
1353 range vectors can be directly fed into the calc vector functions like
1356 A formula can contain an optional mode string after a semicolon.
1357 This string consists of flags to influence Calc and other modes during
1358 execution. By default, Org-mode uses the standard calc modes (precision
1359 12, angular units degrees, fraction and symbolic modes off. The display
1360 format, however, has been changed to `(float 5)' to keep tables
1361 compact. The default settings can be configured using the variable
1362 `org-calc-default-modes'.
1364 p20 switch the internal precision to 20 digits
1365 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1366 D R angle modes: degrees, radians
1367 F S fraction and symbolic modes
1368 N interpret all fields as numbers, use 0 for non-numbers
1369 T force text interpretation
1370 E keep empty fields in ranges
1372 In addition, you may provide a `printf' format specifier to reformat
1373 the final result. A few examples:
1375 $1+$2 Sum of first and second field
1376 $1+$2;%.2f Same, format result to two decimals
1377 exp($2)+exp($1) Math functions can be used
1378 $0;%.1f Reformat current cell to 1 decimal
1379 ($3-32)*5/9 Degrees F -> C conversion
1380 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1381 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1382 sin($1);Dp3%.1e Same, but use printf specifier for display
1383 vmean($2..$7) Compute column range mean, using vector function
1384 vmean($2..$7);EN Same, but treat empty fields as 0
1385 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1387 Calc also contains a complete set of logical operations. For example
1389 if($1<20,teen,string("")) "teen" if age $1 less than 20, else empty
1392 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1394 3.4.3 Emacs Lisp forms as formulas
1395 ----------------------------------
1397 It is also possible to write a formula in Emacs Lisp; this can be useful
1398 for string manipulation and control structures, if the Calc's
1399 functionality is not enough. If a formula starts with a single quote
1400 followed by an opening parenthesis, then it is evaluated as a lisp form.
1401 The evaluation should return either a string or a number. Just as with
1402 `calc' formulas, you can specify modes and a printf format after a
1403 semicolon. A reference will be replaced with a string (in double
1404 quotes) containing the field. If you provide the `N' mode switch, all
1405 referenced elements will be numbers. Ranges are inserted as
1406 space-separated fields, so you can embed them in list or vector syntax.
1407 A few examples, note how the `N' mode is used when we do computations
1410 Swap the first two characters of the content of column 1
1411 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1412 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1414 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1415 '(apply '+ '($1..$4));N
1418 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1420 3.4.4 Field formulas
1421 --------------------
1423 To assign a formula to a particular field, type it directly into the
1424 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1425 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1426 will be stored as the formula for this field, evaluated, and the
1427 current field replaced with the result.
1429 Formulas are stored in a special line starting with `#+TBLFM:'
1430 directly below the table. If you typed the equation in the 4th field of
1431 the 3rd data line in the table, the formula will look like
1432 `@3$4=$1+$2'. When inserting/deleting/swapping column and rows with
1433 the appropriate commands, absolute references (but not relative ones)
1434 in stored formulas are modified in order to still reference the same
1435 field. Of cause this is not true if you edit the table structure with
1436 normal editing commands - then you must fix the equations yourself.
1438 Instead of typing an equation into the field, you may also use the
1442 Install a new formula for the current field. The command prompts
1443 for a formula, with default taken from the `#+TBLFM:' line, applies
1444 it to the current field and stores it.
1447 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1449 3.4.5 Column formulas
1450 ---------------------
1452 Often in a table, the same formula should be used for all fields in a
1453 particular column. Instead of having to copy the formula to all fields
1454 in that column, org-mode allows to assign a single formula to an entire
1455 column. If the table contains horizontal separator hlines, everything
1456 before the first such line is considered part of the table _header_ and
1457 will not be modified by column formulas.
1459 To assign a formula to a column, type it directly into any field in
1460 the column, preceded by an equal sign, like `=$1+$2'. When you press
1461 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1462 formula will be stored as the formula for the current column, evaluated
1463 and the current field replaced with the result. If the field contains
1464 only `=', the previously stored formula for this column is used. For
1465 each column, Org-mode will only remember the most recently used
1466 formula. In the `TBLFM:' line, column formulas will look like
1469 Instead of typing an equation into the field, you may also use the
1473 Install a new formula for the current column and replace current
1474 field with the result of the formula. The command prompts for a
1475 formula, with default taken from the `#+TBLFM' line, applies it to
1476 the current field and stores it. With a numerical prefix (e.g.
1477 `C-5 C-c =') will apply it to that many consecutive fields in the
1481 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1483 3.4.6 Editing and Debugging formulas
1484 ------------------------------------
1486 You can edit individual formulas in the minibuffer or directly in the
1487 field. Org-mode can also prepare a special buffer with all active
1488 formulas of a table. When offering a formula for editing, Org-mode
1489 converts references to the standard format (like `B3' or `D&') if
1490 possible. If you prefer to only work with the internal format (like
1491 `@3$2' or `$4'), configure the variable
1492 `org-table-use-standard-references'.
1496 Edit the formula associated with the current column/field in the
1497 minibuffer. See *Note Column formulas:: and *Note Field
1501 Re-insert the active formula (either a field formula, or a column
1502 formula) into the current field, so that you can edit it directly
1503 in the field. The advantage over editing in the minibuffer is
1504 that you can use the command `C-c ?'.
1507 While editing a formula in a table field, highlight the field(s)
1508 referenced by the reference at the cursor position in the formula.
1511 Toggle the display of row and column numbers for a table, using
1512 overlays. These are updated each time the table is aligned, you
1513 can force it with `C-c C-c'.
1516 Toggle the formula debugger on and off. See below.
1519 Edit all formulas for the current table in a special buffer, where
1520 the formulas will be displayed one per line. If the current field
1521 has an active formula, the cursor in the formula editor will mark
1522 it. While inside the special buffer, Org-mode will automatically
1523 highlight any field or range reference at the cursor position.
1524 You may edit, remove and add formulas, and use the following
1528 Exit the formula editor and store the modified formulas.
1529 With `C-u' prefix, also apply the new formulas to the entire
1533 Exit the formula editor without installing changes.
1536 Toggle all references in the formula editor between standard
1537 (like `B3') and internal (like `@3$2').
1540 Pretty-print or indent lisp formula at point. When in a line
1541 containing a lisp formula, format the formula according to
1542 Emacs Lisp rules. Another <TAB> collapses the formula back
1543 again. In the open formula, <TAB> re-indents just like in
1547 Complete Lisp symbols, just like in Emacs-lisp-mode.
1549 `S-<up>/<down>/<left>/<right>'
1550 Shift the reference at point. For example, if the reference
1551 is `B3' and you press `S-<right>', it will become `C3'. This
1552 also works for relative references, and for hline references.
1555 Move the test line for column formulas in the Org-mode buffer
1559 Scroll the window displaying the table.
1562 Turn the coordinate grid in the table on and off.
1564 Making a table field blank does not remove the formula associated
1565 with the field, because that is stored in a different line (the `TBLFM'
1566 line) - during the next recalculation the field will be filled again.
1567 To remove a formula from a field, you have to give an empty reply when
1568 prompted for the formula, or to edit the `#+TBLFM' line.
1570 You may edit the `#+TBLFM' directly and re-apply the changed
1571 equations with `C-c C-c' in that line, or with the normal recalculation
1572 commands in the table.
1577 When the evaluation of a formula leads to an error, the field content
1578 becomes the string `#ERROR'. If you would like see what is going on
1579 during variable substitution and calculation in order to find a bug,
1580 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1581 for example by pressing `C-u C-u C-c = <RET>' in a field. Detailed
1582 information will be displayed.
1585 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1587 3.4.7 Updating the Table
1588 ------------------------
1590 Recalculation of a table is normally not automatic, but needs to be
1591 triggered by a command. See *Note Advanced features:: for a way to make
1592 recalculation at least semi-automatically.
1594 In order to recalculate a line of a table or the entire table, use
1595 the following commands:
1598 Recalculate the current row by first applying the stored column
1599 formulas from left to right, and all field formulas in the current
1604 Recompute the entire table, line by line. Any lines before the
1605 first hline are left alone, assuming that these are part of the
1609 Iterate the table by recomputing it until no further changes occur.
1610 This may be necessary if some computed fields use the value of
1611 other fields that are computed later in the calculation sequence.
1614 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1616 3.4.8 Advanced features
1617 -----------------------
1619 If you want the recalculation of fields to happen automatically, or if
1620 you want to be able to assign names to fields and columns, you need to
1621 reserve the first column of the table for special marking characters.
1623 Rotate the calculation mark in first column through the states `',
1624 `#', `*', `!', `$'. The meaning of these characters is discussed
1625 below. When there is an active region, change all marks in the
1628 Here is an example of a table that collects exam results of students
1629 and makes use of these features:
1631 |---+---------+--------+--------+--------+-------+------|
1632 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1633 |---+---------+--------+--------+--------+-------+------|
1634 | ! | | P1 | P2 | P3 | Tot | |
1635 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1636 | ^ | | m1 | m2 | m3 | mt | |
1637 |---+---------+--------+--------+--------+-------+------|
1638 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1639 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1640 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1641 |---+---------+--------+--------+--------+-------+------|
1642 | | Average | | | | 29.7 | |
1643 | ^ | | | | | at | |
1644 | $ | max=50 | | | | | |
1645 |---+---------+--------+--------+--------+-------+------|
1646 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1648 Important: Please note that for these special tables, recalculating the
1649 table with `C-u C-c *' will only affect rows that are marked `#' or
1650 `*', and fields that have a formula assigned to the field itself. The
1651 column formulas are not applied in rows with empty first field.
1653 The marking characters have the following meaning:
1655 The fields in this line define names for the columns, so that you
1656 may refer to a column as `$Tot' instead of `$6'.
1659 This row defines names for the fields _above_ the row. With such
1660 a definition, any formula in the table may use `$m1' to refer to
1661 the value `10'. Also, if you assign a formula to a names field, it
1662 will be stored as `$name=...'.
1665 Similar to `^', but defines names for the fields in the row
1669 Fields in this row can define _parameters_ for formulas. For
1670 example, if a field in a `$' row contains `max=50', then formulas
1671 in this table can refer to the value 50 using `$max'. Parameters
1672 work exactly like constants, only that they can be defined on a
1676 Fields in this row are automatically recalculated when pressing
1677 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1678 selected for a global recalculation with `C-u C-c *'. Unmarked
1679 lines will be left alone by this command.
1682 Selects this line for global recalculation with `C-u C-c *', but
1683 not for automatic recalculation. Use this when automatic
1684 recalculation slows down editing too much.
1687 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1688 All lines that should be recalculated should be marked with `#' or
1692 Do not export this line. Useful for lines that contain the
1693 narrowing `<N>' markers.
1695 Finally, just to whet your appetite on what can be done with the
1696 fantastic `calc' package, here is a table that computes the Taylor
1697 series of degree `n' at location `x' for a couple of functions
1698 (homework: try that with Excel :-)
1700 |---+-------------+---+-----+--------------------------------------|
1701 | | Func | n | x | Result |
1702 |---+-------------+---+-----+--------------------------------------|
1703 | # | exp(x) | 1 | x | 1 + x |
1704 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1705 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1706 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1707 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1708 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1709 |---+-------------+---+-----+--------------------------------------|
1710 #+TBLFM: $5=taylor($2,$4,$3);n3
1713 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1718 Just like HTML, Org-mode provides links inside a file, and external
1719 links to other files, Usenet articles, emails, and much more.
1723 * Link format:: How links in Org-mode are formatted
1724 * Internal links:: Links to other places in the current file
1725 * External links:: URL-like links to the world
1726 * Handling links:: Creating, inserting and following
1727 * Link abbreviations:: Shortcuts for writing complex links
1728 * Search options:: Linking to a specific location
1729 * Custom searches:: When the default search is not enough
1730 * Remember:: Org-trees store quick notes
1733 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1738 Org-mode will recognize plain URL-like links and activate them as
1739 clickable links. The general link format, however, looks like this:
1741 [[link][description]] or alternatively [[link]]
1743 Once a link in the buffer is complete (all brackets present),
1744 Org-mode will change the display so that `description' is displayed
1745 instead of `[[link][description]]' and `link' is displayed instead of
1746 `[[link]]'. Links will be highlighted in the face `org-link', which by
1747 default is an underlined face. You can directly edit the visible part
1748 of a link. Note that this can be either the `link' part (if there is
1749 no description) or the `description' part. To edit also the invisible
1750 `link' part, use `C-c C-l' with the cursor on the link.
1752 If you place the cursor at the beginning or just behind the end of
1753 the displayed text and press <BACKSPACE>, you will remove the
1754 (invisible) bracket at that location. This makes the link incomplete
1755 and the internals are again displayed as plain text. Inserting the
1756 missing bracket hides the link internals again. To show the internal
1757 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1761 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1766 If the link does not look like a URL, it is considered to be internal in
1767 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1768 my target]]' lead to a text search in the current file. The link can
1769 be followed with `C-c C-o' when the cursor is on the link, or with a
1770 mouse click (*note Handling links::). The preferred match for such a
1771 link is a dedicated target: the same string in double angular brackets.
1772 Targets may be located anywhere; sometimes it is convenient to put
1773 them into a comment line. For example
1777 In HTML export (*note HTML export::), such targets will become named
1778 anchors for direct access through `http' links(1).
1780 If no dedicated target exists, Org-mode will search for the words in
1781 the link. In the above example the search would be for `my target'.
1782 Links starting with a star like `*My Target' restrict the search to
1783 headlines. When searching, Org-mode will first try an exact match, but
1784 then move on to more and more lenient searches. For example, the link
1785 `[[*My Targets]]' will find any of the following:
1788 ** TODO my targets are bright
1789 ** my 20 targets are
1791 To insert a link targeting a headline, in-buffer completion can be
1792 used. Just type a star followed by a few optional letters into the
1793 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1794 offered as completions. *Note Handling links::, for more commands
1797 Following a link pushes a mark onto Org-mode's own mark ring. You
1798 can return to the previous position with `C-c &'. Using this command
1799 several times in direct succession goes back to positions recorded
1804 * Radio targets:: Make targets trigger links in plain text.
1806 ---------- Footnotes ----------
1808 (1) Note that text before the first headline will never be exported,
1809 so the first such target must be after the first headline.
1812 File: org, Node: Radio targets, Prev: Internal links, Up: Internal links
1817 You can configure Org-mode to link any occurrences of certain target
1818 names in normal text. So without explicitly creating a link, the text
1819 connects to the target radioing its position. Radio targets are
1820 enclosed by triple angular brackets. For example, a target `<<<My
1821 Target>>>' causes each occurrence of `my target' in normal text to
1822 become activated as a link. The Org-mode file is scanned automatically
1823 for radio targets only when the file is first loaded into Emacs. To
1824 update the target list during editing, press `C-c C-c' with the cursor
1828 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1833 Org-mode supports links to files, websites, Usenet and email messages,
1834 and BBDB database entries. External links are URL-like locators. They
1835 start with a short identifying string followed by a colon. There can be
1836 no space after the colon. The following list shows examples for each
1839 http://www.astro.uva.nl/~dominik on the web
1840 file:/home/dominik/images/jupiter.jpg file, absolute path
1841 file:papers/last.pdf file, relative path
1842 news:comp.emacs Usenet link
1843 mailto:adent@galaxy.net Mail link
1844 vm:folder VM folder link
1845 vm:folder#id VM message link
1846 vm://myself@some.where.org/folder#id VM on remote machine
1847 wl:folder WANDERLUST folder link
1848 wl:folder#id WANDERLUST message link
1849 mhe:folder MH-E folder link
1850 mhe:folder#id MH-E message link
1851 rmail:folder RMAIL folder link
1852 rmail:folder#id RMAIL message link
1853 gnus:group GNUS group link
1854 gnus:group#id GNUS article link
1855 bbdb:Richard Stallman BBDB link
1856 shell:ls *.org A shell command
1857 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1859 A link should be enclosed in double brackets and may contain a
1860 descriptive text to be displayed instead of the url (*note Link
1861 format::), for example:
1863 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1865 If the description is a file name or URL that points to an image, HTML
1866 export (*note HTML export::) will inline the image as a clickable
1867 button. If there is no description at all and the link points to an
1868 image, that image will be inlined into the exported HTML file.
1870 Org-mode also finds external links in the normal text and activates
1871 them as links. If spaces must be part of the link (for example in
1872 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1873 the end of the link, enclose them in angular brackets.
1876 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1881 Org-mode provides methods to create a link in the correct syntax, to
1882 insert it into an org-mode file, and to follow the link.
1885 Store a link to the current location. This is a _global_ command
1886 which can be used in any buffer to create a link. The link will be
1887 stored for later insertion into an Org-mode buffer (see below).
1888 For Org-mode files, if there is a `<<target>>' at the cursor, the
1889 link points to the target. Otherwise it points to the current
1890 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1891 the link will indicate the current article/entry. For W3 and W3M
1892 buffers, the link goes to the current URL. For any other files,
1893 the link will point to the file, with a search string (*note
1894 Search options::) pointing to the contents of the current line.
1895 If there is an active region, the selected words will form the
1896 basis of the search string. If the automatically created link is
1897 not working correctly or accurately enough, you can write custom
1898 functions to select the search string and to do the search for
1899 particular file types - see *Note Custom searches::. The key
1900 binding `C-c l' is only a suggestion - see *Note Installation::.
1903 Insert a link. This prompts for a link to be inserted into the
1904 buffer. You can just type a link, using text for an internal
1905 link, or one of the link type prefixes mentioned in the examples
1906 above. All links stored during the current session are part of
1907 the history for this prompt, so you can access them with <up> and
1908 <down>, or with completion(1). The link will be inserted into the
1909 buffer, along with a descriptive text. If some text was selected
1910 when this command is called, the selected text becomes the default
1912 Note that you don't have to use this command to insert a link.
1913 Links in Org-mode are plain text, and you can type or paste them
1914 straight into the buffer. By using this command, the links are
1915 automatically enclosed in double brackets, and you will be asked
1916 for the optional descriptive text.
1919 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1920 file will be inserted and you may use file name completion to
1921 select the name of the file. The path to the file is inserted
1922 relative to the directory of the current org file, if the linked
1923 file is in the current directory or in a subdirectory of it, or if
1924 the path is written relative to the current directory using `../'.
1925 Otherwise an absolute path is used, if possible with `~/' for
1926 your home directory. You can force an absolute path with two
1929 `C-c C-l (with cursor on existing link)'
1930 When the cursor is on an existing link, `C-c C-l' allows you to
1931 edit the link and description parts of the link.
1934 Open link at point. This will launch a web browser for URLs (using
1935 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1936 the corresponding links, and execute the command in a shell link.
1937 When the cursor is on an internal link, this commands runs the
1938 corresponding search. When the cursor is on a TAG list in a
1939 headline, it creates the corresponding TAGS view. If the cursor
1940 is on a time stamp, it compiles the agenda for that date.
1941 Furthermore, it will visit text and remote files in `file:' links
1942 with Emacs and select a suitable application for local non-text
1943 files. Classification of files is based on file extension only.
1944 See option `org-file-apps'. If you want to override the default
1945 application and visit the file with Emacs, use a `C-u' prefix.
1949 On links, `mouse-2' will open the link just as `C-c C-o' would.
1950 Under Emacs 22, also `mouse-1' will follow a link.
1953 Like `mouse-2', but force file links to be opened with Emacs, and
1954 internal links to be displayed in another window(2).
1957 Push the current position onto the mark ring, to be able to return
1958 easily. Commands following an internal link do this automatically.
1961 Jump back to a recorded position. A position is recorded by the
1962 commands following internal links, and by `C-c %'. Using this
1963 command several times in direct succession moves through a ring of
1964 previously recorded positions.
1968 Move forward/backward to the next link in the buffer. At the
1969 limit of the buffer, the search fails once, and then wraps around.
1970 The key bindings for this are really too long, you might want to
1971 bind this also to `C-n' and `C-p'
1972 (add-hook 'org-load-hook
1974 (define-key 'org-mode-map "\C-n" 'org-next-link)
1975 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
1977 ---------- Footnotes ----------
1979 (1) After insertion of a stored link, the link will be removed from
1980 the list of stored links. To keep it in the list later use, use a
1981 triple `C-u' prefix to `C-c C-l', or configure the option
1982 `org-keep-stored-link-after-insertion'.
1984 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1987 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1989 4.5 Link abbreviations
1990 ======================
1992 Long URLs can be cumbersome to type, and often many similar links are
1993 needed in a document. For this you can use link abbreviations. An
1994 abbreviated link looks like this
1996 [[linkword:tag][description]]
1998 where the tag is optional. Such abbreviations are resolved according to
1999 the information in the variable `org-link-abbrev-alist' that relates
2000 the linkwords to replacement text. Here is an example:
2002 (setq org-link-abbrev-alist
2003 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2004 ("google" . "http://www.google.com/search?q=")
2005 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2006 nph-abs_connect?author=%s&db_key=AST")))
2008 If the replacement text contains the string `%s', it will be
2009 replaced with the tag. Otherwise the tag will be appended to the string
2010 in order to create the link. You may also specify a function that will
2011 be called with the tag as the only argument to create the link.
2013 With the above setting, you could link to a specific bug with
2014 `[[bugzilla:129]]', search the web for `OrgMode' with
2015 `[[google:OrgMode]]' and find out what the Org-mode author is doing
2016 besides Emacs hacking with `[[ads:Dominik,C]]'.
2018 If you need special abbreviations just for a single Org-mode buffer,
2019 you can define them in the file with
2021 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
2022 #+LINK: google http://www.google.com/search?q=%s
2024 In-buffer completion *note Completion:: can be used after `[' to
2025 complete link abbreviations.
2028 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
2030 4.6 Search options in file links
2031 ================================
2033 File links can contain additional information to make Emacs jump to a
2034 particular location in the file when following a link. This can be a
2035 line number or a search option after a double(1) colon. For example,
2036 when the command `C-c l' creates a link (*note Handling links::) to a
2037 file, it encodes the words in the current line as a search string that
2038 can be used to find this line back later when following the link with
2041 Here is the syntax of the different ways to attach a search to a file
2042 link, together with an explanation:
2044 [[file:~/code/main.c::255]]
2045 [[file:~/xx.org::My Target]]
2046 [[file:~/xx.org::*My Target]]
2047 [[file:~/xx.org::/regexp/]]
2053 Search for a link target `<<My Target>>', or do a text search for
2054 `my target', similar to the search in internal links, see *Note
2055 Internal links::. In HTML export (*note HTML export::), such a
2056 file link will become an HTML reference to the corresponding named
2057 anchor in the linked file.
2060 In an Org-mode file, restrict search to headlines.
2063 Do a regular expression search for `regexp'. This uses the Emacs
2064 command `occur' to list all matches in a separate window. If the
2065 target file is in Org-mode, `org-occur' is used to create a sparse
2066 tree with the matches.
2068 As a degenerate case, a file link with an empty file name can be used
2069 to search the current file. For example, `[[file:::find me]]' does a
2070 search for `find me' in the current file, just as `[[find me]]' would.
2072 ---------- Footnotes ----------
2074 (1) For backward compatibility, line numbers can also follow a
2078 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
2083 The default mechanism for creating search strings and for doing the
2084 actual search related to a file link may not work correctly in all
2085 cases. For example, BibTeX database files have many entries like
2086 `year="1993"' which would not result in good search strings, because
2087 the only unique identification for a BibTeX entry is the citation key.
2089 If you come across such a problem, you can write custom functions to
2090 set the right search string for a particular file type, and to do the
2091 search for the string in the file. Using `add-hook', these functions
2092 need to be added to the hook variables
2093 `org-create-file-search-functions' and
2094 `org-execute-file-search-functions'. See the docstring for these
2095 variables for more information. Org-mode actually uses this mechanism
2096 for BibTeX database files, and you can use the corresponding code as an
2097 implementation example. Search for `BibTeX links' in the source file.
2100 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
2105 Another way to create org entries with links to other files is through
2106 the remember package by John Wiegley. Remember lets you store quick
2107 notes with little interruption of your work flow. See
2108 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2109 information. The notes produced by Remember can be stored in different
2110 ways, and Org-mode files are a good target. Org-mode significantly
2111 expands the possibilities of remember: You may define templates for
2112 different note types, and to associate target files and headlines with
2113 specific templates. It also allows you to select the location where a
2114 note should be stored interactively, on the fly.
2118 * Setting up remember:: Some code for .emacs to get things going
2119 * Remember templates:: Define the outline of different note types
2120 * Storing notes:: Directly get the note to where it belongs
2123 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
2125 4.8.1 Setting up remember
2126 -------------------------
2128 The following customization will tell remember to use org files as
2129 target, and to create annotations compatible with Org-mode links.
2131 (setq org-directory "~/path/to/my/orgfiles/")
2132 (setq org-default-notes-file "~/.notes")
2133 (setq remember-annotation-functions '(org-remember-annotation))
2134 (setq remember-handler-functions '(org-remember-handler))
2135 (add-hook 'remember-mode-hook 'org-remember-apply-template)
2138 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
2140 4.8.2 Remember templates
2141 ------------------------
2143 In combination with Org-mode, you can use templates to generate
2144 different types of remember notes. For example, if you would like to
2145 use one template to create general TODO entries, another one for
2146 journal entries, and a third one for collecting random ideas, you could
2149 (setq org-remember-templates
2150 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
2151 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
2152 (?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
2154 In these entries, the character specifies how to select the template.
2155 The first string specifies the template. Two more (optional) strings
2156 give the file in which, and the headline under which the new note
2157 should be stored. The file defaults to `org-default-notes-file', the
2158 heading to `org-remember-default-headline'. Both defaults help to get
2159 to the storing location quickly, but you can change the location
2160 interactively while storing the note.
2162 When you call `M-x remember' (or `M-x org-remember') to remember
2163 something, org will prompt for a key to select the template (if you have
2164 more than one template) and then prepare the buffer like
2166 [[file:link to where you called remember]]
2170 * [2006-03-21 Tue 15:37]
2172 [[file:link to where you called remember]]
2174 During expansion of the template, special `%'-escapes allow dynamic
2175 insertion of content:
2176 %^{prompt} prompt the user for a string and replace this sequence with it.
2177 %t time stamp, date only
2178 %T time stamp with date and time
2179 %u, %U like the above, but inactive time stamps
2180 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
2181 You may define a prompt like `%^{Birthday}t'
2182 %n user name (taken from `user-full-name')
2183 %a annotation, normally the link created with `org-store-link'
2184 %i initial content, the region when remember is called with C-u.
2185 The entire text will be indented like `%i' itself.
2186 %:keyword specific information for certain link types, see below
2188 For specific link types, the following keywords will be defined:
2190 Link type | Available keywords
2191 -------------------+----------------------------------------------
2192 bbdb | %:name %:company
2193 vm, wl, mh, rmail | %:type %:subject %:message-id
2194 | %:from %:fromname %:fromaddress
2195 | %:to %:toname %:toaddress
2196 | %:fromto (either "to NAME" or "from NAME")(1)
2197 gnus | %:group, for messages also all email fields
2199 info | %:file %:node
2202 If you would like to have the cursor in a specific position after the
2203 template has been expanded:
2205 %? After completing the template, position cursor here.
2207 If you change you mind about which template to use, call `org-remember'
2208 in the remember buffer. You may then select a new template that will
2209 be filled with the previous context information.
2211 ---------- Footnotes ----------
2213 (1) This will always be the other, not the user. See the variable
2214 `org-from-is-user-regexp'.
2217 File: org, Node: Storing notes, Prev: Remember templates, Up: Remember
2222 When you are finished preparing a note with remember, you have to press
2223 `C-c C-c' to file the note away. The handler first prompts for a
2224 target file - if you press <RET>, the value specified for the template
2225 is used. Then the command offers the headings tree of the selected
2226 file, with the cursor position at the default headline (if you had
2227 specified one in the template). You can either immediately press <RET>
2228 to get the note placed there. Or you can use vertical cursor motion
2229 (<up> and <down>) and visibility cycling (<TAB>) to find a better
2230 place. Pressing <RET> or <left> or <right> then leads to the following
2233 Cursor Key Note gets inserted
2235 buffer-start <RET> as level 2 heading at end of file
2236 on headline <RET> as sublevel of the heading at cursor
2237 <left> as same level, before current heading
2238 <right> as same level, after current heading
2239 not on <RET> at cursor position, level taken from context.
2240 headline Or use prefix arg to specify level
2243 So a fast way to store the note to its default location is to press
2244 `C-c C-c <RET> <RET>'. Even shorter would be `C-u C-c C-c', which does
2245 the same without even asking for a file or showing the tree.
2247 Before inserting the text into a tree, the function ensures that the
2248 text has a headline, i.e. a first line that starts with a `*'. If not,
2249 a headline is constructed from the current date and some additional
2250 data. If the variable `org-adapt-indentation' is non-nil, the entire
2251 text is also indented so that it starts in the same column as the
2252 headline (after the asterisks).
2255 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
2260 Org-mode does not maintain TODO lists as a separate document. TODO
2261 items are an integral part of the notes file, because TODO items
2262 usually come up while taking notes! With Org-mode, you simply mark any
2263 entry in a tree as being a TODO item. In this way, the information is
2264 not duplicated, and the entire context from which the item emerged is
2265 always present when you check.
2267 Of course, this technique causes TODO items to be scattered
2268 throughout your file. Org-mode provides methods to give you an
2269 overview over all things you have to do.
2273 * TODO basics:: Marking and displaying TODO entries
2274 * TODO extensions:: Workflow and assignments
2275 * Priorities:: Some things are more important than others
2276 * Breaking down tasks:: Splitting a task into manageable pieces
2277 * Checkboxes:: Tick-off lists
2280 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2282 5.1 Basic TODO functionality
2283 ============================
2285 Any headline can become a TODO item by starting it with the word TODO,
2288 *** TODO Write letter to Sam Fortune
2290 The most important commands to work with TODO entries are:
2293 Rotate the TODO state of the current item between
2295 ,-> (unmarked) -> TODO -> DONE --.
2296 '--------------------------------'
2298 The same rotation can also be done "remotely" from the timeline and
2299 agenda buffers with the `t' command key (*note Agenda commands::).
2303 Select the following/preceding TODO state, similar to cycling.
2304 Mostly useful if more than two TODO states are possible (*note
2308 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2309 the entire buffer, but shows all TODO items and the headings
2310 hierarchy above them. With prefix arg, search for a specific
2311 TODO. You will be prompted for the keyword, and you can also give
2312 a list of keywords like `kwd1|kwd2|...'. With numerical prefix N,
2313 show the tree for the Nth keyword in the variable
2314 `org-todo-keywords'. With two prefix args, find all TODO and DONE
2318 Show the global TODO list. This collects the TODO items from all
2319 agenda files (*note Agenda views::) into a single buffer. The
2320 buffer is in `agenda-mode', so there are commands to examine and
2321 manipulate the TODO entries directly from that buffer (*note
2322 Agenda commands::). *Note Global TODO list::, for more
2326 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2328 5.2 Extended use of TODO keywords
2329 =================================
2331 The default implementation of TODO entries is just two states: TODO and
2332 DONE. You can use the TODO feature for more complicated things by
2333 configuring the variable `org-todo-keywords'. With special setup, the
2334 TODO keyword system can work differently in different files.
2336 Note that tags are another way to classify headlines in general and
2337 TODO items in particular (*note Tags::).
2341 * Workflow states:: From TODO to DONE in steps
2342 * TODO types:: I do this, Fred the rest
2343 * Multiple sets in one file:: Mixing it all, and still finding your way
2344 * Per file keywords:: Different files, different requirements
2347 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2349 5.2.1 TODO keywords as workflow states
2350 --------------------------------------
2352 You can use TODO keywords to indicate different _sequential_ states in
2353 the process of working on an item, for example(1):
2355 (setq org-todo-keywords
2356 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2358 The vertical bar separates the TODO keywords (states that _need
2359 action_) from the DONE states (which need _no further action_. If you
2360 don't provide the separator bar, the last state is used as the DONE
2361 state. With this setup, the command `C-c C-t' will cycle an entry from
2362 TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
2363 You may also use a prefix argument to quickly select a specific state.
2364 For example `C-3 C-c C-t' will change the state immediately to VERIFY.
2365 If you define many keywords, you can use in-buffer completion (see
2366 *Note Completion::) to insert these words into the buffer. Changing a
2367 todo state can be logged with a timestamp, see *Note Tracking TODO
2368 state changes:: for more information.
2370 ---------- Footnotes ----------
2372 (1) Changing this variable only becomes effective after restarting
2373 Org-mode in a buffer.
2376 File: org, Node: TODO types, Next: Multiple sets in one file, Prev: Workflow states, Up: TODO extensions
2378 5.2.2 TODO keywords as types
2379 ----------------------------
2381 The second possibility is to use TODO keywords to indicate different
2382 _types_ of action items. For example, you might want to indicate that
2383 items are for "work" or "home". Or, when you work with several people
2384 on a single project, you might want to assign action items directly to
2385 persons, by using their names as TODO keywords. This would be set up
2388 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2390 In this case, different keywords do not indicate a sequence, but
2391 rather different types. So the normal work flow would be to assign a
2392 task to a person, and later to mark it DONE. Org-mode supports this
2393 style by adapting the workings of the command `C-c C-t'(1). When used
2394 several times in succession, it will still cycle through all names, in
2395 order to first select the right type for a task. But when you return
2396 to the item after some time and execute `C-c C-t' again, it will switch
2397 from any name directly to DONE. Use prefix arguments or completion to
2398 quickly select a specific name. You can also review the items of a
2399 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2400 C-v'. For example, to see all things Lucy has to do, you would use
2401 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2402 single buffer, you would use the prefix arg as well when creating the
2403 global todo list: `C-3 C-c t'.
2405 ---------- Footnotes ----------
2407 (1) This is also true for the `t' command in the timeline and agenda
2411 File: org, Node: Multiple sets in one file, Next: Per file keywords, Prev: TODO types, Up: TODO extensions
2413 5.2.3 Multiple keyword sets in one file
2414 ---------------------------------------
2416 Sometimes you may want to use different sets of TODO keywords in
2417 parallel. For example, you may want to have the basic `TODO'/`DONE',
2418 but also a workflow for bug fixing, and a separate state indicating
2419 that an item has been canceled (so it is not DONE, but also does not
2420 require action). Your setup would then look like this:
2422 (setq org-todo-keywords
2423 '((sequence "TODO" "|" "DONE")
2424 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2425 (sequence "|" "CANCELED")))
2427 The keywords should all be different, this helps Org-mode to keep
2428 track of which subsequence should be used for a given entry. In this
2429 setup, `C-c C-t' only operates within a subsequence, so it switches from
2430 `DONE' to (nothing) to `TODO', and from `FIXED' to (nothing) to
2431 `REPORT'. Therefore you need a mechanism to initially select the
2432 correct sequence. Besides the obvious ways like typing a keyword or
2433 using completion, you may also apply the following commands:
2437 These keys jump from one TODO subset to the next. In the above
2438 example, `C-S-<right>' would jump from `TODO' or `DONE' to
2439 `REPORT', and any of the words in the second row to `CANCELED'.
2443 `S-<<left>>' and `S-<<right>>' and walk through _all_ keywords
2444 from all sets, so for example `S-<<right>>' would switch from
2445 `DONE' to `REPORT' in the example above.
2448 File: org, Node: Per file keywords, Prev: Multiple sets in one file, Up: TODO extensions
2450 5.2.4 Setting up keywords for individual files
2451 ----------------------------------------------
2453 It can be very useful to use different aspects of the TODO mechanism in
2454 different files. For file-local settings, you need to add special lines
2455 to the file which set the keywords and interpretation for that file
2456 only. For example, to set one of the two examples discussed above, you
2457 need one of the following lines, starting in column zero anywhere in the
2460 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2462 #+TYP_TODO: Fred Sara Lucy Mike | DONE
2464 A setup for using several sets in parallel would be:
2466 #+SEQ_TODO: "TODO" "|" "DONE"
2467 #+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED"
2468 #+SEQ_TODO: "|" "CANCELED"
2470 To make sure you are using the correct keyword, type `#+' into the
2471 buffer and then use `M-<TAB>' completion.
2473 Remember that the keywords after the vertical bar (or the last
2474 keyword if no bar is there) must always mean that the item is DONE
2475 (although you may use a different word). After changing one of these
2476 lines, use `C-c C-c' with the cursor still in the line to make the
2477 changes known to Org-mode(1).
2479 ---------- Footnotes ----------
2481 (1) Org-mode parses these lines only when Org-mode is activated
2482 after visiting a file. `C-c C-c' with the cursor in a line starting
2483 with `#+' is simply restarting Org-mode for the current buffer.
2486 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2491 If you use Org-mode extensively to organize your work, you may end up
2492 with a number of TODO entries so large that you'd like to prioritize
2493 them. This can be done by placing a _priority cookie_ into the
2496 *** TODO [#A] Write letter to Sam Fortune
2498 With its standard setup, Org-mode supports priorities `A', `B', and
2499 `C'. `A' is the highest priority. An entry without a cookie is
2500 treated as priority `B'. Priorities make a difference only in the
2501 agenda (*note Weekly/Daily agenda::).
2504 Set the priority of the current headline. The command prompts for
2505 a priority character `A', `B' or `C'. When you press <SPC>
2506 instead, the priority cookie is removed from the headline. The
2507 priorities can also be changed "remotely" from the timeline and
2508 agenda buffer with the `,' command (*note Agenda commands::).
2512 Increase/decrease priority of current headline. Note that these
2513 keys are also used to modify time stamps (*note Creating
2514 timestamps::). Furthermore, these keys are also used by CUA-mode
2515 (*note Conflicts::).
2518 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2520 5.4 Breaking tasks down into subtasks
2521 =====================================
2523 It is often advisable to break down large tasks into smaller, manageable
2524 subtasks. You can do this by creating an outline tree below a TODO
2525 item, with detailed subtasks on the tree(1). Another possibility is
2526 the use of checkboxes to identify (a hierarchy of) a large number of
2527 subtasks (*note Checkboxes::).
2529 ---------- Footnotes ----------
2531 (1) To keep subtasks out of the global TODO list, see the
2532 `org-agenda-todo-list-sublevels'.
2535 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2540 Every item in a plain list (*note Plain lists::) can be made a checkbox
2541 by starting it with the string `[ ]'. This feature is similar to TODO
2542 items (*note TODO items::), but more lightweight. Checkboxes are not
2543 included into the global TODO list, so they are often great to split a
2544 task into a number of simple steps. Or you can use them in a shopping
2545 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2546 `org-mouse.el'. Here is an example of a checkbox list.
2548 * TODO Organize party [3/6]
2554 - [ ] think about what music to play
2555 - [X] talk to the neighbors
2557 The `[3/6]' and `[1/3]' in the first and second line are cookies
2558 indicating how many checkboxes are present in this entry, and how many
2559 of them have been checked off. This can give you an idea on how many
2560 checkboxes remain, even without opening a folded entry. The cookies
2561 can be placed into a headline or into (the first line of) a plain list
2562 item. Each cookie covers all checkboxes structurally below that
2563 headline/item. You have to insert the cookie yourself by typing either
2564 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2565 the second case you get information about the percentage of checkboxes
2566 checked (in the above example, this would be `[50%]' and `[33%],
2569 The following commands work with checkboxes:
2572 Toggle checkbox at point.
2575 Toggle checkbox at point.
2576 - If there is an active region, toggle the first checkbox in
2577 the region and set all remaining boxes to the same status as
2578 the first. If you want to toggle all boxes in the region
2579 independently, use a prefix argument.
2581 - If the cursor is in a headline, toggle checkboxes in the
2582 region between this headline and the next (so _not_ the
2585 - If there is no active region, just toggle the checkbox at
2589 Insert a new item with a checkbox. This works only if the cursor
2590 is already in a plain list item (*note Plain lists::).
2593 Update the checkbox statistics in the current outline entry. When
2594 called with a `C-u' prefix, update the entire file. Checkbox
2595 statistic cookies are updated automatically if you toggle
2596 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2597 you delete boxes or add/change them by hand, use this command to
2598 get things back into synch. Or simply toggle any checkbox twice
2602 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2607 Items can be labeled with timestamps to make them useful for project
2612 * Time stamps:: Assigning a time to a tree entry
2613 * Creating timestamps:: Commands which insert timestamps
2614 * Custom time format:: If you cannot work with the ISO format
2615 * Repeating items:: Deadlines that come back again and again
2616 * Progress logging:: Documenting when what work was done.
2619 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2621 6.1 Time stamps, deadlines and scheduling
2622 =========================================
2624 A time stamp is a specification of a date (possibly with time) in a
2625 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2626 09:39>'(1). A time stamp can appear anywhere in the headline or body
2627 of an org-tree entry. Its presence allows entries to be shown on
2628 specific dates in the agenda (*note Weekly/Daily agenda::). We
2632 A simple time stamp just assigns a date/time to an item. This is
2633 just like writing down an appointment in a paper agenda, or like
2634 writing down an event in a diary, when you want to take note of
2635 when something happened. In the timeline and agenda displays, the
2636 headline of an entry associated with a plain time stamp will be
2637 shown exactly on that date.
2639 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2642 Just like a plain time stamp, but with square brackets instead of
2643 angular ones. These time stamps are inactive in the sense that
2644 they do _not_ trigger an entry to show up in the agenda.
2646 * Gillian comes late for the fifth time [2006-11-01 Wed]
2649 Two time stamps connected by `--' denote a time range. The
2650 headline will be shown on the first and last day of the range, and
2651 on any dates that are displayed and fall in the range. Here is an
2654 ** Meeting in Amsterdam
2655 <2004-08-23 Mon>--<2004-08-26 Thu>
2657 TIME STAMP WITH SCHEDULED KEYWORD
2658 If a time stamp is preceded by the word `SCHEDULED:', it means you
2659 are planning to start working on that task on the given date. So
2660 this is not about recording an event, but about planning your
2661 work. The headline will be listed under the given date(2). In
2662 addition, a reminder that the scheduled date has passed will be
2663 present in the compilation for _today_, until the entry is marked
2664 DONE. I.e., the task will automatically be forwarded until
2667 *** TODO Call Trillian for a date on New Years Eve.
2668 SCHEDULED: <2004-12-25 Sat>
2670 TIME STAMP WITH DEADLINE KEYWORD
2671 If a time stamp is preceded by the word `DEADLINE:', the task
2672 (most likely a TODO item) is supposed to be finished on that date,
2673 and it will be listed then. In addition, the compilation for
2674 _today_ will carry a warning about the approaching or missed
2675 deadline, starting `org-deadline-warning-days' before the due
2676 date, and continuing until the entry is marked DONE. An example:
2678 *** TODO write article about the Earth for the Guide
2679 The editor in charge is [[bbdb:Ford Prefect]]
2680 DEADLINE: <2004-02-29 Sun>
2682 TIME STAMP WITH CLOSED KEYWORD
2683 When `org-log-done' is non-nil, Org-mode will automatically insert
2684 a special time stamp each time a TODO entry is marked done (*note
2685 Progress logging::). This time stamp is enclosed in square
2686 brackets instead of angular brackets.
2688 TIME RANGE WITH CLOCK KEYWORD
2689 When using the clock to time the work that is being done on
2690 specific items, time ranges preceded by the CLOCK keyword are
2691 inserted automatically into the file. The time stamps are
2692 enclosed in square brackets instead of angular brackets. *Note
2693 Clocking work time::.
2695 ---------- Footnotes ----------
2697 (1) This is the standard ISO date/time format. If you cannot get
2698 used to these, see *Note Custom time format::
2700 (2) It will still be listed on that date after it has been marked
2701 DONE. If you don't like this, set the variable
2702 `org-agenda-skip-scheduled-if-done'.
2705 File: org, Node: Creating timestamps, Next: Custom time format, Prev: Time stamps, Up: Timestamps
2707 6.2 Creating timestamps
2708 =======================
2710 For Org-mode to recognize time stamps, they need to be in the specific
2711 format. All commands listed below produce time stamps in the correct
2715 Prompt for a date and insert a corresponding time stamp. When the
2716 cursor is at a previously used time stamp, it is updated to NOW.
2717 When this command is used twice in succession, a time range is
2721 Like `C-c .', but use the alternative format which contains date
2722 and time. The default time can be rounded to multiples of 5
2723 minutes, see the option `org-time-stamp-rounding-minutes'.
2726 Like `C-c .', but insert an inactive time stamp that will not cause
2730 Insert a time stamp corresponding to the cursor date in the
2734 Access the Emacs calendar for the current date. If there is a
2735 timestamp in the current line, goto the corresponding date instead.
2738 Access the agenda for the date given by the time stamp or -range at
2739 point (*note Weekly/Daily agenda::).
2742 Insert `DEADLINE' keyword along with a stamp. The insertion will
2743 happen in the line directly following the headline.
2746 Create a sparse tree with all deadlines that are either past-due,
2747 or which will become due within `org-deadline-warning-days'. With
2748 `C-u' prefix, show all deadlines in the file. With a numeric
2749 prefix, check that many days. For example, `C-1 C-c C-w' shows
2750 all deadlines due tomorrow.
2753 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2754 happen in the line directly following the headline. Any CLOSED
2755 timestamp will be removed.
2759 Change date at cursor by one day. These key bindings conflict with
2760 CUA-mode (*note Conflicts::).
2764 Change the item under the cursor in a timestamp. The cursor can
2765 be on a year, month, day, hour or minute. Note that if the cursor
2766 is in a headline and not at a time stamp, these same keys modify
2767 the priority of an item. (*note Priorities::). The key bindings
2768 also conflict with CUA-mode (*note Conflicts::).
2771 Evaluate a time range by computing the difference between start and
2772 end. With prefix arg, insert result after the time range (in a
2773 table: into the following column).
2777 * The date/time prompt:: How org-mode helps you entering date and time
2780 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2782 6.2.1 The date/time prompt
2783 --------------------------
2785 When Org-mode prompts for a date/time, the prompt suggests to enter an
2786 ISO date. But it will in fact accept any string containing some date
2787 and/or time information. You can, for example, use `C-y' to paste a
2788 (possibly multi-line) string copied from an email message. Org-mode
2789 will find whatever information is in there and will replace anything not
2790 specified with the current date and time. For example:
2792 3-2-5 --> 2003-02-05
2793 feb 15 --> currentyear-02-15
2794 sep 12 9 --> 2009-09-12
2795 12:45 --> today 12:45
2796 22 sept 0:34 --> currentyear-09-22 0:34
2797 12 --> currentyear-currentmonth-12
2798 Fri --> nearest Friday (today or later)
2799 +4 --> 4 days from now (if +N is the only thing given)
2801 The function understands English month and weekday abbreviations. If
2802 you want to use unabbreviated names and/or other languages, configure
2803 the variables `parse-time-months' and `parse-time-weekdays'.
2805 Parallel to the minibuffer prompt, a calendar is popped up(1). When
2806 you exit the date prompt, either by clicking on a date in the calendar,
2807 or by pressing <RET>, the date selected in the calendar will be
2808 combined with the information entered at the prompt. You can control
2809 the calendar fully from the minibuffer:
2812 Scroll calendar backwards by one month.
2815 Scroll calendar forwards by one month.
2818 Select date by clicking on it.
2839 Choose date in calendar (only if nothing was typed into
2842 ---------- Footnotes ----------
2844 (1) If you don't need/want the calendar, configure the variable
2845 `org-popup-calendar-for-date-prompt'.
2848 File: org, Node: Custom time format, Next: Repeating items, Prev: Creating timestamps, Up: Timestamps
2850 6.3 Custom time format
2851 ======================
2853 Org-mode uses the standard ISO notation for dates and times as it is
2854 defined in ISO 8601. If you cannot get used to this and require another
2855 representation of date and time to keep you happy, you can get it by
2856 customizing the variables `org-display-custom-times' and
2857 `org-time-stamp-custom-formats'.
2860 Toggle the display of custom formats for dates and times.
2862 Org-mode needs the default format for scanning, so the custom date/time
2863 format does not _replace_ the default format - instead it is put _over_
2864 the default format using text properties. This has the following
2866 * You cannot place the cursor onto a time stamp anymore, only before
2869 * The `S-<up>/<down>' keys can no longer be used to adjust each
2870 component of a time stamp. If the cursor is at the beginning of
2871 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2872 like `S-<left>/<right>'. At the end of the stamp, the time will
2873 be changed by one minute.
2875 * When you delete a time stamp character-by-character, it will only
2876 disappear from the buffer after _all_ (invisible) characters
2877 belonging to the ISO timestamp have been removed.
2879 * If the custom time stamp format is longer than the default and you
2880 are using dates in tables, table alignment will be messed up. If
2881 the custom format is shorter, things do work as expected.
2884 File: org, Node: Repeating items, Next: Progress logging, Prev: Custom time format, Up: Timestamps
2889 Org-mode integrates with the Emacs calendar and diary to display cyclic
2890 appointments, anniversaries and other special entries in the agenda
2891 (*note Weekly/Daily agenda::). However, it can be useful to have
2892 certain deadlines and scheduling items to auto-repeat. The advantage of
2893 a deadline or scheduled item is that the they produce warnings ahead of
2894 time and automatically forward themselves in the agenda until they are
2895 done. The abstract difference is therefore between cyclic appointments
2896 and cyclic action items. For appointments you should use the diary,
2897 for actions you can uses an org-mode deadline or scheduling time stamp
2898 together with a REPEAT cookie. For example:
2900 * TODO Replace batteries in smoke detector REPEAT(+18m)
2901 SCHEDULED: <2007-01-01 Mon>
2903 * TODO Get dentist appointment REPEAT(+6m)
2904 SCHEDULED: <2006-12-19 Tue>
2906 * TODO Tax report to IRS REPEAT(+1y)
2907 DEADLINE: <2007-04-01 Sun>
2909 Each time you try to mark one of these entries DONE using `C-c C-t',
2910 they will automatically switch back to the state TODO, and the
2911 deadline/scheduling will be shifted accordingly. The time units
2912 recognized by org-mode are year (y), month (m), week (w), and day (d).
2913 Org-mode will also prompt you for a note and record the fact that you
2914 have closed this item in a note under the headline.
2916 One unusual property of these repeating items is that only one
2917 instance of each exist at any given time. So if you look back or ahead
2918 in the agenda, you will not find past and future instances, only the
2919 current one will show up. Use a cyclic diary entry if you need all
2920 past and future instances to be visible in the agenda.
2923 File: org, Node: Progress logging, Prev: Repeating items, Up: Timestamps
2925 6.5 Progress Logging
2926 ====================
2928 Org-mode can automatically record a time stamp when you mark a TODO item
2929 as DONE, or even each time when you change the state of a TODO item.
2930 You can also measure precisely the time you spent on specific items in a
2931 project by starting and stopping a clock when you start and stop working
2932 on an aspect of a project.
2936 * Closing items:: When was this entry marked DONE?
2937 * Tracking TODO state changes:: When did the status change?
2938 * Clocking work time:: When exactly did you work on this item?
2941 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
2946 If you want to keep track of _when_ a certain TODO item was finished,
2947 turn on logging with(1)
2949 (setq org-log-done t)
2951 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2952 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2953 [timestamp]' will be inserted just after the headline. If you turn the
2954 entry back into a TODO item through further state cycling, that line
2955 will be removed again. In the timeline (*note Timeline::) and in the
2956 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
2957 display the TODO items closed on each day, giving you an overview of
2958 what has been done on a day. If you want to record a note along with
2959 the timestamp, use(2)
2961 (setq org-log-done '(done))
2963 ---------- Footnotes ----------
2965 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
2967 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
2970 File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
2972 6.5.2 Tracking TODO state changes
2973 ---------------------------------
2975 When TODO keywords are used as workflow states (*note Workflow
2976 states::), you might want to keep track of when a state change occurred,
2977 and you may even want to attach notes to that state change. With the
2980 (setq org-log-done '(state))
2982 each state change will prompt you for a note that will be attached to
2983 the current headline. Very likely you do not want this verbose tracking
2984 all the time, so it is probably better to configure this behavior with
2985 in-buffer options. For example, if you are tracking purchases, put
2986 these into a separate file that starts with:
2988 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
2989 #+STARTUP: lognotestate
2992 File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
2994 6.5.3 Clocking work time
2995 ------------------------
2997 Org-mode allows you to clock the time you spent on specific tasks in a
2998 project. When you start working on an item, you can start the clock.
2999 When you stop working on that task, or when you mark the task done, the
3000 clock is stopped and the corresponding time interval is recorded. It
3001 also computes the total time spent on each subtree of a project.
3004 Start the clock on the current item (clock-in). This inserts the
3005 CLOCK keyword together with a timestamp.
3008 Stop the clock (clock-out). The inserts another timestamp at the
3009 same location where the clock was last started. It also directly
3010 computes the resulting time in inserts it after the time range as
3011 `=> HH:MM'. See the variable `org-log-done' for the possibility to
3012 record an additional note together with the clock-out time
3016 Recompute the time interval after changing one of the time stamps.
3017 This is only necessary if you edit the time stamps directly. If
3018 you change them with `S-<cursor>' keys, the update is automatic.
3021 Changing the TODO state of an item to DONE automatically stops the
3022 clock if it is running in this same item.
3025 Cancel the current clock. This is useful if a clock was started by
3026 mistake, or if you ended up working on something else.
3029 Display time summaries for each subtree in the current buffer.
3030 This puts overlays at the end of each headline, showing the total
3031 time recorded under that heading, including the time of any
3032 subheadings. You can use visibility cycling to study the tree, but
3033 the overlays disappear when you change the buffer (see variable
3034 `org-remove-highlights-with-change') or press `C-c C-c'.
3037 Insert a dynamic block (*note Dynamic blocks::) containing a clock
3038 report as an org-mode table into the current file.
3039 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
3042 If such a block already exists, its content is replaced by the new
3043 table. The `BEGIN' line can specify options:
3044 :maxlevels Maximum level depth to which times are listed in the table.
3045 :emphasize When `t', emphasize level one and level two items
3046 :block The time block to consider. This block is specified relative
3047 to the current time and may be any of these keywords:
3048 `today', `yesterday', `thisweek', `lastweek',
3049 `thismonth', `lastmonth', `thisyear', or `lastyear'.
3050 :tstart A time string specifying when to start considering times
3051 :tend A time string specifying when to stop considering times
3052 So to get a clock summary for the current day, you could write
3053 #+BEGIN: clocktable :maxlevel 2 :block today
3056 and to use a specific time range you could write(2)
3057 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
3058 :tend "<2006-08-10 Thu 12:00>"
3063 Update all dynamic blocks (*note Dynamic blocks::). This is
3064 useful if you have several clocktable blocks in a buffer.
3066 The `l' key may be used in the timeline (*note Timeline::) and in
3067 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
3068 worked on or closed during a day.
3070 ---------- Footnotes ----------
3072 (1) The corresponding in-buffer setting is: `#+STARTUP:
3075 (2) Note that all parameters must be specified in a single line -
3076 the line is broken here only to fit it onto the manual.
3079 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
3084 If you wish to implement a system of labels and contexts for
3085 cross-correlating information, an excellent way is to assign tags to
3086 headlines. Org-mode has extensive support for using tags.
3088 Every headline can contain a list of tags, at the end of the
3089 headline. Tags are normal words containing letters, numbers, `_', and
3090 `@'. Tags must be preceded and followed by a single colon; like
3091 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
3095 * Tag inheritance:: Tags use the tree structure of the outline
3096 * Setting tags:: How to assign tags to a headline
3097 * Tag searches:: Searching for combinations of tags
3100 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
3105 Tags make use of the hierarchical structure of outline trees. If a
3106 heading has a certain tag, all subheadings will inherit the tag as
3107 well. For example, in the list
3109 * Meeting with the French group :WORK:
3110 ** Summary by Frank :BOSS:NOTES:
3111 *** TODO Prepare slides for him :ACTION:
3113 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
3114 `:ACTION:'. When executing tag searches and Org-mode finds that a
3115 certain headline matches the search criterion, it will not check any
3116 sublevel headline, assuming that these likely also match, and that the
3117 list of matches can become very long. This may not be what you want,
3118 however, and you can influence inheritance and searching using the
3119 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
3122 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
3127 Tags can simply be typed into the buffer at the end of a headline.
3128 After a colon, `M-<TAB>' offers completion on tags. There is also a
3129 special command for inserting tags:
3132 Enter new tags for the current headline. Org-mode will either
3133 offer completion or a special single-key interface for setting
3134 tags, see below. After pressing <RET>, the tags will be inserted
3135 and aligned to `org-tags-column'. When called with a `C-u'
3136 prefix, all tags in the current buffer will be aligned to that
3137 column, just to make things look nice. TAGS are automatically
3138 realigned after promotion, demotion, and TODO state changes (*note
3141 Org will support tag insertion based on a _list of tags_. By
3142 default this list is constructed dynamically, containing all tags
3143 currently used in the buffer. You may also globally specify a hard list
3144 of tags with the variable `org-tag-alist'. Finally you can set the
3145 default tags for a given file with lines like
3147 #+TAGS: @WORK @HOME @TENNISCLUB
3148 #+TAGS: Laptop Car PC Sailboat
3150 If you have globally defined your preferred set of tags using the
3151 variable `org-tag-alist', but would like to use a dynamic tag list in a
3152 specific file: Just add an empty TAGS option line to that file:
3156 The default support method for entering tags is minibuffer
3157 completion. However, Org-mode also implements a much better method:
3158 _fast tag selection_. This method allows to select and deselect tags
3159 with a single key per tag. To function efficiently, you should assign
3160 unique keys to most tags. This can be done globally with
3162 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
3164 or on a per-file basis with
3166 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
3168 You can also group together tags that are mutually exclusive. With
3171 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
3173 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
3176 Don't forget to press `C-c C-c' with the cursor in one of these lines
3177 to activate any changes.
3179 If at least one tag has a selection key, pressing `C-c C-c' will
3180 automatically present you with a special interface, listing inherited
3181 tags, the tags of the current headline, and a list of all legal tags
3182 with corresponding keys(2). In this interface, you can use the
3186 Pressing keys assigned to tags will add or remove them from the
3187 list of tags in the current line. Selecting a tag in a group of
3188 mutually exclusive tags will turn off any other tags from that
3192 Enter a tag in the minibuffer, even if the tag is not in the
3193 predefined list. You will be able to complete on all tags present
3197 Clear all tags for this line.
3200 Accept the modified set.
3203 Abort without installing changes.
3206 If `q' is not assigned to a tag, it aborts like `C-g'.
3209 Turn off groups of mutually exclusive tags. Use this to (as an
3210 exception) assign several tags from such a group.
3213 Toggle auto-exit after the next change (see below). If you are
3214 using expert mode, the first `C-c' will display the selection
3217 This method lets you assign tags to a headline with very few keys. With
3218 the above setup, you could clear the current tags and set `@HOME',
3219 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
3220 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
3221 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
3222 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3225 If you find that most of the time, you need only a single keypress to
3226 modify your list of tags, set the variable
3227 `org-fast-tag-selection-single-key'. Then you no longer have to press
3228 <RET> to exit fast tag selection - it will immediately exit after the
3229 first change. If you then occasionally need more keys, press `C-c' to
3230 turn off auto-exit for the current tag selection process (in effect:
3231 start selection with `C-c C-c C-c' instead of `C-c C-c'). If you set
3232 the variable to the value `expert', the special window is not even
3233 shown for single-key tag selection, it comes up only when you press an
3236 ---------- Footnotes ----------
3238 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3239 respectively. Several groups are allowed.
3241 (2) Keys will automatically be assigned to tags which have no
3245 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
3250 Once a tags system has been set up, it can be used to collect related
3251 information into special lists.
3254 Create a sparse tree with all headlines matching a tags search.
3255 With a `C-u' prefix argument, ignore headlines that are not a TODO
3259 Create a global list of tag matches from all agenda files. *Note
3260 Matching headline tags::.
3263 Create a global list of tag matches from all agenda files, but
3264 check only TODO items and force checking subitems (see variable
3265 `org-tags-match-list-sublevels').
3267 A tags search string can use Boolean operators `&' for AND and `|'
3268 for OR. `&' binds more strongly than `|'. Parenthesis are currently
3269 not implemented. A tag may also be preceded by `-', to select against
3270 it, and `+' is syntactic sugar for positive selection. The AND
3271 operator `&' is optional when `+' or `-' is present. Examples:
3274 Select headlines tagged `:WORK:', but discard those also tagged
3278 Selects lines tagged `:WORK:' or `:LAPTOP:'.
3281 Like before, but require the `:LAPTOP:' lines to be tagged also
3284 If you are using multi-state TODO keywords (*note TODO
3285 extensions::), it can be useful to also match on the TODO keyword.
3286 This can be done by adding a condition after a slash to a tags match.
3287 The syntax is similar to the tag matches, but should be applied with
3288 consideration: For example, a positive selection on several TODO
3289 keywords can not meaningfully be combined with boolean AND. However,
3290 _negative selection_ combined with AND can be meaningful. To make sure
3291 that only lines are checked that actually have any TODO keyword, use
3292 `C-c a M', or equivalently start the todo part after the slash with `!'.
3296 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3299 `WORK/!-WAITING-NEXT'
3300 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3303 `WORK/+WAITING|+NEXT'
3304 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3307 Any element of the tag/todo match can be a regular expression - in
3308 this case it must be enclosed in curly braces. For example,
3309 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3310 tag starting with `BOSS'.
3312 You can also require a headline to be of a certain level, by writing
3313 instead of any TAG an expression like `LEVEL=3'. For example, a search
3314 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3315 BOSS and are _not_ marked with the todo keyword DONE.
3318 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
3323 Due to the way Org-mode works, TODO items, time-stamped items, and
3324 tagged headlines can be scattered throughout a file or even a number of
3325 files. To get an overview over open action items, or over events that
3326 are important for a particular date, this information must be collected,
3327 sorted and displayed in an organized way.
3329 Org-mode can select items based on various criteria, and display them
3330 in a separate buffer. Six different view types are provided:
3332 * an _agenda_ that is like a calendar and shows information for
3335 * a _TODO list_ that covers all unfinished action items,
3337 * a _tags view_, showings headlines based on the tags associated
3340 * a _timeline view_ that shows all events in a single Org-mode file,
3341 in time-sorted view,
3343 * a _stuck projects view_ showing projects that currently don't move
3346 * _custom views_ that are special tag/keyword searches and
3347 combinations of different views.
3349 The extracted information is displayed in a special _agenda buffer_.
3350 This buffer is read-only, but provides commands to visit the
3351 corresponding locations in the original Org-mode files, and even to
3352 edit these files remotely.
3354 Two variables control how the agenda buffer is displayed and whether
3355 the window configuration is restored when the agenda exits:
3356 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3360 * Agenda files:: Files being searched for agenda information
3361 * Agenda dispatcher:: Keyboard access to agenda views
3362 * Built-in agenda views:: What is available out of the box?
3363 * Presentation and sorting:: How agenda items are prepared for display
3364 * Agenda commands:: Remote editing of org trees
3365 * Custom agenda views:: Defining special searches and views
3368 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
3373 The information to be shown is collected from all _agenda files_, the
3374 files listed in the variable `org-agenda-files'(1). Thus even if you
3375 only work with a single Org-mode file, this file should be put into
3376 that list(2). You can customize `org-agenda-files', but the easiest
3377 way to maintain it is through the following commands
3380 Add current file to the list of agenda files. The file is added to
3381 the front of the list. If it was already in the list, it is moved
3382 to the front. With prefix arg, file is added/moved to the end.
3385 Remove current file from the list of agenda files.
3389 Cycle through agenda file list, visiting one file after the other.
3391 The Org menu contains the current list of files and can be used to
3394 ---------- Footnotes ----------
3396 (1) If the value of that variable is not a list, but a single file
3397 name, then the list of agenda files will be maintained in that external
3400 (2) When using the dispatcher, pressing `1' before selecting a
3401 command will actually limit the command to the current file, and ignore
3402 `org-agenda-files' until the next dispatcher command.
3405 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3407 8.2 The agenda dispatcher
3408 =========================
3410 The views are created through a dispatcher that should be bound to a
3411 global key, for example `C-c a' (*note Installation::). In the
3412 following we will assume that `C-c a' is indeed how the dispatcher is
3413 accessed and list keyboard access to commands accordingly. After
3414 pressing `C-c a', an additional letter is required to execute a
3415 command. The dispatcher offers the following default commands:
3417 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3420 Create a list of all TODO items (*note Global TODO list::).
3423 Create a list of headlines matching a TAGS expression (*note
3424 Matching headline tags::).
3427 Create the timeline view for the current buffer (*note Timeline::).
3430 Create a list of stuck projects (*note Stuck projects::).
3433 Restrict an agenda command to the current buffer. After pressing
3434 `1', you still need to press the character selecting the command.
3437 If there is an active region, restrict the following agenda
3438 command to the region. Otherwise, restrict it to the current
3439 subtree. After pressing `0', you still need to press the
3440 character selecting the command.
3442 You can also define custom commands that will be accessible through
3443 the dispatcher, just like the default commands. This includes the
3444 possibility to create extended agenda buffers that contain several
3445 blocks together, for example the weekly agenda, the global TODO list and
3446 a number of special tags matches. *Note Custom agenda views::.
3449 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3451 8.3 The built-in agenda views
3452 =============================
3454 In this section we describe the built-in views.
3458 * Weekly/Daily agenda:: The calendar page with current tasks
3459 * Global TODO list:: All unfinished action items
3460 * Matching headline tags:: Structured information with fine-tuned search
3461 * Timeline:: Time-sorted view for single file
3462 * Stuck projects:: Find projects you need to review
3465 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3467 8.3.1 The weekly/daily agenda
3468 -----------------------------
3470 The purpose of the weekly/daily _agenda_ is to act like a page of a
3471 paper agenda, showing all the tasks for the current week or day.
3474 Compile an agenda for the current week from a list of org files.
3475 The agenda shows the entries for each day. With a `C-u' prefix (or
3476 when the variable `org-agenda-include-all-todo' is `t'), all
3477 unfinished TODO items (including those without a date) are also
3478 listed at the beginning of the buffer, before the first date.
3480 Remote editing from the agenda buffer means, for example, that you
3481 can change the dates of deadlines and appointments from the agenda
3482 buffer. The commands available in the Agenda buffer are listed in
3483 *Note Agenda commands::.
3485 Calendar/Diary integration
3486 ..........................
3488 Emacs contains the calendar and diary by Edward M. Reingold. The
3489 calendar displays a three-month calendar with holidays from different
3490 countries and cultures. The diary allows you to keep track of
3491 anniversaries, lunar phases, sunrise/set, recurrent appointments
3492 (weekly, monthly) and more. In this way, it is quite complementary to
3493 Org-mode. It can be very useful to combine output from Org-mode with
3496 In order to include entries from the Emacs diary into Org-mode's
3497 agenda, you only need to customize the variable
3499 (setq org-agenda-include-diary t)
3501 After that, everything will happen automatically. All diary entries
3502 including holidays, anniversaries etc will be included in the agenda
3503 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3504 the agenda buffer to jump to the diary file in order to edit existing
3505 diary entries. The `i' command to insert new entries for the current
3506 date works in the agenda buffer, as well as the commands `S', `M', and
3507 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3508 to other calendars, respectively. `c' can be used to switch back and
3509 forth between calendar and agenda.
3512 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3514 8.3.2 The global TODO list
3515 --------------------------
3517 The global TODO list contains all unfinished TODO items, formatted and
3518 collected into a single place.
3521 Show the global TODO list. This collects the TODO items from all
3522 agenda files (*note Agenda views::) into a single buffer. The
3523 buffer is in `agenda-mode', so there are commands to examine and
3524 manipulate the TODO entries directly from that buffer (*note
3528 Like the above, but allows selection of a specific TODO keyword.
3529 You can also do this by specifying a prefix argument to `C-c a t'.
3530 With a `C-u' prefix you are prompted for a keyword, and you may
3531 also specify several keywords by separating them with `|' as
3532 boolean OR operator. With a numeric prefix, the Nth keyword in
3533 `org-todo-keywords' is selected. The `r' key in the agenda buffer
3534 regenerates it, and you can give a prefix argument to this command
3535 to change the selected TODO keyword, for example `3 r'. If you
3536 often need a search for a specific keyword, define a custom
3537 command for it (*note Agenda dispatcher::).
3538 Matching specific TODO keywords can also be done as part of a tags
3539 search (*note Tag searches::).
3541 Remote editing of TODO items means that you can change the state of a
3542 TODO entry with a single key press. The commands available in the TODO
3543 list are described in *Note Agenda commands::.
3545 Normally the global todo list simply shows all headlines with TODO
3546 keywords. This list can become very long. There are two ways to keep
3548 - Some people view a TODO item that has been _scheduled_ for
3549 execution (*note Time stamps::) as no longer _open_. Configure the
3550 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3551 items from the global TODO list.
3553 - TODO items may have sublevels to break up the task into subtasks.
3554 In such cases it may be enough to list only the highest level TODO
3555 headline and omit the sublevels from the global list. Configure
3556 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3559 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3561 8.3.3 Matching headline tags
3562 ----------------------------
3564 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3565 you can select headlines based on the tags that apply to them and
3566 collect them into an agenda buffer.
3569 Produce a list of all headlines that match a given set of tags.
3570 The command prompts for a selection criterion, which is a boolean
3571 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3572 `WORK|HOME' (*note Tags::). If you often need a specific search,
3573 define a custom command for it (*note Agenda dispatcher::).
3576 Like `C-c a m', but only select headlines that are also TODO items
3577 and force checking subitems (see variable
3578 `org-tags-match-list-sublevels'). Matching specific todo keywords
3579 together with a tags match is also possible, see *Note Tag
3582 The commands available in the tags list are described in *Note
3586 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3588 8.3.4 Timeline for a single file
3589 --------------------------------
3591 The timeline summarizes all time-stamped items from a single Org-mode
3592 file in a _time-sorted view_. The main purpose of this command is to
3593 give an overview over events in a project.
3596 Show a time-sorted view of the org file, with all time-stamped
3597 items. When called with a `C-u' prefix, all unfinished TODO
3598 entries (scheduled or not) are also listed under the current date.
3600 The commands available in the timeline buffer are listed in *Note
3604 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3606 8.3.5 Stuck projects
3607 --------------------
3609 If you are following a system like David Allen's GTD to organize your
3610 work, one of the "duties" you have is a regular review to make sure
3611 that all projects move along. A _stuck_ project is a project that has
3612 no defined next actions, so it will never show up in the TODO lists
3613 Org-mode produces. During the review, you need to identify such
3614 projects and define next actions for them.
3617 List projects that are stuck.
3620 Customize the variable `org-stuck-projects' to define what a stuck
3621 project is and how to find it.
3623 You almost certainly will have to configure this view before it will
3624 work for you. The built-in default assumes that all your projects are
3625 level-2 headlines, and that a project is not stuck if it has at least
3626 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3628 Lets assume that you, in your own way of using Org-mode, identify
3629 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3630 indicate a project that should not be considered yet. Lets further
3631 assume that the todo keyword DONE marks finished projects, and that NEXT
3632 and TODO indicate next actions. Finally, the tag @SHOP indicates
3633 shopping and is a next action even without the NEXT tag. In this case
3634 you would start by identifying eligible projects with a tags/todo match
3635 `+PROJECT/-MAYBE-DONE', and then check for TODO, NEXT and @SHOP in the
3636 subtree to identify projects that are not stuck. The correct
3637 customization for this is
3639 (setq org-stuck-projects
3640 ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")))
3643 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3645 8.4 Presentation and sorting
3646 ============================
3648 Before displaying items in an agenda view, Org-mode visually prepares
3649 the items and sorts them. Each item occupies a single line. The line
3650 starts with a _prefix_ that contains the _category_ (*note
3651 Categories::) of the item and other important information. You can
3652 customize the prefix using the option `org-agenda-prefix-format'. The
3653 prefix is followed by a cleaned-up version of the outline headline
3654 associated with the item.
3658 * Categories:: Not all tasks are equal
3659 * Time-of-day specifications:: How the agenda knows the time
3660 * Sorting of agenda items:: The order of things
3663 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3668 The category is a broad label assigned to each agenda item. By default,
3669 the category is simply derived from the file name, but you can also
3670 specify it with a special line in the buffer, like this:
3674 If there are several such lines in a file, each specifies the
3675 category for the text below it (but the first category also applies to
3676 any text before the first CATEGORY line). The display in the agenda
3677 buffer looks best if the category is not longer than 10 characters.
3680 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3682 8.4.2 Time-of-Day Specifications
3683 --------------------------------
3685 Org-mode checks each agenda item for a time-of-day specification. The
3686 time can be part of the time stamp that triggered inclusion into the
3687 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3688 specified with two time stamps, like
3689 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3691 In the headline of the entry itself, a time(range) may also appear as
3692 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3693 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3694 entries are recognized as well.
3696 For agenda display, Org-mode extracts the time and displays it in a
3697 standard 24 hour format as part of the prefix. The example times in
3698 the previous paragraphs would end up in the agenda like this:
3700 8:30-13:00 Arthur Dent lies in front of the bulldozer
3701 12:45...... Ford Prefect arrives and takes Arthur to the pub
3702 19:00...... The Vogon reads his poem
3703 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3705 If the agenda is in single-day mode, or for the display of today, the
3706 timed entries are embedded in a time grid, like
3708 8:00...... ------------------
3709 8:30-13:00 Arthur Dent lies in front of the bulldozer
3710 10:00...... ------------------
3711 12:00...... ------------------
3712 12:45...... Ford Prefect arrives and takes Arthur to the pub
3713 14:00...... ------------------
3714 16:00...... ------------------
3715 18:00...... ------------------
3716 19:00...... The Vogon reads his poem
3717 20:00...... ------------------
3718 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3720 The time grid can be turned on and off with the variable
3721 `org-agenda-use-time-grid', and can be configured with
3722 `org-agenda-time-grid'.
3725 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3727 8.4.3 Sorting of agenda items
3728 -----------------------------
3730 Before being inserted into a view, the items are sorted. How this is
3731 done depends on the type of view.
3732 * For the daily/weekly agenda, the items for each day are sorted.
3733 The default order is to first collect all items containing an
3734 explicit time-of-day specification. These entries will be shown
3735 at the beginning of the list, as a _schedule_ for the day. After
3736 that, items remain grouped in categories, in the sequence given by
3737 `org-agenda-files'. Within each category, items are sorted by
3738 priority (*note Priorities::), which is composed of the base
3739 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3740 plus additional increments for overdue scheduled or deadline items.
3742 * For the TODO list, items remain in the order of categories, but
3743 within each category, sorting takes place according to priority
3744 (*note Priorities::).
3746 * For tags matches, items are not sorted at all, but just appear in
3747 the sequence in which they are found in the agenda files.
3749 Sorting can be customized using the variable
3750 `org-agenda-sorting-strategy'.
3753 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3755 8.5 Commands in the agenda buffer
3756 =================================
3758 Entries in the agenda buffer are linked back to the org file or diary
3759 file where they originate. You are not allowed to edit the agenda
3760 buffer itself, but commands are provided to show and jump to the
3761 original entry location, and to edit the org-files "remotely" from the
3762 agenda buffer. In this way, all information is stored only once,
3763 removing the risk that your agenda and note files may diverge.
3765 Some commands can be executed with mouse clicks on agenda lines. For
3766 the other commands, the cursor needs to be in the desired line.
3772 Next line (same as <up>).
3775 Previous line (same as <down>).
3782 Display the original location of the item in another window.
3785 Display original location and recenter that window.
3790 Go to the original location of the item in another window. Under
3791 Emacs 22, `mouse-1' will also works for this.
3794 Go to the original location of the item and delete other windows.
3797 Toggle Follow mode. In Follow mode, as you move the cursor through
3798 the agenda buffer, the other window always shows the corresponding
3799 location in the org file. The initial setting for this mode in new
3800 agenda buffers can be set with the variable
3801 `org-agenda-start-with-follow-mode'.
3804 Display the entire subtree of the current item in an indirect
3805 buffer. With numerical prefix ARG, go up to this level and then
3806 take that tree. If ARG is negative, go up that many levels. With
3807 `C-u' prefix, do not remove the previously used indirect buffer.
3810 Toggle Logbook mode. In Logbook mode, entries that where marked
3811 DONE while logging was on (variable `org-log-done') are shown in
3812 the agenda, as are entries that have been clocked on that day.
3818 Delete other windows.
3821 Switch to weekly view (7 days displayed together).
3824 Switch to daily view (just one day displayed).
3827 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3831 Toggle the time grid on and off. See also the variables
3832 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3835 Recreate the agenda buffer, for example to reflect the changes
3836 after modification of the time stamps of items with S-<left> and
3837 S-<right>. When the buffer is the global todo list, a prefix
3838 argument is interpreted to create a selective list for a specific
3842 Save all Org-mode buffers in the current Emacs session.
3845 Display the following `org-agenda-ndays' days. For example, if
3846 the display covers a week, switch to the following week. With
3847 prefix arg, go forward that many times `org-agenda-ndays' days.
3850 Display the previous dates.
3862 Undo a change due to a remote editing command. The change is
3863 undone both in the agenda buffer and in the remote buffer.
3866 Change the TODO state of the item, both in the agenda and in the
3870 Delete the current agenda item along with the entire subtree
3871 belonging to it in the original Org-mode file. If the text to be
3872 deleted remotely is longer than one line, the kill needs to be
3873 confirmed by the user. See variable `org-agenda-confirm-kill'.
3876 Archive the subtree corresponding to the current headline.
3879 Show all tags associated with the current item. Because of
3880 inheritance, this may be more than the tags listed in the line
3884 Set tags for the current headline.
3887 Toggle the ARCHIVE tag for the current headline.
3890 Set the priority for the current item. Org-mode prompts for the
3891 priority character. If you reply with <SPC>, the priority cookie
3892 is removed from the entry.
3895 Display weighted priority of current item.
3899 Increase the priority of the current item. The priority is
3900 changed in the original buffer, but the agenda is not resorted.
3901 Use the `r' key for this.
3905 Decrease the priority of the current item.
3911 Set a deadline for this item.
3914 Change the time stamp associated with the current line by one day
3915 into the future. With prefix argument, change it by that many
3916 days. For example, `3 6 5 S-<right>' will change it by a year.
3917 The stamp is changed in the original org file, but the change is
3918 not directly reflected in the agenda buffer. Use the `r' key to
3922 Change the time stamp associated with the current line by one day
3926 Change the time stamp associated with the current line to today.
3927 The key `>' has been chosen, because it is the same as `S-.' on my
3931 Start the clock on the current item. If a clock is running
3932 already, it is stopped first.
3935 Stop the previously started clock.
3938 Cancel the currently running clock.
3944 Open the Emacs calendar and move to the date at the agenda cursor.
3947 When in the calendar, compute and show the Org-mode agenda for the
3951 Insert a new entry into the diary. Prompts for the type of entry
3952 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3953 new entry in the diary, just as `i d' etc. would do in the
3954 calendar. The date is taken from the cursor position.
3957 Show the phases of the moon for the three months around current
3961 Show sunrise and sunset times. The geographical location must be
3962 set with calendar variables, see documentation of the Emacs
3966 Convert the date at cursor into many other cultural and historic
3970 Show holidays for three month around the cursor date.
3973 Export a single iCalendar file containing entries from all agenda
3980 Quit agenda, remove the agenda buffer.
3983 Exit agenda, remove the agenda buffer and all buffers loaded by
3984 Emacs for the compilation of the agenda. Buffers created by the
3985 user to visit org files will not be removed.
3988 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3990 8.6 Custom agenda views
3991 =======================
3993 Custom agenda commands serve two purposes: to store and quickly access
3994 frequently used TODO and tags searches, and to create special composite
3995 agenda buffers. Custom agenda commands will be accessible through the
3996 dispatcher (*note Agenda dispatcher::), just like the default commands.
4000 * Storing searches:: Type once, use often
4001 * Block agenda:: All the stuff you need in a single buffer
4002 * Setting Options:: Changing the rules
4003 * Batch processing:: Agenda views from the command line
4006 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
4008 8.6.1 Storing searches
4009 ----------------------
4011 The first application of custom searches is the definition of keyboard
4012 shortcuts for frequently used searches, either creating an agenda
4013 buffer, or a sparse tree (the latter covering of course only the current
4014 buffer). Custom commands are configured in the variable
4015 `org-agenda-custom-commands'. You can customize this variable, for
4016 example by pressing `C-c a C'. You can also directly set it with Emacs
4017 Lisp in `.emacs'. The following example contains all valid search
4020 (setq org-agenda-custom-commands
4021 '(("w" todo "WAITING")
4022 ("W" todo-tree "WAITING")
4023 ("u" tags "+BOSS-URGENT")
4024 ("v" tags-todo "+BOSS-URGENT")
4025 ("U" tags-tree "+BOSS-URGENT")
4026 ("f" occur-tree "\\<FIXME\\>")))
4028 The initial single-character string in each entry defines the character
4029 you have to press after the dispatcher command `C-c a' in order to
4030 access the command. The second parameter is the search type, followed
4031 by the string or regular expression to be used for the matching. The
4032 example above will therefore define:
4035 as a global search for TODO entries with `WAITING' as the TODO
4039 as the same search, but only in the current buffer and displaying
4040 the results as a sparse tree
4043 as a global tags search for headlines marked `:BOSS:' but not
4047 as the same search as `C-c a u', but limiting the search to
4048 headlines that are also TODO items
4051 as the same search as `C-c a u', but only in the current buffer and
4052 displaying the result as a sparse tree
4055 to create a sparse tree (again: current buffer only) with all
4056 entries containing the word `FIXME'.
4059 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
4064 Another possibility is the construction of agenda views that comprise
4065 the results of _several_ commands, each of which creates a block in the
4066 agenda buffer. The available commands include `agenda' for the daily
4067 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
4068 todo list (as constructed with `C-c a t'), and the matching commands
4069 discussed above: `todo', `tags', and `tags-todo'. Here are two
4072 (setq org-agenda-custom-commands
4073 '(("h" "Agenda and Home-related tasks"
4077 ("o" "Agenda and Office-related tasks"
4082 This will define `C-c a h' to create a multi-block view for stuff you
4083 need to attend to at home. The resulting agenda buffer will contain
4084 your agenda for the current week, all TODO items that carry the tag
4085 `HOME', and also all lines tagged with `GARDEN'. Finally the command
4086 `C-c a o' provides a similar view for office tasks.
4089 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
4091 8.6.3 Setting Options for custom commands
4092 -----------------------------------------
4094 Org-mode contains a number of variables regulating agenda construction
4095 and display. The global variables define the behavior for all agenda
4096 commands, including the custom commands. However, if you want to change
4097 some settings just for a single custom view, you can do so. Setting
4098 options requires inserting a list of variable names and values at the
4099 right spot in `org-agenda-custom-commands'. For example:
4101 (setq org-agenda-custom-commands
4102 '(("w" todo "WAITING"
4103 ((org-agenda-sorting-strategy '(priority-down))
4104 (org-agenda-prefix-format " Mixed: ")))
4105 ("U" tags-tree "+BOSS-URGENT"
4106 ((org-show-following-heading nil)
4107 (org-show-hierarchy-above nil)))))
4109 Now the `C-c a w' command will sort the collected entries only by
4110 priority, and the prefix format is modified to just say ` Mixed:'
4111 instead of giving the category of the entry. The sparse tags tree of
4112 `C-c a U' will now turn out ultra-compact, because neither the headline
4113 hierarchy above the match, nor the headline following the match will be
4116 For command sets creating a block agenda,
4117 `org-agenda-custom-commands' has two separate spots for setting
4118 options. You can add options that should be valid for just a single
4119 command in the set, and options that should be valid for all commands in
4120 the set. The former are just added to the command entry, the latter
4121 must come after the list of command entries. Going back to the block
4122 agenda example (*note Block agenda::), let's change the sorting strategy
4123 for the `C-c a h' commands to `priority-down', but let's sort the
4124 results for GARDEN tags query in the opposite order, `priority-up'.
4125 This would look like this:
4127 (setq org-agenda-custom-commands
4128 '(("h" "Agenda and Home-related tasks"
4131 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
4132 ((org-agenda-sorting-strategy '(priority-down))))
4133 ("o" "Agenda and Office-related tasks"
4138 As you see, the values and parenthesis setting is a little complex.
4139 When in doubt, use the customize interface to set this variable - it
4140 fully supports its structure. Just one caveat: When setting options in
4141 this interface, the _values_ are just lisp expressions. So if the
4142 value is a string, you need to add the double quotes around the value
4146 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
4148 8.6.4 Creating agenda views in batch processing
4149 -----------------------------------------------
4151 If you want to print or otherwise reprocess agenda views, it can be
4152 useful to create an agenda from the command line. This is the purpose
4153 of the function `org-batch-agenda'. It takes as a parameter one of the
4154 strings that are the keys in `org-agenda-custom-commands'. For
4155 example, to directly print the current TODO list, you could use
4157 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4159 You may also modify parameters on the fly like this:
4161 emacs -batch -l ~/.emacs \
4162 -eval '(org-batch-agenda "a" \
4163 org-agenda-ndays 300 \
4164 org-agenda-include-diary nil \
4165 org-agenda-files (quote ("~/org/project.org")))' \
4168 which will produce a 300 day agenda, fully restricted to the Org file
4169 `~/org/projects.org', not even including the diary.
4172 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
4177 Plain ASCII is normally sufficient for almost all note taking. One
4178 exception, however, are scientific notes which need to be able to
4179 contain mathematical symbols and the occasional formula. LaTeX(1) is
4180 widely used to typeset scientific documents. Org-mode supports
4181 embedding LaTeX code into its files, because many academics are used to
4182 read LaTeX source code, and because it can be readily processed into
4183 images for HTML production.
4185 It is not necessary to mark LaTeX macros and code in any special way.
4186 If you observe a few conventions, Org-mode knows how to find it and what
4191 * Math symbols:: TeX macros for symbols and Greek letters
4192 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
4193 * LaTeX fragments:: Complex formulas made easy
4194 * Processing LaTeX fragments:: Previewing LaTeX processing
4195 * CDLaTeX mode:: Speed up entering of formulas
4197 ---------- Footnotes ----------
4199 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4200 Many of the features described here as "LaTeX" are really from TeX, but
4201 for simplicity I am blurring this distinction.
4204 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
4209 You can use LaTeX macros to insert special symbols like `\alpha' to
4210 indicate the Greek letter, or `\to' to indicate an arrow. Completion
4211 for these macros is available, just type `\' and maybe a few letters,
4212 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
4213 Org-mode allows these macros to be present without surrounding math
4214 delimiters, for example:
4216 Angles are written as Greek letters \alpha, \beta and \gamma.
4218 During HTML export (*note HTML export::), these symbols are
4219 translated into the proper syntax for HTML, for the above examples this
4220 is `α' and `→', respectively.
4223 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
4225 9.2 Subscripts and Superscripts
4226 ===============================
4228 Just like in LaTeX, `^' and `_' are used to indicate super- and
4229 subscripts. Again, these can be used without embedding them in
4230 math-mode delimiters. To increase the readability of ASCII text, it is
4231 not necessary (but OK) to surround multi-character sub- and superscripts
4232 with curly braces. For example
4234 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
4235 the sun is R_{sun} = 6.96 x 10^8 m.
4237 To avoid interpretation as raised or lowered text, you can quote `^'
4238 and `_' with a backslash: `\_' and `\^'.
4240 During HTML export (*note HTML export::), subscript and superscripts
4241 are surrounded with `<sub>' and `<sup>' tags, respectively.
4244 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
4249 With symbols, sub- and superscripts, HTML is pretty much at its end when
4250 it comes to representing mathematical formulas(1). More complex
4251 expressions need a dedicated formula processor. To this end, Org-mode
4252 can contain arbitrary LaTeX fragments. It provides commands to preview
4253 the typeset result of these fragments, and upon export to HTML, all
4254 fragments will be converted to images and inlined into the HTML
4255 document. For this to work you need to be on a system with a working
4256 LaTeX installation. You also need the `dvipng' program, available at
4257 `http://sourceforge.net/projects/dvipng/'.
4259 LaTeX fragments don't need any special marking at all. The following
4260 snippets will be identified as LaTeX source code:
4261 * Environments of any kind. The only requirement is that the
4262 `\begin' statement appears on a new line, preceded by only
4265 * Text within the usual LaTeX math delimiters. To avoid conflicts
4266 with currency specifications, single `$' characters are only
4267 recognized as math delimiters if the enclosed text contains at
4268 most two line breaks, is directly attached to the `$' characters
4269 with no whitespace in between, and if the closing `$' is followed
4270 by whitespace or punctuation. For the other delimiters, there is
4271 no such restriction, so when in doubt, use `\(...\)' as inline
4276 \begin{equation} % arbitrary environments,
4277 x=\sqrt{b} % even tables, figures
4278 \end{equation} % etc
4280 If $a^2=b$ and \( b=2 \), then the solution must be
4281 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4283 If you need any of the delimiter ASCII sequences for other purposes, you
4284 can configure the option `org-format-latex-options' to deselect the
4285 ones you do not wish to have interpreted by the LaTeX converter.
4287 ---------- Footnotes ----------
4289 (1) Yes, there is MathML, but that is not yet fully supported by
4290 many browsers, and there is no decent converter for turning LaTeX of
4291 ASCII representations of formulas into MathML. So for the time being,
4292 converting formulas into images seems the way to go.
4295 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
4297 9.4 Processing LaTeX fragments
4298 ==============================
4300 LaTeX fragments can be processed to produce a preview images of the
4301 typeset expressions:
4304 Produce a preview image of the LaTeX fragment at point and overlay
4305 it over the source code. If there is no fragment at point,
4306 process all fragments in the current entry (between two
4307 headlines). When called with a prefix argument, process the
4308 entire subtree. When called with two prefix arguments, or when
4309 the cursor is before the first headline, process the entire buffer.
4312 Remove the overlay preview images.
4314 During HTML export (*note HTML export::), all LaTeX fragments are
4315 converted into images and inlined into the document if the following
4318 (setq org-export-with-LaTeX-fragments t)
4321 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
4323 9.5 Using CDLaTeX to enter math
4324 ===============================
4326 CDLaTeX-mode is a minor mode that is normally used in combination with a
4327 major LaTeX mode like AUCTeX in order to speed-up insertion of
4328 environments and math templates. Inside Org-mode, you can make use of
4329 some of the features of cdlatex-mode. You need to install `cdlatex.el'
4330 and `texmathp.el' (the latter comes also with AUCTeX) from
4331 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
4332 cdlatex-mode itself under Org-mode, but use the light version
4333 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
4334 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4337 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4339 When this mode is enabled, the following features are present (for
4340 more details see the documentation of cdlatex-mode):
4341 * Environment templates can be inserted with `C-c {'.
4343 * The <TAB> key will do template expansion if the cursor is inside a
4344 LaTeX fragment(1). For example, <TAB> will expand `fr' to
4345 `\frac{}{}' and position the cursor correctly inside the first
4346 brace. Another <TAB> will get you into the second brace. Even
4347 outside fragments, <TAB> will expand environment abbreviations at
4348 the beginning of a line. For example, if you write `equ' at the
4349 beginning of a line and press <TAB>, this abbreviation will be
4350 expanded to an `equation' environment. To get a list of all
4351 abbreviations, type `M-x cdlatex-command-help'.
4353 * Pressing `_' and `^' inside a LaTeX fragment will insert these
4354 characters together with a pair of braces. If you use <TAB> to
4355 move out of the braces, and if the braces surround only a single
4356 character or macro, they are removed again (depending on the
4357 variable `cdlatex-simplify-sub-super-scripts').
4359 * Pressing the backquote ``' followed by a character inserts math
4360 macros, also outside LaTeX fragments. If you wait more than 1.5
4361 seconds after the backquote, a help window will pop up.
4363 * Pressing the normal quote `'' followed by another character
4364 modifies the symbol before point with an accent or a font. If you
4365 wait more than 1.5 seconds after the backquote, a help window will
4366 pop up. Character modification will work only inside LaTeX
4367 fragments, outside the quote is normal.
4369 ---------- Footnotes ----------
4371 (1) Org-mode has a method to test if the cursor is inside such a
4372 fragment, see the documentation of the function
4373 `org-inside-LaTeX-fragment-p'.
4376 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
4381 Org-mode documents can be exported into a variety of other formats. For
4382 printing and sharing of notes, ASCII export produces a readable and
4383 simple version of an Org-mode file. HTML export allows you to publish a
4384 notes file on the web, while the XOXO format provides a solid base for
4385 exchange with a broad range of other applications. To incorporate
4386 entries with associated times like deadlines or appointments into a
4387 desktop calendar program like iCal, Org-mode can also produce extracts
4388 in the iCalendar format. Currently Org-mode only supports export, not
4389 import of these different formats.
4391 When exporting, Org-mode uses special conventions to enrich the
4392 output produced. *Note Text interpretation::, for more details.
4395 Dispatcher for export and publishing commands. Displays a
4396 help-window listing the additional key(s) needed to launch an
4397 export or publishing command.
4401 * ASCII export:: Exporting to plain ASCII
4402 * HTML export:: Exporting to HTML
4403 * XOXO export:: Exporting to XOXO
4404 * iCalendar export:: Exporting in iCalendar format
4405 * Text interpretation:: How the exporter looks at the file
4408 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4413 ASCII export produces a simple and very readable version of an Org-mode
4417 Export as ASCII file. If there is an active region, only the
4418 region will be exported. For an org file `myfile.org', the ASCII
4419 file will be `myfile.txt'. The file will be overwritten without
4423 Export only the visible part of the document.
4425 In the exported version, the first 3 outline levels will become
4426 headlines, defining a general document structure. Additional levels
4427 will be exported as itemized lists. If you want that transition to
4428 occur at a different level, specify it with a prefix argument. For
4433 creates only top level headlines and does the rest as items. When
4434 headlines are converted to items, the indentation of the text following
4435 the headline is changed to fit nicely under the item. This is done with
4436 the assumption that the first bodyline indicates the base indentation of
4437 the body text. Any indentation larger than this is adjusted to preserve
4438 the layout relative to the first line. Should there be lines with less
4439 indentation than the first, these are left alone.
4442 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4447 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4448 HTML formatting, in ways similar to John Grubers _markdown_ language,
4449 but with additional support for tables.
4453 * Export commands:: How to invoke HTML export
4454 * Quoting HTML tags:: Using direct HTML in Org-mode
4455 * Links:: How hyperlinks get transferred to HTML
4456 * Images:: To inline or not to inline?
4457 * CSS support:: Style specifications
4460 File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
4462 10.2.1 HTML export commands
4463 ---------------------------
4466 Export as HTML file `myfile.html'.
4469 Export as HTML file and open it with a browser.
4472 Export to a temporary buffer, do not create a file.
4479 Export only the visible part of the document.
4481 In the exported version, the first 3 outline levels will become
4482 headlines, defining a general document structure. Additional levels
4483 will be exported as itemized lists. If you want that transition to
4484 occur at a different level, specify it with a prefix argument. For
4489 creates two levels of headings and does the rest as items.
4492 File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
4494 10.2.2 Quoting HTML tags
4495 ------------------------
4497 Plain `<' and `>' are always transformed to `<' and `>' in HTML
4498 export. If you want to include simple HTML tags which should be
4499 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
4500 Note that this really works only for simple tags. For more extensive
4501 HTML that should be copied verbatim to the exported file use either
4503 #+HTML: Literal HTML code for export
4508 All lines between these markers are exported literally
4512 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
4517 Internal links (*note Internal links::) will continue to work in HTML
4518 files only if they match a dedicated `<<target>>'. Automatic links
4519 created by radio targets (*note Radio targets::) will also work in the
4520 HTML file. Links to external files will still work if the HTML file is
4521 in the same directory as the Org-mode file. Links to other `.org'
4522 files will be translated into HTML links under the assumption that an
4523 HTML version also exists of the linked file. For information related to
4524 linking files while publishing them to a publishing directory see *Note
4528 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
4533 HTML export can inline images given as links in the Org-mode file, and
4534 it can make an image the clickable part of a link. By default(1),
4535 images are inlined if a link does not have a description. So
4536 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4537 image]]' will just produce a link `the image' that points to the image.
4538 If the description part itself is a `file:' link or a `http:' URL
4539 pointing to an image, this image will be inlined and activated so that
4540 clicking on the image will activate the link. For example, to include
4541 a thumbnail that will link to a high resolution version of the image,
4544 [[file:highres.jpg][file:thumb.jpg]]
4546 and you could use `http' addresses just as well.
4548 ---------- Footnotes ----------
4550 (1) but see the variable `org-export-html-inline-images'
4553 File: org, Node: CSS support, Prev: Images, Up: HTML export
4558 You can also give style information for the exported file. The HTML
4559 exporter assigns the following CSS classes to appropriate parts of the
4560 document - your style specifications may change these:
4562 .done the DONE keyword
4563 .timestamp time stamp
4564 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4565 .tag tag in a headline
4566 .target target for links
4568 The default style specification can be configured through the option
4569 `org-export-html-style'. If you want to use a file-local style, you
4570 may use file variables, best wrapped into a COMMENT section at the end
4571 of the outline tree. For example(1):
4573 * COMMENT html style specifications
4576 # org-export-html-style: " <style type=\"text/css\">
4577 # p {font-weight: normal; color: gray; }
4578 # h1 {color: black; }
4582 Remember to execute `M-x normal-mode' after changing this to make
4583 the new style visible to Emacs. This command restarts org-mode for the
4584 current buffer and forces Emacs to re-evaluate the local variables
4585 section in the buffer.
4587 ---------- Footnotes ----------
4589 (1) Under Emacs 21, the continuation lines for a variable value
4590 should have no `#' at the start of the line.
4593 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4598 Org-mode contains an exporter that produces XOXO-style output.
4599 Currently, this exporter only handles the general outline structure and
4600 does not interpret any additional Org-mode features.
4603 Export as XOXO file `myfile.html'.
4606 Export only the visible part of the document.
4609 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4611 10.4 iCalendar export
4612 =====================
4614 Some people like to use Org-mode for keeping track of projects, but
4615 still prefer a standard calendar application for anniversaries and
4616 appointments. In this case it can be useful to have deadlines and
4617 other time-stamped items in Org-mode files show up in the calendar
4618 application. Org-mode can export calendar information in the standard
4619 iCalendar format. If you also want to have TODO entries included in the
4620 export, configure the variable `org-icalendar-include-todo'.
4623 Create iCalendar entries for the current file and store them in
4624 the same directory, using a file extension `.ics'.
4627 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4628 For each of these files, a separate iCalendar file will be
4632 Create a single large iCalendar file from all files in
4633 `org-agenda-files' and write it to the file given by
4634 `org-combined-agenda-icalendar-file'.
4636 How this calendar is best read and updated, depends on the
4637 application you are using. The FAQ covers this issue.
4640 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4642 10.5 Text interpretation by the exporter
4643 ========================================
4645 The exporter backends interpret additional structure in the Org-mode
4646 file in order to produce better output.
4650 * Comment lines:: Some lines will not be exported
4651 * Initial text:: Text before the first headline
4652 * Enhancing text:: Subscripts, symbols and more
4653 * Export options:: How to influence the export settings
4656 File: org, Node: Comment lines, Next: Initial text, Prev: Text interpretation, Up: Text interpretation
4658 10.5.1 Comment lines
4659 --------------------
4661 Lines starting with `#' in column zero are treated as comments and will
4662 never be exported. Also entire subtrees starting with the word
4663 `COMMENT' will never be exported.
4666 Toggle the COMMENT keyword at the beginning of an entry.
4669 File: org, Node: Initial text, Next: Enhancing text, Prev: Comment lines, Up: Text interpretation
4671 10.5.2 Text before the first headline
4672 -------------------------------------
4674 Org-mode normally ignores any text before the first headline when
4675 exporting, leaving this region for internal links to speed up navigation
4676 etc. However, in publishing-oriented files, you might want to have some
4677 text before the first headline, like a small introduction, special HTML
4678 code with a navigation bar, etc. You can ask to have this part of the
4679 file exported as well by setting the variable
4680 `org-export-skip-text-before-1st-heading' to `nil'. On a per-file
4681 basis, you can get the same effect with
4685 The text before the first headline will be fully processed (*note
4686 Enhancing text::), and the first non-comment line becomes the title of
4687 the exported document. If you need to include literal HTML, use the
4688 special constructs described in *Note Quoting HTML tags::. The table
4689 of contents is normally inserted directly before the first headline of
4690 the file. If you would like to get it to a different location, insert
4691 the string `[TABLE-OF-CONTENTS]' on a line by itself at the desired
4694 Finally, if you want to use the space before the first headline for
4695 internal purposes, but _still_ want to place something before the first
4696 headline when exporting the file, you can use the `#+TEXT' construct:
4699 #+TEXT: This text will go before the *first* headline.
4700 #+TEXT: We place the table of contents here:
4701 #+TEXT: [TABLE-OF-CONTENTS]
4702 #+TEXT: This goes between the table of contents and the first headline
4705 File: org, Node: Enhancing text, Next: Export options, Prev: Initial text, Up: Text interpretation
4707 10.5.3 Enhancing text for export
4708 --------------------------------
4710 Some of the export backends of Org-mode allow for sophisticated text
4711 formatting, this is true in particular for the HTML backend. Org-mode
4712 has a number of typing conventions that allow to produce a richly
4715 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4716 enumerator will be recognized and transformed if the backend
4717 supports lists. See *Note Plain lists::.
4719 * You can make words *bold*, /italic/, _underlined_, `=code=', and
4720 even `+strikethrough+'(1).
4722 * A line consisting of only dashes, and at least 5 of them, will be
4723 exported as a horizontal line (`<hr/>' in HTML).
4725 * Many TeX macros and entire LaTeX fragments are converted into HTML
4726 entities or images (*note Embedded LaTeX::).
4728 * Tables are transformed into native tables under the exporter, if
4729 the export backend supports this. Data fields before the first
4730 horizontal separator line will be formatted as table header fields.
4732 * If a headline starts with the word `QUOTE', the text below the
4733 headline will be typeset as fixed-width, to allow quoting of
4734 computer codes etc. Lines starting with `:' are also typeset in
4737 Toggle fixed-width for entry (QUOTE) or region, see below.
4739 * A double backslash _at the end of a line_ enforces a line break at
4742 If these conversions conflict with your habits of typing ASCII text,
4743 they can all be turned off with corresponding variables. See the
4744 customization group `org-export-general', and the following section
4745 which explains how to set export options with special lines in a buffer.
4747 ---------- Footnotes ----------
4749 (1) but remember that strikethrough is typographically evil and
4750 should never be used.
4753 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
4755 10.5.4 Export options
4756 ---------------------
4758 The exporter recognizes special lines in the buffer which provide
4759 additional information. These lines may be put anywhere in the file.
4760 The whole set of lines can be inserted into the buffer with `C-c C-e
4761 t'. For individual lines, a good way to make sure the keyword is
4762 correct is to type `#+' and then use `M-<TAB>' completion (*note
4766 Insert template with export options, see example below.
4768 #+TITLE: the title to be shown (default is the buffer name)
4769 #+AUTHOR: the author (default taken from `user-full-name')
4770 #+EMAIL: his/her email address (default from `user-mail-address')
4771 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
4772 #+TEXT: Some descriptive text to be inserted at the beginning.
4773 #+TEXT: Several lines may be given.
4774 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t skip:t
4776 The OPTIONS line is a compact form to specify export settings. Here
4778 H: set the number of headline levels for export
4779 num: turn on/off section-numbers
4780 toc: turn on/off table of contents, or set level limit (integer)
4781 \n: turn on/off linebreak-preservation
4782 @: turn on/off quoted HTML tags
4783 :: turn on/off fixed-width sections
4784 |: turn on/off tables
4785 ^: turn on/off TeX-like syntax for sub- and superscripts. If
4786 you write "^:{}", `a_{b}' will be interpreted, but
4787 the simple `a_b' will be left as it is.
4788 *: turn on/off emphasized text (bold, italic, underlined)
4789 TeX: turn on/off simple TeX macros in plain text
4790 LaTeX: turn on/off LaTeX fragments
4791 skip: turn on/off skipping the text before the first heading
4794 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
4799 Org-mode includes(1) a publishing management system that allows you to
4800 configure automatic HTML conversion of _projects_ composed of
4801 interlinked org files. This system is called _org-publish_. You can
4802 also configure org-publish to automatically upload your exported HTML
4803 pages and related attachments, such as images and source code files, to
4804 a web server. Org-publish turns org-mode into a web-site authoring
4807 Org-publish has been contributed to Org-mode by David O'Toole.
4811 * Configuration:: Defining projects
4812 * Sample configuration:: Example projects
4813 * Triggering publication:: Publication commands
4815 ---------- Footnotes ----------
4817 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4818 `org.el' as it comes with Emacs, you need to download this file
4819 separately. Also make sure org.el is at least version 4.27.
4822 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4827 Publishing needs significant configuration to specify files, destination
4828 and many other properties of a project.
4832 * Project alist:: The central configuration variable
4833 * Sources and destinations:: From here to there
4834 * Selecting files:: What files are part of the project?
4835 * Publishing action:: Setting the function doing the publishing
4836 * Publishing options:: Tweaking HTML export
4837 * Publishing links:: Which links keep working after publishing?
4838 * Project page index:: Publishing a list of project files
4841 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4843 11.1.1 The variable `org-publish-project-alist'
4844 -----------------------------------------------
4846 Org-publish is configured almost entirely through setting the value of
4847 one variable, called `org-publish-project-alist'. Each element of the
4848 list configures one project, and may be in one of the two following
4851 ("project-name" :property value :property value ...)
4855 ("project-name" :components ("project-name" "project-name" ...))
4857 In both cases, projects are configured by specifying property values.
4858 A project defines the set of files that will be published, as well as
4859 the publishing configuration to use when publishing those files. When
4860 a project takes the second form listed above, the individual members of
4861 the "components" property are taken to be components of the project,
4862 which group together files requiring different publishing options. When
4863 you publish such a "meta-project" all the components will also publish.
4866 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4868 11.1.2 Sources and destinations for files
4869 -----------------------------------------
4871 Most properties are optional, but some should always be set. In
4872 particular, org-publish needs to know where to look for source files,
4873 and where to put published files.
4875 `:base-directory' Directory containing publishing source files
4876 `:publishing-directory'Directory (possibly remote) where output files
4878 `:preparation-function'Function called before starting publishing
4879 process, for example to run `make' for updating
4880 files to be published.
4883 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4885 11.1.3 Selecting files
4886 ----------------------
4888 By default, all files with extension `.org' in the base directory are
4889 considered part of the project. This can be modified by setting the
4891 `:base-extension' Extension (without the dot!) of source files. This
4892 actually is a regular expression.
4893 `:exclude' Regular expression to match file names that should
4894 not be published, even though they have been selected
4895 on the basis of their extension.
4896 `:include' List of files to be included regardless of
4897 `:base-extension' and `:exclude'.
4900 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4902 11.1.4 Publishing Action
4903 ------------------------
4905 Publishing means that a file is copied to the destination directory and
4906 possibly transformed in the process. The default transformation is to
4907 export Org-mode files as HTML files, and this is done by the function
4908 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4909 export::). Other files like images only need to be copied to the
4910 publishing destination. For non-Org-mode files, you need to specify
4911 the publishing function.
4913 `:publishing-function' Function executing the publication of a file.
4914 This may also be a list of functions, which will
4915 all be called in turn.
4917 The function must accept two arguments: a property list containing at
4918 least a `:publishing-directory' property, and the name of the file to
4919 be published. It should take the specified file, make the necessary
4920 transformation (if any) and place the result into the destination
4921 folder. You can write your own publishing function, but `org-publish'
4922 provides one for attachments (files that only need to be copied):
4923 `org-publish-attachment'.
4926 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4928 11.1.5 Options for the HTML exporter
4929 ------------------------------------
4931 The property list can be used to set many export options for the HTML
4932 exporter. In most cases, these properties correspond to user variables
4933 in Org-mode. The table below lists these properties along with the
4934 variable they belong to. See the documentation string for the
4935 respective variable for details.
4937 `:language' `org-export-default-language'
4938 `:headline-levels' `org-export-headline-levels'
4939 `:section-numbers' `org-export-with-section-numbers'
4940 `:table-of-contents' `org-export-with-toc'
4941 `:archived-trees' `org-export-with-archived-trees'
4942 `:emphasize' `org-export-with-emphasize'
4943 `:sub-superscript' `org-export-with-sub-superscripts'
4944 `:TeX-macros' `org-export-with-TeX-macros'
4945 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4946 `:fixed-width' `org-export-with-fixed-width'
4947 `:timestamps' `org-export-with-timestamps'
4949 `:tags' `org-export-with-tags'
4951 `:tables' `org-export-with-tables'
4952 `:table-auto-headline' `org-export-highlight-first-table-line'
4953 `:style' `org-export-html-style'
4954 `:convert-org-links' `org-export-html-link-org-files-as-html'
4955 `:inline-images' `org-export-html-inline-images'
4956 `:expand-quoted-html' `org-export-html-expand'
4957 `:timestamp' `org-export-html-with-timestamp'
4958 `:publishing-directory'`org-export-publishing-directory'
4959 `:preamble' `org-export-html-preamble'
4960 `:postamble' `org-export-html-postamble'
4961 `:auto-preamble' `org-export-html-auto-preamble'
4962 `:auto-postamble' `org-export-html-auto-postamble'
4963 `:author' `user-full-name'
4964 `:email' `user-mail-address'
4966 When a property is given a value in org-publish-project-alist, its
4967 setting overrides the value of the corresponding user variable (if any)
4968 during publishing. options set within a file (*note Export options::),
4969 however, override everything.
4972 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4974 11.1.6 Links between published files
4975 ------------------------------------
4977 To create a link from one Org-mode file to another, you would use
4978 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4979 (*note Hyperlinks::). Upon publishing this link becomes a link to
4980 `foo.html'. In this way, you can interlink the pages of your "org web"
4981 project and the links will work as expected when you publish them to
4984 You may also link to related files, such as images. Provided you are
4985 careful with relative pathnames, and provided you have also configured
4986 org-publish to upload the related files, these links will work too.
4987 *Note Complex example:: for an example of this usage.
4989 Sometime an Org-mode file to be published may contain links that are
4990 only valid in your production environment, but not in the publishing
4991 location. In this case, use the property
4993 `:link-validation-function' Function to validate links
4995 to define a function for checking link validity. This function must
4996 accept two arguments, the file name and a directory relative to which
4997 the file name is interpreted in the production environment. If this
4998 function returns `nil', then the HTML generator will only insert a
4999 description into the HTML file, but no link. One option for this
5000 function is `org-publish-validate-link' which checks if the given file
5001 is part of any project in `org-publish-project-alist'.
5004 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
5006 11.1.7 Project page index
5007 -------------------------
5009 The following properties may be used to control publishing of an index
5010 of files or summary page for a given project.
5012 `:auto-index' When non-nil, publish an index during
5013 org-publish-current-project or org-publish-all.
5014 `:index-filename' Filename for output of index. Defaults to `index.org'
5015 (which becomes `index.html').
5016 `:index-title' Title of index page. Defaults to name of file.
5017 `:index-function' Plugin function to use for generation of index.
5018 Defaults to `org-publish-org-index', which generates
5019 a plain list of links to all files in the project.
5022 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
5024 11.2 Sample configuration
5025 =========================
5027 Below we provide two example configurations. The first one is a simple
5028 project publishing only a set of Org-mode files. The second example is
5029 more complex, with a multi-component project.
5033 * Simple example:: One-component publishing
5034 * Complex example:: A multi-component publishing example
5037 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
5039 11.2.1 Example: simple publishing configuration
5040 -----------------------------------------------
5042 This example publishes a set of Org-mode files to the `public_html'
5043 directory on the local machine.
5045 (setq org-publish-project-alist
5047 :base-directory "~/org/"
5048 :publishing-directory "~/public_html"
5049 :section-numbers nil
5050 :table-of-contents nil
5051 :style "<link rel=stylesheet
5052 href=\"../other/mystyle.css\"
5053 type=\"text/css\">")))
5056 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
5058 11.2.2 Example: complex publishing configuration
5059 ------------------------------------------------
5061 This more complicated example publishes an entire website, including
5062 org files converted to HTML, image files, emacs lisp source code, and
5063 stylesheets. The publishing-directory is remote and private files are
5066 To ensure that links are preserved, care should be taken to replicate
5067 your directory structure on the web server, and to use relative file
5068 paths. For example, if your org files are kept in `~/org' and your
5069 publishable images in `~/images', you'd link to an image with
5070 file:../images/myimage.png
5071 On the web server, the relative path to the image should be the
5072 same. You can accomplish this by setting up an "images" folder in the
5073 right place on the webserver, and publishing images to it.
5075 (setq org-publish-project-alist
5077 :base-directory "~/org/"
5078 :base-extension "org"
5079 :publishing-directory "/ssh:user@host:~/html/notebook/"
5080 :publishing-function org-publish-org-to-html
5081 :exclude "PrivatePage.org" ;; regexp
5083 :section-numbers nil
5084 :table-of-contents nil
5085 :style "<link rel=stylesheet
5086 href=\"../other/mystyle.css\" type=\"text/css\">"
5088 :auto-postamble nil)
5091 :base-directory "~/images/"
5092 :base-extension "jpg\\|gif\\|png"
5093 :publishing-directory "/ssh:user@host:~/html/images/"
5094 :publishing-function org-publish-attachment)
5097 :base-directory "~/other/"
5098 :base-extension "css\\|el"
5099 :publishing-directory "/ssh:user@host:~/html/other/"
5100 :publishing-function org-publish-attachment)
5101 ("website" :components ("orgfiles" "images" "other"))))
5104 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
5106 11.3 Triggering publication
5107 ===========================
5109 Once org-publish is properly configured, you can publish with the
5110 following functions:
5113 Prompt for a specific project and publish all files that belong to
5117 Publish the project containing the current file.
5120 Publish only the current file.
5123 Publish all projects.
5125 Org uses timestamps to track when a file has changed. The above
5126 functions normally only publish changed files. You can override this and
5127 force publishing of all files by giving a prefix argument.
5130 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
5137 * Completion:: M-TAB knows what you need
5138 * Customization:: Adapting Org-mode to your taste
5139 * In-buffer settings:: Overview of the #+KEYWORDS
5140 * The very busy C-c C-c key:: When in doubt, press C-c C-c
5141 * Clean view:: Getting rid of leading stars in the outline
5142 * TTY keys:: Using Org-mode on a tty
5143 * Interaction:: Other Emacs packages
5144 * Bugs:: Things which do not work perfectly
5147 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
5152 Org-mode supports in-buffer completion. This type of completion does
5153 not make use of the minibuffer. You simply type a few letters into the
5154 buffer and use the key to complete text right there.
5157 Complete word at point
5158 * At the beginning of a headline, complete TODO keywords.
5160 * After `\', complete TeX symbols supported by the exporter.
5162 * After `*', complete headlines in the current buffer so that
5163 they can be used in search links like `[[*find this
5166 * After `:', complete tags. The list of tags is taken from the
5167 variable `org-tag-alist' (possibly set through the `#+TAGS'
5168 in-buffer option, *note Setting tags::), or it is created
5169 dynamically from all tags used in the current buffer.
5171 * After `[', complete link abbreviations (*note Link
5174 * After `#+', complete the special keywords like `TYP_TODO' or
5175 `OPTIONS' which set file-specific options for Org-mode. When
5176 the option keyword is already complete, pressing `M-<TAB>'
5177 again will insert example settings for this keyword.
5179 * In the line after `#+STARTUP: ', complete startup keywords,
5180 i.e. valid keys for this line.
5182 * Elsewhere, complete dictionary words using ispell.
5185 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
5190 There are more than 180 variables that can be used to customize
5191 Org-mode. For the sake of compactness of the manual, I am not
5192 describing the variables here. A structured overview of customization
5193 variables is available with `M-x org-customize'. Or select `Browse Org
5194 Group' from the `Org->Customization' menu. Many settings can also be
5195 activated on a per-file basis, by putting special lines into the buffer
5196 (*note In-buffer settings::).
5199 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
5201 12.3 Summary of in-buffer settings
5202 ==================================
5204 Org-mode uses special lines in the buffer to define settings on a
5205 per-file basis. These lines start with a `#+' followed by a keyword, a
5206 colon, and then individual words defining a setting. Several setting
5207 words can be in the same line, but you can also have multiple lines for
5208 the keyword. While these settings are described throughout the manual,
5209 here is a summary. After changing any of those lines in the buffer,
5210 press `C-c C-c' with the cursor still in the line to activate the
5211 changes immediately. Otherwise they become effective only when the
5212 file is visited again in a new Emacs session.
5215 This line sets options to be used at startup of org-mode, when an
5216 Org-mode file is being visited. The first set of options deals
5217 with the initial visibility of the outline tree. The
5218 corresponding variable for global default settings is
5219 `org-startup-folded', with a default value `t', which means
5221 overview top-level headlines only
5222 content all headlines
5223 showall no folding at all, show everything
5224 Then there are options for aligning tables upon visiting a file.
5225 This is useful in files containing narrowed table columns. The
5226 corresponding variable is `org-startup-align-all-tables', with a
5227 default value `nil'.
5228 align align all tables
5229 noalign don't align tables on startup
5230 Logging TODO state changes and clock intervals (variable
5231 `org-log-done') can be configured using these options.
5232 logging record a timestamp when an item is marked DONE
5233 nologging don't record when items are marked DONE
5234 lognotedone record timestamp and a note when DONE
5235 lognotestate record timestamp, note when TODO state changes
5236 lognoteclock-out record timestamp and a note when clocking out
5237 Here are the options for hiding leading stars in outline headings.
5238 The corresponding variables are `org-hide-leading-stars' and
5239 `org-odd-levels-only', both with a default setting `nil' (meaning
5240 `showstars' and `oddeven').
5241 hidestars make all but one of the stars starting a headline invisible.
5242 showstars show all stars starting a headline
5243 odd allow only odd outline levels (1,3,...)
5244 oddeven allow all outline levels
5245 To turn on custom format overlays over time stamps (variables
5246 `org-put-time-stamp-overlays' and
5247 `org-time-stamp-overlay-formats'), use
5248 customtime overlay custom time format
5249 The following options influence the table spreadsheet (variable
5250 `constants-unit-system').
5251 constcgs `constants.el' should use the c-g-s unit system
5252 constSI `constants.el' should use the SI unit system
5254 `#+SEQ_TODO: #+TYP_TODO:'
5255 These lines set the TODO keywords and their interpretation in the
5256 current file. The corresponding variables are `org-todo-keywords'
5257 and `org-todo-interpretation'.
5259 `#+TAGS: TAG1(c1) TAG2(c2)'
5260 These lines (several such lines are allowed) specify the legal
5261 tags in this file, and (potentially) the corresponding _fast tag
5262 selection_ keys. The corresponding variable is `org-tag-alist'.
5264 `#+LINK: linkword replace'
5265 These lines (several are allowed) specify link abbreviations.
5266 *Note Link abbreviations::. The corresponding variable is
5267 `org-link-abbrev-alist'.
5270 This line sets the category for the agenda file. The category
5271 applies for all subsequent lines until the next `#+CATEGORY' line,
5272 or the end of the file. The first such line also applies to any
5275 `#+ARCHIVE: %s_done::'
5276 This line sets the archive location for the agenda file. It
5277 applies for all subsequent lines until the next `#+CATEGORY' line,
5278 or the end of the file. The first such line also applies to any
5279 entries before it. The corresponding variable is
5280 `org-archive-location'.
5283 This line contains the formulas for the table directly above the
5286 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5287 These lines provide settings for exporting files. For more
5288 details see *Note Export options::.
5291 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
5293 12.4 The very busy C-c C-c key
5294 ==============================
5296 The key `C-c C-c' has many purposes in org-mode, which are all
5297 mentioned scattered throughout this manual. One specific function of
5298 this key is to add _tags_ to a headline (*note Tags::). In many other
5299 circumstances it means something like _Hey Org-mode, look here and
5300 update according to what you see here_. Here is a summary of what this
5301 means in different contexts.
5303 - If there are highlights in the buffer from the creation of a sparse
5304 tree, or from clock display, remove these highlights.
5306 - If the cursor is in one of the special `#+KEYWORD' lines, this
5307 triggers scanning the buffer for these lines and updating the
5310 - If the cursor is inside a table, realign the table. This command
5311 works even if the automatic table editor has been turned off.
5313 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5316 - If the cursor is inside a table created by the `table.el' package,
5317 activate that table.
5319 - If the current buffer is a remember buffer, close the note and
5320 file it. With a prefix argument, file it, without further
5321 interaction, to the default location.
5323 - If the cursor is on a `<<<target>>>', update radio targets and
5324 corresponding links in this buffer.
5326 - If the cursor is in a plain list item with a checkbox, toggle the
5327 status of the checkbox.
5329 - If the cursor is on a numbered item in a plain list, renumber the
5333 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
5335 12.5 A cleaner outline view
5336 ===========================
5338 Some people find it noisy and distracting that the Org-mode headlines
5339 are starting with a potentially large number of stars. For example the
5340 tree from *Note Headlines:::
5342 * Top level headline
5348 * Another top level headline
5350 Unfortunately this is deeply ingrained into the code of Org-mode and
5351 cannot be easily changed. You can, however, modify the display in such
5352 a way that all leading stars become invisible and the outline more easy
5353 to read. To do this, customize the variable `org-hide-leading-stars'
5356 (setq org-hide-leading-stars t)
5358 or change this on a per-file basis with one of the lines (anywhere in
5361 #+STARTUP: showstars
5362 #+STARTUP: hidestars
5364 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5367 With stars hidden, the tree becomes:
5369 * Top level headline
5375 * Another top level headline
5377 Note that the leading stars are not truly replaced by whitespace, they
5378 are only fontified with the face `org-hide' that uses the background
5379 color as font color. If you are not using either white or black
5380 background, you may have to customize this face to get the wanted
5381 effect. Another possibility is to set this font such that the extra
5382 stars are almost invisible, for example using the color `grey90' on a
5385 Things become cleaner still if you skip all the even levels and use
5386 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5387 outline level to the next:
5389 * Top level headline
5395 * Another top level headline
5397 In order to make the structure editing and export commands handle this
5398 convention correctly, use
5400 (setq org-odd-levels-only t)
5402 or set this on a per-file basis with one of the following lines (don't
5403 forget to press `C-c C-c' with the cursor in the startup line to
5404 activate changes immediately).
5409 You can convert an Org-mode file from single-star-per-level to the
5410 double-star-per-level convention with `M-x org-convert-to-odd-levels
5411 RET' in that file. The reverse operation is `M-x
5412 org-convert-to-oddeven-levels'.
5415 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
5417 12.6 Using org-mode on a tty
5418 ============================
5420 Org-mode uses a number of keys that are not accessible on a tty. This
5421 applies to most special keys like cursor keys, <TAB> and <RET>, when
5422 these are combined with modifier keys like <Meta> and/or <Shift>.
5423 Org-mode uses these bindings because it needs to provide keys for a
5424 large number of commands, and because these keys appeared particularly
5425 easy to remember. In order to still be able to access the core
5426 functionality of Org-mode on a tty, alternative bindings are provided.
5427 Here is a complete list of these bindings, which are obviously more
5428 cumbersome to use. Note that sometimes a work-around can be better.
5429 For example changing a time stamp is really only fun with `S-<cursor>'
5430 keys. On a tty you would rather use `C-c .' to re-insert the
5433 Default Alternative 1 Alternative 2
5434 `S-<TAB>' `C-u <TAB>'
5435 `M-<left>' `C-c C-x l' `<Esc> <left>'
5436 `M-S-<left>'`C-c C-x L'
5437 `M-<right>' `C-c C-x r' `<Esc>
5439 `M-S-<right>'`C-c C-x R'
5440 `M-<up>' `C-c C-x u' `<Esc> <up>'
5441 `M-S-<up>' `C-c C-x U'
5442 `M-<down>' `C-c C-x d' `<Esc> <down>'
5443 `M-S-<down>'`C-c C-x D'
5444 `S-<RET>' `C-c C-x c'
5445 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
5446 `M-S-<RET>' `C-c C-x M'
5447 `S-<left>' `C-c <left>'
5448 `S-<right>' `C-c <right>'
5450 `S-<down>' `C-c <down>'
5451 `C-S-<left>'`C-c C-x
5453 `C-S-<right>'`C-c C-x
5457 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
5459 12.7 Interaction with other packages
5460 ====================================
5462 Org-mode lives in the world of GNU Emacs and interacts in various ways
5463 with other code out there.
5467 * Cooperation:: Packages Org-mode cooperates with
5468 * Conflicts:: Packages that lead to conflicts
5471 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
5473 12.7.1 Packages that Org-mode cooperates with
5474 ---------------------------------------------
5476 `calc.el' by Dave Gillespie
5477 Org-mode uses the calc package for implementing spreadsheet
5478 functionality in its tables (*note The spreadsheet::). Org-mode
5479 checks for the availability of calc by looking for the function
5480 `calc-eval' which should be autoloaded in your setup if calc has
5481 been installed properly. As of Emacs 22, calc is part of the Emacs
5482 distribution. Another possibility for interaction between the two
5483 packages is using calc for embedded calculations. *Note Embedded
5484 Mode: (calc)Embedded Mode.
5486 `constants.el' by Carsten Dominik
5487 In a table formula (*note The spreadsheet::), it is possible to use
5488 names for natural constants or units. Instead of defining your own
5489 constants in the variable `org-table-formula-constants', install
5490 the `constants' package which defines a large number of constants
5491 and units, and lets you use unit prefixes like `M' for `Mega' etc.
5492 You will need version 2.0 of this package, available at
5493 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5494 function `constants-get', which has to be autoloaded in your
5495 setup. See the installation instructions in the file
5498 `cdlatex.el' by Carsten Dominik
5499 Org-mode can make use of the cdlatex package to efficiently enter
5500 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5502 `remember.el' by John Wiegley
5503 Org mode cooperates with remember, see *Note Remember::.
5504 `Remember.el' is not part of Emacs, find it on the web.
5506 `table.el' by Takaaki Ota
5507 Complex ASCII tables with automatic line wrapping, column- and
5508 row-spanning, and alignment can be created using the Emacs table
5509 package by Takaaki Ota (`http://sourceforge.net/projects/table',
5510 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
5511 such a table, Org-mode will call `table-recognize-table' and move
5512 the cursor into the table. Inside a table, the keymap of Org-mode
5513 is inactive. In order to execute Org-mode-related commands, leave
5517 Recognize `table.el' table. Works when the cursor is in a
5521 Insert a table.el table. If there is already a table at
5522 point, this command converts it between the table.el format
5523 and the Org-mode format. See the documentation string of the
5524 command `org-convert-table' for the restrictions under which
5526 `table.el' is part of Emacs 22.
5529 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
5531 12.7.2 Packages that lead to conflicts with Org-mode
5532 ----------------------------------------------------
5534 `allout.el' by Ken Manheimer
5535 Startup of Org-mode may fail with the error message
5536 `(wrong-type-argument keymapp nil)' when there is an outdated
5537 version `allout.el' on the load path, for example the version
5538 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
5539 will disappear. If for some reason you cannot do this, make sure
5540 that org.el is loaded _before_ `allout.el', for example by putting
5541 `(require 'org)' early enough into your `.emacs' file.
5543 `CUA.el' by Kim. F. Storm
5544 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5545 by CUA-mode (as well as pc-select-mode and s-region-mode) to
5546 select and extend the region. If you want to use one of these
5547 packages along with Org-mode, configure the variable
5548 `org-CUA-compatible'. When set, Org-mode will move the following
5549 keybindings in org-mode files, and in the agenda buffer (but not
5550 during date selection).
5552 S-UP -> M-p S-DOWN -> M-n
5553 S-LEFT -> M-- S-RIGHT -> M-+
5556 Yes, these are unfortunately more difficult to remember. If you
5557 want to have other replacement keys, look at the variable
5558 `org-disputed-keys'.
5560 `windmove.el' by Hovav Shacham
5561 Also this package uses the `S-<cursor>' keys, so everything written
5562 in the paragraph above about CUA mode also applies here.
5565 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5570 Here is a list of things that should work differently, but which I have
5571 found too hard to fix.
5573 * If a table field starts with a link, and if the corresponding table
5574 column is narrowed (*note Narrow columns::) to a width too small to
5575 display the link, the field would look entirely empty even though
5576 it is not. To prevent this, Org-mode throws an error. The
5577 work-around is to make the column wide enough to fit the link, or
5578 to add some text (at least 2 characters) before the link in the
5581 * Narrowing table columns does not work on XEmacs, because the
5582 `format' function does not transport text properties.
5584 * Text in an entry protected with the `QUOTE' keyword should not
5587 * When the application called by `C-c C-o' to open a file link fails
5588 (for example because the application does not exist or refuses to
5589 open the file), it does so silently. No error message is
5592 * Recalculating a table line applies the formulas from left to right.
5593 If a formula uses _calculated_ fields further down the row,
5594 multiple recalculation may be needed to get all fields consistent.
5595 You may use the command `org-table-iterate' (`C-u C-c *') to
5596 recalculate until convergence.
5598 * A single letter cannot be made bold, for example `*a*'.
5600 * The exporters work well, but could be made more efficient.
5603 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5605 Appendix A Extensions, Hooks and Hacking
5606 ****************************************
5608 This appendix lists extensions for Org-mode written by other authors.
5609 It also covers some aspects where users can extend the functionality of
5614 * Extensions:: Existing 3rd-part extensions
5615 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
5616 * Dynamic blocks:: Automatically filled blocks
5617 * Special agenda views:: Customized views
5620 File: org, Node: Extensions, Next: Tables in arbitrary syntax, Prev: Extensions and Hacking, Up: Extensions and Hacking
5622 A.1 Third-party extensions for Org-mode
5623 =======================================
5625 The following extensions for Org-mode have been written by other people:
5627 `org-publish.el' by David O'Toole
5628 This package provides facilities for publishing related sets of
5629 Org-mode files together with linked files like images as webpages.
5630 It is highly configurable and can be used for other publishing
5631 purposes as well. As of Org-mode version 4.30, `org-publish.el'
5632 is part of the Org-mode distribution. It is not yet part of
5633 Emacs, however, a delay caused by the preparations for the 22.1
5634 release. In the mean time, `org-publish.el' can be downloaded
5635 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
5637 `org-mouse.el' by Piotr Zielinski
5638 This package implements extended mouse functionality for Org-mode.
5639 It allows you to cycle visibility and to edit the document
5640 structure with the mouse. Best of all, it provides a
5641 context-sensitive menu on <mouse-3> that changes depending on the
5642 context of a mouse-click. As of Org-mode version 4.53,
5643 `org-mouse.el' is part of the Org-mode distribution. It is not
5644 yet part of Emacs, however, a delay caused by the preparations for
5645 the 22.1 release. In the mean time, `org-mouse.el' can be
5646 downloaded from Piotr's site:
5647 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
5649 `org-blog.el' by David O'Toole
5650 A blogging plug-in for `org-publish.el'.
5651 `http://dto.freeshell.org/notebook/OrgMode.html'.
5653 `blorg.el' by Bastien Guerry
5654 Publish Org-mode files as blogs.
5655 `http://www.cognition.ens.fr/~guerry/blorg.html'.
5657 `org2rem.el' by Bastien Guerry
5658 Translates Org-mode files into something readable by Remind.
5659 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
5662 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
5664 A.2 Tables in arbitrary syntax
5665 ==============================
5667 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
5668 frequent feature request has been to make it work with native tables in
5669 specific languages, for example LaTeX. However, this is extremely hard
5670 to do in a general way, would lead to a customization nightmare, and
5671 would take away much of the simplicity of the Orgtbl-mode table editor.
5673 This appendix describes a different approach. We keep the
5674 Orgtbl-mode table in its native format (the source table), and use a
5675 custom function to translate the table to the correct syntax, and to
5676 install it in the right location (the target table). This puts the
5677 burden of writing conversion functions on the user, but it allows for a
5678 very flexible system.
5682 * Radio tables:: Sending and receiving
5683 * A LaTeX example:: Step by step, almost a tutorial
5684 * Translator functions:: Copy and modify
5687 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
5692 To define the location of the target table, you first need to create two
5693 lines that are comments in the current mode, but contain magic words for
5694 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
5695 between these lines, replacing whatever was there before. For example:
5697 /* BEGIN RECEIVE ORGTBL table_name */
5698 /* END RECEIVE ORGTBL table_name */
5700 Just above the source table, we put a special line that tells
5701 Orgtbl-mode how to translate this table and where to install it. For
5703 #+ORGTBL: SEND table_name translation_function arguments....
5705 `table_name' is the reference name for the table that is also used in
5706 the receiver lines. `translation_function' is the Lisp function that
5707 does the translation. Furthermore, the line can contain a list of
5708 arguments (alternating key and value) at the end. The arguments will be
5709 passed as a property list to the translation function for
5710 interpretation. A few standard parameters are already recognized and
5711 acted upon before the translation function is called:
5714 Skip the first N lines of the table. Hlines do count!
5716 `:skipcols (n1 n2 ...)'
5717 List of columns that should be skipped. If the table has a column
5718 with calculation marks, that column is automatically discarded as
5719 well. Please note that the translator function sees the table
5720 _after_ the removal of these columns, the function never knows
5721 that there have been additional columns.
5723 The one problem remaining is how to keep the source table in the buffer
5724 without disturbing the normal workings of the file, for example during
5725 compilation of a C file or processing of a LaTeX file. There are a
5726 number of different solutions:
5728 * The table could be placed in a block comment if that is supported
5729 by the language. For example, in C-mode you could wrap the table
5730 between `/*' and `*/' lines.
5732 * Sometimes it is possible to put the table after some kind of END
5733 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
5735 * You can just comment the table line by line whenever you want to
5736 process the file, and uncomment it whenever you need to edit the
5737 table. This only sounds tedious - the command `M-x
5738 orgtbl-toggle-comment' does make this comment-toggling very easy,
5739 in particular if you bind it to a key.
5742 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
5744 A.2.2 A LaTeX example
5745 ---------------------
5747 The best way to wrap the source table in LaTeX is to use the `comment'
5748 environment provided by `comment.sty'. It has to be activated by
5749 placing `\usepackage{comment}' into the document header. Orgtbl-mode
5750 can insert a radio table skeleton(1) with the command `M-x
5751 orgtbl-insert-radio-table'. You will be prompted for a table name,
5752 lets say we use `salesfigures'. You will then get the following
5755 % BEGIN RECEIVE ORGTBL salesfigures
5756 % END RECEIVE ORGTBL salesfigures
5758 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5762 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
5763 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
5764 the receiver location with name `salesfigures'. You may now fill in
5765 the table, feel free to use the spreadsheet features(2):
5767 % BEGIN RECEIVE ORGTBL salesfigures
5768 % END RECEIVE ORGTBL salesfigures
5770 #+ORGTBL: SEND salesfigures orgtbl-to-latex
5771 | Month | Days | Nr sold | per day |
5772 |-------+------+---------+---------|
5773 | Jan | 23 | 55 | 2.4 |
5774 | Feb | 21 | 16 | 0.8 |
5775 | March | 22 | 278 | 12.6 |
5776 #+TBLFM: $4=$3/$2;%.1f
5777 % $ (optional extra dollar to keep font-lock happy, see footnote)
5780 When you are done, press `C-c C-c' in the table to get the converted
5781 table inserted between the two marker lines.
5783 Now lets assume you want to make the table header by hand, because
5784 you want to control how columns are aligned etc. In this case we make
5785 sure that the table translator does skip the first 2 lines of the source
5786 table, and tell the command to work as a splice, i.e. to not produce
5787 header and footer commands of the target table:
5789 \begin{tabular}{lrrr}
5790 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
5791 % BEGIN RECEIVE ORGTBL salesfigures
5792 % END RECEIVE ORGTBL salesfigures
5796 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
5797 | Month | Days | Nr sold | per day |
5798 |-------+------+---------+---------|
5799 | Jan | 23 | 55 | 2.4 |
5800 | Feb | 21 | 16 | 0.8 |
5801 | March | 22 | 278 | 12.6 |
5802 #+TBLFM: $4=$3/$2;%.1f
5805 The LaTeX translator function `orgtbl-to-latex' is already part of
5806 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
5807 marks horizontal lines with `\hline'. Furthermore, it interprets the
5808 following parameters:
5811 When set to t, return only table body lines, don't wrap them into a
5812 tabular environment. Default is nil.
5815 A format to be used to wrap each field, should contain `%s' for the
5816 original field value. For example, to wrap each field value in
5817 dollars, you could use `:fmt "$%s$"'. This may also be a property
5818 list with column numbers and formats. for example `:fmt (2 "$%s$"
5822 Use this format to print numbers with exponentials. The format
5823 should have `%s' twice for inserting mantissa and exponent, for
5824 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
5825 may also be a property list with column numbers and formats, for
5826 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
5827 After `efmt' has been applied to a value, `fmt' will also be
5830 ---------- Footnotes ----------
5832 (1) By default this works only for LaTeX, HTML, and TeXInfo.
5833 Configure the variable `orgtbl-radio-tables' to install templates for
5836 (2) If the `#+TBLFM' line contains an odd number of dollar
5837 characters, this may cause problems with font-lock in latex-mode. As
5838 shown in the example you can fix this by adding an extra line inside the
5839 `comment' environment that is used to balance the dollar expressions.
5840 If you are using AUCTeX with the font-latex library, a much better
5841 solution is to add the `comment' environment to the variable
5842 `LaTeX-verbatim-environments'.
5845 File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in arbitrary syntax
5847 A.2.3 Translator functions
5848 --------------------------
5850 Orgtbl-mode has several translator functions built-in:
5851 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. Except
5852 for `orgtbl-to-html'(1), these all use a generic translator,
5853 `orgtbl-to-generic'. For example, `orgtbl-to-latex' itself is a very
5854 short function that computes the column definitions for the `tabular'
5855 environment, defines a few field and line separators and then hands
5856 over to the generic translator. Here is the entire code:
5858 (defun orgtbl-to-latex (table params)
5859 "Convert the orgtbl-mode TABLE to LaTeX."
5860 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
5861 org-table-last-alignment ""))
5864 :tstart (concat "\\begin{tabular}{" alignment "}")
5865 :tend "\\end{tabular}"
5866 :lstart "" :lend " \\\\" :sep " & "
5867 :efmt "%s\\,(%s)" :hline "\\hline")))
5868 (orgtbl-to-generic table (org-combine-plists params2 params))))
5870 As you can see, the properties passed into the function (variable
5871 PARAMS) are combined with the ones newly defined in the function
5872 (variable PARAMS2). The ones passed into the function (i.e. the ones
5873 set by the `ORGTBL SEND' line) take precedence. So if you would like
5874 to use the LaTeX translator, but wanted the line endings to be
5875 `\\[2mm]' instead of the default `\\', you could just overrule the
5878 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
5880 For a new language, you can either write your own converter function
5881 in analogy with the LaTeX translator, or you can use the generic
5882 function directly. For example, if you have a language where a table
5883 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
5884 started with `!BL!', ended with `!EL!' and where the field separator is
5885 a TAB, you could call the generic translator like this (on a single
5888 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
5889 :lstart "!BL! " :lend " !EL!" :sep "\t"
5891 Please check the documentation string of the function
5892 `orgtbl-to-generic' for a full list of parameters understood by that
5893 function and remember that you can pass each of them into
5894 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
5895 the generic function.
5897 Of course you can also write a completely new function doing
5898 complicated things the generic translator cannot do. A translator
5899 function takes two arguments. The first argument is the table, a list
5900 of lines, each line either the symbol `hline' or a list of fields. The
5901 second argument is the property list containing all parameters
5902 specified in the `#+ORGTBL: SEND' line. The function must return a
5903 single string containing the formatted table. If you write a generally
5904 useful translator, please post it on `emacs-orgmode@gnu.org' so that
5905 others can benefit from your work.
5907 ---------- Footnotes ----------
5909 (1) The HTML translator uses the same code that produces tables
5913 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
5918 Org-mode documents can contain _dynamic blocks_. These are specially
5919 marked regions that are updated by some user-written function. A good
5920 example for such a block is the clock table inserted by the command
5921 `C-c C-x C-r' (*note Clocking work time::).
5923 Dynamic block are enclosed by a BEGIN-END structure that assigns a
5924 name to the block and can also specify parameters for the function
5925 producing the content of the block.
5927 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5931 Dynamic blocks are updated with the following commands
5934 Update dynamic block at point.
5937 Update all dynamic blocks in the current file.
5939 Updating a dynamic block means to remove all the text between BEGIN
5940 and END, parse the BEGIN line for parameters and then call the specific
5941 writer function for this block to insert the new content. For a block
5942 with name `myblock', the writer function is `org-dblock-write:myblock'
5943 with as only parameter a property list with the parameters given in the
5944 begin line. Here is a trivial example of a block that keeps track of
5945 when the block update function was last run:
5947 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5951 The corresponding block writer function could look like this:
5953 (defun org-dblock-write:block-update-time (params)
5954 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5955 (insert "Last block update at: "
5956 (format-time-string fmt (current-time)))))
5958 If you want to make sure that all dynamic blocks are always
5959 up-to-date, you could add the function `org-update-all-dblocks' to a
5960 hook, for example `before-save-hook'. `org-update-all-dblocks' is
5961 written in a way that is does nothing in buffers that are not in
5965 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
5967 A.4 Special Agenda Views
5968 ========================
5970 Org-mode provides a special hook that can be used to narrow down the
5971 selection made by any of the agenda views. You may specify a function
5972 that is used at each match to verify if the match should indeed be part
5973 of the agenda view, and if not, how much should be skipped.
5975 Let's say you want to produce a list of projects that contain a
5976 WAITING tag anywhere in the project tree. Let's further assume that
5977 you have marked all tree headings that define a project with the todo
5978 keyword PROJECT. In this case you would run a todo search for the
5979 keyword PROJECT, but skip the match unless there is a WAITING tag
5980 anywhere in the subtree belonging to the project line.
5982 To achieve this, you must write a function that searches the subtree
5983 for the tag. If the tag is found, the function must return `nil' to
5984 indicate that this match should not be skipped. If there is no such
5985 tag, return the location of the end of the subtree, to indicate that
5986 search should continue from there.
5988 (defun my-skip-unless-waiting ()
5989 "Skip trees that are not waiting"
5990 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
5991 (if (re-search-forward ":WAITING:" subtree-end t)
5992 nil ; tag found, do not skip
5993 subtree-end))) ; tag not found, continue after end of subtree
5995 Furthermore you must write a command that uses `let' to temporarily
5996 put this function into the variable `org-agenda-skip-function', sets
5997 the header string for the agenda buffer, and calls the todo-list
5998 generator while asking for the specific TODO keyword PROJECT. The
5999 function must also accept one argument MATCH, but it can choose to
6000 ignore it(1) (as we do in the example below). Here is the example:
6002 (defun my-org-waiting-projects (&optional match)
6003 "Produce a list of projects that contain a WAITING tag.
6004 MATCH is being ignored."
6006 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
6007 (org-agenda-overriding-header "Projects waiting for something: "))
6009 (org-todo-list "PROJECT")))
6011 ---------- Footnotes ----------
6013 (1) MATCH must be present in case you want to define a custom
6014 command for producing this special list. Custom commands always supply
6015 the MATCH argument, but it can be empty if you do not specify it while
6016 defining the command(*note Custom agenda views::).
6019 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
6021 Appendix B History and Acknowledgments
6022 **************************************
6024 Org-mode was borne in 2003, out of frustration over the user interface
6025 of the Emacs outline-mode. I was trying to organize my notes and
6026 projects, and using Emacs seemed to be the natural way to go. However,
6027 having to remember eleven different commands with two or three keys per
6028 command, only to hide and unhide parts of the outline tree, that seemed
6029 entirely unacceptable to me. Also, when using outlines to take notes, I
6030 constantly want to restructure the tree, organizing it parallel to my
6031 thoughts and plans. _Visibility cycling_ and _structure editing_ were
6032 originally implemented in the package `outline-magic.el', but quickly
6033 moved to the more general `org.el'. As this environment became
6034 comfortable for project planning, the next step was adding _TODO
6035 entries_, basic _time stamps_, and _table support_. These areas
6036 highlight the two main goals that Org-mode still has today: To create a
6037 new, outline-based, plain text mode with innovative and intuitive
6038 editing features, and to incorporate project planning functionality
6039 directly into a notes file.
6041 Since the first release, hundreds of emails to me or on
6042 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
6043 feedback, new ideas, and sometimes patches and add-on code. Many
6044 thanks to everyone who has helped to improve this package. I am trying
6045 to keep here a list of the people who had significant influence in
6046 shaping one or more aspects of Org-mode. The list may not be complete,
6047 if I have forgotten someone, please accept my apologies and let me know.
6049 * Thomas Baumann contributed the code for links to the MH-E email
6052 * Alex Bochannek provided a patch for rounding time stamps.
6054 * Charles Cave's suggestion sparked the implementation of templates
6057 * Pavel Chalmoviansky influenced the agenda treatment of items with
6060 * Gregory Chernov patched support for lisp forms into table
6061 calculations and improved XEmacs compatibility, in particular by
6062 porting `nouline.el' to XEmacs.
6064 * Sacha Chua suggested to copy some linking code from Planner.
6066 * Eddward DeVilla proposed and tested checkbox statistics.
6068 * Kees Dullemond used to edit projects lists directly in HTML and so
6069 inspired some of the early development, including HTML export. He
6070 also asked for a way to narrow wide table columns.
6072 * Christian Egli converted the documentation into TeXInfo format,
6073 patched CSS formatting into the HTML exporter, and inspired the
6076 * Nic Ferrier contributed mailcap and XOXO support.
6078 * John Foerch figured out how to make incremental search show context
6079 around a match in a hidden outline tree.
6081 * Niels Giessen had the idea to automatically archive DONE trees.
6083 * Bastien Guerry provided extensive feedback and some patches, and
6084 translated David O'Toole's tutorial into French.
6086 * Kai Grossjohann pointed out key-binding conflicts with other
6089 * Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
6090 provided frequent feedback and some patches.
6092 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
6095 * Rick Moynihan proposed to allow multiple TODO sequences in a file.
6097 * Todd Neal provided patches for links to Info files and elisp forms.
6099 * Tim O'Callaghan suggested in-file links, search options for general
6100 file links, and TAGS.
6102 * Takeshi Okano translated the manual and David O'Toole's tutorial
6105 * Oliver Oppitz suggested multi-state TODO items.
6107 * Scott Otterson sparked the introduction of descriptive text for
6108 links, among other things.
6110 * Pete Phillips helped during the development of the TAGS feature,
6111 and provided frequent feedback.
6113 * T.V. Raman reported bugs and suggested improvements.
6115 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
6118 * Kevin Rogers contributed code to access VM files on remote hosts.
6120 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
6121 conflict with `allout.el'.
6123 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
6125 * Philip Rooke created the Org-mode reference card and provided lots
6128 * Christian Schlauer proposed angular brackets around links, among
6131 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
6132 `organizer-mode.el'.
6134 * Daniel Sinder came up with the idea of internal archiving by
6137 * Dale Smith proposed link abbreviations.
6139 * David O'Toole wrote `org-publish.el' and drafted the manual
6140 chapter about publishing.
6142 * Ju"rgen Vollmer contributed code generating the table of contents
6145 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
6147 * David Wainberg suggested archiving, and improvements to the linking
6150 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
6151 development of Org-mode was fully independent, and both systems are
6152 really different beasts in their basic ideas and implementation
6153 details. I later looked at John's code, however, and learned from
6154 his implementation of (i) links where the link itself is hidden
6155 and only a description is shown, and (ii) popping up a calendar to
6158 * Carsten Wimmer suggested some changes and helped fix a bug in
6161 * Roland Winkler requested additional keybindings to make Org-mode
6164 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
6165 contributed various ideas and code snippets.
6168 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
6176 * abbreviation, links: Link abbreviations. (line 6)
6177 * acknowledgments: History and Acknowledgments.
6179 * action, for publishing: Publishing action. (line 6)
6180 * activation: Activation. (line 6)
6181 * active region <1>: Export commands. (line 6)
6182 * active region <2>: ASCII export. (line 9)
6183 * active region <3>: Built-in table editor.
6185 * active region: Structure editing. (line 64)
6186 * agenda: Weekly/Daily agenda. (line 6)
6187 * agenda dispatcher: Agenda dispatcher. (line 6)
6188 * agenda files: Agenda files. (line 6)
6189 * agenda files, removing buffers: Agenda commands. (line 228)
6190 * agenda views: Agenda views. (line 6)
6191 * agenda views, custom: Custom agenda views. (line 6)
6192 * agenda views, user-defined: Special agenda views.
6194 * agenda, batch production: Batch processing. (line 6)
6195 * agenda, with block views: Block agenda. (line 6)
6196 * align, STARTUP keyword: In-buffer settings. (line 29)
6197 * allout.el: Conflicts. (line 6)
6198 * angular brackets, around links: External links. (line 43)
6199 * archive locations: Moving subtrees. (line 21)
6200 * archiving: Archiving. (line 6)
6201 * ASCII export: ASCII export. (line 6)
6202 * author: Feedback. (line 6)
6203 * autoload: Activation. (line 6)
6204 * backtrace of an error: Feedback. (line 27)
6205 * BBDB links: External links. (line 6)
6206 * block agenda: Block agenda. (line 6)
6207 * blorg.el: Extensions. (line 32)
6208 * bold text: Enhancing text. (line 15)
6209 * Boolean logic, for tag searches: Tag searches. (line 23)
6210 * bug reports: Feedback. (line 6)
6211 * bugs: Bugs. (line 6)
6212 * C-c C-c, overview: The very busy C-c C-c key.
6214 * calc package: The spreadsheet. (line 6)
6215 * calc.el: Cooperation. (line 6)
6216 * calculations, in tables <1>: The spreadsheet. (line 6)
6217 * calculations, in tables: Built-in table editor.
6219 * calendar commands, from agenda: Agenda commands. (line 191)
6220 * calendar integration: Weekly/Daily agenda. (line 24)
6221 * calendar, for selecting date: The date/time prompt.
6223 * category: Categories. (line 6)
6224 * CDLaTeX: CDLaTeX mode. (line 6)
6225 * cdlatex.el: Cooperation. (line 29)
6226 * checkbox statistics: Checkboxes. (line 23)
6227 * checkboxes: Checkboxes. (line 6)
6228 * children, subtree visibility state: Visibility cycling. (line 10)
6229 * clean outline view: Clean view. (line 6)
6230 * CLOCK keyword: Time stamps. (line 71)
6231 * CLOSED keyword: Time stamps. (line 65)
6232 * column formula: Column formulas. (line 6)
6233 * commands, in agenda buffer: Agenda commands. (line 6)
6234 * comment lines: Comment lines. (line 6)
6235 * completion, of dictionary words: Completion. (line 6)
6236 * completion, of file names: Handling links. (line 41)
6237 * completion, of link abbreviations: Completion. (line 6)
6238 * completion, of links: Handling links. (line 25)
6239 * completion, of option keywords <1>: Completion. (line 6)
6240 * completion, of option keywords <2>: Export options. (line 6)
6241 * completion, of option keywords: Per file keywords. (line 23)
6242 * completion, of tags <1>: Completion. (line 6)
6243 * completion, of tags: Setting tags. (line 11)
6244 * completion, of TeX symbols: Completion. (line 6)
6245 * completion, of TODO keywords <1>: Completion. (line 6)
6246 * completion, of TODO keywords: Workflow states. (line 15)
6247 * constants, in calculations: References. (line 82)
6248 * constants.el: Cooperation. (line 14)
6249 * constcgs, STARTUP keyword: In-buffer settings. (line 52)
6250 * constSI, STARTUP keyword: In-buffer settings. (line 52)
6251 * content, STARTUP keyword: In-buffer settings. (line 22)
6252 * contents, global visibility state: Visibility cycling. (line 22)
6253 * copying, of subtrees: Structure editing. (line 6)
6254 * creating timestamps: Creating timestamps. (line 6)
6255 * CUA.el: Conflicts. (line 15)
6256 * custom agenda views: Custom agenda views. (line 6)
6257 * custom date/time format: Custom time format. (line 6)
6258 * custom search strings: Custom searches. (line 6)
6259 * customization: Customization. (line 6)
6260 * customtime, STARTUP keyword: In-buffer settings. (line 49)
6261 * cutting, of subtrees: Structure editing. (line 6)
6262 * cycling, of TODO states: TODO basics. (line 13)
6263 * cycling, visibility: Visibility cycling. (line 6)
6264 * daily agenda: Weekly/Daily agenda. (line 6)
6265 * date format, custom: Custom time format. (line 6)
6266 * date stamps <1>: Time stamps. (line 6)
6267 * date stamps: Timestamps. (line 6)
6268 * date, reading in minibuffer: The date/time prompt.
6270 * DEADLINE keyword: Time stamps. (line 53)
6271 * deadlines: Time stamps. (line 6)
6272 * deadlines, repeating: Repeating items. (line 6)
6273 * debugging, of table formulas: Editing and debugging formulas.
6275 * demotion, of subtrees: Structure editing. (line 6)
6276 * diary entries, creating from agenda: Agenda commands. (line 196)
6277 * diary integration: Weekly/Daily agenda. (line 24)
6278 * dictionary word completion: Completion. (line 6)
6279 * directories, for publishing: Sources and destinations.
6281 * dispatching agenda commands: Agenda dispatcher. (line 6)
6282 * display changing, in agenda: Agenda commands. (line 65)
6283 * document structure: Document structure. (line 6)
6284 * DONE, final TODO keyword: Per file keywords. (line 26)
6285 * dynamic blocks: Dynamic blocks. (line 6)
6286 * editing tables: Tables. (line 6)
6287 * editing, of table formulas: Editing and debugging formulas.
6289 * elisp links: External links. (line 6)
6290 * emphasized text: Export options. (line 25)
6291 * enhancing text: Enhancing text. (line 6)
6292 * evaluate time range: Creating timestamps. (line 64)
6293 * even, STARTUP keyword: In-buffer settings. (line 42)
6294 * exporting: Exporting. (line 6)
6295 * exporting, not: Comment lines. (line 6)
6296 * extended TODO keywords: TODO extensions. (line 6)
6297 * extension, third-party: Extensions. (line 6)
6298 * external archiving: Moving subtrees. (line 6)
6299 * external links: External links. (line 6)
6300 * external links, in HTML export: Links. (line 6)
6301 * FAQ: Summary. (line 53)
6302 * feedback: Feedback. (line 6)
6303 * field formula: Field formulas. (line 6)
6304 * field references: References. (line 15)
6305 * file links: External links. (line 6)
6306 * file links, searching: Search options. (line 6)
6307 * file name completion: Handling links. (line 41)
6308 * files for agenda: Agenda files. (line 6)
6309 * files, adding to agenda list: Agenda files. (line 12)
6310 * files, selecting for publishing: Selecting files. (line 6)
6311 * fixed width: Enhancing text. (line 28)
6312 * fixed-width sections: Export options. (line 25)
6313 * folded, subtree visibility state: Visibility cycling. (line 10)
6314 * folding, sparse trees: Sparse trees. (line 6)
6315 * following links: Handling links. (line 56)
6316 * format specifier: Formula syntax for Calc.
6318 * format, of links: Link format. (line 6)
6319 * formula debugging: Editing and debugging formulas.
6321 * formula editing: Editing and debugging formulas.
6323 * formula syntax, Calc: Formula syntax for Calc.
6325 * formula, for individual table field: Field formulas. (line 6)
6326 * formula, for table column: Column formulas. (line 6)
6327 * formula, in tables: Built-in table editor.
6329 * global cycling: Visibility cycling. (line 22)
6330 * global keybindings: Activation. (line 6)
6331 * global TODO list: Global TODO list. (line 6)
6332 * global visibility states: Visibility cycling. (line 22)
6333 * GNUS links: External links. (line 6)
6334 * hand-formatted lists: Enhancing text. (line 11)
6335 * headline levels: Export options. (line 25)
6336 * headline levels, for exporting <1>: Export commands. (line 22)
6337 * headline levels, for exporting: ASCII export. (line 18)
6338 * headline navigation: Motion. (line 6)
6339 * headline tagging: Tags. (line 6)
6340 * headline, promotion and demotion: Structure editing. (line 6)
6341 * headlines: Headlines. (line 6)
6342 * hide text: Visibility cycling. (line 6)
6343 * hidestars, STARTUP keyword: In-buffer settings. (line 42)
6344 * hiding leading stars: Clean view. (line 6)
6345 * history: History and Acknowledgments.
6347 * horizontal rules, in exported files: Enhancing text. (line 18)
6348 * HTML export: HTML export. (line 6)
6349 * HTML, and orgtbl-mode: Translator functions.
6351 * hyperlinks: Hyperlinks. (line 6)
6352 * iCalendar export: iCalendar export. (line 6)
6353 * images, inline in HTML: Images. (line 6)
6354 * in-buffer settings: In-buffer settings. (line 6)
6355 * inactive timestamp: Time stamps. (line 24)
6356 * index, of published pages: Project page index. (line 6)
6357 * Info links: External links. (line 6)
6358 * inheritance, of tags: Tag inheritance. (line 6)
6359 * inlining images in HTML: Images. (line 6)
6360 * inserting links: Handling links. (line 25)
6361 * installation: Installation. (line 6)
6362 * internal archiving: ARCHIVE tag. (line 6)
6363 * internal links: Internal links. (line 6)
6364 * internal links, in HTML export: Links. (line 6)
6365 * introduction: Introduction. (line 6)
6366 * italic text: Enhancing text. (line 15)
6367 * jumping, to headlines: Motion. (line 6)
6368 * keybindings, global: Activation. (line 6)
6369 * keyword options: Per file keywords. (line 6)
6370 * LaTeX fragments <1>: Export options. (line 25)
6371 * LaTeX fragments: LaTeX fragments. (line 6)
6372 * LaTeX fragments, export: Enhancing text. (line 21)
6373 * LaTeX fragments, preview: Processing LaTeX fragments.
6375 * LaTeX interpretation: Embedded LaTeX. (line 6)
6376 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
6377 * level, require for tags match: Tag searches. (line 68)
6378 * linebreak preservation: Export options. (line 25)
6379 * linebreak, forced: Enhancing text. (line 35)
6380 * link abbreviations: Link abbreviations. (line 6)
6381 * link abbreviations, completion of: Completion. (line 6)
6382 * link completion: Handling links. (line 25)
6383 * link format: Link format. (line 6)
6384 * links, external: External links. (line 6)
6385 * links, finding next/previous: Handling links. (line 89)
6386 * links, handling: Handling links. (line 6)
6387 * links, in HTML export: Links. (line 6)
6388 * links, internal: Internal links. (line 6)
6389 * links, publishing: Publishing links. (line 6)
6390 * links, radio targets: Radio targets. (line 6)
6391 * links, returning to: Handling links. (line 83)
6392 * Lisp forms, as table formulas: Formula syntax for Lisp.
6394 * lists, hand-formatted: Enhancing text. (line 11)
6395 * lists, ordered: Plain lists. (line 6)
6396 * lists, plain: Plain lists. (line 6)
6397 * logdone, STARTUP keyword: In-buffer settings. (line 33)
6398 * logging, of progress: Progress logging. (line 6)
6399 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
6400 * lognotedone, STARTUP keyword: In-buffer settings. (line 33)
6401 * lognotestate, STARTUP keyword: In-buffer settings. (line 33)
6402 * maintainer: Feedback. (line 6)
6403 * mark ring: Handling links. (line 79)
6404 * marking characters, tables: Advanced features. (line 40)
6405 * matching, of tags: Matching headline tags.
6407 * matching, tags: Tags. (line 6)
6408 * math symbols: Math symbols. (line 6)
6409 * MH-E links: External links. (line 6)
6410 * minor mode for tables: orgtbl-mode. (line 6)
6411 * mode, for calc: Formula syntax for Calc.
6413 * motion commands in agenda: Agenda commands. (line 19)
6414 * motion, between headlines: Motion. (line 6)
6415 * name, of column or field: References. (line 82)
6416 * named references: References. (line 82)
6417 * names as TODO keywords: TODO types. (line 6)
6418 * narrow columns in tables: Narrow columns. (line 6)
6419 * noalign, STARTUP keyword: In-buffer settings. (line 29)
6420 * nologging, STARTUP keyword: In-buffer settings. (line 33)
6421 * occur, command: Sparse trees. (line 6)
6422 * odd, STARTUP keyword: In-buffer settings. (line 42)
6423 * option keyword completion: Completion. (line 6)
6424 * options, for custom agenda views: Setting Options. (line 6)
6425 * options, for customization: Customization. (line 6)
6426 * options, for export: Export options. (line 6)
6427 * options, for publishing: Publishing options. (line 6)
6428 * ordered lists: Plain lists. (line 6)
6429 * org-agenda, command: Weekly/Daily agenda. (line 9)
6430 * org-blog.el: Extensions. (line 28)
6431 * org-mode, turning on: Activation. (line 22)
6432 * org-mouse.el: Extensions. (line 16)
6433 * org-publish-project-alist: Project alist. (line 6)
6434 * org-publish.el: Extensions. (line 8)
6435 * org2rem.el: Extensions. (line 36)
6436 * orgtbl-mode <1>: Tables in arbitrary syntax.
6438 * orgtbl-mode: orgtbl-mode. (line 6)
6439 * outline tree: Headlines. (line 6)
6440 * outline-mode: Outlines. (line 6)
6441 * outlines: Outlines. (line 6)
6442 * overview, global visibility state: Visibility cycling. (line 22)
6443 * overview, STARTUP keyword: In-buffer settings. (line 22)
6444 * packages, interaction with other: Interaction. (line 6)
6445 * pasting, of subtrees: Structure editing. (line 6)
6446 * per file keywords: Per file keywords. (line 6)
6447 * plain lists: Plain lists. (line 6)
6448 * plain text external links: External links. (line 43)
6449 * presentation, of agenda items: Presentation and sorting.
6451 * printing sparse trees: Sparse trees. (line 41)
6452 * priorities: Priorities. (line 6)
6453 * priorities, of agenda items: Sorting of agenda items.
6455 * progress logging: Progress logging. (line 6)
6456 * projects, for publishing: Project alist. (line 6)
6457 * promotion, of subtrees: Structure editing. (line 6)
6458 * publishing: Publishing. (line 6)
6459 * quoted HTML tags: Export options. (line 25)
6460 * radio tables: Radio tables. (line 6)
6461 * radio targets: Radio targets. (line 6)
6462 * range references: References. (line 60)
6463 * ranges, time: Time stamps. (line 6)
6464 * recomputing table fields: Updating the table. (line 6)
6465 * references: References. (line 6)
6466 * references, named: References. (line 82)
6467 * references, to fields: References. (line 15)
6468 * references, to ranges: References. (line 60)
6469 * region, active <1>: Export commands. (line 6)
6470 * region, active <2>: ASCII export. (line 9)
6471 * region, active <3>: Built-in table editor.
6473 * region, active: Structure editing. (line 64)
6474 * regular expressions, with tags search: Tag searches. (line 63)
6475 * remember.el <1>: Cooperation. (line 33)
6476 * remember.el: Remember. (line 6)
6477 * remote editing, from agenda: Agenda commands. (line 106)
6478 * remote editing, undo: Agenda commands. (line 107)
6479 * richer text: Enhancing text. (line 6)
6480 * RMAIL links: External links. (line 6)
6481 * SCHEDULED keyword: Time stamps. (line 40)
6482 * scheduling: Time stamps. (line 6)
6483 * scheduling, repeating: Repeating items. (line 6)
6484 * search option in file links: Search options. (line 6)
6485 * search strings, custom: Custom searches. (line 6)
6486 * searching for tags: Tag searches. (line 6)
6487 * section-numbers: Export options. (line 25)
6488 * setting tags: Setting tags. (line 6)
6489 * SHELL links: External links. (line 6)
6490 * show all, command: Visibility cycling. (line 33)
6491 * show all, global visibility state: Visibility cycling. (line 22)
6492 * show hidden text: Visibility cycling. (line 6)
6493 * showall, STARTUP keyword: In-buffer settings. (line 22)
6494 * showstars, STARTUP keyword: In-buffer settings. (line 42)
6495 * sorting, of agenda items: Sorting of agenda items.
6497 * sparse tree, for deadlines: Creating timestamps. (line 39)
6498 * sparse tree, for TODO: TODO basics. (line 26)
6499 * sparse tree, tag based: Tags. (line 6)
6500 * sparse trees: Sparse trees. (line 6)
6501 * special keywords: In-buffer settings. (line 6)
6502 * spreadsheet capabilities: The spreadsheet. (line 6)
6503 * statistics, for checkboxes: Checkboxes. (line 23)
6504 * storing links: Handling links. (line 9)
6505 * structure editing: Structure editing. (line 6)
6506 * structure of document: Document structure. (line 6)
6507 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
6508 * sublevels, inclusion into todo list: Global TODO list. (line 34)
6509 * subscript: Subscripts and Superscripts.
6511 * subtree cycling: Visibility cycling. (line 10)
6512 * subtree visibility states: Visibility cycling. (line 10)
6513 * subtree, cut and paste: Structure editing. (line 6)
6514 * subtree, subtree visibility state: Visibility cycling. (line 10)
6515 * subtrees, cut and paste: Structure editing. (line 6)
6516 * summary: Summary. (line 6)
6517 * superscript: Subscripts and Superscripts.
6519 * syntax, of formulas: Formula syntax for Calc.
6521 * table editor, built-in: Built-in table editor.
6523 * table editor, table.el: Cooperation. (line 37)
6524 * table of contents: Export options. (line 25)
6525 * table.el: Cooperation. (line 34)
6526 * tables <1>: Export options. (line 25)
6527 * tables: Tables. (line 6)
6528 * tables, export: Enhancing text. (line 24)
6529 * tables, in other modes: Tables in arbitrary syntax.
6531 * tag completion: Completion. (line 6)
6532 * tag searches: Tag searches. (line 6)
6533 * tags: Tags. (line 6)
6534 * tags view: Matching headline tags.
6536 * tags, setting: Setting tags. (line 6)
6537 * targets, for links: Internal links. (line 6)
6538 * targets, radio: Radio targets. (line 6)
6539 * tasks, breaking down: Breaking down tasks. (line 6)
6540 * templates, for remember: Remember templates. (line 6)
6541 * TeX interpretation: Embedded LaTeX. (line 6)
6542 * TeX macros <1>: Export options. (line 25)
6543 * TeX macros: Math symbols. (line 6)
6544 * TeX macros, export: Enhancing text. (line 21)
6545 * TeX symbol completion: Completion. (line 6)
6546 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
6547 * thanks: History and Acknowledgments.
6549 * time format, custom: Custom time format. (line 6)
6550 * time grid: Time-of-day specifications.
6552 * time stamps <1>: Time stamps. (line 6)
6553 * time stamps: Timestamps. (line 6)
6554 * time, reading in minibuffer: The date/time prompt.
6556 * time-of-day specification: Time-of-day specifications.
6558 * time-sorted view: Timeline. (line 6)
6559 * timeline, single file: Timeline. (line 6)
6560 * timerange: Time stamps. (line 31)
6561 * timestamp: Time stamps. (line 14)
6562 * timestamp, inactive: Time stamps. (line 24)
6563 * timestamps, creating: Creating timestamps. (line 6)
6564 * TODO items: TODO items. (line 6)
6565 * TODO items, repeating: Repeating items. (line 6)
6566 * TODO keyword matching: Global TODO list. (line 17)
6567 * TODO keyword matching, with tags search: Tag searches. (line 40)
6568 * todo keyword sets: Multiple sets in one file.
6570 * TODO keywords completion: Completion. (line 6)
6571 * TODO list, global: Global TODO list. (line 6)
6572 * TODO types: TODO types. (line 6)
6573 * TODO workflow: Workflow states. (line 6)
6574 * transient-mark-mode <1>: Export commands. (line 6)
6575 * transient-mark-mode <2>: ASCII export. (line 9)
6576 * transient-mark-mode <3>: Built-in table editor.
6578 * transient-mark-mode: Structure editing. (line 64)
6579 * translator function: Translator functions.
6581 * trees, sparse: Sparse trees. (line 6)
6582 * trees, visibility: Visibility cycling. (line 6)
6583 * tty keybindings: TTY keys. (line 6)
6584 * types as TODO keywords: TODO types. (line 6)
6585 * underlined text: Enhancing text. (line 15)
6586 * undoing remote-editing events: Agenda commands. (line 107)
6587 * updating, table: Updating the table. (line 6)
6588 * URL links: External links. (line 6)
6589 * USENET links: External links. (line 6)
6590 * variables, for customization: Customization. (line 6)
6591 * vectors, in table calculations: Formula syntax for Calc.
6593 * visibility cycling: Visibility cycling. (line 6)
6594 * visible text, printing: Sparse trees. (line 41)
6595 * VM links: External links. (line 6)
6596 * WANDERLUST links: External links. (line 6)
6597 * weekly agenda: Weekly/Daily agenda. (line 6)
6598 * windmove.el: Conflicts. (line 33)
6599 * workflow states as TODO keywords: Workflow states. (line 6)
6600 * XEmacs: Installation. (line 6)
6601 * XOXO export: XOXO export. (line 6)
6604 File: org, Node: Key Index, Prev: Index, Up: Top
6612 * $: Agenda commands. (line 121)
6613 * ': CDLaTeX mode. (line 43)
6614 * +: Agenda commands. (line 143)
6615 * ,: Agenda commands. (line 135)
6616 * -: Agenda commands. (line 149)
6617 * .: Agenda commands. (line 98)
6618 * :: Agenda commands. (line 129)
6619 * <: The date/time prompt.
6621 * <left>: Agenda commands. (line 95)
6622 * <RET> <1>: Agenda commands. (line 39)
6623 * <RET> <2>: Setting tags. (line 76)
6624 * <RET> <3>: The date/time prompt.
6626 * <RET>: Built-in table editor.
6628 * <right>: Agenda commands. (line 90)
6629 * <SPC> <1>: Agenda commands. (line 28)
6630 * <SPC>: Setting tags. (line 73)
6631 * <TAB> <1>: CDLaTeX mode. (line 23)
6632 * <TAB> <2>: Agenda commands. (line 33)
6633 * <TAB> <3>: Setting tags. (line 68)
6634 * <TAB> <4>: Editing and debugging formulas.
6636 * <TAB> <5>: Built-in table editor.
6638 * <TAB> <6>: Plain lists. (line 41)
6639 * <TAB>: Visibility cycling. (line 10)
6640 * > <1>: Agenda commands. (line 171)
6641 * >: The date/time prompt.
6643 * ^: CDLaTeX mode. (line 33)
6644 * _: CDLaTeX mode. (line 33)
6645 * `: CDLaTeX mode. (line 39)
6646 * a: Agenda commands. (line 132)
6647 * b: Agenda commands. (line 49)
6648 * C: Agenda commands. (line 211)
6649 * c: Agenda commands. (line 191)
6650 * C-#: Advanced features. (line 9)
6651 * C-': Agenda files. (line 18)
6652 * C-,: Agenda files. (line 18)
6653 * C-_: Agenda commands. (line 107)
6654 * C-a a L: Timeline. (line 10)
6655 * C-c !: Creating timestamps. (line 19)
6656 * C-c #: Checkboxes. (line 56)
6657 * C-c %: Handling links. (line 79)
6658 * C-c &: Handling links. (line 83)
6659 * C-c ': Editing and debugging formulas.
6661 * C-c *: Updating the table. (line 13)
6662 * C-c +: Built-in table editor.
6664 * C-c ,: Priorities. (line 18)
6665 * C-c -: Built-in table editor.
6667 * C-c .: Creating timestamps. (line 10)
6668 * C-c /: Sparse trees. (line 15)
6669 * C-c :: Enhancing text. (line 32)
6670 * C-c ;: Comment lines. (line 10)
6671 * C-c <: Creating timestamps. (line 23)
6672 * C-c <TAB>: Built-in table editor.
6674 * C-c = <1>: Editing and debugging formulas.
6676 * C-c =: Column formulas. (line 26)
6677 * C-c >: Creating timestamps. (line 27)
6678 * C-c ?: Editing and debugging formulas.
6680 * C-c [: Agenda files. (line 12)
6681 * C-c \: Tag searches. (line 9)
6682 * C-c ]: Agenda files. (line 15)
6683 * C-c ^ <1>: Built-in table editor.
6685 * C-c ^: Structure editing. (line 52)
6686 * C-c `: Built-in table editor.
6688 * C-c a !: Stuck projects. (line 14)
6689 * C-c a #: Stuck projects. (line 13)
6690 * C-c a a: Weekly/Daily agenda. (line 9)
6691 * C-c a C: Storing searches. (line 9)
6692 * C-c a M: Matching headline tags.
6694 * C-c a m: Matching headline tags.
6696 * C-c a M: Tag searches. (line 16)
6697 * C-c a m: Tag searches. (line 12)
6698 * C-c a T: Global TODO list. (line 14)
6699 * C-c a t <1>: Global TODO list. (line 9)
6700 * C-c a t: TODO basics. (line 36)
6701 * C-c C-a: Visibility cycling. (line 33)
6702 * C-c C-b: Motion. (line 15)
6703 * C-c C-c <1>: Cooperation. (line 37)
6704 * C-c C-c <2>: The very busy C-c C-c key.
6706 * C-c C-c <3>: Processing LaTeX fragments.
6708 * C-c C-c <4>: Setting tags. (line 10)
6709 * C-c C-c <5>: Checkboxes. (line 37)
6710 * C-c C-c <6>: Editing and debugging formulas.
6712 * C-c C-c <7>: Built-in table editor.
6714 * C-c C-c: Plain lists. (line 78)
6715 * C-c C-d <1>: Agenda commands. (line 156)
6716 * C-c C-d: Creating timestamps. (line 35)
6717 * C-c C-e: Exporting. (line 19)
6718 * C-c C-e a: ASCII export. (line 9)
6719 * C-c C-e b: Export commands. (line 7)
6720 * C-c C-e c: iCalendar export. (line 21)
6721 * C-c C-e H: Export commands. (line 10)
6722 * C-c C-e h: Export commands. (line 6)
6723 * C-c C-e I: iCalendar export. (line 16)
6724 * C-c C-e i: iCalendar export. (line 14)
6725 * C-c C-e t: Export options. (line 13)
6726 * C-c C-e v <1>: XOXO export. (line 11)
6727 * C-c C-e v: Sparse trees. (line 41)
6728 * C-c C-e v a: ASCII export. (line 13)
6729 * C-c C-e v b: Export commands. (line 13)
6730 * C-c C-e v H: Export commands. (line 13)
6731 * C-c C-e v h: Export commands. (line 13)
6732 * C-c C-e x: XOXO export. (line 10)
6733 * C-c C-f: Motion. (line 12)
6734 * C-c C-j: Motion. (line 21)
6735 * C-c C-l: Handling links. (line 25)
6736 * C-c C-n: Motion. (line 8)
6737 * C-c C-o <1>: Creating timestamps. (line 31)
6738 * C-c C-o: Handling links. (line 56)
6739 * C-c C-p: Motion. (line 9)
6740 * C-c C-q <1>: Editing and debugging formulas.
6742 * C-c C-q: Built-in table editor.
6744 * C-c C-r <1>: Editing and debugging formulas.
6746 * C-c C-r: Visibility cycling. (line 34)
6747 * C-c C-s <1>: Agenda commands. (line 153)
6748 * C-c C-s: Creating timestamps. (line 46)
6749 * C-c C-t <1>: Clocking work time. (line 27)
6750 * C-c C-t: TODO basics. (line 13)
6751 * C-c C-u: Motion. (line 18)
6752 * C-c C-v: TODO basics. (line 26)
6753 * C-c C-w: Creating timestamps. (line 39)
6754 * C-c C-x b: Visibility cycling. (line 41)
6755 * C-c C-x C-a: ARCHIVE tag. (line 28)
6756 * C-c C-x C-b: Checkboxes. (line 38)
6757 * C-c C-x C-c: Agenda commands. (line 218)
6758 * C-c C-x C-d: Clocking work time. (line 35)
6759 * C-c C-x C-i: Clocking work time. (line 12)
6760 * C-c C-x C-k: Structure editing. (line 39)
6761 * C-c C-x C-l: Processing LaTeX fragments.
6763 * C-c C-x C-n: Handling links. (line 89)
6764 * C-c C-x C-o: Clocking work time. (line 14)
6765 * C-c C-x C-p: Handling links. (line 89)
6766 * C-c C-x C-r: Clocking work time. (line 43)
6767 * C-c C-x C-s: Moving subtrees. (line 10)
6768 * C-c C-x C-t: Custom time format. (line 12)
6769 * C-c C-x C-u: Dynamic blocks. (line 21)
6770 * C-c C-x C-w <1>: Built-in table editor.
6772 * C-c C-x C-w: Structure editing. (line 39)
6773 * C-c C-x C-x: Clocking work time. (line 31)
6774 * C-c C-x C-y <1>: Built-in table editor.
6776 * C-c C-x C-y: Structure editing. (line 46)
6777 * C-c C-x M-w <1>: Built-in table editor.
6779 * C-c C-x M-w: Structure editing. (line 43)
6780 * C-c C-y <1>: Clocking work time. (line 22)
6781 * C-c C-y: Creating timestamps. (line 64)
6782 * C-c l: Handling links. (line 9)
6783 * C-c { <1>: CDLaTeX mode. (line 21)
6784 * C-c {: Editing and debugging formulas.
6786 * C-c |: Built-in table editor.
6788 * C-c }: Editing and debugging formulas.
6790 * C-c ~: Cooperation. (line 48)
6791 * C-k: Agenda commands. (line 115)
6792 * C-S-<left>: Multiple sets in one file.
6794 * C-S-<right>: Multiple sets in one file.
6796 * C-TAB: ARCHIVE tag. (line 38)
6797 * C-u C-c *: Updating the table. (line 16)
6798 * C-u C-c .: Creating timestamps. (line 14)
6799 * C-u C-c = <1>: Editing and debugging formulas.
6801 * C-u C-c =: Field formulas. (line 24)
6802 * C-u C-c C-c: Updating the table. (line 19)
6803 * C-u C-c C-l: Handling links. (line 41)
6804 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
6805 * C-u C-c C-x C-s: Moving subtrees. (line 12)
6806 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
6807 * C-u C-c C-x C-u: Clocking work time. (line 70)
6808 * C-u C-u C-c *: Updating the table. (line 22)
6809 * C-u C-u C-c =: Editing and debugging formulas.
6811 * C-x C-s: Editing and debugging formulas.
6813 * D: Agenda commands. (line 72)
6814 * d: Agenda commands. (line 69)
6815 * f: Agenda commands. (line 42)
6816 * g: Agenda commands. (line 76)
6817 * H: Agenda commands. (line 215)
6818 * i: Agenda commands. (line 196)
6819 * I: Agenda commands. (line 176)
6820 * l: Agenda commands. (line 55)
6821 * L: Agenda commands. (line 30)
6822 * M: Agenda commands. (line 202)
6823 * M-<down> <1>: Editing and debugging formulas.
6825 * M-<down>: Built-in table editor.
6827 * M-<left> <1>: Built-in table editor.
6829 * M-<left>: Structure editing. (line 21)
6830 * M-<RET> <1>: Plain lists. (line 46)
6831 * M-<RET>: Structure editing. (line 6)
6832 * M-<right> <1>: Built-in table editor.
6834 * M-<right>: Structure editing. (line 24)
6835 * M-<TAB> <1>: Completion. (line 10)
6836 * M-<TAB> <2>: Setting tags. (line 6)
6837 * M-<TAB> <3>: Per file keywords. (line 23)
6838 * M-<TAB>: Editing and debugging formulas.
6840 * M-<up> <1>: Editing and debugging formulas.
6842 * M-<up>: Built-in table editor.
6844 * M-S-<down> <1>: Editing and debugging formulas.
6846 * M-S-<down> <2>: Built-in table editor.
6848 * M-S-<down> <3>: Plain lists. (line 63)
6849 * M-S-<down>: Structure editing. (line 36)
6850 * M-S-<left> <1>: The date/time prompt.
6852 * M-S-<left> <2>: Built-in table editor.
6854 * M-S-<left> <3>: Plain lists. (line 69)
6855 * M-S-<left>: Structure editing. (line 27)
6856 * M-S-<RET> <1>: Checkboxes. (line 53)
6857 * M-S-<RET> <2>: Plain lists. (line 56)
6858 * M-S-<RET>: Structure editing. (line 18)
6859 * M-S-<right> <1>: The date/time prompt.
6861 * M-S-<right> <2>: Built-in table editor.
6863 * M-S-<right> <3>: Plain lists. (line 69)
6864 * M-S-<right>: Structure editing. (line 30)
6865 * M-S-<up> <1>: Editing and debugging formulas.
6867 * M-S-<up> <2>: Built-in table editor.
6869 * M-S-<up> <3>: Plain lists. (line 63)
6870 * M-S-<up>: Structure editing. (line 33)
6871 * mouse-1 <1>: Agenda commands. (line 33)
6872 * mouse-1 <2>: The date/time prompt.
6874 * mouse-1: Handling links. (line 70)
6875 * mouse-2 <1>: Agenda commands. (line 33)
6876 * mouse-2: Handling links. (line 70)
6877 * mouse-3 <1>: Agenda commands. (line 28)
6878 * mouse-3: Handling links. (line 75)
6879 * n: Agenda commands. (line 19)
6880 * O: Agenda commands. (line 180)
6881 * o: Agenda commands. (line 65)
6882 * P: Agenda commands. (line 140)
6883 * p: Agenda commands. (line 20)
6884 * q: Agenda commands. (line 227)
6885 * r <1>: Agenda commands. (line 80)
6886 * r: Global TODO list. (line 22)
6887 * S: Agenda commands. (line 206)
6888 * s: Agenda commands. (line 87)
6889 * S-<down> <1>: Agenda commands. (line 149)
6890 * S-<down> <2>: The date/time prompt.
6892 * S-<down> <3>: Creating timestamps. (line 56)
6893 * S-<down> <4>: Priorities. (line 23)
6894 * S-<down> <5>: Editing and debugging formulas.
6896 * S-<down>: Plain lists. (line 59)
6897 * S-<left> <1>: Agenda commands. (line 167)
6898 * S-<left> <2>: The date/time prompt.
6900 * S-<left> <3>: Creating timestamps. (line 51)
6901 * S-<left> <4>: Multiple sets in one file.
6903 * S-<left> <5>: TODO basics. (line 20)
6904 * S-<left>: Editing and debugging formulas.
6906 * S-<RET>: Built-in table editor.
6908 * S-<right> <1>: Agenda commands. (line 159)
6909 * S-<right> <2>: The date/time prompt.
6911 * S-<right> <3>: Creating timestamps. (line 51)
6912 * S-<right> <4>: Multiple sets in one file.
6914 * S-<right> <5>: TODO basics. (line 20)
6915 * S-<right>: Editing and debugging formulas.
6917 * S-<TAB> <1>: Built-in table editor.
6919 * S-<TAB>: Visibility cycling. (line 22)
6920 * S-<up> <1>: Agenda commands. (line 143)
6921 * S-<up> <2>: The date/time prompt.
6923 * S-<up> <3>: Creating timestamps. (line 56)
6924 * S-<up> <4>: Priorities. (line 23)
6925 * S-<up> <5>: Editing and debugging formulas.
6927 * S-<up>: Plain lists. (line 59)
6928 * T: Agenda commands. (line 124)
6929 * t: Agenda commands. (line 111)
6930 * w: Agenda commands. (line 66)
6931 * x: Agenda commands. (line 228)
6932 * X: Agenda commands. (line 183)
6938 Node: Introduction
\x7f11536
6939 Node: Summary
\x7f11951
6940 Node: Installation
\x7f14960
6941 Node: Activation
\x7f16338
6942 Node: Feedback
\x7f17587
6943 Node: Document structure
\x7f19663
6944 Node: Outlines
\x7f20437
6945 Node: Headlines
\x7f21097
6946 Node: Visibility cycling
\x7f21720
6947 Ref: Visibility cycling-Footnote-1
\x7f23934
6948 Ref: Visibility cycling-Footnote-2
\x7f23992
6949 Ref: Visibility cycling-Footnote-3
\x7f24042
6950 Node: Motion
\x7f24312
6951 Node: Structure editing
\x7f25096
6952 Node: Archiving
\x7f27922
6953 Node: ARCHIVE tag
\x7f28480
6954 Node: Moving subtrees
\x7f30273
6955 Node: Sparse trees
\x7f31584
6956 Ref: Sparse trees-Footnote-1
\x7f33716
6957 Ref: Sparse trees-Footnote-2
\x7f33898
6958 Node: Plain lists
\x7f34013
6959 Ref: Plain lists-Footnote-1
\x7f37782
6960 Ref: Plain lists-Footnote-2
\x7f38140
6961 Node: Tables
\x7f38324
6962 Node: Built-in table editor
\x7f38838
6963 Node: Narrow columns
\x7f45857
6964 Ref: Narrow columns-Footnote-1
\x7f47790
6965 Node: orgtbl-mode
\x7f47836
6966 Node: The spreadsheet
\x7f48640
6967 Node: References
\x7f49727
6968 Ref: References-Footnote-1
\x7f53856
6969 Node: Formula syntax for Calc
\x7f54145
6970 Node: Formula syntax for Lisp
\x7f56611
6971 Node: Field formulas
\x7f57880
6972 Node: Column formulas
\x7f59188
6973 Node: Editing and debugging formulas
\x7f60787
6974 Node: Updating the table
\x7f64940
6975 Node: Advanced features
\x7f65975
6976 Node: Hyperlinks
\x7f70500
6977 Node: Link format
\x7f71273
6978 Node: Internal links
\x7f72566
6979 Ref: Internal links-Footnote-1
\x7f74491
6980 Node: Radio targets
\x7f74623
6981 Node: External links
\x7f75314
6982 Node: Handling links
\x7f77718
6983 Ref: Handling links-Footnote-1
\x7f82828
6984 Ref: Handling links-Footnote-2
\x7f83065
6985 Node: Link abbreviations
\x7f83139
6986 Node: Search options
\x7f84818
6987 Ref: Search options-Footnote-1
\x7f86598
6988 Node: Custom searches
\x7f86679
6989 Node: Remember
\x7f87727
6990 Node: Setting up remember
\x7f88714
6991 Node: Remember templates
\x7f89296
6992 Ref: Remember templates-Footnote-1
\x7f92610
6993 Node: Storing notes
\x7f92708
6994 Node: TODO items
\x7f94516
6995 Node: TODO basics
\x7f95499
6996 Node: TODO extensions
\x7f97198
6997 Node: Workflow states
\x7f98017
6998 Ref: Workflow states-Footnote-1
\x7f99192
6999 Node: TODO types
\x7f99285
7000 Ref: TODO types-Footnote-1
\x7f100868
7001 Node: Multiple sets in one file
\x7f100950
7002 Node: Per file keywords
\x7f102561
7003 Ref: Per file keywords-Footnote-1
\x7f103850
7004 Node: Priorities
\x7f104051
7005 Node: Breaking down tasks
\x7f105297
7006 Ref: Breaking down tasks-Footnote-1
\x7f105817
7007 Node: Checkboxes
\x7f105913
7008 Node: Timestamps
\x7f108668
7009 Node: Time stamps
\x7f109202
7010 Ref: Time stamps-Footnote-1
\x7f112696
7011 Ref: Time stamps-Footnote-2
\x7f112812
7012 Node: Creating timestamps
\x7f112967
7013 Node: The date/time prompt
\x7f115625
7014 Ref: The date/time prompt-Footnote-1
\x7f117586
7015 Node: Custom time format
\x7f117692
7016 Node: Repeating items
\x7f119250
7017 Node: Progress logging
\x7f121060
7018 Node: Closing items
\x7f121706
7019 Ref: Closing items-Footnote-1
\x7f122640
7020 Ref: Closing items-Footnote-2
\x7f122709
7021 Node: Tracking TODO state changes
\x7f122782
7022 Node: Clocking work time
\x7f123638
7023 Ref: Clocking work time-Footnote-1
\x7f127284
7024 Ref: Clocking work time-Footnote-2
\x7f127362
7025 Node: Tags
\x7f127488
7026 Node: Tag inheritance
\x7f128250
7027 Node: Setting tags
\x7f129187
7028 Ref: Setting tags-Footnote-1
\x7f133710
7029 Ref: Setting tags-Footnote-2
\x7f133822
7030 Node: Tag searches
\x7f133905
7031 Node: Agenda views
\x7f136616
7032 Node: Agenda files
\x7f138561
7033 Ref: Agenda files-Footnote-1
\x7f139527
7034 Ref: Agenda files-Footnote-2
\x7f139676
7035 Node: Agenda dispatcher
\x7f139869
7036 Node: Built-in agenda views
\x7f141560
7037 Node: Weekly/Daily agenda
\x7f142138
7038 Node: Global TODO list
\x7f144267
7039 Node: Matching headline tags
\x7f146539
7040 Node: Timeline
\x7f147610
7041 Node: Stuck projects
\x7f148276
7042 Node: Presentation and sorting
\x7f149975
7043 Node: Categories
\x7f150766
7044 Node: Time-of-day specifications
\x7f151430
7045 Node: Sorting of agenda items
\x7f153401
7046 Node: Agenda commands
\x7f154683
7047 Node: Custom agenda views
\x7f161412
7048 Node: Storing searches
\x7f162087
7049 Node: Block agenda
\x7f163999
7050 Node: Setting Options
\x7f165229
7051 Node: Batch processing
\x7f167941
7052 Node: Embedded LaTeX
\x7f169071
7053 Ref: Embedded LaTeX-Footnote-1
\x7f170163
7054 Node: Math symbols
\x7f170353
7055 Node: Subscripts and Superscripts
\x7f171118
7056 Node: LaTeX fragments
\x7f171962
7057 Ref: LaTeX fragments-Footnote-1
\x7f174070
7058 Node: Processing LaTeX fragments
\x7f174332
7059 Node: CDLaTeX mode
\x7f175278
7060 Ref: CDLaTeX mode-Footnote-1
\x7f177762
7061 Node: Exporting
\x7f177910
7062 Node: ASCII export
\x7f179224
7063 Node: HTML export
\x7f180514
7064 Node: Export commands
\x7f181133
7065 Node: Quoting HTML tags
\x7f181944
7066 Node: Links
\x7f182574
7067 Node: Images
\x7f183271
7068 Ref: Images-Footnote-1
\x7f184142
7069 Node: CSS support
\x7f184203
7070 Ref: CSS support-Footnote-1
\x7f185522
7071 Node: XOXO export
\x7f185635
7072 Node: iCalendar export
\x7f186074
7073 Node: Text interpretation
\x7f187293
7074 Node: Comment lines
\x7f187835
7075 Node: Initial text
\x7f188230
7076 Node: Enhancing text
\x7f189904
7077 Ref: Enhancing text-Footnote-1
\x7f191766
7078 Node: Export options
\x7f191856
7079 Node: Publishing
\x7f193749
7080 Ref: Publishing-Footnote-1
\x7f194545
7081 Node: Configuration
\x7f194741
7082 Node: Project alist
\x7f195459
7083 Node: Sources and destinations
\x7f196525
7084 Node: Selecting files
\x7f197255
7085 Node: Publishing action
\x7f198003
7086 Node: Publishing options
\x7f199236
7087 Node: Publishing links
\x7f201388
7088 Node: Project page index
\x7f202901
7089 Node: Sample configuration
\x7f203679
7090 Node: Simple example
\x7f204171
7091 Node: Complex example
\x7f204844
7092 Node: Triggering publication
\x7f206920
7093 Node: Miscellaneous
\x7f207605
7094 Node: Completion
\x7f208239
7095 Node: Customization
\x7f209710
7096 Node: In-buffer settings
\x7f210293
7097 Node: The very busy C-c C-c key
\x7f214770
7098 Node: Clean view
\x7f216414
7099 Node: TTY keys
\x7f218991
7100 Node: Interaction
\x7f220601
7101 Node: Cooperation
\x7f220998
7102 Node: Conflicts
\x7f223740
7103 Node: Bugs
\x7f225332
7104 Node: Extensions and Hacking
\x7f226828
7105 Node: Extensions
\x7f227424
7106 Node: Tables in arbitrary syntax
\x7f229371
7107 Node: Radio tables
\x7f230448
7108 Node: A LaTeX example
\x7f232951
7109 Ref: A LaTeX example-Footnote-1
\x7f236597
7110 Ref: A LaTeX example-Footnote-2
\x7f236745
7111 Node: Translator functions
\x7f237180
7112 Ref: Translator functions-Footnote-1
\x7f240289
7113 Node: Dynamic blocks
\x7f240377
7114 Node: Special agenda views
\x7f242349
7115 Ref: Special agenda views-Footnote-1
\x7f244628
7116 Node: History and Acknowledgments
\x7f244888
7117 Node: Index
\x7f250748
7118 Node: Key Index
\x7f281729