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.77).
10 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation
12 Permission is granted to copy, distribute and/or modify this
13 document under the terms of the GNU Free Documentation License,
14 Version 1.1 or any later version published by the Free Software
15 Foundation; with no Invariant Sections, with the Front-Cover texts
16 being "A GNU Manual," and with the Back-Cover Texts as in (a)
17 below. A copy of the license is included in the section entitled
18 "GNU Free Documentation License."
20 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
21 modify this GNU Manual, like GNU software. Copies published by
22 the Free Software Foundation raise funds for GNU development."
25 File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
30 This manual is for Org-mode (version 4.77).
32 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation
34 Permission is granted to copy, distribute and/or modify this
35 document under the terms of the GNU Free Documentation License,
36 Version 1.1 or any later version published by the Free Software
37 Foundation; with no Invariant Sections, with the Front-Cover texts
38 being "A GNU Manual," and with the Back-Cover Texts as in (a)
39 below. A copy of the license is included in the section entitled
40 "GNU Free Documentation License."
42 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
43 modify this GNU Manual, like GNU software. Copies published by
44 the Free Software Foundation raise funds for GNU development."
48 * Introduction:: Getting started
49 * Document structure:: A tree works like your brain
50 * Tables:: Pure magic for quick formatting
51 * Hyperlinks:: Notes in context
52 * TODO items:: Every tree branch can be a TODO item
53 * Timestamps:: Assign date and time to items
54 * Tags:: Tagging headlines and matching sets of tags
55 * Agenda views:: Collecting information into views
56 * Embedded LaTeX:: LaTeX fragments and formulas
57 * Exporting:: Sharing and publishing of notes
58 * Publishing:: Create a web site of linked Org-mode files
59 * Miscellaneous:: All the rest which did not fit elsewhere
60 * Extensions and Hacking:: It is possible to write add-on code
61 * History and Acknowledgments:: How Org-mode came into being
62 * Index:: The fast road to specific information
63 * Key Index:: Key bindings and where they are described
65 --- The Detailed Node Listing ---
69 * Summary:: Brief summary of what Org-mode does
70 * Installation:: How to install a downloaded version of Org-mode
71 * Activation:: How to activate Org-mode for certain buffers.
72 * Feedback:: Bug reports, ideas, patches etc.
76 * Outlines:: Org-mode is based on outline-mode
77 * Headlines:: How to typeset org-tree headlines
78 * Visibility cycling:: Show and hide, much simplified
79 * Motion:: Jumping to other headlines
80 * Structure editing:: Changing sequence and level of headlines
81 * Archiving:: Move done task trees to a different place
82 * Sparse trees:: Matches embedded in context
83 * Plain lists:: Additional structure within an entry
87 * ARCHIVE tag:: Marking a tree as inactive
88 * Moving subtrees:: Moving a tree to an archive file
92 * Built-in table editor:: Simple tables
93 * Narrow columns:: Stop wasting space in tables
94 * Column groups:: Grouping to trigger vertical lines
95 * orgtbl-mode:: The table editor as minor mode
96 * The spreadsheet:: The table editor has spreadsheet capabilities.
100 * References:: How to refer to another field or range
101 * Formula syntax for Calc:: Using Calc to compute stuff
102 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
103 * Field formulas:: Formulas valid for a single field
104 * Column formulas:: Formulas valid for an entire column
105 * Editing and debugging formulas:: Fixing formulas
106 * Updating the table:: Recomputing all dependent fields
107 * Advanced features:: Field names, parameters and automatic recalc
111 * Link format:: How links in Org-mode are formatted
112 * Internal links:: Links to other places in the current file
113 * External links:: URL-like links to the world
114 * Handling links:: Creating, inserting and following
115 * Link abbreviations:: Shortcuts for writing complex links
116 * Search options:: Linking to a specific location
117 * Custom searches:: When the default search is not enough
118 * Remember:: Org-trees store quick notes
122 * Radio targets:: Make targets trigger links in plain text.
126 * Setting up remember:: Some code for .emacs to get things going
127 * Remember templates:: Define the outline of different note types
128 * Storing notes:: Directly get the note to where it belongs
132 * TODO basics:: Marking and displaying TODO entries
133 * TODO extensions:: Workflow and assignments
134 * Priorities:: Some things are more important than others
135 * Breaking down tasks:: Splitting a task into manageable pieces
136 * Checkboxes:: Tick-off lists
138 Extended use of TODO keywords
140 * Workflow states:: From TODO to DONE in steps
141 * TODO types:: I do this, Fred the rest
142 * Multiple sets in one file:: Mixing it all, and still finding your way
143 * Per file keywords:: Different files, different requirements
147 * Time stamps:: Assigning a time to a tree entry
148 * Creating timestamps:: Commands which insert timestamps
149 * Deadlines and scheduling:: Planning your work
150 * Progress logging:: Documenting when what work was done.
154 * The date/time prompt:: How org-mode helps you entering date and time
155 * Custom time format:: Making dates look differently
157 Deadlines and Scheduling
159 * Inserting deadline/schedule::
164 * Closing items:: When was this entry marked DONE?
165 * Tracking TODO state changes:: When did the status change?
166 * Clocking work time:: When exactly did you work on this item?
170 * Tag inheritance:: Tags use the tree structure of the outline
171 * Setting tags:: How to assign tags to a headline
172 * Tag searches:: Searching for combinations of tags
176 * Agenda files:: Files being searched for agenda information
177 * Agenda dispatcher:: Keyboard access to agenda views
178 * Built-in agenda views:: What is available out of the box?
179 * Presentation and sorting:: How agenda items are prepared for display
180 * Agenda commands:: Remote editing of org trees
181 * Custom agenda views:: Defining special searches and views
183 The built-in agenda views
185 * Weekly/Daily agenda:: The calendar page with current tasks
186 * Global TODO list:: All unfinished action items
187 * Matching headline tags:: Structured information with fine-tuned search
188 * Timeline:: Time-sorted view for single file
189 * Stuck projects:: Find projects you need to review
191 Presentation and sorting
193 * Categories:: Not all tasks are equal
194 * Time-of-day specifications:: How the agenda knows the time
195 * Sorting of agenda items:: The order of things
199 * Storing searches:: Type once, use often
200 * Block agenda:: All the stuff you need in a single buffer
201 * Setting Options:: Changing the rules
202 * Exporting Agenda Views:: Writing agendas to files.
203 * Extracting Agenda Information for other programs::
207 * Math symbols:: TeX macros for symbols and Greek letters
208 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
209 * LaTeX fragments:: Complex formulas made easy
210 * Processing LaTeX fragments:: Previewing LaTeX processing
211 * CDLaTeX mode:: Speed up entering of formulas
215 * ASCII export:: Exporting to plain ASCII
216 * HTML export:: Exporting to HTML
217 * XOXO export:: Exporting to XOXO
218 * iCalendar export:: Exporting in iCalendar format
219 * Text interpretation:: How the exporter looks at the file
223 * Export commands:: How to invoke HTML export
224 * Quoting HTML tags:: Using direct HTML in Org-mode
225 * Links:: How hyperlinks get transferred to HTML
226 * Images:: To inline or not to inline?
227 * CSS support:: Style specifications
229 Text interpretation by the exporter
231 * Comment lines:: Some lines will not be exported
232 * Initial text:: Text before the first headline
233 * Footnotes:: Numbers like [1]
234 * Enhancing text:: Subscripts, symbols and more
235 * Export options:: How to influence the export settings
239 * Configuration:: Defining projects
240 * Sample configuration:: Example projects
241 * Triggering publication:: Publication commands
245 * Project alist:: The central configuration variable
246 * Sources and destinations:: From here to there
247 * Selecting files:: What files are part of the project?
248 * Publishing action:: Setting the function doing the publishing
249 * Publishing options:: Tweaking HTML export
250 * Publishing links:: Which links keep working after publishing?
251 * Project page index:: Publishing a list of project files
255 * Simple example:: One-component publishing
256 * Complex example:: A multi-component publishing example
260 * Completion:: M-TAB knows what you need
261 * Customization:: Adapting Org-mode to your taste
262 * In-buffer settings:: Overview of the #+KEYWORDS
263 * The very busy C-c C-c key:: When in doubt, press C-c C-c
264 * Clean view:: Getting rid of leading stars in the outline
265 * TTY keys:: Using Org-mode on a tty
266 * Interaction:: Other Emacs packages
267 * Bugs:: Things which do not work perfectly
269 Interaction with other packages
271 * Cooperation:: Packages Org-mode cooperates with
272 * Conflicts:: Packages that lead to conflicts
274 Extensions, Hooks and Hacking
276 * Extensions:: Existing 3rd-part extensions
277 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
278 * Dynamic blocks:: Automatically filled blocks
279 * Special agenda views:: Customized views
281 Tables in arbitrary syntax
283 * Radio tables:: Sending and receiving
284 * A LaTeX example:: Step by step, almost a tutorial
285 * Translator functions:: Copy and modify
288 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
295 * Summary:: Brief summary of what Org-mode does
296 * Installation:: How to install a downloaded version of Org-mode
297 * Activation:: How to activate Org-mode for certain buffers.
298 * Feedback:: Bug reports, ideas, patches etc.
301 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
306 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
307 project planning with a fast and effective plain-text system.
309 Org-mode develops organizational tasks around NOTES files that
310 contain lists or information about projects as plain text. Org-mode is
311 implemented on top of outline-mode, which makes it possible to keep the
312 content of large files well structured. Visibility cycling and
313 structure editing help to work with the tree. Tables are easily created
314 with a built-in table editor. Org-mode supports ToDo items, deadlines,
315 time stamps, and scheduling. It dynamically compiles entries into an
316 agenda that utilizes and smoothly integrates much of the Emacs calendar
317 and diary. Plain text URL-like links connect to websites, emails,
318 Usenet messages, BBDB entries, and any files related to the projects.
319 For printing and sharing of notes, an Org-mode file can be exported as a
320 structured ASCII file, as HTML, or (todo and agenda items only) as an
321 iCalendar file. It can also serve as a publishing tool for a set of
324 An important design aspect that distinguishes Org-mode from for
325 example Planner/Muse is that it encourages to store every piece of
326 information only once. In Planner, you have project pages, day pages
327 and possibly other files, duplicating some information such as tasks.
328 In Org-mode, you only have notes files. In your notes you mark entries
329 as tasks, label them with tags and timestamps. All necessary lists
330 like a schedule for the day, the agenda for a meeting, tasks lists
331 selected by tags etc are created dynamically when you need them.
333 Org-mode keeps simple things simple. When first fired up, it should
334 feel like a straightforward, easy to use outliner. Complexity is not
335 imposed, but a large amount of functionality is available when you need
336 it. Org-mode can be used on different levels and in different ways, for
339 * outline extension with visibility cycling and structure editing
340 * ASCII system and table editor for taking structured notes
341 * ASCII table editor with spreadsheet-like capabilities
343 * full agenda and planner with deadlines and work scheduling
344 * environment to implement David Allen's GTD system
345 * simple hypertext system, with HTML export
346 * publishing tool to create a set of interlinked webpages
348 Org-mode's automatic, context sensitive table editor with spreadsheet
349 capabilities can be integrated into any major mode by activating the
350 minor Orgtbl-mode. Using a translation step, it can be used to maintain
351 tables in arbitrary file types, for example in LaTeX.
353 There is a website for Org-mode which provides links to the newest
354 version of Org-mode, as well as additional information, frequently asked
355 questions (FAQ), links to tutorials etc. This page is located at
356 `http://www.astro.uva.nl/~dominik/Tools/org/'.
359 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
364 Important: If Org-mode is part of the Emacs distribution or an XEmacs
365 package, please skip this section and go directly to *Note Activation::.
367 If you have downloaded Org-mode from the Web, you must take the
368 following steps to install it: Go into the Org-mode distribution
369 directory and edit the top section of the file `Makefile'. You must
370 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
371 and the paths to the directories where local Lisp and Info files are
372 kept. If you don't have access to the system-wide directories, create
373 your own two directories for these files, enter them into the Makefile,
374 and make sure Emacs finds the Lisp files by adding the following line
377 (setq load-path (cons "~/path/to/lispdir" load-path))
379 XEmacs users now need to install the file `noutline.el' from the
380 `xemacs' subdirectory of the Org-mode distribution. Use the command:
382 make install-noutline
384 Now byte-compile and install the Lisp files with the shell commands:
389 If you want to install the info documentation, use this command:
393 Then add to `.emacs':
395 ;; This line only if org-mode is not part of the X/Emacs distribution.
396 (require 'org-install)
399 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
404 Add the following lines to your `.emacs' file. The last two lines
405 define _global_ keys for the commands `org-store-link' and `org-agenda'
406 - please choose suitable keys yourself.
408 ;; The following lines are always needed. Choose your own keys.
409 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
410 (define-key global-map "\C-cl" 'org-store-link)
411 (define-key global-map "\C-ca" 'org-agenda)
413 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
414 because significant functionality depends on font-locking being active.
415 You can do this with either one of the following two lines (XEmacs
416 user must use the second option):
417 (global-font-lock-mode 1) ; for all buffers
418 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
420 With this setup, all files with extension `.org' will be put into
421 Org-mode. As an alternative, make the first line of a file look like
424 MY PROJECTS -*- mode: org; -*-
426 which will select Org-mode for this buffer no matter what the file's
427 name is. See also the variable `org-insert-mode-line-in-empty-file'.
430 File: org, Node: Feedback, Prev: Activation, Up: Introduction
435 If you find problems with Org-mode, or if you have questions, remarks,
436 or ideas about it, please contact the maintainer Carsten Dominik at
437 <dominik at science dot uva dot nl>.
439 For bug reports, please provide as much information as possible,
440 including the version information of Emacs (`C-h v emacs-version
441 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
442 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
443 can be very useful (see below on how to create one). Often a small
444 example file helps, along with clear information about:
446 1. What exactly did you do?
448 2. What did you expect to happen?
450 3. What happened instead?
451 Thank you for helping to improve this mode.
453 How to create a useful backtrace
454 ................................
456 If working with Org-mode produces an error with a message you don't
457 understand, you may have hit a bug. The best way to report this is by
458 providing, in addition to what was mentioned above, a _Backtrace_.
459 This is information from the built-in debugger about where and how the
460 error occurred. Here is how to produce a useful backtrace:
462 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
463 original Lisp code in `org.el' instead of the compiled version in
464 `org.elc'. The backtrace contains much more information if it is
465 produced with uncompiled code. To do this, either rename `org.elc'
466 to something else before starting Emacs, or ask Emacs explicitly
467 to load `org.el' by using the command line
468 emacs -l /path/to/org.el
470 2. Go to the `Options' menu and select `Enter Debugger on Error'
471 (XEmacs has this option in the `Troubleshooting' sub-menu).
473 3. Do whatever you have to do to hit the error. Don't forget to
474 document the steps you take.
476 4. When you hit the error, a `*Backtrace*' buffer will appear on the
477 screen. Save this buffer to a file (for example using `C-x C-w')
478 and attach it to your bug report.
481 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
486 Org-mode is based on outline mode and provides flexible commands to
487 edit the structure of the document.
491 * Outlines:: Org-mode is based on outline-mode
492 * Headlines:: How to typeset org-tree headlines
493 * Visibility cycling:: Show and hide, much simplified
494 * Motion:: Jumping to other headlines
495 * Structure editing:: Changing sequence and level of headlines
496 * Archiving:: Move done task trees to a different place
497 * Sparse trees:: Matches embedded in context
498 * Plain lists:: Additional structure within an entry
501 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
506 Org-mode is implemented on top of outline-mode. Outlines allow to
507 organize a document in a hierarchical structure, which (at least for
508 me) is the best representation of notes and thoughts. Overview over
509 this structure is achieved by folding (hiding) large parts of the
510 document to show only the general document structure and the parts
511 currently being worked on. Org-mode greatly simplifies the use of
512 outlines by compressing the entire show/hide functionality into a
513 single command `org-cycle', which is bound to the <TAB> key.
516 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
521 Headlines define the structure of an outline tree. The headlines in
522 Org-mode start with one or more stars, on the left margin(1). For
532 * Another top level headline
534 Some people find the many stars too noisy and would prefer an outline
535 that has whitespace followed by a single star as headline starters.
536 *Note Clean view:: describes a setup to realize this.
538 An empty line after the end of a subtree is considered part of it and
539 will be hidden when the subtree is folded. However, if you leave at
540 least two empty lines, one empty line will remain visible after folding
541 the subtree, in order to structure the collapsed view. See the
542 variable `org-cycle-separator-lines' for modifying this behavior.
544 ---------- Footnotes ----------
546 (1) See the variable `org-special-ctrl-a' to configure special
547 behavior of `C-a' in headlines.
550 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
552 2.3 Visibility cycling
553 ======================
555 Outlines make it possible to hide parts of the text in the buffer.
556 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
557 the visibility in the buffer.
560 _Subtree cycling_: Rotate current subtree among the states
562 ,-> FOLDED -> CHILDREN -> SUBTREE --.
563 '-----------------------------------'
565 The cursor must be on a headline for this to work(1). When the
566 cursor is at the beginning of the buffer and the first line is not
567 a headline, then <TAB> actually runs global cycling (see
568 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
569 global cycling is invoked.
573 _Global cycling_: Rotate the entire buffer among the states
575 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
576 '--------------------------------------'
578 When `S-<TAB>' is called with a numerical prefix N, the CONTENTS
579 view up to headlines of level N will be shown. Note that inside
580 tables, `S-<TAB>' jumps to the previous field.
586 Reveal context around point, showing the current entry, the
587 following heading and the hierarchy above. Useful for working
588 near a location exposed by a sparse tree command (*note Sparse
589 trees::) or an agenda command (*note Agenda commands::). With
590 prefix arg show, on each level, all sibling headings.
593 Show the current subtree in an indirect buffer(3). With numerical
594 prefix ARG, go up to this level and then take that tree. If ARG is
595 negative, go up that many levels. With `C-u' prefix, do not remove
596 the previously used indirect buffer.
598 When Emacs first visits an Org-mode file, the global state is set to
599 OVERVIEW, i.e. only the top level headlines are visible. This can be
600 configured through the variable `org-startup-folded', or on a per-file
601 basis by adding one of the following lines anywhere in the buffer:
607 ---------- Footnotes ----------
609 (1) see, however, the option `org-cycle-emulate-tab'.
611 (2) see the option `org-cycle-global-at-bob'.
613 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
614 Buffers.) will contain the entire buffer, but will be narrowed to the
615 current tree. Editing the indirect buffer will also change the
616 original buffer, but without affecting visibility in that buffer.
619 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
624 The following commands jump to other headlines in the buffer.
633 Next heading same level.
636 Previous heading same level.
639 Backward to higher level heading.
642 Jump to a different place without changing the current outline
643 visibility. Shows the document structure in a temporary buffer,
644 where you can use the following keys to find your destination:
645 <TAB> Cycle visibility.
646 <down> / <up> Next/previous visible headline.
647 n / p Next/previous visible headline.
648 f / b Next/previous headline same level.
651 <RET> Select this location.
654 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
656 2.5 Structure editing
657 =====================
660 Insert new heading with same level as current. If the cursor is
661 in a plain list item, a new item is created (*note Plain lists::).
662 To force creation of a new headline, use a prefix arg, or first
663 press <RET> to get to the beginning of the next line. When this
664 command is used in the middle of a line, the line is split and the
665 rest of the line becomes the new headline. If the command is used
666 at the beginning of a headline, the new headline is created before
667 the current line. If at the beginning of any other line, the
668 content of that line is made the new heading. If the command is
669 used at the end of a folded subtree (i.e. behind the ellipses at
670 the end of a headline), then a headline like the current one will
671 be inserted after the end of the subtree.
674 Insert new TODO entry with same level as current heading.
677 Promote current heading by one level.
680 Demote current heading by one level.
683 Promote the current subtree by one level.
686 Demote the current subtree by one level.
689 Move subtree up (swap with previous subtree of same level).
692 Move subtree down (swap with next subtree of same level).
696 Kill subtree, i.e. remove it from buffer but save in kill ring.
699 Copy subtree to kill ring.
702 Yank subtree from kill ring. This does modify the level of the
703 subtree to make sure the tree fits in nicely at the yank position.
704 The yank level can also be specified with a prefix arg, or by
705 yanking after a headline marker like `****'.
708 Sort same-level entries. When there is an active region, all
709 entries in the region will be sorted. Otherwise the children of
710 the current headline are sorted. The command prompts for the
711 sorting method, which can be alphabetically, numerically, by time
712 (using the first time stamp in each entry), and each of these in
713 reverse order. With a `C-u' prefix, sorting will be
714 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
715 will also be removed.
717 When there is an active region (transient-mark-mode), promotion and
718 demotion work on all headlines in the region. To select a region of
719 headlines, it is best to place both point and mark at the beginning of a
720 line, mark at the beginning of the first headline, and point at the line
721 just after the last headline to change. Note that when the cursor is
722 inside a table (*note Tables::), the Meta-Cursor keys have different
726 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
731 When a project represented by a (sub)tree is finished, you may want to
732 move the tree out of the way and to stop it from contributing to the
733 agenda. Org-mode knows two ways of archiving. You can mark a tree with
734 the ARCHIVE tag, or you can move an entire (sub)tree to a different
739 * ARCHIVE tag:: Marking a tree as inactive
740 * Moving subtrees:: Moving a tree to an archive file
743 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
745 2.6.1 The ARCHIVE tag
746 ---------------------
748 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
749 its location in the outline tree, but behaves in the following way:
750 - It does not open when you attempt to do so with a visibility
751 cycling command (*note Visibility cycling::). You can force
752 cycling archived subtrees with `C-<TAB>', or by setting the option
753 `org-cycle-open-archived-trees'. Also normal outline commands like
754 `show-all' will open archived subtrees.
756 - During sparse tree construction (*note Sparse trees::), matches in
757 archived subtrees are not exposed, unless you configure the option
758 `org-sparse-tree-open-archived-trees'.
760 - During agenda view construction (*note Agenda views::), the
761 content of archived trees is ignored unless you configure the
762 option `org-agenda-skip-archived-trees'.
764 - Archived trees are not exported (*note Exporting::), only the
765 headline is. Configure the details using the variable
766 `org-export-with-archived-trees'.
768 The following commands help managing the ARCHIVE tag:
771 Toggle the ARCHIVE tag for the current headline. When the tag is
772 set, the headline changes to a shadowish face, and the subtree
776 Check if any direct children of the current headline should be
777 archived. To do this, each subtree is checked for open TODO
778 entries. If none are found, the command offers to set the ARCHIVE
779 tag for the child. If the cursor is _not_ on a headline when this
780 command is invoked, the level 1 trees will be checked.
783 Cycle a tree even if it is tagged with ARCHIVE.
786 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
788 2.6.2 Moving subtrees
789 ---------------------
791 Once an entire project is finished, you may want to move it to a
792 different location, either in the current file, or even in a different
793 file, the archive file.
796 Archive the subtree starting at the cursor position to the location
797 given by `org-archive-location'.
800 Check if any direct children of the current headline could be
801 moved to the archive. To do this, each subtree is checked for
802 open TODO entries. If none are found, the command offers to move
803 it to the archive location. If the cursor is _not_ on a headline
804 when this command is invoked, the level 1 trees will be checked.
806 The default archive location is a file in the same directory as the
807 current file, with the name derived by appending `_archive' to the
808 current file name. For information and examples on how to change this,
809 see the documentation string of the variable `org-archive-location'.
810 There is also an in-buffer option for setting this variable, for example
814 You may have several such lines in the buffer, they will then be valid
815 for the entries following the line (the first will also apply to any
819 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
824 An important feature of Org-mode is the ability to construct _sparse
825 trees_ for selected information in an outline tree. A sparse tree
826 means that the entire document is folded as much as possible, but the
827 selected information is made visible along with the headline structure
828 above it(1). Just try it out and you will see immediately how it works.
830 Org-mode contains several commands creating such trees. The most
831 basic one is `org-occur':
834 Occur. Prompts for a regexp and shows a sparse tree with all
835 matches. If the match is in a headline, the headline is made
836 visible. If the match is in the body of an entry, headline and
837 body are made visible. In order to provide minimal context, also
838 the full hierarchy of headlines above the match is shown, as well
839 as the headline following the match. Each match is also
840 highlighted; the highlights disappear when the buffer is changes
841 an editing command, or by pressing `C-c C-c'. When called with a
842 `C-u' prefix argument, previous highlights are kept, so several
843 calls to this command can be stacked.
844 For frequently used sparse trees of specific search strings, you can
845 use the variable `org-agenda-custom-commands' to define fast keyboard
846 access to specific sparse trees. These commands will then be
847 accessible through the agenda dispatcher (*note Agenda dispatcher::).
850 (setq org-agenda-custom-commands
851 '(("f" occur-tree "FIXME")))
853 will define the key `C-c a f' as a shortcut for creating a sparse tree
854 matching the string `FIXME'.
856 Other commands use sparse trees as well. For example `C-c C-v'
857 creates a sparse TODO tree (*note TODO basics::).
859 To print a sparse tree, you can use the Emacs command
860 `ps-print-buffer-with-faces' which does not print invisible parts of
861 the document (2). Or you can use the command `C-c C-e v' to export
862 only the visible part of the document and print the resulting file.
864 ---------- Footnotes ----------
866 (1) See also the variables `org-show-hierarchy-above',
867 `org-show-following-heading', and `org-show-siblings' for detailed
868 control on how much context is shown around each match.
870 (2) This does not work under XEmacs, because XEmacs uses selective
871 display for outlining, not text properties.
874 File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
879 Within an entry of the outline tree, hand-formatted lists can provide
880 additional structure. They also provide a way to create lists of
881 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
882 and the HTML exporter (*note Exporting::) does parse and format them.
884 Org-mode knows ordered and unordered lists. Unordered list items
885 start with `-', `+', or `*'(1) as bullets. Ordered list items start
886 with `1.' or `1)'. Items belonging to the same list must have the same
887 indentation on the first line. In particular, if an ordered list
888 reaches number `10.', then the 2-digit numbers must be written
889 left-aligned with the other numbers in the list. Indentation also
890 determines the end of a list item. It ends before the next line that
891 is indented like the bullet/number, or less. Empty lines are part of
892 the previous item, so you can have several paragraphs in one item. If
893 you would like an emtpy line to terminate all currently open plain
894 lists, configure the variable `org-empty-line-terminates-plain-lists'.
895 Here is an for example:
898 My favorite scenes are (in this order)
899 1. The attack of the Rohirrim
900 2. Eowyns fight with the witch king
901 + this was already my favorite scene in the book
902 + I really like Miranda Otto.
903 3. Peter Jackson being shot by Legolas
905 He makes a really funny face when it happens.
906 But in the end, not individual scenes matter but the film as a whole.
908 Org-mode supports these lists by tuning filling and wrapping
909 commands to deal with them correctly(2).
911 The following commands act on items when the cursor is in the first
912 line of an item (the line with the bullet or number).
915 Items can be folded just like headline levels if you set the
916 variable `org-cycle-include-plain-lists'. The level of an item is
917 then given by the indentation of the bullet/number. Items are
918 always subordinate to real headlines, however; the hierarchies
919 remain completely separated.
922 Insert new item at current level. With prefix arg, force a new
923 heading (*note Structure editing::). If this command is used in
924 the middle of a line, the line is _split_ and the rest of the line
925 becomes the new item. If this command is executed in the
926 _whitespace before a bullet or number_, the new item is created
927 _before_ the current item. If the command is executed in the
928 white space before the text that is part of an item but does not
929 contain the bullet, a bullet is added to the current line.
932 Insert a new item with a checkbox (*note Checkboxes::).
936 Jump to the previous/next item in the current list.
940 Move the item including subitems up/down (swap with previous/next
941 item of same indentation). If the list is ordered, renumbering is
946 Decrease/increase the indentation of the item, including subitems.
947 Initially, the item tree is selected based on current indentation.
948 When these commands are executed several times in direct
949 succession, the initially selected region is used, even if the new
950 indentation would imply a different hierarchy. To use the new
951 hierarchy, break the command chain with a cursor motion or so.
954 If there is a checkbox (*note Checkboxes::) in the item line,
955 toggle the state of the checkbox. Otherwise, if this is an
956 ordered list, renumber the ordered list at the cursor.
958 ---------- Footnotes ----------
960 (1) When using `*' as a bullet, lines must be indented or they will
961 be seen as top-level headlines. Also, when you are hiding leading
962 stars to get a clean outline view, plain list items starting with a
963 star are visually indistinguishable from true headlines. In short:
964 even though `*' is supported, it may be better not to use it for plain
967 (2) Org-mode only changes the filling settings for Emacs. For
968 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
973 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
978 Org-mode has a very fast and intuitive table editor built-in.
979 Spreadsheet-like calculations are supported in connection with the
980 Emacs `calc' package.
984 * Built-in table editor:: Simple tables
985 * Narrow columns:: Stop wasting space in tables
986 * Column groups:: Grouping to trigger vertical lines
987 * orgtbl-mode:: The table editor as minor mode
988 * The spreadsheet:: The table editor has spreadsheet capabilities.
991 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
993 3.1 The built-in table editor
994 =============================
996 Org-mode makes it easy to format tables in plain ASCII. Any line with
997 `|' as the first non-white character is considered part of a table.
998 `|' is also the column separator. A table might look like this:
1000 | Name | Phone | Age |
1001 |-------+-------+-----|
1002 | Peter | 1234 | 17 |
1003 | Anna | 4321 | 25 |
1005 A table is re-aligned automatically each time you press <TAB> or
1006 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
1007 field (<RET> to the next row) and creates new table rows at the end of
1008 the table or before horizontal lines. The indentation of the table is
1009 set by the first line. Any line starting with `|-' is considered as a
1010 horizontal separator line and will be expanded on the next re-align to
1011 span the whole table width. So, to create the above table, you would
1017 and then press <TAB> to align the table and start filling in fields.
1019 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
1020 and all character keys in a special way, so that inserting and deleting
1021 avoids shifting other fields. Also, when typing _immediately after the
1022 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
1023 the field is automatically made blank. If this behavior is too
1024 unpredictable for you, configure the variables
1025 `org-enable-table-editor' and `org-table-auto-blank-field'.
1027 Creation and conversion
1028 .......................
1031 Convert the active region to table. If every line contains at
1032 least one TAB character, the function assumes that the material is
1033 tab separated. If not, lines are split at whitespace into fields.
1034 You can use a prefix argument to indicate the minimum number of
1035 consecutive spaces required to identify a field separator
1036 (default: just one).
1037 If there is no active region, this command creates an empty
1038 Org-mode table. But it's easier just to start typing, like
1039 `|Name|Phone|Age <RET> |- <TAB>'.
1041 Re-aligning and field motion
1042 ............................
1045 Re-align the table without moving the cursor.
1048 Re-align the table, move to the next field. Creates a new row if
1052 Re-align, move to previous field.
1055 Re-align the table and move down to next row. Creates a new row if
1056 necessary. At the beginning or end of a line, <RET> still does
1057 NEWLINE, so it can be used to split a table.
1059 Column and row editing
1060 ......................
1064 Move the current column left/right.
1067 Kill the current column.
1070 Insert a new column to the left of the cursor position.
1074 Move the current row up/down.
1077 Kill the current row or horizontal line.
1080 Insert a new row above (with arg: below) the current row.
1083 Insert a horizontal line below current row. With prefix arg, the
1084 line is created above the current line.
1087 Sort the table lines in the region. The position of point
1088 indicates the column to be used for sorting, and the range of
1089 lines is the range between the nearest horizontal separator lines,
1090 or the entire table. If point is before the first column, you
1091 will be prompted for the sorting column. If there is an active
1092 region, the mark specifies the first line and the sorting column,
1093 while point should be in the last line to be included into the
1094 sorting. The command prompts for the sorting type
1095 (alphabetically, numerically, or by time). When called with a
1096 prefix argument, alphabetic sorting will be case-sensitive.
1102 Copy a rectangular region from a table to a special clipboard.
1103 Point and mark determine edge fields of the rectangle. The
1104 process ignores horizontal separator lines.
1107 Copy a rectangular region from a table to a special clipboard, and
1108 blank all fields in the rectangle. So this is the "cut" operation.
1111 Paste a rectangular region into a table. The upper right corner
1112 ends up in the current field. All involved fields will be
1113 overwritten. If the rectangle does not fit into the present table,
1114 the table is enlarged as needed. The process ignores horizontal
1118 Wrap several fields in a column like a paragraph. If there is an
1119 active region, and both point and mark are in the same column, the
1120 text in the column is wrapped to minimum width for the given
1121 number of lines. A prefix ARG may be used to change the number of
1122 desired lines. If there is no region, the current field is split
1123 at the cursor position and the text fragment to the right of the
1124 cursor is prepended to the field one line down. If there is no
1125 region, but you specify a prefix ARG, the current field is made
1126 blank, and the content is appended to the field above.
1132 Sum the numbers in the current column, or in the rectangle defined
1133 by the active region. The result is shown in the echo area and can
1134 be inserted with `C-y'.
1137 When current field is empty, copy from first non-empty field above.
1138 When not empty, copy current field down to next row and move cursor
1139 along with it. Depending on the variable
1140 `org-table-copy-increment', integer field values will be
1141 incremented during copy. This key is also used by CUA-mode (*note
1148 Edit the current field in a separate window. This is useful for
1149 fields that are not fully visible (*note Narrow columns::). When
1150 called with a `C-u' prefix, just make the full field visible, so
1151 that it can be edited in place.
1154 This is an alias for `C-u C-c `' to make the current field fully
1157 `M-x org-table-import'
1158 Import a file as a table. The table should be TAB- or whitespace
1159 separated. Useful, for example, to import an Excel table or data
1160 from a database, because these programs generally can write
1161 TAB-separated text files. This command works by inserting the
1162 file into the buffer and then converting the region to a table.
1163 Any prefix argument is passed on to the converter, which uses it
1164 to determine the separator.
1167 Tables can also be imported by pasting tabular text into the
1168 org-mode buffer, selecting the pasted text with `C-x C-x' and then
1169 using the `C-c |' command (see above under Creation and conversion.
1171 `M-x org-table-export'
1172 Export the table as a TAB-separated file. Useful for data
1173 exchange with, for example, Excel or database programs.
1175 If you don't like the automatic table editor because it gets in your
1176 way on lines which you would like to start with `|', you can turn it
1179 (setq org-enable-table-editor nil)
1181 Then the only table command that still works is `C-c C-c' to do a
1185 File: org, Node: Narrow columns, Next: Column groups, Prev: Built-in table editor, Up: Tables
1190 The width of columns is automatically determined by the table editor.
1191 Sometimes a single field or a few fields need to carry more text,
1192 leading to inconveniently wide columns. To limit(1) the width of a
1193 column, one field anywhere in the column may contain just the string
1194 `<N>' where `N' is an integer specifying the width of the column in
1195 characters. The next re-align will then set the width of this column
1196 to no more than this value.
1198 |---+------------------------------| |---+--------|
1200 | 1 | one | | 1 | one |
1201 | 2 | two | ----\ | 2 | two |
1202 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1203 | 4 | four | | 4 | four |
1204 |---+------------------------------| |---+--------|
1206 Fields that are wider become clipped and end in the string `=>'. Note
1207 that the full text is still in the buffer, it is only invisible. To
1208 see the full text, hold the mouse over the field - a tool-tip window
1209 will show the full content. To edit such a field, use the command `C-c
1210 `' (that is `C-c' followed by the backquote). This will open a new
1211 window with the full field. Edit it and finish with `C-c C-c'.
1213 When visiting a file containing a table with narrowed columns, the
1214 necessary character hiding has not yet happened, and the table needs to
1215 be aligned before it looks nice. Setting the option
1216 `org-startup-align-all-tables' will realign all tables in a file upon
1217 visiting, but also slow down startup. You can also set this option on
1218 a per-file basis with:
1223 ---------- Footnotes ----------
1225 (1) This feature does not work on XEmacs.
1228 File: org, Node: Column groups, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1233 When Org-mode exports tables, it does so by default without vertical
1234 lines because that is visually more satisfying in general. Occasionally
1235 however, vertical lines can be useful to structure a table into groups
1236 of columns, much like horizontal lines can do for groups of rows. In
1237 order to specify column groups, you can use a special row where the
1238 first field contains only `/'. The further fields can either contain
1239 `<' to indicate that this column should start a group, `>' to indicate
1240 the end of a column, or `<>' to make a column a group of its own.
1241 Boundaries between colum groups will upon export be marked with
1242 vertical lines. Here is an example:
1244 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1245 |---+----+-----+-----+-----+---------+------------|
1246 | / | <> | < | | > | < | > |
1247 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1248 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1249 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1250 |---+----+-----+-----+-----+---------+------------|
1251 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
1253 It is also sufficient to just insert the colum group starters after
1254 every vertical line you'd like to have:
1256 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1257 |----+-----+-----+-----+---------+------------|
1261 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Column groups, Up: Tables
1263 3.4 The Orgtbl minor mode
1264 =========================
1266 If you like the intuitive way the Org-mode table editor works, you
1267 might also want to use it in other modes like text-mode or mail-mode.
1268 The minor mode Orgtbl-mode makes this possible. You can always toggle
1269 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1272 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1274 Furthermore, with some special setup, it is possible to maintain
1275 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1276 possible to construct LaTeX tables with the underlying ease and power of
1277 Orgtbl-mode, including spreadsheet capabilities. For details, see
1278 *Note Tables in arbitrary syntax::.
1281 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1286 The table editor makes use of the Emacs `calc' package to implement
1287 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1288 derive fields from other fields. While fully featured, Org-mode's
1289 implementation is not identical to other spreadsheets. For example,
1290 Org-mode knows the concept of a _column formula_ that will be applied
1291 to all non-header fields in a column without having to copy the formula
1292 to each relevant field.
1296 * References:: How to refer to another field or range
1297 * Formula syntax for Calc:: Using Calc to compute stuff
1298 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1299 * Field formulas:: Formulas valid for a single field
1300 * Column formulas:: Formulas valid for an entire column
1301 * Editing and debugging formulas:: Fixing formulas
1302 * Updating the table:: Recomputing all dependent fields
1303 * Advanced features:: Field names, parameters and automatic recalc
1306 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1311 To compute fields in the table from other fields, formulas must
1312 reference other fields or ranges. In Org-mode, fields can be referenced
1313 by name, by absolute coordinates, and by relative coordinates. To find
1314 out what the coordinates of a field are, press `C-c ?' in that field,
1315 or press `C-c }' to toggle the display of a grid.
1320 Formulas can reference the value of another field in two ways. Like in
1321 any other spreadsheet, you may reference fields with a letter/number
1322 combination like `B3', meaning the 2nd field in the 3rd row.
1324 Org-mode also uses another, more general operator that looks like this:
1327 Column references can be absolute like `1', `2',...`N', or relative to
1328 the current column like `+1' or `-2'.
1330 The row specification only counts data lines and ignores horizontal
1331 separator lines (hlines). You can use absolute row numbers `1'...`N',
1332 and row numbers relative to the current row like `+3' or `-1'. Or
1333 specify the row relative to one of the hlines: `I' refers to the first
1334 hline, `II' to the second etc. `-I' refers to the first such line
1335 above the current line, `+I' to the first such line below the current
1336 line. You can also write `III+2' which is the second data line after
1337 the third hline in the table. Relative row numbers like `-3' will not
1338 cross hlines if the current line is too close to the hline. Instead,
1339 the value directly at the hline is used.
1341 `0' refers to the current row and column. Also, if you omit either
1342 the column or the row part of the reference, the current row/column is
1345 Org-mode's references with _unsigned_ numbers are fixed references
1346 in the sense that if you use the same reference in the formula for two
1347 different fields, the same field will be referenced each time.
1348 Org-mode's references with _signed_ numbers are floating references
1349 because the same reference operator can reference different fields
1350 depending on the field being calculated by the formula.
1352 Here are a few examples:
1354 @2$3 2nd row, 3rd column
1356 $5 column 5 in the current row
1358 @2 current column, row 2
1359 @-1$-3 the field one row up, three columns to the left
1360 @-I$2 field just under hline above current row, column 2
1365 You may reference a rectangular range of fields by specifying two field
1366 references connected by two dots `..'. If both fields are in the
1367 current row, you may simply use `$2..$7', but if at least one field is
1368 in a different row, you need to use the general `@row$column' format at
1369 least for the first field (i.e the reference must start with `@' in
1370 order to be interpreted correctly). Examples:
1372 $1..$3 First three fields in the current row.
1373 $P..$Q Range, using column names (see under Advanced)
1374 @2$1..@4$3 6 fields between these two fields.
1375 A2..C4 Same as above.
1376 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1378 Range references return a vector of values that can be fed into Calc
1379 vector functions. Empty fields in ranges are normally suppressed, so
1380 that the vector contains only the non-empty fields (but see the `E'
1381 mode switch below). If there are no non-empty fields, `[0]' is
1382 returned to avoid syntax errors in formulas.
1387 `$name' is interpreted as the name of a column, parameter or constant.
1388 Constants are defined globally through the variable
1389 `org-table-formula-constants'. If you have the `constants.el' package,
1390 it will also be used to resolve constants, including natural constants
1391 like `$h' for Planck's constant, and units like `$km' for
1392 kilometers(1). Column names and parameters can be specified in special
1393 table lines. These are described below, see *Note Advanced features::.
1394 All names must start with a letter, and further consist of letters and
1397 ---------- Footnotes ----------
1399 (1) `Constant.el' can supply the values of constants in two
1400 different unit systems, `SI' and `cgs'. Which one is used depends on
1401 the value of the variable `constants-unit-system'. You can use the
1402 `#+STARTUP' options `constSI' and `constcgs' to set this value for the
1406 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1408 3.5.2 Formula syntax for Calc
1409 -----------------------------
1411 A formula can be any algebraic expression understood by the Emacs
1412 `Calc' package. Note that `calc' has the non-standard convention that
1413 `/' has lower precedence than `*', so that `a/b*c' is interpreted as
1414 `a/(b*c)'. Before evaluation by `calc-eval' (*note calc-eval:
1415 (calc)Calling Calc from Your Programs.), variable substitution takes
1416 place according to the rules described above. The range vectors can be
1417 directly fed into the calc vector functions like `vmean' and `vsum'.
1419 A formula can contain an optional mode string after a semicolon.
1420 This string consists of flags to influence Calc and other modes during
1421 execution. By default, Org-mode uses the standard calc modes (precision
1422 12, angular units degrees, fraction and symbolic modes off. The display
1423 format, however, has been changed to `(float 5)' to keep tables
1424 compact. The default settings can be configured using the variable
1425 `org-calc-default-modes'.
1427 p20 switch the internal precision to 20 digits
1428 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1429 D R angle modes: degrees, radians
1430 F S fraction and symbolic modes
1431 N interpret all fields as numbers, use 0 for non-numbers
1432 T force text interpretation
1433 E keep empty fields in ranges
1435 In addition, you may provide a `printf' format specifier to reformat
1436 the final result. A few examples:
1438 $1+$2 Sum of first and second field
1439 $1+$2;%.2f Same, format result to two decimals
1440 exp($2)+exp($1) Math functions can be used
1441 $0;%.1f Reformat current cell to 1 decimal
1442 ($3-32)*5/9 Degrees F -> C conversion
1443 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1444 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1445 sin($1);Dp3%.1e Same, but use printf specifier for display
1446 vmean($2..$7) Compute column range mean, using vector function
1447 vmean($2..$7);EN Same, but treat empty fields as 0
1448 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1450 Calc also contains a complete set of logical operations. For example
1452 if($1<20,teen,string("")) "teen" if age $1 less than 20, else empty
1455 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1457 3.5.3 Emacs Lisp forms as formulas
1458 ----------------------------------
1460 It is also possible to write a formula in Emacs Lisp; this can be useful
1461 for string manipulation and control structures, if the Calc's
1462 functionality is not enough. If a formula starts with a single quote
1463 followed by an opening parenthesis, then it is evaluated as a lisp form.
1464 The evaluation should return either a string or a number. Just as with
1465 `calc' formulas, you can specify modes and a printf format after a
1466 semicolon. A reference will be replaced with a string (in double
1467 quotes) containing the field. If you provide the `N' mode switch, all
1468 referenced elements will be numbers. Ranges are inserted as
1469 space-separated fields, so you can embed them in list or vector syntax.
1470 A few examples, note how the `N' mode is used when we do computations
1473 Swap the first two characters of the content of column 1
1474 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1475 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1477 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1478 '(apply '+ '($1..$4));N
1481 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1483 3.5.4 Field formulas
1484 --------------------
1486 To assign a formula to a particular field, type it directly into the
1487 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1488 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1489 will be stored as the formula for this field, evaluated, and the
1490 current field replaced with the result.
1492 Formulas are stored in a special line starting with `#+TBLFM:'
1493 directly below the table. If you typed the equation in the 4th field of
1494 the 3rd data line in the table, the formula will look like
1495 `@3$4=$1+$2'. When inserting/deleting/swapping column and rows with
1496 the appropriate commands, absolute references (but not relative ones)
1497 in stored formulas are modified in order to still reference the same
1498 field. Of cause this is not true if you edit the table structure with
1499 normal editing commands - then you must fix the equations yourself.
1501 Instead of typing an equation into the field, you may also use the
1505 Install a new formula for the current field. The command prompts
1506 for a formula, with default taken from the `#+TBLFM:' line, applies
1507 it to the current field and stores it.
1510 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1512 3.5.5 Column formulas
1513 ---------------------
1515 Often in a table, the same formula should be used for all fields in a
1516 particular column. Instead of having to copy the formula to all fields
1517 in that column, org-mode allows to assign a single formula to an entire
1518 column. If the table contains horizontal separator hlines, everything
1519 before the first such line is considered part of the table _header_ and
1520 will not be modified by column formulas.
1522 To assign a formula to a column, type it directly into any field in
1523 the column, preceded by an equal sign, like `=$1+$2'. When you press
1524 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1525 formula will be stored as the formula for the current column, evaluated
1526 and the current field replaced with the result. If the field contains
1527 only `=', the previously stored formula for this column is used. For
1528 each column, Org-mode will only remember the most recently used
1529 formula. In the `TBLFM:' line, column formulas will look like
1532 Instead of typing an equation into the field, you may also use the
1536 Install a new formula for the current column and replace current
1537 field with the result of the formula. The command prompts for a
1538 formula, with default taken from the `#+TBLFM' line, applies it to
1539 the current field and stores it. With a numerical prefix (e.g.
1540 `C-5 C-c =') will apply it to that many consecutive fields in the
1544 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1546 3.5.6 Editing and Debugging formulas
1547 ------------------------------------
1549 You can edit individual formulas in the minibuffer or directly in the
1550 field. Org-mode can also prepare a special buffer with all active
1551 formulas of a table. When offering a formula for editing, Org-mode
1552 converts references to the standard format (like `B3' or `D&') if
1553 possible. If you prefer to only work with the internal format (like
1554 `@3$2' or `$4'), configure the variable
1555 `org-table-use-standard-references'.
1559 Edit the formula associated with the current column/field in the
1560 minibuffer. See *Note Column formulas:: and *Note Field
1564 Re-insert the active formula (either a field formula, or a column
1565 formula) into the current field, so that you can edit it directly
1566 in the field. The advantage over editing in the minibuffer is
1567 that you can use the command `C-c ?'.
1570 While editing a formula in a table field, highlight the field(s)
1571 referenced by the reference at the cursor position in the formula.
1574 Toggle the display of row and column numbers for a table, using
1575 overlays. These are updated each time the table is aligned, you
1576 can force it with `C-c C-c'.
1579 Toggle the formula debugger on and off. See below.
1582 Edit all formulas for the current table in a special buffer, where
1583 the formulas will be displayed one per line. If the current field
1584 has an active formula, the cursor in the formula editor will mark
1585 it. While inside the special buffer, Org-mode will automatically
1586 highlight any field or range reference at the cursor position.
1587 You may edit, remove and add formulas, and use the following
1591 Exit the formula editor and store the modified formulas.
1592 With `C-u' prefix, also apply the new formulas to the entire
1596 Exit the formula editor without installing changes.
1599 Toggle all references in the formula editor between standard
1600 (like `B3') and internal (like `@3$2').
1603 Pretty-print or indent lisp formula at point. When in a line
1604 containing a lisp formula, format the formula according to
1605 Emacs Lisp rules. Another <TAB> collapses the formula back
1606 again. In the open formula, <TAB> re-indents just like in
1610 Complete Lisp symbols, just like in Emacs-lisp-mode.
1612 `S-<up>/<down>/<left>/<right>'
1613 Shift the reference at point. For example, if the reference
1614 is `B3' and you press `S-<right>', it will become `C3'. This
1615 also works for relative references, and for hline references.
1618 Move the test line for column formulas in the Org-mode buffer
1622 Scroll the window displaying the table.
1625 Turn the coordinate grid in the table on and off.
1627 Making a table field blank does not remove the formula associated
1628 with the field, because that is stored in a different line (the `TBLFM'
1629 line) - during the next recalculation the field will be filled again.
1630 To remove a formula from a field, you have to give an empty reply when
1631 prompted for the formula, or to edit the `#+TBLFM' line.
1633 You may edit the `#+TBLFM' directly and re-apply the changed
1634 equations with `C-c C-c' in that line, or with the normal recalculation
1635 commands in the table.
1640 When the evaluation of a formula leads to an error, the field content
1641 becomes the string `#ERROR'. If you would like see what is going on
1642 during variable substitution and calculation in order to find a bug,
1643 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1644 for example by pressing `C-u C-u C-c = <RET>' in a field. Detailed
1645 information will be displayed.
1648 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1650 3.5.7 Updating the Table
1651 ------------------------
1653 Recalculation of a table is normally not automatic, but needs to be
1654 triggered by a command. See *Note Advanced features:: for a way to make
1655 recalculation at least semi-automatically.
1657 In order to recalculate a line of a table or the entire table, use
1658 the following commands:
1661 Recalculate the current row by first applying the stored column
1662 formulas from left to right, and all field formulas in the current
1667 Recompute the entire table, line by line. Any lines before the
1668 first hline are left alone, assuming that these are part of the
1672 Iterate the table by recomputing it until no further changes occur.
1673 This may be necessary if some computed fields use the value of
1674 other fields that are computed later in the calculation sequence.
1677 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1679 3.5.8 Advanced features
1680 -----------------------
1682 If you want the recalculation of fields to happen automatically, or if
1683 you want to be able to assign names to fields and columns, you need to
1684 reserve the first column of the table for special marking characters.
1686 Rotate the calculation mark in first column through the states `',
1687 `#', `*', `!', `$'. The meaning of these characters is discussed
1688 below. When there is an active region, change all marks in the
1691 Here is an example of a table that collects exam results of students
1692 and makes use of these features:
1694 |---+---------+--------+--------+--------+-------+------|
1695 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1696 |---+---------+--------+--------+--------+-------+------|
1697 | ! | | P1 | P2 | P3 | Tot | |
1698 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1699 | ^ | | m1 | m2 | m3 | mt | |
1700 |---+---------+--------+--------+--------+-------+------|
1701 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1702 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1703 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1704 |---+---------+--------+--------+--------+-------+------|
1705 | | Average | | | | 29.7 | |
1706 | ^ | | | | | at | |
1707 | $ | max=50 | | | | | |
1708 |---+---------+--------+--------+--------+-------+------|
1709 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1711 Important: Please note that for these special tables, recalculating the
1712 table with `C-u C-c *' will only affect rows that are marked `#' or
1713 `*', and fields that have a formula assigned to the field itself. The
1714 column formulas are not applied in rows with empty first field.
1716 The marking characters have the following meaning:
1718 The fields in this line define names for the columns, so that you
1719 may refer to a column as `$Tot' instead of `$6'.
1722 This row defines names for the fields _above_ the row. With such
1723 a definition, any formula in the table may use `$m1' to refer to
1724 the value `10'. Also, if you assign a formula to a names field, it
1725 will be stored as `$name=...'.
1728 Similar to `^', but defines names for the fields in the row
1732 Fields in this row can define _parameters_ for formulas. For
1733 example, if a field in a `$' row contains `max=50', then formulas
1734 in this table can refer to the value 50 using `$max'. Parameters
1735 work exactly like constants, only that they can be defined on a
1739 Fields in this row are automatically recalculated when pressing
1740 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1741 selected for a global recalculation with `C-u C-c *'. Unmarked
1742 lines will be left alone by this command.
1745 Selects this line for global recalculation with `C-u C-c *', but
1746 not for automatic recalculation. Use this when automatic
1747 recalculation slows down editing too much.
1750 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1751 All lines that should be recalculated should be marked with `#' or
1755 Do not export this line. Useful for lines that contain the
1756 narrowing `<N>' markers.
1758 Finally, just to whet your appetite on what can be done with the
1759 fantastic `calc' package, here is a table that computes the Taylor
1760 series of degree `n' at location `x' for a couple of functions
1761 (homework: try that with Excel :-)
1763 |---+-------------+---+-----+--------------------------------------|
1764 | | Func | n | x | Result |
1765 |---+-------------+---+-----+--------------------------------------|
1766 | # | exp(x) | 1 | x | 1 + x |
1767 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1768 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1769 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1770 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1771 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1772 |---+-------------+---+-----+--------------------------------------|
1773 #+TBLFM: $5=taylor($2,$4,$3);n3
1776 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1781 Just like HTML, Org-mode provides links inside a file, and external
1782 links to other files, Usenet articles, emails, and much more.
1786 * Link format:: How links in Org-mode are formatted
1787 * Internal links:: Links to other places in the current file
1788 * External links:: URL-like links to the world
1789 * Handling links:: Creating, inserting and following
1790 * Link abbreviations:: Shortcuts for writing complex links
1791 * Search options:: Linking to a specific location
1792 * Custom searches:: When the default search is not enough
1793 * Remember:: Org-trees store quick notes
1796 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1801 Org-mode will recognize plain URL-like links and activate them as
1802 clickable links. The general link format, however, looks like this:
1804 [[link][description]] or alternatively [[link]]
1806 Once a link in the buffer is complete (all brackets present),
1807 Org-mode will change the display so that `description' is displayed
1808 instead of `[[link][description]]' and `link' is displayed instead of
1809 `[[link]]'. Links will be highlighted in the face `org-link', which by
1810 default is an underlined face. You can directly edit the visible part
1811 of a link. Note that this can be either the `link' part (if there is
1812 no description) or the `description' part. To edit also the invisible
1813 `link' part, use `C-c C-l' with the cursor on the link.
1815 If you place the cursor at the beginning or just behind the end of
1816 the displayed text and press <BACKSPACE>, you will remove the
1817 (invisible) bracket at that location. This makes the link incomplete
1818 and the internals are again displayed as plain text. Inserting the
1819 missing bracket hides the link internals again. To show the internal
1820 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1824 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1829 If the link does not look like a URL, it is considered to be internal in
1830 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1831 my target]]' lead to a text search in the current file. The link can
1832 be followed with `C-c C-o' when the cursor is on the link, or with a
1833 mouse click (*note Handling links::). The preferred match for such a
1834 link is a dedicated target: the same string in double angular brackets.
1835 Targets may be located anywhere; sometimes it is convenient to put
1836 them into a comment line. For example
1840 In HTML export (*note HTML export::), such targets will become named
1841 anchors for direct access through `http' links(1).
1843 If no dedicated target exists, Org-mode will search for the words in
1844 the link. In the above example the search would be for `my target'.
1845 Links starting with a star like `*My Target' restrict the search to
1846 headlines. When searching, Org-mode will first try an exact match, but
1847 then move on to more and more lenient searches. For example, the link
1848 `[[*My Targets]]' will find any of the following:
1851 ** TODO my targets are bright
1852 ** my 20 targets are
1854 To insert a link targeting a headline, in-buffer completion can be
1855 used. Just type a star followed by a few optional letters into the
1856 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1857 offered as completions. *Note Handling links::, for more commands
1860 Following a link pushes a mark onto Org-mode's own mark ring. You
1861 can return to the previous position with `C-c &'. Using this command
1862 several times in direct succession goes back to positions recorded
1867 * Radio targets:: Make targets trigger links in plain text.
1869 ---------- Footnotes ----------
1871 (1) Note that text before the first headline will never be exported,
1872 so the first such target must be after the first headline.
1875 File: org, Node: Radio targets, Prev: Internal links, Up: Internal links
1880 You can configure Org-mode to link any occurrences of certain target
1881 names in normal text. So without explicitly creating a link, the text
1882 connects to the target radioing its position. Radio targets are
1883 enclosed by triple angular brackets. For example, a target `<<<My
1884 Target>>>' causes each occurrence of `my target' in normal text to
1885 become activated as a link. The Org-mode file is scanned automatically
1886 for radio targets only when the file is first loaded into Emacs. To
1887 update the target list during editing, press `C-c C-c' with the cursor
1891 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1896 Org-mode supports links to files, websites, Usenet and email messages,
1897 and BBDB database entries. External links are URL-like locators. They
1898 start with a short identifying string followed by a colon. There can be
1899 no space after the colon. The following list shows examples for each
1902 http://www.astro.uva.nl/~dominik on the web
1903 file:/home/dominik/images/jupiter.jpg file, absolute path
1904 file:papers/last.pdf file, relative path
1905 news:comp.emacs Usenet link
1906 mailto:adent@galaxy.net Mail link
1907 vm:folder VM folder link
1908 vm:folder#id VM message link
1909 vm://myself@some.where.org/folder#id VM on remote machine
1910 wl:folder WANDERLUST folder link
1911 wl:folder#id WANDERLUST message link
1912 mhe:folder MH-E folder link
1913 mhe:folder#id MH-E message link
1914 rmail:folder RMAIL folder link
1915 rmail:folder#id RMAIL message link
1916 gnus:group GNUS group link
1917 gnus:group#id GNUS article link
1918 bbdb:Richard Stallman BBDB link
1919 shell:ls *.org A shell command
1920 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1922 A link should be enclosed in double brackets and may contain a
1923 descriptive text to be displayed instead of the url (*note Link
1924 format::), for example:
1926 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1928 If the description is a file name or URL that points to an image, HTML
1929 export (*note HTML export::) will inline the image as a clickable
1930 button. If there is no description at all and the link points to an
1931 image, that image will be inlined into the exported HTML file.
1933 Org-mode also finds external links in the normal text and activates
1934 them as links. If spaces must be part of the link (for example in
1935 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1936 the end of the link, enclose them in angular brackets.
1939 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1944 Org-mode provides methods to create a link in the correct syntax, to
1945 insert it into an org-mode file, and to follow the link.
1948 Store a link to the current location. This is a _global_ command
1949 which can be used in any buffer to create a link. The link will be
1950 stored for later insertion into an Org-mode buffer (see below).
1951 For Org-mode files, if there is a `<<target>>' at the cursor, the
1952 link points to the target. Otherwise it points to the current
1953 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1954 the link will indicate the current article/entry. For W3 and W3M
1955 buffers, the link goes to the current URL. For any other files,
1956 the link will point to the file, with a search string (*note
1957 Search options::) pointing to the contents of the current line.
1958 If there is an active region, the selected words will form the
1959 basis of the search string. If the automatically created link is
1960 not working correctly or accurately enough, you can write custom
1961 functions to select the search string and to do the search for
1962 particular file types - see *Note Custom searches::. The key
1963 binding `C-c l' is only a suggestion - see *Note Installation::.
1966 Insert a link. This prompts for a link to be inserted into the
1967 buffer. You can just type a link, using text for an internal
1968 link, or one of the link type prefixes mentioned in the examples
1969 above. All links stored during the current session are part of
1970 the history for this prompt, so you can access them with <up> and
1971 <down>. Completion, on the other hand, will help you to insert
1972 valid link prefixes like `http:' or `ftp:', including the prefixes
1973 defined through link abbreviations (*note Link abbreviations::).
1974 The link will be inserted into the buffer(1), along with a
1975 descriptive text. If some text was selected when this command is
1976 called, the selected text becomes the default description.
1977 Note that you don't have to use this command to insert a link.
1978 Links in Org-mode are plain text, and you can type or paste them
1979 straight into the buffer. By using this command, the links are
1980 automatically enclosed in double brackets, and you will be asked
1981 for the optional descriptive text.
1984 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1985 file will be inserted and you may use file name completion to
1986 select the name of the file. The path to the file is inserted
1987 relative to the directory of the current org file, if the linked
1988 file is in the current directory or in a subdirectory of it, or if
1989 the path is written relative to the current directory using `../'.
1990 Otherwise an absolute path is used, if possible with `~/' for
1991 your home directory. You can force an absolute path with two
1994 `C-c C-l (with cursor on existing link)'
1995 When the cursor is on an existing link, `C-c C-l' allows you to
1996 edit the link and description parts of the link.
1999 Open link at point. This will launch a web browser for URLs (using
2000 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
2001 the corresponding links, and execute the command in a shell link.
2002 When the cursor is on an internal link, this commands runs the
2003 corresponding search. When the cursor is on a TAG list in a
2004 headline, it creates the corresponding TAGS view. If the cursor
2005 is on a time stamp, it compiles the agenda for that date.
2006 Furthermore, it will visit text and remote files in `file:' links
2007 with Emacs and select a suitable application for local non-text
2008 files. Classification of files is based on file extension only.
2009 See option `org-file-apps'. If you want to override the default
2010 application and visit the file with Emacs, use a `C-u' prefix.
2014 On links, `mouse-2' will open the link just as `C-c C-o' would.
2015 Under Emacs 22, also `mouse-1' will follow a link.
2018 Like `mouse-2', but force file links to be opened with Emacs, and
2019 internal links to be displayed in another window(2).
2022 Push the current position onto the mark ring, to be able to return
2023 easily. Commands following an internal link do this automatically.
2026 Jump back to a recorded position. A position is recorded by the
2027 commands following internal links, and by `C-c %'. Using this
2028 command several times in direct succession moves through a ring of
2029 previously recorded positions.
2033 Move forward/backward to the next link in the buffer. At the
2034 limit of the buffer, the search fails once, and then wraps around.
2035 The key bindings for this are really too long, you might want to
2036 bind this also to `C-n' and `C-p'
2037 (add-hook 'org-load-hook
2039 (define-key 'org-mode-map "\C-n" 'org-next-link)
2040 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2042 ---------- Footnotes ----------
2044 (1) After insertion of a stored link, the link will be removed from
2045 the list of stored links. To keep it in the list later use, use a
2046 triple `C-u' prefix to `C-c C-l', or configure the option
2047 `org-keep-stored-link-after-insertion'.
2049 (2) See the variable `org-display-internal-link-with-indirect-buffer'
2052 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
2054 4.5 Link abbreviations
2055 ======================
2057 Long URLs can be cumbersome to type, and often many similar links are
2058 needed in a document. For this you can use link abbreviations. An
2059 abbreviated link looks like this
2061 [[linkword:tag][description]]
2063 where the tag is optional. Such abbreviations are resolved according to
2064 the information in the variable `org-link-abbrev-alist' that relates
2065 the linkwords to replacement text. Here is an example:
2067 (setq org-link-abbrev-alist
2068 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2069 ("google" . "http://www.google.com/search?q=")
2070 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2071 nph-abs_connect?author=%s&db_key=AST")))
2073 If the replacement text contains the string `%s', it will be
2074 replaced with the tag. Otherwise the tag will be appended to the string
2075 in order to create the link. You may also specify a function that will
2076 be called with the tag as the only argument to create the link.
2078 With the above setting, you could link to a specific bug with
2079 `[[bugzilla:129]]', search the web for `OrgMode' with
2080 `[[google:OrgMode]]' and find out what the Org-mode author is doing
2081 besides Emacs hacking with `[[ads:Dominik,C]]'.
2083 If you need special abbreviations just for a single Org-mode buffer,
2084 you can define them in the file with
2086 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
2087 #+LINK: google http://www.google.com/search?q=%s
2089 In-buffer completion *note Completion:: can be used after `[' to
2090 complete link abbreviations.
2093 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
2095 4.6 Search options in file links
2096 ================================
2098 File links can contain additional information to make Emacs jump to a
2099 particular location in the file when following a link. This can be a
2100 line number or a search option after a double(1) colon. For example,
2101 when the command `C-c l' creates a link (*note Handling links::) to a
2102 file, it encodes the words in the current line as a search string that
2103 can be used to find this line back later when following the link with
2106 Here is the syntax of the different ways to attach a search to a file
2107 link, together with an explanation:
2109 [[file:~/code/main.c::255]]
2110 [[file:~/xx.org::My Target]]
2111 [[file:~/xx.org::*My Target]]
2112 [[file:~/xx.org::/regexp/]]
2118 Search for a link target `<<My Target>>', or do a text search for
2119 `my target', similar to the search in internal links, see *Note
2120 Internal links::. In HTML export (*note HTML export::), such a
2121 file link will become an HTML reference to the corresponding named
2122 anchor in the linked file.
2125 In an Org-mode file, restrict search to headlines.
2128 Do a regular expression search for `regexp'. This uses the Emacs
2129 command `occur' to list all matches in a separate window. If the
2130 target file is in Org-mode, `org-occur' is used to create a sparse
2131 tree with the matches.
2133 As a degenerate case, a file link with an empty file name can be used
2134 to search the current file. For example, `[[file:::find me]]' does a
2135 search for `find me' in the current file, just as `[[find me]]' would.
2137 ---------- Footnotes ----------
2139 (1) For backward compatibility, line numbers can also follow a
2143 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
2148 The default mechanism for creating search strings and for doing the
2149 actual search related to a file link may not work correctly in all
2150 cases. For example, BibTeX database files have many entries like
2151 `year="1993"' which would not result in good search strings, because
2152 the only unique identification for a BibTeX entry is the citation key.
2154 If you come across such a problem, you can write custom functions to
2155 set the right search string for a particular file type, and to do the
2156 search for the string in the file. Using `add-hook', these functions
2157 need to be added to the hook variables
2158 `org-create-file-search-functions' and
2159 `org-execute-file-search-functions'. See the docstring for these
2160 variables for more information. Org-mode actually uses this mechanism
2161 for BibTeX database files, and you can use the corresponding code as an
2162 implementation example. Search for `BibTeX links' in the source file.
2165 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
2170 Another way to create org entries with links to other files is through
2171 the remember package by John Wiegley. Remember lets you store quick
2172 notes with little interruption of your work flow. See
2173 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2174 information. The notes produced by Remember can be stored in different
2175 ways, and Org-mode files are a good target. Org-mode significantly
2176 expands the possibilities of remember: You may define templates for
2177 different note types, and to associate target files and headlines with
2178 specific templates. It also allows you to select the location where a
2179 note should be stored interactively, on the fly.
2183 * Setting up remember:: Some code for .emacs to get things going
2184 * Remember templates:: Define the outline of different note types
2185 * Storing notes:: Directly get the note to where it belongs
2188 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
2190 4.8.1 Setting up remember
2191 -------------------------
2193 The following customization will tell remember to use org files as
2194 target, and to create annotations compatible with Org-mode links.
2196 (setq org-directory "~/path/to/my/orgfiles/")
2197 (setq org-default-notes-file "~/.notes")
2198 (setq remember-annotation-functions '(org-remember-annotation))
2199 (setq remember-handler-functions '(org-remember-handler))
2200 (add-hook 'remember-mode-hook 'org-remember-apply-template)
2203 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
2205 4.8.2 Remember templates
2206 ------------------------
2208 In combination with Org-mode, you can use templates to generate
2209 different types of remember notes. For example, if you would like to
2210 use one template to create general TODO entries, another one for
2211 journal entries, and a third one for collecting random ideas, you could
2214 (setq org-remember-templates
2215 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
2216 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
2217 (?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
2219 In these entries, the character specifies how to select the template.
2220 The first string specifies the template. Two more (optional) strings
2221 give the file in which, and the headline under which the new note
2222 should be stored. The file defaults (if not present or `nil') to
2223 `org-default-notes-file', the heading to
2224 `org-remember-default-headline'. Both defaults help to get to the
2225 storing location quickly, but you can change the location interactively
2226 while storing the note.
2228 When you call `M-x remember' (or `M-x org-remember') to remember
2229 something, org will prompt for a key to select the template (if you have
2230 more than one template) and then prepare the buffer like
2232 [[file:link to where you called remember]]
2236 * [2006-03-21 Tue 15:37]
2238 [[file:link to where you called remember]]
2240 During expansion of the template, special `%'-escapes allow dynamic
2241 insertion of content:
2242 %^{prompt} prompt the user for a string and replace this sequence with it.
2243 %t time stamp, date only
2244 %T time stamp with date and time
2245 %u, %U like the above, but inactive time stamps
2246 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
2247 You may define a prompt like `%^{Birthday}t'
2248 %n user name (taken from `user-full-name')
2249 %a annotation, normally the link created with `org-store-link'
2250 %i initial content, the region when remember is called with C-u.
2251 The entire text will be indented like `%i' itself.
2252 %:keyword specific information for certain link types, see below
2254 For specific link types, the following keywords will be defined:
2256 Link type | Available keywords
2257 -------------------+----------------------------------------------
2258 bbdb | %:name %:company
2259 vm, wl, mh, rmail | %:type %:subject %:message-id
2260 | %:from %:fromname %:fromaddress
2261 | %:to %:toname %:toaddress
2262 | %:fromto (either "to NAME" or "from NAME")(1)
2263 gnus | %:group, for messages also all email fields
2265 info | %:file %:node
2268 To place the cursor after template expansion use:
2270 %? After completing the template, position cursor here.
2272 If you change you mind about which template to use, call `org-remember'
2273 in the remember buffer. You may then select a new template that will
2274 be filled with the previous context information.
2276 ---------- Footnotes ----------
2278 (1) This will always be the other, not the user. See the variable
2279 `org-from-is-user-regexp'.
2282 File: org, Node: Storing notes, Prev: Remember templates, Up: Remember
2287 When you are finished preparing a note with remember, you have to press
2288 `C-c C-c' to file the note away. The handler first prompts for a
2289 target file - if you press <RET>, the value specified for the template
2290 is used. Then the command offers the headings tree of the selected
2291 file, with the cursor position at the default headline (if you had
2292 specified one in the template). You can either immediately press <RET>
2293 to get the note placed there. Or you can use the following keys to
2294 find a better location:
2295 <TAB> Cycle visibility.
2296 <down> / <up> Next/previous visible headline.
2297 n / p Next/previous visible headline.
2298 f / b Next/previous headline same level.
2300 Pressing <RET> or <left> or <right> then leads to the following
2303 Cursor Key Note gets inserted
2305 buffer-start <RET> as level 2 heading at end of file
2306 on headline <RET> as sublevel of the heading at cursor
2307 <left>/<right>as same level, before/after current heading
2308 not on <RET> at cursor position, level taken from context.
2311 So a fast way to store the note to its default location is to press
2312 `C-c C-c <RET> <RET>'. Even shorter would be `C-u C-c C-c', which does
2313 the same without even asking for a file or showing the tree.
2315 Before inserting the text into a tree, the function ensures that the
2316 text has a headline, i.e. a first line that starts with a `*'. If not,
2317 a headline is constructed from the current date and some additional
2318 data. If the variable `org-adapt-indentation' is non-nil, the entire
2319 text is also indented so that it starts in the same column as the
2320 headline (after the asterisks).
2323 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
2328 Org-mode does not maintain TODO lists as a separate document. TODO
2329 items are an integral part of the notes file, because TODO items
2330 usually come up while taking notes! With Org-mode, you simply mark any
2331 entry in a tree as being a TODO item. In this way, the information is
2332 not duplicated, and the entire context from which the item emerged is
2333 always present when you check.
2335 Of course, this technique causes TODO items to be scattered
2336 throughout your file. Org-mode provides methods to give you an
2337 overview over all things you have to do.
2341 * TODO basics:: Marking and displaying TODO entries
2342 * TODO extensions:: Workflow and assignments
2343 * Priorities:: Some things are more important than others
2344 * Breaking down tasks:: Splitting a task into manageable pieces
2345 * Checkboxes:: Tick-off lists
2348 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2350 5.1 Basic TODO functionality
2351 ============================
2353 Any headline can become a TODO item by starting it with the word TODO,
2356 *** TODO Write letter to Sam Fortune
2358 The most important commands to work with TODO entries are:
2361 Rotate the TODO state of the current item among
2363 ,-> (unmarked) -> TODO -> DONE --.
2364 '--------------------------------'
2366 The same rotation can also be done "remotely" from the timeline and
2367 agenda buffers with the `t' command key (*note Agenda commands::).
2371 Select the following/preceding TODO state, similar to cycling.
2372 Mostly useful if more than two TODO states are possible (*note
2376 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2377 the entire buffer, but shows all TODO items and the headings
2378 hierarchy above them. With prefix arg, search for a specific
2379 TODO. You will be prompted for the keyword, and you can also give
2380 a list of keywords like `kwd1|kwd2|...'. With numerical prefix N,
2381 show the tree for the Nth keyword in the variable
2382 `org-todo-keywords'. With two prefix args, find all TODO and DONE
2386 Show the global TODO list. This collects the TODO items from all
2387 agenda files (*note Agenda views::) into a single buffer. The
2388 buffer is in `agenda-mode', so there are commands to examine and
2389 manipulate the TODO entries directly from that buffer (*note
2390 Agenda commands::). *Note Global TODO list::, for more
2394 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2396 5.2 Extended use of TODO keywords
2397 =================================
2399 The default implementation of TODO entries is just two states: TODO and
2400 DONE. You can use the TODO feature for more complicated things by
2401 configuring the variable `org-todo-keywords'. With special setup, the
2402 TODO keyword system can work differently in different files.
2404 Note that tags are another way to classify headlines in general and
2405 TODO items in particular (*note Tags::).
2409 * Workflow states:: From TODO to DONE in steps
2410 * TODO types:: I do this, Fred the rest
2411 * Multiple sets in one file:: Mixing it all, and still finding your way
2412 * Per file keywords:: Different files, different requirements
2415 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2417 5.2.1 TODO keywords as workflow states
2418 --------------------------------------
2420 You can use TODO keywords to indicate different _sequential_ states in
2421 the process of working on an item, for example(1):
2423 (setq org-todo-keywords
2424 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2426 The vertical bar separates the TODO keywords (states that _need
2427 action_) from the DONE states (which need _no further action_. If you
2428 don't provide the separator bar, the last state is used as the DONE
2429 state. With this setup, the command `C-c C-t' will cycle an entry from
2430 TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
2431 You may also use a prefix argument to quickly select a specific state.
2432 For example `C-3 C-c C-t' will change the state immediately to VERIFY.
2433 If you define many keywords, you can use in-buffer completion (see
2434 *Note Completion::) to insert these words into the buffer. Changing a
2435 todo state can be logged with a timestamp, see *Note Tracking TODO
2436 state changes:: for more information.
2438 ---------- Footnotes ----------
2440 (1) Changing this variable only becomes effective after restarting
2441 Org-mode in a buffer.
2444 File: org, Node: TODO types, Next: Multiple sets in one file, Prev: Workflow states, Up: TODO extensions
2446 5.2.2 TODO keywords as types
2447 ----------------------------
2449 The second possibility is to use TODO keywords to indicate different
2450 _types_ of action items. For example, you might want to indicate that
2451 items are for "work" or "home". Or, when you work with several people
2452 on a single project, you might want to assign action items directly to
2453 persons, by using their names as TODO keywords. This would be set up
2456 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2458 In this case, different keywords do not indicate a sequence, but
2459 rather different types. So the normal work flow would be to assign a
2460 task to a person, and later to mark it DONE. Org-mode supports this
2461 style by adapting the workings of the command `C-c C-t'(1). When used
2462 several times in succession, it will still cycle through all names, in
2463 order to first select the right type for a task. But when you return
2464 to the item after some time and execute `C-c C-t' again, it will switch
2465 from any name directly to DONE. Use prefix arguments or completion to
2466 quickly select a specific name. You can also review the items of a
2467 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2468 C-v'. For example, to see all things Lucy has to do, you would use
2469 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2470 single buffer, you would use the prefix arg as well when creating the
2471 global todo list: `C-3 C-c t'.
2473 ---------- Footnotes ----------
2475 (1) This is also true for the `t' command in the timeline and agenda
2479 File: org, Node: Multiple sets in one file, Next: Per file keywords, Prev: TODO types, Up: TODO extensions
2481 5.2.3 Multiple keyword sets in one file
2482 ---------------------------------------
2484 Sometimes you may want to use different sets of TODO keywords in
2485 parallel. For example, you may want to have the basic `TODO'/`DONE',
2486 but also a workflow for bug fixing, and a separate state indicating
2487 that an item has been canceled (so it is not DONE, but also does not
2488 require action). Your setup would then look like this:
2490 (setq org-todo-keywords
2491 '((sequence "TODO" "|" "DONE")
2492 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2493 (sequence "|" "CANCELED")))
2495 The keywords should all be different, this helps Org-mode to keep
2496 track of which subsequence should be used for a given entry. In this
2497 setup, `C-c C-t' only operates within a subsequence, so it switches from
2498 `DONE' to (nothing) to `TODO', and from `FIXED' to (nothing) to
2499 `REPORT'. Therefore you need a mechanism to initially select the
2500 correct sequence. Besides the obvious ways like typing a keyword or
2501 using completion, you may also apply the following commands:
2505 These keys jump from one TODO subset to the next. In the above
2506 example, `C-S-<right>' would jump from `TODO' or `DONE' to
2507 `REPORT', and any of the words in the second row to `CANCELED'.
2511 `S-<<left>>' and `S-<<right>>' and walk through _all_ keywords
2512 from all sets, so for example `S-<<right>>' would switch from
2513 `DONE' to `REPORT' in the example above.
2516 File: org, Node: Per file keywords, Prev: Multiple sets in one file, Up: TODO extensions
2518 5.2.4 Setting up keywords for individual files
2519 ----------------------------------------------
2521 It can be very useful to use different aspects of the TODO mechanism in
2522 different files. For file-local settings, you need to add special lines
2523 to the file which set the keywords and interpretation for that file
2524 only. For example, to set one of the two examples discussed above, you
2525 need one of the following lines, starting in column zero anywhere in the
2528 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2530 #+TYP_TODO: Fred Sara Lucy Mike | DONE
2532 A setup for using several sets in parallel would be:
2534 #+SEQ_TODO: "TODO" "|" "DONE"
2535 #+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED"
2536 #+SEQ_TODO: "|" "CANCELED"
2538 To make sure you are using the correct keyword, type `#+' into the
2539 buffer and then use `M-<TAB>' completion.
2541 Remember that the keywords after the vertical bar (or the last
2542 keyword if no bar is there) must always mean that the item is DONE
2543 (although you may use a different word). After changing one of these
2544 lines, use `C-c C-c' with the cursor still in the line to make the
2545 changes known to Org-mode(1).
2547 ---------- Footnotes ----------
2549 (1) Org-mode parses these lines only when Org-mode is activated
2550 after visiting a file. `C-c C-c' with the cursor in a line starting
2551 with `#+' is simply restarting Org-mode for the current buffer.
2554 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2559 If you use Org-mode extensively to organize your work, you may end up
2560 with a number of TODO entries so large that you'd like to prioritize
2561 them. This can be done by placing a _priority cookie_ into the
2564 *** TODO [#A] Write letter to Sam Fortune
2566 With its standard setup, Org-mode supports priorities `A', `B', and
2567 `C'. `A' is the highest priority. An entry without a cookie is
2568 treated as priority `B'. Priorities make a difference only in the
2569 agenda (*note Weekly/Daily agenda::).
2572 Set the priority of the current headline. The command prompts for
2573 a priority character `A', `B' or `C'. When you press <SPC>
2574 instead, the priority cookie is removed from the headline. The
2575 priorities can also be changed "remotely" from the timeline and
2576 agenda buffer with the `,' command (*note Agenda commands::).
2580 Increase/decrease priority of current headline. Note that these
2581 keys are also used to modify time stamps (*note Creating
2582 timestamps::). Furthermore, these keys are also used by CUA-mode
2583 (*note Conflicts::).
2585 You can change the range of allowed priorities by setting the
2586 variables `org-highest-priority', `org-lowest-priority', and
2587 `org-default-priority'. For an individual buffer, you may set these
2588 values (highest, lowest, default) like this (please make sure that the
2589 highest priority is earlier in the alphabet than the lowest priority):
2594 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2596 5.4 Breaking tasks down into subtasks
2597 =====================================
2599 It is often advisable to break down large tasks into smaller, manageable
2600 subtasks. You can do this by creating an outline tree below a TODO
2601 item, with detailed subtasks on the tree(1). Another possibility is
2602 the use of checkboxes to identify (a hierarchy of) a large number of
2603 subtasks (*note Checkboxes::).
2605 ---------- Footnotes ----------
2607 (1) To keep subtasks out of the global TODO list, see the
2608 `org-agenda-todo-list-sublevels'.
2611 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2616 Every item in a plain list (*note Plain lists::) can be made a checkbox
2617 by starting it with the string `[ ]'. This feature is similar to TODO
2618 items (*note TODO items::), but more lightweight. Checkboxes are not
2619 included into the global TODO list, so they are often great to split a
2620 task into a number of simple steps. Or you can use them in a shopping
2621 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2622 `org-mouse.el'. Here is an example of a checkbox list.
2624 * TODO Organize party [3/6]
2630 - [ ] think about what music to play
2631 - [X] talk to the neighbors
2633 The `[3/6]' and `[1/3]' in the first and second line are cookies
2634 indicating how many checkboxes are present in this entry, and how many
2635 of them have been checked off. This can give you an idea on how many
2636 checkboxes remain, even without opening a folded entry. The cookies
2637 can be placed into a headline or into (the first line of) a plain list
2638 item. Each cookie covers all checkboxes structurally below that
2639 headline/item. You have to insert the cookie yourself by typing either
2640 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2641 the second case you get information about the percentage of checkboxes
2642 checked (in the above example, this would be `[50%]' and `[33%],
2645 The following commands work with checkboxes:
2648 Toggle checkbox at point.
2651 Toggle checkbox at point.
2652 - If there is an active region, toggle the first checkbox in
2653 the region and set all remaining boxes to the same status as
2654 the first. If you want to toggle all boxes in the region
2655 independently, use a prefix argument.
2657 - If the cursor is in a headline, toggle checkboxes in the
2658 region between this headline and the next (so _not_ the
2661 - If there is no active region, just toggle the checkbox at
2665 Insert a new item with a checkbox. This works only if the cursor
2666 is already in a plain list item (*note Plain lists::).
2669 Update the checkbox statistics in the current outline entry. When
2670 called with a `C-u' prefix, update the entire file. Checkbox
2671 statistic cookies are updated automatically if you toggle
2672 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2673 you delete boxes or add/change them by hand, use this command to
2674 get things back into synch. Or simply toggle any checkbox twice
2678 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2683 Items can be labeled with timestamps to make them useful for project
2688 * Time stamps:: Assigning a time to a tree entry
2689 * Creating timestamps:: Commands which insert timestamps
2690 * Deadlines and scheduling:: Planning your work
2691 * Progress logging:: Documenting when what work was done.
2694 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2696 6.1 Time stamps, deadlines and scheduling
2697 =========================================
2699 A time stamp is a specification of a date (possibly with time) in a
2700 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue
2701 09:39>'(1). A time stamp can appear anywhere in the headline or body
2702 of an org-tree entry. Its presence causes entries to be shown on
2703 specific dates in the agenda (*note Weekly/Daily agenda::). We
2707 A simple time stamp just assigns a date/time to an item. This is
2708 just like writing down an appointment in a paper agenda, or like
2709 writing down an event in a diary, when you want to take note of
2710 when something happened. In the timeline and agenda displays, the
2711 headline of an entry associated with a plain time stamp will be
2712 shown exactly on that date.
2714 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2716 TIME STAMP WITH REPEATER INTERVAL
2717 A time stamp may contain a _repeater interval_, indicating that it
2718 applies not only on the given date, but again and again after a
2719 certain interval of N days (d), weeks (w), months(m), or years(y).
2720 The following will show up in the agenda every Wednesday:
2722 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
2724 DIARY-STYLE SEXP ENTRIES
2725 For more complex date specifications, Org-mode supports using the
2726 special sexp diary entries implemented in the Emacs calendar/diary
2727 package. For example
2729 * The nerd meeting on every 2nd Thursday of the month
2730 <%%(diary-float t 4 2)>
2733 Two time stamps connected by `--' denote a range. The headline
2734 will be shown on the first and last day of the range, and on any
2735 dates that are displayed and fall in the range. Here is an
2738 ** Meeting in Amsterdam
2739 <2004-08-23 Mon>--<2004-08-26 Thu>
2742 Just like a plain time stamp, but with square brackets instead of
2743 angular ones. These time stamps are inactive in the sense that
2744 they do _not_ trigger an entry to show up in the agenda.
2746 * Gillian comes late for the fifth time [2006-11-01 Wed]
2749 ---------- Footnotes ----------
2751 (1) This is the standard ISO date/time format. If you cannot get
2752 used to these, see *Note Custom time format::
2755 File: org, Node: Creating timestamps, Next: Deadlines and scheduling, Prev: Time stamps, Up: Timestamps
2757 6.2 Creating timestamps
2758 =======================
2760 For Org-mode to recognize time stamps, they need to be in the specific
2761 format. All commands listed below produce time stamps in the correct
2765 Prompt for a date and insert a corresponding time stamp. When the
2766 cursor is at a previously used time stamp, it is updated to NOW.
2767 When this command is used twice in succession, a time range is
2771 Like `C-c .', but use the alternative format which contains date
2772 and time. The default time can be rounded to multiples of 5
2773 minutes, see the option `org-time-stamp-rounding-minutes'.
2776 Like `C-c .', but insert an inactive time stamp that will not cause
2780 Insert a time stamp corresponding to the cursor date in the
2784 Access the Emacs calendar for the current date. If there is a
2785 timestamp in the current line, goto the corresponding date instead.
2788 Access the agenda for the date given by the time stamp or -range at
2789 point (*note Weekly/Daily agenda::).
2793 Change date at cursor by one day. These key bindings conflict with
2794 CUA-mode (*note Conflicts::).
2798 Change the item under the cursor in a timestamp. The cursor can
2799 be on a year, month, day, hour or minute. Note that if the cursor
2800 is in a headline and not at a time stamp, these same keys modify
2801 the priority of an item. (*note Priorities::). The key bindings
2802 also conflict with CUA-mode (*note Conflicts::).
2805 Evaluate a time range by computing the difference between start and
2806 end. With prefix arg, insert result after the time range (in a
2807 table: into the following column).
2811 * The date/time prompt:: How org-mode helps you entering date and time
2812 * Custom time format:: Making dates look differently
2815 File: org, Node: The date/time prompt, Next: Custom time format, Prev: Creating timestamps, Up: Creating timestamps
2817 6.2.1 The date/time prompt
2818 --------------------------
2820 When Org-mode prompts for a date/time, the prompt suggests to enter an
2821 ISO date. But it will in fact accept any string containing some date
2822 and/or time information. You can, for example, use `C-y' to paste a
2823 (possibly multi-line) string copied from an email message. Org-mode
2824 will find whatever information is in there and will replace anything not
2825 specified with the current date and time. For example:
2827 3-2-5 --> 2003-02-05
2828 feb 15 --> currentyear-02-15
2829 sep 12 9 --> 2009-09-12
2830 12:45 --> today 12:45
2831 22 sept 0:34 --> currentyear-09-22 0:34
2832 12 --> currentyear-currentmonth-12
2833 Fri --> nearest Friday (today or later)
2834 +4 --> 4 days from now (if +N is the only thing given)
2836 The function understands English month and weekday abbreviations. If
2837 you want to use unabbreviated names and/or other languages, configure
2838 the variables `parse-time-months' and `parse-time-weekdays'.
2840 Parallel to the minibuffer prompt, a calendar is popped up(1). When
2841 you exit the date prompt, either by clicking on a date in the calendar,
2842 or by pressing <RET>, the date selected in the calendar will be
2843 combined with the information entered at the prompt. You can control
2844 the calendar fully from the minibuffer:
2847 Scroll calendar backwards by one month.
2850 Scroll calendar forwards by one month.
2853 Select date by clicking on it.
2874 Choose date in calendar (only if nothing was typed into
2877 ---------- Footnotes ----------
2879 (1) If you don't need/want the calendar, configure the variable
2880 `org-popup-calendar-for-date-prompt'.
2883 File: org, Node: Custom time format, Prev: The date/time prompt, Up: Creating timestamps
2885 6.2.2 Custom time format
2886 ------------------------
2888 Org-mode uses the standard ISO notation for dates and times as it is
2889 defined in ISO 8601. If you cannot get used to this and require another
2890 representation of date and time to keep you happy, you can get it by
2891 customizing the variables `org-display-custom-times' and
2892 `org-time-stamp-custom-formats'.
2895 Toggle the display of custom formats for dates and times.
2897 Org-mode needs the default format for scanning, so the custom date/time
2898 format does not _replace_ the default format - instead it is put _over_
2899 the default format using text properties. This has the following
2901 * You cannot place the cursor onto a time stamp anymore, only before
2904 * The `S-<up>/<down>' keys can no longer be used to adjust each
2905 component of a time stamp. If the cursor is at the beginning of
2906 the stamp, `S-<up>/<down>' will change the stamp by one day, just
2907 like `S-<left>/<right>'. At the end of the stamp, the time will
2908 be changed by one minute.
2910 * When you delete a time stamp character-by-character, it will only
2911 disappear from the buffer after _all_ (invisible) characters
2912 belonging to the ISO timestamp have been removed.
2914 * If the custom time stamp format is longer than the default and you
2915 are using dates in tables, table alignment will be messed up. If
2916 the custom format is shorter, things do work as expected.
2919 File: org, Node: Deadlines and scheduling, Next: Progress logging, Prev: Creating timestamps, Up: Timestamps
2921 6.3 Deadlines and Scheduling
2922 ============================
2924 A time stamp may be preceded by special keywords to facilitate planning
2928 The task (most likely a TODO item) is supposed to be finished on
2929 that date, and it will be listed then. In addition, the
2930 compilation for _today_ will carry a warning about the approaching
2931 or missed deadline, starting `org-deadline-warning-days' before
2932 the due date, and continuing until the entry is marked DONE. An
2935 *** TODO write article about the Earth for the Guide
2936 The editor in charge is [[bbdb:Ford Prefect]]
2937 DEADLINE: <2004-02-29 Sun>
2940 You are planning to start working on that task on the given date.
2941 The headline will be listed under the given date(1). In addition,
2942 a reminder that the scheduled date has passed will be present in
2943 the compilation for _today_, until the entry is marked DONE.
2944 I.e., the task will automatically be forwarded until completed.
2946 *** TODO Call Trillian for a date on New Years Eve.
2947 SCHEDULED: <2004-12-25 Sat>
2951 * Inserting deadline/schedule::
2954 ---------- Footnotes ----------
2956 (1) It will still be listed on that date after it has been marked
2957 DONE. If you don't like this, set the variable
2958 `org-agenda-skip-scheduled-if-done'.
2961 File: org, Node: Inserting deadline/schedule, Next: Repeated tasks, Prev: Deadlines and scheduling, Up: Deadlines and scheduling
2963 6.3.1 Inserting deadline/schedule
2964 ---------------------------------
2966 The following commands allow to quickly insert a deadline or to schedule
2970 Insert `DEADLINE' keyword along with a stamp. The insertion will
2971 happen in the line directly following the headline.
2974 Create a sparse tree with all deadlines that are either past-due,
2975 or which will become due within `org-deadline-warning-days'. With
2976 `C-u' prefix, show all deadlines in the file. With a numeric
2977 prefix, check that many days. For example, `C-1 C-c C-w' shows
2978 all deadlines due tomorrow.
2981 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2982 happen in the line directly following the headline. Any CLOSED
2983 timestamp will be removed.
2986 File: org, Node: Repeated tasks, Prev: Inserting deadline/schedule, Up: Deadlines and scheduling
2988 6.3.2 Repeated Tasks
2989 --------------------
2991 Some tasks need to be repeated again and again, and Org-mode therefore
2992 allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for
2994 ** TODO Pay the rent
2995 DEADLINE: <2005-10-01 Sat +1m>
2997 Deadlines and scheduled items produce entries in the agenda when they
2998 are over-due, so it is important to be able to mark such an entry as
2999 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
3000 with the todo keyword DONE, it will no longer produce entries in the
3001 agenda. The problem with this is, however, that then also the _next_
3002 instance of the repeated entry will not be active. Org-mode deals with
3003 this in the following way: When you try to mark such an entry DONE
3004 (using `C-c C-t'), it will shift the base date of the repeating time
3005 stamp by the repeater interval, and immediately set the entry state
3006 back to TODO. In the example above, setting the state to DONE would
3007 actually switch the date like this:
3009 ** TODO Pay the rent
3010 DEADLINE: <2005-11-01 Tue +1m>
3012 You will also be prompted for a note that will be put under the
3013 DEADLINE line to keep a record that you actually acted on the previous
3014 instance of this deadline.
3016 As a consequence of shifting the base date, this entry will no
3017 longer be visible in the agenda when checking past dates, but all
3018 future instances will be visible.
3020 You may have both scheduling and deadline information for a specific
3021 task - just make sure that the repeater intervals on both are the same.
3024 File: org, Node: Progress logging, Prev: Deadlines and scheduling, Up: Timestamps
3026 6.4 Progress Logging
3027 ====================
3029 Org-mode can automatically record a time stamp when you mark a TODO item
3030 as DONE, or even each time when you change the state of a TODO item.
3031 You can also measure precisely the time you spent on specific items in a
3032 project by starting and stopping a clock when you start and stop working
3033 on an aspect of a project.
3037 * Closing items:: When was this entry marked DONE?
3038 * Tracking TODO state changes:: When did the status change?
3039 * Clocking work time:: When exactly did you work on this item?
3042 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
3047 If you want to keep track of _when_ a certain TODO item was finished,
3048 turn on logging with(1)
3050 (setq org-log-done t)
3052 Then each time you turn a TODO entry into DONE using either `C-c C-t'
3053 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
3054 [timestamp]' will be inserted just after the headline. If you turn the
3055 entry back into a TODO item through further state cycling, that line
3056 will be removed again. In the timeline (*note Timeline::) and in the
3057 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
3058 display the TODO items closed on each day, giving you an overview of
3059 what has been done on a day. If you want to record a note along with
3060 the timestamp, use(2)
3062 (setq org-log-done '(done))
3064 ---------- Footnotes ----------
3066 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
3068 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
3071 File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
3073 6.4.2 Tracking TODO state changes
3074 ---------------------------------
3076 When TODO keywords are used as workflow states (*note Workflow
3077 states::), you might want to keep track of when a state change occurred,
3078 and you may even want to attach notes to that state change. With the
3081 (setq org-log-done '(state))
3083 each state change will prompt you for a note that will be attached to
3084 the current headline. Very likely you do not want this verbose tracking
3085 all the time, so it is probably better to configure this behavior with
3086 in-buffer options. For example, if you are tracking purchases, put
3087 these into a separate file that starts with:
3089 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
3090 #+STARTUP: lognotestate
3093 File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
3095 6.4.3 Clocking work time
3096 ------------------------
3098 Org-mode allows you to clock the time you spent on specific tasks in a
3099 project. When you start working on an item, you can start the clock.
3100 When you stop working on that task, or when you mark the task done, the
3101 clock is stopped and the corresponding time interval is recorded. It
3102 also computes the total time spent on each subtree of a project.
3105 Start the clock on the current item (clock-in). This inserts the
3106 CLOCK keyword together with a timestamp.
3109 Stop the clock (clock-out). The inserts another timestamp at the
3110 same location where the clock was last started. It also directly
3111 computes the resulting time in inserts it after the time range as
3112 `=> HH:MM'. See the variable `org-log-done' for the possibility to
3113 record an additional note together with the clock-out time
3117 Recompute the time interval after changing one of the time stamps.
3118 This is only necessary if you edit the time stamps directly. If
3119 you change them with `S-<cursor>' keys, the update is automatic.
3122 Changing the TODO state of an item to DONE automatically stops the
3123 clock if it is running in this same item.
3126 Cancel the current clock. This is useful if a clock was started by
3127 mistake, or if you ended up working on something else.
3130 Display time summaries for each subtree in the current buffer.
3131 This puts overlays at the end of each headline, showing the total
3132 time recorded under that heading, including the time of any
3133 subheadings. You can use visibility cycling to study the tree, but
3134 the overlays disappear when you change the buffer (see variable
3135 `org-remove-highlights-with-change') or press `C-c C-c'.
3138 Insert a dynamic block (*note Dynamic blocks::) containing a clock
3139 report as an org-mode table into the current file.
3140 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
3143 If such a block already exists, its content is replaced by the new
3144 table. The `BEGIN' line can specify options:
3145 :maxlevels Maximum level depth to which times are listed in the table.
3146 :emphasize When `t', emphasize level one and level two items
3147 :block The time block to consider. This block is specified relative
3148 to the current time and may be any of these keywords:
3149 `today', `yesterday', `thisweek', `lastweek',
3150 `thismonth', `lastmonth', `thisyear', or `lastyear'.
3151 :tstart A time string specifying when to start considering times
3152 :tend A time string specifying when to stop considering times
3153 So to get a clock summary for the current day, you could write
3154 #+BEGIN: clocktable :maxlevel 2 :block today
3157 and to use a specific time range you could write(2)
3158 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
3159 :tend "<2006-08-10 Thu 12:00>"
3164 Update all dynamic blocks (*note Dynamic blocks::). This is
3165 useful if you have several clocktable blocks in a buffer.
3167 The `l' key may be used in the timeline (*note Timeline::) and in
3168 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
3169 worked on or closed during a day.
3171 ---------- Footnotes ----------
3173 (1) The corresponding in-buffer setting is: `#+STARTUP:
3176 (2) Note that all parameters must be specified in a single line -
3177 the line is broken here only to fit it onto the manual.
3180 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
3185 If you wish to implement a system of labels and contexts for
3186 cross-correlating information, an excellent way is to assign tags to
3187 headlines. Org-mode has extensive support for using tags.
3189 Every headline can contain a list of tags, at the end of the
3190 headline. Tags are normal words containing letters, numbers, `_', and
3191 `@'. Tags must be preceded and followed by a single colon; like
3192 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
3196 * Tag inheritance:: Tags use the tree structure of the outline
3197 * Setting tags:: How to assign tags to a headline
3198 * Tag searches:: Searching for combinations of tags
3201 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
3206 Tags make use of the hierarchical structure of outline trees. If a
3207 heading has a certain tag, all subheadings will inherit the tag as
3208 well. For example, in the list
3210 * Meeting with the French group :WORK:
3211 ** Summary by Frank :BOSS:NOTES:
3212 *** TODO Prepare slides for him :ACTION:
3214 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
3215 `:ACTION:'. When executing tag searches and Org-mode finds that a
3216 certain headline matches the search criterion, it will not check any
3217 sublevel headline, assuming that these likely also match, and that the
3218 list of matches can become very long. This may not be what you want,
3219 however, and you can influence inheritance and searching using the
3220 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
3223 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
3228 Tags can simply be typed into the buffer at the end of a headline.
3229 After a colon, `M-<TAB>' offers completion on tags. There is also a
3230 special command for inserting tags:
3233 Enter new tags for the current headline. Org-mode will either
3234 offer completion or a special single-key interface for setting
3235 tags, see below. After pressing <RET>, the tags will be inserted
3236 and aligned to `org-tags-column'. When called with a `C-u'
3237 prefix, all tags in the current buffer will be aligned to that
3238 column, just to make things look nice. TAGS are automatically
3239 realigned after promotion, demotion, and TODO state changes (*note
3242 Org will support tag insertion based on a _list of tags_. By
3243 default this list is constructed dynamically, containing all tags
3244 currently used in the buffer. You may also globally specify a hard list
3245 of tags with the variable `org-tag-alist'. Finally you can set the
3246 default tags for a given file with lines like
3248 #+TAGS: @WORK @HOME @TENNISCLUB
3249 #+TAGS: Laptop Car PC Sailboat
3251 If you have globally defined your preferred set of tags using the
3252 variable `org-tag-alist', but would like to use a dynamic tag list in a
3253 specific file: Just add an empty TAGS option line to that file:
3257 The default support method for entering tags is minibuffer
3258 completion. However, Org-mode also implements a much better method:
3259 _fast tag selection_. This method allows to select and deselect tags
3260 with a single key per tag. To function efficiently, you should assign
3261 unique keys to most tags. This can be done globally with
3263 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
3265 or on a per-file basis with
3267 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
3269 You can also group together tags that are mutually exclusive. With
3272 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
3274 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
3277 Don't forget to press `C-c C-c' with the cursor in one of these lines
3278 to activate any changes.
3280 If at least one tag has a selection key, pressing `C-c C-c' will
3281 automatically present you with a special interface, listing inherited
3282 tags, the tags of the current headline, and a list of all legal tags
3283 with corresponding keys(2). In this interface, you can use the
3287 Pressing keys assigned to tags will add or remove them from the
3288 list of tags in the current line. Selecting a tag in a group of
3289 mutually exclusive tags will turn off any other tags from that
3293 Enter a tag in the minibuffer, even if the tag is not in the
3294 predefined list. You will be able to complete on all tags present
3298 Clear all tags for this line.
3301 Accept the modified set.
3304 Abort without installing changes.
3307 If `q' is not assigned to a tag, it aborts like `C-g'.
3310 Turn off groups of mutually exclusive tags. Use this to (as an
3311 exception) assign several tags from such a group.
3314 Toggle auto-exit after the next change (see below). If you are
3315 using expert mode, the first `C-c' will display the selection
3318 This method lets you assign tags to a headline with very few keys. With
3319 the above setup, you could clear the current tags and set `@HOME',
3320 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
3321 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
3322 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
3323 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3326 If you find that most of the time, you need only a single keypress to
3327 modify your list of tags, set the variable
3328 `org-fast-tag-selection-single-key'. Then you no longer have to press
3329 <RET> to exit fast tag selection - it will immediately exit after the
3330 first change. If you then occasionally need more keys, press `C-c' to
3331 turn off auto-exit for the current tag selection process (in effect:
3332 start selection with `C-c C-c C-c' instead of `C-c C-c'). If you set
3333 the variable to the value `expert', the special window is not even
3334 shown for single-key tag selection, it comes up only when you press an
3337 ---------- Footnotes ----------
3339 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3340 respectively. Several groups are allowed.
3342 (2) Keys will automatically be assigned to tags which have no
3346 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
3351 Once a tags system has been set up, it can be used to collect related
3352 information into special lists.
3355 Create a sparse tree with all headlines matching a tags search.
3356 With a `C-u' prefix argument, ignore headlines that are not a TODO
3360 Create a global list of tag matches from all agenda files. *Note
3361 Matching headline tags::.
3364 Create a global list of tag matches from all agenda files, but
3365 check only TODO items and force checking subitems (see variable
3366 `org-tags-match-list-sublevels').
3368 A tags search string can use Boolean operators `&' for AND and `|'
3369 for OR. `&' binds more strongly than `|'. Parenthesis are currently
3370 not implemented. A tag may also be preceded by `-', to select against
3371 it, and `+' is syntactic sugar for positive selection. The AND
3372 operator `&' is optional when `+' or `-' is present. Examples:
3375 Select headlines tagged `:WORK:', but discard those also tagged
3379 Selects lines tagged `:WORK:' or `:LAPTOP:'.
3382 Like before, but require the `:LAPTOP:' lines to be tagged also
3385 If you are using multi-state TODO keywords (*note TODO
3386 extensions::), it can be useful to also match on the TODO keyword.
3387 This can be done by adding a condition after a slash to a tags match.
3388 The syntax is similar to the tag matches, but should be applied with
3389 consideration: For example, a positive selection on several TODO
3390 keywords can not meaningfully be combined with boolean AND. However,
3391 _negative selection_ combined with AND can be meaningful. To make sure
3392 that only lines are checked that actually have any TODO keyword, use
3393 `C-c a M', or equivalently start the todo part after the slash with `!'.
3397 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
3400 `WORK/!-WAITING-NEXT'
3401 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
3404 `WORK/+WAITING|+NEXT'
3405 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
3408 Any element of the tag/todo match can be a regular expression - in
3409 this case it must be enclosed in curly braces. For example,
3410 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
3411 tag starting with `BOSS'.
3413 You can also require a headline to be of a certain level, by writing
3414 instead of any TAG an expression like `LEVEL=3'. For example, a search
3415 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
3416 BOSS and are _not_ marked with the todo keyword DONE.
3419 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
3424 Due to the way Org-mode works, TODO items, time-stamped items, and
3425 tagged headlines can be scattered throughout a file or even a number of
3426 files. To get an overview over open action items, or over events that
3427 are important for a particular date, this information must be collected,
3428 sorted and displayed in an organized way.
3430 Org-mode can select items based on various criteria, and display them
3431 in a separate buffer. Six different view types are provided:
3433 * an _agenda_ that is like a calendar and shows information for
3436 * a _TODO list_ that covers all unfinished action items,
3438 * a _tags view_, showings headlines based on the tags associated
3441 * a _timeline view_ that shows all events in a single Org-mode file,
3442 in time-sorted view,
3444 * a _stuck projects view_ showing projects that currently don't move
3447 * _custom views_ that are special tag/keyword searches and
3448 combinations of different views.
3450 The extracted information is displayed in a special _agenda buffer_.
3451 This buffer is read-only, but provides commands to visit the
3452 corresponding locations in the original Org-mode files, and even to
3453 edit these files remotely.
3455 Two variables control how the agenda buffer is displayed and whether
3456 the window configuration is restored when the agenda exits:
3457 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3461 * Agenda files:: Files being searched for agenda information
3462 * Agenda dispatcher:: Keyboard access to agenda views
3463 * Built-in agenda views:: What is available out of the box?
3464 * Presentation and sorting:: How agenda items are prepared for display
3465 * Agenda commands:: Remote editing of org trees
3466 * Custom agenda views:: Defining special searches and views
3469 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
3474 The information to be shown is collected from all _agenda files_, the
3475 files listed in the variable `org-agenda-files'(1). Thus even if you
3476 only work with a single Org-mode file, this file should be put into
3477 that list(2). You can customize `org-agenda-files', but the easiest
3478 way to maintain it is through the following commands
3481 Add current file to the list of agenda files. The file is added to
3482 the front of the list. If it was already in the list, it is moved
3483 to the front. With prefix arg, file is added/moved to the end.
3486 Remove current file from the list of agenda files.
3490 Cycle through agenda file list, visiting one file after the other.
3492 The Org menu contains the current list of files and can be used to
3495 ---------- Footnotes ----------
3497 (1) If the value of that variable is not a list, but a single file
3498 name, then the list of agenda files will be maintained in that external
3501 (2) When using the dispatcher, pressing `1' before selecting a
3502 command will actually limit the command to the current file, and ignore
3503 `org-agenda-files' until the next dispatcher command.
3506 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3508 8.2 The agenda dispatcher
3509 =========================
3511 The views are created through a dispatcher that should be bound to a
3512 global key, for example `C-c a' (*note Installation::). In the
3513 following we will assume that `C-c a' is indeed how the dispatcher is
3514 accessed and list keyboard access to commands accordingly. After
3515 pressing `C-c a', an additional letter is required to execute a
3516 command. The dispatcher offers the following default commands:
3518 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3521 Create a list of all TODO items (*note Global TODO list::).
3524 Create a list of headlines matching a TAGS expression (*note
3525 Matching headline tags::).
3528 Create the timeline view for the current buffer (*note Timeline::).
3531 Create a list of stuck projects (*note Stuck projects::).
3534 Restrict an agenda command to the current buffer. After pressing
3535 `1', you still need to press the character selecting the command.
3538 If there is an active region, restrict the following agenda
3539 command to the region. Otherwise, restrict it to the current
3540 subtree. After pressing `0', you still need to press the
3541 character selecting the command.
3543 You can also define custom commands that will be accessible through
3544 the dispatcher, just like the default commands. This includes the
3545 possibility to create extended agenda buffers that contain several
3546 blocks together, for example the weekly agenda, the global TODO list and
3547 a number of special tags matches. *Note Custom agenda views::.
3550 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3552 8.3 The built-in agenda views
3553 =============================
3555 In this section we describe the built-in views.
3559 * Weekly/Daily agenda:: The calendar page with current tasks
3560 * Global TODO list:: All unfinished action items
3561 * Matching headline tags:: Structured information with fine-tuned search
3562 * Timeline:: Time-sorted view for single file
3563 * Stuck projects:: Find projects you need to review
3566 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3568 8.3.1 The weekly/daily agenda
3569 -----------------------------
3571 The purpose of the weekly/daily _agenda_ is to act like a page of a
3572 paper agenda, showing all the tasks for the current week or day.
3575 Compile an agenda for the current week from a list of org files.
3576 The agenda shows the entries for each day. With a `C-u' prefix (or
3577 when the variable `org-agenda-include-all-todo' is `t'), all
3578 unfinished TODO items (including those without a date) are also
3579 listed at the beginning of the buffer, before the first date.
3581 Remote editing from the agenda buffer means, for example, that you
3582 can change the dates of deadlines and appointments from the agenda
3583 buffer. The commands available in the Agenda buffer are listed in
3584 *Note Agenda commands::.
3586 Calendar/Diary integration
3587 ..........................
3589 Emacs contains the calendar and diary by Edward M. Reingold. The
3590 calendar displays a three-month calendar with holidays from different
3591 countries and cultures. The diary allows you to keep track of
3592 anniversaries, lunar phases, sunrise/set, recurrent appointments
3593 (weekly, monthly) and more. In this way, it is quite complementary to
3594 Org-mode. It can be very useful to combine output from Org-mode with
3597 In order to include entries from the Emacs diary into Org-mode's
3598 agenda, you only need to customize the variable
3600 (setq org-agenda-include-diary t)
3602 After that, everything will happen automatically. All diary entries
3603 including holidays, anniversaries etc will be included in the agenda
3604 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3605 the agenda buffer to jump to the diary file in order to edit existing
3606 diary entries. The `i' command to insert new entries for the current
3607 date works in the agenda buffer, as well as the commands `S', `M', and
3608 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3609 to other calendars, respectively. `c' can be used to switch back and
3610 forth between calendar and agenda.
3612 If you are using the diary only for sexp entries and holidays, it is
3613 faster to not use the above setting, but instead to copy or even move
3614 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
3615 entries, and does it faster because there is no overhead for first
3616 creating the diary display. Note that the sexp entries must start at
3617 the left margin, no white space is allowed before them. For example,
3618 the following segment of an Org-mode file will be processed and entries
3619 will be made in the agenda:
3621 * Birthdays and similar stuff
3623 %%(org-calendar-holiday) ; special function for holiday names
3625 %%(diary-anniversary 14 5 1956) Artur Dent %d is years old
3626 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
3629 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3631 8.3.2 The global TODO list
3632 --------------------------
3634 The global TODO list contains all unfinished TODO items, formatted and
3635 collected into a single place.
3638 Show the global TODO list. This collects the TODO items from all
3639 agenda files (*note Agenda views::) into a single buffer. The
3640 buffer is in `agenda-mode', so there are commands to examine and
3641 manipulate the TODO entries directly from that buffer (*note
3645 Like the above, but allows selection of a specific TODO keyword.
3646 You can also do this by specifying a prefix argument to `C-c a t'.
3647 With a `C-u' prefix you are prompted for a keyword, and you may
3648 also specify several keywords by separating them with `|' as
3649 boolean OR operator. With a numeric prefix, the Nth keyword in
3650 `org-todo-keywords' is selected. The `r' key in the agenda buffer
3651 regenerates it, and you can give a prefix argument to this command
3652 to change the selected TODO keyword, for example `3 r'. If you
3653 often need a search for a specific keyword, define a custom
3654 command for it (*note Agenda dispatcher::).
3655 Matching specific TODO keywords can also be done as part of a tags
3656 search (*note Tag searches::).
3658 Remote editing of TODO items means that you can change the state of a
3659 TODO entry with a single key press. The commands available in the TODO
3660 list are described in *Note Agenda commands::.
3662 Normally the global todo list simply shows all headlines with TODO
3663 keywords. This list can become very long. There are two ways to keep
3665 - Some people view a TODO item that has been _scheduled_ for
3666 execution (*note Time stamps::) as no longer _open_. Configure the
3667 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3668 items from the global TODO list.
3670 - TODO items may have sublevels to break up the task into subtasks.
3671 In such cases it may be enough to list only the highest level TODO
3672 headline and omit the sublevels from the global list. Configure
3673 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3676 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3678 8.3.3 Matching headline tags
3679 ----------------------------
3681 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3682 you can select headlines based on the tags that apply to them and
3683 collect them into an agenda buffer.
3686 Produce a list of all headlines that match a given set of tags.
3687 The command prompts for a selection criterion, which is a boolean
3688 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3689 `WORK|HOME' (*note Tags::). If you often need a specific search,
3690 define a custom command for it (*note Agenda dispatcher::).
3693 Like `C-c a m', but only select headlines that are also TODO items
3694 and force checking subitems (see variable
3695 `org-tags-match-list-sublevels'). Matching specific todo keywords
3696 together with a tags match is also possible, see *Note Tag
3699 The commands available in the tags list are described in *Note
3703 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3705 8.3.4 Timeline for a single file
3706 --------------------------------
3708 The timeline summarizes all time-stamped items from a single Org-mode
3709 file in a _time-sorted view_. The main purpose of this command is to
3710 give an overview over events in a project.
3713 Show a time-sorted view of the org file, with all time-stamped
3714 items. When called with a `C-u' prefix, all unfinished TODO
3715 entries (scheduled or not) are also listed under the current date.
3717 The commands available in the timeline buffer are listed in *Note
3721 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3723 8.3.5 Stuck projects
3724 --------------------
3726 If you are following a system like David Allen's GTD to organize your
3727 work, one of the "duties" you have is a regular review to make sure
3728 that all projects move along. A _stuck_ project is a project that has
3729 no defined next actions, so it will never show up in the TODO lists
3730 Org-mode produces. During the review, you need to identify such
3731 projects and define next actions for them.
3734 List projects that are stuck.
3737 Customize the variable `org-stuck-projects' to define what a stuck
3738 project is and how to find it.
3740 You almost certainly will have to configure this view before it will
3741 work for you. The built-in default assumes that all your projects are
3742 level-2 headlines, and that a project is not stuck if it has at least
3743 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3745 Lets assume that you, in your own way of using Org-mode, identify
3746 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3747 indicate a project that should not be considered yet. Lets further
3748 assume that the todo keyword DONE marks finished projects, and that NEXT
3749 and TODO indicate next actions. The tag @SHOP indicates shopping and
3750 is a next action even without the NEXT tag. Finally, if the project
3751 contains the special word IGNORE anywhere, it should not be listed
3752 either. In this case you would start by identifying eligible projects
3753 with a tags/todo match `+PROJECT/-MAYBE-DONE', and then check for TODO,
3754 NEXT, @SHOP, and IGNORE in the subtree to identify projects that are
3755 not stuck. The correct customization for this is
3757 (setq org-stuck-projects
3758 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")
3762 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3764 8.4 Presentation and sorting
3765 ============================
3767 Before displaying items in an agenda view, Org-mode visually prepares
3768 the items and sorts them. Each item occupies a single line. The line
3769 starts with a _prefix_ that contains the _category_ (*note
3770 Categories::) of the item and other important information. You can
3771 customize the prefix using the option `org-agenda-prefix-format'. The
3772 prefix is followed by a cleaned-up version of the outline headline
3773 associated with the item.
3777 * Categories:: Not all tasks are equal
3778 * Time-of-day specifications:: How the agenda knows the time
3779 * Sorting of agenda items:: The order of things
3782 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3787 The category is a broad label assigned to each agenda item. By default,
3788 the category is simply derived from the file name, but you can also
3789 specify it with a special line in the buffer, like this:
3793 If there are several such lines in a file, each specifies the
3794 category for the text below it (but the first category also applies to
3795 any text before the first CATEGORY line). The display in the agenda
3796 buffer looks best if the category is not longer than 10 characters.
3799 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3801 8.4.2 Time-of-Day Specifications
3802 --------------------------------
3804 Org-mode checks each agenda item for a time-of-day specification. The
3805 time can be part of the time stamp that triggered inclusion into the
3806 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3807 specified with two time stamps, like
3808 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3810 In the headline of the entry itself, a time(range) may also appear as
3811 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3812 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3813 entries are recognized as well.
3815 For agenda display, Org-mode extracts the time and displays it in a
3816 standard 24 hour format as part of the prefix. The example times in
3817 the previous paragraphs would end up in the agenda like this:
3819 8:30-13:00 Arthur Dent lies in front of the bulldozer
3820 12:45...... Ford Prefect arrives and takes Arthur to the pub
3821 19:00...... The Vogon reads his poem
3822 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3824 If the agenda is in single-day mode, or for the display of today, the
3825 timed entries are embedded in a time grid, like
3827 8:00...... ------------------
3828 8:30-13:00 Arthur Dent lies in front of the bulldozer
3829 10:00...... ------------------
3830 12:00...... ------------------
3831 12:45...... Ford Prefect arrives and takes Arthur to the pub
3832 14:00...... ------------------
3833 16:00...... ------------------
3834 18:00...... ------------------
3835 19:00...... The Vogon reads his poem
3836 20:00...... ------------------
3837 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3839 The time grid can be turned on and off with the variable
3840 `org-agenda-use-time-grid', and can be configured with
3841 `org-agenda-time-grid'.
3844 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3846 8.4.3 Sorting of agenda items
3847 -----------------------------
3849 Before being inserted into a view, the items are sorted. How this is
3850 done depends on the type of view.
3851 * For the daily/weekly agenda, the items for each day are sorted.
3852 The default order is to first collect all items containing an
3853 explicit time-of-day specification. These entries will be shown
3854 at the beginning of the list, as a _schedule_ for the day. After
3855 that, items remain grouped in categories, in the sequence given by
3856 `org-agenda-files'. Within each category, items are sorted by
3857 priority (*note Priorities::), which is composed of the base
3858 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3859 plus additional increments for overdue scheduled or deadline items.
3861 * For the TODO list, items remain in the order of categories, but
3862 within each category, sorting takes place according to priority
3863 (*note Priorities::).
3865 * For tags matches, items are not sorted at all, but just appear in
3866 the sequence in which they are found in the agenda files.
3868 Sorting can be customized using the variable
3869 `org-agenda-sorting-strategy'.
3872 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3874 8.5 Commands in the agenda buffer
3875 =================================
3877 Entries in the agenda buffer are linked back to the org file or diary
3878 file where they originate. You are not allowed to edit the agenda
3879 buffer itself, but commands are provided to show and jump to the
3880 original entry location, and to edit the org-files "remotely" from the
3881 agenda buffer. In this way, all information is stored only once,
3882 removing the risk that your agenda and note files may diverge.
3884 Some commands can be executed with mouse clicks on agenda lines. For
3885 the other commands, the cursor needs to be in the desired line.
3891 Next line (same as <up>).
3894 Previous line (same as <down>).
3901 Display the original location of the item in another window.
3904 Display original location and recenter that window.
3909 Go to the original location of the item in another window. Under
3910 Emacs 22, `mouse-1' will also works for this.
3913 Go to the original location of the item and delete other windows.
3916 Toggle Follow mode. In Follow mode, as you move the cursor through
3917 the agenda buffer, the other window always shows the corresponding
3918 location in the org file. The initial setting for this mode in new
3919 agenda buffers can be set with the variable
3920 `org-agenda-start-with-follow-mode'.
3923 Display the entire subtree of the current item in an indirect
3924 buffer. With numerical prefix ARG, go up to this level and then
3925 take that tree. If ARG is negative, go up that many levels. With
3926 `C-u' prefix, do not remove the previously used indirect buffer.
3929 Toggle Logbook mode. In Logbook mode, entries that where marked
3930 DONE while logging was on (variable `org-log-done') are shown in
3931 the agenda, as are entries that have been clocked on that day.
3937 Delete other windows.
3940 Switch to weekly view (7 days displayed together).
3943 Switch to daily view (just one day displayed).
3946 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3950 Toggle the time grid on and off. See also the variables
3951 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3954 Recreate the agenda buffer, for example to reflect the changes
3955 after modification of the time stamps of items with S-<left> and
3956 S-<right>. When the buffer is the global todo list, a prefix
3957 argument is interpreted to create a selective list for a specific
3961 Save all Org-mode buffers in the current Emacs session.
3964 Display the following `org-agenda-ndays' days. For example, if
3965 the display covers a week, switch to the following week. With
3966 prefix arg, go forward that many times `org-agenda-ndays' days.
3969 Display the previous dates.
3981 Undo a change due to a remote editing command. The change is
3982 undone both in the agenda buffer and in the remote buffer.
3985 Change the TODO state of the item, both in the agenda and in the
3989 Delete the current agenda item along with the entire subtree
3990 belonging to it in the original Org-mode file. If the text to be
3991 deleted remotely is longer than one line, the kill needs to be
3992 confirmed by the user. See variable `org-agenda-confirm-kill'.
3995 Archive the subtree corresponding to the current headline.
3998 Show all tags associated with the current item. Because of
3999 inheritance, this may be more than the tags listed in the line
4003 Set tags for the current headline.
4006 Toggle the ARCHIVE tag for the current headline.
4009 Set the priority for the current item. Org-mode prompts for the
4010 priority character. If you reply with <SPC>, the priority cookie
4011 is removed from the entry.
4014 Display weighted priority of current item.
4018 Increase the priority of the current item. The priority is
4019 changed in the original buffer, but the agenda is not resorted.
4020 Use the `r' key for this.
4024 Decrease the priority of the current item.
4030 Set a deadline for this item.
4033 Change the time stamp associated with the current line by one day
4034 into the future. With prefix argument, change it by that many
4035 days. For example, `3 6 5 S-<right>' will change it by a year.
4036 The stamp is changed in the original org file, but the change is
4037 not directly reflected in the agenda buffer. Use the `r' key to
4041 Change the time stamp associated with the current line by one day
4045 Change the time stamp associated with the current line to today.
4046 The key `>' has been chosen, because it is the same as `S-.' on my
4050 Start the clock on the current item. If a clock is running
4051 already, it is stopped first.
4054 Stop the previously started clock.
4057 Cancel the currently running clock.
4063 Open the Emacs calendar and move to the date at the agenda cursor.
4066 When in the calendar, compute and show the Org-mode agenda for the
4070 Insert a new entry into the diary. Prompts for the type of entry
4071 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
4072 new entry in the diary, just as `i d' etc. would do in the
4073 calendar. The date is taken from the cursor position.
4076 Show the phases of the moon for the three months around current
4080 Show sunrise and sunset times. The geographical location must be
4081 set with calendar variables, see documentation of the Emacs
4085 Convert the date at cursor into many other cultural and historic
4089 Show holidays for three month around the cursor date.
4092 Export a single iCalendar file containing entries from all agenda
4099 Write the agenda view to a file. Depending on the extension of the
4100 selected file name, the view will be exported as HTML (extension
4101 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4102 (any other extension). Use the variable
4103 `org-agenda-exporter-settings' to set options for `ps-print' and
4104 for `htmlize' to be used during export.
4110 Quit agenda, remove the agenda buffer.
4113 Exit agenda, remove the agenda buffer and all buffers loaded by
4114 Emacs for the compilation of the agenda. Buffers created by the
4115 user to visit org files will not be removed.
4118 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
4120 8.6 Custom agenda views
4121 =======================
4123 Custom agenda commands serve two purposes: to store and quickly access
4124 frequently used TODO and tags searches, and to create special composite
4125 agenda buffers. Custom agenda commands will be accessible through the
4126 dispatcher (*note Agenda dispatcher::), just like the default commands.
4130 * Storing searches:: Type once, use often
4131 * Block agenda:: All the stuff you need in a single buffer
4132 * Setting Options:: Changing the rules
4133 * Exporting Agenda Views:: Writing agendas to files.
4134 * Extracting Agenda Information for other programs::
4137 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
4139 8.6.1 Storing searches
4140 ----------------------
4142 The first application of custom searches is the definition of keyboard
4143 shortcuts for frequently used searches, either creating an agenda
4144 buffer, or a sparse tree (the latter covering of course only the current
4145 buffer). Custom commands are configured in the variable
4146 `org-agenda-custom-commands'. You can customize this variable, for
4147 example by pressing `C-c a C'. You can also directly set it with Emacs
4148 Lisp in `.emacs'. The following example contains all valid search
4151 (setq org-agenda-custom-commands
4152 '(("w" todo "WAITING")
4153 ("W" todo-tree "WAITING")
4154 ("u" tags "+BOSS-URGENT")
4155 ("v" tags-todo "+BOSS-URGENT")
4156 ("U" tags-tree "+BOSS-URGENT")
4157 ("f" occur-tree "\\<FIXME\\>")))
4159 The initial single-character string in each entry defines the character
4160 you have to press after the dispatcher command `C-c a' in order to
4161 access the command. The second parameter is the search type, followed
4162 by the string or regular expression to be used for the matching. The
4163 example above will therefore define:
4166 as a global search for TODO entries with `WAITING' as the TODO
4170 as the same search, but only in the current buffer and displaying
4171 the results as a sparse tree
4174 as a global tags search for headlines marked `:BOSS:' but not
4178 as the same search as `C-c a u', but limiting the search to
4179 headlines that are also TODO items
4182 as the same search as `C-c a u', but only in the current buffer and
4183 displaying the result as a sparse tree
4186 to create a sparse tree (again: current buffer only) with all
4187 entries containing the word `FIXME'.
4190 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
4195 Another possibility is the construction of agenda views that comprise
4196 the results of _several_ commands, each of which creates a block in the
4197 agenda buffer. The available commands include `agenda' for the daily
4198 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
4199 todo list (as constructed with `C-c a t'), and the matching commands
4200 discussed above: `todo', `tags', and `tags-todo'. Here are two
4203 (setq org-agenda-custom-commands
4204 '(("h" "Agenda and Home-related tasks"
4208 ("o" "Agenda and Office-related tasks"
4213 This will define `C-c a h' to create a multi-block view for stuff you
4214 need to attend to at home. The resulting agenda buffer will contain
4215 your agenda for the current week, all TODO items that carry the tag
4216 `HOME', and also all lines tagged with `GARDEN'. Finally the command
4217 `C-c a o' provides a similar view for office tasks.
4220 File: org, Node: Setting Options, Next: Exporting Agenda Views, Prev: Block agenda, Up: Custom agenda views
4222 8.6.3 Setting Options for custom commands
4223 -----------------------------------------
4225 Org-mode contains a number of variables regulating agenda construction
4226 and display. The global variables define the behavior for all agenda
4227 commands, including the custom commands. However, if you want to change
4228 some settings just for a single custom view, you can do so. Setting
4229 options requires inserting a list of variable names and values at the
4230 right spot in `org-agenda-custom-commands'. For example:
4232 (setq org-agenda-custom-commands
4233 '(("w" todo "WAITING"
4234 ((org-agenda-sorting-strategy '(priority-down))
4235 (org-agenda-prefix-format " Mixed: ")))
4236 ("U" tags-tree "+BOSS-URGENT"
4237 ((org-show-following-heading nil)
4238 (org-show-hierarchy-above nil)))))
4240 Now the `C-c a w' command will sort the collected entries only by
4241 priority, and the prefix format is modified to just say ` Mixed:'
4242 instead of giving the category of the entry. The sparse tags tree of
4243 `C-c a U' will now turn out ultra-compact, because neither the headline
4244 hierarchy above the match, nor the headline following the match will be
4247 For command sets creating a block agenda,
4248 `org-agenda-custom-commands' has two separate spots for setting
4249 options. You can add options that should be valid for just a single
4250 command in the set, and options that should be valid for all commands in
4251 the set. The former are just added to the command entry, the latter
4252 must come after the list of command entries. Going back to the block
4253 agenda example (*note Block agenda::), let's change the sorting strategy
4254 for the `C-c a h' commands to `priority-down', but let's sort the
4255 results for GARDEN tags query in the opposite order, `priority-up'.
4256 This would look like this:
4258 (setq org-agenda-custom-commands
4259 '(("h" "Agenda and Home-related tasks"
4263 ((org-agenda-sorting-strategy '(priority-up)))))
4264 ((org-agenda-sorting-strategy '(priority-down))))
4265 ("o" "Agenda and Office-related tasks"
4270 As you see, the values and parenthesis setting is a little complex.
4271 When in doubt, use the customize interface to set this variable - it
4272 fully supports its structure. Just one caveat: When setting options in
4273 this interface, the _values_ are just lisp expressions. So if the
4274 value is a string, you need to add the double quotes around the value
4278 File: org, Node: Exporting Agenda Views, Next: Extracting Agenda Information for other programs, Prev: Setting Options, Up: Custom agenda views
4280 8.6.4 Exporting Agenda Views
4281 ----------------------------
4283 If you are away from your computer, it can be very useful to have a
4284 printed version of some agenda views to carry around. Org-mode can
4285 export custom agenda views as plain text, HTML(1) and postscript. If
4286 you want to do this only occasionally, use the commend
4289 Write the agenda view to a file. Depending on the extension of the
4290 selected file name, the view will be exported as HTML (extension
4291 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4292 (any other extension). Use the variable
4293 `org-agenda-exporter-settings' to set options for `ps-print' and
4294 for `htmlize' to be used during export, for example
4295 (setq org-agenda-exporter-settings
4296 '((ps-number-of-columns 2)
4297 (ps-landscape-mode t)
4298 (htmlize-output-type 'css)))
4300 If you need to export certain agenda views frequently, you can
4301 associate any custom agenda command with a list of output file names
4302 (2). Here is an example that first does define custom commands for the
4303 agenda and the global todo list, together with a number of files to
4304 which to export them. Then we define two block agenda commands and
4305 specify filenames for them as well. File names can be relative to the
4306 current working directory, or absolute.
4308 (setq org-agenda-custom-commands
4309 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
4310 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
4311 ("h" "Agenda and Home-related tasks"
4316 ("~/views/home.html"))
4317 ("o" "Agenda and Office-related tasks"
4322 ("~/views/office.ps"))))
4324 The extension of the file name determines the type of export. If it
4325 is `.html', Org-mode will use the `htmlize.el' package to convert the
4326 buffer to HTML and save it to this file name. If the extension is
4327 `.ps', `ps-print-buffer-with-faces' is used to produce postscript
4328 output. Any other extension produces a plain ASCII file.
4330 The export files are _not_ created when you use one of those
4331 commands interactively. Instead, there is a special command to produce
4332 _all_ specified files in one step:
4335 Export all agenda views that have export filenames associated with
4338 You can use the options section of the custom agenda commands to also
4339 set options for the export commands. For example:
4341 (setq org-agenda-custom-commands
4343 ((ps-number-of-columns 2)
4344 (ps-landscape-mode t)
4345 (org-agenda-prefix-format " [ ] ")
4346 (org-agenda-with-colors nil)
4347 (org-agenda-remove-tags t))
4350 This command sets two options for the postscript exporter, to make it
4351 print in two columns in landscape format - the resulting page can be cut
4352 in two and then used in a paper agenda. The remaining settings modify
4353 the agenda prefix to omit category and scheduling information, and
4354 instead include a checkbox to check off items. We also remove the tags
4355 to make the lines compact, and we don't want to use colors for the
4356 black-and-white printer. Settings specified in
4357 `org-agenda-exporter-settings' will also apply, but the settings in
4358 `org-agenda-custom-commands' take precedence.
4360 From the command line you may also use
4361 emacs -f org-batch-store-agenda-views -kill
4362 or, if you need to modify some parameters
4363 emacs -eval '(org-batch-store-agenda-views \
4364 org-agenda-ndays 30 \
4365 org-agenda-include-diary nil \
4366 org-agenda-files (quote ("~/org/project.org")))' \
4368 which will create the agenda views restricted to the file
4369 `~/org/project.org', without diary entries and with 30 days extent.
4371 ---------- Footnotes ----------
4373 (1) You need to install Hrvoje Niksic' `htmlize.el'.
4375 (2) If you want to store standard views like the weekly agenda or
4376 the global TODO list as well, you need to define custom commands for
4377 them in order to be able to specify filenames.
4380 File: org, Node: Extracting Agenda Information for other programs, Prev: Exporting Agenda Views, Up: Custom agenda views
4382 8.6.5 Extracting Agenda Information for other programs
4383 ------------------------------------------------------
4385 Org-mode provides commands to access agenda information for the command
4386 line in emacs batch mode. This extracted information can be sent
4387 directly to a printer, or it can be read by a program that does further
4388 processing of the data. The first of these commands is the function
4389 `org-batch-agenda', that produces an agenda view and sends it as ASCII
4390 text to STDOUT. The command takes a single string as parameter. If
4391 the string has length 1, it is used as a key to one of the commands you
4392 have configured in `org-agenda-custom-commands', basically any key you
4393 can use after `C-c a'. For example, to directly print the current TODO
4396 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4398 If the parameter is a string with 2 or more characters, it is used
4399 as a tags/todo match string. For example, to print your local shopping
4400 list (all items with the tag `shop', but excluding the tag `NewYork'),
4403 emacs -batch -l ~/.emacs \
4404 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
4406 You may also modify parameters on the fly like this:
4408 emacs -batch -l ~/.emacs \
4409 -eval '(org-batch-agenda "a" \
4410 org-agenda-ndays 30 \
4411 org-agenda-include-diary nil \
4412 org-agenda-files (quote ("~/org/project.org")))' \
4415 which will produce a 30 day agenda, fully restricted to the Org file
4416 `~/org/projects.org', not even including the diary.
4418 If you want to process the agenda data in more sophisticated ways,
4419 you can use the command `org-batch-agenda-csv' to get a comma-separated
4420 list of values for each agenda item. Each line in the output will
4421 contain a number of fields separated by commas. The fields in a line
4424 category The category of the item
4425 head The headline, without TODO kwd, TAGS and PRIORITY
4426 type The type of the agenda entry, can be
4427 todo selected in TODO match
4428 tagsmatch selected in tags match
4429 diary imported from diary
4432 timestamp appointment, selected by timestamp
4433 closed entry was closed on date
4434 upcoming-deadline warning about nearing deadline
4435 past-scheduled forwarded scheduled item
4436 block entry has date block including date
4437 todo The todo keyword, if any
4438 tags All tags including inherited ones, separated by colons
4439 date The relevant date, like 2007-2-14
4440 time The time, like 15:00-16:50
4441 extra String with extra planning info
4442 priority-l The priority letter if any was given
4443 priority-n The computed numerical priority
4445 Time and date will only be given if a timestamp (or deadline/scheduled)
4446 lead to the selection of the item.
4448 A CSV list like this is very easy to use in a post processing script.
4449 For example, here is a Perl program that gets the TODO list from
4450 Emacs/org-mode and prints all the items, preceded by a checkbox:
4454 # define the Emacs command to run
4455 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
4457 # run it and capture the output
4458 $agenda = qx{$cmd 2>/dev/null};
4460 # loop over all lines
4461 foreach $line (split(/\n/,$agenda)) {
4463 # get the individual values
4464 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
4465 $priority_l,$priority_n) = split(/,/,$line);
4467 # proccess and print
4468 print "[ ] $head\n";
4472 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
4477 Plain ASCII is normally sufficient for almost all note taking. One
4478 exception, however, are scientific notes which need to be able to
4479 contain mathematical symbols and the occasional formula. LaTeX(1) is
4480 widely used to typeset scientific documents. Org-mode supports
4481 embedding LaTeX code into its files, because many academics are used to
4482 read LaTeX source code, and because it can be readily processed into
4483 images for HTML production.
4485 It is not necessary to mark LaTeX macros and code in any special way.
4486 If you observe a few conventions, Org-mode knows how to find it and what
4491 * Math symbols:: TeX macros for symbols and Greek letters
4492 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
4493 * LaTeX fragments:: Complex formulas made easy
4494 * Processing LaTeX fragments:: Previewing LaTeX processing
4495 * CDLaTeX mode:: Speed up entering of formulas
4497 ---------- Footnotes ----------
4499 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4500 Many of the features described here as "LaTeX" are really from TeX, but
4501 for simplicity I am blurring this distinction.
4504 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
4509 You can use LaTeX macros to insert special symbols like `\alpha' to
4510 indicate the Greek letter, or `\to' to indicate an arrow. Completion
4511 for these macros is available, just type `\' and maybe a few letters,
4512 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
4513 Org-mode allows these macros to be present without surrounding math
4514 delimiters, for example:
4516 Angles are written as Greek letters \alpha, \beta and \gamma.
4518 During HTML export (*note HTML export::), these symbols are
4519 translated into the proper syntax for HTML, for the above examples this
4520 is `α' and `→', respectively.
4523 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
4525 9.2 Subscripts and Superscripts
4526 ===============================
4528 Just like in LaTeX, `^' and `_' are used to indicate super- and
4529 subscripts. Again, these can be used without embedding them in
4530 math-mode delimiters. To increase the readability of ASCII text, it is
4531 not necessary (but OK) to surround multi-character sub- and superscripts
4532 with curly braces. For example
4534 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
4535 the sun is R_{sun} = 6.96 x 10^8 m.
4537 To avoid interpretation as raised or lowered text, you can quote `^'
4538 and `_' with a backslash: `\_' and `\^'.
4540 During HTML export (*note HTML export::), subscript and superscripts
4541 are surrounded with `<sub>' and `<sup>' tags, respectively.
4544 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
4549 With symbols, sub- and superscripts, HTML is pretty much at its end when
4550 it comes to representing mathematical formulas(1). More complex
4551 expressions need a dedicated formula processor. To this end, Org-mode
4552 can contain arbitrary LaTeX fragments. It provides commands to preview
4553 the typeset result of these fragments, and upon export to HTML, all
4554 fragments will be converted to images and inlined into the HTML
4555 document. For this to work you need to be on a system with a working
4556 LaTeX installation. You also need the `dvipng' program, available at
4557 `http://sourceforge.net/projects/dvipng/'. The LaTeX header that will
4558 be used when processing a fragment can be configured with the variable
4559 `org-format-latex-header'.
4561 LaTeX fragments don't need any special marking at all. The following
4562 snippets will be identified as LaTeX source code:
4563 * Environments of any kind. The only requirement is that the
4564 `\begin' statement appears on a new line, preceded by only
4567 * Text within the usual LaTeX math delimiters. To avoid conflicts
4568 with currency specifications, single `$' characters are only
4569 recognized as math delimiters if the enclosed text contains at
4570 most two line breaks, is directly attached to the `$' characters
4571 with no whitespace in between, and if the closing `$' is followed
4572 by whitespace or punctuation. For the other delimiters, there is
4573 no such restriction, so when in doubt, use `\(...\)' as inline
4578 \begin{equation} % arbitrary environments,
4579 x=\sqrt{b} % even tables, figures
4580 \end{equation} % etc
4582 If $a^2=b$ and \( b=2 \), then the solution must be
4583 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4585 If you need any of the delimiter ASCII sequences for other purposes, you
4586 can configure the option `org-format-latex-options' to deselect the
4587 ones you do not wish to have interpreted by the LaTeX converter.
4589 ---------- Footnotes ----------
4591 (1) Yes, there is MathML, but that is not yet fully supported by
4592 many browsers, and there is no decent converter for turning LaTeX of
4593 ASCII representations of formulas into MathML. So for the time being,
4594 converting formulas into images seems the way to go.
4597 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
4599 9.4 Processing LaTeX fragments
4600 ==============================
4602 LaTeX fragments can be processed to produce a preview images of the
4603 typeset expressions:
4606 Produce a preview image of the LaTeX fragment at point and overlay
4607 it over the source code. If there is no fragment at point,
4608 process all fragments in the current entry (between two
4609 headlines). When called with a prefix argument, process the
4610 entire subtree. When called with two prefix arguments, or when
4611 the cursor is before the first headline, process the entire buffer.
4614 Remove the overlay preview images.
4616 During HTML export (*note HTML export::), all LaTeX fragments are
4617 converted into images and inlined into the document if the following
4620 (setq org-export-with-LaTeX-fragments t)
4623 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
4625 9.5 Using CDLaTeX to enter math
4626 ===============================
4628 CDLaTeX-mode is a minor mode that is normally used in combination with a
4629 major LaTeX mode like AUCTeX in order to speed-up insertion of
4630 environments and math templates. Inside Org-mode, you can make use of
4631 some of the features of cdlatex-mode. You need to install `cdlatex.el'
4632 and `texmathp.el' (the latter comes also with AUCTeX) from
4633 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
4634 cdlatex-mode itself under Org-mode, but use the light version
4635 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
4636 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4639 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4641 When this mode is enabled, the following features are present (for
4642 more details see the documentation of cdlatex-mode):
4643 * Environment templates can be inserted with `C-c {'.
4645 * The <TAB> key will do template expansion if the cursor is inside a
4646 LaTeX fragment(1). For example, <TAB> will expand `fr' to
4647 `\frac{}{}' and position the cursor correctly inside the first
4648 brace. Another <TAB> will get you into the second brace. Even
4649 outside fragments, <TAB> will expand environment abbreviations at
4650 the beginning of a line. For example, if you write `equ' at the
4651 beginning of a line and press <TAB>, this abbreviation will be
4652 expanded to an `equation' environment. To get a list of all
4653 abbreviations, type `M-x cdlatex-command-help'.
4655 * Pressing `_' and `^' inside a LaTeX fragment will insert these
4656 characters together with a pair of braces. If you use <TAB> to
4657 move out of the braces, and if the braces surround only a single
4658 character or macro, they are removed again (depending on the
4659 variable `cdlatex-simplify-sub-super-scripts').
4661 * Pressing the backquote ``' followed by a character inserts math
4662 macros, also outside LaTeX fragments. If you wait more than 1.5
4663 seconds after the backquote, a help window will pop up.
4665 * Pressing the normal quote `'' followed by another character
4666 modifies the symbol before point with an accent or a font. If you
4667 wait more than 1.5 seconds after the backquote, a help window will
4668 pop up. Character modification will work only inside LaTeX
4669 fragments, outside the quote is normal.
4671 ---------- Footnotes ----------
4673 (1) Org-mode has a method to test if the cursor is inside such a
4674 fragment, see the documentation of the function
4675 `org-inside-LaTeX-fragment-p'.
4678 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
4683 Org-mode documents can be exported into a variety of other formats. For
4684 printing and sharing of notes, ASCII export produces a readable and
4685 simple version of an Org-mode file. HTML export allows you to publish a
4686 notes file on the web, while the XOXO format provides a solid base for
4687 exchange with a broad range of other applications. To incorporate
4688 entries with associated times like deadlines or appointments into a
4689 desktop calendar program like iCal, Org-mode can also produce extracts
4690 in the iCalendar format. Currently Org-mode only supports export, not
4691 import of these different formats.
4693 When exporting, Org-mode uses special conventions to enrich the
4694 output produced. *Note Text interpretation::, for more details.
4697 Dispatcher for export and publishing commands. Displays a
4698 help-window listing the additional key(s) needed to launch an
4699 export or publishing command.
4703 * ASCII export:: Exporting to plain ASCII
4704 * HTML export:: Exporting to HTML
4705 * XOXO export:: Exporting to XOXO
4706 * iCalendar export:: Exporting in iCalendar format
4707 * Text interpretation:: How the exporter looks at the file
4710 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4715 ASCII export produces a simple and very readable version of an Org-mode
4719 Export as ASCII file. If there is an active region, only the
4720 region will be exported. For an org file `myfile.org', the ASCII
4721 file will be `myfile.txt'. The file will be overwritten without
4725 Export only the visible part of the document.
4727 In the exported version, the first 3 outline levels will become
4728 headlines, defining a general document structure. Additional levels
4729 will be exported as itemized lists. If you want that transition to
4730 occur at a different level, specify it with a prefix argument. For
4735 creates only top level headlines and does the rest as items. When
4736 headlines are converted to items, the indentation of the text following
4737 the headline is changed to fit nicely under the item. This is done with
4738 the assumption that the first bodyline indicates the base indentation of
4739 the body text. Any indentation larger than this is adjusted to preserve
4740 the layout relative to the first line. Should there be lines with less
4741 indentation than the first, these are left alone.
4744 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4749 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4750 HTML formatting, in ways similar to John Grubers _markdown_ language,
4751 but with additional support for tables.
4755 * Export commands:: How to invoke HTML export
4756 * Quoting HTML tags:: Using direct HTML in Org-mode
4757 * Links:: How hyperlinks get transferred to HTML
4758 * Images:: To inline or not to inline?
4759 * CSS support:: Style specifications
4762 File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
4764 10.2.1 HTML export commands
4765 ---------------------------
4768 Export as HTML file `myfile.html'.
4771 Export as HTML file and open it with a browser.
4774 Export to a temporary buffer, do not create a file.
4777 Export the active region to a temporary buffer. With prefix arg,
4778 do not produce file header and foot, but just the plain HTML
4779 section for the region. This is good for cut-and-paste operations.
4788 Export only the visible part of the document.
4790 `M-x org-export-region-as-html'
4791 Convert the region to HTML under the assumption that it was
4792 org-mode syntax before. This is a global command that can be
4793 invoked in any buffer.
4795 In the exported version, the first 3 outline levels will become
4796 headlines, defining a general document structure. Additional levels
4797 will be exported as itemized lists. If you want that transition to
4798 occur at a different level, specify it with a prefix argument. For
4803 creates two levels of headings and does the rest as items.
4806 File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
4808 10.2.2 Quoting HTML tags
4809 ------------------------
4811 Plain `<' and `>' are always transformed to `<' and `>' in HTML
4812 export. If you want to include simple HTML tags which should be
4813 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
4814 Note that this really works only for simple tags. For more extensive
4815 HTML that should be copied verbatim to the exported file use either
4817 #+HTML: Literal HTML code for export
4822 All lines between these markers are exported literally
4826 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
4831 Internal links (*note Internal links::) will continue to work in HTML
4832 files only if they match a dedicated `<<target>>'. Automatic links
4833 created by radio targets (*note Radio targets::) will also work in the
4834 HTML file. Links to external files will still work if the HTML file is
4835 in the same directory as the Org-mode file. Links to other `.org'
4836 files will be translated into HTML links under the assumption that an
4837 HTML version also exists of the linked file. For information related to
4838 linking files while publishing them to a publishing directory see *Note
4842 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
4847 HTML export can inline images given as links in the Org-mode file, and
4848 it can make an image the clickable part of a link. By default(1),
4849 images are inlined if a link does not have a description. So
4850 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4851 image]]' will just produce a link `the image' that points to the image.
4852 If the description part itself is a `file:' link or a `http:' URL
4853 pointing to an image, this image will be inlined and activated so that
4854 clicking on the image will activate the link. For example, to include
4855 a thumbnail that will link to a high resolution version of the image,
4858 [[file:highres.jpg][file:thumb.jpg]]
4860 and you could use `http' addresses just as well.
4862 ---------- Footnotes ----------
4864 (1) but see the variable `org-export-html-inline-images'
4867 File: org, Node: CSS support, Prev: Images, Up: HTML export
4872 You can also give style information for the exported file. The HTML
4873 exporter assigns the following CSS classes to appropriate parts of the
4874 document - your style specifications may change these:
4876 .done the DONE keyword
4877 .timestamp time stamp
4878 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4879 .tag tag in a headline
4880 .target target for links
4882 The default style specification can be configured through the option
4883 `org-export-html-style'. If you want to use a file-local style, you
4884 may use file variables, best wrapped into a COMMENT section at the end
4885 of the outline tree. For example(1):
4887 * COMMENT html style specifications
4890 # org-export-html-style: " <style type=\"text/css\">
4891 # p {font-weight: normal; color: gray; }
4892 # h1 {color: black; }
4896 Remember to execute `M-x normal-mode' after changing this to make
4897 the new style visible to Emacs. This command restarts org-mode for the
4898 current buffer and forces Emacs to re-evaluate the local variables
4899 section in the buffer.
4901 ---------- Footnotes ----------
4903 (1) Under Emacs 21, the continuation lines for a variable value
4904 should have no `#' at the start of the line.
4907 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4912 Org-mode contains an exporter that produces XOXO-style output.
4913 Currently, this exporter only handles the general outline structure and
4914 does not interpret any additional Org-mode features.
4917 Export as XOXO file `myfile.html'.
4920 Export only the visible part of the document.
4923 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4925 10.4 iCalendar export
4926 =====================
4928 Some people like to use Org-mode for keeping track of projects, but
4929 still prefer a standard calendar application for anniversaries and
4930 appointments. In this case it can be useful to have deadlines and
4931 other time-stamped items in Org-mode files show up in the calendar
4932 application. Org-mode can export calendar information in the standard
4933 iCalendar format. If you also want to have TODO entries included in the
4934 export, configure the variable `org-icalendar-include-todo'.
4937 Create iCalendar entries for the current file and store them in
4938 the same directory, using a file extension `.ics'.
4941 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4942 For each of these files, a separate iCalendar file will be
4946 Create a single large iCalendar file from all files in
4947 `org-agenda-files' and write it to the file given by
4948 `org-combined-agenda-icalendar-file'.
4950 How this calendar is best read and updated, depends on the
4951 application you are using. The FAQ covers this issue.
4954 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4956 10.5 Text interpretation by the exporter
4957 ========================================
4959 The exporter backends interpret additional structure in the Org-mode
4960 file in order to produce better output.
4964 * Comment lines:: Some lines will not be exported
4965 * Initial text:: Text before the first headline
4966 * Footnotes:: Numbers like [1]
4967 * Enhancing text:: Subscripts, symbols and more
4968 * Export options:: How to influence the export settings
4971 File: org, Node: Comment lines, Next: Initial text, Prev: Text interpretation, Up: Text interpretation
4973 10.5.1 Comment lines
4974 --------------------
4976 Lines starting with `#' in column zero are treated as comments and will
4977 never be exported. Also entire subtrees starting with the word
4978 `COMMENT' will never be exported.
4981 Toggle the COMMENT keyword at the beginning of an entry.
4984 File: org, Node: Initial text, Next: Footnotes, Prev: Comment lines, Up: Text interpretation
4986 10.5.2 Text before the first headline
4987 -------------------------------------
4989 Org-mode normally ignores any text before the first headline when
4990 exporting, leaving this region for internal links to speed up navigation
4991 etc. However, in publishing-oriented files, you might want to have some
4992 text before the first headline, like a small introduction, special HTML
4993 code with a navigation bar, etc. You can ask to have this part of the
4994 file exported as well by setting the variable
4995 `org-export-skip-text-before-1st-heading' to `nil'. On a per-file
4996 basis, you can get the same effect with
5000 The text before the first headline will be fully processed (*note
5001 Enhancing text::), and the first non-comment line becomes the title of
5002 the exported document. If you need to include literal HTML, use the
5003 special constructs described in *Note Quoting HTML tags::. The table
5004 of contents is normally inserted directly before the first headline of
5005 the file. If you would like to get it to a different location, insert
5006 the string `[TABLE-OF-CONTENTS]' on a line by itself at the desired
5009 Finally, if you want to use the space before the first headline for
5010 internal purposes, but _still_ want to place something before the first
5011 headline when exporting the file, you can use the `#+TEXT' construct:
5014 #+TEXT: This text will go before the *first* headline.
5015 #+TEXT: We place the table of contents here:
5016 #+TEXT: [TABLE-OF-CONTENTS]
5017 #+TEXT: This goes between the table of contents and the first headline
5020 File: org, Node: Footnotes, Next: Enhancing text, Prev: Initial text, Up: Text interpretation
5025 Numbers in square brackets are treated as footnotes, so that you can use
5026 the Emacs package `footnote.el' to create footnotes. For example:
5028 The org-mode homepage[1] clearly needs help from
5029 a good web designer.
5031 [1] The link is: http://www.astro.uva.nl/~dominik/Tools/org
5033 Note that the `footnote' package uses `C-c !' to invoke its commands.
5034 This binding conflicts with the org-mode command for inserting inactive
5035 time stamps. You could use the variable `footnote-prefix' to switch
5036 footnotes commands to another key. Or, if you are too used to this
5037 binding, you could use `org-replace-disputed-keys' and
5038 `org-disputed-keys' to change the settings in Org-mode.
5041 File: org, Node: Enhancing text, Next: Export options, Prev: Footnotes, Up: Text interpretation
5043 10.5.4 Enhancing text for export
5044 --------------------------------
5046 Some of the export backends of Org-mode allow for sophisticated text
5047 formatting, this is true in particular for the HTML backend. Org-mode
5048 has a number of typing conventions that allow to produce a richly
5051 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
5052 enumerator will be recognized and transformed if the backend
5053 supports lists. See *Note Plain lists::.
5055 * You can make words *bold*, /italic/, _underlined_, `=code=', and
5056 even `+strikethrough+'(1).
5058 * A line consisting of only dashes, and at least 5 of them, will be
5059 exported as a horizontal line (`<hr/>' in HTML).
5061 * Many TeX macros and entire LaTeX fragments are converted into HTML
5062 entities or images (*note Embedded LaTeX::).
5064 * Tables are transformed into native tables under the exporter, if
5065 the export backend supports this. Data fields before the first
5066 horizontal separator line will be formatted as table header fields.
5068 * If a headline starts with the word `QUOTE', the text below the
5069 headline will be typeset as fixed-width, to allow quoting of
5070 computer codes etc. Lines starting with `:' are also typeset in
5073 Toggle fixed-width for entry (QUOTE) or region, see below.
5075 * A double backslash _at the end of a line_ enforces a line break at
5078 If these conversions conflict with your habits of typing ASCII text,
5079 they can all be turned off with corresponding variables. See the
5080 customization group `org-export-general', and the following section
5081 which explains how to set export options with special lines in a buffer.
5083 ---------- Footnotes ----------
5085 (1) but remember that strikethrough is typographically evil and
5086 should never be used.
5089 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
5091 10.5.5 Export options
5092 ---------------------
5094 The exporter recognizes special lines in the buffer which provide
5095 additional information. These lines may be put anywhere in the file.
5096 The whole set of lines can be inserted into the buffer with `C-c C-e
5097 t'. For individual lines, a good way to make sure the keyword is
5098 correct is to type `#+' and then use `M-<TAB>' completion (*note
5102 Insert template with export options, see example below.
5104 #+TITLE: the title to be shown (default is the buffer name)
5105 #+AUTHOR: the author (default taken from `user-full-name')
5106 #+EMAIL: his/her email address (default from `user-mail-address')
5107 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
5108 #+TEXT: Some descriptive text to be inserted at the beginning.
5109 #+TEXT: Several lines may be given.
5110 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t skip:t
5112 The OPTIONS line is a compact form to specify export settings. Here
5114 H: set the number of headline levels for export
5115 num: turn on/off section-numbers
5116 toc: turn on/off table of contents, or set level limit (integer)
5117 \n: turn on/off linebreak-preservation
5118 @: turn on/off quoted HTML tags
5119 :: turn on/off fixed-width sections
5120 |: turn on/off tables
5121 ^: turn on/off TeX-like syntax for sub- and superscripts. If
5122 you write "^:{}", `a_{b}' will be interpreted, but
5123 the simple `a_b' will be left as it is.
5124 *: turn on/off emphasized text (bold, italic, underlined)
5125 TeX: turn on/off simple TeX macros in plain text
5126 LaTeX: turn on/off LaTeX fragments
5127 skip: turn on/off skipping the text before the first heading
5130 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
5135 Org-mode includes(1) a publishing management system that allows you to
5136 configure automatic HTML conversion of _projects_ composed of
5137 interlinked org files. This system is called _org-publish_. You can
5138 also configure org-publish to automatically upload your exported HTML
5139 pages and related attachments, such as images and source code files, to
5140 a web server. Org-publish turns org-mode into a web-site authoring
5143 Org-publish has been contributed to Org-mode by David O'Toole.
5147 * Configuration:: Defining projects
5148 * Sample configuration:: Example projects
5149 * Triggering publication:: Publication commands
5151 ---------- Footnotes ----------
5153 (1) `org-publish.el' is not yet part of Emacs, so if you are using
5154 `org.el' as it comes with Emacs, you need to download this file
5155 separately. Also make sure org.el is at least version 4.27.
5158 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
5163 Publishing needs significant configuration to specify files, destination
5164 and many other properties of a project.
5168 * Project alist:: The central configuration variable
5169 * Sources and destinations:: From here to there
5170 * Selecting files:: What files are part of the project?
5171 * Publishing action:: Setting the function doing the publishing
5172 * Publishing options:: Tweaking HTML export
5173 * Publishing links:: Which links keep working after publishing?
5174 * Project page index:: Publishing a list of project files
5177 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
5179 11.1.1 The variable `org-publish-project-alist'
5180 -----------------------------------------------
5182 Org-publish is configured almost entirely through setting the value of
5183 one variable, called `org-publish-project-alist'. Each element of the
5184 list configures one project, and may be in one of the two following
5187 ("project-name" :property value :property value ...)
5191 ("project-name" :components ("project-name" "project-name" ...))
5193 In both cases, projects are configured by specifying property values.
5194 A project defines the set of files that will be published, as well as
5195 the publishing configuration to use when publishing those files. When
5196 a project takes the second form listed above, the individual members of
5197 the "components" property are taken to be components of the project,
5198 which group together files requiring different publishing options. When
5199 you publish such a "meta-project" all the components will also publish.
5202 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
5204 11.1.2 Sources and destinations for files
5205 -----------------------------------------
5207 Most properties are optional, but some should always be set. In
5208 particular, org-publish needs to know where to look for source files,
5209 and where to put published files.
5211 `:base-directory' Directory containing publishing source files
5212 `:publishing-directory'Directory (possibly remote) where output files
5214 `:preparation-function'Function called before starting publishing
5215 process, for example to run `make' for updating
5216 files to be published.
5219 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
5221 11.1.3 Selecting files
5222 ----------------------
5224 By default, all files with extension `.org' in the base directory are
5225 considered part of the project. This can be modified by setting the
5227 `:base-extension' Extension (without the dot!) of source files. This
5228 actually is a regular expression.
5229 `:exclude' Regular expression to match file names that should
5230 not be published, even though they have been selected
5231 on the basis of their extension.
5232 `:include' List of files to be included regardless of
5233 `:base-extension' and `:exclude'.
5236 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
5238 11.1.4 Publishing Action
5239 ------------------------
5241 Publishing means that a file is copied to the destination directory and
5242 possibly transformed in the process. The default transformation is to
5243 export Org-mode files as HTML files, and this is done by the function
5244 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
5245 export::). Other files like images only need to be copied to the
5246 publishing destination. For non-Org-mode files, you need to specify
5247 the publishing function.
5249 `:publishing-function' Function executing the publication of a file.
5250 This may also be a list of functions, which will
5251 all be called in turn.
5253 The function must accept two arguments: a property list containing at
5254 least a `:publishing-directory' property, and the name of the file to
5255 be published. It should take the specified file, make the necessary
5256 transformation (if any) and place the result into the destination
5257 folder. You can write your own publishing function, but `org-publish'
5258 provides one for attachments (files that only need to be copied):
5259 `org-publish-attachment'.
5262 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
5264 11.1.5 Options for the HTML exporter
5265 ------------------------------------
5267 The property list can be used to set many export options for the HTML
5268 exporter. In most cases, these properties correspond to user variables
5269 in Org-mode. The table below lists these properties along with the
5270 variable they belong to. See the documentation string for the
5271 respective variable for details.
5273 `:language' `org-export-default-language'
5274 `:headline-levels' `org-export-headline-levels'
5275 `:section-numbers' `org-export-with-section-numbers'
5276 `:table-of-contents' `org-export-with-toc'
5277 `:archived-trees' `org-export-with-archived-trees'
5278 `:emphasize' `org-export-with-emphasize'
5279 `:sub-superscript' `org-export-with-sub-superscripts'
5280 `:TeX-macros' `org-export-with-TeX-macros'
5281 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
5282 `:fixed-width' `org-export-with-fixed-width'
5283 `:timestamps' `org-export-with-timestamps'
5285 `:tags' `org-export-with-tags'
5287 `:tables' `org-export-with-tables'
5288 `:table-auto-headline' `org-export-highlight-first-table-line'
5289 `:style' `org-export-html-style'
5290 `:convert-org-links' `org-export-html-link-org-files-as-html'
5291 `:inline-images' `org-export-html-inline-images'
5292 `:expand-quoted-html' `org-export-html-expand'
5293 `:timestamp' `org-export-html-with-timestamp'
5294 `:publishing-directory'`org-export-publishing-directory'
5295 `:preamble' `org-export-html-preamble'
5296 `:postamble' `org-export-html-postamble'
5297 `:auto-preamble' `org-export-html-auto-preamble'
5298 `:auto-postamble' `org-export-html-auto-postamble'
5299 `:author' `user-full-name'
5300 `:email' `user-mail-address'
5302 When a property is given a value in org-publish-project-alist, its
5303 setting overrides the value of the corresponding user variable (if any)
5304 during publishing. options set within a file (*note Export options::),
5305 however, override everything.
5308 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
5310 11.1.6 Links between published files
5311 ------------------------------------
5313 To create a link from one Org-mode file to another, you would use
5314 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
5315 (*note Hyperlinks::). Upon publishing this link becomes a link to
5316 `foo.html'. In this way, you can interlink the pages of your "org web"
5317 project and the links will work as expected when you publish them to
5320 You may also link to related files, such as images. Provided you are
5321 careful with relative pathnames, and provided you have also configured
5322 org-publish to upload the related files, these links will work too.
5323 *Note Complex example:: for an example of this usage.
5325 Sometime an Org-mode file to be published may contain links that are
5326 only valid in your production environment, but not in the publishing
5327 location. In this case, use the property
5329 `:link-validation-function' Function to validate links
5331 to define a function for checking link validity. This function must
5332 accept two arguments, the file name and a directory relative to which
5333 the file name is interpreted in the production environment. If this
5334 function returns `nil', then the HTML generator will only insert a
5335 description into the HTML file, but no link. One option for this
5336 function is `org-publish-validate-link' which checks if the given file
5337 is part of any project in `org-publish-project-alist'.
5340 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
5342 11.1.7 Project page index
5343 -------------------------
5345 The following properties may be used to control publishing of an index
5346 of files or summary page for a given project.
5348 `:auto-index' When non-nil, publish an index during
5349 org-publish-current-project or org-publish-all.
5350 `:index-filename' Filename for output of index. Defaults to `index.org'
5351 (which becomes `index.html').
5352 `:index-title' Title of index page. Defaults to name of file.
5353 `:index-function' Plugin function to use for generation of index.
5354 Defaults to `org-publish-org-index', which generates
5355 a plain list of links to all files in the project.
5358 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
5360 11.2 Sample configuration
5361 =========================
5363 Below we provide two example configurations. The first one is a simple
5364 project publishing only a set of Org-mode files. The second example is
5365 more complex, with a multi-component project.
5369 * Simple example:: One-component publishing
5370 * Complex example:: A multi-component publishing example
5373 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
5375 11.2.1 Example: simple publishing configuration
5376 -----------------------------------------------
5378 This example publishes a set of Org-mode files to the `public_html'
5379 directory on the local machine.
5381 (setq org-publish-project-alist
5383 :base-directory "~/org/"
5384 :publishing-directory "~/public_html"
5385 :section-numbers nil
5386 :table-of-contents nil
5387 :style "<link rel=stylesheet
5388 href=\"../other/mystyle.css\"
5389 type=\"text/css\">")))
5392 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
5394 11.2.2 Example: complex publishing configuration
5395 ------------------------------------------------
5397 This more complicated example publishes an entire website, including
5398 org files converted to HTML, image files, emacs lisp source code, and
5399 stylesheets. The publishing-directory is remote and private files are
5402 To ensure that links are preserved, care should be taken to replicate
5403 your directory structure on the web server, and to use relative file
5404 paths. For example, if your org files are kept in `~/org' and your
5405 publishable images in `~/images', you'd link to an image with
5406 file:../images/myimage.png
5407 On the web server, the relative path to the image should be the
5408 same. You can accomplish this by setting up an "images" folder in the
5409 right place on the webserver, and publishing images to it.
5411 (setq org-publish-project-alist
5413 :base-directory "~/org/"
5414 :base-extension "org"
5415 :publishing-directory "/ssh:user@host:~/html/notebook/"
5416 :publishing-function org-publish-org-to-html
5417 :exclude "PrivatePage.org" ;; regexp
5419 :section-numbers nil
5420 :table-of-contents nil
5421 :style "<link rel=stylesheet
5422 href=\"../other/mystyle.css\" type=\"text/css\">"
5424 :auto-postamble nil)
5427 :base-directory "~/images/"
5428 :base-extension "jpg\\|gif\\|png"
5429 :publishing-directory "/ssh:user@host:~/html/images/"
5430 :publishing-function org-publish-attachment)
5433 :base-directory "~/other/"
5434 :base-extension "css\\|el"
5435 :publishing-directory "/ssh:user@host:~/html/other/"
5436 :publishing-function org-publish-attachment)
5437 ("website" :components ("orgfiles" "images" "other"))))
5440 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
5442 11.3 Triggering publication
5443 ===========================
5445 Once org-publish is properly configured, you can publish with the
5446 following functions:
5449 Prompt for a specific project and publish all files that belong to
5453 Publish the project containing the current file.
5456 Publish only the current file.
5459 Publish all projects.
5461 Org uses timestamps to track when a file has changed. The above
5462 functions normally only publish changed files. You can override this and
5463 force publishing of all files by giving a prefix argument.
5466 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
5473 * Completion:: M-TAB knows what you need
5474 * Customization:: Adapting Org-mode to your taste
5475 * In-buffer settings:: Overview of the #+KEYWORDS
5476 * The very busy C-c C-c key:: When in doubt, press C-c C-c
5477 * Clean view:: Getting rid of leading stars in the outline
5478 * TTY keys:: Using Org-mode on a tty
5479 * Interaction:: Other Emacs packages
5480 * Bugs:: Things which do not work perfectly
5483 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
5488 Org-mode supports in-buffer completion. This type of completion does
5489 not make use of the minibuffer. You simply type a few letters into the
5490 buffer and use the key to complete text right there.
5493 Complete word at point
5494 * At the beginning of a headline, complete TODO keywords.
5496 * After `\', complete TeX symbols supported by the exporter.
5498 * After `*', complete headlines in the current buffer so that
5499 they can be used in search links like `[[*find this
5502 * After `:', complete tags. The list of tags is taken from the
5503 variable `org-tag-alist' (possibly set through the `#+TAGS'
5504 in-buffer option, *note Setting tags::), or it is created
5505 dynamically from all tags used in the current buffer.
5507 * After `[', complete link abbreviations (*note Link
5510 * After `#+', complete the special keywords like `TYP_TODO' or
5511 `OPTIONS' which set file-specific options for Org-mode. When
5512 the option keyword is already complete, pressing `M-<TAB>'
5513 again will insert example settings for this keyword.
5515 * In the line after `#+STARTUP: ', complete startup keywords,
5516 i.e. valid keys for this line.
5518 * Elsewhere, complete dictionary words using ispell.
5521 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
5526 There are more than 180 variables that can be used to customize
5527 Org-mode. For the sake of compactness of the manual, I am not
5528 describing the variables here. A structured overview of customization
5529 variables is available with `M-x org-customize'. Or select `Browse Org
5530 Group' from the `Org->Customization' menu. Many settings can also be
5531 activated on a per-file basis, by putting special lines into the buffer
5532 (*note In-buffer settings::).
5535 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
5537 12.3 Summary of in-buffer settings
5538 ==================================
5540 Org-mode uses special lines in the buffer to define settings on a
5541 per-file basis. These lines start with a `#+' followed by a keyword, a
5542 colon, and then individual words defining a setting. Several setting
5543 words can be in the same line, but you can also have multiple lines for
5544 the keyword. While these settings are described throughout the manual,
5545 here is a summary. After changing any of those lines in the buffer,
5546 press `C-c C-c' with the cursor still in the line to activate the
5547 changes immediately. Otherwise they become effective only when the
5548 file is visited again in a new Emacs session.
5551 This line sets options to be used at startup of org-mode, when an
5552 Org-mode file is being visited. The first set of options deals
5553 with the initial visibility of the outline tree. The
5554 corresponding variable for global default settings is
5555 `org-startup-folded', with a default value `t', which means
5557 overview top-level headlines only
5558 content all headlines
5559 showall no folding at all, show everything
5560 Then there are options for aligning tables upon visiting a file.
5561 This is useful in files containing narrowed table columns. The
5562 corresponding variable is `org-startup-align-all-tables', with a
5563 default value `nil'.
5564 align align all tables
5565 noalign don't align tables on startup
5566 Logging TODO state changes and clock intervals (variable
5567 `org-log-done') can be configured using these options.
5568 logging record a timestamp when an item is marked DONE
5569 nologging don't record when items are marked DONE
5570 lognotedone record timestamp and a note when DONE
5571 lognotestate record timestamp, note when TODO state changes
5572 logrepeat record a not when re-instating a repeating item
5573 nologrepeat do not record when re-instating repeating item
5574 lognoteclock-out record timestamp and a note when clocking out
5575 Here are the options for hiding leading stars in outline headings.
5576 The corresponding variables are `org-hide-leading-stars' and
5577 `org-odd-levels-only', both with a default setting `nil' (meaning
5578 `showstars' and `oddeven').
5579 hidestars make all but one of the stars starting a headline invisible.
5580 showstars show all stars starting a headline
5581 odd allow only odd outline levels (1,3,...)
5582 oddeven allow all outline levels
5583 To turn on custom format overlays over time stamps (variables
5584 `org-put-time-stamp-overlays' and
5585 `org-time-stamp-overlay-formats'), use
5586 customtime overlay custom time format
5587 The following options influence the table spreadsheet (variable
5588 `constants-unit-system').
5589 constcgs `constants.el' should use the c-g-s unit system
5590 constSI `constants.el' should use the SI unit system
5592 `#+SEQ_TODO: #+TYP_TODO:'
5593 These lines set the TODO keywords and their interpretation in the
5594 current file. The corresponding variables are `org-todo-keywords'
5595 and `org-todo-interpretation'.
5597 `#+TAGS: TAG1(c1) TAG2(c2)'
5598 These lines (several such lines are allowed) specify the legal
5599 tags in this file, and (potentially) the corresponding _fast tag
5600 selection_ keys. The corresponding variable is `org-tag-alist'.
5602 `#+LINK: linkword replace'
5603 These lines (several are allowed) specify link abbreviations.
5604 *Note Link abbreviations::. The corresponding variable is
5605 `org-link-abbrev-alist'.
5608 This line sets the category for the agenda file. The category
5609 applies for all subsequent lines until the next `#+CATEGORY' line,
5610 or the end of the file. The first such line also applies to any
5613 `#+ARCHIVE: %s_done::'
5614 This line sets the archive location for the agenda file. It
5615 applies for all subsequent lines until the next `#+CATEGORY' line,
5616 or the end of the file. The first such line also applies to any
5617 entries before it. The corresponding variable is
5618 `org-archive-location'.
5620 `#+PRIORITIES: highest lowest default'
5621 This line sets the limits and the default for the priorities. All
5622 three must be either letters A-Z or numbers 0-9. The highest
5623 priority must have a lower ASCII number that the lowest priority.
5626 This line contains the formulas for the table directly above the
5629 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5630 These lines provide settings for exporting files. For more
5631 details see *Note Export options::.
5634 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
5636 12.4 The very busy C-c C-c key
5637 ==============================
5639 The key `C-c C-c' has many purposes in org-mode, which are all
5640 mentioned scattered throughout this manual. One specific function of
5641 this key is to add _tags_ to a headline (*note Tags::). In many other
5642 circumstances it means something like _Hey Org-mode, look here and
5643 update according to what you see here_. Here is a summary of what this
5644 means in different contexts.
5646 - If there are highlights in the buffer from the creation of a sparse
5647 tree, or from clock display, remove these highlights.
5649 - If the cursor is in one of the special `#+KEYWORD' lines, this
5650 triggers scanning the buffer for these lines and updating the
5653 - If the cursor is inside a table, realign the table. This command
5654 works even if the automatic table editor has been turned off.
5656 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5659 - If the cursor is inside a table created by the `table.el' package,
5660 activate that table.
5662 - If the current buffer is a remember buffer, close the note and
5663 file it. With a prefix argument, file it, without further
5664 interaction, to the default location.
5666 - If the cursor is on a `<<<target>>>', update radio targets and
5667 corresponding links in this buffer.
5669 - If the cursor is in a plain list item with a checkbox, toggle the
5670 status of the checkbox.
5672 - If the cursor is on a numbered item in a plain list, renumber the
5676 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
5678 12.5 A cleaner outline view
5679 ===========================
5681 Some people find it noisy and distracting that the Org-mode headlines
5682 are starting with a potentially large number of stars. For example the
5683 tree from *Note Headlines:::
5685 * Top level headline
5691 * Another top level headline
5693 Unfortunately this is deeply ingrained into the code of Org-mode and
5694 cannot be easily changed. You can, however, modify the display in such
5695 a way that all leading stars become invisible and the outline more easy
5696 to read. To do this, customize the variable `org-hide-leading-stars'
5699 (setq org-hide-leading-stars t)
5701 or change this on a per-file basis with one of the lines (anywhere in
5704 #+STARTUP: showstars
5705 #+STARTUP: hidestars
5707 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5710 With stars hidden, the tree becomes:
5712 * Top level headline
5718 * Another top level headline
5720 Note that the leading stars are not truly replaced by whitespace, they
5721 are only fontified with the face `org-hide' that uses the background
5722 color as font color. If you are not using either white or black
5723 background, you may have to customize this face to get the wanted
5724 effect. Another possibility is to set this font such that the extra
5725 stars are almost invisible, for example using the color `grey90' on a
5728 Things become cleaner still if you skip all the even levels and use
5729 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5730 outline level to the next:
5732 * Top level headline
5738 * Another top level headline
5740 In order to make the structure editing and export commands handle this
5741 convention correctly, use
5743 (setq org-odd-levels-only t)
5745 or set this on a per-file basis with one of the following lines (don't
5746 forget to press `C-c C-c' with the cursor in the startup line to
5747 activate changes immediately).
5752 You can convert an Org-mode file from single-star-per-level to the
5753 double-star-per-level convention with `M-x org-convert-to-odd-levels
5754 RET' in that file. The reverse operation is `M-x
5755 org-convert-to-oddeven-levels'.
5758 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
5760 12.6 Using org-mode on a tty
5761 ============================
5763 Org-mode uses a number of keys that are not accessible on a tty. This
5764 applies to most special keys like cursor keys, <TAB> and <RET>, when
5765 these are combined with modifier keys like <Meta> and/or <Shift>.
5766 Org-mode uses these bindings because it needs to provide keys for a
5767 large number of commands, and because these keys appeared particularly
5768 easy to remember. In order to still be able to access the core
5769 functionality of Org-mode on a tty, alternative bindings are provided.
5770 Here is a complete list of these bindings, which are obviously more
5771 cumbersome to use. Note that sometimes a work-around can be better.
5772 For example changing a time stamp is really only fun with `S-<cursor>'
5773 keys. On a tty you would rather use `C-c .' to re-insert the
5776 Default Alternative 1 Alternative 2
5777 `S-<TAB>' `C-u <TAB>'
5778 `M-<left>' `C-c C-x l' `<Esc> <left>'
5779 `M-S-<left>'`C-c C-x L'
5780 `M-<right>' `C-c C-x r' `<Esc>
5782 `M-S-<right>'`C-c C-x R'
5783 `M-<up>' `C-c C-x u' `<Esc> <up>'
5784 `M-S-<up>' `C-c C-x U'
5785 `M-<down>' `C-c C-x d' `<Esc> <down>'
5786 `M-S-<down>'`C-c C-x D'
5787 `S-<RET>' `C-c C-x c'
5788 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
5789 `M-S-<RET>' `C-c C-x M'
5790 `S-<left>' `C-c <left>'
5791 `S-<right>' `C-c <right>'
5793 `S-<down>' `C-c <down>'
5794 `C-S-<left>'`C-c C-x
5796 `C-S-<right>'`C-c C-x
5800 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
5802 12.7 Interaction with other packages
5803 ====================================
5805 Org-mode lives in the world of GNU Emacs and interacts in various ways
5806 with other code out there.
5810 * Cooperation:: Packages Org-mode cooperates with
5811 * Conflicts:: Packages that lead to conflicts
5814 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
5816 12.7.1 Packages that Org-mode cooperates with
5817 ---------------------------------------------
5819 `calc.el' by Dave Gillespie
5820 Org-mode uses the calc package for implementing spreadsheet
5821 functionality in its tables (*note The spreadsheet::). Org-mode
5822 checks for the availability of calc by looking for the function
5823 `calc-eval' which should be autoloaded in your setup if calc has
5824 been installed properly. As of Emacs 22, calc is part of the Emacs
5825 distribution. Another possibility for interaction between the two
5826 packages is using calc for embedded calculations. *Note Embedded
5827 Mode: (calc)Embedded Mode.
5829 `constants.el' by Carsten Dominik
5830 In a table formula (*note The spreadsheet::), it is possible to use
5831 names for natural constants or units. Instead of defining your own
5832 constants in the variable `org-table-formula-constants', install
5833 the `constants' package which defines a large number of constants
5834 and units, and lets you use unit prefixes like `M' for `Mega' etc.
5835 You will need version 2.0 of this package, available at
5836 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5837 function `constants-get', which has to be autoloaded in your
5838 setup. See the installation instructions in the file
5841 `cdlatex.el' by Carsten Dominik
5842 Org-mode can make use of the cdlatex package to efficiently enter
5843 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5845 `remember.el' by John Wiegley
5846 Org mode cooperates with remember, see *Note Remember::.
5847 `Remember.el' is not part of Emacs, find it on the web.
5849 `table.el' by Takaaki Ota
5850 Complex ASCII tables with automatic line wrapping, column- and
5851 row-spanning, and alignment can be created using the Emacs table
5852 package by Takaaki Ota (`http://sourceforge.net/projects/table',
5853 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
5854 such a table, Org-mode will call `table-recognize-table' and move
5855 the cursor into the table. Inside a table, the keymap of Org-mode
5856 is inactive. In order to execute Org-mode-related commands, leave
5860 Recognize `table.el' table. Works when the cursor is in a
5864 Insert a table.el table. If there is already a table at
5865 point, this command converts it between the table.el format
5866 and the Org-mode format. See the documentation string of the
5867 command `org-convert-table' for the restrictions under which
5869 `table.el' is part of Emacs 22.
5871 `footnote.el' by Steven L. Baur
5872 Org-mode recognizes numerical footnotes as provided by this package
5873 (*note Footnotes::).
5876 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
5878 12.7.2 Packages that lead to conflicts with Org-mode
5879 ----------------------------------------------------
5881 `allout.el' by Ken Manheimer
5882 Startup of Org-mode may fail with the error message
5883 `(wrong-type-argument keymapp nil)' when there is an outdated
5884 version `allout.el' on the load path, for example the version
5885 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
5886 will disappear. If for some reason you cannot do this, make sure
5887 that org.el is loaded _before_ `allout.el', for example by putting
5888 `(require 'org)' early enough into your `.emacs' file.
5890 `CUA.el' by Kim. F. Storm
5891 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5892 by CUA-mode (as well as pc-select-mode and s-region-mode) to
5893 select and extend the region. If you want to use one of these
5894 packages along with Org-mode, configure the variable
5895 `org-CUA-compatible'. When set, Org-mode will move the following
5896 keybindings in org-mode files, and in the agenda buffer (but not
5897 during date selection).
5899 S-UP -> M-p S-DOWN -> M-n
5900 S-LEFT -> M-- S-RIGHT -> M-+
5902 Yes, these are unfortunately more difficult to remember. If you
5903 want to have other replacement keys, look at the variable
5904 `org-disputed-keys'.
5906 `windmove.el' by Hovav Shacham
5907 Also this package uses the `S-<cursor>' keys, so everything written
5908 in the paragraph above about CUA mode also applies here.
5910 `footnote.el' by Steven L. Baur
5911 Org-mode supports the syntax of the footnote package, but only the
5912 numerical footnote markers. Also, the default key for footnote
5913 commands, `C-c !' is already used by org-mode. You could use the
5914 variable `footnote-prefix' to switch footnotes commands to another
5915 key. Or, you could use `org-replace-disputed-keys' and
5916 `org-disputed-keys' to change the settings in Org-mode.
5920 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5925 Here is a list of things that should work differently, but which I have
5926 found too hard to fix.
5928 * If a table field starts with a link, and if the corresponding table
5929 column is narrowed (*note Narrow columns::) to a width too small to
5930 display the link, the field would look entirely empty even though
5931 it is not. To prevent this, Org-mode throws an error. The
5932 work-around is to make the column wide enough to fit the link, or
5933 to add some text (at least 2 characters) before the link in the
5936 * Narrowing table columns does not work on XEmacs, because the
5937 `format' function does not transport text properties.
5939 * Text in an entry protected with the `QUOTE' keyword should not
5942 * When the application called by `C-c C-o' to open a file link fails
5943 (for example because the application does not exist or refuses to
5944 open the file), it does so silently. No error message is
5947 * Recalculating a table line applies the formulas from left to right.
5948 If a formula uses _calculated_ fields further down the row,
5949 multiple recalculation may be needed to get all fields consistent.
5950 You may use the command `org-table-iterate' (`C-u C-c *') to
5951 recalculate until convergence.
5953 * A single letter cannot be made bold, for example `*a*'.
5955 * The exporters work well, but could be made more efficient.
5958 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5960 Appendix A Extensions, Hooks and Hacking
5961 ****************************************
5963 This appendix lists extensions for Org-mode written by other authors.
5964 It also covers some aspects where users can extend the functionality of
5969 * Extensions:: Existing 3rd-part extensions
5970 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
5971 * Dynamic blocks:: Automatically filled blocks
5972 * Special agenda views:: Customized views
5975 File: org, Node: Extensions, Next: Tables in arbitrary syntax, Prev: Extensions and Hacking, Up: Extensions and Hacking
5977 A.1 Third-party extensions for Org-mode
5978 =======================================
5980 The following extensions for Org-mode have been written by other people:
5982 `org-publish.el' by David O'Toole
5983 This package provides facilities for publishing related sets of
5984 Org-mode files together with linked files like images as webpages.
5985 It is highly configurable and can be used for other publishing
5986 purposes as well. As of Org-mode version 4.30, `org-publish.el'
5987 is part of the Org-mode distribution. It is not yet part of
5988 Emacs, however, a delay caused by the preparations for the 22.1
5989 release. In the mean time, `org-publish.el' can be downloaded
5990 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
5992 `org-mouse.el' by Piotr Zielinski
5993 This package implements extended mouse functionality for Org-mode.
5994 It allows you to cycle visibility and to edit the document
5995 structure with the mouse. Best of all, it provides a
5996 context-sensitive menu on <mouse-3> that changes depending on the
5997 context of a mouse-click. As of Org-mode version 4.53,
5998 `org-mouse.el' is part of the Org-mode distribution. It is not
5999 yet part of Emacs, however, a delay caused by the preparations for
6000 the 22.1 release. In the mean time, `org-mouse.el' can be
6001 downloaded from Piotr's site:
6002 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
6004 `org-blog.el' by David O'Toole
6005 A blogging plug-in for `org-publish.el'.
6006 `http://dto.freeshell.org/notebook/OrgMode.html'.
6008 `blorg.el' by Bastien Guerry
6009 Publish Org-mode files as blogs.
6010 `http://www.cognition.ens.fr/~guerry/blorg.html'.
6012 `org2rem.el' by Bastien Guerry
6013 Translates Org-mode files into something readable by Remind.
6014 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
6017 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
6019 A.2 Tables in arbitrary syntax
6020 ==============================
6022 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
6023 frequent feature request has been to make it work with native tables in
6024 specific languages, for example LaTeX. However, this is extremely hard
6025 to do in a general way, would lead to a customization nightmare, and
6026 would take away much of the simplicity of the Orgtbl-mode table editor.
6028 This appendix describes a different approach. We keep the
6029 Orgtbl-mode table in its native format (the source table), and use a
6030 custom function to translate the table to the correct syntax, and to
6031 install it in the right location (the target table). This puts the
6032 burden of writing conversion functions on the user, but it allows for a
6033 very flexible system.
6037 * Radio tables:: Sending and receiving
6038 * A LaTeX example:: Step by step, almost a tutorial
6039 * Translator functions:: Copy and modify
6042 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
6047 To define the location of the target table, you first need to create two
6048 lines that are comments in the current mode, but contain magic words for
6049 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
6050 between these lines, replacing whatever was there before. For example:
6052 /* BEGIN RECEIVE ORGTBL table_name */
6053 /* END RECEIVE ORGTBL table_name */
6055 Just above the source table, we put a special line that tells
6056 Orgtbl-mode how to translate this table and where to install it. For
6058 #+ORGTBL: SEND table_name translation_function arguments....
6060 `table_name' is the reference name for the table that is also used in
6061 the receiver lines. `translation_function' is the Lisp function that
6062 does the translation. Furthermore, the line can contain a list of
6063 arguments (alternating key and value) at the end. The arguments will be
6064 passed as a property list to the translation function for
6065 interpretation. A few standard parameters are already recognized and
6066 acted upon before the translation function is called:
6069 Skip the first N lines of the table. Hlines do count!
6071 `:skipcols (n1 n2 ...)'
6072 List of columns that should be skipped. If the table has a column
6073 with calculation marks, that column is automatically discarded as
6074 well. Please note that the translator function sees the table
6075 _after_ the removal of these columns, the function never knows
6076 that there have been additional columns.
6078 The one problem remaining is how to keep the source table in the buffer
6079 without disturbing the normal workings of the file, for example during
6080 compilation of a C file or processing of a LaTeX file. There are a
6081 number of different solutions:
6083 * The table could be placed in a block comment if that is supported
6084 by the language. For example, in C-mode you could wrap the table
6085 between `/*' and `*/' lines.
6087 * Sometimes it is possible to put the table after some kind of END
6088 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
6090 * You can just comment the table line by line whenever you want to
6091 process the file, and uncomment it whenever you need to edit the
6092 table. This only sounds tedious - the command `M-x
6093 orgtbl-toggle-comment' does make this comment-toggling very easy,
6094 in particular if you bind it to a key.
6097 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
6099 A.2.2 A LaTeX example
6100 ---------------------
6102 The best way to wrap the source table in LaTeX is to use the `comment'
6103 environment provided by `comment.sty'. It has to be activated by
6104 placing `\usepackage{comment}' into the document header. Orgtbl-mode
6105 can insert a radio table skeleton(1) with the command `M-x
6106 orgtbl-insert-radio-table'. You will be prompted for a table name,
6107 lets say we use `salesfigures'. You will then get the following
6110 % BEGIN RECEIVE ORGTBL salesfigures
6111 % END RECEIVE ORGTBL salesfigures
6113 #+ORGTBL: SEND salesfigures orgtbl-to-latex
6117 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
6118 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
6119 the receiver location with name `salesfigures'. You may now fill in
6120 the table, feel free to use the spreadsheet features(2):
6122 % BEGIN RECEIVE ORGTBL salesfigures
6123 % END RECEIVE ORGTBL salesfigures
6125 #+ORGTBL: SEND salesfigures orgtbl-to-latex
6126 | Month | Days | Nr sold | per day |
6127 |-------+------+---------+---------|
6128 | Jan | 23 | 55 | 2.4 |
6129 | Feb | 21 | 16 | 0.8 |
6130 | March | 22 | 278 | 12.6 |
6131 #+TBLFM: $4=$3/$2;%.1f
6132 % $ (optional extra dollar to keep font-lock happy, see footnote)
6135 When you are done, press `C-c C-c' in the table to get the converted
6136 table inserted between the two marker lines.
6138 Now lets assume you want to make the table header by hand, because
6139 you want to control how columns are aligned etc. In this case we make
6140 sure that the table translator does skip the first 2 lines of the source
6141 table, and tell the command to work as a splice, i.e. to not produce
6142 header and footer commands of the target table:
6144 \begin{tabular}{lrrr}
6145 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
6146 % BEGIN RECEIVE ORGTBL salesfigures
6147 % END RECEIVE ORGTBL salesfigures
6151 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
6152 | Month | Days | Nr sold | per day |
6153 |-------+------+---------+---------|
6154 | Jan | 23 | 55 | 2.4 |
6155 | Feb | 21 | 16 | 0.8 |
6156 | March | 22 | 278 | 12.6 |
6157 #+TBLFM: $4=$3/$2;%.1f
6160 The LaTeX translator function `orgtbl-to-latex' is already part of
6161 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
6162 marks horizontal lines with `\hline'. Furthermore, it interprets the
6163 following parameters:
6166 When set to t, return only table body lines, don't wrap them into a
6167 tabular environment. Default is nil.
6170 A format to be used to wrap each field, should contain `%s' for the
6171 original field value. For example, to wrap each field value in
6172 dollars, you could use `:fmt "$%s$"'. This may also be a property
6173 list with column numbers and formats. for example `:fmt (2 "$%s$"
6177 Use this format to print numbers with exponentials. The format
6178 should have `%s' twice for inserting mantissa and exponent, for
6179 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
6180 may also be a property list with column numbers and formats, for
6181 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
6182 After `efmt' has been applied to a value, `fmt' will also be
6185 ---------- Footnotes ----------
6187 (1) By default this works only for LaTeX, HTML, and TeXInfo.
6188 Configure the variable `orgtbl-radio-tables' to install templates for
6191 (2) If the `#+TBLFM' line contains an odd number of dollar
6192 characters, this may cause problems with font-lock in latex-mode. As
6193 shown in the example you can fix this by adding an extra line inside the
6194 `comment' environment that is used to balance the dollar expressions.
6195 If you are using AUCTeX with the font-latex library, a much better
6196 solution is to add the `comment' environment to the variable
6197 `LaTeX-verbatim-environments'.
6200 File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in arbitrary syntax
6202 A.2.3 Translator functions
6203 --------------------------
6205 Orgtbl-mode has several translator functions built-in:
6206 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. Except
6207 for `orgtbl-to-html'(1), these all use a generic translator,
6208 `orgtbl-to-generic'. For example, `orgtbl-to-latex' itself is a very
6209 short function that computes the column definitions for the `tabular'
6210 environment, defines a few field and line separators and then hands
6211 over to the generic translator. Here is the entire code:
6213 (defun orgtbl-to-latex (table params)
6214 "Convert the orgtbl-mode TABLE to LaTeX."
6215 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
6216 org-table-last-alignment ""))
6219 :tstart (concat "\\begin{tabular}{" alignment "}")
6220 :tend "\\end{tabular}"
6221 :lstart "" :lend " \\\\" :sep " & "
6222 :efmt "%s\\,(%s)" :hline "\\hline")))
6223 (orgtbl-to-generic table (org-combine-plists params2 params))))
6225 As you can see, the properties passed into the function (variable
6226 PARAMS) are combined with the ones newly defined in the function
6227 (variable PARAMS2). The ones passed into the function (i.e. the ones
6228 set by the `ORGTBL SEND' line) take precedence. So if you would like
6229 to use the LaTeX translator, but wanted the line endings to be
6230 `\\[2mm]' instead of the default `\\', you could just overrule the
6233 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
6235 For a new language, you can either write your own converter function
6236 in analogy with the LaTeX translator, or you can use the generic
6237 function directly. For example, if you have a language where a table
6238 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
6239 started with `!BL!', ended with `!EL!' and where the field separator is
6240 a TAB, you could call the generic translator like this (on a single
6243 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
6244 :lstart "!BL! " :lend " !EL!" :sep "\t"
6246 Please check the documentation string of the function
6247 `orgtbl-to-generic' for a full list of parameters understood by that
6248 function and remember that you can pass each of them into
6249 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
6250 the generic function.
6252 Of course you can also write a completely new function doing
6253 complicated things the generic translator cannot do. A translator
6254 function takes two arguments. The first argument is the table, a list
6255 of lines, each line either the symbol `hline' or a list of fields. The
6256 second argument is the property list containing all parameters
6257 specified in the `#+ORGTBL: SEND' line. The function must return a
6258 single string containing the formatted table. If you write a generally
6259 useful translator, please post it on `emacs-orgmode@gnu.org' so that
6260 others can benefit from your work.
6262 ---------- Footnotes ----------
6264 (1) The HTML translator uses the same code that produces tables
6268 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
6273 Org-mode documents can contain _dynamic blocks_. These are specially
6274 marked regions that are updated by some user-written function. A good
6275 example for such a block is the clock table inserted by the command
6276 `C-c C-x C-r' (*note Clocking work time::).
6278 Dynamic block are enclosed by a BEGIN-END structure that assigns a
6279 name to the block and can also specify parameters for the function
6280 producing the content of the block.
6282 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
6286 Dynamic blocks are updated with the following commands
6289 Update dynamic block at point.
6292 Update all dynamic blocks in the current file.
6294 Updating a dynamic block means to remove all the text between BEGIN
6295 and END, parse the BEGIN line for parameters and then call the specific
6296 writer function for this block to insert the new content. For a block
6297 with name `myblock', the writer function is `org-dblock-write:myblock'
6298 with as only parameter a property list with the parameters given in the
6299 begin line. Here is a trivial example of a block that keeps track of
6300 when the block update function was last run:
6302 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
6306 The corresponding block writer function could look like this:
6308 (defun org-dblock-write:block-update-time (params)
6309 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
6310 (insert "Last block update at: "
6311 (format-time-string fmt (current-time)))))
6313 If you want to make sure that all dynamic blocks are always
6314 up-to-date, you could add the function `org-update-all-dblocks' to a
6315 hook, for example `before-save-hook'. `org-update-all-dblocks' is
6316 written in a way that is does nothing in buffers that are not in
6320 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
6322 A.4 Special Agenda Views
6323 ========================
6325 Org-mode provides a special hook that can be used to narrow down the
6326 selection made by any of the agenda views. You may specify a function
6327 that is used at each match to verify if the match should indeed be part
6328 of the agenda view, and if not, how much should be skipped.
6330 Let's say you want to produce a list of projects that contain a
6331 WAITING tag anywhere in the project tree. Let's further assume that
6332 you have marked all tree headings that define a project with the todo
6333 keyword PROJECT. In this case you would run a todo search for the
6334 keyword PROJECT, but skip the match unless there is a WAITING tag
6335 anywhere in the subtree belonging to the project line.
6337 To achieve this, you must write a function that searches the subtree
6338 for the tag. If the tag is found, the function must return `nil' to
6339 indicate that this match should not be skipped. If there is no such
6340 tag, return the location of the end of the subtree, to indicate that
6341 search should continue from there.
6343 (defun my-skip-unless-waiting ()
6344 "Skip trees that are not waiting"
6345 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
6346 (if (re-search-forward ":WAITING:" subtree-end t)
6347 nil ; tag found, do not skip
6348 subtree-end))) ; tag not found, continue after end of subtree
6350 Furthermore you must write a command that uses `let' to temporarily
6351 put this function into the variable `org-agenda-skip-function', sets
6352 the header string for the agenda buffer, and calls the todo-list
6353 generator while asking for the specific TODO keyword PROJECT. The
6354 function must also accept one argument MATCH, but it can choose to
6355 ignore it(1) (as we do in the example below). Here is the example:
6357 (defun my-org-waiting-projects (&optional match)
6358 "Produce a list of projects that contain a WAITING tag.
6359 MATCH is being ignored."
6361 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
6362 (org-agenda-overriding-header "Projects waiting for something: "))
6364 (org-todo-list "PROJECT")))
6366 ---------- Footnotes ----------
6368 (1) MATCH must be present in case you want to define a custom
6369 command for producing this special list. Custom commands always supply
6370 the MATCH argument, but it can be empty if you do not specify it while
6371 defining the command(*note Custom agenda views::).
6374 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
6376 Appendix B History and Acknowledgments
6377 **************************************
6379 Org-mode was borne in 2003, out of frustration over the user interface
6380 of the Emacs outline-mode. I was trying to organize my notes and
6381 projects, and using Emacs seemed to be the natural way to go. However,
6382 having to remember eleven different commands with two or three keys per
6383 command, only to hide and unhide parts of the outline tree, that seemed
6384 entirely unacceptable to me. Also, when using outlines to take notes, I
6385 constantly want to restructure the tree, organizing it parallel to my
6386 thoughts and plans. _Visibility cycling_ and _structure editing_ were
6387 originally implemented in the package `outline-magic.el', but quickly
6388 moved to the more general `org.el'. As this environment became
6389 comfortable for project planning, the next step was adding _TODO
6390 entries_, basic _time stamps_, and _table support_. These areas
6391 highlight the two main goals that Org-mode still has today: To create a
6392 new, outline-based, plain text mode with innovative and intuitive
6393 editing features, and to incorporate project planning functionality
6394 directly into a notes file.
6396 Since the first release, hundreds of emails to me or on
6397 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
6398 feedback, new ideas, and sometimes patches and add-on code. Many
6399 thanks to everyone who has helped to improve this package. I am trying
6400 to keep here a list of the people who had significant influence in
6401 shaping one or more aspects of Org-mode. The list may not be complete,
6402 if I have forgotten someone, please accept my apologies and let me know.
6404 * Thomas Baumann contributed the code for links to the MH-E email
6407 * Alex Bochannek provided a patch for rounding time stamps.
6409 * Charles Cave's suggestion sparked the implementation of templates
6412 * Pavel Chalmoviansky influenced the agenda treatment of items with
6415 * Gregory Chernov patched support for lisp forms into table
6416 calculations and improved XEmacs compatibility, in particular by
6417 porting `nouline.el' to XEmacs.
6419 * Sacha Chua suggested to copy some linking code from Planner.
6421 * Eddward DeVilla proposed and tested checkbox statistics.
6423 * Kees Dullemond used to edit projects lists directly in HTML and so
6424 inspired some of the early development, including HTML export. He
6425 also asked for a way to narrow wide table columns.
6427 * Christian Egli converted the documentation into TeXInfo format,
6428 patched CSS formatting into the HTML exporter, and inspired the
6431 * David Emery provided a patch for custom CSS support in exported
6434 * Nic Ferrier contributed mailcap and XOXO support.
6436 * John Foerch figured out how to make incremental search show context
6437 around a match in a hidden outline tree.
6439 * Niels Giessen had the idea to automatically archive DONE trees.
6441 * Bastien Guerry provided extensive feedback and some patches, and
6442 translated David O'Toole's tutorial into French.
6444 * Kai Grossjohann pointed out key-binding conflicts with other
6447 * Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
6448 provided frequent feedback and some patches.
6450 * Jason F. McBrayer suggested agenda export to CSV format.
6452 * Dmitri Minaev sent a patch to set priority limits on a per-file
6455 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
6458 * Rick Moynihan proposed to allow multiple TODO sequences in a file.
6460 * Todd Neal provided patches for links to Info files and elisp forms.
6462 * Tim O'Callaghan suggested in-file links, search options for general
6463 file links, and TAGS.
6465 * Takeshi Okano translated the manual and David O'Toole's tutorial
6468 * Oliver Oppitz suggested multi-state TODO items.
6470 * Scott Otterson sparked the introduction of descriptive text for
6471 links, among other things.
6473 * Pete Phillips helped during the development of the TAGS feature,
6474 and provided frequent feedback.
6476 * T.V. Raman reported bugs and suggested improvements.
6478 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
6481 * Kevin Rogers contributed code to access VM files on remote hosts.
6483 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
6484 conflict with `allout.el'.
6486 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
6488 * Philip Rooke created the Org-mode reference card and provided lots
6491 * Christian Schlauer proposed angular brackets around links, among
6494 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
6495 `organizer-mode.el'.
6497 * Daniel Sinder came up with the idea of internal archiving by
6500 * Dale Smith proposed link abbreviations.
6502 * David O'Toole wrote `org-publish.el' and drafted the manual
6503 chapter about publishing.
6505 * Ju"rgen Vollmer contributed code generating the table of contents
6508 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
6510 * David Wainberg suggested archiving, and improvements to the linking
6513 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
6514 development of Org-mode was fully independent, and both systems are
6515 really different beasts in their basic ideas and implementation
6516 details. I later looked at John's code, however, and learned from
6517 his implementation of (i) links where the link itself is hidden
6518 and only a description is shown, and (ii) popping up a calendar to
6521 * Carsten Wimmer suggested some changes and helped fix a bug in
6524 * Roland Winkler requested additional keybindings to make Org-mode
6527 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
6528 contributed various ideas and code snippets.
6531 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
6539 * abbreviation, links: Link abbreviations. (line 6)
6540 * acknowledgments: History and Acknowledgments.
6542 * action, for publishing: Publishing action. (line 6)
6543 * activation: Activation. (line 6)
6544 * active region <1>: Export commands. (line 6)
6545 * active region <2>: ASCII export. (line 9)
6546 * active region <3>: Built-in table editor.
6548 * active region: Structure editing. (line 64)
6549 * agenda: Weekly/Daily agenda. (line 6)
6550 * agenda dispatcher: Agenda dispatcher. (line 6)
6551 * agenda files: Agenda files. (line 6)
6552 * agenda files, removing buffers: Agenda commands. (line 239)
6553 * agenda views: Agenda views. (line 6)
6554 * agenda views, custom: Custom agenda views. (line 6)
6555 * agenda views, exporting <1>: Exporting Agenda Views.
6557 * agenda views, exporting: Agenda commands. (line 228)
6558 * agenda views, user-defined: Special agenda views.
6560 * agenda, pipe: Extracting Agenda Information for other programs.
6562 * agenda, with block views: Block agenda. (line 6)
6563 * align, STARTUP keyword: In-buffer settings. (line 29)
6564 * allout.el: Conflicts. (line 6)
6565 * angular brackets, around links: External links. (line 43)
6566 * archive locations: Moving subtrees. (line 21)
6567 * archiving: Archiving. (line 6)
6568 * ASCII export: ASCII export. (line 6)
6569 * author: Feedback. (line 6)
6570 * autoload: Activation. (line 6)
6571 * backtrace of an error: Feedback. (line 27)
6572 * BBDB links: External links. (line 6)
6573 * block agenda: Block agenda. (line 6)
6574 * blorg.el: Extensions. (line 32)
6575 * bold text: Enhancing text. (line 15)
6576 * Boolean logic, for tag searches: Tag searches. (line 23)
6577 * bug reports: Feedback. (line 6)
6578 * bugs: Bugs. (line 6)
6579 * C-c C-c, overview: The very busy C-c C-c key.
6581 * calc package: The spreadsheet. (line 6)
6582 * calc.el: Cooperation. (line 6)
6583 * calculations, in tables <1>: The spreadsheet. (line 6)
6584 * calculations, in tables: Built-in table editor.
6586 * calendar commands, from agenda: Agenda commands. (line 191)
6587 * calendar integration: Weekly/Daily agenda. (line 24)
6588 * calendar, for selecting date: The date/time prompt.
6590 * category: Categories. (line 6)
6591 * CDLaTeX: CDLaTeX mode. (line 6)
6592 * cdlatex.el: Cooperation. (line 29)
6593 * checkbox statistics: Checkboxes. (line 23)
6594 * checkboxes: Checkboxes. (line 6)
6595 * children, subtree visibility state: Visibility cycling. (line 10)
6596 * clean outline view: Clean view. (line 6)
6597 * column formula: Column formulas. (line 6)
6598 * commands, in agenda buffer: Agenda commands. (line 6)
6599 * comment lines: Comment lines. (line 6)
6600 * completion, of dictionary words: Completion. (line 6)
6601 * completion, of file names: Handling links. (line 43)
6602 * completion, of link abbreviations: Completion. (line 6)
6603 * completion, of links: Handling links. (line 25)
6604 * completion, of option keywords <1>: Completion. (line 6)
6605 * completion, of option keywords <2>: Export options. (line 6)
6606 * completion, of option keywords: Per file keywords. (line 23)
6607 * completion, of tags <1>: Completion. (line 6)
6608 * completion, of tags: Setting tags. (line 11)
6609 * completion, of TeX symbols: Completion. (line 6)
6610 * completion, of TODO keywords <1>: Completion. (line 6)
6611 * completion, of TODO keywords: Workflow states. (line 15)
6612 * constants, in calculations: References. (line 82)
6613 * constants.el: Cooperation. (line 14)
6614 * constcgs, STARTUP keyword: In-buffer settings. (line 54)
6615 * constSI, STARTUP keyword: In-buffer settings. (line 54)
6616 * content, STARTUP keyword: In-buffer settings. (line 22)
6617 * contents, global visibility state: Visibility cycling. (line 22)
6618 * copying, of subtrees: Structure editing. (line 6)
6619 * creating timestamps: Creating timestamps. (line 6)
6620 * CUA.el: Conflicts. (line 15)
6621 * custom agenda views: Custom agenda views. (line 6)
6622 * custom date/time format: Custom time format. (line 6)
6623 * custom search strings: Custom searches. (line 6)
6624 * customization: Customization. (line 6)
6625 * customtime, STARTUP keyword: In-buffer settings. (line 51)
6626 * cutting, of subtrees: Structure editing. (line 6)
6627 * cycling, of TODO states: TODO basics. (line 13)
6628 * cycling, visibility: Visibility cycling. (line 6)
6629 * daily agenda: Weekly/Daily agenda. (line 6)
6630 * date format, custom: Custom time format. (line 6)
6631 * date range: Time stamps. (line 40)
6632 * date stamps <1>: Time stamps. (line 6)
6633 * date stamps: Timestamps. (line 6)
6634 * date, reading in minibuffer: The date/time prompt.
6636 * DEADLINE keyword: Deadlines and scheduling.
6638 * deadlines: Time stamps. (line 6)
6639 * debugging, of table formulas: Editing and debugging formulas.
6641 * demotion, of subtrees: Structure editing. (line 6)
6642 * diary entries, creating from agenda: Agenda commands. (line 196)
6643 * diary integration: Weekly/Daily agenda. (line 24)
6644 * dictionary word completion: Completion. (line 6)
6645 * directories, for publishing: Sources and destinations.
6647 * dispatching agenda commands: Agenda dispatcher. (line 6)
6648 * display changing, in agenda: Agenda commands. (line 65)
6649 * document structure: Document structure. (line 6)
6650 * DONE, final TODO keyword: Per file keywords. (line 26)
6651 * dynamic blocks: Dynamic blocks. (line 6)
6652 * editing tables: Tables. (line 6)
6653 * editing, of table formulas: Editing and debugging formulas.
6655 * elisp links: External links. (line 6)
6656 * emphasized text: Export options. (line 25)
6657 * enhancing text: Enhancing text. (line 6)
6658 * evaluate time range: Creating timestamps. (line 48)
6659 * even, STARTUP keyword: In-buffer settings. (line 44)
6660 * exporting: Exporting. (line 6)
6661 * exporting agenda views <1>: Exporting Agenda Views.
6663 * exporting agenda views: Agenda commands. (line 228)
6664 * exporting, not: Comment lines. (line 6)
6665 * extended TODO keywords: TODO extensions. (line 6)
6666 * extension, third-party: Extensions. (line 6)
6667 * external archiving: Moving subtrees. (line 6)
6668 * external links: External links. (line 6)
6669 * external links, in HTML export: Links. (line 6)
6670 * FAQ: Summary. (line 53)
6671 * feedback: Feedback. (line 6)
6672 * field formula: Field formulas. (line 6)
6673 * field references: References. (line 15)
6674 * file links: External links. (line 6)
6675 * file links, searching: Search options. (line 6)
6676 * file name completion: Handling links. (line 43)
6677 * files for agenda: Agenda files. (line 6)
6678 * files, adding to agenda list: Agenda files. (line 12)
6679 * files, selecting for publishing: Selecting files. (line 6)
6680 * fixed width: Enhancing text. (line 28)
6681 * fixed-width sections: Export options. (line 25)
6682 * folded, subtree visibility state: Visibility cycling. (line 10)
6683 * folding, sparse trees: Sparse trees. (line 6)
6684 * following links: Handling links. (line 58)
6685 * footnote.el <1>: Conflicts. (line 35)
6686 * footnote.el <2>: Cooperation. (line 56)
6687 * footnote.el: Footnotes. (line 6)
6688 * footnotes: Footnotes. (line 6)
6689 * format specifier: Formula syntax for Calc.
6691 * format, of links: Link format. (line 6)
6692 * formula debugging: Editing and debugging formulas.
6694 * formula editing: Editing and debugging formulas.
6696 * formula syntax, Calc: Formula syntax for Calc.
6698 * formula, for individual table field: Field formulas. (line 6)
6699 * formula, for table column: Column formulas. (line 6)
6700 * formula, in tables: Built-in table editor.
6702 * global cycling: Visibility cycling. (line 22)
6703 * global keybindings: Activation. (line 6)
6704 * global TODO list: Global TODO list. (line 6)
6705 * global visibility states: Visibility cycling. (line 22)
6706 * GNUS links: External links. (line 6)
6707 * grouping columns in tables: Column groups. (line 6)
6708 * hand-formatted lists: Enhancing text. (line 11)
6709 * headline levels: Export options. (line 25)
6710 * headline levels, for exporting <1>: Export commands. (line 34)
6711 * headline levels, for exporting: ASCII export. (line 18)
6712 * headline navigation: Motion. (line 6)
6713 * headline tagging: Tags. (line 6)
6714 * headline, promotion and demotion: Structure editing. (line 6)
6715 * headlines: Headlines. (line 6)
6716 * hide text: Visibility cycling. (line 6)
6717 * hidestars, STARTUP keyword: In-buffer settings. (line 44)
6718 * hiding leading stars: Clean view. (line 6)
6719 * history: History and Acknowledgments.
6721 * horizontal rules, in exported files: Enhancing text. (line 18)
6722 * HTML export: HTML export. (line 6)
6723 * HTML, and orgtbl-mode: Translator functions.
6725 * hyperlinks: Hyperlinks. (line 6)
6726 * iCalendar export: iCalendar export. (line 6)
6727 * images, inline in HTML: Images. (line 6)
6728 * in-buffer settings: In-buffer settings. (line 6)
6729 * inactive timestamp: Time stamps. (line 49)
6730 * index, of published pages: Project page index. (line 6)
6731 * Info links: External links. (line 6)
6732 * inheritance, of tags: Tag inheritance. (line 6)
6733 * inlining images in HTML: Images. (line 6)
6734 * inserting links: Handling links. (line 25)
6735 * installation: Installation. (line 6)
6736 * internal archiving: ARCHIVE tag. (line 6)
6737 * internal links: Internal links. (line 6)
6738 * internal links, in HTML export: Links. (line 6)
6739 * introduction: Introduction. (line 6)
6740 * italic text: Enhancing text. (line 15)
6741 * jumping, to headlines: Motion. (line 6)
6742 * keybindings, global: Activation. (line 6)
6743 * keyword options: Per file keywords. (line 6)
6744 * LaTeX fragments <1>: Export options. (line 25)
6745 * LaTeX fragments: LaTeX fragments. (line 6)
6746 * LaTeX fragments, export: Enhancing text. (line 21)
6747 * LaTeX fragments, preview: Processing LaTeX fragments.
6749 * LaTeX interpretation: Embedded LaTeX. (line 6)
6750 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
6751 * level, require for tags match: Tag searches. (line 68)
6752 * linebreak preservation: Export options. (line 25)
6753 * linebreak, forced: Enhancing text. (line 35)
6754 * link abbreviations: Link abbreviations. (line 6)
6755 * link abbreviations, completion of: Completion. (line 6)
6756 * link completion: Handling links. (line 25)
6757 * link format: Link format. (line 6)
6758 * links, external: External links. (line 6)
6759 * links, finding next/previous: Handling links. (line 91)
6760 * links, handling: Handling links. (line 6)
6761 * links, in HTML export: Links. (line 6)
6762 * links, internal: Internal links. (line 6)
6763 * links, publishing: Publishing links. (line 6)
6764 * links, radio targets: Radio targets. (line 6)
6765 * links, returning to: Handling links. (line 85)
6766 * Lisp forms, as table formulas: Formula syntax for Lisp.
6768 * lists, hand-formatted: Enhancing text. (line 11)
6769 * lists, ordered: Plain lists. (line 6)
6770 * lists, plain: Plain lists. (line 6)
6771 * logdone, STARTUP keyword: In-buffer settings. (line 33)
6772 * logging, of progress: Progress logging. (line 6)
6773 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
6774 * lognotedone, STARTUP keyword: In-buffer settings. (line 33)
6775 * lognotestate, STARTUP keyword: In-buffer settings. (line 33)
6776 * logrepeat, STARTUP keyword: In-buffer settings. (line 33)
6777 * maintainer: Feedback. (line 6)
6778 * mark ring: Handling links. (line 81)
6779 * marking characters, tables: Advanced features. (line 40)
6780 * matching, of tags: Matching headline tags.
6782 * matching, tags: Tags. (line 6)
6783 * math symbols: Math symbols. (line 6)
6784 * MH-E links: External links. (line 6)
6785 * minor mode for tables: orgtbl-mode. (line 6)
6786 * mode, for calc: Formula syntax for Calc.
6788 * motion commands in agenda: Agenda commands. (line 19)
6789 * motion, between headlines: Motion. (line 6)
6790 * name, of column or field: References. (line 82)
6791 * named references: References. (line 82)
6792 * names as TODO keywords: TODO types. (line 6)
6793 * narrow columns in tables: Narrow columns. (line 6)
6794 * noalign, STARTUP keyword: In-buffer settings. (line 29)
6795 * nologging, STARTUP keyword: In-buffer settings. (line 33)
6796 * nologrepeat, STARTUP keyword: In-buffer settings. (line 33)
6797 * occur, command: Sparse trees. (line 6)
6798 * odd, STARTUP keyword: In-buffer settings. (line 44)
6799 * option keyword completion: Completion. (line 6)
6800 * options, for custom agenda views: Setting Options. (line 6)
6801 * options, for customization: Customization. (line 6)
6802 * options, for export: Export options. (line 6)
6803 * options, for publishing: Publishing options. (line 6)
6804 * ordered lists: Plain lists. (line 6)
6805 * org-agenda, command: Weekly/Daily agenda. (line 9)
6806 * org-blog.el: Extensions. (line 28)
6807 * org-mode, turning on: Activation. (line 22)
6808 * org-mouse.el: Extensions. (line 16)
6809 * org-publish-project-alist: Project alist. (line 6)
6810 * org-publish.el: Extensions. (line 8)
6811 * org2rem.el: Extensions. (line 36)
6812 * orgtbl-mode <1>: Tables in arbitrary syntax.
6814 * orgtbl-mode: orgtbl-mode. (line 6)
6815 * outline tree: Headlines. (line 6)
6816 * outline-mode: Outlines. (line 6)
6817 * outlines: Outlines. (line 6)
6818 * overview, global visibility state: Visibility cycling. (line 22)
6819 * overview, STARTUP keyword: In-buffer settings. (line 22)
6820 * packages, interaction with other: Interaction. (line 6)
6821 * pasting, of subtrees: Structure editing. (line 6)
6822 * per file keywords: Per file keywords. (line 6)
6823 * plain lists: Plain lists. (line 6)
6824 * plain text external links: External links. (line 43)
6825 * presentation, of agenda items: Presentation and sorting.
6827 * printing sparse trees: Sparse trees. (line 41)
6828 * priorities: Priorities. (line 6)
6829 * priorities, of agenda items: Sorting of agenda items.
6831 * progress logging: Progress logging. (line 6)
6832 * projects, for publishing: Project alist. (line 6)
6833 * promotion, of subtrees: Structure editing. (line 6)
6834 * publishing: Publishing. (line 6)
6835 * quoted HTML tags: Export options. (line 25)
6836 * radio tables: Radio tables. (line 6)
6837 * radio targets: Radio targets. (line 6)
6838 * range references: References. (line 60)
6839 * ranges, time: Time stamps. (line 6)
6840 * recomputing table fields: Updating the table. (line 6)
6841 * references: References. (line 6)
6842 * references, named: References. (line 82)
6843 * references, to fields: References. (line 15)
6844 * references, to ranges: References. (line 60)
6845 * region, active <1>: Export commands. (line 6)
6846 * region, active <2>: ASCII export. (line 9)
6847 * region, active <3>: Built-in table editor.
6849 * region, active: Structure editing. (line 64)
6850 * regular expressions, with tags search: Tag searches. (line 63)
6851 * remember.el <1>: Cooperation. (line 33)
6852 * remember.el: Remember. (line 6)
6853 * remote editing, from agenda: Agenda commands. (line 106)
6854 * remote editing, undo: Agenda commands. (line 107)
6855 * richer text: Enhancing text. (line 6)
6856 * RMAIL links: External links. (line 6)
6857 * SCHEDULED keyword: Deadlines and scheduling.
6859 * scheduling: Time stamps. (line 6)
6860 * Scripts, for agenda processing: Extracting Agenda Information for other programs.
6862 * search option in file links: Search options. (line 6)
6863 * search strings, custom: Custom searches. (line 6)
6864 * searching for tags: Tag searches. (line 6)
6865 * section-numbers: Export options. (line 25)
6866 * setting tags: Setting tags. (line 6)
6867 * SHELL links: External links. (line 6)
6868 * show all, command: Visibility cycling. (line 33)
6869 * show all, global visibility state: Visibility cycling. (line 22)
6870 * show hidden text: Visibility cycling. (line 6)
6871 * showall, STARTUP keyword: In-buffer settings. (line 22)
6872 * showstars, STARTUP keyword: In-buffer settings. (line 44)
6873 * sorting, of agenda items: Sorting of agenda items.
6875 * sparse tree, for deadlines: Inserting deadline/schedule.
6877 * sparse tree, for TODO: TODO basics. (line 26)
6878 * sparse tree, tag based: Tags. (line 6)
6879 * sparse trees: Sparse trees. (line 6)
6880 * special keywords: In-buffer settings. (line 6)
6881 * spreadsheet capabilities: The spreadsheet. (line 6)
6882 * statistics, for checkboxes: Checkboxes. (line 23)
6883 * storing links: Handling links. (line 9)
6884 * structure editing: Structure editing. (line 6)
6885 * structure of document: Document structure. (line 6)
6886 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
6887 * sublevels, inclusion into todo list: Global TODO list. (line 34)
6888 * subscript: Subscripts and Superscripts.
6890 * subtree cycling: Visibility cycling. (line 10)
6891 * subtree visibility states: Visibility cycling. (line 10)
6892 * subtree, cut and paste: Structure editing. (line 6)
6893 * subtree, subtree visibility state: Visibility cycling. (line 10)
6894 * subtrees, cut and paste: Structure editing. (line 6)
6895 * summary: Summary. (line 6)
6896 * superscript: Subscripts and Superscripts.
6898 * syntax, of formulas: Formula syntax for Calc.
6900 * table editor, built-in: Built-in table editor.
6902 * table editor, table.el: Cooperation. (line 37)
6903 * table of contents: Export options. (line 25)
6904 * table.el: Cooperation. (line 34)
6905 * tables <1>: Export options. (line 25)
6906 * tables: Tables. (line 6)
6907 * tables, export: Enhancing text. (line 24)
6908 * tables, in other modes: Tables in arbitrary syntax.
6910 * tag completion: Completion. (line 6)
6911 * tag searches: Tag searches. (line 6)
6912 * tags: Tags. (line 6)
6913 * tags view: Matching headline tags.
6915 * tags, setting: Setting tags. (line 6)
6916 * targets, for links: Internal links. (line 6)
6917 * targets, radio: Radio targets. (line 6)
6918 * tasks, breaking down: Breaking down tasks. (line 6)
6919 * templates, for remember: Remember templates. (line 6)
6920 * TeX interpretation: Embedded LaTeX. (line 6)
6921 * TeX macros <1>: Export options. (line 25)
6922 * TeX macros: Math symbols. (line 6)
6923 * TeX macros, export: Enhancing text. (line 21)
6924 * TeX symbol completion: Completion. (line 6)
6925 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
6926 * thanks: History and Acknowledgments.
6928 * time format, custom: Custom time format. (line 6)
6929 * time grid: Time-of-day specifications.
6931 * time stamps <1>: Time stamps. (line 6)
6932 * time stamps: Timestamps. (line 6)
6933 * time, reading in minibuffer: The date/time prompt.
6935 * time-of-day specification: Time-of-day specifications.
6937 * time-sorted view: Timeline. (line 6)
6938 * timeline, single file: Timeline. (line 6)
6939 * timerange: Time stamps. (line 40)
6940 * timestamp: Time stamps. (line 14)
6941 * timestamp, inactive: Time stamps. (line 49)
6942 * timestamp, with repeater interval: Time stamps. (line 24)
6943 * timestamps, creating: Creating timestamps. (line 6)
6944 * TODO items: TODO items. (line 6)
6945 * TODO keyword matching: Global TODO list. (line 17)
6946 * TODO keyword matching, with tags search: Tag searches. (line 40)
6947 * todo keyword sets: Multiple sets in one file.
6949 * TODO keywords completion: Completion. (line 6)
6950 * TODO list, global: Global TODO list. (line 6)
6951 * TODO types: TODO types. (line 6)
6952 * TODO workflow: Workflow states. (line 6)
6953 * transient-mark-mode <1>: Export commands. (line 6)
6954 * transient-mark-mode <2>: ASCII export. (line 9)
6955 * transient-mark-mode <3>: Built-in table editor.
6957 * transient-mark-mode: Structure editing. (line 64)
6958 * translator function: Translator functions.
6960 * trees, sparse: Sparse trees. (line 6)
6961 * trees, visibility: Visibility cycling. (line 6)
6962 * tty keybindings: TTY keys. (line 6)
6963 * types as TODO keywords: TODO types. (line 6)
6964 * underlined text: Enhancing text. (line 15)
6965 * undoing remote-editing events: Agenda commands. (line 107)
6966 * updating, table: Updating the table. (line 6)
6967 * URL links: External links. (line 6)
6968 * USENET links: External links. (line 6)
6969 * variables, for customization: Customization. (line 6)
6970 * vectors, in table calculations: Formula syntax for Calc.
6972 * visibility cycling: Visibility cycling. (line 6)
6973 * visible text, printing: Sparse trees. (line 41)
6974 * VM links: External links. (line 6)
6975 * WANDERLUST links: External links. (line 6)
6976 * weekly agenda: Weekly/Daily agenda. (line 6)
6977 * windmove.el: Conflicts. (line 32)
6978 * workflow states as TODO keywords: Workflow states. (line 6)
6979 * XEmacs: Installation. (line 6)
6980 * XOXO export: XOXO export. (line 6)
6983 File: org, Node: Key Index, Prev: Index, Up: Top
6991 * $: Agenda commands. (line 121)
6992 * ': CDLaTeX mode. (line 43)
6993 * +: Agenda commands. (line 143)
6994 * ,: Agenda commands. (line 135)
6995 * -: Agenda commands. (line 149)
6996 * .: Agenda commands. (line 98)
6997 * :: Agenda commands. (line 129)
6998 * <: The date/time prompt.
7000 * <left>: Agenda commands. (line 95)
7001 * <RET> <1>: Agenda commands. (line 39)
7002 * <RET> <2>: Setting tags. (line 76)
7003 * <RET> <3>: The date/time prompt.
7005 * <RET>: Built-in table editor.
7007 * <right>: Agenda commands. (line 90)
7008 * <SPC> <1>: Agenda commands. (line 28)
7009 * <SPC>: Setting tags. (line 73)
7010 * <TAB> <1>: CDLaTeX mode. (line 23)
7011 * <TAB> <2>: Agenda commands. (line 33)
7012 * <TAB> <3>: Setting tags. (line 68)
7013 * <TAB> <4>: Editing and debugging formulas.
7015 * <TAB> <5>: Built-in table editor.
7017 * <TAB> <6>: Plain lists. (line 41)
7018 * <TAB>: Visibility cycling. (line 10)
7019 * > <1>: Agenda commands. (line 171)
7020 * >: The date/time prompt.
7022 * ^: CDLaTeX mode. (line 33)
7023 * _: CDLaTeX mode. (line 33)
7024 * `: CDLaTeX mode. (line 39)
7025 * a: Agenda commands. (line 132)
7026 * b: Agenda commands. (line 49)
7027 * C: Agenda commands. (line 211)
7028 * c: Agenda commands. (line 191)
7029 * C-#: Advanced features. (line 9)
7030 * C-': Agenda files. (line 18)
7031 * C-,: Agenda files. (line 18)
7032 * C-_: Agenda commands. (line 107)
7033 * C-a a L: Timeline. (line 10)
7034 * C-c ! <1>: Footnotes. (line 14)
7035 * C-c !: Creating timestamps. (line 19)
7036 * C-c #: Checkboxes. (line 56)
7037 * C-c %: Handling links. (line 81)
7038 * C-c &: Handling links. (line 85)
7039 * C-c ': Editing and debugging formulas.
7041 * C-c *: Updating the table. (line 13)
7042 * C-c +: Built-in table editor.
7044 * C-c ,: Priorities. (line 18)
7045 * C-c -: Built-in table editor.
7047 * C-c .: Creating timestamps. (line 10)
7048 * C-c /: Sparse trees. (line 15)
7049 * C-c :: Enhancing text. (line 32)
7050 * C-c ;: Comment lines. (line 10)
7051 * C-c <: Creating timestamps. (line 23)
7052 * C-c <TAB>: Built-in table editor.
7054 * C-c = <1>: Editing and debugging formulas.
7056 * C-c =: Column formulas. (line 26)
7057 * C-c >: Creating timestamps. (line 27)
7058 * C-c ?: Editing and debugging formulas.
7060 * C-c [: Agenda files. (line 12)
7061 * C-c \: Tag searches. (line 9)
7062 * C-c ]: Agenda files. (line 15)
7063 * C-c ^ <1>: Built-in table editor.
7065 * C-c ^: Structure editing. (line 52)
7066 * C-c `: Built-in table editor.
7068 * C-c a !: Stuck projects. (line 14)
7069 * C-c a #: Stuck projects. (line 13)
7070 * C-c a a: Weekly/Daily agenda. (line 9)
7071 * C-c a C: Storing searches. (line 9)
7072 * C-c a e: Exporting Agenda Views.
7074 * C-c a M: Matching headline tags.
7076 * C-c a m: Matching headline tags.
7078 * C-c a M: Tag searches. (line 16)
7079 * C-c a m: Tag searches. (line 12)
7080 * C-c a T: Global TODO list. (line 14)
7081 * C-c a t <1>: Global TODO list. (line 9)
7082 * C-c a t: TODO basics. (line 36)
7083 * C-c C-a: Visibility cycling. (line 33)
7084 * C-c C-b: Motion. (line 15)
7085 * C-c C-c <1>: Cooperation. (line 37)
7086 * C-c C-c <2>: The very busy C-c C-c key.
7088 * C-c C-c <3>: Processing LaTeX fragments.
7090 * C-c C-c <4>: Setting tags. (line 10)
7091 * C-c C-c <5>: Checkboxes. (line 37)
7092 * C-c C-c <6>: Editing and debugging formulas.
7094 * C-c C-c <7>: Built-in table editor.
7096 * C-c C-c: Plain lists. (line 78)
7097 * C-c C-d <1>: Agenda commands. (line 156)
7098 * C-c C-d: Inserting deadline/schedule.
7100 * C-c C-e: Exporting. (line 19)
7101 * C-c C-e a: ASCII export. (line 9)
7102 * C-c C-e b: Export commands. (line 7)
7103 * C-c C-e c: iCalendar export. (line 21)
7104 * C-c C-e H: Export commands. (line 10)
7105 * C-c C-e h: Export commands. (line 6)
7106 * C-c C-e I: iCalendar export. (line 16)
7107 * C-c C-e i: iCalendar export. (line 14)
7108 * C-c C-e R: Export commands. (line 13)
7109 * C-c C-e t: Export options. (line 13)
7110 * C-c C-e v <1>: XOXO export. (line 11)
7111 * C-c C-e v: Sparse trees. (line 41)
7112 * C-c C-e v a: ASCII export. (line 13)
7113 * C-c C-e v b: Export commands. (line 18)
7114 * C-c C-e v H: Export commands. (line 18)
7115 * C-c C-e v h: Export commands. (line 18)
7116 * C-c C-e v R: Export commands. (line 18)
7117 * C-c C-e x: XOXO export. (line 10)
7118 * C-c C-f: Motion. (line 12)
7119 * C-c C-j: Motion. (line 21)
7120 * C-c C-l: Handling links. (line 25)
7121 * C-c C-n: Motion. (line 8)
7122 * C-c C-o <1>: Creating timestamps. (line 31)
7123 * C-c C-o: Handling links. (line 58)
7124 * C-c C-p: Motion. (line 9)
7125 * C-c C-q <1>: Editing and debugging formulas.
7127 * C-c C-q: Built-in table editor.
7129 * C-c C-r <1>: Editing and debugging formulas.
7131 * C-c C-r: Visibility cycling. (line 34)
7132 * C-c C-s <1>: Agenda commands. (line 153)
7133 * C-c C-s: Inserting deadline/schedule.
7135 * C-c C-t <1>: Clocking work time. (line 27)
7136 * C-c C-t: TODO basics. (line 13)
7137 * C-c C-u: Motion. (line 18)
7138 * C-c C-v: TODO basics. (line 26)
7139 * C-c C-w: Inserting deadline/schedule.
7141 * C-c C-x b: Visibility cycling. (line 41)
7142 * C-c C-x C-a: ARCHIVE tag. (line 28)
7143 * C-c C-x C-b: Checkboxes. (line 38)
7144 * C-c C-x C-c: Agenda commands. (line 218)
7145 * C-c C-x C-d: Clocking work time. (line 35)
7146 * C-c C-x C-i: Clocking work time. (line 12)
7147 * C-c C-x C-k: Structure editing. (line 39)
7148 * C-c C-x C-l: Processing LaTeX fragments.
7150 * C-c C-x C-n: Handling links. (line 91)
7151 * C-c C-x C-o: Clocking work time. (line 14)
7152 * C-c C-x C-p: Handling links. (line 91)
7153 * C-c C-x C-r: Clocking work time. (line 43)
7154 * C-c C-x C-s: Moving subtrees. (line 10)
7155 * C-c C-x C-t: Custom time format. (line 12)
7156 * C-c C-x C-u: Dynamic blocks. (line 21)
7157 * C-c C-x C-w <1>: Built-in table editor.
7159 * C-c C-x C-w: Structure editing. (line 39)
7160 * C-c C-x C-x: Clocking work time. (line 31)
7161 * C-c C-x C-y <1>: Built-in table editor.
7163 * C-c C-x C-y: Structure editing. (line 46)
7164 * C-c C-x M-w <1>: Built-in table editor.
7166 * C-c C-x M-w: Structure editing. (line 43)
7167 * C-c C-y <1>: Clocking work time. (line 22)
7168 * C-c C-y: Creating timestamps. (line 48)
7169 * C-c l: Handling links. (line 9)
7170 * C-c { <1>: CDLaTeX mode. (line 21)
7171 * C-c {: Editing and debugging formulas.
7173 * C-c |: Built-in table editor.
7175 * C-c }: Editing and debugging formulas.
7177 * C-c ~: Cooperation. (line 48)
7178 * C-k: Agenda commands. (line 115)
7179 * C-S-<left>: Multiple sets in one file.
7181 * C-S-<right>: Multiple sets in one file.
7183 * C-TAB: ARCHIVE tag. (line 38)
7184 * C-u C-c *: Updating the table. (line 16)
7185 * C-u C-c .: Creating timestamps. (line 14)
7186 * C-u C-c = <1>: Editing and debugging formulas.
7188 * C-u C-c =: Field formulas. (line 24)
7189 * C-u C-c C-c: Updating the table. (line 19)
7190 * C-u C-c C-l: Handling links. (line 43)
7191 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
7192 * C-u C-c C-x C-s: Moving subtrees. (line 12)
7193 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
7194 * C-u C-c C-x C-u: Clocking work time. (line 70)
7195 * C-u C-u C-c *: Updating the table. (line 22)
7196 * C-u C-u C-c =: Editing and debugging formulas.
7198 * C-x C-s: Editing and debugging formulas.
7200 * C-x C-w <1>: Exporting Agenda Views.
7202 * C-x C-w: Agenda commands. (line 227)
7203 * D: Agenda commands. (line 72)
7204 * d: Agenda commands. (line 69)
7205 * f: Agenda commands. (line 42)
7206 * g: Agenda commands. (line 76)
7207 * H: Agenda commands. (line 215)
7208 * i: Agenda commands. (line 196)
7209 * I: Agenda commands. (line 176)
7210 * l: Agenda commands. (line 55)
7211 * L: Agenda commands. (line 30)
7212 * M: Agenda commands. (line 202)
7213 * M-<down> <1>: Editing and debugging formulas.
7215 * M-<down>: Built-in table editor.
7217 * M-<left> <1>: Built-in table editor.
7219 * M-<left>: Structure editing. (line 21)
7220 * M-<RET> <1>: Plain lists. (line 46)
7221 * M-<RET>: Structure editing. (line 6)
7222 * M-<right> <1>: Built-in table editor.
7224 * M-<right>: Structure editing. (line 24)
7225 * M-<TAB> <1>: Completion. (line 10)
7226 * M-<TAB> <2>: Setting tags. (line 6)
7227 * M-<TAB> <3>: Per file keywords. (line 23)
7228 * M-<TAB>: Editing and debugging formulas.
7230 * M-<up> <1>: Editing and debugging formulas.
7232 * M-<up>: Built-in table editor.
7234 * M-S-<down> <1>: Editing and debugging formulas.
7236 * M-S-<down> <2>: Built-in table editor.
7238 * M-S-<down> <3>: Plain lists. (line 63)
7239 * M-S-<down>: Structure editing. (line 36)
7240 * M-S-<left> <1>: The date/time prompt.
7242 * M-S-<left> <2>: Built-in table editor.
7244 * M-S-<left> <3>: Plain lists. (line 69)
7245 * M-S-<left>: Structure editing. (line 27)
7246 * M-S-<RET> <1>: Checkboxes. (line 53)
7247 * M-S-<RET> <2>: Plain lists. (line 56)
7248 * M-S-<RET>: Structure editing. (line 18)
7249 * M-S-<right> <1>: The date/time prompt.
7251 * M-S-<right> <2>: Built-in table editor.
7253 * M-S-<right> <3>: Plain lists. (line 69)
7254 * M-S-<right>: Structure editing. (line 30)
7255 * M-S-<up> <1>: Editing and debugging formulas.
7257 * M-S-<up> <2>: Built-in table editor.
7259 * M-S-<up> <3>: Plain lists. (line 63)
7260 * M-S-<up>: Structure editing. (line 33)
7261 * mouse-1 <1>: Agenda commands. (line 33)
7262 * mouse-1 <2>: The date/time prompt.
7264 * mouse-1: Handling links. (line 72)
7265 * mouse-2 <1>: Agenda commands. (line 33)
7266 * mouse-2: Handling links. (line 72)
7267 * mouse-3 <1>: Agenda commands. (line 28)
7268 * mouse-3: Handling links. (line 77)
7269 * n: Agenda commands. (line 19)
7270 * O: Agenda commands. (line 180)
7271 * o: Agenda commands. (line 65)
7272 * P: Agenda commands. (line 140)
7273 * p: Agenda commands. (line 20)
7274 * q: Agenda commands. (line 238)
7275 * r <1>: Agenda commands. (line 80)
7276 * r: Global TODO list. (line 22)
7277 * S: Agenda commands. (line 206)
7278 * s: Agenda commands. (line 87)
7279 * S-<down> <1>: Agenda commands. (line 149)
7280 * S-<down> <2>: The date/time prompt.
7282 * S-<down> <3>: Creating timestamps. (line 40)
7283 * S-<down> <4>: Priorities. (line 23)
7284 * S-<down> <5>: Editing and debugging formulas.
7286 * S-<down>: Plain lists. (line 59)
7287 * S-<left> <1>: Agenda commands. (line 167)
7288 * S-<left> <2>: The date/time prompt.
7290 * S-<left> <3>: Creating timestamps. (line 35)
7291 * S-<left> <4>: Multiple sets in one file.
7293 * S-<left> <5>: TODO basics. (line 20)
7294 * S-<left>: Editing and debugging formulas.
7296 * S-<RET>: Built-in table editor.
7298 * S-<right> <1>: Agenda commands. (line 159)
7299 * S-<right> <2>: The date/time prompt.
7301 * S-<right> <3>: Creating timestamps. (line 35)
7302 * S-<right> <4>: Multiple sets in one file.
7304 * S-<right> <5>: TODO basics. (line 20)
7305 * S-<right>: Editing and debugging formulas.
7307 * S-<TAB> <1>: Built-in table editor.
7309 * S-<TAB>: Visibility cycling. (line 22)
7310 * S-<up> <1>: Agenda commands. (line 143)
7311 * S-<up> <2>: The date/time prompt.
7313 * S-<up> <3>: Creating timestamps. (line 40)
7314 * S-<up> <4>: Priorities. (line 23)
7315 * S-<up> <5>: Editing and debugging formulas.
7317 * S-<up>: Plain lists. (line 59)
7318 * T: Agenda commands. (line 124)
7319 * t: Agenda commands. (line 111)
7320 * w: Agenda commands. (line 66)
7321 * x: Agenda commands. (line 239)
7322 * X: Agenda commands. (line 183)
7328 Node: Introduction
\x7f11743
7329 Node: Summary
\x7f12158
7330 Node: Installation
\x7f15167
7331 Node: Activation
\x7f16545
7332 Node: Feedback
\x7f17794
7333 Node: Document structure
\x7f19870
7334 Node: Outlines
\x7f20644
7335 Node: Headlines
\x7f21304
7336 Ref: Headlines-Footnote-1
\x7f22312
7337 Node: Visibility cycling
\x7f22411
7338 Ref: Visibility cycling-Footnote-1
\x7f24621
7339 Ref: Visibility cycling-Footnote-2
\x7f24679
7340 Ref: Visibility cycling-Footnote-3
\x7f24729
7341 Node: Motion
\x7f24999
7342 Node: Structure editing
\x7f25953
7343 Node: Archiving
\x7f28779
7344 Node: ARCHIVE tag
\x7f29337
7345 Node: Moving subtrees
\x7f31130
7346 Node: Sparse trees
\x7f32441
7347 Ref: Sparse trees-Footnote-1
\x7f34573
7348 Ref: Sparse trees-Footnote-2
\x7f34755
7349 Node: Plain lists
\x7f34870
7350 Ref: Plain lists-Footnote-1
\x7f38639
7351 Ref: Plain lists-Footnote-2
\x7f38997
7352 Node: Tables
\x7f39181
7353 Node: Built-in table editor
\x7f39762
7354 Node: Narrow columns
\x7f47001
7355 Ref: Narrow columns-Footnote-1
\x7f48936
7356 Node: Column groups
\x7f48982
7357 Node: orgtbl-mode
\x7f50515
7358 Node: The spreadsheet
\x7f51318
7359 Node: References
\x7f52405
7360 Ref: References-Footnote-1
\x7f56534
7361 Node: Formula syntax for Calc
\x7f56823
7362 Node: Formula syntax for Lisp
\x7f59280
7363 Node: Field formulas
\x7f60549
7364 Node: Column formulas
\x7f61857
7365 Node: Editing and debugging formulas
\x7f63456
7366 Node: Updating the table
\x7f67609
7367 Node: Advanced features
\x7f68644
7368 Node: Hyperlinks
\x7f73169
7369 Node: Link format
\x7f73942
7370 Node: Internal links
\x7f75235
7371 Ref: Internal links-Footnote-1
\x7f77160
7372 Node: Radio targets
\x7f77292
7373 Node: External links
\x7f77983
7374 Node: Handling links
\x7f80387
7375 Ref: Handling links-Footnote-1
\x7f85674
7376 Ref: Handling links-Footnote-2
\x7f85911
7377 Node: Link abbreviations
\x7f85985
7378 Node: Search options
\x7f87664
7379 Ref: Search options-Footnote-1
\x7f89444
7380 Node: Custom searches
\x7f89525
7381 Node: Remember
\x7f90573
7382 Node: Setting up remember
\x7f91560
7383 Node: Remember templates
\x7f92142
7384 Ref: Remember templates-Footnote-1
\x7f95434
7385 Node: Storing notes
\x7f95532
7386 Node: TODO items
\x7f97419
7387 Node: TODO basics
\x7f98402
7388 Node: TODO extensions
\x7f100099
7389 Node: Workflow states
\x7f100918
7390 Ref: Workflow states-Footnote-1
\x7f102093
7391 Node: TODO types
\x7f102186
7392 Ref: TODO types-Footnote-1
\x7f103769
7393 Node: Multiple sets in one file
\x7f103851
7394 Node: Per file keywords
\x7f105462
7395 Ref: Per file keywords-Footnote-1
\x7f106751
7396 Node: Priorities
\x7f106952
7397 Node: Breaking down tasks
\x7f108562
7398 Ref: Breaking down tasks-Footnote-1
\x7f109082
7399 Node: Checkboxes
\x7f109178
7400 Node: Timestamps
\x7f111933
7401 Node: Time stamps
\x7f112374
7402 Ref: Time stamps-Footnote-1
\x7f114679
7403 Node: Creating timestamps
\x7f114795
7404 Node: The date/time prompt
\x7f116869
7405 Ref: The date/time prompt-Footnote-1
\x7f118857
7406 Node: Custom time format
\x7f118963
7407 Node: Deadlines and scheduling
\x7f120511
7408 Ref: Deadlines and scheduling-Footnote-1
\x7f121861
7409 Node: Inserting deadline/schedule
\x7f122016
7410 Node: Repeated tasks
\x7f122954
7411 Node: Progress logging
\x7f124593
7412 Node: Closing items
\x7f125248
7413 Ref: Closing items-Footnote-1
\x7f126182
7414 Ref: Closing items-Footnote-2
\x7f126251
7415 Node: Tracking TODO state changes
\x7f126324
7416 Node: Clocking work time
\x7f127180
7417 Ref: Clocking work time-Footnote-1
\x7f130826
7418 Ref: Clocking work time-Footnote-2
\x7f130904
7419 Node: Tags
\x7f131030
7420 Node: Tag inheritance
\x7f131792
7421 Node: Setting tags
\x7f132729
7422 Ref: Setting tags-Footnote-1
\x7f137252
7423 Ref: Setting tags-Footnote-2
\x7f137364
7424 Node: Tag searches
\x7f137447
7425 Node: Agenda views
\x7f140158
7426 Node: Agenda files
\x7f142103
7427 Ref: Agenda files-Footnote-1
\x7f143069
7428 Ref: Agenda files-Footnote-2
\x7f143218
7429 Node: Agenda dispatcher
\x7f143411
7430 Node: Built-in agenda views
\x7f145102
7431 Node: Weekly/Daily agenda
\x7f145680
7432 Node: Global TODO list
\x7f148621
7433 Node: Matching headline tags
\x7f150893
7434 Node: Timeline
\x7f151964
7435 Node: Stuck projects
\x7f152630
7436 Node: Presentation and sorting
\x7f154481
7437 Node: Categories
\x7f155272
7438 Node: Time-of-day specifications
\x7f155936
7439 Node: Sorting of agenda items
\x7f157907
7440 Node: Agenda commands
\x7f159189
7441 Node: Custom agenda views
\x7f166343
7442 Node: Storing searches
\x7f167062
7443 Node: Block agenda
\x7f168974
7444 Node: Setting Options
\x7f170204
7445 Node: Exporting Agenda Views
\x7f172943
7446 Ref: Exporting Agenda Views-Footnote-1
\x7f177227
7447 Ref: Exporting Agenda Views-Footnote-2
\x7f177284
7448 Node: Extracting Agenda Information for other programs
\x7f177470
7449 Node: Embedded LaTeX
\x7f181596
7450 Ref: Embedded LaTeX-Footnote-1
\x7f182688
7451 Node: Math symbols
\x7f182878
7452 Node: Subscripts and Superscripts
\x7f183643
7453 Node: LaTeX fragments
\x7f184487
7454 Ref: LaTeX fragments-Footnote-1
\x7f186721
7455 Node: Processing LaTeX fragments
\x7f186983
7456 Node: CDLaTeX mode
\x7f187929
7457 Ref: CDLaTeX mode-Footnote-1
\x7f190413
7458 Node: Exporting
\x7f190561
7459 Node: ASCII export
\x7f191875
7460 Node: HTML export
\x7f193165
7461 Node: Export commands
\x7f193784
7462 Node: Quoting HTML tags
\x7f195028
7463 Node: Links
\x7f195658
7464 Node: Images
\x7f196355
7465 Ref: Images-Footnote-1
\x7f197226
7466 Node: CSS support
\x7f197287
7467 Ref: CSS support-Footnote-1
\x7f198606
7468 Node: XOXO export
\x7f198719
7469 Node: iCalendar export
\x7f199158
7470 Node: Text interpretation
\x7f200377
7471 Node: Comment lines
\x7f200968
7472 Node: Initial text
\x7f201363
7473 Node: Footnotes
\x7f203032
7474 Node: Enhancing text
\x7f203847
7475 Ref: Enhancing text-Footnote-1
\x7f205706
7476 Node: Export options
\x7f205796
7477 Node: Publishing
\x7f207689
7478 Ref: Publishing-Footnote-1
\x7f208485
7479 Node: Configuration
\x7f208681
7480 Node: Project alist
\x7f209399
7481 Node: Sources and destinations
\x7f210465
7482 Node: Selecting files
\x7f211195
7483 Node: Publishing action
\x7f211943
7484 Node: Publishing options
\x7f213176
7485 Node: Publishing links
\x7f215328
7486 Node: Project page index
\x7f216841
7487 Node: Sample configuration
\x7f217619
7488 Node: Simple example
\x7f218111
7489 Node: Complex example
\x7f218784
7490 Node: Triggering publication
\x7f220860
7491 Node: Miscellaneous
\x7f221545
7492 Node: Completion
\x7f222179
7493 Node: Customization
\x7f223650
7494 Node: In-buffer settings
\x7f224233
7495 Node: The very busy C-c C-c key
\x7f229109
7496 Node: Clean view
\x7f230753
7497 Node: TTY keys
\x7f233330
7498 Node: Interaction
\x7f234940
7499 Node: Cooperation
\x7f235337
7500 Node: Conflicts
\x7f238213
7501 Node: Bugs
\x7f240216
7502 Node: Extensions and Hacking
\x7f241712
7503 Node: Extensions
\x7f242308
7504 Node: Tables in arbitrary syntax
\x7f244255
7505 Node: Radio tables
\x7f245332
7506 Node: A LaTeX example
\x7f247835
7507 Ref: A LaTeX example-Footnote-1
\x7f251481
7508 Ref: A LaTeX example-Footnote-2
\x7f251629
7509 Node: Translator functions
\x7f252064
7510 Ref: Translator functions-Footnote-1
\x7f255173
7511 Node: Dynamic blocks
\x7f255261
7512 Node: Special agenda views
\x7f257233
7513 Ref: Special agenda views-Footnote-1
\x7f259512
7514 Node: History and Acknowledgments
\x7f259772
7515 Node: Index
\x7f265866
7516 Node: Key Index
\x7f298020