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