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.78).
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.78).
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 * Tags:: Tagging headlines and matching sets of tags
54 * Timestamps:: Assign date and time to items
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 * Tag inheritance:: Tags use the tree structure of the outline
148 * Setting tags:: How to assign tags to a headline
149 * Tag searches:: Searching for combinations of tags
153 * Time stamps:: Assigning a time to a tree entry
154 * Creating timestamps:: Commands which insert timestamps
155 * Deadlines and scheduling:: Planning your work
156 * Progress logging:: Documenting when what work was done.
160 * The date/time prompt:: How org-mode helps you entering date and time
161 * Custom time format:: Making dates look differently
163 Deadlines and Scheduling
165 * Inserting deadline/schedule::
170 * Closing items:: When was this entry marked DONE?
171 * Tracking TODO state changes:: When did the status change?
172 * Clocking work time:: When exactly did you work on this item?
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.
921 If `org-cycle-include-plain-lists' has not been set, <TAB> fixes
922 the indentation of the curent line in a heuristic way.
925 Insert new item at current level. With prefix arg, force a new
926 heading (*note Structure editing::). If this command is used in
927 the middle of a line, the line is _split_ and the rest of the line
928 becomes the new item. If this command is executed in the
929 _whitespace before a bullet or number_, the new item is created
930 _before_ the current item. If the command is executed in the
931 white space before the text that is part of an item but does not
932 contain the bullet, a bullet is added to the current line.
935 Insert a new item with a checkbox (*note Checkboxes::).
939 Jump to the previous/next item in the current list.
943 Move the item including subitems up/down (swap with previous/next
944 item of same indentation). If the list is ordered, renumbering is
949 Decrease/increase the indentation of the item, including subitems.
950 Initially, the item tree is selected based on current indentation.
951 When these commands are executed several times in direct
952 succession, the initially selected region is used, even if the new
953 indentation would imply a different hierarchy. To use the new
954 hierarchy, break the command chain with a cursor motion or so.
957 If there is a checkbox (*note Checkboxes::) in the item line,
958 toggle the state of the checkbox. If not, make this command makes
959 sure that all the items on this list level use the same bullet.
960 Furthermore, if this is an ordered list, make sure the numbering
963 ---------- Footnotes ----------
965 (1) When using `*' as a bullet, lines must be indented or they will
966 be seen as top-level headlines. Also, when you are hiding leading
967 stars to get a clean outline view, plain list items starting with a
968 star are visually indistinguishable from true headlines. In short:
969 even though `*' is supported, it may be better not to use it for plain
972 (2) Org-mode only changes the filling settings for Emacs. For
973 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
974 put into `.emacs': `(require 'filladapt)'
977 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
982 Org-mode has a very fast and intuitive table editor built-in.
983 Spreadsheet-like calculations are supported in connection with the
984 Emacs `calc' package.
988 * Built-in table editor:: Simple tables
989 * Narrow columns:: Stop wasting space in tables
990 * Column groups:: Grouping to trigger vertical lines
991 * orgtbl-mode:: The table editor as minor mode
992 * The spreadsheet:: The table editor has spreadsheet capabilities.
995 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
997 3.1 The built-in table editor
998 =============================
1000 Org-mode makes it easy to format tables in plain ASCII. Any line with
1001 `|' as the first non-white character is considered part of a table.
1002 `|' is also the column separator. A table might look like this:
1004 | Name | Phone | Age |
1005 |-------+-------+-----|
1006 | Peter | 1234 | 17 |
1007 | Anna | 4321 | 25 |
1009 A table is re-aligned automatically each time you press <TAB> or
1010 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
1011 field (<RET> to the next row) and creates new table rows at the end of
1012 the table or before horizontal lines. The indentation of the table is
1013 set by the first line. Any line starting with `|-' is considered as a
1014 horizontal separator line and will be expanded on the next re-align to
1015 span the whole table width. So, to create the above table, you would
1021 and then press <TAB> to align the table and start filling in fields.
1023 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
1024 and all character keys in a special way, so that inserting and deleting
1025 avoids shifting other fields. Also, when typing _immediately after the
1026 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
1027 the field is automatically made blank. If this behavior is too
1028 unpredictable for you, configure the variables
1029 `org-enable-table-editor' and `org-table-auto-blank-field'.
1031 Creation and conversion
1032 .......................
1035 Convert the active region to table. If every line contains at
1036 least one TAB character, the function assumes that the material is
1037 tab separated. If not, lines are split at whitespace into fields.
1038 You can use a prefix argument to indicate the minimum number of
1039 consecutive spaces required to identify a field separator
1040 (default: just one).
1041 If there is no active region, this command creates an empty
1042 Org-mode table. But it's easier just to start typing, like
1043 `|Name|Phone|Age <RET> |- <TAB>'.
1045 Re-aligning and field motion
1046 ............................
1049 Re-align the table without moving the cursor.
1052 Re-align the table, move to the next field. Creates a new row if
1056 Re-align, move to previous field.
1059 Re-align the table and move down to next row. Creates a new row if
1060 necessary. At the beginning or end of a line, <RET> still does
1061 NEWLINE, so it can be used to split a table.
1063 Column and row editing
1064 ......................
1068 Move the current column left/right.
1071 Kill the current column.
1074 Insert a new column to the left of the cursor position.
1078 Move the current row up/down.
1081 Kill the current row or horizontal line.
1084 Insert a new row above (with arg: below) the current row.
1087 Insert a horizontal line below current row. With prefix arg, the
1088 line is created above the current line.
1091 Sort the table lines in the region. The position of point
1092 indicates the column to be used for sorting, and the range of
1093 lines is the range between the nearest horizontal separator lines,
1094 or the entire table. If point is before the first column, you
1095 will be prompted for the sorting column. If there is an active
1096 region, the mark specifies the first line and the sorting column,
1097 while point should be in the last line to be included into the
1098 sorting. The command prompts for the sorting type
1099 (alphabetically, numerically, or by time). When called with a
1100 prefix argument, alphabetic sorting will be case-sensitive.
1106 Copy a rectangular region from a table to a special clipboard.
1107 Point and mark determine edge fields of the rectangle. The
1108 process ignores horizontal separator lines.
1111 Copy a rectangular region from a table to a special clipboard, and
1112 blank all fields in the rectangle. So this is the "cut" operation.
1115 Paste a rectangular region into a table. The upper right corner
1116 ends up in the current field. All involved fields will be
1117 overwritten. If the rectangle does not fit into the present table,
1118 the table is enlarged as needed. The process ignores horizontal
1122 Wrap several fields in a column like a paragraph. If there is an
1123 active region, and both point and mark are in the same column, the
1124 text in the column is wrapped to minimum width for the given
1125 number of lines. A prefix ARG may be used to change the number of
1126 desired lines. If there is no region, the current field is split
1127 at the cursor position and the text fragment to the right of the
1128 cursor is prepended to the field one line down. If there is no
1129 region, but you specify a prefix ARG, the current field is made
1130 blank, and the content is appended to the field above.
1136 Sum the numbers in the current column, or in the rectangle defined
1137 by the active region. The result is shown in the echo area and can
1138 be inserted with `C-y'.
1141 When current field is empty, copy from first non-empty field above.
1142 When not empty, copy current field down to next row and move cursor
1143 along with it. Depending on the variable
1144 `org-table-copy-increment', integer field values will be
1145 incremented during copy. This key is also used by CUA-mode (*note
1152 Edit the current field in a separate window. This is useful for
1153 fields that are not fully visible (*note Narrow columns::). When
1154 called with a `C-u' prefix, just make the full field visible, so
1155 that it can be edited in place.
1158 This is an alias for `C-u C-c `' to make the current field fully
1161 `M-x org-table-import'
1162 Import a file as a table. The table should be TAB- or whitespace
1163 separated. Useful, for example, to import an Excel table or data
1164 from a database, because these programs generally can write
1165 TAB-separated text files. This command works by inserting the
1166 file into the buffer and then converting the region to a table.
1167 Any prefix argument is passed on to the converter, which uses it
1168 to determine the separator.
1171 Tables can also be imported by pasting tabular text into the
1172 org-mode buffer, selecting the pasted text with `C-x C-x' and then
1173 using the `C-c |' command (see above under Creation and conversion.
1175 `M-x org-table-export'
1176 Export the table as a TAB-separated file. Useful for data
1177 exchange with, for example, Excel or database programs.
1179 If you don't like the automatic table editor because it gets in your
1180 way on lines which you would like to start with `|', you can turn it
1183 (setq org-enable-table-editor nil)
1185 Then the only table command that still works is `C-c C-c' to do a
1189 File: org, Node: Narrow columns, Next: Column groups, Prev: Built-in table editor, Up: Tables
1194 The width of columns is automatically determined by the table editor.
1195 Sometimes a single field or a few fields need to carry more text,
1196 leading to inconveniently wide columns. To limit(1) the width of a
1197 column, one field anywhere in the column may contain just the string
1198 `<N>' where `N' is an integer specifying the width of the column in
1199 characters. The next re-align will then set the width of this column
1200 to no more than this value.
1202 |---+------------------------------| |---+--------|
1204 | 1 | one | | 1 | one |
1205 | 2 | two | ----\ | 2 | two |
1206 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1207 | 4 | four | | 4 | four |
1208 |---+------------------------------| |---+--------|
1210 Fields that are wider become clipped and end in the string `=>'. Note
1211 that the full text is still in the buffer, it is only invisible. To
1212 see the full text, hold the mouse over the field - a tool-tip window
1213 will show the full content. To edit such a field, use the command `C-c
1214 `' (that is `C-c' followed by the backquote). This will open a new
1215 window with the full field. Edit it and finish with `C-c C-c'.
1217 When visiting a file containing a table with narrowed columns, the
1218 necessary character hiding has not yet happened, and the table needs to
1219 be aligned before it looks nice. Setting the option
1220 `org-startup-align-all-tables' will realign all tables in a file upon
1221 visiting, but also slow down startup. You can also set this option on
1222 a per-file basis with:
1227 ---------- Footnotes ----------
1229 (1) This feature does not work on XEmacs.
1232 File: org, Node: Column groups, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1237 When Org-mode exports tables, it does so by default without vertical
1238 lines because that is visually more satisfying in general. Occasionally
1239 however, vertical lines can be useful to structure a table into groups
1240 of columns, much like horizontal lines can do for groups of rows. In
1241 order to specify column groups, you can use a special row where the
1242 first field contains only `/'. The further fields can either contain
1243 `<' to indicate that this column should start a group, `>' to indicate
1244 the end of a column, or `<>' to make a column a group of its own.
1245 Boundaries between colum groups will upon export be marked with
1246 vertical lines. Here is an example:
1248 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1249 |---+----+-----+-----+-----+---------+------------|
1250 | / | <> | < | | > | < | > |
1251 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1252 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1253 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1254 |---+----+-----+-----+-----+---------+------------|
1255 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
1257 It is also sufficient to just insert the colum group starters after
1258 every vertical line you'd like to have:
1260 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1261 |----+-----+-----+-----+---------+------------|
1265 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Column groups, Up: Tables
1267 3.4 The Orgtbl minor mode
1268 =========================
1270 If you like the intuitive way the Org-mode table editor works, you
1271 might also want to use it in other modes like text-mode or mail-mode.
1272 The minor mode Orgtbl-mode makes this possible. You can always toggle
1273 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1276 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1278 Furthermore, with some special setup, it is possible to maintain
1279 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1280 possible to construct LaTeX tables with the underlying ease and power of
1281 Orgtbl-mode, including spreadsheet capabilities. For details, see
1282 *Note Tables in arbitrary syntax::.
1285 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1290 The table editor makes use of the Emacs `calc' package to implement
1291 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1292 derive fields from other fields. While fully featured, Org-mode's
1293 implementation is not identical to other spreadsheets. For example,
1294 Org-mode knows the concept of a _column formula_ that will be applied
1295 to all non-header fields in a column without having to copy the formula
1296 to each relevant field.
1300 * References:: How to refer to another field or range
1301 * Formula syntax for Calc:: Using Calc to compute stuff
1302 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1303 * Field formulas:: Formulas valid for a single field
1304 * Column formulas:: Formulas valid for an entire column
1305 * Editing and debugging formulas:: Fixing formulas
1306 * Updating the table:: Recomputing all dependent fields
1307 * Advanced features:: Field names, parameters and automatic recalc
1310 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1315 To compute fields in the table from other fields, formulas must
1316 reference other fields or ranges. In Org-mode, fields can be referenced
1317 by name, by absolute coordinates, and by relative coordinates. To find
1318 out what the coordinates of a field are, press `C-c ?' in that field,
1319 or press `C-c }' to toggle the display of a grid.
1324 Formulas can reference the value of another field in two ways. Like in
1325 any other spreadsheet, you may reference fields with a letter/number
1326 combination like `B3', meaning the 2nd field in the 3rd row.
1328 Org-mode also uses another, more general operator that looks like this:
1331 Column references can be absolute like `1', `2',...`N', or relative to
1332 the current column like `+1' or `-2'.
1334 The row specification only counts data lines and ignores horizontal
1335 separator lines (hlines). You can use absolute row numbers `1'...`N',
1336 and row numbers relative to the current row like `+3' or `-1'. Or
1337 specify the row relative to one of the hlines: `I' refers to the first
1338 hline, `II' to the second etc. `-I' refers to the first such line
1339 above the current line, `+I' to the first such line below the current
1340 line. You can also write `III+2' which is the second data line after
1341 the third hline in the table. Relative row numbers like `-3' will not
1342 cross hlines if the current line is too close to the hline. Instead,
1343 the value directly at the hline is used.
1345 `0' refers to the current row and column. Also, if you omit either
1346 the column or the row part of the reference, the current row/column is
1349 Org-mode's references with _unsigned_ numbers are fixed references
1350 in the sense that if you use the same reference in the formula for two
1351 different fields, the same field will be referenced each time.
1352 Org-mode's references with _signed_ numbers are floating references
1353 because the same reference operator can reference different fields
1354 depending on the field being calculated by the formula.
1356 Here are a few examples:
1358 @2$3 2nd row, 3rd column
1360 $5 column 5 in the current row
1362 @2 current column, row 2
1363 @-1$-3 the field one row up, three columns to the left
1364 @-I$2 field just under hline above current row, column 2
1369 You may reference a rectangular range of fields by specifying two field
1370 references connected by two dots `..'. If both fields are in the
1371 current row, you may simply use `$2..$7', but if at least one field is
1372 in a different row, you need to use the general `@row$column' format at
1373 least for the first field (i.e the reference must start with `@' in
1374 order to be interpreted correctly). Examples:
1376 $1..$3 First three fields in the current row.
1377 $P..$Q Range, using column names (see under Advanced)
1378 @2$1..@4$3 6 fields between these two fields.
1379 A2..C4 Same as above.
1380 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1382 Range references return a vector of values that can be fed into Calc
1383 vector functions. Empty fields in ranges are normally suppressed, so
1384 that the vector contains only the non-empty fields (but see the `E'
1385 mode switch below). If there are no non-empty fields, `[0]' is
1386 returned to avoid syntax errors in formulas.
1391 `$name' is interpreted as the name of a column, parameter or constant.
1392 Constants are defined globally through the variable
1393 `org-table-formula-constants'. If you have the `constants.el' package,
1394 it will also be used to resolve constants, including natural constants
1395 like `$h' for Planck's constant, and units like `$km' for
1396 kilometers(1). Column names and parameters can be specified in special
1397 table lines. These are described below, see *Note Advanced features::.
1398 All names must start with a letter, and further consist of letters and
1401 ---------- Footnotes ----------
1403 (1) `Constant.el' can supply the values of constants in two
1404 different unit systems, `SI' and `cgs'. Which one is used depends on
1405 the value of the variable `constants-unit-system'. You can use the
1406 `#+STARTUP' options `constSI' and `constcgs' to set this value for the
1410 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1412 3.5.2 Formula syntax for Calc
1413 -----------------------------
1415 A formula can be any algebraic expression understood by the Emacs
1416 `Calc' package. Note that `calc' has the non-standard convention that
1417 `/' has lower precedence than `*', so that `a/b*c' is interpreted as
1418 `a/(b*c)'. Before evaluation by `calc-eval' (*note calc-eval:
1419 (calc)Calling Calc from Your Programs.), variable substitution takes
1420 place according to the rules described above. The range vectors can be
1421 directly fed into the calc vector functions like `vmean' and `vsum'.
1423 A formula can contain an optional mode string after a semicolon.
1424 This string consists of flags to influence Calc and other modes during
1425 execution. By default, Org-mode uses the standard calc modes (precision
1426 12, angular units degrees, fraction and symbolic modes off. The display
1427 format, however, has been changed to `(float 5)' to keep tables
1428 compact. The default settings can be configured using the variable
1429 `org-calc-default-modes'.
1431 p20 switch the internal precision to 20 digits
1432 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1433 D R angle modes: degrees, radians
1434 F S fraction and symbolic modes
1435 N interpret all fields as numbers, use 0 for non-numbers
1436 T force text interpretation
1437 E keep empty fields in ranges
1439 In addition, you may provide a `printf' format specifier to reformat
1440 the final result. A few examples:
1442 $1+$2 Sum of first and second field
1443 $1+$2;%.2f Same, format result to two decimals
1444 exp($2)+exp($1) Math functions can be used
1445 $0;%.1f Reformat current cell to 1 decimal
1446 ($3-32)*5/9 Degrees F -> C conversion
1447 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1448 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1449 sin($1);Dp3%.1e Same, but use printf specifier for display
1450 vmean($2..$7) Compute column range mean, using vector function
1451 vmean($2..$7);EN Same, but treat empty fields as 0
1452 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1454 Calc also contains a complete set of logical operations. For example
1456 if($1<20,teen,string("")) "teen" if age $1 less than 20, else empty
1459 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1461 3.5.3 Emacs Lisp forms as formulas
1462 ----------------------------------
1464 It is also possible to write a formula in Emacs Lisp; this can be useful
1465 for string manipulation and control structures, if the Calc's
1466 functionality is not enough. If a formula starts with a single quote
1467 followed by an opening parenthesis, then it is evaluated as a lisp form.
1468 The evaluation should return either a string or a number. Just as with
1469 `calc' formulas, you can specify modes and a printf format after a
1470 semicolon. With Emacs Lisp forms, you need to be concious about the way
1471 field references are interpolated into the form. By default, a
1472 reference will be interpolated as a Lisp string (in double quotes)
1473 containing the field. If you provide the `N' mode switch, all
1474 referenced elements will be numbers (non-number fields will be zero) and
1475 interpolated as Lisp numbers, without quotes. If you provide the `L'
1476 flag, all fields will be interpolated literally, without quotes. I.e.,
1477 if you want a reference to be interpreted as a string by the Lisp form,
1478 enclode the reference operator itself in double quotes, like `"$3"'.
1479 Ranges are inserted as space-separated fields, so you can embed them in
1480 list or vector syntax. A few examples, note how the `N' mode is used
1481 when we do computations in lisp.
1483 Swap the first two characters of the content of column 1
1484 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1485 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1487 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1488 '(apply '+ '($1..$4));N
1491 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1493 3.5.4 Field formulas
1494 --------------------
1496 To assign a formula to a particular field, type it directly into the
1497 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1498 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1499 will be stored as the formula for this field, evaluated, and the
1500 current field replaced with the result.
1502 Formulas are stored in a special line starting with `#+TBLFM:'
1503 directly below the table. If you typed the equation in the 4th field of
1504 the 3rd data line in the table, the formula will look like
1505 `@3$4=$1+$2'. When inserting/deleting/swapping column and rows with
1506 the appropriate commands, absolute references (but not relative ones)
1507 in stored formulas are modified in order to still reference the same
1508 field. Of cause this is not true if you edit the table structure with
1509 normal editing commands - then you must fix the equations yourself.
1511 Instead of typing an equation into the field, you may also use the
1515 Install a new formula for the current field. The command prompts
1516 for a formula, with default taken from the `#+TBLFM:' line, applies
1517 it to the current field and stores it.
1520 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1522 3.5.5 Column formulas
1523 ---------------------
1525 Often in a table, the same formula should be used for all fields in a
1526 particular column. Instead of having to copy the formula to all fields
1527 in that column, org-mode allows to assign a single formula to an entire
1528 column. If the table contains horizontal separator hlines, everything
1529 before the first such line is considered part of the table _header_ and
1530 will not be modified by column formulas.
1532 To assign a formula to a column, type it directly into any field in
1533 the column, preceded by an equal sign, like `=$1+$2'. When you press
1534 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1535 formula will be stored as the formula for the current column, evaluated
1536 and the current field replaced with the result. If the field contains
1537 only `=', the previously stored formula for this column is used. For
1538 each column, Org-mode will only remember the most recently used
1539 formula. In the `TBLFM:' line, column formulas will look like
1542 Instead of typing an equation into the field, you may also use the
1546 Install a new formula for the current column and replace current
1547 field with the result of the formula. The command prompts for a
1548 formula, with default taken from the `#+TBLFM' line, applies it to
1549 the current field and stores it. With a numerical prefix (e.g.
1550 `C-5 C-c =') will apply it to that many consecutive fields in the
1554 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1556 3.5.6 Editing and Debugging formulas
1557 ------------------------------------
1559 You can edit individual formulas in the minibuffer or directly in the
1560 field. Org-mode can also prepare a special buffer with all active
1561 formulas of a table. When offering a formula for editing, Org-mode
1562 converts references to the standard format (like `B3' or `D&') if
1563 possible. If you prefer to only work with the internal format (like
1564 `@3$2' or `$4'), configure the variable
1565 `org-table-use-standard-references'.
1569 Edit the formula associated with the current column/field in the
1570 minibuffer. See *Note Column formulas:: and *Note Field
1574 Re-insert the active formula (either a field formula, or a column
1575 formula) into the current field, so that you can edit it directly
1576 in the field. The advantage over editing in the minibuffer is
1577 that you can use the command `C-c ?'.
1580 While editing a formula in a table field, highlight the field(s)
1581 referenced by the reference at the cursor position in the formula.
1584 Toggle the display of row and column numbers for a table, using
1585 overlays. These are updated each time the table is aligned, you
1586 can force it with `C-c C-c'.
1589 Toggle the formula debugger on and off. See below.
1592 Edit all formulas for the current table in a special buffer, where
1593 the formulas will be displayed one per line. If the current field
1594 has an active formula, the cursor in the formula editor will mark
1595 it. While inside the special buffer, Org-mode will automatically
1596 highlight any field or range reference at the cursor position.
1597 You may edit, remove and add formulas, and use the following
1601 Exit the formula editor and store the modified formulas.
1602 With `C-u' prefix, also apply the new formulas to the entire
1606 Exit the formula editor without installing changes.
1609 Toggle all references in the formula editor between standard
1610 (like `B3') and internal (like `@3$2').
1613 Pretty-print or indent lisp formula at point. When in a line
1614 containing a lisp formula, format the formula according to
1615 Emacs Lisp rules. Another <TAB> collapses the formula back
1616 again. In the open formula, <TAB> re-indents just like in
1620 Complete Lisp symbols, just like in Emacs-lisp-mode.
1622 `S-<up>/<down>/<left>/<right>'
1623 Shift the reference at point. For example, if the reference
1624 is `B3' and you press `S-<right>', it will become `C3'. This
1625 also works for relative references, and for hline references.
1628 Move the test line for column formulas in the Org-mode buffer
1632 Scroll the window displaying the table.
1635 Turn the coordinate grid in the table on and off.
1637 Making a table field blank does not remove the formula associated
1638 with the field, because that is stored in a different line (the `TBLFM'
1639 line) - during the next recalculation the field will be filled again.
1640 To remove a formula from a field, you have to give an empty reply when
1641 prompted for the formula, or to edit the `#+TBLFM' line.
1643 You may edit the `#+TBLFM' directly and re-apply the changed
1644 equations with `C-c C-c' in that line, or with the normal recalculation
1645 commands in the table.
1650 When the evaluation of a formula leads to an error, the field content
1651 becomes the string `#ERROR'. If you would like see what is going on
1652 during variable substitution and calculation in order to find a bug,
1653 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1654 for example by pressing `C-u C-u C-c = <RET>' in a field. Detailed
1655 information will be displayed.
1658 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1660 3.5.7 Updating the Table
1661 ------------------------
1663 Recalculation of a table is normally not automatic, but needs to be
1664 triggered by a command. See *Note Advanced features:: for a way to make
1665 recalculation at least semi-automatically.
1667 In order to recalculate a line of a table or the entire table, use
1668 the following commands:
1671 Recalculate the current row by first applying the stored column
1672 formulas from left to right, and all field formulas in the current
1677 Recompute the entire table, line by line. Any lines before the
1678 first hline are left alone, assuming that these are part of the
1682 Iterate the table by recomputing it until no further changes occur.
1683 This may be necessary if some computed fields use the value of
1684 other fields that are computed later in the calculation sequence.
1687 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1689 3.5.8 Advanced features
1690 -----------------------
1692 If you want the recalculation of fields to happen automatically, or if
1693 you want to be able to assign names to fields and columns, you need to
1694 reserve the first column of the table for special marking characters.
1696 Rotate the calculation mark in first column through the states `',
1697 `#', `*', `!', `$'. The meaning of these characters is discussed
1698 below. When there is an active region, change all marks in the
1701 Here is an example of a table that collects exam results of students
1702 and makes use of these features:
1704 |---+---------+--------+--------+--------+-------+------|
1705 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1706 |---+---------+--------+--------+--------+-------+------|
1707 | ! | | P1 | P2 | P3 | Tot | |
1708 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1709 | ^ | | m1 | m2 | m3 | mt | |
1710 |---+---------+--------+--------+--------+-------+------|
1711 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1712 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1713 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1714 |---+---------+--------+--------+--------+-------+------|
1715 | | Average | | | | 29.7 | |
1716 | ^ | | | | | at | |
1717 | $ | max=50 | | | | | |
1718 |---+---------+--------+--------+--------+-------+------|
1719 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1721 Important: Please note that for these special tables, recalculating the
1722 table with `C-u C-c *' will only affect rows that are marked `#' or
1723 `*', and fields that have a formula assigned to the field itself. The
1724 column formulas are not applied in rows with empty first field.
1726 The marking characters have the following meaning:
1728 The fields in this line define names for the columns, so that you
1729 may refer to a column as `$Tot' instead of `$6'.
1732 This row defines names for the fields _above_ the row. With such
1733 a definition, any formula in the table may use `$m1' to refer to
1734 the value `10'. Also, if you assign a formula to a names field, it
1735 will be stored as `$name=...'.
1738 Similar to `^', but defines names for the fields in the row
1742 Fields in this row can define _parameters_ for formulas. For
1743 example, if a field in a `$' row contains `max=50', then formulas
1744 in this table can refer to the value 50 using `$max'. Parameters
1745 work exactly like constants, only that they can be defined on a
1749 Fields in this row are automatically recalculated when pressing
1750 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1751 selected for a global recalculation with `C-u C-c *'. Unmarked
1752 lines will be left alone by this command.
1755 Selects this line for global recalculation with `C-u C-c *', but
1756 not for automatic recalculation. Use this when automatic
1757 recalculation slows down editing too much.
1760 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1761 All lines that should be recalculated should be marked with `#' or
1765 Do not export this line. Useful for lines that contain the
1766 narrowing `<N>' markers.
1768 Finally, just to whet your appetite on what can be done with the
1769 fantastic `calc' package, here is a table that computes the Taylor
1770 series of degree `n' at location `x' for a couple of functions
1771 (homework: try that with Excel :-)
1773 |---+-------------+---+-----+--------------------------------------|
1774 | | Func | n | x | Result |
1775 |---+-------------+---+-----+--------------------------------------|
1776 | # | exp(x) | 1 | x | 1 + x |
1777 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1778 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1779 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1780 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1781 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1782 |---+-------------+---+-----+--------------------------------------|
1783 #+TBLFM: $5=taylor($2,$4,$3);n3
1786 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1791 Just like HTML, Org-mode provides links inside a file, and external
1792 links to other files, Usenet articles, emails, and much more.
1796 * Link format:: How links in Org-mode are formatted
1797 * Internal links:: Links to other places in the current file
1798 * External links:: URL-like links to the world
1799 * Handling links:: Creating, inserting and following
1800 * Link abbreviations:: Shortcuts for writing complex links
1801 * Search options:: Linking to a specific location
1802 * Custom searches:: When the default search is not enough
1803 * Remember:: Org-trees store quick notes
1806 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1811 Org-mode will recognize plain URL-like links and activate them as
1812 clickable links. The general link format, however, looks like this:
1814 [[link][description]] or alternatively [[link]]
1816 Once a link in the buffer is complete (all brackets present),
1817 Org-mode will change the display so that `description' is displayed
1818 instead of `[[link][description]]' and `link' is displayed instead of
1819 `[[link]]'. Links will be highlighted in the face `org-link', which by
1820 default is an underlined face. You can directly edit the visible part
1821 of a link. Note that this can be either the `link' part (if there is
1822 no description) or the `description' part. To edit also the invisible
1823 `link' part, use `C-c C-l' with the cursor on the link.
1825 If you place the cursor at the beginning or just behind the end of
1826 the displayed text and press <BACKSPACE>, you will remove the
1827 (invisible) bracket at that location. This makes the link incomplete
1828 and the internals are again displayed as plain text. Inserting the
1829 missing bracket hides the link internals again. To show the internal
1830 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1834 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1839 If the link does not look like a URL, it is considered to be internal in
1840 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1841 my target]]' lead to a text search in the current file. The link can
1842 be followed with `C-c C-o' when the cursor is on the link, or with a
1843 mouse click (*note Handling links::). The preferred match for such a
1844 link is a dedicated target: the same string in double angular brackets.
1845 Targets may be located anywhere; sometimes it is convenient to put
1846 them into a comment line. For example
1850 In HTML export (*note HTML export::), such targets will become named
1851 anchors for direct access through `http' links(1).
1853 If no dedicated target exists, Org-mode will search for the words in
1854 the link. In the above example the search would be for `my target'.
1855 Links starting with a star like `*My Target' restrict the search to
1856 headlines. When searching, Org-mode will first try an exact match, but
1857 then move on to more and more lenient searches. For example, the link
1858 `[[*My Targets]]' will find any of the following:
1861 ** TODO my targets are bright
1862 ** my 20 targets are
1864 To insert a link targeting a headline, in-buffer completion can be
1865 used. Just type a star followed by a few optional letters into the
1866 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1867 offered as completions. *Note Handling links::, for more commands
1870 Following a link pushes a mark onto Org-mode's own mark ring. You
1871 can return to the previous position with `C-c &'. Using this command
1872 several times in direct succession goes back to positions recorded
1877 * Radio targets:: Make targets trigger links in plain text.
1879 ---------- Footnotes ----------
1881 (1) Note that text before the first headline is usually not
1882 exported, so the first such target should be after the first headline.
1885 File: org, Node: Radio targets, Prev: Internal links, Up: Internal links
1890 You can configure Org-mode to link any occurrences of certain target
1891 names in normal text. So without explicitly creating a link, the text
1892 connects to the target radioing its position. Radio targets are
1893 enclosed by triple angular brackets. For example, a target `<<<My
1894 Target>>>' causes each occurrence of `my target' in normal text to
1895 become activated as a link. The Org-mode file is scanned automatically
1896 for radio targets only when the file is first loaded into Emacs. To
1897 update the target list during editing, press `C-c C-c' with the cursor
1901 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1906 Org-mode supports links to files, websites, Usenet and email messages,
1907 and BBDB database entries. External links are URL-like locators. They
1908 start with a short identifying string followed by a colon. There can be
1909 no space after the colon. The following list shows examples for each
1912 http://www.astro.uva.nl/~dominik on the web
1913 file:/home/dominik/images/jupiter.jpg file, absolute path
1914 file:papers/last.pdf file, relative path
1915 news:comp.emacs Usenet link
1916 mailto:adent@galaxy.net Mail link
1917 vm:folder VM folder link
1918 vm:folder#id VM message link
1919 vm://myself@some.where.org/folder#id VM on remote machine
1920 wl:folder WANDERLUST folder link
1921 wl:folder#id WANDERLUST message link
1922 mhe:folder MH-E folder link
1923 mhe:folder#id MH-E message link
1924 rmail:folder RMAIL folder link
1925 rmail:folder#id RMAIL message link
1926 gnus:group GNUS group link
1927 gnus:group#id GNUS article link
1928 bbdb:Richard Stallman BBDB link
1929 shell:ls *.org A shell command
1930 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1932 A link should be enclosed in double brackets and may contain a
1933 descriptive text to be displayed instead of the url (*note Link
1934 format::), for example:
1936 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1938 If the description is a file name or URL that points to an image, HTML
1939 export (*note HTML export::) will inline the image as a clickable
1940 button. If there is no description at all and the link points to an
1941 image, that image will be inlined into the exported HTML file.
1943 Org-mode also finds external links in the normal text and activates
1944 them as links. If spaces must be part of the link (for example in
1945 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
1946 the end of the link, enclose them in angular brackets.
1949 File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
1954 Org-mode provides methods to create a link in the correct syntax, to
1955 insert it into an org-mode file, and to follow the link.
1958 Store a link to the current location. This is a _global_ command
1959 which can be used in any buffer to create a link. The link will be
1960 stored for later insertion into an Org-mode buffer (see below).
1961 For Org-mode files, if there is a `<<target>>' at the cursor, the
1962 link points to the target. Otherwise it points to the current
1963 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1964 the link will indicate the current article/entry. For W3 and W3M
1965 buffers, the link goes to the current URL. For any other files,
1966 the link will point to the file, with a search string (*note
1967 Search options::) pointing to the contents of the current line.
1968 If there is an active region, the selected words will form the
1969 basis of the search string. If the automatically created link is
1970 not working correctly or accurately enough, you can write custom
1971 functions to select the search string and to do the search for
1972 particular file types - see *Note Custom searches::. The key
1973 binding `C-c l' is only a suggestion - see *Note Installation::.
1976 Insert a link. This prompts for a link to be inserted into the
1977 buffer. You can just type a link, using text for an internal
1978 link, or one of the link type prefixes mentioned in the examples
1979 above. All links stored during the current session are part of
1980 the history for this prompt, so you can access them with <up> and
1981 <down>. Completion, on the other hand, will help you to insert
1982 valid link prefixes like `http:' or `ftp:', including the prefixes
1983 defined through link abbreviations (*note Link abbreviations::).
1984 The link will be inserted into the buffer(1), along with a
1985 descriptive text. If some text was selected when this command is
1986 called, the selected text becomes the default description.
1987 Note that you don't have to use this command to insert a link.
1988 Links in Org-mode are plain text, and you can type or paste them
1989 straight into the buffer. By using this command, the links are
1990 automatically enclosed in double brackets, and you will be asked
1991 for the optional descriptive text.
1994 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1995 file will be inserted and you may use file name completion to
1996 select the name of the file. The path to the file is inserted
1997 relative to the directory of the current org file, if the linked
1998 file is in the current directory or in a subdirectory of it, or if
1999 the path is written relative to the current directory using `../'.
2000 Otherwise an absolute path is used, if possible with `~/' for
2001 your home directory. You can force an absolute path with two
2004 `C-c C-l (with cursor on existing link)'
2005 When the cursor is on an existing link, `C-c C-l' allows you to
2006 edit the link and description parts of the link.
2009 Open link at point. This will launch a web browser for URLs (using
2010 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
2011 the corresponding links, and execute the command in a shell link.
2012 When the cursor is on an internal link, this commands runs the
2013 corresponding search. When the cursor is on a TAG list in a
2014 headline, it creates the corresponding TAGS view. If the cursor
2015 is on a time stamp, it compiles the agenda for that date.
2016 Furthermore, it will visit text and remote files in `file:' links
2017 with Emacs and select a suitable application for local non-text
2018 files. Classification of files is based on file extension only.
2019 See option `org-file-apps'. If you want to override the default
2020 application and visit the file with Emacs, use a `C-u' prefix.
2024 On links, `mouse-2' will open the link just as `C-c C-o' would.
2025 Under Emacs 22, also `mouse-1' will follow a link.
2028 Like `mouse-2', but force file links to be opened with Emacs, and
2029 internal links to be displayed in another window(2).
2032 Push the current position onto the mark ring, to be able to return
2033 easily. Commands following an internal link do this automatically.
2036 Jump back to a recorded position. A position is recorded by the
2037 commands following internal links, and by `C-c %'. Using this
2038 command several times in direct succession moves through a ring of
2039 previously recorded positions.
2043 Move forward/backward to the next link in the buffer. At the
2044 limit of the buffer, the search fails once, and then wraps around.
2045 The key bindings for this are really too long, you might want to
2046 bind this also to `C-n' and `C-p'
2047 (add-hook 'org-load-hook
2049 (define-key 'org-mode-map "\C-n" 'org-next-link)
2050 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2052 ---------- Footnotes ----------
2054 (1) After insertion of a stored link, the link will be removed from
2055 the list of stored links. To keep it in the list later use, use a
2056 triple `C-u' prefix to `C-c C-l', or configure the option
2057 `org-keep-stored-link-after-insertion'.
2059 (2) See the variable `org-display-internal-link-with-indirect-buffer'
2062 File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
2064 4.5 Link abbreviations
2065 ======================
2067 Long URLs can be cumbersome to type, and often many similar links are
2068 needed in a document. For this you can use link abbreviations. An
2069 abbreviated link looks like this
2071 [[linkword:tag][description]]
2073 where the tag is optional. Such abbreviations are resolved according to
2074 the information in the variable `org-link-abbrev-alist' that relates
2075 the linkwords to replacement text. Here is an example:
2077 (setq org-link-abbrev-alist
2078 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2079 ("google" . "http://www.google.com/search?q=")
2080 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2081 nph-abs_connect?author=%s&db_key=AST")))
2083 If the replacement text contains the string `%s', it will be
2084 replaced with the tag. Otherwise the tag will be appended to the string
2085 in order to create the link. You may also specify a function that will
2086 be called with the tag as the only argument to create the link.
2088 With the above setting, you could link to a specific bug with
2089 `[[bugzilla:129]]', search the web for `OrgMode' with
2090 `[[google:OrgMode]]' and find out what the Org-mode author is doing
2091 besides Emacs hacking with `[[ads:Dominik,C]]'.
2093 If you need special abbreviations just for a single Org-mode buffer,
2094 you can define them in the file with
2096 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
2097 #+LINK: google http://www.google.com/search?q=%s
2099 In-buffer completion *note Completion:: can be used after `[' to
2100 complete link abbreviations.
2103 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
2105 4.6 Search options in file links
2106 ================================
2108 File links can contain additional information to make Emacs jump to a
2109 particular location in the file when following a link. This can be a
2110 line number or a search option after a double(1) colon. For example,
2111 when the command `C-c l' creates a link (*note Handling links::) to a
2112 file, it encodes the words in the current line as a search string that
2113 can be used to find this line back later when following the link with
2116 Here is the syntax of the different ways to attach a search to a file
2117 link, together with an explanation:
2119 [[file:~/code/main.c::255]]
2120 [[file:~/xx.org::My Target]]
2121 [[file:~/xx.org::*My Target]]
2122 [[file:~/xx.org::/regexp/]]
2128 Search for a link target `<<My Target>>', or do a text search for
2129 `my target', similar to the search in internal links, see *Note
2130 Internal links::. In HTML export (*note HTML export::), such a
2131 file link will become an HTML reference to the corresponding named
2132 anchor in the linked file.
2135 In an Org-mode file, restrict search to headlines.
2138 Do a regular expression search for `regexp'. This uses the Emacs
2139 command `occur' to list all matches in a separate window. If the
2140 target file is in Org-mode, `org-occur' is used to create a sparse
2141 tree with the matches.
2143 As a degenerate case, a file link with an empty file name can be used
2144 to search the current file. For example, `[[file:::find me]]' does a
2145 search for `find me' in the current file, just as `[[find me]]' would.
2147 ---------- Footnotes ----------
2149 (1) For backward compatibility, line numbers can also follow a
2153 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
2158 The default mechanism for creating search strings and for doing the
2159 actual search related to a file link may not work correctly in all
2160 cases. For example, BibTeX database files have many entries like
2161 `year="1993"' which would not result in good search strings, because
2162 the only unique identification for a BibTeX entry is the citation key.
2164 If you come across such a problem, you can write custom functions to
2165 set the right search string for a particular file type, and to do the
2166 search for the string in the file. Using `add-hook', these functions
2167 need to be added to the hook variables
2168 `org-create-file-search-functions' and
2169 `org-execute-file-search-functions'. See the docstring for these
2170 variables for more information. Org-mode actually uses this mechanism
2171 for BibTeX database files, and you can use the corresponding code as an
2172 implementation example. Search for `BibTeX links' in the source file.
2175 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
2180 Another way to create org entries with links to other files is through
2181 the remember package by John Wiegley. Remember lets you store quick
2182 notes with little interruption of your work flow. See
2183 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
2184 information. The notes produced by Remember can be stored in different
2185 ways, and Org-mode files are a good target. Org-mode significantly
2186 expands the possibilities of remember: You may define templates for
2187 different note types, and to associate target files and headlines with
2188 specific templates. It also allows you to select the location where a
2189 note should be stored interactively, on the fly.
2193 * Setting up remember:: Some code for .emacs to get things going
2194 * Remember templates:: Define the outline of different note types
2195 * Storing notes:: Directly get the note to where it belongs
2198 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
2200 4.8.1 Setting up remember
2201 -------------------------
2203 The following customization will tell remember to use org files as
2204 target, and to create annotations compatible with Org-mode links.
2206 (setq org-directory "~/path/to/my/orgfiles/")
2207 (setq org-default-notes-file "~/.notes")
2208 (setq remember-annotation-functions '(org-remember-annotation))
2209 (setq remember-handler-functions '(org-remember-handler))
2210 (add-hook 'remember-mode-hook 'org-remember-apply-template)
2213 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
2215 4.8.2 Remember templates
2216 ------------------------
2218 In combination with Org-mode, you can use templates to generate
2219 different types of remember notes. For example, if you would like to
2220 use one template to create general TODO entries, another one for
2221 journal entries, and a third one for collecting random ideas, you could
2224 (setq org-remember-templates
2225 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
2226 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
2227 (?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
2229 In these entries, the character specifies how to select the template.
2230 The first string specifies the template. Two more (optional) strings
2231 give the file in which, and the headline under which the new note
2232 should be stored. The file defaults (if not present or `nil') to
2233 `org-default-notes-file', the heading to
2234 `org-remember-default-headline'. Both defaults help to get to the
2235 storing location quickly, but you can change the location interactively
2236 while storing the note.
2238 When you call `M-x remember' (or `M-x org-remember') to remember
2239 something, org will prompt for a key to select the template (if you have
2240 more than one template) and then prepare the buffer like
2242 [[file:link to where you called remember]]
2246 * [2006-03-21 Tue 15:37]
2248 [[file:link to where you called remember]]
2250 During expansion of the template, special `%'-escapes allow dynamic
2251 insertion of content:
2252 %^{prompt} prompt the user for a string and replace this sequence with it.
2253 %t time stamp, date only
2254 %T time stamp with date and time
2255 %u, %U like the above, but inactive time stamps
2256 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
2257 You may define a prompt like `%^{Birthday}t'
2258 %n user name (taken from `user-full-name')
2259 %a annotation, normally the link created with `org-store-link'
2260 %i initial content, the region when remember is called with C-u.
2261 The entire text will be indented like `%i' itself.
2262 %:keyword specific information for certain link types, see below
2264 For specific link types, the following keywords will be defined:
2266 Link type | Available keywords
2267 -------------------+----------------------------------------------
2268 bbdb | %:name %:company
2269 vm, wl, mh, rmail | %:type %:subject %:message-id
2270 | %:from %:fromname %:fromaddress
2271 | %:to %:toname %:toaddress
2272 | %:fromto (either "to NAME" or "from NAME")(1)
2273 gnus | %:group, for messages also all email fields
2275 info | %:file %:node
2278 To place the cursor after template expansion use:
2280 %? After completing the template, position cursor here.
2282 If you change you mind about which template to use, call `org-remember'
2283 in the remember buffer. You may then select a new template that will
2284 be filled with the previous context information.
2286 ---------- Footnotes ----------
2288 (1) This will always be the other, not the user. See the variable
2289 `org-from-is-user-regexp'.
2292 File: org, Node: Storing notes, Prev: Remember templates, Up: Remember
2297 When you are finished preparing a note with remember, you have to press
2298 `C-c C-c' to file the note away. The handler first prompts for a
2299 target file - if you press <RET>, the value specified for the template
2300 is used. Then the command offers the headings tree of the selected
2301 file, with the cursor position at the default headline (if you had
2302 specified one in the template). You can either immediately press <RET>
2303 to get the note placed there. Or you can use the following keys to
2304 find a better location:
2305 <TAB> Cycle visibility.
2306 <down> / <up> Next/previous visible headline.
2307 n / p Next/previous visible headline.
2308 f / b Next/previous headline same level.
2310 Pressing <RET> or <left> or <right> then leads to the following
2313 Cursor Key Note gets inserted
2315 buffer-start <RET> as level 2 heading at end of file
2316 on headline <RET> as sublevel of the heading at cursor
2317 <left>/<right>as same level, before/after current heading
2318 not on <RET> at cursor position, level taken from context.
2321 So a fast way to store the note to its default location is to press
2322 `C-c C-c <RET> <RET>'. Even shorter would be `C-u C-c C-c', which does
2323 the same without even asking for a file or showing the tree.
2325 Before inserting the text into a tree, the function ensures that the
2326 text has a headline, i.e. a first line that starts with a `*'. If not,
2327 a headline is constructed from the current date and some additional
2328 data. If the variable `org-adapt-indentation' is non-nil, the entire
2329 text is also indented so that it starts in the same column as the
2330 headline (after the asterisks).
2333 File: org, Node: TODO items, Next: Tags, Prev: Hyperlinks, Up: Top
2338 Org-mode does not maintain TODO lists as a separate document. TODO
2339 items are an integral part of the notes file, because TODO items
2340 usually come up while taking notes! With Org-mode, you simply mark any
2341 entry in a tree as being a TODO item. In this way, the information is
2342 not duplicated, and the entire context from which the item emerged is
2343 always present when you check.
2345 Of course, this technique causes TODO items to be scattered
2346 throughout your file. Org-mode provides methods to give you an
2347 overview over all things you have to do.
2351 * TODO basics:: Marking and displaying TODO entries
2352 * TODO extensions:: Workflow and assignments
2353 * Priorities:: Some things are more important than others
2354 * Breaking down tasks:: Splitting a task into manageable pieces
2355 * Checkboxes:: Tick-off lists
2358 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2360 5.1 Basic TODO functionality
2361 ============================
2363 Any headline can become a TODO item by starting it with the word TODO,
2366 *** TODO Write letter to Sam Fortune
2368 The most important commands to work with TODO entries are:
2371 Rotate the TODO state of the current item among
2373 ,-> (unmarked) -> TODO -> DONE --.
2374 '--------------------------------'
2376 The same rotation can also be done "remotely" from the timeline and
2377 agenda buffers with the `t' command key (*note Agenda commands::).
2381 Select the following/preceding TODO state, similar to cycling.
2382 Mostly useful if more than two TODO states are possible (*note
2386 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2387 the entire buffer, but shows all TODO items and the headings
2388 hierarchy above them. With prefix arg, search for a specific
2389 TODO. You will be prompted for the keyword, and you can also give
2390 a list of keywords like `kwd1|kwd2|...'. With numerical prefix N,
2391 show the tree for the Nth keyword in the variable
2392 `org-todo-keywords'. With two prefix args, find all TODO and DONE
2396 Show the global TODO list. This collects the TODO items from all
2397 agenda files (*note Agenda views::) into a single buffer. The
2398 buffer is in `agenda-mode', so there are commands to examine and
2399 manipulate the TODO entries directly from that buffer (*note
2400 Agenda commands::). *Note Global TODO list::, for more
2404 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
2406 5.2 Extended use of TODO keywords
2407 =================================
2409 The default implementation of TODO entries is just two states: TODO and
2410 DONE. You can use the TODO feature for more complicated things by
2411 configuring the variable `org-todo-keywords'. With special setup, the
2412 TODO keyword system can work differently in different files.
2414 Note that tags are another way to classify headlines in general and
2415 TODO items in particular (*note Tags::).
2419 * Workflow states:: From TODO to DONE in steps
2420 * TODO types:: I do this, Fred the rest
2421 * Multiple sets in one file:: Mixing it all, and still finding your way
2422 * Per file keywords:: Different files, different requirements
2425 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2427 5.2.1 TODO keywords as workflow states
2428 --------------------------------------
2430 You can use TODO keywords to indicate different _sequential_ states in
2431 the process of working on an item, for example(1):
2433 (setq org-todo-keywords
2434 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2436 The vertical bar separates the TODO keywords (states that _need
2437 action_) from the DONE states (which need _no further action_. If you
2438 don't provide the separator bar, the last state is used as the DONE
2439 state. With this setup, the command `C-c C-t' will cycle an entry from
2440 TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
2441 You may also use a prefix argument to quickly select a specific state.
2442 For example `C-3 C-c C-t' will change the state immediately to VERIFY.
2443 If you define many keywords, you can use in-buffer completion (see
2444 *Note Completion::) to insert these words into the buffer. Changing a
2445 todo state can be logged with a timestamp, see *Note Tracking TODO
2446 state changes:: for more information.
2448 ---------- Footnotes ----------
2450 (1) Changing this variable only becomes effective after restarting
2451 Org-mode in a buffer.
2454 File: org, Node: TODO types, Next: Multiple sets in one file, Prev: Workflow states, Up: TODO extensions
2456 5.2.2 TODO keywords as types
2457 ----------------------------
2459 The second possibility is to use TODO keywords to indicate different
2460 _types_ of action items. For example, you might want to indicate that
2461 items are for "work" or "home". Or, when you work with several people
2462 on a single project, you might want to assign action items directly to
2463 persons, by using their names as TODO keywords. This would be set up
2466 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2468 In this case, different keywords do not indicate a sequence, but
2469 rather different types. So the normal work flow would be to assign a
2470 task to a person, and later to mark it DONE. Org-mode supports this
2471 style by adapting the workings of the command `C-c C-t'(1). When used
2472 several times in succession, it will still cycle through all names, in
2473 order to first select the right type for a task. But when you return
2474 to the item after some time and execute `C-c C-t' again, it will switch
2475 from any name directly to DONE. Use prefix arguments or completion to
2476 quickly select a specific name. You can also review the items of a
2477 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2478 C-v'. For example, to see all things Lucy has to do, you would use
2479 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2480 single buffer, you would use the prefix arg as well when creating the
2481 global todo list: `C-3 C-c t'.
2483 ---------- Footnotes ----------
2485 (1) This is also true for the `t' command in the timeline and agenda
2489 File: org, Node: Multiple sets in one file, Next: Per file keywords, Prev: TODO types, Up: TODO extensions
2491 5.2.3 Multiple keyword sets in one file
2492 ---------------------------------------
2494 Sometimes you may want to use different sets of TODO keywords in
2495 parallel. For example, you may want to have the basic `TODO'/`DONE',
2496 but also a workflow for bug fixing, and a separate state indicating
2497 that an item has been canceled (so it is not DONE, but also does not
2498 require action). Your setup would then look like this:
2500 (setq org-todo-keywords
2501 '((sequence "TODO" "|" "DONE")
2502 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2503 (sequence "|" "CANCELED")))
2505 The keywords should all be different, this helps Org-mode to keep
2506 track of which subsequence should be used for a given entry. In this
2507 setup, `C-c C-t' only operates within a subsequence, so it switches from
2508 `DONE' to (nothing) to `TODO', and from `FIXED' to (nothing) to
2509 `REPORT'. Therefore you need a mechanism to initially select the
2510 correct sequence. Besides the obvious ways like typing a keyword or
2511 using completion, you may also apply the following commands:
2515 These keys jump from one TODO subset to the next. In the above
2516 example, `C-S-<right>' would jump from `TODO' or `DONE' to
2517 `REPORT', and any of the words in the second row to `CANCELED'.
2521 `S-<<left>>' and `S-<<right>>' and walk through _all_ keywords
2522 from all sets, so for example `S-<<right>>' would switch from
2523 `DONE' to `REPORT' in the example above.
2526 File: org, Node: Per file keywords, Prev: Multiple sets in one file, Up: TODO extensions
2528 5.2.4 Setting up keywords for individual files
2529 ----------------------------------------------
2531 It can be very useful to use different aspects of the TODO mechanism in
2532 different files. For file-local settings, you need to add special lines
2533 to the file which set the keywords and interpretation for that file
2534 only. For example, to set one of the two examples discussed above, you
2535 need one of the following lines, starting in column zero anywhere in the
2538 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2540 #+TYP_TODO: Fred Sara Lucy Mike | DONE
2542 A setup for using several sets in parallel would be:
2544 #+SEQ_TODO: "TODO" "|" "DONE"
2545 #+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED"
2546 #+SEQ_TODO: "|" "CANCELED"
2548 To make sure you are using the correct keyword, type `#+' into the
2549 buffer and then use `M-<TAB>' completion.
2551 Remember that the keywords after the vertical bar (or the last
2552 keyword if no bar is there) must always mean that the item is DONE
2553 (although you may use a different word). After changing one of these
2554 lines, use `C-c C-c' with the cursor still in the line to make the
2555 changes known to Org-mode(1).
2557 ---------- Footnotes ----------
2559 (1) Org-mode parses these lines only when Org-mode is activated
2560 after visiting a file. `C-c C-c' with the cursor in a line starting
2561 with `#+' is simply restarting Org-mode for the current buffer.
2564 File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
2569 If you use Org-mode extensively to organize your work, you may end up
2570 with a number of TODO entries so large that you'd like to prioritize
2571 them. This can be done by placing a _priority cookie_ into the
2574 *** TODO [#A] Write letter to Sam Fortune
2576 With its standard setup, Org-mode supports priorities `A', `B', and
2577 `C'. `A' is the highest priority. An entry without a cookie is
2578 treated as priority `B'. Priorities make a difference only in the
2579 agenda (*note Weekly/Daily agenda::).
2582 Set the priority of the current headline. The command prompts for
2583 a priority character `A', `B' or `C'. When you press <SPC>
2584 instead, the priority cookie is removed from the headline. The
2585 priorities can also be changed "remotely" from the timeline and
2586 agenda buffer with the `,' command (*note Agenda commands::).
2590 Increase/decrease priority of current headline. Note that these
2591 keys are also used to modify time stamps (*note Creating
2592 timestamps::). Furthermore, these keys are also used by CUA-mode
2593 (*note Conflicts::).
2595 You can change the range of allowed priorities by setting the
2596 variables `org-highest-priority', `org-lowest-priority', and
2597 `org-default-priority'. For an individual buffer, you may set these
2598 values (highest, lowest, default) like this (please make sure that the
2599 highest priority is earlier in the alphabet than the lowest priority):
2604 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2606 5.4 Breaking tasks down into subtasks
2607 =====================================
2609 It is often advisable to break down large tasks into smaller, manageable
2610 subtasks. You can do this by creating an outline tree below a TODO
2611 item, with detailed subtasks on the tree(1). Another possibility is
2612 the use of checkboxes to identify (a hierarchy of) a large number of
2613 subtasks (*note Checkboxes::).
2615 ---------- Footnotes ----------
2617 (1) To keep subtasks out of the global TODO list, see the
2618 `org-agenda-todo-list-sublevels'.
2621 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2626 Every item in a plain list (*note Plain lists::) can be made a checkbox
2627 by starting it with the string `[ ]'. This feature is similar to TODO
2628 items (*note TODO items::), but more lightweight. Checkboxes are not
2629 included into the global TODO list, so they are often great to split a
2630 task into a number of simple steps. Or you can use them in a shopping
2631 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2632 `org-mouse.el'. Here is an example of a checkbox list.
2634 * TODO Organize party [3/6]
2640 - [ ] think about what music to play
2641 - [X] talk to the neighbors
2643 The `[3/6]' and `[1/3]' in the first and second line are cookies
2644 indicating how many checkboxes are present in this entry, and how many
2645 of them have been checked off. This can give you an idea on how many
2646 checkboxes remain, even without opening a folded entry. The cookies
2647 can be placed into a headline or into (the first line of) a plain list
2648 item. Each cookie covers all checkboxes structurally below that
2649 headline/item. You have to insert the cookie yourself by typing either
2650 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2651 the second case you get information about the percentage of checkboxes
2652 checked (in the above example, this would be `[50%]' and `[33%],
2655 The following commands work with checkboxes:
2658 Toggle checkbox at point.
2661 Toggle checkbox at point.
2662 - If there is an active region, toggle the first checkbox in
2663 the region and set all remaining boxes to the same status as
2664 the first. If you want to toggle all boxes in the region
2665 independently, use a prefix argument.
2667 - If the cursor is in a headline, toggle checkboxes in the
2668 region between this headline and the next (so _not_ the
2671 - If there is no active region, just toggle the checkbox at
2675 Insert a new item with a checkbox. This works only if the cursor
2676 is already in a plain list item (*note Plain lists::).
2679 Update the checkbox statistics in the current outline entry. When
2680 called with a `C-u' prefix, update the entire file. Checkbox
2681 statistic cookies are updated automatically if you toggle
2682 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2683 you delete boxes or add/change them by hand, use this command to
2684 get things back into synch. Or simply toggle any checkbox twice
2688 File: org, Node: Tags, Next: Timestamps, Prev: TODO items, Up: Top
2693 If you wish to implement a system of labels and contexts for
2694 cross-correlating information, an excellent way is to assign tags to
2695 headlines. Org-mode has extensive support for using tags.
2697 Every headline can contain a list of tags, at the end of the
2698 headline. Tags are normal words containing letters, numbers, `_', and
2699 `@'. Tags must be preceded and followed by a single colon; like
2700 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2704 * Tag inheritance:: Tags use the tree structure of the outline
2705 * Setting tags:: How to assign tags to a headline
2706 * Tag searches:: Searching for combinations of tags
2709 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2714 Tags make use of the hierarchical structure of outline trees. If a
2715 heading has a certain tag, all subheadings will inherit the tag as
2716 well. For example, in the list
2718 * Meeting with the French group :WORK:
2719 ** Summary by Frank :BOSS:NOTES:
2720 *** TODO Prepare slides for him :ACTION:
2722 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2723 `:ACTION:'. When executing tag searches and Org-mode finds that a
2724 certain headline matches the search criterion, it will not check any
2725 sublevel headline, assuming that these likely also match, and that the
2726 list of matches can become very long. This may not be what you want,
2727 however, and you can influence inheritance and searching using the
2728 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2731 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2736 Tags can simply be typed into the buffer at the end of a headline.
2737 After a colon, `M-<TAB>' offers completion on tags. There is also a
2738 special command for inserting tags:
2741 Enter new tags for the current headline. Org-mode will either
2742 offer completion or a special single-key interface for setting
2743 tags, see below. After pressing <RET>, the tags will be inserted
2744 and aligned to `org-tags-column'. When called with a `C-u'
2745 prefix, all tags in the current buffer will be aligned to that
2746 column, just to make things look nice. TAGS are automatically
2747 realigned after promotion, demotion, and TODO state changes (*note
2750 Org will support tag insertion based on a _list of tags_. By
2751 default this list is constructed dynamically, containing all tags
2752 currently used in the buffer. You may also globally specify a hard list
2753 of tags with the variable `org-tag-alist'. Finally you can set the
2754 default tags for a given file with lines like
2756 #+TAGS: @WORK @HOME @TENNISCLUB
2757 #+TAGS: Laptop Car PC Sailboat
2759 If you have globally defined your preferred set of tags using the
2760 variable `org-tag-alist', but would like to use a dynamic tag list in a
2761 specific file: Just add an empty TAGS option line to that file:
2765 The default support method for entering tags is minibuffer
2766 completion. However, Org-mode also implements a much better method:
2767 _fast tag selection_. This method allows to select and deselect tags
2768 with a single key per tag. To function efficiently, you should assign
2769 unique keys to most tags. This can be done globally with
2771 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2773 or on a per-file basis with
2775 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2777 You can also group together tags that are mutually exclusive. With
2780 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2782 you indicate that at most one of `@WORK', `@HOME', and `@TENNISCLUB'
2785 Don't forget to press `C-c C-c' with the cursor in one of these lines
2786 to activate any changes.
2788 If at least one tag has a selection key, pressing `C-c C-c' will
2789 automatically present you with a special interface, listing inherited
2790 tags, the tags of the current headline, and a list of all legal tags
2791 with corresponding keys(2). In this interface, you can use the
2795 Pressing keys assigned to tags will add or remove them from the
2796 list of tags in the current line. Selecting a tag in a group of
2797 mutually exclusive tags will turn off any other tags from that
2801 Enter a tag in the minibuffer, even if the tag is not in the
2802 predefined list. You will be able to complete on all tags present
2806 Clear all tags for this line.
2809 Accept the modified set.
2812 Abort without installing changes.
2815 If `q' is not assigned to a tag, it aborts like `C-g'.
2818 Turn off groups of mutually exclusive tags. Use this to (as an
2819 exception) assign several tags from such a group.
2822 Toggle auto-exit after the next change (see below). If you are
2823 using expert mode, the first `C-c' will display the selection
2826 This method lets you assign tags to a headline with very few keys. With
2827 the above setup, you could clear the current tags and set `@HOME',
2828 `Laptop' and `PC' tags with just the following keys: `C-c C-c <SPC> h l
2829 p <RET>'. Switching from `@HOME' to `@WORK' would be done with `C-c
2830 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
2831 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
2834 If you find that most of the time, you need only a single keypress to
2835 modify your list of tags, set the variable
2836 `org-fast-tag-selection-single-key'. Then you no longer have to press
2837 <RET> to exit fast tag selection - it will immediately exit after the
2838 first change. If you then occasionally need more keys, press `C-c' to
2839 turn off auto-exit for the current tag selection process (in effect:
2840 start selection with `C-c C-c C-c' instead of `C-c C-c'). If you set
2841 the variable to the value `expert', the special window is not even
2842 shown for single-key tag selection, it comes up only when you press an
2845 ---------- Footnotes ----------
2847 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2848 respectively. Several groups are allowed.
2850 (2) Keys will automatically be assigned to tags which have no
2854 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2859 Once a tags system has been set up, it can be used to collect related
2860 information into special lists.
2863 Create a sparse tree with all headlines matching a tags search.
2864 With a `C-u' prefix argument, ignore headlines that are not a TODO
2868 Create a global list of tag matches from all agenda files. *Note
2869 Matching headline tags::.
2872 Create a global list of tag matches from all agenda files, but
2873 check only TODO items and force checking subitems (see variable
2874 `org-tags-match-list-sublevels').
2876 A tags search string can use Boolean operators `&' for AND and `|'
2877 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2878 not implemented. A tag may also be preceded by `-', to select against
2879 it, and `+' is syntactic sugar for positive selection. The AND
2880 operator `&' is optional when `+' or `-' is present. Examples:
2883 Select headlines tagged `:WORK:', but discard those also tagged
2887 Selects lines tagged `:WORK:' or `:LAPTOP:'.
2890 Like before, but require the `:LAPTOP:' lines to be tagged also
2893 If you are using multi-state TODO keywords (*note TODO
2894 extensions::), it can be useful to also match on the TODO keyword.
2895 This can be done by adding a condition after a slash to a tags match.
2896 The syntax is similar to the tag matches, but should be applied with
2897 consideration: For example, a positive selection on several TODO
2898 keywords can not meaningfully be combined with boolean AND. However,
2899 _negative selection_ combined with AND can be meaningful. To make sure
2900 that only lines are checked that actually have any TODO keyword, use
2901 `C-c a M', or equivalently start the todo part after the slash with `!'.
2905 Select `:WORK:'-tagged TODO lines with the specific TODO keyword
2908 `WORK/!-WAITING-NEXT'
2909 Select `:WORK:'-tagged TODO lines that are neither `WAITING' nor
2912 `WORK/+WAITING|+NEXT'
2913 Select `:WORK:'-tagged TODO lines that are either `WAITING' or
2916 Any element of the tag/todo match can be a regular expression - in
2917 this case it must be enclosed in curly braces. For example,
2918 `WORK+{^BOSS.*}' matches headlines that contain the tag `WORK' and any
2919 tag starting with `BOSS'.
2921 You can also require a headline to be of a certain level, by writing
2922 instead of any TAG an expression like `LEVEL=3'. For example, a search
2923 `+LEVEL=3+BOSS/-DONE' lists all level three headlines that have the tag
2924 BOSS and are _not_ marked with the todo keyword DONE.
2927 File: org, Node: Timestamps, Next: Agenda views, Prev: Tags, Up: Top
2932 Items can be labeled with timestamps to make them useful for project
2937 * Time stamps:: Assigning a time to a tree entry
2938 * Creating timestamps:: Commands which insert timestamps
2939 * Deadlines and scheduling:: Planning your work
2940 * Progress logging:: Documenting when what work was done.
2943 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2945 7.1 Time stamps, deadlines and scheduling
2946 =========================================
2948 A time stamp is a specification of a date (possibly with time or a range
2949 of times) in a special format, either `<2003-09-16 Tue>' or
2950 `<2003-09-16 Tue 09:39>' or `<2003-09-16 Tue 12:00-12:30>'(1). A time
2951 stamp can appear anywhere in the headline or body of an org-tree entry.
2952 Its presence causes entries to be shown on specific dates in the agenda
2953 (*note Weekly/Daily agenda::). We distinguish:
2956 A simple time stamp just assigns a date/time to an item. This is
2957 just like writing down an appointment in a paper agenda, or like
2958 writing down an event in a diary, when you want to take note of
2959 when something happened. In the timeline and agenda displays, the
2960 headline of an entry associated with a plain time stamp will be
2961 shown exactly on that date.
2963 * Meet Peter at the movies <2006-11-01 Wed 19:15>
2964 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
2966 TIME STAMP WITH REPEATER INTERVAL
2967 A time stamp may contain a _repeater interval_, indicating that it
2968 applies not only on the given date, but again and again after a
2969 certain interval of N days (d), weeks (w), months(m), or years(y).
2970 The following will show up in the agenda every Wednesday:
2972 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
2974 DIARY-STYLE SEXP ENTRIES
2975 For more complex date specifications, Org-mode supports using the
2976 special sexp diary entries implemented in the Emacs calendar/diary
2977 package. For example
2979 * The nerd meeting on every 2nd Thursday of the month
2980 <%%(diary-float t 4 2)>
2983 Two time stamps connected by `--' denote a range. The headline
2984 will be shown on the first and last day of the range, and on any
2985 dates that are displayed and fall in the range. Here is an
2988 ** Meeting in Amsterdam
2989 <2004-08-23 Mon>--<2004-08-26 Thu>
2992 Just like a plain time stamp, but with square brackets instead of
2993 angular ones. These time stamps are inactive in the sense that
2994 they do _not_ trigger an entry to show up in the agenda.
2996 * Gillian comes late for the fifth time [2006-11-01 Wed]
2999 ---------- Footnotes ----------
3001 (1) This is the standard ISO date/time format. If you cannot get
3002 used to these, see *Note Custom time format::
3005 File: org, Node: Creating timestamps, Next: Deadlines and scheduling, Prev: Time stamps, Up: Timestamps
3007 7.2 Creating timestamps
3008 =======================
3010 For Org-mode to recognize time stamps, they need to be in the specific
3011 format. All commands listed below produce time stamps in the correct
3015 Prompt for a date and insert a corresponding time stamp. When the
3016 cursor is at a previously used time stamp, it is updated to NOW.
3017 When this command is used twice in succession, a time range is
3021 Like `C-c .', but use the alternative format which contains date
3022 and time. The default time can be rounded to multiples of 5
3023 minutes, see the option `org-time-stamp-rounding-minutes'.
3026 Like `C-c .', but insert an inactive time stamp that will not cause
3030 Insert a time stamp corresponding to the cursor date in the
3034 Access the Emacs calendar for the current date. If there is a
3035 timestamp in the current line, goto the corresponding date instead.
3038 Access the agenda for the date given by the time stamp or -range at
3039 point (*note Weekly/Daily agenda::).
3043 Change date at cursor by one day. These key bindings conflict with
3044 CUA-mode (*note Conflicts::).
3048 Change the item under the cursor in a timestamp. The cursor can
3049 be on a year, month, day, hour or minute. Note that if the cursor
3050 is in a headline and not at a time stamp, these same keys modify
3051 the priority of an item. (*note Priorities::). The key bindings
3052 also conflict with CUA-mode (*note Conflicts::).
3055 Evaluate a time range by computing the difference between start and
3056 end. With prefix arg, insert result after the time range (in a
3057 table: into the following column).
3061 * The date/time prompt:: How org-mode helps you entering date and time
3062 * Custom time format:: Making dates look differently
3065 File: org, Node: The date/time prompt, Next: Custom time format, Prev: Creating timestamps, Up: Creating timestamps
3067 7.2.1 The date/time prompt
3068 --------------------------
3070 When Org-mode prompts for a date/time, the prompt suggests to enter an
3071 ISO date. But it will in fact accept any string containing some date
3072 and/or time information. You can, for example, use `C-y' to paste a
3073 (possibly multi-line) string copied from an email message. Org-mode
3074 will find whatever information is in there and will replace anything not
3075 specified with the current date and time. For example:
3077 3-2-5 --> 2003-02-05
3078 feb 15 --> currentyear-02-15
3079 sep 12 9 --> 2009-09-12
3080 12:45 --> today 12:45
3081 22 sept 0:34 --> currentyear-09-22 0:34
3082 12 --> currentyear-currentmonth-12
3083 Fri --> nearest Friday (today or later)
3084 +4 --> 4 days from now (if +N is the only thing given)
3086 The function understands English month and weekday abbreviations. If
3087 you want to use unabbreviated names and/or other languages, configure
3088 the variables `parse-time-months' and `parse-time-weekdays'.
3090 Parallel to the minibuffer prompt, a calendar is popped up(1). When
3091 you exit the date prompt, either by clicking on a date in the calendar,
3092 or by pressing <RET>, the date selected in the calendar will be
3093 combined with the information entered at the prompt. You can control
3094 the calendar fully from the minibuffer:
3097 Scroll calendar backwards by one month.
3100 Scroll calendar forwards by one month.
3103 Select date by clicking on it.
3124 Choose date in calendar (only if nothing was typed into
3127 ---------- Footnotes ----------
3129 (1) If you don't need/want the calendar, configure the variable
3130 `org-popup-calendar-for-date-prompt'.
3133 File: org, Node: Custom time format, Prev: The date/time prompt, Up: Creating timestamps
3135 7.2.2 Custom time format
3136 ------------------------
3138 Org-mode uses the standard ISO notation for dates and times as it is
3139 defined in ISO 8601. If you cannot get used to this and require another
3140 representation of date and time to keep you happy, you can get it by
3141 customizing the variables `org-display-custom-times' and
3142 `org-time-stamp-custom-formats'.
3145 Toggle the display of custom formats for dates and times.
3147 Org-mode needs the default format for scanning, so the custom date/time
3148 format does not _replace_ the default format - instead it is put _over_
3149 the default format using text properties. This has the following
3151 * You cannot place the cursor onto a time stamp anymore, only before
3154 * The `S-<up>/<down>' keys can no longer be used to adjust each
3155 component of a time stamp. If the cursor is at the beginning of
3156 the stamp, `S-<up>/<down>' will change the stamp by one day, just
3157 like `S-<left>/<right>'. At the end of the stamp, the time will
3158 be changed by one minute.
3160 * If the time stamp contains a range of clock times or a repeater,
3161 these will not be overlayed, but remain in the buffer as they were.
3163 * When you delete a time stamp character-by-character, it will only
3164 disappear from the buffer after _all_ (invisible) characters
3165 belonging to the ISO timestamp have been removed.
3167 * If the custom time stamp format is longer than the default and you
3168 are using dates in tables, table alignment will be messed up. If
3169 the custom format is shorter, things do work as expected.
3172 File: org, Node: Deadlines and scheduling, Next: Progress logging, Prev: Creating timestamps, Up: Timestamps
3174 7.3 Deadlines and Scheduling
3175 ============================
3177 A time stamp may be preceded by special keywords to facilitate planning
3181 The task (most likely a TODO item) is supposed to be finished on
3182 that date, and it will be listed then. In addition, the
3183 compilation for _today_ will carry a warning about the approaching
3184 or missed deadline, starting `org-deadline-warning-days' before
3185 the due date, and continuing until the entry is marked DONE. An
3188 *** TODO write article about the Earth for the Guide
3189 The editor in charge is [[bbdb:Ford Prefect]]
3190 DEADLINE: <2004-02-29 Sun>
3193 You are planning to start working on that task on the given date.
3194 The headline will be listed under the given date(1). In addition,
3195 a reminder that the scheduled date has passed will be present in
3196 the compilation for _today_, until the entry is marked DONE.
3197 I.e., the task will automatically be forwarded until completed.
3199 *** TODO Call Trillian for a date on New Years Eve.
3200 SCHEDULED: <2004-12-25 Sat>
3204 * Inserting deadline/schedule::
3207 ---------- Footnotes ----------
3209 (1) It will still be listed on that date after it has been marked
3210 DONE. If you don't like this, set the variable
3211 `org-agenda-skip-scheduled-if-done'.
3214 File: org, Node: Inserting deadline/schedule, Next: Repeated tasks, Prev: Deadlines and scheduling, Up: Deadlines and scheduling
3216 7.3.1 Inserting deadline/schedule
3217 ---------------------------------
3219 The following commands allow to quickly insert a deadline or to schedule
3223 Insert `DEADLINE' keyword along with a stamp. The insertion will
3224 happen in the line directly following the headline.
3227 Create a sparse tree with all deadlines that are either past-due,
3228 or which will become due within `org-deadline-warning-days'. With
3229 `C-u' prefix, show all deadlines in the file. With a numeric
3230 prefix, check that many days. For example, `C-1 C-c C-w' shows
3231 all deadlines due tomorrow.
3234 Insert `SCHEDULED' keyword along with a stamp. The insertion will
3235 happen in the line directly following the headline. Any CLOSED
3236 timestamp will be removed.
3239 File: org, Node: Repeated tasks, Prev: Inserting deadline/schedule, Up: Deadlines and scheduling
3241 7.3.2 Repeated Tasks
3242 --------------------
3244 Some tasks need to be repeated again and again, and Org-mode therefore
3245 allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for
3247 ** TODO Pay the rent
3248 DEADLINE: <2005-10-01 Sat +1m>
3250 Deadlines and scheduled items produce entries in the agenda when they
3251 are over-due, so it is important to be able to mark such an entry as
3252 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
3253 with the todo keyword DONE, it will no longer produce entries in the
3254 agenda. The problem with this is, however, that then also the _next_
3255 instance of the repeated entry will not be active. Org-mode deals with
3256 this in the following way: When you try to mark such an entry DONE
3257 (using `C-c C-t'), it will shift the base date of the repeating time
3258 stamp by the repeater interval, and immediately set the entry state
3259 back to TODO. In the example above, setting the state to DONE would
3260 actually switch the date like this:
3262 ** TODO Pay the rent
3263 DEADLINE: <2005-11-01 Tue +1m>
3265 You will also be prompted for a note that will be put under the
3266 DEADLINE line to keep a record that you actually acted on the previous
3267 instance of this deadline.
3269 As a consequence of shifting the base date, this entry will no
3270 longer be visible in the agenda when checking past dates, but all
3271 future instances will be visible.
3273 You may have both scheduling and deadline information for a specific
3274 task - just make sure that the repeater intervals on both are the same.
3277 File: org, Node: Progress logging, Prev: Deadlines and scheduling, Up: Timestamps
3279 7.4 Progress Logging
3280 ====================
3282 Org-mode can automatically record a time stamp when you mark a TODO item
3283 as DONE, or even each time when you change the state of a TODO item.
3284 You can also measure precisely the time you spent on specific items in a
3285 project by starting and stopping a clock when you start and stop working
3286 on an aspect of a project.
3290 * Closing items:: When was this entry marked DONE?
3291 * Tracking TODO state changes:: When did the status change?
3292 * Clocking work time:: When exactly did you work on this item?
3295 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
3300 If you want to keep track of _when_ a certain TODO item was finished,
3301 turn on logging with(1)
3303 (setq org-log-done t)
3305 Then each time you turn a TODO entry into DONE using either `C-c C-t'
3306 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
3307 [timestamp]' will be inserted just after the headline. If you turn the
3308 entry back into a TODO item through further state cycling, that line
3309 will be removed again. In the timeline (*note Timeline::) and in the
3310 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
3311 display the TODO items closed on each day, giving you an overview of
3312 what has been done on a day. If you want to record a note along with
3313 the timestamp, use(2)
3315 (setq org-log-done '(done))
3317 ---------- Footnotes ----------
3319 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
3321 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
3324 File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
3326 7.4.2 Tracking TODO state changes
3327 ---------------------------------
3329 When TODO keywords are used as workflow states (*note Workflow
3330 states::), you might want to keep track of when a state change occurred,
3331 and you may even want to attach notes to that state change. With the
3334 (setq org-log-done '(state))
3336 each state change will prompt you for a note that will be attached to
3337 the current headline. Very likely you do not want this verbose tracking
3338 all the time, so it is probably better to configure this behavior with
3339 in-buffer options. For example, if you are tracking purchases, put
3340 these into a separate file that starts with:
3342 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
3343 #+STARTUP: lognotestate
3346 File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
3348 7.4.3 Clocking work time
3349 ------------------------
3351 Org-mode allows you to clock the time you spent on specific tasks in a
3352 project. When you start working on an item, you can start the clock.
3353 When you stop working on that task, or when you mark the task done, the
3354 clock is stopped and the corresponding time interval is recorded. It
3355 also computes the total time spent on each subtree of a project.
3358 Start the clock on the current item (clock-in). This inserts the
3359 CLOCK keyword together with a timestamp.
3362 Stop the clock (clock-out). The inserts another timestamp at the
3363 same location where the clock was last started. It also directly
3364 computes the resulting time in inserts it after the time range as
3365 `=> HH:MM'. See the variable `org-log-done' for the possibility to
3366 record an additional note together with the clock-out time
3370 Recompute the time interval after changing one of the time stamps.
3371 This is only necessary if you edit the time stamps directly. If
3372 you change them with `S-<cursor>' keys, the update is automatic.
3375 Changing the TODO state of an item to DONE automatically stops the
3376 clock if it is running in this same item.
3379 Cancel the current clock. This is useful if a clock was started by
3380 mistake, or if you ended up working on something else.
3383 Display time summaries for each subtree in the current buffer.
3384 This puts overlays at the end of each headline, showing the total
3385 time recorded under that heading, including the time of any
3386 subheadings. You can use visibility cycling to study the tree, but
3387 the overlays disappear when you change the buffer (see variable
3388 `org-remove-highlights-with-change') or press `C-c C-c'.
3391 Insert a dynamic block (*note Dynamic blocks::) containing a clock
3392 report as an org-mode table into the current file.
3393 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
3396 If such a block already exists, its content is replaced by the new
3397 table. The `BEGIN' line can specify options:
3398 :maxlevels Maximum level depth to which times are listed in the table.
3399 :emphasize When `t', emphasize level one and level two items
3400 :block The time block to consider. This block is specified relative
3401 to the current time and may be any of these keywords:
3402 `today', `yesterday', `thisweek', `lastweek',
3403 `thismonth', `lastmonth', `thisyear', or `lastyear'.
3404 :tstart A time string specifying when to start considering times
3405 :tend A time string specifying when to stop considering times
3406 So to get a clock summary for the current day, you could write
3407 #+BEGIN: clocktable :maxlevel 2 :block today
3410 and to use a specific time range you could write(2)
3411 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
3412 :tend "<2006-08-10 Thu 12:00>"
3417 Update all dynamic blocks (*note Dynamic blocks::). This is
3418 useful if you have several clocktable blocks in a buffer.
3420 The `l' key may be used in the timeline (*note Timeline::) and in
3421 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
3422 worked on or closed during a day.
3424 ---------- Footnotes ----------
3426 (1) The corresponding in-buffer setting is: `#+STARTUP:
3429 (2) Note that all parameters must be specified in a single line -
3430 the line is broken here only to fit it onto the manual.
3433 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Timestamps, Up: Top
3438 Due to the way Org-mode works, TODO items, time-stamped items, and
3439 tagged headlines can be scattered throughout a file or even a number of
3440 files. To get an overview over open action items, or over events that
3441 are important for a particular date, this information must be collected,
3442 sorted and displayed in an organized way.
3444 Org-mode can select items based on various criteria, and display them
3445 in a separate buffer. Six different view types are provided:
3447 * an _agenda_ that is like a calendar and shows information for
3450 * a _TODO list_ that covers all unfinished action items,
3452 * a _tags view_, showings headlines based on the tags associated
3455 * a _timeline view_ that shows all events in a single Org-mode file,
3456 in time-sorted view,
3458 * a _stuck projects view_ showing projects that currently don't move
3461 * _custom views_ that are special tag/keyword searches and
3462 combinations of different views.
3464 The extracted information is displayed in a special _agenda buffer_.
3465 This buffer is read-only, but provides commands to visit the
3466 corresponding locations in the original Org-mode files, and even to
3467 edit these files remotely.
3469 Two variables control how the agenda buffer is displayed and whether
3470 the window configuration is restored when the agenda exits:
3471 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
3475 * Agenda files:: Files being searched for agenda information
3476 * Agenda dispatcher:: Keyboard access to agenda views
3477 * Built-in agenda views:: What is available out of the box?
3478 * Presentation and sorting:: How agenda items are prepared for display
3479 * Agenda commands:: Remote editing of org trees
3480 * Custom agenda views:: Defining special searches and views
3483 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
3488 The information to be shown is collected from all _agenda files_, the
3489 files listed in the variable `org-agenda-files'(1). Thus even if you
3490 only work with a single Org-mode file, this file should be put into
3491 that list(2). You can customize `org-agenda-files', but the easiest
3492 way to maintain it is through the following commands
3495 Add current file to the list of agenda files. The file is added to
3496 the front of the list. If it was already in the list, it is moved
3497 to the front. With prefix arg, file is added/moved to the end.
3500 Remove current file from the list of agenda files.
3504 Cycle through agenda file list, visiting one file after the other.
3506 The Org menu contains the current list of files and can be used to
3509 ---------- Footnotes ----------
3511 (1) If the value of that variable is not a list, but a single file
3512 name, then the list of agenda files will be maintained in that external
3515 (2) When using the dispatcher, pressing `1' before selecting a
3516 command will actually limit the command to the current file, and ignore
3517 `org-agenda-files' until the next dispatcher command.
3520 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
3522 8.2 The agenda dispatcher
3523 =========================
3525 The views are created through a dispatcher that should be bound to a
3526 global key, for example `C-c a' (*note Installation::). In the
3527 following we will assume that `C-c a' is indeed how the dispatcher is
3528 accessed and list keyboard access to commands accordingly. After
3529 pressing `C-c a', an additional letter is required to execute a
3530 command. The dispatcher offers the following default commands:
3532 Create the calendar-like agenda (*note Weekly/Daily agenda::).
3535 Create a list of all TODO items (*note Global TODO list::).
3538 Create a list of headlines matching a TAGS expression (*note
3539 Matching headline tags::).
3542 Create the timeline view for the current buffer (*note Timeline::).
3545 Create a list of stuck projects (*note Stuck projects::).
3548 Restrict an agenda command to the current buffer. After pressing
3549 `1', you still need to press the character selecting the command.
3552 If there is an active region, restrict the following agenda
3553 command to the region. Otherwise, restrict it to the current
3554 subtree. After pressing `0', you still need to press the
3555 character selecting the command.
3557 You can also define custom commands that will be accessible through
3558 the dispatcher, just like the default commands. This includes the
3559 possibility to create extended agenda buffers that contain several
3560 blocks together, for example the weekly agenda, the global TODO list and
3561 a number of special tags matches. *Note Custom agenda views::.
3564 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
3566 8.3 The built-in agenda views
3567 =============================
3569 In this section we describe the built-in views.
3573 * Weekly/Daily agenda:: The calendar page with current tasks
3574 * Global TODO list:: All unfinished action items
3575 * Matching headline tags:: Structured information with fine-tuned search
3576 * Timeline:: Time-sorted view for single file
3577 * Stuck projects:: Find projects you need to review
3580 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
3582 8.3.1 The weekly/daily agenda
3583 -----------------------------
3585 The purpose of the weekly/daily _agenda_ is to act like a page of a
3586 paper agenda, showing all the tasks for the current week or day.
3589 Compile an agenda for the current week from a list of org files.
3590 The agenda shows the entries for each day. With a `C-u' prefix (or
3591 when the variable `org-agenda-include-all-todo' is `t'), all
3592 unfinished TODO items (including those without a date) are also
3593 listed at the beginning of the buffer, before the first date.
3595 Remote editing from the agenda buffer means, for example, that you
3596 can change the dates of deadlines and appointments from the agenda
3597 buffer. The commands available in the Agenda buffer are listed in
3598 *Note Agenda commands::.
3600 Calendar/Diary integration
3601 ..........................
3603 Emacs contains the calendar and diary by Edward M. Reingold. The
3604 calendar displays a three-month calendar with holidays from different
3605 countries and cultures. The diary allows you to keep track of
3606 anniversaries, lunar phases, sunrise/set, recurrent appointments
3607 (weekly, monthly) and more. In this way, it is quite complementary to
3608 Org-mode. It can be very useful to combine output from Org-mode with
3611 In order to include entries from the Emacs diary into Org-mode's
3612 agenda, you only need to customize the variable
3614 (setq org-agenda-include-diary t)
3616 After that, everything will happen automatically. All diary entries
3617 including holidays, anniversaries etc will be included in the agenda
3618 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
3619 the agenda buffer to jump to the diary file in order to edit existing
3620 diary entries. The `i' command to insert new entries for the current
3621 date works in the agenda buffer, as well as the commands `S', `M', and
3622 `C' to display Sunrise/Sunset times, show lunar phases and to convert
3623 to other calendars, respectively. `c' can be used to switch back and
3624 forth between calendar and agenda.
3626 If you are using the diary only for sexp entries and holidays, it is
3627 faster to not use the above setting, but instead to copy or even move
3628 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
3629 entries, and does it faster because there is no overhead for first
3630 creating the diary display. Note that the sexp entries must start at
3631 the left margin, no white space is allowed before them. For example,
3632 the following segment of an Org-mode file will be processed and entries
3633 will be made in the agenda:
3635 * Birthdays and similar stuff
3637 %%(org-calendar-holiday) ; special function for holiday names
3639 %%(diary-anniversary 14 5 1956) Artur Dent %d is years old
3640 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
3643 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Built-in agenda views
3645 8.3.2 The global TODO list
3646 --------------------------
3648 The global TODO list contains all unfinished TODO items, formatted and
3649 collected into a single place.
3652 Show the global TODO list. This collects the TODO items from all
3653 agenda files (*note Agenda views::) into a single buffer. The
3654 buffer is in `agenda-mode', so there are commands to examine and
3655 manipulate the TODO entries directly from that buffer (*note
3659 Like the above, but allows selection of a specific TODO keyword.
3660 You can also do this by specifying a prefix argument to `C-c a t'.
3661 With a `C-u' prefix you are prompted for a keyword, and you may
3662 also specify several keywords by separating them with `|' as
3663 boolean OR operator. With a numeric prefix, the Nth keyword in
3664 `org-todo-keywords' is selected. The `r' key in the agenda buffer
3665 regenerates it, and you can give a prefix argument to this command
3666 to change the selected TODO keyword, for example `3 r'. If you
3667 often need a search for a specific keyword, define a custom
3668 command for it (*note Agenda dispatcher::).
3669 Matching specific TODO keywords can also be done as part of a tags
3670 search (*note Tag searches::).
3672 Remote editing of TODO items means that you can change the state of a
3673 TODO entry with a single key press. The commands available in the TODO
3674 list are described in *Note Agenda commands::.
3676 Normally the global todo list simply shows all headlines with TODO
3677 keywords. This list can become very long. There are two ways to keep
3679 - Some people view a TODO item that has been _scheduled_ for
3680 execution (*note Time stamps::) as no longer _open_. Configure the
3681 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
3682 items from the global TODO list.
3684 - TODO items may have sublevels to break up the task into subtasks.
3685 In such cases it may be enough to list only the highest level TODO
3686 headline and omit the sublevels from the global list. Configure
3687 the variable `org-agenda-todo-list-sublevels' to get this behavior.
3690 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
3692 8.3.3 Matching headline tags
3693 ----------------------------
3695 If headlines in the agenda files are marked with _tags_ (*note Tags::),
3696 you can select headlines based on the tags that apply to them and
3697 collect them into an agenda buffer.
3700 Produce a list of all headlines that match a given set of tags.
3701 The command prompts for a selection criterion, which is a boolean
3702 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
3703 `WORK|HOME' (*note Tags::). If you often need a specific search,
3704 define a custom command for it (*note Agenda dispatcher::).
3707 Like `C-c a m', but only select headlines that are also TODO items
3708 and force checking subitems (see variable
3709 `org-tags-match-list-sublevels'). Matching specific todo keywords
3710 together with a tags match is also possible, see *Note Tag
3713 The commands available in the tags list are described in *Note
3717 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching headline tags, Up: Built-in agenda views
3719 8.3.4 Timeline for a single file
3720 --------------------------------
3722 The timeline summarizes all time-stamped items from a single Org-mode
3723 file in a _time-sorted view_. The main purpose of this command is to
3724 give an overview over events in a project.
3727 Show a time-sorted view of the org file, with all time-stamped
3728 items. When called with a `C-u' prefix, all unfinished TODO
3729 entries (scheduled or not) are also listed under the current date.
3731 The commands available in the timeline buffer are listed in *Note
3735 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
3737 8.3.5 Stuck projects
3738 --------------------
3740 If you are following a system like David Allen's GTD to organize your
3741 work, one of the "duties" you have is a regular review to make sure
3742 that all projects move along. A _stuck_ project is a project that has
3743 no defined next actions, so it will never show up in the TODO lists
3744 Org-mode produces. During the review, you need to identify such
3745 projects and define next actions for them.
3748 List projects that are stuck.
3751 Customize the variable `org-stuck-projects' to define what a stuck
3752 project is and how to find it.
3754 You almost certainly will have to configure this view before it will
3755 work for you. The built-in default assumes that all your projects are
3756 level-2 headlines, and that a project is not stuck if it has at least
3757 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
3759 Lets assume that you, in your own way of using Org-mode, identify
3760 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
3761 indicate a project that should not be considered yet. Lets further
3762 assume that the todo keyword DONE marks finished projects, and that NEXT
3763 and TODO indicate next actions. The tag @SHOP indicates shopping and
3764 is a next action even without the NEXT tag. Finally, if the project
3765 contains the special word IGNORE anywhere, it should not be listed
3766 either. In this case you would start by identifying eligible projects
3767 with a tags/todo match `+PROJECT/-MAYBE-DONE', and then check for TODO,
3768 NEXT, @SHOP, and IGNORE in the subtree to identify projects that are
3769 not stuck. The correct customization for this is
3771 (setq org-stuck-projects
3772 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")
3776 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
3778 8.4 Presentation and sorting
3779 ============================
3781 Before displaying items in an agenda view, Org-mode visually prepares
3782 the items and sorts them. Each item occupies a single line. The line
3783 starts with a _prefix_ that contains the _category_ (*note
3784 Categories::) of the item and other important information. You can
3785 customize the prefix using the option `org-agenda-prefix-format'. The
3786 prefix is followed by a cleaned-up version of the outline headline
3787 associated with the item.
3791 * Categories:: Not all tasks are equal
3792 * Time-of-day specifications:: How the agenda knows the time
3793 * Sorting of agenda items:: The order of things
3796 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
3801 The category is a broad label assigned to each agenda item. By default,
3802 the category is simply derived from the file name, but you can also
3803 specify it with a special line in the buffer, like this:
3807 If there are several such lines in a file, each specifies the
3808 category for the text below it (but the first category also applies to
3809 any text before the first CATEGORY line). The display in the agenda
3810 buffer looks best if the category is not longer than 10 characters.
3813 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
3815 8.4.2 Time-of-Day Specifications
3816 --------------------------------
3818 Org-mode checks each agenda item for a time-of-day specification. The
3819 time can be part of the time stamp that triggered inclusion into the
3820 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
3821 specified with two time stamps, like
3822 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
3824 In the headline of the entry itself, a time(range) may also appear as
3825 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
3826 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
3827 entries are recognized as well.
3829 For agenda display, Org-mode extracts the time and displays it in a
3830 standard 24 hour format as part of the prefix. The example times in
3831 the previous paragraphs would end up in the agenda like this:
3833 8:30-13:00 Arthur Dent lies in front of the bulldozer
3834 12:45...... Ford Prefect arrives and takes Arthur to the pub
3835 19:00...... The Vogon reads his poem
3836 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3838 If the agenda is in single-day mode, or for the display of today, the
3839 timed entries are embedded in a time grid, like
3841 8:00...... ------------------
3842 8:30-13:00 Arthur Dent lies in front of the bulldozer
3843 10:00...... ------------------
3844 12:00...... ------------------
3845 12:45...... Ford Prefect arrives and takes Arthur to the pub
3846 14:00...... ------------------
3847 16:00...... ------------------
3848 18:00...... ------------------
3849 19:00...... The Vogon reads his poem
3850 20:00...... ------------------
3851 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
3853 The time grid can be turned on and off with the variable
3854 `org-agenda-use-time-grid', and can be configured with
3855 `org-agenda-time-grid'.
3858 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
3860 8.4.3 Sorting of agenda items
3861 -----------------------------
3863 Before being inserted into a view, the items are sorted. How this is
3864 done depends on the type of view.
3865 * For the daily/weekly agenda, the items for each day are sorted.
3866 The default order is to first collect all items containing an
3867 explicit time-of-day specification. These entries will be shown
3868 at the beginning of the list, as a _schedule_ for the day. After
3869 that, items remain grouped in categories, in the sequence given by
3870 `org-agenda-files'. Within each category, items are sorted by
3871 priority (*note Priorities::), which is composed of the base
3872 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
3873 plus additional increments for overdue scheduled or deadline items.
3875 * For the TODO list, items remain in the order of categories, but
3876 within each category, sorting takes place according to priority
3877 (*note Priorities::).
3879 * For tags matches, items are not sorted at all, but just appear in
3880 the sequence in which they are found in the agenda files.
3882 Sorting can be customized using the variable
3883 `org-agenda-sorting-strategy'.
3886 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
3888 8.5 Commands in the agenda buffer
3889 =================================
3891 Entries in the agenda buffer are linked back to the org file or diary
3892 file where they originate. You are not allowed to edit the agenda
3893 buffer itself, but commands are provided to show and jump to the
3894 original entry location, and to edit the org-files "remotely" from the
3895 agenda buffer. In this way, all information is stored only once,
3896 removing the risk that your agenda and note files may diverge.
3898 Some commands can be executed with mouse clicks on agenda lines. For
3899 the other commands, the cursor needs to be in the desired line.
3905 Next line (same as <up>).
3908 Previous line (same as <down>).
3915 Display the original location of the item in another window.
3918 Display original location and recenter that window.
3923 Go to the original location of the item in another window. Under
3924 Emacs 22, `mouse-1' will also works for this.
3927 Go to the original location of the item and delete other windows.
3930 Toggle Follow mode. In Follow mode, as you move the cursor through
3931 the agenda buffer, the other window always shows the corresponding
3932 location in the org file. The initial setting for this mode in new
3933 agenda buffers can be set with the variable
3934 `org-agenda-start-with-follow-mode'.
3937 Display the entire subtree of the current item in an indirect
3938 buffer. With numerical prefix ARG, go up to this level and then
3939 take that tree. If ARG is negative, go up that many levels. With
3940 `C-u' prefix, do not remove the previously used indirect buffer.
3943 Toggle Logbook mode. In Logbook mode, entries that where marked
3944 DONE while logging was on (variable `org-log-done') are shown in
3945 the agenda, as are entries that have been clocked on that day.
3951 Delete other windows.
3954 Switch to weekly view (7 days displayed together).
3957 Switch to daily view (just one day displayed).
3960 Toggle the inclusion of diary entries. See *Note Weekly/Daily
3964 Toggle the time grid on and off. See also the variables
3965 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
3968 Recreate the agenda buffer, for example to reflect the changes
3969 after modification of the time stamps of items with S-<left> and
3970 S-<right>. When the buffer is the global todo list, a prefix
3971 argument is interpreted to create a selective list for a specific
3975 Save all Org-mode buffers in the current Emacs session.
3978 Display the following `org-agenda-ndays' days. For example, if
3979 the display covers a week, switch to the following week. With
3980 prefix arg, go forward that many times `org-agenda-ndays' days.
3983 Display the previous dates.
3995 Undo a change due to a remote editing command. The change is
3996 undone both in the agenda buffer and in the remote buffer.
3999 Change the TODO state of the item, both in the agenda and in the
4003 Delete the current agenda item along with the entire subtree
4004 belonging to it in the original Org-mode file. If the text to be
4005 deleted remotely is longer than one line, the kill needs to be
4006 confirmed by the user. See variable `org-agenda-confirm-kill'.
4009 Archive the subtree corresponding to the current headline.
4012 Show all tags associated with the current item. Because of
4013 inheritance, this may be more than the tags listed in the line
4017 Set tags for the current headline.
4020 Toggle the ARCHIVE tag for the current headline.
4023 Set the priority for the current item. Org-mode prompts for the
4024 priority character. If you reply with <SPC>, the priority cookie
4025 is removed from the entry.
4028 Display weighted priority of current item.
4032 Increase the priority of the current item. The priority is
4033 changed in the original buffer, but the agenda is not resorted.
4034 Use the `r' key for this.
4038 Decrease the priority of the current item.
4044 Set a deadline for this item.
4047 Change the time stamp associated with the current line by one day
4048 into the future. With prefix argument, change it by that many
4049 days. For example, `3 6 5 S-<right>' will change it by a year.
4050 The stamp is changed in the original org file, but the change is
4051 not directly reflected in the agenda buffer. Use the `r' key to
4055 Change the time stamp associated with the current line by one day
4059 Change the time stamp associated with the current line to today.
4060 The key `>' has been chosen, because it is the same as `S-.' on my
4064 Start the clock on the current item. If a clock is running
4065 already, it is stopped first.
4068 Stop the previously started clock.
4071 Cancel the currently running clock.
4077 Open the Emacs calendar and move to the date at the agenda cursor.
4080 When in the calendar, compute and show the Org-mode agenda for the
4084 Insert a new entry into the diary. Prompts for the type of entry
4085 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
4086 new entry in the diary, just as `i d' etc. would do in the
4087 calendar. The date is taken from the cursor position.
4090 Show the phases of the moon for the three months around current
4094 Show sunrise and sunset times. The geographical location must be
4095 set with calendar variables, see documentation of the Emacs
4099 Convert the date at cursor into many other cultural and historic
4103 Show holidays for three month around the cursor date.
4106 Export a single iCalendar file containing entries from all agenda
4113 Write the agenda view to a file. Depending on the extension of the
4114 selected file name, the view will be exported as HTML (extension
4115 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4116 (any other extension). Use the variable
4117 `org-agenda-exporter-settings' to set options for `ps-print' and
4118 for `htmlize' to be used during export.
4124 Quit agenda, remove the agenda buffer.
4127 Exit agenda, remove the agenda buffer and all buffers loaded by
4128 Emacs for the compilation of the agenda. Buffers created by the
4129 user to visit org files will not be removed.
4132 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
4134 8.6 Custom agenda views
4135 =======================
4137 Custom agenda commands serve two purposes: to store and quickly access
4138 frequently used TODO and tags searches, and to create special composite
4139 agenda buffers. Custom agenda commands will be accessible through the
4140 dispatcher (*note Agenda dispatcher::), just like the default commands.
4144 * Storing searches:: Type once, use often
4145 * Block agenda:: All the stuff you need in a single buffer
4146 * Setting Options:: Changing the rules
4147 * Exporting Agenda Views:: Writing agendas to files.
4148 * Extracting Agenda Information for other programs::
4151 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
4153 8.6.1 Storing searches
4154 ----------------------
4156 The first application of custom searches is the definition of keyboard
4157 shortcuts for frequently used searches, either creating an agenda
4158 buffer, or a sparse tree (the latter covering of course only the current
4159 buffer). Custom commands are configured in the variable
4160 `org-agenda-custom-commands'. You can customize this variable, for
4161 example by pressing `C-c a C'. You can also directly set it with Emacs
4162 Lisp in `.emacs'. The following example contains all valid search
4165 (setq org-agenda-custom-commands
4166 '(("w" todo "WAITING")
4167 ("W" todo-tree "WAITING")
4168 ("u" tags "+BOSS-URGENT")
4169 ("v" tags-todo "+BOSS-URGENT")
4170 ("U" tags-tree "+BOSS-URGENT")
4171 ("f" occur-tree "\\<FIXME\\>")))
4173 The initial single-character string in each entry defines the character
4174 you have to press after the dispatcher command `C-c a' in order to
4175 access the command. The second parameter is the search type, followed
4176 by the string or regular expression to be used for the matching. The
4177 example above will therefore define:
4180 as a global search for TODO entries with `WAITING' as the TODO
4184 as the same search, but only in the current buffer and displaying
4185 the results as a sparse tree
4188 as a global tags search for headlines marked `:BOSS:' but not
4192 as the same search as `C-c a u', but limiting the search to
4193 headlines that are also TODO items
4196 as the same search as `C-c a u', but only in the current buffer and
4197 displaying the result as a sparse tree
4200 to create a sparse tree (again: current buffer only) with all
4201 entries containing the word `FIXME'.
4204 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
4209 Another possibility is the construction of agenda views that comprise
4210 the results of _several_ commands, each of which creates a block in the
4211 agenda buffer. The available commands include `agenda' for the daily
4212 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
4213 todo list (as constructed with `C-c a t'), and the matching commands
4214 discussed above: `todo', `tags', and `tags-todo'. Here are two
4217 (setq org-agenda-custom-commands
4218 '(("h" "Agenda and Home-related tasks"
4222 ("o" "Agenda and Office-related tasks"
4227 This will define `C-c a h' to create a multi-block view for stuff you
4228 need to attend to at home. The resulting agenda buffer will contain
4229 your agenda for the current week, all TODO items that carry the tag
4230 `HOME', and also all lines tagged with `GARDEN'. Finally the command
4231 `C-c a o' provides a similar view for office tasks.
4234 File: org, Node: Setting Options, Next: Exporting Agenda Views, Prev: Block agenda, Up: Custom agenda views
4236 8.6.3 Setting Options for custom commands
4237 -----------------------------------------
4239 Org-mode contains a number of variables regulating agenda construction
4240 and display. The global variables define the behavior for all agenda
4241 commands, including the custom commands. However, if you want to change
4242 some settings just for a single custom view, you can do so. Setting
4243 options requires inserting a list of variable names and values at the
4244 right spot in `org-agenda-custom-commands'. For example:
4246 (setq org-agenda-custom-commands
4247 '(("w" todo "WAITING"
4248 ((org-agenda-sorting-strategy '(priority-down))
4249 (org-agenda-prefix-format " Mixed: ")))
4250 ("U" tags-tree "+BOSS-URGENT"
4251 ((org-show-following-heading nil)
4252 (org-show-hierarchy-above nil)))))
4254 Now the `C-c a w' command will sort the collected entries only by
4255 priority, and the prefix format is modified to just say ` Mixed:'
4256 instead of giving the category of the entry. The sparse tags tree of
4257 `C-c a U' will now turn out ultra-compact, because neither the headline
4258 hierarchy above the match, nor the headline following the match will be
4261 For command sets creating a block agenda,
4262 `org-agenda-custom-commands' has two separate spots for setting
4263 options. You can add options that should be valid for just a single
4264 command in the set, and options that should be valid for all commands in
4265 the set. The former are just added to the command entry, the latter
4266 must come after the list of command entries. Going back to the block
4267 agenda example (*note Block agenda::), let's change the sorting strategy
4268 for the `C-c a h' commands to `priority-down', but let's sort the
4269 results for GARDEN tags query in the opposite order, `priority-up'.
4270 This would look like this:
4272 (setq org-agenda-custom-commands
4273 '(("h" "Agenda and Home-related tasks"
4277 ((org-agenda-sorting-strategy '(priority-up)))))
4278 ((org-agenda-sorting-strategy '(priority-down))))
4279 ("o" "Agenda and Office-related tasks"
4284 As you see, the values and parenthesis setting is a little complex.
4285 When in doubt, use the customize interface to set this variable - it
4286 fully supports its structure. Just one caveat: When setting options in
4287 this interface, the _values_ are just lisp expressions. So if the
4288 value is a string, you need to add the double quotes around the value
4292 File: org, Node: Exporting Agenda Views, Next: Extracting Agenda Information for other programs, Prev: Setting Options, Up: Custom agenda views
4294 8.6.4 Exporting Agenda Views
4295 ----------------------------
4297 If you are away from your computer, it can be very useful to have a
4298 printed version of some agenda views to carry around. Org-mode can
4299 export custom agenda views as plain text, HTML(1) and postscript. If
4300 you want to do this only occasionally, use the commend
4303 Write the agenda view to a file. Depending on the extension of the
4304 selected file name, the view will be exported as HTML (extension
4305 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4306 (any other extension). Use the variable
4307 `org-agenda-exporter-settings' to set options for `ps-print' and
4308 for `htmlize' to be used during export, for example
4309 (setq org-agenda-exporter-settings
4310 '((ps-number-of-columns 2)
4311 (ps-landscape-mode t)
4312 (htmlize-output-type 'css)))
4314 If you need to export certain agenda views frequently, you can
4315 associate any custom agenda command with a list of output file names
4316 (2). Here is an example that first does define custom commands for the
4317 agenda and the global todo list, together with a number of files to
4318 which to export them. Then we define two block agenda commands and
4319 specify filenames for them as well. File names can be relative to the
4320 current working directory, or absolute.
4322 (setq org-agenda-custom-commands
4323 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
4324 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
4325 ("h" "Agenda and Home-related tasks"
4330 ("~/views/home.html"))
4331 ("o" "Agenda and Office-related tasks"
4336 ("~/views/office.ps"))))
4338 The extension of the file name determines the type of export. If it
4339 is `.html', Org-mode will use the `htmlize.el' package to convert the
4340 buffer to HTML and save it to this file name. If the extension is
4341 `.ps', `ps-print-buffer-with-faces' is used to produce postscript
4342 output. Any other extension produces a plain ASCII file.
4344 The export files are _not_ created when you use one of those
4345 commands interactively. Instead, there is a special command to produce
4346 _all_ specified files in one step:
4349 Export all agenda views that have export filenames associated with
4352 You can use the options section of the custom agenda commands to also
4353 set options for the export commands. For example:
4355 (setq org-agenda-custom-commands
4357 ((ps-number-of-columns 2)
4358 (ps-landscape-mode t)
4359 (org-agenda-prefix-format " [ ] ")
4360 (org-agenda-with-colors nil)
4361 (org-agenda-remove-tags t))
4364 This command sets two options for the postscript exporter, to make it
4365 print in two columns in landscape format - the resulting page can be cut
4366 in two and then used in a paper agenda. The remaining settings modify
4367 the agenda prefix to omit category and scheduling information, and
4368 instead include a checkbox to check off items. We also remove the tags
4369 to make the lines compact, and we don't want to use colors for the
4370 black-and-white printer. Settings specified in
4371 `org-agenda-exporter-settings' will also apply, but the settings in
4372 `org-agenda-custom-commands' take precedence.
4374 From the command line you may also use
4375 emacs -f org-batch-store-agenda-views -kill
4376 or, if you need to modify some parameters
4377 emacs -eval '(org-batch-store-agenda-views \
4378 org-agenda-ndays 30 \
4379 org-agenda-include-diary nil \
4380 org-agenda-files (quote ("~/org/project.org")))' \
4382 which will create the agenda views restricted to the file
4383 `~/org/project.org', without diary entries and with 30 days extent.
4385 ---------- Footnotes ----------
4387 (1) You need to install Hrvoje Niksic' `htmlize.el'.
4389 (2) If you want to store standard views like the weekly agenda or
4390 the global TODO list as well, you need to define custom commands for
4391 them in order to be able to specify filenames.
4394 File: org, Node: Extracting Agenda Information for other programs, Prev: Exporting Agenda Views, Up: Custom agenda views
4396 8.6.5 Extracting Agenda Information for other programs
4397 ------------------------------------------------------
4399 Org-mode provides commands to access agenda information for the command
4400 line in emacs batch mode. This extracted information can be sent
4401 directly to a printer, or it can be read by a program that does further
4402 processing of the data. The first of these commands is the function
4403 `org-batch-agenda', that produces an agenda view and sends it as ASCII
4404 text to STDOUT. The command takes a single string as parameter. If
4405 the string has length 1, it is used as a key to one of the commands you
4406 have configured in `org-agenda-custom-commands', basically any key you
4407 can use after `C-c a'. For example, to directly print the current TODO
4410 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
4412 If the parameter is a string with 2 or more characters, it is used
4413 as a tags/todo match string. For example, to print your local shopping
4414 list (all items with the tag `shop', but excluding the tag `NewYork'),
4417 emacs -batch -l ~/.emacs \
4418 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
4420 You may also modify parameters on the fly like this:
4422 emacs -batch -l ~/.emacs \
4423 -eval '(org-batch-agenda "a" \
4424 org-agenda-ndays 30 \
4425 org-agenda-include-diary nil \
4426 org-agenda-files (quote ("~/org/project.org")))' \
4429 which will produce a 30 day agenda, fully restricted to the Org file
4430 `~/org/projects.org', not even including the diary.
4432 If you want to process the agenda data in more sophisticated ways,
4433 you can use the command `org-batch-agenda-csv' to get a comma-separated
4434 list of values for each agenda item. Each line in the output will
4435 contain a number of fields separated by commas. The fields in a line
4438 category The category of the item
4439 head The headline, without TODO kwd, TAGS and PRIORITY
4440 type The type of the agenda entry, can be
4441 todo selected in TODO match
4442 tagsmatch selected in tags match
4443 diary imported from diary
4446 timestamp appointment, selected by timestamp
4447 closed entry was closed on date
4448 upcoming-deadline warning about nearing deadline
4449 past-scheduled forwarded scheduled item
4450 block entry has date block including date
4451 todo The todo keyword, if any
4452 tags All tags including inherited ones, separated by colons
4453 date The relevant date, like 2007-2-14
4454 time The time, like 15:00-16:50
4455 extra String with extra planning info
4456 priority-l The priority letter if any was given
4457 priority-n The computed numerical priority
4459 Time and date will only be given if a timestamp (or deadline/scheduled)
4460 lead to the selection of the item.
4462 A CSV list like this is very easy to use in a post processing script.
4463 For example, here is a Perl program that gets the TODO list from
4464 Emacs/org-mode and prints all the items, preceded by a checkbox:
4468 # define the Emacs command to run
4469 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
4471 # run it and capture the output
4472 $agenda = qx{$cmd 2>/dev/null};
4474 # loop over all lines
4475 foreach $line (split(/\n/,$agenda)) {
4477 # get the individual values
4478 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
4479 $priority_l,$priority_n) = split(/,/,$line);
4481 # proccess and print
4482 print "[ ] $head\n";
4486 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
4491 Plain ASCII is normally sufficient for almost all note taking. One
4492 exception, however, are scientific notes which need to be able to
4493 contain mathematical symbols and the occasional formula. LaTeX(1) is
4494 widely used to typeset scientific documents. Org-mode supports
4495 embedding LaTeX code into its files, because many academics are used to
4496 read LaTeX source code, and because it can be readily processed into
4497 images for HTML production.
4499 It is not necessary to mark LaTeX macros and code in any special way.
4500 If you observe a few conventions, Org-mode knows how to find it and what
4505 * Math symbols:: TeX macros for symbols and Greek letters
4506 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
4507 * LaTeX fragments:: Complex formulas made easy
4508 * Processing LaTeX fragments:: Previewing LaTeX processing
4509 * CDLaTeX mode:: Speed up entering of formulas
4511 ---------- Footnotes ----------
4513 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
4514 Many of the features described here as "LaTeX" are really from TeX, but
4515 for simplicity I am blurring this distinction.
4518 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
4523 You can use LaTeX macros to insert special symbols like `\alpha' to
4524 indicate the Greek letter, or `\to' to indicate an arrow. Completion
4525 for these macros is available, just type `\' and maybe a few letters,
4526 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
4527 Org-mode allows these macros to be present without surrounding math
4528 delimiters, for example:
4530 Angles are written as Greek letters \alpha, \beta and \gamma.
4532 During HTML export (*note HTML export::), these symbols are
4533 translated into the proper syntax for HTML, for the above examples this
4534 is `α' and `→', respectively.
4537 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
4539 9.2 Subscripts and Superscripts
4540 ===============================
4542 Just like in LaTeX, `^' and `_' are used to indicate super- and
4543 subscripts. Again, these can be used without embedding them in
4544 math-mode delimiters. To increase the readability of ASCII text, it is
4545 not necessary (but OK) to surround multi-character sub- and superscripts
4546 with curly braces. For example
4548 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
4549 the sun is R_{sun} = 6.96 x 10^8 m.
4551 To avoid interpretation as raised or lowered text, you can quote `^'
4552 and `_' with a backslash: `\_' and `\^'.
4554 During HTML export (*note HTML export::), subscript and superscripts
4555 are surrounded with `<sub>' and `<sup>' tags, respectively.
4558 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
4563 With symbols, sub- and superscripts, HTML is pretty much at its end when
4564 it comes to representing mathematical formulas(1). More complex
4565 expressions need a dedicated formula processor. To this end, Org-mode
4566 can contain arbitrary LaTeX fragments. It provides commands to preview
4567 the typeset result of these fragments, and upon export to HTML, all
4568 fragments will be converted to images and inlined into the HTML
4569 document. For this to work you need to be on a system with a working
4570 LaTeX installation. You also need the `dvipng' program, available at
4571 `http://sourceforge.net/projects/dvipng/'. The LaTeX header that will
4572 be used when processing a fragment can be configured with the variable
4573 `org-format-latex-header'.
4575 LaTeX fragments don't need any special marking at all. The following
4576 snippets will be identified as LaTeX source code:
4577 * Environments of any kind. The only requirement is that the
4578 `\begin' statement appears on a new line, preceded by only
4581 * Text within the usual LaTeX math delimiters. To avoid conflicts
4582 with currency specifications, single `$' characters are only
4583 recognized as math delimiters if the enclosed text contains at
4584 most two line breaks, is directly attached to the `$' characters
4585 with no whitespace in between, and if the closing `$' is followed
4586 by whitespace or punctuation. For the other delimiters, there is
4587 no such restriction, so when in doubt, use `\(...\)' as inline
4592 \begin{equation} % arbitrary environments,
4593 x=\sqrt{b} % even tables, figures
4594 \end{equation} % etc
4596 If $a^2=b$ and \( b=2 \), then the solution must be
4597 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
4599 If you need any of the delimiter ASCII sequences for other purposes, you
4600 can configure the option `org-format-latex-options' to deselect the
4601 ones you do not wish to have interpreted by the LaTeX converter.
4603 ---------- Footnotes ----------
4605 (1) Yes, there is MathML, but that is not yet fully supported by
4606 many browsers, and there is no decent converter for turning LaTeX of
4607 ASCII representations of formulas into MathML. So for the time being,
4608 converting formulas into images seems the way to go.
4611 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
4613 9.4 Processing LaTeX fragments
4614 ==============================
4616 LaTeX fragments can be processed to produce a preview images of the
4617 typeset expressions:
4620 Produce a preview image of the LaTeX fragment at point and overlay
4621 it over the source code. If there is no fragment at point,
4622 process all fragments in the current entry (between two
4623 headlines). When called with a prefix argument, process the
4624 entire subtree. When called with two prefix arguments, or when
4625 the cursor is before the first headline, process the entire buffer.
4628 Remove the overlay preview images.
4630 During HTML export (*note HTML export::), all LaTeX fragments are
4631 converted into images and inlined into the document if the following
4634 (setq org-export-with-LaTeX-fragments t)
4637 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
4639 9.5 Using CDLaTeX to enter math
4640 ===============================
4642 CDLaTeX-mode is a minor mode that is normally used in combination with a
4643 major LaTeX mode like AUCTeX in order to speed-up insertion of
4644 environments and math templates. Inside Org-mode, you can make use of
4645 some of the features of cdlatex-mode. You need to install `cdlatex.el'
4646 and `texmathp.el' (the latter comes also with AUCTeX) from
4647 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
4648 cdlatex-mode itself under Org-mode, but use the light version
4649 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
4650 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
4653 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
4655 When this mode is enabled, the following features are present (for
4656 more details see the documentation of cdlatex-mode):
4657 * Environment templates can be inserted with `C-c {'.
4659 * The <TAB> key will do template expansion if the cursor is inside a
4660 LaTeX fragment(1). For example, <TAB> will expand `fr' to
4661 `\frac{}{}' and position the cursor correctly inside the first
4662 brace. Another <TAB> will get you into the second brace. Even
4663 outside fragments, <TAB> will expand environment abbreviations at
4664 the beginning of a line. For example, if you write `equ' at the
4665 beginning of a line and press <TAB>, this abbreviation will be
4666 expanded to an `equation' environment. To get a list of all
4667 abbreviations, type `M-x cdlatex-command-help'.
4669 * Pressing `_' and `^' inside a LaTeX fragment will insert these
4670 characters together with a pair of braces. If you use <TAB> to
4671 move out of the braces, and if the braces surround only a single
4672 character or macro, they are removed again (depending on the
4673 variable `cdlatex-simplify-sub-super-scripts').
4675 * Pressing the backquote ``' followed by a character inserts math
4676 macros, also outside LaTeX fragments. If you wait more than 1.5
4677 seconds after the backquote, a help window will pop up.
4679 * Pressing the normal quote `'' followed by another character
4680 modifies the symbol before point with an accent or a font. If you
4681 wait more than 1.5 seconds after the backquote, a help window will
4682 pop up. Character modification will work only inside LaTeX
4683 fragments, outside the quote is normal.
4685 ---------- Footnotes ----------
4687 (1) Org-mode has a method to test if the cursor is inside such a
4688 fragment, see the documentation of the function
4689 `org-inside-LaTeX-fragment-p'.
4692 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
4697 Org-mode documents can be exported into a variety of other formats. For
4698 printing and sharing of notes, ASCII export produces a readable and
4699 simple version of an Org-mode file. HTML export allows you to publish a
4700 notes file on the web, while the XOXO format provides a solid base for
4701 exchange with a broad range of other applications. To incorporate
4702 entries with associated times like deadlines or appointments into a
4703 desktop calendar program like iCal, Org-mode can also produce extracts
4704 in the iCalendar format. Currently Org-mode only supports export, not
4705 import of these different formats.
4707 When exporting, Org-mode uses special conventions to enrich the
4708 output produced. *Note Text interpretation::, for more details.
4711 Dispatcher for export and publishing commands. Displays a
4712 help-window listing the additional key(s) needed to launch an
4713 export or publishing command.
4717 * ASCII export:: Exporting to plain ASCII
4718 * HTML export:: Exporting to HTML
4719 * XOXO export:: Exporting to XOXO
4720 * iCalendar export:: Exporting in iCalendar format
4721 * Text interpretation:: How the exporter looks at the file
4724 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
4729 ASCII export produces a simple and very readable version of an Org-mode
4733 Export as ASCII file. If there is an active region, only the
4734 region will be exported. For an org file `myfile.org', the ASCII
4735 file will be `myfile.txt'. The file will be overwritten without
4739 Export only the visible part of the document.
4741 In the exported version, the first 3 outline levels will become
4742 headlines, defining a general document structure. Additional levels
4743 will be exported as itemized lists. If you want that transition to
4744 occur at a different level, specify it with a prefix argument. For
4749 creates only top level headlines and does the rest as items. When
4750 headlines are converted to items, the indentation of the text following
4751 the headline is changed to fit nicely under the item. This is done with
4752 the assumption that the first bodyline indicates the base indentation of
4753 the body text. Any indentation larger than this is adjusted to preserve
4754 the layout relative to the first line. Should there be lines with less
4755 indentation than the first, these are left alone.
4758 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
4763 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
4764 HTML formatting, in ways similar to John Grubers _markdown_ language,
4765 but with additional support for tables.
4769 * Export commands:: How to invoke HTML export
4770 * Quoting HTML tags:: Using direct HTML in Org-mode
4771 * Links:: How hyperlinks get transferred to HTML
4772 * Images:: To inline or not to inline?
4773 * CSS support:: Style specifications
4776 File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
4778 10.2.1 HTML export commands
4779 ---------------------------
4782 Export as HTML file `myfile.html'.
4785 Export as HTML file and open it with a browser.
4788 Export to a temporary buffer, do not create a file.
4791 Export the active region to a temporary buffer. With prefix arg,
4792 do not produce file header and foot, but just the plain HTML
4793 section for the region. This is good for cut-and-paste operations.
4802 Export only the visible part of the document.
4804 `M-x org-export-region-as-html'
4805 Convert the region to HTML under the assumption that it was
4806 org-mode syntax before. This is a global command that can be
4807 invoked in any buffer.
4809 In the exported version, the first 3 outline levels will become
4810 headlines, defining a general document structure. Additional levels
4811 will be exported as itemized lists. If you want that transition to
4812 occur at a different level, specify it with a prefix argument. For
4817 creates two levels of headings and does the rest as items.
4820 File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
4822 10.2.2 Quoting HTML tags
4823 ------------------------
4825 Plain `<' and `>' are always transformed to `<' and `>' in HTML
4826 export. If you want to include simple HTML tags which should be
4827 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
4828 Note that this really works only for simple tags. For more extensive
4829 HTML that should be copied verbatim to the exported file use either
4831 #+HTML: Literal HTML code for export
4836 All lines between these markers are exported literally
4840 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
4845 Internal links (*note Internal links::) will continue to work in HTML
4846 files only if they match a dedicated `<<target>>'. Automatic links
4847 created by radio targets (*note Radio targets::) will also work in the
4848 HTML file. Links to external files will still work if the HTML file is
4849 in the same directory as the Org-mode file. Links to other `.org'
4850 files will be translated into HTML links under the assumption that an
4851 HTML version also exists of the linked file. For information related to
4852 linking files while publishing them to a publishing directory see *Note
4856 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
4861 HTML export can inline images given as links in the Org-mode file, and
4862 it can make an image the clickable part of a link. By default(1),
4863 images are inlined if a link does not have a description. So
4864 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
4865 image]]' will just produce a link `the image' that points to the image.
4866 If the description part itself is a `file:' link or a `http:' URL
4867 pointing to an image, this image will be inlined and activated so that
4868 clicking on the image will activate the link. For example, to include
4869 a thumbnail that will link to a high resolution version of the image,
4872 [[file:highres.jpg][file:thumb.jpg]]
4874 and you could use `http' addresses just as well.
4876 ---------- Footnotes ----------
4878 (1) but see the variable `org-export-html-inline-images'
4881 File: org, Node: CSS support, Prev: Images, Up: HTML export
4886 You can also give style information for the exported file. The HTML
4887 exporter assigns the following CSS classes to appropriate parts of the
4888 document - your style specifications may change these:
4890 .done the DONE keyword
4891 .timestamp time stamp
4892 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
4893 .tag tag in a headline
4894 .target target for links
4896 The default style specification can be configured through the option
4897 `org-export-html-style'. If you want to use a file-local style, you
4898 may use file variables, best wrapped into a COMMENT section at the end
4899 of the outline tree. For example(1):
4901 * COMMENT html style specifications
4904 # org-export-html-style: " <style type=\"text/css\">
4905 # p {font-weight: normal; color: gray; }
4906 # h1 {color: black; }
4910 Remember to execute `M-x normal-mode' after changing this to make
4911 the new style visible to Emacs. This command restarts org-mode for the
4912 current buffer and forces Emacs to re-evaluate the local variables
4913 section in the buffer.
4915 ---------- Footnotes ----------
4917 (1) Under Emacs 21, the continuation lines for a variable value
4918 should have no `#' at the start of the line.
4921 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
4926 Org-mode contains an exporter that produces XOXO-style output.
4927 Currently, this exporter only handles the general outline structure and
4928 does not interpret any additional Org-mode features.
4931 Export as XOXO file `myfile.html'.
4934 Export only the visible part of the document.
4937 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
4939 10.4 iCalendar export
4940 =====================
4942 Some people like to use Org-mode for keeping track of projects, but
4943 still prefer a standard calendar application for anniversaries and
4944 appointments. In this case it can be useful to have deadlines and
4945 other time-stamped items in Org-mode files show up in the calendar
4946 application. Org-mode can export calendar information in the standard
4947 iCalendar format. If you also want to have TODO entries included in the
4948 export, configure the variable `org-icalendar-include-todo'.
4951 Create iCalendar entries for the current file and store them in
4952 the same directory, using a file extension `.ics'.
4955 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
4956 For each of these files, a separate iCalendar file will be
4960 Create a single large iCalendar file from all files in
4961 `org-agenda-files' and write it to the file given by
4962 `org-combined-agenda-icalendar-file'.
4964 How this calendar is best read and updated, depends on the
4965 application you are using. The FAQ covers this issue.
4968 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
4970 10.5 Text interpretation by the exporter
4971 ========================================
4973 The exporter backends interpret additional structure in the Org-mode
4974 file in order to produce better output.
4978 * Comment lines:: Some lines will not be exported
4979 * Initial text:: Text before the first headline
4980 * Footnotes:: Numbers like [1]
4981 * Enhancing text:: Subscripts, symbols and more
4982 * Export options:: How to influence the export settings
4985 File: org, Node: Comment lines, Next: Initial text, Prev: Text interpretation, Up: Text interpretation
4987 10.5.1 Comment lines
4988 --------------------
4990 Lines starting with `#' in column zero are treated as comments and will
4991 never be exported. Also entire subtrees starting with the word
4992 `COMMENT' will never be exported.
4995 Toggle the COMMENT keyword at the beginning of an entry.
4998 File: org, Node: Initial text, Next: Footnotes, Prev: Comment lines, Up: Text interpretation
5000 10.5.2 Text before the first headline
5001 -------------------------------------
5003 Org-mode normally ignores any text before the first headline when
5004 exporting, leaving this region for internal links to speed up navigation
5005 etc. However, in publishing-oriented files, you might want to have some
5006 text before the first headline, like a small introduction, special HTML
5007 code with a navigation bar, etc. You can ask to have this part of the
5008 file exported as well by setting the variable
5009 `org-export-skip-text-before-1st-heading' to `nil'. On a per-file
5010 basis, you can get the same effect with
5014 The text before the first headline will be fully processed (*note
5015 Enhancing text::), and the first non-comment line becomes the title of
5016 the exported document. If you need to include literal HTML, use the
5017 special constructs described in *Note Quoting HTML tags::. The table
5018 of contents is normally inserted directly before the first headline of
5019 the file. If you would like to get it to a different location, insert
5020 the string `[TABLE-OF-CONTENTS]' on a line by itself at the desired
5023 Finally, if you want to use the space before the first headline for
5024 internal purposes, but _still_ want to place something before the first
5025 headline when exporting the file, you can use the `#+TEXT' construct:
5028 #+TEXT: This text will go before the *first* headline.
5029 #+TEXT: We place the table of contents here:
5030 #+TEXT: [TABLE-OF-CONTENTS]
5031 #+TEXT: This goes between the table of contents and the first headline
5034 File: org, Node: Footnotes, Next: Enhancing text, Prev: Initial text, Up: Text interpretation
5039 Numbers in square brackets are treated as footnotes, so that you can use
5040 the Emacs package `footnote.el' to create footnotes. For example:
5042 The org-mode homepage[1] clearly needs help from
5043 a good web designer.
5045 [1] The link is: http://www.astro.uva.nl/~dominik/Tools/org
5047 Note that the `footnote' package uses `C-c !' to invoke its commands.
5048 This binding conflicts with the org-mode command for inserting inactive
5049 time stamps. You could use the variable `footnote-prefix' to switch
5050 footnotes commands to another key. Or, if you are too used to this
5051 binding, you could use `org-replace-disputed-keys' and
5052 `org-disputed-keys' to change the settings in Org-mode.
5055 File: org, Node: Enhancing text, Next: Export options, Prev: Footnotes, Up: Text interpretation
5057 10.5.4 Enhancing text for export
5058 --------------------------------
5060 Some of the export backends of Org-mode allow for sophisticated text
5061 formatting, this is true in particular for the HTML backend. Org-mode
5062 has a number of typing conventions that allow to produce a richly
5065 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
5066 enumerator will be recognized and transformed if the backend
5067 supports lists. See *Note Plain lists::.
5069 * You can make words *bold*, /italic/, _underlined_, `=code=', and
5070 even `+strikethrough+'(1).
5072 * A line consisting of only dashes, and at least 5 of them, will be
5073 exported as a horizontal line (`<hr/>' in HTML).
5075 * Many TeX macros and entire LaTeX fragments are converted into HTML
5076 entities or images (*note Embedded LaTeX::).
5078 * Tables are transformed into native tables under the exporter, if
5079 the export backend supports this. Data fields before the first
5080 horizontal separator line will be formatted as table header fields.
5082 * If a headline starts with the word `QUOTE', the text below the
5083 headline will be typeset as fixed-width, to allow quoting of
5084 computer codes etc. Lines starting with `:' are also typeset in
5087 Toggle fixed-width for entry (QUOTE) or region, see below.
5089 * A double backslash _at the end of a line_ enforces a line break at
5092 If these conversions conflict with your habits of typing ASCII text,
5093 they can all be turned off with corresponding variables. See the
5094 customization group `org-export-general', and the following section
5095 which explains how to set export options with special lines in a buffer.
5097 ---------- Footnotes ----------
5099 (1) but remember that strikethrough is typographically evil and
5100 should never be used.
5103 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
5105 10.5.5 Export options
5106 ---------------------
5108 The exporter recognizes special lines in the buffer which provide
5109 additional information. These lines may be put anywhere in the file.
5110 The whole set of lines can be inserted into the buffer with `C-c C-e
5111 t'. For individual lines, a good way to make sure the keyword is
5112 correct is to type `#+' and then use `M-<TAB>' completion (*note
5116 Insert template with export options, see example below.
5118 #+TITLE: the title to be shown (default is the buffer name)
5119 #+AUTHOR: the author (default taken from `user-full-name')
5120 #+EMAIL: his/her email address (default from `user-mail-address')
5121 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
5122 #+TEXT: Some descriptive text to be inserted at the beginning.
5123 #+TEXT: Several lines may be given.
5124 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t skip:t
5126 The OPTIONS line is a compact form to specify export settings. Here
5128 H: set the number of headline levels for export
5129 num: turn on/off section-numbers
5130 toc: turn on/off table of contents, or set level limit (integer)
5131 \n: turn on/off linebreak-preservation
5132 @: turn on/off quoted HTML tags
5133 :: turn on/off fixed-width sections
5134 |: turn on/off tables
5135 ^: turn on/off TeX-like syntax for sub- and superscripts. If
5136 you write "^:{}", `a_{b}' will be interpreted, but
5137 the simple `a_b' will be left as it is.
5138 *: turn on/off emphasized text (bold, italic, underlined)
5139 TeX: turn on/off simple TeX macros in plain text
5140 LaTeX: turn on/off LaTeX fragments
5141 skip: turn on/off skipping the text before the first heading
5144 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
5149 Org-mode includes(1) a publishing management system that allows you to
5150 configure automatic HTML conversion of _projects_ composed of
5151 interlinked org files. This system is called _org-publish_. You can
5152 also configure org-publish to automatically upload your exported HTML
5153 pages and related attachments, such as images and source code files, to
5154 a web server. Org-publish turns org-mode into a web-site authoring
5157 Org-publish has been contributed to Org-mode by David O'Toole.
5161 * Configuration:: Defining projects
5162 * Sample configuration:: Example projects
5163 * Triggering publication:: Publication commands
5165 ---------- Footnotes ----------
5167 (1) `org-publish.el' is not yet part of Emacs, so if you are using
5168 `org.el' as it comes with Emacs, you need to download this file
5169 separately. Also make sure org.el is at least version 4.27.
5172 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
5177 Publishing needs significant configuration to specify files, destination
5178 and many other properties of a project.
5182 * Project alist:: The central configuration variable
5183 * Sources and destinations:: From here to there
5184 * Selecting files:: What files are part of the project?
5185 * Publishing action:: Setting the function doing the publishing
5186 * Publishing options:: Tweaking HTML export
5187 * Publishing links:: Which links keep working after publishing?
5188 * Project page index:: Publishing a list of project files
5191 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
5193 11.1.1 The variable `org-publish-project-alist'
5194 -----------------------------------------------
5196 Org-publish is configured almost entirely through setting the value of
5197 one variable, called `org-publish-project-alist'. Each element of the
5198 list configures one project, and may be in one of the two following
5201 ("project-name" :property value :property value ...)
5205 ("project-name" :components ("project-name" "project-name" ...))
5207 In both cases, projects are configured by specifying property values.
5208 A project defines the set of files that will be published, as well as
5209 the publishing configuration to use when publishing those files. When
5210 a project takes the second form listed above, the individual members of
5211 the "components" property are taken to be components of the project,
5212 which group together files requiring different publishing options. When
5213 you publish such a "meta-project" all the components will also publish.
5216 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
5218 11.1.2 Sources and destinations for files
5219 -----------------------------------------
5221 Most properties are optional, but some should always be set. In
5222 particular, org-publish needs to know where to look for source files,
5223 and where to put published files.
5225 `:base-directory' Directory containing publishing source files
5226 `:publishing-directory'Directory (possibly remote) where output files
5228 `:preparation-function'Function called before starting publishing
5229 process, for example to run `make' for updating
5230 files to be published.
5233 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
5235 11.1.3 Selecting files
5236 ----------------------
5238 By default, all files with extension `.org' in the base directory are
5239 considered part of the project. This can be modified by setting the
5241 `:base-extension' Extension (without the dot!) of source files. This
5242 actually is a regular expression.
5243 `:exclude' Regular expression to match file names that should
5244 not be published, even though they have been selected
5245 on the basis of their extension.
5246 `:include' List of files to be included regardless of
5247 `:base-extension' and `:exclude'.
5250 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
5252 11.1.4 Publishing Action
5253 ------------------------
5255 Publishing means that a file is copied to the destination directory and
5256 possibly transformed in the process. The default transformation is to
5257 export Org-mode files as HTML files, and this is done by the function
5258 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
5259 export::). Other files like images only need to be copied to the
5260 publishing destination. For non-Org-mode files, you need to specify
5261 the publishing function.
5263 `:publishing-function' Function executing the publication of a file.
5264 This may also be a list of functions, which will
5265 all be called in turn.
5267 The function must accept two arguments: a property list containing at
5268 least a `:publishing-directory' property, and the name of the file to
5269 be published. It should take the specified file, make the necessary
5270 transformation (if any) and place the result into the destination
5271 folder. You can write your own publishing function, but `org-publish'
5272 provides one for attachments (files that only need to be copied):
5273 `org-publish-attachment'.
5276 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
5278 11.1.5 Options for the HTML exporter
5279 ------------------------------------
5281 The property list can be used to set many export options for the HTML
5282 exporter. In most cases, these properties correspond to user variables
5283 in Org-mode. The table below lists these properties along with the
5284 variable they belong to. See the documentation string for the
5285 respective variable for details.
5287 `:language' `org-export-default-language'
5288 `:headline-levels' `org-export-headline-levels'
5289 `:section-numbers' `org-export-with-section-numbers'
5290 `:table-of-contents' `org-export-with-toc'
5291 `:archived-trees' `org-export-with-archived-trees'
5292 `:emphasize' `org-export-with-emphasize'
5293 `:sub-superscript' `org-export-with-sub-superscripts'
5294 `:TeX-macros' `org-export-with-TeX-macros'
5295 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
5296 `:fixed-width' `org-export-with-fixed-width'
5297 `:timestamps' `org-export-with-timestamps'
5299 `:tags' `org-export-with-tags'
5301 `:tables' `org-export-with-tables'
5302 `:table-auto-headline' `org-export-highlight-first-table-line'
5303 `:style' `org-export-html-style'
5304 `:convert-org-links' `org-export-html-link-org-files-as-html'
5305 `:inline-images' `org-export-html-inline-images'
5306 `:expand-quoted-html' `org-export-html-expand'
5307 `:timestamp' `org-export-html-with-timestamp'
5308 `:publishing-directory'`org-export-publishing-directory'
5309 `:preamble' `org-export-html-preamble'
5310 `:postamble' `org-export-html-postamble'
5311 `:auto-preamble' `org-export-html-auto-preamble'
5312 `:auto-postamble' `org-export-html-auto-postamble'
5313 `:author' `user-full-name'
5314 `:email' `user-mail-address'
5316 When a property is given a value in org-publish-project-alist, its
5317 setting overrides the value of the corresponding user variable (if any)
5318 during publishing. options set within a file (*note Export options::),
5319 however, override everything.
5322 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
5324 11.1.6 Links between published files
5325 ------------------------------------
5327 To create a link from one Org-mode file to another, you would use
5328 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
5329 (*note Hyperlinks::). Upon publishing this link becomes a link to
5330 `foo.html'. In this way, you can interlink the pages of your "org web"
5331 project and the links will work as expected when you publish them to
5334 You may also link to related files, such as images. Provided you are
5335 careful with relative pathnames, and provided you have also configured
5336 org-publish to upload the related files, these links will work too.
5337 *Note Complex example:: for an example of this usage.
5339 Sometime an Org-mode file to be published may contain links that are
5340 only valid in your production environment, but not in the publishing
5341 location. In this case, use the property
5343 `:link-validation-function' Function to validate links
5345 to define a function for checking link validity. This function must
5346 accept two arguments, the file name and a directory relative to which
5347 the file name is interpreted in the production environment. If this
5348 function returns `nil', then the HTML generator will only insert a
5349 description into the HTML file, but no link. One option for this
5350 function is `org-publish-validate-link' which checks if the given file
5351 is part of any project in `org-publish-project-alist'.
5354 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
5356 11.1.7 Project page index
5357 -------------------------
5359 The following properties may be used to control publishing of an index
5360 of files or summary page for a given project.
5362 `:auto-index' When non-nil, publish an index during
5363 org-publish-current-project or org-publish-all.
5364 `:index-filename' Filename for output of index. Defaults to `index.org'
5365 (which becomes `index.html').
5366 `:index-title' Title of index page. Defaults to name of file.
5367 `:index-function' Plugin function to use for generation of index.
5368 Defaults to `org-publish-org-index', which generates
5369 a plain list of links to all files in the project.
5372 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
5374 11.2 Sample configuration
5375 =========================
5377 Below we provide two example configurations. The first one is a simple
5378 project publishing only a set of Org-mode files. The second example is
5379 more complex, with a multi-component project.
5383 * Simple example:: One-component publishing
5384 * Complex example:: A multi-component publishing example
5387 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
5389 11.2.1 Example: simple publishing configuration
5390 -----------------------------------------------
5392 This example publishes a set of Org-mode files to the `public_html'
5393 directory on the local machine.
5395 (setq org-publish-project-alist
5397 :base-directory "~/org/"
5398 :publishing-directory "~/public_html"
5399 :section-numbers nil
5400 :table-of-contents nil
5401 :style "<link rel=stylesheet
5402 href=\"../other/mystyle.css\"
5403 type=\"text/css\">")))
5406 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
5408 11.2.2 Example: complex publishing configuration
5409 ------------------------------------------------
5411 This more complicated example publishes an entire website, including
5412 org files converted to HTML, image files, emacs lisp source code, and
5413 stylesheets. The publishing-directory is remote and private files are
5416 To ensure that links are preserved, care should be taken to replicate
5417 your directory structure on the web server, and to use relative file
5418 paths. For example, if your org files are kept in `~/org' and your
5419 publishable images in `~/images', you'd link to an image with
5420 file:../images/myimage.png
5421 On the web server, the relative path to the image should be the
5422 same. You can accomplish this by setting up an "images" folder in the
5423 right place on the webserver, and publishing images to it.
5425 (setq org-publish-project-alist
5427 :base-directory "~/org/"
5428 :base-extension "org"
5429 :publishing-directory "/ssh:user@host:~/html/notebook/"
5430 :publishing-function org-publish-org-to-html
5431 :exclude "PrivatePage.org" ;; regexp
5433 :section-numbers nil
5434 :table-of-contents nil
5435 :style "<link rel=stylesheet
5436 href=\"../other/mystyle.css\" type=\"text/css\">"
5438 :auto-postamble nil)
5441 :base-directory "~/images/"
5442 :base-extension "jpg\\|gif\\|png"
5443 :publishing-directory "/ssh:user@host:~/html/images/"
5444 :publishing-function org-publish-attachment)
5447 :base-directory "~/other/"
5448 :base-extension "css\\|el"
5449 :publishing-directory "/ssh:user@host:~/html/other/"
5450 :publishing-function org-publish-attachment)
5451 ("website" :components ("orgfiles" "images" "other"))))
5454 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
5456 11.3 Triggering publication
5457 ===========================
5459 Once org-publish is properly configured, you can publish with the
5460 following functions:
5463 Prompt for a specific project and publish all files that belong to
5467 Publish the project containing the current file.
5470 Publish only the current file.
5473 Publish all projects.
5475 Org uses timestamps to track when a file has changed. The above
5476 functions normally only publish changed files. You can override this and
5477 force publishing of all files by giving a prefix argument.
5480 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
5487 * Completion:: M-TAB knows what you need
5488 * Customization:: Adapting Org-mode to your taste
5489 * In-buffer settings:: Overview of the #+KEYWORDS
5490 * The very busy C-c C-c key:: When in doubt, press C-c C-c
5491 * Clean view:: Getting rid of leading stars in the outline
5492 * TTY keys:: Using Org-mode on a tty
5493 * Interaction:: Other Emacs packages
5494 * Bugs:: Things which do not work perfectly
5497 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
5502 Org-mode supports in-buffer completion. This type of completion does
5503 not make use of the minibuffer. You simply type a few letters into the
5504 buffer and use the key to complete text right there.
5507 Complete word at point
5508 * At the beginning of a headline, complete TODO keywords.
5510 * After `\', complete TeX symbols supported by the exporter.
5512 * After `*', complete headlines in the current buffer so that
5513 they can be used in search links like `[[*find this
5516 * After `:', complete tags. The list of tags is taken from the
5517 variable `org-tag-alist' (possibly set through the `#+TAGS'
5518 in-buffer option, *note Setting tags::), or it is created
5519 dynamically from all tags used in the current buffer.
5521 * After `[', complete link abbreviations (*note Link
5524 * After `#+', complete the special keywords like `TYP_TODO' or
5525 `OPTIONS' which set file-specific options for Org-mode. When
5526 the option keyword is already complete, pressing `M-<TAB>'
5527 again will insert example settings for this keyword.
5529 * In the line after `#+STARTUP: ', complete startup keywords,
5530 i.e. valid keys for this line.
5532 * Elsewhere, complete dictionary words using ispell.
5535 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
5540 There are more than 180 variables that can be used to customize
5541 Org-mode. For the sake of compactness of the manual, I am not
5542 describing the variables here. A structured overview of customization
5543 variables is available with `M-x org-customize'. Or select `Browse Org
5544 Group' from the `Org->Customization' menu. Many settings can also be
5545 activated on a per-file basis, by putting special lines into the buffer
5546 (*note In-buffer settings::).
5549 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
5551 12.3 Summary of in-buffer settings
5552 ==================================
5554 Org-mode uses special lines in the buffer to define settings on a
5555 per-file basis. These lines start with a `#+' followed by a keyword, a
5556 colon, and then individual words defining a setting. Several setting
5557 words can be in the same line, but you can also have multiple lines for
5558 the keyword. While these settings are described throughout the manual,
5559 here is a summary. After changing any of those lines in the buffer,
5560 press `C-c C-c' with the cursor still in the line to activate the
5561 changes immediately. Otherwise they become effective only when the
5562 file is visited again in a new Emacs session.
5565 This line sets options to be used at startup of org-mode, when an
5566 Org-mode file is being visited. The first set of options deals
5567 with the initial visibility of the outline tree. The
5568 corresponding variable for global default settings is
5569 `org-startup-folded', with a default value `t', which means
5571 overview top-level headlines only
5572 content all headlines
5573 showall no folding at all, show everything
5574 Then there are options for aligning tables upon visiting a file.
5575 This is useful in files containing narrowed table columns. The
5576 corresponding variable is `org-startup-align-all-tables', with a
5577 default value `nil'.
5578 align align all tables
5579 noalign don't align tables on startup
5580 Logging TODO state changes and clock intervals (variable
5581 `org-log-done') can be configured using these options.
5582 logging record a timestamp when an item is marked DONE
5583 nologging don't record when items are marked DONE
5584 lognotedone record timestamp and a note when DONE
5585 lognotestate record timestamp, note when TODO state changes
5586 logrepeat record a not when re-instating a repeating item
5587 nologrepeat do not record when re-instating repeating item
5588 lognoteclock-out record timestamp and a note when clocking out
5589 Here are the options for hiding leading stars in outline headings.
5590 The corresponding variables are `org-hide-leading-stars' and
5591 `org-odd-levels-only', both with a default setting `nil' (meaning
5592 `showstars' and `oddeven').
5593 hidestars make all but one of the stars starting a headline invisible.
5594 showstars show all stars starting a headline
5595 odd allow only odd outline levels (1,3,...)
5596 oddeven allow all outline levels
5597 To turn on custom format overlays over time stamps (variables
5598 `org-put-time-stamp-overlays' and
5599 `org-time-stamp-overlay-formats'), use
5600 customtime overlay custom time format
5601 The following options influence the table spreadsheet (variable
5602 `constants-unit-system').
5603 constcgs `constants.el' should use the c-g-s unit system
5604 constSI `constants.el' should use the SI unit system
5606 `#+SEQ_TODO: #+TYP_TODO:'
5607 These lines set the TODO keywords and their interpretation in the
5608 current file. The corresponding variables are `org-todo-keywords'
5609 and `org-todo-interpretation'.
5611 `#+TAGS: TAG1(c1) TAG2(c2)'
5612 These lines (several such lines are allowed) specify the legal
5613 tags in this file, and (potentially) the corresponding _fast tag
5614 selection_ keys. The corresponding variable is `org-tag-alist'.
5616 `#+LINK: linkword replace'
5617 These lines (several are allowed) specify link abbreviations.
5618 *Note Link abbreviations::. The corresponding variable is
5619 `org-link-abbrev-alist'.
5622 This line sets the category for the agenda file. The category
5623 applies for all subsequent lines until the next `#+CATEGORY' line,
5624 or the end of the file. The first such line also applies to any
5627 `#+ARCHIVE: %s_done::'
5628 This line sets the archive location for the agenda file. It
5629 applies for all subsequent lines until the next `#+CATEGORY' line,
5630 or the end of the file. The first such line also applies to any
5631 entries before it. The corresponding variable is
5632 `org-archive-location'.
5634 `#+PRIORITIES: highest lowest default'
5635 This line sets the limits and the default for the priorities. All
5636 three must be either letters A-Z or numbers 0-9. The highest
5637 priority must have a lower ASCII number that the lowest priority.
5640 This line contains the formulas for the table directly above the
5643 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
5644 These lines provide settings for exporting files. For more
5645 details see *Note Export options::.
5648 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
5650 12.4 The very busy C-c C-c key
5651 ==============================
5653 The key `C-c C-c' has many purposes in org-mode, which are all
5654 mentioned scattered throughout this manual. One specific function of
5655 this key is to add _tags_ to a headline (*note Tags::). In many other
5656 circumstances it means something like _Hey Org-mode, look here and
5657 update according to what you see here_. Here is a summary of what this
5658 means in different contexts.
5660 - If there are highlights in the buffer from the creation of a sparse
5661 tree, or from clock display, remove these highlights.
5663 - If the cursor is in one of the special `#+KEYWORD' lines, this
5664 triggers scanning the buffer for these lines and updating the
5667 - If the cursor is inside a table, realign the table. This command
5668 works even if the automatic table editor has been turned off.
5670 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
5673 - If the cursor is inside a table created by the `table.el' package,
5674 activate that table.
5676 - If the current buffer is a remember buffer, close the note and
5677 file it. With a prefix argument, file it, without further
5678 interaction, to the default location.
5680 - If the cursor is on a `<<<target>>>', update radio targets and
5681 corresponding links in this buffer.
5683 - If the cursor is in a plain list item with a checkbox, toggle the
5684 status of the checkbox.
5686 - If the cursor is on a numbered item in a plain list, renumber the
5690 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
5692 12.5 A cleaner outline view
5693 ===========================
5695 Some people find it noisy and distracting that the Org-mode headlines
5696 are starting with a potentially large number of stars. For example the
5697 tree from *Note Headlines:::
5699 * Top level headline
5705 * Another top level headline
5707 Unfortunately this is deeply ingrained into the code of Org-mode and
5708 cannot be easily changed. You can, however, modify the display in such
5709 a way that all leading stars become invisible and the outline more easy
5710 to read. To do this, customize the variable `org-hide-leading-stars'
5713 (setq org-hide-leading-stars t)
5715 or change this on a per-file basis with one of the lines (anywhere in
5718 #+STARTUP: showstars
5719 #+STARTUP: hidestars
5721 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
5724 With stars hidden, the tree becomes:
5726 * Top level headline
5732 * Another top level headline
5734 Note that the leading stars are not truly replaced by whitespace, they
5735 are only fontified with the face `org-hide' that uses the background
5736 color as font color. If you are not using either white or black
5737 background, you may have to customize this face to get the wanted
5738 effect. Another possibility is to set this font such that the extra
5739 stars are almost invisible, for example using the color `grey90' on a
5742 Things become cleaner still if you skip all the even levels and use
5743 only odd levels 1, 3, 5..., effectively adding two stars to go from one
5744 outline level to the next:
5746 * Top level headline
5752 * Another top level headline
5754 In order to make the structure editing and export commands handle this
5755 convention correctly, use
5757 (setq org-odd-levels-only t)
5759 or set this on a per-file basis with one of the following lines (don't
5760 forget to press `C-c C-c' with the cursor in the startup line to
5761 activate changes immediately).
5766 You can convert an Org-mode file from single-star-per-level to the
5767 double-star-per-level convention with `M-x org-convert-to-odd-levels
5768 RET' in that file. The reverse operation is `M-x
5769 org-convert-to-oddeven-levels'.
5772 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
5774 12.6 Using org-mode on a tty
5775 ============================
5777 Org-mode uses a number of keys that are not accessible on a tty. This
5778 applies to most special keys like cursor keys, <TAB> and <RET>, when
5779 these are combined with modifier keys like <Meta> and/or <Shift>.
5780 Org-mode uses these bindings because it needs to provide keys for a
5781 large number of commands, and because these keys appeared particularly
5782 easy to remember. In order to still be able to access the core
5783 functionality of Org-mode on a tty, alternative bindings are provided.
5784 Here is a complete list of these bindings, which are obviously more
5785 cumbersome to use. Note that sometimes a work-around can be better.
5786 For example changing a time stamp is really only fun with `S-<cursor>'
5787 keys. On a tty you would rather use `C-c .' to re-insert the
5790 Default Alternative 1 Alternative 2
5791 `S-<TAB>' `C-u <TAB>'
5792 `M-<left>' `C-c C-x l' `<Esc> <left>'
5793 `M-S-<left>'`C-c C-x L'
5794 `M-<right>' `C-c C-x r' `<Esc>
5796 `M-S-<right>'`C-c C-x R'
5797 `M-<up>' `C-c C-x u' `<Esc> <up>'
5798 `M-S-<up>' `C-c C-x U'
5799 `M-<down>' `C-c C-x d' `<Esc> <down>'
5800 `M-S-<down>'`C-c C-x D'
5801 `S-<RET>' `C-c C-x c'
5802 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
5803 `M-S-<RET>' `C-c C-x M'
5804 `S-<left>' `C-c <left>'
5805 `S-<right>' `C-c <right>'
5807 `S-<down>' `C-c <down>'
5808 `C-S-<left>'`C-c C-x
5810 `C-S-<right>'`C-c C-x
5814 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
5816 12.7 Interaction with other packages
5817 ====================================
5819 Org-mode lives in the world of GNU Emacs and interacts in various ways
5820 with other code out there.
5824 * Cooperation:: Packages Org-mode cooperates with
5825 * Conflicts:: Packages that lead to conflicts
5828 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
5830 12.7.1 Packages that Org-mode cooperates with
5831 ---------------------------------------------
5833 `calc.el' by Dave Gillespie
5834 Org-mode uses the calc package for implementing spreadsheet
5835 functionality in its tables (*note The spreadsheet::). Org-mode
5836 checks for the availability of calc by looking for the function
5837 `calc-eval' which should be autoloaded in your setup if calc has
5838 been installed properly. As of Emacs 22, calc is part of the Emacs
5839 distribution. Another possibility for interaction between the two
5840 packages is using calc for embedded calculations. *Note Embedded
5841 Mode: (calc)Embedded Mode.
5843 `constants.el' by Carsten Dominik
5844 In a table formula (*note The spreadsheet::), it is possible to use
5845 names for natural constants or units. Instead of defining your own
5846 constants in the variable `org-table-formula-constants', install
5847 the `constants' package which defines a large number of constants
5848 and units, and lets you use unit prefixes like `M' for `Mega' etc.
5849 You will need version 2.0 of this package, available at
5850 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
5851 function `constants-get', which has to be autoloaded in your
5852 setup. See the installation instructions in the file
5855 `cdlatex.el' by Carsten Dominik
5856 Org-mode can make use of the cdlatex package to efficiently enter
5857 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
5859 `remember.el' by John Wiegley
5860 Org mode cooperates with remember, see *Note Remember::.
5861 `Remember.el' is not part of Emacs, find it on the web.
5863 `table.el' by Takaaki Ota
5864 Complex ASCII tables with automatic line wrapping, column- and
5865 row-spanning, and alignment can be created using the Emacs table
5866 package by Takaaki Ota (`http://sourceforge.net/projects/table',
5867 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
5868 such a table, Org-mode will call `table-recognize-table' and move
5869 the cursor into the table. Inside a table, the keymap of Org-mode
5870 is inactive. In order to execute Org-mode-related commands, leave
5874 Recognize `table.el' table. Works when the cursor is in a
5878 Insert a table.el table. If there is already a table at
5879 point, this command converts it between the table.el format
5880 and the Org-mode format. See the documentation string of the
5881 command `org-convert-table' for the restrictions under which
5883 `table.el' is part of Emacs 22.
5885 `footnote.el' by Steven L. Baur
5886 Org-mode recognizes numerical footnotes as provided by this package
5887 (*note Footnotes::).
5890 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
5892 12.7.2 Packages that lead to conflicts with Org-mode
5893 ----------------------------------------------------
5895 `allout.el' by Ken Manheimer
5896 Startup of Org-mode may fail with the error message
5897 `(wrong-type-argument keymapp nil)' when there is an outdated
5898 version `allout.el' on the load path, for example the version
5899 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
5900 will disappear. If for some reason you cannot do this, make sure
5901 that org.el is loaded _before_ `allout.el', for example by putting
5902 `(require 'org)' early enough into your `.emacs' file.
5904 `CUA.el' by Kim. F. Storm
5905 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
5906 by CUA-mode (as well as pc-select-mode and s-region-mode) to
5907 select and extend the region. If you want to use one of these
5908 packages along with Org-mode, configure the variable
5909 `org-CUA-compatible'. When set, Org-mode will move the following
5910 keybindings in org-mode files, and in the agenda buffer (but not
5911 during date selection).
5913 S-UP -> M-p S-DOWN -> M-n
5914 S-LEFT -> M-- S-RIGHT -> M-+
5916 Yes, these are unfortunately more difficult to remember. If you
5917 want to have other replacement keys, look at the variable
5918 `org-disputed-keys'.
5920 `windmove.el' by Hovav Shacham
5921 Also this package uses the `S-<cursor>' keys, so everything written
5922 in the paragraph above about CUA mode also applies here.
5924 `footnote.el' by Steven L. Baur
5925 Org-mode supports the syntax of the footnote package, but only the
5926 numerical footnote markers. Also, the default key for footnote
5927 commands, `C-c !' is already used by org-mode. You could use the
5928 variable `footnote-prefix' to switch footnotes commands to another
5929 key. Or, you could use `org-replace-disputed-keys' and
5930 `org-disputed-keys' to change the settings in Org-mode.
5934 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
5939 Here is a list of things that should work differently, but which I have
5940 found too hard to fix.
5942 * If a table field starts with a link, and if the corresponding table
5943 column is narrowed (*note Narrow columns::) to a width too small to
5944 display the link, the field would look entirely empty even though
5945 it is not. To prevent this, Org-mode throws an error. The
5946 work-around is to make the column wide enough to fit the link, or
5947 to add some text (at least 2 characters) before the link in the
5950 * Narrowing table columns does not work on XEmacs, because the
5951 `format' function does not transport text properties.
5953 * Text in an entry protected with the `QUOTE' keyword should not
5956 * When the application called by `C-c C-o' to open a file link fails
5957 (for example because the application does not exist or refuses to
5958 open the file), it does so silently. No error message is
5961 * Recalculating a table line applies the formulas from left to right.
5962 If a formula uses _calculated_ fields further down the row,
5963 multiple recalculation may be needed to get all fields consistent.
5964 You may use the command `org-table-iterate' (`C-u C-c *') to
5965 recalculate until convergence.
5967 * A single letter cannot be made bold, for example `*a*'.
5969 * The exporters work well, but could be made more efficient.
5972 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
5974 Appendix A Extensions, Hooks and Hacking
5975 ****************************************
5977 This appendix lists extensions for Org-mode written by other authors.
5978 It also covers some aspects where users can extend the functionality of
5983 * Extensions:: Existing 3rd-part extensions
5984 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
5985 * Dynamic blocks:: Automatically filled blocks
5986 * Special agenda views:: Customized views
5989 File: org, Node: Extensions, Next: Tables in arbitrary syntax, Prev: Extensions and Hacking, Up: Extensions and Hacking
5991 A.1 Third-party extensions for Org-mode
5992 =======================================
5994 The following extensions for Org-mode have been written by other people:
5996 `org-publish.el' by David O'Toole
5997 This package provides facilities for publishing related sets of
5998 Org-mode files together with linked files like images as webpages.
5999 It is highly configurable and can be used for other publishing
6000 purposes as well. As of Org-mode version 4.30, `org-publish.el'
6001 is part of the Org-mode distribution. It is not yet part of
6002 Emacs, however, a delay caused by the preparations for the 22.1
6003 release. In the mean time, `org-publish.el' can be downloaded
6004 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
6006 `org-mouse.el' by Piotr Zielinski
6007 This package implements extended mouse functionality for Org-mode.
6008 It allows you to cycle visibility and to edit the document
6009 structure with the mouse. Best of all, it provides a
6010 context-sensitive menu on <mouse-3> that changes depending on the
6011 context of a mouse-click. As of Org-mode version 4.53,
6012 `org-mouse.el' is part of the Org-mode distribution. It is not
6013 yet part of Emacs, however, a delay caused by the preparations for
6014 the 22.1 release. In the mean time, `org-mouse.el' can be
6015 downloaded from Piotr's site:
6016 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
6018 `org-blog.el' by David O'Toole
6019 A blogging plug-in for `org-publish.el'.
6020 `http://dto.freeshell.org/notebook/OrgMode.html'.
6022 `blorg.el' by Bastien Guerry
6023 Publish Org-mode files as blogs.
6024 `http://www.cognition.ens.fr/~guerry/blorg.html'.
6026 `org2rem.el' by Bastien Guerry
6027 Translates Org-mode files into something readable by Remind.
6028 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
6031 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
6033 A.2 Tables in arbitrary syntax
6034 ==============================
6036 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
6037 frequent feature request has been to make it work with native tables in
6038 specific languages, for example LaTeX. However, this is extremely hard
6039 to do in a general way, would lead to a customization nightmare, and
6040 would take away much of the simplicity of the Orgtbl-mode table editor.
6042 This appendix describes a different approach. We keep the
6043 Orgtbl-mode table in its native format (the source table), and use a
6044 custom function to translate the table to the correct syntax, and to
6045 install it in the right location (the target table). This puts the
6046 burden of writing conversion functions on the user, but it allows for a
6047 very flexible system.
6051 * Radio tables:: Sending and receiving
6052 * A LaTeX example:: Step by step, almost a tutorial
6053 * Translator functions:: Copy and modify
6056 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
6061 To define the location of the target table, you first need to create two
6062 lines that are comments in the current mode, but contain magic words for
6063 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
6064 between these lines, replacing whatever was there before. For example:
6066 /* BEGIN RECEIVE ORGTBL table_name */
6067 /* END RECEIVE ORGTBL table_name */
6069 Just above the source table, we put a special line that tells
6070 Orgtbl-mode how to translate this table and where to install it. For
6072 #+ORGTBL: SEND table_name translation_function arguments....
6074 `table_name' is the reference name for the table that is also used in
6075 the receiver lines. `translation_function' is the Lisp function that
6076 does the translation. Furthermore, the line can contain a list of
6077 arguments (alternating key and value) at the end. The arguments will be
6078 passed as a property list to the translation function for
6079 interpretation. A few standard parameters are already recognized and
6080 acted upon before the translation function is called:
6083 Skip the first N lines of the table. Hlines do count!
6085 `:skipcols (n1 n2 ...)'
6086 List of columns that should be skipped. If the table has a column
6087 with calculation marks, that column is automatically discarded as
6088 well. Please note that the translator function sees the table
6089 _after_ the removal of these columns, the function never knows
6090 that there have been additional columns.
6092 The one problem remaining is how to keep the source table in the buffer
6093 without disturbing the normal workings of the file, for example during
6094 compilation of a C file or processing of a LaTeX file. There are a
6095 number of different solutions:
6097 * The table could be placed in a block comment if that is supported
6098 by the language. For example, in C-mode you could wrap the table
6099 between `/*' and `*/' lines.
6101 * Sometimes it is possible to put the table after some kind of END
6102 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
6104 * You can just comment the table line by line whenever you want to
6105 process the file, and uncomment it whenever you need to edit the
6106 table. This only sounds tedious - the command `M-x
6107 orgtbl-toggle-comment' does make this comment-toggling very easy,
6108 in particular if you bind it to a key.
6111 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
6113 A.2.2 A LaTeX example
6114 ---------------------
6116 The best way to wrap the source table in LaTeX is to use the `comment'
6117 environment provided by `comment.sty'. It has to be activated by
6118 placing `\usepackage{comment}' into the document header. Orgtbl-mode
6119 can insert a radio table skeleton(1) with the command `M-x
6120 orgtbl-insert-radio-table'. You will be prompted for a table name,
6121 lets say we use `salesfigures'. You will then get the following
6124 % BEGIN RECEIVE ORGTBL salesfigures
6125 % END RECEIVE ORGTBL salesfigures
6127 #+ORGTBL: SEND salesfigures orgtbl-to-latex
6131 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
6132 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
6133 the receiver location with name `salesfigures'. You may now fill in
6134 the table, feel free to use the spreadsheet features(2):
6136 % BEGIN RECEIVE ORGTBL salesfigures
6137 % END RECEIVE ORGTBL salesfigures
6139 #+ORGTBL: SEND salesfigures orgtbl-to-latex
6140 | Month | Days | Nr sold | per day |
6141 |-------+------+---------+---------|
6142 | Jan | 23 | 55 | 2.4 |
6143 | Feb | 21 | 16 | 0.8 |
6144 | March | 22 | 278 | 12.6 |
6145 #+TBLFM: $4=$3/$2;%.1f
6146 % $ (optional extra dollar to keep font-lock happy, see footnote)
6149 When you are done, press `C-c C-c' in the table to get the converted
6150 table inserted between the two marker lines.
6152 Now lets assume you want to make the table header by hand, because
6153 you want to control how columns are aligned etc. In this case we make
6154 sure that the table translator does skip the first 2 lines of the source
6155 table, and tell the command to work as a splice, i.e. to not produce
6156 header and footer commands of the target table:
6158 \begin{tabular}{lrrr}
6159 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
6160 % BEGIN RECEIVE ORGTBL salesfigures
6161 % END RECEIVE ORGTBL salesfigures
6165 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
6166 | Month | Days | Nr sold | per day |
6167 |-------+------+---------+---------|
6168 | Jan | 23 | 55 | 2.4 |
6169 | Feb | 21 | 16 | 0.8 |
6170 | March | 22 | 278 | 12.6 |
6171 #+TBLFM: $4=$3/$2;%.1f
6174 The LaTeX translator function `orgtbl-to-latex' is already part of
6175 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
6176 marks horizontal lines with `\hline'. Furthermore, it interprets the
6177 following parameters:
6180 When set to t, return only table body lines, don't wrap them into a
6181 tabular environment. Default is nil.
6184 A format to be used to wrap each field, should contain `%s' for the
6185 original field value. For example, to wrap each field value in
6186 dollars, you could use `:fmt "$%s$"'. This may also be a property
6187 list with column numbers and formats. for example `:fmt (2 "$%s$"
6191 Use this format to print numbers with exponentials. The format
6192 should have `%s' twice for inserting mantissa and exponent, for
6193 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
6194 may also be a property list with column numbers and formats, for
6195 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
6196 After `efmt' has been applied to a value, `fmt' will also be
6199 ---------- Footnotes ----------
6201 (1) By default this works only for LaTeX, HTML, and TeXInfo.
6202 Configure the variable `orgtbl-radio-tables' to install templates for
6205 (2) If the `#+TBLFM' line contains an odd number of dollar
6206 characters, this may cause problems with font-lock in latex-mode. As
6207 shown in the example you can fix this by adding an extra line inside the
6208 `comment' environment that is used to balance the dollar expressions.
6209 If you are using AUCTeX with the font-latex library, a much better
6210 solution is to add the `comment' environment to the variable
6211 `LaTeX-verbatim-environments'.
6214 File: org, Node: Translator functions, Prev: A LaTeX example, Up: Tables in arbitrary syntax
6216 A.2.3 Translator functions
6217 --------------------------
6219 Orgtbl-mode has several translator functions built-in:
6220 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. Except
6221 for `orgtbl-to-html'(1), these all use a generic translator,
6222 `orgtbl-to-generic'. For example, `orgtbl-to-latex' itself is a very
6223 short function that computes the column definitions for the `tabular'
6224 environment, defines a few field and line separators and then hands
6225 over to the generic translator. Here is the entire code:
6227 (defun orgtbl-to-latex (table params)
6228 "Convert the orgtbl-mode TABLE to LaTeX."
6229 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
6230 org-table-last-alignment ""))
6233 :tstart (concat "\\begin{tabular}{" alignment "}")
6234 :tend "\\end{tabular}"
6235 :lstart "" :lend " \\\\" :sep " & "
6236 :efmt "%s\\,(%s)" :hline "\\hline")))
6237 (orgtbl-to-generic table (org-combine-plists params2 params))))
6239 As you can see, the properties passed into the function (variable
6240 PARAMS) are combined with the ones newly defined in the function
6241 (variable PARAMS2). The ones passed into the function (i.e. the ones
6242 set by the `ORGTBL SEND' line) take precedence. So if you would like
6243 to use the LaTeX translator, but wanted the line endings to be
6244 `\\[2mm]' instead of the default `\\', you could just overrule the
6247 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
6249 For a new language, you can either write your own converter function
6250 in analogy with the LaTeX translator, or you can use the generic
6251 function directly. For example, if you have a language where a table
6252 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
6253 started with `!BL!', ended with `!EL!' and where the field separator is
6254 a TAB, you could call the generic translator like this (on a single
6257 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
6258 :lstart "!BL! " :lend " !EL!" :sep "\t"
6260 Please check the documentation string of the function
6261 `orgtbl-to-generic' for a full list of parameters understood by that
6262 function and remember that you can pass each of them into
6263 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
6264 the generic function.
6266 Of course you can also write a completely new function doing
6267 complicated things the generic translator cannot do. A translator
6268 function takes two arguments. The first argument is the table, a list
6269 of lines, each line either the symbol `hline' or a list of fields. The
6270 second argument is the property list containing all parameters
6271 specified in the `#+ORGTBL: SEND' line. The function must return a
6272 single string containing the formatted table. If you write a generally
6273 useful translator, please post it on `emacs-orgmode@gnu.org' so that
6274 others can benefit from your work.
6276 ---------- Footnotes ----------
6278 (1) The HTML translator uses the same code that produces tables
6282 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
6287 Org-mode documents can contain _dynamic blocks_. These are specially
6288 marked regions that are updated by some user-written function. A good
6289 example for such a block is the clock table inserted by the command
6290 `C-c C-x C-r' (*note Clocking work time::).
6292 Dynamic block are enclosed by a BEGIN-END structure that assigns a
6293 name to the block and can also specify parameters for the function
6294 producing the content of the block.
6296 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
6300 Dynamic blocks are updated with the following commands
6303 Update dynamic block at point.
6306 Update all dynamic blocks in the current file.
6308 Updating a dynamic block means to remove all the text between BEGIN
6309 and END, parse the BEGIN line for parameters and then call the specific
6310 writer function for this block to insert the new content. For a block
6311 with name `myblock', the writer function is `org-dblock-write:myblock'
6312 with as only parameter a property list with the parameters given in the
6313 begin line. Here is a trivial example of a block that keeps track of
6314 when the block update function was last run:
6316 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
6320 The corresponding block writer function could look like this:
6322 (defun org-dblock-write:block-update-time (params)
6323 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
6324 (insert "Last block update at: "
6325 (format-time-string fmt (current-time)))))
6327 If you want to make sure that all dynamic blocks are always
6328 up-to-date, you could add the function `org-update-all-dblocks' to a
6329 hook, for example `before-save-hook'. `org-update-all-dblocks' is
6330 written in a way that is does nothing in buffers that are not in
6334 File: org, Node: Special agenda views, Prev: Dynamic blocks, Up: Extensions and Hacking
6336 A.4 Special Agenda Views
6337 ========================
6339 Org-mode provides a special hook that can be used to narrow down the
6340 selection made by any of the agenda views. You may specify a function
6341 that is used at each match to verify if the match should indeed be part
6342 of the agenda view, and if not, how much should be skipped.
6344 Let's say you want to produce a list of projects that contain a
6345 WAITING tag anywhere in the project tree. Let's further assume that
6346 you have marked all tree headings that define a project with the todo
6347 keyword PROJECT. In this case you would run a todo search for the
6348 keyword PROJECT, but skip the match unless there is a WAITING tag
6349 anywhere in the subtree belonging to the project line.
6351 To achieve this, you must write a function that searches the subtree
6352 for the tag. If the tag is found, the function must return `nil' to
6353 indicate that this match should not be skipped. If there is no such
6354 tag, return the location of the end of the subtree, to indicate that
6355 search should continue from there.
6357 (defun my-skip-unless-waiting ()
6358 "Skip trees that are not waiting"
6359 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
6360 (if (re-search-forward ":WAITING:" subtree-end t)
6361 nil ; tag found, do not skip
6362 subtree-end))) ; tag not found, continue after end of subtree
6364 Furthermore you must write a command that uses `let' to temporarily
6365 put this function into the variable `org-agenda-skip-function', sets
6366 the header string for the agenda buffer, and calls the todo-list
6367 generator while asking for the specific TODO keyword PROJECT. The
6368 function must also accept one argument MATCH, but it can choose to
6369 ignore it(1) (as we do in the example below). Here is the example:
6371 (defun my-org-waiting-projects (&optional match)
6372 "Produce a list of projects that contain a WAITING tag.
6373 MATCH is being ignored."
6375 (let ((org-agenda-skip-function 'my-skip-unless-waiting)
6376 (org-agenda-overriding-header "Projects waiting for something: "))
6378 (org-todo-list "PROJECT")))
6380 ---------- Footnotes ----------
6382 (1) MATCH must be present in case you want to define a custom
6383 command for producing this special list. Custom commands always supply
6384 the MATCH argument, but it can be empty if you do not specify it while
6385 defining the command(*note Custom agenda views::).
6388 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
6390 Appendix B History and Acknowledgments
6391 **************************************
6393 Org-mode was borne in 2003, out of frustration over the user interface
6394 of the Emacs outline-mode. I was trying to organize my notes and
6395 projects, and using Emacs seemed to be the natural way to go. However,
6396 having to remember eleven different commands with two or three keys per
6397 command, only to hide and unhide parts of the outline tree, that seemed
6398 entirely unacceptable to me. Also, when using outlines to take notes, I
6399 constantly want to restructure the tree, organizing it parallel to my
6400 thoughts and plans. _Visibility cycling_ and _structure editing_ were
6401 originally implemented in the package `outline-magic.el', but quickly
6402 moved to the more general `org.el'. As this environment became
6403 comfortable for project planning, the next step was adding _TODO
6404 entries_, basic _time stamps_, and _table support_. These areas
6405 highlight the two main goals that Org-mode still has today: To create a
6406 new, outline-based, plain text mode with innovative and intuitive
6407 editing features, and to incorporate project planning functionality
6408 directly into a notes file.
6410 Since the first release, hundreds of emails to me or on
6411 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
6412 feedback, new ideas, and sometimes patches and add-on code. Many
6413 thanks to everyone who has helped to improve this package. I am trying
6414 to keep here a list of the people who had significant influence in
6415 shaping one or more aspects of Org-mode. The list may not be complete,
6416 if I have forgotten someone, please accept my apologies and let me know.
6418 * Thomas Baumann contributed the code for links to the MH-E email
6421 * Alex Bochannek provided a patch for rounding time stamps.
6423 * Charles Cave's suggestion sparked the implementation of templates
6426 * Pavel Chalmoviansky influenced the agenda treatment of items with
6429 * Gregory Chernov patched support for lisp forms into table
6430 calculations and improved XEmacs compatibility, in particular by
6431 porting `nouline.el' to XEmacs.
6433 * Sacha Chua suggested to copy some linking code from Planner.
6435 * Eddward DeVilla proposed and tested checkbox statistics.
6437 * Kees Dullemond used to edit projects lists directly in HTML and so
6438 inspired some of the early development, including HTML export. He
6439 also asked for a way to narrow wide table columns.
6441 * Christian Egli converted the documentation into TeXInfo format,
6442 patched CSS formatting into the HTML exporter, and inspired the
6445 * David Emery provided a patch for custom CSS support in exported
6448 * Nic Ferrier contributed mailcap and XOXO support.
6450 * John Foerch figured out how to make incremental search show context
6451 around a match in a hidden outline tree.
6453 * Niels Giessen had the idea to automatically archive DONE trees.
6455 * Bastien Guerry provided extensive feedback and some patches, and
6456 translated David O'Toole's tutorial into French.
6458 * Kai Grossjohann pointed out key-binding conflicts with other
6461 * Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
6462 provided frequent feedback and some patches.
6464 * Jason F. McBrayer suggested agenda export to CSV format.
6466 * Dmitri Minaev sent a patch to set priority limits on a per-file
6469 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
6472 * Rick Moynihan proposed to allow multiple TODO sequences in a file.
6474 * Todd Neal provided patches for links to Info files and elisp forms.
6476 * Tim O'Callaghan suggested in-file links, search options for general
6477 file links, and TAGS.
6479 * Takeshi Okano translated the manual and David O'Toole's tutorial
6482 * Oliver Oppitz suggested multi-state TODO items.
6484 * Scott Otterson sparked the introduction of descriptive text for
6485 links, among other things.
6487 * Pete Phillips helped during the development of the TAGS feature,
6488 and provided frequent feedback.
6490 * T.V. Raman reported bugs and suggested improvements.
6492 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
6495 * Kevin Rogers contributed code to access VM files on remote hosts.
6497 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
6498 conflict with `allout.el'.
6500 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
6502 * Philip Rooke created the Org-mode reference card and provided lots
6505 * Christian Schlauer proposed angular brackets around links, among
6508 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
6509 `organizer-mode.el'.
6511 * Daniel Sinder came up with the idea of internal archiving by
6514 * Dale Smith proposed link abbreviations.
6516 * David O'Toole wrote `org-publish.el' and drafted the manual
6517 chapter about publishing.
6519 * Ju"rgen Vollmer contributed code generating the table of contents
6522 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
6524 * David Wainberg suggested archiving, and improvements to the linking
6527 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
6528 development of Org-mode was fully independent, and both systems are
6529 really different beasts in their basic ideas and implementation
6530 details. I later looked at John's code, however, and learned from
6531 his implementation of (i) links where the link itself is hidden
6532 and only a description is shown, and (ii) popping up a calendar to
6535 * Carsten Wimmer suggested some changes and helped fix a bug in
6538 * Roland Winkler requested additional keybindings to make Org-mode
6541 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
6542 contributed various ideas and code snippets.
6545 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
6553 * abbreviation, links: Link abbreviations. (line 6)
6554 * acknowledgments: History and Acknowledgments.
6556 * action, for publishing: Publishing action. (line 6)
6557 * activation: Activation. (line 6)
6558 * active region <1>: Export commands. (line 6)
6559 * active region <2>: ASCII export. (line 9)
6560 * active region <3>: Built-in table editor.
6562 * active region: Structure editing. (line 64)
6563 * agenda: Weekly/Daily agenda. (line 6)
6564 * agenda dispatcher: Agenda dispatcher. (line 6)
6565 * agenda files: Agenda files. (line 6)
6566 * agenda files, removing buffers: Agenda commands. (line 239)
6567 * agenda views: Agenda views. (line 6)
6568 * agenda views, custom: Custom agenda views. (line 6)
6569 * agenda views, exporting <1>: Exporting Agenda Views.
6571 * agenda views, exporting: Agenda commands. (line 228)
6572 * agenda views, user-defined: Special agenda views.
6574 * agenda, pipe: Extracting Agenda Information for other programs.
6576 * agenda, with block views: Block agenda. (line 6)
6577 * align, STARTUP keyword: In-buffer settings. (line 29)
6578 * allout.el: Conflicts. (line 6)
6579 * angular brackets, around links: External links. (line 43)
6580 * archive locations: Moving subtrees. (line 21)
6581 * archiving: Archiving. (line 6)
6582 * ASCII export: ASCII export. (line 6)
6583 * author: Feedback. (line 6)
6584 * autoload: Activation. (line 6)
6585 * backtrace of an error: Feedback. (line 27)
6586 * BBDB links: External links. (line 6)
6587 * block agenda: Block agenda. (line 6)
6588 * blorg.el: Extensions. (line 32)
6589 * bold text: Enhancing text. (line 15)
6590 * Boolean logic, for tag searches: Tag searches. (line 23)
6591 * bug reports: Feedback. (line 6)
6592 * bugs: Bugs. (line 6)
6593 * C-c C-c, overview: The very busy C-c C-c key.
6595 * calc package: The spreadsheet. (line 6)
6596 * calc.el: Cooperation. (line 6)
6597 * calculations, in tables <1>: The spreadsheet. (line 6)
6598 * calculations, in tables: Built-in table editor.
6600 * calendar commands, from agenda: Agenda commands. (line 191)
6601 * calendar integration: Weekly/Daily agenda. (line 24)
6602 * calendar, for selecting date: The date/time prompt.
6604 * category: Categories. (line 6)
6605 * CDLaTeX: CDLaTeX mode. (line 6)
6606 * cdlatex.el: Cooperation. (line 29)
6607 * checkbox statistics: Checkboxes. (line 23)
6608 * checkboxes: Checkboxes. (line 6)
6609 * children, subtree visibility state: Visibility cycling. (line 10)
6610 * clean outline view: Clean view. (line 6)
6611 * column formula: Column formulas. (line 6)
6612 * commands, in agenda buffer: Agenda commands. (line 6)
6613 * comment lines: Comment lines. (line 6)
6614 * completion, of dictionary words: Completion. (line 6)
6615 * completion, of file names: Handling links. (line 43)
6616 * completion, of link abbreviations: Completion. (line 6)
6617 * completion, of links: Handling links. (line 25)
6618 * completion, of option keywords <1>: Completion. (line 6)
6619 * completion, of option keywords <2>: Export options. (line 6)
6620 * completion, of option keywords: Per file keywords. (line 23)
6621 * completion, of tags <1>: Completion. (line 6)
6622 * completion, of tags: Setting tags. (line 11)
6623 * completion, of TeX symbols: Completion. (line 6)
6624 * completion, of TODO keywords <1>: Completion. (line 6)
6625 * completion, of TODO keywords: Workflow states. (line 15)
6626 * constants, in calculations: References. (line 82)
6627 * constants.el: Cooperation. (line 14)
6628 * constcgs, STARTUP keyword: In-buffer settings. (line 54)
6629 * constSI, STARTUP keyword: In-buffer settings. (line 54)
6630 * content, STARTUP keyword: In-buffer settings. (line 22)
6631 * contents, global visibility state: Visibility cycling. (line 22)
6632 * copying, of subtrees: Structure editing. (line 6)
6633 * creating timestamps: Creating timestamps. (line 6)
6634 * CUA.el: Conflicts. (line 15)
6635 * custom agenda views: Custom agenda views. (line 6)
6636 * custom date/time format: Custom time format. (line 6)
6637 * custom search strings: Custom searches. (line 6)
6638 * customization: Customization. (line 6)
6639 * customtime, STARTUP keyword: In-buffer settings. (line 51)
6640 * cutting, of subtrees: Structure editing. (line 6)
6641 * cycling, of TODO states: TODO basics. (line 13)
6642 * cycling, visibility: Visibility cycling. (line 6)
6643 * daily agenda: Weekly/Daily agenda. (line 6)
6644 * date format, custom: Custom time format. (line 6)
6645 * date range: Time stamps. (line 41)
6646 * date stamps <1>: Time stamps. (line 6)
6647 * date stamps: Timestamps. (line 6)
6648 * date, reading in minibuffer: The date/time prompt.
6650 * DEADLINE keyword: Deadlines and scheduling.
6652 * deadlines: Time stamps. (line 6)
6653 * debugging, of table formulas: Editing and debugging formulas.
6655 * demotion, of subtrees: Structure editing. (line 6)
6656 * diary entries, creating from agenda: Agenda commands. (line 196)
6657 * diary integration: Weekly/Daily agenda. (line 24)
6658 * dictionary word completion: Completion. (line 6)
6659 * directories, for publishing: Sources and destinations.
6661 * dispatching agenda commands: Agenda dispatcher. (line 6)
6662 * display changing, in agenda: Agenda commands. (line 65)
6663 * document structure: Document structure. (line 6)
6664 * DONE, final TODO keyword: Per file keywords. (line 26)
6665 * dynamic blocks: Dynamic blocks. (line 6)
6666 * editing tables: Tables. (line 6)
6667 * editing, of table formulas: Editing and debugging formulas.
6669 * elisp links: External links. (line 6)
6670 * emphasized text: Export options. (line 25)
6671 * enhancing text: Enhancing text. (line 6)
6672 * evaluate time range: Creating timestamps. (line 48)
6673 * even, STARTUP keyword: In-buffer settings. (line 44)
6674 * exporting: Exporting. (line 6)
6675 * exporting agenda views <1>: Exporting Agenda Views.
6677 * exporting agenda views: Agenda commands. (line 228)
6678 * exporting, not: Comment lines. (line 6)
6679 * extended TODO keywords: TODO extensions. (line 6)
6680 * extension, third-party: Extensions. (line 6)
6681 * external archiving: Moving subtrees. (line 6)
6682 * external links: External links. (line 6)
6683 * external links, in HTML export: Links. (line 6)
6684 * FAQ: Summary. (line 53)
6685 * feedback: Feedback. (line 6)
6686 * field formula: Field formulas. (line 6)
6687 * field references: References. (line 15)
6688 * file links: External links. (line 6)
6689 * file links, searching: Search options. (line 6)
6690 * file name completion: Handling links. (line 43)
6691 * files for agenda: Agenda files. (line 6)
6692 * files, adding to agenda list: Agenda files. (line 12)
6693 * files, selecting for publishing: Selecting files. (line 6)
6694 * fixed width: Enhancing text. (line 28)
6695 * fixed-width sections: Export options. (line 25)
6696 * folded, subtree visibility state: Visibility cycling. (line 10)
6697 * folding, sparse trees: Sparse trees. (line 6)
6698 * following links: Handling links. (line 58)
6699 * footnote.el <1>: Conflicts. (line 35)
6700 * footnote.el <2>: Cooperation. (line 56)
6701 * footnote.el: Footnotes. (line 6)
6702 * footnotes: Footnotes. (line 6)
6703 * format specifier: Formula syntax for Calc.
6705 * format, of links: Link format. (line 6)
6706 * formula debugging: Editing and debugging formulas.
6708 * formula editing: Editing and debugging formulas.
6710 * formula syntax, Calc: Formula syntax for Calc.
6712 * formula, for individual table field: Field formulas. (line 6)
6713 * formula, for table column: Column formulas. (line 6)
6714 * formula, in tables: Built-in table editor.
6716 * global cycling: Visibility cycling. (line 22)
6717 * global keybindings: Activation. (line 6)
6718 * global TODO list: Global TODO list. (line 6)
6719 * global visibility states: Visibility cycling. (line 22)
6720 * GNUS links: External links. (line 6)
6721 * grouping columns in tables: Column groups. (line 6)
6722 * hand-formatted lists: Enhancing text. (line 11)
6723 * headline levels: Export options. (line 25)
6724 * headline levels, for exporting <1>: Export commands. (line 34)
6725 * headline levels, for exporting: ASCII export. (line 18)
6726 * headline navigation: Motion. (line 6)
6727 * headline tagging: Tags. (line 6)
6728 * headline, promotion and demotion: Structure editing. (line 6)
6729 * headlines: Headlines. (line 6)
6730 * hide text: Visibility cycling. (line 6)
6731 * hidestars, STARTUP keyword: In-buffer settings. (line 44)
6732 * hiding leading stars: Clean view. (line 6)
6733 * history: History and Acknowledgments.
6735 * horizontal rules, in exported files: Enhancing text. (line 18)
6736 * HTML export: HTML export. (line 6)
6737 * HTML, and orgtbl-mode: Translator functions.
6739 * hyperlinks: Hyperlinks. (line 6)
6740 * iCalendar export: iCalendar export. (line 6)
6741 * images, inline in HTML: Images. (line 6)
6742 * in-buffer settings: In-buffer settings. (line 6)
6743 * inactive timestamp: Time stamps. (line 50)
6744 * index, of published pages: Project page index. (line 6)
6745 * Info links: External links. (line 6)
6746 * inheritance, of tags: Tag inheritance. (line 6)
6747 * inlining images in HTML: Images. (line 6)
6748 * inserting links: Handling links. (line 25)
6749 * installation: Installation. (line 6)
6750 * internal archiving: ARCHIVE tag. (line 6)
6751 * internal links: Internal links. (line 6)
6752 * internal links, in HTML export: Links. (line 6)
6753 * introduction: Introduction. (line 6)
6754 * italic text: Enhancing text. (line 15)
6755 * jumping, to headlines: Motion. (line 6)
6756 * keybindings, global: Activation. (line 6)
6757 * keyword options: Per file keywords. (line 6)
6758 * LaTeX fragments <1>: Export options. (line 25)
6759 * LaTeX fragments: LaTeX fragments. (line 6)
6760 * LaTeX fragments, export: Enhancing text. (line 21)
6761 * LaTeX fragments, preview: Processing LaTeX fragments.
6763 * LaTeX interpretation: Embedded LaTeX. (line 6)
6764 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
6765 * level, require for tags match: Tag searches. (line 68)
6766 * linebreak preservation: Export options. (line 25)
6767 * linebreak, forced: Enhancing text. (line 35)
6768 * link abbreviations: Link abbreviations. (line 6)
6769 * link abbreviations, completion of: Completion. (line 6)
6770 * link completion: Handling links. (line 25)
6771 * link format: Link format. (line 6)
6772 * links, external: External links. (line 6)
6773 * links, finding next/previous: Handling links. (line 91)
6774 * links, handling: Handling links. (line 6)
6775 * links, in HTML export: Links. (line 6)
6776 * links, internal: Internal links. (line 6)
6777 * links, publishing: Publishing links. (line 6)
6778 * links, radio targets: Radio targets. (line 6)
6779 * links, returning to: Handling links. (line 85)
6780 * Lisp forms, as table formulas: Formula syntax for Lisp.
6782 * lists, hand-formatted: Enhancing text. (line 11)
6783 * lists, ordered: Plain lists. (line 6)
6784 * lists, plain: Plain lists. (line 6)
6785 * logdone, STARTUP keyword: In-buffer settings. (line 33)
6786 * logging, of progress: Progress logging. (line 6)
6787 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
6788 * lognotedone, STARTUP keyword: In-buffer settings. (line 33)
6789 * lognotestate, STARTUP keyword: In-buffer settings. (line 33)
6790 * logrepeat, STARTUP keyword: In-buffer settings. (line 33)
6791 * maintainer: Feedback. (line 6)
6792 * mark ring: Handling links. (line 81)
6793 * marking characters, tables: Advanced features. (line 40)
6794 * matching, of tags: Matching headline tags.
6796 * matching, tags: Tags. (line 6)
6797 * math symbols: Math symbols. (line 6)
6798 * MH-E links: External links. (line 6)
6799 * minor mode for tables: orgtbl-mode. (line 6)
6800 * mode, for calc: Formula syntax for Calc.
6802 * motion commands in agenda: Agenda commands. (line 19)
6803 * motion, between headlines: Motion. (line 6)
6804 * name, of column or field: References. (line 82)
6805 * named references: References. (line 82)
6806 * names as TODO keywords: TODO types. (line 6)
6807 * narrow columns in tables: Narrow columns. (line 6)
6808 * noalign, STARTUP keyword: In-buffer settings. (line 29)
6809 * nologging, STARTUP keyword: In-buffer settings. (line 33)
6810 * nologrepeat, STARTUP keyword: In-buffer settings. (line 33)
6811 * occur, command: Sparse trees. (line 6)
6812 * odd, STARTUP keyword: In-buffer settings. (line 44)
6813 * option keyword completion: Completion. (line 6)
6814 * options, for custom agenda views: Setting Options. (line 6)
6815 * options, for customization: Customization. (line 6)
6816 * options, for export: Export options. (line 6)
6817 * options, for publishing: Publishing options. (line 6)
6818 * ordered lists: Plain lists. (line 6)
6819 * org-agenda, command: Weekly/Daily agenda. (line 9)
6820 * org-blog.el: Extensions. (line 28)
6821 * org-mode, turning on: Activation. (line 22)
6822 * org-mouse.el: Extensions. (line 16)
6823 * org-publish-project-alist: Project alist. (line 6)
6824 * org-publish.el: Extensions. (line 8)
6825 * org2rem.el: Extensions. (line 36)
6826 * orgtbl-mode <1>: Tables in arbitrary syntax.
6828 * orgtbl-mode: orgtbl-mode. (line 6)
6829 * outline tree: Headlines. (line 6)
6830 * outline-mode: Outlines. (line 6)
6831 * outlines: Outlines. (line 6)
6832 * overview, global visibility state: Visibility cycling. (line 22)
6833 * overview, STARTUP keyword: In-buffer settings. (line 22)
6834 * packages, interaction with other: Interaction. (line 6)
6835 * pasting, of subtrees: Structure editing. (line 6)
6836 * per file keywords: Per file keywords. (line 6)
6837 * plain lists: Plain lists. (line 6)
6838 * plain text external links: External links. (line 43)
6839 * presentation, of agenda items: Presentation and sorting.
6841 * printing sparse trees: Sparse trees. (line 41)
6842 * priorities: Priorities. (line 6)
6843 * priorities, of agenda items: Sorting of agenda items.
6845 * progress logging: Progress logging. (line 6)
6846 * projects, for publishing: Project alist. (line 6)
6847 * promotion, of subtrees: Structure editing. (line 6)
6848 * publishing: Publishing. (line 6)
6849 * quoted HTML tags: Export options. (line 25)
6850 * radio tables: Radio tables. (line 6)
6851 * radio targets: Radio targets. (line 6)
6852 * range references: References. (line 60)
6853 * ranges, time: Time stamps. (line 6)
6854 * recomputing table fields: Updating the table. (line 6)
6855 * references: References. (line 6)
6856 * references, named: References. (line 82)
6857 * references, to fields: References. (line 15)
6858 * references, to ranges: References. (line 60)
6859 * region, active <1>: Export commands. (line 6)
6860 * region, active <2>: ASCII export. (line 9)
6861 * region, active <3>: Built-in table editor.
6863 * region, active: Structure editing. (line 64)
6864 * regular expressions, with tags search: Tag searches. (line 63)
6865 * remember.el <1>: Cooperation. (line 33)
6866 * remember.el: Remember. (line 6)
6867 * remote editing, from agenda: Agenda commands. (line 106)
6868 * remote editing, undo: Agenda commands. (line 107)
6869 * richer text: Enhancing text. (line 6)
6870 * RMAIL links: External links. (line 6)
6871 * SCHEDULED keyword: Deadlines and scheduling.
6873 * scheduling: Time stamps. (line 6)
6874 * Scripts, for agenda processing: Extracting Agenda Information for other programs.
6876 * search option in file links: Search options. (line 6)
6877 * search strings, custom: Custom searches. (line 6)
6878 * searching for tags: Tag searches. (line 6)
6879 * section-numbers: Export options. (line 25)
6880 * setting tags: Setting tags. (line 6)
6881 * SHELL links: External links. (line 6)
6882 * show all, command: Visibility cycling. (line 33)
6883 * show all, global visibility state: Visibility cycling. (line 22)
6884 * show hidden text: Visibility cycling. (line 6)
6885 * showall, STARTUP keyword: In-buffer settings. (line 22)
6886 * showstars, STARTUP keyword: In-buffer settings. (line 44)
6887 * sorting, of agenda items: Sorting of agenda items.
6889 * sparse tree, for deadlines: Inserting deadline/schedule.
6891 * sparse tree, for TODO: TODO basics. (line 26)
6892 * sparse tree, tag based: Tags. (line 6)
6893 * sparse trees: Sparse trees. (line 6)
6894 * special keywords: In-buffer settings. (line 6)
6895 * spreadsheet capabilities: The spreadsheet. (line 6)
6896 * statistics, for checkboxes: Checkboxes. (line 23)
6897 * storing links: Handling links. (line 9)
6898 * structure editing: Structure editing. (line 6)
6899 * structure of document: Document structure. (line 6)
6900 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
6901 * sublevels, inclusion into todo list: Global TODO list. (line 34)
6902 * subscript: Subscripts and Superscripts.
6904 * subtree cycling: Visibility cycling. (line 10)
6905 * subtree visibility states: Visibility cycling. (line 10)
6906 * subtree, cut and paste: Structure editing. (line 6)
6907 * subtree, subtree visibility state: Visibility cycling. (line 10)
6908 * subtrees, cut and paste: Structure editing. (line 6)
6909 * summary: Summary. (line 6)
6910 * superscript: Subscripts and Superscripts.
6912 * syntax, of formulas: Formula syntax for Calc.
6914 * table editor, built-in: Built-in table editor.
6916 * table editor, table.el: Cooperation. (line 37)
6917 * table of contents: Export options. (line 25)
6918 * table.el: Cooperation. (line 34)
6919 * tables <1>: Export options. (line 25)
6920 * tables: Tables. (line 6)
6921 * tables, export: Enhancing text. (line 24)
6922 * tables, in other modes: Tables in arbitrary syntax.
6924 * tag completion: Completion. (line 6)
6925 * tag searches: Tag searches. (line 6)
6926 * tags: Tags. (line 6)
6927 * tags view: Matching headline tags.
6929 * tags, setting: Setting tags. (line 6)
6930 * targets, for links: Internal links. (line 6)
6931 * targets, radio: Radio targets. (line 6)
6932 * tasks, breaking down: Breaking down tasks. (line 6)
6933 * templates, for remember: Remember templates. (line 6)
6934 * TeX interpretation: Embedded LaTeX. (line 6)
6935 * TeX macros <1>: Export options. (line 25)
6936 * TeX macros: Math symbols. (line 6)
6937 * TeX macros, export: Enhancing text. (line 21)
6938 * TeX symbol completion: Completion. (line 6)
6939 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
6940 * thanks: History and Acknowledgments.
6942 * time format, custom: Custom time format. (line 6)
6943 * time grid: Time-of-day specifications.
6945 * time stamps <1>: Time stamps. (line 6)
6946 * time stamps: Timestamps. (line 6)
6947 * time, reading in minibuffer: The date/time prompt.
6949 * time-of-day specification: Time-of-day specifications.
6951 * time-sorted view: Timeline. (line 6)
6952 * timeline, single file: Timeline. (line 6)
6953 * timerange: Time stamps. (line 41)
6954 * timestamp: Time stamps. (line 14)
6955 * timestamp, inactive: Time stamps. (line 50)
6956 * timestamp, with repeater interval: Time stamps. (line 25)
6957 * timestamps, creating: Creating timestamps. (line 6)
6958 * TODO items: TODO items. (line 6)
6959 * TODO keyword matching: Global TODO list. (line 17)
6960 * TODO keyword matching, with tags search: Tag searches. (line 40)
6961 * todo keyword sets: Multiple sets in one file.
6963 * TODO keywords completion: Completion. (line 6)
6964 * TODO list, global: Global TODO list. (line 6)
6965 * TODO types: TODO types. (line 6)
6966 * TODO workflow: Workflow states. (line 6)
6967 * transient-mark-mode <1>: Export commands. (line 6)
6968 * transient-mark-mode <2>: ASCII export. (line 9)
6969 * transient-mark-mode <3>: Built-in table editor.
6971 * transient-mark-mode: Structure editing. (line 64)
6972 * translator function: Translator functions.
6974 * trees, sparse: Sparse trees. (line 6)
6975 * trees, visibility: Visibility cycling. (line 6)
6976 * tty keybindings: TTY keys. (line 6)
6977 * types as TODO keywords: TODO types. (line 6)
6978 * underlined text: Enhancing text. (line 15)
6979 * undoing remote-editing events: Agenda commands. (line 107)
6980 * updating, table: Updating the table. (line 6)
6981 * URL links: External links. (line 6)
6982 * USENET links: External links. (line 6)
6983 * variables, for customization: Customization. (line 6)
6984 * vectors, in table calculations: Formula syntax for Calc.
6986 * visibility cycling: Visibility cycling. (line 6)
6987 * visible text, printing: Sparse trees. (line 41)
6988 * VM links: External links. (line 6)
6989 * WANDERLUST links: External links. (line 6)
6990 * weekly agenda: Weekly/Daily agenda. (line 6)
6991 * windmove.el: Conflicts. (line 32)
6992 * workflow states as TODO keywords: Workflow states. (line 6)
6993 * XEmacs: Installation. (line 6)
6994 * XOXO export: XOXO export. (line 6)
6997 File: org, Node: Key Index, Prev: Index, Up: Top
7005 * $: Agenda commands. (line 121)
7006 * ': CDLaTeX mode. (line 43)
7007 * +: Agenda commands. (line 143)
7008 * ,: Agenda commands. (line 135)
7009 * -: Agenda commands. (line 149)
7010 * .: Agenda commands. (line 98)
7011 * :: Agenda commands. (line 129)
7012 * <: The date/time prompt.
7014 * <left>: Agenda commands. (line 95)
7015 * <RET> <1>: Agenda commands. (line 39)
7016 * <RET> <2>: The date/time prompt.
7018 * <RET> <3>: Setting tags. (line 76)
7019 * <RET>: Built-in table editor.
7021 * <right>: Agenda commands. (line 90)
7022 * <SPC> <1>: Agenda commands. (line 28)
7023 * <SPC>: Setting tags. (line 73)
7024 * <TAB> <1>: CDLaTeX mode. (line 23)
7025 * <TAB> <2>: Agenda commands. (line 33)
7026 * <TAB> <3>: Setting tags. (line 68)
7027 * <TAB> <4>: Editing and debugging formulas.
7029 * <TAB> <5>: Built-in table editor.
7031 * <TAB> <6>: Plain lists. (line 41)
7032 * <TAB>: Visibility cycling. (line 10)
7033 * > <1>: Agenda commands. (line 171)
7034 * >: The date/time prompt.
7036 * ^: CDLaTeX mode. (line 33)
7037 * _: CDLaTeX mode. (line 33)
7038 * `: CDLaTeX mode. (line 39)
7039 * a: Agenda commands. (line 132)
7040 * b: Agenda commands. (line 49)
7041 * C: Agenda commands. (line 211)
7042 * c: Agenda commands. (line 191)
7043 * C-#: Advanced features. (line 9)
7044 * C-': Agenda files. (line 18)
7045 * C-,: Agenda files. (line 18)
7046 * C-_: Agenda commands. (line 107)
7047 * C-a a L: Timeline. (line 10)
7048 * C-c ! <1>: Footnotes. (line 14)
7049 * C-c !: Creating timestamps. (line 19)
7050 * C-c #: Checkboxes. (line 56)
7051 * C-c %: Handling links. (line 81)
7052 * C-c &: Handling links. (line 85)
7053 * C-c ': Editing and debugging formulas.
7055 * C-c *: Updating the table. (line 13)
7056 * C-c +: Built-in table editor.
7058 * C-c ,: Priorities. (line 18)
7059 * C-c -: Built-in table editor.
7061 * C-c .: Creating timestamps. (line 10)
7062 * C-c /: Sparse trees. (line 15)
7063 * C-c :: Enhancing text. (line 32)
7064 * C-c ;: Comment lines. (line 10)
7065 * C-c <: Creating timestamps. (line 23)
7066 * C-c <TAB>: Built-in table editor.
7068 * C-c = <1>: Editing and debugging formulas.
7070 * C-c =: Column formulas. (line 26)
7071 * C-c >: Creating timestamps. (line 27)
7072 * C-c ?: Editing and debugging formulas.
7074 * C-c [: Agenda files. (line 12)
7075 * C-c \: Tag searches. (line 9)
7076 * C-c ]: Agenda files. (line 15)
7077 * C-c ^ <1>: Built-in table editor.
7079 * C-c ^: Structure editing. (line 52)
7080 * C-c `: Built-in table editor.
7082 * C-c a !: Stuck projects. (line 14)
7083 * C-c a #: Stuck projects. (line 13)
7084 * C-c a a: Weekly/Daily agenda. (line 9)
7085 * C-c a C: Storing searches. (line 9)
7086 * C-c a e: Exporting Agenda Views.
7088 * C-c a M: Matching headline tags.
7090 * C-c a m: Matching headline tags.
7092 * C-c a M: Tag searches. (line 16)
7093 * C-c a m: Tag searches. (line 12)
7094 * C-c a T: Global TODO list. (line 14)
7095 * C-c a t <1>: Global TODO list. (line 9)
7096 * C-c a t: TODO basics. (line 36)
7097 * C-c C-a: Visibility cycling. (line 33)
7098 * C-c C-b: Motion. (line 15)
7099 * C-c C-c <1>: Cooperation. (line 37)
7100 * C-c C-c <2>: The very busy C-c C-c key.
7102 * C-c C-c <3>: Processing LaTeX fragments.
7104 * C-c C-c <4>: Setting tags. (line 10)
7105 * C-c C-c <5>: Checkboxes. (line 37)
7106 * C-c C-c <6>: Editing and debugging formulas.
7108 * C-c C-c <7>: Built-in table editor.
7110 * C-c C-c: Plain lists. (line 81)
7111 * C-c C-d <1>: Agenda commands. (line 156)
7112 * C-c C-d: Inserting deadline/schedule.
7114 * C-c C-e: Exporting. (line 19)
7115 * C-c C-e a: ASCII export. (line 9)
7116 * C-c C-e b: Export commands. (line 7)
7117 * C-c C-e c: iCalendar export. (line 21)
7118 * C-c C-e H: Export commands. (line 10)
7119 * C-c C-e h: Export commands. (line 6)
7120 * C-c C-e I: iCalendar export. (line 16)
7121 * C-c C-e i: iCalendar export. (line 14)
7122 * C-c C-e R: Export commands. (line 13)
7123 * C-c C-e t: Export options. (line 13)
7124 * C-c C-e v <1>: XOXO export. (line 11)
7125 * C-c C-e v: Sparse trees. (line 41)
7126 * C-c C-e v a: ASCII export. (line 13)
7127 * C-c C-e v b: Export commands. (line 18)
7128 * C-c C-e v H: Export commands. (line 18)
7129 * C-c C-e v h: Export commands. (line 18)
7130 * C-c C-e v R: Export commands. (line 18)
7131 * C-c C-e x: XOXO export. (line 10)
7132 * C-c C-f: Motion. (line 12)
7133 * C-c C-j: Motion. (line 21)
7134 * C-c C-l: Handling links. (line 25)
7135 * C-c C-n: Motion. (line 8)
7136 * C-c C-o <1>: Creating timestamps. (line 31)
7137 * C-c C-o: Handling links. (line 58)
7138 * C-c C-p: Motion. (line 9)
7139 * C-c C-q <1>: Editing and debugging formulas.
7141 * C-c C-q: Built-in table editor.
7143 * C-c C-r <1>: Editing and debugging formulas.
7145 * C-c C-r: Visibility cycling. (line 34)
7146 * C-c C-s <1>: Agenda commands. (line 153)
7147 * C-c C-s: Inserting deadline/schedule.
7149 * C-c C-t <1>: Clocking work time. (line 27)
7150 * C-c C-t: TODO basics. (line 13)
7151 * C-c C-u: Motion. (line 18)
7152 * C-c C-v: TODO basics. (line 26)
7153 * C-c C-w: Inserting deadline/schedule.
7155 * C-c C-x b: Visibility cycling. (line 41)
7156 * C-c C-x C-a: ARCHIVE tag. (line 28)
7157 * C-c C-x C-b: Checkboxes. (line 38)
7158 * C-c C-x C-c: Agenda commands. (line 218)
7159 * C-c C-x C-d: Clocking work time. (line 35)
7160 * C-c C-x C-i: Clocking work time. (line 12)
7161 * C-c C-x C-k: Structure editing. (line 39)
7162 * C-c C-x C-l: Processing LaTeX fragments.
7164 * C-c C-x C-n: Handling links. (line 91)
7165 * C-c C-x C-o: Clocking work time. (line 14)
7166 * C-c C-x C-p: Handling links. (line 91)
7167 * C-c C-x C-r: Clocking work time. (line 43)
7168 * C-c C-x C-s: Moving subtrees. (line 10)
7169 * C-c C-x C-t: Custom time format. (line 12)
7170 * C-c C-x C-u: Dynamic blocks. (line 21)
7171 * C-c C-x C-w <1>: Built-in table editor.
7173 * C-c C-x C-w: Structure editing. (line 39)
7174 * C-c C-x C-x: Clocking work time. (line 31)
7175 * C-c C-x C-y <1>: Built-in table editor.
7177 * C-c C-x C-y: Structure editing. (line 46)
7178 * C-c C-x M-w <1>: Built-in table editor.
7180 * C-c C-x M-w: Structure editing. (line 43)
7181 * C-c C-y <1>: Clocking work time. (line 22)
7182 * C-c C-y: Creating timestamps. (line 48)
7183 * C-c l: Handling links. (line 9)
7184 * C-c { <1>: CDLaTeX mode. (line 21)
7185 * C-c {: Editing and debugging formulas.
7187 * C-c |: Built-in table editor.
7189 * C-c }: Editing and debugging formulas.
7191 * C-c ~: Cooperation. (line 48)
7192 * C-k: Agenda commands. (line 115)
7193 * C-S-<left>: Multiple sets in one file.
7195 * C-S-<right>: Multiple sets in one file.
7197 * C-TAB: ARCHIVE tag. (line 38)
7198 * C-u C-c *: Updating the table. (line 16)
7199 * C-u C-c .: Creating timestamps. (line 14)
7200 * C-u C-c = <1>: Editing and debugging formulas.
7202 * C-u C-c =: Field formulas. (line 24)
7203 * C-u C-c C-c: Updating the table. (line 19)
7204 * C-u C-c C-l: Handling links. (line 43)
7205 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
7206 * C-u C-c C-x C-s: Moving subtrees. (line 12)
7207 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
7208 * C-u C-c C-x C-u: Clocking work time. (line 70)
7209 * C-u C-u C-c *: Updating the table. (line 22)
7210 * C-u C-u C-c =: Editing and debugging formulas.
7212 * C-x C-s: Editing and debugging formulas.
7214 * C-x C-w <1>: Exporting Agenda Views.
7216 * C-x C-w: Agenda commands. (line 227)
7217 * D: Agenda commands. (line 72)
7218 * d: Agenda commands. (line 69)
7219 * f: Agenda commands. (line 42)
7220 * g: Agenda commands. (line 76)
7221 * H: Agenda commands. (line 215)
7222 * i: Agenda commands. (line 196)
7223 * I: Agenda commands. (line 176)
7224 * l: Agenda commands. (line 55)
7225 * L: Agenda commands. (line 30)
7226 * M: Agenda commands. (line 202)
7227 * M-<down> <1>: Editing and debugging formulas.
7229 * M-<down>: Built-in table editor.
7231 * M-<left> <1>: Built-in table editor.
7233 * M-<left>: Structure editing. (line 21)
7234 * M-<RET> <1>: Plain lists. (line 49)
7235 * M-<RET>: Structure editing. (line 6)
7236 * M-<right> <1>: Built-in table editor.
7238 * M-<right>: Structure editing. (line 24)
7239 * M-<TAB> <1>: Completion. (line 10)
7240 * M-<TAB> <2>: Setting tags. (line 6)
7241 * M-<TAB> <3>: Per file keywords. (line 23)
7242 * M-<TAB>: Editing and debugging formulas.
7244 * M-<up> <1>: Editing and debugging formulas.
7246 * M-<up>: Built-in table editor.
7248 * M-S-<down> <1>: Editing and debugging formulas.
7250 * M-S-<down> <2>: Built-in table editor.
7252 * M-S-<down> <3>: Plain lists. (line 66)
7253 * M-S-<down>: Structure editing. (line 36)
7254 * M-S-<left> <1>: The date/time prompt.
7256 * M-S-<left> <2>: Built-in table editor.
7258 * M-S-<left> <3>: Plain lists. (line 72)
7259 * M-S-<left>: Structure editing. (line 27)
7260 * M-S-<RET> <1>: Checkboxes. (line 53)
7261 * M-S-<RET> <2>: Plain lists. (line 59)
7262 * M-S-<RET>: Structure editing. (line 18)
7263 * M-S-<right> <1>: The date/time prompt.
7265 * M-S-<right> <2>: Built-in table editor.
7267 * M-S-<right> <3>: Plain lists. (line 72)
7268 * M-S-<right>: Structure editing. (line 30)
7269 * M-S-<up> <1>: Editing and debugging formulas.
7271 * M-S-<up> <2>: Built-in table editor.
7273 * M-S-<up> <3>: Plain lists. (line 66)
7274 * M-S-<up>: Structure editing. (line 33)
7275 * mouse-1 <1>: Agenda commands. (line 33)
7276 * mouse-1 <2>: The date/time prompt.
7278 * mouse-1: Handling links. (line 72)
7279 * mouse-2 <1>: Agenda commands. (line 33)
7280 * mouse-2: Handling links. (line 72)
7281 * mouse-3 <1>: Agenda commands. (line 28)
7282 * mouse-3: Handling links. (line 77)
7283 * n: Agenda commands. (line 19)
7284 * O: Agenda commands. (line 180)
7285 * o: Agenda commands. (line 65)
7286 * P: Agenda commands. (line 140)
7287 * p: Agenda commands. (line 20)
7288 * q: Agenda commands. (line 238)
7289 * r <1>: Agenda commands. (line 80)
7290 * r: Global TODO list. (line 22)
7291 * S: Agenda commands. (line 206)
7292 * s: Agenda commands. (line 87)
7293 * S-<down> <1>: Agenda commands. (line 149)
7294 * S-<down> <2>: The date/time prompt.
7296 * S-<down> <3>: Creating timestamps. (line 40)
7297 * S-<down> <4>: Priorities. (line 23)
7298 * S-<down> <5>: Editing and debugging formulas.
7300 * S-<down>: Plain lists. (line 62)
7301 * S-<left> <1>: Agenda commands. (line 167)
7302 * S-<left> <2>: The date/time prompt.
7304 * S-<left> <3>: Creating timestamps. (line 35)
7305 * S-<left> <4>: Multiple sets in one file.
7307 * S-<left> <5>: TODO basics. (line 20)
7308 * S-<left>: Editing and debugging formulas.
7310 * S-<RET>: Built-in table editor.
7312 * S-<right> <1>: Agenda commands. (line 159)
7313 * S-<right> <2>: The date/time prompt.
7315 * S-<right> <3>: Creating timestamps. (line 35)
7316 * S-<right> <4>: Multiple sets in one file.
7318 * S-<right> <5>: TODO basics. (line 20)
7319 * S-<right>: Editing and debugging formulas.
7321 * S-<TAB> <1>: Built-in table editor.
7323 * S-<TAB>: Visibility cycling. (line 22)
7324 * S-<up> <1>: Agenda commands. (line 143)
7325 * S-<up> <2>: The date/time prompt.
7327 * S-<up> <3>: Creating timestamps. (line 40)
7328 * S-<up> <4>: Priorities. (line 23)
7329 * S-<up> <5>: Editing and debugging formulas.
7331 * S-<up>: Plain lists. (line 62)
7332 * T: Agenda commands. (line 124)
7333 * t: Agenda commands. (line 111)
7334 * w: Agenda commands. (line 66)
7335 * x: Agenda commands. (line 239)
7336 * X: Agenda commands. (line 183)
7342 Node: Introduction
\x7f11743
7343 Node: Summary
\x7f12158
7344 Node: Installation
\x7f15167
7345 Node: Activation
\x7f16545
7346 Node: Feedback
\x7f17794
7347 Node: Document structure
\x7f19870
7348 Node: Outlines
\x7f20644
7349 Node: Headlines
\x7f21304
7350 Ref: Headlines-Footnote-1
\x7f22312
7351 Node: Visibility cycling
\x7f22411
7352 Ref: Visibility cycling-Footnote-1
\x7f24621
7353 Ref: Visibility cycling-Footnote-2
\x7f24679
7354 Ref: Visibility cycling-Footnote-3
\x7f24729
7355 Node: Motion
\x7f24999
7356 Node: Structure editing
\x7f25953
7357 Node: Archiving
\x7f28779
7358 Node: ARCHIVE tag
\x7f29337
7359 Node: Moving subtrees
\x7f31130
7360 Node: Sparse trees
\x7f32441
7361 Ref: Sparse trees-Footnote-1
\x7f34573
7362 Ref: Sparse trees-Footnote-2
\x7f34755
7363 Node: Plain lists
\x7f34870
7364 Ref: Plain lists-Footnote-1
\x7f38868
7365 Ref: Plain lists-Footnote-2
\x7f39226
7366 Node: Tables
\x7f39407
7367 Node: Built-in table editor
\x7f39988
7368 Node: Narrow columns
\x7f47227
7369 Ref: Narrow columns-Footnote-1
\x7f49162
7370 Node: Column groups
\x7f49208
7371 Node: orgtbl-mode
\x7f50741
7372 Node: The spreadsheet
\x7f51544
7373 Node: References
\x7f52631
7374 Ref: References-Footnote-1
\x7f56760
7375 Node: Formula syntax for Calc
\x7f57049
7376 Node: Formula syntax for Lisp
\x7f59506
7377 Node: Field formulas
\x7f61224
7378 Node: Column formulas
\x7f62532
7379 Node: Editing and debugging formulas
\x7f64131
7380 Node: Updating the table
\x7f68284
7381 Node: Advanced features
\x7f69319
7382 Node: Hyperlinks
\x7f73844
7383 Node: Link format
\x7f74617
7384 Node: Internal links
\x7f75910
7385 Ref: Internal links-Footnote-1
\x7f77835
7386 Node: Radio targets
\x7f77970
7387 Node: External links
\x7f78661
7388 Node: Handling links
\x7f81065
7389 Ref: Handling links-Footnote-1
\x7f86352
7390 Ref: Handling links-Footnote-2
\x7f86589
7391 Node: Link abbreviations
\x7f86663
7392 Node: Search options
\x7f88342
7393 Ref: Search options-Footnote-1
\x7f90122
7394 Node: Custom searches
\x7f90203
7395 Node: Remember
\x7f91251
7396 Node: Setting up remember
\x7f92238
7397 Node: Remember templates
\x7f92820
7398 Ref: Remember templates-Footnote-1
\x7f96112
7399 Node: Storing notes
\x7f96210
7400 Node: TODO items
\x7f98097
7401 Node: TODO basics
\x7f99074
7402 Node: TODO extensions
\x7f100771
7403 Node: Workflow states
\x7f101590
7404 Ref: Workflow states-Footnote-1
\x7f102765
7405 Node: TODO types
\x7f102858
7406 Ref: TODO types-Footnote-1
\x7f104441
7407 Node: Multiple sets in one file
\x7f104523
7408 Node: Per file keywords
\x7f106134
7409 Ref: Per file keywords-Footnote-1
\x7f107423
7410 Node: Priorities
\x7f107624
7411 Node: Breaking down tasks
\x7f109234
7412 Ref: Breaking down tasks-Footnote-1
\x7f109754
7413 Node: Checkboxes
\x7f109850
7414 Node: Tags
\x7f112605
7415 Node: Tag inheritance
\x7f113365
7416 Node: Setting tags
\x7f114302
7417 Ref: Setting tags-Footnote-1
\x7f118825
7418 Ref: Setting tags-Footnote-2
\x7f118937
7419 Node: Tag searches
\x7f119020
7420 Node: Timestamps
\x7f121731
7421 Node: Time stamps
\x7f122174
7422 Ref: Time stamps-Footnote-1
\x7f124602
7423 Node: Creating timestamps
\x7f124718
7424 Node: The date/time prompt
\x7f126792
7425 Ref: The date/time prompt-Footnote-1
\x7f128780
7426 Node: Custom time format
\x7f128886
7427 Node: Deadlines and scheduling
\x7f130578
7428 Ref: Deadlines and scheduling-Footnote-1
\x7f131928
7429 Node: Inserting deadline/schedule
\x7f132083
7430 Node: Repeated tasks
\x7f133021
7431 Node: Progress logging
\x7f134660
7432 Node: Closing items
\x7f135315
7433 Ref: Closing items-Footnote-1
\x7f136249
7434 Ref: Closing items-Footnote-2
\x7f136318
7435 Node: Tracking TODO state changes
\x7f136391
7436 Node: Clocking work time
\x7f137247
7437 Ref: Clocking work time-Footnote-1
\x7f140893
7438 Ref: Clocking work time-Footnote-2
\x7f140971
7439 Node: Agenda views
\x7f141097
7440 Node: Agenda files
\x7f143048
7441 Ref: Agenda files-Footnote-1
\x7f144014
7442 Ref: Agenda files-Footnote-2
\x7f144163
7443 Node: Agenda dispatcher
\x7f144356
7444 Node: Built-in agenda views
\x7f146047
7445 Node: Weekly/Daily agenda
\x7f146625
7446 Node: Global TODO list
\x7f149566
7447 Node: Matching headline tags
\x7f151838
7448 Node: Timeline
\x7f152909
7449 Node: Stuck projects
\x7f153575
7450 Node: Presentation and sorting
\x7f155426
7451 Node: Categories
\x7f156217
7452 Node: Time-of-day specifications
\x7f156881
7453 Node: Sorting of agenda items
\x7f158852
7454 Node: Agenda commands
\x7f160134
7455 Node: Custom agenda views
\x7f167288
7456 Node: Storing searches
\x7f168007
7457 Node: Block agenda
\x7f169919
7458 Node: Setting Options
\x7f171149
7459 Node: Exporting Agenda Views
\x7f173888
7460 Ref: Exporting Agenda Views-Footnote-1
\x7f178172
7461 Ref: Exporting Agenda Views-Footnote-2
\x7f178229
7462 Node: Extracting Agenda Information for other programs
\x7f178415
7463 Node: Embedded LaTeX
\x7f182541
7464 Ref: Embedded LaTeX-Footnote-1
\x7f183633
7465 Node: Math symbols
\x7f183823
7466 Node: Subscripts and Superscripts
\x7f184588
7467 Node: LaTeX fragments
\x7f185432
7468 Ref: LaTeX fragments-Footnote-1
\x7f187666
7469 Node: Processing LaTeX fragments
\x7f187928
7470 Node: CDLaTeX mode
\x7f188874
7471 Ref: CDLaTeX mode-Footnote-1
\x7f191358
7472 Node: Exporting
\x7f191506
7473 Node: ASCII export
\x7f192820
7474 Node: HTML export
\x7f194110
7475 Node: Export commands
\x7f194729
7476 Node: Quoting HTML tags
\x7f195973
7477 Node: Links
\x7f196603
7478 Node: Images
\x7f197300
7479 Ref: Images-Footnote-1
\x7f198171
7480 Node: CSS support
\x7f198232
7481 Ref: CSS support-Footnote-1
\x7f199551
7482 Node: XOXO export
\x7f199664
7483 Node: iCalendar export
\x7f200103
7484 Node: Text interpretation
\x7f201322
7485 Node: Comment lines
\x7f201913
7486 Node: Initial text
\x7f202308
7487 Node: Footnotes
\x7f203977
7488 Node: Enhancing text
\x7f204792
7489 Ref: Enhancing text-Footnote-1
\x7f206651
7490 Node: Export options
\x7f206741
7491 Node: Publishing
\x7f208634
7492 Ref: Publishing-Footnote-1
\x7f209430
7493 Node: Configuration
\x7f209626
7494 Node: Project alist
\x7f210344
7495 Node: Sources and destinations
\x7f211410
7496 Node: Selecting files
\x7f212140
7497 Node: Publishing action
\x7f212888
7498 Node: Publishing options
\x7f214121
7499 Node: Publishing links
\x7f216273
7500 Node: Project page index
\x7f217786
7501 Node: Sample configuration
\x7f218564
7502 Node: Simple example
\x7f219056
7503 Node: Complex example
\x7f219729
7504 Node: Triggering publication
\x7f221805
7505 Node: Miscellaneous
\x7f222490
7506 Node: Completion
\x7f223124
7507 Node: Customization
\x7f224595
7508 Node: In-buffer settings
\x7f225178
7509 Node: The very busy C-c C-c key
\x7f230054
7510 Node: Clean view
\x7f231698
7511 Node: TTY keys
\x7f234275
7512 Node: Interaction
\x7f235885
7513 Node: Cooperation
\x7f236282
7514 Node: Conflicts
\x7f239158
7515 Node: Bugs
\x7f241161
7516 Node: Extensions and Hacking
\x7f242657
7517 Node: Extensions
\x7f243253
7518 Node: Tables in arbitrary syntax
\x7f245200
7519 Node: Radio tables
\x7f246277
7520 Node: A LaTeX example
\x7f248780
7521 Ref: A LaTeX example-Footnote-1
\x7f252426
7522 Ref: A LaTeX example-Footnote-2
\x7f252574
7523 Node: Translator functions
\x7f253009
7524 Ref: Translator functions-Footnote-1
\x7f256118
7525 Node: Dynamic blocks
\x7f256206
7526 Node: Special agenda views
\x7f258178
7527 Ref: Special agenda views-Footnote-1
\x7f260457
7528 Node: History and Acknowledgments
\x7f260717
7529 Node: Index
\x7f266811
7530 Node: Key Index
\x7f298965