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.59).
10 Copyright (C) 2004, 2005, 2006 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.59).
32 Copyright (C) 2004, 2005, 2006 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 * Table calculations:: Compute a field from other fields
95 * orgtbl-mode:: The table editor as minor mode
96 * table.el:: Complex tables
98 Calculations in tables
100 * Formula syntax:: How to write a formula
101 * Lisp formulas:: An alternative way to write formulas
102 * Column formulas:: Formulas valid for all fields in a column
103 * Advanced features:: Field names, parameters and automatic recalc
104 * Named-field formulas:: Formulas valid in single fields
105 * Editing/debugging formulas:: Changing a stored formula
106 * Appetizer:: Taste the power of calc
110 * Link format:: How links in Org-mode are formatted
111 * Internal links:: Links to other places in the current file
112 * External links:: URL-like links to the world
113 * Handling links:: Creating, inserting and following
114 * Link abbreviations:: Shortcuts for writing complex links
115 * Search options:: Linking to a specific location
116 * Custom searches:: When the default search is not enough
117 * Remember:: Org-trees store quick notes
121 * Radio targets:: Make targets trigger links in plain text.
122 * CamelCase links:: Activating CamelCase words as links
126 * TODO basics:: Marking and displaying TODO entries
127 * TODO extensions:: Workflow and assignments
128 * Priorities:: Some things are more important than others
129 * Breaking down tasks:: Splitting a task into managable pieces
130 * Checkboxes:: Tick-off lists
132 Extended use of TODO keywords
134 * Workflow states:: From TODO to DONE in steps
135 * TODO types:: I do this, Fred the rest
136 * Per file keywords:: Different files, different requirements
140 * Time stamps:: Assigning a time to a tree entry
141 * Creating timestamps:: Commands which insert timestamps
142 * Custom time format:: If you cannot work with the ISO format
143 * Progress logging:: Documenting when what work was done.
147 * The date/time prompt:: How org-mode helps you entering date and time
151 * Closing items:: When was this entry marked DONE?
152 * Clocking work time:: When exactly did you work on this item?
156 * Tag inheritance:: Tags use the tree structure of the outline
157 * Setting tags:: How to assign tags to a headline
158 * Tag searches:: Searching for combinations of tags
162 * Agenda files:: Files being searched for agenda information
163 * Agenda dispatcher:: Keyboard access to agenda views
164 * Built-in agenda views:: What is available out of the box?
165 * Presentation and sorting:: How agenda items are prepared for display
166 * Agenda commands:: Remote editing of org trees
167 * Custom agenda views:: Defining special searches and views
169 The built-in agenda views
171 * Weekly/Daily agenda:: The calendar page with current tasks
172 * Global TODO list:: All unfinished action items
173 * Matching headline tags:: Structured information with fine-tuned search
174 * Timeline:: Time-sorted view for single file
175 * Stuck projects:: Find projects you need to review
177 Presentation and sorting
179 * Categories:: Not all tasks are equal
180 * Time-of-day specifications:: How the agenda knows the time
181 * Sorting of agenda items:: The order of things
185 * Storing searches:: Type once, use often
186 * Block agenda:: All the stuff you need in a single buffer
187 * Setting Options:: Changing the rules
188 * Batch processing:: Agenda views from the command line
192 * Math symbols:: TeX macros for symbols and Greek letters
193 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
194 * LaTeX fragments:: Complex formulas made easy
195 * Processing LaTeX fragments:: Previewing LaTeX processing
196 * CDLaTeX mode:: Speed up entering of formulas
200 * ASCII export:: Exporting to plain ASCII
201 * HTML export:: Exporting to HTML
202 * XOXO export:: Exporting to XOXO
203 * iCalendar export:: Exporting in iCalendar format
204 * Text interpretation:: How the exporter looks at the file
206 Text interpretation by the exporter
208 * Comment lines:: Some lines will not be exported
209 * Enhancing text:: Subscripts, symbols and more
210 * Export options:: How to influence the export settings
214 * Configuration:: Defining projects
215 * Sample configuration:: Example projects
216 * Triggering publication:: Publication commands
220 * Project alist:: The central configuration variable
221 * Sources and destinations:: From here to there
222 * Selecting files:: What files are part of the project?
223 * Publishing action:: Setting the function doing the publishing
224 * Publishing options:: Tweaking HTML export
225 * Publishing links:: Which links keep working after publishing?
226 * Project page index:: Publishing a list of project files
230 * Simple example:: One-component publishing
231 * Complex example:: A multi-component publishing example
235 * Completion:: M-TAB knows what you need
236 * Customization:: Adapting Org-mode to your taste
237 * In-buffer settings:: Overview of the #+KEYWORDS
238 * The very busy C-c C-c key:: When in doubt, press C-c C-c
239 * Clean view:: Getting rid of leading stars in the outline
240 * TTY keys:: Using Org-mode on a tty
241 * Interaction:: Other Emacs packages
242 * Bugs:: Things which do not work perfectly
244 Interaction with other packages
246 * Cooperation:: Packages Org-mode cooperates with
247 * Conflicts:: Packages that lead to conflicts
249 Extensions, Hooks and Hacking
251 * Extensions:: Existing 3rd-part extensions
252 * Dynamic blocks:: Automatically filled blocks
253 * Special agenda views::
256 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
263 * Summary:: Brief summary of what Org-mode does
264 * Installation:: How to install a downloaded version of Org-mode
265 * Activation:: How to activate Org-mode for certain buffers.
266 * Feedback:: Bug reports, ideas, patches etc.
269 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
274 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
275 project planning with a fast and effective plain-text system.
277 Org-mode develops organizational tasks around NOTES files that
278 contain lists or information about projects as plain text. Org-mode is
279 implemented on top of outline-mode, which makes it possible to keep the
280 content of large files well structured. Visibility cycling and
281 structure editing help to work with the tree. Tables are easily created
282 with a built-in table editor. Org-mode supports ToDo items, deadlines,
283 time stamps, and scheduling. It dynamically compiles entries into an
284 agenda that utilizes and smoothly integrates much of the Emacs calendar
285 and diary. Plain text URL-like links connect to websites, emails,
286 Usenet messages, BBDB entries, and any files related to the projects.
287 For printing and sharing of notes, an Org-mode file can be exported as a
288 structured ASCII file, as HTML, or (todo and agenda items only) as an
289 iCalendar file. It can also serve as a publishing tool for a set of
292 An important design aspect that distinguishes Org-mode from for
293 example Planner/Muse is that it encougages to store every piece of
294 information only once. In Planner, you have project pages, day pages
295 and possibly other files, duplicating some information such as tasks.
296 In Org-mode, you only have notes files. In your notes you mark entries
297 as tasks, label them with tags and timestamps. All necessary lists
298 like a schedule for the day, the agenda for a meeting, tasks lists
299 selected by tags etc are created dynamically when you need them.
301 Org-mode keeps simple things simple. When first fired up, it should
302 feel like a straightforward, easy to use outliner. Complexity is not
303 imposed, but a large amount of functionality is available when you need
304 it. Org-mode can be used on different levels and in different ways, for
307 * as an outline extension with visibility cycling and structure editing
308 * as an ASCII system and table editor for taking structured notes
309 * as an ASCII table editor with spreadsheet-like capabilities
310 * as a TODO list editor
311 * as a full agenda and planner with deadlines and work scheduling
312 * as an environment to implement David Allen's GTD system
313 * as a simple hypertext system, with HTML export
314 * as a publishing tool to create a set of interlinked webpages
316 Org-mode's automatic, context sensitive table editor can be
317 integrated into any major mode by activating the minor Orgtbl-mode.
319 There is a website for Org-mode which provides links to the newest
320 version of Org-mode, as well as additional information, frequently asked
321 questions (FAQ), links to tutorials etc. This page is located at
322 `http://www.astro.uva.nl/~dominik/Tools/org/'.
325 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
330 Important: If Org-mode is part of the Emacs distribution or an XEmacs
331 package, please skip this section and go directly to *Note Activation::.
333 If you have downloaded Org-mode from the Web, you must take the
334 following steps to install it: Go into the Org-mode distribution
335 directory and edit the top section of the file `Makefile'. You must
336 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
337 and the paths to the directories where local Lisp and Info files are
338 kept. If you don't have access to the system-wide directories, create
339 your own two directories for these files, enter them into the Makefile,
340 and make sure Emacs finds the Lisp files by adding the following line
343 (setq load-path (cons "~/path/to/lispdir" load-path))
345 XEmacs users now need to install the file `noutline.el' from the
346 `xemacs' subdirectory of the Org-mode distribution. Use the command:
348 make install-noutline
350 Now byte-compile and install the Lisp files with the shell commands:
355 If you want to install the info documentation, use this command:
359 Then add to `.emacs':
361 ;; This line only if org-mode is not part of the X/Emacs distribution.
362 (require 'org-install)
365 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
370 Add the following lines to your `.emacs' file. The last two lines
371 define _global_ keys for the commands `org-store-link' and `org-agenda'
372 - please choose suitable keys yourself.
374 ;; The following lines are always needed. Choose your own keys.
375 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
376 (define-key global-map "\C-cl" 'org-store-link)
377 (define-key global-map "\C-ca" 'org-agenda)
379 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
380 because significant functionality depends on font-locking being active.
381 You can do this with either one of the following two lines (XEmacs
382 user must use the second option):
383 (global-font-lock-mode 1) ; for all buffers
384 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
386 With this setup, all files with extension `.org' will be put into
387 Org-mode. As an alternative, make the first line of a file look like
390 MY PROJECTS -*- mode: org; -*-
392 which will select Org-mode for this buffer no matter what the file's
393 name is. See also the variable `org-insert-mode-line-in-empty-file'.
396 File: org, Node: Feedback, Prev: Activation, Up: Introduction
401 If you find problems with Org-mode, or if you have questions, remarks,
402 or ideas about it, please contact the maintainer Carsten Dominik at
403 <dominik at science dot uva dot nl>.
405 For bug reports, please provide as much information as possible,
406 including the version information of Emacs (`C-h v emacs-version
407 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
408 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
409 can be very useful (see below on how to create one). Often a small
410 example file helps, along with clear information about:
412 1. What exactly did you do?
414 2. What did you expect to happen?
416 3. What happened instead?
417 Thank you for helping to improve this mode.
419 How to create a useful backtrace
420 ................................
422 If working with Org-mode produces an error with a message you don't
423 understand, you may have hit a bug. The best way to report this is by
424 providing, in addition to what was mentioned above, a _Backtrace_.
425 This is information from the built-in debugger about where and how the
426 error occurred. Here is how to produce a useful backtrace:
428 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
429 original Lisp code in `org.el' instead of the compiled version in
430 `org.elc'. The backtrace contains much more information if it is
431 produced with uncompiled code. To do this, either rename `org.elc'
432 to something else before starting Emacs, or ask Emacs explicitly
433 to load `org.el' by using the command line
434 emacs -l /path/to/org.el
436 2. Go to the `Options' menu and select `Enter Debugger on Error'
437 (XEmacs has this option in the `Troubleshooting' sub-menu).
439 3. Do whatever you have to do to hit the error. Don't forget to
440 document the steps you take.
442 4. When you hit the error, a `*Backtrace*' buffer will appear on the
443 screen. Save this buffer to a file (for example using `C-x C-w')
444 and attach it to your bug report.
447 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
452 Org-mode is based on outline mode and provides flexible commands to
453 edit the structure of the document.
457 * Outlines:: Org-mode is based on outline-mode
458 * Headlines:: How to typeset org-tree headlines
459 * Visibility cycling:: Show and hide, much simplified
460 * Motion:: Jumping to other headlines
461 * Structure editing:: Changing sequence and level of headlines
462 * Archiving:: Move done task trees to a different place
463 * Sparse trees:: Matches embedded in context
464 * Plain lists:: Additional structure within an entry
467 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
472 Org-mode is implemented on top of outline-mode. Outlines allow to
473 organize a document in a hierarchical structure, which (at least for
474 me) is the best representation of notes and thoughts. Overview over
475 this structure is achieved by folding (hiding) large parts of the
476 document to show only the general document structure and the parts
477 currently being worked on. Org-mode greatly simplifies the use of
478 outlines by compressing the entire show/hide functionality into a
479 single command `org-cycle', which is bound to the <TAB> key.
482 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
487 Headlines define the structure of an outline tree. The headlines in
488 Org-mode start with one or more stars, on the left margin. For example:
496 * Another top level headline
498 Some people find the many stars too noisy and would prefer an outline
499 that has whitespace followed by a single star as headline starters.
500 *Note Clean view:: describes a setup to realize this.
503 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
505 2.3 Visibility cycling
506 ======================
508 Outlines make it possible to hide parts of the text in the buffer.
509 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
510 the visibility in the buffer.
513 _Subtree cycling_: Rotate current subtree between the states
515 ,-> FOLDED -> CHILDREN -> SUBTREE --.
516 '-----------------------------------'
518 The cursor must be on a headline for this to work(1). When the
519 cursor is at the beginning of the buffer and the first line is not
520 a headline, then <TAB> actually runs global cycling (see
521 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
522 global cycling is invoked.
526 _Global cycling_: Rotate the entire buffer between the states
528 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
529 '--------------------------------------'
531 Note that inside tables, `S-<TAB>' jumps to the previous field.
537 Reveal context around point, showing the current entry, the
538 following heading and the hierarchy above. Useful for working
539 near a location exposed by a sparse tree command (*note Sparse
540 trees::) or an agenda command (*note Agenda commands::).
543 Show the current subtree in an indirect buffer(3). With numerical
544 prefix ARG, go up to this level and then take that tree. If ARG
545 is negative, go up that many levels. With `C-u' prefix, do not
546 remove the previously used indirect buffer.
548 When Emacs first visits an Org-mode file, the global state is set to
549 OVERVIEW, i.e. only the top level headlines are visible. This can be
550 configured through the variable `org-startup-folded', or on a per-file
551 basis by adding one of the following lines anywhere in the buffer:
557 ---------- Footnotes ----------
559 (1) see, however, the option `org-cycle-emulate-tab'.
561 (2) see the option `org-cycle-global-at-bob'.
563 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
564 Buffers.) will contain the entire buffer, but will be narrowed to the
565 current tree. Editing the indirect buffer will also change the
566 original buffer, but without affecting visibility in that buffer.
569 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
574 The following commands jump to other headlines in the buffer.
583 Next heading same level.
586 Previous heading same level.
589 Backward to higher level heading.
592 Jump to a different place without changing the current outline
593 visibility. Shows the document structure in a temporary buffer,
594 where you can use visibility cycling (<TAB>) to find your
595 destination. After pressing <RET>, the cursor moves to the
596 selected location in the original buffer, and the headings
597 hierarchy above it is made visible.
600 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
602 2.5 Structure editing
603 =====================
606 Insert new heading with same level as current. If the cursor is
607 in a plain list item, a new item is created (*note Plain lists::).
608 To force creation of a new headline, use a prefix arg, or first
609 press <RET> to get to the beginning of the next line. When this
610 command is used in the middle of a line, the line is split and the
611 rest of the line becomes the new headline. If the command is used
612 at the beginning of a headline, the new headline is created before
613 the current line. If at the beginning of any other line, the
614 content of that line is made the new heading. If the command is
615 used at the end of a folded subtree (i.e. behind the ellipses at
616 the end of a headline), then a headline like the current one will
617 be inserted after the end of the subtree.
620 Insert new TODO entry with same level as current heading.
623 Promote current heading by one level.
626 Demote current heading by one level.
629 Promote the current subtree by one level.
632 Demote the current subtree by one level.
635 Move subtree up (swap with previous subtree of same level).
638 Move subtree down (swap with next subtree of same level).
642 Kill subtree, i.e. remove it from buffer but save in kill ring.
645 Copy subtree to kill ring.
648 Yank subtree from kill ring. This does modify the level of the
649 subtree to make sure the tree fits in nicely at the yank position.
650 The yank level can also be specified with a prefix arg, or by
651 yanking after a headline marker like `****'.
654 Sort same-level entries. When there is an active region, all
655 entries in the region will be sorted. Otherwise the children of
656 the current headline are sorted. The command prompts for the
657 sorting method, which can be alphabetically, numerically, by time
658 (using the first time stamp in each entry), and each of these in
659 reverse order. With a `C-u' prefix, sorting will be
660 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
661 will also be removed.
663 When there is an active region (transient-mark-mode), promotion and
664 demotion work on all headlines in the region. To select a region of
665 headlines, it is best to place both point and mark at the beginning of a
666 line, mark at the beginning of the first headline, and point at the line
667 just after the last headline to change. Note that when the cursor is
668 inside a table (*note Tables::), the Meta-Cursor keys have different
672 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
677 When a project represented by a (sub)tree is finished, you may want to
678 move the tree out of the way and to stop it from contributing to the
679 agenda. Org-mode knows two ways of archiving. You can mark a tree with
680 the ARCHIVE tag, or you can move an entire (sub)tree to a different
685 * ARCHIVE tag:: Marking a tree as inactive
686 * Moving subtrees:: Moving a tree to an archive file
689 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
691 2.6.1 The ARCHIVE tag
692 ---------------------
694 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
695 its location in the outline tree, but behaves in the following way:
696 - It does not open when you attempt to do so with a visibility
697 cycling command (*note Visibility cycling::). You can force
698 cycling archived subtrees with `C-<TAB>', or by setting the option
699 `org-cycle-open-archived-trees'. Also normal outline commands like
700 `show-all' will open archived subtrees.
702 - During sparse tree construction (*note Sparse trees::), matches in
703 archived subtrees are not exposed, unless you configure the option
704 `org-sparse-tree-open-archived-trees'.
706 - During agenda view construction (*note Agenda views::), the
707 content of archived trees is ignored unless you configure the
708 option `org-agenda-skip-archived-trees'.
710 - Archived trees are not exported (*note Exporting::), only the
711 headline is. Configure the details using the variable
712 `org-export-with-archived-trees'.
714 The following commands help managing the ARCHIVE tag:
717 Toggle the ARCHIVE tag for the current headline. When the tag is
718 set, the headline changes to a shadowish face, and the subtree
722 Check if any direct children of the current headline should be
723 archived. To do this, each subtree is checked for open TODO
724 entries. If none are found, the command offers to set the ARCHIVE
725 tag for the child. If the cursor is _not_ on a headline when this
726 command is invoked, the level 1 trees will be checked.
729 Cycle a tree even if it is tagged with ARCHIVE.
732 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
734 2.6.2 Moving subtrees
735 ---------------------
737 Once an entire project is finished, you may want to move it to a
738 different location, either in the current file, or even in a different
739 file, the archive file.
742 Archive the subtree starting at the cursor position to the location
743 given by `org-archive-location'.
746 Check if any direct children of the current headline could be
747 moved to the archive. To do this, each subtree is checked for
748 open TODO entries. If none are found, the command offers to move
749 it to the archive location. If the cursor is _not_ on a headline
750 when this command is invoked, the level 1 trees will be checked.
752 The default archive location is a file in the same directory as the
753 current file, with the name derived by appending `_archive' to the
754 current file name. For information and examples on how to change this,
755 see the documentation string of the variable `org-archive-location'.
758 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
763 An important feature of Org-mode is the ability to construct _sparse
764 trees_ for selected information in an outline tree. A sparse tree
765 means that the entire document is folded as much as possible, but the
766 selected information is made visible along with the headline structure
767 above it(1). Just try it out and you will see immediately how it works.
769 Org-mode contains several commands creating such trees. The most
770 basic one is `org-occur':
773 Occur. Prompts for a regexp and shows a sparse tree with all
774 matches. If the match is in a headline, the headline is made
775 visible. If the match is in the body of an entry, headline and
776 body are made visible. In order to provide minimal context, also
777 the full hierarchy of headlines above the match is shown, as well
778 as the headline following the match. Each match is also
779 highlighted; the highlights disappear when the bufer is changes an
780 editing command, or by pressing `C-c C-c'. When called with a
781 `C-u' prefix argument, previous highlights are kept, so several
782 calls to this command can be stacked.
783 For frequently used sparse trees of specific search strings, you can
784 use the variable `org-agenda-custom-commands' to define fast keyboard
785 access to specific sparse trees. These commands will then be
786 accessible through the agenda dispatcher (*note Agenda dispatcher::).
789 (setq org-agenda-custom-commands
790 '(("f" occur-tree "FIXME")))
792 will define the key `C-c a f' as a shortcut for creating a sparse tree
793 matching the string `FIXME'.
795 Other commands use sparse trees as well. For example `C-c C-v'
796 creates a sparse TODO tree (*note TODO basics::).
798 To print a sparse tree, you can use the Emacs command
799 `ps-print-buffer-with-faces' which does not print invisible parts of
800 the document (2). Or you can use the command `C-c C-e v' to export
801 only the visible part of the document and print the resulting file.
803 ---------- Footnotes ----------
805 (1) See also the variables `org-show-hierarchy-above' and
806 `org-show-following-heading'.
808 (2) This does not work under XEmacs, because XEmacs uses selective
809 display for outlining, not text properties.
812 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
817 Within an entry of the outline tree, hand-formatted lists can provide
818 additional structure. They also provide a way to create lists of
819 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
820 and the HTML exporter (*note Exporting::) does parse and format them.
822 Org-mode knows ordered and unordered lists. Unordered list items
823 start with `-', `+', or `*'(1) as bullets. Ordered list items start
824 with `1.' or `1)'. Items belonging to the same list must have the same
825 indentation on the first line. In particular, if an ordered list
826 reaches number `10.', then the 2-digit numbers must be written
827 left-aligned with the other numbers in the list. Indentation also
828 determines the end of a list item. It ends before the next line that
829 is indented like the bullet/number, or less. For example:
832 My favorite scenes are (in this order)
833 1. The attack of the Rohirrim
834 2. Eowyns fight with the witch king
835 + this was already my favorite scene in the book
836 + I really like Miranda Otto.
837 3. Peter Jackson being shot by Legolas
839 He makes a really funny face when it happens.
840 But in the end, not individual scenes matter but the film as a whole.
842 Org-mode supports these lists by tuning filling and wrapping
843 commands to deal with them correctly(2).
845 The following commands act on items when the cursor is in the first
846 line of an item (the line with the bullet or number).
849 Items can be folded just like headline levels if you set the
850 variable `org-cycle-include-plain-lists'. The level of an item is
851 then given by the indentation of the bullet/number. Items are
852 always subordinate to real headlines, however; the hierarchies
853 remain completely separated.
856 Insert new item at current level. With prefix arg, force a new
857 heading (*note Structure editing::). If this command is used in
858 the middle of a line, the line is _split_ and the rest of the line
859 becomes the new item. If this command is executed in the
860 _whitespace before a bullet or number_, the new item is created
861 _before_ the current item. If the command is executed in the
862 white space before the text that is part of an item but does not
863 contain the bullet, a bullet is added to the current line.
866 Insert a new item with a checkbox (*note Checkboxes::).
870 Jump to the previous/next item in the current list.
874 Move the item including subitems up/down (swap with previous/next
875 item of same indentation). If the list is ordered, renumbering is
880 Decrease/increase the indentation of the item, including subitems.
881 Initially, the item tree is selected based on current indentation.
882 When these commands are executed several times in direct
883 succession, the initially selected region is used, even if the new
884 indentation would imply a different hierarchy. To use the new
885 hierarchy, break the command chain with a cursor motion or so.
888 If there is a checkbox (*note Checkboxes::) in the item line,
889 toggle the state of the checkbox. Otherwise, if this is an
890 ordered list, renumber the ordered list at the cursor.
892 ---------- Footnotes ----------
894 (1) When using `*' as a bullet, lines must be indented or they will
895 be seen as top-level headlines. Also, when you are hiding leading
896 stars to get a clean outline view, plain list items starting with a
897 star are visually indistinguishable from true headlines. In short:
898 even though `*' is supported, it may be better not to use it for plain
901 (2) Org-mode only changes the filling settings for Emacs. For
902 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
907 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
912 Org-mode has a very fast and intuitive table editor built-in.
913 Spreadsheet-like calculations are supported in connection with the
914 Emacs `calc' package.
918 * Built-in table editor:: Simple tables
919 * Narrow columns:: Stop wasting space in tables
920 * Table calculations:: Compute a field from other fields
921 * orgtbl-mode:: The table editor as minor mode
922 * table.el:: Complex tables
925 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
927 3.1 The built-in table editor
928 =============================
930 Org-mode makes it easy to format tables in plain ASCII. Any line with
931 `|' as the first non-white character is considered part of a table.
932 `|' is also the column separator. A table might look like this:
934 | Name | Phone | Age |
935 |-------+-------+-----|
936 | Peter | 1234 | 17 |
939 A table is re-aligned automatically each time you press <TAB> or
940 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
941 field (<RET> to the next row) and creates new table rows at the end of
942 the table or before horizontal lines. The indentation of the table is
943 set by the first line. Any line starting with `|-' is considered as a
944 horizontal separator line and will be expanded on the next re-align to
945 span the whole table width. So, to create the above table, you would
951 and then press <TAB> to align the table and start filling in fields.
953 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
954 and all character keys in a special way, so that inserting and deleting
955 avoids shifting other fields. Also, when typing _immediately after the
956 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
957 the field is automatically made blank. If this behavior is too
958 unpredictable for you, configure the variables
959 `org-enable-table-editor' and `org-table-auto-blank-field'.
961 Creation and conversion
962 .......................
965 Convert the active region to table. If every line contains at
966 least one TAB character, the function assumes that the material is
967 tab separated. If not, lines are split at whitespace into fields.
968 You can use a prefix argument to indicate the minimum number of
969 consecutive spaces required to identify a field separator
971 If there is no active region, this command creates an empty
972 Org-mode table. But it's easier just to start typing, like
973 `|Name|Phone|Age <RET> |- <TAB>'.
975 Re-aligning and field motion
976 ............................
979 Re-align the table without moving the cursor.
982 Re-align the table, move to the next field. Creates a new row if
986 Re-align, move to previous field.
989 Re-align the table and move down to next row. Creates a new row if
990 necessary. At the beginning or end of a line, <RET> still does
991 NEWLINE, so it can be used to split a table.
993 Column and row editing
994 ......................
998 Move the current column left/right.
1001 Kill the current column.
1004 Insert a new column to the left of the cursor position.
1008 Move the current row up/down.
1011 Kill the current row or horizontal line.
1014 Insert a new row above (with arg: below) the current row.
1017 Insert a horizontal line below current row. With prefix arg, the
1018 line is created above the current line.
1021 Sort the table lines in the region. The position of point
1022 indicates the column to be used for sorting, and the range of
1023 lines is the range between the nearest horizontal separator lines,
1024 or the entire table. If point is before the first column, you
1025 will be prompted for the sorting column. If there is an active
1026 region, the mark specifies the first line and the sorting column,
1027 while point should be in the last line to be included into the
1028 sorting. The command prompts for the sorting type
1029 (alphabetically, numerically, or by time). When called with a
1030 prefix argument, alphabetic sorting will be case-sensitive.
1036 Copy a rectangular region from a table to a special clipboard.
1037 Point and mark determine edge fields of the rectangle. The
1038 process ignores horizontal separator lines.
1041 Copy a rectangular region from a table to a special clipboard, and
1042 blank all fields in the rectangle. So this is the "cut" operation.
1045 Paste a rectangular region into a table. The upper right corner
1046 ends up in the current field. All involved fields will be
1047 overwritten. If the rectangle does not fit into the present table,
1048 the table is enlarged as needed. The process ignores horizontal
1052 Wrap several fields in a column like a paragraph. If there is an
1053 active region, and both point and mark are in the same column, the
1054 text in the column is wrapped to minimum width for the given
1055 number of lines. A prefix ARG may be used to change the number of
1056 desired lines. If there is no region, the current field is split
1057 at the cursor position and the text fragment to the right of the
1058 cursor is prepended to the field one line down. If there is no
1059 region, but you specify a prefix ARG, the current field is made
1060 blank, and the content is appended to the field above.
1066 Install a new formula for the current column and replace current
1067 field with the result of the formula.
1070 Install a new formula for the current field, which must be a named
1071 field. Evaluate the formula and replace the field content with the
1075 Edit all formulas associated with the current table in a separate
1079 Recalculate the current row by applying the stored formulas from
1080 left to right. When called with a `C-u' prefix, recalculate the
1081 entire table, starting with the first non-header line (i.e. below
1082 the first horizontal separator line). For details, see *Note
1083 Table calculations::.
1086 Rotate the calculation mark in first column through the states `',
1087 `#', `*', `!', `$'. For the meaning of these marks see *Note
1088 Advanced features::. When there is an active region, change all
1089 marks in the region.
1092 Which table column is the cursor in? Displays number >0 in echo
1096 Sum the numbers in the current column, or in the rectangle defined
1097 by the active region. The result is shown in the echo area and can
1098 be inserted with `C-y'.
1101 When current field is empty, copy from first non-empty field above.
1102 When not empty, copy current field down to next row and move cursor
1103 along with it. Depending on the variable
1104 `org-table-copy-increment', integer field values will be
1105 incremented during copy. This key is also used by CUA-mode (*note
1112 Edit the current field in a separate window. This is useful for
1113 fields that are not fully visible (*note Narrow columns::). When
1114 called with a `C-u' prefix, just make the full field visible, so
1115 that it can be edited in place.
1118 This is an alias for `C-u C-c `' to make the current field fully
1121 `M-x org-table-import'
1122 Import a file as a table. The table should be TAB- or whitespace
1123 separated. Useful, for example, to import an Excel table or data
1124 from a database, because these programs generally can write
1125 TAB-separated text files. This command works by inserting the
1126 file into the buffer and then converting the region to a table.
1127 Any prefix argument is passed on to the converter, which uses it
1128 to determine the separator.
1130 `M-x org-table-export'
1131 Export the table as a TAB-separated file. Useful for data
1132 exchange with, for example, Excel or database programs.
1135 If you don't like the automatic table editor because it gets in your
1136 way on lines which you would like to start with `|', you can turn it
1139 (setq org-enable-table-editor nil)
1141 Then the only table command that still works is `C-c C-c' to do a
1145 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
1150 The width of columns is automatically determined by the table editor.
1151 Sometimes a single field or a few fields need to carry more text,
1152 leading to inconveniently wide columns. To limit(1) the width of a
1153 column, one field anywhere in the column may contain just the string
1154 `<N>' where `N' is an integer specifying the width of the column in
1155 characters. The next re-align will then set the width of this column
1156 to no more than this value.
1158 |---+------------------------------| |---+--------|
1160 | 1 | one | | 1 | one |
1161 | 2 | two | ----\ | 2 | two |
1162 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1163 | 4 | four | | 4 | four |
1164 |---+------------------------------| |---+--------|
1166 Fields that are wider become clipped and end in the string `=>'. Note
1167 that the full text is still in the buffer, it is only invisible. To
1168 see the full text, hold the mouse over the field - a tooltip window
1169 will show the full content. To edit such a field, use the command `C-c
1170 `' (that is `C-c' followed by the backquote). This will open a new
1171 window with the full field. Edit it and finish with `C-c C-c'.
1173 When visiting a file containing a table with narrowed columns, the
1174 necessary character hiding has not yet happened, and the table needs to
1175 be aligned before it looks nice. Setting the option
1176 `org-startup-align-all-tables' will realign all tables in a file upon
1177 visiting, but also slow down startup. You can also set this option on
1178 a per-file basis with:
1183 ---------- Footnotes ----------
1185 (1) This feature does not work on XEmacs.
1188 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1190 3.3 Calculations in tables
1191 ==========================
1193 The table editor makes use of the Emacs `calc' package to implement
1194 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1195 derive fields from other fields. Org-mode has two levels of complexity
1196 for table calculations. On the basic level, tables do only horizontal
1197 computations, so a field can be computed from other fields _in the same
1198 row_, and Org-mode assumes that there is only one formula for each
1199 column. This is very efficient to work with and enough for many tasks.
1200 On the complex level, columns and individual fields can be named for
1201 easier referencing in formulas, individual named fields can have their
1202 own formula associated with them, and recalculation can be automated.
1206 * Formula syntax:: How to write a formula
1207 * Lisp formulas:: An alternative way to write formulas
1208 * Column formulas:: Formulas valid for all fields in a column
1209 * Advanced features:: Field names, parameters and automatic recalc
1210 * Named-field formulas:: Formulas valid in single fields
1211 * Editing/debugging formulas:: Changing a stored formula
1212 * Appetizer:: Taste the power of calc
1215 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1217 3.3.1 Formula syntax
1218 --------------------
1220 A formula can be any algebraic expression understood by the Emacs
1221 `calc' package. Note that `calc' has the slightly non-standard
1222 convention that `/' has lower precedence than `*', so that `a/b*c' is
1223 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1224 calc-eval: (calc)Calling Calc from Your Programs.), variable
1225 substitution takes place:
1227 $ refers to the current field
1228 $3 refers to the field in column 3 of the current row
1229 $3..$7 a vector of the fields in columns 3-7 of current row
1230 $P1..$P3 vector of column range, using column names
1231 &2 second data field above the current, in same column
1232 &5-2 vector from fifth to second field above current
1233 &III-II vector of fields between 2nd and 3rd hline above
1234 &III vector of fields between third hline above and current field
1235 $name a named field, parameter or constant
1237 The range vectors can be directly fed into the calc vector functions
1238 like `vmean' and `vsum'.
1240 `$name' is interpreted as the name of a column, parameter or
1241 constant. Constants are defined globally through the variable
1242 `org-table-formula-constants'. If you have the `constants.el' package,
1243 it will also be used to resolve constants, including natural constants
1244 like `$h' for Planck's constant, and units like `$km' for kilometers.
1245 Column names and parameters can be specified in special table lines.
1246 These are described below, see *Note Advanced features::.
1248 A formula can contain an optional mode string after a semicolon.
1249 This string consists of flags to influence calc's modes(1) during
1250 execution, e.g. `p20' to switch the internal precision to 20 digits,
1251 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1252 or fixed display format, respectively, and `D', `R', `F', and `S' to
1253 turn on degrees, radians, fraction and symbolic modes, respectively.
1254 In addition, you may provide a `printf' format specifier to reformat
1255 the final result. A few examples:
1257 $1+$2 Sum of first and second field
1258 $1+$2;%.2f Same, format result to two decimals
1259 exp($2)+exp($1) Math functions can be used
1260 $;%.1f Reformat current cell to 1 decimal
1261 ($3-32)*5/9 Degrees F -> C conversion
1262 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1263 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1264 sin($1);Dp3%.1e Same, but use printf specifier for display
1265 vmean($2..$7) Compute column range mean, using vector function
1266 vsum(&III) Sum numbers from 3rd hline above, up to here
1267 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1269 ---------- Footnotes ----------
1271 (1) By default, Org-mode uses the standard calc modes (precision 12,
1272 angular units degrees, fraction and symbolic modes off). The display
1273 format, however, has been changed to `(float 5)' to keep tables compact.
1274 The default settings can be configured using the variable
1275 `org-calc-default-modes'.
1278 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1280 3.3.2 Emacs Lisp forms as formulas
1281 ----------------------------------
1283 It is also possible to write a formula in Emacs lisp; this can be useful
1284 for string manipulation and control structures. If a formula starts
1285 with a single quote followed by an opening parenthesis, then it is
1286 evaluated as a lisp form. The evaluation should return either a string
1287 or a number. Just as with `calc' formulas, you can provide a format
1288 specifier after a semicolon. A few examples:
1290 swap the first two characters of the content of column 1
1291 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1292 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1296 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1298 3.3.3 Column formulas
1299 ---------------------
1301 To apply a formula to a field, type it directly into the field,
1302 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1303 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1304 be stored as the formula for the current column, evaluated and the
1305 current field replaced with the result. If the field contains only
1306 `=', the previously stored formula for this column is used.
1308 For each column, Org-mode will remember the most recently used
1309 formula. The information is stored in a special line starting with
1310 `#+TBLFM' directly below the table. When adding/deleting/moving
1311 columns with the appropriate commands, the stored equations will be
1312 modified accordingly. When a column used in a calculation is removed,
1313 references to this column become invalid and will cause an error upon
1314 applying the equation.
1316 Instead of typing an equation into the field, you may also use the
1317 command `C-c ='. It prompts for a formula (with default taken from the
1318 `#+TBLFM:' line) and applies it to the current field. A numerical
1319 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1320 in the current column.
1322 To recompute all the fields in a line, use the command `C-c *'. It
1323 re-applies all stored equations to the current row, from left to right.
1324 With a `C-u' prefix, this will be done to every line in the table, so
1325 use this command it you want to make sure the entire table is
1326 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1327 Global updating does not touch the line(s) above the first horizontal
1328 separator line, assuming that this is the table header.
1331 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1333 3.3.4 Advanced features
1334 -----------------------
1336 If you want the recalculation of fields to happen automatically, or if
1337 you want to be able to assign a formula to an individual field (instead
1338 of an entire column) you need to reserve the first column of the table
1339 for special marking characters. Here is an example of a table that
1340 collects exam results of students and makes use of these features:
1342 |---+---------+--------+--------+--------+-------+------|
1343 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1344 |---+---------+--------+--------+--------+-------+------|
1345 | ! | | P1 | P2 | P3 | Tot | |
1346 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1347 | ^ | | m1 | m2 | m3 | mt | |
1348 |---+---------+--------+--------+--------+-------+------|
1349 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1350 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1351 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1352 |---+---------+--------+--------+--------+-------+------|
1353 | | Average | | | | 29.7 | |
1354 | ^ | | | | | at | |
1355 | $ | max=50 | | | | | |
1356 |---+---------+--------+--------+--------+-------+------|
1357 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1359 Important: Please note that for these special tables, recalculating the
1360 table with `C-u C-c *' will only affect rows that are marked `#' or
1361 `*', and named fields. The column formulas are not applied in rows
1362 with empty first field.
1364 The marking characters have the following meaning:
1366 The fields in this line define names for the columns, so that you
1367 may refer to a column as `$Tot' instead of `$6'.
1370 This row defines names for the fields _above_ the row. With such
1371 a definition, any formula in the table may use `$m1' to refer to
1372 the value `10'. Also, named fields can have their own formula
1373 associated with them.
1376 Similar to `^', but defines names for the fields in the row
1380 Fields in this row can define _parameters_ for formulas. For
1381 example, if a field in a `$' row contains `max=50', then formulas
1382 in this table can refer to the value 50 using `$max'. Parameters
1383 work exactly like constants, only that they can be defined on a
1384 per-table basis. Changing a parameter and then recalculating the
1385 table can be useful.
1388 Fields in this row are automatically recalculated when pressing
1389 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1390 selected for a global recalculation with `C-u C-c *'. Unmarked
1391 lines will be left alone by this command.
1394 Selects this line for global recalculation with `C-u C-c *', but
1395 not for automatic recalculation. Use this when automatic
1396 recalculation slows down editing too much.
1399 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1400 All lines that should be recalculated should be marked with `#' or
1404 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1406 3.3.5 Named-field formulas
1407 --------------------------
1409 A named field can have its own formula associated with it. In the
1410 example above, this is used for the `at' field that contains the
1411 average result of the students. To enter a formula for a named field,
1412 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1413 This equation will be stored below the table like `$name=...'. Any
1414 recalculation in the table (even if only requested for the current
1415 line) will also update all named field formulas.
1418 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1420 3.3.6 Editing and debugging formulas
1421 ------------------------------------
1423 To edit a column or field formula, use the commands `C-c =' and `C-u
1424 C-c =', respectively. The currently active expression is then
1425 presented as default in the minibuffer, where it may be edited.
1427 Note that making a table field blank does not remove the formula
1428 associated with the field - during the next recalculation the field
1429 will be filled again. To remove a formula from a field, you have to
1430 give an empty reply when prompted for the formula, or to edit the
1433 You may edit the `#+TBLFM' directly and re-apply the changed
1434 equations with `C-c C-c' in that line, or with the normal recalculation
1435 commands in the table.
1437 In particular for large tables with many formulas, it is convenient
1438 to use the command `C-c '' to edit the formulas of the current table in
1439 a separate buffer. That buffer will show the formulas one per line,
1440 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1441 `$...' expression to get information about its interpretation.
1442 Exiting the buffer with `C-c C-c' only stores the modified formulas
1443 below the table. Exiting with `C-u C-c C-c' also applies them to the
1444 entire table. `C-c C-q' exits without installing the changes.
1446 When the evaluation of a formula leads to an error, the field content
1447 becomes the string `#ERROR'. If you would like see what is going on
1448 during variable substitution and calculation in order to find a bug,
1449 turn on formula debugging in the menu and repeat the calculation, for
1450 example by pressing `C-c = <RET>' in a field. Detailed information
1454 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1459 Finally, just to whet your appetite on what can be done with the
1460 fantastic `calc' package, here is a table that computes the Taylor
1461 series for a couple of functions (homework: try that with Excel :-)
1463 |---+-------------+---+-----+--------------------------------------|
1464 | | Func | n | x | Result |
1465 |---+-------------+---+-----+--------------------------------------|
1466 | # | exp(x) | 1 | x | 1 + x |
1467 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1468 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1469 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1470 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1471 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1472 |---+-------------+---+-----+--------------------------------------|
1473 #+TBLFM: $5=taylor($2,$4,$3);n3
1476 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1478 3.4 The Orgtbl minor mode
1479 =========================
1481 If you like the intuitive way the Org-mode table editor works, you
1482 might also want to use it in other modes like text-mode or mail-mode.
1483 The minor mode Orgtbl-mode makes this possible. You can always toggle
1484 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1487 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1490 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1492 3.5 The `table.el' package
1493 ==========================
1495 Complex ASCII tables with automatic line wrapping, column- and
1496 row-spanning, and alignment can be created using the Emacs table
1497 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1498 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1499 table, Org-mode will call `table-recognize-table' and move the cursor
1500 into the table. Inside a table, the keymap of Org-mode is inactive.
1501 In order to execute Org-mode-related commands, leave the table.
1504 Recognize `table.el' table. Works when the cursor is in a
1508 Insert a table.el table. If there is already a table at point,
1509 this command converts it between the table.el format and the
1510 Org-mode format. See the documentation string of the command
1511 `org-convert-table' for the restrictions under which this is
1515 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1520 Just like HTML, Org-mode provides links inside a file, and external
1521 links to other files, Usenet articles, emails, and much more.
1525 * Link format:: How links in Org-mode are formatted
1526 * Internal links:: Links to other places in the current file
1527 * External links:: URL-like links to the world
1528 * Handling links:: Creating, inserting and following
1529 * Link abbreviations:: Shortcuts for writing complex links
1530 * Search options:: Linking to a specific location
1531 * Custom searches:: When the default search is not enough
1532 * Remember:: Org-trees store quick notes
1535 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1540 Org-mode will recognize plain URL-like links and activate them as
1541 clickable links. The general link format, however, looks like this:
1543 [[link][description]] or alternatively [[link]]
1545 Once a link in the buffer is complete (all brackets present),
1546 Org-mode will change the display so that `description' is displayed
1547 instead of `[[link][description]]' and `link' is displayed instead of
1548 `[[link]]'. Links will be highlighted in the face `org-link', which by
1549 default is an underlined face. You can directly edit the visible part
1550 of a link. Note that this can be either the `link' part (if there is
1551 no description) or the `description' part. To edit also the invisible
1552 `link' part, use `C-c C-l' with the cursor on the link.
1554 If you place the cursor at the beginning or just behind the end of
1555 the displayed text and press <BACKSPACE>, you will remove the
1556 (invisible) bracket at that location. This makes the link incomplete
1557 and the internals are again displayed as plain text. Inserting the
1558 missing bracket hides the link internals again. To show the internal
1559 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1563 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1568 If the link does not look like a URL, it is considered to be internal in
1569 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1570 my target]]' lead to a text search in the current file. The link can
1571 be followed with `C-c C-o' when the cursor is on the link, or with a
1572 mouse click (*note Handling links::). The preferred match for such a
1573 link is a dedicated target: the same string in double angular brackets.
1574 Targets may be located anywhere; often it is convenient to put them
1575 into a comment line. For example
1579 In HTML export (*note HTML export::), such targets will become named
1580 anchors for direct access through `http' links(1).
1582 If no dedicated target exists, Org-mode will search for the words in
1583 the link. In the above example the search would be for `my target'.
1584 Links starting with a star like `*My Target' restrict the search to
1585 headlines. When searching, Org-mode will first try an exact match, but
1586 then move on to more and more lenient searches. For example, the link
1587 `[[*My Targets]]' will find any of the following:
1590 ** TODO my targets are bright
1591 ** my 20 targets are
1593 To insert a link targeting a headline, in-buffer completion can be
1594 used. Just type a star followed by a few optional letters into the
1595 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1596 offered as completions. *Note Handling links::, for more commands
1599 Following a link pushes a mark onto Org-mode's own mark ring. You
1600 can return to the previous position with `C-c &'. Using this command
1601 several times in direct succession goes back to positions recorded
1606 * Radio targets:: Make targets trigger links in plain text.
1607 * CamelCase links:: Activating CamelCase words as links
1609 ---------- Footnotes ----------
1611 (1) Note that text before the first headline will never be exported,
1612 so the first such target must be after the first headline.
1615 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1620 You can configure Org-mode to link any occurrences of certain target
1621 names in normal text. So without explicitly creating a link, the text
1622 connects to the target radioing its position. Radio targets are
1623 enclosed by triple angular brackets. For example, a target `<<<My
1624 Target>>>' causes each occurrence of `my target' in normal text to
1625 become activated as a link. The Org-mode file is scanned automatically
1626 for radio targets only when the file is first loaded into Emacs. To
1627 update the target list during editing, press `C-c C-c' with the cursor
1631 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1633 4.2.2 CamelCase words as links
1634 ------------------------------
1636 Org-mode also supports CamelCase words as links. This feature is not
1637 turned on by default because of the inconsistencies this system suffers
1638 from. It is also possible that this feature will disappear entirely in
1639 a future version of Org-mode. To activate CamelCase words as links, you
1640 need to customize the option `org-activate-links'. A CamelCase word
1641 then leads to a text search such that `CamelCaseLink' is equivalent to
1642 `[[camel case link]]'.
1645 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1650 Org-mode supports links to files, websites, Usenet and email messages,
1651 and BBDB database entries. External links are URL-like locators. They
1652 start with a short identifying string followed by a colon. There can be
1653 no space after the colon. The following list shows examples for each
1656 http://www.astro.uva.nl/~dominik on the web
1657 file:/home/dominik/images/jupiter.jpg file, absolute path
1658 file:papers/last.pdf file, relative path
1659 news:comp.emacs Usenet link
1660 mailto:adent@galaxy.net Mail link
1661 vm:folder VM folder link
1662 vm:folder#id VM message link
1663 vm://myself@some.where.org/folder#id VM on remote machine
1664 wl:folder WANDERLUST folder link
1665 wl:folder#id WANDERLUST message link
1666 mhe:folder MH-E folder link
1667 mhe:folder#id MH-E message link
1668 rmail:folder RMAIL folder link
1669 rmail:folder#id RMAIL message link
1670 gnus:group GNUS group link
1671 gnus:group#id GNUS article link
1672 bbdb:Richard Stallman BBDB link
1673 shell:ls *.org A shell command
1674 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1676 A link should be enclosed in double brackets and may contain a
1677 descriptive text to be displayed instead of the url (*note Link
1678 format::), for example:
1680 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1682 Org-mode also finds external links in the normal text and activates
1683 them as links. If spaces must be part of the link (for example in
1684 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1685 end of the link, enclose them in angular brackets.
1688 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1693 Org-mode provides methods to create a link in the correct syntax, to
1694 insert it into an org-mode file, and to follow the link.
1697 Store a link to the current location. This is a _global_ command
1698 which can be used in any buffer to create a link. The link will be
1699 stored for later insertion into an Org-mode buffer (see below).
1700 For Org-mode files, if there is a `<<target>>' at the cursor, the
1701 link points to the target. Otherwise it points to the current
1702 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1703 the link will indicate the current article/entry. For W3 and W3M
1704 buffers, the link goes to the current URL. For any other files,
1705 the link will point to the file, with a search string (*note
1706 Search options::) pointing to the contents of the current line.
1707 If there is an active region, the selected words will form the
1708 basis of the search string. If the automatically created link is
1709 not working correctly or accurately enough, you can write custom
1710 functions to select the search string and to do the search for
1711 particular file types - see *Note Custom searches::. The key
1712 binding `C-c l' is only a suggestion - see *Note Installation::.
1715 Insert a link. This prompts for a link to be inserted into the
1716 buffer. You can just type a link, using text for an internal
1717 link, or one of the link type prefixes mentioned in the examples
1718 above. Through completion, all links stored during the current
1719 session can be accessed(1). The link will be inserted into the
1720 buffer, along with a descriptive text. Note that you don't have
1721 to use this command to insert a link. Links in Org-mode are plain
1722 text, and you can type or paste them straight into the buffer. By
1723 using this command, the links are automatically enclosed in double
1724 brackets, and you will be asked for the optional descriptive text.
1725 If the link is a `file:' link and the linked file is located in
1726 the same directory as the current file or a subdirectory of it, the
1727 path of the file will be inserted relative to the current
1731 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1732 file will be inserted and you may use file name completion to
1733 select the name of the file. The path to the file is inserted
1734 relative to the directory of the current org file, if the linked
1735 file is in the current directory or in a subdirectory of it, or if
1736 the path is written relative to the current directory using `../'.
1737 Otherwise an absolute path is used, if possible with `~/' for
1738 your home directory. You can force an absolute path with two
1741 `C-c C-l with cursor on existing link'
1742 When the cursor is on an existing link, `C-c C-l' allows you to
1743 edit the link and description parts of the link.
1746 Open link at point. This will launch a web browser for URLs (using
1747 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1748 the corresponding links, and execute the command in a shell link.
1749 When the cursor is on an internal link, this commands runs the
1750 corresponding search. When the cursor is on a TAG list in a
1751 headline, it creates the corresponding TAGS view. If the cursor
1752 is on a time stamp, it compiles the agenda for that date.
1753 Furthermore, it will visit text and remote files in `file:' links
1754 with Emacs and select a suitable application for local non-text
1755 files. Classification of files is based on file extension only.
1756 See option `org-file-apps'. If you want to override the default
1757 application and visit the file with Emacs, use a `C-u' prefix.
1761 On links, `mouse-2' will open the link just as `C-c C-o' would.
1762 Under Emacs 22, also `mouse-1' will follow a link.
1765 Like `mouse-2', but force file links to be opened with Emacs, and
1766 internal links to be displayed in another window(2).
1769 Push the current position onto the mark ring, to be able to return
1770 easily. Commands following an internal link do this automatically.
1773 Jump back to a recorded position. A position is recorded by the
1774 commands following internal links, and by `C-c %'. Using this
1775 command several times in direct succession moves through a ring of
1776 previously recorded positions.
1778 ---------- Footnotes ----------
1780 (1) After insertion of a stored link, the link will be removed from
1781 the list of stored links. To keep it in the list later use, use a
1782 triple `C-u' prefix to `C-c C-l', or configure the option
1783 `org-keep-stored-link-after-insertion'.
1785 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1788 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1790 4.5 Link abbreviatons
1791 =====================
1793 Long URLs can be cumbersome to type, and often many similar links are
1794 needed in a document. For this you can use link abbreviations. An
1795 abbreviated link looks like this
1797 [[linkword::tag][description]]
1799 where the tag is optional. Such abbreviations are resolved according to
1800 the information in the variable `org-link-abbrev-alist' that relates
1801 the linkwords to replacement text. Here is an example:
1803 (setq org-link-abbrev-alist
1804 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1805 ("google" . "http://www.google.com/search?q=")
1806 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
1807 nph-abs_connect?author=%s&db_key=AST")))
1809 If the replacement text contains the string `%s', it will be
1810 replaced with the tag. Otherwise the tag will be appended to the string
1811 in order to create the link. You may also specify a function that will
1812 be called with the tag as the only argument to create the link.
1814 With the above setting, you could link to a specific bug with
1815 `[[bugzilla::129]]', search the web for OrgMode with
1816 `[[google::OrgMode]]' and find out what the Org-mode author is doing
1817 besides Emacs hacking with `[[ads::Dominik,C]]'.
1819 If you need special abbreviations just for a single Org-mode buffer,
1820 you can define them in the file with
1822 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
1823 #+LINK: google http://www.google.com/search?q=%s
1825 In-buffer completion *note Completion:: can be used after `[' to
1826 complete link abbreviations.
1829 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
1831 4.6 Search options in file links
1832 ================================
1834 File links can contain additional information to make Emacs jump to a
1835 particular location in the file when following a link. This can be a
1836 line number or a search option after a double(1) colon. For example,
1837 when the command `C-c l' creates a link (*note Handling links::) to a
1838 file, it encodes the words in the current line as a search string that
1839 can be used to find this line back later when following the link with
1842 Here is the syntax of the different ways to attach a search to a file
1843 link, together with an explanation:
1845 [[file:~/code/main.c::255]]
1846 [[file:~/xx.org::My Target]]
1847 [[file:~/xx.org::*My Target]]
1848 [[file:~/xx.org::/regexp/]]
1854 Search for a link target `<<My Target>>', or do a text search for
1855 `my target', similar to the search in internal links, see *Note
1856 Internal links::. In HTML export (*note HTML export::), such a
1857 file link will become an HTML reference to the corresponding named
1858 anchor in the linked file.
1861 In an Org-mode file, restrict search to headlines.
1864 Do a regular expression search for `regexp'. This uses the Emacs
1865 command `occur' to list all matches in a separate window. If the
1866 target file is in Org-mode, `org-occur' is used to create a sparse
1867 tree with the matches.
1869 As a degenerate case, a file link with an empty file name can be used
1870 to search the current file. For example, `[[file:::find me]]' does a
1871 search for `find me' in the current file, just as `[[find me]]' would.
1873 ---------- Footnotes ----------
1875 (1) For backward compatibility, line numbers can also follow a
1879 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1884 The default mechanism for creating search strings and for doing the
1885 actual search related to a file link may not work correctly in all
1886 cases. For example, BibTeX database files have many entries like
1887 `year="1993"' which would not result in good search strings, because
1888 the only unique identification for a BibTeX entry is the citation key.
1890 If you come across such a problem, you can write custom functions to
1891 set the right search string for a particular file type, and to do the
1892 search for the string in the file. Using `add-hook', these functions
1893 need to be added to the hook variables
1894 `org-create-file-search-functions' and
1895 `org-execute-file-search-functions'. See the docstring for these
1896 variables for more information. Org-mode actually uses this mechanism
1897 for BibTeX database files, and you can use the corresponding code as an
1898 implementation example. Search for `BibTeX links' in the source file.
1901 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1906 Another way to create org entries with links to other files is through
1907 the _Remember_ package by John Wiegley. _Remember_ lets you store
1908 quick notes with little interruption of your work flow. See
1909 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1910 information. The notes produced by _Remember_ can be stored in
1911 different ways, and Org-mode files are a good target. Org-mode allows
1912 you to file away notes either to a default file, or directly to the
1913 correct location in your Org-mode outline tree. The following
1914 customization will tell _Remember_ to use org files as target, and to
1915 create annotations compatible with Org-mode links.
1917 (setq org-directory "~/path/to/my/orgfiles/")
1918 (setq org-default-notes-file "~/.notes")
1919 (setq remember-annotation-functions '(org-remember-annotation))
1920 (setq remember-handler-functions '(org-remember-handler))
1921 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1923 In combination with Org-mode, you can use templates to generate
1924 different types of remember notes. For example, if you would like to
1925 use one template to create general TODO entries, and another one for
1926 journal entries, you could use:
1928 (setq org-remember-templates
1929 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1930 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1932 In these entries, the character specifies how to select the template,
1933 the first string specifies the template, and the (optional) second
1934 string specifies a default file (overruling `org-default-notes-file')
1935 as a target for this note.
1937 When you call `M-x remember' to remember something, org will prompt
1938 for a key to select the template and then prepare the buffer like
1940 [[file:link to where you called remember]]
1944 * [2006-03-21 Tue 15:37]
1946 [[file:link to where you called remember]]
1948 See the variable `org-remember-templates' for more details.
1950 When you are finished composing a note with remember, you have to
1951 press `C-c C-c' to file the note away. The handler first prompts for a
1952 target file - if you press <RET>, the value of `org-default-notes-file'
1953 is used. Then the command offers the headings tree of the selected
1954 file. You can either immediately press <RET> to get the note appended
1955 to the file. Or you can use vertical cursor motion (<up> and <down>)
1956 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1957 or <left> or <right> leads to the following result.
1959 Cursor Key Note gets inserted
1961 buffer-start <RET> as level 2 heading at end of file
1962 on headline <RET> as sublevel of the heading at cursor
1963 <left> as same level, before current heading
1964 <right> as same level, after current heading
1965 not on <RET> at cursor position, level taken from context.
1966 headline Or use prefix arg to specify level
1969 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1970 append it to the default file. Even shorter would be `C-u C-c C-c',
1971 which does the same without even showing the tree. But with little
1972 extra effort, you can push it directly to the correct location.
1974 Before inserting the text into a tree, the function ensures that the
1975 text has a headline, i.e. a first line that starts with a `*'. If not,
1976 a headline is constructed from the current date and some additional
1977 data. If the variable `org-adapt-indentation' is non-nil, the entire
1978 text is also indented so that it starts in the same column as the
1979 headline (after the asterisks).
1982 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1987 Org-mode does not maintain TODO lists as a separate document. TODO
1988 items are an integral part of the notes file, because TODO items
1989 usually come up while taking notes! With Org-mode, you simply mark any
1990 entry in a tree as being a TODO item. In this way, the information is
1991 not duplicated, and the entire context from which the item emerged is
1992 always present when you check.
1994 Of course, this technique causes TODO items to be scattered
1995 throughout your file. Org-mode provides methods to give you an
1996 overview over all things you have to do.
2000 * TODO basics:: Marking and displaying TODO entries
2001 * TODO extensions:: Workflow and assignments
2002 * Priorities:: Some things are more important than others
2003 * Breaking down tasks:: Splitting a task into managable pieces
2004 * Checkboxes:: Tick-off lists
2007 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2009 5.1 Basic TODO functionality
2010 ============================
2012 Any headline can become a TODO item by starting it with the word TODO,
2015 *** TODO Write letter to Sam Fortune
2017 The most important commands to work with TODO entries are:
2020 Rotate the TODO state of the current item between
2022 ,-> (unmarked) -> TODO -> DONE --.
2023 '--------------------------------'
2025 The same rotation can also be done "remotely" from the timeline and
2026 agenda buffers with the `t' command key (*note Agenda commands::).
2030 Select the following/preceding TODO state, similar to cycling.
2031 Mostly useful if more than two TODO states are possible (*note
2035 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2036 the entire buffer, but shows all TODO items and the headings
2037 hierarchy above them. With prefix arg, show also the DONE
2038 entries. With numerical prefix N, show the tree for the Nth
2039 keyword in the variable `org-todo-keywords'.
2042 Show the global TODO list. This collects the TODO items from all
2043 agenda files (*note Agenda views::) into a single buffer. The
2044 buffer is in `agenda-mode', so there are commands to examine and
2045 manipulate the TODO entries directly from that buffer (*note
2046 Agenda commands::). *Note Global TODO list::, for more
2050 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2052 5.2 Extended use of TODO keywords
2053 =================================
2055 The default implementation of TODO entries is just two states: TODO and
2056 DONE. You can, however, use the TODO feature for more complicated
2057 things by configuring the variables `org-todo-keywords' and
2058 `org-todo-interpretation'. Using special setup, you can even use TODO
2059 keywords in different ways in different org files.
2061 Note that tags are another way to classify headlines in general and
2062 TODO items in particular (*note Tags::).
2066 * Workflow states:: From TODO to DONE in steps
2067 * TODO types:: I do this, Fred the rest
2068 * Per file keywords:: Different files, different requirements
2071 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2073 5.2.1 TODO keywords as workflow states
2074 --------------------------------------
2076 You can use TODO keywords to indicate different states in the process
2077 of working on an item, for example:
2079 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2080 org-todo-interpretation 'sequence)
2082 Changing these variables only becomes effective in a new Emacs
2083 session. With this setup, the command `C-c C-t' will cycle an entry
2084 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
2085 also use a prefix argument to quickly select a specific state. For
2086 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
2087 you define many keywords, you can use in-buffer completion (see *Note
2088 Completion::) to insert these words into the buffer.
2091 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
2093 5.2.2 TODO keywords as types
2094 ----------------------------
2096 The second possibility is to use TODO keywords to indicate different
2097 types of action items. For example, you might want to indicate that
2098 items are for "work" or "home". If you are into David Allen's _Getting
2099 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2100 `MAYBE'. Or, when you work with several people on a single project,
2101 you might want to assign action items directly to persons, by using
2102 their names as TODO keywords. This would be set up like this:
2104 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2105 org-todo-interpretation 'type)
2107 In this case, different keywords do not indicate a sequence, but
2108 rather different types. So it is normally not useful to change from
2109 one type to another. Therefore, in this case the behavior of the
2110 command `C-c C-t' is changed slightly(1). When used several times in
2111 succession, it will still cycle through all names. But when you return
2112 to the item after some time and execute `C-c C-t' again, it will switch
2113 from each name directly to DONE. Use prefix arguments or completion to
2114 quickly select a specific name. You can also review the items of a
2115 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2116 C-v'. For example, to see all things Lucy has to do, you would use
2117 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2118 single buffer, you would use the prefix arg as well when creating the
2119 global todo list: `C-3 C-c t'.
2121 ---------- Footnotes ----------
2123 (1) This is also true for the `t' command in the timeline and agenda
2127 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2129 5.2.3 Setting up TODO keywords for individual files
2130 ---------------------------------------------------
2132 It can be very useful to use different aspects of the TODO mechanism in
2133 different files, which is not possible with the global settings
2134 described above. For file-local settings, you need to add special
2135 lines to the file which set the keywords and interpretation for that
2136 file only. For example, to set one of the two examples discussed
2137 above, you need one of the following lines, starting in column zero
2138 anywhere in the file:
2140 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2141 #+TYP_TODO: Fred Sara Lucy Mike DONE
2143 To make sure you are using the correct keyword, type `#+' into the
2144 buffer and then use `M-<TAB>' completion.
2146 Remember that the last keyword must always mean that the item is DONE
2147 (although you may use a different word). Also note that in each file,
2148 only one of the two aspects of TODO keywords can be used. After
2149 changing one of these lines, use `C-c C-c' with the cursor still in the
2150 line to make the changes known to Org-mode(1).
2152 If you want to use very many keywords, for example when working with
2153 a large group of people, you may split the names over several lines:
2155 #+TYP_TODO: Fred Sara Lucy Mike
2156 #+TYP_TODO: Luis George Jules Jessica
2157 #+TYP_TODO: Kim Arnold Peter
2160 ---------- Footnotes ----------
2162 (1) Org-mode parses these lines only when Org-mode is activated
2163 after visiting a file. `C-c C-c' with the cursor in a line starting
2164 with `#+' is simply restarting Org-mode for the current buffer.
2167 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2172 If you use Org-mode extensively to organize your work, you may end up
2173 with a number of TODO entries so large that you'd like to prioritize
2174 them. This can be done by placing a _priority cookie_ into the
2177 *** TODO [#A] Write letter to Sam Fortune
2179 With its standard setup, Org-mode supports priorities `A', `B', and
2180 `C'. `A' is the highest priority. An entry without a cookie is
2181 treated as priority `B'. Priorities make a difference only in the
2182 agenda (*note Weekly/Daily agenda::).
2185 Set the priority of the current headline. The command prompts for
2186 a priority character `A', `B' or `C'. When you press <SPC>
2187 instead, the priority cookie is removed from the headline. The
2188 priorities can also be changed "remotely" from the timeline and
2189 agenda buffer with the `,' command (*note Agenda commands::).
2193 Increase/decrease priority of current headline. Note that these
2194 keys are also used to modify time stamps (*note Creating
2195 timestamps::). Furthermore, these keys are also used by CUA-mode
2196 (*note Conflicts::).
2199 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2201 5.4 Breaking tasks down into subtasks
2202 =====================================
2204 It is often advisable to break down large tasks into smaller, managable
2205 subtasks. You can do this by creating an outline tree below a TODO
2206 item, with detailed subtasks on the tree(1). Another possibility is
2207 the use of checkboxes to identify (a hierarchy of) a large number of
2208 subtasks (*note Checkboxes::).
2210 ---------- Footnotes ----------
2212 (1) To keep subtasks out of the global TODO list, see the
2213 `org-agenda-todo-list-sublevels'.
2216 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2221 Every item in a plain list (*note Plain lists::) can be made a checkbox
2222 by starting it with the string `[ ]'. This feature is similar to TODO
2223 items (*note TODO items::), but more lightweight. Checkboxes are not
2224 included into the global TODO list, so they are often great to split a
2225 task into a number of simple steps. Or you can use them in a shopping
2226 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2227 `org-mouse.el'. Here is an example of a checkbox list.
2229 * TODO Organize party [3/6]
2235 - [ ] think about what music to play
2236 - [X] talk to the neighbors
2238 The `[3/6]' and `[1/3]' in the first and second line are cookies
2239 indicating how many checkboxes are present in this entry, and how many
2240 of them have been checked off. This can give you an idea on how many
2241 checkboxes remain, even without opening a folded entry. The cookies
2242 can be placed into a headline or into (the first line of) a plain list
2243 item. Each cookie covers all checkboxes structurally below that
2244 headline/item. You have to insert the cookie yourself by typing either
2245 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2246 the second case you get information about the percentage of checkboxes
2247 checked (in the above example, this would be `[50%]' and `[33%],
2250 The following commands work with checkboxes:
2253 Toggle checkbox at point.
2256 Toggle checkbox at point.
2257 - If there is an active region, toggle the first checkbox in
2258 the region and set all remaining boxes to the same status as
2259 the first. If you want to toggle all boxes in the region
2260 independently, use a prefix argument.
2262 - If the cursor is in a headline, toggle checkboxes in the
2263 region between this headline and the next (so _not_ the
2266 - If there is no active region, just toggle the checkbox at
2270 Insert a new item with a checkbox. This works only if the cursor
2271 is already in a plain list item (*note Plain lists::).
2274 Update the checkbox statistics in the current outline entry. When
2275 called with a `C-u' prefix, update the entire file. Checkbox
2276 statistic cookies are updated automatically if you toggle
2277 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2278 you delete boxes or add/change them by hand, use this command to
2279 get things back into synch. Or simply toggle any checkbox twice
2283 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2288 Items can be labeled with timestamps to make them useful for project
2293 * Time stamps:: Assigning a time to a tree entry
2294 * Creating timestamps:: Commands which insert timestamps
2295 * Custom time format:: If you cannot work with the ISO format
2296 * Progress logging:: Documenting when what work was done.
2299 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2301 6.1 Time stamps, deadlines and scheduling
2302 =========================================
2304 A time stamp is a specification of a date (possibly with time) in a
2305 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2306 09:39>'(1). A time stamp can appear anywhere in the headline or body
2307 of an org-tree entry. Its presence allows entries to be shown on
2308 specific dates in the agenda (*note Weekly/Daily agenda::). We
2312 A simple time stamp just assigns a date/time to an item. This is
2313 just like writing down an appointment in a paper agenda, or like
2314 writing down an event in a diary, when you want to take note of
2315 when something happened. In the timeline and agenda displays, the
2316 headline of an entry associated with a plain time stamp will be
2317 shown exactly on that date.
2319 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2322 Just like a plain time stamp, but with square brackets instead of
2323 angular ones. These time stamps are inactive in the sense that
2324 they do _not_ trigger an entry to show up in the agenda.
2326 * Gillian comes late for the fifth time [2006-11-01 Wed]
2329 Two time stamps connected by `--' denote a time range. The
2330 headline will be shown on the first and last day of the range, and
2331 on any dates that are displayed and fall in the range. Here is an
2334 ** Meeting in Amsterdam
2335 <2004-08-23 Mon>--<2004-08-26 Thu>
2337 TIME STAMP WITH SCHEDULED KEYWORD
2338 If a time stamp is preceded by the word `SCHEDULED:', it means you
2339 are planning to start working on that task on the given date. So
2340 this is not about recording an event, but about planning your
2341 work. The headline will be listed under the given date(2). In
2342 addition, a reminder that the scheduled date has passed will be
2343 present in the compilation for _today_, until the entry is marked
2344 DONE. I.e., the task will automatically be forwarded until
2347 *** TODO Call Trillian for a date on New Years Eve.
2348 SCHEDULED: <2004-12-25 Sat>
2350 TIME STAMP WITH DEADLINE KEYWORD
2351 If a time stamp is preceded by the word `DEADLINE:', the task
2352 (most likely a TODO item) is supposed to be finished on that date,
2353 and it will be listed then. In addition, the compilation for
2354 _today_ will carry a warning about the approaching or missed
2355 deadline, starting `org-deadline-warning-days' before the due
2356 date, and continuing until the entry is marked DONE. An example:
2358 *** TODO write article about the Earth for the Guide
2359 The editor in charge is [[bbdb:Ford Prefect]]
2360 DEADLINE: <2004-02-29 Sun>
2362 TIME STAMP WITH CLOSED KEYWORD
2363 When `org-log-done' is non-nil, Org-mode will automatically insert
2364 a special time stamp each time a TODO entry is marked done (*note
2365 Progress logging::). This time stamp is enclosed in square
2366 brackets instead of angular brackets.
2368 TIME RANGE WITH CLOCK KEYWORD
2369 When using the clock to time the work that is being done on
2370 specific items, time ranges preceded by the CLOCK keyword are
2371 inserted automatically into the file. The time stamps are
2372 enclosed in square brackets instead of angular brackets. *Note
2373 Clocking work time::.
2375 ---------- Footnotes ----------
2377 (1) This is the standard ISO date/time format. If you cannot get
2378 used to these, see *Note Custom time format::
2380 (2) It will still be listed on that date after it has been marked
2381 DONE. If you don't like this, set the variable
2382 `org-agenda-skip-scheduled-if-done'.
2385 File: org, Node: Creating timestamps, Next: Custom time format, Prev: Time stamps, Up: Timestamps
2387 6.2 Creating timestamps
2388 =======================
2390 For Org-mode to recognize time stamps, they need to be in the specific
2391 format. All commands listed below produce time stamps in the correct
2395 Prompt for a date and insert a corresponding time stamp. When the
2396 cursor is at a previously used time stamp, it is updated to NOW.
2397 When this command is used twice in succession, a time range is
2401 Like `C-c .', but use the alternative format which contains date
2402 and time. The default time can be rounded to multiples of 5
2403 minutes, see the option `org-time-stamp-rounding-minutes'.
2406 Like `C-c .', but insert an inactive time stamp not triggering the
2410 Insert a time stamp corresponding to the cursor date in the
2414 Access the Emacs calendar for the current date. If there is a
2415 timestamp in the current line, goto the corresponding date instead.
2418 Access the agenda for the date given by the time stamp or -range at
2419 point (*note Weekly/Daily agenda::).
2422 Insert `DEADLINE' keyword along with a stamp. The insertion will
2423 happen in the line directly following the headline.
2426 Create a sparse tree with all deadlines that are either past-due,
2427 or which will become due within `org-deadline-warning-days'. With
2428 `C-u' prefix, show all deadlines in the file. With a numeric
2429 prefix, check that many days. For example, `C-1 C-c C-w' shows
2430 all deadlines due tomorrow.
2433 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2434 happen in the line directly following the headline. Any CLOSED
2435 timestamp will be removed.
2439 Change date at cursor by one day. These key bindings conflict with
2440 CUA-mode (*note Conflicts::).
2444 Change the item under the cursor in a timestamp. The cursor can
2445 be on a year, month, day, hour or minute. Note that if the cursor
2446 is in a headline and not at a time stamp, these same keys modify
2447 the priority of an item. (*note Priorities::). The key bindings
2448 also conflict with CUA-mode (*note Conflicts::).
2451 Evaluate a time range by computing the difference between start and
2452 end. With prefix arg, insert result after the time range (in a
2453 table: into the following column).
2457 * The date/time prompt:: How org-mode helps you entering date and time
2460 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2462 6.2.1 The date/time prompt
2463 --------------------------
2465 When Org-mode prompts for a date/time, the prompt suggests to enter an
2466 ISO date. But it will in fact accept any string containing some date
2467 and/or time information. You can, for example, use `C-y' to paste a
2468 (possibly multi-line) string copied from an email message. Org-mode
2469 will find whatever information is in there and will replace anything not
2470 specified with the current date and time. For example:
2472 3-2-5 --> 2003-02-05
2473 feb 15 --> currentyear-02-15
2474 sep 12 9 --> 2009-09-12
2475 12:45 --> today 12:45
2476 22 sept 0:34 --> currentyear-09-22 0:34
2477 12 --> currentyear-currentmonth-12
2478 Fri --> nearest Friday (today or later)
2479 +4 --> 4 days from now (if +N is the only thing given)
2481 The function understands English month and weekday abbreviations. If
2482 you want to use unabbreviated names and/or other languages, configure
2483 the variables `parse-time-months' and `parse-time-weekdays'.
2485 Parallel to the minibuffer prompt, a calendar is popped up(1). You
2486 can control the calendar fully from the minibuffer:
2489 Scroll calendar backwards by one month.
2492 Scroll calendar forwards by one month.
2495 Select date by clicking on it.
2516 Choose date in calendar (only if nothing was typed into
2519 ---------- Footnotes ----------
2521 (1) If you don't need/want the calendar, configure the variable
2522 `org-popup-calendar-for-date-prompt'.
2525 File: org, Node: Custom time format, Next: Progress logging, Prev: Creating timestamps, Up: Timestamps
2527 6.3 Custom time format
2528 ======================
2530 Org-mode uses the standard ISO notation for dates and times as it is
2531 defined in ISO 8601. If you cannot get used to this and require another
2532 representation of date and time to keep you happy, you can get it by
2533 customizing the variables `org-display-custom-times' and
2534 `org-time-stamp-custom-formats'.
2537 Toggle the display of custom formats for dates and times.
2539 Org-mode needs the default format for scanning, so the custom date/time
2540 format does not _replace_ the default format - instead it is put _over_
2541 the default format using text properties. This has the following
2543 * You cannot place the cursor onto a time stamp anymore, only before
2546 * The `S-<up>/<down>' keys can no longer be used to adjust each
2547 component of a time stamp. If the cursor is at the beginning of
2548 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2549 like `S-<left>/<right>'. At the end of the stamp, the time will
2550 be changed by one minute.
2552 * When you delete a time stamp character-by-character, it will only
2553 disappear from the buffer after _all_ (invisible) characters
2554 belonging to the ISO timestamp have been removed.
2556 * If the custom time stamp format is longer than the default and you
2557 are using dates in tables, table alignment will be messed up. If
2558 the custom format is shorter, things do work as expected.
2561 File: org, Node: Progress logging, Prev: Custom time format, Up: Timestamps
2563 6.4 Progress Logging
2564 ====================
2566 Org-mode can automatically record a time stamp when you mark a TODO item
2567 as DONE. You can also measure precisely the time you spent on specific
2568 items in a project by starting and stopping a clock when you start and
2569 stop working on an aspect of a project.
2573 * Closing items:: When was this entry marked DONE?
2574 * Clocking work time:: When exactly did you work on this item?
2577 File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
2582 If you want to keep track of _when_ a certain TODO item was finished,
2583 turn on logging with
2585 (setq org-log-done t)
2587 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2588 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2589 [timestamp]' will be inserted just after the headline. If you turn the
2590 entry back into a TODO item again through further state cycling, that
2591 line will be removed again. In the timeline (*note Timeline::) and in
2592 the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
2593 to display the TODO items closed on each day, giving you an overview of
2594 what has been done on a day. See the variable `org-log-done' for the
2595 possibility to record an additional note together with a timestamp.
2598 File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
2600 6.4.2 Clocking work time
2601 ------------------------
2603 Org-mode allows you to clock the time you spent on specific tasks in a
2604 project. When you start working on an item, you can start the clock.
2605 When you stop working on that task, or when you mark the task done, the
2606 clock is stopped and the corresponding time interval is recorded. It
2607 also computes the total time spent on each subtree of a project.
2610 Start the clock on the current item (clock-in). This inserts the
2611 CLOCK keyword together with a timestamp.
2614 Stop the clock (clock-out). The inserts another timestamp at the
2615 same location where the clock was last started. It also directly
2616 computes the resulting time in inserts it after the time range as
2617 `=> HH:MM'. See the variable `org-log-done' for the possibility to
2618 record an additional note together with the clock-out time stamp.
2621 Recompute the time interval after changing one of the time stamps.
2622 This is only necessary if you edit the time stamps directly. If
2623 you change them with `S-<cursor>' keys, the update is automatic.
2626 Changing the TODO state of an item to DONE automatically stops the
2627 clock if it is running in this same item.
2630 Cancel the current clock. This is useful if a clock was started by
2631 mistake, or if you ended up working on something else.
2634 Display time summaries for each subtree in the current buffer.
2635 This puts overlays at the end of each headline, showing the total
2636 time recorded under that heading, including the time of any
2637 subheadings. You can use visibility cycling to study the tree, but
2638 the overlays disappear when you change the buffer (see variable
2639 `org-remove-highlights-with-change') or press `C-c C-c'.
2642 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2643 report as an org-mode table into the current file.
2644 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2647 If such a block already exists, its content is replaced by the new
2648 table. The `BEGIN' line can specify options:
2649 :maxlevels Maximum level depth to which times are listed in the table.
2650 :emphasize When `t', emphasize level one and level two items
2651 :block The time block to consider. This block is specified relative
2652 to the current time and may be any of these keywords:
2653 `today', `yesterday', `thisweek', `lastweek',
2654 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2655 :tstart A time string specifying when to start considering times
2656 :tend A time string specifying when to stop considering times
2657 So to get a clock summary for the current day, you could write
2658 #+BEGIN: clocktable :maxlevel 2 :block today
2661 and to use a specific time range you could write(1)
2662 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2663 :tend "<2006-08-10 Thu 12:00>"
2668 Update all dynamic blocks (*note Dynamic blocks::). This is
2669 useful if you have several clocktable blocks in a buffer.
2671 The `l' key may be used in the timeline (*note Timeline::) and in
2672 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2673 worked on or closed during a day.
2675 ---------- Footnotes ----------
2677 (1) Note that all parameters must be specified in a single line -
2678 the line is broken here only to fit it onto the manual.
2681 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2686 If you wish to implement a system of labels and contexts for
2687 cross-correlating information, an excellent way is to assign tags to
2688 headlines. Org-mode has extensive support for using tags.
2690 Every headline can contain a list of tags, at the end of the
2691 headline. Tags are normal words containing letters, numbers, `_', and
2692 `@'. Tags must be preceded and followed by a single colon; like
2693 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2697 * Tag inheritance:: Tags use the tree structure of the outline
2698 * Setting tags:: How to assign tags to a headline
2699 * Tag searches:: Searching for combinations of tags
2702 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2707 Tags make use of the hierarchical structure of outline trees. If a
2708 heading has a certain tag, all subheadings will inherit the tag as
2709 well. For example, in the list
2711 * Meeting with the French group :WORK:
2712 ** Summary by Frank :BOSS:NOTES:
2713 *** TODO Prepare slides for him :ACTION:
2715 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2716 `:ACTION:'. When executing tag searches and Org-mode finds that a
2717 certain headline matches the search criterion, it will not check any
2718 sublevel headline, assuming that these likely also match, and that the
2719 list of matches can become very long. This may not be what you want,
2720 however, and you can influence inheritance and searching using the
2721 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2724 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2729 Tags can simply be typed into the buffer at the end of a headline.
2730 After a colon, `M-<TAB>' offers completion on tags. There is also a
2731 special command for inserting tags:
2734 Enter new tags for the current headline. Org-mode will either
2735 offer completion or a special single-key interface for setting
2736 tags, see below. After pressing <RET>, the tags will be inserted
2737 and aligned to `org-tags-column'. When called with a `C-u'
2738 prefix, all tags in the current buffer will be aligned to that
2739 column, just to make things look nice. TAGS are automatically
2740 realigned after promotion, demotion, and TODO state changes (*note
2743 Org will support tag insertion based on a _list of tags_. By
2744 default this list is constructed dynamically, containing all tags
2745 currently used in the buffer. You may also globally specify a hard list
2746 of tags with the variable `org-tag-alist'. Finally you can set the
2747 default tags for a given file with lines like
2749 #+TAGS: @WORK @HOME @TENNISCLUB
2750 #+TAGS: Laptop Car PC Sailboat
2752 If you have globally defined your preferred set of tags using the
2753 variable `org-tag-alist', but would like to use a dynamic tag list in a
2754 specific file: Just add an empty TAGS option line to that file:
2758 The default support method for entering tags is minibuffer
2759 completion. However, Org-mode also implements a much better method:
2760 _fast tag selection_. This method allows to select and deselect tags
2761 with a single key per tag. To function efficiently, you should assign
2762 unique keys to most tags. This can be done globally with
2764 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2766 or on a per-file basis with
2768 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2770 You can also group together tags that are mutually exclusive. With
2773 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2775 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2778 Don't forget to press `C-c C-c' with the cursor in one of these lines
2779 to activate any changes.
2781 If at least one tag has a selection key, pressing `C-c C-c' will
2782 automatically present you with a special interface, listing inherited
2783 tags, the tags of the current headline, and a list of all legal tags
2784 with corresponding keys(2). In this interface, you can use the
2788 Pressing keys assigned to tags will add or remove them from the
2789 list of tags in the current line. Selecting a tag in a group of
2790 mutually exclusive tags will turn off any other tags from that
2794 Enter a tag in the minibuffer, even if the tag is not in the
2795 predefined list. You will be able to complete on all tags present
2799 Clear all tags for this line.
2802 Accept the modified set.
2805 Abort without installing changes.
2808 If `q' is not assigned to a tag, it aborts like `C-g'.
2811 Turn off groups of mutually exclusive tags. Use this to (as an
2812 exception) assign several tags from such a group.
2815 Toggle auto-exit after the next change (see below).
2817 This method lets you assign tags to a headline with very few keys. With
2818 the above setup, you could clear the current tags and set `@HOME',
2819 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
2820 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
2821 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
2822 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
2825 If you find that most of the time, you need only a single keypress to
2826 modify your list of tags, set the variable
2827 `org-fast-tag-selection-single-key'. Then you no longer have to press
2828 <RET> to exit fast tag selection - it will immediately exit after the
2829 first change. If you then occasionally need more keys, press `C-c' to
2830 turn off auto-exit for the current tag selection process.
2832 ---------- Footnotes ----------
2834 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2835 respectively. Several groups are allowed.
2837 (2) Keys will automatically be assigned to tags which have no
2841 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2846 Once a tags system has been set up, it can be used to collect related
2847 information into special lists.
2850 Create a sparse tree with all headlines matching a tags search.
2851 With a `C-u' prefix argument, ignore headlines that are not a TODO
2855 Create a global list of tag matches from all agenda files. *Note
2856 Matching headline tags::.
2859 Create a global list of tag matches from all agenda files, but
2860 check only TODO items and force checking subitems (see variable
2861 `org-tags-match-list-sublevels').
2863 A tags search string can use Boolean operators `&' for AND and `|'
2864 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2865 not implemented. A tag may also be preceded by `-', to select against
2866 it, and `+' is syntactic sugar for positive selection. The AND
2867 operator `&' is optional when `+' or `-' is present. Examples:
2870 Select headlines tagged `:WORK:', but discard those also tagged
2874 Selects lines tagged `:WORK:' or `:LAPTOP:'.
2877 Like before, but require the `:LAPTOP:' lines to be tagged also
2880 If you are using multi-state TODO keywords (*note TODO
2881 extensions::), it can be useful to also match on the TODO keyword.
2882 This can be done by adding a condition after a slash to a tags match.
2883 The syntax is similar to the tag matches, but should be applied with
2884 consideration: For example, a positive selection on several TODO
2885 keywords can not meaningfully be combined with boolean AND. However,
2886 _negative selection_ combined with AND can be meaningful. To make sure
2887 that only lines are checked that actually have any TODO keyword, use
2888 `C-c a M', or equivalently start the todo part after the slash with `!'.
2892 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
2895 `WORK/!-WAITING-NEXT'
2896 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
2899 `WORK/+WAITING|+NEXT'
2900 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
2903 Any element of the tag/todo match can be a regular expression - in
2904 this case it must be enclosed in curly braces. For example,
2905 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
2906 tag starting with `BOSS'.
2908 You can also require a headline to be of a certain level, by writing
2909 instead of any TAG an expression like `LEVEL=3'. For example, a search
2910 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
2911 BOSS and are _not_ marked witht the todo keyword DONE.
2914 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
2919 Due to the way Org-mode works, TODO items, time-stamped items, and
2920 tagged headlines can be scattered throughout a file or even a number of
2921 files. To get an overview over open action items, or over events that
2922 are important for a particular date, this information must be collected,
2923 sorted and displayed in an organized way.
2925 Org-mode can select items based on various criteria, and display them
2926 in a separate buffer. Six different view types are provided:
2928 * an _agenda_ that is like a calendar and shows information for
2931 * a _TODO list_ that covers all unfinished action items,
2933 * a _tags view_, showings headlines based on the tags associated
2936 * a _timeline view_ that shows all events in a single Org-mode file,
2937 in time-sorted view,
2939 * a _stuck projects view_ showing projects that currently don't move
2942 * _custom views_ that are special tag/keyword searches and
2943 combinations of different views.
2945 The extracted information is displayed in a special _agenda buffer_.
2946 This buffer is read-only, but provides commands to visit the
2947 corresponding locations in the original Org-mode files, and even to
2948 edit these files remotely.
2950 Two variables control how the agenda buffer is displayed and whether
2951 the window configuration is restored when the agenda exits:
2952 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
2956 * Agenda files:: Files being searched for agenda information
2957 * Agenda dispatcher:: Keyboard access to agenda views
2958 * Built-in agenda views:: What is available out of the box?
2959 * Presentation and sorting:: How agenda items are prepared for display
2960 * Agenda commands:: Remote editing of org trees
2961 * Custom agenda views:: Defining special searches and views
2964 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2969 The information to be shown is collected from all _agenda files_, the
2970 files listed in the variable `org-agenda-files'(1). Thus even if you
2971 only work with a single Org-mode file, this file should be put into
2972 that list(2). You can customize `org-agenda-files', but the easiest
2973 way to maintain it is through the following commands
2976 Add current file to the list of agenda files. The file is added to
2977 the front of the list. If it was already in the list, it is moved
2978 to the front. With prefix arg, file is added/moved to the end.
2981 Remove current file from the list of agenda files.
2984 Cycle through agenda file list, visiting one file after the other.
2986 The Org menu contains the current list of files and can be used to
2989 ---------- Footnotes ----------
2991 (1) If the value of that variable is not a list, but a single file
2992 name, then the list of agenda files will be maintained in that external
2995 (2) When using the dispatcher, pressing `1' before selecting a
2996 command will actually limit the command to the current file, and ignore
2997 `org-agenda-files' until the next dispatcher command.
3000 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3002 8.2 The agenda dispatcher
3003 =========================
3005 The views are created through a dispatcher that should be bound to a
3006 global key, for example `C-c a' (*note Installation::). In the
3007 following we will assume that `C-c a' is indeed how the dispatcher is
3008 accessed and list keyboard access to commands accordingly. After
3009 pressing `C-c a', an additional letter is required to execute a
3010 command. The dispatcher offers the following default commands:
3012 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3015 Create a list of all TODO items (*note Global TODO list::).
3018 Create a list of headlines matching a TAGS expression (*note
3019 Matching headline tags::).
3022 Create the timeline view for the current buffer (*note Timeline::).
3025 Create a list of stuck projects (*note Stuck projects::).
3028 Restrict an agenda command to the current buffer. After pressing
3029 `1', you still need to press the character selecting the command.
3032 If there is an active region, restrict the following agenda
3033 command to the region. Otherwise, restrict it to the current
3034 subtree. After pressing `0', you still need to press the
3035 character selecting the command.
3037 You can also define custom commands that will be accessible through
3038 the dispatcher, just like the default commands. This includes the
3039 possibility to create extended agenda buffers that contain several
3040 blocks together, for example the weekly agenda, the global TODO list and
3041 a number of special tags matches. *Note Custom agenda views::.
3044 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3046 8.3 The built-in agenda views
3047 =============================
3049 In this section we describe the built-in views.
3053 * Weekly/Daily agenda:: The calendar page with current tasks
3054 * Global TODO list:: All unfinished action items
3055 * Matching headline tags:: Structured information with fine-tuned search
3056 * Timeline:: Time-sorted view for single file
3057 * Stuck projects:: Find projects you need to review
3060 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3062 8.3.1 The weekly/daily agenda
3063 -----------------------------
3065 The purpose of the weekly/daily _agenda_ is to act like a page of a
3066 paper agenda, showing all the tasks for the current week or day.
3069 Compile an agenda for the current week from a list of org files.
3070 The agenda shows the entries for each day. With a `C-u' prefix (or
3071 when the variable `org-agenda-include-all-todo' is `t'), all
3072 unfinished TODO items (including those without a date) are also
3073 listed at the beginning of the buffer, before the first date.
3075 Remote editing from the agenda buffer means, for example, that you
3076 can change the dates of deadlines and appointments from the agenda
3077 buffer. The commands available in the Agenda buffer are listed in
3078 *Note Agenda commands::.
3080 Calendar/Diary integration
3081 ..........................
3083 Emacs contains the calendar and diary by Edward M. Reingold. The
3084 calendar displays a three-month calendar with holidays from different
3085 countries and cultures. The diary allows you to keep track of
3086 anniversaries, lunar phases, sunrise/set, recurrent appointments
3087 (weekly, monthly) and more. In this way, it is quite complementary to
3088 Org-mode. It can be very useful to combine output from Org-mode with
3091 In order to include entries from the Emacs diary into Org-mode's
3092 agenda, you only need to customize the variable
3094 (setq org-agenda-include-diary t)
3096 After that, everything will happen automatically. All diary entries
3097 including holidays, anniversaries etc will be included in the agenda
3098 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3099 the agenda buffer to jump to the diary file in order to edit existing
3100 diary entries. The `i' command to insert new entries for the current
3101 date works in the agenda buffer, as well as the commands `S', `M', and
3102 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3103 to other calendars, respectively. `c' can be used to switch back and
3104 forth between calendar and agenda.
3107 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3109 8.3.2 The global TODO list
3110 --------------------------
3112 The global TODO list contains all unfinished TODO items, formatted and
3113 collected into a single place.
3116 Show the global TODO list. This collects the TODO items from all
3117 agenda files (*note Agenda views::) into a single buffer. The
3118 buffer is in `agenda-mode', so there are commands to examine and
3119 manipulate the TODO entries directly from that buffer (*note
3123 Like the above, but allows selection of a specific TODO keyword.
3124 You can also do this by specifying a prefix argument to `C-c a t'.
3125 With a `C-u' prefix you are prompted for a keyword. With a
3126 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
3127 `r' key in the agenda buffer regenerates it, and you can give a
3128 prefix argument to this command to change the selected TODO
3129 keyword, for example `3 r'. If you often need a search for a
3130 specific keyword, define a custom command for it (*note Agenda
3132 Matching specific TODO keywords can also be done as part of a tags
3133 search (*note Tag searches::).
3135 Remote editing of TODO items means that you can change the state of a
3136 TODO entry with a single key press. The commands available in the TODO
3137 list are described in *Note Agenda commands::.
3139 Normally the global todo list simply shows all headlines with TODO
3140 keywords. This list can become very long. There are two ways to keep
3142 - Some people view a TODO item that has been _scheduled_ for
3143 execution (*note Time stamps::) as no longer _open_. Configure the
3144 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3145 items from the global TODO list.
3147 - TODO items may have sublevels to break up the task into subtasks.
3148 In such cases it may be enough to list only the highest level TODO
3149 headline and omit the sublevels from the global list. Configure
3150 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3153 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3155 8.3.3 Matching headline tags
3156 ----------------------------
3158 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3159 you can select headlines based on the tags that apply to them and
3160 collect them into an agenda buffer.
3163 Produce a list of all headlines that match a given set of tags.
3164 The command prompts for a selection criterion, which is a boolean
3165 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3166 `WORK|HOME' (*note Tags::). If you often need a specific search,
3167 define a custom command for it (*note Agenda dispatcher::).
3170 Like `C-c a m', but only select headlines that are also TODO items
3171 and force checking subitems (see variable
3172 `org-tags-match-list-sublevels'). Matching specific todo keywords
3173 together with a tags match is also possible, see *Note Tag
3176 The commands available in the tags list are described in *Note
3180 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3182 8.3.4 Timeline for a single file
3183 --------------------------------
3185 The timeline summarizes all time-stamped items from a single Org-mode
3186 file in a _time-sorted view_. The main purpose of this command is to
3187 give an overview over events in a project.
3190 Show a time-sorted view of the org file, with all time-stamped
3191 items. When called with a `C-u' prefix, all unfinished TODO
3192 entries (scheduled or not) are also listed under the current date.
3194 The commands available in the timeline buffer are listed in *Note
3198 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3200 8.3.5 Stuck projects
3201 --------------------
3203 If you are following a system like David Allen's GTD to organize your
3204 work, one of the "duties" you have is a regular review to make sure
3205 that all projects move along. A _stuck_ project is a project that has
3206 no defined next actions, so it will never show up in the TODO lists
3207 Org-mode produces. During the review, you need to identify such
3208 projects and define next actions for them.
3211 List projects that are stuck.
3214 Customize the variable `org-stuck-projects' to define what a stuck
3215 project is and how to find it.
3217 You almost certainly will have to configure this view before it will
3218 work for you. The built-in default assumes that all your projects are
3219 level-2 headlines, and that a project is not stuck if it has at least
3220 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3222 Lets assume that you, in your own way of using Org-mode, identify
3223 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3224 indicate a project that should not be considered yet. Lets further
3225 assume that the todo keyword DONE marks finished projects, and that NEXT
3226 and TODO indicate next actions. Finally, the tag @SHOP indicates
3227 shopping and is a next action even without the NEXT tag. In this case
3228 you would start by identifying elegible projects with a tags/todo match
3229 `+PROJECT/-MAYBE-DONE', and then check for TODO, NEXT and @SHOP in the
3230 subtree to identify projects that are not stuck. The correct
3231 customization for this is
3233 (setq org-stuck-projects
3234 ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")))
3237 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3239 8.4 Presentation and sorting
3240 ============================
3242 Before displaying items in an agenda view, Org-mode visually prepares
3243 the items and sorts them. Each item occupies a single line. The line
3244 starts with a _prefix_ that contains the _category_ (*note
3245 Categories::) of the item and other important information. You can
3246 customize the prefix using the option `org-agenda-prefix-format'. The
3247 prefix is followed by a cleaned-up version of the outline headline
3248 associated with the item.
3252 * Categories:: Not all tasks are equal
3253 * Time-of-day specifications:: How the agenda knows the time
3254 * Sorting of agenda items:: The order of things
3257 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3262 The category is a broad label assigned to each agenda item. By default,
3263 the category is simply derived from the file name, but you can also
3264 specify it with a special line in the buffer, like this:
3268 If there are several such lines in a file, each specifies the
3269 category for the text below it (but the first category also applies to
3270 any text before the first CATEGORY line). The display in the agenda
3271 buffer looks best if the category is not longer than 10 characters.
3274 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3276 8.4.2 Time-of-Day Specifications
3277 --------------------------------
3279 Org-mode checks each agenda item for a time-of-day specification. The
3280 time can be part of the time stamp that triggered inclusion into the
3281 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3282 specified with two time stamps, like
3283 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3285 In the headline of the entry itself, a time(range) may also appear as
3286 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3287 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3288 entries are recognized as well.
3290 For agenda display, Org-mode extracts the time and displays it in a
3291 standard 24 hour format as part of the prefix. The example times in
3292 the previous paragraphs would end up in the agenda like this:
3294 8:30-13:00 Arthur Dent lies in front of the bulldozer
3295 12:45...... Ford Prefect arrives and takes Arthur to the pub
3296 19:00...... The Vogon reads his poem
3297 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3299 If the agenda is in single-day mode, or for the display of today, the
3300 timed entries are embedded in a time grid, like
3302 8:00...... ------------------
3303 8:30-13:00 Arthur Dent lies in front of the bulldozer
3304 10:00...... ------------------
3305 12:00...... ------------------
3306 12:45...... Ford Prefect arrives and takes Arthur to the pub
3307 14:00...... ------------------
3308 16:00...... ------------------
3309 18:00...... ------------------
3310 19:00...... The Vogon reads his poem
3311 20:00...... ------------------
3312 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3314 The time grid can be turned on and off with the variable
3315 `org-agenda-use-time-grid', and can be configured with
3316 `org-agenda-time-grid'.
3319 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3321 8.4.3 Sorting of agenda items
3322 -----------------------------
3324 Before being inserted into a view, the items are sorted. How this is
3325 done depends on the type of view.
3326 * For the daily/weekly agenda, the items for each day are sorted.
3327 The default order is to first collect all items containing an
3328 explicit time-of-day specification. These entries will be shown
3329 at the beginning of the list, as a _schedule_ for the day. After
3330 that, items remain grouped in categories, in the sequence given by
3331 `org-agenda-files'. Within each category, items are sorted by
3332 priority (*note Priorities::), which is composed of the base
3333 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3334 plus additional increments for overdue scheduled or deadline items.
3336 * For the TODO list, items remain in the order of categories, but
3337 within each category, sorting takes place according to priority
3338 (*note Priorities::).
3340 * For tags matches, items are not sorted at all, but just appear in
3341 the sequence in which they are found in the agenda files.
3343 Sorting can be customized using the variable
3344 `org-agenda-sorting-strategy'.
3347 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3349 8.5 Commands in the agenda buffer
3350 =================================
3352 Entries in the agenda buffer are linked back to the org file or diary
3353 file where they originate. You are not allowed to edit the agenda
3354 buffer itself, but commands are provided to show and jump to the
3355 original entry location, and to edit the org-files "remotely" from the
3356 agenda buffer. In this way, all information is stored only once,
3357 removing the risk that your agenda and note files may diverge.
3359 Some commands can be executed with mouse clicks on agenda lines. For
3360 the other commands, the cursor needs to be in the desired line.
3366 Next line (same as <up>).
3369 Previous line (same as <down>).
3376 Display the original location of the item in another window.
3379 Display original location and recenter that window.
3384 Go to the original location of the item in another window. Under
3385 Emacs 22, `mouse-1' will also works for this.
3388 Go to the original location of the item and delete other windows.
3391 Toggle Follow mode. In Follow mode, as you move the cursor through
3392 the agenda buffer, the other window always shows the corresponding
3393 location in the org file. The initial setting for this mode in new
3394 agenda buffers can be set with the variable
3395 `org-agenda-start-with-follow-mode'.
3398 Display the entire subtree of the current item in an indirect
3399 buffer. With numerical prefix ARG, go up to this level and then
3400 take that tree. If ARG is negative, go up that many levels. With
3401 `C-u' prefix, do not remove the previously used indirect buffer.
3404 Toggle Logbook mode. In Logbook mode, entries that where marked
3405 DONE while logging was on (variable `org-log-done') are shown in
3406 the agenda, as are entries that have been clocked on that day.
3412 Delete other windows.
3415 Switch to weekly view (7 days displayed together).
3418 Switch to daily view (just one day displayed).
3421 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3425 Toggle the time grid on and off. See also the variables
3426 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3429 Recreate the agenda buffer, for example to reflect the changes
3430 after modification of the time stamps of items with S-<left> and
3431 S-<right>. When the buffer is the global todo list, a prefix
3432 argument is interpreted to create a selective list for a specific
3436 Save all Org-mode buffers in the current Emacs session.
3439 Display the following `org-agenda-ndays' days. For example, if
3440 the display covers a week, switch to the following week. With
3441 prefix arg, go forward that many times `org-agenda-ndays' days.
3444 Display the previous dates.
3456 Undo a change due to a remote editing command. The change is
3457 undone both in the agenda buffer and in the remote buffer.
3460 Change the TODO state of the item, both in the agenda and in the
3464 Delete the current agenda item along with the entire subtree
3465 belonging to it in the original Org-mode file. If the text to be
3466 deleted remotely is longer than one line, the kill needs to be
3467 confirmed by the user. See variable `org-agenda-confirm-kill'.
3470 Archive the subtree corresponding to the current headline.
3473 Show all tags associated with the current item. Because of
3474 inheritance, this may be more than the tags listed in the line
3478 Set tags for the current headline.
3481 Toggle the ARCHIVE tag for the current headline.
3484 Set the priority for the current item. Org-mode prompts for the
3485 priority character. If you reply with <SPC>, the priority cookie
3486 is removed from the entry.
3489 Display weighted priority of current item.
3493 Increase the priority of the current item. The priority is
3494 changed in the original buffer, but the agenda is not resorted.
3495 Use the `r' key for this.
3499 Decrease the priority of the current item.
3505 Set a deadline for this item.
3508 Change the time stamp associated with the current line by one day
3509 into the future. With prefix argument, change it by that many
3510 days. For example, `3 6 5 S-<right>' will change it by a year.
3511 The stamp is changed in the original org file, but the change is
3512 not directly reflected in the agenda buffer. Use the `r' key to
3516 Change the time stamp associated with the current line by one day
3520 Change the time stamp associated with the current line to today.
3521 The key `>' has been chosen, because it is the same as `S-.' on my
3525 Start the clock on the current item. If a clock is running
3526 already, it is stopped first.
3529 Stop the previously started clock.
3532 Cancel the currently running clock.
3538 Open the Emacs calendar and move to the date at the agenda cursor.
3541 When in the calendar, compute and show the Org-mode agenda for the
3545 Insert a new entry into the diary. Prompts for the type of entry
3546 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3547 new entry in the diary, just as `i d' etc. would do in the
3548 calendar. The date is taken from the cursor position.
3551 Show the phases of the moon for the three months around current
3555 Show sunrise and sunset times. The geographical location must be
3556 set with calendar variables, see documentation of the Emacs
3560 Convert the date at cursor into many other cultural and historic
3564 Show holidays for three month around the cursor date.
3567 Export a single iCalendar file containing entries from all agenda
3574 Quit agenda, remove the agenda buffer.
3577 Exit agenda, remove the agenda buffer and all buffers loaded by
3578 Emacs for the compilation of the agenda. Buffers created by the
3579 user to visit org files will not be removed.
3583 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3585 8.6 Custom agenda views
3586 =======================
3588 Custom agenda commands serve two purposes: to store and quickly access
3589 frequently used TODO and tags searches, and to create special composite
3590 agenda buffers. Custom agenda commands will be accessible through the
3591 dispatcher (*note Agenda dispatcher::), just like the default commands.
3595 * Storing searches:: Type once, use often
3596 * Block agenda:: All the stuff you need in a single buffer
3597 * Setting Options:: Changing the rules
3598 * Batch processing:: Agenda views from the command line
3601 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3603 8.6.1 Storing searches
3604 ----------------------
3606 The first application of custom searches is the definition of keyboard
3607 shortcuts for frequently used searches, either creating an agenda
3608 buffer, or a sparse tree (the latter covering of course only the current
3609 buffer). Custom commands are configured in the variable
3610 `org-agenda-custom-commands'. You can customize this variable, for
3611 example by pressing `C-c a C'. You can also directly set it with Emacs
3612 Lisp in `.emacs'. The following example contains all valid search
3615 (setq org-agenda-custom-commands
3616 '(("w" todo "WAITING")
3617 ("W" todo-tree "WAITING")
3618 ("u" tags "+BOSS-URGENT")
3619 ("v" tags-todo "+BOSS-URGENT")
3620 ("U" tags-tree "+BOSS-URGENT")
3621 ("f" occur-tree "\\<FIXME\\>")))
3623 The initial single-character string in each entry defines the character
3624 you have to press after the dispatcher command `C-c a' in order to
3625 access the command. The second parameter is the search type, followed
3626 by the string or regular expression to be used for the matching. The
3627 example above will therefore define:
3630 as a global search for TODO entries with `WAITING' as the TODO
3634 as the same search, but only in the current buffer and displaying
3635 the results as a sparse tree
3638 as a global tags search for headlines marked `:BOSS:' but not
3642 as the same search as `C-c a u', but limiting the search to
3643 headlines that are also TODO items
3646 as the same search as `C-c a u', but only in the current buffer and
3647 displaying the result as a sparse tree
3650 to create a sparse tree (again: current buffer only) with all
3651 entries containing the word `FIXME'.
3654 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3659 Another possibility is the construction of agenda views that comprise
3660 the results of _several_ commands, each of which creates a block in the
3661 agenda buffer. The available commands include `agenda' for the daily
3662 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3663 todo list (as constructed with `C-c a t'), and the matching commands
3664 discussed above: `todo', `tags', and `tags-todo'. Here are two
3667 (setq org-agenda-custom-commands
3668 '(("h" "Agenda and Home-related tasks"
3672 ("o" "Agenda and Office-related tasks"
3677 This will define `C-c a h' to create a multi-block view for stuff you
3678 need to attend to at home. The resulting agenda buffer will contain
3679 your agenda for the current week, all TODO items that carry the tag
3680 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3681 `C-c a o' provides a similar view for office tasks.
3684 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3686 8.6.3 Setting Options for custom commands
3687 -----------------------------------------
3689 Org-mode contains a number of variables regulating agenda construction
3690 and display. The global variables define the behavior for all agenda
3691 commands, including the custom commands. However, if you want to change
3692 some settings just for a single custom view, you can do so. Setting
3693 options requires inserting a list of variable names and values at the
3694 right spot in `org-agenda-custom-commands'. For example:
3696 (setq org-agenda-custom-commands
3697 '(("w" todo "WAITING"
3698 ((org-agenda-sorting-strategy '(priority-down))
3699 (org-agenda-prefix-format " Mixed: ")))
3700 ("U" tags-tree "+BOSS-URGENT"
3701 ((org-show-following-heading nil)
3702 (org-show-hierarchy-above nil)))))
3704 Now the `C-c a w' command will sort the collected entries only by
3705 priority, and the prefix format is modified to just say ` Mixed:'
3706 instead of giving the category of the entry. The sparse tags tree of
3707 `C-c a U' will now turn out ultra-compact, because neither the headline
3708 hierarchy above the match, nor the headline following the match will be
3711 For command sets creating a block agenda,
3712 `org-agenda-custom-commands' has two separate spots for setting
3713 options. You can add options that should be valid for just a single
3714 command in the set, and options that should be valid for all commands in
3715 the set. The former are just added to the command entry, the latter
3716 must come after the list of command entries. Going back to the block
3717 agenda example (*note Block agenda::), let's change the sorting strategy
3718 for the `C-c a h' commands to `priority-down', but let's sort the
3719 results for GARDEN tags query in the opposite order, `priority-up'.
3720 This would look like this:
3722 (setq org-agenda-custom-commands
3723 '(("h" "Agenda and Home-related tasks"
3726 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
3727 ((org-agenda-sorting-strategy '(priority-down))))
3728 ("o" "Agenda and Office-related tasks"
3733 As you see, the values and parenthesis setting is a little complex.
3734 When in doubt, use the customize interface to set this variable - it
3735 fully supports its structure. Just one caveat: When setting options in
3736 this interface, the _values_ are just lisp expressions. So if the
3737 value is a string, you need to add the double quotes around the value
3741 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
3743 8.6.4 Creating agenda views in batch processing
3744 -----------------------------------------------
3746 If you want to print or otherwise reprocess agenda views, it can be
3747 useful to create an agenda from the command line. This is the purpose
3748 of the function `org-batch-agenda'. It takes as a parameter one of the
3749 strings that are the keys in `org-agenda-custom-commands'. For
3750 example, to directly print the current TODO list, you could use
3752 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
3754 You may also modify parameters on the fly like this:
3756 emacs -batch -l ~/.emacs \
3757 -eval '(org-batch-agenda "a" \
3758 org-agenda-ndays 300 \
3759 org-agenda-include-diary nil \
3760 org-agenda-files (quote ("~/org/project.org")))' \
3763 which will produce a 300 day agenda, fully restricted to the Org file
3764 `~/org/projects.org', not even including the diary.
3767 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
3772 Plain ASCII is normally sufficient for almost all note taking. One
3773 exception, however, are scientific notes which need to be able to
3774 contain mathematical symbols and the occasional formula. LaTeX(1) is
3775 widely used to typeset scientific documents. Org-mode supports
3776 embedding LaTeX code into its files, because many academics are used to
3777 read LaTeX source code, and because it can be readily processed into
3778 images for HTML production.
3780 It is not necessary to mark LaTeX macros and code in any special way.
3781 If you observe a few conventions, Org-mode knows how to find it and what
3786 * Math symbols:: TeX macros for symbols and Greek letters
3787 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
3788 * LaTeX fragments:: Complex formulas made easy
3789 * Processing LaTeX fragments:: Previewing LaTeX processing
3790 * CDLaTeX mode:: Speed up entering of formulas
3792 ---------- Footnotes ----------
3794 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3795 Many of the features described here as "LaTeX" are really from TeX, but
3796 for simplicity I am blurring this distinction.
3799 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
3804 You can use LaTeX macros to insert special symbols like `\alpha' to
3805 indicate the Greek letter, or `\to' to indicate an arrow. Completion
3806 for these macros is available, just type `\' and maybe a few letters,
3807 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
3808 Org-mode allows these macros to be present without surrounding math
3809 delimiters, for example:
3811 Angles are written as Greek letters \alpha, \beta and \gamma.
3813 During HTML export (*note HTML export::), these symbols are
3814 translated into the proper syntax for HTML, for the above examples this
3815 is `α' and `→', respectively.
3818 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
3820 9.2 Subscripts and Superscripts
3821 ===============================
3823 Just like in LaTeX, `^' and `_' are used to indicate super- and
3824 subscripts. Again, these can be used without embedding them in
3825 math-mode delimiters. To increase the readability of ASCII text, it is
3826 not necessary (but OK) to surround multi-character sub- and superscripts
3827 with curly braces. For example
3829 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
3830 the sun is R_{sun} = 6.96 x 10^8 m.
3832 To avoid interpretation as raised or lowered text, you can quote `^'
3833 and `_' with a backslash: `\_' and `\^'.
3835 During HTML export (*note HTML export::), subscript and superscripts
3836 are surrounded with `<sub>' and `<sup>' tags, respectively.
3839 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
3844 With symbols, sub- and superscripts, HTML is pretty much at its end when
3845 it comes to representing mathematical formulas(1). More complex
3846 expressions need a dedicated formula processor. To this end, Org-mode
3847 can contain arbitrary LaTeX fragments. It provides commands to preview
3848 the typeset result of these fragments, and upon export to HTML, all
3849 fragments will be converted to images and inlined into the HTML
3850 document. For this to work you need to be on a system with a working
3851 LaTeX installation. You also need the `dvipng' program, available at
3852 `http://sourceforge.net/projects/dvipng/'.
3854 LaTeX fragments don't need any special marking at all. The following
3855 snippets will be identified as LaTeX source code:
3856 * Environments of any kind. The only requirement is that the
3857 `\begin' statement appears on a new line, preceded by only
3860 * Text within the usual LaTeX math delimiters. To avoid conflicts
3861 with currency specifications, single `$' characters are only
3862 recognized as math delimiters if the enclosed text contains at
3863 most two line breaks, is directly attached to the `$' characters
3864 with no whitespace in between, and if the closing `$' is followed
3865 by whitespace or punctuation. For the other delimiters, there is
3866 no such restriction, so when in doubt, use `\(...\)' as inline
3871 \begin{equation} % arbitrary environments,
3872 x=\sqrt{b} % even tables, figures
3873 \end{equation} % etc
3875 If $a^2=b$ and \( b=2 \), then the solution must be
3876 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
3878 If you need any of the delimiter ASCII sequences for other purposes, you
3879 can configure the option `org-format-latex-options' to deselect the
3880 ones you do not wish to have interpreted by the LaTeX converter.
3882 ---------- Footnotes ----------
3884 (1) Yes, there is MathML, but that is not yet fully supported by
3885 many browsers, and there is no decent converter for turning LaTeX of
3886 ASCII representations of formulas into MathML. So for the time being,
3887 converting formulas into images seems the way to go.
3890 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
3892 9.4 Processing LaTeX fragments
3893 ==============================
3895 LaTeX fragments can be processed to produce a preview images of the
3896 typeset expressions:
3899 Produce a preview image of the LaTeX fragment at point and overlay
3900 it over the source code. If there is no fragment at point,
3901 process all fragments in the current entry (between two
3902 headlines). When called with a prefix argument, process the
3903 entire subtree. When called with two prefix arguments, or when
3904 the cursor is before the first headline, process the entire buffer.
3907 Remove the overlay preview images.
3909 During HTML export (*note HTML export::), all LaTeX fragments are
3910 converted into images and inlined into the document if the following
3913 (setq org-export-with-LaTeX-fragments t)
3916 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
3918 9.5 Using CDLaTeX to enter math
3919 ===============================
3921 CDLaTeX-mode is a minor mode that is normally used in combination with a
3922 major LaTeX mode like AUCTeX in order to speed-up insertion of
3923 environments and math templates. Inside Org-mode, you can make use of
3924 some of the features of cdlatex-mode. You need to install `cdlatex.el'
3925 and `texmathp.el' (the latter comes also with AUCTeX) from
3926 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
3927 cdlatex-mode itself under Org-mode, but use the light version
3928 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
3929 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
3932 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
3934 When this mode is enabled, the following features are present (for
3935 more details see the documentation of cdlatex-mode):
3936 * Environment templates can be inserted with `C-c {'.
3938 * The <TAB> key will do template expansion if the cursor is inside a
3939 LaTeX fragment(1). For example, <TAB> will expand `fr' to
3940 `\frac{}{}' and position the cursor correctly inside the first
3941 brace. Another <TAB> will get you into the second brace. Even
3942 outside fragments, <TAB> will expand environment abbreviations at
3943 the beginning of a line. For example, if you write `equ' at the
3944 beginning of a line and press <TAB>, this abbreviation will be
3945 expanded to an `equation' environment. To get a list of all
3946 abbreviations, type `M-x cdlatex-command-help'.
3948 * Pressing `_' and `^' inside a LaTeX fragment will insert these
3949 characters together with a pair of braces. If you use <TAB> to
3950 move out of the braces, and if the braces surround only a single
3951 character or macro, they are removed again (depending on the
3952 variable `cdlatex-simplify-sub-super-scripts').
3954 * Pressing the backquote ``' followed by a character inserts math
3955 macros, also outside LaTeX fragments. If you wait more than 1.5
3956 seconds after the backquote, a help window will pop up.
3958 * Pressing the normal quote `'' followed by another character
3959 modifies the symbol before point with an accent or a font. If you
3960 wait more than 1.5 seconds after the backquote, a help window will
3961 pop up. Character modification will work only inside LaTeX
3962 fragments, outside the quote is normal.
3964 ---------- Footnotes ----------
3966 (1) Org-mode has a method to test if the cursor is inside such a
3967 fragment, see the documentation of the function
3968 `org-inside-LaTeX-fragment-p'.
3971 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
3976 Org-mode documents can be exported into a variety of other formats. For
3977 printing and sharing of notes, ASCII export produces a readable and
3978 simple version of an Org-mode file. HTML export allows you to publish a
3979 notes file on the web, while the XOXO format provides a solid base for
3980 exchange with a broad range of other applications. To incorporate
3981 entries with associated times like deadlines or appointments into a
3982 desktop calendar program like iCal, Org-mode can also produce extracts
3983 in the iCalendar format. Currently Org-mode only supports export, not
3984 import of these different formats.
3986 When exporting, Org-mode uses special conventions to enrich the
3987 output produced. *Note Text interpretation::, for more details.
3990 Dispatcher for export and publishing commands. Displays a
3991 help-window listing the additional key(s) needed to launch an
3992 export or publishing command.
3996 * ASCII export:: Exporting to plain ASCII
3997 * HTML export:: Exporting to HTML
3998 * XOXO export:: Exporting to XOXO
3999 * iCalendar export:: Exporting in iCalendar format
4000 * Text interpretation:: How the exporter looks at the file
4003 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4008 ASCII export produces a simple and very readable version of an Org-mode
4012 Export as ASCII file. If there is an active region, only the
4013 region will be exported. For an org file `myfile.org', the ASCII
4014 file will be `myfile.txt'. The file will be overwritten without
4018 Export only the visible part of the document.
4020 In the exported version, the first 3 outline levels will become
4021 headlines, defining a general document structure. Additional levels
4022 will be exported as itemized lists. If you want that transition to
4023 occur at a different level, specify it with a prefix argument. For
4028 creates only top level headlines and does the rest as items. When
4029 headlines are converted to items, the indentation of the text following
4030 the headline is changed to fit nicely under the item. This is done with
4031 the assumption that the first bodyline indicates the base indentation of
4032 the body text. Any indentation larger than this is adjusted to preserve
4033 the layout relative to the first line. Should there be lines with less
4034 indentation than the first, these are left alone.
4037 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4042 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4043 HTML formatting, in ways similar to John Grubers _markdown_ language,
4044 but with additional support for tables.
4047 Export as HTML file `myfile.html'.
4050 Export as HTML file and open it with a browser.
4055 Export only the visible part of the document.
4057 In the exported version, the first 3 outline levels will become
4058 headlines, defining a general document structure. Additional levels
4059 will be exported as itemized lists. If you want that transition to
4060 occur at a different level, specify it with a prefix argument. For
4065 creates two levels of headings and does the rest as items.
4067 If you want to include HTML tags which should be interpreted as such,
4068 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
4069 always transformed to `<' and `>' in HTML export.
4071 Internal links (*note Internal links::) will continue to work in HTML
4072 files only if they match a dedicated `<<target>>'. Automatic links
4073 created by radio targets (*note Radio targets::) will also work in the
4074 HTML file. Links to external files will still work if the HTML file is
4075 in the same directory as the Org-mode file. Links to other `.org'
4076 files will be translated into HTML links under the assumption that an
4077 HTML version also exists of the linked file. For information related to
4078 linking files while publishing them to a publishing directory see *Note
4081 You can also give style information for the exported file. The HTML
4082 exporter assigns the following CSS classes to appropriate parts of the
4083 document - your style specifications may change these:
4085 .done the DONE keyword
4086 .timestamp time stamp
4087 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4088 .tag tag in a headline
4089 .target target for links
4091 The default style specification can be configured through the option
4092 `org-export-html-style'. If you want to use a file-local style, you
4093 may use file variables, best wrapped into a COMMENT section at the end
4094 of the outline tree. For example:
4096 * COMMENT HTML style specifications
4099 # org-export-html-style: " <style type=\"text/css\">
4100 # p {font-weight: normal; color: gray; }
4101 # h1 {color: black; }
4105 Remember to execute `M-x normal-mode' after changing this to make
4106 the new style visible to Emacs. This command restarts org-mode for the
4107 current buffer and forces Emacs to re-evaluate the local variables
4108 section in the buffer.
4111 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4116 Org-mode contains an exporter that produces XOXO-style output.
4117 Currently, this exporter only handles the general outline structure and
4118 does not interpret any additional Org-mode features.
4121 Export as XOXO file `myfile.html'.
4124 Export only the visible part of the document.
4127 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4129 10.4 iCalendar export
4130 =====================
4132 Some people like to use Org-mode for keeping track of projects, but
4133 still prefer a standard calendar application for anniversaries and
4134 appointments. In this case it can be useful to have deadlines and
4135 other time-stamped items in Org-mode files show up in the calendar
4136 application. Org-mode can export calendar information in the standard
4140 Create iCalendar entries for the current file and store them in
4141 the same directory, using a file extension `.ics'.
4144 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4145 For each of these files, a separate iCalendar file will be
4149 Create a single large iCalendar file from all files in
4150 `org-agenda-files' and write it to the file given by
4151 `org-combined-agenda-icalendar-file'.
4153 How this calendar is best read and updated, depends on the
4154 application you are using. For example, when using iCal under Apple
4155 MacOS X, you could create a new calendar `OrgMode' (the default name
4156 for the calendar created by `C-c C-e c', see the variables
4157 `org-icalendar-combined-name' and
4158 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
4159 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
4160 use AppleScript to make iCal re-read the calendar files each time a new
4161 version of `OrgMode.ics' is produced. Here is the setup needed for
4164 (setq org-combined-agenda-icalendar-file
4165 "~/Library/Calendars/OrgMode.ics")
4166 (add-hook 'org-after-save-iCalendar-file-hook
4169 "osascript -e 'tell application \"iCal\" to reload calendars'")))
4172 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4174 10.5 Text interpretation by the exporter
4175 ========================================
4177 The exporter backends interpret additional structure in the Org-mode
4178 file in order to produce better output.
4182 * Comment lines:: Some lines will not be exported
4183 * Enhancing text:: Subscripts, symbols and more
4184 * Export options:: How to influence the export settings
4187 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
4189 10.5.1 Comment lines
4190 --------------------
4192 Lines starting with `#' in column zero are treated as comments and will
4193 never be exported. Also entire subtrees starting with the word
4194 `COMMENT' will never be exported. Finally, any text before the first
4195 headline will not be exported either.
4198 Toggle the COMMENT keyword at the beginning of an entry.
4201 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
4203 10.5.2 Enhancing text for export
4204 --------------------------------
4206 Some of the export backends of Org-mode allow for sophisticated text
4207 formatting, this is true in particular for the HTML backend. Org-mode
4208 has a number of typing conventions that allow to produce a richly
4211 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4212 enumerator will be recognized and transformed if the backend
4213 supports lists. See *Note Plain lists::.
4215 * You can make words *bold*, /italic/, _underlined_, `=code=', and
4218 * Many TeX macros and entire LaTeX fragments are converted into HTML
4219 entities or images (*note Embedded LaTeX::).
4221 * Tables are transformed into native tables under the exporter, if
4222 the export backend supports this. Data fields before the first
4223 horizontal separator line will be formatted as table header fields.
4225 * If a headline starts with the word `QUOTE', the text below the
4226 headline will be typeset as fixed-width, to allow quoting of
4227 computer codes etc. Lines starting with `:' are also typeset in
4230 Toggle fixed-width for entry (QUOTE) or region, see below.
4232 * A double backslash _at the end of a line_ enforces a line break at
4235 If these conversions conflict with your habits of typing ASCII text,
4236 they can all be turned off with corresponding variables (see the
4237 customization group `org-export-general', and the following section
4238 which explains how to set export options with special lines in a buffer.
4241 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
4243 10.5.3 Export options
4244 ---------------------
4246 The exporter recognizes special lines in the buffer which provide
4247 additional information. These lines may be put anywhere in the file.
4248 The whole set of lines can be inserted into the buffer with `C-c C-e
4249 t'. For individual lines, a good way to make sure the keyword is
4250 correct is to type `#+' and then use `M-<TAB>' completion (*note
4254 Insert template with export options, see example below.
4256 #+TITLE: the title to be shown (default is the buffer name)
4257 #+AUTHOR: the author (default taken from `user-full-name')
4258 #+EMAIL: his/her email address (default from `user-mail-address')
4259 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
4260 #+TEXT: Some descriptive text to be inserted at the beginning.
4261 #+TEXT: Several lines may be given.
4262 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
4264 The OPTIONS line is a compact form to specify export settings. Here
4266 H: set the number of headline levels for export
4267 num: turn on/off section-numbers
4268 toc: turn on/off table of contents
4269 \n: turn on/off linebreak-preservation
4270 @: turn on/off quoted HTML tags
4271 :: turn on/off fixed-width sections
4272 |: turn on/off tables
4273 ^: turn on/off TeX-like syntax for sub- and superscripts.
4274 *: turn on/off emphasized text (bold, italic, underlined)
4275 TeX: turn on/off simple TeX macros in plain text
4276 LaTeX: turn on/off LaTeX fragments
4279 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
4284 Org-mode includes(1) a publishing management system that allows you to
4285 configure automatic HTML conversion of _projects_ composed of
4286 interlinked org files. This system is called _org-publish_. You can
4287 also configure org-publish to automatically upload your exported HTML
4288 pages and related attachments, such as images and source code files, to
4289 a web server. Org-publish turns org-mode into a web-site authoring
4292 Org-publish has been contributed to Org-mode by David O'Toole.
4296 * Configuration:: Defining projects
4297 * Sample configuration:: Example projects
4298 * Triggering publication:: Publication commands
4300 ---------- Footnotes ----------
4302 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4303 `org.el' as it comes with Emacs, you need to download this file
4304 separately. Also make sure org.el is at least version 4.27.
4307 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4312 Publishing needs significant configuration to specify files, destination
4313 and many other properties of a project.
4317 * Project alist:: The central configuration variable
4318 * Sources and destinations:: From here to there
4319 * Selecting files:: What files are part of the project?
4320 * Publishing action:: Setting the function doing the publishing
4321 * Publishing options:: Tweaking HTML export
4322 * Publishing links:: Which links keep working after publishing?
4323 * Project page index:: Publishing a list of project files
4326 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4328 11.1.1 The variable `org-publish-project-alist'
4329 -----------------------------------------------
4331 Org-publish is configured almost entirely through setting the value of
4332 one variable, called `org-publish-project-alist'. Each element of the
4333 list configures one project, and may be in one of the two following
4336 ("project-name" :property value :property value ...)
4340 ("project-name" :components ("project-name" "project-name" ...))
4342 In both cases, projects are configured by specifying property values.
4343 A project defines the set of files that will be published, as well as
4344 the publishing configuration to use when publishing those files. When
4345 a project takes the second form listed above, the individual members of
4346 the "components" property are taken to be components of the project,
4347 which group together files requiring different publishing options. When
4348 you publish such a "meta-project" all the components will also publish.
4351 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4353 11.1.2 Sources and destinations for files
4354 -----------------------------------------
4356 Most properties are optional, but some should always be set. In
4357 particular, org-publish needs to know where to look for source files,
4358 and where to put published files.
4360 `:base-directory' Directory containing publishing source files
4361 `:publishing-directory'Directory (possibly remote) where output files
4363 `:preparation-function'Function called before starting publishing
4364 process, for example to run `make' for updating
4365 files to be published.
4368 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4370 11.1.3 Selecting files
4371 ----------------------
4373 By default, all files with extension `.org' in the base directory are
4374 considered part of the project. This can be modified by setting the
4376 `:base-extension' Extension (without the dot!) of source files. This
4377 actually is a regular expression.
4378 `:exclude' Regular expression to match file names that should
4379 not be published, even though they have been selected
4380 on the basis of their extension.
4381 `:include' List of files to be included regardless of
4382 `:base-extension' and `:exclude'.
4385 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4387 11.1.4 Publishing Action
4388 ------------------------
4390 Publishing means that a file is copied to the destination directory and
4391 possibly transformed in the process. The default transformation is to
4392 export Org-mode files as HTML files, and this is done by the function
4393 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4394 export::). Other files like images only need to be copied to the
4395 publishing destination. For non-Org-mode files, you need to specify
4396 the publishing function.
4398 `:publishing-function' Function executing the publication of a file.
4399 This may also be a list of functions, which will
4400 all be called in turn.
4402 The function must accept two arguments: a property list containing at
4403 least a `:publishing-directory' property, and the name of the file to
4404 be published. It should take the specified file, make the necessary
4405 transformation (if any) and place the result into the destination
4406 folder. You can write your own publishing function, but `org-publish'
4407 provides one for attachments (files that only need to be copied):
4408 `org-publish-attachment'.
4411 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4413 11.1.5 Options for the HTML exporter
4414 ------------------------------------
4416 The property list can be used to set many export options for the HTML
4417 exporter. In most cases, these properties correspond to user variables
4418 in Org-mode. The table below lists these properties along with the
4419 variable they belong to. See the documentation string for the
4420 respective variable for details.
4422 `:language' `org-export-default-language'
4423 `:headline-levels' `org-export-headline-levels'
4424 `:section-numbers' `org-export-with-section-numbers'
4425 `:table-of-contents' `org-export-with-toc'
4426 `:archived-trees' `org-export-with-archived-trees'
4427 `:emphasize' `org-export-with-emphasize'
4428 `:sub-superscript' `org-export-with-sub-superscripts'
4429 `:TeX-macros' `org-export-with-TeX-macros'
4430 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4431 `:fixed-width' `org-export-with-fixed-width'
4432 `:timestamps' `org-export-with-timestamps'
4434 `:tags' `org-export-with-tags'
4436 `:tables' `org-export-with-tables'
4437 `:table-auto-headline' `org-export-highlight-first-table-line'
4438 `:style' `org-export-html-style'
4439 `:convert-org-links' `org-export-html-link-org-files-as-html'
4440 `:inline-images' `org-export-html-inline-images'
4441 `:expand-quoted-html' `org-export-html-expand'
4442 `:timestamp' `org-export-html-with-timestamp'
4443 `:publishing-directory'`org-export-publishing-directory'
4444 `:preamble' `org-export-html-preamble'
4445 `:postamble' `org-export-html-postamble'
4446 `:auto-preamble' `org-export-html-auto-preamble'
4447 `:auto-postamble' `org-export-html-auto-postamble'
4448 `:author' `user-full-name'
4449 `:email' `user-mail-address'
4451 When a property is given a value in org-publish-project-alist, its
4452 setting overrides the value of the corresponding user variable (if any)
4453 during publishing. options set within a file (*note Export options::),
4454 however, override everything.
4457 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4459 11.1.6 Links between published files
4460 ------------------------------------
4462 To create a link from one Org-mode file to another, you would use
4463 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4464 (*note Hyperlinks::). Upon publishing this link becomes a link to
4465 `foo.html'. In this way, you can interlink the pages of your "org web"
4466 project and the links will work as expected when you publish them to
4469 You may also link to related files, such as images. Provided you are
4470 careful with relative pathnames, and provided you have also configured
4471 org-publish to upload the related files, these links will work too.
4472 *Note Complex example:: for an example of this usage.
4474 Sometime an Org-mode file to be published may contain links that are
4475 only valid in your production environment, but not in the publishing
4476 location. In this case, use the property
4478 `:link-validation-function' Function to validate links
4480 to define a function for checking link validity. This function must
4481 accept two arguments, the file name and a directory relative to which
4482 the file name is interpreted in the production environment. If this
4483 function returns `nil', then the HTML generator will only insert a
4484 description into the HTML file, but no link. One option for this
4485 function is `org-publish-validate-link' which checks if the given file
4486 is part of any project in `org-publish-project-alist'.
4489 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4491 11.1.7 Project page index
4492 -------------------------
4494 The following properties may be used to control publishing of an index
4495 of files or summary page for a given project.
4497 `:auto-index' When non-nil, publish an index during
4498 org-publish-current-project or org-publish-all.
4499 `:index-filename' Filename for output of index. Defaults to `index.org'
4500 (which becomes `index.html').
4501 `:index-title' Title of index page. Defaults to name of file.
4502 `:index-function' Plugin function to use for generation of index.
4503 Defaults to `org-publish-org-index', which generates
4504 a plain list of links to all files in the project.
4507 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4509 11.2 Sample configuration
4510 =========================
4512 Below we provide two example configurations. The first one is a simple
4513 project publishing only a set of Org-mode files. The second example is
4514 more complex, with a multi-component project.
4518 * Simple example:: One-component publishing
4519 * Complex example:: A multi-component publishing example
4522 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4524 11.2.1 Example: simple publishing configuration
4525 -----------------------------------------------
4527 This example publishes a set of Org-mode files to the `public_html'
4528 directory on the local machine.
4530 (setq org-publish-project-alist
4532 :base-directory "~/org/"
4533 :publishing-directory "~/public_html"
4534 :section-numbers nil
4535 :table-of-contents nil
4536 :style "<link rel=stylesheet
4537 href=\"../other/mystyle.css\"
4538 type=\"text/css\">")))
4541 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4543 11.2.2 Example: complex publishing configuration
4544 ------------------------------------------------
4546 This more complicated example publishes an entire website, including
4547 org files converted to HTML, image files, emacs lisp source code, and
4548 stylesheets. The publishing-directory is remote and private files are
4551 To ensure that links are preserved, care should be taken to replicate
4552 your directory structure on the web server, and to use relative file
4553 paths. For example, if your org files are kept in `~/org' and your
4554 publishable images in `~/images', you'd link to an image with
4555 file:../images/myimage.png
4556 On the web server, the relative path to the image should be the
4557 same. You can accomplish this by setting up an "images" folder in the
4558 right place on the webserver, and publishing images to it.
4560 (setq org-publish-project-alist
4562 :base-directory "~/org/"
4563 :base-extension "org"
4564 :publishing-directory "/ssh:user@host:~/html/notebook/"
4565 :publishing-function org-publish-org-to-html
4566 :exclude "PrivatePage.org" ;; regexp
4568 :section-numbers nil
4569 :table-of-contents nil
4570 :style "<link rel=stylesheet
4571 href=\"../other/mystyle.css\" type=\"text/css\">"
4573 :auto-postamble nil)
4576 :base-directory "~/images/"
4577 :base-extension "jpg\\|gif\\|png"
4578 :publishing-directory "/ssh:user@host:~/html/images/"
4579 :publishing-function org-publish-attachment)
4582 :base-directory "~/other/"
4583 :base-extension "css\\|el"
4584 :publishing-directory "/ssh:user@host:~/html/other/"
4585 :publishing-function org-publish-attachment)
4586 ("website" :components ("orgfiles" "images" "other"))))
4589 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4591 11.3 Triggering publication
4592 ===========================
4594 Once org-publish is properly configured, you can publish with the
4595 following functions:
4598 Prompt for a specific project and publish all files that belong to
4602 Publish the project containing the current file.
4605 Publish only the current file.
4608 Publish all projects.
4610 Org uses timestamps to track when a file has changed. The above
4611 functions normally only publish changed files. You can override this and
4612 force publishing of all files by giving a prefix argument.
4615 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4622 * Completion:: M-TAB knows what you need
4623 * Customization:: Adapting Org-mode to your taste
4624 * In-buffer settings:: Overview of the #+KEYWORDS
4625 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4626 * Clean view:: Getting rid of leading stars in the outline
4627 * TTY keys:: Using Org-mode on a tty
4628 * Interaction:: Other Emacs packages
4629 * Bugs:: Things which do not work perfectly
4632 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
4637 Org-mode supports in-buffer completion. This type of completion does
4638 not make use of the minibuffer. You simply type a few letters into the
4639 buffer and use the key to complete text right there.
4642 Complete word at point
4643 * At the beginning of a headline, complete TODO keywords.
4645 * After `\', complete TeX symbols supported by the exporter.
4647 * After `*', complete headlines in the current buffer so that
4648 they can be used in search links like `[[*find this
4651 * After `:', complete tags. The list of tags is taken from the
4652 variable `org-tag-alist' (possibly set through the `#+TAGS'
4653 in-buffer option, *note Setting tags::), or it is created
4654 dynamically from all tags used in the current buffer.
4656 * After `[', complete link abbreviations (*note Link
4659 * After `#+', complete the special keywords like `TYP_TODO' or
4660 `OPTIONS' which set file-specific options for Org-mode. When
4661 the option keyword is already complete, pressing `M-<TAB>'
4662 again will insert example settings for this keyword.
4664 * In the line after `#+STARTUP: ', complete startup keywords,
4665 i.e. valid keys for this line.
4667 * Elsewhere, complete dictionary words using ispell.
4670 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
4675 There are more than 170 variables that can be used to customize
4676 Org-mode. For the sake of compactness of the manual, I am not
4677 describing the variables here. A structured overview of customization
4678 variables is available with `M-x org-customize'. Or select `Browse Org
4679 Group' from the `Org->Customization' menu. Many settings can also be
4680 activated on a per-file basis, by putting special lines into the buffer
4681 (*note In-buffer settings::).
4684 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
4686 12.3 Summary of in-buffer settings
4687 ==================================
4689 Org-mode uses special lines in the buffer to define settings on a
4690 per-file basis. These lines start with a `#+' followed by a keyword, a
4691 colon, and then individual words defining a setting. Several setting
4692 words can be in the same line, but you can also have multiple lines for
4693 the keyword. While these settings are described throughout the manual,
4694 here is a summary. After changing any of those lines in the buffer,
4695 press `C-c C-c' with the cursor still in the line to activate the
4696 changes immediately. Otherwise they become effective only when the
4697 file is visited again in a new Emacs session.
4700 This line sets options to be used at startup of org-mode, when an
4701 Org-mode file is being visited. The first set of options deals
4702 with the initial visibility of the outline tree. The
4703 corresponding variable for global default settings is
4704 `org-startup-folded', with a default value `t', which means
4706 overview top-level headlines only
4707 content all headlines
4708 showall no folding at all, show everything
4709 Then there are options for aligning tables upon visiting a file.
4710 This is useful in files containing narrowed table columns. The
4711 corresponding variable is `org-startup-align-all-tables', with a
4712 default value `nil'.
4713 align align all tables
4714 noalign don't align tables on startup
4715 Logging when a TODO item is marked DONE (variable `org-log-done')
4716 can be configured using these options.
4717 logging record a timestamp when an item is marked DONE
4718 nologging don't record when items are marked DONE
4719 Here are the options for hiding leading stars in outline headings.
4720 The corresponding variables are `org-hide-leading-stars' and
4721 `org-odd-levels-only', both with a default setting `nil' (meaning
4722 `showstars' and `oddeven').
4723 hidestars make all but one of the stars starting a headline invisible.
4724 showstars show all stars starting a headline
4725 odd allow only odd outline levels (1,3,...)
4726 oddeven allow all outline levels
4727 To turn on custom format overlays over time stamps (variables
4728 `org-put-time-stamp-overlays' and
4729 `org-time-stamp-overlay-formats'), use
4730 customtime overlay custom time format
4732 `#+SEQ_TODO: #+TYP_TODO:'
4733 These lines set the TODO keywords and their interpretation in the
4734 current file. The corresponding variables are `org-todo-keywords'
4735 and `org-todo-interpretation'.
4737 `#+TAGS: TAG1(c1) TAG2(c2)'
4738 These lines (several such lines are allowed) specify the legal
4739 tags in this file, and (potentially) the corresponding _fast tag
4740 selection_ keys. The corresponding variable is `org-tag-alist'.
4742 `#+LINK: linkword replace'
4743 These lines (several are allowed) specify link abbreviations.
4744 *Note Link abbreviations::. The corresponding variable is
4745 `org-link-abbrev-alist'.
4748 This line sets the category for the agenda file. The category
4749 applies for all subsequent lines until the next `#+CATEGORY' line,
4750 or the end of the file.
4753 This line contains the formulas for the table directly above the
4756 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
4757 These lines provide settings for exporting files. For more
4758 details see *Note Export options::.
4761 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
4763 12.4 The very busy C-c C-c key
4764 ==============================
4766 The key `C-c C-c' has many purposes in org-mode, which are all
4767 mentioned scattered throughout this manual. One specific function of
4768 this key is to add _tags_ to a headline (*note Tags::). In many other
4769 circumstances it means something like _Hey Org-mode, look here and
4770 update according to what you see here_. Here is a summary of what this
4771 means in different contexts.
4773 - If there are highlights in the buffer from the creation of a sparse
4774 tree, or from clock display, remove these highlights.
4776 - If the cursor is in one of the special `#+KEYWORD' lines, this
4777 triggers scanning the buffer for these lines and updating the
4780 - If the cursor is inside a table, realign the table. This command
4781 works even if the automatic table editor has been turned off.
4783 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
4786 - If the cursor is inside a table created by the `table.el' package,
4787 activate that table.
4789 - If the current buffer is a remember buffer, close the note and
4790 file it. With a prefix argument, file it, without further
4791 interaction, to the default location.
4793 - If the cursor is on a `<<<target>>>', update radio targets and
4794 corresponding links in this buffer.
4796 - If the cursor is in a plain list item with a checkbox, toggle the
4797 status of the checkbox.
4799 - If the cursor is on a numbered item in a plain list, renumber the
4803 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
4805 12.5 A cleaner outline view
4806 ===========================
4808 Some people find it noisy and distracting that the Org-mode headlines
4809 are starting with a potentially large number of stars. For example the
4810 tree from *Note Headlines:::
4812 * Top level headline
4818 * Another top level headline
4820 Unfortunately this is deeply ingrained into the code of Org-mode and
4821 cannot be easily changed. You can, however, modify the display in such
4822 a way that all leading stars become invisible and the outline more easy
4823 to read. To do this, customize the variable `org-hide-leading-stars'
4826 (setq org-hide-leading-stars t)
4828 or change this on a per-file basis with one of the lines (anywhere in
4831 #+STARTUP: showstars
4832 #+STARTUP: hidestars
4834 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
4837 With stars hidden, the tree becomes:
4839 * Top level headline
4845 * Another top level headline
4847 Note that the leading stars are not truly replaced by whitespace, they
4848 are only fontified with the face `org-hide' that uses the background
4849 color as font color. If you are not using either white or black
4850 background, you may have to customize this face to get the wanted
4851 effect. Another possibility is to set this font such that the extra
4852 stars are almost invisible, for example using the color `grey90' on a
4855 Things become cleaner still if you skip all the even levels and use
4856 only odd levels 1, 3, 5..., effectively adding two stars to go from one
4857 outline level to the next:
4859 * Top level headline
4865 * Another top level headline
4867 In order to make the structure editing and export commands handle this
4868 convention correctly, use
4870 (setq org-odd-levels-only t)
4872 or set this on a per-file basis with one of the following lines (don't
4873 forget to press `C-c C-c' with the cursor in the startup line to
4874 activate changes immediately).
4879 You can convert an Org-mode file from single-star-per-level to the
4880 double-star-per-level convention with `M-x org-convert-to-odd-levels
4881 RET' in that file. The reverse operation is `M-x
4882 org-convert-to-oddeven-levels'.
4885 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
4887 12.6 Using org-mode on a tty
4888 ============================
4890 Org-mode uses a number of keys that are not accessible on a tty. This
4891 applies to most special keys like cursor keys, <TAB> and <RET>, when
4892 these are combined with modifier keys like <Meta> and/or <Shift>.
4893 Org-mode uses these bindings because it needs to provide keys for a
4894 large number of commands, and because these keys appeared particularly
4895 easy to remember. In order to still be able to access the core
4896 functionality of Org-mode on a tty, alternative bindings are provided.
4897 Here is a complete list of these bindings, which are obviously more
4898 cumbersome to use. Note that sometimes a work-around can be better.
4899 For example changing a time stamp is really only fun with `S-<cursor>'
4900 keys. On a tty you would rather use `C-c .' to re-insert the
4903 Default Alternative 1 Alternative 2
4904 `S-<TAB>' `C-u <TAB>'
4905 `M-<left>' `C-c C-x l' `<Esc> <left>'
4906 `M-S-<left>'`C-c C-x L'
4907 `M-<right>' `C-c C-x r' `<Esc>
4909 `M-S-<right>'`C-c C-x R'
4910 `M-<up>' `C-c C-x u' `<Esc> <up>'
4911 `M-S-<up>' `C-c C-x U'
4912 `M-<down>' `C-c C-x d' `<Esc> <down>'
4913 `M-S-<down>'`C-c C-x D'
4914 `S-<RET>' `C-c C-x c'
4915 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
4916 `M-S-<RET>' `C-c C-x M'
4919 `S-<right>' `C-c C-x
4927 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
4929 12.7 Interaction with other packages
4930 ====================================
4932 Org-mode lives in the world of GNU Emacs and interacts in various ways
4933 with other code out there.
4937 * Cooperation:: Packages Org-mode cooperates with
4938 * Conflicts:: Packages that lead to conflicts
4941 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
4943 12.7.1 Packages that Org-mode cooperates with
4944 ---------------------------------------------
4946 `calc.el' by Dave Gillespie
4947 Org-mode uses the calc package for implementing spreadsheet
4948 functionality in its tables (*note Table calculations::).
4949 Org-modes checks for the availability of calc by looking for the
4950 function `calc-eval' which should be autoloaded in your setup if
4951 calc has been installed properly. As of Emacs 22, calc is part of
4952 the Emacs distribution. Another possibility for interaction
4953 between the two packages is using calc for embedded calculations.
4954 *Note Embedded Mode: (calc)Embedded Mode.
4956 `constants.el' by Carsten Dominik
4957 In a table formula (*note Table calculations::), it is possible to
4958 use names for natural constants or units. Instead of defining
4959 your own constants in the variable `org-table-formula-constants',
4960 install the `constants' package which defines a large number of
4961 constants and units, and lets you use unit prefixes like `M' for
4962 `Mega' etc. You will need version 2.0 of this package, available
4963 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
4964 the function `constants-get', which has to be autoloaded in your
4965 setup. See the installation instructions in the file
4968 `cdlatex.el' by Carsten Dominik
4969 Org-mode can make use of the cdlatex package to efficiently enter
4970 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
4972 `remember.el' by John Wiegley
4973 Org mode cooperates with remember, see *Note Remember::.
4974 `Remember.el' is not part of Emacs, find it on the web.
4976 `table.el' by Takaaki Ota
4977 Org mode cooperates with table.el, see *Note table.el::.
4978 `table.el' is part of Emacs 22.
4981 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
4983 12.7.2 Packages that lead to conflicts with Org-mode
4984 ----------------------------------------------------
4986 `allout.el' by Ken Manheimer
4987 Startup of Org-mode may fail with the error message
4988 `(wrong-type-argument keymapp nil)' when there is an outdated
4989 version `allout.el' on the load path, for example the version
4990 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
4991 will disappear. If for some reason you cannot do this, make sure
4992 that org.el is loaded _before_ `allout.el', for example by putting
4993 `(require 'org)' early enough into your `.emacs' file.
4995 `CUA.el' by Kim. F. Storm
4996 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4997 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4998 select and extend the region. If you want to use one of these
4999 packages along with Org-mode, configure the variable
5000 `org-CUA-compatible'. When set, Org-mode will move the following
5001 keybindings in org-mode files, and in the agenda buffer (but not
5002 during date selection).
5004 S-UP -> M-p S-DOWN -> M-n
5005 S-LEFT -> M-- S-RIGHT -> M-+
5008 Yes, these are unfortunately more difficult to remember. If you
5009 want to have other replacement keys, look at the variable
5010 `org-disputed-keys'.
5012 `windmove.el' by Hovav Shacham
5013 Also this package uses the `S-<cursor>' keys, so everything written
5014 in the paragraph above about CUA mode also applies here.
5017 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5022 Here is a list of things that should work differently, but which I have
5023 found too hard to fix.
5025 * If a table field starts with a link, and if the corresponding table
5026 column is narrowed (*note Narrow columns::) to a width too small to
5027 display the link, the field would look entirely empty even though
5028 it is not. To prevent this, Org-mode throws an error. The
5029 work-around is to make the column wide enough to fit the link, or
5030 to add some text (at least 2 characters) before the link in the
5033 * Narrowing table columns does not work on XEmacs, because the
5034 `format' function does not transport text properties.
5036 * Text in an entry protected with the `QUOTE' keyword should not
5039 * When the application called by `C-c C-o' to open a file link fails
5040 (for example because the application does not exist or refuses to
5041 open the file), it does so silently. No error message is
5044 * Recalculating a table line applies the formulas from left to right.
5045 If a formula uses _calculated_ fields further down the row,
5046 multiple recalculation may be needed to get all fields consistent.
5048 * A single letter cannot be made bold, for example `*a*'.
5050 * The exporters work well, but could be made more efficient.
5053 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5055 Appendix A Extensions, Hooks and Hacking
5056 ****************************************
5058 This appendix lists extensions for Org-mode written by other authors.
5059 It also covers some aspects where users can extend the functionality of
5064 * Extensions:: Existing 3rd-part extensions
5065 * Dynamic blocks:: Automatically filled blocks
5066 * Special agenda views::
5069 File: org, Node: Extensions, Next: Dynamic blocks, Prev: Extensions and Hacking, Up: Extensions and Hacking
5071 A.1 Third-party extensions for Org-mode
5072 =======================================
5074 The following extensions for Org-mode have been written by other people:
5076 `org-publish.el' by David O'Toole
5077 This package provides facilities for publishing related sets of
5078 Org-mode files together with linked files like images as a
5079 webpages. It is highly configurable and can be used for other
5080 publishing purposes as well. As of Org-mode version 4.30,
5081 `org-publish.el' is part of the Org-mode distribution. It is not
5082 yet part of Emacs, however, a delay caused by the preparations for
5083 the 22.1 release. In the mean time, `org-publish.el' can be
5084 downloaded from David's site:
5085 `http://dto.freeshell.org/e/org-publish.el'.
5087 `org-mouse.el' by Piotr Zielinski
5088 This package implements extended mouse functionality for Org-mode.
5089 It allows you to cycle visibility and to edit the document
5090 structure with the mouse. Best of all, it provides a
5091 context-sensitive menu on <mouse-3> that changes depending on the
5092 context of a mouse-click. As of Org-mode version 4.53,
5093 `org-mouse.el' is part of the Org-mode distribution. It is not
5094 yet part of Emacs, however, a delay caused by the preparations for
5095 the 22.1 release. In the mean time, `org-mouse.el' can be
5096 downloaded from Piotr's site:
5097 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
5099 `org-blog.el' by David O'Toole
5100 A blogging plug-in for `org-publish.el'.
5101 `http://dto.freeshell.org/notebook/OrgMode.html'.
5103 `blorg.el' by Bastien Guerry
5104 Publish Org-mode files as blogs.
5105 `http://www.cognition.ens.fr/~guerry/blorg.html'.
5108 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Extensions, Up: Extensions and Hacking
5113 Org-mode documents can contain _dynamic blocks_. These are specially
5114 marked regions that are updated by some user-written function. A good
5115 example for such a block is the clock table inserted by the command
5116 `C-c C-x C-r' (*note Clocking work time::).
5118 Dynamic block are enclosed by a BEGIN-END structure that assigns a
5119 name to the block and can also specify parameters for the function
5120 producing the content of the block.
5122 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5126 Dynamic blocks are updated with the following commands
5129 Update dynamic block at point.
5132 Update all dynamic blocks in the current file.
5134 Updating a dynamic block means to remove all the text between BEGIN
5135 and END, parse the BEGIN line for parameters and then call the specific
5136 writer function for this block to insert the new content. For a block
5137 with name `myblock', the writer function is `org-dblock-write:myblock'
5138 with as only parameter a property list with the parameters given in the
5139 begin line. Here is a trivial example of a block that keeps track of
5140 when the block update function was last run:
5142 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5146 The corresponding block writer function could look like this:
5148 (defun org-dblock-write:block-update-time (params)
5149 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5150 (insert "Last block update at: "
5151 (format-time-string fmt (current-time)))))
5153 If you want to make sure that all dynamic blocks are always
5154 up-to-date, you could add the function `org-update-all-dblocks' to a
5155 hook, for example `before-save-hook'. `org-update-all-dblocks' is
5156 written in a way that is does nothing in buffers that are not in
5160 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
5162 A.3 Special Agenda Views
5163 ========================
5165 Org-mode provides a special hook that can be used to narrow down the
5166 selection made by any of the agenda views. You may specify a function
5167 that is used at each match to verify if the match should indeed be part
5168 of the agenda view, and if not, how much should be skipped.
5170 Let's say you want to produce a list of projects that contain a
5171 WAITING tag anywhere in the project tree. Let's further assume that
5172 you have marked all tree headings that define a project with the todo
5173 keyword PROJECT. In this case you would run a todo search for the
5174 keyword PROJECT, but skip the match unless there is a WAITING tag
5175 anywhere in the subtree belonging to the project line..
5177 To achieve this, you must write a function that searches the subtree
5178 for the tag. If the tag is found, the function must return `nil' to
5179 indicate that this match should not be skipped. If there is no such
5180 tag, return the location of the end of the subtree, to indicate that
5181 search should continue from there.
5183 (defun my-skip-unless-waiting ()
5184 "Skip trees that are not waiting"
5185 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
5186 (if (re-search-forward ":WAITING:" subtree-end t)
5187 nil ; tag found, do not skip
5188 subtree-end))) ; tag not found, continue after end of subtree
5190 Furthermore you must write a command that uses `let' to temporarily
5191 puts this function into the variable `org-agenda-skip-function', sets
5192 the header string for the agenda buffer, and calls the todo-list
5193 generator while asking for the specific TODO keyword PROJECT. The
5194 function must also accept one argument MATCH, but it can choose to
5195 ignore it(1) (as we do in the example below). Here is the example:
5197 (defun my-org-waiting-projects (&optional match)
5198 "Produce a list of projects that contain a WAITING tag.
5199 MATCH is being ignored."
5201 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
5202 (org-agenda-overriding-header "Projects waiting for something: "))
5204 (org-todo-list "PROJECT")))
5206 ---------- Footnotes ----------
5208 (1) MATCH must be present in case you want to define a custom
5209 command for producing this special list. Custom commands always supply
5210 the MATCH argument, but it can be empty if you do not specify it while
5211 defining the command(*note Custom agenda views::).
5214 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
5216 Appendix B History and Acknowledgments
5217 **************************************
5219 Org-mode was borne in 2003, out of frustration over the user interface
5220 of the Emacs outline-mode. All I wanted was to make working with an
5221 outline tree possible without having to remember more than 10 commands
5222 just for hiding and unhiding parts of the outline tree, and to allow to
5223 restructure a tree easily. Visibility cycling and structure editing
5224 were originally implemented in the package `outline-magic.el', but
5225 quickly moved to the more general `org.el'. TODO entries, basic time
5226 stamps, and table support were added next, and highlight the two main
5227 goals that Org-mode still has today: To create a new, outline-based,
5228 plain text mode with innovative and intuitive editing features, and to
5229 incorporate project planning functionality directly into a notes file.
5231 Since the first release, hundreds of emails to me or on
5232 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
5233 feedback, new ideas, and sometimes even patches and add-on code. Many
5234 thanks to everyone who has helped to improve this package. I am trying
5235 to keep here a list of the people who had significant influence in
5236 shaping one or more aspects of Org-mode. The list may not be complete,
5237 if I have forgotten someone, please accept my apologies and let me know.
5239 * Thomas Baumann contributed the code for links to the MH-E email
5242 * Alex Bochannek provided a patch for rounding time stamps.
5244 * Charles Cave's suggestion sparked the implementation of templates
5247 * Pavel Chalmoviansky influenced the agenda treatment of items with
5250 * Gregory Chernov patched support for lisp forms into table
5251 calculations and improved XEmacs compatibility, in particular by
5252 porting `nouline.el' to XEmacs.
5254 * Sacha Chua suggested to copy some linking code from Planner.
5256 * Eddward DeVilla proposed and tested checkbox statistics.
5258 * Kees Dullemond inspired the use of narrowed tabled columns.
5260 * Christian Egli converted the documentation into TeXInfo format,
5261 patched CSS formatting into the HTML exporter, and inspired the
5264 * Nic Ferrier contributed mailcap and XOXO support.
5266 * Niels Giessen had the idea to automatically archive DONE trees.
5268 * Bastien Guerry provided extensive feedback.
5270 * Kai Grossjohann pointed out key-binding conflicts with other
5273 * Leon Liu asked for embedded LaTeX and tested it.
5275 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
5278 * Todd Neal provided patches for links to Info files and elisp forms.
5280 * Tim O'Callaghan suggested in-file links, search options for general
5281 file links, and TAGS.
5283 * Oliver Oppitz suggested multi-state TODO items.
5285 * Scott Otterson sparked the introduction of descriptive text for
5286 links, among other things.
5288 * Pete Phillips helped during the development of the TAGS feature,
5289 and provided frequent feedback.
5291 * T.V. Raman reported bugs and suggested improvements.
5293 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
5296 * Kevin Rogers contributed code to access VM files on remote hosts.
5298 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
5299 conflict with `allout.el'.
5301 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
5303 * Philip Rooke created the Org-mode reference card and provided lots
5306 * Christian Schlauer proposed angular brackets around links, among
5309 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
5310 `organizer-mode.el'.
5312 * Daniel Sinder came up with the idea of internal archiving by
5315 * Dale Smith proposed link abbreviations.
5317 * David O'Toole wrote `org-publish.el' and drafted the manual
5318 chapter about publishing.
5320 * Ju"rgen Vollmer contributed code generating the table of contents
5323 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
5325 * David Wainberg suggested archiving, and improvements to the linking
5328 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
5329 development of Org-mode was fully independent, and both systems are
5330 really different beasts in their basic ideas and implementation
5331 details. I later looked at John's code, however, and learned from
5332 his implementation of (i) links where the link itself is hidden
5333 and only a description is shown, and (ii) popping up a calendar to
5336 * Carsten Wimmer suggested some changes and helped fix a bug in
5339 * Roland Winkler requested additional keybindings to make Org-mode
5342 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
5343 contributed various ideas and code snippets.
5346 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
5354 * abbreviation, links: Link abbreviations. (line 6)
5355 * acknowledgments: History and Acknowledgments.
5357 * action, for publishing: Publishing action. (line 6)
5358 * activation: Activation. (line 6)
5359 * active region <1>: HTML export. (line 10)
5360 * active region <2>: ASCII export. (line 9)
5361 * active region <3>: Built-in table editor.
5363 * active region: Structure editing. (line 64)
5364 * agenda: Weekly/Daily agenda. (line 6)
5365 * agenda dispatcher: Agenda dispatcher. (line 6)
5366 * agenda files: Agenda files. (line 6)
5367 * agenda files, removing buffers: Agenda commands. (line 230)
5368 * agenda views: Agenda views. (line 6)
5369 * agenda views, custom: Custom agenda views. (line 6)
5370 * agenda, batch production: Batch processing. (line 6)
5371 * agenda, with block views: Block agenda. (line 6)
5372 * allout.el: Conflicts. (line 6)
5373 * angular brackets, around links: External links. (line 38)
5374 * applescript, for calendar update: iCalendar export. (line 38)
5375 * archive locations: Moving subtrees. (line 21)
5376 * archiving: Archiving. (line 6)
5377 * ASCII export: ASCII export. (line 6)
5378 * author: Feedback. (line 6)
5379 * autoload: Activation. (line 6)
5380 * backtrace of an error: Feedback. (line 27)
5381 * BBDB links: External links. (line 6)
5382 * block agenda: Block agenda. (line 6)
5383 * blorg.el: Extensions. (line 33)
5384 * bold text: Enhancing text. (line 15)
5385 * Boolean logic, for tag searches: Tag searches. (line 23)
5386 * bug reports: Feedback. (line 6)
5387 * bugs: Bugs. (line 6)
5388 * C-c C-c, overview: The very busy C-c C-c key.
5390 * calc package: Table calculations. (line 6)
5391 * calc.el: Cooperation. (line 6)
5392 * calculations, in tables <1>: Table calculations. (line 6)
5393 * calculations, in tables: Built-in table editor.
5395 * calendar commands, from agenda: Agenda commands. (line 191)
5396 * calendar integration: Weekly/Daily agenda. (line 24)
5397 * calendar, for selecting date: The date/time prompt.
5399 * CamelCase link completion: Completion. (line 6)
5400 * CamelCase links: Internal links. (line 6)
5401 * CamelCase links, completion of: CamelCase links. (line 6)
5402 * category: Categories. (line 6)
5403 * CDLaTeX: CDLaTeX mode. (line 6)
5404 * cdlatex.el: Cooperation. (line 29)
5405 * checkbox statistics: Checkboxes. (line 23)
5406 * checkboxes: Checkboxes. (line 6)
5407 * children, subtree visibility state: Visibility cycling. (line 10)
5408 * clean outline view: Clean view. (line 6)
5409 * CLOCK keyword: Time stamps. (line 71)
5410 * CLOSED keyword: Time stamps. (line 65)
5411 * column formula: Column formulas. (line 6)
5412 * commands, in agenda buffer: Agenda commands. (line 6)
5413 * comment lines: Comment lines. (line 6)
5414 * completion, of CamelCase links <1>: Completion. (line 6)
5415 * completion, of CamelCase links: CamelCase links. (line 6)
5416 * completion, of dictionary words: Completion. (line 6)
5417 * completion, of file names: Handling links. (line 43)
5418 * completion, of links: Handling links. (line 27)
5419 * completion, of option keywords <1>: Completion. (line 6)
5420 * completion, of option keywords: Export options. (line 6)
5421 * Completion, of option keywords: Per file keywords. (line 17)
5422 * completion, of tags <1>: Completion. (line 6)
5423 * completion, of tags: Setting tags. (line 11)
5424 * completion, of TeX symbols: Completion. (line 6)
5425 * completion, of TODO keywords <1>: Completion. (line 6)
5426 * completion, of TODO keywords: Workflow states. (line 12)
5427 * constants, in calculations: Formula syntax. (line 26)
5428 * constants.el: Cooperation. (line 14)
5429 * contents, global visibility state: Visibility cycling. (line 22)
5430 * copying, of subtrees: Structure editing. (line 6)
5431 * creating timestamps: Creating timestamps. (line 6)
5432 * CUA.el: Conflicts. (line 15)
5433 * custom agenda views: Custom agenda views. (line 6)
5434 * custom date/time format: Custom time format. (line 6)
5435 * custom search strings: Custom searches. (line 6)
5436 * customization: Customization. (line 6)
5437 * cutting, of subtrees: Structure editing. (line 6)
5438 * cycling, of TODO states: TODO basics. (line 13)
5439 * cycling, visibility: Visibility cycling. (line 6)
5440 * daily agenda: Weekly/Daily agenda. (line 6)
5441 * date format, custom: Custom time format. (line 6)
5442 * date stamps <1>: Time stamps. (line 6)
5443 * date stamps: Timestamps. (line 6)
5444 * date, reading in minibuffer: The date/time prompt.
5446 * DEADLINE keyword: Time stamps. (line 53)
5447 * deadlines: Time stamps. (line 6)
5448 * demotion, of subtrees: Structure editing. (line 6)
5449 * diary entries, creating from agenda: Agenda commands. (line 198)
5450 * diary integration: Weekly/Daily agenda. (line 24)
5451 * dictionary word completion: Completion. (line 6)
5452 * directories, for publishing: Sources and destinations.
5454 * dispatching agenda commands: Agenda dispatcher. (line 6)
5455 * display changing, in agenda: Agenda commands. (line 65)
5456 * document structure: Document structure. (line 6)
5457 * DONE, final TODO keyword: Per file keywords. (line 20)
5458 * editing tables: Tables. (line 6)
5459 * editing, of table formulas: Editing/debugging formulas.
5461 * elisp links: External links. (line 6)
5462 * emphasized text: Export options. (line 25)
5463 * enhancing text: Enhancing text. (line 6)
5464 * evaluate time range: Creating timestamps. (line 66)
5465 * exporting: Exporting. (line 6)
5466 * exporting, not: Comment lines. (line 6)
5467 * extended TODO keywords: TODO extensions. (line 6)
5468 * external archiving: Moving subtrees. (line 6)
5469 * external links: External links. (line 6)
5470 * external links, in HTML export: HTML export. (line 35)
5471 * FAQ: Summary. (line 51)
5472 * feedback: Feedback. (line 6)
5473 * file links: External links. (line 6)
5474 * file links, searching: Search options. (line 6)
5475 * file name completion: Handling links. (line 43)
5476 * files for agenda: Agenda files. (line 6)
5477 * files, adding to agenda list: Agenda files. (line 12)
5478 * files, selecting for publishing: Selecting files. (line 6)
5479 * fixed width: Enhancing text. (line 25)
5480 * fixed-width sections: Export options. (line 25)
5481 * folded, subtree visibility state: Visibility cycling. (line 10)
5482 * folding, sparse trees: Sparse trees. (line 6)
5483 * following links: Handling links. (line 58)
5484 * format specifier: Formula syntax. (line 34)
5485 * format, of links: Link format. (line 6)
5486 * formula editing: Editing/debugging formulas.
5488 * formula syntax: Formula syntax. (line 6)
5489 * formula, for named table field: Named-field formulas.
5491 * formula, for table column: Column formulas. (line 6)
5492 * formula, in tables: Built-in table editor.
5494 * global cycling: Visibility cycling. (line 22)
5495 * global keybindings: Activation. (line 6)
5496 * global TODO list: Global TODO list. (line 6)
5497 * global visibility states: Visibility cycling. (line 22)
5498 * GNUS links: External links. (line 6)
5499 * hand-formatted lists: Enhancing text. (line 11)
5500 * headline levels: Export options. (line 25)
5501 * headline levels, for exporting <1>: HTML export. (line 21)
5502 * headline levels, for exporting: ASCII export. (line 18)
5503 * headline navigation: Motion. (line 6)
5504 * headline tagging: Tags. (line 6)
5505 * headline, promotion and demotion: Structure editing. (line 6)
5506 * headlines: Headlines. (line 6)
5507 * hide text: Visibility cycling. (line 6)
5508 * hiding leading stars: Clean view. (line 6)
5509 * history: History and Acknowledgments.
5511 * HTML export: HTML export. (line 6)
5512 * hyperlinks: Hyperlinks. (line 6)
5513 * iCalendar export: iCalendar export. (line 6)
5514 * in-buffer settings: In-buffer settings. (line 6)
5515 * inactive timestamp: Time stamps. (line 24)
5516 * index, of published pages: Project page index. (line 6)
5517 * Info links: External links. (line 6)
5518 * inheritance, of tags: Tag inheritance. (line 6)
5519 * inserting links: Handling links. (line 27)
5520 * installation: Installation. (line 6)
5521 * internal archiving: ARCHIVE tag. (line 6)
5522 * internal links: Internal links. (line 6)
5523 * internal links, in HTML export: HTML export. (line 35)
5524 * introduction: Introduction. (line 6)
5525 * italic text: Enhancing text. (line 15)
5526 * jumping, to headlines: Motion. (line 6)
5527 * keybindings, global: Activation. (line 6)
5528 * keyword options: Per file keywords. (line 6)
5529 * LaTeX fragments <1>: Export options. (line 25)
5530 * LaTeX fragments: LaTeX fragments. (line 6)
5531 * LaTeX fragments, export: Enhancing text. (line 18)
5532 * LaTeX fragments, preview: Processing LaTeX fragments.
5534 * LaTeX interpretation: Embedded LaTeX. (line 6)
5535 * level, require for tags match: Tag searches. (line 68)
5536 * linebreak preservation: Export options. (line 25)
5537 * linebreak, forced: Enhancing text. (line 32)
5538 * link abbreviations: Link abbreviations. (line 6)
5539 * link completion: Handling links. (line 27)
5540 * link format: Link format. (line 6)
5541 * links, external: External links. (line 6)
5542 * links, handling: Handling links. (line 6)
5543 * links, in HTML export: HTML export. (line 35)
5544 * links, internal: Internal links. (line 6)
5545 * links, publishing: Publishing links. (line 6)
5546 * links, radio targets: Radio targets. (line 6)
5547 * links, returning to: Handling links. (line 85)
5548 * Lisp forms, as table formulas: Lisp formulas. (line 6)
5549 * lists, hand-formatted: Enhancing text. (line 11)
5550 * lists, ordered: Plain lists. (line 6)
5551 * lists, plain: Plain lists. (line 6)
5552 * logging, of progress: Progress logging. (line 6)
5553 * maintainer: Feedback. (line 6)
5554 * mark ring: Handling links. (line 81)
5555 * marking characters, tables: Advanced features. (line 34)
5556 * matching, of tags: Matching headline tags.
5558 * matching, tags: Tags. (line 6)
5559 * math symbols: Math symbols. (line 6)
5560 * MH-E links: External links. (line 6)
5561 * minor mode for tables: orgtbl-mode. (line 6)
5562 * mode, for calc: Formula syntax. (line 34)
5563 * motion commands in agenda: Agenda commands. (line 19)
5564 * motion, between headlines: Motion. (line 6)
5565 * name, of column or field: Formula syntax. (line 26)
5566 * named field formula: Named-field formulas.
5568 * names as TODO keywords: TODO types. (line 6)
5569 * narrow columns in tables: Narrow columns. (line 6)
5570 * occur, command: Sparse trees. (line 6)
5571 * option keyword completion: Completion. (line 6)
5572 * options, for custom agenda views: Setting Options. (line 6)
5573 * options, for customization: Customization. (line 6)
5574 * options, for export: Export options. (line 6)
5575 * options, for publishing: Publishing options. (line 6)
5576 * ordered lists: Plain lists. (line 6)
5577 * org-agenda, command: Weekly/Daily agenda. (line 9)
5578 * org-blog.el: Extensions. (line 29)
5579 * org-mode, turning on: Activation. (line 22)
5580 * org-mouse.el: Extensions. (line 17)
5581 * org-publish-project-alist: Project alist. (line 6)
5582 * org-publish.el: Extensions. (line 8)
5583 * orgtbl-mode: orgtbl-mode. (line 6)
5584 * outline tree: Headlines. (line 6)
5585 * outline-mode: Outlines. (line 6)
5586 * outlines: Outlines. (line 6)
5587 * overview, global visibility state: Visibility cycling. (line 22)
5588 * packages, interaction with other: Interaction. (line 6)
5589 * pasting, of subtrees: Structure editing. (line 6)
5590 * per file keywords: Per file keywords. (line 6)
5591 * plain lists: Plain lists. (line 6)
5592 * plain text external links: External links. (line 38)
5593 * presentation, of agenda items: Presentation and sorting.
5595 * printing sparse trees: Sparse trees. (line 41)
5596 * priorities: Priorities. (line 6)
5597 * priorities, of agenda items: Sorting of agenda items.
5599 * progress logging: Progress logging. (line 6)
5600 * projects, for publishing: Project alist. (line 6)
5601 * promotion, of subtrees: Structure editing. (line 6)
5602 * publishing: Publishing. (line 6)
5603 * quoted HTML tags: Export options. (line 25)
5604 * radio targets: Radio targets. (line 6)
5605 * ranges, time: Time stamps. (line 6)
5606 * recomputing table fields: Column formulas. (line 27)
5607 * region, active <1>: HTML export. (line 10)
5608 * region, active <2>: ASCII export. (line 9)
5609 * region, active <3>: Built-in table editor.
5611 * region, active: Structure editing. (line 64)
5612 * regular expressions, with tags search: Tag searches. (line 63)
5613 * remember.el <1>: Cooperation. (line 33)
5614 * remember.el: Remember. (line 6)
5615 * remote editing, from agenda: Agenda commands. (line 106)
5616 * remote editing, undo: Agenda commands. (line 109)
5617 * richer text: Enhancing text. (line 6)
5618 * RMAIL links: External links. (line 6)
5619 * SCHEDULED keyword: Time stamps. (line 40)
5620 * scheduling: Time stamps. (line 6)
5621 * search option in file links: Search options. (line 6)
5622 * search strings, custom: Custom searches. (line 6)
5623 * searching for tags: Tag searches. (line 6)
5624 * section-numbers: Export options. (line 25)
5625 * setting tags: Setting tags. (line 6)
5626 * SHELL links: External links. (line 6)
5627 * show all, command: Visibility cycling. (line 31)
5628 * show all, global visibility state: Visibility cycling. (line 22)
5629 * show hidden text: Visibility cycling. (line 6)
5630 * sorting, of agenda items: Sorting of agenda items.
5632 * sparse tree, for deadlines: Creating timestamps. (line 41)
5633 * sparse tree, for TODO: TODO basics. (line 26)
5634 * sparse tree, tag based: Tags. (line 6)
5635 * sparse trees: Sparse trees. (line 6)
5636 * special keywords: In-buffer settings. (line 6)
5637 * spreadsheet capabilities: Table calculations. (line 6)
5638 * statistics, for checkboxes: Checkboxes. (line 23)
5639 * storing links: Handling links. (line 9)
5640 * structure editing: Structure editing. (line 6)
5641 * structure of document: Document structure. (line 6)
5642 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
5643 * sublevels, inclusion into todo list: Global TODO list. (line 33)
5644 * subscript: Subscripts and Superscripts.
5646 * subtree cycling: Visibility cycling. (line 10)
5647 * subtree visibility states: Visibility cycling. (line 10)
5648 * subtree, cut and paste: Structure editing. (line 6)
5649 * subtree, subtree visibility state: Visibility cycling. (line 10)
5650 * subtrees, cut and paste: Structure editing. (line 6)
5651 * summary: Summary. (line 6)
5652 * superscript: Subscripts and Superscripts.
5654 * syntax, of formulas: Formula syntax. (line 6)
5655 * table editor, builtin: Built-in table editor.
5657 * table editor, table.el: table.el. (line 6)
5658 * table of contents: Export options. (line 25)
5659 * table.el <1>: Cooperation. (line 34)
5660 * table.el: table.el. (line 6)
5661 * tables <1>: Export options. (line 25)
5662 * tables: Tables. (line 6)
5663 * tables, export: Enhancing text. (line 21)
5664 * tag completion: Completion. (line 6)
5665 * tag searches: Tag searches. (line 6)
5666 * tags: Tags. (line 6)
5667 * tags view: Matching headline tags.
5669 * tags, setting: Setting tags. (line 6)
5670 * targets, for links: Internal links. (line 6)
5671 * targets, radio: Radio targets. (line 6)
5672 * tasks, breaking down: Breaking down tasks. (line 6)
5673 * templates, for remember: Remember. (line 23)
5674 * TeX interpretation: Embedded LaTeX. (line 6)
5675 * TeX macros <1>: Export options. (line 25)
5676 * TeX macros: Math symbols. (line 6)
5677 * TeX macros, export: Enhancing text. (line 18)
5678 * TeX symbol completion: Completion. (line 6)
5679 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
5680 * thanks: History and Acknowledgments.
5682 * time format, custom: Custom time format. (line 6)
5683 * time grid: Time-of-day specifications.
5685 * time stamps <1>: Time stamps. (line 6)
5686 * time stamps: Timestamps. (line 6)
5687 * time, reading in minibuffer: The date/time prompt.
5689 * time-of-day specification: Time-of-day specifications.
5691 * time-sorted view: Timeline. (line 6)
5692 * timeline, single file: Timeline. (line 6)
5693 * timerange: Time stamps. (line 31)
5694 * timestamp: Time stamps. (line 14)
5695 * timestamp, inactive: Time stamps. (line 24)
5696 * timestamps, creating: Creating timestamps. (line 6)
5697 * TODO items: TODO items. (line 6)
5698 * TODO keyword matching: Global TODO list. (line 17)
5699 * TODO keyword matching, with tags search: Tag searches. (line 40)
5700 * TODO keywords completion: Completion. (line 6)
5701 * TODO list, global: Global TODO list. (line 6)
5702 * TODO types: TODO types. (line 6)
5703 * TODO workflow: Workflow states. (line 6)
5704 * transient-mark-mode <1>: HTML export. (line 10)
5705 * transient-mark-mode <2>: ASCII export. (line 9)
5706 * transient-mark-mode <3>: Built-in table editor.
5708 * transient-mark-mode: Structure editing. (line 64)
5709 * trees, sparse: Sparse trees. (line 6)
5710 * trees, visibility: Visibility cycling. (line 6)
5711 * tty keybindings: TTY keys. (line 6)
5712 * types as TODO keywords: TODO types. (line 6)
5713 * underlined text: Enhancing text. (line 15)
5714 * undoing remote-editing events: Agenda commands. (line 109)
5715 * URL links: External links. (line 6)
5716 * USENET links: External links. (line 6)
5717 * variables, for customization: Customization. (line 6)
5718 * vectors, in table calculations: Formula syntax. (line 23)
5719 * visibility cycling: Visibility cycling. (line 6)
5720 * visible text, printing: Sparse trees. (line 41)
5721 * VM links: External links. (line 6)
5722 * WANDERLUST links: External links. (line 6)
5723 * weekly agenda: Weekly/Daily agenda. (line 6)
5724 * windmove.el: Conflicts. (line 33)
5725 * workflow states as TODO keywords: Workflow states. (line 6)
5726 * XEmacs: Installation. (line 6)
5727 * XOXO export: XOXO export. (line 6)
5730 File: org, Node: Key Index, Prev: Index, Up: Top
5738 * $: Agenda commands. (line 123)
5739 * ': CDLaTeX mode. (line 43)
5740 * +: Agenda commands. (line 145)
5741 * ,: Agenda commands. (line 137)
5742 * -: Agenda commands. (line 151)
5743 * .: Agenda commands. (line 100)
5744 * :: Agenda commands. (line 131)
5745 * <: The date/time prompt.
5747 * <left>: Agenda commands. (line 97)
5748 * <RET> <1>: Agenda commands. (line 41)
5749 * <RET> <2>: Setting tags. (line 76)
5750 * <RET> <3>: The date/time prompt.
5752 * <RET>: Built-in table editor.
5754 * <right>: Agenda commands. (line 92)
5755 * <SPC> <1>: Agenda commands. (line 28)
5756 * <SPC>: Setting tags. (line 73)
5757 * <TAB> <1>: CDLaTeX mode. (line 23)
5758 * <TAB> <2>: Agenda commands. (line 35)
5759 * <TAB> <3>: Setting tags. (line 68)
5760 * <TAB> <4>: Built-in table editor.
5762 * <TAB> <5>: Plain lists. (line 37)
5763 * <TAB>: Visibility cycling. (line 10)
5764 * > <1>: Agenda commands. (line 173)
5765 * >: The date/time prompt.
5767 * ^: CDLaTeX mode. (line 33)
5768 * _: CDLaTeX mode. (line 33)
5769 * `: CDLaTeX mode. (line 39)
5770 * a: Agenda commands. (line 134)
5771 * b: Agenda commands. (line 51)
5772 * C: Agenda commands. (line 213)
5773 * c: Agenda commands. (line 191)
5774 * C-#: Built-in table editor.
5776 * C-,: Agenda files. (line 18)
5777 * C-_: Agenda commands. (line 109)
5778 * C-a a L: Timeline. (line 10)
5779 * C-c !: Creating timestamps. (line 21)
5780 * C-c #: Checkboxes. (line 56)
5781 * C-c $: Moving subtrees. (line 10)
5782 * C-c %: Handling links. (line 81)
5783 * C-c &: Handling links. (line 85)
5784 * C-c ' <1>: Editing/debugging formulas.
5786 * C-c ': Built-in table editor.
5788 * C-c *: Built-in table editor.
5790 * C-c +: Built-in table editor.
5792 * C-c ,: Priorities. (line 18)
5793 * C-c -: Built-in table editor.
5795 * C-c .: Creating timestamps. (line 10)
5796 * C-c /: Sparse trees. (line 15)
5797 * C-c :: Enhancing text. (line 29)
5798 * C-c ;: Comment lines. (line 11)
5799 * C-c <: Creating timestamps. (line 25)
5800 * C-c <TAB>: Built-in table editor.
5802 * C-c =: Built-in table editor.
5804 * C-c >: Creating timestamps. (line 29)
5805 * C-c ? <1>: Editing/debugging formulas.
5807 * C-c ?: Built-in table editor.
5809 * C-c [: Agenda files. (line 12)
5810 * C-c \: Tag searches. (line 9)
5811 * C-c ]: Agenda files. (line 15)
5812 * C-c ^ <1>: Built-in table editor.
5814 * C-c ^: Structure editing. (line 52)
5815 * C-c `: Built-in table editor.
5817 * C-c a !: Stuck projects. (line 14)
5818 * C-c a #: Stuck projects. (line 13)
5819 * C-c a a: Weekly/Daily agenda. (line 9)
5820 * C-c a C: Storing searches. (line 9)
5821 * C-c a M: Matching headline tags.
5823 * C-c a m: Matching headline tags.
5825 * C-c a M: Tag searches. (line 16)
5826 * C-c a m: Tag searches. (line 12)
5827 * C-c a T: Global TODO list. (line 14)
5828 * C-c a t <1>: Global TODO list. (line 9)
5829 * C-c a t: TODO basics. (line 33)
5830 * C-c C-a: Visibility cycling. (line 31)
5831 * C-c C-b: Motion. (line 15)
5832 * C-c C-c <1>: The very busy C-c C-c key.
5834 * C-c C-c <2>: Processing LaTeX fragments.
5836 * C-c C-c <3>: Setting tags. (line 10)
5837 * C-c C-c <4>: Checkboxes. (line 37)
5838 * C-c C-c <5>: table.el. (line 6)
5839 * C-c C-c <6>: Editing/debugging formulas.
5841 * C-c C-c <7>: Built-in table editor.
5843 * C-c C-c: Plain lists. (line 74)
5844 * C-c C-d <1>: Agenda commands. (line 158)
5845 * C-c C-d: Creating timestamps. (line 37)
5846 * C-c C-e: Exporting. (line 19)
5847 * C-c C-e a: ASCII export. (line 9)
5848 * C-c C-e b: HTML export. (line 11)
5849 * C-c C-e c: iCalendar export. (line 20)
5850 * C-c C-e h: HTML export. (line 10)
5851 * C-c C-e I: iCalendar export. (line 15)
5852 * C-c C-e i: iCalendar export. (line 13)
5853 * C-c C-e t: Export options. (line 13)
5854 * C-c C-e v <1>: XOXO export. (line 11)
5855 * C-c C-e v: Sparse trees. (line 41)
5856 * C-c C-e v a: ASCII export. (line 13)
5857 * C-c C-e v b: HTML export. (line 14)
5858 * C-c C-e v h: HTML export. (line 14)
5859 * C-c C-e x: XOXO export. (line 10)
5860 * C-c C-f: Motion. (line 12)
5861 * C-c C-j: Motion. (line 21)
5862 * C-c C-l: Handling links. (line 27)
5863 * C-c C-n: Motion. (line 8)
5864 * C-c C-o <1>: Creating timestamps. (line 33)
5865 * C-c C-o: Handling links. (line 58)
5866 * C-c C-p: Motion. (line 9)
5867 * C-c C-q <1>: Editing/debugging formulas.
5869 * C-c C-q: Built-in table editor.
5871 * C-c C-r: Visibility cycling. (line 32)
5872 * C-c C-s <1>: Agenda commands. (line 155)
5873 * C-c C-s: Creating timestamps. (line 48)
5874 * C-c C-t <1>: Clocking work time. (line 26)
5875 * C-c C-t: TODO basics. (line 13)
5876 * C-c C-u: Motion. (line 18)
5877 * C-c C-v: TODO basics. (line 26)
5878 * C-c C-w: Creating timestamps. (line 41)
5879 * C-c C-x b: Visibility cycling. (line 38)
5880 * C-c C-x C-a: ARCHIVE tag. (line 28)
5881 * C-c C-x C-b: Checkboxes. (line 38)
5882 * C-c C-x C-c: Agenda commands. (line 220)
5883 * C-c C-x C-d: Clocking work time. (line 34)
5884 * C-c C-x C-i: Clocking work time. (line 12)
5885 * C-c C-x C-k: Structure editing. (line 39)
5886 * C-c C-x C-l: Processing LaTeX fragments.
5888 * C-c C-x C-o: Clocking work time. (line 14)
5889 * C-c C-x C-r: Clocking work time. (line 42)
5890 * C-c C-x C-t: Custom time format. (line 12)
5891 * C-c C-x C-u: Dynamic blocks. (line 21)
5892 * C-c C-x C-w <1>: Built-in table editor.
5894 * C-c C-x C-w: Structure editing. (line 39)
5895 * C-c C-x C-x: Clocking work time. (line 30)
5896 * C-c C-x C-y <1>: Built-in table editor.
5898 * C-c C-x C-y: Structure editing. (line 46)
5899 * C-c C-x M-w <1>: Built-in table editor.
5901 * C-c C-x M-w: Structure editing. (line 43)
5902 * C-c C-y <1>: Clocking work time. (line 21)
5903 * C-c C-y: Creating timestamps. (line 66)
5904 * C-c l: Handling links. (line 9)
5905 * C-c {: CDLaTeX mode. (line 21)
5906 * C-c |: Built-in table editor.
5908 * C-c ~: table.el. (line 18)
5909 * C-k: Agenda commands. (line 117)
5910 * C-TAB: ARCHIVE tag. (line 38)
5911 * C-u C-c $: Moving subtrees. (line 12)
5912 * C-u C-c .: Creating timestamps. (line 16)
5913 * C-u C-c =: Built-in table editor.
5915 * C-u C-c C-l: Handling links. (line 43)
5916 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
5917 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
5918 * C-u C-c C-x C-u: Clocking work time. (line 69)
5919 * D: Agenda commands. (line 74)
5920 * d: Agenda commands. (line 71)
5921 * f: Agenda commands. (line 44)
5922 * g: Agenda commands. (line 78)
5923 * H: Agenda commands. (line 217)
5924 * i: Agenda commands. (line 198)
5925 * I: Agenda commands. (line 178)
5926 * l: Agenda commands. (line 57)
5927 * L: Agenda commands. (line 32)
5928 * M: Agenda commands. (line 204)
5929 * M-<down>: Built-in table editor.
5931 * M-<left> <1>: Built-in table editor.
5933 * M-<left>: Structure editing. (line 21)
5934 * M-<RET> <1>: Plain lists. (line 42)
5935 * M-<RET>: Structure editing. (line 6)
5936 * M-<right> <1>: Built-in table editor.
5938 * M-<right>: Structure editing. (line 24)
5939 * M-<TAB> <1>: Completion. (line 10)
5940 * M-<TAB> <2>: Setting tags. (line 6)
5941 * M-<TAB>: Per file keywords. (line 17)
5942 * M-<up>: Built-in table editor.
5944 * M-S-<down> <1>: Built-in table editor.
5946 * M-S-<down> <2>: Plain lists. (line 59)
5947 * M-S-<down>: Structure editing. (line 36)
5948 * M-S-<left> <1>: The date/time prompt.
5950 * M-S-<left> <2>: Built-in table editor.
5952 * M-S-<left> <3>: Plain lists. (line 65)
5953 * M-S-<left>: Structure editing. (line 27)
5954 * M-S-<RET> <1>: Checkboxes. (line 53)
5955 * M-S-<RET> <2>: Plain lists. (line 52)
5956 * M-S-<RET>: Structure editing. (line 18)
5957 * M-S-<right> <1>: The date/time prompt.
5959 * M-S-<right> <2>: Built-in table editor.
5961 * M-S-<right> <3>: Plain lists. (line 65)
5962 * M-S-<right>: Structure editing. (line 30)
5963 * M-S-<up> <1>: Built-in table editor.
5965 * M-S-<up> <2>: Plain lists. (line 59)
5966 * M-S-<up>: Structure editing. (line 33)
5967 * mouse-1 <1>: Agenda commands. (line 35)
5968 * mouse-1 <2>: The date/time prompt.
5970 * mouse-1: Handling links. (line 72)
5971 * mouse-2 <1>: Agenda commands. (line 35)
5972 * mouse-2: Handling links. (line 72)
5973 * mouse-3 <1>: Agenda commands. (line 28)
5974 * mouse-3: Handling links. (line 77)
5975 * n: Agenda commands. (line 19)
5976 * O: Agenda commands. (line 180)
5977 * o: Agenda commands. (line 65)
5978 * P: Agenda commands. (line 142)
5979 * p: Agenda commands. (line 20)
5980 * q: Agenda commands. (line 227)
5981 * r <1>: Agenda commands. (line 82)
5982 * r: Global TODO list. (line 20)
5983 * S: Agenda commands. (line 208)
5984 * s: Agenda commands. (line 89)
5985 * S-<down> <1>: Agenda commands. (line 151)
5986 * S-<down> <2>: The date/time prompt.
5988 * S-<down> <3>: Creating timestamps. (line 58)
5989 * S-<down> <4>: Priorities. (line 25)
5990 * S-<down>: Plain lists. (line 55)
5991 * S-<left> <1>: Agenda commands. (line 169)
5992 * S-<left> <2>: The date/time prompt.
5994 * S-<left> <3>: Creating timestamps. (line 53)
5995 * S-<left>: TODO basics. (line 20)
5996 * S-<RET>: Built-in table editor.
5998 * S-<right> <1>: Agenda commands. (line 161)
5999 * S-<right> <2>: The date/time prompt.
6001 * S-<right> <3>: Creating timestamps. (line 53)
6002 * S-<right>: TODO basics. (line 20)
6003 * S-<TAB> <1>: Built-in table editor.
6005 * S-<TAB>: Visibility cycling. (line 22)
6006 * S-<up> <1>: Agenda commands. (line 145)
6007 * S-<up> <2>: The date/time prompt.
6009 * S-<up> <3>: Creating timestamps. (line 58)
6010 * S-<up> <4>: Priorities. (line 25)
6011 * S-<up>: Plain lists. (line 55)
6012 * T: Agenda commands. (line 126)
6013 * t: Agenda commands. (line 113)
6014 * w: Agenda commands. (line 68)
6015 * x: Agenda commands. (line 230)
6016 * X: Agenda commands. (line 183)
6022 Node: Introduction
\x7f10454
6023 Node: Summary
\x7f10869
6024 Node: Installation
\x7f13781
6025 Node: Activation
\x7f15159
6026 Node: Feedback
\x7f16408
6027 Node: Document structure
\x7f18484
6028 Node: Outlines
\x7f19258
6029 Node: Headlines
\x7f19918
6030 Node: Visibility cycling
\x7f20541
6031 Ref: Visibility cycling-Footnote-1
\x7f22567
6032 Ref: Visibility cycling-Footnote-2
\x7f22625
6033 Ref: Visibility cycling-Footnote-3
\x7f22675
6034 Node: Motion
\x7f22944
6035 Node: Structure editing
\x7f23728
6036 Node: Archiving
\x7f26554
6037 Node: ARCHIVE tag
\x7f27112
6038 Node: Moving subtrees
\x7f28905
6039 Node: Sparse trees
\x7f29946
6040 Ref: Sparse trees-Footnote-1
\x7f32077
6041 Ref: Sparse trees-Footnote-2
\x7f32169
6042 Node: Plain lists
\x7f32284
6043 Ref: Plain lists-Footnote-1
\x7f35809
6044 Ref: Plain lists-Footnote-2
\x7f36166
6045 Node: Tables
\x7f36350
6046 Node: Built-in table editor
\x7f36898
6047 Node: Narrow columns
\x7f44926
6048 Ref: Narrow columns-Footnote-1
\x7f46865
6049 Node: Table calculations
\x7f46911
6050 Node: Formula syntax
\x7f48231
6051 Ref: Formula syntax-Footnote-1
\x7f51136
6052 Node: Lisp formulas
\x7f51436
6053 Node: Column formulas
\x7f52225
6054 Node: Advanced features
\x7f53987
6055 Node: Named-field formulas
\x7f57241
6056 Node: Editing/debugging formulas
\x7f57881
6057 Node: Appetizer
\x7f59639
6058 Node: orgtbl-mode
\x7f60742
6059 Node: table.el
\x7f61233
6060 Node: Hyperlinks
\x7f62210
6061 Node: Link format
\x7f62983
6062 Node: Internal links
\x7f64276
6063 Ref: Internal links-Footnote-1
\x7f66265
6064 Node: Radio targets
\x7f66397
6065 Node: CamelCase links
\x7f67112
6066 Node: External links
\x7f67706
6067 Node: Handling links
\x7f69837
6068 Ref: Handling links-Footnote-1
\x7f74489
6069 Ref: Handling links-Footnote-2
\x7f74726
6070 Node: Link abbreviations
\x7f74800
6071 Node: Search options
\x7f76479
6072 Ref: Search options-Footnote-1
\x7f78259
6073 Node: Custom searches
\x7f78340
6074 Node: Remember
\x7f79388
6075 Node: TODO items
\x7f83082
6076 Node: TODO basics
\x7f84064
6077 Node: TODO extensions
\x7f85591
6078 Node: Workflow states
\x7f86386
6079 Node: TODO types
\x7f87254
6080 Ref: TODO types-Footnote-1
\x7f88912
6081 Node: Per file keywords
\x7f88994
6082 Ref: Per file keywords-Footnote-1
\x7f90448
6083 Node: Priorities
\x7f90649
6084 Node: Breaking down tasks
\x7f91893
6085 Ref: Breaking down tasks-Footnote-1
\x7f92412
6086 Node: Checkboxes
\x7f92508
6087 Node: Timestamps
\x7f95263
6088 Node: Time stamps
\x7f95724
6089 Ref: Time stamps-Footnote-1
\x7f99218
6090 Ref: Time stamps-Footnote-2
\x7f99334
6091 Node: Creating timestamps
\x7f99489
6092 Node: The date/time prompt
\x7f102115
6093 Ref: The date/time prompt-Footnote-1
\x7f103881
6094 Node: Custom time format
\x7f103987
6095 Node: Progress logging
\x7f105546
6096 Node: Closing items
\x7f106075
6097 Node: Clocking work time
\x7f106979
6098 Ref: Clocking work time-Footnote-1
\x7f110603
6099 Node: Tags
\x7f110729
6100 Node: Tag inheritance
\x7f111491
6101 Node: Setting tags
\x7f112428
6102 Ref: Setting tags-Footnote-1
\x7f116627
6103 Ref: Setting tags-Footnote-2
\x7f116739
6104 Node: Tag searches
\x7f116822
6105 Node: Agenda views
\x7f119534
6106 Node: Agenda files
\x7f121474
6107 Ref: Agenda files-Footnote-1
\x7f122434
6108 Ref: Agenda files-Footnote-2
\x7f122583
6109 Node: Agenda dispatcher
\x7f122776
6110 Node: Built-in agenda views
\x7f124467
6111 Node: Weekly/Daily agenda
\x7f125045
6112 Node: Global TODO list
\x7f127174
6113 Node: Matching headline tags
\x7f129347
6114 Node: Timeline
\x7f130418
6115 Node: Stuck projects
\x7f131084
6116 Node: Presentation and sorting
\x7f132783
6117 Node: Categories
\x7f133574
6118 Node: Time-of-day specifications
\x7f134238
6119 Node: Sorting of agenda items
\x7f136209
6120 Node: Agenda commands
\x7f137491
6121 Node: Custom agenda views
\x7f144144
6122 Node: Storing searches
\x7f144819
6123 Node: Block agenda
\x7f146731
6124 Node: Setting Options
\x7f147961
6125 Node: Batch processing
\x7f150673
6126 Node: Embedded LaTeX
\x7f151803
6127 Ref: Embedded LaTeX-Footnote-1
\x7f152895
6128 Node: Math symbols
\x7f153085
6129 Node: Subscripts and Superscripts
\x7f153850
6130 Node: LaTeX fragments
\x7f154694
6131 Ref: LaTeX fragments-Footnote-1
\x7f156802
6132 Node: Processing LaTeX fragments
\x7f157064
6133 Node: CDLaTeX mode
\x7f158010
6134 Ref: CDLaTeX mode-Footnote-1
\x7f160494
6135 Node: Exporting
\x7f160642
6136 Node: ASCII export
\x7f161956
6137 Node: HTML export
\x7f163246
6138 Node: XOXO export
\x7f166082
6139 Node: iCalendar export
\x7f166521
6140 Node: Text interpretation
\x7f168344
6141 Node: Comment lines
\x7f168823
6142 Node: Enhancing text
\x7f169294
6143 Node: Export options
\x7f170986
6144 Node: Publishing
\x7f172653
6145 Ref: Publishing-Footnote-1
\x7f173449
6146 Node: Configuration
\x7f173645
6147 Node: Project alist
\x7f174363
6148 Node: Sources and destinations
\x7f175429
6149 Node: Selecting files
\x7f176159
6150 Node: Publishing action
\x7f176907
6151 Node: Publishing options
\x7f178140
6152 Node: Publishing links
\x7f180292
6153 Node: Project page index
\x7f181805
6154 Node: Sample configuration
\x7f182583
6155 Node: Simple example
\x7f183075
6156 Node: Complex example
\x7f183748
6157 Node: Triggering publication
\x7f185824
6158 Node: Miscellaneous
\x7f186509
6159 Node: Completion
\x7f187143
6160 Node: Customization
\x7f188614
6161 Node: In-buffer settings
\x7f189197
6162 Node: The very busy C-c C-c key
\x7f192816
6163 Node: Clean view
\x7f194460
6164 Node: TTY keys
\x7f197037
6165 Node: Interaction
\x7f198646
6166 Node: Cooperation
\x7f199043
6167 Node: Conflicts
\x7f200910
6168 Node: Bugs
\x7f202502
6169 Node: Extensions and Hacking
\x7f203896
6170 Node: Extensions
\x7f204400
6171 Node: Dynamic blocks
\x7f206187
6172 Node: Special agenda views
\x7f208143
6173 Ref: Special agenda views-Footnote-1
\x7f210424
6174 Node: History and Acknowledgments
\x7f210684
6175 Node: Index
\x7f215691
6176 Node: Key Index
\x7f242933