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.57).
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.57).
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 * Weekly/Daily agenda:: The calendar page with current tasks
165 * Global TODO list:: All unfinished action items
166 * Matching headline tags:: Structured information with fine-tuned search
167 * Timeline:: Time-sorted view for single file
168 * Presentation and sorting:: How agenda items are prepared for display
169 * Agenda commands:: Remote editing of org trees
170 * Custom agenda views:: Defining special searches and views
172 The weekly/daily agenda
174 * Calendar/Diary integration:: Integrating Anniversaries and more
176 Presentation and sorting
178 * Categories:: Not all tasks are equal
179 * Time-of-day specifications:: How the agenda knows the time
180 * Sorting of agenda items:: The order of things
184 * Storing searches:: Type once, use often
185 * Block agenda:: All the stuff you need in a single buffer
186 * Setting Options:: Changing the rules
187 * Batch processing:: Agenda views from the command line
191 * Math symbols:: TeX macros for symbols and Greek letters
192 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
193 * LaTeX fragments:: Complex formulas made easy
194 * Processing LaTeX fragments:: Previewing LaTeX processing
195 * CDLaTeX mode:: Speed up entering of formulas
199 * ASCII export:: Exporting to plain ASCII
200 * HTML export:: Exporting to HTML
201 * XOXO export:: Exporting to XOXO
202 * iCalendar export:: Exporting in iCalendar format
203 * Text interpretation:: How the exporter looks at the file
205 Text interpretation by the exporter
207 * Comment lines:: Some lines will not be exported
208 * Enhancing text:: Subscripts, symbols and more
209 * Export options:: How to influence the export settings
213 * Configuration:: Defining projects
214 * Sample configuration:: Example projects
215 * Triggering publication:: Publication commands
219 * Project alist:: The central configuration variable
220 * Sources and destinations:: From here to there
221 * Selecting files:: What files are part of the project?
222 * Publishing action:: Setting the function doing the publishing
223 * Publishing options:: Tweaking HTML export
224 * Publishing links:: Which links keep working after publishing?
225 * Project page index:: Publishing a list of project files
229 * Simple example:: One-component publishing
230 * Complex example:: A multi-component publishing example
234 * Completion:: M-TAB knows what you need
235 * Customization:: Adapting Org-mode to your taste
236 * In-buffer settings:: Overview of the #+KEYWORDS
237 * The very busy C-c C-c key:: When in doubt, press C-c C-c
238 * Clean view:: Getting rid of leading stars in the outline
239 * TTY keys:: Using Org-mode on a tty
240 * Interaction:: Other Emacs packages
241 * Bugs:: Things which do not work perfectly
243 Interaction with other packages
245 * Cooperation:: Packages Org-mode cooperates with
246 * Conflicts:: Packages that lead to conflicts
248 Extensions, Hooks and Hacking
250 * Extensions:: Existing 3rd-part extensions
251 * Dynamic blocks:: Automatically filled blocks
254 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
261 * Summary:: Brief summary of what Org-mode does
262 * Installation:: How to install a downloaded version of Org-mode
263 * Activation:: How to activate Org-mode for certain buffers.
264 * Feedback:: Bug reports, ideas, patches etc.
267 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
272 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
273 project planning with a fast and effective plain-text system.
275 Org-mode develops organizational tasks around NOTES files that
276 contain lists or information about projects as plain text. Org-mode is
277 implemented on top of outline-mode, which makes it possible to keep the
278 content of large files well structured. Visibility cycling and
279 structure editing help to work with the tree. Tables are easily created
280 with a built-in table editor. Org-mode supports ToDo items, deadlines,
281 time stamps, and scheduling. It dynamically compiles entries into an
282 agenda that utilizes and smoothly integrates much of the Emacs calendar
283 and diary. Plain text URL-like links connect to websites, emails,
284 Usenet messages, BBDB entries, and any files related to the projects.
285 For printing and sharing of notes, an Org-mode file can be exported as a
286 structured ASCII file, as HTML, or (todo and agenda items only) as an
287 iCalendar file. It can also serve as a publishing tool for a set of
290 An important design aspect that distinguishes Org-mode from for
291 example Planner/Muse is that it encougages to store every piece of
292 information only once. In Planner, you have project pages, day pages
293 and possibly other files, duplicating some information such as tasks.
294 In Org-mode, you only have notes files. In your notes you mark entries
295 as tasks, label them with tags and timestamps. All necessary lists
296 like a schedule for the day, the agenda for a meeting, tasks lists
297 selected by tags etc are created dynamically when you need them.
299 Org-mode keeps simple things simple. When first fired up, it should
300 feel like a straightforward, easy to use outliner. Complexity is not
301 imposed, but a large amount of functionality is available when you need
302 it. Org-mode can be used on different levels and in different ways, for
305 * as an outline extension with visibility cycling and structure editing
306 * as an ASCII system and table editor for taking structured notes
307 * as an ASCII table editor with spreadsheet-like capabilities
308 * as a TODO list editor
309 * as a full agenda and planner with deadlines and work scheduling
310 * as an environment to implement David Allen's GTD system
311 * as a simple hypertext system, with HTML export
312 * as a publishing tool to create a set of interlinked webpages
314 Org-mode's automatic, context sensitive table editor can be
315 integrated into any major mode by activating the minor Orgtbl-mode.
317 There is a website for Org-mode which provides links to the newest
318 version of Org-mode, as well as additional information, frequently asked
319 questions (FAQ), links to tutorials etc. This page is located at
320 `http://www.astro.uva.nl/~dominik/Tools/org/'.
323 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
328 Important: If Org-mode is part of the Emacs distribution or an XEmacs
329 package, please skip this section and go directly to *Note Activation::.
331 If you have downloaded Org-mode from the Web, you must take the
332 following steps to install it: Go into the Org-mode distribution
333 directory and edit the top section of the file `Makefile'. You must
334 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
335 and the paths to the directories where local Lisp and Info files are
336 kept. If you don't have access to the system-wide directories, create
337 your own two directories for these files, enter them into the Makefile,
338 and make sure Emacs finds the Lisp files by adding the following line
341 (setq load-path (cons "~/path/to/lispdir" load-path))
343 XEmacs users now need to install the file `noutline.el' from the
344 `xemacs' subdirectory of the Org-mode distribution. Use the command:
346 make install-noutline
348 Now byte-compile and install the Lisp files with the shell commands:
353 If you want to install the info documentation, use this command:
357 Then add to `.emacs':
359 ;; This line only if org-mode is not part of the X/Emacs distribution.
360 (require 'org-install)
363 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
368 Add the following lines to your `.emacs' file. The last two lines
369 define _global_ keys for the commands `org-store-link' and `org-agenda'
370 - please choose suitable keys yourself.
372 ;; The following lines are always needed. Choose your own keys.
373 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
374 (define-key global-map "\C-cl" 'org-store-link)
375 (define-key global-map "\C-ca" 'org-agenda)
377 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
378 because significant functionality depends on font-locking being active.
379 You can do this with either one of the following two lines (XEmacs
380 user must use the second option):
381 (global-font-lock-mode 1) ; for all buffers
382 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
384 With this setup, all files with extension `.org' will be put into
385 Org-mode. As an alternative, make the first line of a file look like
388 MY PROJECTS -*- mode: org; -*-
390 which will select Org-mode for this buffer no matter what the file's
391 name is. See also the variable `org-insert-mode-line-in-empty-file'.
394 File: org, Node: Feedback, Prev: Activation, Up: Introduction
399 If you find problems with Org-mode, or if you have questions, remarks,
400 or ideas about it, please contact the maintainer Carsten Dominik at
401 <dominik at science dot uva dot nl>.
403 For bug reports, please provide as much information as possible,
404 including the version information of Emacs (`C-h v emacs-version
405 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
406 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
407 can be very useful (see below on how to create one). Often a small
408 example file helps, along with clear information about:
410 1. What exactly did you do?
412 2. What did you expect to happen?
414 3. What happened instead?
415 Thank you for helping to improve this mode.
417 How to create a useful backtrace
418 ................................
420 If working with Org-mode produces an error with a message you don't
421 understand, you may have hit a bug. The best way to report this is by
422 providing, in addition to what was mentioned above, a _Backtrace_.
423 This is information from the built-in debugger about where and how the
424 error occurred. Here is how to produce a useful backtrace:
426 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
427 original Lisp code in `org.el' instead of the compiled version in
428 `org.elc'. The backtrace contains much more information if it is
429 produced with uncompiled code. To do this, either rename `org.elc'
430 to something else before starting Emacs, or ask Emacs explicitly
431 to load `org.el' by using the command line
432 emacs -l /path/to/org.el
434 2. Go to the `Options' menu and select `Enter Debugger on Error'
435 (XEmacs has this option in the `Troubleshooting' sub-menu).
437 3. Do whatever you have to do to hit the error. Don't forget to
438 document the steps you take.
440 4. When you hit the error, a `*Backtrace*' buffer will appear on the
441 screen. Save this buffer to a file (for example using `C-x C-w')
442 and attach it to your bug report.
445 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
450 Org-mode is based on outline mode and provides flexible commands to
451 edit the structure of the document.
455 * Outlines:: Org-mode is based on outline-mode
456 * Headlines:: How to typeset org-tree headlines
457 * Visibility cycling:: Show and hide, much simplified
458 * Motion:: Jumping to other headlines
459 * Structure editing:: Changing sequence and level of headlines
460 * Archiving:: Move done task trees to a different place
461 * Sparse trees:: Matches embedded in context
462 * Plain lists:: Additional structure within an entry
465 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
470 Org-mode is implemented on top of outline-mode. Outlines allow to
471 organize a document in a hierarchical structure, which (at least for
472 me) is the best representation of notes and thoughts. Overview over
473 this structure is achieved by folding (hiding) large parts of the
474 document to show only the general document structure and the parts
475 currently being worked on. Org-mode greatly simplifies the use of
476 outlines by compressing the entire show/hide functionality into a
477 single command `org-cycle', which is bound to the <TAB> key.
480 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
485 Headlines define the structure of an outline tree. The headlines in
486 Org-mode start with one or more stars, on the left margin. For example:
494 * Another top level headline
496 Some people find the many stars too noisy and would prefer an outline
497 that has whitespace followed by a single star as headline starters.
498 *Note Clean view:: describes a setup to realize this.
501 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
503 2.3 Visibility cycling
504 ======================
506 Outlines make it possible to hide parts of the text in the buffer.
507 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
508 the visibility in the buffer.
511 _Subtree cycling_: Rotate current subtree between the states
513 ,-> FOLDED -> CHILDREN -> SUBTREE --.
514 '-----------------------------------'
516 The cursor must be on a headline for this to work(1). When the
517 cursor is at the beginning of the buffer and the first line is not
518 a headline, then <TAB> actually runs global cycling (see
519 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
520 global cycling is invoked.
524 _Global cycling_: Rotate the entire buffer between the states
526 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
527 '--------------------------------------'
529 Note that inside tables, `S-<TAB>' jumps to the previous field.
535 Reveal context around point, showing the current entry, the
536 following heading and the hierarchy above. Useful for working
537 near a location exposed by a sparse tree command (*note Sparse
538 trees::) or an agenda command (*note Agenda commands::).
540 When Emacs first visits an Org-mode file, the global state is set to
541 OVERVIEW, i.e. only the top level headlines are visible. This can be
542 configured through the variable `org-startup-folded', or on a per-file
543 basis by adding one of the following lines anywhere in the buffer:
549 ---------- Footnotes ----------
551 (1) see, however, the option `org-cycle-emulate-tab'.
553 (2) see the option `org-cycle-global-at-bob'.
556 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
561 The following commands jump to other headlines in the buffer.
570 Next heading same level.
573 Previous heading same level.
576 Backward to higher level heading.
579 Jump to a different place without changing the current outline
580 visibility. Shows the document structure in a temporary buffer,
581 where you can use visibility cycling (<TAB>) to find your
582 destination. After pressing <RET>, the cursor moves to the
583 selected location in the original buffer, and the headings
584 hierarchy above it is made visible.
587 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
589 2.5 Structure editing
590 =====================
593 Insert new heading with same level as current. If the cursor is
594 in a plain list item, a new item is created (*note Plain lists::).
595 To force creation of a new headline, use a prefix arg, or first
596 press <RET> to get to the beginning of the next line. When this
597 command is used in the middle of a line, the line is split and the
598 rest of the line becomes the new headline. If the command is used
599 at the beginning of a headline, the new headline is created before
600 the current line. If at the beginning of any other line, the
601 content of that line is made the new heading. If the command is
602 used at the end of a folded subtree (i.e. behind the ellipses at
603 the end of a headline), then a headline like the current one will
604 be inserted after the end of the subtree.
607 Insert new TODO entry with same level as current heading.
610 Promote current heading by one level.
613 Demote current heading by one level.
616 Promote the current subtree by one level.
619 Demote the current subtree by one level.
622 Move subtree up (swap with previous subtree of same level).
625 Move subtree down (swap with next subtree of same level).
629 Kill subtree, i.e. remove it from buffer but save in kill ring.
632 Copy subtree to kill ring.
635 Yank subtree from kill ring. This does modify the level of the
636 subtree to make sure the tree fits in nicely at the yank position.
637 The yank level can also be specified with a prefix arg, or by
638 yanking after a headline marker like `****'.
641 Sort same-level entries. When there is an active region, all
642 entries in the region will be sorted. Otherwise the children of
643 the current headline are sorted. The command prompts for the
644 sorting method, which can be alphabetically, numerically, by time
645 (using the first time stamp in each entry), and each of these in
646 reverse order. With a `C-u' prefix, sorting will be
647 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
648 will also be removed.
650 When there is an active region (transient-mark-mode), promotion and
651 demotion work on all headlines in the region. To select a region of
652 headlines, it is best to place both point and mark at the beginning of a
653 line, mark at the beginning of the first headline, and point at the line
654 just after the last headline to change. Note that when the cursor is
655 inside a table (*note Tables::), the Meta-Cursor keys have different
659 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
664 When a project represented by a (sub)tree is finished, you may want to
665 move the tree out of the way and to stop it from contributing to the
666 agenda. Org-mode knows two ways of archiving. You can mark a tree with
667 the ARCHIVE tag, or you can move an entire (sub)tree to a different
672 * ARCHIVE tag:: Marking a tree as inactive
673 * Moving subtrees:: Moving a tree to an archive file
676 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
678 2.6.1 The ARCHIVE tag
679 ---------------------
681 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
682 its location in the outline tree, but behaves in the following way:
683 - It does not open when you attempt to do so with a visibility
684 cycling command (*note Visibility cycling::). You can force
685 cycling archived subtrees with `C-<TAB>', or by setting the option
686 `org-cycle-open-archived-trees'. Also normal outline commands like
687 `show-all' will open archived subtrees.
689 - During sparse tree construction (*note Sparse trees::), matches in
690 archived subtrees are not exposed, unless you configure the option
691 `org-sparse-tree-open-archived-trees'.
693 - During agenda view construction (*note Agenda views::), the
694 content of archived trees is ignored unless you configure the
695 option `org-agenda-skip-archived-trees'.
697 - Archived trees are not exported (*note Exporting::), only the
698 headline is. Configure the details using the variable
699 `org-export-with-archived-trees'.
701 The following commands help managing the ARCHIVE tag:
704 Toggle the ARCHIVE tag for the current headline. When the tag is
705 set, the headline changes to a shadowish face, and the subtree
709 Check if any direct children of the current headline should be
710 archived. To do this, each subtree is checked for open TODO
711 entries. If none are found, the command offers to set the ARCHIVE
712 tag for the child. If the cursor is _not_ on a headline when this
713 command is invoked, the level 1 trees will be checked.
716 Cycle a tree even if it is tagged with ARCHIVE.
719 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
721 2.6.2 Moving subtrees
722 ---------------------
724 Once an entire project is finished, you may want to move it to a
725 different location, either in the current file, or even in a different
726 file, the archive file.
729 Archive the subtree starting at the cursor position to the location
730 given by `org-archive-location'.
733 Check if any direct children of the current headline could be
734 moved to the archive. To do this, each subtree is checked for
735 open TODO entries. If none are found, the command offers to move
736 it to the archive location. If the cursor is _not_ on a headline
737 when this command is invoked, the level 1 trees will be checked.
739 The default archive location is a file in the same directory as the
740 current file, with the name derived by appending `_archive' to the
741 current file name. For information and examples on how to change this,
742 see the documentation string of the variable `org-archive-location'.
745 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
750 An important feature of Org-mode is the ability to construct _sparse
751 trees_ for selected information in an outline tree. A sparse tree
752 means that the entire document is folded as much as possible, but the
753 selected information is made visible along with the headline structure
754 above it(1). Just try it out and you will see immediately how it works.
756 Org-mode contains several commands creating such trees. The most
757 basic one is `org-occur':
760 Occur. Prompts for a regexp and shows a sparse tree with all
761 matches. If the match is in a headline, the headline is made
762 visible. If the match is in the body of an entry, headline and
763 body are made visible. In order to provide minimal context, also
764 the full hierarchy of headlines above the match is shown, as well
765 as the headline following the match. Each match is also
766 highlighted; the highlights disappear when the bufer is changes an
767 editing command, or by pressing `C-c C-c'. When called with a
768 `C-u' prefix argument, previous highlights are kept, so several
769 calls to this command can be stacked.
770 For frequently used sparse trees of specific search strings, you can
771 use the variable `org-agenda-custom-commands' to define fast keyboard
772 access to specific sparse trees. These commands will then be
773 accessible through the agenda dispatcher (*note Agenda dispatcher::).
776 (setq org-agenda-custom-commands
777 '(("f" occur-tree "FIXME")))
779 will define the key `C-c a f' as a shortcut for creating a sparse tree
780 matching the string `FIXME'.
782 Other commands use sparse trees as well. For example `C-c C-v'
783 creates a sparse TODO tree (*note TODO basics::).
785 To print a sparse tree, you can use the Emacs command
786 `ps-print-buffer-with-faces' which does not print invisible parts of
787 the document (2). Or you can use the command `C-c C-e v' to export
788 only the visible part of the document and print the resulting file.
790 ---------- Footnotes ----------
792 (1) See also the variables `org-show-hierarchy-above' and
793 `org-show-following-heading'.
795 (2) This does not work under XEmacs, because XEmacs uses selective
796 display for outlining, not text properties.
799 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
804 Within an entry of the outline tree, hand-formatted lists can provide
805 additional structure. They also provide a way to create lists of
806 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
807 and the HTML exporter (*note Exporting::) does parse and format them.
809 Org-mode knows ordered and unordered lists. Unordered list items
810 start with `-', `+', or `*'(1) as bullets. Ordered list items start
811 with `1.' or `1)'. Items belonging to the same list must have the same
812 indentation on the first line. In particular, if an ordered list
813 reaches number `10.', then the 2-digit numbers must be written
814 left-aligned with the other numbers in the list. Indentation also
815 determines the end of a list item. It ends before the next line that
816 is indented like the bullet/number, or less. For example:
819 My favorite scenes are (in this order)
820 1. The attack of the Rohirrim
821 2. Eowyns fight with the witch king
822 + this was already my favorite scene in the book
823 + I really like Miranda Otto.
824 3. Peter Jackson being shot by Legolas
826 He makes a really funny face when it happens.
827 But in the end, not individual scenes matter but the film as a whole.
829 Org-mode supports these lists by tuning filling and wrapping
830 commands to deal with them correctly(2).
832 The following commands act on items when the cursor is in the first
833 line of an item (the line with the bullet or number).
836 Items can be folded just like headline levels if you set the
837 variable `org-cycle-include-plain-lists'. The level of an item is
838 then given by the indentation of the bullet/number. Items are
839 always subordinate to real headlines, however; the hierarchies
840 remain completely separated.
843 Insert new item at current level. With prefix arg, force a new
844 heading (*note Structure editing::). If this command is used in
845 the middle of a line, the line is _split_ and the rest of the line
846 becomes the new item. If this command is executed in the
847 _whitespace before a bullet or number_, the new item is created
848 _before_ the current item. If the command is executed in the
849 white space before the text that is part of an item but does not
850 contain the bullet, a bullet is added to the current line.
853 Insert a new item with a checkbox (*note Checkboxes::).
857 Jump to the previous/next item in the current list.
861 Move the item including subitems up/down (swap with previous/next
862 item of same indentation). If the list is ordered, renumbering is
867 Decrease/increase the indentation of the item, including subitems.
868 Initially, the item tree is selected based on current indentation.
869 When these commands are executed several times in direct
870 succession, the initially selected region is used, even if the new
871 indentation would imply a different hierarchy. To use the new
872 hierarchy, break the command chain with a cursor motion or so.
875 If there is a checkbox (*note Checkboxes::) in the item line,
876 toggle the state of the checkbox. Otherwise, if this is an
877 ordered list, renumber the ordered list at the cursor.
879 ---------- Footnotes ----------
881 (1) When using `*' as a bullet, lines must be indented or they will
882 be seen as top-level headlines. Also, when you are hiding leading
883 stars to get a clean outline view, plain list items starting with a
884 star are visually indistinguishable from true headlines. In short:
885 even though `*' is supported, it may be better not to use it for plain
888 (2) Org-mode only changes the filling settings for Emacs. For
889 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
894 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
899 Org-mode has a very fast and intuitive table editor built-in.
900 Spreadsheet-like calculations are supported in connection with the
901 Emacs `calc' package.
905 * Built-in table editor:: Simple tables
906 * Narrow columns:: Stop wasting space in tables
907 * Table calculations:: Compute a field from other fields
908 * orgtbl-mode:: The table editor as minor mode
909 * table.el:: Complex tables
912 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
914 3.1 The built-in table editor
915 =============================
917 Org-mode makes it easy to format tables in plain ASCII. Any line with
918 `|' as the first non-white character is considered part of a table.
919 `|' is also the column separator. A table might look like this:
921 | Name | Phone | Age |
922 |-------+-------+-----|
923 | Peter | 1234 | 17 |
926 A table is re-aligned automatically each time you press <TAB> or
927 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
928 field (<RET> to the next row) and creates new table rows at the end of
929 the table or before horizontal lines. The indentation of the table is
930 set by the first line. Any line starting with `|-' is considered as a
931 horizontal separator line and will be expanded on the next re-align to
932 span the whole table width. So, to create the above table, you would
938 and then press <TAB> to align the table and start filling in fields.
940 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
941 and all character keys in a special way, so that inserting and deleting
942 avoids shifting other fields. Also, when typing _immediately after the
943 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
944 the field is automatically made blank. If this behavior is too
945 unpredictable for you, configure the variables
946 `org-enable-table-editor' and `org-table-auto-blank-field'.
948 Creation and conversion
949 .......................
952 Convert the active region to table. If every line contains at
953 least one TAB character, the function assumes that the material is
954 tab separated. If not, lines are split at whitespace into fields.
955 You can use a prefix argument to indicate the minimum number of
956 consecutive spaces required to identify a field separator
958 If there is no active region, this command creates an empty
959 Org-mode table. But it's easier just to start typing, like
960 `|Name|Phone|Age <RET> |- <TAB>'.
962 Re-aligning and field motion
963 ............................
966 Re-align the table without moving the cursor.
969 Re-align the table, move to the next field. Creates a new row if
973 Re-align, move to previous field.
976 Re-align the table and move down to next row. Creates a new row if
977 necessary. At the beginning or end of a line, <RET> still does
978 NEWLINE, so it can be used to split a table.
980 Column and row editing
981 ......................
985 Move the current column left/right.
988 Kill the current column.
991 Insert a new column to the left of the cursor position.
995 Move the current row up/down.
998 Kill the current row or horizontal line.
1001 Insert a new row above (with arg: below) the current row.
1004 Insert a horizontal line below current row. With prefix arg, the
1005 line is created above the current line.
1008 Sort the table lines in the region. The position of point
1009 indicates the column to be used for sorting, and the range of
1010 lines is the range between the nearest horizontal separator lines,
1011 or the entire table. If point is before the first column, you
1012 will be prompted for the sorting column. If there is an active
1013 region, the mark specifies the first line and the sorting column,
1014 while point should be in the last line to be included into the
1015 sorting. The command prompts for the sorting type
1016 (alphabetically, numerically, or by time). When called with a
1017 prefix argument, alphabetic sorting will be case-sensitive.
1023 Copy a rectangular region from a table to a special clipboard.
1024 Point and mark determine edge fields of the rectangle. The
1025 process ignores horizontal separator lines.
1028 Copy a rectangular region from a table to a special clipboard, and
1029 blank all fields in the rectangle. So this is the "cut" operation.
1032 Paste a rectangular region into a table. The upper right corner
1033 ends up in the current field. All involved fields will be
1034 overwritten. If the rectangle does not fit into the present table,
1035 the table is enlarged as needed. The process ignores horizontal
1039 Wrap several fields in a column like a paragraph. If there is an
1040 active region, and both point and mark are in the same column, the
1041 text in the column is wrapped to minimum width for the given
1042 number of lines. A prefix ARG may be used to change the number of
1043 desired lines. If there is no region, the current field is split
1044 at the cursor position and the text fragment to the right of the
1045 cursor is prepended to the field one line down. If there is no
1046 region, but you specify a prefix ARG, the current field is made
1047 blank, and the content is appended to the field above.
1053 Install a new formula for the current column and replace current
1054 field with the result of the formula.
1057 Install a new formula for the current field, which must be a named
1058 field. Evaluate the formula and replace the field content with the
1062 Edit all formulas associated with the current table in a separate
1066 Recalculate the current row by applying the stored formulas from
1067 left to right. When called with a `C-u' prefix, recalculate the
1068 entire table, starting with the first non-header line (i.e. below
1069 the first horizontal separator line). For details, see *Note
1070 Table calculations::.
1073 Rotate the calculation mark in first column through the states `',
1074 `#', `*', `!', `$'. For the meaning of these marks see *Note
1075 Advanced features::. When there is an active region, change all
1076 marks in the region.
1079 Which table column is the cursor in? Displays number >0 in echo
1083 Sum the numbers in the current column, or in the rectangle defined
1084 by the active region. The result is shown in the echo area and can
1085 be inserted with `C-y'.
1088 When current field is empty, copy from first non-empty field above.
1089 When not empty, copy current field down to next row and move cursor
1090 along with it. Depending on the variable
1091 `org-table-copy-increment', integer field values will be
1092 incremented during copy. This key is also used by CUA-mode (*note
1099 Edit the current field in a separate window. This is useful for
1100 fields that are not fully visible (*note Narrow columns::). When
1101 called with a `C-u' prefix, just make the full field visible, so
1102 that it can be edited in place.
1105 This is an alias for `C-u C-c `' to make the current field fully
1108 `M-x org-table-import'
1109 Import a file as a table. The table should be TAB- or whitespace
1110 separated. Useful, for example, to import an Excel table or data
1111 from a database, because these programs generally can write
1112 TAB-separated text files. This command works by inserting the
1113 file into the buffer and then converting the region to a table.
1114 Any prefix argument is passed on to the converter, which uses it
1115 to determine the separator.
1117 `M-x org-table-export'
1118 Export the table as a TAB-separated file. Useful for data
1119 exchange with, for example, Excel or database programs.
1122 If you don't like the automatic table editor because it gets in your
1123 way on lines which you would like to start with `|', you can turn it
1126 (setq org-enable-table-editor nil)
1128 Then the only table command that still works is `C-c C-c' to do a
1132 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
1137 The width of columns is automatically determined by the table editor.
1138 Sometimes a single field or a few fields need to carry more text,
1139 leading to inconveniently wide columns. To limit(1) the width of a
1140 column, one field anywhere in the column may contain just the string
1141 `<N>' where `N' is an integer specifying the width of the column in
1142 characters. The next re-align will then set the width of this column
1143 to no more than this value.
1145 |---+------------------------------| |---+--------|
1147 | 1 | one | | 1 | one |
1148 | 2 | two | ----\ | 2 | two |
1149 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1150 | 4 | four | | 4 | four |
1151 |---+------------------------------| |---+--------|
1153 Fields that are wider become clipped and end in the string `=>'. Note
1154 that the full text is still in the buffer, it is only invisible. To
1155 see the full text, hold the mouse over the field - a tooltip window
1156 will show the full content. To edit such a field, use the command `C-c
1157 `' (that is `C-c' followed by the backquote). This will open a new
1158 window with the full field. Edit it and finish with `C-c C-c'.
1160 When visiting a file containing a table with narrowed columns, the
1161 necessary character hiding has not yet happened, and the table needs to
1162 be aligned before it looks nice. Setting the option
1163 `org-startup-align-all-tables' will realign all tables in a file upon
1164 visiting, but also slow down startup. You can also set this option on
1165 a per-file basis with:
1170 ---------- Footnotes ----------
1172 (1) This feature does not work on XEmacs.
1175 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1177 3.3 Calculations in tables
1178 ==========================
1180 The table editor makes use of the Emacs `calc' package to implement
1181 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1182 derive fields from other fields. Org-mode has two levels of complexity
1183 for table calculations. On the basic level, tables do only horizontal
1184 computations, so a field can be computed from other fields _in the same
1185 row_, and Org-mode assumes that there is only one formula for each
1186 column. This is very efficient to work with and enough for many tasks.
1187 On the complex level, columns and individual fields can be named for
1188 easier referencing in formulas, individual named fields can have their
1189 own formula associated with them, and recalculation can be automated.
1193 * Formula syntax:: How to write a formula
1194 * Lisp formulas:: An alternative way to write formulas
1195 * Column formulas:: Formulas valid for all fields in a column
1196 * Advanced features:: Field names, parameters and automatic recalc
1197 * Named-field formulas:: Formulas valid in single fields
1198 * Editing/debugging formulas:: Changing a stored formula
1199 * Appetizer:: Taste the power of calc
1202 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1204 3.3.1 Formula syntax
1205 --------------------
1207 A formula can be any algebraic expression understood by the Emacs
1208 `calc' package. Note that `calc' has the slightly non-standard
1209 convention that `/' has lower precedence than `*', so that `a/b*c' is
1210 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1211 calc-eval: (calc)Calling Calc from Your Programs.), variable
1212 substitution takes place:
1214 $ refers to the current field
1215 $3 refers to the field in column 3 of the current row
1216 $3..$7 a vector of the fields in columns 3-7 of current row
1217 $P1..$P3 vector of column range, using column names
1218 &2 second data field above the current, in same column
1219 &5-2 vector from fifth to second field above current
1220 &III-II vector of fields between 2nd and 3rd hline above
1221 &III vector of fields between third hline above and current field
1222 $name a named field, parameter or constant
1224 The range vectors can be directly fed into the calc vector functions
1225 like `vmean' and `vsum'.
1227 `$name' is interpreted as the name of a column, parameter or
1228 constant. Constants are defined globally through the variable
1229 `org-table-formula-constants'. If you have the `constants.el' package,
1230 it will also be used to resolve constants, including natural constants
1231 like `$h' for Planck's constant, and units like `$km' for kilometers.
1232 Column names and parameters can be specified in special table lines.
1233 These are described below, see *Note Advanced features::.
1235 A formula can contain an optional mode string after a semicolon.
1236 This string consists of flags to influence calc's modes(1) during
1237 execution, e.g. `p20' to switch the internal precision to 20 digits,
1238 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1239 or fixed display format, respectively, and `D', `R', `F', and `S' to
1240 turn on degrees, radians, fraction and symbolic modes, respectively.
1241 In addition, you may provide a `printf' format specifier to reformat
1242 the final result. A few examples:
1244 $1+$2 Sum of first and second field
1245 $1+$2;%.2f Same, format result to two decimals
1246 exp($2)+exp($1) Math functions can be used
1247 $;%.1f Reformat current cell to 1 decimal
1248 ($3-32)*5/9 Degrees F -> C conversion
1249 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1250 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1251 sin($1);Dp3%.1e Same, but use printf specifier for display
1252 vmean($2..$7) Compute column range mean, using vector function
1253 vsum(&III) Sum numbers from 3rd hline above, up to here
1254 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1256 ---------- Footnotes ----------
1258 (1) By default, Org-mode uses the standard calc modes (precision 12,
1259 angular units degrees, fraction and symbolic modes off). The display
1260 format, however, has been changed to `(float 5)' to keep tables compact.
1261 The default settings can be configured using the variable
1262 `org-calc-default-modes'.
1265 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1267 3.3.2 Emacs Lisp forms as formulas
1268 ----------------------------------
1270 It is also possible to write a formula in Emacs lisp; this can be useful
1271 for string manipulation and control structures. If a formula starts
1272 with a single quote followed by an opening parenthesis, then it is
1273 evaluated as a lisp form. The evaluation should return either a string
1274 or a number. Just as with `calc' formulas, you can provide a format
1275 specifier after a semicolon. A few examples:
1277 swap the first two characters of the content of column 1
1278 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1279 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1283 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1285 3.3.3 Column formulas
1286 ---------------------
1288 To apply a formula to a field, type it directly into the field,
1289 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1290 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1291 be stored as the formula for the current column, evaluated and the
1292 current field replaced with the result. If the field contains only
1293 `=', the previously stored formula for this column is used.
1295 For each column, Org-mode will remember the most recently used
1296 formula. The information is stored in a special line starting with
1297 `#+TBLFM' directly below the table. When adding/deleting/moving
1298 columns with the appropriate commands, the stored equations will be
1299 modified accordingly. When a column used in a calculation is removed,
1300 references to this column become invalid and will cause an error upon
1301 applying the equation.
1303 Instead of typing an equation into the field, you may also use the
1304 command `C-c ='. It prompts for a formula (with default taken from the
1305 `#+TBLFM:' line) and applies it to the current field. A numerical
1306 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1307 in the current column.
1309 To recompute all the fields in a line, use the command `C-c *'. It
1310 re-applies all stored equations to the current row, from left to right.
1311 With a `C-u' prefix, this will be done to every line in the table, so
1312 use this command it you want to make sure the entire table is
1313 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1314 Global updating does not touch the line(s) above the first horizontal
1315 separator line, assuming that this is the table header.
1318 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1320 3.3.4 Advanced features
1321 -----------------------
1323 If you want the recalculation of fields to happen automatically, or if
1324 you want to be able to assign a formula to an individual field (instead
1325 of an entire column) you need to reserve the first column of the table
1326 for special marking characters. Here is an example of a table that
1327 collects exam results of students and makes use of these features:
1329 |---+---------+--------+--------+--------+-------+------|
1330 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1331 |---+---------+--------+--------+--------+-------+------|
1332 | ! | | P1 | P2 | P3 | Tot | |
1333 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1334 | ^ | | m1 | m2 | m3 | mt | |
1335 |---+---------+--------+--------+--------+-------+------|
1336 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1337 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1338 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1339 |---+---------+--------+--------+--------+-------+------|
1340 | | Average | | | | 29.7 | |
1341 | ^ | | | | | at | |
1342 | $ | max=50 | | | | | |
1343 |---+---------+--------+--------+--------+-------+------|
1344 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1346 Important: Please note that for these special tables, recalculating the
1347 table with `C-u C-c *' will only affect rows that are marked `#' or
1348 `*', and named fields. The column formulas are not applied in rows
1349 with empty first field.
1351 The marking characters have the following meaning:
1353 The fields in this line define names for the columns, so that you
1354 may refer to a column as `$Tot' instead of `$6'.
1357 This row defines names for the fields _above_ the row. With such
1358 a definition, any formula in the table may use `$m1' to refer to
1359 the value `10'. Also, named fields can have their own formula
1360 associated with them.
1363 Similar to `^', but defines names for the fields in the row
1367 Fields in this row can define _parameters_ for formulas. For
1368 example, if a field in a `$' row contains `max=50', then formulas
1369 in this table can refer to the value 50 using `$max'. Parameters
1370 work exactly like constants, only that they can be defined on a
1371 per-table basis. Changing a parameter and then recalculating the
1372 table can be useful.
1375 Fields in this row are automatically recalculated when pressing
1376 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1377 selected for a global recalculation with `C-u C-c *'. Unmarked
1378 lines will be left alone by this command.
1381 Selects this line for global recalculation with `C-u C-c *', but
1382 not for automatic recalculation. Use this when automatic
1383 recalculation slows down editing too much.
1386 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1387 All lines that should be recalculated should be marked with `#' or
1391 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1393 3.3.5 Named-field formulas
1394 --------------------------
1396 A named field can have its own formula associated with it. In the
1397 example above, this is used for the `at' field that contains the
1398 average result of the students. To enter a formula for a named field,
1399 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1400 This equation will be stored below the table like `$name=...'. Any
1401 recalculation in the table (even if only requested for the current
1402 line) will also update all named field formulas.
1405 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1407 3.3.6 Editing and debugging formulas
1408 ------------------------------------
1410 To edit a column or field formula, use the commands `C-c =' and `C-u
1411 C-c =', respectively. The currently active expression is then
1412 presented as default in the minibuffer, where it may be edited.
1414 Note that making a table field blank does not remove the formula
1415 associated with the field - during the next recalculation the field
1416 will be filled again. To remove a formula from a field, you have to
1417 give an empty reply when prompted for the formula, or to edit the
1420 You may edit the `#+TBLFM' directly and re-apply the changed
1421 equations with `C-c C-c' in that line, or with the normal recalculation
1422 commands in the table.
1424 In particular for large tables with many formulas, it is convenient
1425 to use the command `C-c '' to edit the formulas of the current table in
1426 a separate buffer. That buffer will show the formulas one per line,
1427 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1428 `$...' expression to get information about its interpretation.
1429 Exiting the buffer with `C-c C-c' only stores the modified formulas
1430 below the table. Exiting with `C-u C-c C-c' also applies them to the
1431 entire table. `C-c C-q' exits without installing the changes.
1433 When the evaluation of a formula leads to an error, the field content
1434 becomes the string `#ERROR'. If you would like see what is going on
1435 during variable substitution and calculation in order to find a bug,
1436 turn on formula debugging in the menu and repeat the calculation, for
1437 example by pressing `C-c = <RET>' in a field. Detailed information
1441 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1446 Finally, just to whet your appetite on what can be done with the
1447 fantastic `calc' package, here is a table that computes the Taylor
1448 series for a couple of functions (homework: try that with Excel :-)
1450 |---+-------------+---+-----+--------------------------------------|
1451 | | Func | n | x | Result |
1452 |---+-------------+---+-----+--------------------------------------|
1453 | # | exp(x) | 1 | x | 1 + x |
1454 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1455 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1456 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1457 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1458 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1459 |---+-------------+---+-----+--------------------------------------|
1460 #+TBLFM: $5=taylor($2,$4,$3);n3
1463 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1465 3.4 The Orgtbl minor mode
1466 =========================
1468 If you like the intuitive way the Org-mode table editor works, you
1469 might also want to use it in other modes like text-mode or mail-mode.
1470 The minor mode Orgtbl-mode makes this possible. You can always toggle
1471 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1474 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1477 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1479 3.5 The `table.el' package
1480 ==========================
1482 Complex ASCII tables with automatic line wrapping, column- and
1483 row-spanning, and alignment can be created using the Emacs table
1484 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1485 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1486 table, Org-mode will call `table-recognize-table' and move the cursor
1487 into the table. Inside a table, the keymap of Org-mode is inactive.
1488 In order to execute Org-mode-related commands, leave the table.
1491 Recognize `table.el' table. Works when the cursor is in a
1495 Insert a table.el table. If there is already a table at point,
1496 this command converts it between the table.el format and the
1497 Org-mode format. See the documentation string of the command
1498 `org-convert-table' for the restrictions under which this is
1502 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1507 Just like HTML, Org-mode provides links inside a file, and external
1508 links to other files, Usenet articles, emails, and much more.
1512 * Link format:: How links in Org-mode are formatted
1513 * Internal links:: Links to other places in the current file
1514 * External links:: URL-like links to the world
1515 * Handling links:: Creating, inserting and following
1516 * Link abbreviations:: Shortcuts for writing complex links
1517 * Search options:: Linking to a specific location
1518 * Custom searches:: When the default search is not enough
1519 * Remember:: Org-trees store quick notes
1522 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1527 Org-mode will recognize plain URL-like links and activate them as
1528 clickable links. The general link format, however, looks like this:
1530 [[link][description]] or alternatively [[link]]
1532 Once a link in the buffer is complete (all brackets present),
1533 Org-mode will change the display so that `description' is displayed
1534 instead of `[[link][description]]' and `link' is displayed instead of
1535 `[[link]]'. Links will be highlighted in the face `org-link', which by
1536 default is an underlined face. You can directly edit the visible part
1537 of a link. Note that this can be either the `link' part (if there is
1538 no description) or the `description' part. To edit also the invisible
1539 `link' part, use `C-c C-l' with the cursor on the link.
1541 If you place the cursor at the beginning or just behind the end of
1542 the displayed text and press <BACKSPACE>, you will remove the
1543 (invisible) bracket at that location. This makes the link incomplete
1544 and the internals are again displayed as plain text. Inserting the
1545 missing bracket hides the link internals again. To show the internal
1546 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1550 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1555 If the link does not look like a URL, it is considered to be internal in
1556 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1557 my target]]' lead to a text search in the current file. The link can
1558 be followed with `C-c C-o' when the cursor is on the link, or with a
1559 mouse click (*note Handling links::). The preferred match for such a
1560 link is a dedicated target: the same string in double angular brackets.
1561 Targets may be located anywhere; often it is convenient to put them
1562 into a comment line. For example
1566 In HTML export (*note HTML export::), such targets will become named
1567 anchors for direct access through `http' links(1).
1569 If no dedicated target exists, Org-mode will search for the words in
1570 the link. In the above example the search would be for `my target'.
1571 Links starting with a star like `*My Target' restrict the search to
1572 headlines. When searching, Org-mode will first try an exact match, but
1573 then move on to more and more lenient searches. For example, the link
1574 `[[*My Targets]]' will find any of the following:
1577 ** TODO my targets are bright
1578 ** my 20 targets are
1580 To insert a link targeting a headline, in-buffer completion can be
1581 used. Just type a star followed by a few optional letters into the
1582 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1583 offered as completions. *Note Handling links::, for more commands
1586 Following a link pushes a mark onto Org-mode's own mark ring. You
1587 can return to the previous position with `C-c &'. Using this command
1588 several times in direct succession goes back to positions recorded
1593 * Radio targets:: Make targets trigger links in plain text.
1594 * CamelCase links:: Activating CamelCase words as links
1596 ---------- Footnotes ----------
1598 (1) Note that text before the first headline will never be exported,
1599 so the first such target must be after the first headline.
1602 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1607 You can configure Org-mode to link any occurrences of certain target
1608 names in normal text. So without explicitly creating a link, the text
1609 connects to the target radioing its position. Radio targets are
1610 enclosed by triple angular brackets. For example, a target `<<<My
1611 Target>>>' causes each occurrence of `my target' in normal text to
1612 become activated as a link. The Org-mode file is scanned automatically
1613 for radio targets only when the file is first loaded into Emacs. To
1614 update the target list during editing, press `C-c C-c' with the cursor
1618 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1620 4.2.2 CamelCase words as links
1621 ------------------------------
1623 Org-mode also supports CamelCase words as links. This feature is not
1624 turned on by default because of the inconsistencies this system suffers
1625 from. It is also possible that this feature will disappear entirely in
1626 a future version of Org-mode. To activate CamelCase words as links, you
1627 need to customize the option `org-activate-links'. A CamelCase word
1628 then leads to a text search such that `CamelCaseLink' is equivalent to
1629 `[[camel case link]]'.
1632 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1637 Org-mode supports links to files, websites, Usenet and email messages,
1638 and BBDB database entries. External links are URL-like locators. They
1639 start with a short identifying string followed by a colon. There can be
1640 no space after the colon. The following list shows examples for each
1643 http://www.astro.uva.nl/~dominik on the web
1644 file:/home/dominik/images/jupiter.jpg file, absolute path
1645 file:papers/last.pdf file, relative path
1646 news:comp.emacs Usenet link
1647 mailto:adent@galaxy.net Mail link
1648 vm:folder VM folder link
1649 vm:folder#id VM message link
1650 vm://myself@some.where.org/folder#id VM on remote machine
1651 wl:folder WANDERLUST folder link
1652 wl:folder#id WANDERLUST message link
1653 mhe:folder MH-E folder link
1654 mhe:folder#id MH-E message link
1655 rmail:folder RMAIL folder link
1656 rmail:folder#id RMAIL message link
1657 gnus:group GNUS group link
1658 gnus:group#id GNUS article link
1659 bbdb:Richard Stallman BBDB link
1660 shell:ls *.org A shell command
1661 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1663 A link should be enclosed in double brackets and may contain a
1664 descriptive text to be displayed instead of the url (*note Link
1665 format::), for example:
1667 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1669 Org-mode also finds external links in the normal text and activates
1670 them as links. If spaces must be part of the link (for example in
1671 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1672 end of the link, enclose them in angular brackets.
1675 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1680 Org-mode provides methods to create a link in the correct syntax, to
1681 insert it into an org-mode file, and to follow the link.
1684 Store a link to the current location. This is a _global_ command
1685 which can be used in any buffer to create a link. The link will be
1686 stored for later insertion into an Org-mode buffer (see below).
1687 For Org-mode files, if there is a `<<target>>' at the cursor, the
1688 link points to the target. Otherwise it points to the current
1689 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1690 the link will indicate the current article/entry. For W3 and W3M
1691 buffers, the link goes to the current URL. For any other files,
1692 the link will point to the file, with a search string (*note
1693 Search options::) pointing to the contents of the current line.
1694 If there is an active region, the selected words will form the
1695 basis of the search string. If the automatically created link is
1696 not working correctly or accurately enough, you can write custom
1697 functions to select the search string and to do the search for
1698 particular file types - see *Note Custom searches::. The key
1699 binding `C-c l' is only a suggestion - see *Note Installation::.
1702 Insert a link. This prompts for a link to be inserted into the
1703 buffer. You can just type a link, using text for an internal
1704 link, or one of the link type prefixes mentioned in the examples
1705 above. Through completion, all links stored during the current
1706 session can be accessed(1). The link will be inserted into the
1707 buffer, along with a descriptive text. Note that you don't have
1708 to use this command to insert a link. Links in Org-mode are plain
1709 text, and you can type or paste them straight into the buffer. By
1710 using this command, the links are automatically enclosed in double
1711 brackets, and you will be asked for the optional descriptive text.
1712 If the link is a `file:' link and the linked file is located in
1713 the same directory as the current file or a subdirectory of it, the
1714 path of the file will be inserted relative to the current
1718 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1719 file will be inserted and you may use file name completion to
1720 select the name of the file. The path to the file is inserted
1721 relative to the directory of the current org file, if the linked
1722 file is in the current directory or in a subdirectory of it, or if
1723 the path is written relative to the current directory using `../'.
1724 Otherwise an absolute path is used, if possible with `~/' for
1725 your home directory. You can force an absolute path with two
1728 `C-c C-l with cursor on existing link'
1729 When the cursor is on an existing link, `C-c C-l' allows you to
1730 edit the link and description parts of the link.
1733 Open link at point. This will launch a web browser for URLs (using
1734 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1735 the corresponding links, and execute the command in a shell link.
1736 When the cursor is on an internal link, this commands runs the
1737 corresponding search. When the cursor is on a TAG list in a
1738 headline, it creates the corresponding TAGS view. If the cursor
1739 is on a time stamp, it compiles the agenda for that date.
1740 Furthermore, it will visit text and remote files in `file:' links
1741 with Emacs and select a suitable application for local non-text
1742 files. Classification of files is based on file extension only.
1743 See option `org-file-apps'. If you want to override the default
1744 application and visit the file with Emacs, use a `C-u' prefix.
1748 On links, `mouse-2' will open the link just as `C-c C-o' would.
1749 Under Emacs 22, also `mouse-1' will follow a link.
1752 Like `mouse-2', but force file links to be opened with Emacs, and
1753 internal links to be displayed in another window(2).
1756 Push the current position onto the mark ring, to be able to return
1757 easily. Commands following an internal link do this automatically.
1760 Jump back to a recorded position. A position is recorded by the
1761 commands following internal links, and by `C-c %'. Using this
1762 command several times in direct succession moves through a ring of
1763 previously recorded positions.
1765 ---------- Footnotes ----------
1767 (1) After insertion of a stored link, the link will be removed from
1768 the list of stored links. To keep it in the list later use, use a
1769 triple `C-u' prefix to `C-c C-l', or configure the option
1770 `org-keep-stored-link-after-insertion'.
1772 (2) See the variable `org-display-internal-link-with-indirect-buffer'
1775 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
1777 4.5 Link abbreviatons
1778 =====================
1780 Long URLs can be cumbersome to type, and often many similar links are
1781 needed in a document. For this you can use link abbreviations. An
1782 abbreviated link looks like this
1784 [[linkword::tag][description]]
1786 where the tag is optional. Such abbreviations are resolved according to
1787 the information in the variable `org-link-abbrev-alist' that relates
1788 the linkwords to replacement text. Here is an example:
1790 (setq org-link-abbrev-alist
1791 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
1792 ("google" . "http://www.google.com/search?q=")
1793 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
1794 nph-abs_connect?author=%s&db_key=AST")))
1796 If the replacement text contains the string `%s', it will be
1797 replaced with the tag. Otherwise the tag will be appended to the string
1798 in order to create the link. You may also specify a function that will
1799 be called with the tag as the only argument to create the link.
1801 With the above setting, you could link to a specific bug with
1802 `[[bugzilla::129]]', search the web for OrgMode with
1803 `[[google::OrgMode]]' and find out what the Org-mode author is doing
1804 besides Emacs hacking with `[[ads::Dominik,C]]'.
1806 If you need special abbreviations just for a single Org-mode buffer,
1807 you can define them in the file with
1809 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
1810 #+LINK: google http://www.google.com/search?q=%s
1812 In-buffer completion *note Completion:: can be used after `[' to
1813 complete link abbreviations.
1816 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
1818 4.6 Search options in file links
1819 ================================
1821 File links can contain additional information to make Emacs jump to a
1822 particular location in the file when following a link. This can be a
1823 line number or a search option after a double(1) colon. For example,
1824 when the command `C-c l' creates a link (*note Handling links::) to a
1825 file, it encodes the words in the current line as a search string that
1826 can be used to find this line back later when following the link with
1829 Here is the syntax of the different ways to attach a search to a file
1830 link, together with an explanation:
1832 [[file:~/code/main.c::255]]
1833 [[file:~/xx.org::My Target]]
1834 [[file:~/xx.org::*My Target]]
1835 [[file:~/xx.org::/regexp/]]
1841 Search for a link target `<<My Target>>', or do a text search for
1842 `my target', similar to the search in internal links, see *Note
1843 Internal links::. In HTML export (*note HTML export::), such a
1844 file link will become an HTML reference to the corresponding named
1845 anchor in the linked file.
1848 In an Org-mode file, restrict search to headlines.
1851 Do a regular expression search for `regexp'. This uses the Emacs
1852 command `occur' to list all matches in a separate window. If the
1853 target file is in Org-mode, `org-occur' is used to create a sparse
1854 tree with the matches.
1856 As a degenerate case, a file link with an empty file name can be used
1857 to search the current file. For example, `[[file:::find me]]' does a
1858 search for `find me' in the current file, just as `[[find me]]' would.
1860 ---------- Footnotes ----------
1862 (1) For backward compatibility, line numbers can also follow a
1866 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1871 The default mechanism for creating search strings and for doing the
1872 actual search related to a file link may not work correctly in all
1873 cases. For example, BibTeX database files have many entries like
1874 `year="1993"' which would not result in good search strings, because
1875 the only unique identification for a BibTeX entry is the citation key.
1877 If you come across such a problem, you can write custom functions to
1878 set the right search string for a particular file type, and to do the
1879 search for the string in the file. Using `add-hook', these functions
1880 need to be added to the hook variables
1881 `org-create-file-search-functions' and
1882 `org-execute-file-search-functions'. See the docstring for these
1883 variables for more information. Org-mode actually uses this mechanism
1884 for BibTeX database files, and you can use the corresponding code as an
1885 implementation example. Search for `BibTeX links' in the source file.
1888 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1893 Another way to create org entries with links to other files is through
1894 the _Remember_ package by John Wiegley. _Remember_ lets you store
1895 quick notes with little interruption of your work flow. See
1896 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1897 information. The notes produced by _Remember_ can be stored in
1898 different ways, and Org-mode files are a good target. Org-mode allows
1899 you to file away notes either to a default file, or directly to the
1900 correct location in your Org-mode outline tree. The following
1901 customization will tell _Remember_ to use org files as target, and to
1902 create annotations compatible with Org-mode links.
1904 (setq org-directory "~/path/to/my/orgfiles/")
1905 (setq org-default-notes-file "~/.notes")
1906 (setq remember-annotation-functions '(org-remember-annotation))
1907 (setq remember-handler-functions '(org-remember-handler))
1908 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1910 In combination with Org-mode, you can use templates to generate
1911 different types of remember notes. For example, if you would like to
1912 use one template to create general TODO entries, and another one for
1913 journal entries, you could use:
1915 (setq org-remember-templates
1916 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1917 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1919 In these entries, the character specifies how to select the template,
1920 the first string specifies the template, and the (optional) second
1921 string specifies a default file (overruling `org-default-notes-file')
1922 as a target for this note.
1924 When you call `M-x remember' to remember something, org will prompt
1925 for a key to select the template and then prepare the buffer like
1927 [[file:link to where you called remember]]
1931 * [2006-03-21 Tue 15:37]
1933 [[file:link to where you called remember]]
1935 See the variable `org-remember-templates' for more details.
1937 When you are finished composing a note with remember, you have to
1938 press `C-c C-c' to file the note away. The handler first prompts for a
1939 target file - if you press <RET>, the value of `org-default-notes-file'
1940 is used. Then the command offers the headings tree of the selected
1941 file. You can either immediately press <RET> to get the note appended
1942 to the file. Or you can use vertical cursor motion (<up> and <down>)
1943 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1944 or <left> or <right> leads to the following result.
1946 Cursor Key Note gets inserted
1948 buffer-start <RET> as level 2 heading at end of file
1949 on headline <RET> as sublevel of the heading at cursor
1950 <left> as same level, before current heading
1951 <right> as same level, after current heading
1952 not on <RET> at cursor position, level taken from context.
1953 headline Or use prefix arg to specify level
1956 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1957 append it to the default file. Even shorter would be `C-u C-c C-c',
1958 which does the same without even showing the tree. But with little
1959 extra effort, you can push it directly to the correct location.
1961 Before inserting the text into a tree, the function ensures that the
1962 text has a headline, i.e. a first line that starts with a `*'. If not,
1963 a headline is constructed from the current date and some additional
1964 data. If the variable `org-adapt-indentation' is non-nil, the entire
1965 text is also indented so that it starts in the same column as the
1966 headline (after the asterisks).
1969 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1974 Org-mode does not maintain TODO lists as a separate document. TODO
1975 items are an integral part of the notes file, because TODO items
1976 usually come up while taking notes! With Org-mode, you simply mark any
1977 entry in a tree as being a TODO item. In this way, the information is
1978 not duplicated, and the entire context from which the item emerged is
1979 always present when you check.
1981 Of course, this technique causes TODO items to be scattered
1982 throughout your file. Org-mode provides methods to give you an
1983 overview over all things you have to do.
1987 * TODO basics:: Marking and displaying TODO entries
1988 * TODO extensions:: Workflow and assignments
1989 * Priorities:: Some things are more important than others
1990 * Breaking down tasks:: Splitting a task into managable pieces
1991 * Checkboxes:: Tick-off lists
1994 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
1996 5.1 Basic TODO functionality
1997 ============================
1999 Any headline can become a TODO item by starting it with the word TODO,
2002 *** TODO Write letter to Sam Fortune
2004 The most important commands to work with TODO entries are:
2007 Rotate the TODO state of the current item between
2009 ,-> (unmarked) -> TODO -> DONE --.
2010 '--------------------------------'
2012 The same rotation can also be done "remotely" from the timeline and
2013 agenda buffers with the `t' command key (*note Agenda commands::).
2017 Select the following/preceding TODO state, similar to cycling.
2018 Mostly useful if more than two TODO states are possible (*note
2022 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2023 the entire buffer, but shows all TODO items and the headings
2024 hierarchy above them. With prefix arg, show also the DONE
2025 entries. With numerical prefix N, show the tree for the Nth
2026 keyword in the variable `org-todo-keywords'.
2029 Show the global TODO list. This collects the TODO items from all
2030 agenda files (*note Agenda views::) into a single buffer. The
2031 buffer is in `agenda-mode', so there are commands to examine and
2032 manipulate the TODO entries directly from that buffer (*note
2033 Agenda commands::). *Note Global TODO list::, for more
2037 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2039 5.2 Extended use of TODO keywords
2040 =================================
2042 The default implementation of TODO entries is just two states: TODO and
2043 DONE. You can, however, use the TODO feature for more complicated
2044 things by configuring the variables `org-todo-keywords' and
2045 `org-todo-interpretation'. Using special setup, you can even use TODO
2046 keywords in different ways in different org files.
2048 Note that tags are another way to classify headlines in general and
2049 TODO items in particular (*note Tags::).
2053 * Workflow states:: From TODO to DONE in steps
2054 * TODO types:: I do this, Fred the rest
2055 * Per file keywords:: Different files, different requirements
2058 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2060 5.2.1 TODO keywords as workflow states
2061 --------------------------------------
2063 You can use TODO keywords to indicate different states in the process
2064 of working on an item, for example:
2066 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
2067 org-todo-interpretation 'sequence)
2069 Changing these variables only becomes effective in a new Emacs
2070 session. With this setup, the command `C-c C-t' will cycle an entry
2071 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
2072 also use a prefix argument to quickly select a specific state. For
2073 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
2074 you define many keywords, you can use in-buffer completion (see *Note
2075 Completion::) to insert these words into the buffer.
2078 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
2080 5.2.2 TODO keywords as types
2081 ----------------------------
2083 The second possibility is to use TODO keywords to indicate different
2084 types of action items. For example, you might want to indicate that
2085 items are for "work" or "home". If you are into David Allen's _Getting
2086 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
2087 `MAYBE'. Or, when you work with several people on a single project,
2088 you might want to assign action items directly to persons, by using
2089 their names as TODO keywords. This would be set up like this:
2091 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
2092 org-todo-interpretation 'type)
2094 In this case, different keywords do not indicate a sequence, but
2095 rather different types. So it is normally not useful to change from
2096 one type to another. Therefore, in this case the behavior of the
2097 command `C-c C-t' is changed slightly(1). When used several times in
2098 succession, it will still cycle through all names. But when you return
2099 to the item after some time and execute `C-c C-t' again, it will switch
2100 from each name directly to DONE. Use prefix arguments or completion to
2101 quickly select a specific name. You can also review the items of a
2102 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2103 C-v'. For example, to see all things Lucy has to do, you would use
2104 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2105 single buffer, you would use the prefix arg as well when creating the
2106 global todo list: `C-3 C-c t'.
2108 ---------- Footnotes ----------
2110 (1) This is also true for the `t' command in the timeline and agenda
2114 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
2116 5.2.3 Setting up TODO keywords for individual files
2117 ---------------------------------------------------
2119 It can be very useful to use different aspects of the TODO mechanism in
2120 different files, which is not possible with the global settings
2121 described above. For file-local settings, you need to add special
2122 lines to the file which set the keywords and interpretation for that
2123 file only. For example, to set one of the two examples discussed
2124 above, you need one of the following lines, starting in column zero
2125 anywhere in the file:
2127 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2128 #+TYP_TODO: Fred Sara Lucy Mike DONE
2130 To make sure you are using the correct keyword, type `#+' into the
2131 buffer and then use `M-<TAB>' completion.
2133 Remember that the last keyword must always mean that the item is DONE
2134 (although you may use a different word). Also note that in each file,
2135 only one of the two aspects of TODO keywords can be used. After
2136 changing one of these lines, use `C-c C-c' with the cursor still in the
2137 line to make the changes known to Org-mode(1).
2139 If you want to use very many keywords, for example when working with
2140 a large group of people, you may split the names over several lines:
2142 #+TYP_TODO: Fred Sara Lucy Mike
2143 #+TYP_TODO: Luis George Jules Jessica
2144 #+TYP_TODO: Kim Arnold Peter
2147 ---------- Footnotes ----------
2149 (1) Org-mode parses these lines only when Org-mode is activated
2150 after visiting a file. `C-c C-c' with the cursor in a line starting
2151 with `#+' is simply restarting Org-mode for the current buffer.
2154 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2159 If you use Org-mode extensively to organize your work, you may end up
2160 with a number of TODO entries so large that you'd like to prioritize
2161 them. This can be done by placing a _priority cookie_ into the
2164 *** TODO [#A] Write letter to Sam Fortune
2166 With its standard setup, Org-mode supports priorities `A', `B', and
2167 `C'. `A' is the highest priority. An entry without a cookie is
2168 treated as priority `B'. Priorities make a difference only in the
2169 agenda (*note Weekly/Daily agenda::).
2172 Set the priority of the current headline. The command prompts for
2173 a priority character `A', `B' or `C'. When you press <SPC>
2174 instead, the priority cookie is removed from the headline. The
2175 priorities can also be changed "remotely" from the timeline and
2176 agenda buffer with the `,' command (*note Agenda commands::).
2180 Increase/decrease priority of current headline. Note that these
2181 keys are also used to modify time stamps (*note Creating
2182 timestamps::). Furthermore, these keys are also used by CUA-mode
2183 (*note Conflicts::).
2186 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2188 5.4 Breaking tasks down into subtasks
2189 =====================================
2191 It is often advisable to break down large tasks into smaller, managable
2192 subtasks. You can do this by creating an outline tree below a TODO
2193 item, with detailed subtasks on the tree(1). Another possibility is
2194 the use of checkboxes to identify (a hierarchy of) a large number of
2195 subtasks (*note Checkboxes::).
2197 ---------- Footnotes ----------
2199 (1) To keep subtasks out of the global TODO list, see the
2200 `org-agenda-todo-list-sublevels'.
2203 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2208 Every item in a plain list (*note Plain lists::) can be made a checkbox
2209 by starting it with the string `[ ]'. This feature is similar to TODO
2210 items (*note TODO items::), but more lightweight. Checkboxes are not
2211 included into the global TODO list, so they are often great to split a
2212 task into a number of simple steps. Or you can use them in a shopping
2213 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2214 `org-mouse.el'. Here is an example of a checkbox list.
2216 * TODO Organize party [3/6]
2222 - [ ] think about what music to play
2223 - [X] talk to the neighbors
2225 The `[3/6]' and `[1/3]' in the first and second line are cookies
2226 indicating how many checkboxes are present in this entry, and how many
2227 of them have been checked off. This can give you an idea on how many
2228 checkboxes remain, even without opening a folded entry. The cookies
2229 can be placed into a headline or into (the first line of) a plain list
2230 item. Each cookie covers all checkboxes structurally below that
2231 headline/item. You have to insert the cookie yourself by typing either
2232 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2233 the second case you get information about the percentage of checkboxes
2234 checked (in the above example, this would be `[50%]' and `[33%],
2237 The following commands work with checkboxes:
2240 Toggle checkbox at point.
2243 Toggle checkbox at point.
2244 - If there is an active region, toggle the first checkbox in
2245 the region and set all remaining boxes to the same status as
2246 the first. If you want to toggle all boxes in the region
2247 independently, use a prefix argument.
2249 - If the cursor is in a headline, toggle checkboxes in the
2250 region between this headline and the next (so _not_ the
2253 - If there is no active region, just toggle the checkbox at
2257 Insert a new item with a checkbox. This works only if the cursor
2258 is already in a plain list item (*note Plain lists::).
2261 Update the checkbox statistics in the current outline entry. When
2262 called with a `C-u' prefix, update the entire file. Checkbox
2263 statistic cookies are updated automatically if you toggle
2264 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2265 you delete boxes or add/change them by hand, use this command to
2266 get things back into synch. Or simply toggle any checkbox twice
2270 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2275 Items can be labeled with timestamps to make them useful for project
2280 * Time stamps:: Assigning a time to a tree entry
2281 * Creating timestamps:: Commands which insert timestamps
2282 * Custom time format:: If you cannot work with the ISO format
2283 * Progress logging:: Documenting when what work was done.
2286 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2288 6.1 Time stamps, deadlines and scheduling
2289 =========================================
2291 A time stamp is a specification of a date (possibly with time) in a
2292 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2293 09:39>'(1). A time stamp can appear anywhere in the headline or body
2294 of an org-tree entry. Its presence allows entries to be shown on
2295 specific dates in the agenda (*note Weekly/Daily agenda::). We
2299 A simple time stamp just assigns a date/time to an item. This is
2300 just like writing down an appointment in a paper agenda, or like
2301 writing down an event in a diary, when you want to take note of
2302 when something happened. In the timeline and agenda displays, the
2303 headline of an entry associated with a plain time stamp will be
2304 shown exactly on that date.
2306 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2309 Just like a plain time stamp, but with square brackets instead of
2310 angular ones. These time stamps are inactive in the sense that
2311 they do _not_ trigger an entry to show up in the agenda.
2313 * Gillian comes late for the fifth time [2006-11-01 Wed]
2316 Two time stamps connected by `--' denote a time range. The
2317 headline will be shown on the first and last day of the range, and
2318 on any dates that are displayed and fall in the range. Here is an
2321 ** Meeting in Amsterdam
2322 <2004-08-23 Mon>--<2004-08-26 Thu>
2324 TIME STAMP WITH SCHEDULED KEYWORD
2325 If a time stamp is preceded by the word `SCHEDULED:', it means you
2326 are planning to start working on that task on the given date. So
2327 this is not about recording an event, but about planning your
2328 work. The headline will be listed under the given date(2). In
2329 addition, a reminder that the scheduled date has passed will be
2330 present in the compilation for _today_, until the entry is marked
2331 DONE. I.e., the task will automatically be forwarded until
2334 *** TODO Call Trillian for a date on New Years Eve.
2335 SCHEDULED: <2004-12-25 Sat>
2337 TIME STAMP WITH DEADLINE KEYWORD
2338 If a time stamp is preceded by the word `DEADLINE:', the task
2339 (most likely a TODO item) is supposed to be finished on that date,
2340 and it will be listed then. In addition, the compilation for
2341 _today_ will carry a warning about the approaching or missed
2342 deadline, starting `org-deadline-warning-days' before the due
2343 date, and continuing until the entry is marked DONE. An example:
2345 *** TODO write article about the Earth for the Guide
2346 The editor in charge is [[bbdb:Ford Prefect]]
2347 DEADLINE: <2004-02-29 Sun>
2349 TIME STAMP WITH CLOSED KEYWORD
2350 When `org-log-done' is non-nil, Org-mode will automatically insert
2351 a special time stamp each time a TODO entry is marked done (*note
2352 Progress logging::). This time stamp is enclosed in square
2353 brackets instead of angular brackets.
2355 TIME RANGE WITH CLOCK KEYWORD
2356 When using the clock to time the work that is being done on
2357 specific items, time ranges preceded by the CLOCK keyword are
2358 inserted automatically into the file. The time stamps are
2359 enclosed in square brackets instead of angular brackets. *Note
2360 Clocking work time::.
2362 ---------- Footnotes ----------
2364 (1) This is the standard ISO date/time format. If you cannot get
2365 used to these, see *Note Custom time format::
2367 (2) It will still be listed on that date after it has been marked
2368 DONE. If you don't like this, set the variable
2369 `org-agenda-skip-scheduled-if-done'.
2372 File: org, Node: Creating timestamps, Next: Custom time format, Prev: Time stamps, Up: Timestamps
2374 6.2 Creating timestamps
2375 =======================
2377 For Org-mode to recognize time stamps, they need to be in the specific
2378 format. All commands listed below produce time stamps in the correct
2382 Prompt for a date and insert a corresponding time stamp. When the
2383 cursor is at a previously used time stamp, it is updated to NOW.
2384 When this command is used twice in succession, a time range is
2388 Like `C-c .', but use the alternative format which contains date
2389 and time. The default time can be rounded to multiples of 5
2390 minutes, see the option `org-time-stamp-rounding-minutes'.
2393 Like `C-c .', but insert an inactive time stamp not triggering the
2397 Insert a time stamp corresponding to the cursor date in the
2401 Access the Emacs calendar for the current date. If there is a
2402 timestamp in the current line, goto the corresponding date instead.
2405 Access the agenda for the date given by the time stamp or -range at
2406 point (*note Weekly/Daily agenda::).
2409 Insert `DEADLINE' keyword along with a stamp. The insertion will
2410 happen in the line directly following the headline.
2413 Create a sparse tree with all deadlines that are either past-due,
2414 or which will become due within `org-deadline-warning-days'. With
2415 `C-u' prefix, show all deadlines in the file. With a numeric
2416 prefix, check that many days. For example, `C-1 C-c C-w' shows
2417 all deadlines due tomorrow.
2420 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2421 happen in the line directly following the headline. Any CLOSED
2422 timestamp will be removed.
2426 Change date at cursor by one day. These key bindings conflict with
2427 CUA-mode (*note Conflicts::).
2431 Change the item under the cursor in a timestamp. The cursor can
2432 be on a year, month, day, hour or minute. Note that if the cursor
2433 is in a headline and not at a time stamp, these same keys modify
2434 the priority of an item. (*note Priorities::). The key bindings
2435 also conflict with CUA-mode (*note Conflicts::).
2438 Evaluate a time range by computing the difference between start and
2439 end. With prefix arg, insert result after the time range (in a
2440 table: into the following column).
2444 * The date/time prompt:: How org-mode helps you entering date and time
2447 File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
2449 6.2.1 The date/time prompt
2450 --------------------------
2452 When Org-mode prompts for a date/time, the prompt suggests to enter an
2453 ISO date. But it will in fact accept any string containing some date
2454 and/or time information. You can, for example, use `C-y' to paste a
2455 (possibly multi-line) string copied from an email message. Org-mode
2456 will find whatever information is in there and will replace anything not
2457 specified with the current date and time. For example:
2459 3-2-5 --> 2003-02-05
2460 feb 15 --> currentyear-02-15
2461 sep 12 9 --> 2009-09-12
2462 12:45 --> today 12:45
2463 22 sept 0:34 --> currentyear-09-22 0:34
2464 12 --> currentyear-currentmonth-12
2465 Fri --> nearest Friday (today or later)
2466 +4 --> 4 days from now (if +N is the only thing given)
2468 The function understands English month and weekday abbreviations. If
2469 you want to use unabbreviated names and/or other languages, configure
2470 the variables `parse-time-months' and `parse-time-weekdays'.
2472 Parallel to the minibuffer prompt, a calendar is popped up(1). You
2473 can control the calendar fully from the minibuffer:
2476 Scroll calendar backwards by one month.
2479 Scroll calendar forwards by one month.
2482 Select date by clicking on it.
2503 Choose date in calendar (only if nothing was typed into
2506 ---------- Footnotes ----------
2508 (1) If you don't need/want the calendar, configure the variable
2509 `org-popup-calendar-for-date-prompt'.
2512 File: org, Node: Custom time format, Next: Progress logging, Prev: Creating timestamps, Up: Timestamps
2514 6.3 Custom time format
2515 ======================
2517 Org-mode uses the standard ISO notation for dates and times as it is
2518 defined in ISO 8601. If you cannot get used to this and require another
2519 representation of date and time to keep you happy, you can get it by
2520 customizing the variables `org-display-custom-times' and
2521 `org-time-stamp-custom-formats'.
2524 Toggle the display of custom formats for dates and times.
2526 Org-mode needs the default format for scanning, so the custom date/time
2527 format does not _replace_ the default format - instead it is put _over_
2528 the default format using text properties. This has the following
2530 * You cannot place the cursor onto a time stamp anymore, only before
2533 * The `S-<up>/<down>' keys can no longer be used to adjust each
2534 component of a time stamp. If the cursor is at the beginning of
2535 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2536 like `S-<left>/<right>'. At the end of the stamp, the time will
2537 be changed by one minute.
2539 * When you delete a time stamp character-by-character, it will only
2540 disappear from the buffer after _all_ (invisible) characters
2541 belonging to the ISO timestamp have been removed.
2543 * If the custom time stamp format is longer than the default and you
2544 are using dates in tables, table alignment will be messed up. If
2545 the custom format is shorter, things do work as expected.
2548 File: org, Node: Progress logging, Prev: Custom time format, Up: Timestamps
2550 6.4 Progress Logging
2551 ====================
2553 Org-mode can automatically record a time stamp when you mark a TODO item
2554 as DONE. You can also measure precisely the time you spent on specific
2555 items in a project by starting and stopping a clock when you start and
2556 stop working on an aspect of a project.
2560 * Closing items:: When was this entry marked DONE?
2561 * Clocking work time:: When exactly did you work on this item?
2564 File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
2569 If you want to keep track of _when_ a certain TODO item was finished,
2570 turn on logging with
2572 (setq org-log-done t)
2574 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2575 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2576 [timestamp]' will be inserted just after the headline. If you turn the
2577 entry back into a TODO item again through further state cycling, that
2578 line will be removed again. In the timeline (*note Timeline::) and in
2579 the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
2580 to display the TODO items closed on each day, giving you an overview of
2581 what has been done on a day. See the variable `org-log-done' for the
2582 possibility to record an additional note together with a timestamp.
2585 File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
2587 6.4.2 Clocking work time
2588 ------------------------
2590 Org-mode allows you to clock the time you spent on specific tasks in a
2591 project. When you start working on an item, you can start the clock.
2592 When you stop working on that task, or when you mark the task done, the
2593 clock is stopped and the corresponding time interval is recorded. It
2594 also computes the total time spent on each subtree of a project.
2597 Start the clock on the current item (clock-in). This inserts the
2598 CLOCK keyword together with a timestamp.
2601 Stop the clock (clock-out). The inserts another timestamp at the
2602 same location where the clock was last started. It also directly
2603 computes the resulting time in inserts it after the time range as
2604 `=> HH:MM'. See the variable `org-log-done' for the possibility to
2605 record an additional note together with the clock-out time stamp.
2608 Recompute the time interval after changing one of the time stamps.
2609 This is only necessary if you edit the time stamps directly. If
2610 you change them with `S-<cursor>' keys, the update is automatic.
2613 Changing the TODO state of an item to DONE automatically stops the
2614 clock if it is running in this same item.
2617 Cancel the current clock. This is useful if a clock was started by
2618 mistake, or if you ended up working on something else.
2621 Display time summaries for each subtree in the current buffer.
2622 This puts overlays at the end of each headline, showing the total
2623 time recorded under that heading, including the time of any
2624 subheadings. You can use visibility cycling to study the tree, but
2625 the overlays disappear when you change the buffer (see variable
2626 `org-remove-highlights-with-change') or press `C-c C-c'.
2629 Insert a dynamic block (*note Dynamic blocks::) containing a clock
2630 report as an org-mode table into the current file.
2631 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2634 If such a block already exists, its content is replaced by the new
2635 table. The `BEGIN' line can specify options:
2636 :maxlevels Maximum level depth to which times are listed in the table.
2637 :emphasize When `t', emphasize level one and level two items
2638 :block The time block to consider. This block is specified relative
2639 to the current time and may be any of these keywords:
2640 `today', `yesterday', `thisweek', `lastweek',
2641 `thismonth', `lastmonth', `thisyear', or `lastyear'.
2642 :tstart A time string specifying when to start considering times
2643 :tend A time string specifying when to stop considering times
2644 So to get a clock summary for the current day, you could write
2645 #+BEGIN: clocktable :maxlevel 2 :block today
2648 and to use a specific time range you could write(1)
2649 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2650 :tend "<2006-08-10 Thu 12:00>"
2655 Update all dynamic blocks (*note Dynamic blocks::). This is
2656 useful if you have several clocktable blocks in a buffer.
2658 The `l' key may be used in the timeline (*note Timeline::) and in
2659 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2660 worked on or closed during a day.
2662 ---------- Footnotes ----------
2664 (1) Note that all parameters must be specified in a single line -
2665 the line is broken here only to fit it onto the manual.
2668 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2673 If you wish to implement a system of labels and contexts for
2674 cross-correlating information, an excellent way is to assign tags to
2675 headlines. Org-mode has extensive support for using tags.
2677 Every headline can contain a list of tags, at the end of the
2678 headline. Tags are normal words containing letters, numbers, `_', and
2679 `@'. Tags must be preceded and followed by a single colon; like
2680 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2684 * Tag inheritance:: Tags use the tree structure of the outline
2685 * Setting tags:: How to assign tags to a headline
2686 * Tag searches:: Searching for combinations of tags
2689 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2694 Tags make use of the hierarchical structure of outline trees. If a
2695 heading has a certain tag, all subheadings will inherit the tag as
2696 well. For example, in the list
2698 * Meeting with the French group :WORK:
2699 ** Summary by Frank :BOSS:NOTES:
2700 *** TODO Prepare slides for him :ACTION:
2702 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2703 `:ACTION:'. When executing tag searches and Org-mode finds that a
2704 certain headline matches the search criterion, it will not check any
2705 sublevel headline, assuming that these likely also match, and that the
2706 list of matches can become very long. This may not be what you want,
2707 however, and you can influence inheritance and searching using the
2708 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2711 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2716 Tags can simply be typed into the buffer at the end of a headline.
2717 After a colon, `M-<TAB>' offers completion on tags. There is also a
2718 special command for inserting tags:
2721 Enter new tags for the current headline. Org-mode will either
2722 offer completion or a special single-key interface for setting
2723 tags, see below. After pressing <RET>, the tags will be inserted
2724 and aligned to `org-tags-column'. When called with a `C-u'
2725 prefix, all tags in the current buffer will be aligned to that
2726 column, just to make things look nice. TAGS are automatically
2727 realigned after promotion, demotion, and TODO state changes (*note
2730 Org will support tag insertion based on a _list of tags_. By
2731 default this list is constructed dynamically, containing all tags
2732 currently used in the buffer. You may also globally specify a hard list
2733 of tags with the variable `org-tag-alist'. Finally you can set the
2734 default tags for a given file with lines like
2736 #+TAGS: @WORK @HOME @TENNISCLUB
2737 #+TAGS: Laptop Car PC Sailboat
2739 If you have globally defined your preferred set of tags using the
2740 variable `org-tag-alist', but would like to use a dynamic tag list in a
2741 specific file: Just add an empty TAGS option line to that file:
2745 The default support method for entering tags is minibuffer
2746 completion. However, Org-mode also implements a much better method:
2747 _fast tag selection_. This method allows to select and deselect tags
2748 with a single key per tag. To function efficiently, you should assign
2749 unique keys to most tags. This can be done globally with
2751 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2753 or on a per-file basis with
2755 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2757 You can also group together tags that are mutually exclusive. With
2760 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2762 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2765 Don't forget to press `C-c C-c' with the cursor in one of these lines
2766 to activate any changes.
2768 If at least one tag has a selection key, pressing `C-c C-c' will
2769 automatically present you with a special interface, listing inherited
2770 tags, the tags of the current headline, and a list of all legal tags
2771 with corresponding keys(2). In this interface, you can use the
2775 Pressing keys assigned to tags will add or remove them from the
2776 list of tags in the current line. Selecting a tag in a group of
2777 mutually exclusive tags will turn off any other tags from that
2781 Enter a tag in the minibuffer, even if the tag is not in the
2782 predefined list. You will be able to complete on all tags present
2786 Clear all tags for this line.
2789 Accept the modified set.
2792 Abort without installing changes.
2795 If `q' is not assigned to a tag, it aborts like `C-g'.
2798 Turn off groups of mutually exclusive tags. Use this to (as an
2799 exception) assign several tags from such a group.
2802 Toggle auto-exit after the next change (see below).
2804 This method lets you assign tags to a headline with very few keys. With
2805 the above setup, you could clear the current tags and set `@HOME',
2806 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
2807 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
2808 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
2809 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
2812 If you find that most of the time, you need only a single keypress to
2813 modify your list of tags, set the variable
2814 `org-fast-tag-selection-single-key'. Then you no longer have to press
2815 <RET> to exit fast tag selection - it will immediately exit after the
2816 first change. If you then occasionally need more keys, press `C-c' to
2817 turn off auto-exit for the current tag selection process.
2819 ---------- Footnotes ----------
2821 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2822 respectively. Several groups are allowed.
2824 (2) Keys will automatically be assigned to tags which have no
2828 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2833 Once a tags system has been set up, it can be used to collect related
2834 information into special lists.
2837 Create a sparse tree with all headlines matching a tags search.
2840 Create a global list of tag matches from all agenda files. *Note
2841 Matching headline tags::.
2844 Create a global list of tag matches from all agenda files, but
2845 check only TODO items and force checking subitems (see variable
2846 `org-tags-match-list-sublevels').
2848 A tags search string can use Boolean operators `&' for AND and `|'
2849 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2850 not implemented. A tag may also be preceded by `-', to select against
2851 it, and `+' is syntactic sugar for positive selection. The AND
2852 operator `&' is optional when `+' or `-' is present. Examples:
2855 Select all headlines that are tagged `:WORK:', but discard those
2856 also tagged `:BOSS:'.
2859 Selects lines tagged `:WORK:' or `:LAPTOP:'.
2862 Like the previous example, but require the `:LAPTOP:' lines to be
2863 tagged also `NIGHT'.
2865 If you are using multi-state TODO keywords (*note TODO
2866 extensions::), it can be useful to also match on the TODO keyword.
2867 This can be done by adding a condition after a slash to a tags match.
2868 The syntax is similar to the tag matches, but should be applied with
2869 consideration: For example, a positive selection on several TODO
2870 keywords can not meaningfully be combined with boolean AND. However,
2871 _negative selection_ combined with AND can be meaningful. Examples:
2874 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
2877 `WORK/-WAITING-NEXT'
2878 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
2881 `WORK/+WAITING|+NEXT'
2882 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
2885 Any element of the tag/todo match can be a regular expression - in
2886 this case it must be enclosed in curly braces. For example,
2887 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
2888 tag starting with `BOSS'.
2891 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
2896 Due to the way Org-mode works, TODO items, time-stamped items, and
2897 tagged headlines can be scattered throughout a file or even a number of
2898 files. To get an overview over open action items, or over events that
2899 are important for a particular date, this information must be collected,
2900 sorted and displayed in an organized way.
2902 Org-mode can select items based on various criteria, and display them
2903 in a separate buffer. Five different view types are provided:
2905 * an _agenda_ that is like a calendar and shows information for
2908 * a _TODO list_ that covers all unfinished action items,
2910 * a _tags view_ that shows information based on the tags associated
2911 with headlines in the outline tree,
2913 * a _timeline view_ that shows all events in a single Org-mode file,
2916 * _custom views_ that are special tag and keyword searches and
2917 combinations of different views.
2919 The extracted information is displayed in a special _agenda buffer_.
2920 This buffer is read-only, but provides commands to visit the
2921 corresponding locations in the original Org-mode files, and even to
2922 edit these files remotely.
2924 Two variables control how the agenda buffer is displayed and whether
2925 the window configuration is restored when the agenda exits:
2926 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
2930 * Agenda files:: Files being searched for agenda information
2931 * Agenda dispatcher:: Keyboard access to agenda views
2932 * Weekly/Daily agenda:: The calendar page with current tasks
2933 * Global TODO list:: All unfinished action items
2934 * Matching headline tags:: Structured information with fine-tuned search
2935 * Timeline:: Time-sorted view for single file
2936 * Presentation and sorting:: How agenda items are prepared for display
2937 * Agenda commands:: Remote editing of org trees
2938 * Custom agenda views:: Defining special searches and views
2941 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2946 The information to be shown is collected from all _agenda files_, the
2947 files listed in the variable `org-agenda-files'(1). Thus even if you
2948 only work with a single Org-mode file, this file should be put into
2949 that list(2). You can customize `org-agenda-files', but the easiest
2950 way to maintain it is through the following commands
2953 Add current file to the list of agenda files. The file is added to
2954 the front of the list. If it was already in the list, it is moved
2955 to the front. With prefix arg, file is added/moved to the end.
2958 Remove current file from the list of agenda files.
2961 Cycle through agenda file list, visiting one file after the other.
2963 The Org menu contains the current list of files and can be used to
2966 ---------- Footnotes ----------
2968 (1) If the value of that variable is not a list, but a single file
2969 name, then the list of agenda files will be maintained in that external
2972 (2) When using the dispatcher, pressing `1' before selecting a
2973 command will actually limit the command to the current file, and ignore
2974 `org-agenda-files' until the next dispatcher command.
2977 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2979 8.2 The agenda dispatcher
2980 =========================
2982 The views are created through a dispatcher that should be bound to a
2983 global key, for example `C-c a' (*note Installation::). In the
2984 following we will assume that `C-c a' is indeed how the dispatcher is
2985 accessed and list keyboard access to commands accordingly. After
2986 pressing `C-c a', an additional letter is required to execute a
2987 command. The dispatcher offers the following default commands:
2989 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2992 Create a list of all TODO items (*note Global TODO list::).
2995 Create a list of headlines matching a TAGS expression (*note
2996 Matching headline tags::).
2999 Create the timeline view for the current buffer (*note Timeline::).
3002 Restrict an agenda command to the current buffer. After pressing
3003 `1', you still need to press the character selecting the command.
3006 If there is an active region, restrict the following agenda
3007 command to the region. Otherwise, restrict it to the current
3008 subtree. After pressing `0', you still need to press the
3009 character selecting the command.
3011 You can also define custom commands that will be accessible through
3012 the dispatcher, just like the default commands. This includes the
3013 possibility to create extended agenda buffers that contain several
3014 blocks together, for example the weekly agenda, the global TODO list and
3015 a number of special tags matches. *Note Custom agenda views::.
3018 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
3020 8.3 The weekly/daily agenda
3021 ===========================
3023 The purpose of the weekly/daily _agenda_ is to act like a page of a
3024 paper agenda, showing all the tasks for the current week or day.
3027 Compile an agenda for the current week from a list of org files.
3028 The agenda shows the entries for each day. With a `C-u' prefix (or
3029 when the variable `org-agenda-include-all-todo' is `t'), all
3030 unfinished TODO items (including those without a date) are also
3031 listed at the beginning of the buffer, before the first date.
3033 Remote editing from the agenda buffer means, for example, that you
3034 can change the dates of deadlines and appointments from the agenda
3035 buffer. The commands available in the Agenda buffer are listed in
3036 *Note Agenda commands::.
3040 * Calendar/Diary integration:: Integrating Anniversaries and more
3043 File: org, Node: Calendar/Diary integration, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
3045 8.3.1 Calendar/Diary integration
3046 --------------------------------
3048 Emacs contains the calendar and diary by Edward M. Reingold. The
3049 calendar displays a three-month calendar with holidays from different
3050 countries and cultures. The diary allows you to keep track of
3051 anniversaries, lunar phases, sunrise/set, recurrent appointments
3052 (weekly, monthly) and more. In this way, it is quite complementary to
3053 Org-mode. It can be very useful to combine output from Org-mode with
3056 In order to include entries from the Emacs diary into Org-mode's
3057 agenda, you only need to customize the variable
3059 (setq org-agenda-include-diary t)
3061 After that, everything will happen automatically. All diary entries
3062 including holidays, anniversaries etc will be included in the agenda
3063 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3064 the agenda buffer to jump to the diary file in order to edit existing
3065 diary entries. The `i' command to insert new entries for the current
3066 date works in the agenda buffer, as well as the commands `S', `M', and
3067 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3068 to other calendars, respectively. `c' can be used to switch back and
3069 forth between calendar and agenda.
3072 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
3074 8.4 The global TODO list
3075 ========================
3077 The global TODO list contains all unfinished TODO items, formatted and
3078 collected into a single place.
3081 Show the global TODO list. This collects the TODO items from all
3082 agenda files (*note Agenda views::) into a single buffer. The
3083 buffer is in `agenda-mode', so there are commands to examine and
3084 manipulate the TODO entries directly from that buffer (*note
3088 Like the above, but allows selection of a specific TODO keyword.
3089 You can also do this by specifying a prefix argument to `C-c a t'.
3090 With a `C-u' prefix you are prompted for a keyword. With a
3091 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
3092 `r' key in the agenda buffer regenerates it, and you can give a
3093 prefix argument to this command to change the selected TODO
3094 keyword, for example `3 r'. If you often need a search for a
3095 specific keyword, define a custom command for it (*note Agenda
3097 Matching specific TODO keywords can also be done as part of a tags
3098 search (*note Tag searches::).
3100 Remote editing of TODO items means that you can change the state of a
3101 TODO entry with a single key press. The commands available in the TODO
3102 list are described in *Note Agenda commands::.
3104 Normally the global todo list simply shows all headlines with TODO
3105 keywords. This list can become very long. There are two ways to keep
3107 - Some people view a TODO item that has been _scheduled_ for
3108 execution (*note Time stamps::) as no longer _open_. Configure the
3109 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3110 items from the global TODO list.
3112 - TODO items may have sublevels to break up the task into subtasks.
3113 In such cases it may be enough to list only the highest level TODO
3114 headline and omit the sublevels from the global list. Configure
3115 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3118 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
3120 8.5 Matching headline tags
3121 ==========================
3123 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3124 you can select headlines based on the tags that apply to them and
3125 collect them into an agenda buffer.
3128 Produce a list of all headlines that match a given set of tags.
3129 The command prompts for a selection criterion, which is a boolean
3130 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3131 `WORK|HOME' (*note Tags::). If you often need a specific search,
3132 define a custom command for it (*note Agenda dispatcher::).
3135 Like `C-c a m', but only select headlines that are also TODO items
3136 and force checking subitems (see variable
3137 `org-tags-match-list-sublevels'). Matching specific todo keywords
3138 together with a tags match is also possible, see *Note Tag
3141 The commands available in the tags list are described in *Note
3145 File: org, Node: Timeline, Next: Presentation and sorting, Prev: Matching headline tags, Up: Agenda views
3147 8.6 Timeline for a single file
3148 ==============================
3150 The timeline summarizes all time-stamped items from a single Org-mode
3151 file in a _time-sorted view_. The main purpose of this command is to
3152 give an overview over events in a project.
3155 Show a time-sorted view of the org file, with all time-stamped
3156 items. When called with a `C-u' prefix, all unfinished TODO
3157 entries (scheduled or not) are also listed under the current date.
3159 The commands available in the timeline buffer are listed in *Note
3163 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Timeline, Up: Agenda views
3165 8.7 Presentation and sorting
3166 ============================
3168 Before displaying items in an agenda view, Org-mode visually prepares
3169 the items and sorts them. Each item occupies a single line. The line
3170 starts with a _prefix_ that contains the _category_ (*note
3171 Categories::) of the item and other important information. You can
3172 customize the prefix using the option `org-agenda-prefix-format'. The
3173 prefix is followed by a cleaned-up version of the outline headline
3174 associated with the item.
3178 * Categories:: Not all tasks are equal
3179 * Time-of-day specifications:: How the agenda knows the time
3180 * Sorting of agenda items:: The order of things
3183 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3188 The category is a broad label assigned to each agenda item. By default,
3189 the category is simply derived from the file name, but you can also
3190 specify it with a special line in the buffer, like this:
3194 If there are several such lines in a file, each specifies the
3195 category for the text below it (but the first category also applies to
3196 any text before the first CATEGORY line). The display in the agenda
3197 buffer looks best if the category is not longer than 10 characters.
3200 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3202 8.7.2 Time-of-Day Specifications
3203 --------------------------------
3205 Org-mode checks each agenda item for a time-of-day specification. The
3206 time can be part of the time stamp that triggered inclusion into the
3207 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3208 specified with two time stamps, like
3209 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3211 In the headline of the entry itself, a time(range) may also appear as
3212 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3213 Emacs diary (*note Calendar/Diary integration::), time specifications
3214 in diary entries are recognized as well.
3216 For agenda display, Org-mode extracts the time and displays it in a
3217 standard 24 hour format as part of the prefix. The example times in
3218 the previous paragraphs would end up in the agenda like this:
3220 8:30-13:00 Arthur Dent lies in front of the bulldozer
3221 12:45...... Ford Prefect arrives and takes Arthur to the pub
3222 19:00...... The Vogon reads his poem
3223 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3225 If the agenda is in single-day mode, or for the display of today, the
3226 timed entries are embedded in a time grid, like
3228 8:00...... ------------------
3229 8:30-13:00 Arthur Dent lies in front of the bulldozer
3230 10:00...... ------------------
3231 12:00...... ------------------
3232 12:45...... Ford Prefect arrives and takes Arthur to the pub
3233 14:00...... ------------------
3234 16:00...... ------------------
3235 18:00...... ------------------
3236 19:00...... The Vogon reads his poem
3237 20:00...... ------------------
3238 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3240 The time grid can be turned on and off with the variable
3241 `org-agenda-use-time-grid', and can be configured with
3242 `org-agenda-time-grid'.
3245 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3247 8.7.3 Sorting of agenda items
3248 -----------------------------
3250 Before being inserted into a view, the items are sorted. How this is
3251 done depends on the type of view.
3252 * For the daily/weekly agenda, the items for each day are sorted.
3253 The default order is to first collect all items containing an
3254 explicit time-of-day specification. These entries will be shown
3255 at the beginning of the list, as a _schedule_ for the day. After
3256 that, items remain grouped in categories, in the sequence given by
3257 `org-agenda-files'. Within each category, items are sorted by
3258 priority (*note Priorities::), which is composed of the base
3259 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3260 plus additional increments for overdue scheduled or deadline items.
3262 * For the TODO list, items remain in the order of categories, but
3263 within each category, sorting takes place according to priority
3264 (*note Priorities::).
3266 * For tags matches, items are not sorted at all, but just appear in
3267 the sequence in which they are found in the agenda files.
3269 Sorting can be customized using the variable
3270 `org-agenda-sorting-strategy'.
3273 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3275 8.8 Commands in the agenda buffer
3276 =================================
3278 Entries in the agenda buffer are linked back to the org file or diary
3279 file where they originate. You are not allowed to edit the agenda
3280 buffer itself, but commands are provided to show and jump to the
3281 original entry location, and to edit the org-files "remotely" from the
3282 agenda buffer. In this way, all information is stored only once,
3283 removing the risk that your agenda and note files may diverge.
3285 Some commands can be executed with mouse clicks on agenda lines. For
3286 the other commands, the cursor needs to be in the desired line.
3292 Next line (same as <up>).
3295 Previous line (same as <down>).
3302 Display the original location of the item in another window.
3305 Display original location and recenter that window.
3310 Go to the original location of the item in another window. Under
3311 Emacs 22, `mouse-1' will also works for this.
3314 Go to the original location of the item and delete other windows.
3317 Toggle Follow mode. In Follow mode, as you move the cursor through
3318 the agenda buffer, the other window always shows the corresponding
3319 location in the org file. The initial setting for this mode in new
3320 agenda buffers can be set with the variable
3321 `org-agenda-start-with-follow-mode'.
3324 Toggle Logbook mode. In Logbook mode, entries that where marked
3325 DONE while logging was on (variable `org-log-done') are shown in
3326 the agenda, as are entries that have been clocked on that day.
3332 Delete other windows.
3335 Switch to weekly view (7 days displayed together).
3338 Switch to daily view (just one day displayed).
3341 Toggle the inclusion of diary entries. See *Note Calendar/Diary
3345 Toggle the time grid on and off. See also the variables
3346 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3349 Recreate the agenda buffer, for example to reflect the changes
3350 after modification of the time stamps of items with S-<left> and
3351 S-<right>. When the buffer is the global todo list, a prefix
3352 argument is interpreted to create a selective list for a specific
3356 Save all Org-mode buffers in the current Emacs session.
3359 Display the following `org-agenda-ndays' days. For example, if
3360 the display covers a week, switch to the following week. With
3361 prefix arg, go forward that many times `org-agenda-ndays' days.
3364 Display the previous dates.
3376 Change the TODO state of the item, both in the agenda and in the
3380 Delete the current agenda item along with the entire subtree
3381 belonging to it in the original Org-mode file. If the text to be
3382 deleted remotely is longer than one line, the kill needs to be
3383 confirmed by the user. See variable `org-agenda-confirm-kill'.
3386 Archive the subtree corresponding to the current headline.
3389 Show all tags associated with the current item. Because of
3390 inheritance, this may be more than the tags listed in the line
3394 Set tags for the current headline.
3397 Toggle the ARCHIVE tag for the current headline.
3400 Set the priority for the current item. Org-mode prompts for the
3401 priority character. If you reply with <SPC>, the priority cookie
3402 is removed from the entry.
3405 Display weighted priority of current item.
3409 Increase the priority of the current item. The priority is
3410 changed in the original buffer, but the agenda is not resorted.
3411 Use the `r' key for this.
3415 Decrease the priority of the current item.
3421 Set a deadline for this item.
3424 Change the time stamp associated with the current line by one day
3425 into the future. With prefix argument, change it by that many
3426 days. For example, `3 6 5 S-<right>' will change it by a year.
3427 The stamp is changed in the original org file, but the change is
3428 not directly reflected in the agenda buffer. Use the `r' key to
3432 Change the time stamp associated with the current line by one day
3436 Change the time stamp associated with the current line to today.
3437 The key `>' has been chosen, because it is the same as `S-.' on my
3441 Start the clock on the current item. If a clock is running
3442 already, it is stopped first.
3445 Stop the previously started clock.
3448 Cancel the currently running clock.
3454 Open the Emacs calendar and move to the date at the agenda cursor.
3457 When in the calendar, compute and show the Org-mode agenda for the
3461 Insert a new entry into the diary. Prompts for the type of entry
3462 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3463 new entry in the diary, just as `i d' etc. would do in the
3464 calendar. The date is taken from the cursor position.
3467 Show the phases of the moon for the three months around current
3471 Show sunrise and sunset times. The geographical location must be
3472 set with calendar variables, see documentation of the Emacs
3476 Convert the date at cursor into many other cultural and historic
3480 Show holidays for three month around the cursor date.
3483 Export a single iCalendar file containing entries from all agenda
3490 Quit agenda, remove the agenda buffer.
3493 Exit agenda, remove the agenda buffer and all buffers loaded by
3494 Emacs for the compilation of the agenda. Buffers created by the
3495 user to visit org files will not be removed.
3499 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
3501 8.9 Custom agenda views
3502 =======================
3504 Custom agenda commands serve two purposes: to store and quickly access
3505 frequently used TODO and tags searches, and to create special composite
3506 agenda buffers. Custom agenda commands will be accessible through the
3507 dispatcher (*note Agenda dispatcher::), just like the default commands.
3511 * Storing searches:: Type once, use often
3512 * Block agenda:: All the stuff you need in a single buffer
3513 * Setting Options:: Changing the rules
3514 * Batch processing:: Agenda views from the command line
3517 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
3519 8.9.1 Storing searches
3520 ----------------------
3522 The first application of custom searches is the definition of keyboard
3523 shortcuts for frequently used searches, either creating an agenda
3524 buffer, or a sparse tree (the latter covering of course only the current
3525 buffer). Custom commands are configured in the variable
3526 `org-agenda-custom-commands'. You can customize this variable, for
3527 example by pressing `C-c a C'. You can also directly set it with Emacs
3528 Lisp in `.emacs'. The following example contains all valid search
3531 (setq org-agenda-custom-commands
3532 '(("w" todo "WAITING")
3533 ("W" todo-tree "WAITING")
3534 ("u" tags "+BOSS-URGENT")
3535 ("v" tags-todo "+BOSS-URGENT")
3536 ("U" tags-tree "+BOSS-URGENT")
3537 ("f" occur-tree "\\<FIXME\\>")))
3539 The initial single-character string in each entry defines the character
3540 you have to press after the dispatcher command `C-c a' in order to
3541 access the command. The second parameter is the search type, followed
3542 by the string or regular expression to be used for the matching. The
3543 example above will therefore define:
3546 as a global search for TODO entries with `WAITING' as the TODO
3550 as the same search, but only in the current buffer and displaying
3551 the results as a sparse tree
3554 as a global tags search for headlines marked `:BOSS:' but not
3558 as the same search as `C-c a u', but limiting the search to
3559 headlines that are also TODO items
3562 as the same search as `C-c a u', but only in the current buffer and
3563 displaying the result as a sparse tree
3566 to create a sparse tree (again: current buffer only) with all
3567 entries containing the word `FIXME'.
3570 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
3575 Another possibility is the construction of agenda views that comprise
3576 the results of _several_ commands, each of which creates a block in the
3577 agenda buffer. The available commands include `agenda' for the daily
3578 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
3579 todo list (as constructed with `C-c a t'), and the matching commands
3580 discussed above: `todo', `tags', and `tags-todo'. Here are two
3583 (setq org-agenda-custom-commands
3584 '(("h" "Agenda and Home-related tasks"
3588 ("o" "Agenda and Office-related tasks"
3593 This will define `C-c a h' to create a multi-block view for stuff you
3594 need to attend to at home. The resulting agenda buffer will contain
3595 your agenda for the current week, all TODO items that carry the tag
3596 `HOME', and also all lines tagged with `GARDEN'. Finally the command
3597 `C-c a o' provides a similar view for office tasks.
3600 File: org, Node: Setting Options, Next: Batch processing, Prev: Block agenda, Up: Custom agenda views
3602 8.9.3 Setting Options for custom commands
3603 -----------------------------------------
3605 Org-mode contains a number of variables regulating agenda construction
3606 and display. The global variables define the behavior for all agenda
3607 commands, including the custom commands. However, if you want to change
3608 some settings just for a single custom view, you can do so. Setting
3609 options requires inserting a list of variable names and values at the
3610 right spot in `org-agenda-custom-commands'. For example:
3612 (setq org-agenda-custom-commands
3613 '(("w" todo "WAITING"
3614 ((org-agenda-sorting-strategy '(priority-down))
3615 (org-agenda-prefix-format " Mixed: ")))
3616 ("U" tags-tree "+BOSS-URGENT"
3617 ((org-show-following-heading nil)
3618 (org-show-hierarchy-above nil)))))
3620 Now the `C-c a w' command will sort the collected entries only by
3621 priority, and the prefix format is modified to just say ` Mixed:'
3622 instead of giving the category of the entry. The sparse tags tree of
3623 `C-c a U' will now turn out ultra-compact, because neither the headline
3624 hierarchy above the match, nor the headline following the match will be
3627 For command sets creating a block agenda,
3628 `org-agenda-custom-commands' has two separate spots for setting
3629 options. You can add options that should be valid for just a single
3630 command in the set, and options that should be valid for all commands in
3631 the set. The former are just added to the command entry, the latter
3632 must come after the list of command entries. Going back to the block
3633 agenda example (*note Block agenda::), let's change the sorting strategy
3634 for the `C-c a h' commands to `priority-down', but let's sort the
3635 results for GARDEN tags query in the opposite order, `priority-up'.
3636 This would look like this:
3638 (setq org-agenda-custom-commands
3639 '(("h" "Agenda and Home-related tasks"
3642 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
3643 ((org-agenda-sorting-strategy '(priority-down))))
3644 ("o" "Agenda and Office-related tasks"
3649 As you see, the values and parenthesis setting is a little complex.
3650 When in doubt, use the customize interface to set this variable - it
3651 fully supports its structure. Just one caveat: When setting options in
3652 this interface, the _values_ are just lisp expressions. So if the
3653 value is a string, you need to add the double quotes around the value
3657 File: org, Node: Batch processing, Prev: Setting Options, Up: Custom agenda views
3659 8.9.4 Creating agenda views in batch processing
3660 -----------------------------------------------
3662 If you want to print or otherwise reprocess agenda views, it can be
3663 useful to create an agenda from the command line. This is the purpose
3664 of the function `org-batch-agenda'. It takes as a parameter one of the
3665 strings that are the keys in `org-agenda-custom-commands'. For
3666 example, to directly print the current TODO list, you could use
3668 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
3670 You may also modify parameters on the fly like this:
3672 emacs -batch -l ~/.emacs \
3673 -eval '(org-batch-agenda "a" \
3674 org-agenda-ndays 300 \
3675 org-agenda-include-diary nil \
3676 org-agenda-files (quote ("~/org/project.org")))' \
3679 which will produce a 300 day agenda, fully restricted to the Org file
3680 `~/org/projects.org', not even including the diary.
3683 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
3688 Plain ASCII is normally sufficient for almost all note taking. One
3689 exception, however, are scientific notes which need to be able to
3690 contain mathematical symbols and the occasional formula. LaTeX(1) is
3691 widely used to typeset scientific documents. Org-mode supports
3692 embedding LaTeX code into its files, because many academics are used to
3693 read LaTeX source code, and because it can be readily processed into
3694 images for HTML production.
3696 It is not necessary to mark LaTeX macros and code in any special way.
3697 If you observe a few conventions, Org-mode knows how to find it and what
3702 * Math symbols:: TeX macros for symbols and Greek letters
3703 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
3704 * LaTeX fragments:: Complex formulas made easy
3705 * Processing LaTeX fragments:: Previewing LaTeX processing
3706 * CDLaTeX mode:: Speed up entering of formulas
3708 ---------- Footnotes ----------
3710 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3711 Many of the features described here as "LaTeX" are really from TeX, but
3712 for simplicity I am blurring this distinction.
3715 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
3720 You can use LaTeX macros to insert special symbols like `\alpha' to
3721 indicate the Greek letter, or `\to' to indicate an arrow. Completion
3722 for these macros is available, just type `\' and maybe a few letters,
3723 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
3724 Org-mode allows these macros to be present without surrounding math
3725 delimiters, for example:
3727 Angles are written as Greek letters \alpha, \beta and \gamma.
3729 During HTML export (*note HTML export::), these symbols are
3730 translated into the proper syntax for HTML, for the above examples this
3731 is `α' and `→', respectively.
3734 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
3736 9.2 Subscripts and Superscripts
3737 ===============================
3739 Just like in LaTeX, `^' and `_' are used to indicate super- and
3740 subscripts. Again, these can be used without embedding them in
3741 math-mode delimiters. To increase the readability of ASCII text, it is
3742 not necessary (but OK) to surround multi-character sub- and superscripts
3743 with curly braces. For example
3745 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
3746 the sun is R_{sun} = 6.96 x 10^8 m.
3748 To avoid interpretation as raised or lowered text, you can quote `^'
3749 and `_' with a backslash: `\_' and `\^'.
3751 During HTML export (*note HTML export::), subscript and superscripts
3752 are surrounded with `<sub>' and `<sup>' tags, respectively.
3755 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
3760 With symbols, sub- and superscripts, HTML is pretty much at its end when
3761 it comes to representing mathematical formulas(1). More complex
3762 expressions need a dedicated formula processor. To this end, Org-mode
3763 can contain arbitrary LaTeX fragments. It provides commands to preview
3764 the typeset result of these fragments, and upon export to HTML, all
3765 fragments will be converted to images and inlined into the HTML
3766 document. For this to work you need to be on a system with a working
3767 LaTeX installation. You also need the `dvipng' program, available at
3768 `http://sourceforge.net/projects/dvipng/'.
3770 LaTeX fragments don't need any special marking at all. The following
3771 snippets will be identified as LaTeX source code:
3772 * Environments of any kind. The only requirement is that the
3773 `\begin' statement appears on a new line, preceded by only
3776 * Text within the usual LaTeX math delimiters. To avoid conflicts
3777 with currency specifications, single `$' characters are only
3778 recognized as math delimiters if the enclosed text contains at
3779 most two line breaks, is directly attached to the `$' characters
3780 with no whitespace in between, and if the closing `$' is followed
3781 by whitespace or punctuation. For the other delimiters, there is
3782 no such restriction, so when in doubt, use `\(...\)' as inline
3787 \begin{equation} % arbitrary environments,
3788 x=\sqrt{b} % even tables, figures
3789 \end{equation} % etc
3791 If $a^2=b$ and \( b=2 \), then the solution must be
3792 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
3794 If you need any of the delimiter ASCII sequences for other purposes, you
3795 can configure the option `org-format-latex-options' to deselect the
3796 ones you do not wish to have interpreted by the LaTeX converter.
3798 ---------- Footnotes ----------
3800 (1) Yes, there is MathML, but that is not yet fully supported by
3801 many browsers, and there is no decent converter for turning LaTeX of
3802 ASCII representations of formulas into MathML. So for the time being,
3803 converting formulas into images seems the way to go.
3806 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
3808 9.4 Processing LaTeX fragments
3809 ==============================
3811 LaTeX fragments can be processed to produce a preview images of the
3812 typeset expressions:
3815 Produce a preview image of the LaTeX fragment at point and overlay
3816 it over the source code. If there is no fragment at point,
3817 process all fragments in the current entry (between two
3818 headlines). When called with a prefix argument, process the
3819 entire subtree. When called with two prefix arguments, or when
3820 the cursor is before the first headline, process the entire buffer.
3823 Remove the overlay preview images.
3825 During HTML export (*note HTML export::), all LaTeX fragments are
3826 converted into images and inlined into the document if the following
3829 (setq org-export-with-LaTeX-fragments t)
3832 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
3834 9.5 Using CDLaTeX to enter math
3835 ===============================
3837 CDLaTeX-mode is a minor mode that is normally used in combination with a
3838 major LaTeX mode like AUCTeX in order to speed-up insertion of
3839 environments and math templates. Inside Org-mode, you can make use of
3840 some of the features of cdlatex-mode. You need to install `cdlatex.el'
3841 and `texmathp.el' (the latter comes also with AUCTeX) from
3842 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
3843 cdlatex-mode itself under Org-mode, but use the light version
3844 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
3845 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
3848 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
3850 When this mode is enabled, the following features are present (for
3851 more details see the documentation of cdlatex-mode):
3852 * Environment templates can be inserted with `C-c {'.
3854 * The <TAB> key will do template expansion if the cursor is inside a
3855 LaTeX fragment(1). For example, <TAB> will expand `fr' to
3856 `\frac{}{}' and position the cursor correctly inside the first
3857 brace. Another <TAB> will get you into the second brace. Even
3858 outside fragments, <TAB> will expand environment abbreviations at
3859 the beginning of a line. For example, if you write `equ' at the
3860 beginning of a line and press <TAB>, this abbreviation will be
3861 expanded to an `equation' environment. To get a list of all
3862 abbreviations, type `M-x cdlatex-command-help'.
3864 * Pressing `_' and `^' inside a LaTeX fragment will insert these
3865 characters together with a pair of braces. If you use <TAB> to
3866 move out of the braces, and if the braces surround only a single
3867 character or macro, they are removed again (depending on the
3868 variable `cdlatex-simplify-sub-super-scripts').
3870 * Pressing the backquote ``' followed by a character inserts math
3871 macros, also outside LaTeX fragments. If you wait more than 1.5
3872 seconds after the backquote, a help window will pop up.
3874 * Pressing the normal quote `'' followed by another character
3875 modifies the symbol before point with an accent or a font. If you
3876 wait more than 1.5 seconds after the backquote, a help window will
3877 pop up. Character modification will work only inside LaTeX
3878 fragments, outside the quote is normal.
3880 ---------- Footnotes ----------
3882 (1) Org-mode has a method to test if the cursor is inside such a
3883 fragment, see the documentation of the function
3884 `org-inside-LaTeX-fragment-p'.
3887 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
3892 Org-mode documents can be exported into a variety of other formats. For
3893 printing and sharing of notes, ASCII export produces a readable and
3894 simple version of an Org-mode file. HTML export allows you to publish a
3895 notes file on the web, while the XOXO format provides a solid base for
3896 exchange with a broad range of other applications. To incorporate
3897 entries with associated times like deadlines or appointments into a
3898 desktop calendar program like iCal, Org-mode can also produce extracts
3899 in the iCalendar format. Currently Org-mode only supports export, not
3900 import of these different formats.
3902 When exporting, Org-mode uses special conventions to enrich the
3903 output produced. *Note Text interpretation::, for more details.
3906 Dispatcher for export and publishing commands. Displays a
3907 help-window listing the additional key(s) needed to launch an
3908 export or publishing command.
3912 * ASCII export:: Exporting to plain ASCII
3913 * HTML export:: Exporting to HTML
3914 * XOXO export:: Exporting to XOXO
3915 * iCalendar export:: Exporting in iCalendar format
3916 * Text interpretation:: How the exporter looks at the file
3919 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
3924 ASCII export produces a simple and very readable version of an Org-mode
3928 Export as ASCII file. If there is an active region, only the
3929 region will be exported. For an org file `myfile.org', the ASCII
3930 file will be `myfile.txt'. The file will be overwritten without
3934 Export only the visible part of the document.
3936 In the exported version, the first 3 outline levels will become
3937 headlines, defining a general document structure. Additional levels
3938 will be exported as itemized lists. If you want that transition to
3939 occur at a different level, specify it with a prefix argument. For
3944 creates only top level headlines and does the rest as items. When
3945 headlines are converted to items, the indentation of the text following
3946 the headline is changed to fit nicely under the item. This is done with
3947 the assumption that the first bodyline indicates the base indentation of
3948 the body text. Any indentation larger than this is adjusted to preserve
3949 the layout relative to the first line. Should there be lines with less
3950 indentation than the first, these are left alone.
3953 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
3958 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
3959 HTML formatting, in ways similar to John Grubers _markdown_ language,
3960 but with additional support for tables.
3963 Export as HTML file `myfile.html'.
3966 Export as HTML file and open it with a browser.
3971 Export only the visible part of the document.
3973 In the exported version, the first 3 outline levels will become
3974 headlines, defining a general document structure. Additional levels
3975 will be exported as itemized lists. If you want that transition to
3976 occur at a different level, specify it with a prefix argument. For
3981 creates two levels of headings and does the rest as items.
3983 If you want to include HTML tags which should be interpreted as such,
3984 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
3985 always transformed to `<' and `>' in HTML export.
3987 Internal links (*note Internal links::) will continue to work in HTML
3988 files only if they match a dedicated `<<target>>'. Automatic links
3989 created by radio targets (*note Radio targets::) will also work in the
3990 HTML file. Links to external files will still work if the HTML file is
3991 in the same directory as the Org-mode file. Links to other `.org'
3992 files will be translated into HTML links under the assumption that an
3993 HTML version also exists of the linked file. For information related to
3994 linking files while publishing them to a publishing directory see *Note
3997 You can also give style information for the exported file. The HTML
3998 exporter assigns the following CSS classes to appropriate parts of the
3999 document - your style specifications may change these:
4001 .done the DONE keyword
4002 .timestamp time stamp
4003 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4004 .tag tag in a headline
4005 .target target for links
4007 The default style specification can be configured through the option
4008 `org-export-html-style'. If you want to use a file-local style, you
4009 may use file variables, best wrapped into a COMMENT section at the end
4010 of the outline tree. For example:
4012 * COMMENT HTML style specifications
4015 # org-export-html-style: " <style type=\"text/css\">
4016 # p {font-weight: normal; color: gray; }
4017 # h1 {color: black; }
4021 Remember to execute `M-x normal-mode' after changing this to make
4022 the new style visible to Emacs. This command restarts org-mode for the
4023 current buffer and forces Emacs to re-evaluate the local variables
4024 section in the buffer.
4027 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4032 Org-mode contains an exporter that produces XOXO-style output.
4033 Currently, this exporter only handles the general outline structure and
4034 does not interpret any additional Org-mode features.
4037 Export as XOXO file `myfile.html'.
4040 Export only the visible part of the document.
4043 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4045 10.4 iCalendar export
4046 =====================
4048 Some people like to use Org-mode for keeping track of projects, but
4049 still prefer a standard calendar application for anniversaries and
4050 appointments. In this case it can be useful to have deadlines and
4051 other time-stamped items in Org-mode files show up in the calendar
4052 application. Org-mode can export calendar information in the standard
4056 Create iCalendar entries for the current file and store them in
4057 the same directory, using a file extension `.ics'.
4060 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4061 For each of these files, a separate iCalendar file will be
4065 Create a single large iCalendar file from all files in
4066 `org-agenda-files' and write it to the file given by
4067 `org-combined-agenda-icalendar-file'.
4069 How this calendar is best read and updated, depends on the
4070 application you are using. For example, when using iCal under Apple
4071 MacOS X, you could create a new calendar `OrgMode' (the default name
4072 for the calendar created by `C-c C-e c', see the variables
4073 `org-icalendar-combined-name' and
4074 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
4075 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
4076 use AppleScript to make iCal re-read the calendar files each time a new
4077 version of `OrgMode.ics' is produced. Here is the setup needed for
4080 (setq org-combined-agenda-icalendar-file
4081 "~/Library/Calendars/OrgMode.ics")
4082 (add-hook 'org-after-save-iCalendar-file-hook
4085 "osascript -e 'tell application \"iCal\" to reload calendars'")))
4088 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4090 10.5 Text interpretation by the exporter
4091 ========================================
4093 The exporter backends interpret additional structure in the Org-mode
4094 file in order to produce better output.
4098 * Comment lines:: Some lines will not be exported
4099 * Enhancing text:: Subscripts, symbols and more
4100 * Export options:: How to influence the export settings
4103 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
4105 10.5.1 Comment lines
4106 --------------------
4108 Lines starting with `#' in column zero are treated as comments and will
4109 never be exported. Also entire subtrees starting with the word
4110 `COMMENT' will never be exported. Finally, any text before the first
4111 headline will not be exported either.
4114 Toggle the COMMENT keyword at the beginning of an entry.
4117 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
4119 10.5.2 Enhancing text for export
4120 --------------------------------
4122 Some of the export backends of Org-mode allow for sophisticated text
4123 formatting, this is true in particular for the HTML backend. Org-mode
4124 has a number of typing conventions that allow to produce a richly
4127 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
4128 enumerator will be recognized and transformed if the backend
4129 supports lists. See *Note Plain lists::.
4131 * You can make words *bold*, /italic/, _underlined_, `=code=', and
4134 * Many TeX macros and entire LaTeX fragments are converted into HTML
4135 entities or images (*note Embedded LaTeX::).
4137 * Tables are transformed into native tables under the exporter, if
4138 the export backend supports this. Data fields before the first
4139 horizontal separator line will be formatted as table header fields.
4141 * If a headline starts with the word `QUOTE', the text below the
4142 headline will be typeset as fixed-width, to allow quoting of
4143 computer codes etc. Lines starting with `:' are also typeset in
4146 Toggle fixed-width for entry (QUOTE) or region, see below.
4148 * A double backslash _at the end of a line_ enforces a line break at
4151 If these conversions conflict with your habits of typing ASCII text,
4152 they can all be turned off with corresponding variables (see the
4153 customization group `org-export-general', and the following section
4154 which explains how to set export options with special lines in a buffer.
4157 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
4159 10.5.3 Export options
4160 ---------------------
4162 The exporter recognizes special lines in the buffer which provide
4163 additional information. These lines may be put anywhere in the file.
4164 The whole set of lines can be inserted into the buffer with `C-c C-e
4165 t'. For individual lines, a good way to make sure the keyword is
4166 correct is to type `#+' and then use `M-<TAB>' completion (*note
4170 Insert template with export options, see example below.
4172 #+TITLE: the title to be shown (default is the buffer name)
4173 #+AUTHOR: the author (default taken from `user-full-name')
4174 #+EMAIL: his/her email address (default from `user-mail-address')
4175 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
4176 #+TEXT: Some descriptive text to be inserted at the beginning.
4177 #+TEXT: Several lines may be given.
4178 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
4180 The OPTIONS line is a compact form to specify export settings. Here
4182 H: set the number of headline levels for export
4183 num: turn on/off section-numbers
4184 toc: turn on/off table of contents
4185 \n: turn on/off linebreak-preservation
4186 @: turn on/off quoted HTML tags
4187 :: turn on/off fixed-width sections
4188 |: turn on/off tables
4189 ^: turn on/off TeX-like syntax for sub- and superscripts.
4190 *: turn on/off emphasized text (bold, italic, underlined)
4191 TeX: turn on/off simple TeX macros in plain text
4192 LaTeX: turn on/off LaTeX fragments
4195 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
4200 Org-mode includes(1) a publishing management system that allows you to
4201 configure automatic HTML conversion of _projects_ composed of
4202 interlinked org files. This system is called _org-publish_. You can
4203 also configure org-publish to automatically upload your exported HTML
4204 pages and related attachments, such as images and source code files, to
4205 a web server. Org-publish turns org-mode into a web-site authoring
4208 Org-publish has been contributed to Org-mode by David O'Toole.
4212 * Configuration:: Defining projects
4213 * Sample configuration:: Example projects
4214 * Triggering publication:: Publication commands
4216 ---------- Footnotes ----------
4218 (1) `org-publish.el' is not yet part of Emacs, so if you are using
4219 `org.el' as it comes with Emacs, you need to download this file
4220 separately. Also make sure org.el is at least version 4.27.
4223 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
4228 Publishing needs significant configuration to specify files, destination
4229 and many other properties of a project.
4233 * Project alist:: The central configuration variable
4234 * Sources and destinations:: From here to there
4235 * Selecting files:: What files are part of the project?
4236 * Publishing action:: Setting the function doing the publishing
4237 * Publishing options:: Tweaking HTML export
4238 * Publishing links:: Which links keep working after publishing?
4239 * Project page index:: Publishing a list of project files
4242 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
4244 11.1.1 The variable `org-publish-project-alist'
4245 -----------------------------------------------
4247 Org-publish is configured almost entirely through setting the value of
4248 one variable, called `org-publish-project-alist'. Each element of the
4249 list configures one project, and may be in one of the two following
4252 ("project-name" :property value :property value ...)
4256 ("project-name" :components ("project-name" "project-name" ...))
4258 In both cases, projects are configured by specifying property values.
4259 A project defines the set of files that will be published, as well as
4260 the publishing configuration to use when publishing those files. When
4261 a project takes the second form listed above, the individual members of
4262 the "components" property are taken to be components of the project,
4263 which group together files requiring different publishing options. When
4264 you publish such a "meta-project" all the components will also publish.
4267 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
4269 11.1.2 Sources and destinations for files
4270 -----------------------------------------
4272 Most properties are optional, but some should always be set. In
4273 particular, org-publish needs to know where to look for source files,
4274 and where to put published files.
4276 `:base-directory' Directory containing publishing source files
4277 `:publishing-directory'Directory (possibly remote) where output files
4279 `:preparation-function'Function called before starting publishing
4280 process, for example to run `make' for updating
4281 files to be published.
4284 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
4286 11.1.3 Selecting files
4287 ----------------------
4289 By default, all files with extension `.org' in the base directory are
4290 considered part of the project. This can be modified by setting the
4292 `:base-extension' Extension (without the dot!) of source files. This
4293 actually is a regular expression.
4294 `:exclude' Regular expression to match file names that should
4295 not be published, even though they have been selected
4296 on the basis of their extension.
4297 `:include' List of files to be included regardless of
4298 `:base-extension' and `:exclude'.
4301 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
4303 11.1.4 Publishing Action
4304 ------------------------
4306 Publishing means that a file is copied to the destination directory and
4307 possibly transformed in the process. The default transformation is to
4308 export Org-mode files as HTML files, and this is done by the function
4309 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
4310 export::). Other files like images only need to be copied to the
4311 publishing destination. For non-Org-mode files, you need to specify
4312 the publishing function.
4314 `:publishing-function' Function executing the publication of a file.
4315 This may also be a list of functions, which will
4316 all be called in turn.
4318 The function must accept two arguments: a property list containing at
4319 least a `:publishing-directory' property, and the name of the file to
4320 be published. It should take the specified file, make the necessary
4321 transformation (if any) and place the result into the destination
4322 folder. You can write your own publishing function, but `org-publish'
4323 provides one for attachments (files that only need to be copied):
4324 `org-publish-attachment'.
4327 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
4329 11.1.5 Options for the HTML exporter
4330 ------------------------------------
4332 The property list can be used to set many export options for the HTML
4333 exporter. In most cases, these properties correspond to user variables
4334 in Org-mode. The table below lists these properties along with the
4335 variable they belong to. See the documentation string for the
4336 respective variable for details.
4338 `:language' `org-export-default-language'
4339 `:headline-levels' `org-export-headline-levels'
4340 `:section-numbers' `org-export-with-section-numbers'
4341 `:table-of-contents' `org-export-with-toc'
4342 `:archived-trees' `org-export-with-archived-trees'
4343 `:emphasize' `org-export-with-emphasize'
4344 `:sub-superscript' `org-export-with-sub-superscripts'
4345 `:TeX-macros' `org-export-with-TeX-macros'
4346 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
4347 `:fixed-width' `org-export-with-fixed-width'
4348 `:timestamps' `org-export-with-timestamps'
4350 `:tags' `org-export-with-tags'
4352 `:tables' `org-export-with-tables'
4353 `:table-auto-headline' `org-export-highlight-first-table-line'
4354 `:style' `org-export-html-style'
4355 `:convert-org-links' `org-export-html-link-org-files-as-html'
4356 `:inline-images' `org-export-html-inline-images'
4357 `:expand-quoted-html' `org-export-html-expand'
4358 `:timestamp' `org-export-html-with-timestamp'
4359 `:publishing-directory'`org-export-publishing-directory'
4360 `:preamble' `org-export-html-preamble'
4361 `:postamble' `org-export-html-postamble'
4362 `:auto-preamble' `org-export-html-auto-preamble'
4363 `:auto-postamble' `org-export-html-auto-postamble'
4364 `:author' `user-full-name'
4365 `:email' `user-mail-address'
4367 When a property is given a value in org-publish-project-alist, its
4368 setting overrides the value of the corresponding user variable (if any)
4369 during publishing. options set within a file (*note Export options::),
4370 however, override everything.
4373 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
4375 11.1.6 Links between published files
4376 ------------------------------------
4378 To create a link from one Org-mode file to another, you would use
4379 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
4380 (*note Hyperlinks::). Upon publishing this link becomes a link to
4381 `foo.html'. In this way, you can interlink the pages of your "org web"
4382 project and the links will work as expected when you publish them to
4385 You may also link to related files, such as images. Provided you are
4386 careful with relative pathnames, and provided you have also configured
4387 org-publish to upload the related files, these links will work too.
4388 *Note Complex example:: for an example of this usage.
4390 Sometime an Org-mode file to be published may contain links that are
4391 only valid in your production environment, but not in the publishing
4392 location. In this case, use the property
4394 `:link-validation-function' Function to validate links
4396 to define a function for checking link validity. This function must
4397 accept two arguments, the file name and a directory relative to which
4398 the file name is interpreted in the production environment. If this
4399 function returns `nil', then the HTML generator will only insert a
4400 description into the HTML file, but no link. One option for this
4401 function is `org-publish-validate-link' which checks if the given file
4402 is part of any project in `org-publish-project-alist'.
4405 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
4407 11.1.7 Project page index
4408 -------------------------
4410 The following properties may be used to control publishing of an index
4411 of files or summary page for a given project.
4413 `:auto-index' When non-nil, publish an index during
4414 org-publish-current-project or org-publish-all.
4415 `:index-filename' Filename for output of index. Defaults to `index.org'
4416 (which becomes `index.html').
4417 `:index-title' Title of index page. Defaults to name of file.
4418 `:index-function' Plugin function to use for generation of index.
4419 Defaults to `org-publish-org-index', which generates
4420 a plain list of links to all files in the project.
4423 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
4425 11.2 Sample configuration
4426 =========================
4428 Below we provide two example configurations. The first one is a simple
4429 project publishing only a set of Org-mode files. The second example is
4430 more complex, with a multi-component project.
4434 * Simple example:: One-component publishing
4435 * Complex example:: A multi-component publishing example
4438 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
4440 11.2.1 Example: simple publishing configuration
4441 -----------------------------------------------
4443 This example publishes a set of Org-mode files to the `public_html'
4444 directory on the local machine.
4446 (setq org-publish-project-alist
4448 :base-directory "~/org/"
4449 :publishing-directory "~/public_html"
4450 :section-numbers nil
4451 :table-of-contents nil
4452 :style "<link rel=stylesheet
4453 href=\"../other/mystyle.css\"
4454 type=\"text/css\">")))
4457 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
4459 11.2.2 Example: complex publishing configuration
4460 ------------------------------------------------
4462 This more complicated example publishes an entire website, including
4463 org files converted to HTML, image files, emacs lisp source code, and
4464 stylesheets. The publishing-directory is remote and private files are
4467 To ensure that links are preserved, care should be taken to replicate
4468 your directory structure on the web server, and to use relative file
4469 paths. For example, if your org files are kept in `~/org' and your
4470 publishable images in `~/images', you'd link to an image with
4471 file:../images/myimage.png
4472 On the web server, the relative path to the image should be the
4473 same. You can accomplish this by setting up an "images" folder in the
4474 right place on the webserver, and publishing images to it.
4476 (setq org-publish-project-alist
4478 :base-directory "~/org/"
4479 :base-extension "org"
4480 :publishing-directory "/ssh:user@host:~/html/notebook/"
4481 :publishing-function org-publish-org-to-html
4482 :exclude "PrivatePage.org" ;; regexp
4484 :section-numbers nil
4485 :table-of-contents nil
4486 :style "<link rel=stylesheet
4487 href=\"../other/mystyle.css\" type=\"text/css\">"
4489 :auto-postamble nil)
4492 :base-directory "~/images/"
4493 :base-extension "jpg\\|gif\\|png"
4494 :publishing-directory "/ssh:user@host:~/html/images/"
4495 :publishing-function org-publish-attachment)
4498 :base-directory "~/other/"
4499 :base-extension "css\\|el"
4500 :publishing-directory "/ssh:user@host:~/html/other/"
4501 :publishing-function org-publish-attachment)
4502 ("website" :components ("orgfiles" "images" "other"))))
4505 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
4507 11.3 Triggering publication
4508 ===========================
4510 Once org-publish is properly configured, you can publish with the
4511 following functions:
4514 Prompt for a specific project and publish all files that belong to
4518 Publish the project containing the current file.
4521 Publish only the current file.
4524 Publish all projects.
4526 Org uses timestamps to track when a file has changed. The above
4527 functions normally only publish changed files. You can override this and
4528 force publishing of all files by giving a prefix argument.
4531 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
4538 * Completion:: M-TAB knows what you need
4539 * Customization:: Adapting Org-mode to your taste
4540 * In-buffer settings:: Overview of the #+KEYWORDS
4541 * The very busy C-c C-c key:: When in doubt, press C-c C-c
4542 * Clean view:: Getting rid of leading stars in the outline
4543 * TTY keys:: Using Org-mode on a tty
4544 * Interaction:: Other Emacs packages
4545 * Bugs:: Things which do not work perfectly
4548 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
4553 Org-mode supports in-buffer completion. This type of completion does
4554 not make use of the minibuffer. You simply type a few letters into the
4555 buffer and use the key to complete text right there.
4558 Complete word at point
4559 * At the beginning of a headline, complete TODO keywords.
4561 * After `\', complete TeX symbols supported by the exporter.
4563 * After `*', complete headlines in the current buffer so that
4564 they can be used in search links like `[[*find this
4567 * After `:', complete tags. The list of tags is taken from the
4568 variable `org-tag-alist' (possibly set through the `#+TAGS'
4569 in-buffer option, *note Setting tags::), or it is created
4570 dynamically from all tags used in the current buffer.
4572 * After `[', complete link abbreviations (*note Link
4575 * After `#+', complete the special keywords like `TYP_TODO' or
4576 `OPTIONS' which set file-specific options for Org-mode. When
4577 the option keyword is already complete, pressing `M-<TAB>'
4578 again will insert example settings for this keyword.
4580 * In the line after `#+STARTUP: ', complete startup keywords,
4581 i.e. valid keys for this line.
4583 * Elsewhere, complete dictionary words using ispell.
4586 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
4591 There are more than 100 variables that can be used to customize
4592 Org-mode. For the sake of compactness of the manual, we are not
4593 describing the variables here. A structured overview of customization
4594 variables is available with `M-x org-customize'. Or select `Browse Org
4595 Group' from the `Org->Customization' menu. Many settings can also be
4596 activated on a per-file basis, by putting special lines into the buffer
4597 (*note In-buffer settings::).
4600 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
4602 12.3 Summary of in-buffer settings
4603 ==================================
4605 Org-mode uses special lines in the buffer to define settings on a
4606 per-file basis. These lines start with a `#+' followed by a keyword, a
4607 colon, and then individual words defining a setting. Several setting
4608 words can be in the same line, but you can also have multiple lines for
4609 the keyword. While these settings are described throughout the manual,
4610 here is a summary. After changing any of those lines in the buffer,
4611 press `C-c C-c' with the cursor still in the line to activate the
4612 changes immediately. Otherwise they become effective only when the
4613 file is visited again in a new Emacs session.
4616 This line sets options to be used at startup of org-mode, when an
4617 Org-mode file is being visited. The first set of options deals
4618 with the initial visibility of the outline tree. The
4619 corresponding variable for global default settings is
4620 `org-startup-folded', with a default value `t', which means
4622 overview top-level headlines only
4623 content all headlines
4624 showall no folding at all, show everything
4625 Then there are options for aligning tables upon visiting a file.
4626 This is useful in files containing narrowed table columns. The
4627 corresponding variable is `org-startup-align-all-tables', with a
4628 default value `nil'.
4629 align align all tables
4630 noalign don't align tables on startup
4631 Logging when a TODO item is marked DONE (variable `org-log-done')
4632 can be configured using these options.
4633 logging record a timestamp when an item is marked DONE
4634 nologging don't record when items are marked DONE
4635 Here are the options for hiding leading stars in outline headings.
4636 The corresponding variables are `org-hide-leading-stars' and
4637 `org-odd-levels-only', both with a default setting `nil' (meaning
4638 `showstars' and `oddeven').
4639 hidestars make all but one of the stars starting a headline invisible.
4640 showstars show all stars starting a headline
4641 odd allow only odd outline levels (1,3,...)
4642 oddeven allow all outline levels
4643 To turn on custom format overlays over time stamps (variables
4644 `org-put-time-stamp-overlays' and
4645 `org-time-stamp-overlay-formats'), use
4646 customtime overlay custom time format
4648 `#+SEQ_TODO: #+TYP_TODO:'
4649 These lines set the TODO keywords and their interpretation in the
4650 current file. The corresponding variables are `org-todo-keywords'
4651 and `org-todo-interpretation'.
4653 `#+TAGS: TAG1(c1) TAG2(c2)'
4654 These lines (several such lines are allowed) specify the legal
4655 tags in this file, and (potentially) the corresponding _fast tag
4656 selection_ keys. The corresponding variable is `org-tag-alist'.
4658 `#+LINK: linkword replace'
4659 These lines (several are allowed) specify link abbreviations.
4660 *Note Link abbreviations::. The corresponding variable is
4661 `org-link-abbrev-alist'.
4664 This line sets the category for the agenda file. The category
4665 applies for all subsequent lines until the next `#+CATEGORY' line,
4666 or the end of the file.
4669 This line contains the formulas for the table directly above the
4672 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
4673 These lines provide settings for exporting files. For more
4674 details see *Note Export options::.
4677 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
4679 12.4 The very busy C-c C-c key
4680 ==============================
4682 The key `C-c C-c' has many purposes in org-mode, which are all
4683 mentioned scattered throughout this manual. One specific function of
4684 this key is to add _tags_ to a headline (*note Tags::). In many other
4685 circumstances it means something like _Hey Org-mode, look here and
4686 update according to what you see here_. Here is a summary of what this
4687 means in different contexts.
4689 - If there are highlights in the buffer from the creation of a sparse
4690 tree, or from clock display, remove these highlights.
4692 - If the cursor is in one of the special `#+KEYWORD' lines, this
4693 triggers scanning the buffer for these lines and updating the
4696 - If the cursor is inside a table, realign the table. This command
4697 works even if the automatic table editor has been turned off.
4699 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
4702 - If the cursor is inside a table created by the `table.el' package,
4703 activate that table.
4705 - If the current buffer is a remember buffer, close the note and
4706 file it. With a prefix argument, file it, without further
4707 interaction, to the default location.
4709 - If the cursor is on a `<<<target>>>', update radio targets and
4710 corresponding links in this buffer.
4712 - If the cursor is in a plain list item with a checkbox, toggle the
4713 status of the checkbox.
4715 - If the cursor is on a numbered item in a plain list, renumber the
4719 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
4721 12.5 A cleaner outline view
4722 ===========================
4724 Some people find it noisy and distracting that the Org-mode headlines
4725 are starting with a potentially large number of stars. For example the
4726 tree from *Note Headlines:::
4728 * Top level headline
4734 * Another top level headline
4736 Unfortunately this is deeply ingrained into the code of Org-mode and
4737 cannot be easily changed. You can, however, modify the display in such
4738 a way that all leading stars become invisible and the outline more easy
4739 to read. To do this, customize the variable `org-hide-leading-stars'
4742 (setq org-hide-leading-stars t)
4744 or change this on a per-file basis with one of the lines (anywhere in
4747 #+STARTUP: showstars
4748 #+STARTUP: hidestars
4750 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
4753 With stars hidden, the tree becomes:
4755 * Top level headline
4761 * Another top level headline
4763 Note that the leading stars are not truly replaced by whitespace, they
4764 are only fontified with the face `org-hide' that uses the background
4765 color as font color. If you are not using either white or black
4766 background, you may have to customize this face to get the wanted
4767 effect. Another possibility is to set this font such that the extra
4768 stars are almost invisible, for example using the color `grey90' on a
4771 Things become cleaner still if you skip all the even levels and use
4772 only odd levels 1, 3, 5..., effectively adding two stars to go from one
4773 outline level to the next:
4775 * Top level headline
4781 * Another top level headline
4783 In order to make the structure editing and export commands handle this
4784 convention correctly, use
4786 (setq org-odd-levels-only t)
4788 or set this on a per-file basis with one of the following lines (don't
4789 forget to press `C-c C-c' with the cursor in the startup line to
4790 activate changes immediately).
4795 You can convert an Org-mode file from single-star-per-level to the
4796 double-star-per-level convention with `M-x org-convert-to-odd-levels
4797 RET' in that file. The reverse operation is `M-x
4798 org-convert-to-oddeven-levels'.
4801 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
4803 12.6 Using org-mode on a tty
4804 ============================
4806 Org-mode uses a number of keys that are not accessible on a tty. This
4807 applies to most special keys like cursor keys, <TAB> and <RET>, when
4808 these are combined with modifier keys like <Meta> and/or <Shift>.
4809 Org-mode uses these bindings because it needs to provide keys for a
4810 large number of commands, and because these keys appeared particularly
4811 easy to remember. In order to still be able to access the core
4812 functionality of Org-mode on a tty, alternative bindings are provided.
4813 Here is a complete list of these bindings, which are obviously more
4814 cumbersome to use. Note that sometimes a work-around can be better.
4815 For example changing a time stamp is really only fun with `S-<cursor>'
4816 keys. On a tty you would rather use `C-c .' to re-insert the
4819 Default Alternative 1 Alternative 2
4820 `S-<TAB>' `C-u <TAB>'
4821 `M-<left>' `C-c C-x l' `<Esc> <left>'
4822 `M-S-<left>'`C-c C-x L'
4823 `M-<right>' `C-c C-x r' `<Esc>
4825 `M-S-<right>'`C-c C-x R'
4826 `M-<up>' `C-c C-x u' `<Esc> <up>'
4827 `M-S-<up>' `C-c C-x U'
4828 `M-<down>' `C-c C-x d' `<Esc> <down>'
4829 `M-S-<down>'`C-c C-x D'
4830 `S-<RET>' `C-c C-x c'
4831 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
4832 `M-S-<RET>' `C-c C-x M'
4835 `S-<right>' `C-c C-x
4843 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
4845 12.7 Interaction with other packages
4846 ====================================
4848 Org-mode lives in the world of GNU Emacs and interacts in various ways
4849 with other code out there.
4853 * Cooperation:: Packages Org-mode cooperates with
4854 * Conflicts:: Packages that lead to conflicts
4857 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
4859 12.7.1 Packages that Org-mode cooperates with
4860 ---------------------------------------------
4862 `calc.el' by Dave Gillespie
4863 Org-mode uses the calc package for implementing spreadsheet
4864 functionality in its tables (*note Table calculations::).
4865 Org-modes checks for the availability of calc by looking for the
4866 function `calc-eval' which should be autoloaded in your setup if
4867 calc has been installed properly. As of Emacs 22, calc is part of
4868 the Emacs distribution. Another possibility for interaction
4869 between the two packages is using calc for embedded calculations.
4870 *Note Embedded Mode: (calc)Embedded Mode.
4872 `constants.el' by Carsten Dominik
4873 In a table formula (*note Table calculations::), it is possible to
4874 use names for natural constants or units. Instead of defining
4875 your own constants in the variable `org-table-formula-constants',
4876 install the `constants' package which defines a large number of
4877 constants and units, and lets you use unit prefixes like `M' for
4878 `Mega' etc. You will need version 2.0 of this package, available
4879 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
4880 the function `constants-get', which has to be autoloaded in your
4881 setup. See the installation instructions in the file
4884 `cdlatex.el' by Carsten Dominik
4885 Org-mode can make use of the cdlatex package to efficiently enter
4886 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
4888 `remember.el' by John Wiegley
4889 Org mode cooperates with remember, see *Note Remember::.
4890 `Remember.el' is not part of Emacs, find it on the web.
4892 `table.el' by Takaaki Ota
4893 Org mode cooperates with table.el, see *Note table.el::.
4894 `table.el' is part of Emacs 22.
4897 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
4899 12.7.2 Packages that lead to conflicts with Org-mode
4900 ----------------------------------------------------
4902 `allout.el' by Ken Manheimer
4903 Startup of Org-mode may fail with the error message
4904 `(wrong-type-argument keymapp nil)' when there is an outdated
4905 version `allout.el' on the load path, for example the version
4906 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
4907 will disappear. If for some reason you cannot do this, make sure
4908 that org.el is loaded _before_ `allout.el', for example by putting
4909 `(require 'org)' early enough into your `.emacs' file.
4911 `CUA.el' by Kim. F. Storm
4912 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4913 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4914 select and extend the region. If you want to use one of these
4915 packages along with Org-mode, configure the variable
4916 `org-CUA-compatible'. When set, Org-mode will move the following
4917 keybindings in org-mode files, and in the agenda buffer (but not
4918 during date selection).
4920 S-UP -> M-p S-DOWN -> M-n
4921 S-LEFT -> M-- S-RIGHT -> M-+
4924 Yes, these are unfortunately more difficult to remember. If you
4925 want to have other replacement keys, look at the variable
4926 `org-disputed-keys'.
4928 `windmove.el' by Hovav Shacham
4929 Also this package uses the `S-<cursor>' keys, so everything written
4930 in the paragraph above about CUA mode also applies here.
4933 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
4938 Here is a list of things that should work differently, but which I have
4939 found too hard to fix.
4941 * If a table field starts with a link, and if the corresponding table
4942 column is narrowed (*note Narrow columns::) to a width too small to
4943 display the link, the field would look entirely empty even though
4944 it is not. To prevent this, Org-mode throws an error. The
4945 work-around is to make the column wide enough to fit the link, or
4946 to add some text (at least 2 characters) before the link in the
4949 * Narrowing table columns does not work on XEmacs, because the
4950 `format' function does not transport text properties.
4952 * Text in an entry protected with the `QUOTE' keyword should not
4955 * When the application called by `C-c C-o' to open a file link fails
4956 (for example because the application does not exist or refuses to
4957 open the file), it does so silently. No error message is
4960 * The remote-editing commands in the agenda buffer cannot be undone
4961 with `undo' called from within the agenda buffer. But you can go
4962 to the corresponding buffer (using <TAB> or <RET> and execute
4965 * Recalculating a table line applies the formulas from left to right.
4966 If a formula uses _calculated_ fields further down the row,
4967 multiple recalculation may be needed to get all fields consistent.
4969 * A single letter cannot be made bold, for example `*a*'.
4971 * The exporters work well, but could be made more efficient.
4974 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
4976 Appendix A Extensions, Hooks and Hacking
4977 ****************************************
4979 This appendix lists extensions for Org-mode written by other authors.
4980 It also covers some aspects where users can easily extend the
4981 functionality of Org-mode.
4985 * Extensions:: Existing 3rd-part extensions
4986 * Dynamic blocks:: Automatically filled blocks
4989 File: org, Node: Extensions, Next: Dynamic blocks, Prev: Extensions and Hacking, Up: Extensions and Hacking
4991 A.1 Third-party extensions for Org-mode
4992 =======================================
4994 The following extensions for Org-mode have been written by other people:
4996 `org-publish.el' by David O'Toole
4997 This package provides facilities for publishing related sets of
4998 Org-mode files together with linked files like images as a
4999 webpages. It is highly configurable and can be used for other
5000 publishing purposes as well. As of Org-mode version 4.30,
5001 `org-publish.el' is part of the Org-mode distribution. It is not
5002 yet part of Emacs, however, a delay caused by the preparations for
5003 the 22.1 release. In the mean time, `org-publish.el' can be
5004 downloaded from David's site:
5005 `http://dto.freeshell.org/e/org-publish.el'.
5007 `org-mouse.el' by Piotr Zielinski
5008 This package implements extended mouse functionality for Org-mode.
5009 It allows you to cycle visibility and to edit the document
5010 structure with the mouse. Best of all, it provides a
5011 context-sensitive menu on <mouse-3> that changes depending on the
5012 context of a mouse-click. As of Org-mode version 4.53,
5013 `org-mouse.el' is part of the Org-mode distribution. It is not
5014 yet part of Emacs, however, a delay caused by the preparations for
5015 the 22.1 release. In the mean time, `org-mouse.el' can be
5016 downloaded from Piotr's site:
5017 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
5019 `org-blog.el' by David O'Toole
5020 A blogging plug-in for `org-publish.el'.
5021 `http://dto.freeshell.org/notebook/OrgMode.html'.
5023 `blorg.el' by Bastien Guerry
5024 Publish Org-mode files as blogs.
5025 `http://www.cognition.ens.fr/~guerry/blorg.html'.
5028 File: org, Node: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
5033 Org-mode documents can contain _dynamic blocks_. These are specially
5034 marked regions that are updated by some user-written function. A good
5035 example for such a block is the clock table inserted by the command
5036 `C-c C-x C-r' (*note Clocking work time::).
5038 Dynamic block are enclosed by a BEGIN-END structure that assigns a
5039 name to the block and can also specify parameters for the function
5040 producing the content of the block.
5042 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
5046 Dynamic blocks are updated with the following commands
5049 Update dynamic block at point.
5052 Update all dynamic blocks in the current file.
5054 Updating a dynamic block means to remove all the text between BEGIN
5055 and END, parse the BEGIN line for parameters and then call the specific
5056 writer function for this block to insert the new content. For a block
5057 with name `myblock', the writer function is `org-dblock-write:myblock'
5058 with as only parameter a property list with the parameters given in the
5059 begin line. Here is a trivial example of a block that keeps track of
5060 when the block update function was last run:
5062 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
5066 The corresponding block writer function could look like this:
5068 (defun org-dblock-write:block-update-time (params)
5069 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
5070 (insert "Last block update at: "
5071 (format-time-string fmt (current-time)))))
5073 If you want to make sure that all dynamic blocks are always
5074 up-to-date, you could add the function `org-update-all-dblocks' to a
5075 hook, for example `before-save-hook'. `org-update-all-dblocks' is
5076 written in a way that is does nothing in buffers that are not in
5080 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
5082 Appendix B History and Acknowledgments
5083 **************************************
5085 Org-mode was borne in 2003, out of frustration over the user interface
5086 of the Emacs outline-mode. All I wanted was to make working with an
5087 outline tree possible without having to remember more than 10 commands
5088 just for hiding and unhiding parts of the outline tree, and to allow to
5089 restructure a tree easily. Visibility cycling and structure editing
5090 were originally implemented in the package `outline-magic.el', but
5091 quickly moved to the more general `org.el'. TODO entries, basic time
5092 stamps, and table support were added next, and highlight the two main
5093 goals that Org-mode still has today: To create a new, outline-based,
5094 plain text mode with innovative and intuitive editing features, and to
5095 incorporate project planning functionality directly into a notes file.
5097 Since the first release, hundreds of emails to me or on
5098 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
5099 feedback, new ideas, and sometimes even patches and add-on code. Many
5100 thanks to everyone who has helped to improve this package. I am trying
5101 to keep here a list of the people who had significant influence in
5102 shaping one or more aspects of Org-mode. The list may not be complete,
5103 if I have forgotten someone, please accept my apologies and let me know.
5105 * Thomas Baumann contributed the code for links to the MH-E email
5108 * Alex Bochannek provided a patch for rounding time stamps.
5110 * Charles Cave's suggestion sparked the implementation of templates
5113 * Pavel Chalmoviansky influenced the agenda treatment of items with
5116 * Gregory Chernov patched support for lisp forms into table
5117 calculations and improved XEmacs compatibility, in particular by
5118 porting `nouline.el' to XEmacs.
5120 * Sacha Chua suggested to copy some linking code from Planner.
5122 * Eddward DeVilla proposed and tested checkbox statistics.
5124 * Kees Dullemond inspired the use of narrowed tabled columns.
5126 * Christian Egli converted the documentation into TeXInfo format,
5127 patched CSS formatting into the HTML exporter, and inspired the
5130 * Nic Ferrier contributed mailcap and XOXO support.
5132 * Niels Giessen had the idea to automatically archive DONE trees.
5134 * Bastien Guerry provided extensive feedback.
5136 * Kai Grossjohann pointed out key-binding conflicts with other
5139 * Leon Liu asked for embedded LaTeX and tested it.
5141 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
5144 * Todd Neal provided patches for links to Info files and elisp forms.
5146 * Tim O'Callaghan suggested in-file links, search options for general
5147 file links, and TAGS.
5149 * Oliver Oppitz suggested multi-state TODO items.
5151 * Scott Otterson sparked the introduction of descriptive text for
5152 links, among other things.
5154 * Pete Phillips helped during the development of the TAGS feature,
5155 and provided frequent feedback.
5157 * T.V. Raman reported bugs and suggested improvements.
5159 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
5162 * Kevin Rogers contributed code to access VM files on remote hosts.
5164 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
5165 conflict with `allout.el'.
5167 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
5169 * Philip Rooke created the Org-mode reference card and provided lots
5172 * Christian Schlauer proposed angular brackets around links, among
5175 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
5176 `organizer-mode.el'.
5178 * Daniel Sinder came up with the idea of internal archiving by
5181 * Dale Smith proposed link abbreviations.
5183 * David O'Toole wrote `org-publish.el' and drafted the manual
5184 chapter about publishing.
5186 * Ju"rgen Vollmer contributed code generating the table of contents
5189 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
5191 * David Wainberg suggested archiving, and improvements to the linking
5194 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
5195 development of Org-mode was fully independent, and both systems are
5196 really different beasts in their basic ideas and implementation
5197 details. I later looked at John's code, however, and learned from
5198 his implementation of (i) links where the link itself is hidden
5199 and only a description is shown, and (ii) popping up a calendar to
5202 * Carsten Wimmer suggested some changes and helped fix a bug in
5205 * Roland Winkler requested additional keybindings to make Org-mode
5208 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
5209 contributed various ideas and code snippets.
5212 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
5220 * abbreviation, links: Link abbreviations. (line 6)
5221 * acknowledgments: History and Acknowledgments.
5223 * action, for publishing: Publishing action. (line 6)
5224 * activation: Activation. (line 6)
5225 * active region <1>: HTML export. (line 10)
5226 * active region <2>: ASCII export. (line 9)
5227 * active region <3>: Built-in table editor.
5229 * active region: Structure editing. (line 64)
5230 * agenda: Weekly/Daily agenda. (line 6)
5231 * agenda dispatcher: Agenda dispatcher. (line 6)
5232 * agenda files: Agenda files. (line 6)
5233 * agenda files, removing buffers: Agenda commands. (line 220)
5234 * agenda views: Agenda views. (line 6)
5235 * agenda views, custom: Custom agenda views. (line 6)
5236 * agenda, batch production: Batch processing. (line 6)
5237 * agenda, with block views: Block agenda. (line 6)
5238 * allout.el: Conflicts. (line 6)
5239 * angular brackets, around links: External links. (line 38)
5240 * applescript, for calendar update: iCalendar export. (line 38)
5241 * archive locations: Moving subtrees. (line 21)
5242 * archiving: Archiving. (line 6)
5243 * ASCII export: ASCII export. (line 6)
5244 * author: Feedback. (line 6)
5245 * autoload: Activation. (line 6)
5246 * backtrace of an error: Feedback. (line 27)
5247 * BBDB links: External links. (line 6)
5248 * block agenda: Block agenda. (line 6)
5249 * blorg.el: Extensions. (line 33)
5250 * bold text: Enhancing text. (line 15)
5251 * Boolean logic, for tag searches: Tag searches. (line 21)
5252 * bug reports: Feedback. (line 6)
5253 * bugs: Bugs. (line 6)
5254 * C-c C-c, overview: The very busy C-c C-c key.
5256 * calc package: Table calculations. (line 6)
5257 * calc.el: Cooperation. (line 6)
5258 * calculations, in tables <1>: Table calculations. (line 6)
5259 * calculations, in tables: Built-in table editor.
5261 * calendar commands, from agenda: Agenda commands. (line 181)
5262 * calendar integration: Calendar/Diary integration.
5264 * calendar, for selecting date: The date/time prompt.
5266 * CamelCase link completion: Completion. (line 6)
5267 * CamelCase links: Internal links. (line 6)
5268 * CamelCase links, completion of: CamelCase links. (line 6)
5269 * category: Categories. (line 6)
5270 * CDLaTeX: CDLaTeX mode. (line 6)
5271 * cdlatex.el: Cooperation. (line 29)
5272 * checkbox statistics: Checkboxes. (line 23)
5273 * checkboxes: Checkboxes. (line 6)
5274 * children, subtree visibility state: Visibility cycling. (line 10)
5275 * clean outline view: Clean view. (line 6)
5276 * CLOCK keyword: Time stamps. (line 71)
5277 * CLOSED keyword: Time stamps. (line 65)
5278 * column formula: Column formulas. (line 6)
5279 * commands, in agenda buffer: Agenda commands. (line 6)
5280 * comment lines: Comment lines. (line 6)
5281 * completion, of CamelCase links <1>: Completion. (line 6)
5282 * completion, of CamelCase links: CamelCase links. (line 6)
5283 * completion, of dictionary words: Completion. (line 6)
5284 * completion, of file names: Handling links. (line 43)
5285 * completion, of links: Handling links. (line 27)
5286 * completion, of option keywords <1>: Completion. (line 6)
5287 * completion, of option keywords: Export options. (line 6)
5288 * Completion, of option keywords: Per file keywords. (line 17)
5289 * completion, of tags <1>: Completion. (line 6)
5290 * completion, of tags: Setting tags. (line 11)
5291 * completion, of TeX symbols: Completion. (line 6)
5292 * completion, of TODO keywords <1>: Completion. (line 6)
5293 * completion, of TODO keywords: Workflow states. (line 12)
5294 * constants, in calculations: Formula syntax. (line 26)
5295 * constants.el: Cooperation. (line 14)
5296 * contents, global visibility state: Visibility cycling. (line 22)
5297 * copying, of subtrees: Structure editing. (line 6)
5298 * creating timestamps: Creating timestamps. (line 6)
5299 * CUA.el: Conflicts. (line 15)
5300 * custom agenda views: Custom agenda views. (line 6)
5301 * custom date/time format: Custom time format. (line 6)
5302 * custom search strings: Custom searches. (line 6)
5303 * customization: Customization. (line 6)
5304 * cutting, of subtrees: Structure editing. (line 6)
5305 * cycling, of TODO states: TODO basics. (line 13)
5306 * cycling, visibility: Visibility cycling. (line 6)
5307 * daily agenda: Weekly/Daily agenda. (line 6)
5308 * date format, custom: Custom time format. (line 6)
5309 * date stamps <1>: Time stamps. (line 6)
5310 * date stamps: Timestamps. (line 6)
5311 * date, reading in minibuffer: The date/time prompt.
5313 * DEADLINE keyword: Time stamps. (line 53)
5314 * deadlines: Time stamps. (line 6)
5315 * demotion, of subtrees: Structure editing. (line 6)
5316 * diary entries, creating from agenda: Agenda commands. (line 188)
5317 * diary integration: Calendar/Diary integration.
5319 * dictionary word completion: Completion. (line 6)
5320 * directories, for publishing: Sources and destinations.
5322 * dispatching agenda commands: Agenda dispatcher. (line 6)
5323 * display changing, in agenda: Agenda commands. (line 59)
5324 * document structure: Document structure. (line 6)
5325 * DONE, final TODO keyword: Per file keywords. (line 20)
5326 * editing tables: Tables. (line 6)
5327 * editing, of table formulas: Editing/debugging formulas.
5329 * elisp links: External links. (line 6)
5330 * emphasized text: Export options. (line 25)
5331 * enhancing text: Enhancing text. (line 6)
5332 * evaluate time range: Creating timestamps. (line 66)
5333 * exporting: Exporting. (line 6)
5334 * exporting, not: Comment lines. (line 6)
5335 * extended TODO keywords: TODO extensions. (line 6)
5336 * external archiving: Moving subtrees. (line 6)
5337 * external links: External links. (line 6)
5338 * external links, in HTML export: HTML export. (line 35)
5339 * FAQ: Summary. (line 51)
5340 * feedback: Feedback. (line 6)
5341 * file links: External links. (line 6)
5342 * file links, searching: Search options. (line 6)
5343 * file name completion: Handling links. (line 43)
5344 * files for agenda: Agenda files. (line 6)
5345 * files, adding to agenda list: Agenda files. (line 12)
5346 * files, selecting for publishing: Selecting files. (line 6)
5347 * fixed width: Enhancing text. (line 25)
5348 * fixed-width sections: Export options. (line 25)
5349 * folded, subtree visibility state: Visibility cycling. (line 10)
5350 * folding, sparse trees: Sparse trees. (line 6)
5351 * following links: Handling links. (line 58)
5352 * format specifier: Formula syntax. (line 34)
5353 * format, of links: Link format. (line 6)
5354 * formula editing: Editing/debugging formulas.
5356 * formula syntax: Formula syntax. (line 6)
5357 * formula, for named table field: Named-field formulas.
5359 * formula, for table column: Column formulas. (line 6)
5360 * formula, in tables: Built-in table editor.
5362 * global cycling: Visibility cycling. (line 22)
5363 * global keybindings: Activation. (line 6)
5364 * global TODO list: Global TODO list. (line 6)
5365 * global visibility states: Visibility cycling. (line 22)
5366 * GNUS links: External links. (line 6)
5367 * hand-formatted lists: Enhancing text. (line 11)
5368 * headline levels: Export options. (line 25)
5369 * headline levels, for exporting <1>: HTML export. (line 21)
5370 * headline levels, for exporting: ASCII export. (line 18)
5371 * headline navigation: Motion. (line 6)
5372 * headline tagging: Tags. (line 6)
5373 * headline, promotion and demotion: Structure editing. (line 6)
5374 * headlines: Headlines. (line 6)
5375 * hide text: Visibility cycling. (line 6)
5376 * hiding leading stars: Clean view. (line 6)
5377 * history: History and Acknowledgments.
5379 * HTML export: HTML export. (line 6)
5380 * hyperlinks: Hyperlinks. (line 6)
5381 * iCalendar export: iCalendar export. (line 6)
5382 * in-buffer settings: In-buffer settings. (line 6)
5383 * inactive timestamp: Time stamps. (line 24)
5384 * index, of published pages: Project page index. (line 6)
5385 * Info links: External links. (line 6)
5386 * inheritance, of tags: Tag inheritance. (line 6)
5387 * inserting links: Handling links. (line 27)
5388 * installation: Installation. (line 6)
5389 * internal archiving: ARCHIVE tag. (line 6)
5390 * internal links: Internal links. (line 6)
5391 * internal links, in HTML export: HTML export. (line 35)
5392 * introduction: Introduction. (line 6)
5393 * italic text: Enhancing text. (line 15)
5394 * jumping, to headlines: Motion. (line 6)
5395 * keybindings, global: Activation. (line 6)
5396 * keyword options: Per file keywords. (line 6)
5397 * LaTeX fragments <1>: Export options. (line 25)
5398 * LaTeX fragments: LaTeX fragments. (line 6)
5399 * LaTeX fragments, export: Enhancing text. (line 18)
5400 * LaTeX fragments, preview: Processing LaTeX fragments.
5402 * LaTeX interpretation: Embedded LaTeX. (line 6)
5403 * linebreak preservation: Export options. (line 25)
5404 * linebreak, forced: Enhancing text. (line 32)
5405 * link abbreviations: Link abbreviations. (line 6)
5406 * link completion: Handling links. (line 27)
5407 * link format: Link format. (line 6)
5408 * links, external: External links. (line 6)
5409 * links, handling: Handling links. (line 6)
5410 * links, in HTML export: HTML export. (line 35)
5411 * links, internal: Internal links. (line 6)
5412 * links, publishing: Publishing links. (line 6)
5413 * links, radio targets: Radio targets. (line 6)
5414 * links, returning to: Handling links. (line 85)
5415 * Lisp forms, as table formulas: Lisp formulas. (line 6)
5416 * lists, hand-formatted: Enhancing text. (line 11)
5417 * lists, ordered: Plain lists. (line 6)
5418 * lists, plain: Plain lists. (line 6)
5419 * logging, of progress: Progress logging. (line 6)
5420 * maintainer: Feedback. (line 6)
5421 * mark ring: Handling links. (line 81)
5422 * marking characters, tables: Advanced features. (line 34)
5423 * matching, of tags: Matching headline tags.
5425 * matching, tags: Tags. (line 6)
5426 * math symbols: Math symbols. (line 6)
5427 * MH-E links: External links. (line 6)
5428 * minor mode for tables: orgtbl-mode. (line 6)
5429 * mode, for calc: Formula syntax. (line 34)
5430 * motion commands in agenda: Agenda commands. (line 19)
5431 * motion, between headlines: Motion. (line 6)
5432 * name, of column or field: Formula syntax. (line 26)
5433 * named field formula: Named-field formulas.
5435 * names as TODO keywords: TODO types. (line 6)
5436 * narrow columns in tables: Narrow columns. (line 6)
5437 * occur, command: Sparse trees. (line 6)
5438 * option keyword completion: Completion. (line 6)
5439 * options, for custom agenda views: Setting Options. (line 6)
5440 * options, for customization: Customization. (line 6)
5441 * options, for export: Export options. (line 6)
5442 * options, for publishing: Publishing options. (line 6)
5443 * ordered lists: Plain lists. (line 6)
5444 * org-agenda, command: Weekly/Daily agenda. (line 9)
5445 * org-blog.el: Extensions. (line 29)
5446 * org-mode, turning on: Activation. (line 22)
5447 * org-mouse.el: Extensions. (line 17)
5448 * org-publish-project-alist: Project alist. (line 6)
5449 * org-publish.el: Extensions. (line 8)
5450 * orgtbl-mode: orgtbl-mode. (line 6)
5451 * outline tree: Headlines. (line 6)
5452 * outline-mode: Outlines. (line 6)
5453 * outlines: Outlines. (line 6)
5454 * overview, global visibility state: Visibility cycling. (line 22)
5455 * packages, interaction with other: Interaction. (line 6)
5456 * pasting, of subtrees: Structure editing. (line 6)
5457 * per file keywords: Per file keywords. (line 6)
5458 * plain lists: Plain lists. (line 6)
5459 * plain text external links: External links. (line 38)
5460 * presentation, of agenda items: Presentation and sorting.
5462 * printing sparse trees: Sparse trees. (line 41)
5463 * priorities: Priorities. (line 6)
5464 * priorities, of agenda items: Sorting of agenda items.
5466 * progress logging: Progress logging. (line 6)
5467 * projects, for publishing: Project alist. (line 6)
5468 * promotion, of subtrees: Structure editing. (line 6)
5469 * publishing: Publishing. (line 6)
5470 * quoted HTML tags: Export options. (line 25)
5471 * radio targets: Radio targets. (line 6)
5472 * ranges, time: Time stamps. (line 6)
5473 * recomputing table fields: Column formulas. (line 27)
5474 * region, active <1>: HTML export. (line 10)
5475 * region, active <2>: ASCII export. (line 9)
5476 * region, active <3>: Built-in table editor.
5478 * region, active: Structure editing. (line 64)
5479 * regular expressions, with tags search: Tag searches. (line 58)
5480 * remember.el <1>: Cooperation. (line 33)
5481 * remember.el: Remember. (line 6)
5482 * remote editing, from agenda: Agenda commands. (line 100)
5483 * richer text: Enhancing text. (line 6)
5484 * RMAIL links: External links. (line 6)
5485 * SCHEDULED keyword: Time stamps. (line 40)
5486 * scheduling: Time stamps. (line 6)
5487 * search option in file links: Search options. (line 6)
5488 * search strings, custom: Custom searches. (line 6)
5489 * searching for tags: Tag searches. (line 6)
5490 * section-numbers: Export options. (line 25)
5491 * setting tags: Setting tags. (line 6)
5492 * SHELL links: External links. (line 6)
5493 * show all, command: Visibility cycling. (line 31)
5494 * show all, global visibility state: Visibility cycling. (line 22)
5495 * show hidden text: Visibility cycling. (line 6)
5496 * sorting, of agenda items: Sorting of agenda items.
5498 * sparse tree, for deadlines: Creating timestamps. (line 41)
5499 * sparse tree, for TODO: TODO basics. (line 26)
5500 * sparse tree, tag based: Tags. (line 6)
5501 * sparse trees: Sparse trees. (line 6)
5502 * special keywords: In-buffer settings. (line 6)
5503 * spreadsheet capabilities: Table calculations. (line 6)
5504 * statistics, for checkboxes: Checkboxes. (line 23)
5505 * storing links: Handling links. (line 9)
5506 * structure editing: Structure editing. (line 6)
5507 * structure of document: Document structure. (line 6)
5508 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
5509 * sublevels, inclusion into todo list: Global TODO list. (line 33)
5510 * subscript: Subscripts and Superscripts.
5512 * subtree cycling: Visibility cycling. (line 10)
5513 * subtree visibility states: Visibility cycling. (line 10)
5514 * subtree, cut and paste: Structure editing. (line 6)
5515 * subtree, subtree visibility state: Visibility cycling. (line 10)
5516 * subtrees, cut and paste: Structure editing. (line 6)
5517 * summary: Summary. (line 6)
5518 * superscript: Subscripts and Superscripts.
5520 * syntax, of formulas: Formula syntax. (line 6)
5521 * table editor, builtin: Built-in table editor.
5523 * table editor, table.el: table.el. (line 6)
5524 * table of contents: Export options. (line 25)
5525 * table.el <1>: Cooperation. (line 34)
5526 * table.el: table.el. (line 6)
5527 * tables <1>: Export options. (line 25)
5528 * tables: Tables. (line 6)
5529 * tables, export: Enhancing text. (line 21)
5530 * tag completion: Completion. (line 6)
5531 * tag searches: Tag searches. (line 6)
5532 * tags: Tags. (line 6)
5533 * tags view: Matching headline tags.
5535 * tags, setting: Setting tags. (line 6)
5536 * targets, for links: Internal links. (line 6)
5537 * targets, radio: Radio targets. (line 6)
5538 * tasks, breaking down: Breaking down tasks. (line 6)
5539 * templates, for remember: Remember. (line 23)
5540 * TeX interpretation: Embedded LaTeX. (line 6)
5541 * TeX macros <1>: Export options. (line 25)
5542 * TeX macros: Math symbols. (line 6)
5543 * TeX macros, export: Enhancing text. (line 18)
5544 * TeX symbol completion: Completion. (line 6)
5545 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
5546 * thanks: History and Acknowledgments.
5548 * time format, custom: Custom time format. (line 6)
5549 * time grid: Time-of-day specifications.
5551 * time stamps <1>: Time stamps. (line 6)
5552 * time stamps: Timestamps. (line 6)
5553 * time, reading in minibuffer: The date/time prompt.
5555 * time-of-day specification: Time-of-day specifications.
5557 * time-sorted view: Timeline. (line 6)
5558 * timeline, single file: Timeline. (line 6)
5559 * timerange: Time stamps. (line 31)
5560 * timestamp: Time stamps. (line 14)
5561 * timestamp, inactive: Time stamps. (line 24)
5562 * timestamps, creating: Creating timestamps. (line 6)
5563 * TODO items: TODO items. (line 6)
5564 * TODO keyword matching: Global TODO list. (line 17)
5565 * TODO keyword matching, with tags search: Tag searches. (line 38)
5566 * TODO keywords completion: Completion. (line 6)
5567 * TODO list, global: Global TODO list. (line 6)
5568 * TODO types: TODO types. (line 6)
5569 * TODO workflow: Workflow states. (line 6)
5570 * transient-mark-mode <1>: HTML export. (line 10)
5571 * transient-mark-mode <2>: ASCII export. (line 9)
5572 * transient-mark-mode <3>: Built-in table editor.
5574 * transient-mark-mode: Structure editing. (line 64)
5575 * trees, sparse: Sparse trees. (line 6)
5576 * trees, visibility: Visibility cycling. (line 6)
5577 * tty keybindings: TTY keys. (line 6)
5578 * types as TODO keywords: TODO types. (line 6)
5579 * underlined text: Enhancing text. (line 15)
5580 * URL links: External links. (line 6)
5581 * USENET links: External links. (line 6)
5582 * variables, for customization: Customization. (line 6)
5583 * vectors, in table calculations: Formula syntax. (line 23)
5584 * visibility cycling: Visibility cycling. (line 6)
5585 * visible text, printing: Sparse trees. (line 41)
5586 * VM links: External links. (line 6)
5587 * WANDERLUST links: External links. (line 6)
5588 * weekly agenda: Weekly/Daily agenda. (line 6)
5589 * windmove.el: Conflicts. (line 33)
5590 * workflow states as TODO keywords: Workflow states. (line 6)
5591 * XEmacs: Installation. (line 6)
5592 * XOXO export: XOXO export. (line 6)
5595 File: org, Node: Key Index, Prev: Index, Up: Top
5603 * $: Agenda commands. (line 113)
5604 * ': CDLaTeX mode. (line 43)
5605 * +: Agenda commands. (line 135)
5606 * ,: Agenda commands. (line 127)
5607 * -: Agenda commands. (line 141)
5608 * .: Agenda commands. (line 94)
5609 * :: Agenda commands. (line 121)
5610 * <: The date/time prompt.
5612 * <left>: Agenda commands. (line 91)
5613 * <RET> <1>: Agenda commands. (line 41)
5614 * <RET> <2>: Setting tags. (line 76)
5615 * <RET> <3>: The date/time prompt.
5617 * <RET>: Built-in table editor.
5619 * <right>: Agenda commands. (line 86)
5620 * <SPC> <1>: Agenda commands. (line 28)
5621 * <SPC>: Setting tags. (line 73)
5622 * <TAB> <1>: CDLaTeX mode. (line 23)
5623 * <TAB> <2>: Agenda commands. (line 35)
5624 * <TAB> <3>: Setting tags. (line 68)
5625 * <TAB> <4>: Built-in table editor.
5627 * <TAB> <5>: Plain lists. (line 37)
5628 * <TAB>: Visibility cycling. (line 10)
5629 * > <1>: Agenda commands. (line 163)
5630 * >: The date/time prompt.
5632 * ^: CDLaTeX mode. (line 33)
5633 * _: CDLaTeX mode. (line 33)
5634 * `: CDLaTeX mode. (line 39)
5635 * a: Agenda commands. (line 124)
5636 * C: Agenda commands. (line 203)
5637 * c: Agenda commands. (line 181)
5638 * C-#: Built-in table editor.
5640 * C-,: Agenda files. (line 18)
5641 * C-a a L: Timeline. (line 10)
5642 * C-c !: Creating timestamps. (line 21)
5643 * C-c #: Checkboxes. (line 56)
5644 * C-c $: Moving subtrees. (line 10)
5645 * C-c %: Handling links. (line 81)
5646 * C-c &: Handling links. (line 85)
5647 * C-c ' <1>: Editing/debugging formulas.
5649 * C-c ': Built-in table editor.
5651 * C-c *: Built-in table editor.
5653 * C-c +: Built-in table editor.
5655 * C-c ,: Priorities. (line 18)
5656 * C-c -: Built-in table editor.
5658 * C-c .: Creating timestamps. (line 10)
5659 * C-c /: Sparse trees. (line 15)
5660 * C-c :: Enhancing text. (line 29)
5661 * C-c ;: Comment lines. (line 11)
5662 * C-c <: Creating timestamps. (line 25)
5663 * C-c <TAB>: Built-in table editor.
5665 * C-c =: Built-in table editor.
5667 * C-c >: Creating timestamps. (line 29)
5668 * C-c ? <1>: Editing/debugging formulas.
5670 * C-c ?: Built-in table editor.
5672 * C-c [: Agenda files. (line 12)
5673 * C-c \: Tag searches. (line 9)
5674 * C-c ]: Agenda files. (line 15)
5675 * C-c ^ <1>: Built-in table editor.
5677 * C-c ^: Structure editing. (line 52)
5678 * C-c `: Built-in table editor.
5680 * C-c a a: Weekly/Daily agenda. (line 9)
5681 * C-c a C: Storing searches. (line 9)
5682 * C-c a M: Matching headline tags.
5684 * C-c a m: Matching headline tags.
5686 * C-c a M: Tag searches. (line 14)
5687 * C-c a m: Tag searches. (line 10)
5688 * C-c a T: Global TODO list. (line 14)
5689 * C-c a t <1>: Global TODO list. (line 9)
5690 * C-c a t: TODO basics. (line 33)
5691 * C-c C-a: Visibility cycling. (line 31)
5692 * C-c C-b: Motion. (line 15)
5693 * C-c C-c <1>: The very busy C-c C-c key.
5695 * C-c C-c <2>: Processing LaTeX fragments.
5697 * C-c C-c <3>: Setting tags. (line 10)
5698 * C-c C-c <4>: Checkboxes. (line 37)
5699 * C-c C-c <5>: table.el. (line 6)
5700 * C-c C-c <6>: Editing/debugging formulas.
5702 * C-c C-c <7>: Built-in table editor.
5704 * C-c C-c: Plain lists. (line 74)
5705 * C-c C-d <1>: Agenda commands. (line 148)
5706 * C-c C-d: Creating timestamps. (line 37)
5707 * C-c C-e: Exporting. (line 19)
5708 * C-c C-e a: ASCII export. (line 9)
5709 * C-c C-e b: HTML export. (line 11)
5710 * C-c C-e c: iCalendar export. (line 20)
5711 * C-c C-e h: HTML export. (line 10)
5712 * C-c C-e I: iCalendar export. (line 15)
5713 * C-c C-e i: iCalendar export. (line 13)
5714 * C-c C-e t: Export options. (line 13)
5715 * C-c C-e v <1>: XOXO export. (line 11)
5716 * C-c C-e v: Sparse trees. (line 41)
5717 * C-c C-e v a: ASCII export. (line 13)
5718 * C-c C-e v b: HTML export. (line 14)
5719 * C-c C-e v h: HTML export. (line 14)
5720 * C-c C-e x: XOXO export. (line 10)
5721 * C-c C-f: Motion. (line 12)
5722 * C-c C-j: Motion. (line 21)
5723 * C-c C-l: Handling links. (line 27)
5724 * C-c C-n: Motion. (line 8)
5725 * C-c C-o <1>: Creating timestamps. (line 33)
5726 * C-c C-o: Handling links. (line 58)
5727 * C-c C-p: Motion. (line 9)
5728 * C-c C-q <1>: Editing/debugging formulas.
5730 * C-c C-q: Built-in table editor.
5732 * C-c C-r: Visibility cycling. (line 32)
5733 * C-c C-s <1>: Agenda commands. (line 145)
5734 * C-c C-s: Creating timestamps. (line 48)
5735 * C-c C-t <1>: Clocking work time. (line 26)
5736 * C-c C-t: TODO basics. (line 13)
5737 * C-c C-u: Motion. (line 18)
5738 * C-c C-v: TODO basics. (line 26)
5739 * C-c C-w: Creating timestamps. (line 41)
5740 * C-c C-x C-a: ARCHIVE tag. (line 28)
5741 * C-c C-x C-b: Checkboxes. (line 38)
5742 * C-c C-x C-c: Agenda commands. (line 210)
5743 * C-c C-x C-d: Clocking work time. (line 34)
5744 * C-c C-x C-i: Clocking work time. (line 12)
5745 * C-c C-x C-k: Structure editing. (line 39)
5746 * C-c C-x C-l: Processing LaTeX fragments.
5748 * C-c C-x C-o: Clocking work time. (line 14)
5749 * C-c C-x C-r: Clocking work time. (line 42)
5750 * C-c C-x C-t: Custom time format. (line 12)
5751 * C-c C-x C-u: Dynamic blocks. (line 21)
5752 * C-c C-x C-w <1>: Built-in table editor.
5754 * C-c C-x C-w: Structure editing. (line 39)
5755 * C-c C-x C-x: Clocking work time. (line 30)
5756 * C-c C-x C-y <1>: Built-in table editor.
5758 * C-c C-x C-y: Structure editing. (line 46)
5759 * C-c C-x M-w <1>: Built-in table editor.
5761 * C-c C-x M-w: Structure editing. (line 43)
5762 * C-c C-y <1>: Clocking work time. (line 21)
5763 * C-c C-y: Creating timestamps. (line 66)
5764 * C-c l: Handling links. (line 9)
5765 * C-c {: CDLaTeX mode. (line 21)
5766 * C-c |: Built-in table editor.
5768 * C-c ~: table.el. (line 18)
5769 * C-k: Agenda commands. (line 107)
5770 * C-TAB: ARCHIVE tag. (line 38)
5771 * C-u C-c $: Moving subtrees. (line 12)
5772 * C-u C-c .: Creating timestamps. (line 16)
5773 * C-u C-c =: Built-in table editor.
5775 * C-u C-c C-l: Handling links. (line 43)
5776 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
5777 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
5778 * C-u C-c C-x C-u: Clocking work time. (line 69)
5779 * D: Agenda commands. (line 68)
5780 * d: Agenda commands. (line 65)
5781 * f: Agenda commands. (line 44)
5782 * g: Agenda commands. (line 72)
5783 * H: Agenda commands. (line 207)
5784 * i: Agenda commands. (line 188)
5785 * I: Agenda commands. (line 168)
5786 * l: Agenda commands. (line 51)
5787 * L: Agenda commands. (line 32)
5788 * M: Agenda commands. (line 194)
5789 * M-<down>: Built-in table editor.
5791 * M-<left> <1>: Built-in table editor.
5793 * M-<left>: Structure editing. (line 21)
5794 * M-<RET> <1>: Plain lists. (line 42)
5795 * M-<RET>: Structure editing. (line 6)
5796 * M-<right> <1>: Built-in table editor.
5798 * M-<right>: Structure editing. (line 24)
5799 * M-<TAB> <1>: Completion. (line 10)
5800 * M-<TAB> <2>: Setting tags. (line 6)
5801 * M-<TAB>: Per file keywords. (line 17)
5802 * M-<up>: Built-in table editor.
5804 * M-S-<down> <1>: Built-in table editor.
5806 * M-S-<down> <2>: Plain lists. (line 59)
5807 * M-S-<down>: Structure editing. (line 36)
5808 * M-S-<left> <1>: The date/time prompt.
5810 * M-S-<left> <2>: Built-in table editor.
5812 * M-S-<left> <3>: Plain lists. (line 65)
5813 * M-S-<left>: Structure editing. (line 27)
5814 * M-S-<RET> <1>: Checkboxes. (line 53)
5815 * M-S-<RET> <2>: Plain lists. (line 52)
5816 * M-S-<RET>: Structure editing. (line 18)
5817 * M-S-<right> <1>: The date/time prompt.
5819 * M-S-<right> <2>: Built-in table editor.
5821 * M-S-<right> <3>: Plain lists. (line 65)
5822 * M-S-<right>: Structure editing. (line 30)
5823 * M-S-<up> <1>: Built-in table editor.
5825 * M-S-<up> <2>: Plain lists. (line 59)
5826 * M-S-<up>: Structure editing. (line 33)
5827 * mouse-1 <1>: Agenda commands. (line 35)
5828 * mouse-1 <2>: The date/time prompt.
5830 * mouse-1: Handling links. (line 72)
5831 * mouse-2 <1>: Agenda commands. (line 35)
5832 * mouse-2: Handling links. (line 72)
5833 * mouse-3 <1>: Agenda commands. (line 28)
5834 * mouse-3: Handling links. (line 77)
5835 * n: Agenda commands. (line 19)
5836 * O: Agenda commands. (line 170)
5837 * o: Agenda commands. (line 59)
5838 * P: Agenda commands. (line 132)
5839 * p: Agenda commands. (line 20)
5840 * q: Agenda commands. (line 217)
5841 * r <1>: Agenda commands. (line 76)
5842 * r: Global TODO list. (line 20)
5843 * S: Agenda commands. (line 198)
5844 * s: Agenda commands. (line 83)
5845 * S-<down> <1>: Agenda commands. (line 141)
5846 * S-<down> <2>: The date/time prompt.
5848 * S-<down> <3>: Creating timestamps. (line 58)
5849 * S-<down> <4>: Priorities. (line 25)
5850 * S-<down>: Plain lists. (line 55)
5851 * S-<left> <1>: Agenda commands. (line 159)
5852 * S-<left> <2>: The date/time prompt.
5854 * S-<left> <3>: Creating timestamps. (line 53)
5855 * S-<left>: TODO basics. (line 20)
5856 * S-<RET>: Built-in table editor.
5858 * S-<right> <1>: Agenda commands. (line 151)
5859 * S-<right> <2>: The date/time prompt.
5861 * S-<right> <3>: Creating timestamps. (line 53)
5862 * S-<right>: TODO basics. (line 20)
5863 * S-<TAB> <1>: Built-in table editor.
5865 * S-<TAB>: Visibility cycling. (line 22)
5866 * S-<up> <1>: Agenda commands. (line 135)
5867 * S-<up> <2>: The date/time prompt.
5869 * S-<up> <3>: Creating timestamps. (line 58)
5870 * S-<up> <4>: Priorities. (line 25)
5871 * S-<up>: Plain lists. (line 55)
5872 * T: Agenda commands. (line 116)
5873 * t: Agenda commands. (line 103)
5874 * w: Agenda commands. (line 62)
5875 * x: Agenda commands. (line 220)
5876 * X: Agenda commands. (line 173)
5882 Node: Introduction
\x7f10363
5883 Node: Summary
\x7f10778
5884 Node: Installation
\x7f13690
5885 Node: Activation
\x7f15068
5886 Node: Feedback
\x7f16317
5887 Node: Document structure
\x7f18393
5888 Node: Outlines
\x7f19167
5889 Node: Headlines
\x7f19827
5890 Node: Visibility cycling
\x7f20450
5891 Ref: Visibility cycling-Footnote-1
\x7f22201
5892 Ref: Visibility cycling-Footnote-2
\x7f22259
5893 Node: Motion
\x7f22309
5894 Node: Structure editing
\x7f23093
5895 Node: Archiving
\x7f25919
5896 Node: ARCHIVE tag
\x7f26477
5897 Node: Moving subtrees
\x7f28270
5898 Node: Sparse trees
\x7f29311
5899 Ref: Sparse trees-Footnote-1
\x7f31442
5900 Ref: Sparse trees-Footnote-2
\x7f31534
5901 Node: Plain lists
\x7f31649
5902 Ref: Plain lists-Footnote-1
\x7f35174
5903 Ref: Plain lists-Footnote-2
\x7f35531
5904 Node: Tables
\x7f35715
5905 Node: Built-in table editor
\x7f36263
5906 Node: Narrow columns
\x7f44291
5907 Ref: Narrow columns-Footnote-1
\x7f46230
5908 Node: Table calculations
\x7f46276
5909 Node: Formula syntax
\x7f47596
5910 Ref: Formula syntax-Footnote-1
\x7f50501
5911 Node: Lisp formulas
\x7f50801
5912 Node: Column formulas
\x7f51590
5913 Node: Advanced features
\x7f53352
5914 Node: Named-field formulas
\x7f56606
5915 Node: Editing/debugging formulas
\x7f57246
5916 Node: Appetizer
\x7f59004
5917 Node: orgtbl-mode
\x7f60107
5918 Node: table.el
\x7f60598
5919 Node: Hyperlinks
\x7f61575
5920 Node: Link format
\x7f62348
5921 Node: Internal links
\x7f63641
5922 Ref: Internal links-Footnote-1
\x7f65630
5923 Node: Radio targets
\x7f65762
5924 Node: CamelCase links
\x7f66477
5925 Node: External links
\x7f67071
5926 Node: Handling links
\x7f69202
5927 Ref: Handling links-Footnote-1
\x7f73854
5928 Ref: Handling links-Footnote-2
\x7f74091
5929 Node: Link abbreviations
\x7f74165
5930 Node: Search options
\x7f75844
5931 Ref: Search options-Footnote-1
\x7f77624
5932 Node: Custom searches
\x7f77705
5933 Node: Remember
\x7f78753
5934 Node: TODO items
\x7f82447
5935 Node: TODO basics
\x7f83429
5936 Node: TODO extensions
\x7f84956
5937 Node: Workflow states
\x7f85751
5938 Node: TODO types
\x7f86619
5939 Ref: TODO types-Footnote-1
\x7f88277
5940 Node: Per file keywords
\x7f88359
5941 Ref: Per file keywords-Footnote-1
\x7f89813
5942 Node: Priorities
\x7f90014
5943 Node: Breaking down tasks
\x7f91258
5944 Ref: Breaking down tasks-Footnote-1
\x7f91777
5945 Node: Checkboxes
\x7f91873
5946 Node: Timestamps
\x7f94628
5947 Node: Time stamps
\x7f95089
5948 Ref: Time stamps-Footnote-1
\x7f98583
5949 Ref: Time stamps-Footnote-2
\x7f98699
5950 Node: Creating timestamps
\x7f98854
5951 Node: The date/time prompt
\x7f101480
5952 Ref: The date/time prompt-Footnote-1
\x7f103246
5953 Node: Custom time format
\x7f103352
5954 Node: Progress logging
\x7f104911
5955 Node: Closing items
\x7f105440
5956 Node: Clocking work time
\x7f106344
5957 Ref: Clocking work time-Footnote-1
\x7f109968
5958 Node: Tags
\x7f110094
5959 Node: Tag inheritance
\x7f110856
5960 Node: Setting tags
\x7f111793
5961 Ref: Setting tags-Footnote-1
\x7f115992
5962 Ref: Setting tags-Footnote-2
\x7f116104
5963 Node: Tag searches
\x7f116187
5964 Node: Agenda views
\x7f118416
5965 Node: Agenda files
\x7f120509
5966 Ref: Agenda files-Footnote-1
\x7f121469
5967 Ref: Agenda files-Footnote-2
\x7f121618
5968 Node: Agenda dispatcher
\x7f121811
5969 Node: Weekly/Daily agenda
\x7f123428
5970 Node: Calendar/Diary integration
\x7f124393
5971 Node: Global TODO list
\x7f125731
5972 Node: Matching headline tags
\x7f127891
5973 Node: Timeline
\x7f128949
5974 Node: Presentation and sorting
\x7f129612
5975 Node: Categories
\x7f130390
5976 Node: Time-of-day specifications
\x7f131054
5977 Node: Sorting of agenda items
\x7f133032
5978 Node: Agenda commands
\x7f134314
5979 Node: Custom agenda views
\x7f140552
5980 Node: Storing searches
\x7f141227
5981 Node: Block agenda
\x7f143139
5982 Node: Setting Options
\x7f144369
5983 Node: Batch processing
\x7f147081
5984 Node: Embedded LaTeX
\x7f148211
5985 Ref: Embedded LaTeX-Footnote-1
\x7f149303
5986 Node: Math symbols
\x7f149493
5987 Node: Subscripts and Superscripts
\x7f150258
5988 Node: LaTeX fragments
\x7f151102
5989 Ref: LaTeX fragments-Footnote-1
\x7f153210
5990 Node: Processing LaTeX fragments
\x7f153472
5991 Node: CDLaTeX mode
\x7f154418
5992 Ref: CDLaTeX mode-Footnote-1
\x7f156902
5993 Node: Exporting
\x7f157050
5994 Node: ASCII export
\x7f158364
5995 Node: HTML export
\x7f159654
5996 Node: XOXO export
\x7f162490
5997 Node: iCalendar export
\x7f162929
5998 Node: Text interpretation
\x7f164752
5999 Node: Comment lines
\x7f165231
6000 Node: Enhancing text
\x7f165702
6001 Node: Export options
\x7f167394
6002 Node: Publishing
\x7f169061
6003 Ref: Publishing-Footnote-1
\x7f169857
6004 Node: Configuration
\x7f170053
6005 Node: Project alist
\x7f170771
6006 Node: Sources and destinations
\x7f171837
6007 Node: Selecting files
\x7f172567
6008 Node: Publishing action
\x7f173315
6009 Node: Publishing options
\x7f174548
6010 Node: Publishing links
\x7f176700
6011 Node: Project page index
\x7f178213
6012 Node: Sample configuration
\x7f178991
6013 Node: Simple example
\x7f179483
6014 Node: Complex example
\x7f180156
6015 Node: Triggering publication
\x7f182232
6016 Node: Miscellaneous
\x7f182917
6017 Node: Completion
\x7f183551
6018 Node: Customization
\x7f185022
6019 Node: In-buffer settings
\x7f185607
6020 Node: The very busy C-c C-c key
\x7f189226
6021 Node: Clean view
\x7f190870
6022 Node: TTY keys
\x7f193447
6023 Node: Interaction
\x7f195056
6024 Node: Cooperation
\x7f195453
6025 Node: Conflicts
\x7f197320
6026 Node: Bugs
\x7f198912
6027 Node: Extensions and Hacking
\x7f200535
6028 Node: Extensions
\x7f201021
6029 Node: Dynamic blocks
\x7f202808
6030 Node: History and Acknowledgments
\x7f204735
6031 Node: Index
\x7f209742
6032 Node: Key Index
\x7f236903