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