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