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