Mercurial > emacs
annotate man/org.texi @ 66424:86f81b226b02
*** empty log message ***
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Tue, 25 Oct 2005 04:58:35 +0000 |
parents | d979e1d45f97 |
children | 4beb6b8b80fc |
rev | line source |
---|---|
58792 | 1 \input texinfo |
2 @c %**start of header | |
65245
8a283bd1b6c0
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
65244
diff
changeset
|
3 @c @setfilename org |
8a283bd1b6c0
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
65244
diff
changeset
|
4 @setfilename ../info/org |
58792 | 5 @settitle Org Mode Manual |
6 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
7 @set VERSION 3.18 |
65965
927e31d586ca
(Workflow states): Documented that change in keywords
Carsten Dominik <dominik@science.uva.nl>
parents:
65656
diff
changeset
|
8 @set DATE October 2005 |
58792 | 9 |
10 @dircategory Emacs | |
11 @direntry | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
12 * Org Mode: (org). Outline-based notes management and organizer |
58792 | 13 @end direntry |
14 | |
15 @c Version and Contact Info | |
16 @set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage} | |
17 @set MAINTAINER Carsten Dominik | |
18 @set MAINTAINEREMAIL @email{dominik@@science.uva.nl} | |
19 @set MAINTAINERCONTACT @uref{mailto:dominik@@science.uva.nl,contact the maintainer} | |
20 @c %**end of header | |
21 @finalout | |
22 | |
23 @c Macro definitions | |
24 | |
25 @c Subheadings inside a table. Need a difference between info and the rest. | |
26 @macro tsubheading{text} | |
27 @ifinfo | |
28 @subsubheading \text\ | |
29 @end ifinfo | |
30 @ifnotinfo | |
31 @item @b{\text\} | |
32 @end ifnotinfo | |
33 @end macro | |
34 | |
35 @copying | |
36 This manual is for Org-mode (version @value{VERSION}). | |
37 | |
65244 | 38 Copyright @copyright{} 2004, 2005 Free Software Foundation |
58792 | 39 |
40 @quotation | |
41 Permission is granted to copy, distribute and/or modify this document | |
65656 | 42 under the terms of the GNU Free Documentation License, Version 1.1 or |
58792 | 43 any later version published by the Free Software Foundation; with no |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
45 and with the Back-Cover Texts as in (a) below. A copy of the | |
46 license is included in the section entitled ``GNU Free Documentation | |
47 License.'' | |
48 | |
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
50 this GNU Manual, like GNU software. Copies published by the Free | |
51 Software Foundation raise funds for GNU development.'' | |
52 @end quotation | |
53 @end copying | |
54 | |
55 @titlepage | |
56 @title Org Mode Manual | |
57 | |
58 @subtitle Release @value{VERSION} | |
59 @author by Carsten Dominik | |
60 | |
61 @c The following two commands start the copyright page. | |
62 @page | |
63 @vskip 0pt plus 1filll | |
64 @insertcopying | |
65 @end titlepage | |
66 | |
67 @c Output the table of contents at the beginning. | |
68 @contents | |
69 | |
70 @ifnottex | |
71 @node Top, Introduction, (dir), (dir) | |
72 @top Org Mode Manual | |
73 | |
74 @insertcopying | |
75 @end ifnottex | |
76 | |
77 @menu | |
78 * Introduction:: Getting started | |
79 * Document Structure:: A tree works like your brain | |
80 * Tables:: Pure magic for quick formatting | |
81 * Hyperlinks:: Notes in context | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
82 * TODO items:: Every tree branch can be a TODO item |
58792 | 83 * Timestamps:: Assign date and time to items |
84 * Timeline and Agenda:: Use time-stamped items to produce an agenda | |
85 * Exporting:: Sharing and publishing of notes | |
86 * Miscellaneous:: All the rest which did not fit elsewhere | |
87 * Index:: The fast road to specific information | |
88 * Key Index:: Key bindings and where they are described | |
89 | |
90 @detailmenu | |
91 --- The Detailed Node Listing --- | |
92 | |
93 Introduction | |
94 | |
95 * Summary:: Brief summary of what Org-mode does | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
96 * Installation and Activation:: How to install Org-mode |
64517 | 97 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 98 |
99 Document Structure | |
100 | |
101 * Outlines:: Org-mode is based on outline-mode | |
102 * Headlines:: How to typeset org-tree headlines | |
65656 | 103 * Visibility cycling:: Show and hide, much simplified |
58792 | 104 * Motion:: Jumping to other headlines |
105 * Structure editing:: Changing sequence and level of headlines | |
63362 | 106 * Archiving:: Move done task trees to a different place |
58792 | 107 * Sparse trees:: Matches embedded in context |
108 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
109 Tables |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
110 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
111 * Built-in table editor:: Simple tables |
63833 | 112 * Table calculations:: Compute a field from other fields |
113 * orgtbl-mode:: The table editor as minor mode | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
114 * table.el:: Complex tables |
63833 | 115 |
116 Calculations in tables | |
117 | |
118 * Formula syntax:: How to write a formula | |
64517 | 119 * Column formulas:: Formulas valid for all fields in a column |
120 * Advanced features:: Field names, parameters and automatic recalc | |
121 * Named-field formulas:: Formulas valid in single fields | |
122 * Editing/debugging formulas:: Changing a stored formula | |
65656 | 123 * Appetizer:: Taste the power of calc |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
124 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
125 Hyperlinks |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
126 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
127 * Links:: URL-like links to the world |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
128 * Remember:: Org-trees store quick notes |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
129 |
58792 | 130 TODO items |
131 | |
132 * TODO basics:: Marking and displaying TODO entries | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
133 * TODO extensions:: Workflow and assignments |
58792 | 134 * Priorities:: Some things are more important than others |
135 | |
136 Extended use of TODO keywords | |
137 | |
138 * Workflow states:: From TODO to DONE in steps | |
139 * TODO types:: I do this, Fred the rest | |
140 * Per file keywords:: Different files, different requirements | |
141 | |
142 Timestamps | |
143 | |
144 * Time stamps:: Assigning a time to a tree entry | |
145 * Creating timestamps:: Commands which insert timestamps | |
146 | |
147 Timeline and Agenda | |
148 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
149 * Timeline:: Time-sorted view for single file |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
150 * Agenda:: Your weekly planner |
58792 | 151 * Agenda commands:: Remote editing of org trees |
152 * Calendar/Diary integration:: Integrating Anniversaries and more | |
153 | |
154 Calendar/Diary integration | |
155 | |
156 * Diary to agenda:: Agenda incorporates the diary | |
157 * Agenda to diary:: Diary incorporates the agenda | |
158 | |
159 Exporting | |
160 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
161 * ASCII export:: Export as a structured ASCII file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
162 * HTML export:: Export as an HTML file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
163 * iCalendar export:: Create calendar entries. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
164 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
165 HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
166 |
58792 | 167 * HTML formatting:: Interpretation of the buffer content |
168 * Export options:: How to influence exports | |
169 * Comment lines:: Lines which will not be exported | |
170 | |
171 Miscellaneous | |
172 | |
173 * Completion:: M-TAB knows what you need | |
174 * Customization:: Adapting Org-mode to your taste | |
62548 | 175 * FAQ:: Frequently asked questions |
58792 | 176 * Interaction:: Other Emacs packages |
65656 | 177 * TTY keys:: Using Org-mode on a tty |
63362 | 178 * Bugs:: Things which do not work perfectly |
58792 | 179 * Acknowledgments:: These people provided feedback and more |
180 | |
181 @end detailmenu | |
182 @end menu | |
183 | |
184 @node Introduction, Document Structure, Top, Top | |
185 @chapter Introduction | |
186 @cindex introduction | |
187 | |
188 @menu | |
189 * Summary:: Brief summary of what Org-mode does | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
190 * Installation and Activation:: How to install Org-mode |
64517 | 191 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 192 @end menu |
193 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
194 @node Summary, Installation and Activation, Introduction, Introduction |
58792 | 195 @section Summary |
196 @cindex summary | |
197 | |
198 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing | |
199 project planning with a fast and effective plain-text system. | |
200 | |
201 Org-mode develops organizational tasks around NOTES files that contain | |
202 information about projects as plain text. Org-mode is implemented on | |
203 top of outline-mode, which makes it possible to keep the content of | |
204 large files well structured. Visibility cycling and structure editing | |
205 help to work with the tree. Tables are easily created with a built-in | |
206 table editor. Org-mode supports ToDo items, deadlines, time stamps, | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
207 and scheduling. It dynamically compiles entries into an agenda that |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
208 utilizes and smoothly integrates much of the Emacs calendar and diary. |
64517 | 209 Plain text URL-like links connect to websites, emails, Usenet |
58792 | 210 messages, BBDB entries, and any files related to the projects. For |
211 printing and sharing of notes, an Org-mode file can be exported as a | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
212 structured ASCII file, as HTML, or (todo and agenda items only) as an |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
213 iCalendar file. |
58792 | 214 |
215 Org-mode keeps simple things simple. Not every outline branch needs | |
216 to be an action item, not every action item needs to have priority or | |
217 scheduling information associated with it. Org-mode can be used on | |
218 different levels and in different ways, for example | |
219 | |
220 @example | |
221 @r{@bullet{} as an outline extension with visibility cycling and structure editing} | |
222 @r{@bullet{} as an ASCII system and table editor to take structured notes} | |
63833 | 223 @r{@bullet{} as an ASCII table editor with some spreadsheet-like capabilities} |
58792 | 224 @r{@bullet{} as a simple hypertext system, with HTML export} |
225 @r{@bullet{} as a TODO list editor} | |
226 @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} | |
227 @end example | |
228 | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
229 The Org-mode table editor can be integrated into any major mode by |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
230 activating the minor Orgtbl-mode. |
59541 | 231 |
232 There is a website for Org-mode which provides links to the newest | |
233 version of Org-mode, as well as additional information, screen shots | |
234 and example files. This page is located at | |
235 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. | |
236 | |
237 @page | |
238 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
239 @node Installation and Activation, Feedback, Summary, Introduction |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
240 @section Installation and Activation |
58792 | 241 @cindex installation |
242 @cindex autoload | |
243 @cindex global keybindings | |
244 @cindex keybindings, global | |
245 | |
62548 | 246 If Org-mode is part of the Emacs distribution or an XEmacs package, |
247 you only need to copy the following lines to your @file{.emacs} file. | |
248 The last two lines define @emph{global} keys for the commands | |
249 @command{org-store-link} and @command{org-agenda} - please choose | |
250 suitable keys yourself. | |
58792 | 251 |
62548 | 252 @lisp |
253 ;; The following lines are always needed. Choose your own keys. | |
254 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) | |
255 (define-key global-map "\C-cl" 'org-store-link) | |
256 (define-key global-map "\C-ca" 'org-agenda) | |
257 @end lisp | |
58792 | 258 |
62548 | 259 If you have downloaded Org-mode from the Web, you must byte-compile |
260 @file{org.el} and put it on your load path. In addition to the Emacs | |
261 Lisp lines above, you also need to add the following lines to | |
262 @file{.emacs}: | |
58792 | 263 |
264 @lisp | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
265 ;; These lines only if org-mode is not part of the X/Emacs distribution. |
58792 | 266 (autoload 'org-mode "org" "Org mode" t) |
267 (autoload 'org-diary "org" "Diary entries from Org mode") | |
268 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t) | |
269 (autoload 'org-store-link "org" "Store a link to the current location" t) | |
59541 | 270 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t) |
271 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode") | |
58792 | 272 @end lisp |
273 | |
274 @cindex org-mode, turning on | |
62548 | 275 With this setup, all files with extension @samp{.org} will be put into |
276 Org-mode. As an alternative, make the first line of a file look like | |
277 this: | |
58792 | 278 |
279 @example | |
280 MY PROJECTS -*- mode: org; -*- | |
281 @end example | |
282 | |
283 @noindent which will select Org-mode for this buffer no matter what | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
284 the file's name is. See also the variable |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
285 @code{org-insert-mode-line-in-empty-file'}. |
58792 | 286 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
287 @node Feedback, , Installation and Activation, Introduction |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
288 @section Feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
289 @cindex feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
290 @cindex bug reports |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
291 @cindex maintainer |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
292 @cindex author |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
293 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
294 If you find problems with Org-mode, or if you have questions, remarks, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
295 or ideas about it, please contact the maintainer Carsten Dominik at |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
296 @value{MAINTAINEREMAIL}. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
297 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
298 For bug reports, please provide as much information as possible, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
299 including the version information of Emacs (@kbd{C-h v emacs-version |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
300 @key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
301 Org-mode related setup in @file{.emacs}. If an error occurs, a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
302 traceback can be very useful. Often a small example file helps, along |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
303 with clear information about: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
304 @enumerate |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
305 @item What exactly did you do? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
306 @item What did you expect to happen? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
307 @item What happened instead? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
308 @end enumerate |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
309 @noindent Thanks for helping to improve this mode. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
310 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
311 @node Document Structure, Tables, Introduction, Top |
58792 | 312 @chapter Document Structure |
313 @cindex document structure | |
314 @cindex structure of document | |
315 | |
316 Org-mode is based on outline mode and provides flexible commands to | |
317 edit the structure of the document. | |
318 | |
319 @menu | |
320 * Outlines:: Org-mode is based on outline-mode | |
321 * Headlines:: How to typeset org-tree headlines | |
65656 | 322 * Visibility cycling:: Show and hide, much simplified |
58792 | 323 * Motion:: Jumping to other headlines |
324 * Structure editing:: Changing sequence and level of headlines | |
63362 | 325 * Archiving:: Move done task trees to a different place |
58792 | 326 * Sparse trees:: Matches embedded in context |
327 @end menu | |
328 | |
329 @node Outlines, Headlines, Document Structure, Document Structure | |
330 @section Outlines | |
331 @cindex outlines | |
332 @cindex outline-mode | |
333 | |
334 Org-mode is implemented on top of outline-mode. Outlines allow to | |
335 organize a document in a hierarchical structure, which (at least for | |
336 me) is the best representation of notes and thoughts. Overview over | |
337 this structure is achieved by folding (hiding) large parts of the | |
338 document to show only the general document structure and the parts | |
339 currently being worked on. Org-mode greatly simplifies the use of | |
340 outlines by compressing the entire show/hide functionality into a | |
341 single command @command{org-cycle}, which is bound to the @key{TAB} | |
342 key. | |
343 | |
344 @node Headlines, Visibility cycling, Outlines, Document Structure | |
345 @section Headlines | |
346 @cindex headlines | |
347 @cindex outline tree | |
348 | |
349 Headlines define the structure of an outline tree. The Headlines in | |
350 Org-mode start with one or more stars, for example | |
351 | |
352 @example | |
353 * Top level headline | |
354 ** Second level | |
355 *** 3rd level | |
356 some text | |
357 *** 3rd level | |
358 more text | |
359 * Another top level headline | |
360 @end example | |
361 | |
362 @node Visibility cycling, Motion, Headlines, Document Structure | |
363 @section Visibility cycling | |
364 @cindex visibility cycling | |
365 @cindex trees, visibility | |
366 | |
367 Outlines make it possible to hide parts of the text in the buffer. | |
368 Org-mode uses a single command bound to the @key{TAB} key to change | |
369 the visibility in the buffer. | |
370 | |
371 @cindex subtree visibility states | |
372 @cindex folded, subtree visibility state | |
373 @cindex children, subtree visibility state | |
374 @cindex subtree, subtree visibility state | |
375 @table @kbd | |
376 @kindex @key{TAB} | |
377 @item @key{TAB} | |
378 Rotate current subtree between the states | |
379 @example | |
380 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
381 '-----------------------------------' | |
382 @end example | |
383 At the beginning of the buffer (or when called with @kbd{C-u}), this does | |
384 the same as the command @kbd{S-@key{TAB}} below. | |
385 | |
386 @cindex global visibility states | |
387 @cindex overview, global visibility state | |
388 @cindex contents, global visibility state | |
389 @cindex show all, global visibility state | |
390 @kindex S-@key{TAB} | |
391 @item S-@key{TAB} | |
392 Rotate the entire buffer between the states | |
393 @example | |
394 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
395 '--------------------------------------' | |
396 @end example | |
397 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. | |
398 | |
399 @cindex show all, command | |
400 @kindex C-c C-a | |
401 @item C-c C-a | |
402 Show all. | |
403 @end table | |
404 | |
63833 | 405 When Emacs first visits an Org-mode file, the global state is set to |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
406 OVERVIEW, i.e. only the top level headlines are visible. This can be |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
407 configured through the variable @code{org-startup-folded}, or on a |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
408 per-file basis by adding one of the following lines anywhere in the |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
409 buffer: |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
410 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
411 @example |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
412 #+STARTUP: fold |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
413 #+STARTUP: nofold |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
414 #+STARTUP: content |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
415 @end example |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
416 |
58792 | 417 @node Motion, Structure editing, Visibility cycling, Document Structure |
418 @section Motion | |
419 @cindex motion, between headlines | |
420 @cindex jumping, to headlines | |
421 The following commands jump to other headlines in the buffer. | |
422 | |
423 @table @kbd | |
424 @kindex C-c C-n | |
425 @item C-c C-n | |
426 Next heading. | |
427 @kindex C-c C-p | |
428 @item C-c C-p | |
429 Previous heading. | |
430 @kindex C-c C-f | |
431 @item C-c C-f | |
432 Next heading same level. | |
433 @kindex C-c C-b | |
434 @item C-c C-b | |
435 Previous heading same level. | |
436 @kindex C-c C-u | |
437 @item C-c C-u | |
438 Backward to higher level heading. | |
439 @kindex C-c C-j | |
440 @item C-c C-j | |
441 Jump to a different place without changing the current outline | |
442 visibility. Shows the document structure in a temporary buffer, where | |
443 you can use visibility cycling (@key{TAB}) to find your destination. | |
444 After pressing @key{RET}, the cursor moves to the selected location in | |
445 the original buffer, and the headings hierarchy above it is made | |
446 visible. | |
447 @end table | |
448 | |
63362 | 449 @node Structure editing, Archiving, Motion, Document Structure |
58792 | 450 @section Structure editing |
451 @cindex structure editing | |
452 @cindex headline, promotion and demotion | |
453 @cindex promotion, of subtrees | |
454 @cindex demotion, of subtrees | |
455 @cindex subtree, cut and paste | |
63833 | 456 @cindex pasting, of subtrees |
457 @cindex cutting, of subtrees | |
458 @cindex copying, of subtrees | |
58792 | 459 |
460 @table @kbd | |
461 @kindex M-@key{RET} | |
462 @item M-@key{RET} | |
463 Insert new heading with same level as current | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
464 @kindex M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
465 @item M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
466 Insert new TODO entry with same level as current heading. |
58792 | 467 @kindex M-@key{left} |
468 @item M-@key{left} | |
469 Promote current heading by one level | |
470 @kindex M-@key{right} | |
471 @item M-@key{right} | |
472 Demote current heading by one level | |
473 @kindex M-S-@key{left} | |
474 @item M-S-@key{left} | |
475 Promote the current subtree by one level | |
476 @kindex M-S-@key{right} | |
477 @item M-S-@key{right} | |
478 Demote the current subtree by one level | |
479 @kindex M-S-@key{up} | |
480 @item M-S-@key{up} | |
481 Move subtree up (swap with previous subtree of same level) | |
482 @kindex M-S-@key{down} | |
483 @item M-S-@key{down} | |
484 Move subtree down (swap with next subtree of same level) | |
65656 | 485 @kindex C-c C-x C-w |
486 @item C-c C-x C-w | |
58792 | 487 Kill subtree, i.e. remove it from buffer but save in kill ring. |
65656 | 488 @kindex C-c C-x M-w |
489 @item C-c C-x M-w | |
58792 | 490 Copy subtree to kill ring. |
65656 | 491 @kindex C-c C-x C-y |
492 @item C-c C-x C-y | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
493 Yank subtree from kill ring. This does modify the level of the subtree to |
58792 | 494 make sure the tree fits in nicely at the yank position. The yank |
495 level can also be specified with a prefix arg, or by yanking after a | |
496 headline marker like @samp{****}. | |
497 @end table | |
498 | |
499 @cindex region, active | |
500 @cindex active region | |
501 @cindex transient-mark-mode | |
502 When there is an active region (transient-mark-mode), promotion and | |
503 demotion work on all headlines in the region. To select a region of | |
504 headlines, it is best to place both point and mark at the beginning of a | |
505 line, mark at the beginning of the first headline, and point at the line | |
506 just after the last headline to change. Note that when the cursor is | |
507 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
508 functionality. | |
509 | |
63362 | 510 @node Archiving, Sparse trees, Structure editing, Document Structure |
511 @section Archiving | |
512 @cindex archiving | |
513 | |
63833 | 514 When a project represented by a (sub)tree is finished, you may want |
515 to move the tree to an archive place, either in the same file under a | |
63362 | 516 special top-level heading, or even to a different file. |
517 @table @kbd | |
63833 | 518 @kindex C-c $ |
63362 | 519 @item @kbd{C-c $} |
520 Archive the subtree starting at the cursor position to the location | |
521 given by @code{org-archive-location}. | |
522 @end table | |
523 | |
524 @cindex archive locations | |
525 The default archive is a file in the same directory as the current | |
526 file, with the name derived by appending @file{_archive} to the | |
527 current file name. For information and examples on how to change | |
528 this, see the documentation string of the variable | |
529 @code{org-archive-location}. If you are also using the Org-mode | |
530 agenda, archiving to a different file is a good way to keep archived | |
531 trees from contributing agenda items. | |
532 | |
533 @node Sparse trees, , Archiving, Document Structure | |
58792 | 534 @section Sparse trees |
535 @cindex sparse trees | |
536 @cindex trees, sparse | |
537 @cindex folding, sparse trees | |
538 @cindex occur, command | |
539 | |
540 An important feature of Org-mode is the ability to construct | |
541 @emph{sparse trees} for selected information in an outline tree. A | |
542 sparse tree means that the entire document is folded as much as | |
543 possible, but the selected information is made visible along with the | |
62548 | 544 headline structure above it@footnote{See also the variable |
63833 | 545 @code{org-show-following-heading}.}. Just try it out and you will see |
58792 | 546 immediately how it works. |
547 | |
548 Org-mode contains several commands creating such trees. The most | |
549 basic one is @command{org-occur}: | |
550 | |
551 @table @kbd | |
552 @kindex C-c / | |
553 @item C-c / | |
554 Occur. Prompts for a regexp and shows a sparse tree with all matches. | |
555 If the match is in a headline, the headline is made visible. If the | |
556 match is in the body of an entry, headline and body are made visible. | |
557 In order to provide minimal context, also the full hierarchy of | |
558 headlines above the match is shown, as well as the headline following | |
559 the match. | |
560 @end table | |
561 | |
562 Other commands are using this feature as well. For example @kbd{C-c | |
563 C-v} creates a sparse TODO tree (@pxref{TODO basics}). | |
564 | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
565 @kindex C-c C-x v |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
566 @cindex printing sparse trees |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
567 @cindex visible text, printing |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
568 To print a sparse tree, you can use the Emacs command |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
569 @code{ps-print-buffer-with-faces} which does not print invisible parts |
63833 | 570 of the document @footnote{This does not work under XEmacs, because |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
571 XEmacs uses selective display for outlining, not text properties}. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
572 Or you can use the command @kbd{C-c C-x v} to copy the visible part of |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
573 the document to another file (extension @file{.txt}) which then can be |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
574 printed in any desired way. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
575 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
576 @node Tables, Hyperlinks, Document Structure, Top |
58792 | 577 @chapter Tables |
578 @cindex tables | |
579 | |
63833 | 580 Org-mode has a very fast and intuitive table editor built-in. |
581 Spreadsheet-like calculations are supported in connection with the | |
582 Emacs @file{calc} package. | |
58792 | 583 |
584 @menu | |
585 * Built-in table editor:: Simple tables | |
63833 | 586 * Table calculations:: Compute a field from other fields |
587 * orgtbl-mode:: The table editor as minor mode | |
58792 | 588 * table.el:: Complex tables |
589 @end menu | |
590 | |
63833 | 591 @node Built-in table editor, Table calculations, Tables, Tables |
58792 | 592 @section The built-in table editor |
593 @cindex table editor, builtin | |
594 | |
595 Org-mode makes it easy to format tables in plain ASCII. Any line with | |
596 @samp{|} as the first non-white character is considered part of a | |
597 table. @samp{|} is also the column separator. A table might look | |
598 like this: | |
599 | |
600 @example | |
601 | Name | Phone | Age | | |
602 |-------+-------+-----| | |
603 | Peter | 1234 | 17 | | |
604 | Anna | 4321 | 25 | | |
605 @end example | |
606 | |
607 A table is re-aligned automatically each time you press @key{TAB} or | |
63833 | 608 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to |
609 the next field (@key{RET} to the next row) and creates new table rows | |
610 at the end of the table or before horizontal lines. The indentation | |
611 of the table is set by the first line. Any line starting with | |
612 @samp{|-} is considered as a horizontal separator line and will be | |
613 expanded on the next re-align to span the whole table width. So, to | |
614 create the above table, you would only type | |
58792 | 615 |
616 @example | |
617 |Name|Phone|Age | |
618 |- | |
619 @end example | |
620 @noindent and then press @key{TAB} to align the table and start filling in | |
621 fields. | |
622 | |
65656 | 623 When typing text into a field, Org-mode treats @key{DEL}, |
624 @key{Backspace}, and all character keys in a special way, so that | |
625 inserting and deleting avoids shifting other fields. Also, when | |
626 typing @emph{immediately after the cursor was moved into a new field | |
627 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
628 field is automatically made blank. If this behavior is too | |
629 unpredictable for you, configure the variables | |
630 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
631 | |
58792 | 632 @table @kbd |
633 @tsubheading{Creation and conversion} | |
63833 | 634 @item M-x org-table-create |
635 Creates an empty Org-mode table. However, it is much easier to just | |
636 start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}} | |
58792 | 637 |
638 @kindex C-c C-c | |
639 @item C-c C-c | |
640 Convert region to table. Works when the cursor is not in an existing | |
641 table, and when there is a region defined. If every line contains at | |
642 least one TAB character, the function assumes that the material is tab | |
643 separated. If not, lines are split at whitespace into fields. You | |
644 can use a prefix argument to indicate how many consecutive spaces are | |
645 at least required to indicate a field separator (default: just one). | |
646 | |
647 @tsubheading{Re-aligning and field motion} | |
648 @kindex C-c C-c | |
649 @item C-c C-c | |
650 Re-align the table without moving the cursor. | |
651 | |
652 @kindex @key{TAB} | |
653 @item @key{TAB} | |
654 Re-align the table, move to the next field. Creates a new row if | |
655 necessary. | |
656 | |
657 @kindex S-@key{TAB} | |
658 @item S-@key{TAB} | |
63833 | 659 Re-align, move to previous field. |
58792 | 660 |
661 @kindex @key{RET} | |
662 @item @key{RET} | |
663 Re-align the table and move down to next row. Creates a new row if | |
664 necessary. At the beginning or end of a line, @key{RET} still does | |
665 NEWLINE, so it can be used to split a table. | |
666 | |
667 @tsubheading{Column and row editing} | |
668 @kindex M-@key{left} | |
669 @kindex M-@key{right} | |
670 @item M-@key{left} | |
671 @itemx M-@key{right} | |
672 Move the current column left/right | |
673 | |
674 @kindex M-S-@key{left} | |
675 @item M-S-@key{left} | |
676 Kill the current column. | |
677 | |
678 @kindex M-S-@key{right} | |
679 @item M-S-@key{right} | |
680 Insert a new column to the left of the cursor position. | |
681 | |
682 @kindex M-@key{up} | |
683 @kindex M-@key{down} | |
684 @item M-@key{up} | |
685 @itemx M-@key{down} | |
686 Move the current row up/down | |
687 | |
688 @kindex M-S-@key{up} | |
689 @item M-S-@key{up} | |
690 Kill the current row or horizontal line. | |
691 | |
692 @kindex M-S-@key{down} | |
693 @item M-S-@key{down} | |
694 Insert a new row above (with arg: below) the current row. | |
695 | |
696 @kindex C-c - | |
697 @item C-c - | |
63833 | 698 Insert a horizontal line below current row. With prefix arg, the line |
699 is created above the current line. | |
58792 | 700 |
701 @tsubheading{Regions} | |
65656 | 702 @kindex C-c C-x M-w |
703 @item C-c C-x M-w | |
63833 | 704 Copy a rectangular region from a table to a special clipboard. Point |
58792 | 705 and mark determine edge fields of the rectangle. The process ignores |
706 horizontal separator lines. | |
65656 | 707 @kindex C-c C-x C-w |
708 @item C-c C-x C-w | |
63833 | 709 Copy a rectangular region from a table to a special clipboard, and |
710 blank all fields in the rectangle. So this is the ``cut'' operation. | |
65656 | 711 @kindex C-c C-x C-y |
712 @item C-c C-x C-y | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
713 Paste a rectangular region into a table. |
58792 | 714 The upper right corner ends up in the current field. All involved fields |
715 will be overwritten. If the rectangle does not fit into the present table, | |
716 the table is enlarged as needed. The process ignores horizontal separator | |
717 lines. | |
718 @kindex C-c C-q | |
719 @item C-c C-q | |
720 Wrap several fields in a column like a paragraph. If there is an active | |
721 region, and both point and mark are in the same column, the text in the | |
722 column is wrapped to minimum width for the given number of lines. A | |
723 prefix ARG may be used to change the number of desired lines. If there | |
724 is no region, the current field is split at the cursor position and the | |
725 text fragment to the right of the cursor is prepended to the field one | |
726 line down. If there is no region, but you specify a prefix ARG, the | |
727 current field gets blank, and the content is appended to the field | |
728 above. | |
729 | |
730 @tsubheading{Calculations} | |
63833 | 731 @cindex formula, in tables |
732 @cindex calculations, in tables | |
733 @kindex C-c = | |
734 @item C-c = | |
64517 | 735 Install a new formula for the current column and replace current field |
736 with the result of the formula. | |
737 | |
738 @kindex C-u C-c = | |
739 @item C-u C-c = | |
740 Install a new formula for the current field, which must be a named | |
741 field. Evaluate the formula and replace the field content with the | |
742 result. | |
743 | |
744 @kindex C-c ' | |
745 @item C-c ' | |
746 Edit all formulas associated with the current table in a separate | |
747 buffer. | |
63833 | 748 |
749 @kindex C-c * | |
750 @item C-c * | |
751 Recalculate the current row by applying the stored formulas from left | |
752 to right. When called with a @kbd{C-u} prefix, recalculate the | |
753 entire table, starting with the first non-header line (i.e. below the | |
754 first horizontal separator line). For details, see @ref{Table calculations}. | |
755 | |
756 @kindex C-# | |
757 @item C-# | |
64517 | 758 Rotate the calculation mark in first column through the states |
63833 | 759 @samp{}, @samp{#}, @samp{*}, @samp{!}, @samp{$}. For the meaning of |
64517 | 760 these marks see @ref{Advanced features}. When there is an active |
63833 | 761 region, change all marks in the region. |
762 | |
58792 | 763 @kindex C-c ? |
764 @item C-c ? | |
765 Which table column is the cursor in? Displays number >0 in echo | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
766 area. |
58792 | 767 |
768 @cindex region, active | |
769 @cindex active region | |
770 @cindex transient-mark-mode | |
771 @kindex C-c + | |
772 @item C-c + | |
773 Sum the numbers in the current column, or in the rectangle defined by | |
63833 | 774 the active region. The result is shown in the echo area and can |
58792 | 775 be inserted with @kbd{C-y}. |
776 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
777 @kindex S-@key{RET} |
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
778 @item S-@key{RET} |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
779 When current field is empty, copy from first non-empty field above. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
780 When not empty, copy current field down to next row and move cursor |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
781 along with it. Depending on the variable |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
782 @code{org-table-copy-increment}, integer field values will be |
63362 | 783 incremented during copy. This key is also used by CUA-mode |
784 (@pxref{Interaction}). | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
785 |
58792 | 786 @tsubheading{Miscellaneous} |
787 @kindex C-c | | |
788 @item C-c | | |
789 Toggle the visibility of vertical lines in tables. The lines are | |
790 still there, only made invisible with a text property. Any @samp{|} | |
791 added by hand will become invisible on the next align. | |
792 | |
793 @item M-x org-table-import | |
794 Import a file as a table. The table should be TAB- or whitespace | |
795 separated. Useful for example to import an Excel table or data from a | |
796 database, because these programs generally can write TAB-separated text | |
797 files. This command works by inserting the file into the buffer and | |
798 then converting the region to a table. Any prefix argument is passed on | |
799 to the converter, which uses it to determine the separator. | |
800 | |
801 @item M-x org-table-export | |
802 Export the table as a TAB-separated file. Useful for data exchange with | |
803 for example Excel or database programs. | |
804 | |
805 @end table | |
806 | |
807 If you don't like the automatic table editor because it gets into your | |
808 way in lines which you would like to start with @samp{|}, you can turn | |
809 it off with | |
810 @lisp | |
811 (setq org-enable-table-editor nil) | |
812 @end lisp | |
813 @noindent The only table command which then still works is | |
814 @kbd{C-c C-c} to do a manual re-align. | |
815 | |
63833 | 816 @node Table calculations, orgtbl-mode, Built-in table editor, Tables |
817 @section Calculations in tables | |
818 @cindex calculations, in tables | |
819 | |
65656 | 820 The table editor makes use of the Emacs @file{calc} package to |
821 implement spreadsheet-like capabilities. Org-mode has two levels of | |
822 complexity for table calculations. On the basic level, tables do only | |
823 horizontal computations, so a field can be computed from other fields | |
824 @emph{in the same row}, and Org-mode assumes that there is only one | |
825 formula for each column. This is very efficient to work with and | |
826 enough for many tasks. On the complex level, columns and individual | |
827 fields can be named for easier referencing in formulas, individual | |
828 named fields can have their own formula associated with them, and | |
829 recalculation can be automated. | |
63833 | 830 |
831 @menu | |
832 * Formula syntax:: How to write a formula | |
64517 | 833 * Column formulas:: Formulas valid for all fields in a column |
834 * Advanced features:: Field names, parameters and automatic recalc | |
835 * Named-field formulas:: Formulas valid in single fields | |
836 * Editing/debugging formulas:: Changing a stored formula | |
837 * Appetizer:: Taste the power of calc | |
63833 | 838 @end menu |
839 | |
64517 | 840 @node Formula syntax, Column formulas, Table calculations, Table calculations |
63833 | 841 @subsection Formula syntax |
842 | |
64517 | 843 A formula can be any algebraic expression understood by the Emacs |
844 @file{calc} package. Before evaluation by @code{calc-eval} | |
845 (@pxref{Calling Calc from Your Lisp Programs,calc-eval,Calling calc | |
846 from Your Lisp Programs,calc,GNU Emacs Calc Manual}), variable | |
847 substitution takes place: | |
848 | |
849 @example | |
850 $ @r{refers to the current field} | |
851 $3 @r{refers to the field in column 3 of the current row} | |
852 $3..$7 @r{a vector of the fields in columns 3-7 of current row} | |
853 $P1..$P3 @r{vector of column range, using column names} | |
854 &2 @r{second data field above the current, in same column} | |
855 &5-2 @r{vector from fifth to second field above current} | |
856 &III-II @r{vector of fields between 2nd and 3rd hline above} | |
857 &III @r{vector of fields between third hline above and current field} | |
858 $name @r{a named field, parameter or constant} | |
859 @end example | |
860 | |
861 The range vectors can be directly fed into the calc vector functions | |
862 like functions @samp{vmean} and @samp{vsum}. | |
863 | |
864 @samp{$name} is interpreted as the name of a column, parameter or | |
865 constant. Constants are defined globally through the variable | |
866 @code{org-table-formula-constants}. If you have the | |
63833 | 867 @file{constants.el} package, it will also be used to resolve |
64517 | 868 constants, including natural constants like @samp{$k} for Planck's |
63833 | 869 constant, units like @samp{$km} for kilometers. Column names and |
870 parameters can be specified in special table lines. These are | |
64517 | 871 described below, see @ref{Advanced features}. |
63833 | 872 |
873 A formula can contain an optional mode string after a semicolon. This | |
874 string consists of flags to influence calc's modes@footnote{By | |
875 default, Org-mode uses the standard calc modes (precision 12, angular | |
876 units degrees, fraction and symbolic modes off). However, the display | |
65656 | 877 format has been changed to @code{(float 5)} to keep tables compact. |
878 The default settings can be configured using the variable | |
63833 | 879 @code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to |
880 switch the internal precision to 20 digits, @samp{n3}, @samp{s3}, | |
881 @samp{e2} or @samp{f4} to switch to normal, scientific, engineering, | |
882 or fix display format, respectively, and @samp{D}, @samp{R}, @samp{F}, | |
883 and @samp{S} to turn on degrees, radians, fraction and symbolic modes, | |
64517 | 884 respectively. In addition, you may provide a @code{printf} format |
885 specifier to reformat the final result. A few examples: | |
63833 | 886 @example |
887 $1+$2 @r{Sum of first and second field} | |
888 $1+$2;%.2f @r{Same, format result to two decimals} | |
889 exp($2)+exp($1) @r{Math functions can be used} | |
890 $;%.1f @r{Reformat current cell to 1 decimal} | |
64517 | 891 ($3-32)*5/9 @r{Degrees F -> C conversion} |
63833 | 892 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} |
64517 | 893 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} |
894 sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
895 vmean($2..$7) @r{Compute column range mean, using vector function} | |
896 vsum(&III) @r{Sum numbers from 3rd hline above to here} | |
63833 | 897 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} |
898 @end example | |
899 | |
64517 | 900 @node Column formulas, Advanced features, Formula syntax, Table calculations |
901 @subsection Column formulas | |
63833 | 902 |
903 To apply a formula to a field, type it directly into the field, | |
904 preceded by an equal sign, like @samp{=$1+$2}. When you press | |
905 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
64517 | 906 field, the formula will be stored as the formula for the current |
907 column, evaluated and the current field replaced with the result. If | |
908 the field contains only @samp{=}, the previously stored formula for | |
909 this column is used. | |
63833 | 910 |
911 For each column, Org-mode will remember the most recently used | |
64517 | 912 formula. The information is stored in a special line starting with |
913 @samp{#+TBLFM} directly below the table. When adding/deleting/moving | |
914 columns with the appropriate commands, the stored equations will be | |
915 modified accordingly. When a column used in a calculation is removed, | |
916 references to this column become invalid and will cause an error upon | |
917 applying the equation. | |
63833 | 918 |
919 Instead of typing an equation into the field, you may also use the | |
920 command @kbd{C-c =}. It prompts for a formula (with default taken | |
64517 | 921 from the @samp{#+TBLFM:} line) and applies it to the current field. A |
922 numerical prefix (e.g. @kbd{C-5 C-c =}) will apply it to that many | |
923 subsequent fields in the current column. | |
58792 | 924 |
63833 | 925 To recompute all the fields in a line, use the command @kbd{C-c *}. |
926 It re-applies all stored equations to the current row, from left to | |
927 right. With a @kbd{C-u} prefix, this will be done to every line in | |
928 the table, so use this command it you want to make sure the entire | |
64517 | 929 table is up-to-date. @kbd{C-u C-c C-c} is another way to update the |
930 entire table. Global updating does not touch the line(s) above the | |
931 first horizontal separator line, assuming that this is the table | |
932 header. | |
933 | |
934 @node Advanced features, Named-field formulas, Column formulas, Table calculations | |
935 @subsection Advanced features | |
936 | |
937 If you want want the recalculation of fields to happen automatically, | |
938 or if you want to be able to assign a formula to an individual field | |
939 (instead of an entire column) you need to reserve the first column of | |
940 the table for special marking characters. Here is an example of a | |
941 table that collects exam results of students and makes use of these | |
942 features: | |
63833 | 943 @example |
944 @group | |
945 |---+---------+--------+--------+--------+-------+------| | |
946 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
947 |---+---------+--------+--------+--------+-------+------| | |
948 | ! | | P1 | P2 | P3 | Tot | | | |
949 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
64069 | 950 | ^ | | m1 | m2 | m3 | mt | | |
63833 | 951 |---+---------+--------+--------+--------+-------+------| |
952 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
64517 | 953 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | |
63833 | 954 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
955 |---+---------+--------+--------+--------+-------+------| | |
64517 | 956 | | Average | | | | 29.7 | | |
957 | ^ | | | | | at | | | |
63833 | 958 | $ | max=50 | | | | | | |
959 |---+---------+--------+--------+--------+-------+------| | |
64517 | 960 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f |
63833 | 961 @end group |
962 @end example | |
64517 | 963 |
964 @noindent @b{Important}: Please note that for these special tables, | |
965 recalculating the table with @kbd{C-u C-c *} does only affect rows | |
966 which are marked @samp{#} or @samp{*}, and named fields. The column | |
967 formulas are not applied in rows with empty first field. | |
968 | |
969 The marking characters have the following meaning: | |
970 @table @samp | |
971 @item ! | |
972 The fields in this line define names for the columns, so that you may | |
973 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
974 @item ^ | |
975 This row define names for the fields @emph{above} the row. With such | |
976 a definition, any formula in the table may use @samp{$m1} to refer to | |
977 the value @samp{10}. Also, named fields can have their own formula | |
978 associated with them. | |
979 @item _ | |
980 Similar to @samp{^}, but defines names for the fields in the row | |
981 @emph{below}. | |
982 @item $ | |
983 Fields in this row can define @emph{parameters} for formulas. For | |
984 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
985 formulas in this table can refer to the value 50 using @samp{$max}. | |
986 Parameters work exactly like constants, only that they can be defined on | |
987 a per-table basis. Changing a parameter and then recalculating the | |
988 table can be useful. | |
989 @item # | |
990 Fields in this row are automatically recalculated when pressing | |
991 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
992 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
993 lines will be left alone by this command. | |
994 @item * | |
995 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
996 not for automatic recalculation. Use this when automatic | |
997 recalculation slows down editing too much. | |
998 @item | |
999 Unmarked lines are exempted from recalculation with @kbd{C-u C-c *}. | |
1000 All lines that should be recalculated should be marked with @samp{#} | |
1001 or @samp{*}. | |
1002 @end table | |
1003 | |
1004 @node Named-field formulas, Editing/debugging formulas, Advanced features, Table calculations | |
1005 @subsection Named-field formulas | |
1006 | |
1007 A named field can have its own formula associated with it. In the | |
1008 example above, this is used for the @samp{at} field that contains | |
1009 the average result of the students. To enter a formula for a named | |
1010 field, just type it onto the buffer, preceded by @samp{:=}. Or use | |
1011 @kbd{C-u C-c =}. This equation will be stored below the table like | |
1012 @samp{$name=...}. Any recalculation in the table (even if only | |
1013 requested for the current line) will also update all named field | |
1014 formulas. | |
1015 | |
1016 @node Editing/debugging formulas, Appetizer, Named-field formulas, Table calculations | |
1017 @subsection Editing and debugging formulas | |
1018 | |
1019 To edit a column or field formula, you can use the commands @kbd{C-c | |
1020 =} and @kbd{C-u C-c =}, respectively. The currently active expression | |
1021 is then presented as default in the minibuffer, were it may be edited. | |
1022 | |
1023 Note that making a table field blank does not remove the formula | |
1024 associated with the field - during the next recalculation the field | |
1025 will be filled again. To remove a formula from a field, you have to | |
1026 give an empty reply when prompted for the formula, or to edit the | |
1027 @samp{#+TBLFM} line. | |
1028 | |
1029 @kindex C-c C-c | |
1030 You may edit the @samp{#+TBLFM} directly and re-apply | |
1031 the changed equations with @kbd{C-c C-c} in that line, or with the | |
1032 normal recalculation commands in the table. | |
1033 | |
1034 @kindex C-c ' | |
1035 @kindex C-c C-c | |
1036 @kindex C-c C-q | |
1037 @kindex C-c ? | |
1038 In particular for large tables with many formulas, it is convenient to | |
1039 use the command @kbd{C-c '} to edit the formulas of the current table | |
1040 in a separate buffer. That buffer will show the formulas one per | |
1041 line, and you are free to edit, add and remove formulas. Press | |
1042 @kbd{C-c ?} on a @samp{$...} expression to get information about its | |
1043 interpretation. Exiting the buffer with @kbd{C-c C-c} only stores the | |
1044 modified formulas below the table. Exiting with @kbd{C-u C-c C-c} | |
1045 also applies them to the entire table. @kbd{C-c C-q} exits without | |
1046 installing the changes. | |
1047 | |
1048 When the evaluation of a formula leads to an error, the field content | |
1049 becomes the string @samp{#ERROR}. If you would like see what is going | |
1050 on during variable substitution and calculation in order to find a | |
1051 bug, turn on formula debugging in the menu and repeat the calculation | |
1052 by pressing, for example by pressing @kbd{C-c = @key{RET}} in a field. | |
1053 Detailed information will be displayed. | |
1054 | |
1055 @node Appetizer, , Editing/debugging formulas, Table calculations | |
1056 @subsection Appetizer | |
1057 | |
1058 Finally, just to wet your appetite on what can be done with the fantastic | |
63833 | 1059 @file{calc} package, here is a table that computes the Taylor series |
1060 for a couple of functions (homework: try that with Excel :-) | |
1061 | |
1062 @example | |
1063 @group | |
1064 |---+-------------+---+-----+--------------------------------------| | |
1065 | | Func | n | x | Result | | |
1066 |---+-------------+---+-----+--------------------------------------| | |
1067 | # | exp(x) | 1 | x | 1 + x | | |
1068 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
1069 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
1070 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
1071 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
1072 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
1073 |---+-------------+---+-----+--------------------------------------| | |
1074 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
1075 @end group | |
1076 @end example | |
1077 | |
1078 @node orgtbl-mode, table.el, Table calculations, Tables | |
59541 | 1079 @section The Orgtbl minor mode |
1080 @cindex orgtbl-mode | |
63833 | 1081 @cindex minor mode for tables |
59541 | 1082 |
1083 If you like the intuitive way the Org-mode table editor works, you | |
1084 might want to use it also in other modes like text-mode or mail-mode. | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1085 The minor mode Orgtbl-mode makes this possible. You can always toggle |
59541 | 1086 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1087 example in mail mode, use | |
1088 @lisp | |
1089 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1090 @end lisp | |
1091 | |
63833 | 1092 @node table.el, , orgtbl-mode, Tables |
1093 @section The @file{table.el} package | |
1094 @kindex C-c C-c | |
1095 @cindex table editor, @file{table.el} | |
1096 @cindex @file{table.el} | |
1097 | |
1098 Complex ASCII tables with automatic line wrapping, column- and | |
1099 row-spanning, and alignment can be created using the Emacs table | |
1100 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}). | |
1101 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode | |
1102 will call @command{table-recognize-table} and move the cursor into the | |
1103 table. Inside a table, the keymap of Org-mode is inactive. In order | |
1104 to execute Org-mode-related commands, leave the table. | |
1105 | |
1106 @table @kbd | |
1107 @kindex C-c C-c | |
1108 @item C-c C-c | |
1109 Recognize @file{table.el} table. Works when the cursor is in a | |
1110 table.el table. | |
1111 | |
1112 @kindex C-c ~ | |
1113 @item C-c ~ | |
1114 Insert a table.el table. If there is already a table at point, this | |
1115 command converts it between the table.el format and the Org-mode | |
1116 format. See the documentation string of the command | |
1117 @code{org-convert-table} for the restrictions under which this is | |
1118 possible. | |
1119 @end table | |
1120 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1121 @node Hyperlinks, TODO items, Tables, Top |
58792 | 1122 @chapter Hyperlinks |
1123 @cindex hyperlinks | |
1124 | |
64517 | 1125 Just like HMTL, Org-mode provides links to other files, Usenet |
58792 | 1126 articles, emails and much more. |
1127 | |
1128 @menu | |
1129 * Links:: URL-like links to the world | |
1130 * Remember:: Org-trees store quick notes | |
1131 @end menu | |
1132 | |
1133 @node Links, Remember, Hyperlinks, Hyperlinks | |
1134 @section Links | |
1135 @cindex links | |
1136 @cindex GNUS links | |
1137 @cindex BBDB links | |
63833 | 1138 @cindex URL links |
1139 @cindex file links | |
58792 | 1140 @cindex VM links |
1141 @cindex RMAIL links | |
1142 @cindex WANDERLUST links | |
1143 @cindex USENET links | |
1144 @cindex SHELL links | |
1145 | |
64517 | 1146 Org-mode supports links to files, websites, Usenet and email messages; |
63362 | 1147 and BBDB database entries. Links are just plain-text URL-like |
1148 locators, optionally enclosed by angular brackets. The following list | |
1149 shows examples for each link type. | |
58792 | 1150 |
1151 @example | |
63362 | 1152 <http://www.astro.uva.nl/~dominik> @r{on the web} |
1153 <file:/home/dominik/images/jupiter.jpg> @r{file, absolute path} | |
1154 <file:papers/last.pdf> @r{file, relative path} | |
1155 <file:~/code/main.c:255> @r{file, with line number} | |
1156 <news:comp.emacs> @r{Usenet link} | |
1157 <mailto:adent@@galaxy.net> @r{Mail link} | |
1158 <vm:folder> @r{VM folder link} | |
1159 <vm:folder#id> @r{VM message link} | |
1160 <vm://myself@@some.where.org/folder#id> @r{VM on remote machine} | |
1161 <wl:folder> @r{WANDERLUST folder link} | |
1162 <wl:folder#id> @r{WANDERLUST message link} | |
1163 <rmail:folder> @r{RMAIL folder link} | |
1164 <rmail:folder#id> @r{RMAIL message link} | |
1165 <gnus:group> @r{GNUS group link} | |
1166 <gnus:group#id> @r{GNUS article link} | |
1167 <bbdb:Richard Stallman> @r{BBDB link} | |
1168 <shell:ls *.org>@footnote{Note that @samp{<} and @samp{>} cannot be part of a link, and therefore of a shell command. If you need redirection, use @@@{ and @@@} instead.} @r{A shell command} | |
58792 | 1169 @end example |
1170 | |
63362 | 1171 A link may contain space characters and is terminated by @samp{>} or by |
1172 the end of a line. In tables, the end of a table field also terminates | |
1173 a link. Angle brackets around a link are not required, but are | |
1174 recommended to avoid problems with punctuation and other text following | |
1175 the link. See also the variable @code{org-allow-space-in-links}. | |
58792 | 1176 |
1177 @cindex storing links | |
1178 @table @kbd | |
1179 @kindex C-c l | |
1180 @item C-c l | |
1181 Store a link to the current location. This is a @emph{global} command | |
1182 which can be used in any buffer to create a link. The link will be | |
1183 stored for later insertion into an Org-mode buffer (see below). For VM, | |
1184 RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the | |
1185 current article/entry. For W3 and W3M buffer, the link goes to the | |
1186 current URL. For any other files, the link will just point to the file. | |
1187 The key binding @kbd{C-c l} is only a suggestion - see | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1188 @ref{Installation and Activation}. |
58792 | 1189 |
1190 @kindex C-c C-l | |
63833 | 1191 @cindex completion, of links |
1192 @cindex completion, of file names | |
58792 | 1193 @item C-c C-l |
1194 Insert a link. This prompts for a link to be inserted into the | |
1195 buffer. You can just type a link, using one of the link type prefixes | |
1196 mentioned in the examples above. Through completion, all links stored | |
1197 during the current session can be accessed. When called with prefix | |
63362 | 1198 arg, you can use file name completion to enter a file link. The link |
1199 will be formatted as given in the variable @code{org-link-format} and | |
1200 inserted into the buffer. Note that you don't have to use this | |
1201 command to insert a link. Links in Org-mode are plain text, and you | |
1202 can type or paste them straight into the buffer. | |
58792 | 1203 |
1204 @cindex inserting links | |
1205 @kindex C-c C-o | |
1206 @item C-c C-o | |
1207 Open link at point. This will launch a web browser for URLs (using | |
1208 @command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding | |
1209 links, execute the command in a shell link, visit text files with | |
1210 Emacs and select a suitable application for non-text files. | |
1211 Classification of files is based on file extension only. See option | |
1212 @code{org-file-apps}. If there is no link at point, the current | |
1213 subtree will be searched for one. If you want to override the default | |
1214 application and visit the file with Emacs, use a @kbd{C-u} prefix. | |
1215 If the cursor is on a time stamp, compiles the agenda for that date. | |
1216 | |
1217 @strong{IMPORTANT}: Be careful not to use any dangerous commands in a | |
1218 shell link. | |
1219 | |
1220 @kindex mouse-2 | |
1221 @item mouse-2 | |
1222 On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would. | |
1223 | |
1224 @kindex mouse-3 | |
1225 @item mouse-3 | |
1226 Like @kbd{mouse-2}, but force file links to be opened with Emacs. | |
1227 @end table | |
1228 | |
1229 @node Remember, , Links, Hyperlinks | |
1230 @section Remember | |
1231 @cindex @file{remember.el} | |
1232 | |
1233 Another way to create org entries with links to other files is through | |
1234 the @emph{Remember} package by John Wiegley. @emph{Remember} lets you | |
1235 store quick notes with little interruption of your work flow. See | |
1236 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more | |
1237 information. The notes produced by @emph{Remember} can be stored in | |
64517 | 1238 different ways, and Org-mode files are a good target. Org-mode allows |
1239 to file away notes either to a default file, or directly to the | |
1240 correct location in your Org-mode outline tree. The following | |
1241 customization@footnote{The two autoload forms are only necessary if | |
1242 @file{org.el} is not part of the Emacs distribution or and XEmacs | |
1243 package.} will tell @emph{Remember} to use org files as target, and to | |
1244 create annotations compatible with Org-mode links. | |
1245 | |
58792 | 1246 @example |
1247 (autoload 'org-remember-annotation "org") | |
1248 (autoload 'org-remember-handler "org") | |
1249 (setq org-directory "~/path/to/my/orgfiles/") | |
1250 (setq org-default-notes-file "~/.notes") | |
1251 (setq remember-annotation-functions '(org-remember-annotation)) | |
1252 (setq remember-handler-functions '(org-remember-handler)) | |
1253 @end example | |
1254 | |
1255 When you compose a note with remember, you have to press @kbd{C-c C-c} | |
1256 to exit remember-mode and to file away the note. The handler first | |
1257 prompts for a target file - if you press @key{RET}, the value of | |
1258 @code{org-default-notes-file} is used. Then the command offers the | |
1259 headings tree of the selected file. You can either immediately press | |
1260 @key{RET} to get the note appended to the file. Or you can use | |
1261 vertical cursor motion (@key{up} and @key{down}) and visibility | |
1262 cycling (@key{TAB}) to find a better place. Pressing @key{RET} or | |
1263 @key{left} or @key{right} leads to the following result. | |
1264 | |
1265 @multitable @columnfractions 0.2 0.1 0.7 | |
1266 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} | |
1267 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file | |
1268 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor | |
1269 @item @tab @key{left} @tab as same level, before current heading | |
1270 @item @tab @key{right} @tab as same level, after current heading | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1271 @item not on headline @tab @key{RET} |
58792 | 1272 @tab at cursor position, level taken from context. |
1273 Or use prefix arg to specify level manually. | |
1274 @end multitable | |
1275 | |
63362 | 1276 So a fast way to store the note is to press @kbd{C-c C-c @key{RET} |
1277 @key{RET}} to append it to the default file. Even shorter would be | |
1278 @kbd{C-u C-c C-c}, which does the same without even showing the tree. | |
1279 But with little extra effort, you can push it directly to the correct | |
1280 location. | |
58792 | 1281 |
1282 Before inserting the text into a tree, the function ensures that the | |
1283 text has a headline, i.e. a first line that starts with a @samp{*}. | |
1284 If not, a headline is constructed from the current date and some | |
1285 additional data. If the variable @code{org-adapt-indentation} is | |
63833 | 1286 non-nil, the entire text is also indented so that it starts in the |
1287 same column as the headline (after the asterisks). | |
58792 | 1288 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1289 @node TODO items, Timestamps, Hyperlinks, Top |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1290 @chapter TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1291 @cindex TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1292 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1293 Org-mode does not maintain TODO lists as a separate document. TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1294 items are an integral part of the notes file, because TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1295 usually come up while taking notes! With Org-mode, you simply mark |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1296 any entry in a tree as being a TODO item. In this way, the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1297 information is not duplicated, and the entire context from which the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1298 item emerged is always present when you check. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1299 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1300 Of course, this technique causes TODO items to be scattered throughout |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1301 your file. Org-mode provides methods to give you an overview over all |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1302 things you have to do. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1303 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1304 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1305 * TODO basics:: Marking and displaying TODO entries |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1306 * TODO extensions:: Workflow and assignments |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1307 * Priorities:: Some things are more important than others |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1308 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1309 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1310 @node TODO basics, TODO extensions, TODO items, TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1311 @section Basic TODO functionality |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1312 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1313 Any headline can become a TODO item by starting it with the word TODO, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1314 for example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1315 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1316 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1317 *** TODO Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1318 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1319 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1320 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1321 The most important commands to work with TODO entries are: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1322 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1323 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1324 @kindex C-c C-t |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1325 @item C-c C-t |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1326 Rotate the TODO state of the current item between |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1327 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1328 ,-> (unmarked) -> TODO -> DONE --. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1329 '--------------------------------' |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1330 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1331 The same rotation can also be done ``remotely'' from the timeline and |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1332 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1333 @kindex C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1334 @cindex sparse tree, for TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1335 @item C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1336 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1337 the entire buffer, but shows all TODO items and the headings hierarchy |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1338 above them. With prefix arg, show also the DONE entries. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1339 @item C-u C-c a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1340 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1341 collects all unfinished TODO items into a single place. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1342 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1343 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1344 @node TODO extensions, Priorities, TODO basics, TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1345 @section Extended use of TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1346 @cindex extended TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1347 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1348 The default implementation of TODO entries is just two states: TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1349 and DONE. You can, however, use the TODO feature for more |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1350 complicated things by configuring the variables |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1351 @code{org-todo-keywords} and @code{org-todo-interpretation}. Using |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1352 special setup, you can even use TODO keywords in different ways in |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1353 different org files. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1354 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1355 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1356 * Workflow states:: From TODO to DONE in steps |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1357 * TODO types:: I do this, Fred the rest |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1358 * Per file keywords:: Different files, different requirements |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1359 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1360 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1361 @node Workflow states, TODO types, TODO extensions, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1362 @subsection TODO keywords as workflow states |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1363 @cindex TODO workflow |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1364 @cindex workflow states as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1365 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1366 You can use TODO keywords to indicate different states in the process |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1367 of working on an item, for example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1368 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1369 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1370 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1371 org-todo-interpretation 'sequence) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1372 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1373 |
63833 | 1374 @cindex completion, of TODO keywords |
65656 | 1375 Changing these variables becomes only effective in a new Emacs session. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1376 With this setup, the command @kbd{C-c C-t} will cycle an entry from |
65656 | 1377 TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1378 use a prefix argument to quickly select a specific state. For example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1379 @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1380 If you define many keywords, you can use in-buffer completion (see |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1381 @ref{Completion}) to insert these words into the buffer. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1382 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1383 @node TODO types, Per file keywords, Workflow states, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1384 @subsection TODO keywords as types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1385 @cindex TODO types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1386 @cindex names as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1387 @cindex types as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1388 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1389 The second possibility is to use TODO keywords to indicate different |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1390 types of action items. For example, you might want to indicate that |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1391 items are for ``work'' or ``home''. Or, when you work with several |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1392 people on a single project, you might want to assign action items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1393 directly to persons, by using their names as TODO keywords. This |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1394 would be set up like this: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1395 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1396 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1397 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1398 org-todo-interpretation 'type) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1399 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1400 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1401 In this case, different keywords do not indicate a sequence, but |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1402 rather different types. So it is normally not useful to change from |
63833 | 1403 one type to another. Therefore, in this case the behavior of the |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1404 command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
63833 | 1405 for the @kbd{t} command in the timeline and agenda buffers.}. When |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1406 used several times in succession, it will still cycle through all |
65656 | 1407 names. But when you return to the item after some time and |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1408 execute @kbd{C-c C-t} again, it will switch from each name directly to |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1409 DONE. Use prefix arguments or completion to quickly select a specific |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1410 name. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1411 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1412 @node Per file keywords, , TODO types, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1413 @subsection Setting up TODO keywords for individual files |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1414 @cindex keyword options |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1415 @cindex per file keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1416 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1417 It can be very useful to use different aspects of the TODO mechanism |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1418 in different files, which is not possible with the global settings |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1419 described above. For file-local settings, you need to add special |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1420 lines to the file which set the keywords and interpretation for that |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1421 file only. For example, to set one of the two examples discussed |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1422 above, you need one of the following lines, starting in column zero |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1423 anywhere in the file: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1424 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1425 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1426 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1427 #+TYP_TODO: Fred Sara Lucy Mike DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1428 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1429 |
63833 | 1430 @cindex Completion, of option keywords |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1431 @kindex M-@key{TAB} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1432 @noindent To make sure you are using the correct keyword, type |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1433 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1434 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1435 @cindex DONE, final TODO keyword |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1436 Remember that the last keyword must always mean that the item is DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1437 (you may use a different word, though). Also note that in each file, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1438 only one of the two aspects of TODO keywords can be used. After |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1439 changing one of these lines, use @kbd{C-c C-c} with the cursor still |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1440 in the line to make the changes known to Org-mode@footnote{Org-mode |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1441 parses these lines only when Org-mode is activated after visiting a |
65656 | 1442 file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+} |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1443 is simply restarting Org-mode, making sure that these changes will be |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1444 respected.}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1445 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1446 If you want to use very many keywords, for example when working with a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1447 large group of people, you may split the names over several lines: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1448 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1449 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1450 #+TYP_TODO: Fred Sara Lucy Mike |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1451 #+TYP_TODO: Luis George Jules Jessica |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1452 #+TYP_TODO: Kim Arnold Peter |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1453 #+TYP_TODO: DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1454 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1455 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1456 @node Priorities, , TODO extensions, TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1457 @section Priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1458 @cindex priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1459 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1460 If you use Org-mode extensively to organize your work, you may end up |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1461 with a number of TODO entries so large that you'd like to prioritize |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1462 them. This can be done by placing a @emph{priority cookie} into the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1463 headline, like this |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1464 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1465 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1466 *** TODO [#A] Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1467 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1468 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1469 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1470 With its standard setup, Org-mode supports priorities @samp{A}, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1471 @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1472 without a cookie is treated as priority @samp{B}. Priorities make a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1473 difference only in the agenda (@pxref{Agenda}). |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1474 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1475 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1476 @kindex @kbd{C-c ,} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1477 @item @kbd{C-c ,} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1478 Set the priority of the current item. The command prompts for a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1479 priority character @samp{A}, @samp{B} or @samp{C}. When you press |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1480 @key{SPC} instead, the priority cookie is removed from the headline. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1481 The priorities can also be changed ``remotely'' from the timeline and |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1482 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1483 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1484 @kindex S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1485 @kindex S-@key{down} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1486 @item S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1487 @itemx S-@key{down} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1488 Increase/decrease priority of current item. Note that these keys are |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1489 also used to modify time stamps (@pxref{Creating timestamps}). |
63833 | 1490 Furthermore, these keys are also used by CUA-mode |
63362 | 1491 (@pxref{Interaction}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1492 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1493 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1494 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1495 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1496 @node Timestamps, Timeline and Agenda, TODO items, Top |
58792 | 1497 @chapter Timestamps |
1498 | |
1499 Items can be labeled with timestamps to make them useful for project | |
1500 planning. | |
1501 | |
1502 @menu | |
1503 * Time stamps:: Assigning a time to a tree entry | |
1504 * Creating timestamps:: Commands which insert timestamps | |
1505 @end menu | |
1506 | |
1507 | |
1508 @node Time stamps, Creating timestamps, Timestamps, Timestamps | |
1509 @section Time stamps, deadlines and scheduling | |
1510 @cindex time stamps | |
1511 @cindex deadlines | |
1512 @cindex scheduling | |
1513 | |
1514 A time stamp is a specification of a date (possibly with time) in a | |
1515 special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 | |
1516 Tue 09:39>}. A time stamp can appear anywhere in the headline or body | |
1517 of an org-tree entry. Its presence allows to show entries on specific | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1518 dates in the agenda (@pxref{Agenda}). We distinguish: |
58792 | 1519 |
1520 @table @var | |
1521 @cindex timestamp | |
1522 @item TIMESTAMP | |
1523 A simple time stamp just assigns a date/time to an item. In the | |
1524 timeline and agenda displays, the headline of the entry will be shown | |
1525 exactly on that date. | |
1526 | |
1527 @item TIMERANGE | |
1528 @cindex timerange | |
1529 Two time stamps connected by @samp{--} denote a time range. The | |
1530 headline will be shown on the first and last day of the range, and on | |
1531 any dates that are displayed and fall in the range. Here is an | |
1532 example: | |
1533 | |
1534 @example | |
1535 ** Meeting in Amsterdam | |
1536 <2004-08-23 Mon>--<2004-08-26 Thu> | |
1537 @end example | |
1538 | |
1539 @item DEADLINE | |
63833 | 1540 @cindex DEADLINE keyword |
58792 | 1541 If a time stamp is preceded by the word @samp{DEADLINE:}, the task |
1542 (most likely a TODO item) is supposed to be finished on that date, and | |
63833 | 1543 it will be listed then. In addition, the compilation for @emph{today} |
1544 will carry a warning about the approaching or missed deadline, | |
1545 starting @code{org-deadline-warning-days} before the due date, and | |
1546 continuing until the entry is marked DONE. An example: | |
58792 | 1547 |
1548 @example | |
1549 *** TODO write article about the Earth for the Guide | |
63833 | 1550 The editor in charge is <bbdb:Ford Prefect> |
58792 | 1551 DEADLINE: <2004-02-29 Sun> |
1552 @end example | |
1553 | |
1554 @item SCHEDULED | |
65244 | 1555 @cindex SCHEDULED keyword |
58792 | 1556 If a time stamp is preceded by the word @samp{SCHEDULED:}, it means |
1557 you are planning to start working on that task on the given date. The | |
1558 headline will be listed under the given date. In addition, a reminder | |
1559 that the scheduled date has passed will be present in the compilation | |
64069 | 1560 for @emph{today}, until the entry is marked DONE. I.e., the |
58792 | 1561 task will automatically be forwarded. |
1562 @end table | |
1563 | |
1564 @node Creating timestamps, , Time stamps, Timestamps | |
1565 @section Creating timestamps | |
1566 @cindex creating timestamps | |
1567 | |
1568 For Org-mode to recognize time stamps, they need to be in the specific | |
1569 format. All commands listed below produce time stamps in the correct | |
1570 format. | |
1571 | |
1572 @table @kbd | |
1573 @kindex C-c . | |
1574 @item C-c . | |
1575 Prompt for a date and insert a corresponding time stamp. When the | |
1576 cursor is at a previously used time stamp, it is updated to NOW. When | |
1577 this command is used twice in succession, a time range is inserted. | |
1578 | |
1579 @kindex C-u C-c . | |
1580 @item C-u C-c . | |
1581 Like @kbd{C-c .}, but use the alternative format which contains date | |
1582 and time. | |
1583 | |
65656 | 1584 @kindex C-c ! |
1585 @item C-c ! | |
1586 Like @kbd{C-c .}, but insert an inactive time stamp not triggering the | |
1587 agenda. | |
1588 | |
58792 | 1589 @kindex C-c < |
1590 @item C-c < | |
1591 Insert a time stamp corresponding to the cursor date in the Calendar. | |
1592 | |
1593 @kindex C-c > | |
1594 @item C-c > | |
1595 Access the Emacs calendar for the current date. If there is a | |
1596 timestamp in the current line, goto the corresponding date | |
1597 instead. | |
1598 | |
1599 @kindex C-c C-o | |
1600 @item C-c C-o | |
1601 Access the agenda for the date given by the time stamp at point | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1602 (@pxref{Agenda}). |
58792 | 1603 |
1604 @kindex C-c C-d | |
1605 @item C-c C-d | |
1606 Insert @samp{DEADLINE} keyword along with a stamp. | |
1607 @kindex C-c C-w | |
1608 @cindex sparse tree, for deadlines | |
1609 @item C-c C-w | |
1610 Create a sparse tree with all deadlines that are either past-due, or | |
1611 which will become due within @code{org-deadline-warning-days}. | |
1612 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
1613 prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows | |
1614 all deadlines due tomorrow. | |
1615 | |
1616 @kindex C-c C-s | |
1617 @item C-c C-s | |
1618 Insert @samp{SCHEDULED} keyword along with a stamp. | |
1619 | |
1620 @kindex S-@key{left} | |
1621 @kindex S-@key{right} | |
1622 @item S-@key{left} | |
1623 @itemx S-@key{right} | |
63362 | 1624 Change date at cursor by one day. These key bindings conflict with |
1625 CUA-mode (@pxref{Interaction}). | |
58792 | 1626 |
1627 @kindex S-@key{up} | |
1628 @kindex S-@key{down} | |
1629 @item S-@key{up} | |
1630 @itemx S-@key{down} | |
1631 Change the item under the cursor in a timestamp. The cursor can be on | |
1632 a year, month, day, hour or minute. Note that if the cursor is not at | |
63362 | 1633 a time stamp, these same keys modify the priority of an item. |
63833 | 1634 (@pxref{Priorities}). The key bindings also conflict with CUA-mode |
63362 | 1635 (@pxref{Interaction}). |
1636 | |
58792 | 1637 |
1638 @kindex C-c C-y | |
1639 @cindex evaluate time range | |
1640 @item C-c C-y | |
1641 Evaluate a time range by computing the difference between start and | |
1642 end. With prefix arg, insert result after the time range (in a table: | |
1643 into the following column). | |
1644 @end table | |
1645 | |
1646 @cindex date, reading in minibuffer | |
1647 @cindex time, reading in minibuffer | |
1648 @cindex calendar, for selecting date | |
63833 | 1649 When Org-mode prompts for a date/time, the function reading your input |
1650 will replace anything you choose not to specify with the current date | |
1651 and time. For details, see the documentation string of | |
58792 | 1652 @command{org-read-date}. Also, a calender will pop up to allow |
1653 selecting a date. The calendar can be fully controlled from the | |
1654 minibuffer, and a date can be selected with the following commands: | |
1655 | |
1656 @table @kbd | |
1657 @kindex < | |
1658 @item < | |
1659 Scroll calendar backwards by one month. | |
1660 @kindex > | |
1661 @item > | |
1662 Scroll calendar forwards by one month. | |
1663 @kindex mouse-1 | |
1664 @item mouse-1 | |
1665 Select date by clicking on it. | |
1666 @kindex S-@key{right} | |
1667 @item S-@key{right} | |
1668 One day forward. | |
1669 @kindex S-@key{left} | |
1670 @item S-@key{left} | |
1671 One day back. | |
1672 @kindex S-@key{down} | |
1673 @item S-@key{down} | |
1674 One week forward. | |
1675 @kindex S-@key{up} | |
1676 @item S-@key{up} | |
1677 One week back. | |
1678 @kindex M-S-@key{right} | |
1679 @item M-S-@key{right} | |
1680 One month forward. | |
1681 @kindex M-S-@key{left} | |
1682 @item M-S-@key{left} | |
1683 One month back. | |
1684 @kindex @key{RET} | |
1685 @item @key{RET} | |
1686 Choose date in calendar (only if nothing typed into minibuffer). | |
1687 @end table | |
1688 | |
1689 @node Timeline and Agenda, Exporting, Timestamps, Top | |
1690 @chapter Timeline and Agenda | |
1691 @cindex agenda | |
1692 | |
1693 We have already described three commands to filter important | |
1694 information in an org file into a sparse tree (@pxref{Sparse trees}): | |
1695 | |
1696 @cindex sparse trees | |
1697 @itemize @bullet | |
1698 @item | |
1699 The TODO tree, (@kbd{C-c C-v}), see @ref{TODO items}. | |
1700 @item | |
1701 The occur tree @kbd{C-c /}, see @ref{TODO items}. | |
1702 @item | |
1703 Checking upcoming deadlines with @kbd{C-c C-w}, see @ref{Creating | |
1704 timestamps}. | |
1705 @end itemize | |
1706 @noindent | |
1707 | |
1708 Instead of using the sparse trees, Org-mode can also collect and | |
1709 time-sort the important items into a separate buffer, which we call | |
1710 the @emph{timeline} of the org file. It can also collect information | |
1711 from a @emph{list of files} and in this way provide an @emph{agenda} | |
1712 which covers all of your current projects, action items and | |
1713 appointments. | |
1714 | |
1715 @menu | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1716 * Timeline:: Time-sorted view for single file |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1717 * Agenda:: Your weekly planner |
58792 | 1718 * Agenda commands:: Remote editing of org trees |
1719 * Calendar/Diary integration:: Integrating Anniversaries and more | |
1720 @end menu | |
1721 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1722 @node Timeline, Agenda, Timeline and Agenda, Timeline and Agenda |
58792 | 1723 @section Timeline for a single file |
1724 @cindex single file summary | |
1725 @cindex agenda, for single file | |
1726 @cindex timeline, single file | |
1727 @cindex time-sorted view | |
1728 | |
1729 The timeline shows all time-stamped items in a single Org-mode file, | |
1730 in @emph{time-sorted view}. The main purpose of this command is to | |
1731 give an overview over events in a project. | |
1732 | |
1733 @table @kbd | |
1734 @kindex C-c C-r | |
1735 @item C-c C-r | |
1736 Show a time-sorted view of the org file, with all time-stamped items | |
1737 of today or later. When called with a @kbd{C-u} prefix, past dates | |
1738 will be included as well. When called with two @kbd{C-u C-u} | |
1739 prefixes, all unfinished TODO entries (scheduled or not) are also | |
1740 listed under the current date. | |
1741 @end table | |
1742 @noindent | |
1743 | |
1744 The timeline is shown in a temporary buffer @file{*Org Agenda*}. The | |
1745 commands available in the Agenda buffer are listed in @ref{Agenda | |
1746 commands}. | |
1747 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1748 @node Agenda, Agenda commands, Timeline, Timeline and Agenda |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1749 @section Agenda |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1750 @cindex agenda |
58792 | 1751 |
1752 An agenda can be compiled from one or more org files. The main | |
62548 | 1753 purpose of this command is to act like a paper agenda, showing you all |
1754 the tasks for the current day or week. | |
58792 | 1755 |
1756 The Org-mode files to be processed in order to generate the agenda are | |
1757 listed in the variable @code{org-agenda-files}. You can customize | |
1758 this variable, but the easiest way to maintain it is through the | |
1759 following commands | |
1760 | |
1761 @cindex files, adding to agenda list | |
1762 @table @kbd | |
1763 @kindex C-c [ | |
1764 @item C-c [ | |
1765 Add current file to the list of agenda files | |
1766 @kindex C-c ] | |
1767 @item C-c ] | |
1768 Remove current file from the list of agenda files. | |
1769 @end table | |
1770 @noindent | |
1771 The Org menu contains the list of all files and can be used to quickly | |
1772 visit any of them. | |
1773 | |
1774 The global command @command{org-agenda} compiles the agenda from all | |
1775 listed files. | |
1776 | |
1777 @table @kbd | |
1778 @cindex org-agenda, command | |
1779 @kindex C-c a | |
1780 @item C-c a | |
1781 Compile an agenda for the current week from a list of org files. The | |
1782 agenda shows the entries for each day. With a @kbd{C-u} prefix (or | |
1783 when the variable @code{org-agenda-include-all-todo} is @code{t}), all | |
1784 unfinished TODO items (also those without a date) are also listed at | |
1785 the beginning of the buffer, before the first date.@* | |
1786 The key binding @kbd{C-c a} is only a suggestion - see | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1787 @ref{Installation and Activation}. |
58792 | 1788 @end table |
1789 | |
1790 The commands available in the Agenda buffer are listed in | |
1791 @ref{Agenda commands}. | |
1792 | |
1793 @subsection Categories | |
1794 | |
1795 @cindex category | |
1796 In the agenda buffer, each entry is preceded by a @emph{category}, | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1797 which is derived from the file name. The category can also be set |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1798 with a special line anywhere in the buffer, looking like this: |
58792 | 1799 @example |
62548 | 1800 #+CATEGORY: Thesis |
58792 | 1801 @end example |
1802 @noindent | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1803 After changing this line, press @kbd{C-c C-c} with the cursor still in |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1804 the line, to make the changes known to org-mode. Otherwise, the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1805 change will only be active the next time you visit this file with |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1806 Emacs. |
58792 | 1807 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1808 The display in the agenda buffer looks best if the category is not |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1809 longer than 10 characters. |
58792 | 1810 |
63833 | 1811 @subsection Time-of-Day Specifications |
62548 | 1812 |
64069 | 1813 Org-mode checks each agenda item for a time-of-day specification. The |
63833 | 1814 time can be part of the time stamp that triggered inclusion into the |
1815 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time | |
1816 ranges can be specified with two time stamps, like | |
62548 | 1817 @c |
1818 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
1819 | |
1820 In the headline of the entry itself, a time(range) may also appear as | |
1821 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda | |
1822 integrates the Emacs diary (@pxref{Calendar/Diary integration}), time | |
1823 specifications in diary entries are recognized as well. | |
1824 | |
1825 For agenda display, Org-mode extracts the time and displays it in a | |
1826 standard 24 hour format as part of the prefix. The example times in | |
1827 the previous paragraphs would end up in the agenda like this: | |
1828 | |
1829 @example | |
1830 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
1831 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
1832 19:00...... The Vogon reads his poem | |
1833 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
1834 @end example | |
1835 | |
1836 If the agenda is in single-day mode, or for the display of today, the | |
1837 timed entries are embedded in a time grid, like | |
1838 | |
1839 @example | |
1840 8:00...... ------------------ | |
1841 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
1842 10:00...... ------------------ | |
1843 12:00...... ------------------ | |
1844 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
1845 14:00...... ------------------ | |
1846 16:00...... ------------------ | |
1847 18:00...... ------------------ | |
1848 19:00...... The Vogon reads his poem | |
1849 20:00...... ------------------ | |
1850 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
1851 @end example | |
1852 | |
1853 The time grid can be turned on and off with the variable | |
1854 @code{org-agenda-use-time-grid}, and can be configured with | |
1855 @code{org-agenda-time-grid}. | |
1856 | |
1857 | |
58792 | 1858 @subsection Sorting of agenda items |
1859 @cindex sorting, of agenda items | |
1860 @cindex priorities, of agenda items | |
1861 The entries for each day are sorted. The default order is to first | |
1862 collect all items containing an explicit time-of-day specification. | |
1863 These entries will be shown at the beginning of the list, as a | |
1864 @emph{schedule} for the day. After that, items remain grouped in | |
1865 categories, in the sequence given by @code{org-agenda-files}. Within | |
1866 each category, items are sorted by priority (@pxref{Priorities}). | |
1867 | |
1868 The priority is a numerical quantity composed of the base priority | |
1869 (2000 for priority @samp{A}, 1000 for @samp{B}, and 0 for @samp{C}), | |
1870 plus additional increments for overdue scheduled or deadline items. | |
1871 | |
1872 Sorting can be customized using the variable | |
1873 @code{org-agenda-sorting-strategy}. | |
1874 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1875 @node Agenda commands, Calendar/Diary integration, Agenda, Timeline and Agenda |
58792 | 1876 @section Commands in the agenda buffer |
1877 | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1878 Entries in the agenda buffer are linked back to the org file or diary |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1879 file where they originate. You are not allowed to edit the agenda |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1880 buffer itself, but commands are provided to show and jump to the |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1881 original entry location, and to edit the org-files ``remotely'' from |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1882 the agenda buffer. In this way, all information is stored only once, |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1883 and you don't risk that your agenda and note files diverge. |
58792 | 1884 |
1885 Some commands can be executed with mouse clicks on agenda lines. For | |
1886 the other commands, the cursor needs to be in the desired line. Most | |
1887 commands are available for both timelines and the agenda. The | |
1888 exceptions are marked. | |
1889 | |
1890 @table @kbd | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1891 @tsubheading{Motion} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1892 @kindex n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1893 @item n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1894 Next line (same as @key{up}). |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1895 @kindex p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1896 @item p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1897 Previous line (same as @key{down}). |
58792 | 1898 @tsubheading{View/GoTo org file} |
1899 @kindex mouse-3 | |
1900 @kindex @key{SPC} | |
1901 @item mouse-3 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1902 @itemx @key{SPC} |
58792 | 1903 Display the original location of the item in another window. |
1904 | |
1905 @kindex l | |
1906 @item l | |
1907 Display original location and recenter that window. | |
1908 | |
1909 @kindex mouse-2 | |
1910 @kindex @key{TAB} | |
1911 @item mouse-2 | |
1912 @itemx @key{TAB} | |
1913 Go to the original location of the item in another window. | |
1914 | |
1915 @kindex @key{RET} | |
1916 @itemx @key{RET} | |
1917 Go to the original location of the item and delete other windows. | |
1918 | |
1919 @kindex f | |
1920 @item f | |
1921 Toggle follow mode. In follow mode, as you move the cursor through | |
1922 the agenda buffer, the other window always shows the corresponding | |
1923 location in the org file. | |
1924 | |
1925 @tsubheading{Change display} | |
1926 @kindex o | |
1927 @item o | |
1928 Delete other windows. | |
1929 | |
1930 @kindex w | |
1931 @item w | |
63833 | 1932 Switch to weekly view (7 days displayed together) |
58792 | 1933 |
1934 @kindex d | |
1935 @item d | |
63833 | 1936 Switch to daily view (just one day displayed) |
1937 | |
1938 @kindex D | |
1939 @item D | |
58792 | 1940 Toggle the inclusion of diary entries. See @ref{Calendar/Diary integration}. |
1941 | |
62548 | 1942 @kindex g |
1943 @item g | |
1944 Toggle the time grid on and off. See also the variables | |
1945 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
1946 | |
58792 | 1947 @kindex r |
1948 @item r | |
1949 Recreate the agenda buffer, for example to reflect the changes | |
1950 after modification of the time stamps of items with S-@key{left} and | |
1951 S-@key{right}. | |
1952 | |
1953 @kindex @key{right} | |
1954 @item @key{right} | |
1955 Display the following @code{org-agenda-ndays} days. For example, if | |
1956 the display covers a week, switch to the following week. With prefix | |
1957 arg, go forward that many times @code{org-agenda-ndays} days. Not | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1958 available in timelines. |
58792 | 1959 |
1960 @kindex @key{left} | |
1961 @item @key{left} | |
1962 Display the previous dates. Not available in timelines. | |
1963 | |
1964 @kindex . | |
1965 @item . | |
1966 Goto today. | |
1967 | |
1968 @tsubheading{Remote editing} | |
1969 | |
1970 @item 0-9 | |
1971 Digit argument. | |
1972 | |
1973 @kindex t | |
1974 @item t | |
1975 Change the TODO state of the item, both in the agenda and in the | |
1976 original org file. | |
1977 | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1978 @kindex , |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1979 @item , |
58792 | 1980 Set the priority for the current item. Org-mode prompts for the |
1981 priority character. If you reply with @key{SPC}, the priority cookie | |
1982 is removed from the entry. | |
1983 | |
1984 @kindex P | |
1985 @item p | |
1986 Display weighted priority of current item. | |
1987 | |
1988 @kindex + | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1989 @kindex S-@key{up} |
58792 | 1990 @item + |
63833 | 1991 @itemx S-@key{up} |
58792 | 1992 Increase the priority of the current item. The priority is changed in |
1993 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
1994 key for this. | |
1995 | |
1996 @kindex - | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
1997 @kindex S-@key{down} |
58792 | 1998 @item - |
63833 | 1999 @itemx S-@key{down} |
58792 | 2000 Decrease the priority of the current item. |
2001 | |
2002 @kindex S-@key{right} | |
2003 @item S-@key{right} | |
2004 Change the time stamp associated with the current line by one day into | |
2005 the future. With prefix argument, change it by that many days. For | |
2006 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The | |
2007 stamp is changed in the original org file, but the change is not | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2008 directly reflected in the agenda buffer. Use the |
58792 | 2009 @kbd{r} key to update the buffer. |
2010 | |
2011 @kindex S-@key{left} | |
2012 @item S-@key{left} | |
2013 Change the time stamp associated with the current line by one day | |
2014 into the past. | |
2015 | |
2016 @kindex > | |
2017 @item > | |
2018 Change the time stamp associated with the current line to today. | |
2019 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
2020 on my keyboard. | |
2021 | |
2022 @cindex diary entries, creating from agenda | |
2023 @kindex i | |
2024 @item i | |
2025 Insert a new entry into the diary. Prompts for the type of entry | |
2026 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | |
2027 entry in the diary, just like @kbd{i d} etc. would do in the calendar. | |
2028 The date is taken from the cursor position. | |
2029 | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2030 @tsubheading{Calendar commands} |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2031 @kindex c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2032 @item c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2033 Open the Emacs calendar and move to the date at the agenda cursor. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2034 |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2035 @item c |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2036 When in the calendar, compute and show the Org-mode agenda for the |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2037 date at the cursor. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2038 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2039 @kindex M |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2040 @item M |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2041 Show the phases of the moon for three month around current date. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2042 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2043 @kindex S |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2044 @item S |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2045 Show sunrise and sunset times. The geographical location must be set |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2046 with calendar variables, see documentation of the Emacs calendar. |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2047 |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2048 @kindex C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2049 @item C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2050 Convert the date at cursor into many other cultural and historic |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2051 calendars. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2052 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2053 @kindex H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2054 @item H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2055 Show holidays for three month around the cursor date. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2056 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2057 @kindex C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2058 @item C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2059 Export a single iCalendar file containing entries from all agenda files. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2060 Not available in timelines. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2061 |
58792 | 2062 @tsubheading{Quit and Exit} |
2063 @kindex q | |
2064 @item q | |
2065 Quit Agenda, remove the agenda buffer. | |
2066 | |
2067 @kindex x | |
2068 @cindex agenda files, removing buffers | |
2069 @item x | |
2070 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
2071 for the compilation of the agenda. Buffers created by the user to | |
2072 visit org files will not be removed. | |
2073 | |
2074 @end table | |
2075 | |
2076 @node Calendar/Diary integration, , Agenda commands, Timeline and Agenda | |
2077 @section Calendar/Diary integration | |
2078 @cindex calendar integration | |
2079 @cindex diary integration | |
2080 | |
2081 Emacs contains the calendar and diary by Edward M. Reingold. The | |
2082 calendar displays a three-month calendar with holidays from different | |
2083 countries and cultures. The diary allows to keep track of | |
2084 anniversaries, lunar phases, sunrise/set, recurrent appointments | |
2085 (weekly, monthly) and more. In this way, it is quite complementary to | |
2086 Org-mode. It can be very useful to combine output from Org-mode with | |
2087 the diary. | |
2088 | |
2089 The interaction between Org-mode and diary works both ways: You can | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2090 list entries from the diary in the Org-mode agenda, from which many |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2091 calendar and diary commands are directly accessible. Or you can |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2092 display entries from the org agenda in the Emacs diary. |
58792 | 2093 |
2094 @menu | |
2095 * Diary to agenda:: Agenda incorporates the diary | |
2096 * Agenda to diary:: Diary incorporates the agenda | |
2097 @end menu | |
2098 | |
2099 @node Diary to agenda, Agenda to diary, Calendar/Diary integration, Calendar/Diary integration | |
2100 @subsection Including the diary into the agenda | |
2101 @cindex diary to agenda | |
2102 | |
2103 In order to include entries from the Emacs diary into Org-mode's | |
2104 agenda, you only need to customize the variable | |
2105 | |
2106 @lisp | |
2107 (setq org-agenda-include-diary t) | |
2108 @end lisp | |
2109 @noindent | |
2110 | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2111 @noindent After that, everything will happen automatically. All diary |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2112 entries including holidays, anniversaries etc will be included in the |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2113 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
2114 @key{RET} can be used from the agenda buffer to jump to the diary |
63833 | 2115 file, in order to edit existing diary entries. The @kbd{i} command to |
2116 insert new entries for the current date works in the agenda buffer, as | |
2117 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
2118 Sunrise/Sunset times, show lunar phases and to convert to other | |
2119 calendars, respectively. @kbd{c} can be used to switch back and forth | |
2120 between calendar and agenda. | |
58792 | 2121 |
2122 @node Agenda to diary, , Diary to agenda, Calendar/Diary integration | |
2123 @subsection Including the agenda into the diary | |
2124 | |
2125 If you prefer to use the Emacs diary as your main instrument and if | |
2126 you wish to include the Org-mode agenda into it, the following steps | |
2127 are necessary: Autoload the function @command{org-diary} as shown | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2128 above under @ref{Installation and Activation}. You also need to use |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2129 @emph{fancy diary display} by setting in @file{.emacs}: |
58792 | 2130 |
2131 @lisp | |
2132 (add-hook 'diary-display-hook 'fancy-diary-display) | |
2133 @end lisp | |
2134 | |
2135 Then include the following line into your @file{~/diary} file, in | |
2136 order to get the entries from all files listed in the variable | |
2137 @code{org-agenda-files}: | |
2138 | |
2139 @example | |
2140 &%%(org-diary) | |
2141 @end example | |
2142 @noindent | |
2143 You may also select specific files with | |
2144 | |
2145 @example | |
2146 &%%(org-diary) ~/path/to/some/org-file.org | |
2147 &%%(org-diary) ~/path/to/another/org-file.org | |
2148 @end example | |
2149 | |
2150 If you now launch the calendar and press @kbd{d} to display a diary, | |
2151 the headlines of entries containing a timestamp, date range, schedule, | |
2152 or deadline referring to the selected date will be listed. Just like | |
2153 in Org-mode's agenda view, the diary for @emph{today} contains | |
2154 additional entries for overdue deadlines and scheduled items. See | |
2155 also the documentation of the @command{org-diary} function. | |
2156 | |
2157 @node Exporting, Miscellaneous, Timeline and Agenda, Top | |
2158 @chapter Exporting | |
2159 @cindex exporting | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2160 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2161 For printing and sharing of notes, Org-mode documents can be exported |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2162 as ASCII or HTML files. To incorporate entries with associated times |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2163 like deadlines or appointments into a desktop calendar program like |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2164 iCal, Org-mode can also produce extracts in the iCalendar format. |
58792 | 2165 |
2166 @menu | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2167 * ASCII export:: Export as a structured ASCII file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2168 * HTML export:: Export as an HTML file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2169 * iCalendar export:: Create calendar entries. |
58792 | 2170 @end menu |
2171 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2172 @node ASCII export, HTML export, Exporting, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2173 @section ASCII export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2174 @cindex ASCII export |
58792 | 2175 |
2176 @cindex region, active | |
2177 @cindex active region | |
2178 @cindex transient-mark-mode | |
2179 @table @kbd | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2180 @kindex C-c C-x a |
58792 | 2181 @item C-c C-x a |
2182 Export as ASCII file. If there is an active region, only the region | |
2183 will be exported. For an org file @file{myfile.org}, the ASCII file | |
2184 will be @file{myfile.txt}. The file will be overwritten without | |
2185 warning. | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2186 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2187 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2188 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2189 In the exported version, the first 3 outline levels will become |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2190 headlines, defining a general document structure. Additional levels |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2191 will be exported as itemize lists. If you want that transition to occur |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2192 at a different level, specify it with a prefix argument. For example, |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2193 @example |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2194 @kbd{C-1 C-c C-x a org-export-as-ascii} |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2195 @end example |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2196 @noindent |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2197 creates only top level headlines and does the rest as items. Lines |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2198 starting with @samp{#} and subtree starting with the word @samp{COMMENT} |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2199 will not be exported. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2200 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2201 @node HTML export, iCalendar export, ASCII export, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2202 @section HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2203 @cindex HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2204 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2205 Org-mode contains an HTML exporter with extensive HTML formatting. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2206 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2207 @cindex region, active |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2208 @cindex active region |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2209 @cindex transient-mark-mode |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2210 @table @kbd |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2211 @kindex C-c C-x h |
58792 | 2212 @item C-c C-x h |
2213 Export as HTML file @file{myfile.html}. | |
65656 | 2214 @kindex C-c C-x b |
2215 @item C-c C-x b | |
58792 | 2216 Export as HTML file and open it with a browser. |
2217 @kindex C-c C-x t | |
2218 @item C-c C-x t | |
2219 Insert template with export options, see below. | |
2220 @kindex C-c : | |
2221 @item C-c : | |
65656 | 2222 Toggle fixed-width for entry (QUOTE) or region, see below. |
58792 | 2223 @end table |
2224 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2225 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2226 In the exported version, the first 3 outline levels will become |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2227 headlines, defining a general document structure. Additional levels |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2228 will be exported as itemize lists. If you want that transition to occur |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2229 at a different level, specify it with a prefix argument. For example, |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2230 @example |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2231 @kbd{C-2 C-c C-x b} |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2232 @end example |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2233 @noindent |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2234 creates two levels of headings and does the rest as items. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2235 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2236 @menu |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2237 * HTML formatting:: Interpretation of the buffer content |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2238 * Export options:: How to influence exports |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2239 * Comment lines:: Lines which will not be exported |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2240 @end menu |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2241 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2242 @node HTML formatting, Export options, HTML export, HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2243 @subsection HTML formatting |
58792 | 2244 |
2245 Not all text is transferred literally to the exported HTML file. The | |
2246 exporter implements the following interpretation: | |
2247 | |
2248 @itemize @bullet | |
2249 @cindex underlined text | |
2250 @cindex bold text | |
2251 @cindex italic text | |
2252 @item | |
2253 You can make words @b{*bold*}, @i{/italic/}, and _underlined_ | |
2254 | |
2255 @cindex @TeX{} interpretation | |
2256 @item | |
2257 Simple @TeX{}-like math constructs are interpreted: | |
2258 | |
63833 | 2259 @cindex completion, of @TeX{} symbols |
58792 | 2260 @itemize @minus |
2261 @item | |
2262 @samp{10^22} and @samp{J_n} are super- and subscripts. You can quote | |
2263 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^} | |
2264 @item | |
2265 @samp{\alpha} indicates a Greek letter, @samp{\to} an arrow. You can | |
2266 use completion for these macros, just type @samp{\} and maybe a few | |
2267 letters, and press @kbd{M-@key{TAB}} to see possible completions. | |
2268 @end itemize | |
2269 | |
2270 @cindex tables, export to HTML | |
2271 @item | |
63362 | 2272 Tables are transformed into HTML tables. Data fields before the first |
2273 horizontal separator line will be formatted as table header fields. | |
58792 | 2274 |
2275 @cindex fixed width | |
2276 @item | |
65244 | 2277 If a headline starts with the word @samp{QUOTE}, the text below the |
2278 headline will be typeset as fixed-width, to allow quoting of computer | |
2279 codes etc. Lines starting with @samp{:} are also typeset in | |
2280 fixed-width font. | |
58792 | 2281 |
2282 @cindex HTML tags | |
2283 @item | |
2284 If you want to include HTML tags which should be interpreted as such, | |
2285 mark them with a @samp{@@} like in @samp{@@<b>bold text@@</b>}. | |
2286 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
2287 @samp{>} in HTML export. | |
2288 @end itemize | |
2289 | |
2290 If these conversions conflict with your habits of typing ASCII text, | |
2291 they can all be turned off with corresponding variables. | |
2292 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2293 @node Export options, Comment lines, HTML formatting, HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2294 @subsection Export options |
58792 | 2295 @cindex options, for export |
2296 | |
63833 | 2297 @cindex completion, of option keywords |
58792 | 2298 The exporter recognizes special lines in the buffer which provide |
2299 additional information. These lines may be put anywhere in the file. | |
2300 The whole set of lines can be inserted into the buffer with @kbd{C-c | |
2301 C-x t}. For individual lines, a good way to make sure the keyword is | |
65656 | 2302 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2303 (@pxref{Completion}). |
58792 | 2304 |
2305 @example | |
2306 #+TITLE: the title to be shown (default is the buffer name) | |
2307 #+AUTHOR: the author (default taken from @code{user-full-name}) | |
2308 #+EMAIL: his/her email address (default from @code{user-mail-address}) | |
2309 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) | |
2310 #+TEXT: Some descriptive text to be inserted at the beginning. | |
2311 #+TEXT: Several lines may be given. | |
2312 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t | |
2313 @end example | |
2314 @noindent | |
2315 The OPTIONS line is a compact form to specify export settings. Here | |
2316 you can | |
2317 @cindex headline levels | |
2318 @cindex section-numbers | |
2319 @cindex table of contents | |
63833 | 2320 @cindex linebreak preservation |
58792 | 2321 @cindex quoted html tags |
2322 @cindex fixed-width sections | |
2323 @cindex tables | |
2324 @cindex @TeX{}-like syntax for sub- and superscripts | |
2325 @cindex emphasized text | |
2326 @cindex @TeX{} macros | |
2327 @example | |
2328 H: @r{set the number of headline levels for export} | |
2329 num: @r{turn on/off section-numbers} | |
2330 toc: @r{turn on/off table of contents} | |
2331 \n: @r{turn on/off linebreak-preservation} | |
2332 @@: @r{turn on/off quoted html tags} | |
2333 :: @r{turn on/off fixed-width sections} | |
2334 |: @r{turn on/off tables} | |
2335 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.} | |
2336 *: @r{turn on/off emphasized text (bold, italic, underlined)} | |
2337 TeX: @r{turn on/off @TeX{} macros} | |
2338 @end example | |
2339 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2340 @node Comment lines, , Export options, HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2341 @subsection Comment lines |
58792 | 2342 @cindex comment lines |
2343 @cindex exporting, not | |
2344 | |
2345 Lines starting with @samp{#} in column zero are treated as comments | |
2346 and will never be exported. Also entire subtrees starting with the | |
2347 word @samp{COMMENT} will never be exported. Finally, any text before | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2348 the first headline will not be exported either. This applies also for |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2349 ASCII export. |
58792 | 2350 |
2351 @table @kbd | |
2352 @kindex C-c ; | |
2353 @item C-c ; | |
2354 Toggle the COMMENT keyword at the beginning of an entry. | |
2355 @end table | |
2356 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2357 @node iCalendar export, , HTML export, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2358 @section iCalendar export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2359 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2360 Some people like to use Org-mode for keeping track of projects, but |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2361 still prefer a standard calendar application for anniversaries and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2362 appointments. In this case it can be useful to have deadlines and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2363 other time-stamped items in Org-mode files show up in the calendar |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2364 application. Org-mode can export calendar information in the standard |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2365 iCalendar format. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2366 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2367 @table @kbd |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2368 @kindex C-c C-x i |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2369 @item C-c C-x i |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2370 Create iCalendar entries for the current file and store them in the same |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2371 directory, using a file extension @file{.ics}. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2372 @kindex C-c C-x C-i |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2373 @item C-c C-x C-i |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2374 Like @kbd{C-c C-x i}, but do this for all files in |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2375 @code{org-agenda-files}. For each of these files, a separate iCalendar |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2376 file will be written. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2377 @kindex C-c C-x c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2378 @item C-c C-x c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2379 Create a single large iCalendar file from all files in |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2380 @code{org-agenda-files} and write it to the file given by |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2381 @code{org-combined-agenda-icalendar-file}. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2382 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2383 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2384 How this calendar is best read and updated, depends on the on the |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2385 application you are using. For example, when using iCal under Apple |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2386 MacOS X, you could create a new calendar @samp{OrgMode} (the default |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2387 name for the calendar created by @kbd{C-c C-x c}, see the variables |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2388 @code{org-icalendar-combined-name} and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2389 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2390 overwrite the corresponding file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2391 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2392 to make iCal re-read the calendar files each time a new version of |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2393 @file{OrgMode.ics} is produced. Here is the setup needed for this: |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2394 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2395 @lisp |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2396 (setq org-combined-agenda-icalendar-file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2397 "~/Library/Calendars/OrgMode.ics") |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2398 (add-hook 'org-after-save-iCalendar-file-hook |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2399 (lambda () |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2400 (shell-command |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2401 "osascript -e 'tell application \"iCal\" to reload calendars'"))) |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2402 @end lisp |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
2403 |
58792 | 2404 @node Miscellaneous, Index, Exporting, Top |
2405 @chapter Miscellaneous | |
2406 | |
2407 @menu | |
2408 * Completion:: M-TAB knows what you need | |
2409 * Customization:: Adapting Org-mode to your taste | |
62548 | 2410 * FAQ:: Frequently asked questions |
58792 | 2411 * Interaction:: Other Emacs packages |
65656 | 2412 * TTY keys:: Using Org-mode on a tty |
63362 | 2413 * Bugs:: Things which do not work perfectly |
58792 | 2414 * Acknowledgments:: These people provided feedback and more |
2415 @end menu | |
2416 | |
2417 @node Completion, Customization, Miscellaneous, Miscellaneous | |
2418 @section Completion | |
63833 | 2419 @cindex completion, of @TeX{} symbols |
2420 @cindex completion, of TODO keywords | |
2421 @cindex completion, of dictionary words | |
2422 @cindex completion, of option keywords | |
58792 | 2423 |
2424 Org-mode supports in-buffer completion. This type of completion does | |
2425 not make use of the minibuffer. You simply type a few letters into | |
2426 the buffer and use the key to complete text right there. | |
2427 | |
2428 @table @kbd | |
2429 @kindex M-@key{TAB} | |
2430 @item M-@key{TAB} | |
2431 Complete word at point | |
2432 @itemize @bullet | |
2433 @item | |
2434 At the beginning of a headline, complete TODO keywords. | |
2435 @item | |
2436 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
2437 @item | |
2438 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |
2439 @samp{OPTIONS} which set file-specific options for Org-mode. When the | |
2440 option keyword is already complete, pressing @kbd{M-@key{TAB}} again | |
2441 will insert example settings for this keyword. | |
2442 @item | |
2443 Elsewhere, complete dictionary words using ispell. | |
2444 @end itemize | |
2445 @end table | |
2446 | |
62548 | 2447 @node Customization, FAQ, Completion, Miscellaneous |
58792 | 2448 @section Customization |
2449 @cindex customization | |
2450 @cindex options, for customization | |
2451 @cindex variables, for customization | |
2452 | |
2453 There is a large number of variables which can be used to customize | |
2454 Org-mode. For the sake of compactness of the manual, we are not | |
2455 describing the variables here. For an overview of customization | |
2456 variables, use @kbd{M-x org-customize}. Or select @code{Browse Org | |
2457 Group} from the @code{Org->Customization} menu. | |
2458 | |
62548 | 2459 @node FAQ, Interaction, Customization, Miscellaneous |
2460 @section Frequently asked questions | |
58792 | 2461 |
62548 | 2462 @enumerate |
64069 | 2463 @item @b{Org-mode seems to be a useful default mode for the various |
62548 | 2464 @file{README} files I have scattered through my directories. How do I |
2465 turn it on for all @file{README} files?} | |
58792 | 2466 @example |
2467 (add-to-list 'auto-mode-alist '("README$" . org-mode)) | |
2468 @end example | |
2469 | |
62548 | 2470 @item @b{I would like to have two windows on the same Org-mode |
2471 file, but with different outline visibility. Is that possible?}@* | |
58792 | 2472 @cindex @code{make-indirect-buffer} |
2473 @cindex indirect buffers | |
62548 | 2474 In GNU Emacs, you may use @emph{indirect buffers} which do exactly |
2475 this. See the documentation on the command | |
2476 @code{make-indirect-buffer}. In XEmacs, this is currently not | |
63362 | 2477 possible because of the different outline implementation. |
58792 | 2478 |
62548 | 2479 @item @b{Is there an easy way to insert links to web locations?}@* |
58792 | 2480 @cindex URL, paste into buffer |
63833 | 2481 Sure, just type or paste them into the buffer. A plain-text URL-like |
2482 string is directly interpreted as a link. | |
58792 | 2483 |
62548 | 2484 @item @b{When I export my TODO list, every TODO item becomes a |
2485 separate section. How do I enforce these items to be exported as an | |
2486 itemized list?}@* | |
58792 | 2487 If you plan to use ASCII or HTML export, make sure things you want to |
2488 be exported as item lists are level 4 at least, even if that does mean | |
2489 there is a level jump. For example | |
2490 | |
2491 @example | |
2492 * Todays top priorities | |
2493 **** TODO write a letter to xyz | |
2494 **** TODO Finish the paper | |
2495 **** Pick up kids at the school | |
2496 @end example | |
2497 | |
2498 Alternatively, if you need a specific value for the heading/item | |
2499 transition in a particular file, use the @samp{+OPTIONS} line to | |
2500 configure the @samp{H} switch. | |
2501 | |
2502 @example | |
2503 +OPTIONS: H:2; ... | |
2504 @end example | |
2505 | |
62548 | 2506 @item @b{I would like to export only a subtree of my file to HTML. How?}@* |
58792 | 2507 @cindex exporting a subtree |
2508 If you want to export a subtree, mark the subtree as region and then | |
2509 export. Marking can be done with @kbd{C-c @@ C-x C-x}, for example. | |
2510 | |
63362 | 2511 @item @b{Org-mode takes over the S-cursor keys. I also want to use |
2512 CUA-mode, is there a way to fix this conflict?}@* | |
2513 Yes, see @ref{Interaction} | |
2514 | |
62548 | 2515 @item @b{Is there an easy way to insert an empty table template with a |
2516 default number of rows and columns?}@* | |
58792 | 2517 @cindex table, empty template |
2518 To insert an empty table template, just type @samp{|-} and use | |
62548 | 2519 @key{TAB}. The default size can be changed with the variable |
63362 | 2520 @code{org-table-default-size}. However, just starting to type the |
2521 first line is usually much easier. | |
58792 | 2522 |
63833 | 2523 @item @b{One of my table columns has started to fill up with |
2524 @samp{#ERROR}. What is going on?}@* | |
2525 Org-mode tried to compute the column from other fields using a | |
2526 formula stored in the @samp{#+TBLFMT:} line just below the table, and | |
2527 the evaluation of the formula fails. Fix the fields used in the | |
2528 formula, or fix the formula, or remove it! | |
2529 | |
62548 | 2530 @item @b{When I am in the last column of a table and just above a |
2531 horizontal line in the table, pressing TAB creates a new table line | |
2532 @i{before} the horizontal line. How can I quickly move to the line | |
2533 @i{below} the horizontal line instead?}@* | |
2534 Press @key{down} (to get on the separator line) and then @key{TAB}. | |
58792 | 2535 |
62548 | 2536 @item @b{How can I change the indentation of an entire table without |
2537 fixing every line by hand?}@* | |
58792 | 2538 @cindex indentation, of tables |
62548 | 2539 The indentation of a table is set by the first line. So just fix the |
2540 indentation of the first line and realign with @key{TAB}. | |
58792 | 2541 |
62548 | 2542 @end enumerate |
58792 | 2543 |
2544 | |
65656 | 2545 @node Interaction, TTY keys, FAQ, Miscellaneous |
58792 | 2546 @section Interaction with other packages |
2547 @cindex packages, interaction with other | |
63833 | 2548 Org-mode can cooperate with the following packages: |
58792 | 2549 |
2550 @table @asis | |
2551 @cindex @file{table.el} | |
2552 @item @file{table.el} by Takaaki Ota | |
2553 Org mode cooperates with table.el, see @ref{table.el}. | |
63833 | 2554 @cindex @file{calc.el} |
2555 @item @file{calc.el} by Dave Gillespie | |
2556 Org-mode uses the calc package for implementing spreadsheet | |
2557 functionality in its tables (@pxref{Table calculations}). Org-modes | |
2558 checks for the availability of calc by looking for the function | |
2559 @code{calc-eval} which should be autoloaded in your setup if calc has | |
2560 been installed properly. As of Emacs 22, calc is part of the Emacs | |
2561 distribution. Another possibility for interaction between the two | |
2562 packages is using calc for embedded calculations. @xref{Embedded Mode, | |
64517 | 2563 , Embedded Mode, calc, GNU Emacs Calc Manual}. |
63833 | 2564 @cindex @file{constants.el} |
2565 @item @file{constants.el} by Carsten Dominik | |
2566 In a table formula (@pxref{Table calculations}), it is possible to use | |
2567 names for natural constants or units. Instead of defining you own | |
2568 constants in the variable @code{org-table-formula-constants}, install | |
2569 the @file{constants} package which defines a large number of constants | |
2570 and units, and lets you use unit prefixes like @samp{M} for | |
2571 @samp{Mega} etc. You will need version 2.0 of this package, available | |
2572 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for | |
2573 the function @code{constants-get}, which has to be autoloaded in your | |
2574 setup. See the installation instructions in the file | |
2575 @file{constants.el}. | |
2576 @cindex @file{remember.el} | |
63362 | 2577 @cindex @file{CUA.el} |
2578 @item @file{CUA.el} by Kim. F. Storm | |
2579 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys | |
2580 used by CUA-mode (as well as pc-select-mode and s-region-mode) to | |
2581 select and extend the region. If you want to use one of these | |
2582 packages along with Org-mode, configure the variable | |
63833 | 2583 @code{org-CUA-compatible}. When set, Org-mode will move the following |
63362 | 2584 keybindings in org-mode files, and in the agenda buffer (but not |
2585 during date selection). | |
2586 @example | |
2587 S-UP -> M-p S-DOWN -> M-n | |
2588 S-LEFT -> M-- S-RIGHT -> M-+ | |
2589 S-RET -> C-S-RET | |
2590 @end example | |
2591 Yes, these are unfortunately more difficult to remember. If you want | |
2592 to have other replacement keys, look at the variable | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2593 @code{org-disputed-keys}. |
63833 | 2594 @item @file{remember.el} by John Wiegley |
2595 Org mode cooperates with remember, see @ref{Remember}. | |
2596 @cindex @file{planner.el} | |
2597 @item @file{planner.el} by John Wiegley | |
2598 Planner is another tool to plan work and keep track of tasks. Planner | |
2599 uses a multi-file approach with project pages and day pages. Is based | |
2600 on Emacs-Wiki. If Planner is your primary tool, it can be useful to | |
2601 display the agenda entries resulting from org files in day-pages of | |
2602 the planner. This can be done through the diary of the calendar: | |
2603 Integrate org files into the diary as described above, and then turn | |
2604 on the diary support of planner. | |
58792 | 2605 @end table |
2606 | |
65656 | 2607 @node TTY keys, Bugs, Interaction, Miscellaneous |
2608 @section Using org-mode on a tty | |
2609 | |
2610 Org-mode uses a number of keys that are not accessible on a tty. This | |
2611 applies to most special keys like cursor keys, @key{TAB} and | |
2612 @key{RET}, when these are combined with modifier keys like @key{Meta} | |
2613 and/or @key{Shift}. Org-mode uses these bindings because it needs to | |
2614 provide keys for a large number of commands, and because these keys | |
2615 appeared particularly easy to remember. In order to still be able to | |
2616 access the core functionality of Org-mode on a tty, alternative | |
2617 bindings are provided. Here is a complete list of these bindings, | |
2618 which are obviously more cumbersome to use. Note that sometimes a | |
2619 work-around can be better. For example changing a time stamp is | |
2620 really only fun with @kbd{S-@key{cursor}} keys. On a tty you would | |
2621 rather use @kbd{C-c .} to re-insert the timestamp. | |
2622 | |
2623 @page | |
2624 @multitable @columnfractions 0.15 0.2 0.2 | |
2625 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
2626 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
2627 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
2628 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
2629 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} | |
2630 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab | |
2631 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
2632 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
2633 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
2634 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
2635 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
2636 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
2637 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
2638 @item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
2639 @item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
2640 @item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab | |
2641 @item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab | |
2642 @end multitable | |
2643 | |
2644 @node Bugs, Acknowledgments, TTY keys, Miscellaneous | |
63362 | 2645 @section Bugs |
2646 @cindex bugs | |
2647 | |
2648 Here is a list of things which should work differently, but which I | |
2649 have found too hard to fix. | |
58792 | 2650 |
63362 | 2651 @itemize @bullet |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2652 @item |
63362 | 2653 If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the |
2654 filling is correctly disabled. However, if some text directly | |
64517 | 2655 (without an empty line in between) precedes or follows a table, calling |
63362 | 2656 @code{fill-paragraph} in that text will also fill the table like |
2657 normal text. Also, @code{fill-region} does bypass the | |
2658 @code{fill-paragraph} code and will fill tables like normal text. | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2659 @item |
65656 | 2660 Text in an entry protected with the @samp{QUOTE} keyword should not |
2661 autowrap. | |
2662 @item | |
63362 | 2663 When the application called by @kbd{C-c C-o} to open a file link fails |
2664 (for example because the application does not exits or refuses to open | |
2665 the file), it does so silently. No error message is displayed. | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2666 @item |
65656 | 2667 The remote-editing commands in the agenda buffer cannot be undone with |
2668 @code{undo} called from within the agenda buffer. But you can go to | |
2669 the corresponding buffer (using @key{TAB} or @key{RET} and execute | |
2670 @code{undo} there. | |
2671 @item | |
63833 | 2672 Recalculating a table line applies the formulas from left to right. |
65656 | 2673 If a formula uses @emph{calculated} fields further down the row, |
2674 multiple recalculation may be needed to get all fields consistent. | |
63833 | 2675 @item |
63362 | 2676 Under XEmacs, if Org-mode entries are included into the diary, it is |
2677 not possible to jump back from the diary to the org file. Apparently, | |
2678 the text properties are lost when the fancy-diary-display is used. | |
2679 However, from Org-mode's timeline and agenda buffers (created with | |
2680 @kbd{C-c C-r} and @kbd{C-c a}), things do work correctly. | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2681 @item |
63362 | 2682 Linux should also have a default viewer application, using mailcap. |
2683 Maybe we can use GNUS or VM mime code? Or dired's guessing commands? | |
2684 Any hints (or even patches) are appreciated. | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2685 @item |
63362 | 2686 When you write @samp{x = a /b/ c}, b will be exported in italics. |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2687 @item |
63362 | 2688 The exporters work well, but could be made more efficient. |
2689 @end itemize | |
2690 | |
2691 @page | |
2692 | |
2693 @node Acknowledgments, , Bugs, Miscellaneous | |
58792 | 2694 @section Acknowledgments |
2695 @cindex acknowledgments | |
2696 | |
2697 Org-mode was written by Carsten Dominik, who still maintains it at the | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2698 Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2699 The following people have helped the development along with ideas, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2700 suggestions and patches. |
58792 | 2701 |
2702 @itemize @bullet | |
2703 @item | |
63833 | 2704 Matthias Rempe (Oelde) provided ideas, a patch introducing Windows |
2705 NT/2000 support, and quality control. | |
58792 | 2706 @item |
2707 Kevin Rogers contributed code to access VM files on remote hosts. | |
2708 @item | |
2709 Juergen Vollmer contributed code generating the table of contents | |
2710 in HTML output, and other export improvements. | |
2711 @item | |
2712 Christian Egli converted the documentation into TeXInfo format. He | |
2713 also showed me his plans for a multifile summary for Org-mode. Some of | |
2714 his ideas have found their way into the agenda. | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2715 @item |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2716 Philip Rooke created the Org-mode reference card. He also helped with |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
2717 beta testing and contributed a number of very useful ideas. |
58792 | 2718 @item |
63833 | 2719 Christian Schlauer proposed angular brackets around links, among other |
2720 things. | |
63362 | 2721 @item |
64517 | 2722 David Wainberg suggested to implement an archiving mechanism and helped |
2723 testing. | |
63362 | 2724 @item |
58792 | 2725 Linking to VM/BBDB/GNUS was inspired by Tom Shannon's |
2726 @file{organizer-mode.el}. | |
2727 @item | |
2728 Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. | |
2729 @item | |
63362 | 2730 Sacha Chua, the current maintainer of Planner, offered linking code |
2731 from Planner. I made use of the offer for links to RMAIL and Wanderlust. | |
58792 | 2732 @item |
2733 Oliver Oppitz sent several useful suggestions. | |
2734 @item | |
2735 Carsten Wimmer suggested some changes and helped fix a bug in linking | |
2736 to GNUS. | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2737 @item |
62548 | 2738 Pavel Chalmoviansky reported bugs and suggested improvements related |
63362 | 2739 to the agenda treatment of items with specified time. |
62548 | 2740 @item |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2741 Stefan Monnier provided a patch with lots of little fixes to keep the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2742 Emacs-Lisp compiler happy. |
63362 | 2743 @item |
2744 Kai Grossjohann pointed out that a number of key bindings in Org-mode | |
2745 conflict with other packages. | |
65656 | 2746 @item |
2747 Roland Winkler pointed out that additional keybindings are need to use | |
2748 Org-mode on a tty. | |
58792 | 2749 @end itemize |
2750 | |
2751 @node Index, Key Index, Miscellaneous, Top | |
2752 @chapter Index | |
2753 | |
2754 @printindex cp | |
2755 | |
2756 @node Key Index, , Index, Top | |
2757 @chapter Key Index | |
2758 | |
2759 @printindex ky | |
2760 | |
2761 @bye | |
64070 | 2762 |
2763 @ignore | |
2764 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | |
2765 @end ignore |