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 5.15).
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 5.15).
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 * Properties and columns:: Storing information about an entry
55 * Dates and times:: Making items useful for planning
56 * Remember:: Quickly adding nodes to the outline tree
57 * Agenda views:: Collecting information into views
58 * Embedded LaTeX:: LaTeX fragments and formulas
59 * Exporting:: Sharing and publishing of notes
60 * Publishing:: Create a web site of linked Org-mode files
61 * Miscellaneous:: All the rest which did not fit elsewhere
62 * Extensions and Hacking:: It is possible to write add-on code
63 * History and Acknowledgments:: How Org-mode came into being
64 * Index:: The fast road to specific information
65 * Key Index:: Key bindings and where they are described
67 --- The Detailed Node Listing ---
71 * Summary:: Brief summary of what Org-mode does
72 * Installation:: How to install a downloaded version of Org-mode
73 * Activation:: How to activate Org-mode for certain buffers.
74 * Feedback:: Bug reports, ideas, patches etc.
75 * Conventions:: Type-setting conventions in the manual
79 * Outlines:: Org-mode is based on outline-mode
80 * Headlines:: How to typeset org-tree headlines
81 * Visibility cycling:: Show and hide, much simplified
82 * Motion:: Jumping to other headlines
83 * Structure editing:: Changing sequence and level of headlines
84 * Archiving:: Move done task trees to a different place
85 * Sparse trees:: Matches embedded in context
86 * Plain lists:: Additional structure within an entry
87 * Drawers:: Tucking stuff away
88 * orgstruct-mode:: Structure editing outside Org-mode
92 * ARCHIVE tag:: Marking a tree as inactive
93 * Moving subtrees:: Moving a tree to an archive file
97 * Built-in table editor:: Simple tables
98 * Narrow columns:: Stop wasting space in tables
99 * Column groups:: Grouping to trigger vertical lines
100 * orgtbl-mode:: The table editor as minor mode
101 * The spreadsheet:: The table editor has spreadsheet capabilities.
105 * References:: How to refer to another field or range
106 * Formula syntax for Calc:: Using Calc to compute stuff
107 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
108 * Field formulas:: Formulas valid for a single field
109 * Column formulas:: Formulas valid for an entire column
110 * Editing and debugging formulas:: Fixing formulas
111 * Updating the table:: Recomputing all dependent fields
112 * Advanced features:: Field names, parameters and automatic recalc
116 * Link format:: How links in Org-mode are formatted
117 * Internal links:: Links to other places in the current file
118 * External links:: URL-like links to the world
119 * Handling links:: Creating, inserting and following
120 * Using links outside Org-mode:: Linking from my C source code?
121 * Link abbreviations:: Shortcuts for writing complex links
122 * Search options:: Linking to a specific location
123 * Custom searches:: When the default search is not enough
127 * Radio targets:: Make targets trigger links in plain text.
131 * TODO basics:: Marking and displaying TODO entries
132 * TODO extensions:: Workflow and assignments
133 * Progress logging:: Dates and notes for progress
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 * Fast access to TODO states:: Single letter selection of a state
144 * Per file keywords:: Different files, different requirements
145 * Faces for TODO keywords:: Highlighting states
149 * Closing items:: When was this entry marked DONE?
150 * Tracking TODO state changes:: When did the status change?
154 * Tag inheritance:: Tags use the tree structure of the outline
155 * Setting tags:: How to assign tags to a headline
156 * Tag searches:: Searching for combinations of tags
158 Properties and Columns
160 * Property syntax:: How properties are spelled out
161 * Special properties:: Access to other Org-mode features
162 * Property searches:: Matching property values
163 * Property inheritance:: Passing values down the tree
164 * Column view:: Tabular viewing and editing
165 * Property API:: Properties for Lisp programmers
169 * Defining columns:: The COLUMNS format property
170 * Using column view:: How to create and use column view
171 * Capturing Column View:: A dynamic block for column view
175 * Scope of column definitions:: Where defined, where valid?
176 * Column attributes:: Appearance and content of a column
180 * Time stamps:: Assigning a time to a tree entry
181 * Creating timestamps:: Commands which insert timestamps
182 * Deadlines and scheduling:: Planning your work
183 * Clocking work time::
187 * The date/time prompt:: How org-mode helps you entering date and time
188 * Custom time format:: Making dates look differently
190 Deadlines and Scheduling
192 * Inserting deadline/schedule:: Planning items
193 * Repeated tasks:: Items that show up again and again
197 * Setting up remember:: Some code for .emacs to get things going
198 * Remember templates:: Define the outline of different note types
199 * Storing notes:: Directly get the note to where it belongs
200 * Refiling notes:: Moving a note or task to a project
204 * Agenda files:: Files being searched for agenda information
205 * Agenda dispatcher:: Keyboard access to agenda views
206 * Built-in agenda views:: What is available out of the box?
207 * Presentation and sorting:: How agenda items are prepared for display
208 * Agenda commands:: Remote editing of org trees
209 * Custom agenda views:: Defining special searches and views
211 The built-in agenda views
213 * Weekly/Daily agenda:: The calendar page with current tasks
214 * Global TODO list:: All unfinished action items
215 * Matching tags and properties:: Structured information with fine-tuned search
216 * Timeline:: Time-sorted view for single file
217 * Stuck projects:: Find projects you need to review
219 Presentation and sorting
221 * Categories:: Not all tasks are equal
222 * Time-of-day specifications:: How the agenda knows the time
223 * Sorting of agenda items:: The order of things
227 * Storing searches:: Type once, use often
228 * Block agenda:: All the stuff you need in a single buffer
229 * Setting Options:: Changing the rules
230 * Exporting Agenda Views:: Writing agendas to files.
231 * Extracting Agenda Information for other programs::
235 * Math symbols:: TeX macros for symbols and Greek letters
236 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
237 * LaTeX fragments:: Complex formulas made easy
238 * Processing LaTeX fragments:: Previewing LaTeX processing
239 * CDLaTeX mode:: Speed up entering of formulas
243 * ASCII export:: Exporting to plain ASCII
244 * HTML export:: Exporting to HTML
245 * LaTeX export:: Exporting to LaTeX
246 * XOXO export:: Exporting to XOXO
247 * iCalendar export:: Exporting in iCalendar format
248 * Text interpretation:: How the exporter looks at the file
252 * HTML Export commands:: How to invoke LaTeX export
253 * Quoting HTML tags:: Using direct HTML in Org-mode
254 * Links:: Transformation of links for HTML
255 * Images:: How to include images
256 * CSS support:: Changing the appearence of the output
260 * LaTeX export commands:: How to invoke LaTeX export
261 * Quoting LaTeX code:: Incorporating literal LaTeX code
262 * Sectioning structure::
264 Text interpretation by the exporter
266 * Comment lines:: Some lines will not be exported
267 * Initial text:: Text before the first headline
268 * Footnotes:: Numbers like [1]
269 * Quoted examples:: Inserting quoted chnuks of text
270 * Enhancing text:: Subscripts, symbols and more
271 * Export options:: How to influence the export settings
275 * Configuration:: Defining projects
276 * Sample configuration:: Example projects
277 * Triggering publication:: Publication commands
281 * Project alist:: The central configuration variable
282 * Sources and destinations:: From here to there
283 * Selecting files:: What files are part of the project?
284 * Publishing action:: Setting the function doing the publishing
285 * Publishing options:: Tweaking HTML export
286 * Publishing links:: Which links keep working after publishing?
287 * Project page index:: Publishing a list of project files
291 * Simple example:: One-component publishing
292 * Complex example:: A multi-component publishing example
296 * Completion:: M-TAB knows what you need
297 * Customization:: Adapting Org-mode to your taste
298 * In-buffer settings:: Overview of the #+KEYWORDS
299 * The very busy C-c C-c key:: When in doubt, press C-c C-c
300 * Clean view:: Getting rid of leading stars in the outline
301 * TTY keys:: Using Org-mode on a tty
302 * Interaction:: Other Emacs packages
303 * Bugs:: Things which do not work perfectly
305 Interaction with other packages
307 * Cooperation:: Packages Org-mode cooperates with
308 * Conflicts:: Packages that lead to conflicts
310 Extensions, Hooks and Hacking
312 * Extensions:: Existing 3rd-part extensions
313 * Adding hyperlink types:: New custom link types
314 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
315 * Dynamic blocks:: Automatically filled blocks
316 * Special agenda views:: Customized views
317 * Using the property API:: Writing programs that use entry properties
319 Tables and Lists in arbitrary syntax
321 * Radio tables:: Sending and receiving
322 * A LaTeX example:: Step by step, almost a tutorial
323 * Translator functions:: Copy and modify
324 * Radio lists:: Doing the same for lists.
327 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
334 * Summary:: Brief summary of what Org-mode does
335 * Installation:: How to install a downloaded version of Org-mode
336 * Activation:: How to activate Org-mode for certain buffers.
337 * Feedback:: Bug reports, ideas, patches etc.
338 * Conventions:: Type-setting conventions in the manual
341 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
346 Org-mode is a mode for keeping notes, maintaining TODO lists, and doing
347 project planning with a fast and effective plain-text system.
349 Org-mode develops organizational tasks around NOTES files that
350 contain lists or information about projects as plain text. Org-mode is
351 implemented on top of outline-mode, which makes it possible to keep the
352 content of large files well structured. Visibility cycling and
353 structure editing help to work with the tree. Tables are easily created
354 with a built-in table editor. Org-mode supports TODO items, deadlines,
355 time stamps, and scheduling. It dynamically compiles entries into an
356 agenda that utilizes and smoothly integrates much of the Emacs calendar
357 and diary. Plain text URL-like links connect to websites, emails,
358 Usenet messages, BBDB entries, and any files related to the projects.
359 For printing and sharing of notes, an Org-mode file can be exported as a
360 structured ASCII file, as HTML, or (todo and agenda items only) as an
361 iCalendar file. It can also serve as a publishing tool for a set of
364 An important design aspect that distinguishes Org-mode from for
365 example Planner/Muse is that it encourages to store every piece of
366 information only once. In Planner, you have project pages, day pages
367 and possibly other files, duplicating some information such as tasks.
368 In Org-mode, you only have notes files. In your notes you mark entries
369 as tasks, label them with tags and timestamps. All necessary lists
370 like a schedule for the day, the agenda for a meeting, tasks lists
371 selected by tags etc are created dynamically when you need them.
373 Org-mode keeps simple things simple. When first fired up, it should
374 feel like a straightforward, easy to use outliner. Complexity is not
375 imposed, but a large amount of functionality is available when you need
376 it. Org-mode is a toolbox and can be used in different ways, for
379 * outline extension with visibility cycling and structure editing
380 * ASCII system and table editor for taking structured notes
381 * ASCII table editor with spreadsheet-like capabilities
383 * full agenda and planner with deadlines and work scheduling
384 * environment to implement David Allen's GTD system
385 * a basic database application
386 * simple hypertext system, with HTML and LaTeX export
387 * publishing tool to create a set of interlinked webpages
389 Org-mode's automatic, context sensitive table editor with spreadsheet
390 capabilities can be integrated into any major mode by activating the
391 minor Orgtbl-mode. Using a translation step, it can be used to maintain
392 tables in arbitrary file types, for example in LaTeX. The structure
393 editing and list creation capabilities can be used outside Org-mode with
394 the minor Orgstruct-mode.
396 There is a website for Org-mode which provides links to the newest
397 version of Org-mode, as well as additional information, frequently asked
398 questions (FAQ), links to tutorials etc. This page is located at
399 `http://orgmode.org'.
402 File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
407 Important: If Org-mode is part of the Emacs distribution or an XEmacs
408 package, please skip this section and go directly to *Note Activation::.
410 If you have downloaded Org-mode from the Web, you must take the
411 following steps to install it: Go into the Org-mode distribution
412 directory and edit the top section of the file `Makefile'. You must
413 set the name of the Emacs binary (likely either `emacs' or `xemacs'),
414 and the paths to the directories where local Lisp and Info files are
415 kept. If you don't have access to the system-wide directories, create
416 your own two directories for these files, enter them into the Makefile,
417 and make sure Emacs finds the Lisp files by adding the following line
420 (setq load-path (cons "~/path/to/lispdir" load-path))
422 XEmacs users now need to install the file `noutline.el' from the
423 `xemacs' subdirectory of the Org-mode distribution. Use the command:
425 make install-noutline
427 Now byte-compile and install the Lisp files with the shell commands:
432 If you want to install the info documentation, use this command:
436 Then add to `.emacs':
438 ;; This line only if org-mode is not part of the X/Emacs distribution.
439 (require 'org-install)
442 File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
447 Add the following lines to your `.emacs' file. The last two lines
448 define _global_ keys for the commands `org-store-link' and `org-agenda'
449 - please choose suitable keys yourself.
451 ;; The following lines are always needed. Choose your own keys.
452 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
453 (global-set-key "\C-cl" 'org-store-link)
454 (global-set-key "\C-ca" 'org-agenda)
456 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
457 because significant functionality depends on font-locking being active.
458 You can do this with either one of the following two lines (XEmacs
459 user must use the second option):
460 (global-font-lock-mode 1) ; for all buffers
461 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
463 With this setup, all files with extension `.org' will be put into
464 Org-mode. As an alternative, make the first line of a file look like
467 MY PROJECTS -*- mode: org; -*-
469 which will select Org-mode for this buffer no matter what the file's
470 name is. See also the variable `org-insert-mode-line-in-empty-file'.
473 File: org, Node: Feedback, Next: Conventions, Prev: Activation, Up: Introduction
478 If you find problems with Org-mode, or if you have questions, remarks,
479 or ideas about it, please contact the maintainer Carsten Dominik at
480 <carsten at orgmode dot org>.
482 For bug reports, please provide as much information as possible,
483 including the version information of Emacs (`C-h v emacs-version
484 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
485 Org-mode related setup in `.emacs'. If an error occurs, a backtrace
486 can be very useful (see below on how to create one). Often a small
487 example file helps, along with clear information about:
489 1. What exactly did you do?
491 2. What did you expect to happen?
493 3. What happened instead?
494 Thank you for helping to improve this mode.
496 How to create a useful backtrace
497 ................................
499 If working with Org-mode produces an error with a message you don't
500 understand, you may have hit a bug. The best way to report this is by
501 providing, in addition to what was mentioned above, a _Backtrace_.
502 This is information from the built-in debugger about where and how the
503 error occurred. Here is how to produce a useful backtrace:
505 1. Start a fresh Emacs or XEmacs, and make sure that it will load the
506 original Lisp code in `org.el' instead of the compiled version in
507 `org.elc'. The backtrace contains much more information if it is
508 produced with uncompiled code. To do this, either rename `org.elc'
509 to something else before starting Emacs, or ask Emacs explicitly
510 to load `org.el' by using the command line
511 emacs -l /path/to/org.el
513 2. Go to the `Options' menu and select `Enter Debugger on Error'
514 (XEmacs has this option in the `Troubleshooting' sub-menu).
516 3. Do whatever you have to do to hit the error. Don't forget to
517 document the steps you take.
519 4. When you hit the error, a `*Backtrace*' buffer will appear on the
520 screen. Save this buffer to a file (for example using `C-x C-w')
521 and attach it to your bug report.
524 File: org, Node: Conventions, Prev: Feedback, Up: Introduction
526 1.5 Typesetting conventions used in this manual
527 ===============================================
529 Org-mode has 3 types of keywords that are being used. TODO keywords,
530 tags, and property names. For this manual we are using the following
535 TODO keyword are written with all capitals, even if they are
540 User-defined Tags are written in lowercase, built-in tags with
541 special meaning a all-caps.
545 User-defined properties are capitalized in all examples, while
546 built-in properties with special meaning are all-caps.
549 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
554 Org-mode is based on outline mode and provides flexible commands to
555 edit the structure of the document.
559 * Outlines:: Org-mode is based on outline-mode
560 * Headlines:: How to typeset org-tree headlines
561 * Visibility cycling:: Show and hide, much simplified
562 * Motion:: Jumping to other headlines
563 * Structure editing:: Changing sequence and level of headlines
564 * Archiving:: Move done task trees to a different place
565 * Sparse trees:: Matches embedded in context
566 * Plain lists:: Additional structure within an entry
567 * Drawers:: Tucking stuff away
568 * orgstruct-mode:: Structure editing outside Org-mode
571 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
576 Org-mode is implemented on top of outline-mode. Outlines allow a
577 document to be organized in a hierarchical structure, which (at least
578 for me) is the best representation of notes and thoughts. An overview
579 of this structure is achieved by folding (hiding) large parts of the
580 document to show only the general document structure and the parts
581 currently being worked on. Org-mode greatly simplifies the use of
582 outlines by compressing the entire show/hide functionality into a single
583 command `org-cycle', which is bound to the <TAB> key.
586 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
591 Headlines define the structure of an outline tree. The headlines in
592 Org-mode start with one or more stars, on the left margin(1). For
602 * Another top level headline
604 Some people find the many stars too noisy and would prefer an outline
605 that has whitespace followed by a single star as headline starters.
606 *Note Clean view:: describes a setup to realize this.
608 An empty line after the end of a subtree is considered part of it and
609 will be hidden when the subtree is folded. However, if you leave at
610 least two empty lines, one empty line will remain visible after folding
611 the subtree, in order to structure the collapsed view. See the
612 variable `org-cycle-separator-lines' to modify this behavior.
614 ---------- Footnotes ----------
616 (1) See the variable `org-special-ctrl-a/e' to configure special
617 behavior of `C-a' and `C-e' in headlines.
620 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
622 2.3 Visibility cycling
623 ======================
625 Outlines make it possible to hide parts of the text in the buffer.
626 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
627 the visibility in the buffer.
630 _Subtree cycling_: Rotate current subtree among the states
632 ,-> FOLDED -> CHILDREN -> SUBTREE --.
633 '-----------------------------------'
635 The cursor must be on a headline for this to work(1). When the
636 cursor is at the beginning of the buffer and the first line is not
637 a headline, then <TAB> actually runs global cycling (see
638 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
639 global cycling is invoked.
643 _Global cycling_: Rotate the entire buffer among the states
645 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
646 '--------------------------------------'
648 When `S-<TAB>' is called with a numerical prefix N, the CONTENTS
649 view up to headlines of level N will be shown. Note that inside
650 tables, `S-<TAB>' jumps to the previous field.
656 Reveal context around point, showing the current entry, the
657 following heading and the hierarchy above. Useful for working
658 near a location exposed by a sparse tree command (*note Sparse
659 trees::) or an agenda command (*note Agenda commands::). With
660 prefix arg show, on each level, all sibling headings.
663 Show the current subtree in an indirect buffer(3). With numerical
664 prefix ARG, go up to this level and then take that tree. If ARG is
665 negative, go up that many levels. With `C-u' prefix, do not remove
666 the previously used indirect buffer.
668 When Emacs first visits an Org-mode file, the global state is set to
669 OVERVIEW, i.e. only the top level headlines are visible. This can be
670 configured through the variable `org-startup-folded', or on a per-file
671 basis by adding one of the following lines anywhere in the buffer:
677 ---------- Footnotes ----------
679 (1) see, however, the option `org-cycle-emulate-tab'.
681 (2) see the option `org-cycle-global-at-bob'.
683 (3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
684 Buffers.) will contain the entire buffer, but will be narrowed to the
685 current tree. Editing the indirect buffer will also change the
686 original buffer, but without affecting visibility in that buffer.
689 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
694 The following commands jump to other headlines in the buffer.
703 Next heading same level.
706 Previous heading same level.
709 Backward to higher level heading.
712 Jump to a different place without changing the current outline
713 visibility. Shows the document structure in a temporary buffer,
714 where you can use the following keys to find your destination:
715 <TAB> Cycle visibility.
716 <down> / <up> Next/previous visible headline.
717 n / p Next/previous visible headline.
718 f / b Next/previous headline same level.
721 <RET> Select this location.
724 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
726 2.5 Structure editing
727 =====================
730 Insert new heading with same level as current. If the cursor is
731 in a plain list item, a new item is created (*note Plain lists::).
732 To force creation of a new headline, use a prefix arg, or first
733 press <RET> to get to the beginning of the next line. When this
734 command is used in the middle of a line, the line is split and the
735 rest of the line becomes the new headline. If the command is used
736 at the beginning of a headline, the new headline is created before
737 the current line. If at the beginning of any other line, the
738 content of that line is made the new heading. If the command is
739 used at the end of a folded subtree (i.e. behind the ellipses at
740 the end of a headline), then a headline like the current one will
741 be inserted after the end of the subtree.
744 Insert a new heading after the current subtree, same level as the
745 current headline. This command works from anywhere in the entry.
748 Insert new TODO entry with same level as current heading.
751 Promote current heading by one level.
754 Demote current heading by one level.
757 Promote the current subtree by one level.
760 Demote the current subtree by one level.
763 Move subtree up (swap with previous subtree of same level).
766 Move subtree down (swap with next subtree of same level).
770 Kill subtree, i.e. remove it from buffer but save in kill ring.
771 With prefix arg, kill N sequential subtrees.
774 Copy subtree to kill ring. With prefix arg, copy N sequential
778 Yank subtree from kill ring. This does modify the level of the
779 subtree to make sure the tree fits in nicely at the yank position.
780 The yank level can also be specified with a prefix arg, or by
781 yanking after a headline marker like `****'.
784 Refile entry to a different location. *Note Refiling notes::.
787 Sort same-level entries. When there is an active region, all
788 entries in the region will be sorted. Otherwise the children of
789 the current headline are sorted. The command prompts for the
790 sorting method, which can be alphabetically, numerically, by time
791 (using the first time stamp in each entry), by priority, and each
792 of these in reverse order. You can also supply your own function
793 to extract the sorting key. With a `C-u' prefix, sorting will be
794 case-sensitive. With two `C-u C-u' prefixes, duplicate entries
795 will also be removed.
797 When there is an active region (transient-mark-mode), promotion and
798 demotion work on all headlines in the region. To select a region of
799 headlines, it is best to place both point and mark at the beginning of a
800 line, mark at the beginning of the first headline, and point at the line
801 just after the last headline to change. Note that when the cursor is
802 inside a table (*note Tables::), the Meta-Cursor keys have different
806 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
811 When a project represented by a (sub)tree is finished, you may want to
812 move the tree out of the way and to stop it from contributing to the
813 agenda. Org-mode knows two ways of archiving. You can mark a tree with
814 the ARCHIVE tag, or you can move an entire (sub)tree to a different
819 * ARCHIVE tag:: Marking a tree as inactive
820 * Moving subtrees:: Moving a tree to an archive file
823 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
825 2.6.1 The ARCHIVE tag
826 ---------------------
828 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
829 its location in the outline tree, but behaves in the following way:
830 - It does not open when you attempt to do so with a visibility
831 cycling command (*note Visibility cycling::). You can force
832 cycling archived subtrees with `C-<TAB>', or by setting the option
833 `org-cycle-open-archived-trees'. Also normal outline commands like
834 `show-all' will open archived subtrees.
836 - During sparse tree construction (*note Sparse trees::), matches in
837 archived subtrees are not exposed, unless you configure the option
838 `org-sparse-tree-open-archived-trees'.
840 - During agenda view construction (*note Agenda views::), the
841 content of archived trees is ignored unless you configure the
842 option `org-agenda-skip-archived-trees'.
844 - Archived trees are not exported (*note Exporting::), only the
845 headline is. Configure the details using the variable
846 `org-export-with-archived-trees'.
848 The following commands help managing the ARCHIVE tag:
851 Toggle the ARCHIVE tag for the current headline. When the tag is
852 set, the headline changes to a shadowish face, and the subtree
856 Check if any direct children of the current headline should be
857 archived. To do this, each subtree is checked for open TODO
858 entries. If none are found, the command offers to set the ARCHIVE
859 tag for the child. If the cursor is _not_ on a headline when this
860 command is invoked, the level 1 trees will be checked.
863 Cycle a tree even if it is tagged with ARCHIVE.
866 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
868 2.6.2 Moving subtrees
869 ---------------------
871 Once an entire project is finished, you may want to move it to a
872 different location, either in the current file, or even in a different
873 file, the archive file.
876 Archive the subtree starting at the cursor position to the location
877 given by `org-archive-location'. Context information that could be
878 lost like the file name, the category, inherited tags, and the todo
879 state will be store as properties in the entry.
882 Check if any direct children of the current headline could be
883 moved to the archive. To do this, each subtree is checked for
884 open TODO entries. If none are found, the command offers to move
885 it to the archive location. If the cursor is _not_ on a headline
886 when this command is invoked, the level 1 trees will be checked.
888 The default archive location is a file in the same directory as the
889 current file, with the name derived by appending `_archive' to the
890 current file name. For information and examples on how to change this,
891 see the documentation string of the variable `org-archive-location'.
892 There is also an in-buffer option for setting this variable, for
897 If you would like to have a special ARCHIVE location for a single entry
898 or a (sub)tree, give the entry an `:ARCHIVE:' property with the
899 location as the value (*note Properties and columns::).
901 ---------- Footnotes ----------
903 (1) For backward compatibility, the following also works: If there
904 are several such lines in a file, each specifies the archive location
905 for the text below it. The first such line also applies to any text
906 before its definition. However, using this method is _strongly_
907 deprecated as it is incompatible with the outline structure of the
908 document. The correct method for setting multiple archive locations in
909 a buffer is using a property.
912 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
917 An important feature of Org-mode is the ability to construct _sparse
918 trees_ for selected information in an outline tree. A sparse tree
919 means that the entire document is folded as much as possible, but the
920 selected information is made visible along with the headline structure
921 above it(1). Just try it out and you will see immediately how it works.
923 Org-mode contains several commands creating such trees, all these
924 commands can be accessed through a dispatcher:
927 This prompts for an extra key to select a sparse-tree creating
931 Occur. Prompts for a regexp and shows a sparse tree with all
932 matches. If the match is in a headline, the headline is made
933 visible. If the match is in the body of an entry, headline and
934 body are made visible. In order to provide minimal context, also
935 the full hierarchy of headlines above the match is shown, as well
936 as the headline following the match. Each match is also
937 highlighted; the highlights disappear when the buffer is changed
938 by an editing command, or by pressing `C-c C-c'. When called with
939 a `C-u' prefix argument, previous highlights are kept, so several
940 calls to this command can be stacked.
941 For frequently used sparse trees of specific search strings, you can
942 use the variable `org-agenda-custom-commands' to define fast keyboard
943 access to specific sparse trees. These commands will then be
944 accessible through the agenda dispatcher (*note Agenda dispatcher::).
947 (setq org-agenda-custom-commands
948 '(("f" occur-tree "FIXME")))
950 will define the key `C-c a f' as a shortcut for creating a sparse tree
951 matching the string `FIXME'.
953 The other sparse tree commands select headings based on TODO
954 keywords, tags, or properties and will be discussed later in this
957 To print a sparse tree, you can use the Emacs command
958 `ps-print-buffer-with-faces' which does not print invisible parts of
959 the document (2). Or you can use the command `C-c C-e v' to export
960 only the visible part of the document and print the resulting file.
962 ---------- Footnotes ----------
964 (1) See also the variables `org-show-hierarchy-above',
965 `org-show-following-heading', and `org-show-siblings' for detailed
966 control on how much context is shown around each match.
968 (2) This does not work under XEmacs, because XEmacs uses selective
969 display for outlining, not text properties.
972 File: org, Node: Plain lists, Next: Drawers, Prev: Sparse trees, Up: Document structure
977 Within an entry of the outline tree, hand-formatted lists can provide
978 additional structure. They also provide a way to create lists of
979 checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
980 and the HTML exporter (*note Exporting::) does parse and format them.
982 Org-mode knows ordered and unordered lists. Unordered list items
983 start with `-', `+', or `*'(1) as bullets. Ordered list items start
984 with `1.' or `1)'. Items belonging to the same list must have the same
985 indentation on the first line. In particular, if an ordered list
986 reaches number `10.', then the 2-digit numbers must be written
987 left-aligned with the other numbers in the list. Indentation also
988 determines the end of a list item. It ends before the next line that
989 is indented like the bullet/number, or less. Empty lines are part of
990 the previous item, so you can have several paragraphs in one item. If
991 you would like an empty line to terminate all currently open plain
992 lists, configure the variable `org-empty-line-terminates-plain-lists'.
996 My favorite scenes are (in this order)
997 1. The attack of the Rohirrim
998 2. Eowyns fight with the witch king
999 + this was already my favorite scene in the book
1000 + I really like Miranda Otto.
1001 3. Peter Jackson being shot by Legolas
1003 He makes a really funny face when it happens.
1004 But in the end, not individual scenes matter but the film as a whole.
1006 Org-mode supports these lists by tuning filling and wrapping
1007 commands to deal with them correctly(2).
1009 The following commands act on items when the cursor is in the first
1010 line of an item (the line with the bullet or number).
1013 Items can be folded just like headline levels if you set the
1014 variable `org-cycle-include-plain-lists'. The level of an item is
1015 then given by the indentation of the bullet/number. Items are
1016 always subordinate to real headlines, however; the hierarchies
1017 remain completely separated.
1019 If `org-cycle-include-plain-lists' has not been set, <TAB> fixes
1020 the indentation of the curent line in a heuristic way.
1023 Insert new item at current level. With prefix arg, force a new
1024 heading (*note Structure editing::). If this command is used in
1025 the middle of a line, the line is _split_ and the rest of the line
1026 becomes the new item. If this command is executed in the
1027 _whitespace before a bullet or number_, the new item is created
1028 _before_ the current item. If the command is executed in the
1029 white space before the text that is part of an item but does not
1030 contain the bullet, a bullet is added to the current line.
1033 Insert a new item with a checkbox (*note Checkboxes::).
1037 Jump to the previous/next item in the current list.
1041 Move the item including subitems up/down (swap with previous/next
1042 item of same indentation). If the list is ordered, renumbering is
1047 Decrease/increase the indentation of the item, including subitems.
1048 Initially, the item tree is selected based on current indentation.
1049 When these commands are executed several times in direct
1050 succession, the initially selected region is used, even if the new
1051 indentation would imply a different hierarchy. To use the new
1052 hierarchy, break the command chain with a cursor motion or so.
1055 If there is a checkbox (*note Checkboxes::) in the item line,
1056 toggle the state of the checkbox. If not, make this command makes
1057 sure that all the items on this list level use the same bullet.
1058 Furthermore, if this is an ordered list, make sure the numbering
1062 Cycle the entire list level through the different itemize/enumerate
1063 bullets (`-', `+', `*', `1.', `1)'). With prefix arg, select the
1064 nth bullet from this list.
1066 ---------- Footnotes ----------
1068 (1) When using `*' as a bullet, lines must be indented or they will
1069 be seen as top-level headlines. Also, when you are hiding leading
1070 stars to get a clean outline view, plain list items starting with a
1071 star are visually indistinguishable from true headlines. In short:
1072 even though `*' is supported, it may be better not to use it for plain
1075 (2) Org-mode only changes the filling settings for Emacs. For
1076 XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn this on,
1077 put into `.emacs': `(require 'filladapt)'
1080 File: org, Node: Drawers, Next: orgstruct-mode, Prev: Plain lists, Up: Document structure
1085 Sometimes you want to keep information associated with an entry, but you
1086 normally don't want to see it. For this, Org-mode has _drawers_.
1087 Drawers need to be configured with the variable `org-drawers'(1), and
1090 ** This is a headline
1091 Still outside the drawer
1093 This is inside the drawer.
1097 Visibility cycling (*note Visibility cycling::) on the headline will
1098 hide and show the entry, but keep the drawer collapsed to a single line.
1099 In order to look inside the drawer, you need to move the cursor to the
1100 drawer line and press <TAB> there. Org-mode uses a drawer for storing
1101 properties (*note Properties and columns::).
1103 ---------- Footnotes ----------
1105 (1) You can define drawers on a per-file basis with a line like
1106 `#+DRAWERS: HIDDEN PROPPERTIES STATE'
1109 File: org, Node: orgstruct-mode, Prev: Drawers, Up: Document structure
1111 2.10 The Orgstruct minor mode
1112 =============================
1114 If you like the intuitive way the Org-mode structure editing and list
1115 formatting works, you might want to use these commands in other modes
1116 like text-mode or mail-mode as well. The minor mode Orgstruct-mode
1117 makes this possible. You can always toggle the mode with `M-x
1118 orgstruct-mode'. To turn it on by default, for example in mail mode,
1121 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1123 When this mode is active and the cursor is on a line that looks to
1124 Org-mode like a headline of the first line of a list item, most
1125 structure editing commands will work, even if the same keys normally
1126 have different functionality in the major mode you are using. If the
1127 cursor is not in one of those special lines, Orgstruct-mode lurks
1128 silently in the shadow.
1131 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
1136 Org-mode has a very fast and intuitive table editor built-in.
1137 Spreadsheet-like calculations are supported in connection with the
1138 Emacs `calc' package.
1142 * Built-in table editor:: Simple tables
1143 * Narrow columns:: Stop wasting space in tables
1144 * Column groups:: Grouping to trigger vertical lines
1145 * orgtbl-mode:: The table editor as minor mode
1146 * The spreadsheet:: The table editor has spreadsheet capabilities.
1149 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
1151 3.1 The built-in table editor
1152 =============================
1154 Org-mode makes it easy to format tables in plain ASCII. Any line with
1155 `|' as the first non-whitespace character is considered part of a
1156 table. `|' is also the column separator. A table might look like this:
1158 | Name | Phone | Age |
1159 |-------+-------+-----|
1160 | Peter | 1234 | 17 |
1161 | Anna | 4321 | 25 |
1163 A table is re-aligned automatically each time you press <TAB> or
1164 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
1165 field (<RET> to the next row) and creates new table rows at the end of
1166 the table or before horizontal lines. The indentation of the table is
1167 set by the first line. Any line starting with `|-' is considered as a
1168 horizontal separator line and will be expanded on the next re-align to
1169 span the whole table width. So, to create the above table, you would
1175 and then press <TAB> to align the table and start filling in fields.
1177 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
1178 and all character keys in a special way, so that inserting and deleting
1179 avoids shifting other fields. Also, when typing _immediately after the
1180 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
1181 the field is automatically made blank. If this behavior is too
1182 unpredictable for you, configure the variables
1183 `org-enable-table-editor' and `org-table-auto-blank-field'.
1185 Creation and conversion
1186 .......................
1189 Convert the active region to table. If every line contains at
1190 least one TAB character, the function assumes that the material is
1191 tab separated. If every line contains a comma, comma-separated
1192 values (CSV) are assumed. If not, lines are split at whitespace
1193 into fields. You can use a prefix argument to force a specific
1194 separator: `C-u' forces CSV, `C-u C-u' forces TAB, and a numeric
1195 argument N indicates that at least N consequtive spaces, or
1196 alternatively a TAB will be the separator.
1197 If there is no active region, this command creates an empty
1198 Org-mode table. But it's easier just to start typing, like
1199 `|Name|Phone|Age <RET> |- <TAB>'.
1201 Re-aligning and field motion
1202 ............................
1205 Re-align the table without moving the cursor.
1208 Re-align the table, move to the next field. Creates a new row if
1212 Re-align, move to previous field.
1215 Re-align the table and move down to next row. Creates a new row if
1216 necessary. At the beginning or end of a line, <RET> still does
1217 NEWLINE, so it can be used to split a table.
1219 Column and row editing
1220 ......................
1224 Move the current column left/right.
1227 Kill the current column.
1230 Insert a new column to the left of the cursor position.
1234 Move the current row up/down.
1237 Kill the current row or horizontal line.
1240 Insert a new row above (with arg: below) the current row.
1243 Insert a horizontal line below current row. With prefix arg, the
1244 line is created above the current line.
1247 Sort the table lines in the region. The position of point
1248 indicates the column to be used for sorting, and the range of
1249 lines is the range between the nearest horizontal separator lines,
1250 or the entire table. If point is before the first column, you
1251 will be prompted for the sorting column. If there is an active
1252 region, the mark specifies the first line and the sorting column,
1253 while point should be in the last line to be included into the
1254 sorting. The command prompts for the sorting type
1255 (alphabetically, numerically, or by time). When called with a
1256 prefix argument, alphabetic sorting will be case-sensitive.
1262 Copy a rectangular region from a table to a special clipboard.
1263 Point and mark determine edge fields of the rectangle. The
1264 process ignores horizontal separator lines.
1267 Copy a rectangular region from a table to a special clipboard, and
1268 blank all fields in the rectangle. So this is the "cut" operation.
1271 Paste a rectangular region into a table. The upper right corner
1272 ends up in the current field. All involved fields will be
1273 overwritten. If the rectangle does not fit into the present table,
1274 the table is enlarged as needed. The process ignores horizontal
1278 Wrap several fields in a column like a paragraph. If there is an
1279 active region, and both point and mark are in the same column, the
1280 text in the column is wrapped to minimum width for the given
1281 number of lines. A prefix ARG may be used to change the number of
1282 desired lines. If there is no region, the current field is split
1283 at the cursor position and the text fragment to the right of the
1284 cursor is prepended to the field one line down. If there is no
1285 region, but you specify a prefix ARG, the current field is made
1286 blank, and the content is appended to the field above.
1292 Sum the numbers in the current column, or in the rectangle defined
1293 by the active region. The result is shown in the echo area and can
1294 be inserted with `C-y'.
1297 When current field is empty, copy from first non-empty field above.
1298 When not empty, copy current field down to next row and move cursor
1299 along with it. Depending on the variable
1300 `org-table-copy-increment', integer field values will be
1301 incremented during copy. This key is also used by CUA-mode (*note
1308 Edit the current field in a separate window. This is useful for
1309 fields that are not fully visible (*note Narrow columns::). When
1310 called with a `C-u' prefix, just make the full field visible, so
1311 that it can be edited in place.
1314 This is an alias for `C-u C-c `' to make the current field fully
1317 `M-x org-table-import'
1318 Import a file as a table. The table should be TAB- or whitespace
1319 separated. Useful, for example, to import a spreadsheet table or
1320 data from a database, because these programs generally can write
1321 TAB-separated text files. This command works by inserting the
1322 file into the buffer and then converting the region to a table.
1323 Any prefix argument is passed on to the converter, which uses it
1324 to determine the separator.
1327 Tables can also be imported by pasting tabular text into the
1328 org-mode buffer, selecting the pasted text with `C-x C-x' and then
1329 using the `C-c |' command (see above under Creation and conversion.
1331 `M-x org-table-export'
1332 Export the table as a TAB-separated file. Useful for data
1333 exchange with, for example, spreadsheet or database programs.
1335 If you don't like the automatic table editor because it gets in your
1336 way on lines which you would like to start with `|', you can turn it
1339 (setq org-enable-table-editor nil)
1341 Then the only table command that still works is `C-c C-c' to do a
1345 File: org, Node: Narrow columns, Next: Column groups, Prev: Built-in table editor, Up: Tables
1350 The width of columns is automatically determined by the table editor.
1351 Sometimes a single field or a few fields need to carry more text,
1352 leading to inconveniently wide columns. To limit(1) the width of a
1353 column, one field anywhere in the column may contain just the string
1354 `<N>' where `N' is an integer specifying the width of the column in
1355 characters. The next re-align will then set the width of this column
1356 to no more than this value.
1358 |---+------------------------------| |---+--------|
1360 | 1 | one | | 1 | one |
1361 | 2 | two | ----\ | 2 | two |
1362 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1363 | 4 | four | | 4 | four |
1364 |---+------------------------------| |---+--------|
1366 Fields that are wider become clipped and end in the string `=>'. Note
1367 that the full text is still in the buffer, it is only invisible. To
1368 see the full text, hold the mouse over the field - a tool-tip window
1369 will show the full content. To edit such a field, use the command `C-c
1370 `' (that is `C-c' followed by the backquote). This will open a new
1371 window with the full field. Edit it and finish with `C-c C-c'.
1373 When visiting a file containing a table with narrowed columns, the
1374 necessary character hiding has not yet happened, and the table needs to
1375 be aligned before it looks nice. Setting the option
1376 `org-startup-align-all-tables' will realign all tables in a file upon
1377 visiting, but also slow down startup. You can also set this option on
1378 a per-file basis with:
1383 ---------- Footnotes ----------
1385 (1) This feature does not work on XEmacs.
1388 File: org, Node: Column groups, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1393 When Org-mode exports tables, it does so by default without vertical
1394 lines because that is visually more satisfying in general. Occasionally
1395 however, vertical lines can be useful to structure a table into groups
1396 of columns, much like horizontal lines can do for groups of rows. In
1397 order to specify column groups, you can use a special row where the
1398 first field contains only `/'. The further fields can either contain
1399 `<' to indicate that this column should start a group, `>' to indicate
1400 the end of a column, or `<>' to make a column a group of its own.
1401 Boundaries between colum groups will upon export be marked with
1402 vertical lines. Here is an example:
1404 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1405 |---+----+-----+-----+-----+---------+------------|
1406 | / | <> | < | | > | < | > |
1407 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1408 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1409 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1410 |---+----+-----+-----+-----+---------+------------|
1411 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
1413 It is also sufficient to just insert the colum group starters after
1414 every vertical line you'd like to have:
1416 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1417 |----+-----+-----+-----+---------+------------|
1421 File: org, Node: orgtbl-mode, Next: The spreadsheet, Prev: Column groups, Up: Tables
1423 3.4 The Orgtbl minor mode
1424 =========================
1426 If you like the intuitive way the Org-mode table editor works, you
1427 might also want to use it in other modes like text-mode or mail-mode.
1428 The minor mode Orgtbl-mode makes this possible. You can always toggle
1429 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1432 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1434 Furthermore, with some special setup, it is possible to maintain
1435 tables in arbitrary syntax with Orgtbl-mode. For example, it is
1436 possible to construct LaTeX tables with the underlying ease and power of
1437 Orgtbl-mode, including spreadsheet capabilities. For details, see
1438 *Note Tables in arbitrary syntax::.
1441 File: org, Node: The spreadsheet, Prev: orgtbl-mode, Up: Tables
1446 The table editor makes use of the Emacs `calc' package to implement
1447 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1448 derive fields from other fields. While fully featured, Org-mode's
1449 implementation is not identical to other spreadsheets. For example,
1450 Org-mode knows the concept of a _column formula_ that will be applied
1451 to all non-header fields in a column without having to copy the formula
1452 to each relevant field.
1456 * References:: How to refer to another field or range
1457 * Formula syntax for Calc:: Using Calc to compute stuff
1458 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1459 * Field formulas:: Formulas valid for a single field
1460 * Column formulas:: Formulas valid for an entire column
1461 * Editing and debugging formulas:: Fixing formulas
1462 * Updating the table:: Recomputing all dependent fields
1463 * Advanced features:: Field names, parameters and automatic recalc
1466 File: org, Node: References, Next: Formula syntax for Calc, Prev: The spreadsheet, Up: The spreadsheet
1471 To compute fields in the table from other fields, formulas must
1472 reference other fields or ranges. In Org-mode, fields can be referenced
1473 by name, by absolute coordinates, and by relative coordinates. To find
1474 out what the coordinates of a field are, press `C-c ?' in that field,
1475 or press `C-c }' to toggle the display of a grid.
1480 Formulas can reference the value of another field in two ways. Like in
1481 any other spreadsheet, you may reference fields with a letter/number
1482 combination like `B3', meaning the 2nd field in the 3rd row.
1484 Org-mode also uses another, more general operator that looks like this:
1487 Column references can be absolute like `1', `2',...`N', or relative to
1488 the current column like `+1' or `-2'.
1490 The row specification only counts data lines and ignores horizontal
1491 separator lines (hlines). You can use absolute row numbers `1'...`N',
1492 and row numbers relative to the current row like `+3' or `-1'. Or
1493 specify the row relative to one of the hlines: `I' refers to the first
1494 hline(1), `II' to the second etc. `-I' refers to the first such line
1495 above the current line, `+I' to the first such line below the current
1496 line. You can also write `III+2' which is the second data line after
1497 the third hline in the table. Relative row numbers like `-3' will not
1498 cross hlines if the current line is too close to the hline. Instead,
1499 the value directly at the hline is used.
1501 `0' refers to the current row and column. Also, if you omit either
1502 the column or the row part of the reference, the current row/column is
1505 Org-mode's references with _unsigned_ numbers are fixed references
1506 in the sense that if you use the same reference in the formula for two
1507 different fields, the same field will be referenced each time.
1508 Org-mode's references with _signed_ numbers are floating references
1509 because the same reference operator can reference different fields
1510 depending on the field being calculated by the formula.
1512 Here are a few examples:
1514 @2$3 2nd row, 3rd column
1516 $5 column 5 in the current row
1518 @2 current column, row 2
1519 @-1$-3 the field one row up, three columns to the left
1520 @-I$2 field just under hline above current row, column 2
1525 You may reference a rectangular range of fields by specifying two field
1526 references connected by two dots `..'. If both fields are in the
1527 current row, you may simply use `$2..$7', but if at least one field is
1528 in a different row, you need to use the general `@row$column' format at
1529 least for the first field (i.e the reference must start with `@' in
1530 order to be interpreted correctly). Examples:
1532 $1..$3 First three fields in the current row.
1533 $P..$Q Range, using column names (see under Advanced)
1534 @2$1..@4$3 6 fields between these two fields.
1535 A2..C4 Same as above.
1536 @-1$-2..@-1 3 numbers from the column to the left, 2 up to current row
1538 Range references return a vector of values that can be fed into Calc
1539 vector functions. Empty fields in ranges are normally suppressed, so
1540 that the vector contains only the non-empty fields (but see the `E'
1541 mode switch below). If there are no non-empty fields, `[0]' is
1542 returned to avoid syntax errors in formulas.
1547 `$name' is interpreted as the name of a column, parameter or constant.
1548 Constants are defined globally through the variable
1549 `org-table-formula-constants', and locally (for the file) through a
1552 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
1554 Also properties (*note Properties and columns::) can be used as
1555 constants in table formulas: For a property `:XYZ:' use the name
1556 `$PROP_XYZ', and the property will be searched in the current outline
1557 entry and in the hierarchy above it. If you have the `constants.el'
1558 package, it will also be used to resolve constants, including natural
1559 constants like `$h' for Planck's constant, and units like `$km' for
1560 kilometers(2). Column names and parameters can be specified in special
1561 table lines. These are described below, see *Note Advanced features::.
1562 All names must start with a letter, and further consist of letters and
1565 ---------- Footnotes ----------
1567 (1) Note that only hlines are counted that _separate_ table lines.
1568 If the table starts with a hline above the header, it does not count.
1570 (2) `Constant.el' can supply the values of constants in two
1571 different unit systems, `SI' and `cgs'. Which one is used depends on
1572 the value of the variable `constants-unit-system'. You can use the
1573 `#+STARTUP' options `constSI' and `constcgs' to set this value for the
1577 File: org, Node: Formula syntax for Calc, Next: Formula syntax for Lisp, Prev: References, Up: The spreadsheet
1579 3.5.2 Formula syntax for Calc
1580 -----------------------------
1582 A formula can be any algebraic expression understood by the Emacs
1583 `Calc' package. Note that `calc' has the non-standard convention that
1584 `/' has lower precedence than `*', so that `a/b*c' is interpreted as
1585 `a/(b*c)'. Before evaluation by `calc-eval' (*note calc-eval:
1586 (calc)Calling Calc from Your Programs.), variable substitution takes
1587 place according to the rules described above. The range vectors can be
1588 directly fed into the calc vector functions like `vmean' and `vsum'.
1590 A formula can contain an optional mode string after a semicolon.
1591 This string consists of flags to influence Calc and other modes during
1592 execution. By default, Org-mode uses the standard calc modes (precision
1593 12, angular units degrees, fraction and symbolic modes off. The display
1594 format, however, has been changed to `(float 5)' to keep tables
1595 compact. The default settings can be configured using the variable
1596 `org-calc-default-modes'.
1598 p20 switch the internal precision to 20 digits
1599 n3 s3 e2 f4 normal, scientific, engineering, or fixed display format
1600 D R angle modes: degrees, radians
1601 F S fraction and symbolic modes
1602 N interpret all fields as numbers, use 0 for non-numbers
1603 T force text interpretation
1604 E keep empty fields in ranges
1606 In addition, you may provide a `printf' format specifier to reformat
1607 the final result. A few examples:
1609 $1+$2 Sum of first and second field
1610 $1+$2;%.2f Same, format result to two decimals
1611 exp($2)+exp($1) Math functions can be used
1612 $0;%.1f Reformat current cell to 1 decimal
1613 ($3-32)*5/9 Degrees F -> C conversion
1614 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1615 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1616 sin($1);Dp3%.1e Same, but use printf specifier for display
1617 vmean($2..$7) Compute column range mean, using vector function
1618 vmean($2..$7);EN Same, but treat empty fields as 0
1619 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1621 Calc also contains a complete set of logical operations. For example
1623 if($1<20,teen,string("")) "teen" if age $1 less than 20, else empty
1626 File: org, Node: Formula syntax for Lisp, Next: Field formulas, Prev: Formula syntax for Calc, Up: The spreadsheet
1628 3.5.3 Emacs Lisp forms as formulas
1629 ----------------------------------
1631 It is also possible to write a formula in Emacs Lisp; this can be useful
1632 for string manipulation and control structures, if the Calc's
1633 functionality is not enough. If a formula starts with a single quote
1634 followed by an opening parenthesis, then it is evaluated as a lisp form.
1635 The evaluation should return either a string or a number. Just as with
1636 `calc' formulas, you can specify modes and a printf format after a
1637 semicolon. With Emacs Lisp forms, you need to be concious about the way
1638 field references are interpolated into the form. By default, a
1639 reference will be interpolated as a Lisp string (in double quotes)
1640 containing the field. If you provide the `N' mode switch, all
1641 referenced elements will be numbers (non-number fields will be zero) and
1642 interpolated as Lisp numbers, without quotes. If you provide the `L'
1643 flag, all fields will be interpolated literally, without quotes. I.e.,
1644 if you want a reference to be interpreted as a string by the Lisp form,
1645 enclode the reference operator itself in double quotes, like `"$3"'.
1646 Ranges are inserted as space-separated fields, so you can embed them in
1647 list or vector syntax. A few examples, note how the `N' mode is used
1648 when we do computations in lisp.
1650 Swap the first two characters of the content of column 1
1651 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1652 Add columns 1 and 2, equivalent to the Calc's `$1+$2'
1654 Compute the sum of columns 1-4, like Calc's `vsum($1..$4)'
1655 '(apply '+ '($1..$4));N
1658 File: org, Node: Field formulas, Next: Column formulas, Prev: Formula syntax for Lisp, Up: The spreadsheet
1660 3.5.4 Field formulas
1661 --------------------
1663 To assign a formula to a particular field, type it directly into the
1664 field, preceded by `:=', for example `:=$1+$2'. When you press <TAB>
1665 or <RET> or `C-c C-c' with the cursor still in the field, the formula
1666 will be stored as the formula for this field, evaluated, and the
1667 current field replaced with the result.
1669 Formulas are stored in a special line starting with `#+TBLFM:'
1670 directly below the table. If you typed the equation in the 4th field of
1671 the 3rd data line in the table, the formula will look like
1672 `@3$4=$1+$2'. When inserting/deleting/swapping column and rows with
1673 the appropriate commands, absolute references (but not relative ones)
1674 in stored formulas are modified in order to still reference the same
1675 field. Of cause this is not true if you edit the table structure with
1676 normal editing commands - then you must fix the equations yourself.
1678 Instead of typing an equation into the field, you may also use the
1682 Install a new formula for the current field. The command prompts
1683 for a formula, with default taken from the `#+TBLFM:' line, applies
1684 it to the current field and stores it.
1687 File: org, Node: Column formulas, Next: Editing and debugging formulas, Prev: Field formulas, Up: The spreadsheet
1689 3.5.5 Column formulas
1690 ---------------------
1692 Often in a table, the same formula should be used for all fields in a
1693 particular column. Instead of having to copy the formula to all fields
1694 in that column, org-mode allows to assign a single formula to an entire
1695 column. If the table contains horizontal separator hlines, everything
1696 before the first such line is considered part of the table _header_ and
1697 will not be modified by column formulas.
1699 To assign a formula to a column, type it directly into any field in
1700 the column, preceded by an equal sign, like `=$1+$2'. When you press
1701 <TAB> or <RET> or `C-c C-c' with the cursor still in the field, the
1702 formula will be stored as the formula for the current column, evaluated
1703 and the current field replaced with the result. If the field contains
1704 only `=', the previously stored formula for this column is used. For
1705 each column, Org-mode will only remember the most recently used
1706 formula. In the `TBLFM:' line, column formulas will look like
1709 Instead of typing an equation into the field, you may also use the
1713 Install a new formula for the current column and replace current
1714 field with the result of the formula. The command prompts for a
1715 formula, with default taken from the `#+TBLFM' line, applies it to
1716 the current field and stores it. With a numerical prefix (e.g.
1717 `C-5 C-c =') will apply it to that many consecutive fields in the
1721 File: org, Node: Editing and debugging formulas, Next: Updating the table, Prev: Column formulas, Up: The spreadsheet
1723 3.5.6 Editing and Debugging formulas
1724 ------------------------------------
1726 You can edit individual formulas in the minibuffer or directly in the
1727 field. Org-mode can also prepare a special buffer with all active
1728 formulas of a table. When offering a formula for editing, Org-mode
1729 converts references to the standard format (like `B3' or `D&') if
1730 possible. If you prefer to only work with the internal format (like
1731 `@3$2' or `$4'), configure the variable
1732 `org-table-use-standard-references'.
1736 Edit the formula associated with the current column/field in the
1737 minibuffer. See *Note Column formulas:: and *Note Field
1741 Re-insert the active formula (either a field formula, or a column
1742 formula) into the current field, so that you can edit it directly
1743 in the field. The advantage over editing in the minibuffer is
1744 that you can use the command `C-c ?'.
1747 While editing a formula in a table field, highlight the field(s)
1748 referenced by the reference at the cursor position in the formula.
1751 Toggle the display of row and column numbers for a table, using
1752 overlays. These are updated each time the table is aligned, you
1753 can force it with `C-c C-c'.
1756 Toggle the formula debugger on and off. See below.
1759 Edit all formulas for the current table in a special buffer, where
1760 the formulas will be displayed one per line. If the current field
1761 has an active formula, the cursor in the formula editor will mark
1762 it. While inside the special buffer, Org-mode will automatically
1763 highlight any field or range reference at the cursor position.
1764 You may edit, remove and add formulas, and use the following
1768 Exit the formula editor and store the modified formulas.
1769 With `C-u' prefix, also apply the new formulas to the entire
1773 Exit the formula editor without installing changes.
1776 Toggle all references in the formula editor between standard
1777 (like `B3') and internal (like `@3$2').
1780 Pretty-print or indent lisp formula at point. When in a line
1781 containing a lisp formula, format the formula according to
1782 Emacs Lisp rules. Another <TAB> collapses the formula back
1783 again. In the open formula, <TAB> re-indents just like in
1787 Complete Lisp symbols, just like in Emacs-lisp-mode.
1789 `S-<up>/<down>/<left>/<right>'
1790 Shift the reference at point. For example, if the reference
1791 is `B3' and you press `S-<right>', it will become `C3'. This
1792 also works for relative references, and for hline references.
1795 Move the test line for column formulas in the Org-mode buffer
1799 Scroll the window displaying the table.
1802 Turn the coordinate grid in the table on and off.
1804 Making a table field blank does not remove the formula associated
1805 with the field, because that is stored in a different line (the `TBLFM'
1806 line) - during the next recalculation the field will be filled again.
1807 To remove a formula from a field, you have to give an empty reply when
1808 prompted for the formula, or to edit the `#+TBLFM' line.
1810 You may edit the `#+TBLFM' directly and re-apply the changed
1811 equations with `C-c C-c' in that line, or with the normal recalculation
1812 commands in the table.
1817 When the evaluation of a formula leads to an error, the field content
1818 becomes the string `#ERROR'. If you would like see what is going on
1819 during variable substitution and calculation in order to find a bug,
1820 turn on formula debugging in the `Tbl' menu and repeat the calculation,
1821 for example by pressing `C-u C-u C-c = <RET>' in a field. Detailed
1822 information will be displayed.
1825 File: org, Node: Updating the table, Next: Advanced features, Prev: Editing and debugging formulas, Up: The spreadsheet
1827 3.5.7 Updating the Table
1828 ------------------------
1830 Recalculation of a table is normally not automatic, but needs to be
1831 triggered by a command. See *Note Advanced features:: for a way to make
1832 recalculation at least semi-automatically.
1834 In order to recalculate a line of a table or the entire table, use
1835 the following commands:
1838 Recalculate the current row by first applying the stored column
1839 formulas from left to right, and all field formulas in the current
1844 Recompute the entire table, line by line. Any lines before the
1845 first hline are left alone, assuming that these are part of the
1850 Iterate the table by recomputing it until no further changes occur.
1851 This may be necessary if some computed fields use the value of
1852 other fields that are computed later in the calculation sequence.
1855 File: org, Node: Advanced features, Prev: Updating the table, Up: The spreadsheet
1857 3.5.8 Advanced features
1858 -----------------------
1860 If you want the recalculation of fields to happen automatically, or if
1861 you want to be able to assign names to fields and columns, you need to
1862 reserve the first column of the table for special marking characters.
1864 Rotate the calculation mark in first column through the states `',
1865 `#', `*', `!', `$'. The meaning of these characters is discussed
1866 below. When there is an active region, change all marks in the
1869 Here is an example of a table that collects exam results of students
1870 and makes use of these features:
1872 |---+---------+--------+--------+--------+-------+------|
1873 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1874 |---+---------+--------+--------+--------+-------+------|
1875 | ! | | P1 | P2 | P3 | Tot | |
1876 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1877 | ^ | | m1 | m2 | m3 | mt | |
1878 |---+---------+--------+--------+--------+-------+------|
1879 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1880 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1881 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1882 |---+---------+--------+--------+--------+-------+------|
1883 | | Average | | | | 29.7 | |
1884 | ^ | | | | | at | |
1885 | $ | max=50 | | | | | |
1886 |---+---------+--------+--------+--------+-------+------|
1887 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
1889 Important: Please note that for these special tables, recalculating the
1890 table with `C-u C-c *' will only affect rows that are marked `#' or
1891 `*', and fields that have a formula assigned to the field itself. The
1892 column formulas are not applied in rows with empty first field.
1894 The marking characters have the following meaning:
1896 The fields in this line define names for the columns, so that you
1897 may refer to a column as `$Tot' instead of `$6'.
1900 This row defines names for the fields _above_ the row. With such
1901 a definition, any formula in the table may use `$m1' to refer to
1902 the value `10'. Also, if you assign a formula to a names field, it
1903 will be stored as `$name=...'.
1906 Similar to `^', but defines names for the fields in the row
1910 Fields in this row can define _parameters_ for formulas. For
1911 example, if a field in a `$' row contains `max=50', then formulas
1912 in this table can refer to the value 50 using `$max'. Parameters
1913 work exactly like constants, only that they can be defined on a
1917 Fields in this row are automatically recalculated when pressing
1918 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1919 selected for a global recalculation with `C-u C-c *'. Unmarked
1920 lines will be left alone by this command.
1923 Selects this line for global recalculation with `C-u C-c *', but
1924 not for automatic recalculation. Use this when automatic
1925 recalculation slows down editing too much.
1928 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1929 All lines that should be recalculated should be marked with `#' or
1933 Do not export this line. Useful for lines that contain the
1934 narrowing `<N>' markers.
1936 Finally, just to whet your appetite on what can be done with the
1937 fantastic `calc' package, here is a table that computes the Taylor
1938 series of degree `n' at location `x' for a couple of functions
1939 (homework: try that with Excel :-)
1941 |---+-------------+---+-----+--------------------------------------|
1942 | | Func | n | x | Result |
1943 |---+-------------+---+-----+--------------------------------------|
1944 | # | exp(x) | 1 | x | 1 + x |
1945 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1946 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1947 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1948 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1949 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1950 |---+-------------+---+-----+--------------------------------------|
1951 #+TBLFM: $5=taylor($2,$4,$3);n3
1954 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1959 Just like HTML, Org-mode provides links inside a file, and external
1960 links to other files, Usenet articles, emails, and much more.
1964 * Link format:: How links in Org-mode are formatted
1965 * Internal links:: Links to other places in the current file
1966 * External links:: URL-like links to the world
1967 * Handling links:: Creating, inserting and following
1968 * Using links outside Org-mode:: Linking from my C source code?
1969 * Link abbreviations:: Shortcuts for writing complex links
1970 * Search options:: Linking to a specific location
1971 * Custom searches:: When the default search is not enough
1974 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1979 Org-mode will recognize plain URL-like links and activate them as
1980 clickable links. The general link format, however, looks like this:
1982 [[link][description]] or alternatively [[link]]
1984 Once a link in the buffer is complete (all brackets present),
1985 Org-mode will change the display so that `description' is displayed
1986 instead of `[[link][description]]' and `link' is displayed instead of
1987 `[[link]]'. Links will be highlighted in the face `org-link', which by
1988 default is an underlined face. You can directly edit the visible part
1989 of a link. Note that this can be either the `link' part (if there is
1990 no description) or the `description' part. To edit also the invisible
1991 `link' part, use `C-c C-l' with the cursor on the link.
1993 If you place the cursor at the beginning or just behind the end of
1994 the displayed text and press <BACKSPACE>, you will remove the
1995 (invisible) bracket at that location. This makes the link incomplete
1996 and the internals are again displayed as plain text. Inserting the
1997 missing bracket hides the link internals again. To show the internal
1998 structure of all links, use the menu entry `Org->Hyperlinks->Literal
2002 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
2007 If the link does not look like a URL, it is considered to be internal in
2008 the current file. Links such as `[[My Target]]' or `[[My Target][Find
2009 my target]]' lead to a text search in the current file. The link can
2010 be followed with `C-c C-o' when the cursor is on the link, or with a
2011 mouse click (*note Handling links::). The preferred match for such a
2012 link is a dedicated target: the same string in double angular brackets.
2013 Targets may be located anywhere; sometimes it is convenient to put
2014 them into a comment line. For example
2018 In HTML export (*note HTML export::), such targets will become named
2019 anchors for direct access through `http' links(1).
2021 If no dedicated target exists, Org-mode will search for the words in
2022 the link. In the above example the search would be for `my target'.
2023 Links starting with a star like `*My Target' restrict the search to
2024 headlines. When searching, Org-mode will first try an exact match, but
2025 then move on to more and more lenient searches. For example, the link
2026 `[[*My Targets]]' will find any of the following:
2029 ** TODO my targets are bright
2030 ** my 20 targets are
2032 To insert a link targeting a headline, in-buffer completion can be
2033 used. Just type a star followed by a few optional letters into the
2034 buffer and press `M-<TAB>'. All headlines in the current buffer will be
2035 offered as completions. *Note Handling links::, for more commands
2038 Following a link pushes a mark onto Org-mode's own mark ring. You
2039 can return to the previous position with `C-c &'. Using this command
2040 several times in direct succession goes back to positions recorded
2045 * Radio targets:: Make targets trigger links in plain text.
2047 ---------- Footnotes ----------
2049 (1) Note that text before the first headline is usually not
2050 exported, so the first such target should be after the first headline.
2053 File: org, Node: Radio targets, Prev: Internal links, Up: Internal links
2058 Org-mode can automatically turn any occurrences of certain target names
2059 in normal text into a link. So without explicitly creating a link, the
2060 text connects to the target radioing its position. Radio targets are
2061 enclosed by triple angular brackets. For example, a target `<<<My
2062 Target>>>' causes each occurrence of `my target' in normal text to
2063 become activated as a link. The Org-mode file is scanned automatically
2064 for radio targets only when the file is first loaded into Emacs. To
2065 update the target list during editing, press `C-c C-c' with the cursor
2069 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
2074 Org-mode supports links to files, websites, Usenet and email messages,
2075 and BBDB database entries. External links are URL-like locators. They
2076 start with a short identifying string followed by a colon. There can be
2077 no space after the colon. The following list shows examples for each
2080 http://www.astro.uva.nl/~dominik on the web
2081 file:/home/dominik/images/jupiter.jpg file, absolute path
2082 file:papers/last.pdf file, relative path
2083 news:comp.emacs Usenet link
2084 mailto:adent@galaxy.net Mail link
2085 vm:folder VM folder link
2086 vm:folder#id VM message link
2087 vm://myself@some.where.org/folder#id VM on remote machine
2088 wl:folder WANDERLUST folder link
2089 wl:folder#id WANDERLUST message link
2090 mhe:folder MH-E folder link
2091 mhe:folder#id MH-E message link
2092 rmail:folder RMAIL folder link
2093 rmail:folder#id RMAIL message link
2094 gnus:group GNUS group link
2095 gnus:group#id GNUS article link
2096 bbdb:Richard Stallman BBDB link
2097 shell:ls *.org A shell command
2098 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
2100 A link should be enclosed in double brackets and may contain a
2101 descriptive text to be displayed instead of the url (*note Link
2102 format::), for example:
2104 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2106 If the description is a file name or URL that points to an image, HTML
2107 export (*note HTML export::) will inline the image as a clickable
2108 button. If there is no description at all and the link points to an
2109 image, that image will be inlined into the exported HTML file.
2111 Org-mode also finds external links in the normal text and activates
2112 them as links. If spaces must be part of the link (for example in
2113 `bbdb:Richard Stallman'), or if you need to remove ambiguities about
2114 the end of the link, enclose them in angular brackets.
2117 File: org, Node: Handling links, Next: Using links outside Org-mode, Prev: External links, Up: Hyperlinks
2122 Org-mode provides methods to create a link in the correct syntax, to
2123 insert it into an org-mode file, and to follow the link.
2126 Store a link to the current location. This is a _global_ command
2127 which can be used in any buffer to create a link. The link will be
2128 stored for later insertion into an Org-mode buffer (see below).
2129 For Org-mode files, if there is a `<<target>>' at the cursor, the
2130 link points to the target. Otherwise it points to the current
2131 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
2132 the link will indicate the current article/entry. For W3 and W3M
2133 buffers, the link goes to the current URL. For any other files,
2134 the link will point to the file, with a search string (*note
2135 Search options::) pointing to the contents of the current line.
2136 If there is an active region, the selected words will form the
2137 basis of the search string. If the automatically created link is
2138 not working correctly or accurately enough, you can write custom
2139 functions to select the search string and to do the search for
2140 particular file types - see *Note Custom searches::. The key
2141 binding `C-c l' is only a suggestion - see *Note Installation::.
2144 Insert a link. This prompts for a link to be inserted into the
2145 buffer. You can just type a link, using text for an internal
2146 link, or one of the link type prefixes mentioned in the examples
2147 above. All links stored during the current session are part of
2148 the history for this prompt, so you can access them with <up> and
2149 <down> (or `M-p/n'). Completion, on the other hand, will help you
2150 to insert valid link prefixes like `http:' or `ftp:', including
2151 the prefixes defined through link abbreviations (*note Link
2152 abbreviations::). The link will be inserted into the buffer(1),
2153 along with a descriptive text. If some text was selected when
2154 this command is called, the selected text becomes the default
2156 Note that you don't have to use this command to insert a link.
2157 Links in Org-mode are plain text, and you can type or paste them
2158 straight into the buffer. By using this command, the links are
2159 automatically enclosed in double brackets, and you will be asked
2160 for the optional descriptive text.
2163 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
2164 file will be inserted and you may use file name completion to
2165 select the name of the file. The path to the file is inserted
2166 relative to the directory of the current org file, if the linked
2167 file is in the current directory or in a subdirectory of it, or if
2168 the path is written relative to the current directory using `../'.
2169 Otherwise an absolute path is used, if possible with `~/' for
2170 your home directory. You can force an absolute path with two
2173 `C-c C-l (with cursor on existing link)'
2174 When the cursor is on an existing link, `C-c C-l' allows you to
2175 edit the link and description parts of the link.
2178 Open link at point. This will launch a web browser for URLs (using
2179 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
2180 the corresponding links, and execute the command in a shell link.
2181 When the cursor is on an internal link, this commands runs the
2182 corresponding search. When the cursor is on a TAG list in a
2183 headline, it creates the corresponding TAGS view. If the cursor
2184 is on a time stamp, it compiles the agenda for that date.
2185 Furthermore, it will visit text and remote files in `file:' links
2186 with Emacs and select a suitable application for local non-text
2187 files. Classification of files is based on file extension only.
2188 See option `org-file-apps'. If you want to override the default
2189 application and visit the file with Emacs, use a `C-u' prefix.
2193 On links, `mouse-2' will open the link just as `C-c C-o' would.
2194 Under Emacs 22, also `mouse-1' will follow a link.
2197 Like `mouse-2', but force file links to be opened with Emacs, and
2198 internal links to be displayed in another window(2).
2201 Push the current position onto the mark ring, to be able to return
2202 easily. Commands following an internal link do this automatically.
2205 Jump back to a recorded position. A position is recorded by the
2206 commands following internal links, and by `C-c %'. Using this
2207 command several times in direct succession moves through a ring of
2208 previously recorded positions.
2212 Move forward/backward to the next link in the buffer. At the
2213 limit of the buffer, the search fails once, and then wraps around.
2214 The key bindings for this are really too long, you might want to
2215 bind this also to `C-n' and `C-p'
2216 (add-hook 'org-load-hook
2218 (define-key 'org-mode-map "\C-n" 'org-next-link)
2219 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2221 ---------- Footnotes ----------
2223 (1) After insertion of a stored link, the link will be removed from
2224 the list of stored links. To keep it in the list later use, use a
2225 triple `C-u' prefix to `C-c C-l', or configure the option
2226 `org-keep-stored-link-after-insertion'.
2228 (2) See the variable `org-display-internal-link-with-indirect-buffer'
2231 File: org, Node: Using links outside Org-mode, Next: Link abbreviations, Prev: Handling links, Up: Hyperlinks
2233 4.5 Using links outside Org-mode
2234 ================================
2236 You can insert and follow links that have Org-mode syntax not only in
2237 Org-mode, but in any Emacs buffer. For this, you should create two
2238 global commands, like this (please select suitable global keys
2241 (global-set-key "\C-c L" 'org-insert-link-global)
2242 (global-set-key "\C-c o" 'org-open-at-point-global)
2245 File: org, Node: Link abbreviations, Next: Search options, Prev: Using links outside Org-mode, Up: Hyperlinks
2247 4.6 Link abbreviations
2248 ======================
2250 Long URLs can be cumbersome to type, and often many similar links are
2251 needed in a document. For this you can use link abbreviations. An
2252 abbreviated link looks like this
2254 [[linkword:tag][description]]
2256 where the tag is optional. Such abbreviations are resolved according to
2257 the information in the variable `org-link-abbrev-alist' that relates
2258 the linkwords to replacement text. Here is an example:
2260 (setq org-link-abbrev-alist
2261 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2262 ("google" . "http://www.google.com/search?q=")
2263 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2264 nph-abs_connect?author=%s&db_key=AST")))
2266 If the replacement text contains the string `%s', it will be
2267 replaced with the tag. Otherwise the tag will be appended to the string
2268 in order to create the link. You may also specify a function that will
2269 be called with the tag as the only argument to create the link.
2271 With the above setting, you could link to a specific bug with
2272 `[[bugzilla:129]]', search the web for `OrgMode' with
2273 `[[google:OrgMode]]' and find out what the Org-mode author is doing
2274 besides Emacs hacking with `[[ads:Dominik,C]]'.
2276 If you need special abbreviations just for a single Org-mode buffer,
2277 you can define them in the file with
2279 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
2280 #+LINK: google http://www.google.com/search?q=%s
2282 In-buffer completion *note Completion:: can be used after `[' to
2283 complete link abbreviations.
2286 File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
2288 4.7 Search options in file links
2289 ================================
2291 File links can contain additional information to make Emacs jump to a
2292 particular location in the file when following a link. This can be a
2293 line number or a search option after a double(1) colon. For example,
2294 when the command `C-c l' creates a link (*note Handling links::) to a
2295 file, it encodes the words in the current line as a search string that
2296 can be used to find this line back later when following the link with
2299 Here is the syntax of the different ways to attach a search to a file
2300 link, together with an explanation:
2302 [[file:~/code/main.c::255]]
2303 [[file:~/xx.org::My Target]]
2304 [[file:~/xx.org::*My Target]]
2305 [[file:~/xx.org::/regexp/]]
2311 Search for a link target `<<My Target>>', or do a text search for
2312 `my target', similar to the search in internal links, see *Note
2313 Internal links::. In HTML export (*note HTML export::), such a
2314 file link will become an HTML reference to the corresponding named
2315 anchor in the linked file.
2318 In an Org-mode file, restrict search to headlines.
2321 Do a regular expression search for `regexp'. This uses the Emacs
2322 command `occur' to list all matches in a separate window. If the
2323 target file is in Org-mode, `org-occur' is used to create a sparse
2324 tree with the matches.
2326 As a degenerate case, a file link with an empty file name can be used
2327 to search the current file. For example, `[[file:::find me]]' does a
2328 search for `find me' in the current file, just as `[[find me]]' would.
2330 ---------- Footnotes ----------
2332 (1) For backward compatibility, line numbers can also follow a
2336 File: org, Node: Custom searches, Prev: Search options, Up: Hyperlinks
2341 The default mechanism for creating search strings and for doing the
2342 actual search related to a file link may not work correctly in all
2343 cases. For example, BibTeX database files have many entries like
2344 `year="1993"' which would not result in good search strings, because
2345 the only unique identification for a BibTeX entry is the citation key.
2347 If you come across such a problem, you can write custom functions to
2348 set the right search string for a particular file type, and to do the
2349 search for the string in the file. Using `add-hook', these functions
2350 need to be added to the hook variables
2351 `org-create-file-search-functions' and
2352 `org-execute-file-search-functions'. See the docstring for these
2353 variables for more information. Org-mode actually uses this mechanism
2354 for BibTeX database files, and you can use the corresponding code as an
2355 implementation example. Search for `BibTeX links' in the source file.
2358 File: org, Node: TODO items, Next: Tags, Prev: Hyperlinks, Up: Top
2363 Org-mode does not maintain TODO lists as a separate document. TODO
2364 items are an integral part of the notes file, because TODO items
2365 usually come up while taking notes! With Org-mode, you simply mark any
2366 entry in a tree as being a TODO item. In this way, the information is
2367 not duplicated, and the entire context from which the item emerged is
2368 always present when you check.
2370 Of course, this technique causes TODO items to be scattered
2371 throughout your file. Org-mode provides methods to give you an
2372 overview over all things you have to do.
2376 * TODO basics:: Marking and displaying TODO entries
2377 * TODO extensions:: Workflow and assignments
2378 * Progress logging:: Dates and notes for progress
2379 * Priorities:: Some things are more important than others
2380 * Breaking down tasks:: Splitting a task into manageable pieces
2381 * Checkboxes:: Tick-off lists
2384 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
2386 5.1 Basic TODO functionality
2387 ============================
2389 Any headline can become a TODO item by starting it with the word TODO,
2392 *** TODO Write letter to Sam Fortune
2394 The most important commands to work with TODO entries are:
2397 Rotate the TODO state of the current item among
2399 ,-> (unmarked) -> TODO -> DONE --.
2400 '--------------------------------'
2402 The same rotation can also be done "remotely" from the timeline and
2403 agenda buffers with the `t' command key (*note Agenda commands::).
2406 Select a specific keyword using completion of (if it has been set
2407 up) the fast selection interface.
2411 Select the following/preceding TODO state, similar to cycling.
2412 Mostly useful if more than two TODO states are possible (*note
2416 Use the fast tag interface to quickly and directly select a
2417 specific TODO state. For this you need to assign keys to TODO
2419 #+SEQ_TODO: TODO(t) STARTED(s) WAITING(w) | DONE(d)
2420 See *Note Per file keywords:: and *Note Setting tags:: for more
2425 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
2426 the entire buffer, but shows all TODO items and the headings
2427 hierarchy above them. With prefix arg, search for a specific
2428 TODO. You will be prompted for the keyword, and you can also give
2429 a list of keywords like `kwd1|kwd2|...'. With numerical prefix N,
2430 show the tree for the Nth keyword in the variable
2431 `org-todo-keywords'. With two prefix args, find all TODO and DONE
2435 Show the global TODO list. This collects the TODO items from all
2436 agenda files (*note Agenda views::) into a single buffer. The
2437 buffer is in `agenda-mode', so there are commands to examine and
2438 manipulate the TODO entries directly from that buffer (*note
2439 Agenda commands::). *Note Global TODO list::, for more
2443 Insert a new TODO entry below the current one.
2446 File: org, Node: TODO extensions, Next: Progress logging, Prev: TODO basics, Up: TODO items
2448 5.2 Extended use of TODO keywords
2449 =================================
2451 The default implementation of TODO entries is just two states: TODO and
2452 DONE. You can use the TODO feature for more complicated things by
2453 configuring the variable `org-todo-keywords'. With special setup, the
2454 TODO keyword system can work differently in different files.
2456 Note that tags are another way to classify headlines in general and
2457 TODO items in particular (*note Tags::).
2461 * Workflow states:: From TODO to DONE in steps
2462 * TODO types:: I do this, Fred the rest
2463 * Multiple sets in one file:: Mixing it all, and still finding your way
2464 * Fast access to TODO states:: Single letter selection of a state
2465 * Per file keywords:: Different files, different requirements
2466 * Faces for TODO keywords:: Highlighting states
2469 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
2471 5.2.1 TODO keywords as workflow states
2472 --------------------------------------
2474 You can use TODO keywords to indicate different _sequential_ states in
2475 the process of working on an item, for example(1):
2477 (setq org-todo-keywords
2478 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2480 The vertical bar separates the TODO keywords (states that _need
2481 action_) from the DONE states (which need _no further action_. If you
2482 don't provide the separator bar, the last state is used as the DONE
2483 state. With this setup, the command `C-c C-t' will cycle an entry from
2484 TODO to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.
2485 You may also use a prefix argument to quickly select a specific state.
2486 For example `C-3 C-c C-t' will change the state immediately to VERIFY.
2487 If you define many keywords, you can use in-buffer completion (see
2488 *Note Completion::) to insert these words into the buffer. Changing a
2489 todo state can be logged with a timestamp, see *Note Tracking TODO
2490 state changes:: for more information.
2492 ---------- Footnotes ----------
2494 (1) Changing this variable only becomes effective after restarting
2495 Org-mode in a buffer.
2498 File: org, Node: TODO types, Next: Multiple sets in one file, Prev: Workflow states, Up: TODO extensions
2500 5.2.2 TODO keywords as types
2501 ----------------------------
2503 The second possibility is to use TODO keywords to indicate different
2504 _types_ of action items. For example, you might want to indicate that
2505 items are for "work" or "home". Or, when you work with several people
2506 on a single project, you might want to assign action items directly to
2507 persons, by using their names as TODO keywords. This would be set up
2510 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2512 In this case, different keywords do not indicate a sequence, but
2513 rather different types. So the normal work flow would be to assign a
2514 task to a person, and later to mark it DONE. Org-mode supports this
2515 style by adapting the workings of the command `C-c C-t'(1). When used
2516 several times in succession, it will still cycle through all names, in
2517 order to first select the right type for a task. But when you return
2518 to the item after some time and execute `C-c C-t' again, it will switch
2519 from any name directly to DONE. Use prefix arguments or completion to
2520 quickly select a specific name. You can also review the items of a
2521 specific TODO type in a sparse tree by using a numeric prefix to `C-c
2522 C-v'. For example, to see all things Lucy has to do, you would use
2523 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
2524 single buffer, you would use the prefix arg as well when creating the
2525 global todo list: `C-3 C-c t'.
2527 ---------- Footnotes ----------
2529 (1) This is also true for the `t' command in the timeline and agenda
2533 File: org, Node: Multiple sets in one file, Next: Fast access to TODO states, Prev: TODO types, Up: TODO extensions
2535 5.2.3 Multiple keyword sets in one file
2536 ---------------------------------------
2538 Sometimes you may want to use different sets of TODO keywords in
2539 parallel. For example, you may want to have the basic `TODO'/`DONE',
2540 but also a workflow for bug fixing, and a separate state indicating
2541 that an item has been canceled (so it is not DONE, but also does not
2542 require action). Your setup would then look like this:
2544 (setq org-todo-keywords
2545 '((sequence "TODO" "|" "DONE")
2546 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2547 (sequence "|" "CANCELED")))
2549 The keywords should all be different, this helps Org-mode to keep
2550 track of which subsequence should be used for a given entry. In this
2551 setup, `C-c C-t' only operates within a subsequence, so it switches from
2552 `DONE' to (nothing) to `TODO', and from `FIXED' to (nothing) to
2553 `REPORT'. Therefore you need a mechanism to initially select the
2554 correct sequence. Besides the obvious ways like typing a keyword or
2555 using completion, you may also apply the following commands:
2559 These keys jump from one TODO subset to the next. In the above
2560 example, `C-S-<right>' would jump from `TODO' or `DONE' to
2561 `REPORT', and any of the words in the second row to `CANCELED'.
2565 `S-<<left>>' and `S-<<right>>' and walk through _all_ keywords
2566 from all sets, so for example `S-<<right>>' would switch from
2567 `DONE' to `REPORT' in the example above.
2570 File: org, Node: Fast access to TODO states, Next: Per file keywords, Prev: Multiple sets in one file, Up: TODO extensions
2572 5.2.4 Fast access to TODO states
2573 --------------------------------
2575 If you would like to quickly change an entry to an arbitrary TODO state
2576 instead of cycling through the states, you can set up keys for
2577 single-letter access to the states. This is done by adding the section
2578 key after each keyword, in parenthesis. For example:
2580 (setq org-todo-keywords
2581 '((sequence "TODO(t)" "|" "DONE(d)")
2582 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
2583 (sequence "|" "CANCELED(c)")))
2585 If you then press `C-u C-c C-t' followed by the selection key, the
2586 entry will be switched to this state. <SPC> can be used to remove any
2587 TODO keyword from an entry. Should you like this way of selecting TODO
2588 states a lot, you might want to set the variable
2589 `org-use-fast-todo-selection' to `t' and make this behavior the
2590 default. Check also the variable
2591 `org-fast-tag-selection-include-todo', it allows to change the TODO
2592 state through the tags interface (*note Setting tags::).
2595 File: org, Node: Per file keywords, Next: Faces for TODO keywords, Prev: Fast access to TODO states, Up: TODO extensions
2597 5.2.5 Setting up keywords for individual files
2598 ----------------------------------------------
2600 It can be very useful to use different aspects of the TODO mechanism in
2601 different files. For file-local settings, you need to add special lines
2602 to the file which set the keywords and interpretation for that file
2603 only. For example, to set one of the two examples discussed above, you
2604 need one of the following lines, starting in column zero anywhere in the
2607 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2609 #+TYP_TODO: Fred Sara Lucy Mike | DONE
2611 A setup for using several sets in parallel would be:
2613 #+SEQ_TODO: TODO | DONE
2614 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
2615 #+SEQ_TODO: | CANCELED
2617 To make sure you are using the correct keyword, type `#+' into the
2618 buffer and then use `M-<TAB>' completion.
2620 Remember that the keywords after the vertical bar (or the last
2621 keyword if no bar is there) must always mean that the item is DONE
2622 (although you may use a different word). After changing one of these
2623 lines, use `C-c C-c' with the cursor still in the line to make the
2624 changes known to Org-mode(1).
2626 ---------- Footnotes ----------
2628 (1) Org-mode parses these lines only when Org-mode is activated
2629 after visiting a file. `C-c C-c' with the cursor in a line starting
2630 with `#+' is simply restarting Org-mode for the current buffer.
2633 File: org, Node: Faces for TODO keywords, Prev: Per file keywords, Up: TODO extensions
2635 5.2.6 Faces for TODO keywords
2636 -----------------------------
2638 Org-mode highlights TODO keywords with special faces: `org-todo' for
2639 keywords indicating that an item still has to be acted upon, and
2640 `org-done' for keywords indicating that an item is finished. If you
2641 are using more than 2 different states, you might want to use special
2642 faces for some of them. This can be done using the variable
2643 `org-todo-keyword-faces'. For example:
2645 (setq org-todo-keyword-faces
2646 '(("TODO" . org-warning)
2647 ("DEFERRED" . shadow)
2648 ("CANCELED" . (:foreground "blue" :weight bold))))
2651 File: org, Node: Progress logging, Next: Priorities, Prev: TODO extensions, Up: TODO items
2653 5.3 Progress Logging
2654 ====================
2656 Org-mode can automatically record a time stamp and even a note when you
2657 mark a TODO item as DONE, or even each time you change the state of a
2662 * Closing items:: When was this entry marked DONE?
2663 * Tracking TODO state changes:: When did the status change?
2666 File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
2671 If you want to keep track of _when_ a certain TODO item was finished,
2672 turn on logging with(1)
2674 (setq org-log-done t)
2676 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2677 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2678 [timestamp]' will be inserted just after the headline. If you turn the
2679 entry back into a TODO item through further state cycling, that line
2680 will be removed again. In the timeline (*note Timeline::) and in the
2681 agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
2682 display the TODO items closed on each day, giving you an overview of
2683 what has been done on a day. If you want to record a note along with
2684 the timestamp, use(2)
2686 (setq org-log-done '(done))
2688 ---------- Footnotes ----------
2690 (1) The corresponding in-buffer setting is: `#+STARTUP: logdone'.
2691 You may also set this for the scope of a subtree by adding a `LOGGING'
2692 property with one or more of the logging keywords in the value.
2694 (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'
2697 File: org, Node: Tracking TODO state changes, Prev: Closing items, Up: Progress logging
2699 5.3.2 Tracking TODO state changes
2700 ---------------------------------
2702 When TODO keywords are used as workflow states (*note Workflow
2703 states::), you might want to keep track of when a state change occurred
2704 and record a note about this change. With the setting(1)
2706 (setq org-log-done '(state))
2708 each state change will prompt you for a note that will be attached to
2709 the current headline. If you press `C-c C-c' without typing anything
2710 into the note buffer, only the time of the state change will be noted.
2711 Very likely you do not want this verbose tracking all the time, so it
2712 is probably better to configure this behavior with in-buffer options.
2713 For example, if you are tracking purchases, put these into a separate
2716 #+SEQ_TODO: TODO(t) ORDERED(o) INVOICE(i) PAYED(p) | RECEIVED(r)
2717 #+STARTUP: lognotestate
2719 If you only need to take a note for some of the states, mark those
2720 states with an additional `@', like this:
2722 #+SEQ_TODO: TODO(t) ORDERED(o@) INVOICE(i@) PAYED(p) | RECEIVED(r)
2723 #+STARTUP: lognotestate
2725 ---------- Footnotes ----------
2727 (1) The corresponding in-buffer setting is: `#+STARTUP:
2731 File: org, Node: Priorities, Next: Breaking down tasks, Prev: Progress logging, Up: TODO items
2736 If you use Org-mode extensively to organize your work, you may end up
2737 with a number of TODO entries so large that you'd like to prioritize
2738 them. This can be done by placing a _priority cookie_ into the
2741 *** TODO [#A] Write letter to Sam Fortune
2743 With its standard setup, Org-mode supports priorities `A', `B', and
2744 `C'. `A' is the highest priority. An entry without a cookie is
2745 treated as priority `B'. Priorities make a difference only in the
2746 agenda (*note Weekly/Daily agenda::).
2749 Set the priority of the current headline. The command prompts for
2750 a priority character `A', `B' or `C'. When you press <SPC>
2751 instead, the priority cookie is removed from the headline. The
2752 priorities can also be changed "remotely" from the timeline and
2753 agenda buffer with the `,' command (*note Agenda commands::).
2757 Increase/decrease priority of current headline(1). Note that these
2758 keys are also used to modify time stamps (*note Creating
2759 timestamps::). Furthermore, these keys are also used by CUA-mode
2760 (*note Conflicts::).
2762 You can change the range of allowed priorities by setting the
2763 variables `org-highest-priority', `org-lowest-priority', and
2764 `org-default-priority'. For an individual buffer, you may set these
2765 values (highest, lowest, default) like this (please make sure that the
2766 highest priority is earlier in the alphabet than the lowest priority):
2770 ---------- Footnotes ----------
2772 (1) See also the option `org-priority-start-cycle-with-default''.
2775 File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
2777 5.5 Breaking tasks down into subtasks
2778 =====================================
2780 It is often advisable to break down large tasks into smaller, manageable
2781 subtasks. You can do this by creating an outline tree below a TODO
2782 item, with detailed subtasks on the tree(1). Another possibility is
2783 the use of checkboxes to identify (a hierarchy of) a large number of
2784 subtasks (*note Checkboxes::).
2786 ---------- Footnotes ----------
2788 (1) To keep subtasks out of the global TODO list, see the
2789 `org-agenda-todo-list-sublevels'.
2792 File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
2797 Every item in a plain list (*note Plain lists::) can be made a checkbox
2798 by starting it with the string `[ ]'. This feature is similar to TODO
2799 items (*note TODO items::), but more lightweight. Checkboxes are not
2800 included into the global TODO list, so they are often great to split a
2801 task into a number of simple steps. Or you can use them in a shopping
2802 list. To toggle a checkbox, use `C-c C-c', or try Piotr Zielinski's
2803 `org-mouse.el'. Here is an example of a checkbox list.
2805 * TODO Organize party [3/6]
2811 - [ ] think about what music to play
2812 - [X] talk to the neighbors
2814 The `[3/6]' and `[1/3]' in the first and second line are cookies
2815 indicating how many checkboxes are present in this entry, and how many
2816 of them have been checked off. This can give you an idea on how many
2817 checkboxes remain, even without opening a folded entry. The cookies
2818 can be placed into a headline or into (the first line of) a plain list
2819 item. Each cookie covers all checkboxes structurally below that
2820 headline/item. You have to insert the cookie yourself by typing either
2821 `[/]' or `[%]'. In the first case you get an `n out of m' result, in
2822 the second case you get information about the percentage of checkboxes
2823 checked (in the above example, this would be `[50%]' and `[33%],
2826 The following commands work with checkboxes:
2829 Toggle checkbox at point. With prefix argument, set it to `[-]',
2830 which is considered to be an intermediate state.
2833 Toggle checkbox at point.
2834 - If there is an active region, toggle the first checkbox in
2835 the region and set all remaining boxes to the same status as
2836 the first. If you want to toggle all boxes in the region
2837 independently, use a prefix argument.
2839 - If the cursor is in a headline, toggle checkboxes in the
2840 region between this headline and the next (so _not_ the
2843 - If there is no active region, just toggle the checkbox at
2847 Insert a new item with a checkbox. This works only if the cursor
2848 is already in a plain list item (*note Plain lists::).
2851 Update the checkbox statistics in the current outline entry. When
2852 called with a `C-u' prefix, update the entire file. Checkbox
2853 statistic cookies are updated automatically if you toggle
2854 checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
2855 you delete boxes or add/change them by hand, use this command to
2856 get things back into synch. Or simply toggle any checkbox twice
2860 File: org, Node: Tags, Next: Properties and columns, Prev: TODO items, Up: Top
2865 If you wish to implement a system of labels and contexts for
2866 cross-correlating information, an excellent way is to assign tags to
2867 headlines. Org-mode has extensive support for using tags.
2869 Every headline can contain a list of tags, at the end of the
2870 headline. Tags are normal words containing letters, numbers, `_', and
2871 `@'. Tags must be preceded and followed by a single colon; like
2872 `:WORK:'. Several tags can be specified like `:work:URGENT:'.
2876 * Tag inheritance:: Tags use the tree structure of the outline
2877 * Setting tags:: How to assign tags to a headline
2878 * Tag searches:: Searching for combinations of tags
2881 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2886 Tags make use of the hierarchical structure of outline trees. If a
2887 heading has a certain tag, all subheadings will inherit the tag as
2888 well. For example, in the list
2890 * Meeting with the French group :work:
2891 ** Summary by Frank :boss:notes:
2892 *** TODO Prepare slides for him :action:
2894 the final heading will have the tags `:work:', `:boss:', `:notes:', and
2895 `:action:'. When executing tag searches and Org-mode finds that a
2896 certain headline matches the search criterion, it will not check any
2897 sublevel headline, assuming that these likely also match, and that the
2898 list of matches can become very long. This may not be what you want,
2899 however, and you can influence inheritance and searching using the
2900 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2903 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2908 Tags can simply be typed into the buffer at the end of a headline.
2909 After a colon, `M-<TAB>' offers completion on tags. There is also a
2910 special command for inserting tags:
2913 Enter new tags for the current headline. Org-mode will either
2914 offer completion or a special single-key interface for setting
2915 tags, see below. After pressing <RET>, the tags will be inserted
2916 and aligned to `org-tags-column'. When called with a `C-u'
2917 prefix, all tags in the current buffer will be aligned to that
2918 column, just to make things look nice. TAGS are automatically
2919 realigned after promotion, demotion, and TODO state changes (*note
2922 Org will support tag insertion based on a _list of tags_. By
2923 default this list is constructed dynamically, containing all tags
2924 currently used in the buffer. You may also globally specify a hard list
2925 of tags with the variable `org-tag-alist'. Finally you can set the
2926 default tags for a given file with lines like
2928 #+TAGS: @work @home @tennisclub
2929 #+TAGS: laptop car pc sailboat
2931 If you have globally defined your preferred set of tags using the
2932 variable `org-tag-alist', but would like to use a dynamic tag list in a
2933 specific file: Just add an empty TAGS option line to that file:
2937 The default support method for entering tags is minibuffer
2938 completion. However, Org-mode also implements a much better method:
2939 _fast tag selection_. This method allows to select and deselect tags
2940 with a single key per tag. To function efficiently, you should assign
2941 unique keys to most tags. This can be done globally with
2943 (setq org-tag-alist '(("@work" . ?w) ("@home" . ?h) ("laptop" . ?l)))
2945 or on a per-file basis with
2947 #+TAGS: @work(w) @home(h) @tennisclub(t) laptop(l) pc(p)
2949 You can also group together tags that are mutually exclusive. With
2952 #+TAGS: { @work(w) @home(h) @tennisclub(t) } laptop(l) pc(p)
2954 you indicate that at most one of `@work', `@home', and `@tennisclub'
2957 Don't forget to press `C-c C-c' with the cursor in one of these lines
2958 to activate any changes.
2960 If at least one tag has a selection key, pressing `C-c C-c' will
2961 automatically present you with a special interface, listing inherited
2962 tags, the tags of the current headline, and a list of all legal tags
2963 with corresponding keys(2). In this interface, you can use the
2967 Pressing keys assigned to tags will add or remove them from the
2968 list of tags in the current line. Selecting a tag in a group of
2969 mutually exclusive tags will turn off any other tags from that
2973 Enter a tag in the minibuffer, even if the tag is not in the
2974 predefined list. You will be able to complete on all tags present
2978 Clear all tags for this line.
2981 Accept the modified set.
2984 Abort without installing changes.
2987 If `q' is not assigned to a tag, it aborts like `C-g'.
2990 Turn off groups of mutually exclusive tags. Use this to (as an
2991 exception) assign several tags from such a group.
2994 Toggle auto-exit after the next change (see below). If you are
2995 using expert mode, the first `C-c' will display the selection
2998 This method lets you assign tags to a headline with very few keys. With
2999 the above setup, you could clear the current tags and set `@home',
3000 `laptop' and `pc' tags with just the following keys: `C-c C-c <SPC> h l
3001 p <RET>'. Switching from `@home' to `@work' would be done with `C-c
3002 C-c w <RET>' or alternatively with `C-c C-c C-c w'. Adding the
3003 non-predefined tag `Sarah' could be done with `C-c C-c <TAB> S a r a h
3006 If you find that most of the time, you need only a single keypress to
3007 modify your list of tags, set the variable
3008 `org-fast-tag-selection-single-key'. Then you no longer have to press
3009 <RET> to exit fast tag selection - it will immediately exit after the
3010 first change. If you then occasionally need more keys, press `C-c' to
3011 turn off auto-exit for the current tag selection process (in effect:
3012 start selection with `C-c C-c C-c' instead of `C-c C-c'). If you set
3013 the variable to the value `expert', the special window is not even
3014 shown for single-key tag selection, it comes up only when you press an
3017 ---------- Footnotes ----------
3019 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
3020 respectively. Several groups are allowed.
3022 (2) Keys will automatically be assigned to tags which have no
3026 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
3031 Once a tags system has been set up, it can be used to collect related
3032 information into special lists.
3036 Create a sparse tree with all headlines matching a tags search.
3037 With a `C-u' prefix argument, ignore headlines that are not a TODO
3041 Create a global list of tag matches from all agenda files. *Note
3042 Matching tags and properties::.
3045 Create a global list of tag matches from all agenda files, but
3046 check only TODO items and force checking subitems (see variable
3047 `org-tags-match-list-sublevels').
3049 A tags search string can use Boolean operators `&' for AND and `|'
3050 for OR. `&' binds more strongly than `|'. Parenthesis are currently
3051 not implemented. A tag may also be preceded by `-', to select against
3052 it, and `+' is syntactic sugar for positive selection. The AND
3053 operator `&' is optional when `+' or `-' is present. Examples:
3056 Select headlines tagged `:work:', but discard those also tagged
3060 Selects lines tagged `:work:' or `:laptop:'.
3063 Like before, but require the `:laptop:' lines to be tagged also
3066 If you are using multi-state TODO keywords (*note TODO
3067 extensions::), it can be useful to also match on the TODO keyword.
3068 This can be done by adding a condition after a slash to a tags match.
3069 The syntax is similar to the tag matches, but should be applied with
3070 consideration: For example, a positive selection on several TODO
3071 keywords can not meaningfully be combined with boolean AND. However,
3072 _negative selection_ combined with AND can be meaningful. To make sure
3073 that only lines are checked that actually have any TODO keyword, use
3074 `C-c a M', or equivalently start the todo part after the slash with `!'.
3078 Select `:work:'-tagged TODO lines with the specific TODO keyword
3081 `work/!-WAITING-NEXT'
3082 Select `:work:'-tagged TODO lines that are neither `WAITING' nor
3085 `work/+WAITING|+NEXT'
3086 Select `:work:'-tagged TODO lines that are either `WAITING' or
3089 Any element of the tag/todo match can be a regular expression - in
3090 this case it must be enclosed in curly braces. For example,
3091 `work+{^boss.*}' matches headlines that contain the tag `work' and any
3092 tag starting with `boss'.
3094 You can also require a headline to be of a certain level or
3095 category, by writing instead of any TAG an expression like `LEVEL=3' or
3096 `CATEGORY="work"', respectively. For example, a search
3097 `+LEVEL=3+boss/-DONE' lists all level three headlines that have the tag
3098 `boss' and are _not_ marked with the todo keyword DONE.
3101 File: org, Node: Properties and columns, Next: Dates and times, Prev: Tags, Up: Top
3103 7 Properties and Columns
3104 ************************
3106 Properties are a set of key-value pairs associated with an entry. There
3107 are two main applications for properties in Org-mode. First, properties
3108 are like tags, but with a value. For example, in a file where you
3109 document bugs and plan releases of a piece of software, instead of using
3110 tags like `:release_1:', `:release_2:', it can be more efficient to use
3111 a property `Release' with a value `1.0' or `2.0'. Second, you can use
3112 properties to implement (very basic) database capabilities in an
3113 Org-mode buffer, for example to create a list of Music CD's you own.
3114 You can edit and view properties conveniently in column view (*note
3119 * Property syntax:: How properties are spelled out
3120 * Special properties:: Access to other Org-mode features
3121 * Property searches:: Matching property values
3122 * Property inheritance:: Passing values down the tree
3123 * Column view:: Tabular viewing and editing
3124 * Property API:: Properties for Lisp programmers
3127 File: org, Node: Property syntax, Next: Special properties, Prev: Properties and columns, Up: Properties and columns
3132 Properties are key-value pairs. They need to be inserted into a special
3133 drawer (*note Drawers::) with the name `PROPERTIES'. Each property is
3134 specified on a single line, with the key (surrounded by colons) first,
3135 and the value after it. Here is an example:
3139 *** Goldberg Variations
3141 :Title: Goldberg Variations
3142 :Composer: J.S. Bach
3144 :Publisher: Deutsche Grammphon
3148 You may define the allowed values for a particular property `Xyz' by
3149 setting a property `Xyz_ALL'. This special property is _inherited_, so
3150 if you set it in a level 1 entry, it will apply to the entire tree.
3151 When allowed values are defined, setting the corresponding property
3152 becomes easier and is less prone to typing errors. For the example
3153 with the CD collection, we can predefine publishers and the number of
3154 disks in a box like this:
3158 :NDisks_ALL: 1 2 3 4
3159 :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
3162 If you want to set properties that can be inherited by any entry in a
3163 file, use a line like
3165 #+PROPERTY: NDisks_ALL 1 2 3 4
3167 Property values set with the global variable `org-global-properties'
3168 can be inherited by all entries in all Org-mode files.
3170 The following commands help to work with properties:
3173 After an initial colon in a line, complete property keys. All
3174 keys used in the current file will be offered as possible
3178 Set a property. This prompts for a property name and a value. If
3179 necessary, the property drawer is created as well.
3181 `M-x org-insert-property-drawer'
3182 Insert a property drawer into the current entry. The drawer will
3183 be inserted early in the entry, but after the lines with planning
3184 information like deadlines.
3187 With the cursor in a property drawer, this executes property
3191 Set a property in the current entry. Both the property and the
3192 value can be inserted using completion.
3195 Switch property at point to the next/previous allowed value.
3198 Remove a property from the current entry.
3201 Globally remove a property, from all entries in the current file.
3204 Compute the property at point, using the operator and scope from
3205 the nearest column format definition.
3208 File: org, Node: Special properties, Next: Property searches, Prev: Property syntax, Up: Properties and columns
3210 7.2 Special Properties
3211 ======================
3213 Special properties provide alternative access method to Org-mode
3214 features discussed in the previous chapters, like the TODO state or the
3215 priority of an entry. This interface exists so that you can include
3216 these states into columns view (*note Column view::), or to use them in
3217 queries. The following property names are special and should not be
3218 used as keys in the properties drawer:
3220 TODO The TODO keyword of the entry.
3221 TAGS The tags defined directly in the headline.
3222 ALLTAGS All tags, including inherited ones.
3223 PRIORITY The priority of the entry, a string with a single letter.
3224 DEADLINE The deadline time string, without the angular brackets.
3225 SCHEDULED The scheduling time stamp, without the angular brackets.
3226 TIMESTAMP The first keyword-less time stamp in the entry.
3227 TIMESTAMP_IA The first inactive time stamp in the entry.
3230 File: org, Node: Property searches, Next: Property inheritance, Prev: Special properties, Up: Properties and columns
3232 7.3 Property searches
3233 =====================
3235 To create sparse trees and special lists with selection based on
3236 properties, the same commands are used as for tag searches (*note Tag
3237 searches::), and the same logic applies. For example, a search string
3239 +work-boss+PRIORITY="A"+Coffee="unlimited"+With={Sarah\|Denny}
3241 finds entries tagged `:work:' but not `:boss:', which also have a
3242 priority value `A', a `:Coffee:' property with the value `unlimited',
3243 and a `:With:' property that is matched by the regular expression
3246 You can configure Org-mode to use property inheritance during a
3247 search, see *Note Property inheritance:: for details.
3249 There is also a special command for creating sparse trees based on a
3253 Create a sparse tree based on the value of a property. This first
3254 prompts for the name of a property, and then for a value. A
3255 sparse tree is created with all entries that define this property
3256 with the given value. If you enclose the value into curly braces,
3257 it is interpreted as a regular expression and matched against the
3261 File: org, Node: Property inheritance, Next: Column view, Prev: Property searches, Up: Properties and columns
3263 7.4 Property Inheritance
3264 ========================
3266 The outline structure of Org-mode documents lends itself for an
3267 inheritance model of properties: If the parent in a tree has a certain
3268 property, the children can inherit this property. Org-mode does not
3269 turn this on by default, because it can slow down property searches
3270 significantly and is often not needed. However, if you find inheritance
3271 useful, you can turn it on by setting the variable
3272 `org-use-property-inheritance'. It may be set to `t', to make all
3273 properties inherited from the parent, or to a list of properties that
3274 should be inherited.
3276 Org-mode has a few properties for which inheritance is hard-coded, at
3277 least for the special applications for which they are used:
3280 The column property defines the format of column view (*note
3281 Column view::). It is inherited in the sense that the level where
3282 a `COLUMNS' property is defined is used as the starting point for a
3283 column view table, independently of the location in the subtree
3284 from where columns view is turned on.
3287 For agenda view, a category set through a `CATEGORY' property
3288 applies to the entire subtree.
3291 For archiving, the `ARCHIVE' property may define the archive
3292 location for the entire subtree (*note Moving subtrees::).
3295 File: org, Node: Column view, Next: Property API, Prev: Property inheritance, Up: Properties and columns
3300 A great way to view and edit properties in an outline tree is _column
3301 view_. In column view, each outline item is turned into a table row.
3302 Columns in this table provide access to properties of the entries.
3303 Org-mode implements columns by overlaying a tabular structure over the
3304 headline of each item. While the headlines have been turned into a
3305 table row, you can still change the visibility of the outline tree.
3306 For example, you get a compact table by switching to CONTENTS view
3307 (`S-<TAB> S-<TAB>', or simply `c' while column view is active), but you
3308 can still open, read, and edit the entry below each headline. Or, you
3309 can switch to column view after executing a sparse tree command and in
3310 this way get a table only for the selected items. Column view also
3311 works in agenda buffers (*note Agenda views::) where queries have
3312 collected selected items, possibly from a number of files.
3316 * Defining columns:: The COLUMNS format property
3317 * Using column view:: How to create and use column view
3318 * Capturing Column View:: A dynamic block for column view
3321 File: org, Node: Defining columns, Next: Using column view, Prev: Column view, Up: Column view
3323 7.5.1 Defining Columns
3324 ----------------------
3326 Setting up a column view first requires defining the columns. This is
3327 done by defining a column format line.
3331 * Scope of column definitions:: Where defined, where valid?
3332 * Column attributes:: Appearance and content of a column
3335 File: org, Node: Scope of column definitions, Next: Column attributes, Prev: Defining columns, Up: Defining columns
3337 7.5.1.1 Scope of column definitions
3338 ...................................
3340 To define a column format for an entire file, use a line like
3342 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
3344 To specify a format that only applies to a specific tree, add a
3345 COLUMNS property to the top node of that tree, for example
3346 ** Top node for columns view
3348 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
3351 If a `COLUMNS' property is present in an entry, it defines columns
3352 for the entry itself, and for the entire subtree below it. Since the
3353 column definition is part of the hierarchical structure of the document,
3354 you can define columns on level 1 that are general enough for all
3355 sublevels, and more specific columns further down, when you edit a
3356 deeper part of the tree.
3359 File: org, Node: Column attributes, Prev: Scope of column definitions, Up: Defining columns
3361 7.5.1.2 Column attributes
3362 .........................
3364 A column definition sets the attributes of a column. The general
3365 definition looks like this:
3367 %[width]property[(title)][{summary-type}]
3369 Except for the percent sign and the property name, all items are
3370 optional. The individual parts have the following meaning:
3372 width An integer specifying the width of the column in characters.
3373 If omitted, the width will be determined automatically.
3374 property The property that should be edited in this column.
3375 (title) The header text for the column. If omitted, the
3376 property name is used.
3377 {summary-type} The summary type. If specified, the column values for
3378 parent nodes are computed from the children.
3379 Supported summary types are:
3380 {+} Sum numbers in this column.
3381 {+;%.1f} Like `+', but format result with `%.1f'.
3382 {$} Currency, short for `+;%.2f'.
3383 {:} Sum times, HH:MM:SS, plain numbers are hours.
3384 {X} Checkbox status, [X] if all children are [X].
3386 Here is an example for a complete columns definition, along with allowed
3389 :COLUMNS: %20ITEM %9Approved(Approved?){X} %Owner %11Status %10Time_Spent{:}
3390 :Owner_ALL: Tammy Mark Karl Lisa Don
3391 :Status_ALL: "In progress" "Not started yet" "Finished" ""
3392 :Approved_ALL: "[ ]" "[X]"
3394 The first column, `%25ITEM', means the first 25 characters of the
3395 item itself, i.e. of the headline. You probably always should start the
3396 column definition with the ITEM specifier. The other specifiers create
3397 columns `Owner' with a list of names as allowed values, for `Status'
3398 with four different possible values, and for a checkbox field
3399 `Approved'. When no width is given after the `%' character, the column
3400 will be exactly as wide as it needs to be in order to fully display all
3401 values. The `Approved' column does have a modified title (`Approved?',
3402 with a question mark). Summaries will be created for the `Time_Spent'
3403 column by adding time duration expressions like HH:MM, and for the
3404 `Approved' column, by providing an `[X]' status if all children have
3408 File: org, Node: Using column view, Next: Capturing Column View, Prev: Defining columns, Up: Column view
3410 7.5.2 Using Column View
3411 -----------------------
3413 Turning column view on and off
3414 ..............................
3417 Create the column view for the local environment. This command
3418 searches the hierarchy, up from point, for a `COLUMNS' property
3419 that defines a format. When one is found, the column view table
3420 is established for the entire tree, starting from the entry that
3421 contains the `COLUMNS' property. If none is found, the format is
3422 taken from the `#+COLUMNS' line or from the variable
3423 `org-columns-default-format', and column view is established for
3424 the current entry and its subtree.
3432 `<left> <right> <up> <down>'
3433 Move through the column view from field to field.
3436 Switch to the next/previous allowed value of the field. For this,
3437 you have to have specified allowed values for a property.
3440 Same as `S-<left>/<right>'
3443 Edit the property at point. For the special properties, this will
3444 invoke the same interface that you normally use to change that
3445 property. For example, when editing a TAGS property, the tag
3446 completion or fast selection interface will pop up.
3449 When there is a checkbox at point, toggle it.
3452 View the full value of this property. This is useful if the width
3453 of the column is smaller than that of the value.
3456 Edit the list of allowed values for this property. If the list is
3457 found in the hierarchy, the modified values is stored there. If
3458 no list is found, the new value is stored in the first entry that
3459 is part of the current column view.
3461 Modifying the table structure
3462 .............................
3465 Make the column narrower/wider by one character.
3468 Insert a new column, to the right of the current column.
3471 Delete the current column.
3474 File: org, Node: Capturing Column View, Prev: Using column view, Up: Column view
3476 7.5.3 Capturing Column View
3477 ---------------------------
3479 Since column view is just an overlay over a buffer, it cannot be
3480 exported or printed directly. If you want to capture a column view, use
3481 the dynamic block (*note Dynamic blocks::). The frame of this block
3485 #+BEGIN: columnview :hlines 1 :id "label"
3489 This dynamic block has the following parameters:
3492 This is most important parameter. Column view is a feature that is
3493 often localized to a certain (sub)tree, and the capture block
3494 might be in a different location in the file. To identify the
3495 tree whose view to capture, you can use 3 values:
3496 local use the tree in which the capture block is located
3497 global make a global view, including all headings in the file
3498 "label" call column view in the tree that has and `:ID:'
3499 property with the value label
3502 When `t', insert a hline after every line. When a number N, insert
3503 a hline before each headline with level `<= N'.
3506 When set to `t', enforce column groups to get vertical lines.
3508 The following commands insert or update the dynamic block:
3511 Insert a dynamic block capturing a column view. You will be
3512 prompted for the scope or id of the view.
3516 Update dynamical block at point. The cursor needs to be in the
3517 `#+BEGIN' line of the dynamic block.
3520 Update all dynamic blocks (*note Dynamic blocks::). This is
3521 useful if you have several clocktable blocks in a buffer.
3524 File: org, Node: Property API, Prev: Column view, Up: Properties and columns
3526 7.6 The Property API
3527 ====================
3529 There is a full API for accessing and changing properties. This API can
3530 be used by Emacs Lisp programs to work with properties and to implement
3531 features based on them. For more information see *Note Using the
3535 File: org, Node: Dates and times, Next: Remember, Prev: Properties and columns, Up: Top
3540 Items can be labeled with a date and/or a time to make them useful for
3541 project planning. The specially formatted string carrying the date and
3542 time information is called a _timestamp_ in Org-mode. This may be a
3543 little confusing because timestamp is often used as indicating when
3544 something was created or last changed. However, in Org-mode this term
3545 is used in a much wider sense.
3549 * Time stamps:: Assigning a time to a tree entry
3550 * Creating timestamps:: Commands which insert timestamps
3551 * Deadlines and scheduling:: Planning your work
3552 * Clocking work time::
3555 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Dates and times, Up: Dates and times
3557 8.1 Time stamps, deadlines and scheduling
3558 =========================================
3560 A time stamp is a specification of a date (possibly with time or a range
3561 of times) in a special format, either `<2003-09-16 Tue>' or
3562 `<2003-09-16 Tue 09:39>' or `<2003-09-16 Tue 12:00-12:30>'(1). A time
3563 stamp can appear anywhere in the headline or body of an org-tree entry.
3564 Its presence causes entries to be shown on specific dates in the agenda
3565 (*note Weekly/Daily agenda::). We distinguish:
3567 PLAIN TIME STAMP; EVENT; APPOINTMENT
3568 A simple time stamp just assigns a date/time to an item. This is
3569 just like writing down an appointment or event in a paper agenda.
3570 In the timeline and agenda displays, the headline of an entry
3571 associated with a plain time stamp will be shown exactly on that
3574 * Meet Peter at the movies <2006-11-01 Wed 19:15>
3575 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
3577 TIME STAMP WITH REPEATER INTERVAL
3578 A time stamp may contain a _repeater interval_, indicating that it
3579 applies not only on the given date, but again and again after a
3580 certain interval of N days (d), weeks (w), months(m), or years(y).
3581 The following will show up in the agenda every Wednesday:
3583 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
3585 DIARY-STYLE SEXP ENTRIES
3586 For more complex date specifications, Org-mode supports using the
3587 special sexp diary entries implemented in the Emacs calendar/diary
3588 package. For example
3590 * The nerd meeting on every 2nd Thursday of the month
3591 <%%(diary-float t 4 2)>
3594 Two time stamps connected by `--' denote a range. The headline
3595 will be shown on the first and last day of the range, and on any
3596 dates that are displayed and fall in the range. Here is an
3599 ** Meeting in Amsterdam
3600 <2004-08-23 Mon>--<2004-08-26 Thu>
3603 Just like a plain time stamp, but with square brackets instead of
3604 angular ones. These time stamps are inactive in the sense that
3605 they do _not_ trigger an entry to show up in the agenda.
3607 * Gillian comes late for the fifth time [2006-11-01 Wed]
3610 ---------- Footnotes ----------
3612 (1) This is the standard ISO date/time format. If you cannot get
3613 used to these, see *Note Custom time format::
3616 File: org, Node: Creating timestamps, Next: Deadlines and scheduling, Prev: Time stamps, Up: Dates and times
3618 8.2 Creating timestamps
3619 =======================
3621 For Org-mode to recognize time stamps, they need to be in the specific
3622 format. All commands listed below produce time stamps in the correct
3626 Prompt for a date and insert a corresponding time stamp. When the
3627 cursor is at a previously used time stamp, it is updated to NOW.
3628 When this command is used twice in succession, a time range is
3632 Like `C-c .', but use the alternative format which contains date
3633 and time. The default time can be rounded to multiples of 5
3634 minutes, see the option `org-time-stamp-rounding-minutes'.
3637 Like `C-c .', but insert an inactive time stamp that will not cause
3641 Insert a time stamp corresponding to the cursor date in the
3645 Access the Emacs calendar for the current date. If there is a
3646 timestamp in the current line, goto the corresponding date instead.
3649 Access the agenda for the date given by the time stamp or -range at
3650 point (*note Weekly/Daily agenda::).
3654 Change date at cursor by one day. These key bindings conflict with
3655 CUA-mode (*note Conflicts::).
3659 Change the item under the cursor in a timestamp. The cursor can
3660 be on a year, month, day, hour or minute. Note that if the cursor
3661 is in a headline and not at a time stamp, these same keys modify
3662 the priority of an item. (*note Priorities::). The key bindings
3663 also conflict with CUA-mode (*note Conflicts::).
3666 Evaluate a time range by computing the difference between start and
3667 end. With prefix arg, insert result after the time range (in a
3668 table: into the following column).
3672 * The date/time prompt:: How org-mode helps you entering date and time
3673 * Custom time format:: Making dates look differently
3676 File: org, Node: The date/time prompt, Next: Custom time format, Prev: Creating timestamps, Up: Creating timestamps
3678 8.2.1 The date/time prompt
3679 --------------------------
3681 When Org-mode prompts for a date/time, the default is shown as an ISO
3682 date, and the prompt therefore seems to ask for an ISO date. But it
3683 will in fact accept any string containing some date and/or time
3684 information, and it is really smart about interpreting your input. You
3685 can, for example, use `C-y' to paste a (possibly multi-line) string
3686 copied from an email message. Org-mode will find whatever information
3687 is in there and derive anything you have not specified from the
3688 _default date and time_. The default is usually the current date and
3689 time, but when modifying an existing time stamp, or when entering the
3690 second stamp of a range, it is taken from the stamp in the buffer.
3691 When filling in information, Org-mode assumes that most of the time you
3692 will want to enter a date in the future: If you omit the month/year and
3693 the given day/month is before today, it will assume that you mean a
3696 For example, lets assume that today is June 13, 2006. Here is how
3697 various inputs will be interpreted, the items filled in by Org-mode are
3700 3-2-5 --> 2003-02-05
3703 Fri --> nearest Friday (defaultdate or later)
3704 sep 15 --> 2006-11-15
3705 feb 15 --> 2007-02-15
3706 sep 12 9 --> 2009-09-12
3707 12:45 --> 2006-06-13 12:45
3708 22 sept 0:34 --> 2006-09-22 0:34
3710 Furthermore you can specify a relative date by giving, as the
3711 _first_ thing in the input: a plus/minus sign, a number and a letter
3712 [dwmy] to indicate change in days weeks, months, years. With a single
3713 plus or minus, the date is always relative to today. With a double
3714 plus or minus, it is relative to the default date. If instead of a
3715 single letter, you use the abbreviation of day name, the date will be
3716 the nth such day. E.g.
3718 +4d --> four days from today
3719 +4 --> same as above
3720 +2w --> two weeks from today
3721 ++5 --> five days from default date
3722 +2tue --> second tuesday from now.
3724 The function understands English month and weekday abbreviations. If
3725 you want to use unabbreviated names and/or other languages, configure
3726 the variables `parse-time-months' and `parse-time-weekdays'.
3728 Parallel to the minibuffer prompt, a calendar is popped up(2). When
3729 you exit the date prompt, either by clicking on a date in the calendar,
3730 or by pressing <RET>, the date selected in the calendar will be
3731 combined with the information entered at the prompt. You can control
3732 the calendar fully from the minibuffer:
3734 > / < Scroll calendar forward/backward by one month.
3735 mouse-1 Select date by clicking on it.
3736 S-<right>/<left> One day forward/backward.
3737 S-<down>/<up> One week forward/backward.
3738 M-S-<right>/<left> One month forward/backward.
3739 <RET> Choose date in calendar.
3741 The actions of the date/time prompt may seem complex, but I asure you
3742 they will grow on you. To help you understand what is going on, the
3743 current interpretation of your input will be displayed live in the
3746 ---------- Footnotes ----------
3748 (1) See the variable `org-read-date-prefer-future'.
3750 (2) If you don't need/want the calendar, configure the variable
3751 `org-popup-calendar-for-date-prompt'.
3753 (3) If you find this distracting, turn the display of with
3754 `org-read-date-display-live'.
3757 File: org, Node: Custom time format, Prev: The date/time prompt, Up: Creating timestamps
3759 8.2.2 Custom time format
3760 ------------------------
3762 Org-mode uses the standard ISO notation for dates and times as it is
3763 defined in ISO 8601. If you cannot get used to this and require another
3764 representation of date and time to keep you happy, you can get it by
3765 customizing the variables `org-display-custom-times' and
3766 `org-time-stamp-custom-formats'.
3769 Toggle the display of custom formats for dates and times.
3771 Org-mode needs the default format for scanning, so the custom date/time
3772 format does not _replace_ the default format - instead it is put _over_
3773 the default format using text properties. This has the following
3775 * You cannot place the cursor onto a time stamp anymore, only before
3778 * The `S-<up>/<down>' keys can no longer be used to adjust each
3779 component of a time stamp. If the cursor is at the beginning of
3780 the stamp, `S-<up>/<down>' will change the stamp by one day, just
3781 like `S-<left>/<right>'. At the end of the stamp, the time will
3782 be changed by one minute.
3784 * If the time stamp contains a range of clock times or a repeater,
3785 these will not be overlayed, but remain in the buffer as they were.
3787 * When you delete a time stamp character-by-character, it will only
3788 disappear from the buffer after _all_ (invisible) characters
3789 belonging to the ISO timestamp have been removed.
3791 * If the custom time stamp format is longer than the default and you
3792 are using dates in tables, table alignment will be messed up. If
3793 the custom format is shorter, things do work as expected.
3796 File: org, Node: Deadlines and scheduling, Next: Clocking work time, Prev: Creating timestamps, Up: Dates and times
3798 8.3 Deadlines and Scheduling
3799 ============================
3801 A time stamp may be preceded by special keywords to facilitate planning
3805 The task (most likely a TODO item) is supposed to be finished on
3806 that date, and it will be listed then. In addition, the
3807 compilation for _today_ will carry a warning about the approaching
3808 or missed deadline, starting `org-deadline-warning-days' before
3809 the due date, and continuing until the entry is marked DONE. An
3812 *** TODO write article about the Earth for the Guide
3813 The editor in charge is [[bbdb:Ford Prefect]]
3814 DEADLINE: <2004-02-29 Sun>
3816 You can specify a different lead time for warnings for a specific
3817 deadlines using the following syntax. Here is an example with a
3818 warning period of 5 days `DEADLINE: <2004-02-29 Sun -5d>'.
3821 You are planning to start working on that task on the given date.
3822 The headline will be listed under the given date(1). In addition,
3823 a reminder that the scheduled date has passed will be present in
3824 the compilation for _today_, until the entry is marked DONE.
3825 I.e., the task will automatically be forwarded until completed.
3827 *** TODO Call Trillian for a date on New Years Eve.
3828 SCHEDULED: <2004-12-25 Sat>
3830 Important: Scheduling an item in Org-mode should not be understood
3831 like Scheduling a meeting. Setting a date for a meeting is just a
3832 simple appointment, you should mark this entry with a simple plain
3833 time stamp, to get this item shown on the date where it applies.
3834 This is a frequent mis-understanding from Org-users. In Org-mode,
3835 Scheduling means setting a date when you want to start working on
3840 * Inserting deadline/schedule:: Planning items
3841 * Repeated tasks:: Items that show up again and again
3843 ---------- Footnotes ----------
3845 (1) It will still be listed on that date after it has been marked
3846 DONE. If you don't like this, set the variable
3847 `org-agenda-skip-scheduled-if-done'.
3850 File: org, Node: Inserting deadline/schedule, Next: Repeated tasks, Prev: Deadlines and scheduling, Up: Deadlines and scheduling
3852 8.3.1 Inserting deadline/schedule
3853 ---------------------------------
3855 The following commands allow to quickly insert a deadline or to schedule
3859 Insert `DEADLINE' keyword along with a stamp. The insertion will
3860 happen in the line directly following the headline. When called
3861 with a prefix arg, an existing deadline will be removed from the
3865 Create a sparse tree with all deadlines that are either past-due,
3866 or which will become due within `org-deadline-warning-days'. With
3867 `C-u' prefix, show all deadlines in the file. With a numeric
3868 prefix, check that many days. For example, `C-1 C-c / d' shows
3869 all deadlines due tomorrow.
3872 Insert `SCHEDULED' keyword along with a stamp. The insertion will
3873 happen in the line directly following the headline. Any CLOSED
3874 timestamp will be removed. When called with a prefix argument,
3875 remove the scheduling date from the entry.
3878 File: org, Node: Repeated tasks, Prev: Inserting deadline/schedule, Up: Deadlines and scheduling
3880 8.3.2 Repeated Tasks
3881 --------------------
3883 Some tasks need to be repeated again and again, and Org-mode therefore
3884 allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for
3886 ** TODO Pay the rent
3887 DEADLINE: <2005-10-01 Sat +1m>
3889 Deadlines and scheduled items produce entries in the agenda when they
3890 are over-due, so it is important to be able to mark such an entry as
3891 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
3892 with the todo keyword DONE, it will no longer produce entries in the
3893 agenda. The problem with this is, however, that then also the _next_
3894 instance of the repeated entry will not be active. Org-mode deals with
3895 this in the following way: When you try to mark such an entry DONE
3896 (using `C-c C-t'), it will shift the base date of the repeating time
3897 stamp by the repeater interval, and immediately set the entry state
3898 back to TODO. In the example above, setting the state to DONE would
3899 actually switch the date like this:
3901 ** TODO Pay the rent
3902 DEADLINE: <2005-11-01 Tue +1m>
3904 You will also be prompted for a note(1) that will be put under the
3905 DEADLINE line to keep a record that you actually acted on the previous
3906 instance of this deadline.
3908 As a consequence of shifting the base date, this entry will no
3909 longer be visible in the agenda when checking past dates, but all
3910 future instances will be visible.
3912 You may have both scheduling and deadline information for a specific
3913 task - just make sure that the repeater intervals on both are the same.
3915 ---------- Footnotes ----------
3917 (1) You can change this using the option `org-log-repeat', or the
3918 `#+STARTUP' options `logrepeat' and `nologrepeat'.
3921 File: org, Node: Clocking work time, Prev: Deadlines and scheduling, Up: Dates and times
3923 8.4 Clocking work time
3924 ======================
3926 Org-mode allows you to clock the time you spent on specific tasks in a
3927 project. When you start working on an item, you can start the clock.
3928 When you stop working on that task, or when you mark the task done, the
3929 clock is stopped and the corresponding time interval is recorded. It
3930 also computes the total time spent on each subtree of a project.
3933 Start the clock on the current item (clock-in). This inserts the
3934 CLOCK keyword together with a timestamp. If this is not the first
3935 clocking of this item, the multiple CLOCK lines will be wrapped
3936 into a `:CLOCK:' drawer (see also the variable
3937 `org-clock-into-drawer'.
3940 Stop the clock (clock-out). The inserts another timestamp at the
3941 same location where the clock was last started. It also directly
3942 computes the resulting time in inserts it after the time range as
3943 `=> HH:MM'. See the variable `org-log-done' for the possibility to
3944 record an additional note together with the clock-out time
3948 Recompute the time interval after changing one of the time stamps.
3949 This is only necessary if you edit the time stamps directly. If
3950 you change them with `S-<cursor>' keys, the update is automatic.
3953 Changing the TODO state of an item to DONE automatically stops the
3954 clock if it is running in this same item.
3957 Cancel the current clock. This is useful if a clock was started by
3958 mistake, or if you ended up working on something else.
3961 Jump to the entry that contains the currently running clock, an
3965 Display time summaries for each subtree in the current buffer.
3966 This puts overlays at the end of each headline, showing the total
3967 time recorded under that heading, including the time of any
3968 subheadings. You can use visibility cycling to study the tree, but
3969 the overlays disappear when you change the buffer (see variable
3970 `org-remove-highlights-with-change') or press `C-c C-c'.
3973 Insert a dynamic block (*note Dynamic blocks::) containing a clock
3974 report as an org-mode table into the current file. When the
3975 cursor is at an existing clock table, just update it. When called
3976 with a prefix argument, jump to the first clock report in the
3977 current document and update it.
3978 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
3981 If such a block already exists at point, its content is replaced
3982 by the new table. The `BEGIN' line can specify options:
3983 :maxlevel Maximum level depth to which times are listed in the table.
3984 :emphasize When `t', emphasize level one and level two items
3985 :scope The scope to consider. This can be any of the following:
3986 nil the current buffer or narrowed region
3987 file the full current buffer
3988 subtree the subtree where the clocktable is located
3989 treeN the surrounding level N tree, for example `tree3'
3990 tree the surrounding level 1 tree
3991 agenda all agenda files
3992 ("file"..) scan these files
3993 :block The time block to consider. This block is specified relative
3994 to the current time and may be any of these keywords:
3995 `today', `yesterday', `thisweek', `lastweek',
3996 `thismonth', `lastmonth', `thisyear', or `lastyear'.
3997 :tstart A time string specifying when to start considering times
3998 :tend A time string specifying when to stop considering times
3999 So to get a clock summary of the current level 1 tree, for the
4000 current day, you could write
4001 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1
4004 and to use a specific time range you could write(2)
4005 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
4006 :tend "<2006-08-10 Thu 12:00>"
4012 Update dynamical block at point. The cursor needs to be in the
4013 `#+BEGIN' line of the dynamic block.
4016 Update all dynamic blocks (*note Dynamic blocks::). This is
4017 useful if you have several clocktable blocks in a buffer.
4019 The `l' key may be used in the timeline (*note Timeline::) and in
4020 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
4021 worked on or closed during a day.
4023 ---------- Footnotes ----------
4025 (1) The corresponding in-buffer setting is: `#+STARTUP:
4028 (2) Note that all parameters must be specified in a single line -
4029 the line is broken here only to fit it onto the manual.
4032 File: org, Node: Remember, Next: Agenda views, Prev: Dates and times, Up: Top
4037 The Remember package by John Wiegley lets you store quick notes with
4038 little interruption of your work flow. See
4039 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
4040 information. It is an excellent way to add new notes and tasks to
4041 Org-mode files. Org-mode significantly expands the possibilities of
4042 remember: You may define templates for different note types, and
4043 associate target files and headlines with specific templates. It also
4044 allows you to select the location where a note should be stored
4045 interactively, on the fly.
4049 * Setting up remember:: Some code for .emacs to get things going
4050 * Remember templates:: Define the outline of different note types
4051 * Storing notes:: Directly get the note to where it belongs
4052 * Refiling notes:: Moving a note or task to a project
4055 File: org, Node: Setting up remember, Next: Remember templates, Prev: Remember, Up: Remember
4057 9.1 Setting up remember
4058 =======================
4060 The following customization will tell remember to use org files as
4061 target, and to create annotations compatible with Org-mode links.
4063 (org-remember-insinuate)
4064 (setq org-directory "~/path/to/my/orgfiles/")
4065 (setq org-default-notes-file (concat org-directory "/notes.org"))
4066 (define-key global-map "\C-cr" 'org-remember)
4068 The last line binds the command `org-remember' to a global key(1).
4069 `org-remember' basically just calls `remember', but it makes a few
4070 things easier: If there is an active region, it will automatically copy
4071 the region into the remember buffer. It also allows to jump to the
4072 buffer and location where remember notes are being stored: Just call
4073 `org-remember' with a prefix argument.
4075 ---------- Footnotes ----------
4077 (1) Please select your own key, `C-c r' is only a suggestion.
4080 File: org, Node: Remember templates, Next: Storing notes, Prev: Setting up remember, Up: Remember
4082 9.2 Remember templates
4083 ======================
4085 In combination with Org-mode, you can use templates to generate
4086 different types of remember notes. For example, if you would like to
4087 use one template to create general TODO entries, another one for
4088 journal entries, and a third one for collecting random ideas, you could
4091 (setq org-remember-templates
4092 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
4093 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
4094 ("Idea" ?i "* %^{Title}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
4096 In these entries, the first string is just a name, and the character
4097 specifies how to select the template. It is useful if the character is
4098 also the first letter of the name. The next string specifies the
4099 template. Two more (optional) strings give the file in which, and the
4100 headline under which the new note should be stored. The file (if not
4101 present or `nil') defaults to `org-default-notes-file', the heading to
4102 `org-remember-default-headline'.
4104 When you call `M-x remember' (or `M-x org-remember') to remember
4105 something, org will prompt for a key to select the template (if you have
4106 more than one template) and then prepare the buffer like
4108 [[file:link to where you called remember]]
4110 During expansion of the template, special `%'-escapes allow dynamic
4111 insertion of content:
4112 %^{prompt} prompt the user for a string and replace this sequence with it.
4113 %t time stamp, date only
4114 %T time stamp with date and time
4115 %u, %U like the above, but inactive time stamps
4116 %^t like `%t', but prompt for date. Similarly `%^T', `%^u', `%^U'
4117 You may define a prompt like `%^{Birthday}t'
4118 %n user name (taken from `user-full-name')
4119 %a annotation, normally the link created with `org-store-link'
4120 %A like `%a', but prompt for the description part
4121 %i initial content, the region when remember is called with C-u.
4122 The entire text will be indented like `%i' itself.
4123 %c Content of the clipboard, or current kill ring head.
4124 %^g prompt for tags, with completion on tags in target file.
4125 %^G prompt for tags, with completion all tags in all agenda files.
4126 %:keyword specific information for certain link types, see below
4127 %[pathname] insert the contents of the file given by `pathname'
4128 %(sexp) evaluate elisp `(sexp)' and replace with the result
4130 For specific link types, the following keywords will be defined(1):
4132 Link type | Available keywords
4133 -------------------+----------------------------------------------
4134 bbdb | %:name %:company
4135 vm, wl, mh, rmail | %:type %:subject %:message-id
4136 | %:from %:fromname %:fromaddress
4137 | %:to %:toname %:toaddress
4138 | %:fromto (either "to NAME" or "from NAME")(2)
4139 gnus | %:group, for messages also all email fields
4141 info | %:file %:node
4144 To place the cursor after template expansion use:
4146 %? After completing the template, position cursor here.
4148 If you change you mind about which template to use, call `org-remember'
4149 in the remember buffer. You may then select a new template that will
4150 be filled with the previous context information.
4152 ---------- Footnotes ----------
4154 (1) If you define your own link types (*note Adding hyperlink
4155 types::), any property you store with `org-store-link-props' can be
4156 accessed in remember templates in a similar way.
4158 (2) This will always be the other, not the user. See the variable
4159 `org-from-is-user-regexp'.
4162 File: org, Node: Storing notes, Next: Refiling notes, Prev: Remember templates, Up: Remember
4167 When you are finished preparing a note with remember, you have to press
4168 `C-c C-c' to file the note away. The handler will store the note in
4169 the file and under the headline specified in the template, or it will
4170 use the default file and headlines. The window configuration will be
4171 restored, and you are back in the working context before the call to
4172 `remember'. To re-use the location found during the last call to
4173 `remember', exit the remember buffer with `C-u C-u C-c C-c', i.e.
4174 specify a double prefix argument to `C-c C-c'.
4176 If you want to store the note directly to a different place, use
4177 `C-u C-c C-c' instead to exit remember(1). The handler will then first
4178 prompt for a target file - if you press <RET>, the value specified for
4179 the template is used. Then the command offers the headings tree of the
4180 selected file, with the cursor position at the default headline (if you
4181 had specified one in the template). You can either immediately press
4182 <RET> to get the note placed there. Or you can use the following keys
4183 to find a different location:
4184 <TAB> Cycle visibility.
4185 <down> / <up> Next/previous visible headline.
4186 n / p Next/previous visible headline.
4187 f / b Next/previous headline same level.
4189 Pressing <RET> or <left> or <right> then leads to the following
4192 Cursor Key Note gets inserted
4194 on headline <RET> as sublevel of the heading at cursor, first or
4196 depending on `org-reverse-note-order'.
4197 <left>/<right>as same level, before/after current heading
4198 buffer-start <RET> as level 2 heading at end of file or level 1
4200 depending on `org-reverse-note-order'.
4201 not on <RET> at cursor position, level taken from context.
4204 Before inserting the text into a tree, the function ensures that the
4205 text has a headline, i.e. a first line that starts with a `*'. If not,
4206 a headline is constructed from the current date and some additional
4207 data. If you have indented the text of the note below the headline, the
4208 indentation will be adapted if inserting the note into the tree requires
4209 demotion from level 1.
4211 ---------- Footnotes ----------
4213 (1) Configure the variable `org-remember-store-without-prompt' to
4214 make this behavior the default.
4217 File: org, Node: Refiling notes, Prev: Storing notes, Up: Remember
4222 Remember is usually used to quickly capture notes and tasks into one or
4223 a few capture lists. When reviewing the captured data, you may want to
4224 refile some of the entries into a different list, for example into a
4225 project. Cutting, finding the right location and then pasting the note
4226 is cumbersome. To simplify this process, you can use the following
4230 Refile the entry at point. This command offers possible locations
4231 for refiling the entry and lets you select one with completion.
4232 The item is filed below the target heading as a subitem.
4233 Depending on `org-reverse-note-order', it will be either the first
4234 of last subitem, and you can toggle the value of this variable for
4235 the duration of the command by using a `C-u' prefix.
4236 By default, all level 1 headlines in the current buffer are
4237 considered to be targets, but you can have more complex
4238 definitions across a number of files. See the variable
4239 `org-refile-targets' for details. The list of targets is compiled
4240 upon first use, you can update it by using a double prefix
4241 argument (`C-u C-u') to this command.
4244 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Remember, Up: Top
4249 Due to the way Org-mode works, TODO items, time-stamped items, and
4250 tagged headlines can be scattered throughout a file or even a number of
4251 files. To get an overview over open action items, or over events that
4252 are important for a particular date, this information must be collected,
4253 sorted and displayed in an organized way.
4255 Org-mode can select items based on various criteria, and display them
4256 in a separate buffer. Six different view types are provided:
4258 * an _agenda_ that is like a calendar and shows information for
4261 * a _TODO list_ that covers all unfinished action items,
4263 * a _tags view_, showings headlines based on the tags associated
4266 * a _timeline view_ that shows all events in a single Org-mode file,
4267 in time-sorted view,
4269 * a _stuck projects view_ showing projects that currently don't move
4272 * _custom views_ that are special tag/keyword searches and
4273 combinations of different views.
4275 The extracted information is displayed in a special _agenda buffer_.
4276 This buffer is read-only, but provides commands to visit the
4277 corresponding locations in the original Org-mode files, and even to
4278 edit these files remotely.
4280 Two variables control how the agenda buffer is displayed and whether
4281 the window configuration is restored when the agenda exits:
4282 `org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
4286 * Agenda files:: Files being searched for agenda information
4287 * Agenda dispatcher:: Keyboard access to agenda views
4288 * Built-in agenda views:: What is available out of the box?
4289 * Presentation and sorting:: How agenda items are prepared for display
4290 * Agenda commands:: Remote editing of org trees
4291 * Custom agenda views:: Defining special searches and views
4294 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
4299 The information to be shown is collected from all _agenda files_, the
4300 files listed in the variable `org-agenda-files'(1). If a directory is
4301 part of this list, all files with the extension `.org' in this
4302 directory will be part of the list.
4304 Thus even if you only work with a single Org-mode file, this file
4305 should be put into that list(2). You can customize `org-agenda-files',
4306 but the easiest way to maintain it is through the following commands
4309 Add current file to the list of agenda files. The file is added to
4310 the front of the list. If it was already in the list, it is moved
4311 to the front. With prefix arg, file is added/moved to the end.
4314 Remove current file from the list of agenda files.
4318 Cycle through agenda file list, visiting one file after the other.
4320 The Org menu contains the current list of files and can be used to
4323 ---------- Footnotes ----------
4325 (1) If the value of that variable is not a list, but a single file
4326 name, then the list of agenda files will be maintained in that external
4329 (2) When using the dispatcher, pressing `<' before selecting a
4330 command will actually limit the command to the current file, and ignore
4331 `org-agenda-files' until the next dispatcher command.
4334 File: org, Node: Agenda dispatcher, Next: Built-in agenda views, Prev: Agenda files, Up: Agenda views
4336 10.2 The agenda dispatcher
4337 ==========================
4339 The views are created through a dispatcher that should be bound to a
4340 global key, for example `C-c a' (*note Installation::). In the
4341 following we will assume that `C-c a' is indeed how the dispatcher is
4342 accessed and list keyboard access to commands accordingly. After
4343 pressing `C-c a', an additional letter is required to execute a
4344 command. The dispatcher offers the following default commands:
4346 Create the calendar-like agenda (*note Weekly/Daily agenda::).
4349 Create a list of all TODO items (*note Global TODO list::).
4352 Create a list of headlines matching a TAGS expression (*note
4353 Matching tags and properties::).
4356 Create the timeline view for the current buffer (*note Timeline::).
4359 Create a list of stuck projects (*note Stuck projects::).
4362 Search for a regular expression in all agenda files and
4363 additionally in the files listed in
4364 `org-agenda-multi-occur-extra-files'. This uses the Emacs command
4365 `multi-occur'. A prefix argument can be used to specify the
4366 number of context lines for each match, default is 1.
4369 Restrict an agenda command to the current buffer(1). After
4370 pressing `<', you still need to press the character selecting the
4374 If there is an active region, restrict the following agenda
4375 command to the region. Otherwise, restrict it to the current
4376 subtree(2). After pressing `< <', you still need to press the
4377 character selecting the command.
4379 You can also define custom commands that will be accessible through
4380 the dispatcher, just like the default commands. This includes the
4381 possibility to create extended agenda buffers that contain several
4382 blocks together, for example the weekly agenda, the global TODO list and
4383 a number of special tags matches. *Note Custom agenda views::.
4385 ---------- Footnotes ----------
4387 (1) For backward compatibility, you can also press `1' to restrict
4388 to the current buffer.
4390 (2) For backward compatibility, you can also press `0' to restrict
4391 to the current buffer.
4394 File: org, Node: Built-in agenda views, Next: Presentation and sorting, Prev: Agenda dispatcher, Up: Agenda views
4396 10.3 The built-in agenda views
4397 ==============================
4399 In this section we describe the built-in views.
4403 * Weekly/Daily agenda:: The calendar page with current tasks
4404 * Global TODO list:: All unfinished action items
4405 * Matching tags and properties:: Structured information with fine-tuned search
4406 * Timeline:: Time-sorted view for single file
4407 * Stuck projects:: Find projects you need to review
4410 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Built-in agenda views, Up: Built-in agenda views
4412 10.3.1 The weekly/daily agenda
4413 ------------------------------
4415 The purpose of the weekly/daily _agenda_ is to act like a page of a
4416 paper agenda, showing all the tasks for the current week or day.
4419 Compile an agenda for the current week from a list of org files.
4420 The agenda shows the entries for each day. With a numeric
4421 prefix(1) (like `C-u 2 1 C-c a a') you may set the number of days
4422 to be displayed (see also the variable `org-agenda-ndays')
4424 Remote editing from the agenda buffer means, for example, that you
4425 can change the dates of deadlines and appointments from the agenda
4426 buffer. The commands available in the Agenda buffer are listed in
4427 *Note Agenda commands::.
4429 Calendar/Diary integration
4430 ..........................
4432 Emacs contains the calendar and diary by Edward M. Reingold. The
4433 calendar displays a three-month calendar with holidays from different
4434 countries and cultures. The diary allows you to keep track of
4435 anniversaries, lunar phases, sunrise/set, recurrent appointments
4436 (weekly, monthly) and more. In this way, it is quite complementary to
4437 Org-mode. It can be very useful to combine output from Org-mode with
4440 In order to include entries from the Emacs diary into Org-mode's
4441 agenda, you only need to customize the variable
4443 (setq org-agenda-include-diary t)
4445 After that, everything will happen automatically. All diary entries
4446 including holidays, anniversaries etc will be included in the agenda
4447 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
4448 the agenda buffer to jump to the diary file in order to edit existing
4449 diary entries. The `i' command to insert new entries for the current
4450 date works in the agenda buffer, as well as the commands `S', `M', and
4451 `C' to display Sunrise/Sunset times, show lunar phases and to convert
4452 to other calendars, respectively. `c' can be used to switch back and
4453 forth between calendar and agenda.
4455 If you are using the diary only for sexp entries and holidays, it is
4456 faster to not use the above setting, but instead to copy or even move
4457 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
4458 entries, and does it faster because there is no overhead for first
4459 creating the diary display. Note that the sexp entries must start at
4460 the left margin, no white space is allowed before them. For example,
4461 the following segment of an Org-mode file will be processed and entries
4462 will be made in the agenda:
4464 * Birthdays and similar stuff
4466 %%(org-calendar-holiday) ; special function for holiday names
4468 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
4469 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
4471 Appointment reminders
4472 .....................
4474 Org can interact with Emacs appointments notification facility.
4476 To add all the appointments of your agenda files, use the command
4477 `org-agenda-to-appt'. This commands also lets you filter through the
4478 list of your appointments and add only those belonging to a specific
4479 category or matching a regular expression. See the docstring for
4482 ---------- Footnotes ----------
4484 (1) For backward compatibility, the universal prefix `C-u' causes
4485 all TODO entries to be listed before the agenda. This feature is
4486 deprecated, use the dedicated TODO list, or a block agenda instead.
4489 File: org, Node: Global TODO list, Next: Matching tags and properties, Prev: Weekly/Daily agenda, Up: Built-in agenda views
4491 10.3.2 The global TODO list
4492 ---------------------------
4494 The global TODO list contains all unfinished TODO items, formatted and
4495 collected into a single place.
4498 Show the global TODO list. This collects the TODO items from all
4499 agenda files (*note Agenda views::) into a single buffer. The
4500 buffer is in `agenda-mode', so there are commands to examine and
4501 manipulate the TODO entries directly from that buffer (*note
4505 Like the above, but allows selection of a specific TODO keyword.
4506 You can also do this by specifying a prefix argument to `C-c a t'.
4507 With a `C-u' prefix you are prompted for a keyword, and you may
4508 also specify several keywords by separating them with `|' as
4509 boolean OR operator. With a numeric prefix, the Nth keyword in
4510 `org-todo-keywords' is selected. The `r' key in the agenda buffer
4511 regenerates it, and you can give a prefix argument to this command
4512 to change the selected TODO keyword, for example `3 r'. If you
4513 often need a search for a specific keyword, define a custom
4514 command for it (*note Agenda dispatcher::).
4515 Matching specific TODO keywords can also be done as part of a tags
4516 search (*note Tag searches::).
4518 Remote editing of TODO items means that you can change the state of a
4519 TODO entry with a single key press. The commands available in the TODO
4520 list are described in *Note Agenda commands::.
4522 Normally the global todo list simply shows all headlines with TODO
4523 keywords. This list can become very long. There are two ways to keep
4525 - Some people view a TODO item that has been _scheduled_ for
4526 execution (*note Time stamps::) as no longer _open_. Configure the
4527 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
4528 items from the global TODO list.
4530 - TODO items may have sublevels to break up the task into subtasks.
4531 In such cases it may be enough to list only the highest level TODO
4532 headline and omit the sublevels from the global list. Configure
4533 the variable `org-agenda-todo-list-sublevels' to get this behavior.
4536 File: org, Node: Matching tags and properties, Next: Timeline, Prev: Global TODO list, Up: Built-in agenda views
4538 10.3.3 Matching Tags and Properties
4539 -----------------------------------
4541 If headlines in the agenda files are marked with _tags_ (*note Tags::),
4542 you can select headlines based on the tags that apply to them and
4543 collect them into an agenda buffer.
4546 Produce a list of all headlines that match a given set of tags.
4547 The command prompts for a selection criterion, which is a boolean
4548 logic expression with tags, like `+work+urgent-withboss' or
4549 `work|home' (*note Tags::). If you often need a specific search,
4550 define a custom command for it (*note Agenda dispatcher::).
4553 Like `C-c a m', but only select headlines that are also TODO items
4554 and force checking subitems (see variable
4555 `org-tags-match-list-sublevels'). Matching specific todo keywords
4556 together with a tags match is also possible, see *Note Tag
4559 The commands available in the tags list are described in *Note
4563 File: org, Node: Timeline, Next: Stuck projects, Prev: Matching tags and properties, Up: Built-in agenda views
4565 10.3.4 Timeline for a single file
4566 ---------------------------------
4568 The timeline summarizes all time-stamped items from a single Org-mode
4569 file in a _time-sorted view_. The main purpose of this command is to
4570 give an overview over events in a project.
4573 Show a time-sorted view of the org file, with all time-stamped
4574 items. When called with a `C-u' prefix, all unfinished TODO
4575 entries (scheduled or not) are also listed under the current date.
4577 The commands available in the timeline buffer are listed in *Note
4581 File: org, Node: Stuck projects, Prev: Timeline, Up: Built-in agenda views
4583 10.3.5 Stuck projects
4584 ---------------------
4586 If you are following a system like David Allen's GTD to organize your
4587 work, one of the "duties" you have is a regular review to make sure
4588 that all projects move along. A _stuck_ project is a project that has
4589 no defined next actions, so it will never show up in the TODO lists
4590 Org-mode produces. During the review, you need to identify such
4591 projects and define next actions for them.
4594 List projects that are stuck.
4597 Customize the variable `org-stuck-projects' to define what a stuck
4598 project is and how to find it.
4600 You almost certainly will have to configure this view before it will
4601 work for you. The built-in default assumes that all your projects are
4602 level-2 headlines, and that a project is not stuck if it has at least
4603 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
4605 Lets assume that you, in your own way of using Org-mode, identify
4606 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
4607 indicate a project that should not be considered yet. Lets further
4608 assume that the todo keyword DONE marks finished projects, and that NEXT
4609 and TODO indicate next actions. The tag @SHOP indicates shopping and
4610 is a next action even without the NEXT tag. Finally, if the project
4611 contains the special word IGNORE anywhere, it should not be listed
4612 either. In this case you would start by identifying eligible projects
4613 with a tags/todo match `+PROJECT/-MAYBE-DONE', and then check for TODO,
4614 NEXT, @SHOP, and IGNORE in the subtree to identify projects that are
4615 not stuck. The correct customization for this is
4617 (setq org-stuck-projects
4618 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@SHOP")
4622 File: org, Node: Presentation and sorting, Next: Agenda commands, Prev: Built-in agenda views, Up: Agenda views
4624 10.4 Presentation and sorting
4625 =============================
4627 Before displaying items in an agenda view, Org-mode visually prepares
4628 the items and sorts them. Each item occupies a single line. The line
4629 starts with a _prefix_ that contains the _category_ (*note
4630 Categories::) of the item and other important information. You can
4631 customize the prefix using the option `org-agenda-prefix-format'. The
4632 prefix is followed by a cleaned-up version of the outline headline
4633 associated with the item.
4637 * Categories:: Not all tasks are equal
4638 * Time-of-day specifications:: How the agenda knows the time
4639 * Sorting of agenda items:: The order of things
4642 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Presentation and sorting, Up: Presentation and sorting
4647 The category is a broad label assigned to each agenda item. By default,
4648 the category is simply derived from the file name, but you can also
4649 specify it with a special line in the buffer, like this(1):
4653 If you would like to have a special CATEGORY for a single entry or a
4654 (sub)tree, give the entry a `:CATEGORY:' property with the location as
4655 the value (*note Properties and columns::).
4657 The display in the agenda buffer looks best if the category is not
4658 longer than 10 characters.
4660 ---------- Footnotes ----------
4662 (1) For backward compatibility, the following also works: If there
4663 are several such lines in a file, each specifies the category for the
4664 text below it. The first category also applies to any text before the
4665 first CATEGORY line. However, using this method is _strongly_
4666 deprecated as it is incompatible with the outline structure of the
4667 document. The correct method for setting multiple categories in a
4668 buffer is using a property.
4671 File: org, Node: Time-of-day specifications, Next: Sorting of agenda items, Prev: Categories, Up: Presentation and sorting
4673 10.4.2 Time-of-Day Specifications
4674 ---------------------------------
4676 Org-mode checks each agenda item for a time-of-day specification. The
4677 time can be part of the time stamp that triggered inclusion into the
4678 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
4679 specified with two time stamps, like
4680 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
4682 In the headline of the entry itself, a time(range) may also appear as
4683 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
4684 Emacs diary (*note Weekly/Daily agenda::), time specifications in diary
4685 entries are recognized as well.
4687 For agenda display, Org-mode extracts the time and displays it in a
4688 standard 24 hour format as part of the prefix. The example times in
4689 the previous paragraphs would end up in the agenda like this:
4691 8:30-13:00 Arthur Dent lies in front of the bulldozer
4692 12:45...... Ford Prefect arrives and takes Arthur to the pub
4693 19:00...... The Vogon reads his poem
4694 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
4696 If the agenda is in single-day mode, or for the display of today, the
4697 timed entries are embedded in a time grid, like
4699 8:00...... ------------------
4700 8:30-13:00 Arthur Dent lies in front of the bulldozer
4701 10:00...... ------------------
4702 12:00...... ------------------
4703 12:45...... Ford Prefect arrives and takes Arthur to the pub
4704 14:00...... ------------------
4705 16:00...... ------------------
4706 18:00...... ------------------
4707 19:00...... The Vogon reads his poem
4708 20:00...... ------------------
4709 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
4711 The time grid can be turned on and off with the variable
4712 `org-agenda-use-time-grid', and can be configured with
4713 `org-agenda-time-grid'.
4716 File: org, Node: Sorting of agenda items, Prev: Time-of-day specifications, Up: Presentation and sorting
4718 10.4.3 Sorting of agenda items
4719 ------------------------------
4721 Before being inserted into a view, the items are sorted. How this is
4722 done depends on the type of view.
4723 * For the daily/weekly agenda, the items for each day are sorted.
4724 The default order is to first collect all items containing an
4725 explicit time-of-day specification. These entries will be shown
4726 at the beginning of the list, as a _schedule_ for the day. After
4727 that, items remain grouped in categories, in the sequence given by
4728 `org-agenda-files'. Within each category, items are sorted by
4729 priority (*note Priorities::), which is composed of the base
4730 priority (2000 for priority `A', 1000 for `B', and 0 for `C'),
4731 plus additional increments for overdue scheduled or deadline items.
4733 * For the TODO list, items remain in the order of categories, but
4734 within each category, sorting takes place according to priority
4735 (*note Priorities::).
4737 * For tags matches, items are not sorted at all, but just appear in
4738 the sequence in which they are found in the agenda files.
4740 Sorting can be customized using the variable
4741 `org-agenda-sorting-strategy'.
4744 File: org, Node: Agenda commands, Next: Custom agenda views, Prev: Presentation and sorting, Up: Agenda views
4746 10.5 Commands in the agenda buffer
4747 ==================================
4749 Entries in the agenda buffer are linked back to the org file or diary
4750 file where they originate. You are not allowed to edit the agenda
4751 buffer itself, but commands are provided to show and jump to the
4752 original entry location, and to edit the org-files "remotely" from the
4753 agenda buffer. In this way, all information is stored only once,
4754 removing the risk that your agenda and note files may diverge.
4756 Some commands can be executed with mouse clicks on agenda lines. For
4757 the other commands, the cursor needs to be in the desired line.
4763 Next line (same as <up> and `C-p').
4766 Previous line (same as <down> and `C-n').
4773 Display the original location of the item in another window.
4776 Display original location and recenter that window.
4781 Go to the original location of the item in another window. Under
4782 Emacs 22, `mouse-1' will also works for this.
4785 Go to the original location of the item and delete other windows.
4788 Toggle Follow mode. In Follow mode, as you move the cursor through
4789 the agenda buffer, the other window always shows the corresponding
4790 location in the org file. The initial setting for this mode in new
4791 agenda buffers can be set with the variable
4792 `org-agenda-start-with-follow-mode'.
4795 Display the entire subtree of the current item in an indirect
4796 buffer. With numerical prefix ARG, go up to this level and then
4797 take that tree. If ARG is negative, go up that many levels. With
4798 `C-u' prefix, do not remove the previously used indirect buffer.
4801 Toggle Logbook mode. In Logbook mode, entries that where marked
4802 DONE while logging was on (variable `org-log-done') are shown in
4803 the agenda, as are entries that have been clocked on that day.
4809 Delete other windows.
4812 Switch to day/week/month/year view. When switching to day or week
4813 view, this setting becomes the default for subseqent agenda
4814 commands. Since month and year views are slow to create, the do
4815 not become the default.
4818 Toggle the inclusion of diary entries. See *Note Weekly/Daily
4822 Toggle the time grid on and off. See also the variables
4823 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
4826 Recreate the agenda buffer, for example to reflect the changes
4827 after modification of the time stamps of items with S-<left> and
4828 S-<right>. When the buffer is the global todo list, a prefix
4829 argument is interpreted to create a selective list for a specific
4834 Save all Org-mode buffers in the current Emacs session.
4837 Display the following `org-agenda-ndays' days. For example, if
4838 the display covers a week, switch to the following week. With
4839 prefix arg, go forward that many times `org-agenda-ndays' days.
4842 Display the previous dates.
4854 Undo a change due to a remote editing command. The change is
4855 undone both in the agenda buffer and in the remote buffer.
4858 Change the TODO state of the item, both in the agenda and in the
4862 Delete the current agenda item along with the entire subtree
4863 belonging to it in the original Org-mode file. If the text to be
4864 deleted remotely is longer than one line, the kill needs to be
4865 confirmed by the user. See variable `org-agenda-confirm-kill'.
4868 Archive the subtree corresponding to the current headline.
4871 Show all tags associated with the current item. Because of
4872 inheritance, this may be more than the tags listed in the line
4876 Set tags for the current headline. If there is an active region
4877 in the agenda, change a tag for all headings in the region.
4880 Toggle the ARCHIVE tag for the current headline.
4883 Set the priority for the current item. Org-mode prompts for the
4884 priority character. If you reply with <SPC>, the priority cookie
4885 is removed from the entry.
4888 Display weighted priority of current item.
4892 Increase the priority of the current item. The priority is
4893 changed in the original buffer, but the agenda is not resorted.
4894 Use the `r' key for this.
4898 Decrease the priority of the current item.
4904 Set a deadline for this item.
4907 Change the time stamp associated with the current line by one day
4908 into the future. With prefix argument, change it by that many
4909 days. For example, `3 6 5 S-<right>' will change it by a year.
4910 The stamp is changed in the original org file, but the change is
4911 not directly reflected in the agenda buffer. Use the `r' key to
4915 Change the time stamp associated with the current line by one day
4919 Change the time stamp associated with the current line to today.
4920 The key `>' has been chosen, because it is the same as `S-.' on my
4924 Start the clock on the current item. If a clock is running
4925 already, it is stopped first.
4928 Stop the previously started clock.
4931 Cancel the currently running clock.
4934 Jump to the running clock in another window.
4940 Open the Emacs calendar and move to the date at the agenda cursor.
4943 When in the calendar, compute and show the Org-mode agenda for the
4947 Insert a new entry into the diary. Prompts for the type of entry
4948 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
4949 new entry in the diary, just as `i d' etc. would do in the
4950 calendar. The date is taken from the cursor position.
4953 Show the phases of the moon for the three months around current
4957 Show sunrise and sunset times. The geographical location must be
4958 set with calendar variables, see documentation of the Emacs
4962 Convert the date at cursor into many other cultural and historic
4966 Show holidays for three month around the cursor date.
4969 Export a single iCalendar file containing entries from all agenda
4976 Write the agenda view to a file. Depending on the extension of the
4977 selected file name, the view will be exported as HTML (extension
4978 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
4979 (any other extension). Use the variable
4980 `org-agenda-exporter-settings' to set options for `ps-print' and
4981 for `htmlize' to be used during export.
4987 Quit agenda, remove the agenda buffer.
4990 Exit agenda, remove the agenda buffer and all buffers loaded by
4991 Emacs for the compilation of the agenda. Buffers created by the
4992 user to visit org files will not be removed.
4995 File: org, Node: Custom agenda views, Prev: Agenda commands, Up: Agenda views
4997 10.6 Custom agenda views
4998 ========================
5000 Custom agenda commands serve two purposes: to store and quickly access
5001 frequently used TODO and tags searches, and to create special composite
5002 agenda buffers. Custom agenda commands will be accessible through the
5003 dispatcher (*note Agenda dispatcher::), just like the default commands.
5007 * Storing searches:: Type once, use often
5008 * Block agenda:: All the stuff you need in a single buffer
5009 * Setting Options:: Changing the rules
5010 * Exporting Agenda Views:: Writing agendas to files.
5011 * Extracting Agenda Information for other programs::
5014 File: org, Node: Storing searches, Next: Block agenda, Prev: Custom agenda views, Up: Custom agenda views
5016 10.6.1 Storing searches
5017 -----------------------
5019 The first application of custom searches is the definition of keyboard
5020 shortcuts for frequently used searches, either creating an agenda
5021 buffer, or a sparse tree (the latter covering of course only the current
5022 buffer). Custom commands are configured in the variable
5023 `org-agenda-custom-commands'. You can customize this variable, for
5024 example by pressing `C-c a C'. You can also directly set it with Emacs
5025 Lisp in `.emacs'. The following example contains all valid search
5028 (setq org-agenda-custom-commands
5029 '(("w" todo "WAITING")
5030 ("W" todo-tree "WAITING")
5031 ("u" tags "+BOSS-URGENT")
5032 ("v" tags-todo "+BOSS-URGENT")
5033 ("U" tags-tree "+BOSS-URGENT")
5034 ("f" occur-tree "\\<FIXME\\>")
5035 ("h" . "HOME+Name tags searches") ; description for "h" prefix
5036 ("hl" tags "+HOME+Lisa")
5037 ("hp" tags "+HOME+Peter")
5038 ("hk" tags "+HOME+Kim")))
5040 The initial string in each entry defines the keys you have to press
5041 after the dispatcher command `C-c a' in order to access the command.
5042 Usually this will be just a single character, but if you have many
5043 similar commands, you can also define two-letter combinations where the
5044 first character is the same in several combinations and serves as a
5045 prefix key(1). The second parameter is the search type, followed by
5046 the string or regular expression to be used for the matching. The
5047 example above will therefore define:
5050 as a global search for TODO entries with `WAITING' as the TODO
5054 as the same search, but only in the current buffer and displaying
5055 the results as a sparse tree
5058 as a global tags search for headlines marked `:BOSS:' but not
5062 as the same search as `C-c a u', but limiting the search to
5063 headlines that are also TODO items
5066 as the same search as `C-c a u', but only in the current buffer and
5067 displaying the result as a sparse tree
5070 to create a sparse tree (again: current buffer only) with all
5071 entries containing the word `FIXME'
5074 as a prefix command for a HOME tags search where you have to press
5075 an additional key (`l', `p' or `k') to select a name (Lisa, Peter,
5076 or Kim) as additional tag to match.
5078 ---------- Footnotes ----------
5080 (1) You can provide a description for a prefix key by inserting a
5081 cons cell with the prefix and the description.
5084 File: org, Node: Block agenda, Next: Setting Options, Prev: Storing searches, Up: Custom agenda views
5089 Another possibility is the construction of agenda views that comprise
5090 the results of _several_ commands, each of which creates a block in the
5091 agenda buffer. The available commands include `agenda' for the daily
5092 or weekly agenda (as created with `C-c a a'), `alltodo' for the global
5093 todo list (as constructed with `C-c a t'), and the matching commands
5094 discussed above: `todo', `tags', and `tags-todo'. Here are two
5097 (setq org-agenda-custom-commands
5098 '(("h" "Agenda and Home-related tasks"
5102 ("o" "Agenda and Office-related tasks"
5107 This will define `C-c a h' to create a multi-block view for stuff you
5108 need to attend to at home. The resulting agenda buffer will contain
5109 your agenda for the current week, all TODO items that carry the tag
5110 `HOME', and also all lines tagged with `GARDEN'. Finally the command
5111 `C-c a o' provides a similar view for office tasks.
5114 File: org, Node: Setting Options, Next: Exporting Agenda Views, Prev: Block agenda, Up: Custom agenda views
5116 10.6.3 Setting Options for custom commands
5117 ------------------------------------------
5119 Org-mode contains a number of variables regulating agenda construction
5120 and display. The global variables define the behavior for all agenda
5121 commands, including the custom commands. However, if you want to change
5122 some settings just for a single custom view, you can do so. Setting
5123 options requires inserting a list of variable names and values at the
5124 right spot in `org-agenda-custom-commands'. For example:
5126 (setq org-agenda-custom-commands
5127 '(("w" todo "WAITING"
5128 ((org-agenda-sorting-strategy '(priority-down))
5129 (org-agenda-prefix-format " Mixed: ")))
5130 ("U" tags-tree "+BOSS-URGENT"
5131 ((org-show-following-heading nil)
5132 (org-show-hierarchy-above nil)))))
5134 Now the `C-c a w' command will sort the collected entries only by
5135 priority, and the prefix format is modified to just say ` Mixed:'
5136 instead of giving the category of the entry. The sparse tags tree of
5137 `C-c a U' will now turn out ultra-compact, because neither the headline
5138 hierarchy above the match, nor the headline following the match will be
5141 For command sets creating a block agenda,
5142 `org-agenda-custom-commands' has two separate spots for setting
5143 options. You can add options that should be valid for just a single
5144 command in the set, and options that should be valid for all commands in
5145 the set. The former are just added to the command entry, the latter
5146 must come after the list of command entries. Going back to the block
5147 agenda example (*note Block agenda::), let's change the sorting strategy
5148 for the `C-c a h' commands to `priority-down', but let's sort the
5149 results for GARDEN tags query in the opposite order, `priority-up'.
5150 This would look like this:
5152 (setq org-agenda-custom-commands
5153 '(("h" "Agenda and Home-related tasks"
5157 ((org-agenda-sorting-strategy '(priority-up)))))
5158 ((org-agenda-sorting-strategy '(priority-down))))
5159 ("o" "Agenda and Office-related tasks"
5164 As you see, the values and parenthesis setting is a little complex.
5165 When in doubt, use the customize interface to set this variable - it
5166 fully supports its structure. Just one caveat: When setting options in
5167 this interface, the _values_ are just lisp expressions. So if the
5168 value is a string, you need to add the double quotes around the value
5172 File: org, Node: Exporting Agenda Views, Next: Extracting Agenda Information for other programs, Prev: Setting Options, Up: Custom agenda views
5174 10.6.4 Exporting Agenda Views
5175 -----------------------------
5177 If you are away from your computer, it can be very useful to have a
5178 printed version of some agenda views to carry around. Org-mode can
5179 export custom agenda views as plain text, HTML(1) and postscript. If
5180 you want to do this only occasionally, use the command
5183 Write the agenda view to a file. Depending on the extension of the
5184 selected file name, the view will be exported as HTML (extension
5185 `.html' or `.htm'), Postscript (extension `.ps'), or plain text
5186 (any other extension). Use the variable
5187 `org-agenda-exporter-settings' to set options for `ps-print' and
5188 for `htmlize' to be used during export, for example
5189 (setq org-agenda-exporter-settings
5190 '((ps-number-of-columns 2)
5191 (ps-landscape-mode t)
5192 (htmlize-output-type 'css)))
5194 If you need to export certain agenda views frequently, you can
5195 associate any custom agenda command with a list of output file names
5196 (2). Here is an example that first does define custom commands for the
5197 agenda and the global todo list, together with a number of files to
5198 which to export them. Then we define two block agenda commands and
5199 specify filenames for them as well. File names can be relative to the
5200 current working directory, or absolute.
5202 (setq org-agenda-custom-commands
5203 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
5204 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
5205 ("h" "Agenda and Home-related tasks"
5210 ("~/views/home.html"))
5211 ("o" "Agenda and Office-related tasks"
5216 ("~/views/office.ps"))))
5218 The extension of the file name determines the type of export. If it
5219 is `.html', Org-mode will use the `htmlize.el' package to convert the
5220 buffer to HTML and save it to this file name. If the extension is
5221 `.ps', `ps-print-buffer-with-faces' is used to produce postscript
5222 output. Any other extension produces a plain ASCII file.
5224 The export files are _not_ created when you use one of those
5225 commands interactively. Instead, there is a special command to produce
5226 _all_ specified files in one step:
5229 Export all agenda views that have export filenames associated with
5232 You can use the options section of the custom agenda commands to also
5233 set options for the export commands. For example:
5235 (setq org-agenda-custom-commands
5237 ((ps-number-of-columns 2)
5238 (ps-landscape-mode t)
5239 (org-agenda-prefix-format " [ ] ")
5240 (org-agenda-with-colors nil)
5241 (org-agenda-remove-tags t))
5244 This command sets two options for the postscript exporter, to make it
5245 print in two columns in landscape format - the resulting page can be cut
5246 in two and then used in a paper agenda. The remaining settings modify
5247 the agenda prefix to omit category and scheduling information, and
5248 instead include a checkbox to check off items. We also remove the tags
5249 to make the lines compact, and we don't want to use colors for the
5250 black-and-white printer. Settings specified in
5251 `org-agenda-exporter-settings' will also apply, but the settings in
5252 `org-agenda-custom-commands' take precedence.
5254 From the command line you may also use
5255 emacs -f org-batch-store-agenda-views -kill
5256 or, if you need to modify some parameters
5257 emacs -eval '(org-batch-store-agenda-views \
5258 org-agenda-ndays 30 \
5259 org-agenda-start-day "2007-11-01" \
5260 org-agenda-include-diary nil \
5261 org-agenda-files (quote ("~/org/project.org")))' \
5263 which will create the agenda views restricted to the file
5264 `~/org/project.org', without diary entries and with 30 days extent.
5266 ---------- Footnotes ----------
5268 (1) You need to install Hrvoje Niksic' `htmlize.el'.
5270 (2) If you want to store standard views like the weekly agenda or
5271 the global TODO list as well, you need to define custom commands for
5272 them in order to be able to specify filenames.
5275 File: org, Node: Extracting Agenda Information for other programs, Prev: Exporting Agenda Views, Up: Custom agenda views
5277 10.6.5 Extracting Agenda Information for other programs
5278 -------------------------------------------------------
5280 Org-mode provides commands to access agenda information for the command
5281 line in emacs batch mode. This extracted information can be sent
5282 directly to a printer, or it can be read by a program that does further
5283 processing of the data. The first of these commands is the function
5284 `org-batch-agenda', that produces an agenda view and sends it as ASCII
5285 text to STDOUT. The command takes a single string as parameter. If
5286 the string has length 1, it is used as a key to one of the commands you
5287 have configured in `org-agenda-custom-commands', basically any key you
5288 can use after `C-c a'. For example, to directly print the current TODO
5291 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
5293 If the parameter is a string with 2 or more characters, it is used
5294 as a tags/todo match string. For example, to print your local shopping
5295 list (all items with the tag `shop', but excluding the tag `NewYork'),
5298 emacs -batch -l ~/.emacs \
5299 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
5301 You may also modify parameters on the fly like this:
5303 emacs -batch -l ~/.emacs \
5304 -eval '(org-batch-agenda "a" \
5305 org-agenda-ndays 30 \
5306 org-agenda-include-diary nil \
5307 org-agenda-files (quote ("~/org/project.org")))' \
5310 which will produce a 30 day agenda, fully restricted to the Org file
5311 `~/org/projects.org', not even including the diary.
5313 If you want to process the agenda data in more sophisticated ways,
5314 you can use the command `org-batch-agenda-csv' to get a comma-separated
5315 list of values for each agenda item. Each line in the output will
5316 contain a number of fields separated by commas. The fields in a line
5319 category The category of the item
5320 head The headline, without TODO kwd, TAGS and PRIORITY
5321 type The type of the agenda entry, can be
5322 todo selected in TODO match
5323 tagsmatch selected in tags match
5324 diary imported from diary
5327 timestamp appointment, selected by timestamp
5328 closed entry was closed on date
5329 upcoming-deadline warning about nearing deadline
5330 past-scheduled forwarded scheduled item
5331 block entry has date block including date
5332 todo The todo keyword, if any
5333 tags All tags including inherited ones, separated by colons
5334 date The relevant date, like 2007-2-14
5335 time The time, like 15:00-16:50
5336 extra String with extra planning info
5337 priority-l The priority letter if any was given
5338 priority-n The computed numerical priority
5340 Time and date will only be given if a timestamp (or deadline/scheduled)
5341 lead to the selection of the item.
5343 A CSV list like this is very easy to use in a post processing script.
5344 For example, here is a Perl program that gets the TODO list from
5345 Emacs/org-mode and prints all the items, preceded by a checkbox:
5349 # define the Emacs command to run
5350 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
5352 # run it and capture the output
5353 $agenda = qx{$cmd 2>/dev/null};
5355 # loop over all lines
5356 foreach $line (split(/\n/,$agenda)) {
5358 # get the individual values
5359 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
5360 $priority_l,$priority_n) = split(/,/,$line);
5362 # proccess and print
5363 print "[ ] $head\n";
5367 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
5372 Plain ASCII is normally sufficient for almost all note taking. One
5373 exception, however, are scientific notes which need to be able to
5374 contain mathematical symbols and the occasional formula. LaTeX(1) is
5375 widely used to typeset scientific documents. Org-mode supports
5376 embedding LaTeX code into its files, because many academics are used to
5377 read LaTeX source code, and because it can be readily processed into
5378 images for HTML production.
5380 It is not necessary to mark LaTeX macros and code in any special way.
5381 If you observe a few conventions, Org-mode knows how to find it and what
5386 * Math symbols:: TeX macros for symbols and Greek letters
5387 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
5388 * LaTeX fragments:: Complex formulas made easy
5389 * Processing LaTeX fragments:: Previewing LaTeX processing
5390 * CDLaTeX mode:: Speed up entering of formulas
5392 ---------- Footnotes ----------
5394 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
5395 Many of the features described here as "LaTeX" are really from TeX, but
5396 for simplicity I am blurring this distinction.
5399 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
5404 You can use LaTeX macros to insert special symbols like `\alpha' to
5405 indicate the Greek letter, or `\to' to indicate an arrow. Completion
5406 for these macros is available, just type `\' and maybe a few letters,
5407 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
5408 Org-mode allows these macros to be present without surrounding math
5409 delimiters, for example:
5411 Angles are written as Greek letters \alpha, \beta and \gamma.
5413 During HTML export (*note HTML export::), these symbols are
5414 translated into the proper syntax for HTML, for the above examples this
5415 is `α' and `→', respectively.
5418 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
5420 11.2 Subscripts and Superscripts
5421 ================================
5423 Just like in LaTeX, `^' and `_' are used to indicate super- and
5424 subscripts. Again, these can be used without embedding them in
5425 math-mode delimiters. To increase the readability of ASCII text, it is
5426 not necessary (but OK) to surround multi-character sub- and superscripts
5427 with curly braces. For example
5429 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
5430 the sun is R_{sun} = 6.96 x 10^8 m.
5432 To avoid interpretation as raised or lowered text, you can quote `^'
5433 and `_' with a backslash: `\_' and `\^'.
5435 During HTML export (*note HTML export::), subscript and superscripts
5436 are surrounded with `<sub>' and `<sup>' tags, respectively.
5439 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
5441 11.3 LaTeX fragments
5442 ====================
5444 With symbols, sub- and superscripts, HTML is pretty much at its end when
5445 it comes to representing mathematical formulas(1). More complex
5446 expressions need a dedicated formula processor. To this end, Org-mode
5447 can contain arbitrary LaTeX fragments. It provides commands to preview
5448 the typeset result of these fragments, and upon export to HTML, all
5449 fragments will be converted to images and inlined into the HTML
5450 document(2). For this to work you need to be on a system with a working
5451 LaTeX installation. You also need the `dvipng' program, available at
5452 `http://sourceforge.net/projects/dvipng/'. The LaTeX header that will
5453 be used when processing a fragment can be configured with the variable
5454 `org-format-latex-header'.
5456 LaTeX fragments don't need any special marking at all. The following
5457 snippets will be identified as LaTeX source code:
5458 * Environments of any kind. The only requirement is that the
5459 `\begin' statement appears on a new line, preceded by only
5462 * Text within the usual LaTeX math delimiters. To avoid conflicts
5463 with currency specifications, single `$' characters are only
5464 recognized as math delimiters if the enclosed text contains at
5465 most two line breaks, is directly attached to the `$' characters
5466 with no whitespace in between, and if the closing `$' is followed
5467 by whitespace or punctuation. For the other delimiters, there is
5468 no such restriction, so when in doubt, use `\(...\)' as inline
5473 \begin{equation} % arbitrary environments,
5474 x=\sqrt{b} % even tables, figures
5475 \end{equation} % etc
5477 If $a^2=b$ and \( b=2 \), then the solution must be
5478 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
5480 If you need any of the delimiter ASCII sequences for other purposes, you
5481 can configure the option `org-format-latex-options' to deselect the
5482 ones you do not wish to have interpreted by the LaTeX converter.
5484 ---------- Footnotes ----------
5486 (1) Yes, there is MathML, but that is not yet fully supported by
5487 many browsers, and there is no decent converter for turning LaTeX or
5488 ASCII representations of formulas into MathML. So for the time being,
5489 converting formulas into images seems the way to go.
5491 (2) The LaTeX export will not use images for displaying LaTeX
5492 fragments but include these fragments directly into the LaTeX code.
5495 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
5497 11.4 Processing LaTeX fragments
5498 ===============================
5500 LaTeX fragments can be processed to produce a preview images of the
5501 typeset expressions:
5504 Produce a preview image of the LaTeX fragment at point and overlay
5505 it over the source code. If there is no fragment at point,
5506 process all fragments in the current entry (between two
5507 headlines). When called with a prefix argument, process the
5508 entire subtree. When called with two prefix arguments, or when
5509 the cursor is before the first headline, process the entire buffer.
5512 Remove the overlay preview images.
5514 During HTML export (*note HTML export::), all LaTeX fragments are
5515 converted into images and inlined into the document if the following
5518 (setq org-export-with-LaTeX-fragments t)
5521 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
5523 11.5 Using CDLaTeX to enter math
5524 ================================
5526 CDLaTeX-mode is a minor mode that is normally used in combination with a
5527 major LaTeX mode like AUCTeX in order to speed-up insertion of
5528 environments and math templates. Inside Org-mode, you can make use of
5529 some of the features of cdlatex-mode. You need to install `cdlatex.el'
5530 and `texmathp.el' (the latter comes also with AUCTeX) from
5531 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
5532 cdlatex-mode itself under Org-mode, but use the light version
5533 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
5534 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
5537 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
5539 When this mode is enabled, the following features are present (for
5540 more details see the documentation of cdlatex-mode):
5541 * Environment templates can be inserted with `C-c {'.
5543 * The <TAB> key will do template expansion if the cursor is inside a
5544 LaTeX fragment(1). For example, <TAB> will expand `fr' to
5545 `\frac{}{}' and position the cursor correctly inside the first
5546 brace. Another <TAB> will get you into the second brace. Even
5547 outside fragments, <TAB> will expand environment abbreviations at
5548 the beginning of a line. For example, if you write `equ' at the
5549 beginning of a line and press <TAB>, this abbreviation will be
5550 expanded to an `equation' environment. To get a list of all
5551 abbreviations, type `M-x cdlatex-command-help'.
5553 * Pressing `_' and `^' inside a LaTeX fragment will insert these
5554 characters together with a pair of braces. If you use <TAB> to
5555 move out of the braces, and if the braces surround only a single
5556 character or macro, they are removed again (depending on the
5557 variable `cdlatex-simplify-sub-super-scripts').
5559 * Pressing the backquote ``' followed by a character inserts math
5560 macros, also outside LaTeX fragments. If you wait more than 1.5
5561 seconds after the backquote, a help window will pop up.
5563 * Pressing the normal quote `'' followed by another character
5564 modifies the symbol before point with an accent or a font. If you
5565 wait more than 1.5 seconds after the backquote, a help window will
5566 pop up. Character modification will work only inside LaTeX
5567 fragments, outside the quote is normal.
5569 ---------- Footnotes ----------
5571 (1) Org-mode has a method to test if the cursor is inside such a
5572 fragment, see the documentation of the function
5573 `org-inside-LaTeX-fragment-p'.
5576 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
5581 Org-mode documents can be exported into a variety of other formats. For
5582 printing and sharing of notes, ASCII export produces a readable and
5583 simple version of an Org-mode file. HTML export allows you to publish a
5584 notes file on the web, while the XOXO format provides a solid base for
5585 exchange with a broad range of other applications. LaTeX export lets
5586 you use Org-mode and its structured editing functions to easily create
5587 LaTeX files. To incorporate entries with associated times like
5588 deadlines or appointments into a desktop calendar program like iCal,
5589 Org-mode can also produce extracts in the iCalendar format. Currently
5590 Org-mode only supports export, not import of these different formats.
5592 When exporting, Org-mode uses special conventions to enrich the
5593 output produced. *Note Text interpretation::, for more details.
5596 Dispatcher for export and publishing commands. Displays a
5597 help-window listing the additional key(s) needed to launch an
5598 export or publishing command.
5602 * ASCII export:: Exporting to plain ASCII
5603 * HTML export:: Exporting to HTML
5604 * LaTeX export:: Exporting to LaTeX
5605 * XOXO export:: Exporting to XOXO
5606 * iCalendar export:: Exporting in iCalendar format
5607 * Text interpretation:: How the exporter looks at the file
5610 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
5615 ASCII export produces a simple and very readable version of an Org-mode
5619 Export as ASCII file. For an org file `myfile.org', the ASCII file
5620 will be `myfile.txt'. The file will be overwritten without
5621 warning. If there is an active region, only the region will be
5622 exported. If the selected region is a single tree, the tree head
5623 will become the document title. If the tree head entry has or
5624 inherits an EXPORT_FILE_NAME property, that name will be used for
5628 Export only the visible part of the document.
5630 In the exported version, the first 3 outline levels will become
5631 headlines, defining a general document structure. Additional levels
5632 will be exported as itemized lists. If you want that transition to
5633 occur at a different level, specify it with a prefix argument. For
5638 creates only top level headlines and does the rest as items. When
5639 headlines are converted to items, the indentation of the text following
5640 the headline is changed to fit nicely under the item. This is done with
5641 the assumption that the first bodyline indicates the base indentation of
5642 the body text. Any indentation larger than this is adjusted to preserve
5643 the layout relative to the first line. Should there be lines with less
5644 indentation than the first, these are left alone.
5647 File: org, Node: HTML export, Next: LaTeX export, Prev: ASCII export, Up: Exporting
5652 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
5653 HTML formatting, in ways similar to John Grubers _markdown_ language,
5654 but with additional support for tables.
5658 * HTML Export commands:: How to invoke LaTeX export
5659 * Quoting HTML tags:: Using direct HTML in Org-mode
5660 * Links:: Transformation of links for HTML
5661 * Images:: How to include images
5662 * CSS support:: Changing the appearence of the output
5665 File: org, Node: HTML Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
5667 12.2.1 HTML export commands
5668 ---------------------------
5671 Export as HTML file `myfile.html'. For an org file `myfile.org',
5672 the ASCII file will be `myfile.html'. The file will be
5673 overwritten without warning. If there is an active region, only
5674 the region will be exported. If the selected region is a single
5675 tree, the tree head will become the document title. If the tree
5676 head entry has or inherits an EXPORT_FILE_NAME property, that name
5677 will be used for the export.
5680 Export as HTML file and immediately open it with a browser.
5683 Export to a temporary buffer, do not create a file.
5686 Export the active region to a temporary buffer. With prefix arg,
5687 do not produce file header and foot, but just the plain HTML
5688 section for the region. This is good for cut-and-paste operations.
5697 Export only the visible part of the document.
5699 `M-x org-export-region-as-html'
5700 Convert the region to HTML under the assumption that it was
5701 org-mode syntax before. This is a global command that can be
5702 invoked in any buffer.
5704 `M-x org-replace-region-by-HTML'
5705 Replace the active region (assumed to be in Org-mode syntax) by
5708 In the exported version, the first 3 outline levels will become
5709 headlines, defining a general document structure. Additional levels
5710 will be exported as itemized lists. If you want that transition to
5711 occur at a different level, specify it with a prefix argument. For
5716 creates two levels of headings and does the rest as items.
5719 File: org, Node: Quoting HTML tags, Next: Links, Prev: HTML Export commands, Up: HTML export
5721 12.2.2 Quoting HTML tags
5722 ------------------------
5724 Plain `<' and `>' are always transformed to `<' and `>' in HTML
5725 export. If you want to include simple HTML tags which should be
5726 interpreted as such, mark them with `@' as in `@<b>bold text@</b>'.
5727 Note that this really works only for simple tags. For more extensive
5728 HTML that should be copied verbatim to the exported file use either
5730 #+HTML: Literal HTML code for export
5735 All lines between these markers are exported literally
5739 File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
5744 Internal links (*note Internal links::) will continue to work in HTML
5745 files only if they match a dedicated `<<target>>'. Automatic links
5746 created by radio targets (*note Radio targets::) will also work in the
5747 HTML file. Links to external files will still work if the HTML file is
5748 in the same directory as the Org-mode file. Links to other `.org'
5749 files will be translated into HTML links under the assumption that an
5750 HTML version also exists of the linked file. For information related to
5751 linking files while publishing them to a publishing directory see *Note
5755 File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
5760 HTML export can inline images given as links in the Org-mode file, and
5761 it can make an image the clickable part of a link. By default(1),
5762 images are inlined if a link does not have a description. So
5763 `[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
5764 image]]' will just produce a link `the image' that points to the image.
5765 If the description part itself is a `file:' link or a `http:' URL
5766 pointing to an image, this image will be inlined and activated so that
5767 clicking on the image will activate the link. For example, to include
5768 a thumbnail that will link to a high resolution version of the image,
5771 [[file:highres.jpg][file:thumb.jpg]]
5773 and you could use `http' addresses just as well.
5775 ---------- Footnotes ----------
5777 (1) but see the variable `org-export-html-inline-images'
5780 File: org, Node: CSS support, Prev: Images, Up: HTML export
5785 You can also give style information for the exported file. The HTML
5786 exporter assigns the following CSS classes to appropriate parts of the
5787 document - your style specifications may change these:
5789 .done the DONE keyword
5790 .timestamp time stamp
5791 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
5792 .tag tag in a headline
5793 .target target for links
5795 The default style specification can be configured through the option
5796 `org-export-html-style'. If you want to use a file-local style, you
5797 may use file variables, best wrapped into a COMMENT section at the end
5798 of the outline tree. For example(1):
5800 * COMMENT html style specifications
5803 # org-export-html-style: " <style type=\"text/css\">
5804 # p {font-weight: normal; color: gray; }
5805 # h1 {color: black; }
5809 Remember to execute `M-x normal-mode' after changing this to make
5810 the new style visible to Emacs. This command restarts org-mode for the
5811 current buffer and forces Emacs to re-evaluate the local variables
5812 section in the buffer.
5814 ---------- Footnotes ----------
5816 (1) Under Emacs 21, the continuation lines for a variable value
5817 should have no `#' at the start of the line.
5820 File: org, Node: LaTeX export, Next: XOXO export, Prev: HTML export, Up: Exporting
5825 Org-mode contains a LaTeX exporter written by Bastien Guerry.
5829 * LaTeX export commands:: How to invoke LaTeX export
5830 * Quoting LaTeX code:: Incorporating literal LaTeX code
5831 * Sectioning structure::
5834 File: org, Node: LaTeX export commands, Next: Quoting LaTeX code, Prev: LaTeX export, Up: LaTeX export
5836 12.3.1 LaTeX export commands
5837 ----------------------------
5840 Export as LaTeX file `myfile.tex'.
5843 Export to a temporary buffer, do not create a file.
5848 Export only the visible part of the document.
5850 `M-x org-export-region-as-latex'
5851 Convert the region to LaTeX under the assumption that it was
5852 org-mode syntax before. This is a global command that can be
5853 invoked in any buffer.
5855 `M-x org-replace-region-by-latex'
5856 Replace the active region (assumed to be in Org-mode syntax) by
5859 In the exported version, the first 3 outline levels will become
5860 headlines, defining a general document structure. Additional levels
5861 will be exported as description lists. The exporter can ignore them or
5862 convert them to a custom string depending on `org-latex-low-levels'.
5864 If you want that transition to occur at a different level, specify it
5865 with a prefix argument. For example,
5869 creates two levels of headings and does the rest as items.
5872 File: org, Node: Quoting LaTeX code, Next: Sectioning structure, Prev: LaTeX export commands, Up: LaTeX export
5874 12.3.2 Quoting LaTeX code
5875 -------------------------
5877 Embedded LaTeX as described in *Note Embedded LaTeX:: will be correctly
5878 inserted into the LaTeX file. Forthermore, you can add special code
5879 that should only be present in LaTeX export with the following
5882 #+LaTeX: Literal LaTeX code for export
5887 All lines between these markers are exported literally
5891 File: org, Node: Sectioning structure, Prev: Quoting LaTeX code, Up: LaTeX export
5893 12.3.3 Sectioning structure
5894 ---------------------------
5896 By default, the LaTeX output uses the class `article'.
5898 You can change this globally by setting a different value for
5899 `org-export-latex-default-class' or locally by adding an option like
5900 `#+LaTeX_CLASS: myclass' in your file. The class should be listed in
5901 `org-export-latex-classes', where you can also define the sectioning
5902 structure for each class.
5905 File: org, Node: XOXO export, Next: iCalendar export, Prev: LaTeX export, Up: Exporting
5910 Org-mode contains an exporter that produces XOXO-style output.
5911 Currently, this exporter only handles the general outline structure and
5912 does not interpret any additional Org-mode features.
5915 Export as XOXO file `myfile.html'.
5918 Export only the visible part of the document.
5921 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
5923 12.5 iCalendar export
5924 =====================
5926 Some people like to use Org-mode for keeping track of projects, but
5927 still prefer a standard calendar application for anniversaries and
5928 appointments. In this case it can be useful to have deadlines and
5929 other time-stamped items in Org-mode files show up in the calendar
5930 application. Org-mode can export calendar information in the standard
5931 iCalendar format. If you also want to have TODO entries included in the
5932 export, configure the variable `org-icalendar-include-todo'.
5935 Create iCalendar entries for the current file and store them in
5936 the same directory, using a file extension `.ics'.
5939 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
5940 For each of these files, a separate iCalendar file will be
5944 Create a single large iCalendar file from all files in
5945 `org-agenda-files' and write it to the file given by
5946 `org-combined-agenda-icalendar-file'.
5948 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
5949 the selected entries have them. If not, the summary will be derived
5950 from the headline, and the description from the body (limited to
5951 `org-icalendar-include-body' characters).
5953 How this calendar is best read and updated, depends on the
5954 application you are using. The FAQ covers this issue.
5957 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
5959 12.6 Text interpretation by the exporter
5960 ========================================
5962 The exporter backends interpret additional structure in the Org-mode
5963 file in order to produce better output.
5967 * Comment lines:: Some lines will not be exported
5968 * Initial text:: Text before the first headline
5969 * Footnotes:: Numbers like [1]
5970 * Quoted examples:: Inserting quoted chnuks of text
5971 * Enhancing text:: Subscripts, symbols and more
5972 * Export options:: How to influence the export settings
5975 File: org, Node: Comment lines, Next: Initial text, Prev: Text interpretation, Up: Text interpretation
5977 12.6.1 Comment lines
5978 --------------------
5980 Lines starting with `#' in column zero are treated as comments and will
5981 never be exported. Also entire subtrees starting with the word
5982 `COMMENT' will never be exported.
5985 Toggle the COMMENT keyword at the beginning of an entry.
5988 File: org, Node: Initial text, Next: Footnotes, Prev: Comment lines, Up: Text interpretation
5990 12.6.2 Text before the first headline
5991 -------------------------------------
5993 Org-mode normally ignores any text before the first headline when
5994 exporting, leaving this region for internal links to speed up navigation
5995 etc. However, in publishing-oriented files, you might want to have some
5996 text before the first headline, like a small introduction, special HTML
5997 code with a navigation bar, etc. You can ask to have this part of the
5998 file exported as well by setting the variable
5999 `org-export-skip-text-before-1st-heading' to `nil'. On a per-file
6000 basis, you can get the same effect with
6004 The text before the first headline will be fully processed (*note
6005 Enhancing text::), and the first non-comment line becomes the title of
6006 the exported document. If you need to include literal HTML, use the
6007 special constructs described in *Note Quoting HTML tags::. The table
6008 of contents is normally inserted directly before the first headline of
6009 the file. If you would like to get it to a different location, insert
6010 the string `[TABLE-OF-CONTENTS]' on a line by itself at the desired
6013 Finally, if you want to use the space before the first headline for
6014 internal purposes, but _still_ want to place something before the first
6015 headline when exporting the file, you can use the `#+TEXT' construct:
6018 #+TEXT: This text will go before the *first* headline.
6019 #+TEXT: We place the table of contents here:
6020 #+TEXT: [TABLE-OF-CONTENTS]
6021 #+TEXT: This goes between the table of contents and the first headline
6024 File: org, Node: Footnotes, Next: Quoted examples, Prev: Initial text, Up: Text interpretation
6029 Numbers in square brackets are treated as footnotes, so that you can use
6030 the Emacs package `footnote.el' to create footnotes. For example:
6032 The org-mode homepage[1] clearly needs help from
6033 a good web designer.
6035 [1] The link is: http://orgmode.org
6037 Note that the `footnote' package uses `C-c !' to invoke its commands.
6038 This binding conflicts with the org-mode command for inserting inactive
6039 time stamps. You could use the variable `footnote-prefix' to switch
6040 footnotes commands to another key. Or, if you are too used to this
6041 binding, you could use `org-replace-disputed-keys' and
6042 `org-disputed-keys' to change the settings in Org-mode.
6045 File: org, Node: Quoted examples, Next: Enhancing text, Prev: Footnotes, Up: Text interpretation
6047 12.6.4 Quoted examples
6048 ----------------------
6050 When writing technical documents, you often need to insert examples that
6051 are not further interpreted by Org-mode. For historical reasons, there
6052 are several ways to do this:
6054 * If a headline starts with the word `QUOTE', the text below the
6055 headline will be typeset as fixed-width, to allow quoting of
6058 * Lines starting with `:' are also typeset in fixed-width font.
6060 Toggle fixed-width for entry (QUOTE) or region, see below.
6062 * Finally, text between
6066 will also be exported in this way.
6069 File: org, Node: Enhancing text, Next: Export options, Prev: Quoted examples, Up: Text interpretation
6071 12.6.5 Enhancing text for export
6072 --------------------------------
6074 Some of the export backends of Org-mode allow for sophisticated text
6075 formatting, this is true in particular for the HTML and LaTeX backends.
6076 Org-mode has a number of typing conventions that allow to produce a
6077 richly formatted output.
6079 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
6080 enumerator will be recognized and transformed if the backend
6081 supports lists. See *Note Plain lists::.
6083 * You can make words *bold*, /italic/, _underlined_, `=code=' and
6084 `~verbatim~', and, if you must, `+strikethrough+'. Text in the
6085 code and verbatim string is not processed for org-mode specific
6086 syntax, it is exported verbatim.
6088 * A line consisting of only dashes, and at least 5 of them, will be
6089 exported as a horizontal line (`<hr/>' in HTML).
6091 * Many TeX macros and entire LaTeX fragments are converted into HTML
6092 entities or images (*note Embedded LaTeX::).
6094 * Tables are transformed into native tables under the exporter, if
6095 the export backend supports this. Data fields before the first
6096 horizontal separator line will be formatted as table header fields.
6098 * If a headline starts with the word `QUOTE', the text below the
6099 headline will be typeset as fixed-width, to allow quoting of
6100 computer codes etc. Lines starting with `:' are also typeset in
6103 Toggle fixed-width for entry (QUOTE) or region, see below.
6104 Finally, text between
6108 will also be exported in this way.
6110 * A double backslash _at the end of a line_ enforces a line break at
6113 * Strings like `\alpha' will be exported as `α', in the HTML
6114 output. These strings are exported as `$\alpha$' in the LaTeX
6115 output. Similarly, `\nbsp' will become ` ' in HTML and in
6116 LaTeX. This applies for a long list of entities, see the variable
6117 `org-html-entities' for the complete list.
6119 If these conversions conflict with your habits of typing ASCII text,
6120 they can all be turned off with corresponding variables. See the
6121 customization group `org-export-general', and the following section
6122 which explains how to set export options with special lines in a buffer.
6125 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
6127 12.6.6 Export options
6128 ---------------------
6130 The exporter recognizes special lines in the buffer which provide
6131 additional information. These lines may be put anywhere in the file.
6132 The whole set of lines can be inserted into the buffer with `C-c C-e
6133 t'. For individual lines, a good way to make sure the keyword is
6134 correct is to type `#+' and then use `M-<TAB>' completion (*note
6138 Insert template with export options, see example below.
6140 #+TITLE: the title to be shown (default is the buffer name)
6141 #+AUTHOR: the author (default taken from `user-full-name')
6142 #+DATE: A date, fixed, of a format string for `format-time-string'
6143 #+EMAIL: his/her email address (default from `user-mail-address')
6144 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
6145 #+TEXT: Some descriptive text to be inserted at the beginning.
6146 #+TEXT: Several lines may be given.
6147 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t f:t TeX:t ...
6149 The OPTIONS line is a compact form to specify export settings. Here
6151 H: set the number of headline levels for export
6152 num: turn on/off section-numbers
6153 toc: turn on/off table of contents, or set level limit (integer)
6154 \n: turn on/off linebreak-preservation
6155 @: turn on/off quoted HTML tags
6156 :: turn on/off fixed-width sections
6157 |: turn on/off tables
6158 ^: turn on/off TeX-like syntax for sub- and superscripts. If
6159 you write "^:{}", `a_{b}' will be interpreted, but
6160 the simple `a_b' will be left as it is.
6161 -: turn on/off conversion of special strings.
6162 f: turn on/off foototes like this[1].
6163 *: turn on/off emphasized text (bold, italic, underlined)
6164 TeX: turn on/off simple TeX macros in plain text
6165 LaTeX: turn on/off LaTeX fragments
6166 skip: turn on/off skipping the text before the first heading
6167 author: turn on/off inclusion of author name/email into exported file
6168 timestamp: turn on/off inclusion creation time into exported file
6169 d: turn on/off inclusion of drawers
6171 These options take effect in both the HTML and LaTeX export, except
6172 for `TeX' and `LaTeX', which are respectively `t' and `nil' for the
6176 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
6181 Org-mode includes(1) a publishing management system that allows you to
6182 configure automatic HTML conversion of _projects_ composed of
6183 interlinked org files. This system is called _org-publish_. You can
6184 also configure org-publish to automatically upload your exported HTML
6185 pages and related attachments, such as images and source code files, to
6186 a web server. Org-publish turns org-mode into a web-site authoring tool.
6188 You can also use Org-publish to convert files into LaTeX, or even
6189 combine HTML and LaTeX conversion so that files are available in both
6190 formats on the server(2).
6192 Org-publish has been contributed to Org-mode by David O'Toole.
6196 * Configuration:: Defining projects
6197 * Sample configuration:: Example projects
6198 * Triggering publication:: Publication commands
6200 ---------- Footnotes ----------
6202 (1) `org-publish.el' is not distributed with Emacs 21, if you are
6203 still using Emacs 21, you need you need to download this file
6206 (2) Since LaTeX files on a server are not that helpful, you surely
6207 want to perform further conversion on them - e.g. convert them to `PDF'
6211 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
6216 Publishing needs significant configuration to specify files, destination
6217 and many other properties of a project.
6221 * Project alist:: The central configuration variable
6222 * Sources and destinations:: From here to there
6223 * Selecting files:: What files are part of the project?
6224 * Publishing action:: Setting the function doing the publishing
6225 * Publishing options:: Tweaking HTML export
6226 * Publishing links:: Which links keep working after publishing?
6227 * Project page index:: Publishing a list of project files
6230 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
6232 13.1.1 The variable `org-publish-project-alist'
6233 -----------------------------------------------
6235 Org-publish is configured almost entirely through setting the value of
6236 one variable, called `org-publish-project-alist'. Each element of the
6237 list configures one project, and may be in one of the two following
6240 ("project-name" :property value :property value ...)
6244 ("project-name" :components ("project-name" "project-name" ...))
6246 In both cases, projects are configured by specifying property values.
6247 A project defines the set of files that will be published, as well as
6248 the publishing configuration to use when publishing those files. When
6249 a project takes the second form listed above, the individual members of
6250 the "components" property are taken to be components of the project,
6251 which group together files requiring different publishing options. When
6252 you publish such a "meta-project" all the components will also publish.
6255 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
6257 13.1.2 Sources and destinations for files
6258 -----------------------------------------
6260 Most properties are optional, but some should always be set. In
6261 particular, org-publish needs to know where to look for source files,
6262 and where to put published files.
6264 `:base-directory' Directory containing publishing source files
6265 `:publishing-directory'Directory (possibly remote) where output files
6267 `:preparation-function'Function called before starting publishing
6268 process, for example to run `make' for updating
6269 files to be published.
6272 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
6274 13.1.3 Selecting files
6275 ----------------------
6277 By default, all files with extension `.org' in the base directory are
6278 considered part of the project. This can be modified by setting the
6280 `:base-extension' Extension (without the dot!) of source files. This
6281 actually is a regular expression.
6282 `:exclude' Regular expression to match file names that should
6283 not be published, even though they have been selected
6284 on the basis of their extension.
6285 `:include' List of files to be included regardless of
6286 `:base-extension' and `:exclude'.
6289 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
6291 13.1.4 Publishing Action
6292 ------------------------
6294 Publishing means that a file is copied to the destination directory and
6295 possibly transformed in the process. The default transformation is to
6296 export Org-mode files as HTML files, and this is done by the function
6297 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
6298 export::). But you also can publish your files in LaTeX by using the
6299 function `org-publish-org-to-latex' instead. Other files like images
6300 only need to be copied to the publishing destination. For non-Org-mode
6301 files, you need to specify the publishing function.
6303 `:publishing-function' Function executing the publication of a file.
6304 This may also be a list of functions, which will
6305 all be called in turn.
6307 The function must accept two arguments: a property list containing at
6308 least a `:publishing-directory' property, and the name of the file to
6309 be published. It should take the specified file, make the necessary
6310 transformation (if any) and place the result into the destination
6311 folder. You can write your own publishing function, but `org-publish'
6312 provides one for attachments (files that only need to be copied):
6313 `org-publish-attachment'.
6316 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
6318 13.1.5 Options for the HTML/LaTeX exporters
6319 -------------------------------------------
6321 The property list can be used to set many export options for the HTML
6322 and LaTeX exporters. In most cases, these properties correspond to user
6323 variables in Org-mode. The table below lists these properties along
6324 with the variable they belong to. See the documentation string for the
6325 respective variable for details.
6327 `:language' `org-export-default-language'
6328 `:headline-levels' `org-export-headline-levels'
6329 `:section-numbers' `org-export-with-section-numbers'
6330 `:table-of-contents' `org-export-with-toc'
6331 `:archived-trees' `org-export-with-archived-trees'
6332 `:emphasize' `org-export-with-emphasize'
6333 `:sub-superscript' `org-export-with-sub-superscripts'
6334 `:special-strings' `org-export-with-special-strings'
6335 `:TeX-macros' `org-export-with-TeX-macros'
6336 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
6337 `:fixed-width' `org-export-with-fixed-width'
6338 `:timestamps' `org-export-with-timestamps'
6340 `:tags' `org-export-with-tags'
6342 `:tables' `org-export-with-tables'
6343 `:table-auto-headline' `org-export-highlight-first-table-line'
6344 `:style' `org-export-html-style'
6345 `:convert-org-links' `org-export-html-link-org-files-as-html'
6346 `:inline-images' `org-export-html-inline-images'
6347 `:expand-quoted-html' `org-export-html-expand'
6348 `:timestamp' `org-export-html-with-timestamp'
6349 `:publishing-directory'`org-export-publishing-directory'
6350 `:preamble' `org-export-html-preamble'
6351 `:postamble' `org-export-html-postamble'
6352 `:auto-preamble' `org-export-html-auto-preamble'
6353 `:auto-postamble' `org-export-html-auto-postamble'
6354 `:author' `user-full-name'
6355 `:email' `user-mail-address'
6357 If you use several email addresses, separate them by a semi-column.
6359 Most of the `org-export-with-*' variables have the same effect in
6360 both HTML and LaTeX exporters, except for `:TeX-macros' and
6361 `:LaTeX-fragments', respectively `nil' and `t' in the LaTeX export.
6363 When a property is given a value in `org-publish-project-alist', its
6364 setting overrides the value of the corresponding user variable (if any)
6365 during publishing. Options set within a file (*note Export options::),
6366 however, override everything.
6369 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
6371 13.1.6 Links between published files
6372 ------------------------------------
6374 To create a link from one Org-mode file to another, you would use
6375 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
6376 (*note Hyperlinks::). Upon publishing this link becomes a link to
6377 `foo.html'. In this way, you can interlink the pages of your "org web"
6378 project and the links will work as expected when you publish them to
6381 You may also link to related files, such as images. Provided you are
6382 careful with relative pathnames, and provided you have also configured
6383 `org-publish' to upload the related files, these links will work too.
6384 *Note Complex example:: for an example of this usage.
6386 Sometime an Org-mode file to be published may contain links that are
6387 only valid in your production environment, but not in the publishing
6388 location. In this case, use the property
6390 `:link-validation-function' Function to validate links
6392 to define a function for checking link validity. This function must
6393 accept two arguments, the file name and a directory relative to which
6394 the file name is interpreted in the production environment. If this
6395 function returns `nil', then the HTML generator will only insert a
6396 description into the HTML file, but no link. One option for this
6397 function is `org-publish-validate-link' which checks if the given file
6398 is part of any project in `org-publish-project-alist'.
6401 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
6403 13.1.7 Project page index
6404 -------------------------
6406 The following properties may be used to control publishing of an index
6407 of files or summary page for a given project.
6409 `:auto-index' When non-nil, publish an index during
6410 org-publish-current-project or org-publish-all.
6411 `:index-filename' Filename for output of index. Defaults to `index.org'
6412 (which becomes `index.html').
6413 `:index-title' Title of index page. Defaults to name of file.
6414 `:index-function' Plugin function to use for generation of index.
6415 Defaults to `org-publish-org-index', which generates
6416 a plain list of links to all files in the project.
6419 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
6421 13.2 Sample configuration
6422 =========================
6424 Below we provide two example configurations. The first one is a simple
6425 project publishing only a set of Org-mode files. The second example is
6426 more complex, with a multi-component project.
6430 * Simple example:: One-component publishing
6431 * Complex example:: A multi-component publishing example
6434 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
6436 13.2.1 Example: simple publishing configuration
6437 -----------------------------------------------
6439 This example publishes a set of Org-mode files to the `public_html'
6440 directory on the local machine.
6442 (setq org-publish-project-alist
6444 :base-directory "~/org/"
6445 :publishing-directory "~/public_html"
6446 :section-numbers nil
6447 :table-of-contents nil
6448 :style "<link rel=stylesheet
6449 href=\"../other/mystyle.css\"
6450 type=\"text/css\">")))
6453 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
6455 13.2.2 Example: complex publishing configuration
6456 ------------------------------------------------
6458 This more complicated example publishes an entire website, including
6459 org files converted to HTML, image files, emacs lisp source code, and
6460 stylesheets. The publishing-directory is remote and private files are
6463 To ensure that links are preserved, care should be taken to replicate
6464 your directory structure on the web server, and to use relative file
6465 paths. For example, if your org files are kept in `~/org' and your
6466 publishable images in `~/images', you'd link to an image with
6467 file:../images/myimage.png
6468 On the web server, the relative path to the image should be the
6469 same. You can accomplish this by setting up an "images" folder in the
6470 right place on the webserver, and publishing images to it.
6472 (setq org-publish-project-alist
6474 :base-directory "~/org/"
6475 :base-extension "org"
6476 :publishing-directory "/ssh:user@host:~/html/notebook/"
6477 :publishing-function org-publish-org-to-html
6478 :exclude "PrivatePage.org" ;; regexp
6480 :section-numbers nil
6481 :table-of-contents nil
6482 :style "<link rel=stylesheet
6483 href=\"../other/mystyle.css\" type=\"text/css\">"
6485 :auto-postamble nil)
6488 :base-directory "~/images/"
6489 :base-extension "jpg\\|gif\\|png"
6490 :publishing-directory "/ssh:user@host:~/html/images/"
6491 :publishing-function org-publish-attachment)
6494 :base-directory "~/other/"
6495 :base-extension "css\\|el"
6496 :publishing-directory "/ssh:user@host:~/html/other/"
6497 :publishing-function org-publish-attachment)
6498 ("website" :components ("orgfiles" "images" "other"))))
6501 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
6503 13.3 Triggering publication
6504 ===========================
6506 Once org-publish is properly configured, you can publish with the
6507 following functions:
6510 Prompt for a specific project and publish all files that belong to
6514 Publish the project containing the current file.
6517 Publish only the current file.
6520 Publish all projects.
6522 Org uses timestamps to track when a file has changed. The above
6523 functions normally only publish changed files. You can override this and
6524 force publishing of all files by giving a prefix argument.
6527 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
6534 * Completion:: M-TAB knows what you need
6535 * Customization:: Adapting Org-mode to your taste
6536 * In-buffer settings:: Overview of the #+KEYWORDS
6537 * The very busy C-c C-c key:: When in doubt, press C-c C-c
6538 * Clean view:: Getting rid of leading stars in the outline
6539 * TTY keys:: Using Org-mode on a tty
6540 * Interaction:: Other Emacs packages
6541 * Bugs:: Things which do not work perfectly
6544 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
6549 Org-mode supports in-buffer completion. This type of completion does
6550 not make use of the minibuffer. You simply type a few letters into the
6551 buffer and use the key to complete text right there.
6554 Complete word at point
6555 * At the beginning of a headline, complete TODO keywords.
6557 * After `\', complete TeX symbols supported by the exporter.
6559 * After `*', complete headlines in the current buffer so that
6560 they can be used in search links like `[[*find this
6563 * After `:' in a headline, complete tags. The list of tags is
6564 taken from the variable `org-tag-alist' (possibly set through
6565 the `#+TAGS' in-buffer option, *note Setting tags::), or it
6566 is created dynamically from all tags used in the current
6569 * After `:' and not in a headline, complete property keys. The
6570 list of keys is constructed dynamically from all keys used in
6573 * After `[', complete link abbreviations (*note Link
6576 * After `#+', complete the special keywords like `TYP_TODO' or
6577 `OPTIONS' which set file-specific options for Org-mode. When
6578 the option keyword is already complete, pressing `M-<TAB>'
6579 again will insert example settings for this keyword.
6581 * In the line after `#+STARTUP: ', complete startup keywords,
6582 i.e. valid keys for this line.
6584 * Elsewhere, complete dictionary words using ispell.
6587 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
6592 There are more than 180 variables that can be used to customize
6593 Org-mode. For the sake of compactness of the manual, I am not
6594 describing the variables here. A structured overview of customization
6595 variables is available with `M-x org-customize'. Or select `Browse Org
6596 Group' from the `Org->Customization' menu. Many settings can also be
6597 activated on a per-file basis, by putting special lines into the buffer
6598 (*note In-buffer settings::).
6601 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
6603 14.3 Summary of in-buffer settings
6604 ==================================
6606 Org-mode uses special lines in the buffer to define settings on a
6607 per-file basis. These lines start with a `#+' followed by a keyword, a
6608 colon, and then individual words defining a setting. Several setting
6609 words can be in the same line, but you can also have multiple lines for
6610 the keyword. While these settings are described throughout the manual,
6611 here is a summary. After changing any of those lines in the buffer,
6612 press `C-c C-c' with the cursor still in the line to activate the
6613 changes immediately. Otherwise they become effective only when the
6614 file is visited again in a new Emacs session.
6616 `#+ARCHIVE: %s_done::'
6617 This line sets the archive location for the agenda file. It
6618 applies for all subsequent lines until the next `#+ARCHIVE' line,
6619 or the end of the file. The first such line also applies to any
6620 entries before it. The corresponding variable is
6621 `org-archive-location'.
6624 This line sets the category for the agenda file. The category
6625 applies for all subsequent lines until the next `#+CATEGORY' line,
6626 or the end of the file. The first such line also applies to any
6629 `#+COLUMNS: %25ITEM .....'
6630 Set the default format for columns view. This format applies when
6631 columns view is invoked in location where no COLUMNS property
6634 `#+CONSTANTS: name1=value1 ...'
6635 Set file-local values for constants to be used in table formulas.
6636 This line set the local variable
6637 `org-table-formula-constants-local'. The global version of this
6638 variable is `org-table-formula-constants'.
6640 `#+DRAWERS: NAME1 .....'
6641 Set the file-local set of drawers. The corresponding global
6642 variable is `org-drawers'.
6644 `#+LINK: linkword replace'
6645 These lines (several are allowed) specify link abbreviations.
6646 *Note Link abbreviations::. The corresponding variable is
6647 `org-link-abbrev-alist'.
6649 `#+PRIORITIES: highest lowest default'
6650 This line sets the limits and the default for the priorities. All
6651 three must be either letters A-Z or numbers 0-9. The highest
6652 priority must have a lower ASCII number that the lowest priority.
6654 `#+PROPERTY: Property_Name Value'
6655 This line sets a default inheritance value for entries in the
6656 current buffer, most useful for specifying the allowed values of a
6660 This line sets options to be used at startup of Org-mode, when an
6661 Org-mode file is being visited. The first set of options deals
6662 with the initial visibility of the outline tree. The
6663 corresponding variable for global default settings is
6664 `org-startup-folded', with a default value `t', which means
6666 overview top-level headlines only
6667 content all headlines
6668 showall no folding at all, show everything
6669 Then there are options for aligning tables upon visiting a file.
6670 This is useful in files containing narrowed table columns. The
6671 corresponding variable is `org-startup-align-all-tables', with a
6672 default value `nil'.
6673 align align all tables
6674 noalign don't align tables on startup
6675 Logging TODO state changes and clock intervals (variables
6676 `org-log-done' and `org-log-repeat') can be configured using these
6678 logging record a timestamp when an item is marked DONE
6679 nologging don't record when items are marked DONE
6680 lognotedone record timestamp and a note when DONE
6681 lognotestate record timestamp and a note when TODO state changes
6682 logrepeat record a note when re-instating a repeating item
6683 nologrepeat do not record when re-instating repeating item
6684 lognoteclock-out record timestamp and a note when clocking out
6685 Here are the options for hiding leading stars in outline headings.
6686 The corresponding variables are `org-hide-leading-stars' and
6687 `org-odd-levels-only', both with a default setting `nil' (meaning
6688 `showstars' and `oddeven').
6689 hidestars make all but one of the stars starting a headline invisible.
6690 showstars show all stars starting a headline
6691 odd allow only odd outline levels (1,3,...)
6692 oddeven allow all outline levels
6693 To turn on custom format overlays over time stamps (variables
6694 `org-put-time-stamp-overlays' and
6695 `org-time-stamp-overlay-formats'), use
6696 customtime overlay custom time format
6697 The following options influence the table spreadsheet (variable
6698 `constants-unit-system').
6699 constcgs `constants.el' should use the c-g-s unit system
6700 constSI `constants.el' should use the SI unit system
6702 `#+TAGS: TAG1(c1) TAG2(c2)'
6703 These lines (several such lines are allowed) specify the legal
6704 tags in this file, and (potentially) the corresponding _fast tag
6705 selection_ keys. The corresponding variable is `org-tag-alist'.
6708 This line contains the formulas for the table directly above the
6711 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:'
6712 These lines provide settings for exporting files. For more
6713 details see *Note Export options::.
6715 `#+SEQ_TODO: #+TYP_TODO:'
6716 These lines set the TODO keywords and their interpretation in the
6717 current file. The corresponding variables are `org-todo-keywords'
6718 and `org-todo-interpretation'.
6721 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
6723 14.4 The very busy C-c C-c key
6724 ==============================
6726 The key `C-c C-c' has many purposes in org-mode, which are all
6727 mentioned scattered throughout this manual. One specific function of
6728 this key is to add _tags_ to a headline (*note Tags::). In many other
6729 circumstances it means something like _Hey Org-mode, look here and
6730 update according to what you see here_. Here is a summary of what this
6731 means in different contexts.
6733 - If there are highlights in the buffer from the creation of a sparse
6734 tree, or from clock display, remove these highlights.
6736 - If the cursor is in one of the special `#+KEYWORD' lines, this
6737 triggers scanning the buffer for these lines and updating the
6740 - If the cursor is inside a table, realign the table. This command
6741 works even if the automatic table editor has been turned off.
6743 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
6746 - If the cursor is inside a table created by the `table.el' package,
6747 activate that table.
6749 - If the current buffer is a remember buffer, close the note and
6750 file it. With a prefix argument, file it, without further
6751 interaction, to the default location.
6753 - If the cursor is on a `<<<target>>>', update radio targets and
6754 corresponding links in this buffer.
6756 - If the cursor is in a property line or at the start or end of a
6757 property drawer, offer property commands.
6759 - If the cursor is in a plain list item with a checkbox, toggle the
6760 status of the checkbox.
6762 - If the cursor is on a numbered item in a plain list, renumber the
6765 - If the cursor is on the `#+BEGIN' line of a dynamical block, the
6769 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
6771 14.5 A cleaner outline view
6772 ===========================
6774 Some people find it noisy and distracting that the Org-mode headlines
6775 are starting with a potentially large number of stars. For example the
6776 tree from *Note Headlines:::
6778 * Top level headline
6784 * Another top level headline
6786 Unfortunately this is deeply ingrained into the code of Org-mode and
6787 cannot be easily changed. You can, however, modify the display in such
6788 a way that all leading stars become invisible and the outline more easy
6789 to read. To do this, customize the variable `org-hide-leading-stars'
6792 (setq org-hide-leading-stars t)
6794 or change this on a per-file basis with one of the lines (anywhere in
6797 #+STARTUP: showstars
6798 #+STARTUP: hidestars
6800 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
6803 With stars hidden, the tree becomes:
6805 * Top level headline
6811 * Another top level headline
6813 Note that the leading stars are not truly replaced by whitespace, they
6814 are only fontified with the face `org-hide' that uses the background
6815 color as font color. If you are not using either white or black
6816 background, you may have to customize this face to get the wanted
6817 effect. Another possibility is to set this font such that the extra
6818 stars are almost invisible, for example using the color `grey90' on a
6821 Things become cleaner still if you skip all the even levels and use
6822 only odd levels 1, 3, 5..., effectively adding two stars to go from one
6823 outline level to the next:
6825 * Top level headline
6831 * Another top level headline
6833 In order to make the structure editing and export commands handle this
6834 convention correctly, use
6836 (setq org-odd-levels-only t)
6838 or set this on a per-file basis with one of the following lines (don't
6839 forget to press `C-c C-c' with the cursor in the startup line to
6840 activate changes immediately).
6845 You can convert an Org-mode file from single-star-per-level to the
6846 double-star-per-level convention with `M-x org-convert-to-odd-levels
6847 RET' in that file. The reverse operation is `M-x
6848 org-convert-to-oddeven-levels'.
6851 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
6853 14.6 Using org-mode on a tty
6854 ============================
6856 Org-mode uses a number of keys that are not accessible on a tty. This
6857 applies to most special keys like cursor keys, <TAB> and <RET>, when
6858 these are combined with modifier keys like <Meta> and/or <Shift>.
6859 Org-mode uses these bindings because it needs to provide keys for a
6860 large number of commands, and because these keys appeared particularly
6861 easy to remember. In order to still be able to access the core
6862 functionality of Org-mode on a tty, alternative bindings are provided.
6863 Here is a complete list of these bindings, which are obviously more
6864 cumbersome to use. Note that sometimes a work-around can be better.
6865 For example changing a time stamp is really only fun with `S-<cursor>'
6866 keys. On a tty you would rather use `C-c .' to re-insert the
6869 Default Alternative 1 Alternative 2
6870 `S-<TAB>' `C-u <TAB>'
6871 `M-<left>' `C-c C-x l' `<Esc> <left>'
6872 `M-S-<left>'`C-c C-x L'
6873 `M-<right>' `C-c C-x r' `<Esc>
6875 `M-S-<right>'`C-c C-x R'
6876 `M-<up>' `C-c C-x u' `<Esc> <up>'
6877 `M-S-<up>' `C-c C-x U'
6878 `M-<down>' `C-c C-x d' `<Esc> <down>'
6879 `M-S-<down>'`C-c C-x D'
6880 `S-<RET>' `C-c C-x c'
6881 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
6882 `M-S-<RET>' `C-c C-x M'
6883 `S-<left>' `C-c <left>'
6884 `S-<right>' `C-c <right>'
6886 `S-<down>' `C-c <down>'
6887 `C-S-<left>'`C-c C-x
6889 `C-S-<right>'`C-c C-x
6893 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
6895 14.7 Interaction with other packages
6896 ====================================
6898 Org-mode lives in the world of GNU Emacs and interacts in various ways
6899 with other code out there.
6903 * Cooperation:: Packages Org-mode cooperates with
6904 * Conflicts:: Packages that lead to conflicts
6907 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
6909 14.7.1 Packages that Org-mode cooperates with
6910 ---------------------------------------------
6912 `calc.el' by Dave Gillespie
6913 Org-mode uses the calc package for implementing spreadsheet
6914 functionality in its tables (*note The spreadsheet::). Org-mode
6915 checks for the availability of calc by looking for the function
6916 `calc-eval' which should be autoloaded in your setup if calc has
6917 been installed properly. As of Emacs 22, calc is part of the Emacs
6918 distribution. Another possibility for interaction between the two
6919 packages is using calc for embedded calculations. *Note Embedded
6920 Mode: (calc)Embedded Mode.
6922 `constants.el' by Carsten Dominik
6923 In a table formula (*note The spreadsheet::), it is possible to use
6924 names for natural constants or units. Instead of defining your own
6925 constants in the variable `org-table-formula-constants', install
6926 the `constants' package which defines a large number of constants
6927 and units, and lets you use unit prefixes like `M' for `Mega' etc.
6928 You will need version 2.0 of this package, available at
6929 `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for the
6930 function `constants-get', which has to be autoloaded in your
6931 setup. See the installation instructions in the file
6934 `cdlatex.el' by Carsten Dominik
6935 Org-mode can make use of the cdlatex package to efficiently enter
6936 LaTeX fragments into Org-mode files. See *Note CDLaTeX mode::.
6938 `remember.el' by John Wiegley
6939 Org mode cooperates with remember, see *Note Remember::.
6940 `Remember.el' is not part of Emacs, find it on the web.
6942 `table.el' by Takaaki Ota
6943 Complex ASCII tables with automatic line wrapping, column- and
6944 row-spanning, and alignment can be created using the Emacs table
6945 package by Takaaki Ota (`http://sourceforge.net/projects/table',
6946 and also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in
6947 such a table, Org-mode will call `table-recognize-table' and move
6948 the cursor into the table. Inside a table, the keymap of Org-mode
6949 is inactive. In order to execute Org-mode-related commands, leave
6953 Recognize `table.el' table. Works when the cursor is in a
6957 Insert a table.el table. If there is already a table at
6958 point, this command converts it between the table.el format
6959 and the Org-mode format. See the documentation string of the
6960 command `org-convert-table' for the restrictions under which
6962 `table.el' is part of Emacs 22.
6964 `footnote.el' by Steven L. Baur
6965 Org-mode recognizes numerical footnotes as provided by this package
6966 (*note Footnotes::).
6969 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
6971 14.7.2 Packages that lead to conflicts with Org-mode
6972 ----------------------------------------------------
6974 `allout.el' by Ken Manheimer
6975 Startup of Org-mode may fail with the error message
6976 `(wrong-type-argument keymapp nil)' when there is an outdated
6977 version `allout.el' on the load path, for example the version
6978 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
6979 will disappear. If for some reason you cannot do this, make sure
6980 that org.el is loaded _before_ `allout.el', for example by putting
6981 `(require 'org)' early enough into your `.emacs' file.
6983 `CUA.el' by Kim. F. Storm
6984 Keybindings in Org-mode conflict with the `S-<cursor>' keys used by
6985 CUA-mode (as well as pc-select-mode and s-region-mode) to select
6986 and extend the region. If you want to use one of these packages
6987 along with Org-mode, configure the variable
6988 `org-replace-disputed-keys'. When set, Org-mode will move the
6989 following keybindings in Org-mode files, and in the agenda buffer
6990 (but not during date selection).
6992 S-UP -> M-p S-DOWN -> M-n
6993 S-LEFT -> M-- S-RIGHT -> M-+
6995 Yes, these are unfortunately more difficult to remember. If you
6996 want to have other replacement keys, look at the variable
6997 `org-disputed-keys'.
6999 `windmove.el' by Hovav Shacham
7000 Also this package uses the `S-<cursor>' keys, so everything written
7001 in the paragraph above about CUA mode also applies here.
7003 `footnote.el' by Steven L. Baur
7004 Org-mode supports the syntax of the footnote package, but only the
7005 numerical footnote markers. Also, the default key for footnote
7006 commands, `C-c !' is already used by Org-mode. You could use the
7007 variable `footnote-prefix' to switch footnotes commands to another
7008 key. Or, you could use `org-replace-disputed-keys' and
7009 `org-disputed-keys' to change the settings in Org-mode.
7013 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
7018 Here is a list of things that should work differently, but which I have
7019 found too hard to fix.
7021 * If a table field starts with a link, and if the corresponding table
7022 column is narrowed (*note Narrow columns::) to a width too small to
7023 display the link, the field would look entirely empty even though
7024 it is not. To prevent this, Org-mode throws an error. The
7025 work-around is to make the column wide enough to fit the link, or
7026 to add some text (at least 2 characters) before the link in the
7029 * Narrowing table columns does not work on XEmacs, because the
7030 `format' function does not transport text properties.
7032 * Text in an entry protected with the `QUOTE' keyword should not
7035 * When the application called by `C-c C-o' to open a file link fails
7036 (for example because the application does not exist or refuses to
7037 open the file), it does so silently. No error message is
7040 * Recalculating a table line applies the formulas from left to right.
7041 If a formula uses _calculated_ fields further down the row,
7042 multiple recalculation may be needed to get all fields consistent.
7043 You may use the command `org-table-iterate' (`C-u C-c *') to
7044 recalculate until convergence.
7046 * A single letter cannot be made bold, for example `*a*'.
7048 * The exporters work well, but could be made more efficient.
7051 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
7053 Appendix A Extensions, Hooks and Hacking
7054 ****************************************
7056 This appendix lists extensions for Org-mode written by other authors.
7057 It also covers some aspects where users can extend the functionality of
7062 * Extensions:: Existing 3rd-part extensions
7063 * Adding hyperlink types:: New custom link types
7064 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
7065 * Dynamic blocks:: Automatically filled blocks
7066 * Special agenda views:: Customized views
7067 * Using the property API:: Writing programs that use entry properties
7070 File: org, Node: Extensions, Next: Adding hyperlink types, Prev: Extensions and Hacking, Up: Extensions and Hacking
7072 A.1 Third-party extensions for Org-mode
7073 =======================================
7075 The following extensions for Org-mode have been written by other people:
7077 `org-publish.el' by David O'Toole
7078 This package provides facilities for publishing related sets of
7079 Org-mode files together with linked files like images as webpages.
7080 It is highly configurable and can be used for other publishing
7081 purposes as well. As of Org-mode version 4.30, `org-publish.el'
7082 is part of the Org-mode distribution. It is not yet part of
7083 Emacs, however, a delay caused by the preparations for the 22.1
7084 release. In the mean time, `org-publish.el' can be downloaded
7085 from David's site: `http://dto.freeshell.org/e/org-publish.el'.
7087 `org-mouse.el' by Piotr Zielinski
7088 This package implements extended mouse functionality for Org-mode.
7089 It allows you to cycle visibility and to edit the document
7090 structure with the mouse. Best of all, it provides a
7091 context-sensitive menu on <mouse-3> that changes depending on the
7092 context of a mouse-click. As of Org-mode version 4.53,
7093 `org-mouse.el' is part of the Org-mode distribution. It is not
7094 yet part of Emacs, however, a delay caused by the preparations for
7095 the 22.1 release. In the mean time, `org-mouse.el' can be
7096 downloaded from Piotr's site:
7097 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
7099 `org-blog.el' by David O'Toole
7100 A blogging plug-in for `org-publish.el'.
7101 `http://dto.freeshell.org/notebook/OrgMode.html'.
7103 `blorg.el' by Bastien Guerry
7104 Publish Org-mode files as blogs.
7105 `http://www.cognition.ens.fr/~guerry/blorg.html'.
7107 `org2rem.el' by Bastien Guerry
7108 Translates Org-mode files into something readable by Remind.
7109 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
7111 `org-toc.el' by Bastien Guerry
7112 Produces a simple table of contents of an Org-mode file, for easy
7113 navigation. `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
7115 `org-registry.el' by Bastien Guerry
7116 Find which Org-file link to a certain document.
7117 `http://www.cognition.ens.fr/~guerry/u/org2rem.el'.
7120 File: org, Node: Adding hyperlink types, Next: Tables in arbitrary syntax, Prev: Extensions, Up: Extensions and Hacking
7122 A.2 Adding hyperlink types
7123 ==========================
7125 Org-mode has a large number of hyperlink types built-in (*note
7126 Hyperlinks::). If you would like to add new link types, it provides an
7127 interface for doing so. Lets look at an example file `org-man.el' that
7128 will add support for creating links like `[[man:printf][The printf
7129 manpage]]' to show unix manual pages inside emacs:
7131 ;;; org-man.el - Support for links to manpages in Org-mode
7135 (org-add-link-type "man" 'org-man-open)
7136 (add-hook 'org-store-link-functions 'org-man-store-link)
7138 (defcustom org-man-command 'man
7139 "The Emacs command to be used to display a man page."
7141 :type '(choice (const man) (const woman)))
7143 (defun org-man-open (path)
7144 "Visit the manpage on PATH.
7145 PATH should be a topic that can be thrown at the man command."
7146 (funcall org-man-command path))
7148 (defun org-man-store-link ()
7149 "Store a link to a manpage."
7150 (when (memq major-mode '(Man-mode woman-mode))
7151 ;; This is a man page, we do make this link
7152 (let* ((page (org-man-get-page-name))
7153 (link (concat "man:" page))
7154 (description (format "Manpage for %s" page)))
7155 (org-store-link-props
7158 :description description))))
7160 (defun org-man-get-page-name ()
7161 "Extract the page name from the buffer name."
7162 ;; This works for both `Man-mode' and `woman-mode'.
7163 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
7164 (match-string 1 (buffer-name))
7165 (error "Cannot create link to this man page")))
7169 ;;; org-man.el ends here
7171 You would activate this new link type in `.emacs' with
7175 Lets go through the file and see what it does.
7176 1. It does `(require 'org)' to make sure that `org.el' has been
7179 2. The next line calls `org-add-link-type' to define a new link type
7180 with prefix `man'. The call also contains the name of a function
7181 that will be called to follow such a link.
7183 3. The next line adds a function to `org-store-link-functions', in
7184 order to allow the command `C-c l' to record a useful link in a
7185 buffer displaying a man page.
7187 The rest of the file defines the necessary variables and functions.
7188 First there is a customization variable that determines which emacs
7189 command should be used to display manpages. There are two options,
7190 `man' and `woman'. Then the function to follow a link is defined. It
7191 gets the link path as an argument - in this case the link path is just
7192 a topic for the manual command. The function calls the value of
7193 `org-man-command' to display the man page.
7195 Finally the function `org-man-store-link' is defined. When you try
7196 to store a link with `C-c l', also this function will be called to try
7197 to make a link. The function must first decide if it is supposed to
7198 create the link for this buffer type, we do this by checking the value
7199 of the variable `major-mode'. If not, the function must exit and
7200 retunr the value `nil'. If yes, the link is created by getting the
7201 manual tpoic from the buffer name and prefixing it with the string
7202 `man:'. Then it must call the command `org-store-link-props' and set
7203 the `:type' and `:link' properties. Optionally you can also set the
7204 `:description' property to provide a default for the link description
7205 when the link is later inserted into tan Org-mode buffer with `C-c C-l'.
7208 File: org, Node: Tables in arbitrary syntax, Next: Dynamic blocks, Prev: Adding hyperlink types, Up: Extensions and Hacking
7210 A.3 Tables and Lists in arbitrary syntax
7211 ========================================
7213 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
7214 frequent feature request has been to make it work with native tables in
7215 specific languages, for example LaTeX. However, this is extremely hard
7216 to do in a general way, would lead to a customization nightmare, and
7217 would take away much of the simplicity of the Orgtbl-mode table editor.
7219 This appendix describes a different approach. We keep the
7220 Orgtbl-mode table in its native format (the source table), and use a
7221 custom function to translate the table to the correct syntax, and to
7222 install it in the right location (the target table). This puts the
7223 burden of writing conversion functions on the user, but it allows for a
7224 very flexible system.
7226 Bastien added the ability to do the same with lists. You can use
7227 Org's facilities to edit and structure lists by turning `orgstruct-mode'
7228 on, then locally exporting such lists in another format (HTML, LaTeX or
7233 * Radio tables:: Sending and receiving
7234 * A LaTeX example:: Step by step, almost a tutorial
7235 * Translator functions:: Copy and modify
7236 * Radio lists:: Doing the same for lists.
7239 File: org, Node: Radio tables, Next: A LaTeX example, Prev: Tables in arbitrary syntax, Up: Tables in arbitrary syntax
7244 To define the location of the target table, you first need to create two
7245 lines that are comments in the current mode, but contain magic words for
7246 Orgtbl-mode to find. Orgtbl-mode will insert the translated table
7247 between these lines, replacing whatever was there before. For example:
7249 /* BEGIN RECEIVE ORGTBL table_name */
7250 /* END RECEIVE ORGTBL table_name */
7252 Just above the source table, we put a special line that tells
7253 Orgtbl-mode how to translate this table and where to install it. For
7255 #+ORGTBL: SEND table_name translation_function arguments....
7257 `table_name' is the reference name for the table that is also used in
7258 the receiver lines. `translation_function' is the Lisp function that
7259 does the translation. Furthermore, the line can contain a list of
7260 arguments (alternating key and value) at the end. The arguments will be
7261 passed as a property list to the translation function for
7262 interpretation. A few standard parameters are already recognized and
7263 acted upon before the translation function is called:
7266 Skip the first N lines of the table. Hlines do count!
7268 `:skipcols (n1 n2 ...)'
7269 List of columns that should be skipped. If the table has a column
7270 with calculation marks, that column is automatically discarded as
7271 well. Please note that the translator function sees the table
7272 _after_ the removal of these columns, the function never knows
7273 that there have been additional columns.
7275 The one problem remaining is how to keep the source table in the buffer
7276 without disturbing the normal workings of the file, for example during
7277 compilation of a C file or processing of a LaTeX file. There are a
7278 number of different solutions:
7280 * The table could be placed in a block comment if that is supported
7281 by the language. For example, in C-mode you could wrap the table
7282 between `/*' and `*/' lines.
7284 * Sometimes it is possible to put the table after some kind of END
7285 statement, for example `\bye' in TeX and `\end{document}' in LaTeX.
7287 * You can just comment the table line by line whenever you want to
7288 process the file, and uncomment it whenever you need to edit the
7289 table. This only sounds tedious - the command `M-x
7290 orgtbl-toggle-comment' does make this comment-toggling very easy,
7291 in particular if you bind it to a key.
7294 File: org, Node: A LaTeX example, Next: Translator functions, Prev: Radio tables, Up: Tables in arbitrary syntax
7296 A.3.2 A LaTeX example of radio tables
7297 -------------------------------------
7299 The best way to wrap the source table in LaTeX is to use the `comment'
7300 environment provided by `comment.sty'. It has to be activated by
7301 placing `\usepackage{comment}' into the document header. Orgtbl-mode
7302 can insert a radio table skeleton(1) with the command `M-x
7303 orgtbl-insert-radio-table'. You will be prompted for a table name,
7304 lets say we use `salesfigures'. You will then get the following
7307 % BEGIN RECEIVE ORGTBL salesfigures
7308 % END RECEIVE ORGTBL salesfigures
7310 #+ORGTBL: SEND salesfigures orgtbl-to-latex
7314 The `#+ORGTBL: SEND' line tells orgtbl-mode to use the function
7315 `orgtbl-to-latex' to convert the table into LaTeX and to put it into
7316 the receiver location with name `salesfigures'. You may now fill in
7317 the table, feel free to use the spreadsheet features(2):
7319 % BEGIN RECEIVE ORGTBL salesfigures
7320 % END RECEIVE ORGTBL salesfigures
7322 #+ORGTBL: SEND salesfigures orgtbl-to-latex
7323 | Month | Days | Nr sold | per day |
7324 |-------+------+---------+---------|
7325 | Jan | 23 | 55 | 2.4 |
7326 | Feb | 21 | 16 | 0.8 |
7327 | March | 22 | 278 | 12.6 |
7328 #+TBLFM: $4=$3/$2;%.1f
7329 % $ (optional extra dollar to keep font-lock happy, see footnote)
7332 When you are done, press `C-c C-c' in the table to get the converted
7333 table inserted between the two marker lines.
7335 Now lets assume you want to make the table header by hand, because
7336 you want to control how columns are aligned etc. In this case we make
7337 sure that the table translator does skip the first 2 lines of the source
7338 table, and tell the command to work as a splice, i.e. to not produce
7339 header and footer commands of the target table:
7341 \begin{tabular}{lrrr}
7342 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
7343 % BEGIN RECEIVE ORGTBL salesfigures
7344 % END RECEIVE ORGTBL salesfigures
7348 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
7349 | Month | Days | Nr sold | per day |
7350 |-------+------+---------+---------|
7351 | Jan | 23 | 55 | 2.4 |
7352 | Feb | 21 | 16 | 0.8 |
7353 | March | 22 | 278 | 12.6 |
7354 #+TBLFM: $4=$3/$2;%.1f
7357 The LaTeX translator function `orgtbl-to-latex' is already part of
7358 Orgtbl-mode. It uses a `tabular' environment to typeset the table and
7359 marks horizontal lines with `\hline'. Furthermore, it interprets the
7360 following parameters:
7363 When set to t, return only table body lines, don't wrap them into a
7364 tabular environment. Default is nil.
7367 A format to be used to wrap each field, should contain `%s' for the
7368 original field value. For example, to wrap each field value in
7369 dollars, you could use `:fmt "$%s$"'. This may also be a property
7370 list with column numbers and formats. for example `:fmt (2 "$%s$"
7374 Use this format to print numbers with exponentials. The format
7375 should have `%s' twice for inserting mantissa and exponent, for
7376 example `"%s\\times10^{%s}"'. The default is `"%s\\,(%s)"'. This
7377 may also be a property list with column numbers and formats, for
7378 example `:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")'.
7379 After `efmt' has been applied to a value, `fmt' will also be
7382 ---------- Footnotes ----------
7384 (1) By default this works only for LaTeX, HTML, and TeXInfo.
7385 Configure the variable `orgtbl-radio-tables' to install templates for
7388 (2) If the `#+TBLFM' line contains an odd number of dollar
7389 characters, this may cause problems with font-lock in latex-mode. As
7390 shown in the example you can fix this by adding an extra line inside the
7391 `comment' environment that is used to balance the dollar expressions.
7392 If you are using AUCTeX with the font-latex library, a much better
7393 solution is to add the `comment' environment to the variable
7394 `LaTeX-verbatim-environments'.
7397 File: org, Node: Translator functions, Next: Radio lists, Prev: A LaTeX example, Up: Tables in arbitrary syntax
7399 A.3.3 Translator functions
7400 --------------------------
7402 Orgtbl-mode has several translator functions built-in:
7403 `orgtbl-to-latex', `orgtbl-to-html', and `orgtbl-to-texinfo'. Except
7404 for `orgtbl-to-html'(1), these all use a generic translator,
7405 `orgtbl-to-generic'. For example, `orgtbl-to-latex' itself is a very
7406 short function that computes the column definitions for the `tabular'
7407 environment, defines a few field and line separators and then hands
7408 over to the generic translator. Here is the entire code:
7410 (defun orgtbl-to-latex (table params)
7411 "Convert the orgtbl-mode TABLE to LaTeX."
7412 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
7413 org-table-last-alignment ""))
7416 :tstart (concat "\\begin{tabular}{" alignment "}")
7417 :tend "\\end{tabular}"
7418 :lstart "" :lend " \\\\" :sep " & "
7419 :efmt "%s\\,(%s)" :hline "\\hline")))
7420 (orgtbl-to-generic table (org-combine-plists params2 params))))
7422 As you can see, the properties passed into the function (variable
7423 PARAMS) are combined with the ones newly defined in the function
7424 (variable PARAMS2). The ones passed into the function (i.e. the ones
7425 set by the `ORGTBL SEND' line) take precedence. So if you would like
7426 to use the LaTeX translator, but wanted the line endings to be
7427 `\\[2mm]' instead of the default `\\', you could just overrule the
7430 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
7432 For a new language, you can either write your own converter function
7433 in analogy with the LaTeX translator, or you can use the generic
7434 function directly. For example, if you have a language where a table
7435 is started with `!BTBL!', ended with `!ETBL!', and where table lines are
7436 started with `!BL!', ended with `!EL!' and where the field separator is
7437 a TAB, you could call the generic translator like this (on a single
7440 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
7441 :lstart "!BL! " :lend " !EL!" :sep "\t"
7443 Please check the documentation string of the function
7444 `orgtbl-to-generic' for a full list of parameters understood by that
7445 function and remember that you can pass each of them into
7446 `orgtbl-to-latex', `orgtbl-to-texinfo', and any other function using
7447 the generic function.
7449 Of course you can also write a completely new function doing
7450 complicated things the generic translator cannot do. A translator
7451 function takes two arguments. The first argument is the table, a list
7452 of lines, each line either the symbol `hline' or a list of fields. The
7453 second argument is the property list containing all parameters
7454 specified in the `#+ORGTBL: SEND' line. The function must return a
7455 single string containing the formatted table. If you write a generally
7456 useful translator, please post it on `emacs-orgmode@gnu.org' so that
7457 others can benefit from your work.
7459 ---------- Footnotes ----------
7461 (1) The HTML translator uses the same code that produces tables
7465 File: org, Node: Radio lists, Prev: Translator functions, Up: Tables in arbitrary syntax
7470 Sending and receiving radio lists works exactly the same way than
7471 sending and receiving radio tables (*note Radio tables::) (1). As for
7472 radio tables, you can insert radio lists templates in HTML, LaTeX and
7473 TeXInfo modes by calling `org-list-insert-radio-list'.
7475 Here are the differences with radio tables:
7477 - Use `ORGLST' instead of `ORGTBL'.
7479 - The available translation functions for radio lists don't take
7482 - `C-c C-c' will work when pressed on the first item of the list.
7484 Here is a LaTeX example. Let's say that you have this in your LaTeX
7487 % BEGIN RECEIVE ORGLST to-buy
7488 % END RECEIVE ORGLST to-buy
7490 #+ORGLIST: SEND to-buy orgtbl-to-latex
7498 Pressing `C-c C-c' on `a new house' and will insert the converted
7499 LaTeX list between the two marker lines.
7501 ---------- Footnotes ----------
7503 (1) You need to load the `org-export-latex.el' package to use radio
7504 lists since the relevant code is there for now.
7507 File: org, Node: Dynamic blocks, Next: Special agenda views, Prev: Tables in arbitrary syntax, Up: Extensions and Hacking
7512 Org-mode documents can contain _dynamic blocks_. These are specially
7513 marked regions that are updated by some user-written function. A good
7514 example for such a block is the clock table inserted by the command
7515 `C-c C-x C-r' (*note Clocking work time::).
7517 Dynamic block are enclosed by a BEGIN-END structure that assigns a
7518 name to the block and can also specify parameters for the function
7519 producing the content of the block.
7521 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
7525 Dynamic blocks are updated with the following commands
7528 Update dynamic block at point.
7531 Update all dynamic blocks in the current file.
7533 Updating a dynamic block means to remove all the text between BEGIN
7534 and END, parse the BEGIN line for parameters and then call the specific
7535 writer function for this block to insert the new content. For a block
7536 with name `myblock', the writer function is `org-dblock-write:myblock'
7537 with as only parameter a property list with the parameters given in the
7538 begin line. Here is a trivial example of a block that keeps track of
7539 when the block update function was last run:
7541 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
7545 The corresponding block writer function could look like this:
7547 (defun org-dblock-write:block-update-time (params)
7548 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
7549 (insert "Last block update at: "
7550 (format-time-string fmt (current-time)))))
7552 If you want to make sure that all dynamic blocks are always
7553 up-to-date, you could add the function `org-update-all-dblocks' to a
7554 hook, for example `before-save-hook'. `org-update-all-dblocks' is
7555 written in a way that is does nothing in buffers that are not in
7559 File: org, Node: Special agenda views, Next: Using the property API, Prev: Dynamic blocks, Up: Extensions and Hacking
7561 A.5 Special Agenda Views
7562 ========================
7564 Org-mode provides a special hook that can be used to narrow down the
7565 selection made by any of the agenda views. You may specify a function
7566 that is used at each match to verify if the match should indeed be part
7567 of the agenda view, and if not, how much should be skipped.
7569 Let's say you want to produce a list of projects that contain a
7570 WAITING tag anywhere in the project tree. Let's further assume that
7571 you have marked all tree headings that define a project with the todo
7572 keyword PROJECT. In this case you would run a todo search for the
7573 keyword PROJECT, but skip the match unless there is a WAITING tag
7574 anywhere in the subtree belonging to the project line.
7576 To achieve this, you must write a function that searches the subtree
7577 for the tag. If the tag is found, the function must return `nil' to
7578 indicate that this match should not be skipped. If there is no such
7579 tag, return the location of the end of the subtree, to indicate that
7580 search should continue from there.
7582 (defun my-skip-unless-waiting ()
7583 "Skip trees that are not waiting"
7584 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
7585 (if (re-search-forward ":WAITING:" subtree-end t)
7586 nil ; tag found, do not skip
7587 subtree-end))) ; tag not found, continue after end of subtree
7589 Now you may use this function in an agenda custom command, for
7592 (org-add-agenda-custom-command
7593 '("b" todo "PROJECT"
7594 ((org-agenda-skip-function 'my-org-waiting-projects)
7595 (org-agenda-overriding-header "Projects waiting for something: "))))
7597 Note that this also binds `org-agenda-overriding-header' to get a
7598 meaningful header in the agenda view.
7600 You may also put a Lisp form into `org-agenda-skip-function'. In
7601 particular, you may use the functions `org-agenda-skip-entry-if' and
7602 `org-agenda-skip-subtree-if' in this form, for example:
7604 `'(org-agenda-skip-entry-if 'scheduled)'
7605 Skip current entry if it has been scheduled.
7607 `'(org-agenda-skip-entry-if 'notscheduled)'
7608 Skip current entry if it has not been scheduled.
7610 `'(org-agenda-skip-entry-if 'deadline)'
7611 Skip current entry if it has a deadline.
7613 `'(org-agenda-skip-entry-if 'scheduled 'deadline)'
7614 Skip current entry if it has a deadline, or if it is scheduled.
7616 `'(org-agenda-skip-entry 'regexp "regular expression")'
7617 Skip current entry if the regular expression matches in the entry.
7619 `'(org-agenda-skip-entry 'notregexp "regular expression")'
7620 Skip current entry unless the regular expression matches.
7622 `'(org-agenda-skip-subtree-if 'regexp "regular expression")'
7623 Same as above, but check and skip the entire subtree.
7625 Therefore we could also have written the search for WAITING projects
7626 like this, even without defining a special function:
7628 (org-add-agenda-custom-command
7629 '("b" todo "PROJECT"
7630 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
7631 'regexp ":WAITING:"))
7632 (org-agenda-overriding-header "Projects waiting for something: "))))
7635 File: org, Node: Using the property API, Prev: Special agenda views, Up: Extensions and Hacking
7637 A.6 Using the property API
7638 ==========================
7640 Here is a description of the functions that can be used to work with
7643 -- Function: org-entry-properties &optional pom which
7644 Get all properties of the entry at point-or-marker POM. This
7645 includes the TODO keyword, the tags, time strings for deadline,
7646 scheduled, and clocking, and any additional properties defined in
7647 the entry. The return value is an alist, keys may occur multiple
7648 times if the property key was used several times. POM may also be
7649 nil, in which case the current entry is used. If WHICH is nil or
7650 `all', get all properties. If WHICH is `special' or `standard',
7651 only get that subclass.
7653 -- Function: org-entry-get pom property &optional inherit
7654 Get value of PROPERTY for entry at point-or-marker POM. If
7655 INHERIT is non-nil and the entry does not have the property, then
7656 also check higher levels of the hierarchy. This function ignores
7657 the value of `org-use-property-inheritance' and requires the
7658 explicit INHERIT flag.
7660 -- Function: org-entry-delete pom property
7661 Delete the property PROPERTY from entry at point-or-marker POM.
7663 -- Function: org-entry-put pom property value
7664 Set PROPERTY to VALUE for entry at point-or-marker POM.
7666 -- Function: org-buffer-property-keys &optional include-specials
7667 Get all property keys in the current buffer.
7669 -- Function: org-insert-property-drawer
7670 Insert a property drawer at point.
7673 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
7675 Appendix B History and Acknowledgments
7676 **************************************
7678 Org-mode was borne in 2003, out of frustration over the user interface
7679 of the Emacs outline-mode. I was trying to organize my notes and
7680 projects, and using Emacs seemed to be the natural way to go. However,
7681 having to remember eleven different commands with two or three keys per
7682 command, only to hide and unhide parts of the outline tree, that seemed
7683 entirely unacceptable to me. Also, when using outlines to take notes, I
7684 constantly want to restructure the tree, organizing it parallel to my
7685 thoughts and plans. _Visibility cycling_ and _structure editing_ were
7686 originally implemented in the package `outline-magic.el', but quickly
7687 moved to the more general `org.el'. As this environment became
7688 comfortable for project planning, the next step was adding _TODO
7689 entries_, basic _time stamps_, and _table support_. These areas
7690 highlight the two main goals that Org-mode still has today: To create a
7691 new, outline-based, plain text mode with innovative and intuitive
7692 editing features, and to incorporate project planning functionality
7693 directly into a notes file.
7695 Since the first release, literally thousands of emails to me or on
7696 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
7697 feedback, new ideas, and sometimes patches and add-on code. Many
7698 thanks to everyone who has helped to improve this package. I am trying
7699 to keep here a list of the people who had significant influence in
7700 shaping one or more aspects of Org-mode. The list may not be complete,
7701 if I have forgotten someone, please accept my apologies and let me know.
7703 * Russel Adams came up with the idea for drawers.
7705 * Thomas Baumann contributed the code for links to the MH-E email
7708 * Alex Bochannek provided a patch for rounding time stamps.
7710 * Charles Cave's suggestion sparked the implementation of templates
7713 * Pavel Chalmoviansky influenced the agenda treatment of items with
7716 * Gregory Chernov patched support for lisp forms into table
7717 calculations and improved XEmacs compatibility, in particular by
7718 porting `nouline.el' to XEmacs.
7720 * Sacha Chua suggested to copy some linking code from Planner.
7722 * Eddward DeVilla proposed and tested checkbox statistics. He also
7723 came up with the idea of properties, and that there should be an
7726 * Kees Dullemond used to edit projects lists directly in HTML and so
7727 inspired some of the early development, including HTML export. He
7728 also asked for a way to narrow wide table columns.
7730 * Christian Egli converted the documentation into TeXInfo format,
7731 patched CSS formatting into the HTML exporter, and inspired the
7734 * David Emery provided a patch for custom CSS support in exported
7737 * Nic Ferrier contributed mailcap and XOXO support.
7739 * John Foerch figured out how to make incremental search show context
7740 around a match in a hidden outline tree.
7742 * Niels Giesen had the idea to automatically archive DONE trees.
7744 * Bastien Guerry wrote the LaTeX exporter and has been prolific with
7745 patches, ideas, and bug reports.
7747 * Kai Grossjohann pointed out key-binding conflicts with other
7750 * Scott Jaderholm proposed footnotes, control over whitespace between
7751 folded entries, and column view for properties.
7753 * Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
7754 provided frequent feedback and some patches.
7756 * Jason F. McBrayer suggested agenda export to CSV format.
7758 * Dmitri Minaev sent a patch to set priority limits on a per-file
7761 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
7764 * Rick Moynihan proposed to allow multiple TODO sequences in a file.
7766 * Todd Neal provided patches for links to Info files and elisp forms.
7768 * Tim O'Callaghan suggested in-file links, search options for general
7769 file links, and TAGS.
7771 * Takeshi Okano translated the manual and David O'Toole's tutorial
7774 * Oliver Oppitz suggested multi-state TODO items.
7776 * Scott Otterson sparked the introduction of descriptive text for
7777 links, among other things.
7779 * Pete Phillips helped during the development of the TAGS feature,
7780 and provided frequent feedback.
7782 * T.V. Raman reported bugs and suggested improvements.
7784 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
7787 * Kevin Rogers contributed code to access VM files on remote hosts.
7789 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
7790 conflict with `allout.el'.
7792 * Jason Riedy sent a patch to fix a bug with export of TODO keywords.
7794 * Philip Rooke created the Org-mode reference card and provided lots
7797 * Christian Schlauer proposed angular brackets around links, among
7800 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
7801 `organizer-mode.el'.
7803 * Daniel Sinder came up with the idea of internal archiving by
7806 * Dale Smith proposed link abbreviations.
7808 * Adam Spiers asked for global linking commands and inspired the link
7809 extension system. support mairix.
7811 * David O'Toole wrote `org-publish.el' and drafted the manual
7812 chapter about publishing.
7814 * Ju"rgen Vollmer contributed code generating the table of contents
7817 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
7819 * David Wainberg suggested archiving, and improvements to the linking
7822 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
7823 development of Org-mode was fully independent, and both systems are
7824 really different beasts in their basic ideas and implementation
7825 details. I later looked at John's code, however, and learned from
7826 his implementation of (i) links where the link itself is hidden
7827 and only a description is shown, and (ii) popping up a calendar to
7828 select a date. John has also contributed a number of great ideas
7829 directly to Org-mode.
7831 * Carsten Wimmer suggested some changes and helped fix a bug in
7834 * Roland Winkler requested additional keybindings to make Org-mode
7837 * Piotr Zielinski wrote `org-mouse.el', proposed agenda blocks and
7838 contributed various ideas and code snippets.
7841 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
7849 * abbreviation, links: Link abbreviations. (line 6)
7850 * acknowledgments: History and Acknowledgments.
7852 * action, for publishing: Publishing action. (line 6)
7853 * activation: Activation. (line 6)
7854 * active region <1>: Structure editing. (line 74)
7855 * active region <2>: HTML Export commands.
7857 * active region <3>: ASCII export. (line 9)
7858 * active region: Built-in table editor.
7860 * agenda: Weekly/Daily agenda. (line 6)
7861 * agenda dispatcher: Agenda dispatcher. (line 6)
7862 * agenda files: Agenda files. (line 6)
7863 * agenda files, removing buffers: Agenda commands. (line 244)
7864 * agenda views: Agenda views. (line 6)
7865 * agenda views, custom: Custom agenda views. (line 6)
7866 * agenda views, exporting <1>: Agenda commands. (line 233)
7867 * agenda views, exporting: Exporting Agenda Views.
7869 * agenda views, user-defined: Special agenda views.
7871 * agenda, pipe: Extracting Agenda Information for other programs.
7873 * agenda, with block views: Block agenda. (line 6)
7874 * align, STARTUP keyword: In-buffer settings. (line 72)
7875 * allout.el: Conflicts. (line 6)
7876 * angular brackets, around links: External links. (line 43)
7877 * API, for properties <1>: Property API. (line 6)
7878 * API, for properties: Using the property API.
7880 * appointment reminders: Weekly/Daily agenda. (line 65)
7881 * appt.el: Weekly/Daily agenda. (line 65)
7882 * archive locations: Moving subtrees. (line 23)
7883 * archiving: Archiving. (line 6)
7884 * ASCII export: ASCII export. (line 6)
7885 * author: Feedback. (line 6)
7886 * author info, in export: Export options. (line 26)
7887 * autoload: Activation. (line 6)
7888 * backtrace of an error: Feedback. (line 27)
7889 * BBDB links: External links. (line 6)
7890 * block agenda: Block agenda. (line 6)
7891 * blorg.el: Extensions. (line 32)
7892 * bold text: Enhancing text. (line 15)
7893 * Boolean logic, for tag searches: Tag searches. (line 24)
7894 * bug reports: Feedback. (line 6)
7895 * bugs: Bugs. (line 6)
7896 * C-c C-c, overview: The very busy C-c C-c key.
7898 * calc package: The spreadsheet. (line 6)
7899 * calc.el: Cooperation. (line 6)
7900 * calculations, in tables <1>: Built-in table editor.
7902 * calculations, in tables: The spreadsheet. (line 6)
7903 * calendar commands, from agenda: Agenda commands. (line 196)
7904 * calendar integration: Weekly/Daily agenda. (line 23)
7905 * calendar, for selecting date: The date/time prompt.
7907 * category: Categories. (line 6)
7908 * category, require for tags/property match: Tag searches. (line 69)
7909 * CDLaTeX: CDLaTeX mode. (line 6)
7910 * cdlatex.el: Cooperation. (line 29)
7911 * checkbox statistics: Checkboxes. (line 23)
7912 * checkboxes: Checkboxes. (line 6)
7913 * children, subtree visibility state: Visibility cycling. (line 10)
7914 * clean outline view: Clean view. (line 6)
7915 * column formula: Column formulas. (line 6)
7916 * column view, for properties: Defining columns. (line 6)
7917 * commands, in agenda buffer: Agenda commands. (line 6)
7918 * comment lines: Comment lines. (line 6)
7919 * completion, of dictionary words: Completion. (line 6)
7920 * completion, of file names: Handling links. (line 44)
7921 * completion, of link abbreviations: Completion. (line 6)
7922 * completion, of links: Handling links. (line 25)
7923 * completion, of option keywords <1>: Per file keywords. (line 23)
7924 * completion, of option keywords <2>: Completion. (line 6)
7925 * completion, of option keywords: Export options. (line 6)
7926 * completion, of property keys: Completion. (line 6)
7927 * completion, of tags <1>: Setting tags. (line 11)
7928 * completion, of tags: Completion. (line 6)
7929 * completion, of TeX symbols: Completion. (line 6)
7930 * completion, of TODO keywords <1>: Completion. (line 6)
7931 * completion, of TODO keywords: Workflow states. (line 15)
7932 * constants, in calculations: References. (line 82)
7933 * constants.el: Cooperation. (line 14)
7934 * constcgs, STARTUP keyword: In-buffer settings. (line 98)
7935 * constSI, STARTUP keyword: In-buffer settings. (line 98)
7936 * content, STARTUP keyword: In-buffer settings. (line 65)
7937 * contents, global visibility state: Visibility cycling. (line 22)
7938 * copying, of subtrees: Structure editing. (line 6)
7939 * creating timestamps: Creating timestamps. (line 6)
7940 * CUA.el: Conflicts. (line 15)
7941 * custom agenda views: Custom agenda views. (line 6)
7942 * custom date/time format: Custom time format. (line 6)
7943 * custom search strings: Custom searches. (line 6)
7944 * customization: Customization. (line 6)
7945 * customtime, STARTUP keyword: In-buffer settings. (line 95)
7946 * cutting, of subtrees: Structure editing. (line 6)
7947 * cycling, of TODO states: TODO basics. (line 13)
7948 * cycling, visibility: Visibility cycling. (line 6)
7949 * daily agenda: Weekly/Daily agenda. (line 6)
7950 * date format, custom: Custom time format. (line 6)
7951 * date range: Time stamps. (line 40)
7952 * date stamps <1>: Dates and times. (line 6)
7953 * date stamps: Time stamps. (line 6)
7954 * date, reading in minibuffer: The date/time prompt.
7956 * dates: Dates and times. (line 6)
7957 * DEADLINE keyword: Deadlines and scheduling.
7959 * deadlines: Time stamps. (line 6)
7960 * debugging, of table formulas: Editing and debugging formulas.
7962 * demotion, of subtrees: Structure editing. (line 6)
7963 * diary entries, creating from agenda: Agenda commands. (line 201)
7964 * diary integration: Weekly/Daily agenda. (line 23)
7965 * dictionary word completion: Completion. (line 6)
7966 * directories, for publishing: Sources and destinations.
7968 * dispatching agenda commands: Agenda dispatcher. (line 6)
7969 * display changing, in agenda: Agenda commands. (line 65)
7970 * document structure: Document structure. (line 6)
7971 * DONE, final TODO keyword: Per file keywords. (line 26)
7972 * drawer, for properties: Property syntax. (line 6)
7973 * drawers: Drawers. (line 6)
7974 * dynamic blocks: Dynamic blocks. (line 6)
7975 * editing tables: Tables. (line 6)
7976 * editing, of table formulas: Editing and debugging formulas.
7978 * elisp links: External links. (line 6)
7979 * emphasized text: Export options. (line 26)
7980 * enhancing text: Enhancing text. (line 6)
7981 * evaluate time range: Creating timestamps. (line 48)
7982 * even, STARTUP keyword: In-buffer settings. (line 88)
7983 * examples, quoted: Quoted examples. (line 6)
7984 * exporting: Exporting. (line 6)
7985 * exporting agenda views <1>: Agenda commands. (line 233)
7986 * exporting agenda views: Exporting Agenda Views.
7988 * exporting, not: Comment lines. (line 6)
7989 * extended TODO keywords: TODO extensions. (line 6)
7990 * extension, third-party: Extensions. (line 6)
7991 * external archiving: Moving subtrees. (line 6)
7992 * external links: External links. (line 6)
7993 * external links, in HTML export: Links. (line 6)
7994 * faces, for TODO keywords: Faces for TODO keywords.
7996 * FAQ: Summary. (line 56)
7997 * feedback: Feedback. (line 6)
7998 * field formula: Field formulas. (line 6)
7999 * field references: References. (line 15)
8000 * file links: External links. (line 6)
8001 * file links, searching: Search options. (line 6)
8002 * file name completion: Handling links. (line 44)
8003 * files for agenda: Agenda files. (line 6)
8004 * files, adding to agenda list: Agenda files. (line 15)
8005 * files, selecting for publishing: Selecting files. (line 6)
8006 * fixed width: Enhancing text. (line 30)
8007 * fixed width text: Quoted examples. (line 6)
8008 * fixed-width sections: Export options. (line 26)
8009 * folded, subtree visibility state: Visibility cycling. (line 10)
8010 * folding, sparse trees: Sparse trees. (line 6)
8011 * following links: Handling links. (line 59)
8012 * footnote.el <1>: Cooperation. (line 56)
8013 * footnote.el <2>: Footnotes. (line 6)
8014 * footnote.el: Conflicts. (line 35)
8015 * footnotes <1>: Footnotes. (line 6)
8016 * footnotes: Export options. (line 26)
8017 * format specifier: Formula syntax for Calc.
8019 * format, of links: Link format. (line 6)
8020 * formula debugging: Editing and debugging formulas.
8022 * formula editing: Editing and debugging formulas.
8024 * formula syntax, Calc: Formula syntax for Calc.
8026 * formula, for individual table field: Field formulas. (line 6)
8027 * formula, for table column: Column formulas. (line 6)
8028 * formula, in tables: Built-in table editor.
8030 * global cycling: Visibility cycling. (line 22)
8031 * global keybindings: Activation. (line 6)
8032 * global TODO list: Global TODO list. (line 6)
8033 * global visibility states: Visibility cycling. (line 22)
8034 * GNUS links: External links. (line 6)
8035 * grouping columns in tables: Column groups. (line 6)
8036 * hand-formatted lists: Enhancing text. (line 11)
8037 * headline levels: Export options. (line 26)
8038 * headline levels, for exporting <1>: LaTeX export commands.
8040 * headline levels, for exporting <2>: HTML Export commands.
8042 * headline levels, for exporting: ASCII export. (line 21)
8043 * headline navigation: Motion. (line 6)
8044 * headline tagging: Tags. (line 6)
8045 * headline, promotion and demotion: Structure editing. (line 6)
8046 * headlines: Headlines. (line 6)
8047 * hide text: Visibility cycling. (line 6)
8048 * hidestars, STARTUP keyword: In-buffer settings. (line 88)
8049 * hiding leading stars: Clean view. (line 6)
8050 * history: History and Acknowledgments.
8052 * horizontal rules, in exported files: Enhancing text. (line 20)
8053 * HTML entities, LaTeX entities: Enhancing text. (line 45)
8054 * HTML export: HTML export. (line 6)
8055 * HTML, and orgtbl-mode: Translator functions.
8057 * hyperlinks: Hyperlinks. (line 6)
8058 * hyperlinks, adding new types: Adding hyperlink types.
8060 * iCalendar export: iCalendar export. (line 6)
8061 * images, inline in HTML: Images. (line 6)
8062 * in-buffer settings: In-buffer settings. (line 6)
8063 * inactive timestamp: Time stamps. (line 49)
8064 * index, of published pages: Project page index. (line 6)
8065 * Info links: External links. (line 6)
8066 * inheritance, of properties: Property searches. (line 6)
8067 * inheritance, of tags: Tag inheritance. (line 6)
8068 * inlining images in HTML: Images. (line 6)
8069 * inserting links: Handling links. (line 25)
8070 * installation: Installation. (line 6)
8071 * internal archiving: ARCHIVE tag. (line 6)
8072 * internal links: Internal links. (line 6)
8073 * internal links, in HTML export: Links. (line 6)
8074 * introduction: Introduction. (line 6)
8075 * italic text: Enhancing text. (line 15)
8076 * jumping, to headlines: Motion. (line 6)
8077 * keybindings, global: Activation. (line 6)
8078 * keyword options: Per file keywords. (line 6)
8079 * LaTeX class: Sectioning structure.
8081 * LaTeX export: LaTeX export. (line 6)
8082 * LaTeX fragments <1>: Export options. (line 26)
8083 * LaTeX fragments: LaTeX fragments. (line 6)
8084 * LaTeX fragments, export: Enhancing text. (line 23)
8085 * LaTeX fragments, preview: Processing LaTeX fragments.
8087 * LaTeX interpretation: Embedded LaTeX. (line 6)
8088 * LaTeX sectioning structure: Sectioning structure.
8090 * LaTeX, and orgtbl-mode: A LaTeX example. (line 6)
8091 * level, require for tags/property match: Tag searches. (line 69)
8092 * linebreak preservation: Export options. (line 26)
8093 * linebreak, forced: Enhancing text. (line 42)
8094 * link abbreviations: Link abbreviations. (line 6)
8095 * link abbreviations, completion of: Completion. (line 6)
8096 * link completion: Handling links. (line 25)
8097 * link format: Link format. (line 6)
8098 * links, external: External links. (line 6)
8099 * links, finding next/previous: Handling links. (line 92)
8100 * links, handling: Handling links. (line 6)
8101 * links, in HTML export: Links. (line 6)
8102 * links, internal: Internal links. (line 6)
8103 * links, publishing: Publishing links. (line 6)
8104 * links, radio targets: Radio targets. (line 6)
8105 * links, returning to: Handling links. (line 86)
8106 * Lisp forms, as table formulas: Formula syntax for Lisp.
8108 * lists, hand-formatted: Enhancing text. (line 11)
8109 * lists, in other modes: Tables in arbitrary syntax.
8111 * lists, ordered: Plain lists. (line 6)
8112 * lists, plain: Plain lists. (line 6)
8113 * logdone, STARTUP keyword: In-buffer settings. (line 77)
8114 * logging, of progress: Progress logging. (line 6)
8115 * lognoteclock-out, STARTUP keyword: In-buffer settings. (line 77)
8116 * lognotedone, STARTUP keyword: In-buffer settings. (line 77)
8117 * lognotestate, STARTUP keyword: In-buffer settings. (line 77)
8118 * logrepeat, STARTUP keyword: In-buffer settings. (line 77)
8119 * maintainer: Feedback. (line 6)
8120 * mark ring: Handling links. (line 82)
8121 * marking characters, tables: Advanced features. (line 40)
8122 * matching, of properties: Matching tags and properties.
8124 * matching, of tags: Matching tags and properties.
8126 * matching, tags: Tags. (line 6)
8127 * math symbols: Math symbols. (line 6)
8128 * MH-E links: External links. (line 6)
8129 * minor mode for structure editing: orgstruct-mode. (line 6)
8130 * minor mode for tables: orgtbl-mode. (line 6)
8131 * mode, for calc: Formula syntax for Calc.
8133 * motion commands in agenda: Agenda commands. (line 19)
8134 * motion, between headlines: Motion. (line 6)
8135 * name, of column or field: References. (line 82)
8136 * named references: References. (line 82)
8137 * names as TODO keywords: TODO types. (line 6)
8138 * narrow columns in tables: Narrow columns. (line 6)
8139 * noalign, STARTUP keyword: In-buffer settings. (line 72)
8140 * nologging, STARTUP keyword: In-buffer settings. (line 77)
8141 * nologrepeat, STARTUP keyword: In-buffer settings. (line 77)
8142 * occur, command: Sparse trees. (line 6)
8143 * odd, STARTUP keyword: In-buffer settings. (line 88)
8144 * option keyword completion: Completion. (line 6)
8145 * options, for custom agenda views: Setting Options. (line 6)
8146 * options, for customization: Customization. (line 6)
8147 * options, for export: Export options. (line 6)
8148 * options, for publishing: Publishing options. (line 6)
8149 * ordered lists: Plain lists. (line 6)
8150 * org-agenda, command: Weekly/Daily agenda. (line 9)
8151 * org-blog.el: Extensions. (line 28)
8152 * org-list-insert-radio-list: Radio lists. (line 6)
8153 * org-mode, turning on: Activation. (line 22)
8154 * org-mouse.el: Extensions. (line 16)
8155 * org-publish-project-alist: Project alist. (line 6)
8156 * org-publish.el: Extensions. (line 8)
8157 * org2rem.el: Extensions. (line 36)
8158 * orgstruct-mode: orgstruct-mode. (line 6)
8159 * orgtbl-mode <1>: orgtbl-mode. (line 6)
8160 * orgtbl-mode: Tables in arbitrary syntax.
8162 * outline tree: Headlines. (line 6)
8163 * outline-mode: Outlines. (line 6)
8164 * outlines: Outlines. (line 6)
8165 * overview, global visibility state: Visibility cycling. (line 22)
8166 * overview, STARTUP keyword: In-buffer settings. (line 65)
8167 * packages, interaction with other: Interaction. (line 6)
8168 * pasting, of subtrees: Structure editing. (line 6)
8169 * per file keywords: Per file keywords. (line 6)
8170 * plain lists: Plain lists. (line 6)
8171 * plain text external links: External links. (line 43)
8172 * presentation, of agenda items: Presentation and sorting.
8174 * printing sparse trees: Sparse trees. (line 46)
8175 * priorities: Priorities. (line 6)
8176 * priorities, of agenda items: Sorting of agenda items.
8178 * progress logging: Progress logging. (line 6)
8179 * projects, for publishing: Project alist. (line 6)
8180 * promotion, of subtrees: Structure editing. (line 6)
8181 * properties: Properties and columns.
8183 * properties, API <1>: Property API. (line 6)
8184 * properties, API: Using the property API.
8186 * properties, column view: Defining columns. (line 6)
8187 * properties, inheritance: Property searches. (line 6)
8188 * properties, searching: Property searches. (line 6)
8189 * properties, special: Special properties. (line 6)
8190 * property syntax: Property syntax. (line 6)
8191 * publishing: Publishing. (line 6)
8192 * quoted examples: Quoted examples. (line 6)
8193 * quoted HTML tags: Export options. (line 26)
8194 * radio lists: Radio lists. (line 6)
8195 * radio tables: Radio tables. (line 6)
8196 * radio targets: Radio targets. (line 6)
8197 * range references: References. (line 60)
8198 * ranges, time: Time stamps. (line 6)
8199 * recomputing table fields: Updating the table. (line 6)
8200 * references: References. (line 6)
8201 * references, named: References. (line 82)
8202 * references, to fields: References. (line 15)
8203 * references, to ranges: References. (line 60)
8204 * refiling notes: Refiling notes. (line 6)
8205 * region, active <1>: Built-in table editor.
8207 * region, active <2>: Structure editing. (line 74)
8208 * region, active <3>: HTML Export commands.
8210 * region, active: ASCII export. (line 9)
8211 * regular expressions, with tags search: Tag searches. (line 64)
8212 * remember.el <1>: Remember. (line 6)
8213 * remember.el: Cooperation. (line 33)
8214 * remote editing, from agenda: Agenda commands. (line 107)
8215 * remote editing, undo: Agenda commands. (line 108)
8216 * richer text: Enhancing text. (line 6)
8217 * RMAIL links: External links. (line 6)
8218 * SCHEDULED keyword: Deadlines and scheduling.
8220 * scheduling: Time stamps. (line 6)
8221 * Scripts, for agenda processing: Extracting Agenda Information for other programs.
8223 * search option in file links: Search options. (line 6)
8224 * search strings, custom: Custom searches. (line 6)
8225 * searching for tags: Tag searches. (line 6)
8226 * searching, of properties: Property searches. (line 6)
8227 * section-numbers: Export options. (line 26)
8228 * setting tags: Setting tags. (line 6)
8229 * SHELL links: External links. (line 6)
8230 * show all, command: Visibility cycling. (line 33)
8231 * show all, global visibility state: Visibility cycling. (line 22)
8232 * show hidden text: Visibility cycling. (line 6)
8233 * showall, STARTUP keyword: In-buffer settings. (line 65)
8234 * showstars, STARTUP keyword: In-buffer settings. (line 88)
8235 * sorting, of agenda items: Sorting of agenda items.
8237 * sparse tree, for deadlines: Inserting deadline/schedule.
8239 * sparse tree, for TODO: TODO basics. (line 38)
8240 * sparse tree, tag based: Tags. (line 6)
8241 * sparse trees: Sparse trees. (line 6)
8242 * special keywords: In-buffer settings. (line 6)
8243 * special strings: Export options. (line 26)
8244 * spreadsheet capabilities: The spreadsheet. (line 6)
8245 * statistics, for checkboxes: Checkboxes. (line 23)
8246 * storing links: Handling links. (line 9)
8247 * structure editing: Structure editing. (line 6)
8248 * structure of document: Document structure. (line 6)
8249 * sublevels, inclusion into tags match: Tag inheritance. (line 6)
8250 * sublevels, inclusion into todo list: Global TODO list. (line 34)
8251 * subscript: Subscripts and Superscripts.
8253 * subtree cycling: Visibility cycling. (line 10)
8254 * subtree visibility states: Visibility cycling. (line 10)
8255 * subtree, cut and paste: Structure editing. (line 6)
8256 * subtree, subtree visibility state: Visibility cycling. (line 10)
8257 * subtrees, cut and paste: Structure editing. (line 6)
8258 * summary: Summary. (line 6)
8259 * superscript: Subscripts and Superscripts.
8261 * syntax, of formulas: Formula syntax for Calc.
8263 * table editor, built-in: Built-in table editor.
8265 * table editor, table.el: Cooperation. (line 37)
8266 * table of contents: Export options. (line 26)
8267 * table.el: Cooperation. (line 34)
8268 * tables <1>: Export options. (line 26)
8269 * tables: Tables. (line 6)
8270 * tables, export: Enhancing text. (line 26)
8271 * tables, in other modes: Tables in arbitrary syntax.
8273 * tag completion: Completion. (line 6)
8274 * tag inheritance: Tag inheritance. (line 6)
8275 * tag searches: Tag searches. (line 6)
8276 * tags: Tags. (line 6)
8277 * tags view: Matching tags and properties.
8279 * tags, setting: Setting tags. (line 6)
8280 * targets, for links: Internal links. (line 6)
8281 * targets, radio: Radio targets. (line 6)
8282 * tasks, breaking down: Breaking down tasks. (line 6)
8283 * templates, for remember: Remember templates. (line 6)
8284 * TeX interpretation: Embedded LaTeX. (line 6)
8285 * TeX macros <1>: Math symbols. (line 6)
8286 * TeX macros: Export options. (line 26)
8287 * TeX macros, export: Enhancing text. (line 23)
8288 * TeX symbol completion: Completion. (line 6)
8289 * TeX-like syntax for sub- and superscripts: Export options. (line 26)
8290 * text, fixed width: Quoted examples. (line 6)
8291 * thanks: History and Acknowledgments.
8293 * time format, custom: Custom time format. (line 6)
8294 * time grid: Time-of-day specifications.
8296 * time info, in export: Export options. (line 26)
8297 * time stamps <1>: Dates and times. (line 6)
8298 * time stamps: Time stamps. (line 6)
8299 * time, reading in minibuffer: The date/time prompt.
8301 * time-of-day specification: Time-of-day specifications.
8303 * time-sorted view: Timeline. (line 6)
8304 * timeline, single file: Timeline. (line 6)
8305 * timerange: Time stamps. (line 40)
8306 * times: Dates and times. (line 6)
8307 * timestamp: Time stamps. (line 14)
8308 * timestamp, inactive: Time stamps. (line 49)
8309 * timestamp, with repeater interval: Time stamps. (line 24)
8310 * timestamps, creating: Creating timestamps. (line 6)
8311 * TODO items: TODO items. (line 6)
8312 * TODO keyword matching: Global TODO list. (line 17)
8313 * TODO keyword matching, with tags search: Tag searches. (line 41)
8314 * todo keyword sets: Multiple sets in one file.
8316 * TODO keywords completion: Completion. (line 6)
8317 * TODO list, global: Global TODO list. (line 6)
8318 * TODO types: TODO types. (line 6)
8319 * TODO workflow: Workflow states. (line 6)
8320 * transient-mark-mode <1>: ASCII export. (line 9)
8321 * transient-mark-mode <2>: Built-in table editor.
8323 * transient-mark-mode <3>: Structure editing. (line 74)
8324 * transient-mark-mode: HTML Export commands.
8326 * translator function: Translator functions.
8328 * trees, sparse: Sparse trees. (line 6)
8329 * trees, visibility: Visibility cycling. (line 6)
8330 * tty keybindings: TTY keys. (line 6)
8331 * types as TODO keywords: TODO types. (line 6)
8332 * underlined text: Enhancing text. (line 15)
8333 * undoing remote-editing events: Agenda commands. (line 108)
8334 * updating, table: Updating the table. (line 6)
8335 * URL links: External links. (line 6)
8336 * USENET links: External links. (line 6)
8337 * variables, for customization: Customization. (line 6)
8338 * vectors, in table calculations: Formula syntax for Calc.
8340 * verbatim text: Enhancing text. (line 15)
8341 * visibility cycling: Visibility cycling. (line 6)
8342 * visibility cycling, drawers: Drawers. (line 6)
8343 * visible text, printing: Sparse trees. (line 46)
8344 * VM links: External links. (line 6)
8345 * WANDERLUST links: External links. (line 6)
8346 * weekly agenda: Weekly/Daily agenda. (line 6)
8347 * windmove.el: Conflicts. (line 32)
8348 * workflow states as TODO keywords: Workflow states. (line 6)
8349 * XEmacs: Installation. (line 6)
8350 * XOXO export: XOXO export. (line 6)
8353 File: org, Node: Key Index, Prev: Index, Up: Top
8361 * $: Agenda commands. (line 122)
8362 * ': CDLaTeX mode. (line 43)
8363 * +: Agenda commands. (line 145)
8364 * ,: Agenda commands. (line 137)
8365 * -: Agenda commands. (line 151)
8366 * .: Agenda commands. (line 99)
8367 * :: Agenda commands. (line 130)
8368 * < <1>: The date/time prompt.
8370 * <: Using column view. (line 57)
8371 * <left>: Agenda commands. (line 96)
8372 * <RET> <1>: The date/time prompt.
8374 * <RET> <2>: Setting tags. (line 76)
8375 * <RET> <3>: Agenda commands. (line 39)
8376 * <RET>: Built-in table editor.
8378 * <right>: Agenda commands. (line 91)
8379 * <SPC> <1>: Agenda commands. (line 28)
8380 * <SPC>: Setting tags. (line 73)
8381 * <TAB> <1>: Visibility cycling. (line 10)
8382 * <TAB> <2>: Editing and debugging formulas.
8384 * <TAB> <3>: Built-in table editor.
8386 * <TAB> <4>: Plain lists. (line 41)
8387 * <TAB> <5>: Agenda commands. (line 33)
8388 * <TAB> <6>: CDLaTeX mode. (line 23)
8389 * <TAB>: Setting tags. (line 68)
8390 * > <1>: Using column view. (line 57)
8391 * > <2>: Agenda commands. (line 173)
8392 * >: The date/time prompt.
8394 * ^: CDLaTeX mode. (line 33)
8395 * _: CDLaTeX mode. (line 33)
8396 * `: CDLaTeX mode. (line 39)
8397 * a <1>: Using column view. (line 46)
8398 * a: Agenda commands. (line 134)
8399 * b: Agenda commands. (line 49)
8400 * C: Agenda commands. (line 216)
8401 * c: Agenda commands. (line 196)
8402 * C-#: Advanced features. (line 9)
8403 * C-': Agenda files. (line 21)
8404 * C-,: Agenda files. (line 21)
8405 * C-<RET>: Structure editing. (line 18)
8406 * C-_: Agenda commands. (line 108)
8407 * C-c ! <1>: Footnotes. (line 14)
8408 * C-c !: Creating timestamps. (line 19)
8409 * C-c #: Checkboxes. (line 57)
8410 * C-c %: Handling links. (line 82)
8411 * C-c &: Handling links. (line 86)
8412 * C-c ': Editing and debugging formulas.
8414 * C-c *: Updating the table. (line 13)
8415 * C-c +: Built-in table editor.
8417 * C-c ,: Priorities. (line 18)
8418 * C-c - <1>: Plain lists. (line 88)
8419 * C-c -: Built-in table editor.
8421 * C-c .: Creating timestamps. (line 10)
8422 * C-c /: Sparse trees. (line 15)
8423 * C-c / d: Inserting deadline/schedule.
8425 * C-c / p: Property searches. (line 23)
8426 * C-c / r: Sparse trees. (line 17)
8427 * C-c / T: Tag searches. (line 9)
8428 * C-c / t: TODO basics. (line 38)
8429 * C-c : <1>: Quoted examples. (line 15)
8430 * C-c :: Enhancing text. (line 34)
8431 * C-c ;: Comment lines. (line 10)
8432 * C-c <: Creating timestamps. (line 23)
8433 * C-c <TAB>: Built-in table editor.
8435 * C-c = <1>: Column formulas. (line 26)
8436 * C-c =: Editing and debugging formulas.
8438 * C-c >: Creating timestamps. (line 27)
8439 * C-c ?: Editing and debugging formulas.
8441 * C-c [: Agenda files. (line 15)
8442 * C-c \: Tag searches. (line 9)
8443 * C-c ]: Agenda files. (line 18)
8444 * C-c ^ <1>: Structure editing. (line 61)
8445 * C-c ^: Built-in table editor.
8447 * C-c `: Built-in table editor.
8449 * C-c a !: Stuck projects. (line 14)
8450 * C-c a #: Stuck projects. (line 13)
8451 * C-c a a: Weekly/Daily agenda. (line 9)
8452 * C-c a C: Storing searches. (line 9)
8453 * C-c a e: Exporting Agenda Views.
8455 * C-c a L: Timeline. (line 10)
8456 * C-c a M <1>: Tag searches. (line 17)
8457 * C-c a M: Matching tags and properties.
8459 * C-c a m <1>: Tag searches. (line 13)
8460 * C-c a m: Matching tags and properties.
8462 * C-c a t <1>: Global TODO list. (line 9)
8463 * C-c a t: TODO basics. (line 49)
8464 * C-c a T: Global TODO list. (line 14)
8465 * C-c C-a: Visibility cycling. (line 33)
8466 * C-c C-b: Motion. (line 15)
8467 * C-c C-c <1>: TODO basics. (line 30)
8468 * C-c C-c <2>: Cooperation. (line 37)
8469 * C-c C-c <3>: The very busy C-c C-c key.
8471 * C-c C-c <4>: Processing LaTeX fragments.
8473 * C-c C-c <5>: Plain lists. (line 81)
8474 * C-c C-c <6>: Built-in table editor.
8476 * C-c C-c <7>: Clocking work time. (line 89)
8477 * C-c C-c <8>: Editing and debugging formulas.
8479 * C-c C-c <9>: Capturing Column View.
8481 * C-c C-c <10>: Using column view. (line 39)
8482 * C-c C-c <11>: Editing and debugging formulas.
8484 * C-c C-c <12>: Property syntax. (line 58)
8485 * C-c C-c <13>: Setting tags. (line 10)
8486 * C-c C-c: Checkboxes. (line 37)
8487 * C-c C-d <1>: Inserting deadline/schedule.
8489 * C-c C-d: Agenda commands. (line 158)
8490 * C-c C-e: Exporting. (line 20)
8491 * C-c C-e a: ASCII export. (line 9)
8492 * C-c C-e b: HTML Export commands.
8494 * C-c C-e c: iCalendar export. (line 21)
8495 * C-c C-e h: HTML Export commands.
8497 * C-c C-e H: HTML Export commands.
8499 * C-c C-e i: iCalendar export. (line 14)
8500 * C-c C-e I: iCalendar export. (line 16)
8501 * C-c C-e L: LaTeX export commands.
8503 * C-c C-e l: LaTeX export commands.
8505 * C-c C-e R: HTML Export commands.
8507 * C-c C-e t: Export options. (line 13)
8508 * C-c C-e v <1>: XOXO export. (line 11)
8509 * C-c C-e v: Sparse trees. (line 46)
8510 * C-c C-e v a: ASCII export. (line 16)
8511 * C-c C-e v b: HTML Export commands.
8513 * C-c C-e v H: HTML Export commands.
8515 * C-c C-e v h: HTML Export commands.
8517 * C-c C-e v l: LaTeX export commands.
8519 * C-c C-e v L: LaTeX export commands.
8521 * C-c C-e v R: HTML Export commands.
8523 * C-c C-e x: XOXO export. (line 10)
8524 * C-c C-f: Motion. (line 12)
8525 * C-c C-j: Motion. (line 21)
8526 * C-c C-l: Handling links. (line 25)
8527 * C-c C-n: Motion. (line 8)
8528 * C-c C-o <1>: Creating timestamps. (line 31)
8529 * C-c C-o: Handling links. (line 59)
8530 * C-c C-p: Motion. (line 9)
8531 * C-c C-q <1>: Built-in table editor.
8533 * C-c C-q: Editing and debugging formulas.
8535 * C-c C-r <1>: Visibility cycling. (line 34)
8536 * C-c C-r: Editing and debugging formulas.
8538 * C-c C-s <1>: Inserting deadline/schedule.
8540 * C-c C-s: Agenda commands. (line 155)
8541 * C-c C-t <1>: Clocking work time. (line 30)
8542 * C-c C-t: TODO basics. (line 13)
8543 * C-c C-u: Motion. (line 18)
8544 * C-c C-v: TODO basics. (line 38)
8545 * C-c C-w <1>: Structure editing. (line 58)
8546 * C-c C-w: Refiling notes. (line 13)
8547 * C-c C-x b: Visibility cycling. (line 41)
8548 * C-c C-x C-a: ARCHIVE tag. (line 28)
8549 * C-c C-x C-b: Checkboxes. (line 39)
8550 * C-c C-x C-c <1>: Agenda commands. (line 223)
8551 * C-c C-x C-c: Using column view. (line 9)
8552 * C-c C-x C-d: Clocking work time. (line 42)
8553 * C-c C-x C-i: Clocking work time. (line 12)
8554 * C-c C-x C-j: Clocking work time. (line 38)
8555 * C-c C-x C-k: Structure editing. (line 43)
8556 * C-c C-x C-l: Processing LaTeX fragments.
8558 * C-c C-x C-n: Handling links. (line 92)
8559 * C-c C-x C-o: Clocking work time. (line 17)
8560 * C-c C-x C-p: Handling links. (line 92)
8561 * C-c C-x C-r: Clocking work time. (line 50)
8562 * C-c C-x C-s: Moving subtrees. (line 10)
8563 * C-c C-x C-t: Custom time format. (line 12)
8564 * C-c C-x C-u <1>: Clocking work time. (line 91)
8565 * C-c C-x C-u <2>: Dynamic blocks. (line 21)
8566 * C-c C-x C-u: Capturing Column View.
8568 * C-c C-x C-w <1>: Built-in table editor.
8570 * C-c C-x C-w: Structure editing. (line 43)
8571 * C-c C-x C-x: Clocking work time. (line 34)
8572 * C-c C-x C-y <1>: Built-in table editor.
8574 * C-c C-x C-y: Structure editing. (line 52)
8575 * C-c C-x M-w <1>: Structure editing. (line 48)
8576 * C-c C-x M-w: Built-in table editor.
8578 * C-c C-x p: Property syntax. (line 49)
8579 * C-c C-x r: Capturing Column View.
8581 * C-c C-y <1>: Creating timestamps. (line 48)
8582 * C-c C-y: Clocking work time. (line 25)
8583 * C-c l: Handling links. (line 9)
8584 * C-c { <1>: CDLaTeX mode. (line 21)
8585 * C-c {: Editing and debugging formulas.
8587 * C-c |: Built-in table editor.
8589 * C-c }: Editing and debugging formulas.
8591 * C-c ~: Cooperation. (line 48)
8592 * C-k: Agenda commands. (line 116)
8593 * C-S-<left>: Multiple sets in one file.
8595 * C-S-<right>: Multiple sets in one file.
8597 * C-TAB: ARCHIVE tag. (line 38)
8598 * C-u C-c *: Updating the table. (line 16)
8599 * C-u C-c .: Creating timestamps. (line 14)
8600 * C-u C-c = <1>: Field formulas. (line 24)
8601 * C-u C-c =: Editing and debugging formulas.
8603 * C-u C-c C-c: Updating the table. (line 19)
8604 * C-u C-c C-l: Handling links. (line 44)
8605 * C-u C-c C-t: TODO basics. (line 22)
8606 * C-u C-c C-x C-a: ARCHIVE tag. (line 31)
8607 * C-u C-c C-x C-s: Moving subtrees. (line 14)
8608 * C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
8609 * C-u C-c C-x C-u <2>: Clocking work time. (line 93)
8610 * C-u C-c C-x C-u: Capturing Column View.
8612 * C-u C-u C-c *: Updating the table. (line 22)
8613 * C-u C-u C-c =: Editing and debugging formulas.
8615 * C-u C-u C-c C-c: Updating the table. (line 22)
8616 * C-x C-s <1>: Agenda commands. (line 87)
8617 * C-x C-s: Editing and debugging formulas.
8619 * C-x C-w <1>: Agenda commands. (line 232)
8620 * C-x C-w: Exporting Agenda Views.
8622 * D: Agenda commands. (line 72)
8623 * d: Agenda commands. (line 66)
8624 * e: Using column view. (line 33)
8625 * f: Agenda commands. (line 42)
8626 * g: Agenda commands. (line 76)
8627 * H: Agenda commands. (line 220)
8628 * I: Agenda commands. (line 178)
8629 * i: Agenda commands. (line 201)
8630 * J: Agenda commands. (line 190)
8631 * L: Agenda commands. (line 30)
8632 * l: Agenda commands. (line 55)
8633 * M: Agenda commands. (line 207)
8634 * m: Agenda commands. (line 66)
8635 * M-<down> <1>: Editing and debugging formulas.
8637 * M-<down>: Built-in table editor.
8639 * M-<left> <1>: Structure editing. (line 25)
8640 * M-<left>: Built-in table editor.
8642 * M-<RET> <1>: Plain lists. (line 49)
8643 * M-<RET>: Structure editing. (line 6)
8644 * M-<right> <1>: Structure editing. (line 28)
8645 * M-<right>: Built-in table editor.
8647 * M-<TAB> <1>: Completion. (line 10)
8648 * M-<TAB> <2>: Property syntax. (line 46)
8649 * M-<TAB> <3>: Setting tags. (line 6)
8650 * M-<TAB> <4>: Per file keywords. (line 23)
8651 * M-<TAB>: Editing and debugging formulas.
8653 * M-<up> <1>: Built-in table editor.
8655 * M-<up>: Editing and debugging formulas.
8657 * M-S-<down> <1>: Built-in table editor.
8659 * M-S-<down> <2>: Editing and debugging formulas.
8661 * M-S-<down> <3>: Plain lists. (line 66)
8662 * M-S-<down>: Structure editing. (line 40)
8663 * M-S-<left> <1>: Plain lists. (line 72)
8664 * M-S-<left> <2>: Built-in table editor.
8666 * M-S-<left> <3>: Structure editing. (line 31)
8667 * M-S-<left>: The date/time prompt.
8669 * M-S-<RET> <1>: Checkboxes. (line 54)
8670 * M-S-<RET> <2>: Plain lists. (line 59)
8671 * M-S-<RET>: Structure editing. (line 22)
8672 * M-S-<right> <1>: The date/time prompt.
8674 * M-S-<right> <2>: Plain lists. (line 72)
8675 * M-S-<right> <3>: Structure editing. (line 34)
8676 * M-S-<right>: Built-in table editor.
8678 * M-S-<up> <1>: Structure editing. (line 37)
8679 * M-S-<up> <2>: Plain lists. (line 66)
8680 * M-S-<up> <3>: Built-in table editor.
8682 * M-S-<up>: Editing and debugging formulas.
8684 * mouse-1 <1>: Agenda commands. (line 33)
8685 * mouse-1 <2>: Handling links. (line 73)
8686 * mouse-1: The date/time prompt.
8688 * mouse-2 <1>: Handling links. (line 73)
8689 * mouse-2: Agenda commands. (line 33)
8690 * mouse-3 <1>: Agenda commands. (line 28)
8691 * mouse-3: Handling links. (line 78)
8692 * n <1>: Agenda commands. (line 19)
8693 * n: Using column view. (line 30)
8694 * O: Agenda commands. (line 182)
8695 * o: Agenda commands. (line 65)
8696 * p <1>: Using column view. (line 30)
8697 * p: Agenda commands. (line 20)
8698 * P: Agenda commands. (line 142)
8699 * q <1>: Agenda commands. (line 243)
8700 * q: Using column view. (line 17)
8701 * r <1>: Global TODO list. (line 22)
8702 * r: Agenda commands. (line 80)
8703 * S: Agenda commands. (line 211)
8704 * s: Agenda commands. (line 87)
8705 * S-<down> <1>: The date/time prompt.
8707 * S-<down> <2>: Creating timestamps. (line 40)
8708 * S-<down> <3>: Plain lists. (line 62)
8709 * S-<down> <4>: Editing and debugging formulas.
8711 * S-<down> <5>: Agenda commands. (line 151)
8712 * S-<down>: Priorities. (line 23)
8713 * S-<left> <1>: The date/time prompt.
8715 * S-<left> <2>: Agenda commands. (line 169)
8716 * S-<left> <3>: Creating timestamps. (line 35)
8717 * S-<left> <4>: TODO basics. (line 26)
8718 * S-<left> <5>: Multiple sets in one file.
8720 * S-<left> <6>: Using column view. (line 26)
8721 * S-<left> <7>: Property syntax. (line 66)
8722 * S-<left>: Editing and debugging formulas.
8724 * S-<RET>: Built-in table editor.
8726 * S-<right> <1>: Editing and debugging formulas.
8728 * S-<right> <2>: Multiple sets in one file.
8730 * S-<right> <3>: TODO basics. (line 26)
8731 * S-<right> <4>: Creating timestamps. (line 35)
8732 * S-<right> <5>: Using column view. (line 26)
8733 * S-<right> <6>: The date/time prompt.
8735 * S-<right> <7>: Agenda commands. (line 161)
8736 * S-<right>: Property syntax. (line 66)
8737 * S-<TAB> <1>: Visibility cycling. (line 22)
8738 * S-<TAB>: Built-in table editor.
8740 * S-<up> <1>: Plain lists. (line 62)
8741 * S-<up> <2>: The date/time prompt.
8743 * S-<up> <3>: Editing and debugging formulas.
8745 * S-<up> <4>: Creating timestamps. (line 40)
8746 * S-<up> <5>: Agenda commands. (line 145)
8747 * S-<up>: Priorities. (line 23)
8748 * S-M-<left>: Using column view. (line 61)
8749 * S-M-<RET>: TODO basics. (line 57)
8750 * S-M-<right>: Using column view. (line 58)
8751 * T: Agenda commands. (line 125)
8752 * t: Agenda commands. (line 112)
8753 * v: Using column view. (line 42)
8754 * w: Agenda commands. (line 66)
8755 * x: Agenda commands. (line 244)
8756 * X: Agenda commands. (line 185)
8757 * y: Agenda commands. (line 66)
8763 Node: Introduction
\x7f13509
8764 Node: Summary
\x7f13995
8765 Node: Installation
\x7f17132
8766 Node: Activation
\x7f18510
8767 Node: Feedback
\x7f19747
8768 Node: Conventions
\x7f21836
8769 Node: Document structure
\x7f22528
8770 Node: Outlines
\x7f23420
8771 Node: Headlines
\x7f24085
8772 Ref: Headlines-Footnote-1
\x7f25089
8773 Node: Visibility cycling
\x7f25200
8774 Ref: Visibility cycling-Footnote-1
\x7f27410
8775 Ref: Visibility cycling-Footnote-2
\x7f27468
8776 Ref: Visibility cycling-Footnote-3
\x7f27518
8777 Node: Motion
\x7f27788
8778 Node: Structure editing
\x7f28742
8779 Node: Archiving
\x7f31990
8780 Node: ARCHIVE tag
\x7f32548
8781 Node: Moving subtrees
\x7f34341
8782 Ref: Moving subtrees-Footnote-1
\x7f35888
8783 Node: Sparse trees
\x7f36332
8784 Ref: Sparse trees-Footnote-1
\x7f38604
8785 Ref: Sparse trees-Footnote-2
\x7f38786
8786 Node: Plain lists
\x7f38901
8787 Ref: Plain lists-Footnote-1
\x7f43098
8788 Ref: Plain lists-Footnote-2
\x7f43456
8789 Node: Drawers
\x7f43637
8790 Ref: Drawers-Footnote-1
\x7f44514
8791 Node: orgstruct-mode
\x7f44620
8792 Node: Tables
\x7f45520
8793 Node: Built-in table editor
\x7f46101
8794 Node: Narrow columns
\x7f53518
8795 Ref: Narrow columns-Footnote-1
\x7f55453
8796 Node: Column groups
\x7f55499
8797 Node: orgtbl-mode
\x7f57032
8798 Node: The spreadsheet
\x7f57835
8799 Node: References
\x7f58922
8800 Ref: References-Footnote-1
\x7f63389
8801 Ref: References-Footnote-2
\x7f63530
8802 Node: Formula syntax for Calc
\x7f63819
8803 Node: Formula syntax for Lisp
\x7f66276
8804 Node: Field formulas
\x7f67994
8805 Node: Column formulas
\x7f69302
8806 Node: Editing and debugging formulas
\x7f70901
8807 Node: Updating the table
\x7f75054
8808 Node: Advanced features
\x7f76107
8809 Node: Hyperlinks
\x7f80632
8810 Node: Link format
\x7f81410
8811 Node: Internal links
\x7f82703
8812 Ref: Internal links-Footnote-1
\x7f84628
8813 Node: Radio targets
\x7f84763
8814 Node: External links
\x7f85463
8815 Node: Handling links
\x7f87867
8816 Ref: Handling links-Footnote-1
\x7f93183
8817 Ref: Handling links-Footnote-2
\x7f93420
8818 Node: Using links outside Org-mode
\x7f93494
8819 Node: Link abbreviations
\x7f94004
8820 Node: Search options
\x7f95697
8821 Ref: Search options-Footnote-1
\x7f97477
8822 Node: Custom searches
\x7f97558
8823 Node: TODO items
\x7f98589
8824 Node: TODO basics
\x7f99627
8825 Node: TODO extensions
\x7f101842
8826 Node: Workflow states
\x7f102786
8827 Ref: Workflow states-Footnote-1
\x7f103961
8828 Node: TODO types
\x7f104054
8829 Ref: TODO types-Footnote-1
\x7f105637
8830 Node: Multiple sets in one file
\x7f105719
8831 Node: Fast access to TODO states
\x7f107339
8832 Node: Per file keywords
\x7f108482
8833 Ref: Per file keywords-Footnote-1
\x7f109784
8834 Node: Faces for TODO keywords
\x7f109985
8835 Node: Progress logging
\x7f110691
8836 Node: Closing items
\x7f111122
8837 Ref: Closing items-Footnote-1
\x7f112056
8838 Ref: Closing items-Footnote-2
\x7f112261
8839 Node: Tracking TODO state changes
\x7f112334
8840 Ref: Tracking TODO state changes-Footnote-1
\x7f113519
8841 Node: Priorities
\x7f113594
8842 Ref: Priorities-Footnote-1
\x7f115244
8843 Node: Breaking down tasks
\x7f115314
8844 Ref: Breaking down tasks-Footnote-1
\x7f115834
8845 Node: Checkboxes
\x7f115930
8846 Node: Tags
\x7f118779
8847 Node: Tag inheritance
\x7f119551
8848 Node: Setting tags
\x7f120488
8849 Ref: Setting tags-Footnote-1
\x7f125011
8850 Ref: Setting tags-Footnote-2
\x7f125123
8851 Node: Tag searches
\x7f125206
8852 Node: Properties and columns
\x7f127982
8853 Node: Property syntax
\x7f129153
8854 Node: Special properties
\x7f131843
8855 Node: Property searches
\x7f132914
8856 Node: Property inheritance
\x7f134175
8857 Node: Column view
\x7f135622
8858 Node: Defining columns
\x7f136856
8859 Node: Scope of column definitions
\x7f137254
8860 Node: Column attributes
\x7f138176
8861 Node: Using column view
\x7f140572
8862 Node: Capturing Column View
\x7f142653
8863 Node: Property API
\x7f144380
8864 Node: Dates and times
\x7f144734
8865 Node: Time stamps
\x7f145463
8866 Ref: Time stamps-Footnote-1
\x7f147827
8867 Node: Creating timestamps
\x7f147943
8868 Node: The date/time prompt
\x7f150022
8869 Ref: The date/time prompt-Footnote-1
\x7f153378
8870 Ref: The date/time prompt-Footnote-2
\x7f153434
8871 Ref: The date/time prompt-Footnote-3
\x7f153540
8872 Node: Custom time format
\x7f153633
8873 Node: Deadlines and scheduling
\x7f155325
8874 Ref: Deadlines and scheduling-Footnote-1
\x7f157403
8875 Node: Inserting deadline/schedule
\x7f157558
8876 Node: Repeated tasks
\x7f158676
8877 Ref: Repeated tasks-Footnote-1
\x7f160354
8878 Node: Clocking work time
\x7f160475
8879 Ref: Clocking work time-Footnote-1
\x7f165327
8880 Ref: Clocking work time-Footnote-2
\x7f165405
8881 Node: Remember
\x7f165531
8882 Node: Setting up remember
\x7f166477
8883 Ref: Setting up remember-Footnote-1
\x7f167386
8884 Node: Remember templates
\x7f167452
8885 Ref: Remember templates-Footnote-1
\x7f171091
8886 Ref: Remember templates-Footnote-2
\x7f171274
8887 Node: Storing notes
\x7f171372
8888 Ref: Storing notes-Footnote-1
\x7f173883
8889 Node: Refiling notes
\x7f173985
8890 Node: Agenda views
\x7f175250
8891 Node: Agenda files
\x7f177201
8892 Ref: Agenda files-Footnote-1
\x7f178289
8893 Ref: Agenda files-Footnote-2
\x7f178438
8894 Node: Agenda dispatcher
\x7f178631
8895 Ref: Agenda dispatcher-Footnote-1
\x7f180685
8896 Ref: Agenda dispatcher-Footnote-2
\x7f180779
8897 Node: Built-in agenda views
\x7f180873
8898 Node: Weekly/Daily agenda
\x7f181455
8899 Ref: Weekly/Daily agenda-Footnote-1
\x7f184753
8900 Node: Global TODO list
\x7f184957
8901 Node: Matching tags and properties
\x7f187237
8902 Node: Timeline
\x7f188328
8903 Node: Stuck projects
\x7f189002
8904 Node: Presentation and sorting
\x7f190855
8905 Node: Categories
\x7f191648
8906 Ref: Categories-Footnote-1
\x7f192359
8907 Node: Time-of-day specifications
\x7f192796
8908 Node: Sorting of agenda items
\x7f194769
8909 Node: Agenda commands
\x7f196053
8910 Node: Custom agenda views
\x7f203516
8911 Node: Storing searches
\x7f204237
8912 Ref: Storing searches-Footnote-1
\x7f206771
8913 Node: Block agenda
\x7f206888
8914 Node: Setting Options
\x7f208120
8915 Node: Exporting Agenda Views
\x7f210861
8916 Ref: Exporting Agenda Views-Footnote-1
\x7f215218
8917 Ref: Exporting Agenda Views-Footnote-2
\x7f215275
8918 Node: Extracting Agenda Information for other programs
\x7f215461
8919 Node: Embedded LaTeX
\x7f219589
8920 Ref: Embedded LaTeX-Footnote-1
\x7f220683
8921 Node: Math symbols
\x7f220873
8922 Node: Subscripts and Superscripts
\x7f221640
8923 Node: LaTeX fragments
\x7f222486
8924 Ref: LaTeX fragments-Footnote-1
\x7f224719
8925 Ref: LaTeX fragments-Footnote-2
\x7f224980
8926 Node: Processing LaTeX fragments
\x7f225114
8927 Node: CDLaTeX mode
\x7f226062
8928 Ref: CDLaTeX mode-Footnote-1
\x7f228548
8929 Node: Exporting
\x7f228696
8930 Node: ASCII export
\x7f230163
8931 Node: HTML export
\x7f231664
8932 Node: HTML Export commands
\x7f232290
8933 Node: Quoting HTML tags
\x7f234077
8934 Node: Links
\x7f234712
8935 Node: Images
\x7f235409
8936 Ref: Images-Footnote-1
\x7f236280
8937 Node: CSS support
\x7f236341
8938 Ref: CSS support-Footnote-1
\x7f237660
8939 Node: LaTeX export
\x7f237773
8940 Node: LaTeX export commands
\x7f238122
8941 Node: Quoting LaTeX code
\x7f239284
8942 Node: Sectioning structure
\x7f239818
8943 Node: XOXO export
\x7f240319
8944 Node: iCalendar export
\x7f240759
8945 Node: Text interpretation
\x7f242228
8946 Node: Comment lines
\x7f242883
8947 Node: Initial text
\x7f243278
8948 Node: Footnotes
\x7f244947
8949 Node: Quoted examples
\x7f245739
8950 Node: Enhancing text
\x7f246514
8951 Node: Export options
\x7f248963
8952 Node: Publishing
\x7f251424
8953 Ref: Publishing-Footnote-1
\x7f252385
8954 Ref: Publishing-Footnote-2
\x7f252529
8955 Node: Configuration
\x7f252680
8956 Node: Project alist
\x7f253398
8957 Node: Sources and destinations
\x7f254464
8958 Node: Selecting files
\x7f255194
8959 Node: Publishing action
\x7f255942
8960 Node: Publishing options
\x7f257276
8961 Node: Publishing links
\x7f259782
8962 Node: Project page index
\x7f261297
8963 Node: Sample configuration
\x7f262075
8964 Node: Simple example
\x7f262567
8965 Node: Complex example
\x7f263240
8966 Node: Triggering publication
\x7f265316
8967 Node: Miscellaneous
\x7f266001
8968 Node: Completion
\x7f266635
8969 Node: Customization
\x7f268305
8970 Node: In-buffer settings
\x7f268888
8971 Node: The very busy C-c C-c key
\x7f274558
8972 Node: Clean view
\x7f276413
8973 Node: TTY keys
\x7f278990
8974 Node: Interaction
\x7f280600
8975 Node: Cooperation
\x7f280997
8976 Node: Conflicts
\x7f283873
8977 Node: Bugs
\x7f285883
8978 Node: Extensions and Hacking
\x7f287379
8979 Node: Extensions
\x7f288104
8980 Node: Adding hyperlink types
\x7f290366
8981 Node: Tables in arbitrary syntax
\x7f294028
8982 Node: Radio tables
\x7f295420
8983 Node: A LaTeX example
\x7f297923
8984 Ref: A LaTeX example-Footnote-1
\x7f301601
8985 Ref: A LaTeX example-Footnote-2
\x7f301749
8986 Node: Translator functions
\x7f302184
8987 Ref: Translator functions-Footnote-1
\x7f305313
8988 Node: Radio lists
\x7f305401
8989 Ref: Radio lists-Footnote-1
\x7f306523
8990 Node: Dynamic blocks
\x7f306643
8991 Node: Special agenda views
\x7f308615
8992 Node: Using the property API
\x7f311860
8993 Node: History and Acknowledgments
\x7f313458
8994 Node: Index
\x7f320019
8995 Node: Key Index
\x7f356451