1 This is org, produced by makeinfo version 4.8 from org.texi.
5 * Org Mode: (org). outline-based notes management and organizer
8 This manual is for Org-mode (version 4.43).
10 Copyright (C) 2004, 2005, 2006 Free Software Foundation
12 Permission is granted to copy, distribute and/or modify this
13 document under the terms of the GNU Free Documentation License,
14 Version 1.1 or any later version published by the Free Software
15 Foundation; with no Invariant Sections, with the Front-Cover texts
16 being "A GNU Manual," and with the Back-Cover Texts as in (a)
17 below. A copy of the license is included in the section entitled
18 "GNU Free Documentation License."
20 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
21 modify this GNU Manual, like GNU software. Copies published by
22 the Free Software Foundation raise funds for GNU development."
25 File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
30 This manual is for Org-mode (version 4.43).
32 Copyright (C) 2004, 2005, 2006 Free Software Foundation
34 Permission is granted to copy, distribute and/or modify this
35 document under the terms of the GNU Free Documentation License,
36 Version 1.1 or any later version published by the Free Software
37 Foundation; with no Invariant Sections, with the Front-Cover texts
38 being "A GNU Manual," and with the Back-Cover Texts as in (a)
39 below. A copy of the license is included in the section entitled
40 "GNU Free Documentation License."
42 (a) The FSF's Back-Cover Text is: "You have freedom to copy and
43 modify this GNU Manual, like GNU software. Copies published by
44 the Free Software Foundation raise funds for GNU development."
48 * Introduction:: Getting started
49 * Document structure:: A tree works like your brain
50 * Tables:: Pure magic for quick formatting
51 * Hyperlinks:: Notes in context
52 * TODO items:: Every tree branch can be a TODO item
53 * Timestamps:: Assign date and time to items
54 * Tags:: Tagging headlines and matching sets of tags
55 * Agenda views:: Collecting information into views
56 * Embedded LaTeX:: LaTeX fragments and formulas
57 * Exporting:: Sharing and publishing of notes
58 * Publishing:: Create a web site of linked Org-mode files
59 * Miscellaneous:: All the rest which did not fit elsewhere
60 * Extensions and Hacking:: It is possible to write add-on code
61 * History and Acknowledgments:: How Org-mode came into being
62 * Index:: The fast road to specific information
63 * Key Index:: Key bindings and where they are described
65 --- The Detailed Node Listing ---
69 * Summary:: Brief summary of what Org-mode does
70 * Installation:: How to install Org-mode
71 * Feedback:: Bug reports, ideas, patches etc.
75 * Outlines:: Org-mode is based on outline-mode
76 * Headlines:: How to typeset org-tree headlines
77 * Visibility cycling:: Show and hide, much simplified
78 * Motion:: Jumping to other headlines
79 * Structure editing:: Changing sequence and level of headlines
80 * Archiving:: Move done task trees to a different place
81 * Sparse trees:: Matches embedded in context
82 * Plain lists:: Editing hand-formatted lists
83 * Checkboxes:: Easily checking off things.
87 * ARCHIVE tag:: Marking a tree as inactive
88 * Moving subtrees:: Moving a tree to an archive file
92 * Built-in table editor:: Simple tables
93 * Narrow columns:: Stop wasting space in tables
94 * Table calculations:: Compute a field from other fields
95 * orgtbl-mode:: The table editor as minor mode
96 * table.el:: Complex tables
98 Calculations in tables
100 * Formula syntax:: How to write a formula
101 * Lisp formulas:: An alternative way to write formulas
102 * Column formulas:: Formulas valid for all fields in a column
103 * Advanced features:: Field names, parameters and automatic recalc
104 * Named-field formulas:: Formulas valid in single fields
105 * Editing/debugging formulas:: Changing a stored formula
106 * Appetizer:: Taste the power of calc
110 * Link format:: How links in Org-mode are formatted
111 * Internal links:: Links to other places in the current file
112 * External links:: URL-like links to the world
113 * Handling links:: Creating, inserting and following
114 * Search options:: Linking to a specific location
115 * Custom searches:: When the default search is not enough
116 * Remember:: Org-trees store quick notes
120 * Radio targets:: Make targets trigger links in plain text.
121 * CamelCase links:: Activating CamelCase words as links
125 * TODO basics:: Marking and displaying TODO entries
126 * TODO extensions:: Workflow and assignments
127 * Priorities:: Some things are more important than others
129 Extended use of TODO keywords
131 * Workflow states:: From TODO to DONE in steps
132 * TODO types:: I do this, Fred the rest
133 * Per file keywords:: Different files, different requirements
137 * Time stamps:: Assigning a time to a tree entry
138 * Creating timestamps:: Commands which insert timestamps
139 * Progress logging:: Documenting when what work was done.
143 * Closing items:: When was this entry marked DONE?
144 * Clocking work time:: When exactly did you work on this item?
148 * Tag inheritance:: Tags use the tree structure of the outline
149 * Setting tags:: How to assign tags to a headline
150 * Tag searches:: Searching for combinations of tags
154 * Agenda files:: Files being searched for agenda information
155 * Agenda dispatcher:: Keyboard access to agenda views
156 * Weekly/Daily agenda:: The calendar page with current tasks
157 * Global TODO list:: All unfinished action items
158 * Matching headline tags:: Structured information with fine-tuned search
159 * Timeline:: Time-sorted view for single file
160 * Agenda commands:: Remote editing of org trees
162 The weekly/daily agenda
164 * Categories:: Not all tasks are equal
165 * Time-of-day specifications:: How the agenda knows the time
166 * Calendar/Diary integration:: Integrating Anniversaries and more
167 * Sorting of agenda items:: The order of things
171 * Math symbols:: TeX macros for symbols and Greek letters
172 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
173 * LaTeX fragments:: Complex formulas made easy
174 * Processing LaTeX fragments:: Previewing LaTeX processing
175 * CDLaTeX mode:: Speed up entering of formulas
179 * ASCII export:: Exporting to plain ASCII
180 * HTML export:: Exporting to HTML
181 * XOXO export:: Exporting to XOXO
182 * iCalendar export:: Exporting in iCalendar format
183 * Text interpretation:: How the exporter looks at the file
185 Text interpretation by the exporter
187 * Comment lines:: Some lines will not be exported
188 * Enhancing text:: Subscripts, symbols and more
189 * Export options:: How to influence the export settings
193 * Configuration:: Defining projects
194 * Sample configuration:: Example projects
195 * Triggering publication:: Publication commands
199 * Project alist:: The central configuration variable
200 * Sources and destinations:: From here to there
201 * Selecting files:: What files are part of the project?
202 * Publishing action:: Setting the function doing the publishing
203 * Publishing options:: Tweaking HTML export
204 * Publishing links:: Which links keep working after publishing?
205 * Project page index:: Publishing a list of project files
209 * Simple example:: One-component publishing
210 * Complex example:: A multi-component publishing example
214 * Completion:: M-TAB knows what you need
215 * Customization:: Adapting Org-mode to your taste
216 * In-buffer settings:: Overview of the #+KEYWORDS
217 * The very busy C-c C-c key:: When in doubt, press C-c C-c
218 * Clean view:: Getting rid of leading stars in the outline
219 * TTY keys:: Using Org-mode on a tty
220 * Interaction:: Other Emacs packages
221 * Bugs:: Things which do not work perfectly
223 Interaction with other packages
225 * Cooperation:: Packages Org-mode cooperates with
226 * Conflicts:: Packages that lead to conflicts
228 Extensions, Hooks and Hacking
230 * Extensions:: Existing 3rd-part extensions
231 * Dynamic blocks:: Automatically filled blocks
234 File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
241 * Summary:: Brief summary of what Org-mode does
242 * Installation:: How to install Org-mode
243 * Feedback:: Bug reports, ideas, patches etc.
246 File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
251 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
252 project planning with a fast and effective plain-text system.
254 Org-mode develops organizational tasks around NOTES files that
255 contain information about projects as plain text. Org-mode is
256 implemented on top of outline-mode, which makes it possible to keep the
257 content of large files well structured. Visibility cycling and
258 structure editing help to work with the tree. Tables are easily
259 created with a built-in table editor. Org-mode supports ToDo items,
260 deadlines, time stamps, and scheduling. It dynamically compiles
261 entries into an agenda that utilizes and smoothly integrates much of
262 the Emacs calendar and diary. Plain text URL-like links connect to
263 websites, emails, Usenet messages, BBDB entries, and any files related
264 to the projects. For printing and sharing of notes, an Org-mode file
265 can be exported as a structured ASCII file, as HTML, or (todo and
266 agenda items only) as an iCalendar file. It can also serve as a
267 publishing tool for a set of linked webpages.
269 Org-mode keeps simple things simple. When first fired up, it should
270 feel like a straightforward, easy to use outliner. Complexity is not
271 imposed, but a large amount of functionality is available when you need
272 it. Org-mode can be used on different levels and in different ways, for
275 * as an outline extension with visibility cycling and structure editing
276 * as an ASCII system and table editor for taking structured notes
277 * as an ASCII table editor with spreadsheet-like capabilities
278 * as a TODO list editor
279 * as a full agenda and planner with deadlines and work scheduling
280 * as a simple hypertext system, with HTML export
281 * as a publishing tool to create a set of interlinked webpages
283 The Org-mode table editor can be integrated into any major mode by
284 activating the minor Orgtbl-mode.
286 There is a website for Org-mode which provides links to the newest
287 version of Org-mode, as well as additional information, frequently asked
288 questions (FAQ), links to tutorials etc. This page is located at
289 `http://www.astro.uva.nl/~dominik/Tools/org/'.
292 File: org, Node: Installation, Next: Feedback, Prev: Summary, Up: Introduction
294 1.2 Installation and Activation
295 ===============================
297 If Org-mode is part of the Emacs distribution or an XEmacs package, you
298 only need to copy the following lines to your `.emacs' file. The last
299 two lines define _global_ keys for the commands `org-store-link' and
300 `org-agenda' - please choose suitable keys yourself.
302 ;; The following lines are always needed. Choose your own keys.
303 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
304 (define-key global-map "\C-cl" 'org-store-link)
305 (define-key global-map "\C-ca" 'org-agenda)
307 Furthermore, you must activate `font-lock-mode' in org-mode buffers,
308 because significant functionality depends on font-locking being active.
309 You can do this with either one of the following two lines:
310 (global-font-lock-mode 1) ; for all buffers
311 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
313 If you have downloaded Org-mode from the Web, you must take
314 additional action: Byte-compile `org.el' and `org-publish.el' and put
315 them together with `org-install.el' on your load path. Then add to
318 ;; This line only if org-mode is not part of the X/Emacs distribution.
319 (require 'org-install)
321 If you use Org-mode with XEmacs, you also need to install the file
322 `noutline.el' from the `xemacs' subdirectory of the Org-mode
325 With this setup, all files with extension `.org' will be put into
326 Org-mode. As an alternative, make the first line of a file look like
329 MY PROJECTS -*- mode: org; -*-
331 which will select Org-mode for this buffer no matter what the file's
332 name is. See also the variable `org-insert-mode-line-in-empty-file'.
335 File: org, Node: Feedback, Prev: Installation, Up: Introduction
340 If you find problems with Org-mode, or if you have questions, remarks,
341 or ideas about it, please contact the maintainer Carsten Dominik at
342 <dominik@science.uva.nl>.
344 For bug reports, please provide as much information as possible,
345 including the version information of Emacs (`C-h v emacs-version
346 <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
347 Org-mode related setup in `.emacs'. If an error occurs, a traceback
348 can be very useful. Often a small example file helps, along with clear
351 1. What exactly did you do?
353 2. What did you expect to happen?
355 3. What happened instead?
356 Thank you for helping to improve this mode.
359 File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
364 Org-mode is based on outline mode and provides flexible commands to
365 edit the structure of the document.
369 * Outlines:: Org-mode is based on outline-mode
370 * Headlines:: How to typeset org-tree headlines
371 * Visibility cycling:: Show and hide, much simplified
372 * Motion:: Jumping to other headlines
373 * Structure editing:: Changing sequence and level of headlines
374 * Archiving:: Move done task trees to a different place
375 * Sparse trees:: Matches embedded in context
376 * Plain lists:: Editing hand-formatted lists
377 * Checkboxes:: Easily checking off things.
380 File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
385 Org-mode is implemented on top of outline-mode. Outlines allow to
386 organize a document in a hierarchical structure, which (at least for
387 me) is the best representation of notes and thoughts. Overview over
388 this structure is achieved by folding (hiding) large parts of the
389 document to show only the general document structure and the parts
390 currently being worked on. Org-mode greatly simplifies the use of
391 outlines by compressing the entire show/hide functionality into a
392 single command `org-cycle', which is bound to the <TAB> key.
395 File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
400 Headlines define the structure of an outline tree. The headlines in
401 Org-mode start with one or more stars, on the left margin. For example:
409 * Another top level headline
411 Some people find the many stars too noisy and would prefer an outline
412 that has whitespace followed by a single star as headline starters.
413 *Note Clean view:: describes a setup to realize this.
416 File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
418 2.3 Visibility cycling
419 ======================
421 Outlines make it possible to hide parts of the text in the buffer.
422 Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
423 the visibility in the buffer.
426 _Subtree cycling_: Rotate current subtree between the states
428 ,-> FOLDED -> CHILDREN -> SUBTREE --.
429 '-----------------------------------'
431 The cursor must be on a headline for this to work(1). When the
432 cursor is at the beginning of the buffer and the first line is not
433 a headline, then <TAB> actually runs global cycling (see
434 below)(2). Also when called with a prefix argument (`C-u <TAB>'),
435 global cycling is invoked.
439 _Global cycling_: Rotate the entire buffer between the states
441 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
442 '--------------------------------------'
444 Note that inside tables, `S-<TAB>' jumps to the previous field.
449 When Emacs first visits an Org-mode file, the global state is set to
450 OVERVIEW, i.e. only the top level headlines are visible. This can be
451 configured through the variable `org-startup-folded', or on a per-file
452 basis by adding one of the following lines anywhere in the buffer:
458 ---------- Footnotes ----------
460 (1) see, however, the option `org-cycle-emulate-tab'.
462 (2) see the option `org-cycle-global-at-bob'.
465 File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
470 The following commands jump to other headlines in the buffer.
479 Next heading same level.
482 Previous heading same level.
485 Backward to higher level heading.
488 Jump to a different place without changing the current outline
489 visibility. Shows the document structure in a temporary buffer,
490 where you can use visibility cycling (<TAB>) to find your
491 destination. After pressing <RET>, the cursor moves to the
492 selected location in the original buffer, and the headings
493 hierarchy above it is made visible.
496 File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
498 2.5 Structure editing
499 =====================
502 Insert new heading with same level as current. If the cursor is
503 in a plain list item, a new item is created (*note Plain lists::).
504 To force creation of a new headline, use a prefix arg, or first
505 press <RET> to get to the beginning of the next line. When this
506 command is used in the middle of a line, the line is split and the
507 rest of the line becomes the new headline. If the command is used
508 at the beginning of a headline, the new headline is created before
509 the current line. If at the beginning of any other line, the
510 content of that line is made the new heading.
513 Insert new TODO entry with same level as current heading.
516 Promote current heading by one level.
519 Demote current heading by one level.
522 Promote the current subtree by one level.
525 Demote the current subtree by one level.
528 Move subtree up (swap with previous subtree of same level).
531 Move subtree down (swap with next subtree of same level).
535 Kill subtree, i.e. remove it from buffer but save in kill ring.
538 Copy subtree to kill ring.
541 Yank subtree from kill ring. This does modify the level of the
542 subtree to make sure the tree fits in nicely at the yank position.
543 The yank level can also be specified with a prefix arg, or by
544 yanking after a headline marker like `****'.
546 When there is an active region (transient-mark-mode), promotion and
547 demotion work on all headlines in the region. To select a region of
548 headlines, it is best to place both point and mark at the beginning of a
549 line, mark at the beginning of the first headline, and point at the line
550 just after the last headline to change. Note that when the cursor is
551 inside a table (*note Tables::), the Meta-Cursor keys have different
555 File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
560 When a project represented by a (sub)tree is finished, you may want to
561 move the tree out of the way and to stop it from contributing to the
562 agenda. Org-mode knows two ways of archiving. You can mark a tree with
563 the ARCHIVE tag, or you can move an entire (sub)tree to a different
568 * ARCHIVE tag:: Marking a tree as inactive
569 * Moving subtrees:: Moving a tree to an archive file
572 File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Archiving
574 2.6.1 The ARCHIVE tag
575 ---------------------
577 A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
578 its location in the outline tree, but behaves in the following way:
579 - It does not open when you attempt to do so with a visibility
580 cycling command (*note Visibility cycling::). You can still open
581 it with a normal outline command like `show-all'. Or you can
582 modify the option `org-cycle-open-archived-trees'.
584 - During sparse tree construction (*note Sparse trees::), matches in
585 archived subtrees are not exposed, unless you configure the option
586 `org-sparse-tree-open-archived-trees'.
588 - During agenda view construction (*note Agenda views::), the
589 content of archived trees is ignored unless you configure the
590 option `org-agenda-skip-archived-trees'.
592 - Archived trees are not exported (*note Exporting::), only the
593 headline is. Configure the details using the variable
594 `org-export-with-archived-trees'.
596 The following commands allow to set or clear the ARCHIVE tag:
599 Toggle the ARCHIVE tag for the current headline. When the tag is
600 set, the headline changes to a shadowish face, and the subtree
604 Check if any direct children of the current headline should be
605 archived. To do this, each subtree is checked for open TODO
606 entries. If none are found, the command offers to set the ARCHIVE
607 tag for the child. If the cursor is _not_ on a headline when this
608 command is invoked, the level 1 trees will be checked.
611 File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
613 2.6.2 Moving subtrees
614 ---------------------
616 Once an entire project is finished, you may want to move it to a
617 different location, either in the current file, or even in a different
618 file, the archive file.
621 Archive the subtree starting at the cursor position to the location
622 given by `org-archive-location'.
625 Check if any direct children of the current headline could be
626 moved to the archive. To do this, each subtree is checked for
627 open TODO entries. If none are found, the command offers to move
628 it to the archive location. If the cursor is _not_ on a headline
629 when this command is invoked, the level 1 trees will be checked.
631 The default archive location is a file in the same directory as the
632 current file, with the name derived by appending `_archive' to the
633 current file name. For information and examples on how to change this,
634 see the documentation string of the variable `org-archive-location'.
637 File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
642 An important feature of Org-mode is the ability to construct _sparse
643 trees_ for selected information in an outline tree. A sparse tree
644 means that the entire document is folded as much as possible, but the
645 selected information is made visible along with the headline structure
646 above it(1). Just try it out and you will see immediately how it works.
648 Org-mode contains several commands creating such trees. The most
649 basic one is `org-occur':
652 Occur. Prompts for a regexp and shows a sparse tree with all
653 matches. If the match is in a headline, the headline is made
654 visible. If the match is in the body of an entry, headline and
655 body are made visible. In order to provide minimal context, also
656 the full hierarchy of headlines above the match is shown, as well
657 as the headline following the match. Each match is also
658 highlighted; the highlights disappear when the buffer is changed
659 with an editing command.
660 For frequently used sparse trees of specific search strings, you can
661 use the variable `org-agenda-custom-commands' to define fast keyboard
662 access to specific sparse trees. These commands will then be
663 accessible through the agenda dispatcher (*note Agenda dispatcher::).
666 (setq org-agenda-custom-commands
667 '(("f" occur-tree "FIXME")))
669 will define the key `C-c a f' as a shortcut for creating a sparse tree
670 matching the string `FIXME'.
672 Other commands use sparse trees as well. For example `C-c C-v'
673 creates a sparse TODO tree (*note TODO basics::).
675 To print a sparse tree, you can use the Emacs command
676 `ps-print-buffer-with-faces' which does not print invisible parts of
677 the document (2). Or you can use the command `C-c C-e v' to export
678 only the visible part of the document and print the resulting file.
680 ---------- Footnotes ----------
682 (1) See also the variables `org-show-hierarchy-above' and
683 `org-show-following-heading'.
685 (2) This does not work under XEmacs, because XEmacs uses selective
686 display for outlining, not text properties.
689 File: org, Node: Plain lists, Next: Checkboxes, Prev: Sparse trees, Up: Document structure
694 Headlines define both the structure of the Org-mode file, and also lists
695 (for example, TODO items (*note TODO items::) should be created using
696 headline levels). When taking notes, however, the plain text is
697 sometimes easier to read with hand-formatted lists. Org-mode supports
698 editing such lists, and the HTML exporter (*note Exporting::) does
699 parse and format them.
701 Org-mode knows ordered and unordered lists. Unordered list items
702 start with `-', `+', or `*'(1) as bullets. Ordered list items start
703 with `1.' or `1)'. Items belonging to the same list must have the same
704 indentation on the first line. In particular, if an ordered list
705 reaches number `10.', then the 2-digit numbers must be written
706 left-aligned with the other numbers in the list. Indentation also
707 determines the end of a list item. It ends before the next line that
708 is indented like the bullet/number, or less. For example:
711 My favorite scenes are (in this order)
712 1. Eowyns fight with the witch king
713 + this was already my favorite scene in the book
714 + I really like Miranda Otto.
715 2. The attack of the Rohirrim
716 3. Peter Jackson being shot by Legolas
718 He makes a really funny face when it happens.
719 But in the end, not individual scenes matter but the film as a whole.
721 Org-mode supports these lists by tuning filling and wrapping commands
722 to deal with them correctly.
724 The following commands act on items when the cursor is in the first
725 line of an item (the line with the bullet or number).
728 Items can be folded just like headline levels if you set the
729 variable `org-cycle-include-plain-lists'. The level of an item is
730 then given by the indentation of the bullet/number. Items are
731 always subordinate to real headlines, however; the hierarchies
732 remain completely separated.
735 Insert new item at current level. With prefix arg, force a new
736 heading (*note Structure editing::). If this command is used in
737 the middle of a line, the line is _split_ and the rest of the line
738 becomes the new item. If this command is executed in the
739 _whitespace before a bullet or number_, the new item is created
740 _before_ the current item. If the command is executed in the
741 white space before the text that is part of an item but does not
742 contain the bullet, a bullet is added to the current line.
745 Insert a new item with a checkbox (*note Checkboxes::).
749 Jump to the previous/next item in the current list.
753 Move the item including subitems up/down (swap with previous/next
754 item of same indentation). If the list is ordered, renumbering is
759 Decrease/increase the indentation of the item, including subitems.
760 Initially, the item tree is selected based on current indentation.
761 When these commands are executed several times in direct
762 succession, the initially selected region is used, even if the new
763 indentation would imply a different hierarchy. To use the new
764 hierarchy, break the command chain with a cursor motion or so.
767 If there is a checkbox (*note Checkboxes::) in the item line,
768 toggle the state of the checkbox. Otherwise, if this is an
769 ordered list, renumber the ordered list at the cursor.
771 ---------- Footnotes ----------
773 (1) When using `*' as a bullet, lines must be indented or they will
774 be seen as top-level headlines. Also, when you are hiding leading
775 stars to get a clean outline view, plain list items starting with a
776 star are visually indistinguishable from true headlines. In short:
777 even though `*' is supported, it may be better not to use it for plain
781 File: org, Node: Checkboxes, Prev: Plain lists, Up: Document structure
786 Every item in a plain list (ordered and unordered) can be made a
787 checkbox by starting it with the string `[ ]'. This feature is similar
788 to TODO items (*note TODO items::), but more lightweight. Checkboxes
789 are not included into the global TODO list, so they are often great to
790 split a task into a number of simple steps. Or you can use them in a
791 shopping list to select the items you need to buy. To toggle a
792 checkbox, use `C-c C-c', or try Piotr Zielinski's `org-mouse.el'. Here
793 is an example of a checkbox list.
795 * Avoid stupid mistakes when distributing a new version
796 - [ ] update also Emacs CVS
797 - [X] forget to update index.html on the website
798 - [X] leaving a `(debug)' form in the code
800 The following commands work with checkboxes:
803 Toggle checkbox at point.
806 Toggle checkbox at point.
807 - If there is an active region, toggle the first checkbox in
808 the region and set all remaining boxes to the same status as
809 the first. If you want to toggle all boxes in the region
810 independently, use a prefix argument.
812 - If the cursor is in a headline, toggle checkboxes in the
813 region between this headline and the next. This does _not_
814 act on the entire subtree, just the current entry.
816 - If no active region, just toggle the checkbox at point.
819 Insert a new item with a checkbox. This works only if the cursor
820 is already in a plain list item (*note Plain lists::).
823 File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
828 Org-mode has a very fast and intuitive table editor built-in.
829 Spreadsheet-like calculations are supported in connection with the
830 Emacs `calc' package.
834 * Built-in table editor:: Simple tables
835 * Narrow columns:: Stop wasting space in tables
836 * Table calculations:: Compute a field from other fields
837 * orgtbl-mode:: The table editor as minor mode
838 * table.el:: Complex tables
841 File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
843 3.1 The built-in table editor
844 =============================
846 Org-mode makes it easy to format tables in plain ASCII. Any line with
847 `|' as the first non-white character is considered part of a table.
848 `|' is also the column separator. A table might look like this:
850 | Name | Phone | Age |
851 |-------+-------+-----|
852 | Peter | 1234 | 17 |
855 A table is re-aligned automatically each time you press <TAB> or
856 <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
857 field (<RET> to the next row) and creates new table rows at the end of
858 the table or before horizontal lines. The indentation of the table is
859 set by the first line. Any line starting with `|-' is considered as a
860 horizontal separator line and will be expanded on the next re-align to
861 span the whole table width. So, to create the above table, you would
867 and then press <TAB> to align the table and start filling in fields.
869 When typing text into a field, Org-mode treats <DEL>, <Backspace>,
870 and all character keys in a special way, so that inserting and deleting
871 avoids shifting other fields. Also, when typing _immediately after the
872 cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
873 the field is automatically made blank. If this behavior is too
874 unpredictable for you, configure the variables
875 `org-enable-table-editor' and `org-table-auto-blank-field'.
877 Creation and conversion
878 .......................
881 Convert the active region to table. If every line contains at
882 least one TAB character, the function assumes that the material is
883 tab separated. If not, lines are split at whitespace into fields.
884 You can use a prefix argument to indicate the minimum number of
885 consecutive spaces required to identify a field separator
887 If there is no active region, this command creates an empty
888 Org-mode table. But it's easier just to start typing, like
889 `|Name|Phone|Age <RET> |- <TAB>'.
891 Re-aligning and field motion
892 ............................
895 Re-align the table without moving the cursor.
898 Re-align the table, move to the next field. Creates a new row if
902 Re-align, move to previous field.
905 Re-align the table and move down to next row. Creates a new row if
906 necessary. At the beginning or end of a line, <RET> still does
907 NEWLINE, so it can be used to split a table.
909 Column and row editing
910 ......................
914 Move the current column left/right.
917 Kill the current column.
920 Insert a new column to the left of the cursor position.
924 Move the current row up/down.
927 Kill the current row or horizontal line.
930 Insert a new row above (with arg: below) the current row.
933 Insert a horizontal line below current row. With prefix arg, the
934 line is created above the current line.
937 Sort the table lines in the region. Point and mark must be in the
938 first and last line to be included, and must be in the column that
939 should be used for sorting. The command prompts for numerical
940 versus alphanumerical sorting.
946 Copy a rectangular region from a table to a special clipboard.
947 Point and mark determine edge fields of the rectangle. The
948 process ignores horizontal separator lines.
951 Copy a rectangular region from a table to a special clipboard, and
952 blank all fields in the rectangle. So this is the "cut" operation.
955 Paste a rectangular region into a table. The upper right corner
956 ends up in the current field. All involved fields will be
957 overwritten. If the rectangle does not fit into the present table,
958 the table is enlarged as needed. The process ignores horizontal
962 Wrap several fields in a column like a paragraph. If there is an
963 active region, and both point and mark are in the same column, the
964 text in the column is wrapped to minimum width for the given
965 number of lines. A prefix ARG may be used to change the number of
966 desired lines. If there is no region, the current field is split
967 at the cursor position and the text fragment to the right of the
968 cursor is prepended to the field one line down. If there is no
969 region, but you specify a prefix ARG, the current field is made
970 blank, and the content is appended to the field above.
976 Install a new formula for the current column and replace current
977 field with the result of the formula.
980 Install a new formula for the current field, which must be a named
981 field. Evaluate the formula and replace the field content with the
985 Edit all formulas associated with the current table in a separate
989 Recalculate the current row by applying the stored formulas from
990 left to right. When called with a `C-u' prefix, recalculate the
991 entire table, starting with the first non-header line (i.e. below
992 the first horizontal separator line). For details, see *Note
993 Table calculations::.
996 Rotate the calculation mark in first column through the states `',
997 `#', `*', `!', `$'. For the meaning of these marks see *Note
998 Advanced features::. When there is an active region, change all
1002 Which table column is the cursor in? Displays number >0 in echo
1006 Sum the numbers in the current column, or in the rectangle defined
1007 by the active region. The result is shown in the echo area and can
1008 be inserted with `C-y'.
1011 When current field is empty, copy from first non-empty field above.
1012 When not empty, copy current field down to next row and move cursor
1013 along with it. Depending on the variable
1014 `org-table-copy-increment', integer field values will be
1015 incremented during copy. This key is also used by CUA-mode (*note
1022 Edit the current field in a separate window. This is useful for
1023 fields that are not fully visible (*note Narrow columns::). When
1024 called with a `C-u' prefix, just make the full field visible, so
1025 that it can be edited in place.
1028 This is an alias for `C-u C-c `' to make the current field fully
1031 `M-x org-table-import'
1032 Import a file as a table. The table should be TAB- or whitespace
1033 separated. Useful, for example, to import an Excel table or data
1034 from a database, because these programs generally can write
1035 TAB-separated text files. This command works by inserting the
1036 file into the buffer and then converting the region to a table.
1037 Any prefix argument is passed on to the converter, which uses it
1038 to determine the separator.
1040 `M-x org-table-export'
1041 Export the table as a TAB-separated file. Useful for data
1042 exchange with, for example, Excel or database programs.
1045 If you don't like the automatic table editor because it gets in your
1046 way on lines which you would like to start with `|', you can turn it
1049 (setq org-enable-table-editor nil)
1051 Then the only table command that still works is `C-c C-c' to do a
1055 File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
1060 The width of columns is automatically determined by the table editor.
1061 Sometimes a single field or a few fields need to carry more text,
1062 leading to inconveniently wide columns. To limit(1) the width of a
1063 column, one field anywhere in the column may contain just the string
1064 `<N>' where `N' is an integer specifying the width of the column in
1065 characters. The next re-align will then set the width of this column
1066 to no more than this value.
1068 |---+------------------------------| |---+--------|
1070 | 1 | one | | 1 | one |
1071 | 2 | two | ----\ | 2 | two |
1072 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1073 | 4 | four | | 4 | four |
1074 |---+------------------------------| |---+--------|
1076 Fields that are wider become clipped and end in the string `=>'. Note
1077 that the full text is still in the buffer, it is only invisible. To
1078 see the full text, hold the mouse over the field - a tooltip window
1079 will show the full content. To edit such a field, use the command `C-c
1080 `' (that is `C-c' followed by the backquote). This will open a new
1081 window with the full field. Edit it and finish with `C-c C-c'.
1083 When visiting a file containing a table with narrowed columns, the
1084 necessary character hiding has not yet happened, and the table needs to
1085 be aligned before it looks nice. Setting the option
1086 `org-startup-align-all-tables' will realign all tables in a file upon
1087 visiting, but also slow down startup. You can also set this option on
1088 a per-file basis with:
1093 ---------- Footnotes ----------
1095 (1) This feature does not work on XEmacs.
1098 File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
1100 3.3 Calculations in tables
1101 ==========================
1103 The table editor makes use of the Emacs `calc' package to implement
1104 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1105 derive fields from other fields. Org-mode has two levels of complexity
1106 for table calculations. On the basic level, tables do only horizontal
1107 computations, so a field can be computed from other fields _in the same
1108 row_, and Org-mode assumes that there is only one formula for each
1109 column. This is very efficient to work with and enough for many tasks.
1110 On the complex level, columns and individual fields can be named for
1111 easier referencing in formulas, individual named fields can have their
1112 own formula associated with them, and recalculation can be automated.
1116 * Formula syntax:: How to write a formula
1117 * Lisp formulas:: An alternative way to write formulas
1118 * Column formulas:: Formulas valid for all fields in a column
1119 * Advanced features:: Field names, parameters and automatic recalc
1120 * Named-field formulas:: Formulas valid in single fields
1121 * Editing/debugging formulas:: Changing a stored formula
1122 * Appetizer:: Taste the power of calc
1125 File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
1127 3.3.1 Formula syntax
1128 --------------------
1130 A formula can be any algebraic expression understood by the Emacs
1131 `calc' package. Note that `calc' has the slightly non-standard
1132 convention that `/' has lower precedence than `*', so that `a/b*c' is
1133 interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
1134 calc-eval: (calc)Calling Calc from Your Programs.), variable
1135 substitution takes place:
1137 $ refers to the current field
1138 $3 refers to the field in column 3 of the current row
1139 $3..$7 a vector of the fields in columns 3-7 of current row
1140 $P1..$P3 vector of column range, using column names
1141 &2 second data field above the current, in same column
1142 &5-2 vector from fifth to second field above current
1143 &III-II vector of fields between 2nd and 3rd hline above
1144 &III vector of fields between third hline above and current field
1145 $name a named field, parameter or constant
1147 The range vectors can be directly fed into the calc vector functions
1148 like `vmean' and `vsum'.
1150 `$name' is interpreted as the name of a column, parameter or
1151 constant. Constants are defined globally through the variable
1152 `org-table-formula-constants'. If you have the `constants.el' package,
1153 it will also be used to resolve constants, including natural constants
1154 like `$h' for Planck's constant, and units like `$km' for kilometers.
1155 Column names and parameters can be specified in special table lines.
1156 These are described below, see *Note Advanced features::.
1158 A formula can contain an optional mode string after a semicolon.
1159 This string consists of flags to influence calc's modes(1) during
1160 execution, e.g. `p20' to switch the internal precision to 20 digits,
1161 `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
1162 or fixed display format, respectively, and `D', `R', `F', and `S' to
1163 turn on degrees, radians, fraction and symbolic modes, respectively.
1164 In addition, you may provide a `printf' format specifier to reformat
1165 the final result. A few examples:
1167 $1+$2 Sum of first and second field
1168 $1+$2;%.2f Same, format result to two decimals
1169 exp($2)+exp($1) Math functions can be used
1170 $;%.1f Reformat current cell to 1 decimal
1171 ($3-32)*5/9 Degrees F -> C conversion
1172 $c/$1/$cm Hz -> cm conversion, using `constants.el'
1173 tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
1174 sin($1);Dp3%.1e Same, but use printf specifier for display
1175 vmean($2..$7) Compute column range mean, using vector function
1176 vsum(&III) Sum numbers from 3rd hline above, up to here
1177 taylor($3,x=7,2) taylor series of $3, at x=7, second degree
1179 ---------- Footnotes ----------
1181 (1) By default, Org-mode uses the standard calc modes (precision 12,
1182 angular units degrees, fraction and symbolic modes off). The display
1183 format, however, has been changed to `(float 5)' to keep tables compact.
1184 The default settings can be configured using the variable
1185 `org-calc-default-modes'.
1188 File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
1190 3.3.2 Emacs Lisp forms as formulas
1191 ----------------------------------
1193 It is also possible to write a formula in Emacs lisp; this can be useful
1194 for string manipulation and control structures. If a formula starts
1195 with a single quote followed by an opening parenthesis, then it is
1196 evaluated as a lisp form. The evaluation should return either a string
1197 or a number. Just as with `calc' formulas, you can provide a format
1198 specifier after a semicolon. A few examples:
1200 swap the first two characters of the content of column 1
1201 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
1202 Add columns 1 and 2, equivalent to the calc's `$1+$2'
1206 File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
1208 3.3.3 Column formulas
1209 ---------------------
1211 To apply a formula to a field, type it directly into the field,
1212 preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
1213 <RET> or `C-c C-c' with the cursor still in the field, the formula will
1214 be stored as the formula for the current column, evaluated and the
1215 current field replaced with the result. If the field contains only
1216 `=', the previously stored formula for this column is used.
1218 For each column, Org-mode will remember the most recently used
1219 formula. The information is stored in a special line starting with
1220 `#+TBLFM' directly below the table. When adding/deleting/moving
1221 columns with the appropriate commands, the stored equations will be
1222 modified accordingly. When a column used in a calculation is removed,
1223 references to this column become invalid and will cause an error upon
1224 applying the equation.
1226 Instead of typing an equation into the field, you may also use the
1227 command `C-c ='. It prompts for a formula (with default taken from the
1228 `#+TBLFM:' line) and applies it to the current field. A numerical
1229 prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
1230 in the current column.
1232 To recompute all the fields in a line, use the command `C-c *'. It
1233 re-applies all stored equations to the current row, from left to right.
1234 With a `C-u' prefix, this will be done to every line in the table, so
1235 use this command it you want to make sure the entire table is
1236 up-to-date. `C-u C-c C-c' is another way to update the entire table.
1237 Global updating does not touch the line(s) above the first horizontal
1238 separator line, assuming that this is the table header.
1241 File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
1243 3.3.4 Advanced features
1244 -----------------------
1246 If you want the recalculation of fields to happen automatically, or if
1247 you want to be able to assign a formula to an individual field (instead
1248 of an entire column) you need to reserve the first column of the table
1249 for special marking characters. Here is an example of a table that
1250 collects exam results of students and makes use of these features:
1252 |---+---------+--------+--------+--------+-------+------|
1253 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
1254 |---+---------+--------+--------+--------+-------+------|
1255 | ! | | P1 | P2 | P3 | Tot | |
1256 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
1257 | ^ | | m1 | m2 | m3 | mt | |
1258 |---+---------+--------+--------+--------+-------+------|
1259 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
1260 | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
1261 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
1262 |---+---------+--------+--------+--------+-------+------|
1263 | | Average | | | | 29.7 | |
1264 | ^ | | | | | at | |
1265 | $ | max=50 | | | | | |
1266 |---+---------+--------+--------+--------+-------+------|
1267 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
1269 Important: Please note that for these special tables, recalculating the
1270 table with `C-u C-c *' will only affect rows that are marked `#' or
1271 `*', and named fields. The column formulas are not applied in rows
1272 with empty first field.
1274 The marking characters have the following meaning:
1276 The fields in this line define names for the columns, so that you
1277 may refer to a column as `$Tot' instead of `$6'.
1280 This row defines names for the fields _above_ the row. With such
1281 a definition, any formula in the table may use `$m1' to refer to
1282 the value `10'. Also, named fields can have their own formula
1283 associated with them.
1286 Similar to `^', but defines names for the fields in the row
1290 Fields in this row can define _parameters_ for formulas. For
1291 example, if a field in a `$' row contains `max=50', then formulas
1292 in this table can refer to the value 50 using `$max'. Parameters
1293 work exactly like constants, only that they can be defined on a
1294 per-table basis. Changing a parameter and then recalculating the
1295 table can be useful.
1298 Fields in this row are automatically recalculated when pressing
1299 <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
1300 selected for a global recalculation with `C-u C-c *'. Unmarked
1301 lines will be left alone by this command.
1304 Selects this line for global recalculation with `C-u C-c *', but
1305 not for automatic recalculation. Use this when automatic
1306 recalculation slows down editing too much.
1309 Unmarked lines are exempt from recalculation with `C-u C-c *'.
1310 All lines that should be recalculated should be marked with `#' or
1314 File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
1316 3.3.5 Named-field formulas
1317 --------------------------
1319 A named field can have its own formula associated with it. In the
1320 example above, this is used for the `at' field that contains the
1321 average result of the students. To enter a formula for a named field,
1322 just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
1323 This equation will be stored below the table like `$name=...'. Any
1324 recalculation in the table (even if only requested for the current
1325 line) will also update all named field formulas.
1328 File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
1330 3.3.6 Editing and debugging formulas
1331 ------------------------------------
1333 To edit a column or field formula, use the commands `C-c =' and `C-u
1334 C-c =', respectively. The currently active expression is then
1335 presented as default in the minibuffer, where it may be edited.
1337 Note that making a table field blank does not remove the formula
1338 associated with the field - during the next recalculation the field
1339 will be filled again. To remove a formula from a field, you have to
1340 give an empty reply when prompted for the formula, or to edit the
1343 You may edit the `#+TBLFM' directly and re-apply the changed
1344 equations with `C-c C-c' in that line, or with the normal recalculation
1345 commands in the table.
1347 In particular for large tables with many formulas, it is convenient
1348 to use the command `C-c '' to edit the formulas of the current table in
1349 a separate buffer. That buffer will show the formulas one per line,
1350 and you are free to edit, add and remove formulas. Press `C-c ?' on a
1351 `$...' expression to get information about its interpretation.
1352 Exiting the buffer with `C-c C-c' only stores the modified formulas
1353 below the table. Exiting with `C-u C-c C-c' also applies them to the
1354 entire table. `C-c C-q' exits without installing the changes.
1356 When the evaluation of a formula leads to an error, the field content
1357 becomes the string `#ERROR'. If you would like see what is going on
1358 during variable substitution and calculation in order to find a bug,
1359 turn on formula debugging in the menu and repeat the calculation, for
1360 example by pressing `C-c = <RET>' in a field. Detailed information
1364 File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
1369 Finally, just to whet your appetite on what can be done with the
1370 fantastic `calc' package, here is a table that computes the Taylor
1371 series for a couple of functions (homework: try that with Excel :-)
1373 |---+-------------+---+-----+--------------------------------------|
1374 | | Func | n | x | Result |
1375 |---+-------------+---+-----+--------------------------------------|
1376 | # | exp(x) | 1 | x | 1 + x |
1377 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
1378 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
1379 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
1380 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
1381 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
1382 |---+-------------+---+-----+--------------------------------------|
1383 #+TBLFM: $5=taylor($2,$4,$3);n3
1386 File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
1388 3.4 The Orgtbl minor mode
1389 =========================
1391 If you like the intuitive way the Org-mode table editor works, you
1392 might also want to use it in other modes like text-mode or mail-mode.
1393 The minor mode Orgtbl-mode makes this possible. You can always toggle
1394 the mode with `M-x orgtbl-mode'. To turn it on by default, for example
1397 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1400 File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
1402 3.5 The `table.el' package
1403 ==========================
1405 Complex ASCII tables with automatic line wrapping, column- and
1406 row-spanning, and alignment can be created using the Emacs table
1407 package by Takaaki Ota (`http://sourceforge.net/projects/table', and
1408 also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
1409 table, Org-mode will call `table-recognize-table' and move the cursor
1410 into the table. Inside a table, the keymap of Org-mode is inactive.
1411 In order to execute Org-mode-related commands, leave the table.
1414 Recognize `table.el' table. Works when the cursor is in a
1418 Insert a table.el table. If there is already a table at point,
1419 this command converts it between the table.el format and the
1420 Org-mode format. See the documentation string of the command
1421 `org-convert-table' for the restrictions under which this is
1425 File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
1430 Just like HTML, Org-mode provides links inside a file, and external
1431 links to other files, Usenet articles, emails, and much more.
1435 * Link format:: How links in Org-mode are formatted
1436 * Internal links:: Links to other places in the current file
1437 * External links:: URL-like links to the world
1438 * Handling links:: Creating, inserting and following
1439 * Search options:: Linking to a specific location
1440 * Custom searches:: When the default search is not enough
1441 * Remember:: Org-trees store quick notes
1444 File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
1449 Org-mode will recognize plain URL-like links and activate them as
1450 clickable links. The general link format, however, looks like this:
1452 [[link][description]] or alternatively [[link]]
1454 Once a link in the buffer is complete (all brackets present),
1455 Org-mode will change the display so that `description' is displayed
1456 instead of `[[link][description]]' and `link' is displayed instead of
1457 `[[link]]'. Links will be highlighted in the face `org-link', which by
1458 default is an underlined face. You can directly edit the visible part
1459 of a link. Note that this can be either the `link' part (if there is
1460 no description) or the `description' part. To edit also the invisible
1461 `link' part, use `C-c C-l' with the cursor on the link.
1463 If you place the cursor at the beginning or just behind the end of
1464 the displayed text and press <BACKSPACE>, you will remove the
1465 (invisible) bracket at that location. This makes the link incomplete
1466 and the internals are again displayed as plain text. Inserting the
1467 missing bracket hides the link internals again. To show the internal
1468 structure of all links, use the menu entry `Org->Hyperlinks->Literal
1472 File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
1477 If the link does not look like a URL, it is considered to be internal in
1478 the current file. Links such as `[[My Target]]' or `[[My Target][Find
1479 my target]]' lead to a text search in the current file. The link can
1480 be followed with `C-c C-o' when the cursor is on the link, or with a
1481 mouse click (*note Handling links::). The preferred match for such a
1482 link is a dedicated target: the same string in double angular brackets.
1483 Targets may be located anywhere; often it is convenient to put them
1484 into a comment line. For example
1488 In HTML export (*note HTML export::), such targets will become named
1489 anchors for direct access through `http' links(1).
1491 If no dedicated target exists, Org-mode will search for the words in
1492 the link. In the above example the search would be for `my target'.
1493 Links starting with a star like `*My Target' restrict the search to
1494 headlines. When searching, Org-mode will first try an exact match, but
1495 then move on to more and more lenient searches. For example, the link
1496 `[[*My Targets]]' will find any of the following:
1499 ** TODO my targets are bright
1500 ** my 20 targets are
1502 To insert a link targeting a headline, in-buffer completion can be
1503 used. Just type a star followed by a few optional letters into the
1504 buffer and press `M-<TAB>'. All headlines in the current buffer will be
1505 offered as completions. *Note Handling links::, for more commands
1508 Following a link pushes a mark onto Org-mode's own mark ring. You
1509 can return to the previous position with `C-c &'. Using this command
1510 several times in direct succession goes back to positions recorded
1515 * Radio targets:: Make targets trigger links in plain text.
1516 * CamelCase links:: Activating CamelCase words as links
1518 ---------- Footnotes ----------
1520 (1) Note that text before the first headline will never be exported,
1521 so the first such target must be after the first headline.
1524 File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
1529 You can configure Org-mode to link any occurrences of certain target
1530 names in normal text. So without explicitly creating a link, the text
1531 connects to the target radioing its position. Radio targets are
1532 enclosed by triple angular brackets. For example, a target `<<<My
1533 Target>>>' causes each occurrence of `my target' in normal text to
1534 become activated as a link. The Org-mode file is scanned automatically
1535 for radio targets only when the file is first loaded into Emacs. To
1536 update the target list during editing, press `C-c C-c' with the cursor
1540 File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
1542 4.2.2 CamelCase words as links
1543 ------------------------------
1545 Org-mode also supports CamelCase words as links. This feature is not
1546 turned on by default because of the inconsistencies this system suffers
1547 from. To activate CamelCase words as links, you need to customize the
1548 option `org-activate-links'. A CamelCase word then leads to a text
1549 search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
1552 File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
1557 Org-mode supports links to files, websites, Usenet and email messages,
1558 and BBDB database entries. External links are URL-like locators. They
1559 start with a short identifying string followed by a colon. There can be
1560 no space after the colon. The following list shows examples for each
1563 http://www.astro.uva.nl/~dominik on the web
1564 file:/home/dominik/images/jupiter.jpg file, absolute path
1565 file:papers/last.pdf file, relative path
1566 news:comp.emacs Usenet link
1567 mailto:adent@galaxy.net Mail link
1568 vm:folder VM folder link
1569 vm:folder#id VM message link
1570 vm://myself@some.where.org/folder#id VM on remote machine
1571 wl:folder WANDERLUST folder link
1572 wl:folder#id WANDERLUST message link
1573 mhe:folder MH-E folder link
1574 mhe:folder#id MH-E message link
1575 rmail:folder RMAIL folder link
1576 rmail:folder#id RMAIL message link
1577 gnus:group GNUS group link
1578 gnus:group#id GNUS article link
1579 bbdb:Richard Stallman BBDB link
1580 shell:ls *.org A shell command
1581 elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
1583 A link should be enclosed in double brackets and may contain a
1584 descriptive text to be displayed instead of the url (*note Link
1585 format::), for example:
1587 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
1589 Org-mode also finds external links in the normal text and activates
1590 them as links. If spaces must be part of the link (for example in
1591 `bbdb:Richard Stallman'), or you need to remove ambiguities about the
1592 end of the link, enclose them in angular brackets.
1595 File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
1600 Org-mode provides methods to create a link in the correct syntax, to
1601 insert it into an org-mode file, and to follow the link.
1604 Store a link to the current location. This is a _global_ command
1605 which can be used in any buffer to create a link. The link will be
1606 stored for later insertion into an Org-mode buffer (see below).
1607 For Org-mode files, if there is a `<<target>>' at the cursor, the
1608 link points to the target. Otherwise it points to the current
1609 headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
1610 the link will indicate the current article/entry. For W3 and W3M
1611 buffers, the link goes to the current URL. For any other files,
1612 the link will point to the file, with a search string (*note
1613 Search options::) pointing to the contents of the current line.
1614 If there is an active region, the selected words will form the
1615 basis of the search string. If the automatically created link is
1616 not working correctly or accurately enough, you can write custom
1617 functions to select the search string and to do the search for
1618 particular file types - see *Note Custom searches::. The key
1619 binding `C-c l' is only a suggestion - see *Note Installation::.
1622 Insert a link. This prompts for a link to be inserted into the
1623 buffer. You can just type a link, using text for an internal
1624 link, or one of the link type prefixes mentioned in the examples
1625 above. Through completion, all links stored during the current
1626 session can be accessed(1). The link will be inserted into the
1627 buffer, along with a descriptive text. Note that you don't have
1628 to use this command to insert a link. Links in Org-mode are plain
1629 text, and you can type or paste them straight into the buffer. By
1630 using this command, the links are automatically enclosed in double
1631 brackets, and you will be asked for the optional descriptive text.
1632 If the link is a `file:' link and the linked file is located in
1633 the same directory as the current file or a subdirectory of it, the
1634 path of the file will be inserted relative to the current
1638 When `C-c C-l' is called with a `C-u' prefix argument, a link to a
1639 file will be inserted and you may use file name completion to
1640 select the name of the file. The path to the file is inserted
1641 relative to the directory of the current org file, if the linked
1642 file is in the current directory or in a subdirectory of it, or if
1643 the path is written relative to the current directory using `../'.
1644 Otherwise an absolute path is used, if possible with `~/' for
1645 your home directory. You can force an absolute path with two
1648 `C-c C-l with cursor on existing link'
1649 When the cursor is on an existing link, `C-c C-l' allows you to
1650 edit the link and description parts of the link.
1653 Open link at point. This will launch a web browser for URLs (using
1654 `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
1655 the corresponding links, and execute the command in a shell link.
1656 When the cursor is on an internal link, this commands runs the
1657 corresponding search. When the cursor is on a TAG list in a
1658 headline, it creates the corresponding TAGS view. If the cursor
1659 is on a time stamp, it compiles the agenda for that date.
1660 Furthermore, it will visit text and remote files in `file:' links
1661 with Emacs and select a suitable application for local non-text
1662 files. Classification of files is based on file extension only.
1663 See option `org-file-apps'. If you want to override the default
1664 application and visit the file with Emacs, use a `C-u' prefix.
1668 On links, `mouse-2' will open the link just as `C-c C-o' would.
1669 Under Emacs 22, also `mouse-1' will follow a link.
1672 Like `mouse-2', but force file links to be opened with Emacs.
1675 Push the current position onto the mark ring, to be able to return
1676 easily. Commands following an internal link do this automatically.
1679 Jump back to a recorded position. A position is recorded by the
1680 commands following internal links, and by `C-c %'. Using this
1681 command several times in direct succession moves through a ring of
1682 previously recorded positions.
1684 ---------- Footnotes ----------
1686 (1) After insertion of a stored link, the link will be removed from
1687 the list of stored links. To keep it in the list later use, use a
1688 triple `C-u' prefix to `C-c C-l', or configure the option
1689 `org-keep-stored-link-after-insertion'.
1692 File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
1694 4.5 Search options in file links
1695 ================================
1697 File links can contain additional information to make Emacs jump to a
1698 particular location in the file when following a link. This can be a
1699 line number or a search option after a double(1) colon. For example,
1700 when the command `C-c l' creates a link (*note Handling links::) to a
1701 file, it encodes the words in the current line as a search string that
1702 can be used to find this line back later when following the link with
1705 Here is the syntax of the different ways to attach a search to a file
1706 link, together with an explanation:
1708 [[file:~/code/main.c::255]]
1709 [[file:~/xx.org::My Target]]
1710 [[file:~/xx.org::*My Target]]
1711 [[file:~/xx.org::/regexp/]]
1717 Search for a link target `<<My Target>>', or do a text search for
1718 `my target', similar to the search in internal links, see *Note
1719 Internal links::. In HTML export (*note HTML export::), such a
1720 file link will become an HTML reference to the corresponding named
1721 anchor in the linked file.
1724 In an Org-mode file, restrict search to headlines.
1727 Do a regular expression search for `regexp'. This uses the Emacs
1728 command `occur' to list all matches in a separate window. If the
1729 target file is in Org-mode, `org-occur' is used to create a sparse
1730 tree with the matches.
1732 As a degenerate case, a file link with an empty file name can be used
1733 to search the current file. For example, `<file:::find me>' does a
1734 search for `find me' in the current file, just as `[[find me]]' would.
1736 ---------- Footnotes ----------
1738 (1) For backward compatibility, line numbers can also follow a
1742 File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
1747 The default mechanism for creating search strings and for doing the
1748 actual search related to a file link may not work correctly in all
1749 cases. For example, BibTeX database files have many entries like
1750 `year="1993"' which would not result in good search strings, because
1751 the only unique identification for a BibTeX entry is the citation key.
1753 If you come across such a problem, you can write custom functions to
1754 set the right search string for a particular file type, and to do the
1755 search for the string in the file. Using `add-hook', these functions
1756 need to be added to the hook variables
1757 `org-create-file-search-functions' and
1758 `org-execute-file-search-functions'. See the docstring for these
1759 variables for more information. Org-mode actually uses this mechanism
1760 for BibTeX database files, and you can use the corresponding code as an
1761 implementation example. Search for `BibTeX links' in the source file.
1764 File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
1769 Another way to create org entries with links to other files is through
1770 the _Remember_ package by John Wiegley. _Remember_ lets you store
1771 quick notes with little interruption of your work flow. See
1772 `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
1773 information. The notes produced by _Remember_ can be stored in
1774 different ways, and Org-mode files are a good target. Org-mode allows
1775 you to file away notes either to a default file, or directly to the
1776 correct location in your Org-mode outline tree. The following
1777 customization will tell _Remember_ to use org files as target, and to
1778 create annotations compatible with Org-mode links.
1780 (setq org-directory "~/path/to/my/orgfiles/")
1781 (setq org-default-notes-file "~/.notes")
1782 (setq remember-annotation-functions '(org-remember-annotation))
1783 (setq remember-handler-functions '(org-remember-handler))
1784 (add-hook 'remember-mode-hook 'org-remember-apply-template)
1786 In combination with Org-mode, you can use templates to generate
1787 different types of remember notes. For example, if you would like to
1788 use one template to create general TODO entries, and another one for
1789 journal entries, you could use:
1791 (setq org-remember-templates
1792 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
1793 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
1795 In these entries, the character specifies how to select the template,
1796 the first string specifies the template, and the (optional) second
1797 string specifies a default file (overruling `org-default-notes-file')
1798 as a target for this note.
1800 When you call `M-x remember' to remember something, org will prompt
1801 for a key to select the template and then prepare the buffer like
1803 <file:link to where you called remember>
1807 * [2006-03-21 Tue 15:37]
1809 <file:link to where you called remember>
1811 See the variable `org-remember-templates' for more details.
1813 When you are finished composing a note with remember, you have to
1814 press `C-c C-c' to file the note away. The handler first prompts for a
1815 target file - if you press <RET>, the value of `org-default-notes-file'
1816 is used. Then the command offers the headings tree of the selected
1817 file. You can either immediately press <RET> to get the note appended
1818 to the file. Or you can use vertical cursor motion (<up> and <down>)
1819 and visibility cycling (<TAB>) to find a better place. Pressing <RET>
1820 or <left> or <right> leads to the following result.
1822 Cursor Key Note gets inserted
1824 buffer-start <RET> as level 2 heading at end of file
1825 on headline <RET> as sublevel of the heading at cursor
1826 <left> as same level, before current heading
1827 <right> as same level, after current heading
1828 not on <RET> at cursor position, level taken from context.
1829 headline Or use prefix arg to specify level
1832 So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
1833 append it to the default file. Even shorter would be `C-u C-c C-c',
1834 which does the same without even showing the tree. But with little
1835 extra effort, you can push it directly to the correct location.
1837 Before inserting the text into a tree, the function ensures that the
1838 text has a headline, i.e. a first line that starts with a `*'. If not,
1839 a headline is constructed from the current date and some additional
1840 data. If the variable `org-adapt-indentation' is non-nil, the entire
1841 text is also indented so that it starts in the same column as the
1842 headline (after the asterisks).
1845 File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
1850 Org-mode does not maintain TODO lists as a separate document. TODO
1851 items are an integral part of the notes file, because TODO items
1852 usually come up while taking notes! With Org-mode, you simply mark any
1853 entry in a tree as being a TODO item. In this way, the information is
1854 not duplicated, and the entire context from which the item emerged is
1855 always present when you check.
1857 Of course, this technique causes TODO items to be scattered
1858 throughout your file. Org-mode provides methods to give you an
1859 overview over all things you have to do.
1863 * TODO basics:: Marking and displaying TODO entries
1864 * TODO extensions:: Workflow and assignments
1865 * Priorities:: Some things are more important than others
1868 File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
1870 5.1 Basic TODO functionality
1871 ============================
1873 Any headline can become a TODO item by starting it with the word TODO,
1876 *** TODO Write letter to Sam Fortune
1878 The most important commands to work with TODO entries are:
1881 Rotate the TODO state of the current item between
1883 ,-> (unmarked) -> TODO -> DONE --.
1884 '--------------------------------'
1886 The same rotation can also be done "remotely" from the timeline and
1887 agenda buffers with the `t' command key (*note Agenda commands::).
1891 Select the following/preceding TODO state, similar to cycling.
1892 Mostly useful if more than two TODO states are possible (*note
1896 View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
1897 the entire buffer, but shows all TODO items and the headings
1898 hierarchy above them. With prefix arg, show also the DONE
1899 entries. With numerical prefix N, show the tree for the Nth
1900 keyword in the variable `org-todo-keywords'.
1903 Show the global TODO list. This collects the TODO items from all
1904 agenda files (*note Agenda views::) into a single buffer. The
1905 buffer is in `agenda-mode', so there are commands to examine and
1906 manipulate the TODO entries directly from that buffer (*note
1907 Agenda commands::). *Note Global TODO list::, for more
1911 File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
1913 5.2 Extended use of TODO keywords
1914 =================================
1916 The default implementation of TODO entries is just two states: TODO and
1917 DONE. You can, however, use the TODO feature for more complicated
1918 things by configuring the variables `org-todo-keywords' and
1919 `org-todo-interpretation'. Using special setup, you can even use TODO
1920 keywords in different ways in different org files.
1922 Note that tags are another way to classify headlines in general and
1923 TODO items in particular (*note Tags::).
1927 * Workflow states:: From TODO to DONE in steps
1928 * TODO types:: I do this, Fred the rest
1929 * Per file keywords:: Different files, different requirements
1932 File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
1934 5.2.1 TODO keywords as workflow states
1935 --------------------------------------
1937 You can use TODO keywords to indicate different states in the process
1938 of working on an item, for example:
1940 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
1941 org-todo-interpretation 'sequence)
1943 Changing these variables only becomes effective in a new Emacs
1944 session. With this setup, the command `C-c C-t' will cycle an entry
1945 from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
1946 also use a prefix argument to quickly select a specific state. For
1947 example `C-3 C-c C-t' will change the state immediately to VERIFY. If
1948 you define many keywords, you can use in-buffer completion (see *Note
1949 Completion::) to insert these words into the buffer.
1952 File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
1954 5.2.2 TODO keywords as types
1955 ----------------------------
1957 The second possibility is to use TODO keywords to indicate different
1958 types of action items. For example, you might want to indicate that
1959 items are for "work" or "home". If you are into David Allen's _Getting
1960 Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
1961 `MAYBE'. Or, when you work with several people on a single project,
1962 you might want to assign action items directly to persons, by using
1963 their names as TODO keywords. This would be set up like this:
1965 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
1966 org-todo-interpretation 'type)
1968 In this case, different keywords do not indicate a sequence, but
1969 rather different types. So it is normally not useful to change from
1970 one type to another. Therefore, in this case the behavior of the
1971 command `C-c C-t' is changed slightly(1). When used several times in
1972 succession, it will still cycle through all names. But when you return
1973 to the item after some time and execute `C-c C-t' again, it will switch
1974 from each name directly to DONE. Use prefix arguments or completion to
1975 quickly select a specific name. You can also review the items of a
1976 specific TODO type in a sparse tree by using a numeric prefix to `C-c
1977 C-v'. For example, to see all things Lucy has to do, you would use
1978 `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
1979 single buffer, you would use the prefix arg as well when creating the
1980 global todo list: `C-3 C-c t'.
1982 ---------- Footnotes ----------
1984 (1) This is also true for the `t' command in the timeline and agenda
1988 File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
1990 5.2.3 Setting up TODO keywords for individual files
1991 ---------------------------------------------------
1993 It can be very useful to use different aspects of the TODO mechanism in
1994 different files, which is not possible with the global settings
1995 described above. For file-local settings, you need to add special
1996 lines to the file which set the keywords and interpretation for that
1997 file only. For example, to set one of the two examples discussed
1998 above, you need one of the following lines, starting in column zero
1999 anywhere in the file:
2001 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
2002 #+TYP_TODO: Fred Sara Lucy Mike DONE
2004 To make sure you are using the correct keyword, type `#+' into the
2005 buffer and then use `M-<TAB>' completion.
2007 Remember that the last keyword must always mean that the item is DONE
2008 (although you may use a different word). Also note that in each file,
2009 only one of the two aspects of TODO keywords can be used. After
2010 changing one of these lines, use `C-c C-c' with the cursor still in the
2011 line to make the changes known to Org-mode(1).
2013 If you want to use very many keywords, for example when working with
2014 a large group of people, you may split the names over several lines:
2016 #+TYP_TODO: Fred Sara Lucy Mike
2017 #+TYP_TODO: Luis George Jules Jessica
2018 #+TYP_TODO: Kim Arnold Peter
2021 ---------- Footnotes ----------
2023 (1) Org-mode parses these lines only when Org-mode is activated
2024 after visiting a file. `C-c C-c' with the cursor in a line starting
2025 with `#+' is simply restarting Org-mode, making sure that these changes
2029 File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
2034 If you use Org-mode extensively to organize your work, you may end up
2035 with a number of TODO entries so large that you'd like to prioritize
2036 them. This can be done by placing a _priority cookie_ into the
2039 *** TODO [#A] Write letter to Sam Fortune
2041 With its standard setup, Org-mode supports priorities `A', `B', and
2042 `C'. `A' is the highest priority. An entry without a cookie is
2043 treated as priority `B'. Priorities make a difference only in the
2044 agenda (*note Weekly/Daily agenda::).
2047 Set the priority of the current headline. The command prompts for
2048 a priority character `A', `B' or `C'. When you press <SPC>
2049 instead, the priority cookie is removed from the headline. The
2050 priorities can also be changed "remotely" from the timeline and
2051 agenda buffer with the `,' command (*note Agenda commands::).
2055 Increase/decrease priority of current headline. Note that these
2056 keys are also used to modify time stamps (*note Creating
2057 timestamps::). Furthermore, these keys are also used by CUA-mode
2058 (*note Conflicts::).
2061 File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
2066 Items can be labeled with timestamps to make them useful for project
2071 * Time stamps:: Assigning a time to a tree entry
2072 * Creating timestamps:: Commands which insert timestamps
2073 * Progress logging:: Documenting when what work was done.
2076 File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
2078 6.1 Time stamps, deadlines and scheduling
2079 =========================================
2081 A time stamp is a specification of a date (possibly with time) in a
2082 special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
2083 A time stamp can appear anywhere in the headline or body of an org-tree
2084 entry. Its presence allows entries to be shown on specific dates in
2085 the agenda (*note Weekly/Daily agenda::). We distinguish:
2088 A simple time stamp just assigns a date/time to an item. This is
2089 just like writing down an appointment in a paper agenda, or like
2090 writing down an event in a diary, when you want to take note of
2091 when something happened. In the timeline and agenda displays, the
2092 headline of an entry associated with a plain time stamp will be
2093 shown exactly on that date.
2096 Two time stamps connected by `--' denote a time range. The
2097 headline will be shown on the first and last day of the range, and
2098 on any dates that are displayed and fall in the range. Here is an
2101 ** Meeting in Amsterdam
2102 <2004-08-23 Mon>--<2004-08-26 Thu>
2104 TIME STAMP WITH SCHEDULED KEYWORD
2105 If a time stamp is preceded by the word `SCHEDULED:', it means you
2106 are planning to start working on that task on the given date. So
2107 this is not about recording an event, but about planning your
2108 work. The headline will be listed under the given date. In
2109 addition, a reminder that the scheduled date has passed will be
2110 present in the compilation for _today_, until the entry is marked
2111 DONE. I.e., the task will automatically be forwarded until
2114 *** TODO Call Trillian for a date on New Years Eve.
2115 SCHEDULED: <2004-12-25 Sat>
2117 TIME STAMP WITH DEADLINE KEYWORD
2118 If a time stamp is preceded by the word `DEADLINE:', the task
2119 (most likely a TODO item) is supposed to be finished on that date,
2120 and it will be listed then. In addition, the compilation for
2121 _today_ will carry a warning about the approaching or missed
2122 deadline, starting `org-deadline-warning-days' before the due
2123 date, and continuing until the entry is marked DONE. An example:
2125 *** TODO write article about the Earth for the Guide
2126 The editor in charge is <bbdb:Ford Prefect>
2127 DEADLINE: <2004-02-29 Sun>
2129 TIME STAMP WITH CLOSED KEYWORD
2130 When `org-log-done' is non-nil, Org-mode will automatically insert
2131 a special time stamp each time a TODO entry is marked done (*note
2132 Progress logging::). This time stamp is enclosed in square
2133 brackets instead of angular brackets.
2135 TIME RANGE WITH CLOCK KEYWORD
2136 When using the clock to time the work that is being done on
2137 specific items, time ranges preceded by the CLOCK keyword are
2138 inserted automatically into the file. The time stamps are
2139 enclosed in square brackets instead of angular brackets. *Note
2140 Clocking work time::.
2143 File: org, Node: Creating timestamps, Next: Progress logging, Prev: Time stamps, Up: Timestamps
2145 6.2 Creating timestamps
2146 =======================
2148 For Org-mode to recognize time stamps, they need to be in the specific
2149 format. All commands listed below produce time stamps in the correct
2153 Prompt for a date and insert a corresponding time stamp. When the
2154 cursor is at a previously used time stamp, it is updated to NOW.
2155 When this command is used twice in succession, a time range is
2159 Like `C-c .', but use the alternative format which contains date
2160 and time. The default time can be rounded to multiples of 5
2161 minutes, see the option `org-time-stamp-rounding-minutes'.
2164 Like `C-c .', but insert an inactive time stamp not triggering the
2168 Insert a time stamp corresponding to the cursor date in the
2172 Access the Emacs calendar for the current date. If there is a
2173 timestamp in the current line, goto the corresponding date instead.
2176 Access the agenda for the date given by the time stamp at point
2177 (*note Weekly/Daily agenda::).
2180 Insert `DEADLINE' keyword along with a stamp. The insertion will
2181 happen in the line directly following the headline.
2184 Create a sparse tree with all deadlines that are either past-due,
2185 or which will become due within `org-deadline-warning-days'. With
2186 `C-u' prefix, show all deadlines in the file. With a numeric
2187 prefix, check that many days. For example, `C-1 C-c C-w' shows
2188 all deadlines due tomorrow.
2191 Insert `SCHEDULED' keyword along with a stamp. The insertion will
2192 happen in the line directly following the headline. Any CLOSED
2193 timestamp will be removed.
2197 Change date at cursor by one day. These key bindings conflict with
2198 CUA-mode (*note Conflicts::).
2202 Change the item under the cursor in a timestamp. The cursor can
2203 be on a year, month, day, hour or minute. Note that if the cursor
2204 is not at a time stamp, these same keys modify the priority of an
2205 item. (*note Priorities::). The key bindings also conflict with
2206 CUA-mode (*note Conflicts::).
2209 Evaluate a time range by computing the difference between start and
2210 end. With prefix arg, insert result after the time range (in a
2211 table: into the following column).
2213 When Org-mode prompts for a date/time, the function reading your
2214 input will replace anything you choose not to specify with the current
2215 date and time. For details, see the documentation string of
2216 `org-read-date'. Also, a calender will pop up to allow selecting a
2217 date. The calendar can be fully controlled from the minibuffer, and a
2218 date can be selected with the following commands:
2221 Scroll calendar backwards by one month.
2224 Scroll calendar forwards by one month.
2227 Select date by clicking on it.
2248 Choose date in calendar (only if nothing typed into minibuffer).
2251 File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
2253 6.3 Progress Logging
2254 ====================
2256 Org-mode can automatically record a time stamp when you mark a TODO item
2257 as DONE. You can also measure precisely the time you spent on specific
2258 items in a project by starting and stopping a clock when you start and
2259 stop working on an aspect of a project.
2263 * Closing items:: When was this entry marked DONE?
2264 * Clocking work time:: When exactly did you work on this item?
2267 File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
2272 If you want to keep track of _when_ a certain TODO item was finished,
2273 turn on logging with
2275 (setq org-log-done t)
2277 Then each time you turn a TODO entry into DONE using either `C-c C-t'
2278 in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
2279 [timestamp]' will be inserted just after the headline. If you turn the
2280 entry back into a TODO item again through further state cycling, that
2281 line will be removed again. In the timeline (*note Timeline::) and in
2282 the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
2283 to display the TODO items closed on each day, giving you an overview of
2284 what has been done on a day.
2287 File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
2289 6.3.2 Clocking work time
2290 ------------------------
2292 Org-mode allows you to clock the time you spent on specific tasks in a
2293 project. When you start working on an item, you can start the clock.
2294 When you stop working on that task, or when you mark the task done, the
2295 clock is stopped and the corresponding time interval is recorded. It
2296 also computes the total time spent on each subtree of a project.
2299 Start the clock on the current item (clock-in). This inserts the
2300 CLOCK keyword together with a timestamp.
2303 Stop the clock (clock-out). The inserts another timestamp at the
2304 same location where the clock was last started. It also directly
2305 computes the resulting time in inserts it after the time range as
2309 Changing the TODO state of an item to DONE automatically stops the
2310 clock if it is running in this same item.
2313 Cancel the current clock. This is useful if a clock was started by
2314 mistake, or if you ended up working on something else.
2317 Display time summaries for each subtree in the current buffer.
2318 This puts overlays at the end of each headline, showing the total
2319 time recorded under that heading, including the time of any
2320 subheadings. You can use visibility cycling to study the tree, but
2321 the overlays disappear automatically when the buffer is changed.
2324 Insert a dynamic block containing a clock report as an org-mode
2325 table into the current file.
2326 #+BEGIN: clocktable :maxlevel 2 :emphasize nil
2329 If such a block already exists, its content is replaced by the new
2330 table. The `BEGIN' line can specify options:
2331 :maxlevels Maximum level depth to which times are listed in the table.
2332 :emphasize When `t', emphasize level one and level two items
2334 The `l' key may be used in the timeline (*note Timeline::) and in
2335 the agenda (*note Weekly/Daily agenda::) to show which tasks have been
2336 worked on or closed during a day.
2339 File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
2344 If you wish to implement a system of labels and contexts for
2345 cross-correlating information, an excellent way is to assign tags to
2346 headlines. Org-mode has extensive support for using tags.
2348 Every headline can contain a list of tags, at the end of the
2349 headline. Tags are normal words containing letters, numbers, `_', and
2350 `@'. Tags must be preceded and followed by a single colon; like
2351 `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
2355 * Tag inheritance:: Tags use the tree structure of the outline
2356 * Setting tags:: How to assign tags to a headline
2357 * Tag searches:: Searching for combinations of tags
2360 File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
2365 Tags make use of the hierarchical structure of outline trees. If a
2366 heading has a certain tag, all subheadings will inherit the tag as
2367 well. For example, in the list
2369 * Meeting with the French group :WORK:
2370 ** Summary by Frank :BOSS:NOTES:
2371 *** TODO Prepare slides for him :ACTION:
2373 the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
2374 `:ACTION:'. When executing tag searches and Org-mode finds that a
2375 certain headline matches the search criterion, it will not check any
2376 sublevel headline, assuming that these likely also match, and that the
2377 list of matches can become very long. This may not be what you want,
2378 however, and you can influence inheritance and searching using the
2379 variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
2382 File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
2387 Tags can simply be typed into the buffer at the end of a headline.
2388 After a colon, `M-<TAB>' offers completion on tags. There is also a
2389 special command for inserting tags:
2392 Enter new tags for the current headline. Org-mode will either
2393 offer completion or a special single-key interface for setting
2394 tags, see below. After pressing <RET>, the tags will be inserted
2395 and aligned to `org-tags-column'. When called with a `C-u'
2396 prefix, all tags in the current buffer will be aligned to that
2397 column, just to make things look nice. TAGS are automatically
2398 realigned after promotion, demotion, and TODO state changes (*note
2401 Org will support tag insertion based on a _list of tags_. By
2402 default this list is constructed dynamically, containing all tags
2403 currently used in the buffer. You may also globally specify a hard list
2404 of tags with the variable `org-tag-alist'. Finally you can set the
2405 allowed tags for a given file with lines like
2407 #+TAGS: @WORK @HOME @TENNISCLUB
2408 #+TAGS: Laptop Car PC Sailboat
2410 The default support method is minibuffer completion. However,
2411 Org-mode also implements a much better method: _fast tag selection_.
2412 This method allows to select and deselect tags with a single key per
2413 tag. To function efficiently, you should assign unique keys to all
2414 tags. This can be done globally with
2416 (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
2418 or on a per-file basis with
2420 #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
2422 You can also group together tags that are mutually exclusive. With
2425 #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
2427 you indicate that at most one of `@WORK', `@HOME', and `@SAILBOAT'
2430 Don't forget to press `C-c C-c' with the cursor in one of these lines
2431 to activate any changes.
2433 If at least one tag has a selection key, pressing `C-c C-c' will
2434 automatically present you with a special interface, listing inherited
2435 tags, the tags of the current headline, and a list of all legal tags
2436 with corresponding keys(2). Pressing keys for the tags will add or
2437 remove them from the list of tags in the current line. Selecting a tag
2438 in a group of mutually exclusive tags will turn off any other tags from
2439 that group. <SPC> clears all tags for this line, `RET' accepts the
2440 modified set, and `C-g' aborts without installing changes. This method
2441 lets you assign tags to a headline with very few keys. With the above
2442 setup, you could clear the current tags and set `@HOME', `Laptop' and
2443 `PC' tags with just the following keys: `C-c C-c <SPC> h l p <RET>'.
2444 Switching from `@HOME' to `@WORK' would be done with `C-c C-c w <RET>'.
2446 What if you have globally defined your preferred set of tags using
2447 the variable `org-tag-alist', but would like to use a dynamic tag list
2448 in a specific file? Just add an empty TAGS option line to that file:
2452 ---------- Footnotes ----------
2454 (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
2455 respectively. Several groups are allowed.
2457 (2) Keys will automatically assigned to tags which have no
2461 File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
2466 Once a tags system has been set up, it can be used to collect related
2467 information into special lists.
2470 Create a sparse tree with all headlines matching a tags search.
2473 Create a global list of tag matches from all agenda files. *Note
2474 Matching headline tags::.
2477 Create a global list of tag matches from all agenda files, but
2478 check only TODO items and force checking subitems (see variable
2479 `org-tags-match-list-sublevels').
2481 A tags search string can use Boolean operators `&' for AND and `|'
2482 for OR. `&' binds more strongly than `|'. Parenthesis are currently
2483 not implemented. A tag may also be preceded by `-', to select against
2484 it, and `+' is syntactic sugar for positive selection. The AND
2485 operator `&' is optional when `+' or `-' is present. For example,
2486 `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
2487 discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
2488 selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
2489 `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
2493 File: org, Node: Agenda views, Next: Embedded LaTeX, Prev: Tags, Up: Top
2498 Due to the way Org-mode works, TODO items, time-stamped items, and
2499 tagged headlines can be scattered throughout a file or even a number of
2500 files. To get an overview over open action items, or over events that
2501 are important for a particular date, this information must be collected,
2502 sorted and displayed in an organized way.
2504 Org-mode can select items based on various criteria, and display them
2505 in a separate buffer. Three different views are provided:
2507 * an _agenda_ that is like a calendar and shows information for
2510 * a _TODO list_ that covers all unfinished action items, and
2512 * a _tags view_ that shows information based on the tags associated
2513 with headlines in the outline tree.
2515 The extracted information is displayed in a special _agenda buffer_.
2516 This buffer is read-only, but provides commands to visit the
2517 corresponding locations in the original Org-mode files, and even to
2518 edit these files remotely.
2522 * Agenda files:: Files being searched for agenda information
2523 * Agenda dispatcher:: Keyboard access to agenda views
2524 * Weekly/Daily agenda:: The calendar page with current tasks
2525 * Global TODO list:: All unfinished action items
2526 * Matching headline tags:: Structured information with fine-tuned search
2527 * Timeline:: Time-sorted view for single file
2528 * Agenda commands:: Remote editing of org trees
2531 File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
2536 The information to be shown is collected from all _agenda files_, the
2537 files listed in the variable `org-agenda-files'(1). Thus even if you
2538 only work with a single Org-mode file, this file should be put into
2539 that list(2). You can customize `org-agenda-files', but the easiest
2540 way to maintain it is through the following commands
2543 Add current file to the list of agenda files. The file is added to
2544 the front of the list. If it was already in the list, it is moved
2545 to the front. With prefix arg, file is added/moved to the end.
2548 Remove current file from the list of agenda files.
2551 Cycle through agenda file list, visiting one file after the other.
2553 The Org menu contains the current list of files and can be used to
2556 ---------- Footnotes ----------
2558 (1) If the value of that variable is not a list, but a single file
2559 name, then the list of agenda files will be maintained in that external
2562 (2) When using the dispatcher pressing `1' before selecting a
2563 command will actually limit the command to the current file, and ignore
2564 `org-agenda-files' until the next dispatcher command.
2567 File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
2569 8.2 The agenda dispatcher
2570 =========================
2572 The views are created through a dispatcher that should be bound to a
2573 global key, for example `C-c a' (*note Installation::). In the
2574 following we will assume that `C-c a' is indeed how the dispatcher is
2575 accessed and list keyboard access to commands accordingly. After
2576 pressing `C-c a', an additional letter is required to execute a
2577 command. The dispatcher offers the following default commands:
2579 Create the calendar-like agenda (*note Weekly/Daily agenda::).
2582 Create a list of all TODO items (*note Global TODO list::).
2585 Create a list of headlines matching a TAGS expression (*note
2586 Matching headline tags::).
2588 You can also define custom commands that will be accessible through
2589 the dispatcher, just like the default commands. Custom commands are
2590 global searches for tags and specific TODO keywords, or a variety of
2591 sparse tree creating commands (*note Sparse trees::). As sparse trees
2592 are only defined for a single org-mode file, these latter commands act
2593 on the current buffer instead of the list of agenda files.
2595 Custom commands are configured in the variable
2596 `org-agenda-custom-commands'. You can customize this variable, for
2597 example by pressing `C-c a C'. You can also directly set it with Emacs
2598 Lisp in `.emacs'. For example:
2600 (setq org-agenda-custom-commands
2601 '(("w" todo "WAITING")
2602 ("u" tags "+BOSS-URGENT")
2603 ("U" tags-tree "+BOSS-URGENT")
2604 ("f" occur-tree "\\<FIXME\\>")))
2606 will define `C-c a w' as a global search for TODO entries with
2607 `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
2608 headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
2609 search but only in the current buffer and display the result as a
2610 sparse tree, and `C-c a f' to create a sparse tree with all entries
2611 containing the word `FIXME'. For more information, look at the
2612 documentation string of the variable `org-agenda-custom-commands'.
2615 File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
2617 8.3 The weekly/daily agenda
2618 ===========================
2620 The purpose of the weekly/daily _agenda_ is to act like a page of a
2621 paper agenda, showing all the tasks for the current week or day.
2624 Compile an agenda for the current week from a list of org files.
2625 The agenda shows the entries for each day. With a `C-u' prefix (or
2626 when the variable `org-agenda-include-all-todo' is `t'), all
2627 unfinished TODO items (including those without a date) are also
2628 listed at the beginning of the buffer, before the first date.
2630 Remote editing from the agenda buffer means, for example, that you
2631 can change the dates of deadlines and appointments from the agenda
2632 buffer. The commands available in the Agenda buffer are listed in
2633 *Note Agenda commands::.
2637 * Categories:: Not all tasks are equal
2638 * Time-of-day specifications:: How the agenda knows the time
2639 * Calendar/Diary integration:: Integrating Anniversaries and more
2640 * Sorting of agenda items:: The order of things
2643 File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
2648 In the agenda buffer, each entry is preceded by a _category_, which is
2649 derived from the file name. The category can also be set with a
2650 special line anywhere in the buffer, looking like this:
2654 If there are several such lines in a file, each specifies the
2655 category for the text below it (but the first category also applies to
2656 any text before the first CATEGORY line). The display in the agenda
2657 buffer looks best if the category is not longer than 10 characters.
2660 File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily agenda
2662 8.3.2 Time-of-Day Specifications
2663 --------------------------------
2665 Org-mode checks each agenda item for a time-of-day specification. The
2666 time can be part of the time stamp that triggered inclusion into the
2667 agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
2668 specified with two time stamps, like
2669 `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
2671 In the headline of the entry itself, a time(range) may also appear as
2672 plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
2673 Emacs diary (*note Calendar/Diary integration::), time specifications
2674 in diary entries are recognized as well.
2676 For agenda display, Org-mode extracts the time and displays it in a
2677 standard 24 hour format as part of the prefix. The example times in
2678 the previous paragraphs would end up in the agenda like this:
2680 8:30-13:00 Arthur Dent lies in front of the bulldozer
2681 12:45...... Ford Prefect arrives and takes Arthur to the pub
2682 19:00...... The Vogon reads his poem
2683 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2685 If the agenda is in single-day mode, or for the display of today, the
2686 timed entries are embedded in a time grid, like
2688 8:00...... ------------------
2689 8:30-13:00 Arthur Dent lies in front of the bulldozer
2690 10:00...... ------------------
2691 12:00...... ------------------
2692 12:45...... Ford Prefect arrives and takes Arthur to the pub
2693 14:00...... ------------------
2694 16:00...... ------------------
2695 18:00...... ------------------
2696 19:00...... The Vogon reads his poem
2697 20:00...... ------------------
2698 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
2700 The time grid can be turned on and off with the variable
2701 `org-agenda-use-time-grid', and can be configured with
2702 `org-agenda-time-grid'.
2705 File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily agenda
2707 8.3.3 Calendar/Diary integration
2708 --------------------------------
2710 Emacs contains the calendar and diary by Edward M. Reingold. The
2711 calendar displays a three-month calendar with holidays from different
2712 countries and cultures. The diary allows you to keep track of
2713 anniversaries, lunar phases, sunrise/set, recurrent appointments
2714 (weekly, monthly) and more. In this way, it is quite complementary to
2715 Org-mode. It can be very useful to combine output from Org-mode with
2718 In order to include entries from the Emacs diary into Org-mode's
2719 agenda, you only need to customize the variable
2721 (setq org-agenda-include-diary t)
2723 After that, everything will happen automatically. All diary entries
2724 including holidays, anniversaries etc will be included in the agenda
2725 buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
2726 the agenda buffer to jump to the diary file in order to edit existing
2727 diary entries. The `i' command to insert new entries for the current
2728 date works in the agenda buffer, as well as the commands `S', `M', and
2729 `C' to display Sunrise/Sunset times, show lunar phases and to convert
2730 to other calendars, respectively. `c' can be used to switch back and
2731 forth between calendar and agenda.
2734 File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily agenda
2736 8.3.4 Sorting of agenda items
2737 -----------------------------
2739 The entries for each day are sorted. The default order is to first
2740 collect all items containing an explicit time-of-day specification.
2741 These entries will be shown at the beginning of the list, as a
2742 _schedule_ for the day. After that, items remain grouped in
2743 categories, in the sequence given by `org-agenda-files'. Within each
2744 category, items are sorted by priority (*note Priorities::).
2746 The priority is a numerical quantity composed of the base priority
2747 (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
2748 increments for overdue scheduled or deadline items.
2750 Sorting can be customized using the variable
2751 `org-agenda-sorting-strategy'.
2754 File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
2756 8.4 The global TODO list
2757 ========================
2759 The global TODO list contains all unfinished TODO items, formatted and
2760 collected into a single place.
2763 Show the global TODO list. This collects the TODO items from all
2764 agenda files (*note Agenda views::) into a single buffer. The
2765 buffer is in `agenda-mode', so there are commands to examine and
2766 manipulate the TODO entries directly from that buffer (*note
2770 Like the above, but allows selection of a specific TODO keyword.
2771 You can also do this by specifying a prefix argument to `C-c a t'.
2772 With a `C-u' prefix you are prompted for a keyword. With a
2773 numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
2774 `r' key in the agenda buffer regenerates it, and you can give a
2775 prefix argument to this command to change the selected TODO
2776 keyword, for example `3 r'. If you often need a search for a
2777 specific keyword, define a custom command for it (*note Agenda
2780 Remote editing of TODO items means that you can change the state of a
2781 TODO entry with a single key press. The commands available in the TODO
2782 list are described in *Note Agenda commands::.
2784 Nomally the global todo list simply shows all headlines with TODO
2785 keywords. This list can become very long. There are two ways to keep
2787 - Some people view a TODO item that has been _scheduled_ for
2788 execution (*note Time stamps::) as no longer _open_. Configure the
2789 variable `org-agenda-todo-ignore-scheduled' to exclude scheduled
2790 items from the global TODO list.
2792 - TODO items may have sublevels to break up the task into subtasks.
2793 In such cases it may be enough to list only the highest level TODO
2794 headline and omit the sublevels from the global list. Configure
2795 the variable `org-agenda-todo-list-sublevels' to get this behavior.
2798 File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
2800 8.5 Matching headline tags
2801 ==========================
2803 If headlines in the agenda files are marked with _tags_ (*note Tags::),
2804 you can select headlines based on the tags that apply to them and
2805 collect them into an agenda buffer.
2808 Produce a list of all headlines that match a given set of tags.
2809 The command prompts for a selection criterion, which is a boolean
2810 logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
2811 `WORK|HOME' (*note Tags::). If you often need a specific search,
2812 define a custom command for it (*note Agenda dispatcher::).
2815 Like `C-c a m', but only select headlines that are also TODO items
2816 and force checking subitems (see variable
2817 `org-tags-match-list-sublevels'.
2819 The commands available in the tags list are described in *Note
2823 File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda views
2825 8.6 Timeline for a single file
2826 ==============================
2828 The timeline is not really an agenda view, because it only summarizes
2829 items from a single Org-mode file. But it also uses the agenda buffer
2830 and provides similar commands, so we discuss it here. The timeline
2831 shows all time-stamped items in a single Org-mode file (or the selected
2832 part of it), in a _time-sorted view_. The main purpose of this command
2833 is to give an overview over events in a project.
2836 Show a time-sorted view of the org file, with all time-stamped
2837 items. When called with a `C-u' prefix, all unfinished TODO
2838 entries (scheduled or not) are also listed under the current date.
2840 The commands available in the timeline buffer are listed in *Note
2844 File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda views
2846 8.7 Commands in the agenda buffer
2847 =================================
2849 Entries in the agenda buffer are linked back to the org file or diary
2850 file where they originate. You are not allowed to edit the agenda
2851 buffer itself, but commands are provided to show and jump to the
2852 original entry location, and to edit the org-files "remotely" from the
2853 agenda buffer. In this way, all information is stored only once,
2854 removing the risk that your agenda and note files may diverge.
2856 Some commands can be executed with mouse clicks on agenda lines. For
2857 the other commands, the cursor needs to be in the desired line.
2863 Next line (same as <up>).
2866 Previous line (same as <down>).
2873 Display the original location of the item in another window.
2876 Display original location and recenter that window.
2881 Go to the original location of the item in another window. Under
2882 Emacs 22, `mouse-1' will also works for this.
2885 Go to the original location of the item and delete other windows.
2888 Toggle Follow mode. In Follow mode, as you move the cursor through
2889 the agenda buffer, the other window always shows the corresponding
2890 location in the org file. The initial setting for this mode in new
2891 agenda buffers can be set with the variable
2892 `org-agenda-start-with-follow-mode'.
2895 Toggle Logbook mode. In Logbook mode, entries that where marked
2896 DONE while logging was on (variable `org-log-done') are shown in
2897 the agenda, as are entries that have been clocked on that day.
2903 Delete other windows.
2906 Switch to weekly view (7 days displayed together).
2909 Switch to daily view (just one day displayed).
2912 Toggle the inclusion of diary entries. See *Note Calendar/Diary
2916 Toggle the time grid on and off. See also the variables
2917 `org-agenda-use-time-grid' and `org-agenda-time-grid'.
2920 Recreate the agenda buffer, for example to reflect the changes
2921 after modification of the time stamps of items with S-<left> and
2922 S-<right>. When the buffer is the global todo list, a prefix
2923 argument is interpreted to create a selective list for a specific
2927 Save all Org-mode buffers in the current Emacs session.
2930 Display the following `org-agenda-ndays' days. For example, if
2931 the display covers a week, switch to the following week. With
2932 prefix arg, go forward that many times `org-agenda-ndays' days.
2935 Display the previous dates.
2947 Change the TODO state of the item, both in the agenda and in the
2951 Show all tags associated with the current item. Because of
2952 inheritance, this may be more than the tags listed in the line
2956 Set tags for the current headline.
2959 Toggle the ARCHIVE tag for the current headline.
2962 Set the priority for the current item. Org-mode prompts for the
2963 priority character. If you reply with <SPC>, the priority cookie
2964 is removed from the entry.
2967 Display weighted priority of current item.
2971 Increase the priority of the current item. The priority is
2972 changed in the original buffer, but the agenda is not resorted.
2973 Use the `r' key for this.
2977 Decrease the priority of the current item.
2983 Set a deadline for this item.
2986 Change the time stamp associated with the current line by one day
2987 into the future. With prefix argument, change it by that many
2988 days. For example, `3 6 5 S-<right>' will change it by a year.
2989 The stamp is changed in the original org file, but the change is
2990 not directly reflected in the agenda buffer. Use the `r' key to
2994 Change the time stamp associated with the current line by one day
2998 Change the time stamp associated with the current line to today.
2999 The key `>' has been chosen, because it is the same as `S-.' on my
3003 Start the clock on the current item. If a clock is running
3004 already, it is stopped first.
3007 Stop the previously started clock.
3010 Cancel the currently running clock.
3016 Open the Emacs calendar and move to the date at the agenda cursor.
3019 When in the calendar, compute and show the Org-mode agenda for the
3023 Insert a new entry into the diary. Prompts for the type of entry
3024 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
3025 new entry in the diary, just as `i d' etc. would do in the
3026 calendar. The date is taken from the cursor position.
3029 Show the phases of the moon for the three months around current
3033 Show sunrise and sunset times. The geographical location must be
3034 set with calendar variables, see documentation of the Emacs
3038 Convert the date at cursor into many other cultural and historic
3042 Show holidays for three month around the cursor date.
3045 Export a single iCalendar file containing entries from all agenda
3052 Quit agenda, remove the agenda buffer.
3055 Exit agenda, remove the agenda buffer and all buffers loaded by
3056 Emacs for the compilation of the agenda. Buffers created by the
3057 user to visit org files will not be removed.
3061 File: org, Node: Embedded LaTeX, Next: Exporting, Prev: Agenda views, Up: Top
3066 Plain ASCII is normally sufficient for almost all note taking. One
3067 exception, however, are scientific notes which need to be able to
3068 contain mathematical symbols and the occasional formula. LaTeX(1) is
3069 widely used to typeset scientific documents. Org-mode supports
3070 embedding LaTeX code into its files, because many academics are used to
3071 read LaTeX source code, and because it can be readily processed into
3072 images for HTML production.
3074 It is not necessary to mark LaTeX macros and code in any special way.
3075 If you observe a few conventions, Org-mode knows how to find it and what
3080 * Math symbols:: TeX macros for symbols and Greek letters
3081 * Subscripts and Superscripts:: Simple syntax for raising/lowering text
3082 * LaTeX fragments:: Complex formulas made easy
3083 * Processing LaTeX fragments:: Previewing LaTeX processing
3084 * CDLaTeX mode:: Speed up entering of formulas
3086 ---------- Footnotes ----------
3088 (1) LaTeX is a macro system based on Donald E. Knuth's TeX system.
3089 Many of the features described here as "LaTeX" are really from TeX, but
3090 for simplicity I am blurring this distinction.
3093 File: org, Node: Math symbols, Next: Subscripts and Superscripts, Prev: Embedded LaTeX, Up: Embedded LaTeX
3098 You can use LaTeX macros to insert special symbols like `\alpha' to
3099 indicate the Greek letter, or `\to' to indicate an arrow. Completion
3100 for these macros is available, just type `\' and maybe a few letters,
3101 and press `M-<TAB>' to see possible completions. Unlike LaTeX code,
3102 Org-mode allows these macros to be present without surrounding math
3103 delimiters, for example:
3105 Angles are written as Greek letters \alpha, \beta and \gamma.
3107 During HTML export (*note HTML export::), these symbols are
3108 translated into the proper syntax for HTML, for the above examples this
3109 is `α' and `→', respectively.
3112 File: org, Node: Subscripts and Superscripts, Next: LaTeX fragments, Prev: Math symbols, Up: Embedded LaTeX
3114 9.2 Subscripts and Superscripts
3115 ===============================
3117 Just like in LaTeX, `^' and `_' are used to indicate super- and
3118 subscripts. Again, these can be used without embedding them in
3119 math-mode delimiters. To increase the readability of ASCII text, it is
3120 not necessary (but OK) to surround multi-character sub- and superscripts
3121 with curly braces. For example
3123 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
3124 the sun is R_{sun} = 6.96 x 10^8 m.
3126 To avoid interpretation as raised or lowered text, you can quote `^'
3127 and `_' with a backslash: `\_' and `\^'.
3129 During HTML export (*note HTML export::), subscript and superscripts
3130 are surrounded with `<sub>' and `<sup>' tags, respectively.
3133 File: org, Node: LaTeX fragments, Next: Processing LaTeX fragments, Prev: Subscripts and Superscripts, Up: Embedded LaTeX
3138 With symbols, sub- and superscripts, HTML is pretty much at its end when
3139 it comes to representing mathematical formulas. More complex
3140 expressions need a dedicated formula processor. To this end, Org-mode
3141 can contain arbitrary LaTeX fragments. It provides commands to preview
3142 the typeset result of these fragments, and upon export to HTML, all
3143 fragments will be converted to images and inlined into the HTML
3144 document. For this to work you need to be on a system with a working
3145 LaTeX installation. You also need the `dvipng' program, available at
3146 `http://sourceforge.net/projects/dvipng/'.
3148 LaTeX fragments don't need any special marking at all. The following
3149 snippets will be identified as LaTeX source code:
3150 * Environments of any kind. The only requirement is that the
3151 `\begin' statement appears on a new line, preceded by only
3154 * Text within the usual LaTeX math delimiters. To avoid conflicts
3155 with currency specifications, single `$' characters are only
3156 recognized as math delimiters if the enclosed text contains at
3157 most two line breaks, is directly attached to the `$' characters
3158 with no whitespace in between, and if the closing `$' is followed
3159 by whitespace or punctuation. For the other delimiters, there is
3160 no such restriction, so when in doubt, use `\(...\)' as inline
3165 \begin{equation} % arbitrary environments,
3166 x=\sqrt{b} % even tables, figures
3167 \end{equation} % etc
3169 If $a^2=b$ and \( b=2 \), then the solution must be
3170 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
3172 If you need any of the delimiter ASCII sequences for other purposes, you
3173 can configure the option `org-format-latex-options' to deselect the
3174 ones you do not wish to have interpreted by the LaTeX converter.
3177 File: org, Node: Processing LaTeX fragments, Next: CDLaTeX mode, Prev: LaTeX fragments, Up: Embedded LaTeX
3179 9.4 Processing LaTeX fragments
3180 ==============================
3182 LaTeX fragments can be processed to produce a preview images of the
3183 typeset expressions:
3186 Produce a preview image of the LaTeX fragment at point and overlay
3187 it over the source code. If there is no fragment at point,
3188 process all fragments in the current entry (between two
3189 headlines). When called with a prefix argument, process the
3190 entire subtree. When called with two prefix arguments, or when
3191 the cursor is before the first headline, process the entire buffer.
3194 Remove the overlay preview images.
3196 During HTML export (*note HTML export::), all LaTeX fragments are
3197 converted into images and inlined into the document if the following
3200 (setq org-export-with-LaTeX-fragments t)
3203 File: org, Node: CDLaTeX mode, Prev: Processing LaTeX fragments, Up: Embedded LaTeX
3205 9.5 Using CDLaTeX to enter math
3206 ===============================
3208 CDLaTeX-mode is a minor mode that is normally used in combination with a
3209 major LaTeX mode like AUCTeX in order to speed-up insertion of
3210 environments and math templates. Inside Org-mode, you can make use of
3211 some of the features of cdlatex-mode. You need to install `cdlatex.el'
3212 and `texmathp.el' (the latter comes also with AUCTeX) from
3213 `http://www.astro.uva.nl/~dominik/Tools/cdlatex'. Don't turn
3214 cdlatex-mode itself under Org-mode, but use the light version
3215 `org-cdlatex-mode' that comes as part of Org-mode. Turn it on for the
3216 current buffer with `M-x org-cdlatex-mode', or for all Org-mode files
3219 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
3221 When this mode is enabled, the following features are present (for
3222 more details see the documentation of cdlatex-mode):
3223 * Environment templates can be inserted with `C-c {'.
3225 * The <TAB> key will do template expansion if the cursor is inside a
3226 LaTeX fragment(1). For example, <TAB> will expand `fr' to
3227 `\frac{}{}' and position the cursor correctly inside the first
3228 brace. Another <TAB> will get you into the second brace. Even
3229 outside fragments, <TAB> will expand environment abbreviations at
3230 the beginning of a line. For example, if you write `equ' at the
3231 beginning of a line and press <TAB>, this abbreviation will be
3232 expanded to an `equation' environment. To get a list of all
3233 abbreviations, type `M-x cdlatex-command-help'.
3235 * Pressing `_' and `^' inside a LaTeX fragment will insert these
3236 characters together with a pair of braces. If you use <TAB> to
3237 move out of the braces, and if the braces surround only a single
3238 character or macro, they are removed again (depending on the
3239 variable `cdlatex-simplify-sub-super-scripts').
3241 * Pressing the backquote ``' followed by a character inserts math
3242 macros, also outside LaTeX fragments. If you wait more than 1.5
3243 seconds after the backquote, a help window will pop up.
3245 * Pressing the normal quote `'' followed by another character
3246 modifies the symbol before point with an accent or a font. If you
3247 wait more than 1.5 seconds after the backquote, a help window will
3248 pop up. Character modification will work only inside LaTeX
3249 fragments, outside the quote is normal.
3251 ---------- Footnotes ----------
3253 (1) Org-mode has a method to test if the cursor is inside such a
3254 fragment, see the documentation of the function
3255 `org-inside-LaTeX-fragment-p'.
3258 File: org, Node: Exporting, Next: Publishing, Prev: Embedded LaTeX, Up: Top
3263 Org-mode documents can be exported into a variety of other formats. For
3264 printing and sharing of notes, ASCII export produces a readable and
3265 simple version of an Org-mode file. HTML export allows you to publish a
3266 notes file on the web, while the XOXO format provides a solid base for
3267 exchange with a broad range of other applications. To incorporate
3268 entries with associated times like deadlines or appointments into a
3269 desktop calendar program like iCal, Org-mode can also produce extracts
3270 in the iCalendar format. Currently Org-mode only supports export, not
3271 import of these different formats.
3273 When exporting, Org-mode uses special conventions to enrich the
3274 output produced. *Note Text interpretation::, for more details.
3277 Dispatcher for export and publishing commands. Displays a
3278 help-window listing the additional key(s) needed to launch an
3279 export or publishing command.
3283 * ASCII export:: Exporting to plain ASCII
3284 * HTML export:: Exporting to HTML
3285 * XOXO export:: Exporting to XOXO
3286 * iCalendar export:: Exporting in iCalendar format
3287 * Text interpretation:: How the exporter looks at the file
3290 File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
3295 ASCII export produces a simple and very readable version of an Org-mode
3299 Export as ASCII file. If there is an active region, only the
3300 region will be exported. For an org file `myfile.org', the ASCII
3301 file will be `myfile.txt'. The file will be overwritten without
3305 Export only the visible part of the document.
3307 In the exported version, the first 3 outline levels will become
3308 headlines, defining a general document structure. Additional levels
3309 will be exported as itemized lists. If you want that transition to
3310 occur at a different level, specify it with a prefix argument. For
3315 creates only top level headlines and does the rest as items. When
3316 headlines are converted to items, the indentation of the text following
3317 the headline is changed to fit nicely under the item. This is done with
3318 the assumption that the first bodyline indicates the base indentation of
3319 the body text. Any indentation larger than this is adjusted to preserve
3320 the layout relative to the first line. Should there be lines with less
3321 indentation than the first, these are left alone.
3324 File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
3329 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
3330 HTML formatting, in ways similar to John Grubers _markdown_ language,
3331 but with additional support for tables.
3334 Export as HTML file `myfile.html'.
3337 Export as HTML file and open it with a browser.
3342 Export only the visible part of the document.
3344 In the exported version, the first 3 outline levels will become
3345 headlines, defining a general document structure. Additional levels
3346 will be exported as itemized lists. If you want that transition to
3347 occur at a different level, specify it with a prefix argument. For
3352 creates two levels of headings and does the rest as items.
3354 If you want to include HTML tags which should be interpreted as such,
3355 mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
3356 always transformed to `<' and `>' in HTML export.
3358 Internal links (*note Internal links::) will continue to work in HTML
3359 files only if they match a dedicated `<<target>>'. Automatic links
3360 created by radio targets (*note Radio targets::) will also work in the
3361 HTML file. Links to external files will still work if the HTML file is
3362 in the same directory as the Org-mode file. Links to other `.org'
3363 files will be translated into HTML links under the assumption that an
3364 HTML version also exists of the linked file. For information related to
3365 linking files while publishing them to a publishing directory see *Note
3368 You can also give style information for the exported file. The HTML
3369 exporter assigns the following CSS classes to appropriate parts of the
3370 document - your style specifications may change these:
3372 .done the DONE keyword
3373 .timestamp time stamp
3374 .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
3375 .tag tag in a headline
3376 .target target for links
3378 The default style specification can be configured through the option
3379 `org-export-html-style'. If you want to use a file-local style, you
3380 may use file variables, best wrapped into a COMMENT section at the end
3381 of the outline tree. For example:
3383 * COMMENT HTML style specifications
3386 # org-export-html-style: " <style type=\"text/css\">
3387 # p {font-weight: normal; color: gray; }
3388 # h1 {color: black; }
3392 Remember to execute `M-x normal-mode' after changing this to make
3393 the new style visible to Emacs. This command restarts org-mode for the
3394 current buffer and forces Emacs to re-evaluate the local variables
3395 section in the buffer.
3398 File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
3403 Org-mode contains an exporter that produces XOXO-style output.
3404 Currently, this exporter only handles the general outline structure and
3405 does not interpret any additional Org-mode features.
3408 Export as XOXO file `myfile.html'.
3411 Export only the visible part of the document.
3414 File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
3416 10.4 iCalendar export
3417 =====================
3419 Some people like to use Org-mode for keeping track of projects, but
3420 still prefer a standard calendar application for anniversaries and
3421 appointments. In this case it can be useful to have deadlines and
3422 other time-stamped items in Org-mode files show up in the calendar
3423 application. Org-mode can export calendar information in the standard
3427 Create iCalendar entries for the current file and store them in
3428 the same directory, using a file extension `.ics'.
3431 Like `C-c C-e i', but do this for all files in `org-agenda-files'.
3432 For each of these files, a separate iCalendar file will be
3436 Create a single large iCalendar file from all files in
3437 `org-agenda-files' and write it to the file given by
3438 `org-combined-agenda-icalendar-file'.
3440 How this calendar is best read and updated, depends on the
3441 application you are using. For example, when using iCal under Apple
3442 MacOS X, you could create a new calendar `OrgMode' (the default name
3443 for the calendar created by `C-c C-e c', see the variables
3444 `org-icalendar-combined-name' and
3445 `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
3446 the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
3447 use AppleScript to make iCal re-read the calendar files each time a new
3448 version of `OrgMode.ics' is produced. Here is the setup needed for
3451 (setq org-combined-agenda-icalendar-file
3452 "~/Library/Calendars/OrgMode.ics")
3453 (add-hook 'org-after-save-iCalendar-file-hook
3456 "osascript -e 'tell application \"iCal\" to reload calendars'")))
3459 File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
3461 10.5 Text interpretation by the exporter
3462 ========================================
3464 The exporter backends interpret additional structure in the Org-mode
3465 file in order to produce better output.
3469 * Comment lines:: Some lines will not be exported
3470 * Enhancing text:: Subscripts, symbols and more
3471 * Export options:: How to influence the export settings
3474 File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
3476 10.5.1 Comment lines
3477 --------------------
3479 Lines starting with `#' in column zero are treated as comments and will
3480 never be exported. Also entire subtrees starting with the word
3481 `COMMENT' will never be exported. Finally, any text before the first
3482 headline will not be exported either.
3485 Toggle the COMMENT keyword at the beginning of an entry.
3488 File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
3490 10.5.2 Enhancing text for export
3491 --------------------------------
3493 Some of the export backends of Org-mode allow for sophisticated text
3494 formatting, this is true in particular for the HTML backend. Org-mode
3495 has a number of typing conventions that allow to produce a richly
3498 * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
3499 enumerator will be recognized and transformed if the backend
3500 supports lists. See *Note Plain lists::.
3502 * You can make words *bold*, /italic/, _underlined_, `=code=', and
3505 * Many TeX macros and entire LaTeX fragments are converted into HTML
3506 entities or images (*note Embedded LaTeX::).
3508 * Tables are transformed into native tables under the exporter, if
3509 the export backend supports this. Data fields before the first
3510 horizontal separator line will be formatted as table header fields.
3512 * If a headline starts with the word `QUOTE', the text below the
3513 headline will be typeset as fixed-width, to allow quoting of
3514 computer codes etc. Lines starting with `:' are also typeset in
3517 Toggle fixed-width for entry (QUOTE) or region, see below.
3519 * A double backslash _at the end of a line_ enforces a line break at
3522 If these conversions conflict with your habits of typing ASCII text,
3523 they can all be turned off with corresponding variables (see the
3524 customization group `org-export-general', and the following section
3525 which explains how to set export options with special lines in a buffer.
3528 File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
3530 10.5.3 Export options
3531 ---------------------
3533 The exporter recognizes special lines in the buffer which provide
3534 additional information. These lines may be put anywhere in the file.
3535 The whole set of lines can be inserted into the buffer with `C-c C-e
3536 t'. For individual lines, a good way to make sure the keyword is
3537 correct is to type `#+' and then use `M-<TAB>' completion (*note
3541 Insert template with export options, see example below.
3543 #+TITLE: the title to be shown (default is the buffer name)
3544 #+AUTHOR: the author (default taken from `user-full-name')
3545 #+EMAIL: his/her email address (default from `user-mail-address')
3546 #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
3547 #+TEXT: Some descriptive text to be inserted at the beginning.
3548 #+TEXT: Several lines may be given.
3549 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t LaTeX:t
3551 The OPTIONS line is a compact form to specify export settings. Here
3553 H: set the number of headline levels for export
3554 num: turn on/off section-numbers
3555 toc: turn on/off table of contents
3556 \n: turn on/off linebreak-preservation
3557 @: turn on/off quoted HTML tags
3558 :: turn on/off fixed-width sections
3559 |: turn on/off tables
3560 ^: turn on/off TeX-like syntax for sub- and superscripts.
3561 *: turn on/off emphasized text (bold, italic, underlined)
3562 TeX: turn on/off simple TeX macros in plain text
3563 LaTeX: turn on/off LaTeX fragments
3566 File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
3571 Org-mode includes(1) a publishing management system that allows you to
3572 configure automatic HTML conversion of _projects_ composed of
3573 interlinked org files. This system is called _org-publish_. You can
3574 also configure org-publish to automatically upload your exported HTML
3575 pages and related attachments, such as images and source code files, to
3576 a web server. Org-publish turns org-mode into a web-site authoring
3579 Org-publish has been contributed to Org-mode by David O'Toole.
3583 * Configuration:: Defining projects
3584 * Sample configuration:: Example projects
3585 * Triggering publication:: Publication commands
3587 ---------- Footnotes ----------
3589 (1) `org-publish.el' is not yet part of emacs, so if you are using
3590 `org.el' as it comes with Emacs, you need to download this file
3591 separately. Also make sure org.el is at least version 4.27.
3594 File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
3599 Publishing needs significant configuration to specify files, destination
3600 and many other properties of a project.
3604 * Project alist:: The central configuration variable
3605 * Sources and destinations:: From here to there
3606 * Selecting files:: What files are part of the project?
3607 * Publishing action:: Setting the function doing the publishing
3608 * Publishing options:: Tweaking HTML export
3609 * Publishing links:: Which links keep working after publishing?
3610 * Project page index:: Publishing a list of project files
3613 File: org, Node: Project alist, Next: Sources and destinations, Prev: Configuration, Up: Configuration
3615 11.1.1 The variable `org-publish-project-alist'
3616 -----------------------------------------------
3618 Org-publish is configured almost entirely through setting the value of
3619 one variable, called `org-publish-project-alist'. Each element of the
3620 list configures one project, and may be in one of the two following
3623 ("project-name" :property value :property value ...)
3627 ("project-name" :components ("project-name" "project-name" ...))
3629 In both cases, projects are configured by specifying property values.
3630 A project defines the set of files that will be published, as well as
3631 the publishing configuration to use when publishing those files. When
3632 a project takes the second form listed above, the individual members of
3633 the "components" property are taken to be components of the project,
3634 which group together files requiring different publishing options. When
3635 you publish such a "meta-project" all the components will also publish.
3638 File: org, Node: Sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
3640 11.1.2 Sources and destinations for files
3641 -----------------------------------------
3643 Most properties are optional, but some should always be set. In
3644 particular, org-publish needs to know where to look for source files,
3645 and where to put published files.
3647 `:base-directory' Directory containing publishing source files
3648 `:publishing-directory'Directory (possibly remote) where output files
3652 File: org, Node: Selecting files, Next: Publishing action, Prev: Sources and destinations, Up: Configuration
3654 11.1.3 Selecting files
3655 ----------------------
3657 By default, all files with extension `.org' in the base directory are
3658 considered part of the project. This can be modified by setting the
3660 `:base-extension' Extension (without the dot!) of source files. This
3661 actually is a regular expression.
3662 `:exclude' Regular expression to match file names that should
3663 not be published, even though they have been selected
3664 on the basis of their extension.
3665 `:include' List of files to be included regardless of
3666 `:base-extension' and `:exclude'.
3669 File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
3671 11.1.4 Publishing Action
3672 ------------------------
3674 Publishing means that a file is copied to the destination directory and
3675 possibly transformed in the process. The default transformation is to
3676 export Org-mode files as HTML files, and this is done by the function
3677 `org-publish-org-to-html' which calls the HTML exporter (*note HTML
3678 export::). Other files like images only need to be copied to the
3679 publishing destination. For non-Org-mode files, you need to specify
3680 the publishing function.
3682 `:publishing-function' Function executing the publication of a file.
3684 The function must accept two arguments: a property list containing at
3685 least a `:publishing-directory' property, and the name of the file to
3686 be published. It should take the specified file, make the necessary
3687 transformation (if any) and place the result into the destination
3688 folder. You can write your own publishing function, but `org-publish'
3689 provides one for attachments (files that only need to be copied):
3690 `org-publish-attachment'.
3693 File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
3695 11.1.5 Options for the HTML exporter
3696 ------------------------------------
3698 The property list can be used to set many export options for the HTML
3699 exporter. In most cases, these properties correspond to user variables
3700 in Org-mode. The table below lists these properties along with the
3701 variable they belong to. See the documentation string for the
3702 respective variable for details.
3704 `:language' `org-export-default-language'
3705 `:headline-levels' `org-export-headline-levels'
3706 `:section-numbers' `org-export-with-section-numbers'
3707 `:table-of-contents' `org-export-with-toc'
3708 `:archived-trees' `org-export-with-archived-trees'
3709 `:emphasize' `org-export-with-emphasize'
3710 `:sub-superscript' `org-export-with-sub-superscripts'
3711 `:TeX-macros' `org-export-with-TeX-macros'
3712 `:LaTeX-fragments' `org-export-with-LaTeX-fragments'
3713 `:fixed-width' `org-export-with-fixed-width'
3714 `:timestamps' `org-export-with-timestamps'
3716 `:tags' `org-export-with-tags'
3718 `:tables' `org-export-with-tables'
3719 `:table-auto-headline' `org-export-highlight-first-table-line'
3720 `:style' `org-export-html-style'
3721 `:convert-org-links' `org-export-html-link-org-files-as-html'
3722 `:inline-images' `org-export-html-inline-images'
3723 `:expand-quoted-html' `org-export-html-expand'
3724 `:timestamp' `org-export-html-with-timestamp'
3725 `:publishing-directory'`org-export-publishing-directory'
3726 `:preamble' `org-export-html-preamble'
3727 `:postamble' `org-export-html-postamble'
3728 `:auto-preamble' `org-export-html-auto-preamble'
3729 `:auto-postamble' `org-export-html-auto-postamble'
3730 `:author' `user-full-name'
3731 `:email' `user-mail-address'
3733 When a property is given a value in org-publish-project-alist, its
3734 setting overrides the value of the corresponding user variable (if any)
3735 during publishing. options set within a file (*note Export options::),
3736 however, override everything.
3739 File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
3741 11.1.6 Links between published files
3742 ------------------------------------
3744 To create a link from one Org-mode file to another, you would use
3745 something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
3746 (*note Hyperlinks::). Upon publishing this link becomes a link to
3747 `foo.html'. In this way, you can interlink the pages of your "org web"
3748 project and the links will work as expected when you publish them to
3751 You may also link to related files, such as images. Provided you are
3752 careful with relative pathnames, and provided you have also configured
3753 org-publish to upload the related files, these links will work too.
3754 *Note Complex example:: for an example of this usage.
3756 Sometime an Org-mode file to be published may contain links that are
3757 only valid in your production environment, but not in the publishing
3758 location. In this case, use the property
3760 `:link-validation-function' Function to validate links
3762 to define a function for checking link validity. This function must
3763 accept two arguments, the file name and a directory relative to which
3764 the file name is interpreted in the production environment. If this
3765 function returns `nil', then the HTML generator will only insert a
3766 description into the HTML file, but no link. One option for this
3767 function is `org-publish-validate-link' which checks if the given file
3768 is part of any project in `org-publish-project-alist'.
3771 File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
3773 11.1.7 Project page index
3774 -------------------------
3776 The following properties may be used to control publishing of an index
3777 of files or summary page for a given project.
3779 `:auto-index' When non-nil, publish an index during
3780 org-publish-current-project or org-publish-all.
3781 `:index-filename' Filename for output of index. Defaults to `index.org'
3782 (which becomes `index.html').
3783 `:index-title' Title of index page. Defaults to name of file.
3784 `:index-function' Plugin function to use for generation of index.
3785 Defaults to `org-publish-org-index', which generates
3786 a plain list of links to all files in the project.
3789 File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
3791 11.2 Sample configuration
3792 =========================
3794 Below we provide two example configurations. The first one is a simple
3795 project publishing only a set of Org-mode files. The second example is
3796 more complex, with a multi-component project.
3800 * Simple example:: One-component publishing
3801 * Complex example:: A multi-component publishing example
3804 File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
3806 11.2.1 Example: simple publishing configuration
3807 -----------------------------------------------
3809 This example publishes a set of Org-mode files to the `public_html'
3810 directory on the local machine.
3812 (setq org-publish-project-alist
3814 :base-directory "~/org/"
3815 :publishing-directory "~/public_html"
3816 :section-numbers nil
3817 :table-of-contents nil
3818 :style "<link rel=stylesheet
3819 href=\"../other/mystyle.css\"
3820 type=\"text/css\">")))
3823 File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
3825 11.2.2 Example: complex publishing configuration
3826 ------------------------------------------------
3828 This more complicated example publishes an entire website, including
3829 org files converted to HTML, image files, emacs lisp source code, and
3830 stylesheets. The publishing-directory is remote and private files are
3833 To ensure that links are preserved, care should be taken to replicate
3834 your directory structure on the web server, and to use relative file
3835 paths. For example, if your org files are kept in `~/org' and your
3836 publishable images in `~/images', you'd link to an image with
3837 file:../images/myimage.png
3838 On the web server, the relative path to the image should be the
3839 same. You can accomplish this by setting up an "images" folder in the
3840 right place on the webserver, and publishing images to it.
3842 (setq org-publish-project-alist
3844 :base-directory "~/org/"
3845 :base-extension "org"
3846 :publishing-directory "/ssh:user@host:~/html/notebook/"
3847 :publishing-function org-publish-org-to-html
3848 :exclude "PrivatePage.org" ;; regexp
3850 :section-numbers nil
3851 :table-of-contents nil
3852 :style "<link rel=stylesheet
3853 href=\"../other/mystyle.css\" type=\"text/css\">"
3855 :auto-postamble nil)
3858 :base-directory "~/images/"
3859 :base-extension "jpg\\|gif\\|png"
3860 :publishing-directory "/ssh:user@host:~/html/images/"
3861 :publishing-function org-publish-attachment)
3864 :base-directory "~/other/"
3865 :base-extension "css\\|el"
3866 :publishing-directory "/ssh:user@host:~/html/other/"
3867 :publishing-function org-publish-attachment)
3868 ("website" :components ("orgfiles" "images" "other"))))
3871 File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
3873 11.3 Triggering publication
3874 ===========================
3876 Once org-publish is properly configured, you can publish with the
3877 following functions:
3880 Prompt for a specific project and publish all files that belong to
3884 Publish the project containin the current file.
3887 Publish only the current file.
3890 Publish all projects.
3892 Org uses timestamps to track when a file has changed. The above
3893 functions normally only publish changed files. You can override this and
3894 force publishing of all files by giving a prefix argument.
3897 File: org, Node: Miscellaneous, Next: Extensions and Hacking, Prev: Publishing, Up: Top
3904 * Completion:: M-TAB knows what you need
3905 * Customization:: Adapting Org-mode to your taste
3906 * In-buffer settings:: Overview of the #+KEYWORDS
3907 * The very busy C-c C-c key:: When in doubt, press C-c C-c
3908 * Clean view:: Getting rid of leading stars in the outline
3909 * TTY keys:: Using Org-mode on a tty
3910 * Interaction:: Other Emacs packages
3911 * Bugs:: Things which do not work perfectly
3914 File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
3919 Org-mode supports in-buffer completion. This type of completion does
3920 not make use of the minibuffer. You simply type a few letters into the
3921 buffer and use the key to complete text right there.
3924 Complete word at point
3925 * At the beginning of a headline, complete TODO keywords.
3927 * After `\', complete TeX symbols supported by the exporter.
3929 * After `*', complete CamelCase versions of all headlines in the
3932 * After `:', complete tags used elsewhere in the buffer.
3934 * After `#+', complete the special keywords like `TYP_TODO' or
3935 `OPTIONS' which set file-specific options for Org-mode. When
3936 the option keyword is already complete, pressing `M-<TAB>'
3937 again will insert example settings for this keyword.
3939 * Elsewhere, complete dictionary words using ispell.
3942 File: org, Node: Customization, Next: In-buffer settings, Prev: Completion, Up: Miscellaneous
3947 There are more than 100 variables that can be used to customize
3948 Org-mode. For the sake of compactness of the manual, we are not
3949 describing the variables here. A structured overview of customization
3950 variables is available with `M-x org-customize'. Or select `Browse Org
3951 Group' from the `Org->Customization' menu. Many settings can also be
3952 activated on a per-file basis, by putting special lines into the buffer
3953 (*note In-buffer settings::).
3956 File: org, Node: In-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
3958 12.3 Summary of in-buffer settings
3959 ==================================
3961 Org-mode uses special lines in the buffer to define settings on a
3962 per-file basis. These lines start with a `#+' followed by a keyword, a
3963 colon, and then individual words defining a setting. Several setting
3964 words can be in the same line, but you can also have multiple lines for
3965 the keyword. While these settings are described throughout the manual,
3966 here is a summary. After changing any of those lines in the buffer,
3967 press `C-c C-c' with the cursor still in the line to activate the
3968 changes immediately. Otherwise they become effective only when the
3969 file is visited again in a new Emacs session.
3972 This line sets options to be used at startup of org-mode, when an
3973 Org-mode file is being visited. The first set of options deals
3974 with the initial visibility of the outline tree. The
3975 corresponding variable for global default settings is
3976 `org-startup-folded', with a default value `t', which means
3978 overview top-level headlines only
3979 content all headlines
3980 showall no folding at all, show everything
3981 Then there are options for aligning tables upon visiting a file.
3982 This is useful in files containing narrowed table columns. The
3983 corresponding variable is `org-startup-align-all-tables', with a
3984 default value `nil'.
3985 align align all tables
3986 noalign don't align tables on startup
3987 Logging when a TODO item is marked DONE (variable `org-log-done')
3988 can be configured using these options.
3989 logging record a timestamp when an item is marked DONE
3990 nologging don't record when items are marked DONE
3991 Here are the options for hiding leading stars in outline headings.
3992 The corresponding variables are `org-hide-leading-stars' and
3993 `org-odd-levels-only', both with a default setting `nil' (meaning
3994 `showstars' and `oddeven').
3995 hidestars make all but one of the stars starting a headline invisible.
3996 showstars show all stars starting a headline
3997 odd allow only odd outline levels (1,3,...)
3998 oddeven allow all outline levels
4000 `#+SEQ_TODO: #+TYP_TODO:'
4001 These lines set the TODO keywords and their interpretation in the
4002 current file. The corresponding variables are `org-todo-keywords'
4003 and `org-todo-interpretation'.
4005 `#+TAGS: TAG1(c1) TAG2(c2)'
4006 These lines (several such lines are allowed) specify the legal
4007 tags in this file, and (potentially) the corresponding _fast tag
4008 selection_ keys. The corresponding variable is `org-tag-alist'.
4011 This line sets the category for the agenda file. The category
4012 applies for all subsequent lines until the next `#+CATEGORY' line,
4013 or the end of the file.
4016 This line contains the formulas for the table directly above the
4019 `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
4020 These lines provide settings for exporting files. For more
4021 details see *Note Export options::.
4024 File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: In-buffer settings, Up: Miscellaneous
4026 12.4 The very busy C-c C-c key
4027 ==============================
4029 The key `C-c C-c' has many purposes in org-mode, which are all
4030 mentioned scattered throughout this manual. One specific function of
4031 this key is to add _tags_ to a headline (*note Tags::). In many other
4032 circumstances it means something like _Hey Org-mode, look here and
4033 update according to what you see here_. Here is a summary of what this
4034 means in different contexts.
4036 - If there are highlights in the buffer from the creation of a sparse
4037 tree, or from clock display, remove these highlights.
4039 - If the cursor is in one of the special `#+KEYWORD' lines, this
4040 triggers scanning the buffer for these lines and updating the
4043 - If the cursor is inside a table, realign the table. This command
4044 works even if the automatic table editor has been turned off.
4046 - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
4049 - If the cursor is inside a table created by the `table.el' package,
4050 activate that table.
4052 - If the current buffer is a remember buffer, close note and file it.
4053 with a prefix argument, file it without further interaction to the
4056 - If the cursor is on a `<<<target>>>', update radio targets and
4057 corresponding links in this buffer.
4059 - If the cursor is in a plain list item with a checkbox, toggle the
4060 status of the checkbox.
4062 - If the cursor is on a numbered item in a plain list, renumber the
4066 File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
4068 12.5 A cleaner outline view
4069 ===========================
4071 Some people find it noisy and distracting that the Org-mode headlines
4072 are starting with a potentially large number of stars. For example the
4073 tree from *Note Headlines:::
4075 * Top level headline
4081 * Another top level headline
4083 Unfortunately this is deeply ingrained into the code of Org-mode and
4084 cannot be easily changed. You can, however, modify the display in such
4085 a way that all leading stars become invisible and the outline more easy
4086 to read. To do this, customize the variable `org-hide-leading-stars'
4089 (setq org-hide-leading-stars t)
4091 or change this on a per-file basis with one of the lines (anywhere in
4094 #+STARTUP: showstars
4095 #+STARTUP: hidestars
4097 Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
4100 With stars hidden, the tree becomes:
4102 * Top level headline
4108 * Another top level headline
4110 Note that the leading stars are not truly replaced by whitespace, they
4111 are only fontified with the face `org-hide' that uses the background
4112 color as font color. If are are not using either white or black
4113 background, you may have to customize this face to get the wanted
4114 effect. Another possibility is to set this font such that the extra
4115 stars are almost invisible, for example using the color `grey90' on a
4118 Things become cleaner still if you skip all the even levels and use
4119 only odd levels 1, 3, 5..., effectively adding two stars to go from one
4120 outline level to the next:
4122 * Top level headline
4128 * Another top level headline
4130 In order to make the structure editing and export commands handle this
4131 convention correctly, use
4133 (setq org-odd-levels-only t)
4135 or set this on a per-file basis with one of the following lines (don't
4136 forget to press `C-c C-c' with the cursor in the startup line to
4137 activate changes immediately).
4142 You can convert an Org-mode file from single-star-per-level to the
4143 double-star-per-level convention with `M-x org-convert-to-odd-levels
4144 RET' in that file. The reverse operation is `M-x
4145 org-convert-to-oddeven-levels'.
4148 File: org, Node: TTY keys, Next: Interaction, Prev: Clean view, Up: Miscellaneous
4150 12.6 Using org-mode on a tty
4151 ============================
4153 Org-mode uses a number of keys that are not accessible on a tty. This
4154 applies to most special keys like cursor keys, <TAB> and <RET>, when
4155 these are combined with modifier keys like <Meta> and/or <Shift>.
4156 Org-mode uses these bindings because it needs to provide keys for a
4157 large number of commands, and because these keys appeared particularly
4158 easy to remember. In order to still be able to access the core
4159 functionality of Org-mode on a tty, alternative bindings are provided.
4160 Here is a complete list of these bindings, which are obviously more
4161 cumbersome to use. Note that sometimes a work-around can be better.
4162 For example changing a time stamp is really only fun with `S-<cursor>'
4163 keys. On a tty you would rather use `C-c .' to re-insert the
4166 Default Alternative 1 Alternative 2
4167 `S-<TAB>' `C-u <TAB>'
4168 `M-<left>' `C-c C-x l' `<Esc> <left>'
4169 `M-S-<left>'`C-c C-x L'
4170 `M-<right>' `C-c C-x r' `<Esc>
4172 `M-S-<right>'`C-c C-x R'
4173 `M-<up>' `C-c C-x u' `<Esc> <up>'
4174 `M-S-<up>' `C-c C-x U'
4175 `M-<down>' `C-c C-x d' `<Esc> <down>'
4176 `M-S-<down>'`C-c C-x D'
4177 `S-<RET>' `C-c C-x c'
4178 `M-<RET>' `C-c C-x m' `<Esc> <RET>'
4179 `M-S-<RET>' `C-c C-x M'
4182 `S-<right>' `C-c C-x
4190 File: org, Node: Interaction, Next: Bugs, Prev: TTY keys, Up: Miscellaneous
4192 12.7 Interaction with other packages
4193 ====================================
4195 Org-mode lives in the world of GNU Emacs and interacts in various ways
4196 with other code out there.
4200 * Cooperation:: Packages Org-mode cooperates with
4201 * Conflicts:: Packages that lead to conflicts
4204 File: org, Node: Cooperation, Next: Conflicts, Prev: Interaction, Up: Interaction
4206 12.7.1 Packages that Org-mode cooperates with
4207 ---------------------------------------------
4209 `calc.el' by Dave Gillespie
4210 Org-mode uses the calc package for implementing spreadsheet
4211 functionality in its tables (*note Table calculations::).
4212 Org-modes checks for the availability of calc by looking for the
4213 function `calc-eval' which should be autoloaded in your setup if
4214 calc has been installed properly. As of Emacs 22, calc is part of
4215 the Emacs distribution. Another possibility for interaction
4216 between the two packages is using calc for embedded calculations.
4217 *Note Embedded Mode: (calc)Embedded Mode.
4219 `constants.el' by Carsten Dominik
4220 In a table formula (*note Table calculations::), it is possible to
4221 use names for natural constants or units. Instead of defining
4222 your own constants in the variable `org-table-formula-constants',
4223 install the `constants' package which defines a large number of
4224 constants and units, and lets you use unit prefixes like `M' for
4225 `Mega' etc. You will need version 2.0 of this package, available
4226 at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
4227 the function `constants-get', which has to be autoloaded in your
4228 setup. See the installation instructions in the file
4231 `cdlatex.el' by Carsten Dominik
4232 Org-mode can make use of the cdlatex package to efficiently enter
4233 LaTeX fragments into Org-mode files. `cdlatex.el' is not part of
4234 Emacs, find it on the web.
4236 `remember.el' by John Wiegley
4237 Org mode cooperates with remember, see *Note Remember::.
4238 `Remember.el' is not part of Emacs, find it on the web.
4240 `table.el' by Takaaki Ota
4241 Org mode cooperates with table.el, see *Note table.el::.
4242 `table.el' is part of Emacs 22.
4245 File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
4247 12.7.2 Packages that lead to conflicts with Org-mode
4248 ----------------------------------------------------
4250 `allout.el' by Ken Manheimer
4251 Startup of Org-mode may fail with the error message
4252 `(wrong-type-argument keymapp nil)' when there is an outdated
4253 version `allout.el' on the load path, for example the version
4254 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
4255 will disappear. If for some reason you cannot do this, make sure
4256 that org.el is loaded _before_ `allout.el', for example by putting
4257 `(require 'org)' early enough into your `.emacs' file.
4259 `CUA.el' by Kim. F. Storm
4260 Keybindings in Org-mode conflict with the `S-<cursor>' keys used
4261 by CUA-mode (as well as pc-select-mode and s-region-mode) to
4262 select and extend the region. If you want to use one of these
4263 packages along with Org-mode, configure the variable
4264 `org-CUA-compatible'. When set, Org-mode will move the following
4265 keybindings in org-mode files, and in the agenda buffer (but not
4266 during date selection).
4268 S-UP -> M-p S-DOWN -> M-n
4269 S-LEFT -> M-- S-RIGHT -> M-+
4272 Yes, these are unfortunately more difficult to remember. If you
4273 want to have other replacement keys, look at the variable
4274 `org-disputed-keys'.
4276 `windmove.el' by Hovav Shacham
4277 Also this package uses the `S-<cursor>' keys, so everything written
4278 in the paragraph above about CUA mode also applies here.
4281 File: org, Node: Bugs, Prev: Interaction, Up: Miscellaneous
4286 Here is a list of things that should work differently, but which I have
4287 found too hard to fix.
4289 * If a table field starts with a link, and if the corresponding table
4290 column is narrowed (*note Narrow columns::) to a width too small to
4291 display the link, the field would look entirely empty even though
4292 it is not. To prevent this, Org-mode throws an error. The
4293 work-around is to make the column wide enough to fit the link, or
4294 to add some text (at least 2 characters) before the link in the
4297 * Narrowing table columns does not work on XEmacs, because the
4298 `format' function does not transport text properties.
4300 * Text in an entry protected with the `QUOTE' keyword should not
4303 * When the application called by `C-c C-o' to open a file link fails
4304 (for example because the application does not exist or refuses to
4305 open the file), it does so silently. No error message is
4308 * The remote-editing commands in the agenda buffer cannot be undone
4309 with `undo' called from within the agenda buffer. But you can go
4310 to the corresponding buffer (using <TAB> or <RET> and execute
4313 * Recalculating a table line applies the formulas from left to right.
4314 If a formula uses _calculated_ fields further down the row,
4315 multiple recalculation may be needed to get all fields consistent.
4317 * A single letter cannot be made bold, for example `*a*'.
4319 * The exporters work well, but could be made more efficient.
4322 File: org, Node: Extensions and Hacking, Next: History and Acknowledgments, Prev: Miscellaneous, Up: Top
4324 Appendix A Extensions, Hooks and Hacking
4325 ****************************************
4327 This appendix lists extensions for Org-mode written by other authors.
4328 It also covers some aspects where users can easily extend the
4329 functionality of Org-mode.
4333 * Extensions:: Existing 3rd-part extensions
4334 * Dynamic blocks:: Automatically filled blocks
4337 File: org, Node: Extensions, Next: Dynamic blocks, Prev: Extensions and Hacking, Up: Extensions and Hacking
4339 A.1 Third-party extensions for Org-mode
4340 =======================================
4342 The following extensions for Org-mode have been written by other people:
4344 `org-mouse.el' by Piotr Zielinski
4345 This package implements extended mouse functionality for Org-mode.
4346 It allows you to cycle visibility and to edit the document
4347 structure with the mouse. Best of all, it provides a
4348 context-sensitive menu on <mouse-3> that changes depending on the
4349 context of a mouse-click. `org-mouse.el' is freely available at
4350 `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
4352 `org-publish.el' by David O'Toole
4353 This package provides facilities for publishing related sets of
4354 Org-mode files together with linked files like images as a
4355 webpages. It is highly configurable and can be used for other
4356 publishing purposes as well. As of Org-mode version 4.30,
4357 `org-publish.el' is part of the Org-mode distribution. It is not
4358 yet part of Emacs, however, a delay caused by the preparations for
4359 the 22.1 release. In the mean time, `org-publish.el' can be
4360 downloaded from David's site:
4361 `http://dto.freeshell.org/e/org-publish.el'.
4363 `org-blog.el' by David O'Toole
4364 A blogging plug-in for `org-publish.el'.
4365 `http://dto.freeshell.org/notebook/OrgMode.html'.
4367 `org-blogging.el' by Bastien Guerry
4368 Publish Org-mode files as blogs.
4369 `http://www.cognition.ens.fr/~guerry/org-blogging.html'.
4372 File: org, Node: Dynamic blocks, Prev: Extensions, Up: Extensions and Hacking
4377 Org-mode documents can contain _dynamic blocks_. These are specially
4378 marked regions that are updated by some user-written function. A good
4379 example for such a block is the clock table inserted by the command
4380 `C-c C-x C-r' (*note Clocking work time::).
4382 Dynamic block are enclosed by a BEGIN-END structure that assigns a
4383 name to the block and can also specify parameters for the function
4384 producing the content of the block.
4386 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 .....
4390 Dynamic blocks are updated with the following commands
4393 Update dynamic block at point.
4396 Update all dynamic blocks in the current file.
4398 Updating a dynamic block means to remove all the text between BEGIN
4399 and END, parse the BEGIN line for parameters and then call the specific
4400 writer function for this block to insert the new content. For a block
4401 with name `myblock', the writer function is `org-dblock-write:myblock'
4402 with as only parameter a property list with the parameters given in the
4403 begin line. Here is a trivial example of a block that keeps track of
4404 when the block update function was last run:
4406 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
4410 The corresponding block writer function could look like this:
4412 (defun org-dblock-write:block-update-time (params)
4413 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
4414 (insert "Last block update at: "
4415 (format-time-string fmt (current-time)))))
4417 If you want to make sure that all dynamic blocks are always
4418 up-to-date, you could add the function `org-update-all-dblocks' to a
4419 hook, for example `before-save-hook'. `org-update-all-dblocks' is
4420 written in a way that is does nothing in buffers that are not in
4424 File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions and Hacking, Up: Top
4426 Appendix B History and Acknowledgments
4427 **************************************
4429 The beginnings of Org-mode go back to 2003. It was borne out of
4430 frustration over the user interface of the emacs outline-mode. All I
4431 wanted was to make working with an outline tree possible without having
4432 to remember more than 10 commands just for hiding and unhiding parts of
4433 the outline tree, and to allow to restructure a tree easily. Visibility
4434 cycling and structure editing were originally implemented in the package
4435 `outline-magic.el', but quickly moved to the more general `org.el'.
4436 TODO entries, basic time stamps, and table support were added next, and
4437 highlight the two main goals that Org-mode still has today: To create
4438 a new, outline-based, plain text mode with innovative and intuitive
4439 editing features, and to incorporate project planning functionality
4440 directly into a notes file.
4442 Since the first release, hundreds of emails to me or on
4443 `emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
4444 feedback, new ideas, and sometimes even patches and add-on code. Many
4445 thanks to everyone who has helped to improve this package. I am trying
4446 to keep here a list of the people who had significant influence in
4447 shaping one or more aspects of Org-mode. The list may not be complete,
4448 if I have forgotten someone, please accept my apologies and let me know.
4450 * Thomas Baumann contributed the code for links to the MH-E email
4453 * Alex Bochannek provided a patch for rounding time stamps.
4455 * Charles Cave's suggestion sparked the implementation of templates
4458 * Pavel Chalmoviansky influenced the agenda treatment of items with
4461 * Gregory Chernov patched support for lisp forms into table
4462 calculations and improved XEmacs compatibility, in particular by
4463 porting `nouline.el' to XEmacs.
4465 * Sacha Chua suggested to copy some linking code from Planner.
4467 * Kees Dullemond inspired the use of narrowed tabled columns.
4469 * Christian Egli converted the documentation into TeXInfo format,
4470 patched CSS formatting into the HTML exporter, and inspired the
4473 * Nic Ferrier contributed mailcap and XOXO support.
4475 * Niels Giessen had the idea to automatically archive DONE trees.
4477 * Bastien Guerry provoded extensive feedback.
4479 * Kai Grossjohann pointed out key-binding conflicts caused by
4482 * Leon Liu asked for embedded LaTeX and tested it.
4484 * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
4487 * Todd Neal provided patches for links to Info files and elisp forms.
4489 * Tim O'Callaghan suggested in-file links, search options for general
4490 file links, and TAGS.
4492 * Oliver Oppitz suggested multi-state TODO items.
4494 * Scott Otterson sparked the introduction of descriptive text for
4495 links, among other things.
4497 * Pete Phillips helped the development of the TAGS feature.
4499 * T.V. Raman reported bugs and suggested improvements.
4501 * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
4504 * Kevin Rogers contributed code to access VM files on remote hosts.
4506 * Frank Ruell solved the mystery of the `keymapp nil' bug, a
4507 conflict with `allout.el'.
4509 * Philip Rooke created the Org-mode reference card and provided lots
4512 * Christian Schlauer proposed angular brackets around links, among
4515 * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
4516 `organizer-mode.el'.
4518 * Daniel Sinder came up with the idea of internal archiving by
4521 * David O'Toole wrote `org-publish.el' and drafted the manual
4522 chapter about publishing.
4524 * Ju"rgen Vollmer contributed code generating the table of contents
4527 * Chris Wallace provided a patch implementing the `QUOTE' keyword.
4529 * David Wainberg suggested archiving, and improvements to the linking
4532 * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
4533 development of Org-mode was fully independent, and both systems are
4534 really different beasts in their basic ideas and implementation
4535 details. I later looked at John's code, however, and learned from
4536 his implementation of (i) links where the link itself is hidden
4537 and only a description is shown, and (ii) popping up a calendar to
4540 * Carsten Wimmer suggested some changes and helped fix a bug in
4543 * Roland Winkler requested additional keybindings to make Org-mode
4546 * Piotr Zielinski wrote `org-mouse.el' and showed how to follow
4550 File: org, Node: Index, Next: Key Index, Prev: History and Acknowledgments, Up: Top
4558 * acknowledgments: History and Acknowledgments.
4560 * action, for publishing: Publishing action. (line 6)
4561 * active region <1>: HTML export. (line 10)
4562 * active region <2>: ASCII export. (line 9)
4563 * active region <3>: Built-in table editor.
4565 * active region: Structure editing. (line 51)
4566 * agenda: Weekly/Daily agenda. (line 6)
4567 * agenda commands, custom: Agenda dispatcher. (line 6)
4568 * agenda dispatcher: Agenda dispatcher. (line 6)
4569 * agenda files, removing buffers: Agenda commands. (line 211)
4570 * agenda views: Agenda views. (line 6)
4571 * agenda, for single file: Timeline. (line 6)
4572 * allout.el: Conflicts. (line 6)
4573 * angular brackets, around links: External links. (line 38)
4574 * applescript, for calendar update: iCalendar export. (line 38)
4575 * archive locations: Moving subtrees. (line 21)
4576 * archiving: Archiving. (line 6)
4577 * ASCII export: ASCII export. (line 6)
4578 * author: Feedback. (line 6)
4579 * autoload: Installation. (line 6)
4580 * BBDB links: External links. (line 6)
4581 * bold text: Enhancing text. (line 15)
4582 * bug reports: Feedback. (line 6)
4583 * bugs: Bugs. (line 6)
4584 * calc package: Table calculations. (line 6)
4585 * calc.el: Cooperation. (line 6)
4586 * calculations, in tables <1>: Table calculations. (line 6)
4587 * calculations, in tables: Built-in table editor.
4589 * calendar integration: Calendar/Diary integration.
4591 * calendar, for selecting date: Creating timestamps. (line 71)
4592 * CamelCase link completion: Completion. (line 6)
4593 * CamelCase links: Internal links. (line 6)
4594 * CamelCase links, completion of: CamelCase links. (line 6)
4595 * category: Categories. (line 6)
4596 * cdlatex.el: Cooperation. (line 29)
4597 * checkboxes: Checkboxes. (line 6)
4598 * children, subtree visibility state: Visibility cycling. (line 10)
4599 * clean outline view: Clean view. (line 6)
4600 * CLOCK keyword: Time stamps. (line 61)
4601 * CLOSED keyword: Time stamps. (line 55)
4602 * column formula: Column formulas. (line 6)
4603 * commands, in agenda buffer: Agenda commands. (line 6)
4604 * comment lines: Comment lines. (line 6)
4605 * completion, of CamelCase links <1>: Completion. (line 6)
4606 * completion, of CamelCase links: CamelCase links. (line 6)
4607 * completion, of dictionary words: Completion. (line 6)
4608 * completion, of file names: Handling links. (line 43)
4609 * completion, of links: Handling links. (line 27)
4610 * completion, of option keywords <1>: Completion. (line 6)
4611 * completion, of option keywords: Export options. (line 6)
4612 * Completion, of option keywords: Per file keywords. (line 17)
4613 * completion, of tags <1>: Completion. (line 6)
4614 * completion, of tags: Setting tags. (line 11)
4615 * completion, of TeX symbols: Completion. (line 6)
4616 * completion, of TODO keywords <1>: Completion. (line 6)
4617 * completion, of TODO keywords: Workflow states. (line 12)
4618 * constants, in calculations: Formula syntax. (line 26)
4619 * constants.el: Cooperation. (line 14)
4620 * contents, global visibility state: Visibility cycling. (line 22)
4621 * copying, of subtrees: Structure editing. (line 6)
4622 * creating timestamps: Creating timestamps. (line 6)
4623 * CUA.el: Conflicts. (line 15)
4624 * custom agenda commands: Agenda dispatcher. (line 6)
4625 * custom search strings: Custom searches. (line 6)
4626 * customization: Customization. (line 6)
4627 * cutting, of subtrees: Structure editing. (line 6)
4628 * cycling, of TODO states: TODO basics. (line 13)
4629 * cycling, visibility: Visibility cycling. (line 6)
4630 * date stamps: Time stamps. (line 6)
4631 * date, reading in minibuffer: Creating timestamps. (line 71)
4632 * DEADLINE keyword: Time stamps. (line 43)
4633 * deadlines: Time stamps. (line 6)
4634 * demotion, of subtrees: Structure editing. (line 6)
4635 * diary entries, creating from agenda: Agenda commands. (line 179)
4636 * diary integration: Calendar/Diary integration.
4638 * dictionary word completion: Completion. (line 6)
4639 * directories, for publishing: Sources and destinations.
4641 * dispatching agenda commands: Agenda dispatcher. (line 6)
4642 * document structure: Document structure. (line 6)
4643 * DONE, final TODO keyword: Per file keywords. (line 20)
4644 * editing tables: Tables. (line 6)
4645 * editing, of table formulas: Editing/debugging formulas.
4647 * elisp links: External links. (line 6)
4648 * emphasized text: Export options. (line 25)
4649 * enhancing text: Enhancing text. (line 6)
4650 * evaluate time range: Creating timestamps. (line 66)
4651 * exporting: Exporting. (line 6)
4652 * exporting, not: Comment lines. (line 6)
4653 * extended TODO keywords: TODO extensions. (line 6)
4654 * external archiving: Moving subtrees. (line 6)
4655 * external links: External links. (line 6)
4656 * external links, in HTML export: HTML export. (line 35)
4657 * FAQ: Summary. (line 41)
4658 * feedback: Feedback. (line 6)
4659 * file links: External links. (line 6)
4660 * file links, searching: Search options. (line 6)
4661 * file name completion: Handling links. (line 43)
4662 * files, adding to agenda list: Agenda files. (line 12)
4663 * files, selecting for publishing: Selecting files. (line 6)
4664 * fixed width: Enhancing text. (line 25)
4665 * fixed-width sections: Export options. (line 25)
4666 * folded, subtree visibility state: Visibility cycling. (line 10)
4667 * folding, sparse trees: Sparse trees. (line 6)
4668 * following links: Handling links. (line 58)
4669 * format specifier: Formula syntax. (line 34)
4670 * format, of links: Link format. (line 6)
4671 * formula editing: Editing/debugging formulas.
4673 * formula syntax: Formula syntax. (line 6)
4674 * formula, for named table field: Named-field formulas.
4676 * formula, for table column: Column formulas. (line 6)
4677 * formula, in tables: Built-in table editor.
4679 * global cycling: Visibility cycling. (line 22)
4680 * global keybindings: Installation. (line 6)
4681 * global TODO list: Global TODO list. (line 6)
4682 * global visibility states: Visibility cycling. (line 22)
4683 * GNUS links: External links. (line 6)
4684 * hand-formatted lists: Enhancing text. (line 11)
4685 * headline levels: Export options. (line 25)
4686 * headline levels, for exporting <1>: HTML export. (line 21)
4687 * headline levels, for exporting: ASCII export. (line 18)
4688 * headline navigation: Motion. (line 6)
4689 * headline tagging: Tags. (line 6)
4690 * headline, promotion and demotion: Structure editing. (line 6)
4691 * headlines: Headlines. (line 6)
4692 * hide text: Visibility cycling. (line 6)
4693 * hiding leading stars: Clean view. (line 6)
4694 * history: History and Acknowledgments.
4696 * HTML export: HTML export. (line 6)
4697 * hyperlinks: Hyperlinks. (line 6)
4698 * iCalendar export: iCalendar export. (line 6)
4699 * in-buffer settings: In-buffer settings. (line 6)
4700 * index, of published pages: Project page index. (line 6)
4701 * Info links: External links. (line 6)
4702 * inheritance, of tags: Tag inheritance. (line 6)
4703 * inserting links: Handling links. (line 27)
4704 * installation: Installation. (line 6)
4705 * internal archiving: ARCHIVE tag. (line 6)
4706 * internal links: Internal links. (line 6)
4707 * internal links, in HTML export: HTML export. (line 35)
4708 * introduction: Introduction. (line 6)
4709 * italic text: Enhancing text. (line 15)
4710 * jumping, to headlines: Motion. (line 6)
4711 * keybindings, global: Installation. (line 6)
4712 * keyword options: Per file keywords. (line 6)
4713 * LaTeX fragments: Export options. (line 25)
4714 * LaTeX fragments, export: Enhancing text. (line 18)
4715 * LaTeX interpretation: Embedded LaTeX. (line 6)
4716 * linebreak preservation: Export options. (line 25)
4717 * linebreak, forced: Enhancing text. (line 32)
4718 * link completion: Handling links. (line 27)
4719 * link format: Link format. (line 6)
4720 * links, external: External links. (line 6)
4721 * links, in HTML export: HTML export. (line 35)
4722 * links, internal: Internal links. (line 6)
4723 * links, publishing: Publishing links. (line 6)
4724 * links, returning to: Handling links. (line 84)
4725 * Lisp forms, as table formulas: Lisp formulas. (line 6)
4726 * lists, hand-formatted: Enhancing text. (line 11)
4727 * lists, ordered: Plain lists. (line 6)
4728 * lists, plain: Plain lists. (line 6)
4729 * logging, of progress: Progress logging. (line 6)
4730 * maintainer: Feedback. (line 6)
4731 * mark ring: Handling links. (line 80)
4732 * marking characters, tables: Advanced features. (line 34)
4733 * matching, of tags: Matching headline tags.
4735 * matching, tags: Tags. (line 6)
4736 * MH-E links: External links. (line 6)
4737 * minor mode for tables: orgtbl-mode. (line 6)
4738 * mode, for calc: Formula syntax. (line 34)
4739 * motion, between headlines: Motion. (line 6)
4740 * name, of column or field: Formula syntax. (line 26)
4741 * named field formula: Named-field formulas.
4743 * names as TODO keywords: TODO types. (line 6)
4744 * narrow columns in tables: Narrow columns. (line 6)
4745 * occur, command: Sparse trees. (line 6)
4746 * option keyword completion: Completion. (line 6)
4747 * options, for customization: Customization. (line 6)
4748 * options, for export: Export options. (line 6)
4749 * options, for publishing: Publishing options. (line 6)
4750 * ordered lists: Plain lists. (line 6)
4751 * org-agenda, command: Weekly/Daily agenda. (line 9)
4752 * org-blog.el: Extensions. (line 25)
4753 * org-blogging.el: Extensions. (line 29)
4754 * org-mode, turning on: Installation. (line 34)
4755 * org-mouse.el: Extensions. (line 8)
4756 * org-publish-project-alist: Project alist. (line 6)
4757 * org-publish.el: Extensions. (line 14)
4758 * orgtbl-mode: orgtbl-mode. (line 6)
4759 * outline tree: Headlines. (line 6)
4760 * outline-mode: Outlines. (line 6)
4761 * outlines: Outlines. (line 6)
4762 * overview, global visibility state: Visibility cycling. (line 22)
4763 * packages, interaction with other: Interaction. (line 6)
4764 * pasting, of subtrees: Structure editing. (line 6)
4765 * per file keywords: Per file keywords. (line 6)
4766 * plain lists: Plain lists. (line 6)
4767 * plain text external links: External links. (line 38)
4768 * printing sparse trees: Sparse trees. (line 39)
4769 * priorities: Priorities. (line 6)
4770 * priorities, of agenda items: Sorting of agenda items.
4772 * progress logging: Progress logging. (line 6)
4773 * projects, for publishing: Project alist. (line 6)
4774 * promotion, of subtrees: Structure editing. (line 6)
4775 * publishing: Publishing. (line 6)
4776 * quoted HTML tags: Export options. (line 25)
4777 * ranges, time: Time stamps. (line 6)
4778 * recomputing table fields: Column formulas. (line 27)
4779 * region, active <1>: HTML export. (line 10)
4780 * region, active <2>: ASCII export. (line 9)
4781 * region, active <3>: Built-in table editor.
4783 * region, active: Structure editing. (line 51)
4784 * remember.el <1>: Cooperation. (line 34)
4785 * remember.el: Remember. (line 6)
4786 * richer text: Enhancing text. (line 6)
4787 * RMAIL links: External links. (line 6)
4788 * SCHEDULED keyword: Time stamps. (line 30)
4789 * scheduling: Time stamps. (line 6)
4790 * search option in file links: Search options. (line 6)
4791 * section-numbers: Export options. (line 25)
4792 * setting tags: Setting tags. (line 6)
4793 * SHELL links: External links. (line 6)
4794 * show all, command: Visibility cycling. (line 31)
4795 * show all, global visibility state: Visibility cycling. (line 22)
4796 * show hidden text: Visibility cycling. (line 6)
4797 * single file summary: Timeline. (line 6)
4798 * sorting, of agenda items: Sorting of agenda items.
4800 * sparse tree, for deadlines: Creating timestamps. (line 41)
4801 * sparse tree, for TODO: TODO basics. (line 26)
4802 * sparse tree, tag based: Tags. (line 6)
4803 * sparse trees: Sparse trees. (line 6)
4804 * special keywords: In-buffer settings. (line 6)
4805 * spreadsheet capabilities: Table calculations. (line 6)
4806 * storing links: Handling links. (line 9)
4807 * structure editing: Structure editing. (line 6)
4808 * structure of document: Document structure. (line 6)
4809 * subtree cycling: Visibility cycling. (line 10)
4810 * subtree visibility states: Visibility cycling. (line 10)
4811 * subtree, cut and paste: Structure editing. (line 6)
4812 * subtree, subtree visibility state: Visibility cycling. (line 10)
4813 * subtrees, cut and paste: Structure editing. (line 6)
4814 * summary: Summary. (line 6)
4815 * syntax, of formulas: Formula syntax. (line 6)
4816 * table editor, builtin: Built-in table editor.
4818 * table editor, table.el: table.el. (line 6)
4819 * table of contents: Export options. (line 25)
4820 * table.el <1>: Cooperation. (line 35)
4821 * table.el: table.el. (line 6)
4822 * tables <1>: Export options. (line 25)
4823 * tables: Tables. (line 6)
4824 * tables, export: Enhancing text. (line 21)
4825 * tag completion: Completion. (line 6)
4826 * tag searches: Tag searches. (line 6)
4827 * tags: Tags. (line 6)
4828 * tags view: Matching headline tags.
4830 * templates, for remember: Remember. (line 23)
4831 * TeX interpretation: Embedded LaTeX. (line 6)
4832 * TeX macros: Export options. (line 25)
4833 * TeX macros, export: Enhancing text. (line 18)
4834 * TeX symbol completion: Completion. (line 6)
4835 * TeX-like syntax for sub- and superscripts: Export options. (line 25)
4836 * thanks: History and Acknowledgments.
4838 * time stamps: Time stamps. (line 6)
4839 * time, reading in minibuffer: Creating timestamps. (line 71)
4840 * time-sorted view: Timeline. (line 6)
4841 * timeline, single file: Timeline. (line 6)
4842 * timerange: Time stamps. (line 21)
4843 * timestamp: Time stamps. (line 13)
4844 * timestamps, creating: Creating timestamps. (line 6)
4845 * TODO items: TODO items. (line 6)
4846 * TODO keywords completion: Completion. (line 6)
4847 * TODO list, global: Global TODO list. (line 6)
4848 * TODO types: TODO types. (line 6)
4849 * TODO workflow: Workflow states. (line 6)
4850 * transient-mark-mode <1>: HTML export. (line 10)
4851 * transient-mark-mode <2>: ASCII export. (line 9)
4852 * transient-mark-mode <3>: Built-in table editor.
4854 * transient-mark-mode: Structure editing. (line 51)
4855 * trees, sparse: Sparse trees. (line 6)
4856 * trees, visibility: Visibility cycling. (line 6)
4857 * tty keybindings: TTY keys. (line 6)
4858 * types as TODO keywords: TODO types. (line 6)
4859 * underlined text: Enhancing text. (line 15)
4860 * URL links: External links. (line 6)
4861 * USENET links: External links. (line 6)
4862 * variables, for customization: Customization. (line 6)
4863 * vectors, in table calculations: Formula syntax. (line 23)
4864 * visibility cycling: Visibility cycling. (line 6)
4865 * visible text, printing: Sparse trees. (line 39)
4866 * VM links: External links. (line 6)
4867 * WANDERLUST links: External links. (line 6)
4868 * windmove.el: Conflicts. (line 33)
4869 * workflow states as TODO keywords: Workflow states. (line 6)
4870 * XOXO export: XOXO export. (line 6)
4873 File: org, Node: Key Index, Prev: Index, Up: Top
4881 * ': CDLaTeX mode. (line 43)
4882 * +: Agenda commands. (line 126)
4883 * ,: Agenda commands. (line 118)
4884 * -: Agenda commands. (line 132)
4885 * .: Agenda commands. (line 94)
4886 * :: Agenda commands. (line 112)
4887 * <: Creating timestamps. (line 78)
4888 * <left>: Agenda commands. (line 91)
4889 * <RET> <1>: Agenda commands. (line 41)
4890 * <RET> <2>: Creating timestamps. (line 103)
4891 * <RET>: Built-in table editor.
4893 * <right>: Agenda commands. (line 86)
4894 * <SPC>: Agenda commands. (line 28)
4895 * <TAB> <1>: CDLaTeX mode. (line 23)
4896 * <TAB> <2>: Agenda commands. (line 35)
4897 * <TAB> <3>: Built-in table editor.
4899 * <TAB> <4>: Plain lists. (line 39)
4900 * <TAB>: Visibility cycling. (line 10)
4901 * > <1>: Agenda commands. (line 154)
4902 * >: Creating timestamps. (line 79)
4903 * ^: CDLaTeX mode. (line 33)
4904 * _: CDLaTeX mode. (line 33)
4905 * `: CDLaTeX mode. (line 39)
4906 * a: Agenda commands. (line 115)
4907 * C: Agenda commands. (line 194)
4908 * c: Agenda commands. (line 172)
4909 * C-#: Built-in table editor.
4911 * C-,: Agenda files. (line 18)
4912 * C-c !: Creating timestamps. (line 21)
4913 * C-c $: Moving subtrees. (line 10)
4914 * C-c %: Handling links. (line 80)
4915 * C-c &: Handling links. (line 84)
4916 * C-c ' <1>: Editing/debugging formulas.
4918 * C-c ': Built-in table editor.
4920 * C-c *: Built-in table editor.
4922 * C-c +: Built-in table editor.
4924 * C-c ,: Priorities. (line 18)
4925 * C-c -: Built-in table editor.
4927 * C-c .: Creating timestamps. (line 10)
4928 * C-c /: Sparse trees. (line 15)
4929 * C-c :: Enhancing text. (line 29)
4930 * C-c ;: Comment lines. (line 11)
4931 * C-c <: Creating timestamps. (line 25)
4932 * C-c <TAB>: Built-in table editor.
4934 * C-c =: Built-in table editor.
4936 * C-c >: Creating timestamps. (line 29)
4937 * C-c ? <1>: Editing/debugging formulas.
4939 * C-c ?: Built-in table editor.
4941 * C-c [: Agenda files. (line 12)
4942 * C-c \: Tag searches. (line 9)
4943 * C-c ]: Agenda files. (line 15)
4944 * C-c ^: Built-in table editor.
4946 * C-c `: Built-in table editor.
4948 * C-c a a: Weekly/Daily agenda. (line 9)
4949 * C-c a C: Agenda dispatcher. (line 29)
4950 * C-c a M: Matching headline tags.
4952 * C-c a m: Matching headline tags.
4954 * C-c a M: Tag searches. (line 14)
4955 * C-c a m: Tag searches. (line 10)
4956 * C-c a T: Global TODO list. (line 14)
4957 * C-c a t <1>: Global TODO list. (line 9)
4958 * C-c a t: TODO basics. (line 33)
4959 * C-c C-a: Visibility cycling. (line 31)
4960 * C-c C-b: Motion. (line 15)
4961 * C-c C-c <1>: The very busy C-c C-c key.
4963 * C-c C-c <2>: Processing LaTeX fragments.
4965 * C-c C-c <3>: Setting tags. (line 10)
4966 * C-c C-c <4>: table.el. (line 6)
4967 * C-c C-c <5>: Editing/debugging formulas.
4969 * C-c C-c <6>: Built-in table editor.
4971 * C-c C-c <7>: Checkboxes. (line 22)
4972 * C-c C-c: Plain lists. (line 76)
4973 * C-c C-d <1>: Agenda commands. (line 139)
4974 * C-c C-d: Creating timestamps. (line 37)
4975 * C-c C-e: Exporting. (line 19)
4976 * C-c C-e a: ASCII export. (line 9)
4977 * C-c C-e b: HTML export. (line 11)
4978 * C-c C-e c: iCalendar export. (line 20)
4979 * C-c C-e h: HTML export. (line 10)
4980 * C-c C-e I: iCalendar export. (line 15)
4981 * C-c C-e i: iCalendar export. (line 13)
4982 * C-c C-e t: Export options. (line 13)
4983 * C-c C-e v <1>: XOXO export. (line 11)
4984 * C-c C-e v: Sparse trees. (line 39)
4985 * C-c C-e v a: ASCII export. (line 13)
4986 * C-c C-e v b: HTML export. (line 14)
4987 * C-c C-e v h: HTML export. (line 14)
4988 * C-c C-e x: XOXO export. (line 10)
4989 * C-c C-f: Motion. (line 12)
4990 * C-c C-j: Motion. (line 21)
4991 * C-c C-l: Handling links. (line 27)
4992 * C-c C-n: Motion. (line 8)
4993 * C-c C-o <1>: Creating timestamps. (line 33)
4994 * C-c C-o: Handling links. (line 58)
4995 * C-c C-p: Motion. (line 9)
4996 * C-c C-q <1>: Editing/debugging formulas.
4998 * C-c C-q: Built-in table editor.
5000 * C-c C-r: Timeline. (line 13)
5001 * C-c C-s <1>: Agenda commands. (line 136)
5002 * C-c C-s: Creating timestamps. (line 48)
5003 * C-c C-t <1>: Clocking work time. (line 20)
5004 * C-c C-t: TODO basics. (line 13)
5005 * C-c C-u: Motion. (line 18)
5006 * C-c C-v: TODO basics. (line 26)
5007 * C-c C-w: Creating timestamps. (line 41)
5008 * C-c C-x C-a: ARCHIVE tag. (line 27)
5009 * C-c C-x C-b: Checkboxes. (line 23)
5010 * C-c C-x C-c: Agenda commands. (line 201)
5011 * C-c C-x C-d: Clocking work time. (line 28)
5012 * C-c C-x C-i: Clocking work time. (line 12)
5013 * C-c C-x C-k: Structure editing. (line 36)
5014 * C-c C-x C-l: Processing LaTeX fragments.
5016 * C-c C-x C-o: Clocking work time. (line 14)
5017 * C-c C-x C-r: Clocking work time. (line 35)
5018 * C-c C-x C-u: Dynamic blocks. (line 21)
5019 * C-c C-x C-w <1>: Built-in table editor.
5021 * C-c C-x C-w: Structure editing. (line 36)
5022 * C-c C-x C-x: Clocking work time. (line 24)
5023 * C-c C-x C-y <1>: Built-in table editor.
5025 * C-c C-x C-y: Structure editing. (line 43)
5026 * C-c C-x M-w <1>: Built-in table editor.
5028 * C-c C-x M-w: Structure editing. (line 40)
5029 * C-c C-y: Creating timestamps. (line 66)
5030 * C-c l: Handling links. (line 9)
5031 * C-c {: CDLaTeX mode. (line 21)
5032 * C-c |: Built-in table editor.
5034 * C-c ~: table.el. (line 18)
5035 * C-u C-c $: Moving subtrees. (line 12)
5036 * C-u C-c .: Creating timestamps. (line 16)
5037 * C-u C-c =: Built-in table editor.
5039 * C-u C-c C-l: Handling links. (line 43)
5040 * C-u C-c C-x C-a: ARCHIVE tag. (line 30)
5041 * C-u C-c C-x C-u: Dynamic blocks. (line 22)
5042 * D: Agenda commands. (line 68)
5043 * d: Agenda commands. (line 65)
5044 * f: Agenda commands. (line 44)
5045 * g: Agenda commands. (line 72)
5046 * H: Agenda commands. (line 198)
5047 * i: Agenda commands. (line 179)
5048 * I: Agenda commands. (line 159)
5049 * l: Agenda commands. (line 51)
5050 * L: Agenda commands. (line 32)
5051 * M: Agenda commands. (line 185)
5052 * M-<down>: Built-in table editor.
5054 * M-<left> <1>: Built-in table editor.
5056 * M-<left>: Structure editing. (line 18)
5057 * M-<RET> <1>: Plain lists. (line 44)
5058 * M-<RET>: Structure editing. (line 6)
5059 * M-<right> <1>: Built-in table editor.
5061 * M-<right>: Structure editing. (line 21)
5062 * M-<TAB> <1>: Completion. (line 10)
5063 * M-<TAB> <2>: Setting tags. (line 6)
5064 * M-<TAB>: Per file keywords. (line 17)
5065 * M-<up>: Built-in table editor.
5067 * M-S-<down> <1>: Built-in table editor.
5069 * M-S-<down> <2>: Plain lists. (line 61)
5070 * M-S-<down>: Structure editing. (line 33)
5071 * M-S-<left> <1>: Creating timestamps. (line 100)
5072 * M-S-<left> <2>: Built-in table editor.
5074 * M-S-<left> <3>: Plain lists. (line 67)
5075 * M-S-<left>: Structure editing. (line 24)
5076 * M-S-<RET> <1>: Checkboxes. (line 37)
5077 * M-S-<RET> <2>: Plain lists. (line 54)
5078 * M-S-<RET>: Structure editing. (line 15)
5079 * M-S-<right> <1>: Creating timestamps. (line 97)
5080 * M-S-<right> <2>: Built-in table editor.
5082 * M-S-<right> <3>: Plain lists. (line 67)
5083 * M-S-<right>: Structure editing. (line 27)
5084 * M-S-<up> <1>: Built-in table editor.
5086 * M-S-<up> <2>: Plain lists. (line 61)
5087 * M-S-<up>: Structure editing. (line 30)
5088 * mouse-1 <1>: Agenda commands. (line 35)
5089 * mouse-1 <2>: Creating timestamps. (line 82)
5090 * mouse-1: Handling links. (line 72)
5091 * mouse-2 <1>: Agenda commands. (line 35)
5092 * mouse-2: Handling links. (line 72)
5093 * mouse-3 <1>: Agenda commands. (line 28)
5094 * mouse-3: Handling links. (line 77)
5095 * n: Agenda commands. (line 19)
5096 * O: Agenda commands. (line 161)
5097 * o: Agenda commands. (line 59)
5098 * P: Agenda commands. (line 123)
5099 * p: Agenda commands. (line 20)
5100 * q: Agenda commands. (line 208)
5101 * r <1>: Agenda commands. (line 76)
5102 * r: Global TODO list. (line 20)
5103 * S: Agenda commands. (line 189)
5104 * s: Agenda commands. (line 83)
5105 * S-<down> <1>: Agenda commands. (line 132)
5106 * S-<down> <2>: Creating timestamps. (line 58)
5107 * S-<down> <3>: Priorities. (line 25)
5108 * S-<down>: Plain lists. (line 57)
5109 * S-<left> <1>: Agenda commands. (line 150)
5110 * S-<left> <2>: Creating timestamps. (line 53)
5111 * S-<left>: TODO basics. (line 20)
5112 * S-<RET>: Built-in table editor.
5114 * S-<right> <1>: Agenda commands. (line 142)
5115 * S-<right> <2>: Creating timestamps. (line 53)
5116 * S-<right>: TODO basics. (line 20)
5117 * S-<TAB> <1>: Built-in table editor.
5119 * S-<TAB>: Visibility cycling. (line 22)
5120 * S-<up> <1>: Agenda commands. (line 126)
5121 * S-<up> <2>: Creating timestamps. (line 58)
5122 * S-<up> <3>: Priorities. (line 25)
5123 * S-<up>: Plain lists. (line 57)
5124 * T: Agenda commands. (line 107)
5125 * t: Agenda commands. (line 103)
5126 * w: Agenda commands. (line 62)
5127 * x: Agenda commands. (line 211)
5128 * X: Agenda commands. (line 164)
5134 Node: Introduction
\x7f9515
5135 Node: Summary
\x7f9828
5136 Node: Installation
\x7f12095
5137 Node: Feedback
\x7f13884
5138 Node: Document structure
\x7f14655
5139 Node: Outlines
\x7f15481
5140 Node: Headlines
\x7f16141
5141 Node: Visibility cycling
\x7f16764
5142 Ref: Visibility cycling-Footnote-1
\x7f18239
5143 Ref: Visibility cycling-Footnote-2
\x7f18297
5144 Node: Motion
\x7f18347
5145 Node: Structure editing
\x7f19131
5146 Node: Archiving
\x7f21240
5147 Node: ARCHIVE tag
\x7f21798
5148 Node: Moving subtrees
\x7f23473
5149 Node: Sparse trees
\x7f24514
5150 Ref: Sparse trees-Footnote-1
\x7f26493
5151 Ref: Sparse trees-Footnote-2
\x7f26585
5152 Node: Plain lists
\x7f26700
5153 Ref: Plain lists-Footnote-1
\x7f30305
5154 Node: Checkboxes
\x7f30662
5155 Node: Tables
\x7f32299
5156 Node: Built-in table editor
\x7f32847
5157 Node: Narrow columns
\x7f40454
5158 Ref: Narrow columns-Footnote-1
\x7f42393
5159 Node: Table calculations
\x7f42439
5160 Node: Formula syntax
\x7f43759
5161 Ref: Formula syntax-Footnote-1
\x7f46664
5162 Node: Lisp formulas
\x7f46964
5163 Node: Column formulas
\x7f47753
5164 Node: Advanced features
\x7f49515
5165 Node: Named-field formulas
\x7f52769
5166 Node: Editing/debugging formulas
\x7f53409
5167 Node: Appetizer
\x7f55167
5168 Node: orgtbl-mode
\x7f56270
5169 Node: table.el
\x7f56761
5170 Node: Hyperlinks
\x7f57738
5171 Node: Link format
\x7f58443
5172 Node: Internal links
\x7f59736
5173 Ref: Internal links-Footnote-1
\x7f61725
5174 Node: Radio targets
\x7f61857
5175 Node: CamelCase links
\x7f62572
5176 Node: External links
\x7f63070
5177 Node: Handling links
\x7f65201
5178 Ref: Handling links-Footnote-1
\x7f69787
5179 Node: Search options
\x7f70024
5180 Ref: Search options-Footnote-1
\x7f71798
5181 Node: Custom searches
\x7f71879
5182 Node: Remember
\x7f72927
5183 Node: TODO items
\x7f76617
5184 Node: TODO basics
\x7f77481
5185 Node: TODO extensions
\x7f79008
5186 Node: Workflow states
\x7f79803
5187 Node: TODO types
\x7f80671
5188 Ref: TODO types-Footnote-1
\x7f82329
5189 Node: Per file keywords
\x7f82411
5190 Ref: Per file keywords-Footnote-1
\x7f83865
5191 Node: Priorities
\x7f84093
5192 Node: Timestamps
\x7f85309
5193 Node: Time stamps
\x7f85699
5194 Node: Creating timestamps
\x7f88796
5195 Node: Progress logging
\x7f92142
5196 Node: Closing items
\x7f92672
5197 Node: Clocking work time
\x7f93467
5199 Node: Tag inheritance
\x7f96398
5200 Node: Setting tags
\x7f97335
5201 Ref: Setting tags-Footnote-1
\x7f100465
5202 Ref: Setting tags-Footnote-2
\x7f100577
5203 Node: Tag searches
\x7f100657
5204 Node: Agenda views
\x7f101866
5205 Node: Agenda files
\x7f103410
5206 Ref: Agenda files-Footnote-1
\x7f104370
5207 Ref: Agenda files-Footnote-2
\x7f104519
5208 Node: Agenda dispatcher
\x7f104711
5209 Node: Weekly/Daily agenda
\x7f106827
5210 Node: Categories
\x7f107962
5211 Node: Time-of-day specifications
\x7f108610
5212 Node: Calendar/Diary integration
\x7f110586
5213 Node: Sorting of agenda items
\x7f111963
5214 Node: Global TODO list
\x7f112795
5215 Node: Matching headline tags
\x7f114846
5216 Node: Timeline
\x7f115789
5217 Node: Agenda commands
\x7f116662
5218 Node: Embedded LaTeX
\x7f122506
5219 Ref: Embedded LaTeX-Footnote-1
\x7f123598
5220 Node: Math symbols
\x7f123788
5221 Node: Subscripts and Superscripts
\x7f124553
5222 Node: LaTeX fragments
\x7f125397
5223 Node: Processing LaTeX fragments
\x7f127466
5224 Node: CDLaTeX mode
\x7f128412
5225 Ref: CDLaTeX mode-Footnote-1
\x7f130896
5226 Node: Exporting
\x7f131044
5227 Node: ASCII export
\x7f132358
5228 Node: HTML export
\x7f133648
5229 Node: XOXO export
\x7f136484
5230 Node: iCalendar export
\x7f136923
5231 Node: Text interpretation
\x7f138746
5232 Node: Comment lines
\x7f139225
5233 Node: Enhancing text
\x7f139696
5234 Node: Export options
\x7f141388
5235 Node: Publishing
\x7f143055
5236 Ref: Publishing-Footnote-1
\x7f143851
5237 Node: Configuration
\x7f144047
5238 Node: Project alist
\x7f144765
5239 Node: Sources and destinations
\x7f145831
5240 Node: Selecting files
\x7f146378
5241 Node: Publishing action
\x7f147126
5242 Node: Publishing options
\x7f148241
5243 Node: Publishing links
\x7f150393
5244 Node: Project page index
\x7f151906
5245 Node: Sample configuration
\x7f152684
5246 Node: Simple example
\x7f153176
5247 Node: Complex example
\x7f153849
5248 Node: Triggering publication
\x7f155925
5249 Node: Miscellaneous
\x7f156609
5250 Node: Completion
\x7f157243
5251 Node: Customization
\x7f158239
5252 Node: In-buffer settings
\x7f158824
5253 Node: The very busy C-c C-c key
\x7f162055
5254 Node: Clean view
\x7f163692
5255 Node: TTY keys
\x7f166269
5256 Node: Interaction
\x7f167878
5257 Node: Cooperation
\x7f168275
5258 Node: Conflicts
\x7f170177
5259 Node: Bugs
\x7f171769
5260 Node: Extensions and Hacking
\x7f173392
5261 Node: Extensions
\x7f173878
5262 Node: Dynamic blocks
\x7f175448
5263 Node: History and Acknowledgments
\x7f177370
5264 Node: Index
\x7f182151
5265 Node: Key Index
\x7f204991