Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo |
2 | @c %**start of header | |
311f0356 | 3 | @setfilename ../../info/org |
a7808fba | 4 | @settitle The Org Manual |
6f66f53f | 5 | @set VERSION 8.2.5c |
86fbb8ca CD |
6 | |
7 | @c Use proper quote and backtick for code sections in PDF output | |
8 | @c Cf. Texinfo manual 14.2 | |
9 | @set txicodequoteundirected | |
10 | @set txicodequotebacktick | |
4009494e | 11 | |
4009494e | 12 | @c Version and Contact Info |
271672fa | 13 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} |
4009494e GM |
14 | @set AUTHOR Carsten Dominik |
15 | @set MAINTAINER Carsten Dominik | |
dbc28aaa CD |
16 | @set MAINTAINEREMAIL @email{carsten at orgmode dot org} |
17 | @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer} | |
c6ab4664 | 18 | @documentencoding UTF-8 |
4009494e GM |
19 | @c %**end of header |
20 | @finalout | |
21 | ||
acedf35c CD |
22 | |
23 | @c ----------------------------------------------------------------------------- | |
24 | ||
25 | @c Macro definitions for commands and keys | |
26 | @c ======================================= | |
27 | ||
28 | @c The behavior of the key/command macros will depend on the flag cmdnames | |
29 | @c When set, commands names are shown. When clear, they are not shown. | |
30 | ||
31 | @set cmdnames | |
32 | ||
33 | @c Below we define the following macros for Org key tables: | |
34 | ||
ce57c2fe | 35 | @c orgkey{key} A key item |
acedf35c | 36 | @c orgcmd{key,cmd} Key with command name |
27e428e7 | 37 | @c xorgcmd{key,cmd} Key with command name as @itemx |
acedf35c CD |
38 | @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key |
39 | @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key | |
40 | @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or" | |
41 | @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but | |
42 | @c different functions, so format as @itemx | |
43 | @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short" | |
44 | @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx | |
45 | @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands | |
46 | ||
47 | @c a key but no command | |
48 | @c Inserts: @item key | |
49 | @macro orgkey{key} | |
50 | @kindex \key\ | |
51 | @item @kbd{\key\} | |
52 | @end macro | |
53 | ||
54 | @macro xorgkey{key} | |
55 | @kindex \key\ | |
56 | @itemx @kbd{\key\} | |
57 | @end macro | |
58 | ||
59 | @c one key with a command | |
60 | @c Inserts: @item KEY COMMAND | |
afe98dfa | 61 | @macro orgcmd{key,command} |
acedf35c | 62 | @ifset cmdnames |
afe98dfa CD |
63 | @kindex \key\ |
64 | @findex \command\ | |
acedf35c | 65 | @iftex |
afe98dfa CD |
66 | @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} |
67 | @end iftex | |
68 | @ifnottex | |
acedf35c CD |
69 | @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) |
70 | @end ifnottex | |
71 | @end ifset | |
72 | @ifclear cmdnames | |
73 | @kindex \key\ | |
74 | @item @kbd{\key\} | |
75 | @end ifclear | |
76 | @end macro | |
77 | ||
78 | @c One key with one command, formatted using @itemx | |
79 | @c Inserts: @itemx KEY COMMAND | |
80 | @macro xorgcmd{key,command} | |
81 | @ifset cmdnames | |
82 | @kindex \key\ | |
83 | @findex \command\ | |
84 | @iftex | |
85 | @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} | |
86 | @end iftex | |
87 | @ifnottex | |
88 | @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
89 | @end ifnottex | |
90 | @end ifset | |
91 | @ifclear cmdnames | |
afe98dfa | 92 | @kindex \key\ |
acedf35c CD |
93 | @itemx @kbd{\key\} |
94 | @end ifclear | |
95 | @end macro | |
96 | ||
97 | @c one key with a command, bit do not index the key | |
98 | @c Inserts: @item KEY COMMAND | |
99 | @macro orgcmdnki{key,command} | |
100 | @ifset cmdnames | |
afe98dfa | 101 | @findex \command\ |
acedf35c CD |
102 | @iftex |
103 | @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} | |
104 | @end iftex | |
105 | @ifnottex | |
afe98dfa CD |
106 | @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) |
107 | @end ifnottex | |
acedf35c CD |
108 | @end ifset |
109 | @ifclear cmdnames | |
110 | @item @kbd{\key\} | |
111 | @end ifclear | |
afe98dfa CD |
112 | @end macro |
113 | ||
acedf35c CD |
114 | @c one key with a command, and special text to replace key in item |
115 | @c Inserts: @item TEXT COMMAND | |
116 | @macro orgcmdtkc{text,key,command} | |
117 | @ifset cmdnames | |
afe98dfa | 118 | @kindex \key\ |
acedf35c CD |
119 | @findex \command\ |
120 | @iftex | |
121 | @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\} | |
122 | @end iftex | |
123 | @ifnottex | |
124 | @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
125 | @end ifnottex | |
126 | @end ifset | |
127 | @ifclear cmdnames | |
128 | @kindex \key\ | |
129 | @item @kbd{\text\} | |
130 | @end ifclear | |
afe98dfa CD |
131 | @end macro |
132 | ||
acedf35c CD |
133 | @c two keys with one command |
134 | @c Inserts: @item KEY1 or KEY2 COMMAND | |
135 | @macro orgcmdkkc{key1,key2,command} | |
136 | @ifset cmdnames | |
137 | @kindex \key1\ | |
138 | @kindex \key2\ | |
139 | @findex \command\ | |
c8d0cf5c | 140 | @iftex |
acedf35c | 141 | @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} |
c8d0cf5c | 142 | @end iftex |
acedf35c CD |
143 | @ifnottex |
144 | @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
145 | @end ifnottex | |
146 | @end ifset | |
147 | @ifclear cmdnames | |
148 | @kindex \key1\ | |
149 | @kindex \key2\ | |
150 | @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} | |
151 | @end ifclear | |
c8d0cf5c | 152 | @end macro |
acedf35c CD |
153 | |
154 | @c Two keys with one command name, but different functions, so format as | |
155 | @c @itemx | |
156 | @c Inserts: @item KEY1 | |
157 | @c @itemx KEY2 COMMAND | |
158 | @macro orgcmdkxkc{key1,key2,command} | |
159 | @ifset cmdnames | |
160 | @kindex \key1\ | |
161 | @kindex \key2\ | |
162 | @findex \command\ | |
163 | @iftex | |
164 | @item @kbd{\key1\} | |
165 | @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} | |
166 | @end iftex | |
167 | @ifnottex | |
168 | @item @kbd{\key1\} | |
169 | @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
170 | @end ifnottex | |
171 | @end ifset | |
172 | @ifclear cmdnames | |
173 | @kindex \key1\ | |
174 | @kindex \key2\ | |
175 | @item @kbd{\key1\} | |
176 | @itemx @kbd{\key2\} | |
177 | @end ifclear | |
c8d0cf5c | 178 | @end macro |
acedf35c CD |
179 | |
180 | @c Same as previous, but use "or short" | |
181 | @c Inserts: @item KEY1 or short KEY2 COMMAND | |
182 | @macro orgcmdkskc{key1,key2,command} | |
183 | @ifset cmdnames | |
184 | @kindex \key1\ | |
185 | @kindex \key2\ | |
186 | @findex \command\ | |
187 | @iftex | |
188 | @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} | |
189 | @end iftex | |
190 | @ifnottex | |
191 | @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
192 | @end ifnottex | |
193 | @end ifset | |
194 | @ifclear cmdnames | |
195 | @kindex \key1\ | |
196 | @kindex \key2\ | |
197 | @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} | |
198 | @end ifclear | |
c8d0cf5c | 199 | @end macro |
acedf35c CD |
200 | |
201 | @c Same as previous, but use @itemx | |
202 | @c Inserts: @itemx KEY1 or short KEY2 COMMAND | |
203 | @macro xorgcmdkskc{key1,key2,command} | |
204 | @ifset cmdnames | |
205 | @kindex \key1\ | |
206 | @kindex \key2\ | |
207 | @findex \command\ | |
208 | @iftex | |
209 | @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} | |
210 | @end iftex | |
211 | @ifnottex | |
212 | @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) | |
213 | @end ifnottex | |
214 | @end ifset | |
215 | @ifclear cmdnames | |
216 | @kindex \key1\ | |
217 | @kindex \key2\ | |
218 | @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} | |
219 | @end ifclear | |
c8d0cf5c | 220 | @end macro |
4009494e | 221 | |
acedf35c CD |
222 | @c two keys with two commands |
223 | @c Inserts: @item KEY1 COMMAND1 | |
224 | @c @itemx KEY2 COMMAND2 | |
225 | @macro orgcmdkkcc{key1,key2,command1,command2} | |
226 | @ifset cmdnames | |
227 | @kindex \key1\ | |
228 | @kindex \key2\ | |
229 | @findex \command1\ | |
230 | @findex \command2\ | |
231 | @iftex | |
232 | @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\} | |
233 | @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\} | |
234 | @end iftex | |
235 | @ifnottex | |
236 | @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\}) | |
237 | @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\}) | |
238 | @end ifnottex | |
239 | @end ifset | |
240 | @ifclear cmdnames | |
241 | @kindex \key1\ | |
242 | @kindex \key2\ | |
243 | @item @kbd{\key1\} | |
244 | @itemx @kbd{\key2\} | |
245 | @end ifclear | |
246 | @end macro | |
247 | @c ----------------------------------------------------------------------------- | |
248 | ||
249 | @iftex | |
250 | @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed} | |
251 | @end iftex | |
252 | ||
4009494e GM |
253 | @c Subheadings inside a table. |
254 | @macro tsubheading{text} | |
255 | @ifinfo | |
256 | @subsubheading \text\ | |
257 | @end ifinfo | |
258 | @ifnotinfo | |
259 | @item @b{\text\} | |
260 | @end ifnotinfo | |
261 | @end macro | |
262 | ||
263 | @copying | |
c8d0cf5c | 264 | This manual is for Org version @value{VERSION}. |
4009494e | 265 | |
6bc383b1 | 266 | Copyright @copyright{} 2004--2014 Free Software Foundation, Inc. |
4009494e GM |
267 | |
268 | @quotation | |
269 | Permission is granted to copy, distribute and/or modify this document | |
d60b1ba1 | 270 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e GM |
271 | any later version published by the Free Software Foundation; with no |
272 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
47271179 GM |
273 | and with the Back-Cover Texts as in (a) below. A copy of the license |
274 | is included in the section entitled ``GNU Free Documentation License.'' | |
4009494e | 275 | |
6f093307 | 276 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
76ef8423 | 277 | modify this GNU manual.'' |
4009494e GM |
278 | @end quotation |
279 | @end copying | |
280 | ||
9e7a4bcf | 281 | @dircategory Emacs editing modes |
5dc584b5 | 282 | @direntry |
6f66f53f | 283 | * Org Mode: (org). Outline-based notes management and organizer. |
5dc584b5 KB |
284 | @end direntry |
285 | ||
4009494e | 286 | @titlepage |
a7808fba | 287 | @title The Org Manual |
4009494e GM |
288 | |
289 | @subtitle Release @value{VERSION} | |
290 | @author by Carsten Dominik | |
271672fa BG |
291 | with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan |
292 | Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou. | |
4009494e GM |
293 | |
294 | @c The following two commands start the copyright page. | |
295 | @page | |
296 | @vskip 0pt plus 1filll | |
297 | @insertcopying | |
298 | @end titlepage | |
299 | ||
300 | @c Output the table of contents at the beginning. | |
301 | @contents | |
302 | ||
303 | @ifnottex | |
257b2c7d GM |
304 | @c FIXME These hand-written next,prev,up node pointers make editing a lot |
305 | @c harder. There should be no need for them, makeinfo can do it | |
306 | @c automatically for any document with a normal structure. | |
4009494e GM |
307 | @node Top, Introduction, (dir), (dir) |
308 | @top Org Mode Manual | |
309 | ||
310 | @insertcopying | |
311 | @end ifnottex | |
312 | ||
313 | @menu | |
c0468714 GM |
314 | * Introduction:: Getting started |
315 | * Document Structure:: A tree works like your brain | |
316 | * Tables:: Pure magic for quick formatting | |
317 | * Hyperlinks:: Notes in context | |
318 | * TODO Items:: Every tree branch can be a TODO item | |
319 | * Tags:: Tagging headlines and matching sets of tags | |
320 | * Properties and Columns:: Storing information about an entry | |
321 | * Dates and Times:: Making items useful for planning | |
322 | * Capture - Refile - Archive:: The ins and outs for projects | |
323 | * Agenda Views:: Collecting information into views | |
324 | * Markup:: Prepare text for rich export | |
271672fa | 325 | * Exporting:: Sharing and publishing notes |
c0468714 GM |
326 | * Publishing:: Create a web site of linked Org files |
327 | * Working With Source Code:: Export, evaluate, and tangle code blocks | |
328 | * Miscellaneous:: All the rest which did not fit elsewhere | |
329 | * Hacking:: How to hack your way around | |
330 | * MobileOrg:: Viewing and capture on a mobile device | |
331 | * History and Acknowledgments:: How Org came into being | |
257b2c7d | 332 | * GNU Free Documentation License:: The license for this documentation. |
c0468714 GM |
333 | * Main Index:: An index of Org's concepts and features |
334 | * Key Index:: Key bindings and where they are described | |
afe98dfa | 335 | * Command and Function Index:: Command names and some internal functions |
c0468714 | 336 | * Variable Index:: Variables mentioned in the manual |
4009494e GM |
337 | |
338 | @detailmenu | |
339 | --- The Detailed Node Listing --- | |
340 | ||
341 | Introduction | |
342 | ||
c0468714 | 343 | * Summary:: Brief summary of what Org does |
a89c8ef0 | 344 | * Installation:: Installing Org |
c0468714 GM |
345 | * Activation:: How to activate Org for certain buffers |
346 | * Feedback:: Bug reports, ideas, patches etc. | |
8223b1d2 | 347 | * Conventions:: Typesetting conventions in the manual |
86fbb8ca CD |
348 | |
349 | Document structure | |
350 | ||
c0468714 GM |
351 | * Outlines:: Org is based on Outline mode |
352 | * Headlines:: How to typeset Org tree headlines | |
353 | * Visibility cycling:: Show and hide, much simplified | |
354 | * Motion:: Jumping to other headlines | |
355 | * Structure editing:: Changing sequence and level of headlines | |
356 | * Sparse trees:: Matches embedded in context | |
357 | * Plain lists:: Additional structure within an entry | |
358 | * Drawers:: Tucking stuff away | |
359 | * Blocks:: Folding blocks | |
360 | * Footnotes:: How footnotes are defined in Org's syntax | |
361 | * Orgstruct mode:: Structure editing outside Org | |
271672fa BG |
362 | * Org syntax:: Formal description of Org's syntax |
363 | ||
364 | Visibility cycling | |
365 | ||
366 | * Global and local cycling:: Cycling through various visibility states | |
367 | * Initial visibility:: Setting the initial visibility state | |
368 | * Catching invisible edits:: Preventing mistakes when editing invisible parts | |
369 | ||
370 | Global and local cycling | |
371 | ||
372 | * Initial visibility:: Setting the initial visibility state | |
373 | * Catching invisible edits:: Preventing mistakes when editing invisible parts | |
4009494e | 374 | |
4009494e GM |
375 | Tables |
376 | ||
c0468714 GM |
377 | * Built-in table editor:: Simple tables |
378 | * Column width and alignment:: Overrule the automatic settings | |
379 | * Column groups:: Grouping to trigger vertical lines | |
380 | * Orgtbl mode:: The table editor as minor mode | |
381 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
382 | * Org-Plot:: Plotting from org tables | |
4009494e GM |
383 | |
384 | The spreadsheet | |
385 | ||
c0468714 GM |
386 | * References:: How to refer to another field or range |
387 | * Formula syntax for Calc:: Using Calc to compute stuff | |
388 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
ce57c2fe BG |
389 | * Durations and time values:: How to compute durations and time values |
390 | * Field and range formulas:: Formula for specific (ranges of) fields | |
c0468714 | 391 | * Column formulas:: Formulas valid for an entire column |
271672fa | 392 | * Lookup functions:: Lookup functions for searching tables |
4009494e | 393 | * Editing and debugging formulas:: Fixing formulas |
c0468714 | 394 | * Updating the table:: Recomputing all dependent fields |
e66ba1df | 395 | * Advanced features:: Field and column names, parameters and automatic recalc |
4009494e GM |
396 | |
397 | Hyperlinks | |
398 | ||
c0468714 GM |
399 | * Link format:: How links in Org are formatted |
400 | * Internal links:: Links to other places in the current file | |
401 | * External links:: URL-like links to the world | |
402 | * Handling links:: Creating, inserting and following | |
403 | * Using links outside Org:: Linking from my C source code? | |
404 | * Link abbreviations:: Shortcuts for writing complex links | |
405 | * Search options:: Linking to a specific location | |
406 | * Custom searches:: When the default search is not enough | |
4009494e GM |
407 | |
408 | Internal links | |
409 | ||
c0468714 | 410 | * Radio targets:: Make targets trigger links in plain text |
4009494e | 411 | |
86fbb8ca | 412 | TODO items |
4009494e | 413 | |
c0468714 GM |
414 | * TODO basics:: Marking and displaying TODO entries |
415 | * TODO extensions:: Workflow and assignments | |
416 | * Progress logging:: Dates and notes for progress | |
417 | * Priorities:: Some things are more important than others | |
418 | * Breaking down tasks:: Splitting a task into manageable pieces | |
419 | * Checkboxes:: Tick-off lists | |
4009494e GM |
420 | |
421 | Extended use of TODO keywords | |
422 | ||
c0468714 GM |
423 | * Workflow states:: From TODO to DONE in steps |
424 | * TODO types:: I do this, Fred does the rest | |
425 | * Multiple sets in one file:: Mixing it all, and still finding your way | |
426 | * Fast access to TODO states:: Single letter selection of a state | |
427 | * Per-file keywords:: Different files, different requirements | |
428 | * Faces for TODO keywords:: Highlighting states | |
429 | * TODO dependencies:: When one task needs to wait for others | |
dbc28aaa | 430 | |
a7808fba | 431 | Progress logging |
dbc28aaa | 432 | |
c0468714 GM |
433 | * Closing items:: When was this entry marked DONE? |
434 | * Tracking TODO state changes:: When did the status change? | |
435 | * Tracking your habits:: How consistent have you been? | |
4009494e GM |
436 | |
437 | Tags | |
438 | ||
c0468714 GM |
439 | * Tag inheritance:: Tags use the tree structure of the outline |
440 | * Setting tags:: How to assign tags to a headline | |
271672fa | 441 | * Tag groups:: Use one tag to search for several tags |
c0468714 | 442 | * Tag searches:: Searching for combinations of tags |
4009494e | 443 | |
86fbb8ca | 444 | Properties and columns |
4009494e | 445 | |
c0468714 | 446 | * Property syntax:: How properties are spelled out |
e66ba1df | 447 | * Special properties:: Access to other Org mode features |
c0468714 GM |
448 | * Property searches:: Matching property values |
449 | * Property inheritance:: Passing values down the tree | |
450 | * Column view:: Tabular viewing and editing | |
451 | * Property API:: Properties for Lisp programmers | |
4009494e | 452 | |
a7808fba | 453 | Column view |
4009494e | 454 | |
c0468714 GM |
455 | * Defining columns:: The COLUMNS format property |
456 | * Using column view:: How to create and use column view | |
457 | * Capturing column view:: A dynamic block for column view | |
4009494e | 458 | |
a7808fba | 459 | Defining columns |
4009494e | 460 | |
c0468714 GM |
461 | * Scope of column definitions:: Where defined, where valid? |
462 | * Column attributes:: Appearance and content of a column | |
4009494e | 463 | |
86fbb8ca | 464 | Dates and times |
4009494e | 465 | |
c0468714 GM |
466 | * Timestamps:: Assigning a time to a tree entry |
467 | * Creating timestamps:: Commands which insert timestamps | |
468 | * Deadlines and scheduling:: Planning your work | |
469 | * Clocking work time:: Tracking how long you spend on a task | |
c0468714 GM |
470 | * Effort estimates:: Planning work effort in advance |
471 | * Relative timer:: Notes with a running timer | |
afe98dfa | 472 | * Countdown timer:: Starting a countdown timer for a task |
4009494e GM |
473 | |
474 | Creating timestamps | |
475 | ||
e66ba1df | 476 | * The date/time prompt:: How Org mode helps you entering date and time |
c0468714 | 477 | * Custom time format:: Making dates look different |
4009494e | 478 | |
a7808fba | 479 | Deadlines and scheduling |
4009494e | 480 | |
c0468714 GM |
481 | * Inserting deadline/schedule:: Planning items |
482 | * Repeated tasks:: Items that show up again and again | |
4009494e | 483 | |
acedf35c CD |
484 | Clocking work time |
485 | ||
486 | * Clocking commands:: Starting and stopping a clock | |
487 | * The clock table:: Detailed reports | |
488 | * Resolving idle time:: Resolving time when you've been idle | |
489 | ||
a351880d | 490 | Capture - Refile - Archive |
864c9740 | 491 | |
c0468714 GM |
492 | * Capture:: Capturing new stuff |
493 | * Attachments:: Add files to tasks | |
494 | * RSS Feeds:: Getting input from RSS feeds | |
1df7defd | 495 | * Protocols:: External (e.g., Browser) access to Emacs and Org |
271672fa | 496 | * Refile and copy:: Moving/copying a tree from one place to another |
c0468714 | 497 | * Archiving:: What to do with finished projects |
86fbb8ca CD |
498 | |
499 | Capture | |
500 | ||
c0468714 GM |
501 | * Setting up capture:: Where notes will be stored |
502 | * Using capture:: Commands to invoke and terminate capture | |
503 | * Capture templates:: Define the outline of different note types | |
864c9740 | 504 | |
86fbb8ca | 505 | Capture templates |
4009494e | 506 | |
c0468714 GM |
507 | * Template elements:: What is needed for a complete template entry |
508 | * Template expansion:: Filling in information about time and context | |
8223b1d2 | 509 | * Templates in contexts:: Only show a template in a specific context |
a351880d CD |
510 | |
511 | Archiving | |
512 | ||
c0468714 GM |
513 | * Moving subtrees:: Moving a tree to an archive file |
514 | * Internal archiving:: Switch off a tree but keep it in the file | |
4009494e | 515 | |
86fbb8ca | 516 | Agenda views |
4009494e | 517 | |
c0468714 GM |
518 | * Agenda files:: Files being searched for agenda information |
519 | * Agenda dispatcher:: Keyboard access to agenda views | |
520 | * Built-in agenda views:: What is available out of the box? | |
521 | * Presentation and sorting:: How agenda items are prepared for display | |
522 | * Agenda commands:: Remote editing of Org trees | |
523 | * Custom agenda views:: Defining special searches and views | |
524 | * Exporting Agenda Views:: Writing a view to a file | |
525 | * Agenda column view:: Using column view for collected entries | |
4009494e GM |
526 | |
527 | The built-in agenda views | |
528 | ||
c0468714 GM |
529 | * Weekly/daily agenda:: The calendar page with current tasks |
530 | * Global TODO list:: All unfinished action items | |
4009494e | 531 | * Matching tags and properties:: Structured information with fine-tuned search |
c0468714 GM |
532 | * Timeline:: Time-sorted view for single file |
533 | * Search view:: Find entries by searching for text | |
534 | * Stuck projects:: Find projects you need to review | |
4009494e GM |
535 | |
536 | Presentation and sorting | |
537 | ||
c0468714 GM |
538 | * Categories:: Not all tasks are equal |
539 | * Time-of-day specifications:: How the agenda knows the time | |
271672fa BG |
540 | * Sorting agenda items:: The order of things |
541 | * Filtering/limiting agenda items:: Dynamically narrow the agenda | |
4009494e GM |
542 | |
543 | Custom agenda views | |
544 | ||
c0468714 GM |
545 | * Storing searches:: Type once, use often |
546 | * Block agenda:: All the stuff you need in a single buffer | |
547 | * Setting Options:: Changing the rules | |
4009494e | 548 | |
a351880d CD |
549 | Markup for rich export |
550 | ||
c0468714 | 551 | * Structural markup elements:: The basic structure as seen by the exporter |
271672fa | 552 | * Images and tables:: Images, tables and caption mechanism |
c0468714 GM |
553 | * Literal examples:: Source code examples with special formatting |
554 | * Include files:: Include additional files into a document | |
555 | * Index entries:: Making an index | |
271672fa | 556 | * Macro replacement:: Use macros to create templates |
e66ba1df | 557 | * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents |
271672fa | 558 | * Special blocks:: Containers targeted at export back-ends |
a351880d CD |
559 | |
560 | Structural markup elements | |
561 | ||
c0468714 GM |
562 | * Document title:: Where the title is taken from |
563 | * Headings and sections:: The document structure as seen by the exporter | |
564 | * Table of contents:: The if and where of the table of contents | |
c0468714 GM |
565 | * Lists:: Lists |
566 | * Paragraphs:: Paragraphs | |
567 | * Footnote markup:: Footnotes | |
568 | * Emphasis and monospace:: Bold, italic, etc. | |
569 | * Horizontal rules:: Make a line | |
570 | * Comment lines:: What will *not* be exported | |
a351880d | 571 | |
acedf35c | 572 | Embedded @LaTeX{} |
4009494e | 573 | |
c0468714 GM |
574 | * Special symbols:: Greek letters and other symbols |
575 | * Subscripts and superscripts:: Simple syntax for raising/lowering text | |
8223b1d2 | 576 | * @LaTeX{} fragments:: Complex formulas made easy |
e66ba1df | 577 | * Previewing @LaTeX{} fragments:: What will this snippet look like? |
c0468714 | 578 | * CDLaTeX mode:: Speed up entering of formulas |
4009494e GM |
579 | |
580 | Exporting | |
581 | ||
271672fa BG |
582 | * The Export Dispatcher:: The main exporter interface |
583 | * Export back-ends:: Built-in export formats | |
584 | * Export settings:: Generic export settings | |
c0468714 | 585 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
271672fa | 586 | * Beamer export:: Exporting as a Beamer presentation |
c0468714 | 587 | * HTML export:: Exporting to HTML |
e66ba1df | 588 | * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF |
271672fa | 589 | * Markdown export:: Exporting to Markdown |
e66ba1df | 590 | * OpenDocument Text export:: Exporting to OpenDocument Text |
3c8b09ca | 591 | * Org export:: Exporting to Org |
271672fa BG |
592 | * iCalendar export:: Exporting to iCalendar |
593 | * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org | |
594 | * Export in foreign buffers:: Author tables in lists in Org syntax | |
595 | * Advanced configuration:: Fine-tuning the export output | |
b349f79f | 596 | |
4009494e GM |
597 | HTML export |
598 | ||
c0468714 | 599 | * HTML Export commands:: How to invoke HTML export |
271672fa | 600 | * HTML doctypes:: Org can export to various (X)HTML flavors |
ce57c2fe | 601 | * HTML preamble and postamble:: How to insert a preamble and a postamble |
e66ba1df | 602 | * Quoting HTML tags:: Using direct HTML in Org mode |
c0468714 GM |
603 | * Links in HTML export:: How links will be interpreted and formatted |
604 | * Tables in HTML export:: How to modify the formatting of tables | |
605 | * Images in HTML export:: How to insert figures into HTML output | |
afe98dfa | 606 | * Math formatting in HTML export:: Beautiful math also on the web |
c0468714 GM |
607 | * Text areas in HTML export:: An alternative way to show an example |
608 | * CSS support:: Changing the appearance of the output | |
609 | * JavaScript support:: Info and Folding in a web browser | |
4009494e | 610 | |
acedf35c | 611 | @LaTeX{} and PDF export |
4009494e | 612 | |
271672fa | 613 | * @LaTeX{} export commands:: How to export to LaTeX and PDF |
c0468714 | 614 | * Header and sectioning:: Setting up the export file structure |
e66ba1df | 615 | * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code |
271672fa | 616 | * @LaTeX{} specific attributes:: Controlling @LaTeX{} output |
4009494e | 617 | |
e66ba1df | 618 | OpenDocument Text export |
ce57c2fe | 619 | |
153ae947 BG |
620 | * Pre-requisites for ODT export:: What packages ODT exporter relies on |
621 | * ODT export commands:: How to invoke ODT export | |
622 | * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files | |
e66ba1df | 623 | * Applying custom styles:: How to apply custom styles to the output |
153ae947 BG |
624 | * Links in ODT export:: How links will be interpreted and formatted |
625 | * Tables in ODT export:: How Tables are exported | |
626 | * Images in ODT export:: How to insert images | |
627 | * Math formatting in ODT export:: How @LaTeX{} fragments are formatted | |
628 | * Labels and captions in ODT export:: How captions are rendered | |
629 | * Literal examples in ODT export:: How source and example blocks are formatted | |
630 | * Advanced topics in ODT export:: Read this if you are a power user | |
e66ba1df | 631 | |
153ae947 | 632 | Math formatting in ODT export |
e66ba1df BG |
633 | |
634 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments | |
635 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format | |
636 | ||
153ae947 | 637 | Advanced topics in ODT export |
e66ba1df | 638 | |
153ae947 | 639 | * Configuring a document converter:: How to register a document converter |
e66ba1df BG |
640 | * Working with OpenDocument style files:: Explore the internals |
641 | * Creating one-off styles:: How to produce custom highlighting etc | |
153ae947 | 642 | * Customizing tables in ODT export:: How to define and use Table templates |
e66ba1df | 643 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files |
ce57c2fe | 644 | |
4009494e GM |
645 | Publishing |
646 | ||
c0468714 GM |
647 | * Configuration:: Defining projects |
648 | * Uploading files:: How to get files up on the server | |
649 | * Sample configuration:: Example projects | |
650 | * Triggering publication:: Publication commands | |
4009494e GM |
651 | |
652 | Configuration | |
653 | ||
c0468714 GM |
654 | * Project alist:: The central configuration variable |
655 | * Sources and destinations:: From here to there | |
656 | * Selecting files:: What files are part of the project? | |
657 | * Publishing action:: Setting the function doing the publishing | |
ce57c2fe | 658 | * Publishing options:: Tweaking HTML/@LaTeX{} export |
c0468714 GM |
659 | * Publishing links:: Which links keep working after publishing? |
660 | * Sitemap:: Generating a list of all pages | |
661 | * Generating an index:: An index that reaches across pages | |
4009494e GM |
662 | |
663 | Sample configuration | |
664 | ||
c0468714 GM |
665 | * Simple example:: One-component publishing |
666 | * Complex example:: A multi-component publishing example | |
86fbb8ca CD |
667 | |
668 | Working with source code | |
669 | ||
c0468714 GM |
670 | * Structure of code blocks:: Code block syntax described |
671 | * Editing source code:: Language major-mode editing | |
672 | * Exporting code blocks:: Export contents and/or results | |
673 | * Extracting source code:: Create pure source code files | |
e66ba1df | 674 | * Evaluating code blocks:: Place results of evaluation in the Org mode buffer |
c0468714 GM |
675 | * Library of Babel:: Use and contribute to a library of useful code blocks |
676 | * Languages:: List of supported code block languages | |
677 | * Header arguments:: Configure code block functionality | |
678 | * Results of evaluation:: How evaluation results are handled | |
e66ba1df | 679 | * Noweb reference syntax:: Literate programming in Org mode |
86fbb8ca | 680 | * Key bindings and useful functions:: Work quickly with code blocks |
c0468714 | 681 | * Batch execution:: Call functions from the command line |
86fbb8ca CD |
682 | |
683 | Header arguments | |
684 | ||
c0468714 GM |
685 | * Using header arguments:: Different ways to set header arguments |
686 | * Specific header arguments:: List of header arguments | |
86fbb8ca CD |
687 | |
688 | Using header arguments | |
689 | ||
690 | * System-wide header arguments:: Set global default values | |
c0468714 | 691 | * Language-specific header arguments:: Set default values by language |
e66ba1df | 692 | * Header arguments in Org mode properties:: Set default values for a buffer or heading |
d1389828 | 693 | * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading |
86fbb8ca | 694 | * Code block specific header arguments:: The most common way to set values |
afe98dfa | 695 | * Header arguments in function calls:: The most specific level |
86fbb8ca CD |
696 | |
697 | Specific header arguments | |
698 | ||
c0468714 | 699 | * var:: Pass arguments to code blocks |
afe98dfa CD |
700 | * results:: Specify the type of results and how they will |
701 | be collected and handled | |
c0468714 | 702 | * file:: Specify a path for file output |
8223b1d2 | 703 | * file-desc:: Specify a description for file results |
afe98dfa CD |
704 | * dir:: Specify the default (possibly remote) |
705 | directory for code block execution | |
c0468714 GM |
706 | * exports:: Export code and/or results |
707 | * tangle:: Toggle tangling and specify file name | |
ce57c2fe BG |
708 | * mkdirp:: Toggle creation of parent directories of target |
709 | files during tangling | |
afe98dfa CD |
710 | * comments:: Toggle insertion of comments in tangled |
711 | code files | |
ce57c2fe BG |
712 | * padline:: Control insertion of padding lines in tangled |
713 | code files | |
afe98dfa CD |
714 | * no-expand:: Turn off variable assignment and noweb |
715 | expansion during tangling | |
c0468714 GM |
716 | * session:: Preserve the state of code evaluation |
717 | * noweb:: Toggle expansion of noweb references | |
ce57c2fe | 718 | * noweb-ref:: Specify block's noweb reference resolution target |
153ae947 | 719 | * noweb-sep:: String used to separate noweb references |
c0468714 | 720 | * cache:: Avoid re-evaluating unchanged code blocks |
ce57c2fe | 721 | * sep:: Delimiter for writing tabular results outside Org |
c0468714 GM |
722 | * hlines:: Handle horizontal lines in tables |
723 | * colnames:: Handle column names in tables | |
724 | * rownames:: Handle row names in tables | |
725 | * shebang:: Make tangled files executable | |
271672fa | 726 | * tangle-mode:: Set permission of tangled files |
afe98dfa | 727 | * eval:: Limit evaluation of specific code blocks |
8223b1d2 | 728 | * wrap:: Mark source block evaluation results |
271672fa BG |
729 | * post:: Post processing of code block results |
730 | * prologue:: Text to prepend to code block body | |
731 | * epilogue:: Text to append to code block body | |
4009494e GM |
732 | |
733 | Miscellaneous | |
734 | ||
c0468714 | 735 | * Completion:: M-TAB knows what you need |
afe98dfa | 736 | * Easy Templates:: Quick insertion of structural elements |
c0468714 GM |
737 | * Speed keys:: Electric commands at the beginning of a headline |
738 | * Code evaluation security:: Org mode files evaluate inline code | |
739 | * Customization:: Adapting Org to your taste | |
740 | * In-buffer settings:: Overview of the #+KEYWORDS | |
741 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
742 | * Clean view:: Getting rid of leading stars in the outline | |
743 | * TTY keys:: Using Org on a tty | |
744 | * Interaction:: Other Emacs packages | |
271672fa | 745 | * org-crypt:: Encrypting Org files |
4009494e GM |
746 | |
747 | Interaction with other packages | |
748 | ||
c0468714 GM |
749 | * Cooperation:: Packages Org cooperates with |
750 | * Conflicts:: Packages that lead to conflicts | |
4009494e | 751 | |
b349f79f | 752 | Hacking |
4009494e | 753 | |
8223b1d2 | 754 | * Hooks:: How to reach into Org's internals |
c0468714 GM |
755 | * Add-on packages:: Available extensions |
756 | * Adding hyperlink types:: New custom link types | |
271672fa | 757 | * Adding export back-ends:: How to write new export back-ends |
c0468714 | 758 | * Context-sensitive commands:: How to add functionality to such commands |
acedf35c | 759 | * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs |
c0468714 GM |
760 | * Dynamic blocks:: Automatically filled blocks |
761 | * Special agenda views:: Customized views | |
271672fa BG |
762 | * Speeding up your agendas:: Tips on how to speed up your agendas |
763 | * Extracting agenda information:: Post-processing of agenda information | |
c0468714 GM |
764 | * Using the property API:: Writing programs that use entry properties |
765 | * Using the mapping API:: Mapping over all or selected entries | |
4009494e | 766 | |
a7808fba | 767 | Tables and lists in arbitrary syntax |
4009494e | 768 | |
c0468714 | 769 | * Radio tables:: Sending and receiving radio tables |
e66ba1df | 770 | * A @LaTeX{} example:: Step by step, almost a tutorial |
c0468714 | 771 | * Translator functions:: Copy and modify |
271672fa | 772 | * Radio lists:: Sending and receiving lists |
4009494e | 773 | |
7006d207 CD |
774 | MobileOrg |
775 | ||
c0468714 GM |
776 | * Setting up the staging area:: Where to interact with the mobile device |
777 | * Pushing to MobileOrg:: Uploading Org files and agendas | |
778 | * Pulling from MobileOrg:: Integrating captured and flagged items | |
7006d207 | 779 | |
4009494e GM |
780 | @end detailmenu |
781 | @end menu | |
782 | ||
a7808fba | 783 | @node Introduction, Document Structure, Top, Top |
4009494e GM |
784 | @chapter Introduction |
785 | @cindex introduction | |
786 | ||
787 | @menu | |
c0468714 | 788 | * Summary:: Brief summary of what Org does |
a89c8ef0 | 789 | * Installation:: Installing Org |
c0468714 GM |
790 | * Activation:: How to activate Org for certain buffers |
791 | * Feedback:: Bug reports, ideas, patches etc. | |
8223b1d2 | 792 | * Conventions:: Typesetting conventions in the manual |
4009494e GM |
793 | @end menu |
794 | ||
795 | @node Summary, Installation, Introduction, Introduction | |
796 | @section Summary | |
797 | @cindex summary | |
798 | ||
a7808fba | 799 | Org is a mode for keeping notes, maintaining TODO lists, and doing |
4009494e GM |
800 | project planning with a fast and effective plain-text system. |
801 | ||
a7808fba CD |
802 | Org develops organizational tasks around NOTES files that contain |
803 | lists or information about projects as plain text. Org is | |
804 | implemented on top of Outline mode, which makes it possible to keep the | |
4009494e GM |
805 | content of large files well structured. Visibility cycling and |
806 | structure editing help to work with the tree. Tables are easily created | |
a7808fba | 807 | with a built-in table editor. Org supports TODO items, deadlines, |
c8d0cf5c | 808 | timestamps, and scheduling. It dynamically compiles entries into an |
4009494e GM |
809 | agenda that utilizes and smoothly integrates much of the Emacs calendar |
810 | and diary. Plain text URL-like links connect to websites, emails, | |
811 | Usenet messages, BBDB entries, and any files related to the projects. | |
271672fa | 812 | For printing and sharing notes, an Org file can be exported as a |
dbc28aaa | 813 | structured ASCII file, as HTML, or (TODO and agenda items only) as an |
4009494e | 814 | iCalendar file. It can also serve as a publishing tool for a set of |
a7808fba | 815 | linked web pages. |
4009494e | 816 | |
86fbb8ca CD |
817 | As a project planning environment, Org works by adding metadata to outline |
818 | nodes. Based on this data, specific entries can be extracted in queries and | |
819 | create dynamic @i{agenda views}. | |
820 | ||
acedf35c CD |
821 | Org mode contains the Org Babel environment which allows you to work with |
822 | embedded source code blocks in a file, to facilitate code evaluation, | |
ce57c2fe | 823 | documentation, and literate programming techniques. |
86fbb8ca CD |
824 | |
825 | Org's automatic, context-sensitive table editor with spreadsheet | |
826 | capabilities can be integrated into any major mode by activating the | |
827 | minor Orgtbl mode. Using a translation step, it can be used to maintain | |
acedf35c | 828 | tables in arbitrary file types, for example in @LaTeX{}. The structure |
86fbb8ca CD |
829 | editing and list creation capabilities can be used outside Org with |
830 | the minor Orgstruct mode. | |
4009494e | 831 | |
a7808fba | 832 | Org keeps simple things simple. When first fired up, it should |
4009494e GM |
833 | feel like a straightforward, easy to use outliner. Complexity is not |
834 | imposed, but a large amount of functionality is available when you need | |
86fbb8ca CD |
835 | it. Org is a toolbox and can be used in different ways and for different |
836 | ends, for example: | |
4009494e GM |
837 | |
838 | @example | |
c8d0cf5c CD |
839 | @r{@bullet{} an outline extension with visibility cycling and structure editing} |
840 | @r{@bullet{} an ASCII system and table editor for taking structured notes} | |
c8d0cf5c CD |
841 | @r{@bullet{} a TODO list editor} |
842 | @r{@bullet{} a full agenda and planner with deadlines and work scheduling} | |
843 | @pindex GTD, Getting Things Done | |
86fbb8ca | 844 | @r{@bullet{} an environment in which to implement David Allen's GTD system} |
acedf35c | 845 | @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export} |
271672fa | 846 | @r{@bullet{} a publishing tool to create a set of interlinked web pages} |
86fbb8ca | 847 | @r{@bullet{} an environment for literate programming} |
4009494e GM |
848 | @end example |
849 | ||
4009494e | 850 | @cindex FAQ |
a7808fba CD |
851 | There is a website for Org which provides links to the newest |
852 | version of Org, as well as additional information, frequently asked | |
1df7defd | 853 | questions (FAQ), links to tutorials, etc. This page is located at |
dbc28aaa | 854 | @uref{http://orgmode.org}. |
4009494e | 855 | |
ce57c2fe BG |
856 | @cindex print edition |
857 | The version 7.3 of this manual is available as a | |
858 | @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network | |
859 | Theory Ltd.} | |
860 | ||
4009494e GM |
861 | @page |
862 | ||
863 | ||
864 | @node Installation, Activation, Summary, Introduction | |
865 | @section Installation | |
866 | @cindex installation | |
867 | @cindex XEmacs | |
868 | ||
a89c8ef0 BG |
869 | Org is part of recent distributions of GNU Emacs, so you normally don't need |
870 | to install it. If, for one reason or another, you want to install Org on top | |
871 | of this pre-packaged version, there are three ways to do it: | |
a7808fba | 872 | |
8223b1d2 | 873 | @itemize @bullet |
a89c8ef0 BG |
874 | @item By using Emacs package system. |
875 | @item By downloading Org as an archive. | |
876 | @item By using Org's git repository. | |
8223b1d2 | 877 | @end itemize |
a7808fba | 878 | |
a89c8ef0 | 879 | We @b{strongly recommend} to stick to a single installation method. |
4009494e | 880 | |
a89c8ef0 | 881 | @subsubheading Using Emacs packaging system |
8223b1d2 | 882 | |
a89c8ef0 BG |
883 | Recent Emacs distributions include a packaging system which lets you install |
884 | Elisp libraries. You can install Org with @kbd{M-x package-install RET org}. | |
271672fa BG |
885 | You need to do this in a session where no @code{.org} file has been visited. |
886 | Then, to make sure your Org configuration is taken into account, initialize | |
887 | the package system with @code{(package-initialize)} in your @file{.emacs} | |
888 | before setting any Org option. If you want to use Org's package repository, | |
889 | check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}. | |
8223b1d2 | 890 | |
a89c8ef0 | 891 | @subsubheading Downloading Org as an archive |
8223b1d2 | 892 | |
a89c8ef0 BG |
893 | You can download Org latest release from @uref{http://orgmode.org/, Org's |
894 | website}. In this case, make sure you set the load-path correctly in your | |
895 | @file{.emacs}: | |
4009494e | 896 | |
271672fa | 897 | @lisp |
8223b1d2 | 898 | (add-to-list 'load-path "~/path/to/orgdir/lisp") |
271672fa | 899 | @end lisp |
4009494e | 900 | |
a89c8ef0 BG |
901 | The downloaded archive contains contributed libraries that are not included |
902 | in Emacs. If you want to use them, add the @file{contrib} directory to your | |
903 | load-path: | |
4009494e | 904 | |
271672fa | 905 | @lisp |
8223b1d2 | 906 | (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t) |
271672fa | 907 | @end lisp |
c8d0cf5c | 908 | |
a89c8ef0 BG |
909 | Optionally, you can compile the files and/or install them in your system. |
910 | Run @code{make help} to list compilation and installation options. | |
911 | ||
912 | @subsubheading Using Org's git repository | |
8223b1d2 | 913 | |
a89c8ef0 | 914 | You can clone Org's repository and install Org like this: |
ce57c2fe BG |
915 | |
916 | @example | |
a89c8ef0 BG |
917 | $ cd ~/src/ |
918 | $ git clone git://orgmode.org/org-mode.git | |
919 | $ make autoloads | |
ce57c2fe BG |
920 | @end example |
921 | ||
d3517077 BG |
922 | Note that in this case, @code{make autoloads} is mandatory: it defines Org's |
923 | version in @file{org-version.el} and Org's autoloads in | |
a89c8ef0 | 924 | @file{org-loaddefs.el}. |
c8d0cf5c | 925 | |
a89c8ef0 | 926 | Remember to add the correct load-path as described in the method above. |
4009494e | 927 | |
d3517077 BG |
928 | You can also compile with @code{make}, generate the documentation with |
929 | @code{make doc}, create a local configuration with @code{make config} and | |
930 | install Org with @code{make install}. Please run @code{make help} to get | |
931 | the list of compilation/installation options. | |
a89c8ef0 BG |
932 | |
933 | For more detailed explanations on Org's build system, please check the Org | |
d3517077 BG |
934 | Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html, |
935 | Worg}. | |
a7808fba | 936 | |
4009494e GM |
937 | @node Activation, Feedback, Installation, Introduction |
938 | @section Activation | |
939 | @cindex activation | |
940 | @cindex autoload | |
8223b1d2 | 941 | @cindex ELPA |
a7808fba CD |
942 | @cindex global key bindings |
943 | @cindex key bindings, global | |
8223b1d2 BG |
944 | @findex org-agenda |
945 | @findex org-capture | |
946 | @findex org-store-link | |
947 | @findex org-iswitchb | |
948 | ||
949 | Since Emacs 22.2, files with the @file{.org} extension use Org mode by | |
950 | default. If you are using an earlier version of Emacs, add this line to your | |
951 | @file{.emacs} file: | |
4009494e | 952 | |
4009494e | 953 | @lisp |
4009494e | 954 | (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) |
ce57c2fe | 955 | @end lisp |
8223b1d2 | 956 | |
f99f1641 | 957 | Org mode buffers need font-lock to be turned on: this is the default in |
8223b1d2 BG |
958 | Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer |
959 | with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}. | |
960 | ||
961 | There are compatibility issues between Org mode and some other Elisp | |
962 | packages, please take the time to check the list (@pxref{Conflicts}). | |
ce57c2fe BG |
963 | |
964 | The four Org commands @command{org-store-link}, @command{org-capture}, | |
965 | @command{org-agenda}, and @command{org-iswitchb} should be accessible through | |
1df7defd | 966 | global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are |
ce57c2fe BG |
967 | suggested bindings for these keys, please modify the keys to your own |
968 | liking. | |
969 | @lisp | |
4009494e | 970 | (global-set-key "\C-cl" 'org-store-link) |
ce57c2fe | 971 | (global-set-key "\C-cc" 'org-capture) |
4009494e | 972 | (global-set-key "\C-ca" 'org-agenda) |
a7808fba | 973 | (global-set-key "\C-cb" 'org-iswitchb) |
4009494e GM |
974 | @end lisp |
975 | ||
e66ba1df | 976 | @cindex Org mode, turning on |
4009494e | 977 | With this setup, all files with extension @samp{.org} will be put |
e66ba1df | 978 | into Org mode. As an alternative, make the first line of a file look |
4009494e GM |
979 | like this: |
980 | ||
981 | @example | |
982 | MY PROJECTS -*- mode: org; -*- | |
983 | @end example | |
984 | ||
c8d0cf5c | 985 | @vindex org-insert-mode-line-in-empty-file |
e66ba1df | 986 | @noindent which will select Org mode for this buffer no matter what |
4009494e GM |
987 | the file's name is. See also the variable |
988 | @code{org-insert-mode-line-in-empty-file}. | |
989 | ||
c8d0cf5c CD |
990 | Many commands in Org work on the region if the region is @i{active}. To make |
991 | use of this, you need to have @code{transient-mark-mode} | |
992 | (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default, | |
993 | in Emacs 22 you need to do this yourself with | |
b6cb4cd5 CD |
994 | @lisp |
995 | (transient-mark-mode 1) | |
996 | @end lisp | |
c8d0cf5c CD |
997 | @noindent If you do not like @code{transient-mark-mode}, you can create an |
998 | active region by using the mouse to select a region, or pressing | |
999 | @kbd{C-@key{SPC}} twice before moving the cursor. | |
b6cb4cd5 | 1000 | |
dbc28aaa | 1001 | @node Feedback, Conventions, Activation, Introduction |
4009494e GM |
1002 | @section Feedback |
1003 | @cindex feedback | |
1004 | @cindex bug reports | |
1005 | @cindex maintainer | |
1006 | @cindex author | |
1007 | ||
b349f79f | 1008 | If you find problems with Org, or if you have questions, remarks, or ideas |
c8d0cf5c | 1009 | about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}. |
6eb02347 | 1010 | If you are not a member of the mailing list, your mail will be passed to the |
afe98dfa CD |
1011 | list after a moderator has approved it@footnote{Please consider subscribing |
1012 | to the mailing list, in order to minimize the work the mailing list | |
1013 | moderators have to do.}. | |
1014 | ||
1015 | For bug reports, please first try to reproduce the bug with the latest | |
acedf35c | 1016 | version of Org available---if you are running an outdated version, it is |
afe98dfa CD |
1017 | quite possible that the bug has been fixed already. If the bug persists, |
1018 | prepare a report and provide as much information as possible, including the | |
1019 | version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org | |
271672fa | 1020 | (@kbd{M-x org-version RET}), as well as the Org related setup in |
6eb02347 CD |
1021 | @file{.emacs}. The easiest way to do this is to use the command |
1022 | @example | |
271672fa | 1023 | @kbd{M-x org-submit-bug-report RET} |
6eb02347 CD |
1024 | @end example |
1025 | @noindent which will put all this information into an Emacs mail buffer so | |
1026 | that you only need to add your description. If you re not sending the Email | |
1027 | from within Emacs, please copy and paste the content into your Email program. | |
1028 | ||
e66ba1df BG |
1029 | Sometimes you might face a problem due to an error in your Emacs or Org mode |
1030 | setup. Before reporting a bug, it is very helpful to start Emacs with minimal | |
7bd20f91 | 1031 | customizations and reproduce the problem. Doing so often helps you determine |
27e428e7 | 1032 | if the problem is with your customization or with Org mode itself. You can |
e66ba1df BG |
1033 | start a typical minimal session with a command like the example below. |
1034 | ||
1035 | @example | |
1036 | $ emacs -Q -l /path/to/minimal-org.el | |
1037 | @end example | |
1038 | ||
1039 | However if you are using Org mode as distributed with Emacs, a minimal setup | |
8223b1d2 BG |
1040 | is not necessary. In that case it is sufficient to start Emacs as |
1041 | @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as | |
1042 | shown below. | |
e66ba1df | 1043 | |
271672fa | 1044 | @lisp |
e66ba1df BG |
1045 | ;;; Minimal setup to load latest `org-mode' |
1046 | ||
1047 | ;; activate debugging | |
1048 | (setq debug-on-error t | |
1049 | debug-on-signal nil | |
1050 | debug-on-quit nil) | |
1051 | ||
1052 | ;; add latest org-mode to load path | |
1053 | (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) | |
8223b1d2 | 1054 | (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t)) |
271672fa | 1055 | @end lisp |
e66ba1df | 1056 | |
6eb02347 CD |
1057 | If an error occurs, a backtrace can be very useful (see below on how to |
1058 | create one). Often a small example file helps, along with clear information | |
1059 | about: | |
4009494e GM |
1060 | |
1061 | @enumerate | |
1062 | @item What exactly did you do? | |
1063 | @item What did you expect to happen? | |
1064 | @item What happened instead? | |
1065 | @end enumerate | |
afe98dfa | 1066 | @noindent Thank you for helping to improve this program. |
4009494e GM |
1067 | |
1068 | @subsubheading How to create a useful backtrace | |
1069 | ||
1070 | @cindex backtrace of an error | |
a7808fba | 1071 | If working with Org produces an error with a message you don't |
4009494e | 1072 | understand, you may have hit a bug. The best way to report this is by |
c8d0cf5c | 1073 | providing, in addition to what was mentioned above, a @emph{backtrace}. |
4009494e GM |
1074 | This is information from the built-in debugger about where and how the |
1075 | error occurred. Here is how to produce a useful backtrace: | |
1076 | ||
1077 | @enumerate | |
1078 | @item | |
e66ba1df | 1079 | Reload uncompiled versions of all Org mode Lisp files. The backtrace |
c8d0cf5c CD |
1080 | contains much more information if it is produced with uncompiled code. |
1081 | To do this, use | |
4009494e | 1082 | @example |
271672fa | 1083 | @kbd{C-u M-x org-reload RET} |
4009494e | 1084 | @end example |
c8d0cf5c CD |
1085 | @noindent |
1086 | or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the | |
1087 | menu. | |
4009494e GM |
1088 | @item |
1089 | Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
1090 | (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
1091 | @item | |
1092 | Do whatever you have to do to hit the error. Don't forget to | |
1093 | document the steps you take. | |
1094 | @item | |
1095 | When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
1096 | screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
1097 | attach it to your bug report. | |
1098 | @end enumerate | |
1099 | ||
dbc28aaa CD |
1100 | @node Conventions, , Feedback, Introduction |
1101 | @section Typesetting conventions used in this manual | |
1102 | ||
8223b1d2 BG |
1103 | @subsubheading TODO keywords, tags, properties, etc. |
1104 | ||
1105 | Org mainly uses three types of keywords: TODO keywords, tags and property | |
dbc28aaa CD |
1106 | names. In this manual we use the following conventions: |
1107 | ||
1108 | @table @code | |
1109 | @item TODO | |
1110 | @itemx WAITING | |
1111 | TODO keywords are written with all capitals, even if they are | |
1112 | user-defined. | |
1113 | @item boss | |
1114 | @itemx ARCHIVE | |
1115 | User-defined tags are written in lowercase; built-in tags with special | |
1116 | meaning are written with all capitals. | |
1117 | @item Release | |
1118 | @itemx PRIORITY | |
1119 | User-defined properties are capitalized; built-in properties with | |
1120 | special meaning are written with all capitals. | |
1121 | @end table | |
1122 | ||
8223b1d2 BG |
1123 | Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title) |
1124 | and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML} | |
1125 | environment). They are written in uppercase in the manual to enhance its | |
1126 | readability, but you can use lowercase in your Org files@footnote{Easy | |
1127 | templates insert lowercase keywords and Babel dynamically inserts | |
271672fa | 1128 | @code{#+results}.}. |
8223b1d2 BG |
1129 | |
1130 | @subsubheading Keybindings and commands | |
1131 | @kindex C-c a | |
1132 | @findex org-agenda | |
1133 | @kindex C-c c | |
1134 | @findex org-capture | |
1135 | ||
1136 | The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda} | |
1137 | and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the | |
1138 | rest of the manual assumes that you are using these keybindings. | |
1139 | ||
1140 | Also, the manual lists both the keys and the corresponding commands for | |
1141 | accessing a functionality. Org mode often uses the same key for different | |
1142 | functions, depending on context. The command that is bound to such keys has | |
1143 | a generic name, like @code{org-metaright}. In the manual we will, wherever | |
1144 | possible, give the function that is internally called by the generic command. | |
1145 | For example, in the chapter on document structure, @kbd{M-@key{right}} will | |
1146 | be listed to call @code{org-do-demote}, while in the chapter on tables, it | |
1147 | will be listed to call @code{org-table-move-column-right}. If you prefer, | |
1148 | you can compile the manual without the command names by unsetting the flag | |
1149 | @code{cmdnames} in @file{org.texi}. | |
acedf35c | 1150 | |
a7808fba | 1151 | @node Document Structure, Tables, Introduction, Top |
86fbb8ca | 1152 | @chapter Document structure |
4009494e GM |
1153 | @cindex document structure |
1154 | @cindex structure of document | |
1155 | ||
c8d0cf5c | 1156 | Org is based on Outline mode and provides flexible commands to |
4009494e GM |
1157 | edit the structure of the document. |
1158 | ||
1159 | @menu | |
c0468714 GM |
1160 | * Outlines:: Org is based on Outline mode |
1161 | * Headlines:: How to typeset Org tree headlines | |
1162 | * Visibility cycling:: Show and hide, much simplified | |
1163 | * Motion:: Jumping to other headlines | |
1164 | * Structure editing:: Changing sequence and level of headlines | |
1165 | * Sparse trees:: Matches embedded in context | |
1166 | * Plain lists:: Additional structure within an entry | |
1167 | * Drawers:: Tucking stuff away | |
1168 | * Blocks:: Folding blocks | |
1169 | * Footnotes:: How footnotes are defined in Org's syntax | |
1170 | * Orgstruct mode:: Structure editing outside Org | |
271672fa | 1171 | * Org syntax:: Formal description of Org's syntax |
4009494e GM |
1172 | @end menu |
1173 | ||
a7808fba | 1174 | @node Outlines, Headlines, Document Structure, Document Structure |
4009494e GM |
1175 | @section Outlines |
1176 | @cindex outlines | |
a7808fba | 1177 | @cindex Outline mode |
4009494e | 1178 | |
a7808fba | 1179 | Org is implemented on top of Outline mode. Outlines allow a |
4009494e GM |
1180 | document to be organized in a hierarchical structure, which (at least |
1181 | for me) is the best representation of notes and thoughts. An overview | |
1182 | of this structure is achieved by folding (hiding) large parts of the | |
1183 | document to show only the general document structure and the parts | |
a7808fba | 1184 | currently being worked on. Org greatly simplifies the use of |
4009494e | 1185 | outlines by compressing the entire show/hide functionality into a single |
c8d0cf5c | 1186 | command, @command{org-cycle}, which is bound to the @key{TAB} key. |
4009494e | 1187 | |
a7808fba | 1188 | @node Headlines, Visibility cycling, Outlines, Document Structure |
4009494e GM |
1189 | @section Headlines |
1190 | @cindex headlines | |
1191 | @cindex outline tree | |
c8d0cf5c | 1192 | @vindex org-special-ctrl-a/e |
86fbb8ca CD |
1193 | @vindex org-special-ctrl-k |
1194 | @vindex org-ctrl-k-protect-subtree | |
4009494e | 1195 | |
86fbb8ca CD |
1196 | Headlines define the structure of an outline tree. The headlines in Org |
1197 | start with one or more stars, on the left margin@footnote{See the variables | |
1198 | @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and | |
1199 | @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a}, | |
8223b1d2 BG |
1200 | @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with |
1201 | headings indented less then 30 stars.}. For example: | |
4009494e GM |
1202 | |
1203 | @example | |
1204 | * Top level headline | |
1205 | ** Second level | |
1206 | *** 3rd level | |
1207 | some text | |
1208 | *** 3rd level | |
1209 | more text | |
1210 | ||
1211 | * Another top level headline | |
1212 | @end example | |
1213 | ||
1214 | @noindent Some people find the many stars too noisy and would prefer an | |
1215 | outline that has whitespace followed by a single star as headline | |
c8d0cf5c | 1216 | starters. @ref{Clean view}, describes a setup to realize this. |
4009494e | 1217 | |
c8d0cf5c | 1218 | @vindex org-cycle-separator-lines |
4009494e GM |
1219 | An empty line after the end of a subtree is considered part of it and |
1220 | will be hidden when the subtree is folded. However, if you leave at | |
1221 | least two empty lines, one empty line will remain visible after folding | |
1222 | the subtree, in order to structure the collapsed view. See the | |
1223 | variable @code{org-cycle-separator-lines} to modify this behavior. | |
1224 | ||
a7808fba | 1225 | @node Visibility cycling, Motion, Headlines, Document Structure |
4009494e GM |
1226 | @section Visibility cycling |
1227 | @cindex cycling, visibility | |
1228 | @cindex visibility cycling | |
1229 | @cindex trees, visibility | |
1230 | @cindex show hidden text | |
1231 | @cindex hide text | |
1232 | ||
271672fa BG |
1233 | @menu |
1234 | * Global and local cycling:: Cycling through various visibility states | |
1235 | * Initial visibility:: Setting the initial visibility state | |
1236 | * Catching invisible edits:: Preventing mistakes when editing invisible parts | |
1237 | @end menu | |
1238 | ||
1239 | @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling | |
1240 | @subsection Global and local cycling | |
1241 | ||
4009494e | 1242 | Outlines make it possible to hide parts of the text in the buffer. |
a7808fba | 1243 | Org uses just two commands, bound to @key{TAB} and |
4009494e GM |
1244 | @kbd{S-@key{TAB}} to change the visibility in the buffer. |
1245 | ||
1246 | @cindex subtree visibility states | |
1247 | @cindex subtree cycling | |
1248 | @cindex folded, subtree visibility state | |
1249 | @cindex children, subtree visibility state | |
1250 | @cindex subtree, subtree visibility state | |
afe98dfa CD |
1251 | @table @asis |
1252 | @orgcmd{@key{TAB},org-cycle} | |
4009494e GM |
1253 | @emph{Subtree cycling}: Rotate current subtree among the states |
1254 | ||
1255 | @example | |
1256 | ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
1257 | '-----------------------------------' | |
1258 | @end example | |
1259 | ||
c8d0cf5c CD |
1260 | @vindex org-cycle-emulate-tab |
1261 | @vindex org-cycle-global-at-bob | |
4009494e GM |
1262 | The cursor must be on a headline for this to work@footnote{see, however, |
1263 | the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
1264 | beginning of the buffer and the first line is not a headline, then | |
1265 | @key{TAB} actually runs global cycling (see below)@footnote{see the | |
1266 | option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
1267 | argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
1268 | ||
1269 | @cindex global visibility states | |
1270 | @cindex global cycling | |
1271 | @cindex overview, global visibility state | |
1272 | @cindex contents, global visibility state | |
1273 | @cindex show all, global visibility state | |
afe98dfa | 1274 | @orgcmd{S-@key{TAB},org-global-cycle} |
4009494e GM |
1275 | @itemx C-u @key{TAB} |
1276 | @emph{Global cycling}: Rotate the entire buffer among the states | |
1277 | ||
1278 | @example | |
1279 | ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
1280 | '--------------------------------------' | |
1281 | @end example | |
1282 | ||
a7808fba CD |
1283 | When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the |
1284 | CONTENTS view up to headlines of level N will be shown. Note that inside | |
1285 | tables, @kbd{S-@key{TAB}} jumps to the previous field. | |
4009494e | 1286 | |
3c8b09ca BG |
1287 | @cindex set startup visibility, command |
1288 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} | |
1289 | Switch back to the startup visibility of the buffer (@pxref{Initial visibility}). | |
4009494e | 1290 | @cindex show all, command |
afe98dfa | 1291 | @orgcmd{C-u C-u C-u @key{TAB},show-all} |
864c9740 | 1292 | Show all, including drawers. |
8223b1d2 | 1293 | @cindex revealing context |
afe98dfa | 1294 | @orgcmd{C-c C-r,org-reveal} |
a7808fba CD |
1295 | Reveal context around point, showing the current entry, the following heading |
1296 | and the hierarchy above. Useful for working near a location that has been | |
1297 | exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command | |
1298 | (@pxref{Agenda commands}). With a prefix argument show, on each | |
27e428e7 | 1299 | level, all sibling headings. With a double prefix argument, also show the |
e66ba1df | 1300 | entire subtree of the parent. |
8223b1d2 | 1301 | @cindex show branches, command |
afe98dfa | 1302 | @orgcmd{C-c C-k,show-branches} |
86fbb8ca | 1303 | Expose all the headings of the subtree, CONTENT view for just one subtree. |
8223b1d2 BG |
1304 | @cindex show children, command |
1305 | @orgcmd{C-c @key{TAB},show-children} | |
1306 | Expose all direct children of the subtree. With a numeric prefix argument N, | |
1df7defd | 1307 | expose all children down to level N@. |
afe98dfa | 1308 | @orgcmd{C-c C-x b,org-tree-to-indirect-buffer} |
4009494e GM |
1309 | Show the current subtree in an indirect buffer@footnote{The indirect |
1310 | buffer | |
1311 | @ifinfo | |
1312 | (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
1313 | @end ifinfo | |
1314 | @ifnotinfo | |
1315 | (see the Emacs manual for more information about indirect buffers) | |
1316 | @end ifnotinfo | |
1317 | will contain the entire buffer, but will be narrowed to the current | |
1318 | tree. Editing the indirect buffer will also change the original buffer, | |
a7808fba CD |
1319 | but without affecting visibility in that buffer.}. With a numeric |
1320 | prefix argument N, go up to level N and then take that tree. If N is | |
1321 | negative then go up that many levels. With a @kbd{C-u} prefix, do not remove | |
4009494e | 1322 | the previously used indirect buffer. |
ce57c2fe BG |
1323 | @orgcmd{C-c C-x v,org-copy-visible} |
1324 | Copy the @i{visible} text in the region into the kill ring. | |
4009494e GM |
1325 | @end table |
1326 | ||
271672fa BG |
1327 | @menu |
1328 | * Initial visibility:: Setting the initial visibility state | |
1329 | * Catching invisible edits:: Preventing mistakes when editing invisible parts | |
1330 | @end menu | |
1331 | ||
1332 | @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling | |
1333 | @subsection Initial visibility | |
1334 | ||
1335 | @cindex visibility, initialize | |
c8d0cf5c | 1336 | @vindex org-startup-folded |
8a28a5b8 | 1337 | @vindex org-agenda-inhibit-startup |
c8d0cf5c CD |
1338 | @cindex @code{overview}, STARTUP keyword |
1339 | @cindex @code{content}, STARTUP keyword | |
1340 | @cindex @code{showall}, STARTUP keyword | |
7006d207 | 1341 | @cindex @code{showeverything}, STARTUP keyword |
c8d0cf5c | 1342 | |
271672fa BG |
1343 | When Emacs first visits an Org file, the global state is set to OVERVIEW, |
1344 | i.e., only the top level headlines are visible@footnote{When | |
1345 | @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default | |
1346 | visibility state when first opening a file for the agenda (@pxref{Speeding up | |
1347 | your agendas}).} This can be configured through the variable | |
1348 | @code{org-startup-folded}, or on a per-file basis by adding one of the | |
1349 | following lines anywhere in the buffer: | |
4009494e GM |
1350 | |
1351 | @example | |
1352 | #+STARTUP: overview | |
1353 | #+STARTUP: content | |
1354 | #+STARTUP: showall | |
7006d207 | 1355 | #+STARTUP: showeverything |
4009494e GM |
1356 | @end example |
1357 | ||
8a28a5b8 BG |
1358 | The startup visibility options are ignored when the file is open for the |
1359 | first time during the agenda generation: if you want the agenda to honor | |
271672fa | 1360 | the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}. |
8a28a5b8 | 1361 | |
c8d0cf5c | 1362 | @cindex property, VISIBILITY |
b349f79f | 1363 | @noindent |
a50253cc | 1364 | Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties |
b349f79f CD |
1365 | and Columns}) will get their visibility adapted accordingly. Allowed values |
1366 | for this property are @code{folded}, @code{children}, @code{content}, and | |
1367 | @code{all}. | |
271672fa | 1368 | |
afe98dfa CD |
1369 | @table @asis |
1370 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} | |
1df7defd | 1371 | Switch back to the startup visibility of the buffer, i.e., whatever is |
b349f79f CD |
1372 | requested by startup options and @samp{VISIBILITY} properties in individual |
1373 | entries. | |
1374 | @end table | |
1375 | ||
271672fa BG |
1376 | @node Catching invisible edits, , Initial visibility, Visibility cycling |
1377 | @subsection Catching invisible edits | |
1378 | ||
1379 | @vindex org-catch-invisible-edits | |
1380 | @cindex edits, catching invisible | |
1381 | Sometimes you may inadvertently edit an invisible part of the buffer and be | |
1382 | confused on what has been edited and how to undo the mistake. Setting | |
1383 | @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the | |
1384 | docstring of this option on how Org should catch invisible edits and process | |
1385 | them. | |
1386 | ||
a7808fba | 1387 | @node Motion, Structure editing, Visibility cycling, Document Structure |
4009494e GM |
1388 | @section Motion |
1389 | @cindex motion, between headlines | |
1390 | @cindex jumping, to headlines | |
1391 | @cindex headline navigation | |
1392 | The following commands jump to other headlines in the buffer. | |
1393 | ||
afe98dfa CD |
1394 | @table @asis |
1395 | @orgcmd{C-c C-n,outline-next-visible-heading} | |
4009494e | 1396 | Next heading. |
afe98dfa | 1397 | @orgcmd{C-c C-p,outline-previous-visible-heading} |
4009494e | 1398 | Previous heading. |
afe98dfa | 1399 | @orgcmd{C-c C-f,org-forward-same-level} |
4009494e | 1400 | Next heading same level. |
afe98dfa | 1401 | @orgcmd{C-c C-b,org-backward-same-level} |
4009494e | 1402 | Previous heading same level. |
afe98dfa | 1403 | @orgcmd{C-c C-u,outline-up-heading} |
4009494e | 1404 | Backward to higher level heading. |
afe98dfa | 1405 | @orgcmd{C-c C-j,org-goto} |
4009494e GM |
1406 | Jump to a different place without changing the current outline |
1407 | visibility. Shows the document structure in a temporary buffer, where | |
1408 | you can use the following keys to find your destination: | |
c8d0cf5c | 1409 | @vindex org-goto-auto-isearch |
4009494e GM |
1410 | @example |
1411 | @key{TAB} @r{Cycle visibility.} | |
1412 | @key{down} / @key{up} @r{Next/previous visible headline.} | |
71d35b24 CD |
1413 | @key{RET} @r{Select this location.} |
1414 | @kbd{/} @r{Do a Sparse-tree search} | |
1415 | @r{The following keys work if you turn off @code{org-goto-auto-isearch}} | |
4009494e GM |
1416 | n / p @r{Next/previous visible headline.} |
1417 | f / b @r{Next/previous headline same level.} | |
1418 | u @r{One level up.} | |
1419 | 0-9 @r{Digit argument.} | |
71d35b24 | 1420 | q @r{Quit} |
4009494e | 1421 | @end example |
c8d0cf5c CD |
1422 | @vindex org-goto-interface |
1423 | @noindent | |
271672fa | 1424 | See also the option @code{org-goto-interface}. |
4009494e GM |
1425 | @end table |
1426 | ||
a351880d | 1427 | @node Structure editing, Sparse trees, Motion, Document Structure |
4009494e GM |
1428 | @section Structure editing |
1429 | @cindex structure editing | |
1430 | @cindex headline, promotion and demotion | |
1431 | @cindex promotion, of subtrees | |
1432 | @cindex demotion, of subtrees | |
1433 | @cindex subtree, cut and paste | |
1434 | @cindex pasting, of subtrees | |
1435 | @cindex cutting, of subtrees | |
1436 | @cindex copying, of subtrees | |
6eb02347 | 1437 | @cindex sorting, of subtrees |
4009494e GM |
1438 | @cindex subtrees, cut and paste |
1439 | ||
afe98dfa CD |
1440 | @table @asis |
1441 | @orgcmd{M-@key{RET},org-insert-heading} | |
c8d0cf5c | 1442 | @vindex org-M-RET-may-split-line |
271672fa BG |
1443 | Insert a new heading/item with the same level than the one at point. |
1444 | If the cursor is in a plain list item, a new item is created | |
1445 | (@pxref{Plain lists}). To prevent this behavior in lists, call the | |
1446 | command with a prefix argument. When this command is used in the | |
1447 | middle of a line, the line is split and the rest of the line becomes | |
1448 | the new item or headline@footnote{If you do not want the line to be | |
1449 | split, customize the variable @code{org-M-RET-may-split-line}.}. If | |
1450 | the command is used at the @emph{beginning} of a headline, the new | |
1451 | headline is created before the current line. If the command is used | |
1452 | at the @emph{end} of a folded subtree (i.e., behind the ellipses at | |
1453 | the end of a headline), then a headline will be | |
1454 | inserted after the end of the subtree. Calling this command with | |
1455 | @kbd{C-u C-u} will unconditionally respect the headline's content and | |
1456 | create a new item at the end of the parent subtree. | |
afe98dfa | 1457 | @orgcmd{C-@key{RET},org-insert-heading-respect-content} |
71d35b24 CD |
1458 | Just like @kbd{M-@key{RET}}, except when adding a new heading below the |
1459 | current heading, the new heading is placed after the body instead of before | |
1460 | it. This command works from anywhere in the entry. | |
afe98dfa | 1461 | @orgcmd{M-S-@key{RET},org-insert-todo-heading} |
c8d0cf5c CD |
1462 | @vindex org-treat-insert-todo-heading-as-state-change |
1463 | Insert new TODO entry with same level as current heading. See also the | |
1464 | variable @code{org-treat-insert-todo-heading-as-state-change}. | |
afe98dfa | 1465 | @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content} |
864c9740 CD |
1466 | Insert new TODO entry with same level as current heading. Like |
1467 | @kbd{C-@key{RET}}, the new headline will be inserted after the current | |
1468 | subtree. | |
afe98dfa | 1469 | @orgcmd{@key{TAB},org-cycle} |
a351880d CD |
1470 | In a new entry with no text yet, the first @key{TAB} demotes the entry to |
1471 | become a child of the previous one. The next @key{TAB} makes it a parent, | |
1472 | and so on, all the way to top level. Yet another @key{TAB}, and you are back | |
1473 | to the initial level. | |
afe98dfa | 1474 | @orgcmd{M-@key{left},org-do-promote} |
4009494e | 1475 | Promote current heading by one level. |
afe98dfa | 1476 | @orgcmd{M-@key{right},org-do-demote} |
4009494e | 1477 | Demote current heading by one level. |
afe98dfa | 1478 | @orgcmd{M-S-@key{left},org-promote-subtree} |
4009494e | 1479 | Promote the current subtree by one level. |
afe98dfa | 1480 | @orgcmd{M-S-@key{right},org-demote-subtree} |
4009494e | 1481 | Demote the current subtree by one level. |
afe98dfa | 1482 | @orgcmd{M-S-@key{up},org-move-subtree-up} |
4009494e GM |
1483 | Move subtree up (swap with previous subtree of same |
1484 | level). | |
afe98dfa | 1485 | @orgcmd{M-S-@key{down},org-move-subtree-down} |
4009494e | 1486 | Move subtree down (swap with next subtree of same level). |
6d3e4c80 BG |
1487 | @orgcmd{M-h,org-mark-element} |
1488 | Mark the element at point. Hitting repeatedly will mark subsequent elements | |
65e7ca35 | 1489 | of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it, |
6d3e4c80 BG |
1490 | hitting @key{M-h} immediately again will mark the next one. |
1491 | @orgcmd{C-c @@,org-mark-subtree} | |
1492 | Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees | |
1493 | of the same level than the marked subtree. | |
afe98dfa | 1494 | @orgcmd{C-c C-x C-w,org-cut-subtree} |
1df7defd | 1495 | Kill subtree, i.e., remove it from buffer but save in kill ring. |
a7808fba | 1496 | With a numeric prefix argument N, kill N sequential subtrees. |
afe98dfa | 1497 | @orgcmd{C-c C-x M-w,org-copy-subtree} |
a7808fba CD |
1498 | Copy subtree to kill ring. With a numeric prefix argument N, copy the N |
1499 | sequential subtrees. | |
afe98dfa | 1500 | @orgcmd{C-c C-x C-y,org-paste-subtree} |
4009494e | 1501 | Yank subtree from kill ring. This does modify the level of the subtree to |
a7808fba CD |
1502 | make sure the tree fits in nicely at the yank position. The yank level can |
1503 | also be specified with a numeric prefix argument, or by yanking after a | |
4009494e | 1504 | headline marker like @samp{****}. |
afe98dfa | 1505 | @orgcmd{C-y,org-yank} |
c8d0cf5c CD |
1506 | @vindex org-yank-adjusted-subtrees |
1507 | @vindex org-yank-folded-subtrees | |
271672fa | 1508 | Depending on the options @code{org-yank-adjusted-subtrees} and |
e45e3595 CD |
1509 | @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will |
1510 | paste subtrees folded and in a clever way, using the same command as @kbd{C-c | |
55033558 CD |
1511 | C-x C-y}. With the default settings, no level adjustment will take place, |
1512 | but the yanked tree will be folded unless doing so would swallow text | |
1513 | previously visible. Any prefix argument to this command will force a normal | |
1514 | @code{yank} to be executed, with the prefix passed along. A good way to | |
1515 | force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a | |
1516 | yank, it will yank previous kill items plainly, without adjustment and | |
1517 | folding. | |
afe98dfa | 1518 | @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift} |
c8d0cf5c CD |
1519 | Clone a subtree by making a number of sibling copies of it. You will be |
1520 | prompted for the number of copies to make, and you can also specify if any | |
1521 | timestamps in the entry should be shifted. This can be useful, for example, | |
1522 | to create a number of tasks related to a series of lectures to prepare. For | |
1523 | more details, see the docstring of the command | |
1524 | @code{org-clone-subtree-with-time-shift}. | |
afe98dfa | 1525 | @orgcmd{C-c C-w,org-refile} |
271672fa | 1526 | Refile entry or region to a different location. @xref{Refile and copy}. |
8223b1d2 | 1527 | @orgcmd{C-c ^,org-sort} |
a7808fba CD |
1528 | Sort same-level entries. When there is an active region, all entries in the |
1529 | region will be sorted. Otherwise the children of the current headline are | |
1530 | sorted. The command prompts for the sorting method, which can be | |
c8d0cf5c CD |
1531 | alphabetically, numerically, by time (first timestamp with active preferred, |
1532 | creation time, scheduled time, deadline time), by priority, by TODO keyword | |
1533 | (in the sequence the keywords have been defined in the setup) or by the value | |
1534 | of a property. Reverse sorting is possible as well. You can also supply | |
1535 | your own function to extract the sorting key. With a @kbd{C-u} prefix, | |
153ae947 | 1536 | sorting will be case-sensitive. |
afe98dfa | 1537 | @orgcmd{C-x n s,org-narrow-to-subtree} |
b349f79f | 1538 | Narrow buffer to current subtree. |
ce57c2fe BG |
1539 | @orgcmd{C-x n b,org-narrow-to-block} |
1540 | Narrow buffer to current block. | |
afe98dfa | 1541 | @orgcmd{C-x n w,widen} |
c8d0cf5c | 1542 | Widen buffer to remove narrowing. |
afe98dfa | 1543 | @orgcmd{C-c *,org-toggle-heading} |
55e0839d CD |
1544 | Turn a normal line or plain list item into a headline (so that it becomes a |
1545 | subheading at its location). Also turn a headline into a normal line by | |
1546 | removing the stars. If there is an active region, turn all lines in the | |
1547 | region into headlines. If the first line in the region was an item, turn | |
1548 | only the item lines into headlines. Finally, if the first line is a | |
28a16a1b | 1549 | headline, remove the stars from all headlines in the region. |
4009494e GM |
1550 | @end table |
1551 | ||
1552 | @cindex region, active | |
1553 | @cindex active region | |
c8d0cf5c CD |
1554 | @cindex transient mark mode |
1555 | When there is an active region (Transient Mark mode), promotion and | |
4009494e GM |
1556 | demotion work on all headlines in the region. To select a region of |
1557 | headlines, it is best to place both point and mark at the beginning of a | |
1558 | line, mark at the beginning of the first headline, and point at the line | |
1559 | just after the last headline to change. Note that when the cursor is | |
1560 | inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
1561 | functionality. | |
1562 | ||
28a16a1b | 1563 | |
a351880d | 1564 | @node Sparse trees, Plain lists, Structure editing, Document Structure |
4009494e GM |
1565 | @section Sparse trees |
1566 | @cindex sparse trees | |
1567 | @cindex trees, sparse | |
1568 | @cindex folding, sparse trees | |
1569 | @cindex occur, command | |
1570 | ||
c8d0cf5c CD |
1571 | @vindex org-show-hierarchy-above |
1572 | @vindex org-show-following-heading | |
1573 | @vindex org-show-siblings | |
1574 | @vindex org-show-entry-below | |
e66ba1df | 1575 | An important feature of Org mode is the ability to construct @emph{sparse |
b349f79f CD |
1576 | trees} for selected information in an outline tree, so that the entire |
1577 | document is folded as much as possible, but the selected information is made | |
1578 | visible along with the headline structure above it@footnote{See also the | |
1579 | variables @code{org-show-hierarchy-above}, @code{org-show-following-heading}, | |
1580 | @code{org-show-siblings}, and @code{org-show-entry-below} for detailed | |
1581 | control on how much context is shown around each match.}. Just try it out | |
1582 | and you will see immediately how it works. | |
dbc28aaa | 1583 | |
e66ba1df | 1584 | Org mode contains several commands creating such trees, all these |
dbc28aaa | 1585 | commands can be accessed through a dispatcher: |
4009494e | 1586 | |
afe98dfa CD |
1587 | @table @asis |
1588 | @orgcmd{C-c /,org-sparse-tree} | |
dbc28aaa | 1589 | This prompts for an extra key to select a sparse-tree creating command. |
acedf35c | 1590 | @orgcmd{C-c / r,org-occur} |
c8d0cf5c | 1591 | @vindex org-remove-highlights-with-change |
ce57c2fe | 1592 | Prompts for a regexp and shows a sparse tree with all matches. If |
b349f79f CD |
1593 | the match is in a headline, the headline is made visible. If the match is in |
1594 | the body of an entry, headline and body are made visible. In order to | |
1595 | provide minimal context, also the full hierarchy of headlines above the match | |
1596 | is shown, as well as the headline following the match. Each match is also | |
1597 | highlighted; the highlights disappear when the buffer is changed by an | |
c8d0cf5c | 1598 | editing command@footnote{This depends on the option |
b349f79f CD |
1599 | @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}. |
1600 | When called with a @kbd{C-u} prefix argument, previous highlights are kept, | |
1601 | so several calls to this command can be stacked. | |
ce57c2fe BG |
1602 | @orgcmdkkc{M-g n,M-g M-n,next-error} |
1603 | Jump to the next sparse tree match in this buffer. | |
1604 | @orgcmdkkc{M-g p,M-g M-p,previous-error} | |
1605 | Jump to the previous sparse tree match in this buffer. | |
4009494e | 1606 | @end table |
dbc28aaa | 1607 | |
4009494e | 1608 | @noindent |
c8d0cf5c | 1609 | @vindex org-agenda-custom-commands |
4009494e | 1610 | For frequently used sparse trees of specific search strings, you can |
271672fa | 1611 | use the option @code{org-agenda-custom-commands} to define fast |
4009494e GM |
1612 | keyboard access to specific sparse trees. These commands will then be |
1613 | accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1614 | For example: | |
1615 | ||
1616 | @lisp | |
1617 | (setq org-agenda-custom-commands | |
1618 | '(("f" occur-tree "FIXME"))) | |
1619 | @end lisp | |
1620 | ||
1621 | @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1622 | a sparse tree matching the string @samp{FIXME}. | |
1623 | ||
dbc28aaa CD |
1624 | The other sparse tree commands select headings based on TODO keywords, |
1625 | tags, or properties and will be discussed later in this manual. | |
4009494e | 1626 | |
271672fa | 1627 | @kindex C-c C-e C-v |
4009494e GM |
1628 | @cindex printing sparse trees |
1629 | @cindex visible text, printing | |
1630 | To print a sparse tree, you can use the Emacs command | |
1631 | @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1632 | of the document @footnote{This does not work under XEmacs, because | |
1633 | XEmacs uses selective display for outlining, not text properties.}. | |
271672fa BG |
1634 | Or you can use @kbd{C-c C-e C-v} to export only the visible part of |
1635 | the document and print the resulting file. | |
4009494e | 1636 | |
a7808fba | 1637 | @node Plain lists, Drawers, Sparse trees, Document Structure |
4009494e GM |
1638 | @section Plain lists |
1639 | @cindex plain lists | |
1640 | @cindex lists, plain | |
1641 | @cindex lists, ordered | |
1642 | @cindex ordered lists | |
1643 | ||
1644 | Within an entry of the outline tree, hand-formatted lists can provide | |
afe98dfa CD |
1645 | additional structure. They also provide a way to create lists of checkboxes |
1646 | (@pxref{Checkboxes}). Org supports editing such lists, and every exporter | |
1647 | (@pxref{Exporting}) can parse and format them. | |
4009494e | 1648 | |
b349f79f CD |
1649 | Org knows ordered lists, unordered lists, and description lists. |
1650 | @itemize @bullet | |
1651 | @item | |
1652 | @emph{Unordered} list items start with @samp{-}, @samp{+}, or | |
1653 | @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or | |
1654 | they will be seen as top-level headlines. Also, when you are hiding leading | |
ce57c2fe BG |
1655 | stars to get a clean outline view, plain list items starting with a star may |
1656 | be hard to distinguish from true headlines. In short: even though @samp{*} | |
1657 | is supported, it may be better to not use it for plain list items.} as | |
1658 | bullets. | |
b349f79f | 1659 | @item |
afe98dfa | 1660 | @vindex org-plain-list-ordered-item-terminator |
271672fa | 1661 | @vindex org-list-allow-alphabetical |
b349f79f | 1662 | @emph{Ordered} list items start with a numeral followed by either a period or |
afe98dfa CD |
1663 | a right parenthesis@footnote{You can filter out any of them by configuring |
1664 | @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or | |
ce57c2fe | 1665 | @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and |
271672fa | 1666 | @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize |
ce57c2fe BG |
1667 | confusion with normal text, those are limited to one character only. Beyond |
1668 | that limit, bullets will automatically fallback to numbers.}. If you want a | |
1df7defd | 1669 | list to start with a different value (e.g., 20), start the text of the item |
ce57c2fe BG |
1670 | with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie |
1671 | must be put @emph{before} the checkbox. If you have activated alphabetical | |
1672 | lists, you can also use counters like @code{[@@b]}.}. Those constructs can | |
1673 | be used in any item of the list in order to enforce a particular numbering. | |
b349f79f | 1674 | @item |
a351880d | 1675 | @emph{Description} list items are unordered list items, and contain the |
ce57c2fe | 1676 | separator @samp{ :: } to distinguish the description @emph{term} from the |
a50253cc | 1677 | description. |
b349f79f CD |
1678 | @end itemize |
1679 | ||
1680 | Items belonging to the same list must have the same indentation on the first | |
1681 | line. In particular, if an ordered list reaches number @samp{10.}, then the | |
1682 | 2--digit numbers must be written left-aligned with the other numbers in the | |
ce57c2fe BG |
1683 | list. An item ends before the next line that is less or equally indented |
1684 | than its bullet/number. | |
afe98dfa | 1685 | |
271672fa | 1686 | @vindex org-list-empty-line-terminates-plain-lists |
153ae947 BG |
1687 | A list ends whenever every item has ended, which means before any line less |
1688 | or equally indented than items at top level. It also ends before two blank | |
271672fa BG |
1689 | lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}. |
1690 | In that case, all items are closed. Here is an example: | |
4009494e GM |
1691 | |
1692 | @example | |
1693 | @group | |
1694 | ** Lord of the Rings | |
1695 | My favorite scenes are (in this order) | |
1696 | 1. The attack of the Rohirrim | |
a50253cc | 1697 | 2. Eowyn's fight with the witch king |
4009494e GM |
1698 | + this was already my favorite scene in the book |
1699 | + I really like Miranda Otto. | |
1700 | 3. Peter Jackson being shot by Legolas | |
afe98dfa | 1701 | - on DVD only |
ce57c2fe | 1702 | He makes a really funny face when it happens. |
a50253cc | 1703 | But in the end, no individual scenes matter but the film as a whole. |
b349f79f | 1704 | Important actors in this film are: |
a50253cc | 1705 | - @b{Elijah Wood} :: He plays Frodo |
ac20fddf | 1706 | - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember |
c8d0cf5c | 1707 | him very well from his role as Mikey Walsh in @i{The Goonies}. |
4009494e GM |
1708 | @end group |
1709 | @end example | |
1710 | ||
c8d0cf5c CD |
1711 | Org supports these lists by tuning filling and wrapping commands to deal with |
1712 | them correctly@footnote{Org only changes the filling settings for Emacs. For | |
1713 | XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on, | |
1714 | put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them | |
1715 | properly (@pxref{Exporting}). Since indentation is what governs the | |
1716 | structure of these lists, many structural constructs like @code{#+BEGIN_...} | |
ce57c2fe | 1717 | blocks can be indented to signal that they belong to a particular item. |
4009494e | 1718 | |
86fbb8ca | 1719 | @vindex org-list-demote-modify-bullet |
ce57c2fe | 1720 | @vindex org-list-indent-offset |
86fbb8ca CD |
1721 | If you find that using a different bullet for a sub-list (than that used for |
1722 | the current list-level) improves readability, customize the variable | |
ce57c2fe BG |
1723 | @code{org-list-demote-modify-bullet}. To get a greater difference of |
1724 | indentation between items and theirs sub-items, customize | |
1725 | @code{org-list-indent-offset}. | |
86fbb8ca | 1726 | |
afe98dfa CD |
1727 | @vindex org-list-automatic-rules |
1728 | The following commands act on items when the cursor is in the first line of | |
1729 | an item (the line with the bullet or number). Some of them imply the | |
acedf35c | 1730 | application of automatic rules to keep list structure intact. If some of |
afe98dfa CD |
1731 | these actions get in your way, configure @code{org-list-automatic-rules} |
1732 | to disable them individually. | |
4009494e | 1733 | |
afe98dfa CD |
1734 | @table @asis |
1735 | @orgcmd{@key{TAB},org-cycle} | |
e66ba1df | 1736 | @cindex cycling, in plain lists |
c8d0cf5c CD |
1737 | @vindex org-cycle-include-plain-lists |
1738 | Items can be folded just like headline levels. Normally this works only if | |
1739 | the cursor is on a plain list item. For more details, see the variable | |
acedf35c CD |
1740 | @code{org-cycle-include-plain-lists}. If this variable is set to |
1741 | @code{integrate}, plain list items will be treated like low-level | |
e66ba1df BG |
1742 | headlines. The level of an item is then given by the indentation of the |
1743 | bullet/number. Items are always subordinate to real headlines, however; the | |
1744 | hierarchies remain completely separated. In a new item with no text yet, the | |
1745 | first @key{TAB} demotes the item to become a child of the previous | |
1746 | one. Subsequent @key{TAB}s move the item to meaningful levels in the list | |
1747 | and eventually get it back to its initial position. | |
afe98dfa | 1748 | @orgcmd{M-@key{RET},org-insert-heading} |
c8d0cf5c | 1749 | @vindex org-M-RET-may-split-line |
afe98dfa | 1750 | @vindex org-list-automatic-rules |
a7808fba CD |
1751 | Insert new item at current level. With a prefix argument, force a new |
1752 | heading (@pxref{Structure editing}). If this command is used in the middle | |
ce57c2fe BG |
1753 | of an item, that item is @emph{split} in two, and the second part becomes the |
1754 | new item@footnote{If you do not want the item to be split, customize the | |
1755 | variable @code{org-M-RET-may-split-line}.}. If this command is executed | |
1756 | @emph{before item's body}, the new item is created @emph{before} the current | |
1757 | one. | |
e66ba1df BG |
1758 | @end table |
1759 | ||
1760 | @table @kbd | |
4009494e | 1761 | @kindex M-S-@key{RET} |
271672fa | 1762 | @item M-S-@key{RET} |
4009494e | 1763 | Insert a new item with a checkbox (@pxref{Checkboxes}). |
4009494e | 1764 | @kindex S-@key{down} |
e66ba1df BG |
1765 | @item S-up |
1766 | @itemx S-down | |
3da3282e | 1767 | @cindex shift-selection-mode |
c8d0cf5c | 1768 | @vindex org-support-shift-select |
ce57c2fe BG |
1769 | @vindex org-list-use-circular-motion |
1770 | Jump to the previous/next item in the current list@footnote{If you want to | |
1771 | cycle around items that way, you may customize | |
1772 | @code{org-list-use-circular-motion}.}, but only if | |
3da3282e CD |
1773 | @code{org-support-shift-select} is off. If not, you can still use paragraph |
1774 | jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite | |
1775 | similar effect. | |
ce57c2fe BG |
1776 | @kindex M-@key{up} |
1777 | @kindex M-@key{down} | |
e66ba1df BG |
1778 | @item M-up |
1779 | @itemx M-down | |
ce57c2fe | 1780 | Move the item including subitems up/down@footnote{See |
271672fa | 1781 | @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with |
ce57c2fe BG |
1782 | previous/next item of same indentation). If the list is ordered, renumbering |
1783 | is automatic. | |
86fbb8ca CD |
1784 | @kindex M-@key{left} |
1785 | @kindex M-@key{right} | |
e66ba1df BG |
1786 | @item M-left |
1787 | @itemx M-right | |
86fbb8ca | 1788 | Decrease/increase the indentation of an item, leaving children alone. |
4009494e GM |
1789 | @kindex M-S-@key{left} |
1790 | @kindex M-S-@key{right} | |
271672fa BG |
1791 | @item M-S-@key{left} |
1792 | @itemx M-S-@key{right} | |
4009494e | 1793 | Decrease/increase the indentation of the item, including subitems. |
afe98dfa CD |
1794 | Initially, the item tree is selected based on current indentation. When |
1795 | these commands are executed several times in direct succession, the initially | |
1796 | selected region is used, even if the new indentation would imply a different | |
1797 | hierarchy. To use the new hierarchy, break the command chain with a cursor | |
1798 | motion or so. | |
1799 | ||
1800 | As a special case, using this command on the very first item of a list will | |
1801 | move the whole list. This behavior can be disabled by configuring | |
1802 | @code{org-list-automatic-rules}. The global indentation of a list has no | |
1803 | influence on the text @emph{after} the list. | |
4009494e GM |
1804 | @kindex C-c C-c |
1805 | @item C-c C-c | |
1806 | If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the | |
ce57c2fe BG |
1807 | state of the checkbox. In any case, verify bullets and indentation |
1808 | consistency in the whole list. | |
4009494e | 1809 | @kindex C-c - |
afe98dfa | 1810 | @vindex org-plain-list-ordered-item-terminator |
4009494e | 1811 | @item C-c - |
a7808fba | 1812 | Cycle the entire list level through the different itemize/enumerate bullets |
afe98dfa CD |
1813 | (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them, |
1814 | depending on @code{org-plain-list-ordered-item-terminator}, the type of list, | |
8223b1d2 BG |
1815 | and its indentation. With a numeric prefix argument N, select the Nth bullet |
1816 | from this list. If there is an active region when calling this, selected | |
1817 | text will be changed into an item. With a prefix argument, all lines will be | |
1818 | converted to list items. If the first line already was a list item, any item | |
1819 | marker will be removed from the list. Finally, even without an active | |
1820 | region, a normal line will be converted into a list item. | |
c8d0cf5c CD |
1821 | @kindex C-c * |
1822 | @item C-c * | |
1823 | Turn a plain list item into a headline (so that it becomes a subheading at | |
ce57c2fe BG |
1824 | its location). @xref{Structure editing}, for a detailed explanation. |
1825 | @kindex C-c C-* | |
1826 | @item C-c C-* | |
1827 | Turn the whole plain list into a subtree of the current heading. Checkboxes | |
1828 | (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked | |
1829 | (resp. checked). | |
64fb801f CD |
1830 | @kindex S-@key{left} |
1831 | @kindex S-@key{right} | |
e66ba1df | 1832 | @item S-left/right |
c8d0cf5c | 1833 | @vindex org-support-shift-select |
3da3282e CD |
1834 | This command also cycles bullet styles when the cursor in on the bullet or |
1835 | anywhere in an item line, details depending on | |
1836 | @code{org-support-shift-select}. | |
c8d0cf5c | 1837 | @kindex C-c ^ |
271672fa | 1838 | @cindex sorting, of plain list |
c8d0cf5c CD |
1839 | @item C-c ^ |
1840 | Sort the plain list. You will be prompted for the sorting method: | |
271672fa BG |
1841 | numerically, alphabetically, by time, by checked status for check lists, |
1842 | or by a custom function. | |
4009494e GM |
1843 | @end table |
1844 | ||
c8d0cf5c | 1845 | @node Drawers, Blocks, Plain lists, Document Structure |
4009494e GM |
1846 | @section Drawers |
1847 | @cindex drawers | |
c8d0cf5c | 1848 | @cindex #+DRAWERS |
4009494e GM |
1849 | @cindex visibility cycling, drawers |
1850 | ||
c8d0cf5c | 1851 | @vindex org-drawers |
8223b1d2 BG |
1852 | @cindex org-insert-drawer |
1853 | @kindex C-c C-x d | |
4009494e | 1854 | Sometimes you want to keep information associated with an entry, but you |
e66ba1df | 1855 | normally don't want to see it. For this, Org mode has @emph{drawers}. |
271672fa BG |
1856 | Drawers need to be configured with the option @code{org-drawers}@footnote{You |
1857 | can define additional drawers on a per-file basis with a line like | |
1858 | @code{#+DRAWERS: HIDDEN STATE}}. Drawers look like this: | |
4009494e GM |
1859 | |
1860 | @example | |
1861 | ** This is a headline | |
1862 | Still outside the drawer | |
1863 | :DRAWERNAME: | |
ce57c2fe | 1864 | This is inside the drawer. |
4009494e GM |
1865 | :END: |
1866 | After the drawer. | |
1867 | @end example | |
1868 | ||
8223b1d2 BG |
1869 | You can interactively insert drawers at point by calling |
1870 | @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active | |
1871 | region, this command will put the region inside the drawer. With a prefix | |
1872 | argument, this command calls @code{org-insert-property-drawer} and add a | |
1873 | property drawer right below the current headline. Completion over drawer | |
1874 | keywords is also possible using @key{M-TAB}. | |
1875 | ||
c8d0cf5c CD |
1876 | Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and |
1877 | show the entry, but keep the drawer collapsed to a single line. In order to | |
1878 | look inside the drawer, you need to move the cursor to the drawer line and | |
e66ba1df | 1879 | press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for |
c8d0cf5c CD |
1880 | storing properties (@pxref{Properties and Columns}), and you can also arrange |
1881 | for state change notes (@pxref{Tracking TODO state changes}) and clock times | |
ed21c5c8 | 1882 | (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you |
acedf35c | 1883 | want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use |
ed21c5c8 CD |
1884 | |
1885 | @table @kbd | |
1886 | @kindex C-c C-z | |
1887 | @item C-c C-z | |
1888 | Add a time-stamped note to the LOGBOOK drawer. | |
1889 | @end table | |
c8d0cf5c | 1890 | |
271672fa BG |
1891 | @vindex org-export-with-drawers |
1892 | You can select the name of the drawers which should be exported with | |
1893 | @code{org-export-with-drawers}. In that case, drawer contents will appear in | |
1894 | export output. Property drawers are not affected by this variable and are | |
1895 | never exported. | |
1896 | ||
c8d0cf5c CD |
1897 | @node Blocks, Footnotes, Drawers, Document Structure |
1898 | @section Blocks | |
1899 | ||
1900 | @vindex org-hide-block-startup | |
1901 | @cindex blocks, folding | |
e66ba1df | 1902 | Org mode uses begin...end blocks for various purposes from including source |
c8d0cf5c CD |
1903 | code examples (@pxref{Literal examples}) to capturing time logging |
1904 | information (@pxref{Clocking work time}). These blocks can be folded and | |
1905 | unfolded by pressing TAB in the begin line. You can also get all blocks | |
271672fa | 1906 | folded at startup by configuring the option @code{org-hide-block-startup} |
c8d0cf5c | 1907 | or on a per-file basis by using |
4009494e | 1908 | |
c8d0cf5c CD |
1909 | @cindex @code{hideblocks}, STARTUP keyword |
1910 | @cindex @code{nohideblocks}, STARTUP keyword | |
1911 | @example | |
1912 | #+STARTUP: hideblocks | |
1913 | #+STARTUP: nohideblocks | |
1914 | @end example | |
1915 | ||
1916 | @node Footnotes, Orgstruct mode, Blocks, Document Structure | |
55e0839d CD |
1917 | @section Footnotes |
1918 | @cindex footnotes | |
1919 | ||
e66ba1df | 1920 | Org mode supports the creation of footnotes. In contrast to the |
271672fa BG |
1921 | @file{footnote.el} package, Org mode's footnotes are designed for work on |
1922 | a larger document, not only for one-off documents like emails. | |
1923 | ||
1924 | A footnote is started by a footnote marker in square brackets in column 0, no | |
1925 | indentation allowed. It ends at the next footnote definition, headline, or | |
1926 | after two consecutive empty lines. The footnote reference is simply the | |
1927 | marker in square brackets, inside text. For example: | |
55e0839d CD |
1928 | |
1929 | @example | |
1930 | The Org homepage[fn:1] now looks a lot better than it used to. | |
1931 | ... | |
1932 | [fn:1] The link is: http://orgmode.org | |
1933 | @end example | |
1934 | ||
e66ba1df | 1935 | Org mode extends the number-based syntax to @emph{named} footnotes and |
55e0839d CD |
1936 | optional inline definition. Using plain numbers as markers (as |
1937 | @file{footnote.el} does) is supported for backward compatibility, but not | |
acedf35c | 1938 | encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded |
e66ba1df | 1939 | @LaTeX{}}). Here are the valid references: |
55e0839d CD |
1940 | |
1941 | @table @code | |
1942 | @item [1] | |
c8d0cf5c | 1943 | A plain numeric footnote marker. Compatible with @file{footnote.el}, but not |
86fbb8ca | 1944 | recommended because something like @samp{[1]} could easily be part of a code |
c8d0cf5c | 1945 | snippet. |
55e0839d CD |
1946 | @item [fn:name] |
1947 | A named footnote reference, where @code{name} is a unique label word, or, for | |
1948 | simplicity of automatic creation, a number. | |
1949 | @item [fn:: This is the inline definition of this footnote] | |
acedf35c | 1950 | A @LaTeX{}-like anonymous footnote where the definition is given directly at the |
55e0839d CD |
1951 | reference point. |
1952 | @item [fn:name: a definition] | |
1953 | An inline definition of a footnote, which also specifies a name for the note. | |
867d4bb3 | 1954 | Since Org allows multiple references to the same note, you can then use |
55e0839d CD |
1955 | @code{[fn:name]} to create additional references. |
1956 | @end table | |
1957 | ||
c8d0cf5c CD |
1958 | @vindex org-footnote-auto-label |
1959 | Footnote labels can be created automatically, or you can create names yourself. | |
55e0839d | 1960 | This is handled by the variable @code{org-footnote-auto-label} and its |
acedf35c | 1961 | corresponding @code{#+STARTUP} keywords. See the docstring of that variable |
55e0839d CD |
1962 | for details. |
1963 | ||
1964 | @noindent The following command handles footnotes: | |
1965 | ||
1966 | @table @kbd | |
1967 | @kindex C-c C-x f | |
1968 | @item C-c C-x f | |
1969 | The footnote action command. | |
1970 | ||
1971 | When the cursor is on a footnote reference, jump to the definition. When it | |
1972 | is at a definition, jump to the (first) reference. | |
1973 | ||
c8d0cf5c CD |
1974 | @vindex org-footnote-define-inline |
1975 | @vindex org-footnote-section | |
1976 | @vindex org-footnote-auto-adjust | |
271672fa | 1977 | Otherwise, create a new footnote. Depending on the option |
55e0839d CD |
1978 | @code{org-footnote-define-inline}@footnote{The corresponding in-buffer |
1979 | setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the | |
1980 | definition will be placed right into the text as part of the reference, or | |
271672fa | 1981 | separately into the location determined by the option |
55e0839d CD |
1982 | @code{org-footnote-section}. |
1983 | ||
1984 | When this command is called with a prefix argument, a menu of additional | |
1985 | options is offered: | |
1986 | @example | |
1987 | s @r{Sort the footnote definitions by reference sequence. During editing,} | |
1988 | @r{Org makes no effort to sort footnote definitions into a particular} | |
1989 | @r{sequence. If you want them sorted, use this command, which will} | |
c8d0cf5c CD |
1990 | @r{also move entries according to @code{org-footnote-section}. Automatic} |
1991 | @r{sorting after each insertion/deletion can be configured using the} | |
271672fa | 1992 | @r{option @code{org-footnote-auto-adjust}.} |
c8d0cf5c | 1993 | r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering} |
271672fa | 1994 | @r{after each insertion/deletion can be configured using the option} |
c8d0cf5c CD |
1995 | @r{@code{org-footnote-auto-adjust}.} |
1996 | S @r{Short for first @code{r}, then @code{s} action.} | |
55e0839d CD |
1997 | n @r{Normalize the footnotes by collecting all definitions (including} |
1998 | @r{inline definitions) into a special section, and then numbering them} | |
1999 | @r{in sequence. The references will then also be numbers. This is} | |
1df7defd | 2000 | @r{meant to be the final step before finishing a document (e.g., sending} |
271672fa | 2001 | @r{off an email).} |
55e0839d CD |
2002 | d @r{Delete the footnote at point, and all definitions of and references} |
2003 | @r{to it.} | |
2004 | @end example | |
c8d0cf5c CD |
2005 | Depending on the variable @code{org-footnote-auto-adjust}@footnote{the |
2006 | corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.}, | |
2007 | renumbering and sorting footnotes can be automatic after each insertion or | |
2008 | deletion. | |
2009 | ||
55e0839d CD |
2010 | @kindex C-c C-c |
2011 | @item C-c C-c | |
2012 | If the cursor is on a footnote reference, jump to the definition. If it is a | |
2013 | the definition, jump back to the reference. When called at a footnote | |
2014 | location with a prefix argument, offer the same menu as @kbd{C-c C-x f}. | |
2015 | @kindex C-c C-o | |
2016 | @kindex mouse-1 | |
2017 | @kindex mouse-2 | |
c8d0cf5c | 2018 | @item C-c C-o @r{or} mouse-1/2 |
55e0839d CD |
2019 | Footnote labels are also links to the corresponding definition/reference, and |
2020 | you can use the usual commands to follow these links. | |
2021 | @end table | |
2022 | ||
271672fa | 2023 | @node Orgstruct mode, Org syntax, Footnotes, Document Structure |
4009494e | 2024 | @section The Orgstruct minor mode |
a7808fba | 2025 | @cindex Orgstruct mode |
4009494e GM |
2026 | @cindex minor mode for structure editing |
2027 | ||
e66ba1df | 2028 | If you like the intuitive way the Org mode structure editing and list |
c8d0cf5c CD |
2029 | formatting works, you might want to use these commands in other modes like |
2030 | Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes | |
271672fa | 2031 | this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or |
ce57c2fe | 2032 | turn it on by default, for example in Message mode, with one of: |
4009494e GM |
2033 | |
2034 | @lisp | |
ce57c2fe BG |
2035 | (add-hook 'message-mode-hook 'turn-on-orgstruct) |
2036 | (add-hook 'message-mode-hook 'turn-on-orgstruct++) | |
4009494e GM |
2037 | @end lisp |
2038 | ||
c8d0cf5c CD |
2039 | When this mode is active and the cursor is on a line that looks to Org like a |
2040 | headline or the first line of a list item, most structure editing commands | |
2041 | will work, even if the same keys normally have different functionality in the | |
2042 | major mode you are using. If the cursor is not in one of those special | |
271672fa BG |
2043 | lines, Orgstruct mode lurks silently in the shadows. |
2044 | ||
2045 | When you use @code{orgstruct++-mode}, Org will also export indentation and | |
2046 | autofill settings into that mode, and detect item context after the first | |
2047 | line of an item. | |
2048 | ||
2049 | @vindex orgstruct-heading-prefix-regexp | |
2050 | You can also use Org structure editing to fold and unfold headlines in | |
2051 | @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}: | |
2052 | the regular expression must match the local prefix to use before Org's | |
2053 | headlines. For example, if you set this variable to @code{";; "} in Emacs | |
2054 | Lisp files, you will be able to fold and unfold headlines in Emacs Lisp | |
2055 | commented lines. Some commands like @code{org-demote} are disabled when the | |
2056 | prefix is set, but folding/unfolding will work correctly. | |
2057 | ||
2058 | @node Org syntax, , Orgstruct mode, Document Structure | |
2059 | @section Org syntax | |
2060 | @cindex Org syntax | |
2061 | ||
2062 | A reference document providing a formal description of Org's syntax is | |
2063 | available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on | |
2064 | Worg}, written and maintained by Nicolas Goaziou. It defines Org's core | |
2065 | internal concepts such as @code{headlines}, @code{sections}, @code{affiliated | |
2066 | keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org | |
2067 | file falls into one of the categories above. | |
2068 | ||
2069 | To explore the abstract structure of an Org buffer, run this in a buffer: | |
2070 | ||
2071 | @lisp | |
2072 | M-: (org-element-parse-buffer) RET | |
2073 | @end lisp | |
2074 | ||
2075 | It will output a list containing the buffer's content represented as an | |
2076 | abstract structure. The export engine relies on the information stored in | |
2077 | this list. Most interactive commands (e.g., for structure editing) also | |
2078 | rely on the syntactic meaning of the surrounding context. | |
4009494e | 2079 | |
a7808fba | 2080 | @node Tables, Hyperlinks, Document Structure, Top |
4009494e GM |
2081 | @chapter Tables |
2082 | @cindex tables | |
2083 | @cindex editing tables | |
2084 | ||
a7808fba | 2085 | Org comes with a fast and intuitive table editor. Spreadsheet-like |
acedf35c | 2086 | calculations are supported using the Emacs @file{calc} package |
153ae947 | 2087 | (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}). |
4009494e GM |
2088 | |
2089 | @menu | |
c0468714 GM |
2090 | * Built-in table editor:: Simple tables |
2091 | * Column width and alignment:: Overrule the automatic settings | |
2092 | * Column groups:: Grouping to trigger vertical lines | |
2093 | * Orgtbl mode:: The table editor as minor mode | |
2094 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
2095 | * Org-Plot:: Plotting from org tables | |
4009494e GM |
2096 | @end menu |
2097 | ||
c8d0cf5c | 2098 | @node Built-in table editor, Column width and alignment, Tables, Tables |
4009494e GM |
2099 | @section The built-in table editor |
2100 | @cindex table editor, built-in | |
2101 | ||
1df7defd | 2102 | Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as |
ce57c2fe BG |
2103 | the first non-whitespace character is considered part of a table. @samp{|} |
2104 | is also the column separator@footnote{To insert a vertical bar into a table | |
2105 | field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table | |
2106 | might look like this: | |
4009494e GM |
2107 | |
2108 | @example | |
2109 | | Name | Phone | Age | | |
2110 | |-------+-------+-----| | |
2111 | | Peter | 1234 | 17 | | |
2112 | | Anna | 4321 | 25 | | |
2113 | @end example | |
2114 | ||
2115 | A table is re-aligned automatically each time you press @key{TAB} or | |
2116 | @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
2117 | the next field (@key{RET} to the next row) and creates new table rows | |
2118 | at the end of the table or before horizontal lines. The indentation | |
2119 | of the table is set by the first line. Any line starting with | |
2120 | @samp{|-} is considered as a horizontal separator line and will be | |
2121 | expanded on the next re-align to span the whole table width. So, to | |
2122 | create the above table, you would only type | |
2123 | ||
2124 | @example | |
2125 | |Name|Phone|Age| | |
2126 | |- | |
2127 | @end example | |
2128 | ||
2129 | @noindent and then press @key{TAB} to align the table and start filling in | |
55e0839d CD |
2130 | fields. Even faster would be to type @code{|Name|Phone|Age} followed by |
2131 | @kbd{C-c @key{RET}}. | |
4009494e | 2132 | |
c8d0cf5c CD |
2133 | @vindex org-enable-table-editor |
2134 | @vindex org-table-auto-blank-field | |
a7808fba | 2135 | When typing text into a field, Org treats @key{DEL}, |
4009494e GM |
2136 | @key{Backspace}, and all character keys in a special way, so that |
2137 | inserting and deleting avoids shifting other fields. Also, when | |
2138 | typing @emph{immediately after the cursor was moved into a new field | |
2139 | with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
2140 | field is automatically made blank. If this behavior is too | |
271672fa | 2141 | unpredictable for you, configure the options |
4009494e GM |
2142 | @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. |
2143 | ||
2144 | @table @kbd | |
2145 | @tsubheading{Creation and conversion} | |
afe98dfa | 2146 | @orgcmd{C-c |,org-table-create-or-convert-from-region} |
ce57c2fe | 2147 | Convert the active region to table. If every line contains at least one |
4009494e | 2148 | TAB character, the function assumes that the material is tab separated. |
dbc28aaa | 2149 | If every line contains a comma, comma-separated values (CSV) are assumed. |
4009494e | 2150 | If not, lines are split at whitespace into fields. You can use a prefix |
dbc28aaa CD |
2151 | argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u |
2152 | C-u} forces TAB, and a numeric argument N indicates that at least N | |
a7808fba | 2153 | consecutive spaces, or alternatively a TAB will be the separator. |
28a16a1b | 2154 | @* |
a7808fba | 2155 | If there is no active region, this command creates an empty Org |
ce57c2fe | 2156 | table. But it is easier just to start typing, like |
4009494e GM |
2157 | @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. |
2158 | ||
2159 | @tsubheading{Re-aligning and field motion} | |
acedf35c | 2160 | @orgcmd{C-c C-c,org-table-align} |
271672fa | 2161 | Re-align the table and don't move to another field. |
4009494e | 2162 | @c |
acedf35c | 2163 | @orgcmd{<TAB>,org-table-next-field} |
4009494e GM |
2164 | Re-align the table, move to the next field. Creates a new row if |
2165 | necessary. | |
2166 | @c | |
acedf35c | 2167 | @orgcmd{S-@key{TAB},org-table-previous-field} |
4009494e GM |
2168 | Re-align, move to previous field. |
2169 | @c | |
acedf35c | 2170 | @orgcmd{@key{RET},org-table-next-row} |
4009494e GM |
2171 | Re-align the table and move down to next row. Creates a new row if |
2172 | necessary. At the beginning or end of a line, @key{RET} still does | |
2173 | NEWLINE, so it can be used to split a table. | |
c8d0cf5c | 2174 | @c |
acedf35c | 2175 | @orgcmd{M-a,org-table-beginning-of-field} |
c8d0cf5c | 2176 | Move to beginning of the current table field, or on to the previous field. |
acedf35c | 2177 | @orgcmd{M-e,org-table-end-of-field} |
c8d0cf5c | 2178 | Move to end of the current table field, or on to the next field. |
4009494e GM |
2179 | |
2180 | @tsubheading{Column and row editing} | |
acedf35c | 2181 | @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right} |
4009494e GM |
2182 | Move the current column left/right. |
2183 | @c | |
acedf35c | 2184 | @orgcmd{M-S-@key{left},org-table-delete-column} |
4009494e GM |
2185 | Kill the current column. |
2186 | @c | |
acedf35c | 2187 | @orgcmd{M-S-@key{right},org-table-insert-column} |
4009494e GM |
2188 | Insert a new column to the left of the cursor position. |
2189 | @c | |
acedf35c | 2190 | @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down} |
4009494e GM |
2191 | Move the current row up/down. |
2192 | @c | |
acedf35c | 2193 | @orgcmd{M-S-@key{up},org-table-kill-row} |
4009494e GM |
2194 | Kill the current row or horizontal line. |
2195 | @c | |
acedf35c | 2196 | @orgcmd{M-S-@key{down},org-table-insert-row} |
a7808fba CD |
2197 | Insert a new row above the current row. With a prefix argument, the line is |
2198 | created below the current one. | |
4009494e | 2199 | @c |
acedf35c | 2200 | @orgcmd{C-c -,org-table-insert-hline} |
2096a1b6 | 2201 | Insert a horizontal line below current row. With a prefix argument, the line |
4009494e GM |
2202 | is created above the current line. |
2203 | @c | |
acedf35c | 2204 | @orgcmd{C-c @key{RET},org-table-hline-and-move} |
2096a1b6 | 2205 | Insert a horizontal line below current row, and move the cursor into the row |
55e0839d CD |
2206 | below that line. |
2207 | @c | |
acedf35c | 2208 | @orgcmd{C-c ^,org-table-sort-lines} |
4009494e GM |
2209 | Sort the table lines in the region. The position of point indicates the |
2210 | column to be used for sorting, and the range of lines is the range | |
2211 | between the nearest horizontal separator lines, or the entire table. If | |
2212 | point is before the first column, you will be prompted for the sorting | |
2213 | column. If there is an active region, the mark specifies the first line | |
2214 | and the sorting column, while point should be in the last line to be | |
2215 | included into the sorting. The command prompts for the sorting type | |
2216 | (alphabetically, numerically, or by time). When called with a prefix | |
2217 | argument, alphabetic sorting will be case-sensitive. | |
2218 | ||
2219 | @tsubheading{Regions} | |
acedf35c | 2220 | @orgcmd{C-c C-x M-w,org-table-copy-region} |
c8d0cf5c CD |
2221 | Copy a rectangular region from a table to a special clipboard. Point and |
2222 | mark determine edge fields of the rectangle. If there is no active region, | |
2223 | copy just the current field. The process ignores horizontal separator lines. | |
4009494e | 2224 | @c |
acedf35c | 2225 | @orgcmd{C-c C-x C-w,org-table-cut-region} |
4009494e GM |
2226 | Copy a rectangular region from a table to a special clipboard, and |
2227 | blank all fields in the rectangle. So this is the ``cut'' operation. | |
2228 | @c | |
acedf35c | 2229 | @orgcmd{C-c C-x C-y,org-table-paste-rectangle} |
4009494e | 2230 | Paste a rectangular region into a table. |
864c9740 | 2231 | The upper left corner ends up in the current field. All involved fields |
4009494e GM |
2232 | will be overwritten. If the rectangle does not fit into the present table, |
2233 | the table is enlarged as needed. The process ignores horizontal separator | |
2234 | lines. | |
2235 | @c | |
acedf35c CD |
2236 | @orgcmd{M-@key{RET},org-table-wrap-region} |
2237 | Split the current field at the cursor position and move the rest to the line | |
2238 | below. If there is an active region, and both point and mark are in the same | |
2239 | column, the text in the column is wrapped to minimum width for the given | |
2240 | number of lines. A numeric prefix argument may be used to change the number | |
2241 | of desired lines. If there is no region, but you specify a prefix argument, | |
2242 | the current field is made blank, and the content is appended to the field | |
2243 | above. | |
4009494e GM |
2244 | |
2245 | @tsubheading{Calculations} | |
2246 | @cindex formula, in tables | |
2247 | @cindex calculations, in tables | |
2248 | @cindex region, active | |
2249 | @cindex active region | |
c8d0cf5c | 2250 | @cindex transient mark mode |
acedf35c | 2251 | @orgcmd{C-c +,org-table-sum} |
4009494e GM |
2252 | Sum the numbers in the current column, or in the rectangle defined by |
2253 | the active region. The result is shown in the echo area and can | |
2254 | be inserted with @kbd{C-y}. | |
2255 | @c | |
acedf35c | 2256 | @orgcmd{S-@key{RET},org-table-copy-down} |
c8d0cf5c | 2257 | @vindex org-table-copy-increment |
864c9740 CD |
2258 | When current field is empty, copy from first non-empty field above. When not |
2259 | empty, copy current field down to next row and move cursor along with it. | |
271672fa | 2260 | Depending on the option @code{org-table-copy-increment}, integer field |
864c9740 | 2261 | values will be incremented during copy. Integers that are too large will not |
a50253cc | 2262 | be incremented. Also, a @code{0} prefix argument temporarily disables the |
c8d0cf5c CD |
2263 | increment. This key is also used by shift-selection and related modes |
2264 | (@pxref{Conflicts}). | |
4009494e GM |
2265 | |
2266 | @tsubheading{Miscellaneous} | |
acedf35c | 2267 | @orgcmd{C-c `,org-table-edit-field} |
c8d0cf5c CD |
2268 | Edit the current field in a separate window. This is useful for fields that |
2269 | are not fully visible (@pxref{Column width and alignment}). When called with | |
2270 | a @kbd{C-u} prefix, just make the full field visible, so that it can be | |
ce57c2fe BG |
2271 | edited in place. When called with two @kbd{C-u} prefixes, make the editor |
2272 | window follow the cursor through the table and always show the current | |
2273 | field. The follow mode exits automatically when the cursor leaves the table, | |
2274 | or when you repeat this command with @kbd{C-u C-u C-c `}. | |
4009494e | 2275 | @c |
271672fa | 2276 | @item M-x org-table-import RET |
c8d0cf5c CD |
2277 | Import a file as a table. The table should be TAB or whitespace |
2278 | separated. Use, for example, to import a spreadsheet table or data | |
dbc28aaa CD |
2279 | from a database, because these programs generally can write |
2280 | TAB-separated text files. This command works by inserting the file into | |
2281 | the buffer and then converting the region to a table. Any prefix | |
2282 | argument is passed on to the converter, which uses it to determine the | |
2283 | separator. | |
acedf35c | 2284 | @orgcmd{C-c |,org-table-create-or-convert-from-region} |
a7808fba | 2285 | Tables can also be imported by pasting tabular text into the Org |
4009494e | 2286 | buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
44ce9197 | 2287 | @kbd{C-c |} command (see above under @i{Creation and conversion}). |
4009494e | 2288 | @c |
271672fa | 2289 | @item M-x org-table-export RET |
acedf35c | 2290 | @findex org-table-export |
c8d0cf5c CD |
2291 | @vindex org-table-export-default-format |
2292 | Export the table, by default as a TAB-separated file. Use for data | |
a7808fba | 2293 | exchange with, for example, spreadsheet or database programs. The format |
271672fa | 2294 | used to export the file can be configured in the option |
a7808fba CD |
2295 | @code{org-table-export-default-format}. You may also use properties |
2296 | @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file | |
b349f79f CD |
2297 | name and the format for table export in a subtree. Org supports quite |
2298 | general formats for exported tables. The exporter format is the same as the | |
c8d0cf5c | 2299 | format used by Orgtbl radio tables, see @ref{Translator functions}, for a |
b349f79f | 2300 | detailed description. |
4009494e GM |
2301 | @end table |
2302 | ||
2303 | If you don't like the automatic table editor because it gets in your | |
2304 | way on lines which you would like to start with @samp{|}, you can turn | |
2305 | it off with | |
2306 | ||
2307 | @lisp | |
2308 | (setq org-enable-table-editor nil) | |
2309 | @end lisp | |
2310 | ||
2311 | @noindent Then the only table command that still works is | |
2312 | @kbd{C-c C-c} to do a manual re-align. | |
2313 | ||
c8d0cf5c CD |
2314 | @node Column width and alignment, Column groups, Built-in table editor, Tables |
2315 | @section Column width and alignment | |
4009494e | 2316 | @cindex narrow columns in tables |
c8d0cf5c CD |
2317 | @cindex alignment in tables |
2318 | ||
2319 | The width of columns is automatically determined by the table editor. And | |
2320 | also the alignment of a column is determined automatically from the fraction | |
2321 | of number-like versus non-number fields in the column. | |
4009494e | 2322 | |
ed21c5c8 CD |
2323 | Sometimes a single field or a few fields need to carry more text, leading to |
2324 | inconveniently wide columns. Or maybe you want to make a table with several | |
2325 | columns having a fixed width, regardless of content. To set@footnote{This | |
2326 | feature does not work on XEmacs.} the width of a column, one field anywhere | |
2327 | in the column may contain just the string @samp{<N>} where @samp{N} is an | |
2328 | integer specifying the width of the column in characters. The next re-align | |
2329 | will then set the width of this column to this value. | |
4009494e GM |
2330 | |
2331 | @example | |
2332 | @group | |
2333 | |---+------------------------------| |---+--------| | |
2334 | | | | | | <6> | | |
2335 | | 1 | one | | 1 | one | | |
2336 | | 2 | two | ----\ | 2 | two | | |
2337 | | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
2338 | | 4 | four | | 4 | four | | |
2339 | |---+------------------------------| |---+--------| | |
2340 | @end group | |
2341 | @end example | |
2342 | ||
2343 | @noindent | |
2344 | Fields that are wider become clipped and end in the string @samp{=>}. | |
acedf35c | 2345 | Note that the full text is still in the buffer but is hidden. |
c8d0cf5c | 2346 | To see the full text, hold the mouse over the field---a tool-tip window |
4009494e GM |
2347 | will show the full content. To edit such a field, use the command |
2348 | @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
2349 | open a new window with the full field. Edit it and finish with @kbd{C-c | |
2350 | C-c}. | |
2351 | ||
c8d0cf5c | 2352 | @vindex org-startup-align-all-tables |
4009494e GM |
2353 | When visiting a file containing a table with narrowed columns, the |
2354 | necessary character hiding has not yet happened, and the table needs to | |
2355 | be aligned before it looks nice. Setting the option | |
2356 | @code{org-startup-align-all-tables} will realign all tables in a file | |
2357 | upon visiting, but also slow down startup. You can also set this option | |
2358 | on a per-file basis with: | |
2359 | ||
2360 | @example | |
2361 | #+STARTUP: align | |
2362 | #+STARTUP: noalign | |
2363 | @end example | |
2364 | ||
c8d0cf5c | 2365 | If you would like to overrule the automatic alignment of number-rich columns |
acedf35c | 2366 | to the right and of string-rich column to the left, you can use @samp{<r>}, |
8223b1d2 | 2367 | @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an |
afe98dfa | 2368 | effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may |
271672fa | 2369 | also combine alignment and field width like this: @samp{<r10>}. |
c8d0cf5c | 2370 | |
86fbb8ca CD |
2371 | Lines which only contain these formatting cookies will be removed |
2372 | automatically when exporting the document. | |
2373 | ||
c8d0cf5c | 2374 | @node Column groups, Orgtbl mode, Column width and alignment, Tables |
4009494e GM |
2375 | @section Column groups |
2376 | @cindex grouping columns in tables | |
2377 | ||
a7808fba | 2378 | When Org exports tables, it does so by default without vertical |
4009494e GM |
2379 | lines because that is visually more satisfying in general. Occasionally |
2380 | however, vertical lines can be useful to structure a table into groups | |
2381 | of columns, much like horizontal lines can do for groups of rows. In | |
2382 | order to specify column groups, you can use a special row where the | |
2383 | first field contains only @samp{/}. The further fields can either | |
2384 | contain @samp{<} to indicate that this column should start a group, | |
153ae947 BG |
2385 | @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<} |
2386 | and @samp{>}) to make a column | |
a7808fba | 2387 | a group of its own. Boundaries between column groups will upon export be |
4009494e GM |
2388 | marked with vertical lines. Here is an example: |
2389 | ||
2390 | @example | |
86fbb8ca CD |
2391 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | |
2392 | |---+-----+-----+-----+---------+------------| | |
2393 | | / | < | | > | < | > | | |
2394 | | 1 | 1 | 1 | 1 | 1 | 1 | | |
2395 | | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
2396 | | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
2397 | |---+-----+-----+-----+---------+------------| | |
2398 | #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1))) | |
4009494e GM |
2399 | @end example |
2400 | ||
a7808fba | 2401 | It is also sufficient to just insert the column group starters after |
86fbb8ca | 2402 | every vertical line you would like to have: |
4009494e GM |
2403 | |
2404 | @example | |
2405 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
2406 | |----+-----+-----+-----+---------+------------| | |
2407 | | / | < | | | < | | | |
2408 | @end example | |
2409 | ||
a7808fba | 2410 | @node Orgtbl mode, The spreadsheet, Column groups, Tables |
4009494e | 2411 | @section The Orgtbl minor mode |
a7808fba | 2412 | @cindex Orgtbl mode |
4009494e GM |
2413 | @cindex minor mode for tables |
2414 | ||
a7808fba CD |
2415 | If you like the intuitive way the Org table editor works, you |
2416 | might also want to use it in other modes like Text mode or Mail mode. | |
2417 | The minor mode Orgtbl mode makes this possible. You can always toggle | |
271672fa | 2418 | the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for |
ce57c2fe | 2419 | example in Message mode, use |
4009494e GM |
2420 | |
2421 | @lisp | |
ce57c2fe | 2422 | (add-hook 'message-mode-hook 'turn-on-orgtbl) |
4009494e GM |
2423 | @end lisp |
2424 | ||
2425 | Furthermore, with some special setup, it is possible to maintain tables | |
a7808fba | 2426 | in arbitrary syntax with Orgtbl mode. For example, it is possible to |
acedf35c | 2427 | construct @LaTeX{} tables with the underlying ease and power of |
a7808fba | 2428 | Orgtbl mode, including spreadsheet capabilities. For details, see |
4009494e GM |
2429 | @ref{Tables in arbitrary syntax}. |
2430 | ||
c8d0cf5c | 2431 | @node The spreadsheet, Org-Plot, Orgtbl mode, Tables |
4009494e GM |
2432 | @section The spreadsheet |
2433 | @cindex calculations, in tables | |
2434 | @cindex spreadsheet capabilities | |
2435 | @cindex @file{calc} package | |
2436 | ||
2437 | The table editor makes use of the Emacs @file{calc} package to implement | |
2438 | spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to | |
ed21c5c8 CD |
2439 | derive fields from other fields. While fully featured, Org's implementation |
2440 | is not identical to other spreadsheets. For example, Org knows the concept | |
2441 | of a @emph{column formula} that will be applied to all non-header fields in a | |
2442 | column without having to copy the formula to each relevant field. There is | |
2443 | also a formula debugger, and a formula editor with features for highlighting | |
2444 | fields in the table corresponding to the references at the point in the | |
2445 | formula, moving these references by arrow keys | |
4009494e GM |
2446 | |
2447 | @menu | |
c0468714 GM |
2448 | * References:: How to refer to another field or range |
2449 | * Formula syntax for Calc:: Using Calc to compute stuff | |
2450 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
ce57c2fe BG |
2451 | * Durations and time values:: How to compute durations and time values |
2452 | * Field and range formulas:: Formula for specific (ranges of) fields | |
c0468714 | 2453 | * Column formulas:: Formulas valid for an entire column |
271672fa | 2454 | * Lookup functions:: Lookup functions for searching tables |
4009494e | 2455 | * Editing and debugging formulas:: Fixing formulas |
c0468714 | 2456 | * Updating the table:: Recomputing all dependent fields |
e66ba1df | 2457 | * Advanced features:: Field and column names, parameters and automatic recalc |
4009494e GM |
2458 | @end menu |
2459 | ||
2460 | @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
2461 | @subsection References | |
2462 | @cindex references | |
2463 | ||
2464 | To compute fields in the table from other fields, formulas must | |
a7808fba | 2465 | reference other fields or ranges. In Org, fields can be referenced |
4009494e GM |
2466 | by name, by absolute coordinates, and by relative coordinates. To find |
2467 | out what the coordinates of a field are, press @kbd{C-c ?} in that | |
2468 | field, or press @kbd{C-c @}} to toggle the display of a grid. | |
2469 | ||
2470 | @subsubheading Field references | |
2471 | @cindex field references | |
2472 | @cindex references, to fields | |
2473 | ||
2474 | Formulas can reference the value of another field in two ways. Like in | |
2475 | any other spreadsheet, you may reference fields with a letter/number | |
2476 | combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
ce57c2fe BG |
2477 | @vindex org-table-use-standard-references |
2478 | However, Org prefers@footnote{Org will understand references typed by the | |
2479 | user as @samp{B4}, but it will not use this syntax when offering a formula | |
271672fa BG |
2480 | for editing. You can customize this behavior using the option |
2481 | @code{org-table-use-standard-references}.} to use another, more general | |
ce57c2fe | 2482 | representation that looks like this: |
4009494e | 2483 | @example |
c8d0cf5c | 2484 | @@@var{row}$@var{column} |
4009494e GM |
2485 | @end example |
2486 | ||
ce57c2fe | 2487 | Column specifications can be absolute like @code{$1}, |
1df7defd | 2488 | @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the |
ce57c2fe BG |
2489 | column of the field which is being computed) like @code{$+1} or @code{$-2}. |
2490 | @code{$<} and @code{$>} are immutable references to the first and last | |
2491 | column, respectively, and you can use @code{$>>>} to indicate the third | |
2492 | column from the right. | |
2493 | ||
2494 | The row specification only counts data lines and ignores horizontal separator | |
2495 | lines (hlines). Like with columns, you can use absolute row numbers | |
2496 | @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the | |
2497 | current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are | |
2498 | immutable references the first and last@footnote{For backward compatibility | |
2499 | you can also use special names like @code{$LR5} and @code{$LR12} to refer in | |
2500 | a stable way to the 5th and 12th field in the last row of the table. | |
2501 | However, this syntax is deprecated, it should not be used for new documents. | |
2502 | Use @code{@@>$} instead.} row in the table, respectively. You may also | |
2503 | specify the row relative to one of the hlines: @code{@@I} refers to the first | |
1df7defd | 2504 | hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such |
ce57c2fe BG |
2505 | line above the current line, @code{@@+I} to the first such line below the |
2506 | current line. You can also write @code{@@III+2} which is the second data line | |
2507 | after the third hline in the table. | |
2508 | ||
2509 | @code{@@0} and @code{$0} refer to the current row and column, respectively, | |
1df7defd | 2510 | i.e., to the row/column for the field being computed. Also, if you omit |
ce57c2fe BG |
2511 | either the column or the row part of the reference, the current row/column is |
2512 | implied. | |
4009494e | 2513 | |
a7808fba | 2514 | Org's references with @emph{unsigned} numbers are fixed references |
4009494e GM |
2515 | in the sense that if you use the same reference in the formula for two |
2516 | different fields, the same field will be referenced each time. | |
a7808fba | 2517 | Org's references with @emph{signed} numbers are floating |
4009494e GM |
2518 | references because the same reference operator can reference different |
2519 | fields depending on the field being calculated by the formula. | |
2520 | ||
2521 | Here are a few examples: | |
2522 | ||
2523 | @example | |
ce57c2fe BG |
2524 | @@2$3 @r{2nd row, 3rd column (same as @code{C2})} |
2525 | $5 @r{column 5 in the current row (same as @code{E&})} | |
4009494e GM |
2526 | @@2 @r{current column, row 2} |
2527 | @@-1$-3 @r{the field one row up, three columns to the left} | |
2528 | @@-I$2 @r{field just under hline above current row, column 2} | |
ce57c2fe | 2529 | @@>$5 @r{field in the last row, in column 5} |
4009494e GM |
2530 | @end example |
2531 | ||
2532 | @subsubheading Range references | |
2533 | @cindex range references | |
2534 | @cindex references, to ranges | |
2535 | ||
2536 | You may reference a rectangular range of fields by specifying two field | |
2537 | references connected by two dots @samp{..}. If both fields are in the | |
2538 | current row, you may simply use @samp{$2..$7}, but if at least one field | |
2539 | is in a different row, you need to use the general @code{@@row$column} | |
8a28a5b8 | 2540 | format at least for the first field (i.e the reference must start with |
4009494e GM |
2541 | @samp{@@} in order to be interpreted correctly). Examples: |
2542 | ||
2543 | @example | |
ce57c2fe BG |
2544 | $1..$3 @r{first three fields in the current row} |
2545 | $P..$Q @r{range, using column names (see under Advanced)} | |
2546 | $<<<..$>> @r{start in third column, continue to the one but last} | |
2547 | @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})} | |
271672fa | 2548 | @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left} |
ce57c2fe | 2549 | @@I..II @r{between first and second hline, short for @code{@@I..@@II}} |
4009494e GM |
2550 | @end example |
2551 | ||
2552 | @noindent Range references return a vector of values that can be fed | |
271672fa BG |
2553 | into Calc vector functions. Empty fields in ranges are normally suppressed, |
2554 | so that the vector contains only the non-empty fields. For other options | |
2555 | with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax | |
2556 | for Calc}. | |
4009494e | 2557 | |
ed21c5c8 CD |
2558 | @subsubheading Field coordinates in formulas |
2559 | @cindex field coordinates | |
2560 | @cindex coordinates, of field | |
2561 | @cindex row, of field coordinates | |
2562 | @cindex column, of field coordinates | |
2563 | ||
2564 | For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to | |
2565 | get the row or column number of the field where the formula result goes. | |
2566 | The traditional Lisp formula equivalents are @code{org-table-current-dline} | |
2567 | and @code{org-table-current-column}. Examples: | |
2568 | ||
2569 | @example | |
2570 | if(@@# % 2, $#, string("")) @r{column number on odd lines only} | |
2571 | $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into} | |
2572 | @r{column 3 of the current table} | |
2573 | @end example | |
2574 | ||
2575 | @noindent For the second example, table FOO must have at least as many rows | |
ce57c2fe | 2576 | as the current table. Note that this is inefficient@footnote{The computation time scales as |
ed21c5c8 CD |
2577 | O(N^2) because table FOO is parsed for each field to be copied.} for large |
2578 | number of rows. | |
2579 | ||
4009494e GM |
2580 | @subsubheading Named references |
2581 | @cindex named references | |
2582 | @cindex references, named | |
2583 | @cindex name, of column or field | |
2584 | @cindex constants, in calculations | |
c8d0cf5c | 2585 | @cindex #+CONSTANTS |
4009494e | 2586 | |
c8d0cf5c | 2587 | @vindex org-table-formula-constants |
4009494e | 2588 | @samp{$name} is interpreted as the name of a column, parameter or |
271672fa | 2589 | constant. Constants are defined globally through the option |
4009494e GM |
2590 | @code{org-table-formula-constants}, and locally (for the file) through a |
2591 | line like | |
2592 | ||
2593 | @example | |
2594 | #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
2595 | @end example | |
2596 | ||
2597 | @noindent | |
c8d0cf5c CD |
2598 | @vindex constants-unit-system |
2599 | @pindex constants.el | |
a7808fba | 2600 | Also properties (@pxref{Properties and Columns}) can be used as |
c8d0cf5c | 2601 | constants in table formulas: for a property @samp{:Xyz:} use the name |
dbc28aaa | 2602 | @samp{$PROP_Xyz}, and the property will be searched in the current |
4009494e GM |
2603 | outline entry and in the hierarchy above it. If you have the |
2604 | @file{constants.el} package, it will also be used to resolve constants, | |
2605 | including natural constants like @samp{$h} for Planck's constant, and | |
c8d0cf5c | 2606 | units like @samp{$km} for kilometers@footnote{@file{constants.el} can |
4009494e GM |
2607 | supply the values of constants in two different unit systems, @code{SI} |
2608 | and @code{cgs}. Which one is used depends on the value of the variable | |
2609 | @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
2610 | @code{constSI} and @code{constcgs} to set this value for the current | |
2611 | buffer.}. Column names and parameters can be specified in special table | |
2612 | lines. These are described below, see @ref{Advanced features}. All | |
2613 | names must start with a letter, and further consist of letters and | |
2614 | numbers. | |
2615 | ||
55e0839d CD |
2616 | @subsubheading Remote references |
2617 | @cindex remote references | |
2618 | @cindex references, remote | |
2619 | @cindex references, to a different table | |
2620 | @cindex name, of column or field | |
2621 | @cindex constants, in calculations | |
271672fa | 2622 | @cindex #+NAME, for table |
55e0839d CD |
2623 | |
2624 | You may also reference constants, fields and ranges from a different table, | |
2625 | either in the current file or even in a different file. The syntax is | |
2626 | ||
2627 | @example | |
2628 | remote(NAME-OR-ID,REF) | |
2629 | @end example | |
2630 | ||
2631 | @noindent | |
2632 | where NAME can be the name of a table in the current file as set by a | |
271672fa | 2633 | @code{#+NAME: Name} line before the table. It can also be the ID of an |
55e0839d CD |
2634 | entry, even in a different file, and the reference then refers to the first |
2635 | table in that entry. REF is an absolute field or range reference as | |
c8d0cf5c CD |
2636 | described above for example @code{@@3$3} or @code{$somename}, valid in the |
2637 | referenced table. | |
55e0839d | 2638 | |
4009494e GM |
2639 | @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet |
2640 | @subsection Formula syntax for Calc | |
2641 | @cindex formula syntax, Calc | |
2642 | @cindex syntax, of formulas | |
2643 | ||
271672fa BG |
2644 | A formula can be any algebraic expression understood by the Emacs @file{Calc} |
2645 | package. Note that @file{calc} has the non-standard convention that @samp{/} | |
2646 | has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as | |
2647 | @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc | |
2648 | from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, | |
2649 | GNU Emacs Calc Manual}), variable substitution takes place according to the | |
2650 | rules described above. | |
4009494e | 2651 | @cindex vectors, in table calculations |
a7808fba | 2652 | The range vectors can be directly fed into the Calc vector functions |
4009494e GM |
2653 | like @samp{vmean} and @samp{vsum}. |
2654 | ||
2655 | @cindex format specifier | |
2656 | @cindex mode, for @file{calc} | |
c8d0cf5c | 2657 | @vindex org-calc-default-modes |
4009494e GM |
2658 | A formula can contain an optional mode string after a semicolon. This |
2659 | string consists of flags to influence Calc and other modes during | |
a7808fba | 2660 | execution. By default, Org uses the standard Calc modes (precision |
44ce9197 | 2661 | 12, angular units degrees, fraction and symbolic modes off). The display |
c8d0cf5c | 2662 | format, however, has been changed to @code{(float 8)} to keep tables |
271672fa | 2663 | compact. The default settings can be configured using the option |
4009494e GM |
2664 | @code{org-calc-default-modes}. |
2665 | ||
271672fa BG |
2666 | @noindent List of modes: |
2667 | ||
2668 | @table @asis | |
2669 | @item @code{p20} | |
2670 | Set the internal Calc calculation precision to 20 digits. | |
2671 | @item @code{n3}, @code{s3}, @code{e2}, @code{f4} | |
2672 | Normal, scientific, engineering or fixed format of the result of Calc passed | |
2673 | back to Org. Calc formatting is unlimited in precision as long as the Calc | |
2674 | calculation precision is greater. | |
2675 | @item @code{D}, @code{R} | |
2676 | Degree and radian angle modes of Calc. | |
2677 | @item @code{F}, @code{S} | |
2678 | Fraction and symbolic modes of Calc. | |
2679 | @item @code{T}, @code{t} | |
2680 | Duration computations in Calc or Lisp, @pxref{Durations and time values}. | |
2681 | @item @code{E} | |
2682 | If and how to consider empty fields. Without @samp{E} empty fields in range | |
2683 | references are suppressed so that the Calc vector or Lisp list contains only | |
2684 | the non-empty fields. With @samp{E} the empty fields are kept. For empty | |
2685 | fields in ranges or empty field references the value @samp{nan} (not a | |
2686 | number) is used in Calc formulas and the empty string is used for Lisp | |
2687 | formulas. Add @samp{N} to use 0 instead for both formula types. For the | |
2688 | value of a field the mode @samp{N} has higher precedence than @samp{E}. | |
2689 | @item @code{N} | |
2690 | Interpret all fields as numbers, use 0 for non-numbers. See the next section | |
2691 | to see how this is essential for computations with Lisp formulas. In Calc | |
2692 | formulas it is used only occasionally because there number strings are | |
2693 | already interpreted as numbers without @samp{N}. | |
2694 | @item @code{L} | |
2695 | Literal, for Lisp formulas only. See the next section. | |
2696 | @end table | |
4009494e GM |
2697 | |
2698 | @noindent | |
271672fa BG |
2699 | Unless you use large integer numbers or high-precision-calculation and |
2700 | -display for floating point numbers you may alternatively provide a | |
2701 | @samp{printf} format specifier to reformat the Calc result after it has been | |
ed21c5c8 | 2702 | passed back to Org instead of letting Calc already do the |
271672fa BG |
2703 | formatting@footnote{The @samp{printf} reformatting is limited in precision |
2704 | because the value passed to it is converted into an @samp{integer} or | |
2705 | @samp{double}. The @samp{integer} is limited in size by truncating the | |
2706 | signed value to 32 bits. The @samp{double} is limited in precision to 64 | |
2707 | bits overall which leaves approximately 16 significant decimal digits.}. A | |
2708 | few examples: | |
4009494e GM |
2709 | |
2710 | @example | |
2711 | $1+$2 @r{Sum of first and second field} | |
2712 | $1+$2;%.2f @r{Same, format result to two decimals} | |
2713 | exp($2)+exp($1) @r{Math functions can be used} | |
2714 | $0;%.1f @r{Reformat current cell to 1 decimal} | |
2715 | ($3-32)*5/9 @r{Degrees F -> C conversion} | |
2716 | $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
2717 | tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
2718 | sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
acedf35c | 2719 | taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree} |
4009494e GM |
2720 | @end example |
2721 | ||
271672fa BG |
2722 | Calc also contains a complete set of logical operations, (@pxref{Logical |
2723 | Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example | |
4009494e | 2724 | |
271672fa BG |
2725 | @table @code |
2726 | @item if($1 < 20, teen, string("")) | |
2727 | "teen" if age $1 is less than 20, else the Org table result field is set to | |
2728 | empty with the empty string. | |
2729 | @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E | |
2730 | Sum of the first two columns. When at least one of the input fields is empty | |
2731 | the Org table result field is set to empty. | |
2732 | @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E | |
2733 | Mean value of a range unless there is any empty field. Every field in the | |
2734 | range that is empty is replaced by @samp{nan} which lets @samp{vmean} result | |
2735 | in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from | |
2736 | @samp{vmean} and the Org table result field is set to empty. Use this when | |
2737 | the sample set is expected to never have missing values. | |
2738 | @item if("$1..$7" == "[]", string(""), vmean($1..$7)) | |
2739 | Mean value of a range with empty fields skipped. Every field in the range | |
2740 | that is empty is skipped. When all fields in the range are empty the mean | |
2741 | value is not defined and the Org table result field is set to empty. Use | |
2742 | this when the sample set can have a variable size. | |
2743 | @item vmean($1..$7); EN | |
2744 | To complete the example before: Mean value of a range with empty fields | |
2745 | counting as samples with value 0. Use this only when incomplete sample sets | |
2746 | should be padded with 0 to the full size. | |
2747 | @end table | |
4009494e | 2748 | |
271672fa BG |
2749 | You can add your own Calc functions defined in Emacs Lisp with @code{defmath} |
2750 | and use them in formula syntax for Calc. | |
ce57c2fe BG |
2751 | |
2752 | @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet | |
4009494e GM |
2753 | @subsection Emacs Lisp forms as formulas |
2754 | @cindex Lisp forms, as table formulas | |
2755 | ||
8223b1d2 | 2756 | It is also possible to write a formula in Emacs Lisp. This can be useful |
735135f9 PE |
2757 | for string manipulation and control structures, if Calc's functionality is |
2758 | not enough. | |
8223b1d2 BG |
2759 | |
2760 | If a formula starts with a single-quote followed by an opening parenthesis, | |
2761 | then it is evaluated as a Lisp form. The evaluation should return either a | |
2762 | string or a number. Just as with @file{calc} formulas, you can specify modes | |
735135f9 | 2763 | and a printf format after a semicolon. |
8223b1d2 BG |
2764 | |
2765 | With Emacs Lisp forms, you need to be conscious about the way field | |
2766 | references are interpolated into the form. By default, a reference will be | |
2767 | interpolated as a Lisp string (in double-quotes) containing the field. If | |
2768 | you provide the @samp{N} mode switch, all referenced elements will be numbers | |
2769 | (non-number fields will be zero) and interpolated as Lisp numbers, without | |
2770 | quotes. If you provide the @samp{L} flag, all fields will be interpolated | |
2771 | literally, without quotes. I.e., if you want a reference to be interpreted | |
2772 | as a string by the Lisp form, enclose the reference operator itself in | |
2773 | double-quotes, like @code{"$3"}. Ranges are inserted as space-separated | |
2774 | fields, so you can embed them in list or vector syntax. | |
2775 | ||
2776 | Here are a few examples---note how the @samp{N} mode is used when we do | |
2777 | computations in Lisp: | |
4009494e | 2778 | |
271672fa BG |
2779 | @table @code |
2780 | @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
2781 | Swap the first two characters of the content of column 1. | |
2782 | @item '(+ $1 $2);N | |
2783 | Add columns 1 and 2, equivalent to Calc's @code{$1+$2}. | |
2784 | @item '(apply '+ '($1..$4));N | |
2785 | Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}. | |
2786 | @end table | |
4009494e | 2787 | |
ce57c2fe BG |
2788 | @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet |
2789 | @subsection Durations and time values | |
2790 | @cindex Duration, computing | |
2791 | @cindex Time, computing | |
2792 | @vindex org-table-duration-custom-format | |
2793 | ||
2794 | If you want to compute time values use the @code{T} flag, either in Calc | |
2795 | formulas or Elisp formulas: | |
2796 | ||
2797 | @example | |
2798 | @group | |
2799 | | Task 1 | Task 2 | Total | | |
2800 | |---------+----------+----------| | |
2801 | | 2:12 | 1:47 | 03:59:00 | | |
2802 | | 3:02:20 | -2:07:00 | 0.92 | | |
2803 | #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t | |
2804 | @end group | |
2805 | @end example | |
2806 | ||
2807 | Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds | |
2808 | are optional. With the @code{T} flag, computed durations will be displayed | |
8c8b834f | 2809 | as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag, |
271672fa | 2810 | computed durations will be displayed according to the value of the option |
ce57c2fe BG |
2811 | @code{org-table-duration-custom-format}, which defaults to @code{'hours} and |
2812 | will display the result as a fraction of hours (see the second formula in the | |
2813 | example above). | |
2814 | ||
2815 | Negative duration values can be manipulated as well, and integers will be | |
2816 | considered as seconds in addition and subtraction. | |
2817 | ||
2818 | @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet | |
2819 | @subsection Field and range formulas | |
4009494e | 2820 | @cindex field formula |
ce57c2fe | 2821 | @cindex range formula |
4009494e | 2822 | @cindex formula, for individual table field |
ce57c2fe | 2823 | @cindex formula, for range of fields |
4009494e | 2824 | |
ce57c2fe BG |
2825 | To assign a formula to a particular field, type it directly into the field, |
2826 | preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press | |
2827 | @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field, | |
2828 | the formula will be stored as the formula for this field, evaluated, and the | |
2829 | current field will be replaced with the result. | |
4009494e | 2830 | |
c8d0cf5c | 2831 | @cindex #+TBLFM |
ce57c2fe BG |
2832 | Formulas are stored in a special line starting with @samp{#+TBLFM:} directly |
2833 | below the table. If you type the equation in the 4th field of the 3rd data | |
2834 | line in the table, the formula will look like @samp{@@3$4=$1+$2}. When | |
2835 | inserting/deleting/swapping column and rows with the appropriate commands, | |
2836 | @i{absolute references} (but not relative ones) in stored formulas are | |
2837 | modified in order to still reference the same field. To avoid this from | |
2838 | happening, in particular in range references, anchor ranges at the table | |
2839 | borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines | |
2840 | using the @code{@@I} notation. Automatic adaptation of field references does | |
8223b1d2 | 2841 | of course not happen if you edit the table structure with normal editing |
ce57c2fe BG |
2842 | commands---then you must fix the equations yourself. |
2843 | ||
2844 | Instead of typing an equation into the field, you may also use the following | |
2845 | command | |
4009494e GM |
2846 | |
2847 | @table @kbd | |
acedf35c | 2848 | @orgcmd{C-u C-c =,org-table-eval-formula} |
4009494e | 2849 | Install a new formula for the current field. The command prompts for a |
c8d0cf5c CD |
2850 | formula with default taken from the @samp{#+TBLFM:} line, applies |
2851 | it to the current field, and stores it. | |
4009494e GM |
2852 | @end table |
2853 | ||
ce57c2fe BG |
2854 | The left-hand side of a formula can also be a special expression in order to |
2855 | assign the formula to a number of different fields. There is no keyboard | |
2856 | shortcut to enter such range formulas. To add them, use the formula editor | |
2857 | (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line | |
2858 | directly. | |
2859 | ||
2860 | @table @code | |
2861 | @item $2= | |
2862 | Column formula, valid for the entire column. This is so common that Org | |
2863 | treats these formulas in a special way, see @ref{Column formulas}. | |
2864 | @item @@3= | |
2865 | Row formula, applies to all fields in the specified row. @code{@@>=} means | |
2866 | the last row. | |
2867 | @item @@1$2..@@4$3= | |
2868 | Range formula, applies to all fields in the given rectangular range. This | |
2869 | can also be used to assign a formula to some but not all fields in a row. | |
2870 | @item $name= | |
2871 | Named field, see @ref{Advanced features}. | |
2872 | @end table | |
2873 | ||
271672fa | 2874 | @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet |
4009494e GM |
2875 | @subsection Column formulas |
2876 | @cindex column formula | |
2877 | @cindex formula, for table column | |
2878 | ||
ce57c2fe BG |
2879 | When you assign a formula to a simple column reference like @code{$3=}, the |
2880 | same formula will be used in all fields of that column, with the following | |
2881 | very convenient exceptions: (i) If the table contains horizontal separator | |
271672fa BG |
2882 | hlines with rows above and below, everything before the first such hline is |
2883 | considered part of the table @emph{header} and will not be modified by column | |
2884 | formulas. Therefore a header is mandatory when you use column formulas and | |
2885 | want to add hlines to group rows, like for example to separate a total row at | |
2886 | the bottom from the summand rows above. (ii) Fields that already get a value | |
2887 | from a field/range formula will be left alone by column formulas. These | |
2888 | conditions make column formulas very easy to use. | |
4009494e GM |
2889 | |
2890 | To assign a formula to a column, type it directly into any field in the | |
2891 | column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
c8d0cf5c CD |
2892 | @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field, |
2893 | the formula will be stored as the formula for the current column, evaluated | |
2894 | and the current field replaced with the result. If the field contains only | |
2895 | @samp{=}, the previously stored formula for this column is used. For each | |
2896 | column, Org will only remember the most recently used formula. In the | |
ce57c2fe BG |
2897 | @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The |
2898 | left-hand side of a column formula can not be the name of column, it must be | |
2899 | the numeric column reference or @code{$>}. | |
4009494e GM |
2900 | |
2901 | Instead of typing an equation into the field, you may also use the | |
2902 | following command: | |
2903 | ||
2904 | @table @kbd | |
acedf35c | 2905 | @orgcmd{C-c =,org-table-eval-formula} |
a7808fba CD |
2906 | Install a new formula for the current column and replace current field with |
2907 | the result of the formula. The command prompts for a formula, with default | |
2908 | taken from the @samp{#+TBLFM} line, applies it to the current field and | |
1df7defd | 2909 | stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command |
4009494e GM |
2910 | will apply it to that many consecutive fields in the current column. |
2911 | @end table | |
2912 | ||
271672fa BG |
2913 | @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet |
2914 | @subsection Lookup functions | |
2915 | @cindex lookup functions in tables | |
2916 | @cindex table lookup functions | |
2917 | ||
2918 | Org has three predefined Emacs Lisp functions for lookups in tables. | |
2919 | @table @code | |
2920 | @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE) | |
2921 | @findex org-lookup-first | |
2922 | Searches for the first element @code{S} in list @code{S-LIST} for which | |
2923 | @lisp | |
2924 | (PREDICATE VAL S) | |
2925 | @end lisp | |
2926 | is @code{t}; returns the value from the corresponding position in list | |
2927 | @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the | |
2928 | parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same | |
2929 | order as the corresponding parameters are in the call to | |
2930 | @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If | |
2931 | @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST} | |
2932 | is returned. | |
2933 | @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE) | |
2934 | @findex org-lookup-last | |
2935 | Similar to @code{org-lookup-first} above, but searches for the @i{last} | |
2936 | element for which @code{PREDICATE} is @code{t}. | |
2937 | @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE) | |
2938 | @findex org-lookup-all | |
2939 | Similar to @code{org-lookup-first}, but searches for @i{all} elements for | |
2940 | which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding | |
2941 | values. This function can not be used by itself in a formula, because it | |
2942 | returns a list of values. However, powerful lookups can be built when this | |
2943 | function is combined with other Emacs Lisp functions. | |
2944 | @end table | |
2945 | ||
2946 | If the ranges used in these functions contain empty fields, the @code{E} mode | |
2947 | for the formula should usually be specified: otherwise empty fields will not be | |
2948 | included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result | |
2949 | in an incorrect mapping from an element of @code{S-LIST} to the corresponding | |
2950 | element of @code{R-LIST}. | |
2951 | ||
2952 | These three functions can be used to implement associative arrays, count | |
2953 | matching cells, rank results, group data etc. For practical examples | |
2954 | see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this | |
2955 | tutorial on Worg}. | |
2956 | ||
2957 | @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet | |
a7808fba | 2958 | @subsection Editing and debugging formulas |
4009494e GM |
2959 | @cindex formula editing |
2960 | @cindex editing, of table formulas | |
2961 | ||
c8d0cf5c | 2962 | @vindex org-table-use-standard-references |
271672fa BG |
2963 | You can edit individual formulas in the minibuffer or directly in the field. |
2964 | Org can also prepare a special buffer with all active formulas of a table. | |
2965 | When offering a formula for editing, Org converts references to the standard | |
2966 | format (like @code{B3} or @code{D&}) if possible. If you prefer to only work | |
2967 | with the internal format (like @code{@@3$2} or @code{$4}), configure the | |
2968 | option @code{org-table-use-standard-references}. | |
4009494e GM |
2969 | |
2970 | @table @kbd | |
acedf35c | 2971 | @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula} |
4009494e | 2972 | Edit the formula associated with the current column/field in the |
ce57c2fe | 2973 | minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}. |
acedf35c | 2974 | @orgcmd{C-u C-u C-c =,org-table-eval-formula} |
4009494e GM |
2975 | Re-insert the active formula (either a |
2976 | field formula, or a column formula) into the current field, so that you | |
2977 | can edit it directly in the field. The advantage over editing in the | |
2978 | minibuffer is that you can use the command @kbd{C-c ?}. | |
acedf35c | 2979 | @orgcmd{C-c ?,org-table-field-info} |
4009494e GM |
2980 | While editing a formula in a table field, highlight the field(s) |
2981 | referenced by the reference at the cursor position in the formula. | |
2982 | @kindex C-c @} | |
acedf35c | 2983 | @findex org-table-toggle-coordinate-overlays |
4009494e | 2984 | @item C-c @} |
acedf35c CD |
2985 | Toggle the display of row and column numbers for a table, using overlays |
2986 | (@command{org-table-toggle-coordinate-overlays}). These are updated each | |
2987 | time the table is aligned; you can force it with @kbd{C-c C-c}. | |
4009494e | 2988 | @kindex C-c @{ |
acedf35c | 2989 | @findex org-table-toggle-formula-debugger |
4009494e | 2990 | @item C-c @{ |
acedf35c CD |
2991 | Toggle the formula debugger on and off |
2992 | (@command{org-table-toggle-formula-debugger}). See below. | |
2993 | @orgcmd{C-c ',org-table-edit-formulas} | |
4009494e GM |
2994 | Edit all formulas for the current table in a special buffer, where the |
2995 | formulas will be displayed one per line. If the current field has an | |
2996 | active formula, the cursor in the formula editor will mark it. | |
a7808fba | 2997 | While inside the special buffer, Org will automatically highlight |
4009494e GM |
2998 | any field or range reference at the cursor position. You may edit, |
2999 | remove and add formulas, and use the following commands: | |
271672fa | 3000 | |
4009494e | 3001 | @table @kbd |
acedf35c | 3002 | @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish} |
4009494e GM |
3003 | Exit the formula editor and store the modified formulas. With @kbd{C-u} |
3004 | prefix, also apply the new formulas to the entire table. | |
acedf35c | 3005 | @orgcmd{C-c C-q,org-table-fedit-abort} |
4009494e | 3006 | Exit the formula editor without installing changes. |
acedf35c | 3007 | @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type} |
4009494e GM |
3008 | Toggle all references in the formula editor between standard (like |
3009 | @code{B3}) and internal (like @code{@@3$2}). | |
acedf35c | 3010 | @orgcmd{@key{TAB},org-table-fedit-lisp-indent} |
c8d0cf5c CD |
3011 | Pretty-print or indent Lisp formula at point. When in a line containing |
3012 | a Lisp formula, format the formula according to Emacs Lisp rules. | |
4009494e | 3013 | Another @key{TAB} collapses the formula back again. In the open |
c8d0cf5c | 3014 | formula, @key{TAB} re-indents just like in Emacs Lisp mode. |
acedf35c | 3015 | @orgcmd{M-@key{TAB},lisp-complete-symbol} |
c8d0cf5c | 3016 | Complete Lisp symbols, just like in Emacs Lisp mode. |
4009494e GM |
3017 | @kindex S-@key{up} |
3018 | @kindex S-@key{down} | |
3019 | @kindex S-@key{left} | |
3020 | @kindex S-@key{right} | |
acedf35c CD |
3021 | @findex org-table-fedit-ref-up |
3022 | @findex org-table-fedit-ref-down | |
3023 | @findex org-table-fedit-ref-left | |
3024 | @findex org-table-fedit-ref-right | |
4009494e GM |
3025 | @item S-@key{up}/@key{down}/@key{left}/@key{right} |
3026 | Shift the reference at point. For example, if the reference is | |
3027 | @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
c8d0cf5c | 3028 | This also works for relative references and for hline references. |
acedf35c | 3029 | @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down} |
a7808fba | 3030 | Move the test line for column formulas in the Org buffer up and |
4009494e | 3031 | down. |
acedf35c | 3032 | @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up} |
4009494e GM |
3033 | Scroll the window displaying the table. |
3034 | @kindex C-c @} | |
acedf35c | 3035 | @findex org-table-toggle-coordinate-overlays |
4009494e GM |
3036 | @item C-c @} |
3037 | Turn the coordinate grid in the table on and off. | |
3038 | @end table | |
3039 | @end table | |
3040 | ||
3041 | Making a table field blank does not remove the formula associated with | |
c8d0cf5c CD |
3042 | the field, because that is stored in a different line (the @samp{#+TBLFM} |
3043 | line)---during the next recalculation the field will be filled again. | |
4009494e GM |
3044 | To remove a formula from a field, you have to give an empty reply when |
3045 | prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
3046 | ||
3047 | @kindex C-c C-c | |
3048 | You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
c8d0cf5c | 3049 | equations with @kbd{C-c C-c} in that line or with the normal |
4009494e GM |
3050 | recalculation commands in the table. |
3051 | ||
271672fa BG |
3052 | @anchor{Using multiple #+TBLFM lines} |
3053 | @subsubheading Using multiple #+TBLFM lines | |
3054 | @cindex #+TBLFM line, multiple | |
3055 | @cindex #+TBLFM | |
3056 | @cindex #+TBLFM, switching | |
3057 | @kindex C-c C-c | |
3058 | ||
3059 | You may apply the formula temporarily. This is useful when you | |
3060 | switch the formula. Place multiple @samp{#+TBLFM} lines right | |
3061 | after the table, and then press @kbd{C-c C-c} on the formula to | |
3062 | apply. Here is an example: | |
3063 | ||
3064 | @example | |
3065 | | x | y | | |
3066 | |---+---| | |
3067 | | 1 | | | |
3068 | | 2 | | | |
3069 | #+TBLFM: $2=$1*1 | |
3070 | #+TBLFM: $2=$1*2 | |
3071 | @end example | |
3072 | ||
3073 | @noindent | |
3074 | Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields: | |
3075 | ||
3076 | @example | |
3077 | | x | y | | |
3078 | |---+---| | |
3079 | | 1 | 2 | | |
3080 | | 2 | 4 | | |
3081 | #+TBLFM: $2=$1*1 | |
3082 | #+TBLFM: $2=$1*2 | |
3083 | @end example | |
3084 | ||
3085 | @noindent | |
3086 | Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you | |
3087 | will get the following result of applying only the first @samp{#+TBLFM} line. | |
3088 | ||
3089 | @example | |
3090 | | x | y | | |
3091 | |---+---| | |
3092 | | 1 | 1 | | |
3093 | | 2 | 2 | | |
3094 | #+TBLFM: $2=$1*1 | |
3095 | #+TBLFM: $2=$1*2 | |
3096 | @end example | |
3097 | ||
4009494e GM |
3098 | @subsubheading Debugging formulas |
3099 | @cindex formula debugging | |
3100 | @cindex debugging, of table formulas | |
3101 | When the evaluation of a formula leads to an error, the field content | |
3102 | becomes the string @samp{#ERROR}. If you would like see what is going | |
3103 | on during variable substitution and calculation in order to find a bug, | |
3104 | turn on formula debugging in the @code{Tbl} menu and repeat the | |
3105 | calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
3106 | field. Detailed information will be displayed. | |
3107 | ||
3108 | @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet | |
a7808fba | 3109 | @subsection Updating the table |
4009494e GM |
3110 | @cindex recomputing table fields |
3111 | @cindex updating, table | |
3112 | ||
3113 | Recalculation of a table is normally not automatic, but needs to be | |
c8d0cf5c CD |
3114 | triggered by a command. See @ref{Advanced features}, for a way to make |
3115 | recalculation at least semi-automatic. | |
4009494e GM |
3116 | |
3117 | In order to recalculate a line of a table or the entire table, use the | |
3118 | following commands: | |
3119 | ||
3120 | @table @kbd | |
acedf35c | 3121 | @orgcmd{C-c *,org-table-recalculate} |
4009494e | 3122 | Recalculate the current row by first applying the stored column formulas |
ce57c2fe | 3123 | from left to right, and all field/range formulas in the current row. |
4009494e GM |
3124 | @c |
3125 | @kindex C-u C-c * | |
3126 | @item C-u C-c * | |
3127 | @kindex C-u C-c C-c | |
3128 | @itemx C-u C-c C-c | |
3129 | Recompute the entire table, line by line. Any lines before the first | |
3130 | hline are left alone, assuming that these are part of the table header. | |
3131 | @c | |
acedf35c | 3132 | @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate} |
4009494e GM |
3133 | Iterate the table by recomputing it until no further changes occur. |
3134 | This may be necessary if some computed fields use the value of other | |
3135 | fields that are computed @i{later} in the calculation sequence. | |
271672fa | 3136 | @item M-x org-table-recalculate-buffer-tables RET |
acedf35c | 3137 | @findex org-table-recalculate-buffer-tables |
86fbb8ca | 3138 | Recompute all tables in the current buffer. |
271672fa | 3139 | @item M-x org-table-iterate-buffer-tables RET |
acedf35c | 3140 | @findex org-table-iterate-buffer-tables |
86fbb8ca CD |
3141 | Iterate all tables in the current buffer, in order to converge table-to-table |
3142 | dependencies. | |
4009494e GM |
3143 | @end table |
3144 | ||
3145 | @node Advanced features, , Updating the table, The spreadsheet | |
3146 | @subsection Advanced features | |
3147 | ||
e66ba1df BG |
3148 | If you want the recalculation of fields to happen automatically, or if you |
3149 | want to be able to assign @i{names}@footnote{Such names must start by an | |
3150 | alphabetic character and use only alphanumeric/underscore characters.} to | |
3151 | fields and columns, you need to reserve the first column of the table for | |
3152 | special marking characters. | |
ce57c2fe | 3153 | |
4009494e | 3154 | @table @kbd |
acedf35c | 3155 | @orgcmd{C-#,org-table-rotate-recalc-marks} |
a351880d | 3156 | Rotate the calculation mark in first column through the states @samp{ }, |
864c9740 CD |
3157 | @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, |
3158 | change all marks in the region. | |
4009494e GM |
3159 | @end table |
3160 | ||
3161 | Here is an example of a table that collects exam results of students and | |
3162 | makes use of these features: | |
3163 | ||
3164 | @example | |
3165 | @group | |
3166 | |---+---------+--------+--------+--------+-------+------| | |
3167 | | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
3168 | |---+---------+--------+--------+--------+-------+------| | |
3169 | | ! | | P1 | P2 | P3 | Tot | | | |
3170 | | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
3171 | | ^ | | m1 | m2 | m3 | mt | | | |
3172 | |---+---------+--------+--------+--------+-------+------| | |
3173 | | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
4009494e GM |
3174 | | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
3175 | |---+---------+--------+--------+--------+-------+------| | |
8223b1d2 | 3176 | | | Average | | | | 25.0 | | |
4009494e GM |
3177 | | ^ | | | | | at | | |
3178 | | $ | max=50 | | | | | | | |
3179 | |---+---------+--------+--------+--------+-------+------| | |
3180 | #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
3181 | @end group | |
3182 | @end example | |
3183 | ||
c8d0cf5c | 3184 | @noindent @b{Important}: please note that for these special tables, |
4009494e GM |
3185 | recalculating the table with @kbd{C-u C-c *} will only affect rows that |
3186 | are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
3187 | to the field itself. The column formulas are not applied in rows with | |
3188 | empty first field. | |
3189 | ||
3190 | @cindex marking characters, tables | |
3191 | The marking characters have the following meaning: | |
271672fa | 3192 | |
4009494e GM |
3193 | @table @samp |
3194 | @item ! | |
3195 | The fields in this line define names for the columns, so that you may | |
3196 | refer to a column as @samp{$Tot} instead of @samp{$6}. | |
3197 | @item ^ | |
3198 | This row defines names for the fields @emph{above} the row. With such | |
3199 | a definition, any formula in the table may use @samp{$m1} to refer to | |
3200 | the value @samp{10}. Also, if you assign a formula to a names field, it | |
3201 | will be stored as @samp{$name=...}. | |
3202 | @item _ | |
3203 | Similar to @samp{^}, but defines names for the fields in the row | |
3204 | @emph{below}. | |
3205 | @item $ | |
3206 | Fields in this row can define @emph{parameters} for formulas. For | |
3207 | example, if a field in a @samp{$} row contains @samp{max=50}, then | |
3208 | formulas in this table can refer to the value 50 using @samp{$max}. | |
3209 | Parameters work exactly like constants, only that they can be defined on | |
3210 | a per-table basis. | |
3211 | @item # | |
3212 | Fields in this row are automatically recalculated when pressing | |
3213 | @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
3214 | is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
3215 | lines will be left alone by this command. | |
3216 | @item * | |
3217 | Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
3218 | not for automatic recalculation. Use this when automatic | |
3219 | recalculation slows down editing too much. | |
7b08ccf7 | 3220 | @item @w{ } |
4009494e GM |
3221 | Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. |
3222 | All lines that should be recalculated should be marked with @samp{#} | |
3223 | or @samp{*}. | |
3224 | @item / | |
3225 | Do not export this line. Useful for lines that contain the narrowing | |
6eb02347 | 3226 | @samp{<N>} markers or column group markers. |
4009494e GM |
3227 | @end table |
3228 | ||
c8d0cf5c CD |
3229 | Finally, just to whet your appetite for what can be done with the |
3230 | fantastic @file{calc.el} package, here is a table that computes the Taylor | |
28a16a1b CD |
3231 | series of degree @code{n} at location @code{x} for a couple of |
3232 | functions. | |
4009494e GM |
3233 | |
3234 | @example | |
3235 | @group | |
3236 | |---+-------------+---+-----+--------------------------------------| | |
3237 | | | Func | n | x | Result | | |
3238 | |---+-------------+---+-----+--------------------------------------| | |
3239 | | # | exp(x) | 1 | x | 1 + x | | |
3240 | | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
3241 | | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
3242 | | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
3243 | | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
3244 | | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
3245 | |---+-------------+---+-----+--------------------------------------| | |
3246 | #+TBLFM: $5=taylor($2,$4,$3);n3 | |
3247 | @end group | |
3248 | @end example | |
3249 | ||
c8d0cf5c CD |
3250 | @node Org-Plot, , The spreadsheet, Tables |
3251 | @section Org-Plot | |
864c9740 | 3252 | @cindex graph, in tables |
86fbb8ca | 3253 | @cindex plot tables using Gnuplot |
c8d0cf5c | 3254 | @cindex #+PLOT |
864c9740 | 3255 | |
c8d0cf5c | 3256 | Org-Plot can produce 2D and 3D graphs of information stored in org tables |
71d35b24 | 3257 | using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode} |
d3517077 BG |
3258 | @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure |
3259 | that you have both Gnuplot and Gnuplot mode installed on your system, then | |
3260 | call @code{org-plot/gnuplot} on the following table. | |
864c9740 CD |
3261 | |
3262 | @example | |
3263 | @group | |
3264 | #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" | |
3265 | | Sede | Max cites | H-index | | |
3266 | |-----------+-----------+---------| | |
3267 | | Chile | 257.72 | 21.39 | | |
3268 | | Leeds | 165.77 | 19.68 | | |
3269 | | Sao Paolo | 71.00 | 11.50 | | |
3270 | | Stockholm | 134.19 | 14.33 | | |
3271 | | Morelia | 257.56 | 17.67 | | |
3272 | @end group | |
3273 | @end example | |
3274 | ||
c8d0cf5c | 3275 | Notice that Org Plot is smart enough to apply the table's headers as labels. |
864c9740 | 3276 | Further control over the labels, type, content, and appearance of plots can |
c8d0cf5c CD |
3277 | be exercised through the @code{#+PLOT:} lines preceding a table. See below |
3278 | for a complete list of Org-plot options. For more information and examples | |
3279 | see the Org-plot tutorial at | |
ce57c2fe | 3280 | @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}. |
864c9740 CD |
3281 | |
3282 | @subsubheading Plot Options | |
3283 | ||
3284 | @table @code | |
3285 | @item set | |
c8d0cf5c | 3286 | Specify any @command{gnuplot} option to be set when graphing. |
864c9740 CD |
3287 | |
3288 | @item title | |
3289 | Specify the title of the plot. | |
3290 | ||
3291 | @item ind | |
3292 | Specify which column of the table to use as the @code{x} axis. | |
3293 | ||
3294 | @item deps | |
c8d0cf5c | 3295 | Specify the columns to graph as a Lisp style list, surrounded by parentheses |
71d35b24 | 3296 | and separated by spaces for example @code{dep:(3 4)} to graph the third and |
c8d0cf5c | 3297 | fourth columns (defaults to graphing all other columns aside from the @code{ind} |
71d35b24 | 3298 | column). |
864c9740 CD |
3299 | |
3300 | @item type | |
3301 | Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. | |
3302 | ||
3303 | @item with | |
3304 | Specify a @code{with} option to be inserted for every col being plotted | |
1df7defd | 3305 | (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). |
223b43fa | 3306 | Defaults to @code{lines}. |
864c9740 CD |
3307 | |
3308 | @item file | |
c8d0cf5c | 3309 | If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}. |
864c9740 CD |
3310 | |
3311 | @item labels | |
acedf35c CD |
3312 | List of labels to be used for the @code{deps} (defaults to the column headers |
3313 | if they exist). | |
864c9740 CD |
3314 | |
3315 | @item line | |
c8d0cf5c | 3316 | Specify an entire line to be inserted in the Gnuplot script. |
864c9740 CD |
3317 | |
3318 | @item map | |
3319 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a | |
3320 | flat mapping rather than a @code{3d} slope. | |
3321 | ||
e45e3595 | 3322 | @item timefmt |
e66ba1df | 3323 | Specify format of Org mode timestamps as they will be parsed by Gnuplot. |
223b43fa | 3324 | Defaults to @samp{%Y-%m-%d-%H:%M:%S}. |
e45e3595 | 3325 | |
864c9740 | 3326 | @item script |
c8d0cf5c CD |
3327 | If you want total control, you can specify a script file (place the file name |
3328 | between double-quotes) which will be used to plot. Before plotting, every | |
864c9740 | 3329 | instance of @code{$datafile} in the specified script will be replaced with |
c8d0cf5c | 3330 | the path to the generated data file. Note: even if you set this option, you |
864c9740 CD |
3331 | may still want to specify the plot type, as that can impact the content of |
3332 | the data file. | |
3333 | @end table | |
3334 | ||
a7808fba | 3335 | @node Hyperlinks, TODO Items, Tables, Top |
4009494e GM |
3336 | @chapter Hyperlinks |
3337 | @cindex hyperlinks | |
3338 | ||
a7808fba | 3339 | Like HTML, Org provides links inside a file, external links to |
dbc28aaa | 3340 | other files, Usenet articles, emails, and much more. |
4009494e GM |
3341 | |
3342 | @menu | |
c0468714 GM |
3343 | * Link format:: How links in Org are formatted |
3344 | * Internal links:: Links to other places in the current file | |
3345 | * External links:: URL-like links to the world | |
3346 | * Handling links:: Creating, inserting and following | |
3347 | * Using links outside Org:: Linking from my C source code? | |
3348 | * Link abbreviations:: Shortcuts for writing complex links | |
3349 | * Search options:: Linking to a specific location | |
3350 | * Custom searches:: When the default search is not enough | |
4009494e GM |
3351 | @end menu |
3352 | ||
3353 | @node Link format, Internal links, Hyperlinks, Hyperlinks | |
3354 | @section Link format | |
3355 | @cindex link format | |
3356 | @cindex format, of links | |
3357 | ||
a7808fba | 3358 | Org will recognize plain URL-like links and activate them as |
4009494e GM |
3359 | clickable links. The general link format, however, looks like this: |
3360 | ||
3361 | @example | |
28a16a1b | 3362 | [[link][description]] @r{or alternatively} [[link]] |
4009494e GM |
3363 | @end example |
3364 | ||
c8d0cf5c | 3365 | @noindent |
a7808fba | 3366 | Once a link in the buffer is complete (all brackets present), Org |
4009494e GM |
3367 | will change the display so that @samp{description} is displayed instead |
3368 | of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
3369 | @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
3370 | which by default is an underlined face. You can directly edit the | |
3371 | visible part of a link. Note that this can be either the @samp{link} | |
3372 | part (if there is no description) or the @samp{description} part. To | |
3373 | edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
3374 | cursor on the link. | |
3375 | ||
3376 | If you place the cursor at the beginning or just behind the end of the | |
3377 | displayed text and press @key{BACKSPACE}, you will remove the | |
3378 | (invisible) bracket at that location. This makes the link incomplete | |
3379 | and the internals are again displayed as plain text. Inserting the | |
3380 | missing bracket hides the link internals again. To show the | |
3381 | internal structure of all links, use the menu entry | |
3382 | @code{Org->Hyperlinks->Literal links}. | |
3383 | ||
3384 | @node Internal links, External links, Link format, Hyperlinks | |
3385 | @section Internal links | |
3386 | @cindex internal links | |
3387 | @cindex links, internal | |
3388 | @cindex targets, for links | |
3389 | ||
c8d0cf5c CD |
3390 | @cindex property, CUSTOM_ID |
3391 | If the link does not look like a URL, it is considered to be internal in the | |
3392 | current file. The most important case is a link like | |
3393 | @samp{[[#my-custom-id]]} which will link to the entry with the | |
271672fa BG |
3394 | @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself |
3395 | to make sure these custom IDs are unique in a file. | |
c8d0cf5c CD |
3396 | |
3397 | Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]} | |
3398 | lead to a text search in the current file. | |
3399 | ||
3400 | The link can be followed with @kbd{C-c C-o} when the cursor is on the link, | |
3401 | or with a mouse click (@pxref{Handling links}). Links to custom IDs will | |
3402 | point to the corresponding headline. The preferred match for a text link is | |
271672fa BG |
3403 | a @i{dedicated target}: the same string in double angular brackets, like |
3404 | @samp{<<My Target>>}. | |
3405 | ||
3406 | @cindex #+NAME | |
3407 | If no dedicated target exists, the link will then try to match the exact name | |
3408 | of an element within the buffer. Naming is done with the @code{#+NAME} | |
3409 | keyword, which has to be put the line before the element it refers to, as in | |
3410 | the following example | |
4009494e GM |
3411 | |
3412 | @example | |
271672fa BG |
3413 | #+NAME: My Target |
3414 | | a | table | | |
3415 | |----+------------| | |
3416 | | of | four cells | | |
4009494e GM |
3417 | @end example |
3418 | ||
271672fa | 3419 | If none of the above succeeds, Org will search for a headline that is exactly |
afe98dfa | 3420 | the link text but may also include a TODO keyword and tags@footnote{To insert |
271672fa BG |
3421 | a link targeting a headline, in-buffer completion can be used. Just type |
3422 | a star followed by a few optional letters into the buffer and press | |
afe98dfa | 3423 | @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as |
271672fa BG |
3424 | completions.}. |
3425 | ||
3426 | During export, internal links will be used to mark objects and assign them | |
3427 | a number. Marked objects will then be referenced by links pointing to them. | |
3428 | In particular, links without a description will appear as the number assigned | |
3429 | to the marked object@footnote{When targeting a @code{#+NAME} keyword, | |
3430 | @code{#+CAPTION} keyword is mandatory in order to get proper numbering | |
3431 | (@pxref{Images and tables}).}. In the following excerpt from an Org buffer | |
3432 | ||
3433 | @example | |
3434 | - one item | |
3435 | - <<target>>another item | |
3436 | Here we refer to item [[target]]. | |
3437 | @end example | |
3438 | ||
3439 | @noindent | |
3440 | The last sentence will appear as @samp{Here we refer to item 2} when | |
3441 | exported. | |
3442 | ||
3443 | In non-Org files, the search will look for the words in the link text. In | |
3444 | the above example the search would be for @samp{my target}. | |
4009494e | 3445 | |
a7808fba | 3446 | Following a link pushes a mark onto Org's own mark ring. You can |
4009494e GM |
3447 | return to the previous position with @kbd{C-c &}. Using this command |
3448 | several times in direct succession goes back to positions recorded | |
3449 | earlier. | |
3450 | ||
3451 | @menu | |
c0468714 | 3452 | * Radio targets:: Make targets trigger links in plain text |
4009494e GM |
3453 | @end menu |
3454 | ||
3455 | @node Radio targets, , Internal links, Internal links | |
3456 | @subsection Radio targets | |
3457 | @cindex radio targets | |
3458 | @cindex targets, radio | |
3459 | @cindex links, radio targets | |
3460 | ||
a7808fba | 3461 | Org can automatically turn any occurrences of certain target names |
4009494e GM |
3462 | in normal text into a link. So without explicitly creating a link, the |
3463 | text connects to the target radioing its position. Radio targets are | |
3464 | enclosed by triple angular brackets. For example, a target @samp{<<<My | |
3465 | Target>>>} causes each occurrence of @samp{my target} in normal text to | |
a7808fba | 3466 | become activated as a link. The Org file is scanned automatically |
4009494e GM |
3467 | for radio targets only when the file is first loaded into Emacs. To |
3468 | update the target list during editing, press @kbd{C-c C-c} with the | |
3469 | cursor on or at a target. | |
3470 | ||
3471 | @node External links, Handling links, Internal links, Hyperlinks | |
3472 | @section External links | |
3473 | @cindex links, external | |
3474 | @cindex external links | |
a7808fba | 3475 | @cindex Gnus links |
4009494e | 3476 | @cindex BBDB links |
28a16a1b | 3477 | @cindex IRC links |
4009494e GM |
3478 | @cindex URL links |
3479 | @cindex file links | |
4009494e | 3480 | @cindex RMAIL links |
4009494e GM |
3481 | @cindex MH-E links |
3482 | @cindex USENET links | |
3483 | @cindex SHELL links | |
3484 | @cindex Info links | |
c8d0cf5c | 3485 | @cindex Elisp links |
4009494e | 3486 | |
271672fa BG |
3487 | Org supports links to files, websites, Usenet and email messages, BBDB |
3488 | database entries and links to both IRC conversations and their logs. | |
3489 | External links are URL-like locators. They start with a short identifying | |
3490 | string followed by a colon. There can be no space after the colon. The | |
3491 | following list shows examples for each link type. | |
4009494e GM |
3492 | |
3493 | @example | |
a7808fba | 3494 | http://www.astro.uva.nl/~dominik @r{on the web} |
86fbb8ca | 3495 | doi:10.1000/182 @r{DOI for an electronic resource} |
4009494e | 3496 | file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
44ce9197 | 3497 | /home/dominik/images/jupiter.jpg @r{same as above} |
4009494e | 3498 | file:papers/last.pdf @r{file, relative path} |
44ce9197 | 3499 | ./papers/last.pdf @r{same as above} |
ed21c5c8 CD |
3500 | file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine} |
3501 | /myself@@some.where:papers/last.pdf @r{same as above} | |
e66ba1df | 3502 | file:sometextfile::NNN @r{file, jump to line number} |
c8d0cf5c | 3503 | file:projects.org @r{another Org file} |
e66ba1df BG |
3504 | file:projects.org::some words @r{text search in Org file}@footnote{ |
3505 | The actual behavior of the search will depend on the value of | |
271672fa BG |
3506 | the option @code{org-link-search-must-match-exact-headline}. If its value |
3507 | is @code{nil}, then a fuzzy text search will be done. If it is t, then only the | |
e66ba1df BG |
3508 | exact headline will be matched. If the value is @code{'query-to-create}, |
3509 | then an exact headline will be searched; if it is not found, then the user | |
3510 | will be queried to create it.} | |
c8d0cf5c | 3511 | file:projects.org::*task title @r{heading search in Org file} |
e66ba1df BG |
3512 | file+sys:/path/to/file @r{open via OS, like double-click} |
3513 | file+emacs:/path/to/file @r{force opening by Emacs} | |
3514 | docview:papers/last.pdf::NNN @r{open in doc-view mode at page} | |
55e0839d | 3515 | id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} |
4009494e | 3516 | news:comp.emacs @r{Usenet link} |
55e0839d | 3517 | mailto:adent@@galaxy.net @r{Mail link} |
4009494e GM |
3518 | mhe:folder @r{MH-E folder link} |
3519 | mhe:folder#id @r{MH-E message link} | |
3520 | rmail:folder @r{RMAIL folder link} | |
3521 | rmail:folder#id @r{RMAIL message link} | |
a7808fba CD |
3522 | gnus:group @r{Gnus group link} |
3523 | gnus:group#id @r{Gnus article link} | |
64fb801f | 3524 | bbdb:R.*Stallman @r{BBDB link (with regexp)} |
28a16a1b | 3525 | irc:/irc.com/#emacs/bob @r{IRC link} |
e66ba1df | 3526 | info:org#External links @r{Info node link} |
4009494e | 3527 | shell:ls *.org @r{A shell command} |
c8d0cf5c | 3528 | elisp:org-agenda @r{Interactive Elisp command} |
64fb801f | 3529 | elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} |
4009494e GM |
3530 | @end example |
3531 | ||
271672fa BG |
3532 | @cindex VM links |
3533 | @cindex WANDERLUST links | |
3534 | On top of these built-in link types, some are available through the | |
3535 | @code{contrib/} directory (@pxref{Installation}). For example, these links | |
3536 | to VM or Wanderlust messages are available when you load the corresponding | |
3537 | libraries from the @code{contrib/} directory: | |
3538 | ||
3539 | @example | |
3540 | vm:folder @r{VM folder link} | |
3541 | vm:folder#id @r{VM message link} | |
3542 | vm://myself@@some.where.org/folder#id @r{VM on remote machine} | |
3543 | vm-imap:account:folder @r{VM IMAP folder link} | |
3544 | vm-imap:account:folder#id @r{VM IMAP message link} | |
3545 | wl:folder @r{WANDERLUST folder link} | |
3546 | wl:folder#id @r{WANDERLUST message link} | |
3547 | @end example | |
3548 | ||
ce57c2fe BG |
3549 | For customizing Org to add new link types @ref{Adding hyperlink types}. |
3550 | ||
271672fa BG |
3551 | A link should be enclosed in double brackets and may contain a descriptive |
3552 | text to be displayed instead of the URL (@pxref{Link format}), for example: | |
4009494e GM |
3553 | |
3554 | @example | |
3555 | [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
3556 | @end example | |
3557 | ||
3558 | @noindent | |
3559 | If the description is a file name or URL that points to an image, HTML | |
3560 | export (@pxref{HTML export}) will inline the image as a clickable | |
3561 | button. If there is no description at all and the link points to an | |
3562 | image, | |
3563 | that image will be inlined into the exported HTML file. | |
3564 | ||
c8d0cf5c | 3565 | @cindex square brackets, around links |
4009494e | 3566 | @cindex plain text external links |
a7808fba | 3567 | Org also finds external links in the normal text and activates them |
4009494e GM |
3568 | as links. If spaces must be part of the link (for example in |
3569 | @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
c8d0cf5c | 3570 | about the end of the link, enclose them in square brackets. |
4009494e | 3571 | |
a7808fba | 3572 | @node Handling links, Using links outside Org, External links, Hyperlinks |
4009494e GM |
3573 | @section Handling links |
3574 | @cindex links, handling | |
3575 | ||
a7808fba CD |
3576 | Org provides methods to create a link in the correct syntax, to |
3577 | insert it into an Org file, and to follow the link. | |
4009494e GM |
3578 | |
3579 | @table @kbd | |
acedf35c | 3580 | @orgcmd{C-c l,org-store-link} |
4009494e | 3581 | @cindex storing links |
55e0839d CD |
3582 | Store a link to the current location. This is a @emph{global} command (you |
3583 | must create the key binding yourself) which can be used in any buffer to | |
3584 | create a link. The link will be stored for later insertion into an Org | |
c8d0cf5c CD |
3585 | buffer (see below). What kind of link will be created depends on the current |
3586 | buffer: | |
55e0839d | 3587 | |
e66ba1df | 3588 | @b{Org mode buffers}@* |
55e0839d | 3589 | For Org files, if there is a @samp{<<target>>} at the cursor, the link points |
c8d0cf5c | 3590 | to the target. Otherwise it points to the current headline, which will also |
ce57c2fe | 3591 | be the description@footnote{If the headline contains a timestamp, it will be |
f99f1641 | 3592 | removed from the link and result in a wrong link---you should avoid putting |
ce57c2fe | 3593 | timestamp in the headline.}. |
c8d0cf5c | 3594 | |
a89c8ef0 | 3595 | @vindex org-id-link-to-org-use-id |
c8d0cf5c CD |
3596 | @cindex property, CUSTOM_ID |
3597 | @cindex property, ID | |
3598 | If the headline has a @code{CUSTOM_ID} property, a link to this custom ID | |
3599 | will be stored. In addition or alternatively (depending on the value of | |
a89c8ef0 | 3600 | @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will |
271672fa BG |
3601 | be created and/or used to construct a link@footnote{The library |
3602 | @file{org-id.el} must first be loaded, either through @code{org-customize} by | |
3603 | enabling @code{org-id} in @code{org-modules}, or by adding @code{(require | |
3604 | 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will | |
3605 | potentially create two links: a human-readable from the custom ID, and one | |
3606 | that is globally unique and works even if the entry is moved from file to | |
3607 | file. Later, when inserting the link, you need to decide which one to use. | |
c8d0cf5c CD |
3608 | |
3609 | @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@* | |
3610 | Pretty much all Emacs mail clients are supported. The link will point to the | |
3611 | current article, or, in some GNUS buffers, to the group. The description is | |
3612 | constructed from the author and the subject. | |
3613 | ||
3614 | @b{Web browsers: W3 and W3M}@* | |
3615 | Here the link will be the current URL, with the page title as description. | |
3616 | ||
3617 | @b{Contacts: BBDB}@* | |
3618 | Links created in a BBDB buffer will point to the current entry. | |
3619 | ||
3620 | @b{Chat: IRC}@* | |
3621 | @vindex org-irc-link-to-logs | |
271672fa BG |
3622 | For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t}, |
3623 | a @samp{file:/} style link to the relevant point in the logs for the current | |
3624 | conversation is created. Otherwise an @samp{irc:/} style link to the | |
3625 | user/channel/server under the point will be stored. | |
c8d0cf5c CD |
3626 | |
3627 | @b{Other files}@* | |
55e0839d CD |
3628 | For any other files, the link will point to the file, with a search string |
3629 | (@pxref{Search options}) pointing to the contents of the current line. If | |
3630 | there is an active region, the selected words will form the basis of the | |
3631 | search string. If the automatically created link is not working correctly or | |
3632 | accurately enough, you can write custom functions to select the search string | |
c8d0cf5c CD |
3633 | and to do the search for particular file types---see @ref{Custom searches}. |
3634 | The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}. | |
7006d207 CD |
3635 | |
3636 | @b{Agenda view}@* | |
3637 | When the cursor is in an agenda view, the created link points to the | |
3638 | entry referenced by the current line. | |
3639 | ||
4009494e | 3640 | @c |
acedf35c | 3641 | @orgcmd{C-c C-l,org-insert-link} |
4009494e GM |
3642 | @cindex link completion |
3643 | @cindex completion, of links | |
3644 | @cindex inserting links | |
c8d0cf5c CD |
3645 | @vindex org-keep-stored-link-after-insertion |
3646 | Insert a link@footnote{ Note that you don't have to use this command to | |
3647 | insert a link. Links in Org are plain text, and you can type or paste them | |
3648 | straight into the buffer. By using this command, the links are automatically | |
3649 | enclosed in double brackets, and you will be asked for the optional | |
3650 | descriptive text.}. This prompts for a link to be inserted into the buffer. | |
3651 | You can just type a link, using text for an internal link, or one of the link | |
3652 | type prefixes mentioned in the examples above. The link will be inserted | |
3653 | into the buffer@footnote{After insertion of a stored link, the link will be | |
3654 | removed from the list of stored links. To keep it in the list later use, use | |
3655 | a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option | |
a7808fba CD |
3656 | @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text. |
3657 | If some text was selected when this command is called, the selected text | |
c8d0cf5c CD |
3658 | becomes the default description. |
3659 | ||
3660 | @b{Inserting stored links}@* | |
3661 | All links stored during the | |
3662 | current session are part of the history for this prompt, so you can access | |
3663 | them with @key{up} and @key{down} (or @kbd{M-p/n}). | |
3664 | ||
3665 | @b{Completion support}@* Completion with @key{TAB} will help you to insert | |
3666 | valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes | |
3667 | defined through link abbreviations (@pxref{Link abbreviations}). If you | |
3668 | press @key{RET} after inserting only the @var{prefix}, Org will offer | |
3669 | specific completion support for some link types@footnote{This works by | |
3670 | calling a special function @code{org-PREFIX-complete-link}.} For | |
3671 | example, if you type @kbd{file @key{RET}}, file name completion (alternative | |
3672 | access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb | |
3673 | @key{RET}} you can complete contact names. | |
acedf35c | 3674 | @orgkey C-u C-c C-l |
4009494e GM |
3675 | @cindex file name completion |
3676 | @cindex completion, of file names | |
4009494e GM |
3677 | When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to |
3678 | a file will be inserted and you may use file name completion to select | |
3679 | the name of the file. The path to the file is inserted relative to the | |
c8d0cf5c | 3680 | directory of the current Org file, if the linked file is in the current |
a7808fba | 3681 | directory or in a sub-directory of it, or if the path is written relative |
4009494e GM |
3682 | to the current directory using @samp{../}. Otherwise an absolute path |
3683 | is used, if possible with @samp{~/} for your home directory. You can | |
3684 | force an absolute path with two @kbd{C-u} prefixes. | |
3685 | @c | |
86fbb8ca | 3686 | @item C-c C-l @ @r{(with cursor on existing link)} |
4009494e GM |
3687 | When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the |
3688 | link and description parts of the link. | |
3689 | @c | |
3690 | @cindex following links | |
acedf35c | 3691 | @orgcmd{C-c C-o,org-open-at-point} |
c8d0cf5c | 3692 | @vindex org-file-apps |
e66ba1df | 3693 | @vindex org-link-frame-setup |
4009494e | 3694 | Open link at point. This will launch a web browser for URLs (using |
864c9740 CD |
3695 | @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for |
3696 | the corresponding links, and execute the command in a shell link. When the | |
04d3bb6c | 3697 | cursor is on an internal link, this command runs the corresponding search. |
864c9740 | 3698 | When the cursor is on a TAG list in a headline, it creates the corresponding |
c8d0cf5c | 3699 | TAGS view. If the cursor is on a timestamp, it compiles the agenda for that |
864c9740 CD |
3700 | date. Furthermore, it will visit text and remote files in @samp{file:} links |
3701 | with Emacs and select a suitable application for local non-text files. | |
3702 | Classification of files is based on file extension only. See option | |
3703 | @code{org-file-apps}. If you want to override the default application and | |
e45e3595 | 3704 | visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid |
6eb02347 CD |
3705 | opening in Emacs, use a @kbd{C-u C-u} prefix.@* |
3706 | If the cursor is on a headline, but not on a link, offer all links in the | |
e66ba1df BG |
3707 | headline and entry text. If you want to setup the frame configuration for |
3708 | following links, customize @code{org-link-frame-setup}. | |
3709 | ||
acedf35c CD |
3710 | @orgkey @key{RET} |
3711 | @vindex org-return-follows-link | |
3712 | When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow | |
3713 | the link at point. | |
4009494e GM |
3714 | @c |
3715 | @kindex mouse-2 | |
3716 | @kindex mouse-1 | |
3717 | @item mouse-2 | |
3718 | @itemx mouse-1 | |
3719 | On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
acedf35c | 3720 | would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link. |
4009494e GM |
3721 | @c |
3722 | @kindex mouse-3 | |
3723 | @item mouse-3 | |
c8d0cf5c | 3724 | @vindex org-display-internal-link-with-indirect-buffer |
4009494e GM |
3725 | Like @kbd{mouse-2}, but force file links to be opened with Emacs, and |
3726 | internal links to be displayed in another window@footnote{See the | |
271672fa | 3727 | option @code{org-display-internal-link-with-indirect-buffer}}. |
4009494e | 3728 | @c |
acedf35c | 3729 | @orgcmd{C-c C-x C-v,org-toggle-inline-images} |
86fbb8ca CD |
3730 | @cindex inlining images |
3731 | @cindex images, inlining | |
afe98dfa CD |
3732 | @vindex org-startup-with-inline-images |
3733 | @cindex @code{inlineimages}, STARTUP keyword | |
3734 | @cindex @code{noinlineimages}, STARTUP keyword | |
86fbb8ca | 3735 | Toggle the inline display of linked images. Normally this will only inline |
1df7defd | 3736 | images that have no description part in the link, i.e., images that will also |
86fbb8ca | 3737 | be inlined during export. When called with a prefix argument, also display |
afe98dfa CD |
3738 | images that do have a link description. You can ask for inline images to be |
3739 | displayed at startup by configuring the variable | |
3740 | @code{org-startup-with-inline-images}@footnote{with corresponding | |
271672fa | 3741 | @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}. |
acedf35c | 3742 | @orgcmd{C-c %,org-mark-ring-push} |
4009494e | 3743 | @cindex mark ring |
4009494e | 3744 | Push the current position onto the mark ring, to be able to return |
ce57c2fe | 3745 | easily. Commands following an internal link do this automatically. |
4009494e | 3746 | @c |
acedf35c | 3747 | @orgcmd{C-c &,org-mark-ring-goto} |
4009494e | 3748 | @cindex links, returning to |
4009494e GM |
3749 | Jump back to a recorded position. A position is recorded by the |
3750 | commands following internal links, and by @kbd{C-c %}. Using this | |
3751 | command several times in direct succession moves through a ring of | |
3752 | previously recorded positions. | |
3753 | @c | |
acedf35c | 3754 | @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link} |
4009494e | 3755 | @cindex links, finding next/previous |
4009494e GM |
3756 | Move forward/backward to the next link in the buffer. At the limit of |
3757 | the buffer, the search fails once, and then wraps around. The key | |
acedf35c | 3758 | bindings for this are really too long; you might want to bind this also |
4009494e GM |
3759 | to @kbd{C-n} and @kbd{C-p} |
3760 | @lisp | |
3761 | (add-hook 'org-load-hook | |
3762 | (lambda () | |
ce57c2fe BG |
3763 | (define-key org-mode-map "\C-n" 'org-next-link) |
3764 | (define-key org-mode-map "\C-p" 'org-previous-link))) | |
4009494e GM |
3765 | @end lisp |
3766 | @end table | |
3767 | ||
a7808fba CD |
3768 | @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks |
3769 | @section Using links outside Org | |
4009494e | 3770 | |
a7808fba CD |
3771 | You can insert and follow links that have Org syntax not only in |
3772 | Org, but in any Emacs buffer. For this, you should create two | |
4009494e GM |
3773 | global commands, like this (please select suitable global keys |
3774 | yourself): | |
3775 | ||
3776 | @lisp | |
3777 | (global-set-key "\C-c L" 'org-insert-link-global) | |
3778 | (global-set-key "\C-c o" 'org-open-at-point-global) | |
3779 | @end lisp | |
3780 | ||
a7808fba | 3781 | @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
4009494e GM |
3782 | @section Link abbreviations |
3783 | @cindex link abbreviations | |
3784 | @cindex abbreviation, links | |
3785 | ||
3786 | Long URLs can be cumbersome to type, and often many similar links are | |
3787 | needed in a document. For this you can use link abbreviations. An | |
3788 | abbreviated link looks like this | |
3789 | ||
3790 | @example | |
3791 | [[linkword:tag][description]] | |
3792 | @end example | |
3793 | ||
3794 | @noindent | |
c8d0cf5c | 3795 | @vindex org-link-abbrev-alist |
86fbb8ca CD |
3796 | where the tag is optional. |
3797 | The @i{linkword} must be a word, starting with a letter, followed by | |
3798 | letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved | |
c8d0cf5c CD |
3799 | according to the information in the variable @code{org-link-abbrev-alist} |
3800 | that relates the linkwords to replacement text. Here is an example: | |
4009494e | 3801 | |
afe98dfa | 3802 | @smalllisp |
4009494e GM |
3803 | @group |
3804 | (setq org-link-abbrev-alist | |
8223b1d2 BG |
3805 | '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") |
3806 | ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h") | |
3807 | ("google" . "http://www.google.com/search?q=") | |
3808 | ("gmap" . "http://maps.google.com/maps?q=%s") | |
3809 | ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1") | |
3810 | ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST"))) | |
4009494e | 3811 | @end group |
afe98dfa | 3812 | @end smalllisp |
4009494e GM |
3813 | |
3814 | If the replacement text contains the string @samp{%s}, it will be | |
8223b1d2 BG |
3815 | replaced with the tag. Using @samp{%h} instead of @samp{%s} will |
3816 | url-encode the tag (see the example above, where we need to encode | |
3817 | the URL parameter.) Using @samp{%(my-function)} will pass the tag | |
3818 | to a custom function, and replace it by the resulting string. | |
3819 | ||
3820 | If the replacement text don't contain any specifier, it will simply | |
3821 | be appended to the string in order to create the link. | |
3822 | ||
3823 | Instead of a string, you may also specify a function that will be | |
3824 | called with the tag as the only argument to create the link. | |
4009494e GM |
3825 | |
3826 | With the above setting, you could link to a specific bug with | |
3827 | @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with | |
afe98dfa CD |
3828 | @code{[[google:OrgMode]]}, show the map location of the Free Software |
3829 | Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office | |
3830 | @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out | |
3831 | what the Org author is doing besides Emacs hacking with | |
3832 | @code{[[ads:Dominik,C]]}. | |
4009494e | 3833 | |
a7808fba | 3834 | If you need special abbreviations just for a single Org buffer, you |
4009494e GM |
3835 | can define them in the file with |
3836 | ||
c8d0cf5c | 3837 | @cindex #+LINK |
4009494e GM |
3838 | @example |
3839 | #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
3840 | #+LINK: google http://www.google.com/search?q=%s | |
3841 | @end example | |
3842 | ||
3843 | @noindent | |
c8d0cf5c CD |
3844 | In-buffer completion (@pxref{Completion}) can be used after @samp{[} to |
3845 | complete link abbreviations. You may also define a function | |
1df7defd | 3846 | @code{org-PREFIX-complete-link} that implements special (e.g., completion) |
c8d0cf5c CD |
3847 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
3848 | not accept any arguments, and return the full link with prefix. | |
4009494e GM |
3849 | |
3850 | @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
3851 | @section Search options in file links | |
3852 | @cindex search option in file links | |
3853 | @cindex file links, searching | |
3854 | ||
3855 | File links can contain additional information to make Emacs jump to a | |
3856 | particular location in the file when following a link. This can be a | |
3857 | line number or a search option after a double@footnote{For backward | |
ce57c2fe | 3858 | compatibility, line numbers can also follow a single colon.} colon. For |
4009494e GM |
3859 | example, when the command @kbd{C-c l} creates a link (@pxref{Handling |
3860 | links}) to a file, it encodes the words in the current line as a search | |
3861 | string that can be used to find this line back later when following the | |
28a16a1b | 3862 | link with @kbd{C-c C-o}. |
4009494e GM |
3863 | |
3864 | Here is the syntax of the different ways to attach a search to a file | |
3865 | link, together with an explanation: | |
3866 | ||
3867 | @example | |
3868 | [[file:~/code/main.c::255]] | |
3869 | [[file:~/xx.org::My Target]] | |
3870 | [[file:~/xx.org::*My Target]] | |
ed21c5c8 | 3871 | [[file:~/xx.org::#my-custom-id]] |
4009494e GM |
3872 | [[file:~/xx.org::/regexp/]] |
3873 | @end example | |
3874 | ||
3875 | @table @code | |
3876 | @item 255 | |
3877 | Jump to line 255. | |
3878 | @item My Target | |
3879 | Search for a link target @samp{<<My Target>>}, or do a text search for | |
3880 | @samp{my target}, similar to the search in internal links, see | |
3881 | @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
d1389828 | 3882 | link will become an HTML reference to the corresponding named anchor in |
4009494e GM |
3883 | the linked file. |
3884 | @item *My Target | |
a7808fba | 3885 | In an Org file, restrict search to headlines. |
ed21c5c8 CD |
3886 | @item #my-custom-id |
3887 | Link to a heading with a @code{CUSTOM_ID} property | |
4009494e GM |
3888 | @item /regexp/ |
3889 | Do a regular expression search for @code{regexp}. This uses the Emacs | |
3890 | command @code{occur} to list all matches in a separate window. If the | |
e66ba1df | 3891 | target file is in Org mode, @code{org-occur} is used to create a |
4009494e GM |
3892 | sparse tree with the matches. |
3893 | @c If the target file is a directory, | |
3894 | @c @code{grep} will be used to search all files in the directory. | |
3895 | @end table | |
3896 | ||
3897 | As a degenerate case, a file link with an empty file name can be used | |
3898 | to search the current file. For example, @code{[[file:::find me]]} does | |
3899 | a search for @samp{find me} in the current file, just as | |
3900 | @samp{[[find me]]} would. | |
3901 | ||
dbc28aaa | 3902 | @node Custom searches, , Search options, Hyperlinks |
4009494e GM |
3903 | @section Custom Searches |
3904 | @cindex custom search strings | |
3905 | @cindex search strings, custom | |
3906 | ||
3907 | The default mechanism for creating search strings and for doing the | |
3908 | actual search related to a file link may not work correctly in all | |
c8d0cf5c | 3909 | cases. For example, Bib@TeX{} database files have many entries like |
4009494e | 3910 | @samp{year="1993"} which would not result in good search strings, |
c8d0cf5c | 3911 | because the only unique identification for a Bib@TeX{} entry is the |
4009494e GM |
3912 | citation key. |
3913 | ||
c8d0cf5c CD |
3914 | @vindex org-create-file-search-functions |
3915 | @vindex org-execute-file-search-functions | |
4009494e GM |
3916 | If you come across such a problem, you can write custom functions to set |
3917 | the right search string for a particular file type, and to do the search | |
3918 | for the string in the file. Using @code{add-hook}, these functions need | |
3919 | to be added to the hook variables | |
3920 | @code{org-create-file-search-functions} and | |
3921 | @code{org-execute-file-search-functions}. See the docstring for these | |
a7808fba | 3922 | variables for more information. Org actually uses this mechanism |
4009494e | 3923 | for Bib@TeX{} database files, and you can use the corresponding code as |
44ce9197 | 3924 | an implementation example. See the file @file{org-bibtex.el}. |
4009494e | 3925 | |
a7808fba | 3926 | @node TODO Items, Tags, Hyperlinks, Top |
86fbb8ca | 3927 | @chapter TODO items |
4009494e GM |
3928 | @cindex TODO items |
3929 | ||
e66ba1df | 3930 | Org mode does not maintain TODO lists as separate documents@footnote{Of |
a50253cc | 3931 | course, you can make a document that contains only long lists of TODO items, |
44ce9197 CD |
3932 | but this is not required.}. Instead, TODO items are an integral part of the |
3933 | notes file, because TODO items usually come up while taking notes! With Org | |
3934 | mode, simply mark any entry in a tree as being a TODO item. In this way, | |
3935 | information is not duplicated, and the entire context from which the TODO | |
3936 | item emerged is always present. | |
4009494e | 3937 | |
dbc28aaa | 3938 | Of course, this technique for managing TODO items scatters them |
e66ba1df | 3939 | throughout your notes file. Org mode compensates for this by providing |
dbc28aaa | 3940 | methods to give you an overview of all the things that you have to do. |
4009494e GM |
3941 | |
3942 | @menu | |
c0468714 GM |
3943 | * TODO basics:: Marking and displaying TODO entries |
3944 | * TODO extensions:: Workflow and assignments | |
3945 | * Progress logging:: Dates and notes for progress | |
3946 | * Priorities:: Some things are more important than others | |
3947 | * Breaking down tasks:: Splitting a task into manageable pieces | |
3948 | * Checkboxes:: Tick-off lists | |
4009494e GM |
3949 | @end menu |
3950 | ||
a7808fba | 3951 | @node TODO basics, TODO extensions, TODO Items, TODO Items |
4009494e GM |
3952 | @section Basic TODO functionality |
3953 | ||
dbc28aaa CD |
3954 | Any headline becomes a TODO item when it starts with the word |
3955 | @samp{TODO}, for example: | |
4009494e GM |
3956 | |
3957 | @example | |
3958 | *** TODO Write letter to Sam Fortune | |
3959 | @end example | |
3960 | ||
3961 | @noindent | |
3962 | The most important commands to work with TODO entries are: | |
3963 | ||
3964 | @table @kbd | |
acedf35c | 3965 | @orgcmd{C-c C-t,org-todo} |
4009494e | 3966 | @cindex cycling, of TODO states |
c7cf0ebc BG |
3967 | @vindex org-use-fast-todo-selection |
3968 | ||
4009494e GM |
3969 | Rotate the TODO state of the current item among |
3970 | ||
3971 | @example | |
3972 | ,-> (unmarked) -> TODO -> DONE --. | |
3973 | '--------------------------------' | |
3974 | @end example | |
3975 | ||
c7cf0ebc BG |
3976 | If TODO keywords have fast access keys (see @ref{Fast access to TODO |
3977 | states}), you will be prompted for a TODO keyword through the fast selection | |
3978 | interface; this is the default behavior when | |
271672fa | 3979 | @code{org-use-fast-todo-selection} is non-@code{nil}. |
c7cf0ebc BG |
3980 | |
3981 | The same rotation can also be done ``remotely'' from the timeline and agenda | |
3982 | buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
dbc28aaa | 3983 | |
acedf35c | 3984 | @orgkey{C-u C-c C-t} |
c7cf0ebc BG |
3985 | When TODO keywords have no selection keys, select a specific keyword using |
3986 | completion; otherwise force cycling through TODO states with no prompt. When | |
271672fa | 3987 | @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast |
c7cf0ebc | 3988 | selection interface. |
dbc28aaa | 3989 | |
4009494e GM |
3990 | @kindex S-@key{right} |
3991 | @kindex S-@key{left} | |
acedf35c | 3992 | @item S-@key{right} @ @r{/} @ S-@key{left} |
c8d0cf5c | 3993 | @vindex org-treat-S-cursor-todo-selection-as-state-change |
dbc28aaa CD |
3994 | Select the following/preceding TODO state, similar to cycling. Useful |
3995 | mostly if more than two TODO states are possible (@pxref{TODO | |
c8d0cf5c CD |
3996 | extensions}). See also @ref{Conflicts}, for a discussion of the interaction |
3997 | with @code{shift-selection-mode}. See also the variable | |
3998 | @code{org-treat-S-cursor-todo-selection-as-state-change}. | |
bdebdb64 | 3999 | @orgcmd{C-c / t,org-show-todo-tree} |
4009494e | 4000 | @cindex sparse tree, for TODO |
c8d0cf5c CD |
4001 | @vindex org-todo-keywords |
4002 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the | |
86fbb8ca CD |
4003 | entire buffer, but shows all TODO items (with not-DONE state) and the |
4004 | headings hierarchy above them. With a prefix argument (or by using @kbd{C-c | |
271672fa BG |
4005 | / T}), search for a specific TODO@. You will be prompted for the keyword, |
4006 | and you can also give a list of keywords like @code{KWD1|KWD2|...} to list | |
ce57c2fe | 4007 | entries that match any one of these keywords. With a numeric prefix argument |
271672fa BG |
4008 | N, show the tree for the Nth keyword in the option @code{org-todo-keywords}. |
4009 | With two prefix arguments, find all TODO states, both un-done and done. | |
acedf35c | 4010 | @orgcmd{C-c a t,org-todo-list} |
86fbb8ca CD |
4011 | Show the global TODO list. Collects the TODO items (with not-DONE states) |
4012 | from all agenda files (@pxref{Agenda Views}) into a single buffer. The new | |
4013 | buffer will be in @code{agenda-mode}, which provides commands to examine and | |
4014 | manipulate the TODO entries from the new buffer (@pxref{Agenda commands}). | |
4015 | @xref{Global TODO list}, for more information. | |
acedf35c | 4016 | @orgcmd{S-M-@key{RET},org-insert-todo-heading} |
4009494e GM |
4017 | Insert a new TODO entry below the current one. |
4018 | @end table | |
4019 | ||
71d35b24 | 4020 | @noindent |
c8d0cf5c | 4021 | @vindex org-todo-state-tags-triggers |
71d35b24 CD |
4022 | Changing a TODO state can also trigger tag changes. See the docstring of the |
4023 | option @code{org-todo-state-tags-triggers} for details. | |
4024 | ||
a7808fba | 4025 | @node TODO extensions, Progress logging, TODO basics, TODO Items |
4009494e GM |
4026 | @section Extended use of TODO keywords |
4027 | @cindex extended TODO keywords | |
4028 | ||
c8d0cf5c | 4029 | @vindex org-todo-keywords |
dbc28aaa | 4030 | By default, marked TODO entries have one of only two states: TODO and |
1df7defd | 4031 | DONE@. Org mode allows you to classify TODO items in more complex ways |
dbc28aaa CD |
4032 | with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With |
4033 | special setup, the TODO keyword system can work differently in different | |
4034 | files. | |
4009494e GM |
4035 | |
4036 | Note that @i{tags} are another way to classify headlines in general and | |
4037 | TODO items in particular (@pxref{Tags}). | |
4038 | ||
4039 | @menu | |
c0468714 GM |
4040 | * Workflow states:: From TODO to DONE in steps |
4041 | * TODO types:: I do this, Fred does the rest | |
4042 | * Multiple sets in one file:: Mixing it all, and still finding your way | |
4043 | * Fast access to TODO states:: Single letter selection of a state | |
4044 | * Per-file keywords:: Different files, different requirements | |
4045 | * Faces for TODO keywords:: Highlighting states | |
4046 | * TODO dependencies:: When one task needs to wait for others | |
4009494e GM |
4047 | @end menu |
4048 | ||
4049 | @node Workflow states, TODO types, TODO extensions, TODO extensions | |
4050 | @subsection TODO keywords as workflow states | |
4051 | @cindex TODO workflow | |
4052 | @cindex workflow states as TODO keywords | |
4053 | ||
4054 | You can use TODO keywords to indicate different @emph{sequential} states | |
4055 | in the process of working on an item, for example@footnote{Changing | |
e66ba1df | 4056 | this variable only becomes effective after restarting Org mode in a |
4009494e GM |
4057 | buffer.}: |
4058 | ||
4059 | @lisp | |
4060 | (setq org-todo-keywords | |
4061 | '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
4062 | @end lisp | |
4063 | ||
4064 | The vertical bar separates the TODO keywords (states that @emph{need | |
44ce9197 | 4065 | action}) from the DONE states (which need @emph{no further action}). If |
4009494e GM |
4066 | you don't provide the separator bar, the last state is used as the DONE |
4067 | state. | |
4068 | @cindex completion, of TODO keywords | |
4069 | With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
1df7defd | 4070 | to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may |
a7808fba | 4071 | also use a numeric prefix argument to quickly select a specific state. For |
1df7defd | 4072 | example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@. |
560bb6ea | 4073 | Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you |
28a16a1b CD |
4074 | define many keywords, you can use in-buffer completion |
4075 | (@pxref{Completion}) or even a special one-key selection scheme | |
4076 | (@pxref{Fast access to TODO states}) to insert these words into the | |
a7808fba | 4077 | buffer. Changing a TODO state can be logged with a timestamp, see |
c8d0cf5c | 4078 | @ref{Tracking TODO state changes}, for more information. |
4009494e GM |
4079 | |
4080 | @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
4081 | @subsection TODO keywords as types | |
4082 | @cindex TODO types | |
4083 | @cindex names as TODO keywords | |
4084 | @cindex types as TODO keywords | |
4085 | ||
4086 | The second possibility is to use TODO keywords to indicate different | |
4087 | @emph{types} of action items. For example, you might want to indicate | |
4088 | that items are for ``work'' or ``home''. Or, when you work with several | |
4089 | people on a single project, you might want to assign action items | |
4090 | directly to persons, by using their names as TODO keywords. This would | |
4091 | be set up like this: | |
4092 | ||
4093 | @lisp | |
4094 | (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
4095 | @end lisp | |
4096 | ||
4097 | In this case, different keywords do not indicate a sequence, but rather | |
4098 | different types. So the normal work flow would be to assign a task to a | |
1df7defd | 4099 | person, and later to mark it DONE@. Org mode supports this style by adapting |
a7808fba CD |
4100 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the |
4101 | @kbd{t} command in the timeline and agenda buffers.}. When used several | |
4102 | times in succession, it will still cycle through all names, in order to first | |
4103 | select the right type for a task. But when you return to the item after some | |
4104 | time and execute @kbd{C-c C-t} again, it will switch from any name directly | |
1df7defd | 4105 | to DONE@. Use prefix arguments or completion to quickly select a specific |
a7808fba | 4106 | name. You can also review the items of a specific TODO type in a sparse tree |
86fbb8ca CD |
4107 | by using a numeric prefix to @kbd{C-c / t}. For example, to see all things |
4108 | Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items | |
a7808fba | 4109 | from all agenda files into a single buffer, you would use the numeric prefix |
86fbb8ca | 4110 | argument as well when creating the global TODO list: @kbd{C-3 C-c a t}. |
4009494e | 4111 | |
dbc28aaa | 4112 | @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
4009494e | 4113 | @subsection Multiple keyword sets in one file |
a7808fba | 4114 | @cindex TODO keyword sets |
4009494e GM |
4115 | |
4116 | Sometimes you may want to use different sets of TODO keywords in | |
4117 | parallel. For example, you may want to have the basic | |
4118 | @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
4119 | separate state indicating that an item has been canceled (so it is not | |
4120 | DONE, but also does not require action). Your setup would then look | |
4121 | like this: | |
4122 | ||
4123 | @lisp | |
4124 | (setq org-todo-keywords | |
4125 | '((sequence "TODO" "|" "DONE") | |
4126 | (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
4127 | (sequence "|" "CANCELED"))) | |
4128 | @end lisp | |
4129 | ||
e66ba1df | 4130 | The keywords should all be different, this helps Org mode to keep track |
4009494e GM |
4131 | of which subsequence should be used for a given entry. In this setup, |
4132 | @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
4133 | @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
4134 | (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
4135 | select the correct sequence. Besides the obvious ways like typing a | |
4136 | keyword or using completion, you may also apply the following commands: | |
4137 | ||
4138 | @table @kbd | |
4139 | @kindex C-S-@key{right} | |
4140 | @kindex C-S-@key{left} | |
3da3282e CD |
4141 | @kindex C-u C-u C-c C-t |
4142 | @item C-u C-u C-c C-t | |
4143 | @itemx C-S-@key{right} | |
4009494e GM |
4144 | @itemx C-S-@key{left} |
4145 | These keys jump from one TODO subset to the next. In the above example, | |
3da3282e CD |
4146 | @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or |
4147 | @code{DONE} to @code{REPORT}, and any of the words in the second row to | |
4148 | @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with | |
4149 | @code{shift-selection-mode} (@pxref{Conflicts}). | |
4009494e GM |
4150 | @kindex S-@key{right} |
4151 | @kindex S-@key{left} | |
4152 | @item S-@key{right} | |
4153 | @itemx S-@key{left} | |
3da3282e CD |
4154 | @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all} |
4155 | keywords from all sets, so for example @kbd{S-@key{<right>}} would switch | |
4156 | from @code{DONE} to @code{REPORT} in the example above. See also | |
c8d0cf5c | 4157 | @ref{Conflicts}, for a discussion of the interaction with |
3da3282e | 4158 | @code{shift-selection-mode}. |
4009494e GM |
4159 | @end table |
4160 | ||
dbc28aaa CD |
4161 | @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions |
4162 | @subsection Fast access to TODO states | |
4163 | ||
4164 | If you would like to quickly change an entry to an arbitrary TODO state | |
8223b1d2 BG |
4165 | instead of cycling through the states, you can set up keys for single-letter |
4166 | access to the states. This is done by adding the selection character after | |
4167 | each keyword, in parentheses@footnote{All characters are allowed except | |
4168 | @code{@@^!}, which have a special meaning here.}. For example: | |
dbc28aaa CD |
4169 | |
4170 | @lisp | |
4171 | (setq org-todo-keywords | |
4172 | '((sequence "TODO(t)" "|" "DONE(d)") | |
4173 | (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") | |
4174 | (sequence "|" "CANCELED(c)"))) | |
4175 | @end lisp | |
4176 | ||
c8d0cf5c | 4177 | @vindex org-fast-tag-selection-include-todo |
ce57c2fe BG |
4178 | If you then press @kbd{C-c C-t} followed by the selection key, the entry |
4179 | will be switched to this state. @kbd{SPC} can be used to remove any TODO | |
271672fa | 4180 | keyword from an entry.@footnote{Check also the option |
c8d0cf5c | 4181 | @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO |
55033558 CD |
4182 | state through the tags interface (@pxref{Setting tags}), in case you like to |
4183 | mingle the two concepts. Note that this means you need to come up with | |
4184 | unique keys across both sets of keywords.} | |
dbc28aaa CD |
4185 | |
4186 | @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions | |
4009494e GM |
4187 | @subsection Setting up keywords for individual files |
4188 | @cindex keyword options | |
dbc28aaa | 4189 | @cindex per-file keywords |
c8d0cf5c CD |
4190 | @cindex #+TODO |
4191 | @cindex #+TYP_TODO | |
4192 | @cindex #+SEQ_TODO | |
4009494e GM |
4193 | |
4194 | It can be very useful to use different aspects of the TODO mechanism in | |
4195 | different files. For file-local settings, you need to add special lines | |
4196 | to the file which set the keywords and interpretation for that file | |
4197 | only. For example, to set one of the two examples discussed above, you | |
4198 | need one of the following lines, starting in column zero anywhere in the | |
4199 | file: | |
4200 | ||
4201 | @example | |
c8d0cf5c | 4202 | #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED |
4009494e | 4203 | @end example |
c8d0cf5c CD |
4204 | @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the |
4205 | interpretation, but it means the same as @code{#+TODO}), or | |
4009494e GM |
4206 | @example |
4207 | #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
4208 | @end example | |
4209 | ||
4210 | A setup for using several sets in parallel would be: | |
4211 | ||
4212 | @example | |
c8d0cf5c CD |
4213 | #+TODO: TODO | DONE |
4214 | #+TODO: REPORT BUG KNOWNCAUSE | FIXED | |
4215 | #+TODO: | CANCELED | |
4009494e GM |
4216 | @end example |
4217 | ||
4218 | @cindex completion, of option keywords | |
4219 | @kindex M-@key{TAB} | |
4220 | @noindent To make sure you are using the correct keyword, type | |
4221 | @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
4222 | ||
4223 | @cindex DONE, final TODO keyword | |
4224 | Remember that the keywords after the vertical bar (or the last keyword | |
4225 | if no bar is there) must always mean that the item is DONE (although you | |
4226 | may use a different word). After changing one of these lines, use | |
4227 | @kbd{C-c C-c} with the cursor still in the line to make the changes | |
e66ba1df BG |
4228 | known to Org mode@footnote{Org mode parses these lines only when |
4229 | Org mode is activated after visiting a file. @kbd{C-c C-c} with the | |
4230 | cursor in a line starting with @samp{#+} is simply restarting Org mode | |
4009494e GM |
4231 | for the current buffer.}. |
4232 | ||
7ddb1b5f | 4233 | @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions |
dbc28aaa CD |
4234 | @subsection Faces for TODO keywords |
4235 | @cindex faces, for TODO keywords | |
4236 | ||
c8d0cf5c CD |
4237 | @vindex org-todo @r{(face)} |
4238 | @vindex org-done @r{(face)} | |
4239 | @vindex org-todo-keyword-faces | |
e66ba1df | 4240 | Org mode highlights TODO keywords with special faces: @code{org-todo} |
dbc28aaa CD |
4241 | for keywords indicating that an item still has to be acted upon, and |
4242 | @code{org-done} for keywords indicating that an item is finished. If | |
4243 | you are using more than 2 different states, you might want to use | |
271672fa | 4244 | special faces for some of them. This can be done using the option |
dbc28aaa CD |
4245 | @code{org-todo-keyword-faces}. For example: |
4246 | ||
4247 | @lisp | |
96c8522a | 4248 | @group |
dbc28aaa | 4249 | (setq org-todo-keyword-faces |
ed21c5c8 CD |
4250 | '(("TODO" . org-warning) ("STARTED" . "yellow") |
4251 | ("CANCELED" . (:foreground "blue" :weight bold)))) | |
96c8522a | 4252 | @end group |
dbc28aaa CD |
4253 | @end lisp |
4254 | ||
ed21c5c8 | 4255 | While using a list with face properties as shown for CANCELED @emph{should} |
27e428e7 | 4256 | work, this does not always seem to be the case. If necessary, define a |
271672fa | 4257 | special face and use that. A string is interpreted as a color. The option |
ed21c5c8 CD |
4258 | @code{org-faces-easy-properties} determines if that color is interpreted as a |
4259 | foreground or a background color. | |
28a16a1b | 4260 | |
7ddb1b5f CD |
4261 | @node TODO dependencies, , Faces for TODO keywords, TODO extensions |
4262 | @subsection TODO dependencies | |
2e461fc1 CD |
4263 | @cindex TODO dependencies |
4264 | @cindex dependencies, of TODO states | |
7ddb1b5f | 4265 | |
c8d0cf5c CD |
4266 | @vindex org-enforce-todo-dependencies |
4267 | @cindex property, ORDERED | |
7ddb1b5f CD |
4268 | The structure of Org files (hierarchy and lists) makes it easy to define TODO |
4269 | dependencies. Usually, a parent TODO task should not be marked DONE until | |
1df7defd | 4270 | all subtasks (defined as children tasks) are marked as DONE@. And sometimes |
7ddb1b5f CD |
4271 | there is a logical sequence to a number of (sub)tasks, so that one task |
4272 | cannot be acted upon before all siblings above it are done. If you customize | |
271672fa | 4273 | the option @code{org-enforce-todo-dependencies}, Org will block entries |
1df7defd | 4274 | from changing state to DONE while they have children that are not DONE@. |
2e461fc1 | 4275 | Furthermore, if an entry has a property @code{ORDERED}, each of its children |
1df7defd | 4276 | will be blocked until all earlier siblings are marked DONE@. Here is an |
2e461fc1 | 4277 | example: |
7ddb1b5f CD |
4278 | |
4279 | @example | |
4280 | * TODO Blocked until (two) is done | |
4281 | ** DONE one | |
4282 | ** TODO two | |
4283 | ||
4284 | * Parent | |
4285 | :PROPERTIES: | |
ce57c2fe | 4286 | :ORDERED: t |
7ddb1b5f CD |
4287 | :END: |
4288 | ** TODO a | |
4289 | ** TODO b, needs to wait for (a) | |
4290 | ** TODO c, needs to wait for (a) and (b) | |
4291 | @end example | |
4292 | ||
bc283609 | 4293 | @table @kbd |
acedf35c | 4294 | @orgcmd{C-c C-x o,org-toggle-ordered-property} |
c8d0cf5c CD |
4295 | @vindex org-track-ordered-property-with-tag |
4296 | @cindex property, ORDERED | |
4297 | Toggle the @code{ORDERED} property of the current entry. A property is used | |
4298 | for this behavior because this should be local to the current entry, not | |
4299 | inherited like a tag. However, if you would like to @i{track} the value of | |
271672fa | 4300 | this property with a tag for better visibility, customize the option |
c8d0cf5c | 4301 | @code{org-track-ordered-property-with-tag}. |
acedf35c | 4302 | @orgkey{C-u C-u C-u C-c C-t} |
c8d0cf5c | 4303 | Change TODO state, circumventing any state blocking. |
bc283609 CD |
4304 | @end table |
4305 | ||
c8d0cf5c | 4306 | @vindex org-agenda-dim-blocked-tasks |
271672fa | 4307 | If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries |
7ddb1b5f CD |
4308 | that cannot be closed because of such dependencies will be shown in a dimmed |
4309 | font or even made invisible in agenda views (@pxref{Agenda Views}). | |
4310 | ||
2e461fc1 | 4311 | @cindex checkboxes and TODO dependencies |
c8d0cf5c | 4312 | @vindex org-enforce-todo-dependencies |
2e461fc1 | 4313 | You can also block changes of TODO states by looking at checkboxes |
271672fa | 4314 | (@pxref{Checkboxes}). If you set the option |
2e461fc1 CD |
4315 | @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked |
4316 | checkboxes will be blocked from switching to DONE. | |
4317 | ||
7ddb1b5f CD |
4318 | If you need more complex dependency structures, for example dependencies |
4319 | between entries in different trees or files, check out the contributed | |
4320 | module @file{org-depend.el}. | |
4321 | ||
dbc28aaa | 4322 | @page |
a7808fba CD |
4323 | @node Progress logging, Priorities, TODO extensions, TODO Items |
4324 | @section Progress logging | |
dbc28aaa CD |
4325 | @cindex progress logging |
4326 | @cindex logging, of progress | |
4327 | ||
e66ba1df | 4328 | Org mode can automatically record a timestamp and possibly a note when |
28a16a1b | 4329 | you mark a TODO item as DONE, or even each time you change the state of |
8a28a5b8 | 4330 | a TODO item. This system is highly configurable; settings can be on a |
28a16a1b CD |
4331 | per-keyword basis and can be localized to a file or even a subtree. For |
4332 | information on how to clock working time for a task, see @ref{Clocking | |
4333 | work time}. | |
dbc28aaa CD |
4334 | |
4335 | @menu | |
c0468714 GM |
4336 | * Closing items:: When was this entry marked DONE? |
4337 | * Tracking TODO state changes:: When did the status change? | |
4338 | * Tracking your habits:: How consistent have you been? | |
dbc28aaa CD |
4339 | @end menu |
4340 | ||
4341 | @node Closing items, Tracking TODO state changes, Progress logging, Progress logging | |
4342 | @subsection Closing items | |
4343 | ||
28a16a1b CD |
4344 | The most basic logging is to keep track of @emph{when} a certain TODO |
4345 | item was finished. This is achieved with@footnote{The corresponding | |
acedf35c | 4346 | in-buffer setting is: @code{#+STARTUP: logdone}} |
dbc28aaa CD |
4347 | |
4348 | @lisp | |
28a16a1b | 4349 | (setq org-log-done 'time) |
dbc28aaa CD |
4350 | @end lisp |
4351 | ||
271672fa | 4352 | @vindex org-closed-keep-when-no-todo |
dbc28aaa | 4353 | @noindent |
271672fa BG |
4354 | Then each time you turn an entry from a TODO (not-done) state into any of the |
4355 | DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after | |
4356 | the headline. If you turn the entry back into a TODO item through further | |
4357 | state cycling, that line will be removed again. If you turn the entry back | |
4358 | to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line | |
4359 | will also be removed, unless you set @code{org-closed-keep-when-no-todo} to | |
4360 | non-@code{nil}. If you want to record a note along with the timestamp, | |
4361 | use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP: | |
4362 | lognotedone}.} | |
dbc28aaa CD |
4363 | |
4364 | @lisp | |
28a16a1b | 4365 | (setq org-log-done 'note) |
dbc28aaa CD |
4366 | @end lisp |
4367 | ||
28a16a1b CD |
4368 | @noindent |
4369 | You will then be prompted for a note, and that note will be stored below | |
4370 | the entry with a @samp{Closing Note} heading. | |
4371 | ||
4372 | In the timeline (@pxref{Timeline}) and in the agenda | |
a7808fba | 4373 | (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to |
28a16a1b CD |
4374 | display the TODO items with a @samp{CLOSED} timestamp on each day, |
4375 | giving you an overview of what has been done. | |
4376 | ||
a351880d | 4377 | @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging |
dbc28aaa | 4378 | @subsection Tracking TODO state changes |
c8d0cf5c CD |
4379 | @cindex drawer, for state change recording |
4380 | ||
4381 | @vindex org-log-states-order-reversed | |
4382 | @vindex org-log-into-drawer | |
4383 | @cindex property, LOG_INTO_DRAWER | |
4384 | When TODO keywords are used as workflow states (@pxref{Workflow states}), you | |
4385 | might want to keep track of when a state change occurred and maybe take a | |
4386 | note about this change. You can either record just a timestamp, or a | |
4387 | time-stamped note for a change. These records will be inserted after the | |
271672fa | 4388 | headline as an itemized list, newest first@footnote{See the option |
c8d0cf5c CD |
4389 | @code{org-log-states-order-reversed}}. When taking a lot of notes, you might |
4390 | want to get the notes out of the way into a drawer (@pxref{Drawers}). | |
271672fa BG |
4391 | Customize @code{org-log-into-drawer} to get this behavior---the recommended |
4392 | drawer for this is called @code{LOGBOOK}@footnote{Note that the | |
8223b1d2 BG |
4393 | @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to |
4394 | show an entry---use @key{C-u SPC} to keep it folded here}. You can also | |
4395 | overrule the setting of this variable for a subtree by setting a | |
c8d0cf5c CD |
4396 | @code{LOG_INTO_DRAWER} property. |
4397 | ||
e66ba1df | 4398 | Since it is normally too much to record a note for every state, Org mode |
c8d0cf5c | 4399 | expects configuration on a per-keyword basis for this. This is achieved by |
e66ba1df BG |
4400 | adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note |
4401 | with timestamp) in parentheses after each keyword. For example, with the | |
4402 | setting | |
dbc28aaa CD |
4403 | |
4404 | @lisp | |
28a16a1b CD |
4405 | (setq org-todo-keywords |
4406 | '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)"))) | |
dbc28aaa CD |
4407 | @end lisp |
4408 | ||
e66ba1df BG |
4409 | To record a timestamp without a note for TODO keywords configured with |
4410 | @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted. | |
4411 | ||
dbc28aaa | 4412 | @noindent |
c8d0cf5c | 4413 | @vindex org-log-done |
28a16a1b | 4414 | you not only define global TODO keywords and fast access keys, but also |
c8d0cf5c | 4415 | request that a time is recorded when the entry is set to |
e66ba1df | 4416 | DONE@footnote{It is possible that Org mode will record two timestamps |
28a16a1b | 4417 | when you are using both @code{org-log-done} and state change logging. |
c8d0cf5c | 4418 | However, it will never prompt for two notes---if you have configured |
28a16a1b CD |
4419 | both, the state change recording note will take precedence and cancel |
4420 | the @samp{Closing Note}.}, and that a note is recorded when switching to | |
1df7defd | 4421 | WAIT or CANCELED@. The setting for WAIT is even more special: the |
28a16a1b | 4422 | @samp{!} after the slash means that in addition to the note taken when |
c8d0cf5c | 4423 | entering the state, a timestamp should be recorded when @i{leaving} the |
28a16a1b CD |
4424 | WAIT state, if and only if the @i{target} state does not configure |
4425 | logging for entering it. So it has no effect when switching from WAIT | |
4426 | to DONE, because DONE is configured to record a timestamp only. But | |
4427 | when switching from WAIT back to TODO, the @samp{/!} in the WAIT | |
4428 | setting now triggers a timestamp even though TODO has no logging | |
4429 | configured. | |
4430 | ||
4431 | You can use the exact same syntax for setting logging preferences local | |
4432 | to a buffer: | |
4433 | @example | |
c8d0cf5c | 4434 | #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) |
28a16a1b CD |
4435 | @end example |
4436 | ||
c8d0cf5c | 4437 | @cindex property, LOGGING |
28a16a1b CD |
4438 | In order to define logging settings that are local to a subtree or a |
4439 | single item, define a LOGGING property in this entry. Any non-empty | |
271672fa | 4440 | LOGGING property resets all logging settings to @code{nil}. You may then turn |
28a16a1b CD |
4441 | on logging for this specific tree using STARTUP keywords like |
4442 | @code{lognotedone} or @code{logrepeat}, as well as adding state specific | |
4443 | settings like @code{TODO(!)}. For example | |
4444 | ||
4445 | @example | |
4446 | * TODO Log each state with only a time | |
4447 | :PROPERTIES: | |
4448 | :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) | |
4449 | :END: | |
4450 | * TODO Only log when switching to WAIT, and when repeating | |
4451 | :PROPERTIES: | |
4452 | :LOGGING: WAIT(@@) logrepeat | |
4453 | :END: | |
4454 | * TODO No logging at all | |
4455 | :PROPERTIES: | |
4456 | :LOGGING: nil | |
4457 | :END: | |
dbc28aaa CD |
4458 | @end example |
4459 | ||
a351880d CD |
4460 | @node Tracking your habits, , Tracking TODO state changes, Progress logging |
4461 | @subsection Tracking your habits | |
4462 | @cindex habits | |
4463 | ||
4464 | Org has the ability to track the consistency of a special category of TODOs, | |
4465 | called ``habits''. A habit has the following properties: | |
4466 | ||
4467 | @enumerate | |
4468 | @item | |
271672fa | 4469 | You have enabled the @code{habits} module by customizing @code{org-modules}. |
a351880d | 4470 | @item |
ce57c2fe | 4471 | The habit is a TODO item, with a TODO keyword representing an open state. |
a351880d CD |
4472 | @item |
4473 | The property @code{STYLE} is set to the value @code{habit}. | |
4474 | @item | |
afe98dfa CD |
4475 | The TODO has a scheduled date, usually with a @code{.+} style repeat |
4476 | interval. A @code{++} style may be appropriate for habits with time | |
4477 | constraints, e.g., must be done on weekends, or a @code{+} style for an | |
4478 | unusual habit that can have a backlog, e.g., weekly reports. | |
a351880d CD |
4479 | @item |
4480 | The TODO may also have minimum and maximum ranges specified by using the | |
4481 | syntax @samp{.+2d/3d}, which says that you want to do the task at least every | |
4482 | three days, but at most every two days. | |
4483 | @item | |
8223b1d2 BG |
4484 | You must also have state logging for the @code{DONE} state enabled |
4485 | (@pxref{Tracking TODO state changes}), in order for historical data to be | |
4486 | represented in the consistency graph. If it is not enabled it is not an | |
4487 | error, but the consistency graphs will be largely meaningless. | |
a351880d CD |
4488 | @end enumerate |
4489 | ||
4490 | To give you an idea of what the above rules look like in action, here's an | |
4491 | actual habit with some history: | |
4492 | ||
4493 | @example | |
4494 | ** TODO Shave | |
4495 | SCHEDULED: <2009-10-17 Sat .+2d/4d> | |
4496 | - State "DONE" from "TODO" [2009-10-15 Thu] | |
4497 | - State "DONE" from "TODO" [2009-10-12 Mon] | |
4498 | - State "DONE" from "TODO" [2009-10-10 Sat] | |
4499 | - State "DONE" from "TODO" [2009-10-04 Sun] | |
4500 | - State "DONE" from "TODO" [2009-10-02 Fri] | |
4501 | - State "DONE" from "TODO" [2009-09-29 Tue] | |
4502 | - State "DONE" from "TODO" [2009-09-25 Fri] | |
4503 | - State "DONE" from "TODO" [2009-09-19 Sat] | |
4504 | - State "DONE" from "TODO" [2009-09-16 Wed] | |
4505 | - State "DONE" from "TODO" [2009-09-12 Sat] | |
4506 | :PROPERTIES: | |
4507 | :STYLE: habit | |
4508 | :LAST_REPEAT: [2009-10-19 Mon 00:36] | |
4509 | :END: | |
4510 | @end example | |
4511 | ||
4512 | What this habit says is: I want to shave at most every 2 days (given by the | |
4513 | @code{SCHEDULED} date and repeat interval) and at least every 4 days. If | |
4514 | today is the 15th, then the habit first appears in the agenda on Oct 17, | |
4515 | after the minimum of 2 days has elapsed, and will appear overdue on Oct 19, | |
4516 | after four days have elapsed. | |
4517 | ||
4518 | What's really useful about habits is that they are displayed along with a | |
4519 | consistency graph, to show how consistent you've been at getting that task | |
4520 | done in the past. This graph shows every day that the task was done over the | |
4521 | past three weeks, with colors for each day. The colors used are: | |
4522 | ||
4523 | @table @code | |
4524 | @item Blue | |
4525 | If the task wasn't to be done yet on that day. | |
4526 | @item Green | |
4527 | If the task could have been done on that day. | |
4528 | @item Yellow | |
4529 | If the task was going to be overdue the next day. | |
4530 | @item Red | |
4531 | If the task was overdue on that day. | |
4532 | @end table | |
4533 | ||
86fbb8ca | 4534 | In addition to coloring each day, the day is also marked with an asterisk if |
a351880d CD |
4535 | the task was actually done that day, and an exclamation mark to show where |
4536 | the current day falls in the graph. | |
4537 | ||
4538 | There are several configuration variables that can be used to change the way | |
4539 | habits are displayed in the agenda. | |
4540 | ||
4541 | @table @code | |
4542 | @item org-habit-graph-column | |
4543 | The buffer column at which the consistency graph should be drawn. This will | |
ce57c2fe | 4544 | overwrite any text in that column, so it is a good idea to keep your habits' |
a351880d CD |
4545 | titles brief and to the point. |
4546 | @item org-habit-preceding-days | |
4547 | The amount of history, in days before today, to appear in consistency graphs. | |
4548 | @item org-habit-following-days | |
4549 | The number of days after today that will appear in consistency graphs. | |
4550 | @item org-habit-show-habits-only-for-today | |
271672fa | 4551 | If non-@code{nil}, only show habits in today's agenda view. This is set to true by |
a351880d CD |
4552 | default. |
4553 | @end table | |
4554 | ||
4555 | Lastly, pressing @kbd{K} in the agenda buffer will cause habits to | |
4556 | temporarily be disabled and they won't appear at all. Press @kbd{K} again to | |
4557 | bring them back. They are also subject to tag filtering, if you have habits | |
4558 | which should only be done in certain contexts, for example. | |
4559 | ||
a7808fba | 4560 | @node Priorities, Breaking down tasks, Progress logging, TODO Items |
4009494e GM |
4561 | @section Priorities |
4562 | @cindex priorities | |
4563 | ||
e66ba1df | 4564 | If you use Org mode extensively, you may end up with enough TODO items that |
dbc28aaa | 4565 | it starts to make sense to prioritize them. Prioritizing can be done by |
86fbb8ca | 4566 | placing a @emph{priority cookie} into the headline of a TODO item, like this |
4009494e GM |
4567 | |
4568 | @example | |
4569 | *** TODO [#A] Write letter to Sam Fortune | |
4570 | @end example | |
4571 | ||
4572 | @noindent | |
ed21c5c8 | 4573 | @vindex org-priority-faces |
e66ba1df | 4574 | By default, Org mode supports three priorities: @samp{A}, @samp{B}, and |
ed21c5c8 | 4575 | @samp{C}. @samp{A} is the highest priority. An entry without a cookie is |
afe98dfa CD |
4576 | treated just like priority @samp{B}. Priorities make a difference only for |
4577 | sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they | |
e66ba1df | 4578 | have no inherent meaning to Org mode. The cookies can be highlighted with |
271672fa | 4579 | special faces by customizing @code{org-priority-faces}. |
dbc28aaa | 4580 | |
afe98dfa CD |
4581 | Priorities can be attached to any outline node; they do not need to be TODO |
4582 | items. | |
4009494e GM |
4583 | |
4584 | @table @kbd | |
4009494e | 4585 | @item @kbd{C-c ,} |
acedf35c CD |
4586 | @kindex @kbd{C-c ,} |
4587 | @findex org-priority | |
4588 | Set the priority of the current headline (@command{org-priority}). The | |
4589 | command prompts for a priority character @samp{A}, @samp{B} or @samp{C}. | |
4590 | When you press @key{SPC} instead, the priority cookie is removed from the | |
4591 | headline. The priorities can also be changed ``remotely'' from the timeline | |
4592 | and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
4009494e | 4593 | @c |
acedf35c | 4594 | @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down} |
c8d0cf5c | 4595 | @vindex org-priority-start-cycle-with-default |
3da3282e | 4596 | Increase/decrease priority of current headline@footnote{See also the option |
c8d0cf5c CD |
4597 | @code{org-priority-start-cycle-with-default}.}. Note that these keys are |
4598 | also used to modify timestamps (@pxref{Creating timestamps}). See also | |
4599 | @ref{Conflicts}, for a discussion of the interaction with | |
3da3282e | 4600 | @code{shift-selection-mode}. |
4009494e GM |
4601 | @end table |
4602 | ||
c8d0cf5c CD |
4603 | @vindex org-highest-priority |
4604 | @vindex org-lowest-priority | |
4605 | @vindex org-default-priority | |
271672fa | 4606 | You can change the range of allowed priorities by setting the options |
4009494e GM |
4607 | @code{org-highest-priority}, @code{org-lowest-priority}, and |
4608 | @code{org-default-priority}. For an individual buffer, you may set | |
4609 | these values (highest, lowest, default) like this (please make sure that | |
4610 | the highest priority is earlier in the alphabet than the lowest | |
4611 | priority): | |
4612 | ||
c8d0cf5c | 4613 | @cindex #+PRIORITIES |
4009494e GM |
4614 | @example |
4615 | #+PRIORITIES: A C B | |
4616 | @end example | |
4617 | ||
a7808fba | 4618 | @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
4009494e GM |
4619 | @section Breaking tasks down into subtasks |
4620 | @cindex tasks, breaking down | |
6eb02347 | 4621 | @cindex statistics, for TODO items |
4009494e | 4622 | |
c8d0cf5c | 4623 | @vindex org-agenda-todo-list-sublevels |
4009494e | 4624 | It is often advisable to break down large tasks into smaller, manageable |
b349f79f CD |
4625 | subtasks. You can do this by creating an outline tree below a TODO item, |
4626 | with detailed subtasks on the tree@footnote{To keep subtasks out of the | |
4627 | global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep | |
4628 | the overview over the fraction of subtasks that are already completed, insert | |
4629 | either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will | |
86fbb8ca | 4630 | be updated each time the TODO status of a child changes, or when pressing |
6eb02347 | 4631 | @kbd{C-c C-c} on the cookie. For example: |
b349f79f CD |
4632 | |
4633 | @example | |
4634 | * Organize Party [33%] | |
4635 | ** TODO Call people [1/2] | |
4636 | *** TODO Peter | |
4637 | *** DONE Sarah | |
4638 | ** TODO Buy food | |
4639 | ** DONE Talk to neighbor | |
4640 | @end example | |
4641 | ||
c8d0cf5c CD |
4642 | @cindex property, COOKIE_DATA |
4643 | If a heading has both checkboxes and TODO children below it, the meaning of | |
4644 | the statistics cookie become ambiguous. Set the property | |
4645 | @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve | |
4646 | this issue. | |
4647 | ||
6eb02347 CD |
4648 | @vindex org-hierarchical-todo-statistics |
4649 | If you would like to have the statistics cookie count any TODO entries in the | |
271672fa | 4650 | subtree (not just direct children), configure |
6eb02347 CD |
4651 | @code{org-hierarchical-todo-statistics}. To do this for a single subtree, |
4652 | include the word @samp{recursive} into the value of the @code{COOKIE_DATA} | |
4653 | property. | |
4654 | ||
4655 | @example | |
4656 | * Parent capturing statistics [2/20] | |
4657 | :PROPERTIES: | |
4658 | :COOKIE_DATA: todo recursive | |
4659 | :END: | |
4660 | @end example | |
4661 | ||
c8d0cf5c CD |
4662 | If you would like a TODO entry to automatically change to DONE |
4663 | when all children are done, you can use the following setup: | |
b349f79f CD |
4664 | |
4665 | @example | |
4666 | (defun org-summary-todo (n-done n-not-done) | |
4667 | "Switch entry to DONE when all subentries are done, to TODO otherwise." | |
4668 | (let (org-log-done org-log-states) ; turn off logging | |
4669 | (org-todo (if (= n-not-done 0) "DONE" "TODO")))) | |
4670 | ||
4671 | (add-hook 'org-after-todo-statistics-hook 'org-summary-todo) | |
4672 | @end example | |
4673 | ||
4674 | ||
4675 | Another possibility is the use of checkboxes to identify (a hierarchy of) a | |
4676 | large number of subtasks (@pxref{Checkboxes}). | |
4009494e GM |
4677 | |
4678 | ||
a7808fba | 4679 | @node Checkboxes, , Breaking down tasks, TODO Items |
4009494e GM |
4680 | @section Checkboxes |
4681 | @cindex checkboxes | |
4682 | ||
afe98dfa CD |
4683 | @vindex org-list-automatic-rules |
4684 | Every item in a plain list@footnote{With the exception of description | |
ce57c2fe | 4685 | lists. But you can allow it by modifying @code{org-list-automatic-rules} |
afe98dfa CD |
4686 | accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting |
4687 | it with the string @samp{[ ]}. This feature is similar to TODO items | |
4688 | (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included | |
8a28a5b8 | 4689 | in the global TODO list, so they are often great to split a task into a |
afe98dfa CD |
4690 | number of simple steps. Or you can use them in a shopping list. To toggle a |
4691 | checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's | |
4692 | @file{org-mouse.el}). | |
dbc28aaa CD |
4693 | |
4694 | Here is an example of a checkbox list. | |
4009494e GM |
4695 | |
4696 | @example | |
28a16a1b CD |
4697 | * TODO Organize party [2/4] |
4698 | - [-] call people [1/3] | |
4009494e GM |
4699 | - [ ] Peter |
4700 | - [X] Sarah | |
4701 | - [ ] Sam | |
4702 | - [X] order food | |
4703 | - [ ] think about what music to play | |
4704 | - [X] talk to the neighbors | |
4705 | @end example | |
4706 | ||
28a16a1b CD |
4707 | Checkboxes work hierarchically, so if a checkbox item has children that |
4708 | are checkboxes, toggling one of the children checkboxes will make the | |
4709 | parent checkbox reflect if none, some, or all of the children are | |
4710 | checked. | |
4711 | ||
4009494e GM |
4712 | @cindex statistics, for checkboxes |
4713 | @cindex checkbox statistics | |
c8d0cf5c | 4714 | @cindex property, COOKIE_DATA |
271672fa | 4715 | @vindex org-checkbox-hierarchical-statistics |
c8d0cf5c CD |
4716 | The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies |
4717 | indicating how many checkboxes present in this entry have been checked off, | |
4718 | and the total number of checkboxes present. This can give you an idea on how | |
4719 | many checkboxes remain, even without opening a folded entry. The cookies can | |
4720 | be placed into a headline or into (the first line of) a plain list item. | |
4721 | Each cookie covers checkboxes of direct children structurally below the | |
271672fa BG |
4722 | headline/item on which the cookie appears@footnote{Set the option |
4723 | @code{org-checkbox-hierarchical-statistics} if you want such cookies to | |
ce57c2fe | 4724 | count all checkboxes below the cookie, not just those belonging to direct |
c8d0cf5c CD |
4725 | children.}. You have to insert the cookie yourself by typing either |
4726 | @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} | |
4727 | result, as in the examples above. With @samp{[%]} you get information about | |
4728 | the percentage of checkboxes checked (in the above example, this would be | |
4729 | @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can | |
4730 | count either checkboxes below the heading or TODO states of children, and it | |
4731 | will display whatever was changed last. Set the property @code{COOKIE_DATA} | |
4732 | to either @samp{checkbox} or @samp{todo} to resolve this issue. | |
4733 | ||
4734 | @cindex blocking, of checkboxes | |
4735 | @cindex checkbox blocking | |
4736 | @cindex property, ORDERED | |
4737 | If the current outline node has an @code{ORDERED} property, checkboxes must | |
4738 | be checked off in sequence, and an error will be thrown if you try to check | |
4739 | off a box while there are unchecked boxes above it. | |
4009494e GM |
4740 | |
4741 | @noindent The following commands work with checkboxes: | |
4742 | ||
4743 | @table @kbd | |
acedf35c | 4744 | @orgcmd{C-c C-c,org-toggle-checkbox} |
27e428e7 | 4745 | Toggle checkbox status or (with prefix arg) checkbox presence at point. |
e66ba1df | 4746 | With a single prefix argument, add an empty checkbox or remove the current |
d3517077 | 4747 | one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox |
e66ba1df BG |
4748 | will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is |
4749 | considered to be an intermediate state. | |
acedf35c | 4750 | @orgcmd{C-c C-x C-b,org-toggle-checkbox} |
c8d0cf5c CD |
4751 | Toggle checkbox status or (with prefix arg) checkbox presence at point. With |
4752 | double prefix argument, set it to @samp{[-]}, which is considered to be an | |
4753 | intermediate state. | |
4009494e GM |
4754 | @itemize @minus |
4755 | @item | |
4756 | If there is an active region, toggle the first checkbox in the region | |
7ddb1b5f CD |
4757 | and set all remaining boxes to the same status as the first. With a prefix |
4758 | arg, add or remove the checkbox for all items in the region. | |
4009494e GM |
4759 | @item |
4760 | If the cursor is in a headline, toggle checkboxes in the region between | |
4761 | this headline and the next (so @emph{not} the entire subtree). | |
4762 | @item | |
4763 | If there is no active region, just toggle the checkbox at point. | |
4764 | @end itemize | |
acedf35c | 4765 | @orgcmd{M-S-@key{RET},org-insert-todo-heading} |
ce57c2fe BG |
4766 | Insert a new item with a checkbox. This works only if the cursor is already |
4767 | in a plain list item (@pxref{Plain lists}). | |
acedf35c | 4768 | @orgcmd{C-c C-x o,org-toggle-ordered-property} |
c8d0cf5c CD |
4769 | @vindex org-track-ordered-property-with-tag |
4770 | @cindex property, ORDERED | |
4771 | Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must | |
4772 | be checked off in sequence. A property is used for this behavior because | |
4773 | this should be local to the current entry, not inherited like a tag. | |
4774 | However, if you would like to @i{track} the value of this property with a tag | |
271672fa | 4775 | for better visibility, customize @code{org-track-ordered-property-with-tag}. |
acedf35c | 4776 | @orgcmd{C-c #,org-update-statistics-cookies} |
6eb02347 CD |
4777 | Update the statistics cookie in the current outline entry. When called with |
4778 | a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are | |
4779 | updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make | |
4780 | new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when | |
4781 | changing TODO states. If you delete boxes/entries or add/change them by | |
ce57c2fe | 4782 | hand, use this command to get things back into sync. |
4009494e GM |
4783 | @end table |
4784 | ||
a7808fba | 4785 | @node Tags, Properties and Columns, TODO Items, Top |
4009494e GM |
4786 | @chapter Tags |
4787 | @cindex tags | |
4788 | @cindex headline tagging | |
4789 | @cindex matching, tags | |
4790 | @cindex sparse tree, tag based | |
4791 | ||
dbc28aaa | 4792 | An excellent way to implement labels and contexts for cross-correlating |
e66ba1df | 4793 | information is to assign @i{tags} to headlines. Org mode has extensive |
dbc28aaa | 4794 | support for tags. |
4009494e | 4795 | |
c8d0cf5c | 4796 | @vindex org-tag-faces |
dbc28aaa | 4797 | Every headline can contain a list of tags; they occur at the end of the |
96c8522a | 4798 | headline. Tags are normal words containing letters, numbers, @samp{_}, and |
a351880d | 4799 | @samp{@@}. Tags must be preceded and followed by a single colon, e.g., |
96c8522a | 4800 | @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}. |
c8d0cf5c | 4801 | Tags will by default be in bold face with the same color as the headline. |
271672fa | 4802 | You may specify special faces for specific tags using the option |
c8d0cf5c | 4803 | @code{org-tag-faces}, in much the same way as you can for TODO keywords |
96c8522a | 4804 | (@pxref{Faces for TODO keywords}). |
4009494e GM |
4805 | |
4806 | @menu | |
c0468714 GM |
4807 | * Tag inheritance:: Tags use the tree structure of the outline |
4808 | * Setting tags:: How to assign tags to a headline | |
271672fa | 4809 | * Tag groups:: Use one tag to search for several tags |
c0468714 | 4810 | * Tag searches:: Searching for combinations of tags |
4009494e GM |
4811 | @end menu |
4812 | ||
4813 | @node Tag inheritance, Setting tags, Tags, Tags | |
4814 | @section Tag inheritance | |
dbc28aaa | 4815 | @cindex tag inheritance |
4009494e GM |
4816 | @cindex inheritance, of tags |
4817 | @cindex sublevels, inclusion into tags match | |
4818 | ||
4819 | @i{Tags} make use of the hierarchical structure of outline trees. If a | |
4820 | heading has a certain tag, all subheadings will inherit the tag as | |
4821 | well. For example, in the list | |
4822 | ||
4823 | @example | |
dbc28aaa CD |
4824 | * Meeting with the French group :work: |
4825 | ** Summary by Frank :boss:notes: | |
4826 | *** TODO Prepare slides for him :action: | |
4009494e GM |
4827 | @end example |
4828 | ||
4829 | @noindent | |
dbc28aaa CD |
4830 | the final heading will have the tags @samp{:work:}, @samp{:boss:}, |
4831 | @samp{:notes:}, and @samp{:action:} even though the final heading is not | |
b349f79f | 4832 | explicitly marked with those tags. You can also set tags that all entries in |
c8d0cf5c | 4833 | a file should inherit just as if these tags were defined in a hypothetical |
7006d207 CD |
4834 | level zero that surrounds the entire file. Use a line like this@footnote{As |
4835 | with all these in-buffer settings, pressing @kbd{C-c C-c} activates any | |
4836 | changes in the line.}: | |
b349f79f | 4837 | |
c8d0cf5c | 4838 | @cindex #+FILETAGS |
b349f79f CD |
4839 | @example |
4840 | #+FILETAGS: :Peter:Boss:Secret: | |
4841 | @end example | |
4842 | ||
4843 | @noindent | |
c8d0cf5c CD |
4844 | @vindex org-use-tag-inheritance |
4845 | @vindex org-tags-exclude-from-inheritance | |
6d3e4c80 BG |
4846 | To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}. |
4847 | To turn it off entirely, use @code{org-use-tag-inheritance}. | |
b349f79f | 4848 | |
c8d0cf5c | 4849 | @vindex org-tags-match-list-sublevels |
b349f79f | 4850 | When a headline matches during a tags search while tag inheritance is turned |
96c8522a | 4851 | on, all the sublevels in the same tree will (for a simple match form) match |
07450bee | 4852 | as well@footnote{This is only true if the search does not involve more |
96c8522a CD |
4853 | complex tests including properties (@pxref{Property searches}).}. The list |
4854 | of matches may then become very long. If you only want to see the first tags | |
271672fa BG |
4855 | match in a subtree, configure @code{org-tags-match-list-sublevels} (not |
4856 | recommended). | |
4009494e | 4857 | |
6d3e4c80 BG |
4858 | @vindex org-agenda-use-tag-inheritance |
4859 | Tag inheritance is relevant when the agenda search tries to match a tag, | |
4860 | either in the @code{tags} or @code{tags-todo} agenda types. In other agenda | |
4861 | types, @code{org-use-tag-inheritance} has no effect. Still, you may want to | |
4862 | have your tags correctly set in the agenda, so that tag filtering works fine, | |
4863 | with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control | |
271672fa | 4864 | this: the default value includes all agenda types, but setting this to @code{nil} |
6d3e4c80 BG |
4865 | can really speed up agenda generation. |
4866 | ||
271672fa | 4867 | @node Setting tags, Tag groups, Tag inheritance, Tags |
4009494e GM |
4868 | @section Setting tags |
4869 | @cindex setting tags | |
4870 | @cindex tags, setting | |
4871 | ||
4872 | @kindex M-@key{TAB} | |
4873 | Tags can simply be typed into the buffer at the end of a headline. | |
4874 | After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
4875 | also a special command for inserting tags: | |
4876 | ||
4877 | @table @kbd | |
acedf35c | 4878 | @orgcmd{C-c C-q,org-set-tags-command} |
4009494e | 4879 | @cindex completion, of tags |
c8d0cf5c | 4880 | @vindex org-tags-column |
e66ba1df | 4881 | Enter new tags for the current headline. Org mode will either offer |
4009494e GM |
4882 | completion or a special single-key interface for setting tags, see |
4883 | below. After pressing @key{RET}, the tags will be inserted and aligned | |
4884 | to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
4885 | tags in the current buffer will be aligned to that column, just to make | |
4886 | things look nice. TAGS are automatically realigned after promotion, | |
4887 | demotion, and TODO state changes (@pxref{TODO basics}). | |
271672fa | 4888 | |
acedf35c | 4889 | @orgcmd{C-c C-c,org-set-tags-command} |
71d35b24 | 4890 | When the cursor is in a headline, this does the same as @kbd{C-c C-q}. |
4009494e GM |
4891 | @end table |
4892 | ||
c8d0cf5c | 4893 | @vindex org-tag-alist |
ce57c2fe | 4894 | Org supports tag insertion based on a @emph{list of tags}. By |
4009494e GM |
4895 | default this list is constructed dynamically, containing all tags |
4896 | currently used in the buffer. You may also globally specify a hard list | |
4897 | of tags with the variable @code{org-tag-alist}. Finally you can set | |
4898 | the default tags for a given file with lines like | |
4899 | ||
c8d0cf5c | 4900 | @cindex #+TAGS |
4009494e | 4901 | @example |
dbc28aaa CD |
4902 | #+TAGS: @@work @@home @@tennisclub |
4903 | #+TAGS: laptop car pc sailboat | |
4009494e GM |
4904 | @end example |
4905 | ||
4906 | If you have globally defined your preferred set of tags using the | |
4907 | variable @code{org-tag-alist}, but would like to use a dynamic tag list | |
dbc28aaa | 4908 | in a specific file, add an empty TAGS option line to that file: |
4009494e GM |
4909 | |
4910 | @example | |
4911 | #+TAGS: | |
4912 | @end example | |
4913 | ||
c8d0cf5c CD |
4914 | @vindex org-tag-persistent-alist |
4915 | If you have a preferred set of tags that you would like to use in every file, | |
4916 | in addition to those defined on a per-file basis by TAGS option lines, then | |
4917 | you may specify a list of tags with the variable | |
4918 | @code{org-tag-persistent-alist}. You may turn this off on a per-file basis | |
4919 | by adding a STARTUP option line to that file: | |
4920 | ||
4921 | @example | |
4922 | #+STARTUP: noptag | |
4923 | @end example | |
4924 | ||
e66ba1df | 4925 | By default Org mode uses the standard minibuffer completion facilities for |
a7808fba CD |
4926 | entering tags. However, it also implements another, quicker, tag selection |
4927 | method called @emph{fast tag selection}. This allows you to select and | |
4928 | deselect tags with just a single key press. For this to work well you should | |
4929 | assign unique letters to most of your commonly used tags. You can do this | |
4930 | globally by configuring the variable @code{org-tag-alist} in your | |
4931 | @file{.emacs} file. For example, you may find the need to tag many items in | |
4932 | different files with @samp{:@@home:}. In this case you can set something | |
4933 | like: | |
4009494e GM |
4934 | |
4935 | @lisp | |
dbc28aaa | 4936 | (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
4009494e GM |
4937 | @end lisp |
4938 | ||
c8d0cf5c CD |
4939 | @noindent If the tag is only relevant to the file you are working on, then you |
4940 | can instead set the TAGS option line as: | |
4009494e GM |
4941 | |
4942 | @example | |
dbc28aaa | 4943 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
4009494e GM |
4944 | @end example |
4945 | ||
c8d0cf5c CD |
4946 | @noindent The tags interface will show the available tags in a splash |
4947 | window. If you want to start a new line after a specific tag, insert | |
4948 | @samp{\n} into the tag list | |
4949 | ||
4950 | @example | |
4951 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p) | |
4952 | @end example | |
4953 | ||
4954 | @noindent or write them in two lines: | |
4955 | ||
4956 | @example | |
4957 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) | |
4958 | #+TAGS: laptop(l) pc(p) | |
4959 | @end example | |
4960 | ||
4009494e | 4961 | @noindent |
c8d0cf5c | 4962 | You can also group together tags that are mutually exclusive by using |
a7808fba | 4963 | braces, as in: |
4009494e GM |
4964 | |
4965 | @example | |
dbc28aaa | 4966 | #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) |
4009494e GM |
4967 | @end example |
4968 | ||
dbc28aaa | 4969 | @noindent you indicate that at most one of @samp{@@work}, @samp{@@home}, |
a7808fba | 4970 | and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
4009494e GM |
4971 | |
4972 | @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
4973 | these lines to activate any changes. | |
4974 | ||
a7808fba | 4975 | @noindent |
271672fa | 4976 | To set these mutually exclusive groups in the variable @code{org-tag-alist}, |
a7808fba | 4977 | you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead |
c8d0cf5c CD |
4978 | of the braces. Similarly, you can use @code{:newline} to indicate a line |
4979 | break. The previous example would be set globally by the following | |
a7808fba CD |
4980 | configuration: |
4981 | ||
4982 | @lisp | |
4983 | (setq org-tag-alist '((:startgroup . nil) | |
4984 | ("@@work" . ?w) ("@@home" . ?h) | |
4985 | ("@@tennisclub" . ?t) | |
4986 | (:endgroup . nil) | |
4987 | ("laptop" . ?l) ("pc" . ?p))) | |
4988 | @end lisp | |
4989 | ||
4990 | If at least one tag has a selection key then pressing @kbd{C-c C-c} will | |
4991 | automatically present you with a special interface, listing inherited tags, | |
4992 | the tags of the current headline, and a list of all valid tags with | |
4993 | corresponding keys@footnote{Keys will automatically be assigned to tags which | |
4994 | have no configured keys.}. In this interface, you can use the following | |
4995 | keys: | |
4009494e GM |
4996 | |
4997 | @table @kbd | |
4998 | @item a-z... | |
4999 | Pressing keys assigned to tags will add or remove them from the list of | |
5000 | tags in the current line. Selecting a tag in a group of mutually | |
5001 | exclusive tags will turn off any other tags from that group. | |
5002 | @kindex @key{TAB} | |
5003 | @item @key{TAB} | |
5004 | Enter a tag in the minibuffer, even if the tag is not in the predefined | |
5005 | list. You will be able to complete on all tags present in the buffer. | |
ce57c2fe BG |
5006 | You can also add several tags: just separate them with a comma. |
5007 | ||
4009494e GM |
5008 | @kindex @key{SPC} |
5009 | @item @key{SPC} | |
5010 | Clear all tags for this line. | |
5011 | @kindex @key{RET} | |
5012 | @item @key{RET} | |
5013 | Accept the modified set. | |
5014 | @item C-g | |
5015 | Abort without installing changes. | |
5016 | @item q | |
5017 | If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
5018 | @item ! | |
5019 | Turn off groups of mutually exclusive tags. Use this to (as an | |
5020 | exception) assign several tags from such a group. | |
5021 | @item C-c | |
5022 | Toggle auto-exit after the next change (see below). | |
5023 | If you are using expert mode, the first @kbd{C-c} will display the | |
5024 | selection window. | |
5025 | @end table | |
5026 | ||
5027 | @noindent | |
5028 | This method lets you assign tags to a headline with very few keys. With | |
dbc28aaa CD |
5029 | the above setup, you could clear the current tags and set @samp{@@home}, |
5030 | @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c | |
5031 | C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to | |
5032 | @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or | |
4009494e GM |
5033 | alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
5034 | @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
5035 | @key{RET} @key{RET}}. | |
5036 | ||
c8d0cf5c CD |
5037 | @vindex org-fast-tag-selection-single-key |
5038 | If you find that most of the time you need only a single key press to | |
271672fa BG |
5039 | modify your list of tags, set @code{org-fast-tag-selection-single-key}. |
5040 | Then you no longer have to press @key{RET} to exit fast tag selection---it | |
5041 | will immediately exit after the first change. If you then occasionally | |
5042 | need more keys, press @kbd{C-c} to turn off auto-exit for the current tag | |
5043 | selection process (in effect: start selection with @kbd{C-c C-c C-c} | |
5044 | instead of @kbd{C-c C-c}). If you set the variable to the value | |
5045 | @code{expert}, the special window is not even shown for single-key tag | |
5046 | selection, it comes up only when you press an extra @kbd{C-c}. | |
5047 | ||
5048 | @node Tag groups, Tag searches, Setting tags, Tags | |
5049 | @section Tag groups | |
5050 | ||
5051 | @cindex group tags | |
5052 | @cindex tags, groups | |
5053 | In a set of mutually exclusive tags, the first tag can be defined as a | |
5054 | @emph{group tag}. When you search for a group tag, it will return matches | |
5055 | for all members in the group. In an agenda view, filtering by a group tag | |
5056 | will display headlines tagged with at least one of the members of the | |
5057 | group. This makes tag searches and filters even more flexible. | |
5058 | ||
5059 | You can set group tags by inserting a colon between the group tag and other | |
5060 | tags---beware that all whitespaces are mandatory so that Org can parse this | |
5061 | line correctly: | |
5062 | ||
5063 | @example | |
5064 | #+TAGS: @{ @@read : @@read_book @@read_ebook @} | |
5065 | @end example | |
5066 | ||
5067 | In this example, @samp{@@read} is a @emph{group tag} for a set of three | |
5068 | tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}. | |
5069 | ||
5070 | You can also use the @code{:grouptags} keyword directly when setting | |
5071 | @code{org-tag-alist}: | |
5072 | ||
5073 | @lisp | |
5074 | (setq org-tag-alist '((:startgroup . nil) | |
5075 | ("@@read" . nil) | |
5076 | (:grouptags . nil) | |
5077 | ("@@read_book" . nil) | |
5078 | ("@@read_ebook" . nil) | |
5079 | (:endgroup . nil))) | |
5080 | @end lisp | |
5081 | ||
5082 | You cannot nest group tags or use a group tag as a tag in another group. | |
5083 | ||
5084 | @kindex C-c C-x q | |
5085 | @vindex org-group-tags | |
5086 | If you want to ignore group tags temporarily, toggle group tags support | |
5087 | with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you | |
5088 | want to disable tag groups completely, set @code{org-group-tags} to @code{nil}. | |
5089 | ||
5090 | @node Tag searches, , Tag groups, Tags | |
4009494e GM |
5091 | @section Tag searches |
5092 | @cindex tag searches | |
5093 | @cindex searching for tags | |
5094 | ||
dbc28aaa | 5095 | Once a system of tags has been set up, it can be used to collect related |
4009494e GM |
5096 | information into special lists. |
5097 | ||
5098 | @table @kbd | |
ce57c2fe | 5099 | @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree} |
271672fa BG |
5100 | Create a sparse tree with all headlines matching a tags/property/TODO search. |
5101 | With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
4009494e | 5102 | @xref{Matching tags and properties}. |
271672fa BG |
5103 | @orgcmd{C-c a m,org-tags-view} |
5104 | Create a global list of tag matches from all agenda files. @xref{Matching | |
5105 | tags and properties}. | |
acedf35c | 5106 | @orgcmd{C-c a M,org-tags-view} |
c8d0cf5c | 5107 | @vindex org-tags-match-list-sublevels |
4009494e | 5108 | Create a global list of tag matches from all agenda files, but check |
271672fa | 5109 | only TODO items and force checking subitems (see the option |
4009494e GM |
5110 | @code{org-tags-match-list-sublevels}). |
5111 | @end table | |
5112 | ||
c8d0cf5c CD |
5113 | These commands all prompt for a match string which allows basic Boolean logic |
5114 | like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and | |
5115 | @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries | |
5116 | which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search | |
5117 | string is rich and allows also matching against TODO keywords, entry levels | |
5118 | and properties. For a complete description with many examples, see | |
5119 | @ref{Matching tags and properties}. | |
dbc28aaa | 5120 | |
e45e3595 | 5121 | |
a7808fba | 5122 | @node Properties and Columns, Dates and Times, Tags, Top |
86fbb8ca | 5123 | @chapter Properties and columns |
4009494e GM |
5124 | @cindex properties |
5125 | ||
e66ba1df BG |
5126 | A property is a key-value pair associated with an entry. Properties can be |
5127 | set so they are associated with a single entry, with every entry in a tree, | |
5128 | or with every entry in an Org mode file. | |
5129 | ||
5130 | There are two main applications for properties in Org mode. First, | |
5131 | properties are like tags, but with a value. Imagine maintaining a file where | |
c8d0cf5c | 5132 | you document bugs and plan releases for a piece of software. Instead of |
e66ba1df | 5133 | using tags like @code{:release_1:}, @code{:release_2:}, you can use a |
dbc28aaa | 5134 | property, say @code{:Release:}, that in different subtrees has different |
e66ba1df BG |
5135 | values, such as @code{1.0} or @code{2.0}. Second, you can use properties to |
5136 | implement (very basic) database capabilities in an Org buffer. Imagine | |
5137 | keeping track of your music CDs, where properties could be things such as the | |
5138 | album, artist, date of release, number of tracks, and so on. | |
dbc28aaa | 5139 | |
28a16a1b | 5140 | Properties can be conveniently edited and viewed in column view |
dbc28aaa CD |
5141 | (@pxref{Column view}). |
5142 | ||
4009494e | 5143 | @menu |
c0468714 | 5144 | * Property syntax:: How properties are spelled out |
e66ba1df | 5145 | * Special properties:: Access to other Org mode features |
c0468714 GM |
5146 | * Property searches:: Matching property values |
5147 | * Property inheritance:: Passing values down the tree | |
5148 | * Column view:: Tabular viewing and editing | |
5149 | * Property API:: Properties for Lisp programmers | |
4009494e GM |
5150 | @end menu |
5151 | ||
a7808fba CD |
5152 | @node Property syntax, Special properties, Properties and Columns, Properties and Columns |
5153 | @section Property syntax | |
4009494e GM |
5154 | @cindex property syntax |
5155 | @cindex drawer, for properties | |
5156 | ||
e66ba1df BG |
5157 | Properties are key-value pairs. When they are associated with a single entry |
5158 | or with a tree they need to be inserted into a special | |
4009494e GM |
5159 | drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property |
5160 | is specified on a single line, with the key (surrounded by colons) | |
5161 | first, and the value after it. Here is an example: | |
5162 | ||
5163 | @example | |
5164 | * CD collection | |
5165 | ** Classic | |
5166 | *** Goldberg Variations | |
5167 | :PROPERTIES: | |
5168 | :Title: Goldberg Variations | |
5169 | :Composer: J.S. Bach | |
28a16a1b | 5170 | :Artist: Glen Gould |
c8d0cf5c | 5171 | :Publisher: Deutsche Grammophon |
4009494e | 5172 | :NDisks: 1 |
28a16a1b | 5173 | :END: |
4009494e GM |
5174 | @end example |
5175 | ||
e66ba1df BG |
5176 | Depending on the value of @code{org-use-property-inheritance}, a property set |
5177 | this way will either be associated with a single entry, or the sub-tree | |
5178 | defined by the entry, see @ref{Property inheritance}. | |
5179 | ||
dbc28aaa CD |
5180 | You may define the allowed values for a particular property @samp{:Xyz:} |
5181 | by setting a property @samp{:Xyz_ALL:}. This special property is | |
4009494e GM |
5182 | @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
5183 | the entire tree. When allowed values are defined, setting the | |
5184 | corresponding property becomes easier and is less prone to typing | |
5185 | errors. For the example with the CD collection, we can predefine | |
5186 | publishers and the number of disks in a box like this: | |
5187 | ||
5188 | @example | |
5189 | * CD collection | |
5190 | :PROPERTIES: | |
5191 | :NDisks_ALL: 1 2 3 4 | |
64fb801f | 5192 | :Publisher_ALL: "Deutsche Grammophon" Philips EMI |
4009494e GM |
5193 | :END: |
5194 | @end example | |
5195 | ||
5196 | If you want to set properties that can be inherited by any entry in a | |
5197 | file, use a line like | |
c8d0cf5c CD |
5198 | @cindex property, _ALL |
5199 | @cindex #+PROPERTY | |
4009494e GM |
5200 | @example |
5201 | #+PROPERTY: NDisks_ALL 1 2 3 4 | |
5202 | @end example | |
5203 | ||
271672fa BG |
5204 | Contrary to properties set from a special drawer, you have to refresh the |
5205 | buffer with @kbd{C-c C-c} to activate this changes. | |
5206 | ||
e66ba1df BG |
5207 | If you want to add to the value of an existing property, append a @code{+} to |
5208 | the property name. The following results in the property @code{var} having | |
5209 | the value ``foo=1 bar=2''. | |
5210 | @cindex property, + | |
5211 | @example | |
5212 | #+PROPERTY: var foo=1 | |
5213 | #+PROPERTY: var+ bar=2 | |
5214 | @end example | |
5215 | ||
5216 | It is also possible to add to the values of inherited properties. The | |
5217 | following results in the @code{genres} property having the value ``Classic | |
5218 | Baroque'' under the @code{Goldberg Variations} subtree. | |
5219 | @cindex property, + | |
5220 | @example | |
5221 | * CD collection | |
5222 | ** Classic | |
5223 | :PROPERTIES: | |
5224 | :GENRES: Classic | |
5225 | :END: | |
5226 | *** Goldberg Variations | |
5227 | :PROPERTIES: | |
5228 | :Title: Goldberg Variations | |
5229 | :Composer: J.S. Bach | |
5230 | :Artist: Glen Gould | |
5231 | :Publisher: Deutsche Grammophon | |
5232 | :NDisks: 1 | |
5233 | :GENRES+: Baroque | |
5234 | :END: | |
5235 | @end example | |
5236 | Note that a property can only have one entry per Drawer. | |
5237 | ||
c8d0cf5c | 5238 | @vindex org-global-properties |
4009494e GM |
5239 | Property values set with the global variable |
5240 | @code{org-global-properties} can be inherited by all entries in all | |
a7808fba | 5241 | Org files. |
4009494e GM |
5242 | |
5243 | @noindent | |
5244 | The following commands help to work with properties: | |
5245 | ||
5246 | @table @kbd | |
ce57c2fe | 5247 | @orgcmd{M-@key{TAB},pcomplete} |
4009494e GM |
5248 | After an initial colon in a line, complete property keys. All keys used |
5249 | in the current file will be offered as possible completions. | |
acedf35c | 5250 | @orgcmd{C-c C-x p,org-set-property} |
dbc28aaa CD |
5251 | Set a property. This prompts for a property name and a value. If |
5252 | necessary, the property drawer is created as well. | |
271672fa | 5253 | @item C-u M-x org-insert-drawer RET |
8223b1d2 | 5254 | @cindex org-insert-drawer |
4009494e GM |
5255 | Insert a property drawer into the current entry. The drawer will be |
5256 | inserted early in the entry, but after the lines with planning | |
5257 | information like deadlines. | |
acedf35c | 5258 | @orgcmd{C-c C-c,org-property-action} |
4009494e | 5259 | With the cursor in a property drawer, this executes property commands. |
acedf35c | 5260 | @orgcmd{C-c C-c s,org-set-property} |
4009494e GM |
5261 | Set a property in the current entry. Both the property and the value |
5262 | can be inserted using completion. | |
acedf35c | 5263 | @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value} |
4009494e | 5264 | Switch property at point to the next/previous allowed value. |
acedf35c | 5265 | @orgcmd{C-c C-c d,org-delete-property} |
4009494e | 5266 | Remove a property from the current entry. |
acedf35c | 5267 | @orgcmd{C-c C-c D,org-delete-property-globally} |
4009494e | 5268 | Globally remove a property, from all entries in the current file. |
acedf35c | 5269 | @orgcmd{C-c C-c c,org-compute-property-at-point} |
dbc28aaa CD |
5270 | Compute the property at point, using the operator and scope from the |
5271 | nearest column format definition. | |
4009494e GM |
5272 | @end table |
5273 | ||
a7808fba CD |
5274 | @node Special properties, Property searches, Property syntax, Properties and Columns |
5275 | @section Special properties | |
4009494e GM |
5276 | @cindex properties, special |
5277 | ||
e66ba1df | 5278 | Special properties provide an alternative access method to Org mode features, |
ce57c2fe BG |
5279 | like the TODO state or the priority of an entry, discussed in the previous |
5280 | chapters. This interface exists so that you can include these states in a | |
5281 | column view (@pxref{Column view}), or to use them in queries. The following | |
5282 | property names are special and (except for @code{:CATEGORY:}) should not be | |
dbc28aaa | 5283 | used as keys in the properties drawer: |
4009494e | 5284 | |
8223b1d2 | 5285 | @cindex property, special, ID |
c8d0cf5c CD |
5286 | @cindex property, special, TODO |
5287 | @cindex property, special, TAGS | |
5288 | @cindex property, special, ALLTAGS | |
5289 | @cindex property, special, CATEGORY | |
5290 | @cindex property, special, PRIORITY | |
5291 | @cindex property, special, DEADLINE | |
5292 | @cindex property, special, SCHEDULED | |
5293 | @cindex property, special, CLOSED | |
5294 | @cindex property, special, TIMESTAMP | |
5295 | @cindex property, special, TIMESTAMP_IA | |
5296 | @cindex property, special, CLOCKSUM | |
8223b1d2 | 5297 | @cindex property, special, CLOCKSUM_T |
ed21c5c8 | 5298 | @cindex property, special, BLOCKED |
c8d0cf5c CD |
5299 | @c guessing that ITEM is needed in this area; also, should this list be sorted? |
5300 | @cindex property, special, ITEM | |
ce57c2fe | 5301 | @cindex property, special, FILE |
4009494e | 5302 | @example |
8223b1d2 BG |
5303 | ID @r{A globally unique ID used for synchronization during} |
5304 | @r{iCalendar or MobileOrg export.} | |
4009494e GM |
5305 | TODO @r{The TODO keyword of the entry.} |
5306 | TAGS @r{The tags defined directly in the headline.} | |
5307 | ALLTAGS @r{All tags, including inherited ones.} | |
c8d0cf5c | 5308 | CATEGORY @r{The category of an entry.} |
4009494e GM |
5309 | PRIORITY @r{The priority of the entry, a string with a single letter.} |
5310 | DEADLINE @r{The deadline time string, without the angular brackets.} | |
c8d0cf5c CD |
5311 | SCHEDULED @r{The scheduling timestamp, without the angular brackets.} |
5312 | CLOSED @r{When was this entry closed?} | |
5313 | TIMESTAMP @r{The first keyword-less timestamp in the entry.} | |
5314 | TIMESTAMP_IA @r{The first inactive timestamp in the entry.} | |
dbc28aaa | 5315 | CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} |
ce57c2fe | 5316 | @r{must be run first to compute the values in the current buffer.} |
8223b1d2 BG |
5317 | CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.} |
5318 | @r{@code{org-clock-sum-today} must be run first to compute the} | |
5319 | @r{values in the current buffer.} | |
ed21c5c8 | 5320 | BLOCKED @r{"t" if task is currently blocked by children or siblings} |
8223b1d2 | 5321 | ITEM @r{The headline of the entry.} |
ce57c2fe | 5322 | FILE @r{The filename the entry is located in.} |
4009494e GM |
5323 | @end example |
5324 | ||
a7808fba | 5325 | @node Property searches, Property inheritance, Special properties, Properties and Columns |
4009494e GM |
5326 | @section Property searches |
5327 | @cindex properties, searching | |
dbc28aaa | 5328 | @cindex searching, of properties |
4009494e | 5329 | |
a7808fba | 5330 | To create sparse trees and special lists with selection based on properties, |
c8d0cf5c | 5331 | the same commands are used as for tag searches (@pxref{Tag searches}). |
271672fa | 5332 | |
c8d0cf5c | 5333 | @table @kbd |
7b08ccf7 | 5334 | @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree} |
c8d0cf5c CD |
5335 | Create a sparse tree with all matching entries. With a |
5336 | @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
acedf35c | 5337 | @orgcmd{C-c a m,org-tags-view} |
c8d0cf5c CD |
5338 | Create a global list of tag/property matches from all agenda files. |
5339 | @xref{Matching tags and properties}. | |
acedf35c | 5340 | @orgcmd{C-c a M,org-tags-view} |
c8d0cf5c CD |
5341 | @vindex org-tags-match-list-sublevels |
5342 | Create a global list of tag matches from all agenda files, but check | |
271672fa | 5343 | only TODO items and force checking of subitems (see the option |
c8d0cf5c CD |
5344 | @code{org-tags-match-list-sublevels}). |
5345 | @end table | |
a7808fba | 5346 | |
c8d0cf5c CD |
5347 | The syntax for the search string is described in @ref{Matching tags and |
5348 | properties}. | |
dbc28aaa CD |
5349 | |
5350 | There is also a special command for creating sparse trees based on a | |
5351 | single property: | |
5352 | ||
5353 | @table @kbd | |
acedf35c | 5354 | @orgkey{C-c / p} |
dbc28aaa CD |
5355 | Create a sparse tree based on the value of a property. This first |
5356 | prompts for the name of a property, and then for a value. A sparse tree | |
5357 | is created with all entries that define this property with the given | |
acedf35c | 5358 | value. If you enclose the value in curly braces, it is interpreted as |
dbc28aaa CD |
5359 | a regular expression and matched against the property values. |
5360 | @end table | |
5361 | ||
a7808fba | 5362 | @node Property inheritance, Column view, Property searches, Properties and Columns |
dbc28aaa | 5363 | @section Property Inheritance |
a7808fba CD |
5364 | @cindex properties, inheritance |
5365 | @cindex inheritance, of properties | |
dbc28aaa | 5366 | |
c8d0cf5c | 5367 | @vindex org-use-property-inheritance |
e66ba1df | 5368 | The outline structure of Org mode documents lends itself to an |
c8d0cf5c | 5369 | inheritance model of properties: if the parent in a tree has a certain |
e66ba1df | 5370 | property, the children can inherit this property. Org mode does not |
dbc28aaa CD |
5371 | turn this on by default, because it can slow down property searches |
5372 | significantly and is often not needed. However, if you find inheritance | |
5373 | useful, you can turn it on by setting the variable | |
c8d0cf5c | 5374 | @code{org-use-property-inheritance}. It may be set to @code{t} to make |
a7808fba CD |
5375 | all properties inherited from the parent, to a list of properties |
5376 | that should be inherited, or to a regular expression that matches | |
271672fa | 5377 | inherited properties. If a property has the value @code{nil}, this is |
acedf35c | 5378 | interpreted as an explicit undefine of the property, so that inheritance |
86fbb8ca | 5379 | search will stop at this value and return @code{nil}. |
dbc28aaa | 5380 | |
e66ba1df | 5381 | Org mode has a few properties for which inheritance is hard-coded, at |
dbc28aaa CD |
5382 | least for the special applications for which they are used: |
5383 | ||
c8d0cf5c | 5384 | @cindex property, COLUMNS |
dbc28aaa CD |
5385 | @table @code |
5386 | @item COLUMNS | |
5387 | The @code{:COLUMNS:} property defines the format of column view | |
5388 | (@pxref{Column view}). It is inherited in the sense that the level | |
5389 | where a @code{:COLUMNS:} property is defined is used as the starting | |
5390 | point for a column view table, independently of the location in the | |
5391 | subtree from where columns view is turned on. | |
5392 | @item CATEGORY | |
c8d0cf5c | 5393 | @cindex property, CATEGORY |
dbc28aaa CD |
5394 | For agenda view, a category set through a @code{:CATEGORY:} property |
5395 | applies to the entire subtree. | |
5396 | @item ARCHIVE | |
c8d0cf5c | 5397 | @cindex property, ARCHIVE |
dbc28aaa CD |
5398 | For archiving, the @code{:ARCHIVE:} property may define the archive |
5399 | location for the entire subtree (@pxref{Moving subtrees}). | |
28a16a1b | 5400 | @item LOGGING |
c8d0cf5c | 5401 | @cindex property, LOGGING |
28a16a1b CD |
5402 | The LOGGING property may define logging settings for an entry or a |
5403 | subtree (@pxref{Tracking TODO state changes}). | |
dbc28aaa CD |
5404 | @end table |
5405 | ||
a7808fba CD |
5406 | @node Column view, Property API, Property inheritance, Properties and Columns |
5407 | @section Column view | |
4009494e GM |
5408 | |
5409 | A great way to view and edit properties in an outline tree is | |
c8d0cf5c | 5410 | @emph{column view}. In column view, each outline node is turned into a |
4009494e | 5411 | table row. Columns in this table provide access to properties of the |
e66ba1df | 5412 | entries. Org mode implements columns by overlaying a tabular structure |
4009494e GM |
5413 | over the headline of each item. While the headlines have been turned |
5414 | into a table row, you can still change the visibility of the outline | |
5415 | tree. For example, you get a compact table by switching to CONTENTS | |
5416 | view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
5417 | is active), but you can still open, read, and edit the entry below each | |
5418 | headline. Or, you can switch to column view after executing a sparse | |
5419 | tree command and in this way get a table only for the selected items. | |
a7808fba | 5420 | Column view also works in agenda buffers (@pxref{Agenda Views}) where |
4009494e GM |
5421 | queries have collected selected items, possibly from a number of files. |
5422 | ||
5423 | @menu | |
c0468714 GM |
5424 | * Defining columns:: The COLUMNS format property |
5425 | * Using column view:: How to create and use column view | |
5426 | * Capturing column view:: A dynamic block for column view | |
4009494e GM |
5427 | @end menu |
5428 | ||
5429 | @node Defining columns, Using column view, Column view, Column view | |
a7808fba | 5430 | @subsection Defining columns |
4009494e GM |
5431 | @cindex column view, for properties |
5432 | @cindex properties, column view | |
5433 | ||
5434 | Setting up a column view first requires defining the columns. This is | |
5435 | done by defining a column format line. | |
5436 | ||
5437 | @menu | |
c0468714 GM |
5438 | * Scope of column definitions:: Where defined, where valid? |
5439 | * Column attributes:: Appearance and content of a column | |
4009494e GM |
5440 | @end menu |
5441 | ||
5442 | @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
5443 | @subsubsection Scope of column definitions | |
5444 | ||
5445 | To define a column format for an entire file, use a line like | |
5446 | ||
c8d0cf5c | 5447 | @cindex #+COLUMNS |
4009494e GM |
5448 | @example |
5449 | #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
5450 | @end example | |
5451 | ||
dbc28aaa CD |
5452 | To specify a format that only applies to a specific tree, add a |
5453 | @code{:COLUMNS:} property to the top node of that tree, for example: | |
5454 | ||
4009494e GM |
5455 | @example |
5456 | ** Top node for columns view | |
5457 | :PROPERTIES: | |
5458 | :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
5459 | :END: | |
5460 | @end example | |
5461 | ||
dbc28aaa | 5462 | If a @code{:COLUMNS:} property is present in an entry, it defines columns |
4009494e GM |
5463 | for the entry itself, and for the entire subtree below it. Since the |
5464 | column definition is part of the hierarchical structure of the document, | |
5465 | you can define columns on level 1 that are general enough for all | |
5466 | sublevels, and more specific columns further down, when you edit a | |
5467 | deeper part of the tree. | |
5468 | ||
5469 | @node Column attributes, , Scope of column definitions, Defining columns | |
5470 | @subsubsection Column attributes | |
5471 | A column definition sets the attributes of a column. The general | |
5472 | definition looks like this: | |
5473 | ||
5474 | @example | |
c8d0cf5c | 5475 | %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}] |
4009494e GM |
5476 | @end example |
5477 | ||
5478 | @noindent | |
5479 | Except for the percent sign and the property name, all items are | |
5480 | optional. The individual parts have the following meaning: | |
5481 | ||
5482 | @example | |
c8d0cf5c | 5483 | @var{width} @r{An integer specifying the width of the column in characters.} |
72d803ad | 5484 | @r{If omitted, the width will be determined automatically.} |
c8d0cf5c | 5485 | @var{property} @r{The property that should be edited in this column.} |
72d803ad CD |
5486 | @r{Special properties representing meta data are allowed here} |
5487 | @r{as well (@pxref{Special properties})} | |
ce57c2fe | 5488 | @var{title} @r{The header text for the column. If omitted, the property} |
afe98dfa | 5489 | @r{name is used.} |
c8d0cf5c | 5490 | @{@var{summary-type}@} @r{The summary type. If specified, the column values for} |
72d803ad CD |
5491 | @r{parent nodes are computed from the children.} |
5492 | @r{Supported summary types are:} | |
5493 | @{+@} @r{Sum numbers in this column.} | |
5494 | @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.} | |
5495 | @{$@} @r{Currency, short for @samp{+;%.2f}.} | |
86fbb8ca | 5496 | @{:@} @r{Sum times, HH:MM, plain numbers are hours.} |
72d803ad CD |
5497 | @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.} |
5498 | @{X/@} @r{Checkbox status, @samp{[n/m]}.} | |
5499 | @{X%@} @r{Checkbox status, @samp{[n%]}.} | |
5500 | @{min@} @r{Smallest number in column.} | |
5501 | @{max@} @r{Largest number.} | |
5502 | @{mean@} @r{Arithmetic mean of numbers.} | |
5503 | @{:min@} @r{Smallest time value in column.} | |
5504 | @{:max@} @r{Largest time value.} | |
5505 | @{:mean@} @r{Arithmetic mean of time values.} | |
afe98dfa CD |
5506 | @{@@min@} @r{Minimum age (in days/hours/mins/seconds).} |
5507 | @{@@max@} @r{Maximum age (in days/hours/mins/seconds).} | |
5508 | @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).} | |
5509 | @{est+@} @r{Add low-high estimates.} | |
4009494e GM |
5510 | @end example |
5511 | ||
5512 | @noindent | |
a351880d | 5513 | Be aware that you can only have one summary type for any property you |
ce57c2fe | 5514 | include. Subsequent columns referencing the same property will all display the |
a351880d CD |
5515 | same summary information. |
5516 | ||
afe98dfa CD |
5517 | The @code{est+} summary type requires further explanation. It is used for |
5518 | combining estimates, expressed as low-high ranges. For example, instead | |
5519 | of estimating a particular task will take 5 days, you might estimate it as | |
f99f1641 PE |
5520 | 5--6 days if you're fairly confident you know how much work is required, or |
5521 | 1--10 days if you don't really know what needs to be done. Both ranges | |
afe98dfa CD |
5522 | average at 5.5 days, but the first represents a more predictable delivery. |
5523 | ||
5524 | When combining a set of such estimates, simply adding the lows and highs | |
ce57c2fe | 5525 | produces an unrealistically wide result. Instead, @code{est+} adds the |
afe98dfa CD |
5526 | statistical mean and variance of the sub-tasks, generating a final estimate |
5527 | from the sum. For example, suppose you had ten tasks, each of which was | |
5528 | estimated at 0.5 to 2 days of work. Straight addition produces an estimate | |
5529 | of 5 to 20 days, representing what to expect if everything goes either | |
ce57c2fe | 5530 | extremely well or extremely poorly. In contrast, @code{est+} estimates the |
f99f1641 | 5531 | full job more realistically, at 10--15 days. |
afe98dfa | 5532 | |
4009494e GM |
5533 | Here is an example for a complete columns definition, along with allowed |
5534 | values. | |
5535 | ||
5536 | @example | |
7006d207 | 5537 | :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.} |
8223b1d2 | 5538 | %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T |
4009494e GM |
5539 | :Owner_ALL: Tammy Mark Karl Lisa Don |
5540 | :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
5541 | :Approved_ALL: "[ ]" "[X]" | |
5542 | @end example | |
5543 | ||
c8d0cf5c | 5544 | @noindent |
4009494e | 5545 | The first column, @samp{%25ITEM}, means the first 25 characters of the |
1df7defd | 5546 | item itself, i.e., of the headline. You probably always should start the |
28a16a1b CD |
5547 | column definition with the @samp{ITEM} specifier. The other specifiers |
5548 | create columns @samp{Owner} with a list of names as allowed values, for | |
4009494e GM |
5549 | @samp{Status} with four different possible values, and for a checkbox |
5550 | field @samp{Approved}. When no width is given after the @samp{%} | |
5551 | character, the column will be exactly as wide as it needs to be in order | |
5552 | to fully display all values. The @samp{Approved} column does have a | |
5553 | modified title (@samp{Approved?}, with a question mark). Summaries will | |
dbc28aaa | 5554 | be created for the @samp{Time_Estimate} column by adding time duration |
4009494e | 5555 | expressions like HH:MM, and for the @samp{Approved} column, by providing |
dbc28aaa | 5556 | an @samp{[X]} status if all children have been checked. The |
8223b1d2 BG |
5557 | @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the |
5558 | sums of CLOCK intervals in the subtree, either for all clocks or just for | |
5559 | today. | |
4009494e | 5560 | |
a7808fba CD |
5561 | @node Using column view, Capturing column view, Defining columns, Column view |
5562 | @subsection Using column view | |
4009494e GM |
5563 | |
5564 | @table @kbd | |
5565 | @tsubheading{Turning column view on and off} | |
acedf35c | 5566 | @orgcmd{C-c C-x C-c,org-columns} |
c8d0cf5c CD |
5567 | @vindex org-columns-default-format |
5568 | Turn on column view. If the cursor is before the first headline in the file, | |
5569 | column view is turned on for the entire file, using the @code{#+COLUMNS} | |
a351880d | 5570 | definition. If the cursor is somewhere inside the outline, this command |
c8d0cf5c CD |
5571 | searches the hierarchy, up from point, for a @code{:COLUMNS:} property that |
5572 | defines a format. When one is found, the column view table is established | |
5573 | for the tree starting at the entry that contains the @code{:COLUMNS:} | |
5574 | property. If no such property is found, the format is taken from the | |
5575 | @code{#+COLUMNS} line or from the variable @code{org-columns-default-format}, | |
5576 | and column view is established for the current entry and its subtree. | |
acedf35c | 5577 | @orgcmd{r,org-columns-redo} |
a7808fba | 5578 | Recreate the column view, to include recent changes made in the buffer. |
acedf35c | 5579 | @orgcmd{g,org-columns-redo} |
28a16a1b | 5580 | Same as @kbd{r}. |
acedf35c | 5581 | @orgcmd{q,org-columns-quit} |
4009494e GM |
5582 | Exit column view. |
5583 | @tsubheading{Editing values} | |
5584 | @item @key{left} @key{right} @key{up} @key{down} | |
5585 | Move through the column view from field to field. | |
5586 | @kindex S-@key{left} | |
5587 | @kindex S-@key{right} | |
5588 | @item S-@key{left}/@key{right} | |
5589 | Switch to the next/previous allowed value of the field. For this, you | |
5590 | have to have specified allowed values for a property. | |
b349f79f | 5591 | @item 1..9,0 |
acedf35c CD |
5592 | Directly select the Nth allowed value, @kbd{0} selects the 10th value. |
5593 | @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value} | |
4009494e | 5594 | Same as @kbd{S-@key{left}/@key{right}} |
acedf35c | 5595 | @orgcmd{e,org-columns-edit-value} |
4009494e GM |
5596 | Edit the property at point. For the special properties, this will |
5597 | invoke the same interface that you normally use to change that | |
5598 | property. For example, when editing a TAGS property, the tag completion | |
5599 | or fast selection interface will pop up. | |
acedf35c | 5600 | @orgcmd{C-c C-c,org-columns-set-tags-or-toggle} |
dbc28aaa | 5601 | When there is a checkbox at point, toggle it. |
acedf35c | 5602 | @orgcmd{v,org-columns-show-value} |
4009494e GM |
5603 | View the full value of this property. This is useful if the width of |
5604 | the column is smaller than that of the value. | |
acedf35c | 5605 | @orgcmd{a,org-columns-edit-allowed} |
4009494e GM |
5606 | Edit the list of allowed values for this property. If the list is found |
5607 | in the hierarchy, the modified values is stored there. If no list is | |
5608 | found, the new value is stored in the first entry that is part of the | |
5609 | current column view. | |
5610 | @tsubheading{Modifying the table structure} | |
acedf35c | 5611 | @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen} |
4009494e | 5612 | Make the column narrower/wider by one character. |
acedf35c | 5613 | @orgcmd{S-M-@key{right},org-columns-new} |
864c9740 | 5614 | Insert a new column, to the left of the current column. |
acedf35c | 5615 | @orgcmd{S-M-@key{left},org-columns-delete} |
4009494e GM |
5616 | Delete the current column. |
5617 | @end table | |
5618 | ||
a7808fba CD |
5619 | @node Capturing column view, , Using column view, Column view |
5620 | @subsection Capturing column view | |
dbc28aaa CD |
5621 | |
5622 | Since column view is just an overlay over a buffer, it cannot be | |
5623 | exported or printed directly. If you want to capture a column view, use | |
c8d0cf5c | 5624 | a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame |
28a16a1b | 5625 | of this block looks like this: |
dbc28aaa | 5626 | |
c8d0cf5c | 5627 | @cindex #+BEGIN, columnview |
dbc28aaa CD |
5628 | @example |
5629 | * The column view | |
5630 | #+BEGIN: columnview :hlines 1 :id "label" | |
5631 | ||
5632 | #+END: | |
5633 | @end example | |
5634 | ||
5635 | @noindent This dynamic block has the following parameters: | |
5636 | ||
5637 | @table @code | |
5638 | @item :id | |
c8d0cf5c | 5639 | This is the most important parameter. Column view is a feature that is |
dbc28aaa | 5640 | often localized to a certain (sub)tree, and the capture block might be |
c8d0cf5c CD |
5641 | at a different location in the file. To identify the tree whose view to |
5642 | capture, you can use 4 values: | |
5643 | @cindex property, ID | |
dbc28aaa CD |
5644 | @example |
5645 | local @r{use the tree in which the capture block is located} | |
5646 | global @r{make a global view, including all headings in the file} | |
c8d0cf5c | 5647 | "file:@var{path-to-file}" |
55e0839d | 5648 | @r{run column view at the top of this file} |
c8d0cf5c | 5649 | "@var{ID}" @r{call column view in the tree that has an @code{:ID:}} |
b349f79f | 5650 | @r{property with the value @i{label}. You can use} |
271672fa | 5651 | @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for} |
b349f79f | 5652 | @r{the current entry and copy it to the kill-ring.} |
dbc28aaa CD |
5653 | @end example |
5654 | @item :hlines | |
c8d0cf5c CD |
5655 | When @code{t}, insert an hline after every line. When a number @var{N}, insert |
5656 | an hline before each headline with level @code{<= @var{N}}. | |
dbc28aaa | 5657 | @item :vlines |
c8d0cf5c | 5658 | When set to @code{t}, force column groups to get vertical lines. |
28a16a1b CD |
5659 | @item :maxlevel |
5660 | When set to a number, don't capture entries below this level. | |
5661 | @item :skip-empty-rows | |
c8d0cf5c | 5662 | When set to @code{t}, skip rows where the only non-empty specifier of the |
28a16a1b CD |
5663 | column view is @code{ITEM}. |
5664 | ||
dbc28aaa CD |
5665 | @end table |
5666 | ||
5667 | @noindent | |
5668 | The following commands insert or update the dynamic block: | |
5669 | ||
5670 | @table @kbd | |
acedf35c | 5671 | @orgcmd{C-c C-x i,org-insert-columns-dblock} |
dbc28aaa | 5672 | Insert a dynamic block capturing a column view. You will be prompted |
c8d0cf5c | 5673 | for the scope or ID of the view. |
acedf35c | 5674 | @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} |
c8d0cf5c | 5675 | Update dynamic block at point. The cursor needs to be in the |
dbc28aaa | 5676 | @code{#+BEGIN} line of the dynamic block. |
acedf35c | 5677 | @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks} |
dbc28aaa | 5678 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if |
acedf35c CD |
5679 | you have several clock table blocks, column-capturing blocks or other dynamic |
5680 | blocks in a buffer. | |
dbc28aaa CD |
5681 | @end table |
5682 | ||
864c9740 | 5683 | You can add formulas to the column view table and you may add plotting |
c8d0cf5c | 5684 | instructions in front of the table---these will survive an update of the |
864c9740 CD |
5685 | block. If there is a @code{#+TBLFM:} after the table, the table will |
5686 | actually be recalculated automatically after an update. | |
5687 | ||
c8d0cf5c CD |
5688 | An alternative way to capture and process property values into a table is |
5689 | provided by Eric Schulte's @file{org-collector.el} which is a contributed | |
5690 | package@footnote{Contributed packages are not part of Emacs, but are | |
5691 | distributed with the main distribution of Org (visit | |
5692 | @uref{http://orgmode.org}).}. It provides a general API to collect | |
5693 | properties from entries in a certain scope, and arbitrary Lisp expressions to | |
5694 | process these values before inserting them into a table or a dynamic block. | |
5695 | ||
a7808fba | 5696 | @node Property API, , Column view, Properties and Columns |
4009494e GM |
5697 | @section The Property API |
5698 | @cindex properties, API | |
5699 | @cindex API, for properties | |
5700 | ||
5701 | There is a full API for accessing and changing properties. This API can | |
5702 | be used by Emacs Lisp programs to work with properties and to implement | |
5703 | features based on them. For more information see @ref{Using the | |
5704 | property API}. | |
5705 | ||
a351880d | 5706 | @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top |
86fbb8ca | 5707 | @chapter Dates and times |
dbc28aaa CD |
5708 | @cindex dates |
5709 | @cindex times | |
c8d0cf5c CD |
5710 | @cindex timestamp |
5711 | @cindex date stamp | |
4009494e | 5712 | |
dbc28aaa CD |
5713 | To assist project planning, TODO items can be labeled with a date and/or |
5714 | a time. The specially formatted string carrying the date and time | |
e66ba1df | 5715 | information is called a @emph{timestamp} in Org mode. This may be a |
dbc28aaa | 5716 | little confusing because timestamp is often used as indicating when |
e66ba1df | 5717 | something was created or last changed. However, in Org mode this term |
dbc28aaa | 5718 | is used in a much wider sense. |
4009494e GM |
5719 | |
5720 | @menu | |
c0468714 GM |
5721 | * Timestamps:: Assigning a time to a tree entry |
5722 | * Creating timestamps:: Commands which insert timestamps | |
5723 | * Deadlines and scheduling:: Planning your work | |
5724 | * Clocking work time:: Tracking how long you spend on a task | |
c0468714 GM |
5725 | * Effort estimates:: Planning work effort in advance |
5726 | * Relative timer:: Notes with a running timer | |
afe98dfa | 5727 | * Countdown timer:: Starting a countdown timer for a task |
4009494e GM |
5728 | @end menu |
5729 | ||
5730 | ||
a7808fba | 5731 | @node Timestamps, Creating timestamps, Dates and Times, Dates and Times |
c8d0cf5c CD |
5732 | @section Timestamps, deadlines, and scheduling |
5733 | @cindex timestamps | |
4009494e GM |
5734 | @cindex ranges, time |
5735 | @cindex date stamps | |
5736 | @cindex deadlines | |
5737 | @cindex scheduling | |
5738 | ||
7006d207 | 5739 | A timestamp is a specification of a date (possibly with a time or a range of |
e66ba1df BG |
5740 | times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this |
5741 | simplest form, the day name is optional when you type the date yourself. | |
5742 | However, any dates inserted or modified by Org will add that day name, for | |
5743 | reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 | |
5744 | Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 | |
5745 | date/time format. To use an alternative format, see @ref{Custom time | |
5746 | format}.}. A timestamp can appear anywhere in the headline or body of an Org | |
5747 | tree entry. Its presence causes entries to be shown on specific dates in the | |
5748 | agenda (@pxref{Weekly/daily agenda}). We distinguish: | |
4009494e GM |
5749 | |
5750 | @table @var | |
c8d0cf5c | 5751 | @item Plain timestamp; Event; Appointment |
4009494e | 5752 | @cindex timestamp |
e66ba1df | 5753 | @cindex appointment |
c8d0cf5c | 5754 | A simple timestamp just assigns a date/time to an item. This is just |
dbc28aaa CD |
5755 | like writing down an appointment or event in a paper agenda. In the |
5756 | timeline and agenda displays, the headline of an entry associated with a | |
c8d0cf5c | 5757 | plain timestamp will be shown exactly on that date. |
4009494e GM |
5758 | |
5759 | @example | |
8223b1d2 BG |
5760 | * Meet Peter at the movies |
5761 | <2006-11-01 Wed 19:15> | |
5762 | * Discussion on climate change | |
5763 | <2006-11-02 Thu 20:00-22:00> | |
4009494e GM |
5764 | @end example |
5765 | ||
c8d0cf5c | 5766 | @item Timestamp with repeater interval |
4009494e | 5767 | @cindex timestamp, with repeater interval |
c8d0cf5c | 5768 | A timestamp may contain a @emph{repeater interval}, indicating that it |
4009494e | 5769 | applies not only on the given date, but again and again after a certain |
c8d0cf5c | 5770 | interval of N days (d), weeks (w), months (m), or years (y). The |
4009494e GM |
5771 | following will show up in the agenda every Wednesday: |
5772 | ||
5773 | @example | |
8223b1d2 BG |
5774 | * Pick up Sam at school |
5775 | <2007-05-16 Wed 12:30 +1w> | |
4009494e GM |
5776 | @end example |
5777 | ||
5778 | @item Diary-style sexp entries | |
e66ba1df | 5779 | For more complex date specifications, Org mode supports using the special |
ce57c2fe BG |
5780 | sexp diary entries implemented in the Emacs calendar/diary |
5781 | package@footnote{When working with the standard diary sexp functions, you | |
5782 | need to be very careful with the order of the arguments. That order depend | |
5783 | evilly on the variable @code{calendar-date-style} (or, for older Emacs | |
5784 | versions, @code{european-calendar-style}). For example, to specify a date | |
5785 | December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or | |
5786 | @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on | |
e66ba1df | 5787 | the settings. This has been the source of much confusion. Org mode users |
ce57c2fe BG |
5788 | can resort to special versions of these functions like @code{org-date} or |
5789 | @code{org-anniversary}. These work just like the corresponding @code{diary-} | |
5790 | functions, but with stable ISO order of arguments (year, month, day) wherever | |
153ae947 BG |
5791 | applicable, independent of the value of @code{calendar-date-style}.}. For |
5792 | example with optional time | |
4009494e GM |
5793 | |
5794 | @example | |
153ae947 | 5795 | * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month |
c7cf0ebc | 5796 | <%%(diary-float t 4 2)> |
4009494e GM |
5797 | @end example |
5798 | ||
5799 | @item Time/Date range | |
5800 | @cindex timerange | |
5801 | @cindex date range | |
c8d0cf5c | 5802 | Two timestamps connected by @samp{--} denote a range. The headline |
4009494e GM |
5803 | will be shown on the first and last day of the range, and on any dates |
5804 | that are displayed and fall in the range. Here is an example: | |
5805 | ||
5806 | @example | |
5807 | ** Meeting in Amsterdam | |
5808 | <2004-08-23 Mon>--<2004-08-26 Thu> | |
5809 | @end example | |
5810 | ||
c8d0cf5c | 5811 | @item Inactive timestamp |
4009494e GM |
5812 | @cindex timestamp, inactive |
5813 | @cindex inactive timestamp | |
c8d0cf5c CD |
5814 | Just like a plain timestamp, but with square brackets instead of |
5815 | angular ones. These timestamps are inactive in the sense that they do | |
4009494e GM |
5816 | @emph{not} trigger an entry to show up in the agenda. |
5817 | ||
5818 | @example | |
8223b1d2 BG |
5819 | * Gillian comes late for the fifth time |
5820 | [2006-11-01 Wed] | |
4009494e GM |
5821 | @end example |
5822 | ||
5823 | @end table | |
5824 | ||
a7808fba | 5825 | @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
4009494e GM |
5826 | @section Creating timestamps |
5827 | @cindex creating timestamps | |
5828 | @cindex timestamps, creating | |
5829 | ||
e66ba1df | 5830 | For Org mode to recognize timestamps, they need to be in the specific |
c8d0cf5c | 5831 | format. All commands listed below produce timestamps in the correct |
4009494e GM |
5832 | format. |
5833 | ||
5834 | @table @kbd | |
afe98dfa | 5835 | @orgcmd{C-c .,org-time-stamp} |
c8d0cf5c CD |
5836 | Prompt for a date and insert a corresponding timestamp. When the cursor is |
5837 | at an existing timestamp in the buffer, the command is used to modify this | |
864c9740 CD |
5838 | timestamp instead of inserting a new one. When this command is used twice in |
5839 | succession, a time range is inserted. | |
4009494e | 5840 | @c |
afe98dfa | 5841 | @orgcmd{C-c !,org-time-stamp-inactive} |
c8d0cf5c | 5842 | Like @kbd{C-c .}, but insert an inactive timestamp that will not cause |
4009494e GM |
5843 | an agenda entry. |
5844 | @c | |
c8d0cf5c CD |
5845 | @kindex C-u C-c . |
5846 | @kindex C-u C-c ! | |
5847 | @item C-u C-c . | |
5848 | @itemx C-u C-c ! | |
5849 | @vindex org-time-stamp-rounding-minutes | |
5850 | Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which | |
5851 | contains date and time. The default time can be rounded to multiples of 5 | |
5852 | minutes, see the option @code{org-time-stamp-rounding-minutes}. | |
5853 | @c | |
e66ba1df BG |
5854 | @orgkey{C-c C-c} |
5855 | Normalize timestamp, insert/fix day name if missing or wrong. | |
5856 | @c | |
afe98dfa | 5857 | @orgcmd{C-c <,org-date-from-calendar} |
c8d0cf5c | 5858 | Insert a timestamp corresponding to the cursor date in the Calendar. |
4009494e | 5859 | @c |
afe98dfa | 5860 | @orgcmd{C-c >,org-goto-calendar} |
4009494e | 5861 | Access the Emacs calendar for the current date. If there is a |
a7808fba | 5862 | timestamp in the current line, go to the corresponding date |
4009494e GM |
5863 | instead. |
5864 | @c | |
afe98dfa | 5865 | @orgcmd{C-c C-o,org-open-at-point} |
c8d0cf5c | 5866 | Access the agenda for the date given by the timestamp or -range at |
a7808fba | 5867 | point (@pxref{Weekly/daily agenda}). |
4009494e | 5868 | @c |
acedf35c | 5869 | @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day} |
4009494e | 5870 | Change date at cursor by one day. These key bindings conflict with |
c8d0cf5c | 5871 | shift-selection and related modes (@pxref{Conflicts}). |
4009494e | 5872 | @c |
acedf35c | 5873 | @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down} |
4009494e | 5874 | Change the item under the cursor in a timestamp. The cursor can be on a |
c8d0cf5c CD |
5875 | year, month, day, hour or minute. When the timestamp contains a time range |
5876 | like @samp{15:30-16:30}, modifying the first time will also shift the second, | |
5877 | shifting the time block with constant length. To change the length, modify | |
5878 | the second time. Note that if the cursor is in a headline and not at a | |
5879 | timestamp, these same keys modify the priority of an item. | |
ce57c2fe | 5880 | (@pxref{Priorities}). The key bindings also conflict with shift-selection and |
c8d0cf5c | 5881 | related modes (@pxref{Conflicts}). |
4009494e | 5882 | @c |
acedf35c | 5883 | @orgcmd{C-c C-y,org-evaluate-time-range} |
4009494e | 5884 | @cindex evaluate time range |
a7808fba CD |
5885 | Evaluate a time range by computing the difference between start and end. |
5886 | With a prefix argument, insert result after the time range (in a table: into | |
5887 | the following column). | |
4009494e GM |
5888 | @end table |
5889 | ||
5890 | ||
5891 | @menu | |
e66ba1df | 5892 | * The date/time prompt:: How Org mode helps you entering date and time |
c0468714 | 5893 | * Custom time format:: Making dates look different |
4009494e GM |
5894 | @end menu |
5895 | ||
5896 | @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
5897 | @subsection The date/time prompt | |
5898 | @cindex date, reading in minibuffer | |
5899 | @cindex time, reading in minibuffer | |
5900 | ||
c8d0cf5c | 5901 | @vindex org-read-date-prefer-future |
e66ba1df | 5902 | When Org mode prompts for a date/time, the default is shown in default |
7006d207 | 5903 | date/time format, and the prompt therefore seems to ask for a specific |
271672fa BG |
5904 | format. But it will in fact accept date/time information in a variety of |
5905 | formats. Generally, the information should start at the beginning of the | |
5906 | string. Org mode will find whatever information is in | |
7006d207 CD |
5907 | there and derive anything you have not specified from the @emph{default date |
5908 | and time}. The default is usually the current date and time, but when | |
5909 | modifying an existing timestamp, or when entering the second stamp of a | |
5910 | range, it is taken from the stamp in the buffer. When filling in | |
e66ba1df | 5911 | information, Org mode assumes that most of the time you will want to enter a |
7006d207 CD |
5912 | date in the future: if you omit the month/year and the given day/month is |
5913 | @i{before} today, it will assume that you mean a future date@footnote{See the | |
a351880d CD |
5914 | variable @code{org-read-date-prefer-future}. You may set that variable to |
5915 | the symbol @code{time} to even make a time before now shift the date to | |
5916 | tomorrow.}. If the date has been automatically shifted into the future, the | |
5917 | time prompt will show this with @samp{(=>F).} | |
dbc28aaa | 5918 | |
07450bee | 5919 | For example, let's assume that today is @b{June 13, 2006}. Here is how |
e66ba1df | 5920 | various inputs will be interpreted, the items filled in by Org mode are |
dbc28aaa CD |
5921 | in @b{bold}. |
5922 | ||
5923 | @example | |
ce57c2fe BG |
5924 | 3-2-5 @result{} 2003-02-05 |
5925 | 2/5/3 @result{} 2003-02-05 | |
5926 | 14 @result{} @b{2006}-@b{06}-14 | |
5927 | 12 @result{} @b{2006}-@b{07}-12 | |
5928 | 2/5 @result{} @b{2007}-02-05 | |
271672fa | 5929 | Fri @result{} nearest Friday after the default date |
ce57c2fe BG |
5930 | sep 15 @result{} @b{2006}-09-15 |
5931 | feb 15 @result{} @b{2007}-02-15 | |
5932 | sep 12 9 @result{} 2009-09-12 | |
5933 | 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45 | |
5934 | 22 sept 0:34 @result{} @b{2006}-09-22 0:34 | |
5935 | w4 @result{} ISO week for of the current year @b{2006} | |
5936 | 2012 w4 fri @result{} Friday of ISO week 4 in 2012 | |
5937 | 2012-w04-5 @result{} Same as above | |
dbc28aaa CD |
5938 | @end example |
5939 | ||
271672fa BG |
5940 | Furthermore you can specify a relative date by giving, as the @emph{first} |
5941 | thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to | |
5942 | indicate change in hours, days, weeks, months, or years. With a single plus | |
5943 | or minus, the date is always relative to today. With a double plus or minus, | |
5944 | it is relative to the default date. If instead of a single letter, you use | |
5945 | the abbreviation of day name, the date will be the Nth such day, e.g.: | |
dbc28aaa CD |
5946 | |
5947 | @example | |
ce57c2fe BG |
5948 | +0 @result{} today |
5949 | . @result{} today | |
5950 | +4d @result{} four days from today | |
5951 | +4 @result{} same as above | |
5952 | +2w @result{} two weeks from today | |
5953 | ++5 @result{} five days from default date | |
271672fa BG |
5954 | +2tue @result{} second Tuesday from now |
5955 | -wed @result{} last Wednesday | |
4009494e GM |
5956 | @end example |
5957 | ||
c8d0cf5c CD |
5958 | @vindex parse-time-months |
5959 | @vindex parse-time-weekdays | |
4009494e GM |
5960 | The function understands English month and weekday abbreviations. If |
5961 | you want to use unabbreviated names and/or other languages, configure | |
5962 | the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
5963 | ||
ce57c2fe BG |
5964 | @vindex org-read-date-force-compatible-dates |
5965 | Not all dates can be represented in a given Emacs implementation. By default | |
5966 | Org mode forces dates into the compatibility range 1970--2037 which works on | |
5967 | all Emacs implementations. If you want to use dates outside of this range, | |
5968 | read the docstring of the variable | |
5969 | @code{org-read-date-force-compatible-dates}. | |
5970 | ||
afe98dfa | 5971 | You can specify a time range by giving start and end times or by giving a |
ce57c2fe BG |
5972 | start time and a duration (in HH:MM format). Use one or two dash(es) as the |
5973 | separator in the former case and use '+' as the separator in the latter | |
1df7defd | 5974 | case, e.g.: |
afe98dfa CD |
5975 | |
5976 | @example | |
ce57c2fe BG |
5977 | 11am-1:15pm @result{} 11:00-13:15 |
5978 | 11am--1:15pm @result{} same as above | |
5979 | 11am+2:15 @result{} same as above | |
afe98dfa CD |
5980 | @end example |
5981 | ||
4009494e | 5982 | @cindex calendar, for selecting date |
c8d0cf5c | 5983 | @vindex org-popup-calendar-for-date-prompt |
4009494e GM |
5984 | Parallel to the minibuffer prompt, a calendar is popped up@footnote{If |
5985 | you don't need/want the calendar, configure the variable | |
5986 | @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
5987 | prompt, either by clicking on a date in the calendar, or by pressing | |
5988 | @key{RET}, the date selected in the calendar will be combined with the | |
5989 | information entered at the prompt. You can control the calendar fully | |
5990 | from the minibuffer: | |
5991 | ||
4009494e | 5992 | @kindex < |
4009494e | 5993 | @kindex > |
86fbb8ca CD |
5994 | @kindex M-v |
5995 | @kindex C-v | |
4009494e | 5996 | @kindex mouse-1 |
4009494e | 5997 | @kindex S-@key{right} |
4009494e | 5998 | @kindex S-@key{left} |
4009494e | 5999 | @kindex S-@key{down} |
4009494e | 6000 | @kindex S-@key{up} |
4009494e | 6001 | @kindex M-S-@key{right} |
4009494e | 6002 | @kindex M-S-@key{left} |
4009494e | 6003 | @kindex @key{RET} |
dbc28aaa | 6004 | @example |
86fbb8ca | 6005 | @key{RET} @r{Choose date at cursor in calendar.} |
dbc28aaa CD |
6006 | mouse-1 @r{Select date by clicking on it.} |
6007 | S-@key{right}/@key{left} @r{One day forward/backward.} | |
6008 | S-@key{down}/@key{up} @r{One week forward/backward.} | |
6009 | M-S-@key{right}/@key{left} @r{One month forward/backward.} | |
86fbb8ca CD |
6010 | > / < @r{Scroll calendar forward/backward by one month.} |
6011 | M-v / C-v @r{Scroll calendar forward/backward by 3 months.} | |
dbc28aaa CD |
6012 | @end example |
6013 | ||
c8d0cf5c | 6014 | @vindex org-read-date-display-live |
a7808fba CD |
6015 | The actions of the date/time prompt may seem complex, but I assure you they |
6016 | will grow on you, and you will start getting annoyed by pretty much any other | |
6017 | way of entering a date/time out there. To help you understand what is going | |
6018 | on, the current interpretation of your input will be displayed live in the | |
271672fa | 6019 | minibuffer@footnote{If you find this distracting, turn the display off with |
a7808fba | 6020 | @code{org-read-date-display-live}.}. |
4009494e GM |
6021 | |
6022 | @node Custom time format, , The date/time prompt, Creating timestamps | |
6023 | @subsection Custom time format | |
6024 | @cindex custom date/time format | |
6025 | @cindex time format, custom | |
6026 | @cindex date format, custom | |
6027 | ||
c8d0cf5c CD |
6028 | @vindex org-display-custom-times |
6029 | @vindex org-time-stamp-custom-formats | |
e66ba1df | 6030 | Org mode uses the standard ISO notation for dates and times as it is |
4009494e GM |
6031 | defined in ISO 8601. If you cannot get used to this and require another |
6032 | representation of date and time to keep you happy, you can get it by | |
271672fa | 6033 | customizing the options @code{org-display-custom-times} and |
4009494e GM |
6034 | @code{org-time-stamp-custom-formats}. |
6035 | ||
6036 | @table @kbd | |
acedf35c | 6037 | @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays} |
4009494e GM |
6038 | Toggle the display of custom formats for dates and times. |
6039 | @end table | |
6040 | ||
6041 | @noindent | |
e66ba1df | 6042 | Org mode needs the default format for scanning, so the custom date/time |
c8d0cf5c | 6043 | format does not @emph{replace} the default format---instead it is put |
4009494e GM |
6044 | @emph{over} the default format using text properties. This has the |
6045 | following consequences: | |
6046 | @itemize @bullet | |
28a16a1b | 6047 | @item |
c8d0cf5c | 6048 | You cannot place the cursor onto a timestamp anymore, only before or |
4009494e GM |
6049 | after. |
6050 | @item | |
6051 | The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
c8d0cf5c | 6052 | each component of a timestamp. If the cursor is at the beginning of |
4009494e GM |
6053 | the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, |
6054 | just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
6055 | time will be changed by one minute. | |
6056 | @item | |
c8d0cf5c | 6057 | If the timestamp contains a range of clock times or a repeater, these |
acedf35c | 6058 | will not be overlaid, but remain in the buffer as they were. |
4009494e | 6059 | @item |
c8d0cf5c | 6060 | When you delete a timestamp character-by-character, it will only |
4009494e GM |
6061 | disappear from the buffer after @emph{all} (invisible) characters |
6062 | belonging to the ISO timestamp have been removed. | |
6063 | @item | |
c8d0cf5c | 6064 | If the custom timestamp format is longer than the default and you are |
4009494e GM |
6065 | using dates in tables, table alignment will be messed up. If the custom |
6066 | format is shorter, things do work as expected. | |
6067 | @end itemize | |
6068 | ||
6069 | ||
a7808fba CD |
6070 | @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times |
6071 | @section Deadlines and scheduling | |
4009494e | 6072 | |
c8d0cf5c | 6073 | A timestamp may be preceded by special keywords to facilitate planning: |
4009494e GM |
6074 | |
6075 | @table @var | |
6076 | @item DEADLINE | |
6077 | @cindex DEADLINE keyword | |
dbc28aaa CD |
6078 | |
6079 | Meaning: the task (most likely a TODO item, though not necessarily) is supposed | |
6080 | to be finished on that date. | |
6081 | ||
c8d0cf5c | 6082 | @vindex org-deadline-warning-days |
271672fa | 6083 | @vindex org-agenda-skip-deadline-prewarning-if-scheduled |
dbc28aaa CD |
6084 | On the deadline date, the task will be listed in the agenda. In |
6085 | addition, the agenda for @emph{today} will carry a warning about the | |
6086 | approaching or missed deadline, starting | |
6087 | @code{org-deadline-warning-days} before the due date, and continuing | |
1df7defd | 6088 | until the entry is marked DONE@. An example: |
4009494e GM |
6089 | |
6090 | @example | |
6091 | *** TODO write article about the Earth for the Guide | |
4009494e | 6092 | DEADLINE: <2004-02-29 Sun> |
801a68c8 | 6093 | The editor in charge is [[bbdb:Ford Prefect]] |
4009494e GM |
6094 | @end example |
6095 | ||
6096 | You can specify a different lead time for warnings for a specific | |
6097 | deadlines using the following syntax. Here is an example with a warning | |
271672fa BG |
6098 | period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is |
6099 | deactivated if the task get scheduled and you set | |
6100 | @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. | |
4009494e GM |
6101 | |
6102 | @item SCHEDULED | |
6103 | @cindex SCHEDULED keyword | |
dbc28aaa CD |
6104 | |
6105 | Meaning: you are planning to start working on that task on the given | |
6106 | date. | |
6107 | ||
c8d0cf5c | 6108 | @vindex org-agenda-skip-scheduled-if-done |
dbc28aaa | 6109 | The headline will be listed under the given date@footnote{It will still |
1df7defd | 6110 | be listed on that date after it has been marked DONE@. If you don't like |
4009494e GM |
6111 | this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
6112 | addition, a reminder that the scheduled date has passed will be present | |
1df7defd | 6113 | in the compilation for @emph{today}, until the entry is marked DONE, i.e., |
acedf35c | 6114 | the task will automatically be forwarded until completed. |
4009494e GM |
6115 | |
6116 | @example | |
6117 | *** TODO Call Trillian for a date on New Years Eve. | |
6118 | SCHEDULED: <2004-12-25 Sat> | |
6119 | @end example | |
dbc28aaa | 6120 | |
271672fa BG |
6121 | @vindex org-scheduled-delay-days |
6122 | @vindex org-agenda-skip-scheduled-delay-if-deadline | |
6123 | If you want to @emph{delay} the display of this task in the agenda, use | |
6124 | @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the | |
6125 | 25th but will appear two days later. In case the task contains a repeater, | |
6126 | the delay is considered to affect all occurrences; if you want the delay to | |
6127 | only affect the first scheduled occurrence of the task, use @code{--2d} | |
6128 | instead. See @code{org-scheduled-delay-days} and | |
6129 | @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to | |
6130 | control this globally or per agenda. | |
6131 | ||
dbc28aaa | 6132 | @noindent |
e66ba1df | 6133 | @b{Important:} Scheduling an item in Org mode should @i{not} be |
dbc28aaa CD |
6134 | understood in the same way that we understand @i{scheduling a meeting}. |
6135 | Setting a date for a meeting is just a simple appointment, you should | |
c8d0cf5c CD |
6136 | mark this entry with a simple plain timestamp, to get this item shown |
6137 | on the date where it applies. This is a frequent misunderstanding by | |
e66ba1df | 6138 | Org users. In Org mode, @i{scheduling} means setting a date when you |
dbc28aaa | 6139 | want to start working on an action item. |
4009494e GM |
6140 | @end table |
6141 | ||
c8d0cf5c | 6142 | You may use timestamps with repeaters in scheduling and deadline |
e66ba1df | 6143 | entries. Org mode will issue early and late warnings based on the |
c8d0cf5c | 6144 | assumption that the timestamp represents the @i{nearest instance} of |
dbc28aaa CD |
6145 | the repeater. However, the use of diary sexp entries like |
6146 | @c | |
c7cf0ebc | 6147 | @code{<%%(diary-float t 42)>} |
dbc28aaa | 6148 | @c |
e66ba1df | 6149 | in scheduling and deadline timestamps is limited. Org mode does not |
dbc28aaa CD |
6150 | know enough about the internals of each sexp function to issue early and |
6151 | late warnings. However, it will show the item on each day where the | |
6152 | sexp entry matches. | |
6153 | ||
4009494e | 6154 | @menu |
c0468714 GM |
6155 | * Inserting deadline/schedule:: Planning items |
6156 | * Repeated tasks:: Items that show up again and again | |
4009494e GM |
6157 | @end menu |
6158 | ||
6159 | @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling | |
a7808fba | 6160 | @subsection Inserting deadlines or schedules |
4009494e | 6161 | |
ce57c2fe BG |
6162 | The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and |
6163 | @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put | |
6164 | any text between this line and the headline.} a deadline or to schedule | |
4009494e GM |
6165 | an item: |
6166 | ||
6167 | @table @kbd | |
6168 | @c | |
acedf35c | 6169 | @orgcmd{C-c C-d,org-deadline} |
a351880d | 6170 | Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen |
ce57c2fe | 6171 | in the line directly following the headline. Any CLOSED timestamp will be |
91af3942 | 6172 | removed. When called with a prefix arg, an existing deadline will be removed |
ce57c2fe | 6173 | from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding |
a351880d CD |
6174 | @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline}, |
6175 | and @code{nologredeadline}}, a note will be taken when changing an existing | |
6176 | deadline. | |
ce57c2fe | 6177 | |
acedf35c | 6178 | @orgcmd{C-c C-s,org-schedule} |
4009494e | 6179 | Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will |
a351880d CD |
6180 | happen in the line directly following the headline. Any CLOSED timestamp |
6181 | will be removed. When called with a prefix argument, remove the scheduling | |
6182 | date from the entry. Depending on the variable | |
6183 | @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} | |
ce57c2fe BG |
6184 | keywords @code{logreschedule}, @code{lognotereschedule}, and |
6185 | @code{nologreschedule}}, a note will be taken when changing an existing | |
a351880d | 6186 | scheduling time. |
b349f79f | 6187 | @c |
acedf35c | 6188 | @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action} |
b349f79f CD |
6189 | @kindex k a |
6190 | @kindex k s | |
b349f79f CD |
6191 | Mark the current entry for agenda action. After you have marked the entry |
6192 | like this, you can open the agenda or the calendar to find an appropriate | |
6193 | date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to | |
6194 | schedule the marked item. | |
c8d0cf5c | 6195 | @c |
acedf35c | 6196 | @orgcmd{C-c / d,org-check-deadlines} |
c8d0cf5c | 6197 | @cindex sparse tree, for deadlines |
c8d0cf5c CD |
6198 | @vindex org-deadline-warning-days |
6199 | Create a sparse tree with all deadlines that are either past-due, or | |
6200 | which will become due within @code{org-deadline-warning-days}. | |
6201 | With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
6202 | prefix, check that many days. For example, @kbd{C-1 C-c / d} shows | |
6203 | all deadlines due tomorrow. | |
6204 | @c | |
acedf35c | 6205 | @orgcmd{C-c / b,org-check-before-date} |
c8d0cf5c CD |
6206 | Sparse tree for deadlines and scheduled items before a given date. |
6207 | @c | |
acedf35c | 6208 | @orgcmd{C-c / a,org-check-after-date} |
c8d0cf5c | 6209 | Sparse tree for deadlines and scheduled items after a given date. |
4009494e GM |
6210 | @end table |
6211 | ||
ce57c2fe | 6212 | Note that @code{org-schedule} and @code{org-deadline} supports |
1df7defd | 6213 | setting the date by indicating a relative time: e.g., +1d will set |
ce57c2fe BG |
6214 | the date to the next day after today, and --1w will set the date |
6215 | to the previous week before any current timestamp. | |
6216 | ||
4009494e | 6217 | @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling |
a7808fba | 6218 | @subsection Repeated tasks |
c8d0cf5c CD |
6219 | @cindex tasks, repeated |
6220 | @cindex repeated tasks | |
4009494e | 6221 | |
e66ba1df | 6222 | Some tasks need to be repeated again and again. Org mode helps to |
28a16a1b | 6223 | organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, |
c8d0cf5c | 6224 | or plain timestamp. In the following example |
4009494e GM |
6225 | @example |
6226 | ** TODO Pay the rent | |
6227 | DEADLINE: <2005-10-01 Sat +1m> | |
6228 | @end example | |
c8d0cf5c CD |
6229 | @noindent |
6230 | the @code{+1m} is a repeater; the intended interpretation is that the task | |
6231 | has a deadline on <2005-10-01> and repeats itself every (one) month starting | |
8223b1d2 BG |
6232 | from that time. You can use yearly, monthly, weekly, daily and hourly repeat |
6233 | cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater | |
6234 | and a special warning period in a deadline entry, the repeater should come | |
6235 | first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. | |
4009494e | 6236 | |
86fbb8ca CD |
6237 | @vindex org-todo-repeat-to-state |
6238 | Deadlines and scheduled items produce entries in the agenda when they are | |
6239 | over-due, so it is important to be able to mark such an entry as completed | |
6240 | once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO | |
6241 | keyword DONE, it will no longer produce entries in the agenda. The problem | |
6242 | with this is, however, that then also the @emph{next} instance of the | |
e66ba1df | 6243 | repeated entry will not be active. Org mode deals with this in the following |
86fbb8ca CD |
6244 | way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will |
6245 | shift the base date of the repeating timestamp by the repeater interval, and | |
6246 | immediately set the entry state back to TODO@footnote{In fact, the target | |
6247 | state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or | |
6248 | the variable @code{org-todo-repeat-to-state}. If neither of these is | |
6249 | specified, the target state defaults to the first state of the TODO state | |
6250 | sequence.}. In the example above, setting the state to DONE would actually | |
6251 | switch the date like this: | |
4009494e GM |
6252 | |
6253 | @example | |
6254 | ** TODO Pay the rent | |
6255 | DEADLINE: <2005-11-01 Tue +1m> | |
6256 | @end example | |
6257 | ||
c8d0cf5c | 6258 | @vindex org-log-repeat |
a7808fba CD |
6259 | A timestamp@footnote{You can change this using the option |
6260 | @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat}, | |
6261 | @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you | |
a50253cc | 6262 | will also be prompted for a note.} will be added under the deadline, to keep |
a7808fba | 6263 | a record that you actually acted on the previous instance of this deadline. |
4009494e GM |
6264 | |
6265 | As a consequence of shifting the base date, this entry will no longer be | |
6266 | visible in the agenda when checking past dates, but all future instances | |
6267 | will be visible. | |
6268 | ||
28a16a1b | 6269 | With the @samp{+1m} cookie, the date shift will always be exactly one |
c8d0cf5c | 6270 | month. So if you have not paid the rent for three months, marking this |
28a16a1b CD |
6271 | entry DONE will still keep it as an overdue deadline. Depending on the |
6272 | task, this may not be the best way to handle it. For example, if you | |
acedf35c | 6273 | forgot to call your father for 3 weeks, it does not make sense to call |
a7808fba | 6274 | him 3 times in a single day to make up for it. Finally, there are tasks |
28a16a1b | 6275 | like changing batteries which should always repeat a certain time |
e66ba1df | 6276 | @i{after} the last time you did it. For these tasks, Org mode has |
acedf35c | 6277 | special repeaters @samp{++} and @samp{.+}. For example: |
28a16a1b CD |
6278 | |
6279 | @example | |
6280 | ** TODO Call Father | |
6281 | DEADLINE: <2008-02-10 Sun ++1w> | |
6282 | Marking this DONE will shift the date by at least one week, | |
6283 | but also by as many weeks as it takes to get this date into | |
6284 | the future. However, it stays on a Sunday, even if you called | |
6285 | and marked it done on Saturday. | |
6286 | ** TODO Check the batteries in the smoke detectors | |
6287 | DEADLINE: <2005-11-01 Tue .+1m> | |
6288 | Marking this DONE will shift the date to one month after | |
6289 | today. | |
6290 | @end example | |
6291 | ||
271672fa BG |
6292 | @vindex org-agenda-skip-scheduled-if-deadline-is-shown |
6293 | You may have both scheduling and deadline information for a specific task. | |
6294 | If the repeater is set for the scheduling information only, you probably want | |
6295 | the repeater to be ignored after the deadline. If so, set the variable | |
6296 | @code{org-agenda-skip-scheduled-if-deadline-is-shown} to | |
6297 | @code{repeated-after-deadline}. If you want both scheduling and deadline | |
6298 | information to repeat after the same interval, set the same repeater for both | |
6299 | timestamps. | |
c8d0cf5c CD |
6300 | |
6301 | An alternative to using a repeater is to create a number of copies of a task | |
6302 | subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was | |
6303 | created for this purpose, it is described in @ref{Structure editing}. | |
6304 | ||
4009494e | 6305 | |
acedf35c | 6306 | @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times |
dbc28aaa | 6307 | @section Clocking work time |
acedf35c CD |
6308 | @cindex clocking time |
6309 | @cindex time clocking | |
4009494e | 6310 | |
e66ba1df | 6311 | Org mode allows you to clock the time you spend on specific tasks in a |
8223b1d2 BG |
6312 | project. When you start working on an item, you can start the clock. When |
6313 | you stop working on that task, or when you mark the task done, the clock is | |
6314 | stopped and the corresponding time interval is recorded. It also computes | |
6315 | the total time spent on each subtree@footnote{Clocking only works if all | |
6316 | headings are indented with less than 30 stars. This is a hardcoded | |
6317 | limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a | |
6318 | history or tasks recently clocked, to that you can jump quickly between a | |
6319 | number of tasks absorbing your time. | |
c8d0cf5c | 6320 | |
a351880d | 6321 | To save the clock history across Emacs sessions, use |
c8d0cf5c | 6322 | @lisp |
a351880d | 6323 | (setq org-clock-persist 'history) |
c8d0cf5c CD |
6324 | (org-clock-persistence-insinuate) |
6325 | @end lisp | |
a351880d CD |
6326 | When you clock into a new task after resuming Emacs, the incomplete |
6327 | clock@footnote{To resume the clock under the assumption that you have worked | |
6328 | on this task while outside Emacs, use @code{(setq org-clock-persist t)}.} | |
6329 | will be found (@pxref{Resolving idle time}) and you will be prompted about | |
6330 | what to do with it. | |
c8d0cf5c | 6331 | |
acedf35c CD |
6332 | @menu |
6333 | * Clocking commands:: Starting and stopping a clock | |
6334 | * The clock table:: Detailed reports | |
6335 | * Resolving idle time:: Resolving time when you've been idle | |
6336 | @end menu | |
6337 | ||
6338 | @node Clocking commands, The clock table, Clocking work time, Clocking work time | |
6339 | @subsection Clocking commands | |
6340 | ||
4009494e | 6341 | @table @kbd |
acedf35c | 6342 | @orgcmd{C-c C-x C-i,org-clock-in} |
c8d0cf5c | 6343 | @vindex org-clock-into-drawer |
8223b1d2 | 6344 | @vindex org-clock-continuously |
ce57c2fe | 6345 | @cindex property, LOG_INTO_DRAWER |
4009494e | 6346 | Start the clock on the current item (clock-in). This inserts the CLOCK |
dbc28aaa CD |
6347 | keyword together with a timestamp. If this is not the first clocking of |
6348 | this item, the multiple CLOCK lines will be wrapped into a | |
c8d0cf5c | 6349 | @code{:LOGBOOK:} drawer (see also the variable |
ce57c2fe BG |
6350 | @code{org-clock-into-drawer}). You can also overrule |
6351 | the setting of this variable for a subtree by setting a | |
6352 | @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. | |
6353 | When called with a @kbd{C-u} prefix argument, | |
a7808fba | 6354 | select the task from a list of recently clocked tasks. With two @kbd{C-u |
8223b1d2 BG |
6355 | C-u} prefixes, clock into the task at point and mark it as the default task; |
6356 | the default task will then always be available with letter @kbd{d} when | |
6357 | selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force | |
6358 | continuous clocking by starting the clock when the last clock stopped.@* | |
c8d0cf5c CD |
6359 | @cindex property: CLOCK_MODELINE_TOTAL |
6360 | @cindex property: LAST_REPEAT | |
6361 | @vindex org-clock-modeline-total | |
6362 | While the clock is running, the current clocking time is shown in the mode | |
6363 | line, along with the title of the task. The clock time shown will be all | |
6364 | time ever clocked for this task and its children. If the task has an effort | |
6365 | estimate (@pxref{Effort estimates}), the mode line displays the current | |
6366 | clocking time against it@footnote{To add an effort estimate ``on the fly'', | |
6367 | hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task | |
6368 | is a repeating one (@pxref{Repeated tasks}), only the time since the last | |
6369 | reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property} | |
6370 | will be shown. More control over what time is shown can be exercised with | |
6371 | the @code{CLOCK_MODELINE_TOTAL} property. It may have the values | |
6372 | @code{current} to show only the current clocking instance, @code{today} to | |
6373 | show all time clocked on this tasks today (see also the variable | |
6374 | @code{org-extend-today-until}), @code{all} to include all time, or | |
6375 | @code{auto} which is the default@footnote{See also the variable | |
6376 | @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the | |
6377 | mode line entry will pop up a menu with clocking options. | |
acedf35c CD |
6378 | @c |
6379 | @orgcmd{C-c C-x C-o,org-clock-out} | |
c8d0cf5c | 6380 | @vindex org-log-note-clock-out |
a20d3598 | 6381 | Stop the clock (clock-out). This inserts another timestamp at the same |
4009494e GM |
6382 | location where the clock was last started. It also directly computes |
6383 | the resulting time in inserts it after the time range as @samp{=> | |
28a16a1b CD |
6384 | HH:MM}. See the variable @code{org-log-note-clock-out} for the |
6385 | possibility to record an additional note together with the clock-out | |
c8d0cf5c | 6386 | timestamp@footnote{The corresponding in-buffer setting is: |
28a16a1b | 6387 | @code{#+STARTUP: lognoteclock-out}}. |
8223b1d2 BG |
6388 | @orgcmd{C-c C-x C-x,org-clock-in-last} |
6389 | @vindex org-clock-continuously | |
6390 | Reclock the last clocked task. With one @kbd{C-u} prefix argument, | |
6391 | select the task from the clock history. With two @kbd{C-u} prefixes, | |
6392 | force continuous clocking by starting the clock when the last clock | |
6393 | stopped. | |
acedf35c | 6394 | @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate} |
c8d0cf5c | 6395 | Update the effort estimate for the current clock task. |
4009494e | 6396 | @kindex C-c C-y |
c8d0cf5c | 6397 | @kindex C-c C-c |
acedf35c | 6398 | @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range} |
c8d0cf5c CD |
6399 | Recompute the time interval after changing one of the timestamps. This |
6400 | is only necessary if you edit the timestamps directly. If you change | |
4009494e | 6401 | them with @kbd{S-@key{cursor}} keys, the update is automatic. |
ce57c2fe | 6402 | @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down} |
8223b1d2 | 6403 | On @code{CLOCK} log lines, increase/decrease both timestamps so that the |
735135f9 | 6404 | clock duration keeps the same. |
8223b1d2 BG |
6405 | @orgcmd{S-M-@key{up/down},org-timestamp-up/down} |
6406 | On @code{CLOCK} log lines, increase/decrease the timestamp at point and | |
6407 | the one of the previous (or the next clock) timestamp by the same duration. | |
6408 | For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp | |
6409 | by five minutes, then the clocked-in timestamp of the next clock will be | |
6410 | increased by five minutes. | |
acedf35c | 6411 | @orgcmd{C-c C-t,org-todo} |
4009494e GM |
6412 | Changing the TODO state of an item to DONE automatically stops the clock |
6413 | if it is running in this same item. | |
8223b1d2 | 6414 | @orgcmd{C-c C-x C-q,org-clock-cancel} |
4009494e GM |
6415 | Cancel the current clock. This is useful if a clock was started by |
6416 | mistake, or if you ended up working on something else. | |
acedf35c | 6417 | @orgcmd{C-c C-x C-j,org-clock-goto} |
afe98dfa CD |
6418 | Jump to the headline of the currently clocked in task. With a @kbd{C-u} |
6419 | prefix arg, select the target task from a list of recently clocked tasks. | |
acedf35c | 6420 | @orgcmd{C-c C-x C-d,org-clock-display} |
c8d0cf5c | 6421 | @vindex org-remove-highlights-with-change |
ce57c2fe BG |
6422 | Display time summaries for each subtree in the current buffer. This puts |
6423 | overlays at the end of each headline, showing the total time recorded under | |
6424 | that heading, including the time of any subheadings. You can use visibility | |
6425 | cycling to study the tree, but the overlays disappear when you change the | |
6426 | buffer (see variable @code{org-remove-highlights-with-change}) or press | |
6427 | @kbd{C-c C-c}. | |
acedf35c CD |
6428 | @end table |
6429 | ||
6430 | The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | |
6431 | the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been | |
6432 | worked on or closed during a day. | |
6433 | ||
8223b1d2 BG |
6434 | @strong{Important:} note that both @code{org-clock-out} and |
6435 | @code{org-clock-in-last} can have a global keybinding and will not | |
6436 | modify the window disposition. | |
6437 | ||
acedf35c CD |
6438 | @node The clock table, Resolving idle time, Clocking commands, Clocking work time |
6439 | @subsection The clock table | |
6440 | @cindex clocktable, dynamic block | |
6441 | @cindex report, of clocked time | |
6442 | ||
6443 | Org mode can produce quite complex reports based on the time clocking | |
6444 | information. Such a report is called a @emph{clock table}, because it is | |
6445 | formatted as one or several Org tables. | |
6446 | ||
6447 | @table @kbd | |
6448 | @orgcmd{C-c C-x C-r,org-clock-report} | |
4009494e | 6449 | Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock |
e66ba1df | 6450 | report as an Org mode table into the current file. When the cursor is |
dbc28aaa CD |
6451 | at an existing clock table, just update it. When called with a prefix |
6452 | argument, jump to the first clock report in the current document and | |
e66ba1df BG |
6453 | update it. The clock table always includes also trees with |
6454 | @code{:ARCHIVE:} tag. | |
acedf35c CD |
6455 | @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} |
6456 | Update dynamic block at point. The cursor needs to be in the | |
6457 | @code{#+BEGIN} line of the dynamic block. | |
6458 | @orgkey{C-u C-c C-x C-u} | |
6459 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
6460 | you have several clock table blocks in a buffer. | |
6461 | @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift} | |
6462 | Shift the current @code{:block} interval and update the table. The cursor | |
6463 | needs to be in the @code{#+BEGIN: clocktable} line for this command. If | |
6464 | @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. | |
6465 | @end table | |
6466 | ||
6467 | ||
6468 | Here is an example of the frame for a clock table as it is inserted into the | |
6469 | buffer with the @kbd{C-c C-x C-r} command: | |
6470 | ||
c8d0cf5c | 6471 | @cindex #+BEGIN, clocktable |
4009494e | 6472 | @example |
dbc28aaa | 6473 | #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
4009494e GM |
6474 | #+END: clocktable |
6475 | @end example | |
6476 | @noindent | |
acedf35c CD |
6477 | @vindex org-clocktable-defaults |
6478 | The @samp{BEGIN} line and specify a number of options to define the scope, | |
6479 | structure, and formatting of the report. Defaults for all these options can | |
6480 | be configured in the variable @code{org-clocktable-defaults}. | |
6481 | ||
6482 | @noindent First there are options that determine which clock entries are to | |
6483 | be selected: | |
4009494e | 6484 | @example |
dbc28aaa | 6485 | :maxlevel @r{Maximum level depth to which times are listed in the table.} |
acedf35c | 6486 | @r{Clocks at deeper levels will be summed into the upper level.} |
dbc28aaa CD |
6487 | :scope @r{The scope to consider. This can be any of the following:} |
6488 | nil @r{the current buffer or narrowed region} | |
6489 | file @r{the full current buffer} | |
6490 | subtree @r{the subtree where the clocktable is located} | |
c8d0cf5c | 6491 | tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}} |
dbc28aaa CD |
6492 | tree @r{the surrounding level 1 tree} |
6493 | agenda @r{all agenda files} | |
6494 | ("file"..) @r{scan these files} | |
a7808fba CD |
6495 | file-with-archives @r{current file and its archives} |
6496 | agenda-with-archives @r{all agenda files, including archives} | |
6497 | :block @r{The time block to consider. This block is specified either} | |
6498 | @r{absolute, or relative to the current time and may be any of} | |
6499 | @r{these formats:} | |
6500 | 2007-12-31 @r{New year eve 2007} | |
6501 | 2007-12 @r{December 2007} | |
6502 | 2007-W50 @r{ISO-week 50 in 2007} | |
acedf35c | 6503 | 2007-Q2 @r{2nd quarter in 2007} |
a7808fba | 6504 | 2007 @r{the year 2007} |
c8d0cf5c CD |
6505 | today, yesterday, today-@var{N} @r{a relative day} |
6506 | thisweek, lastweek, thisweek-@var{N} @r{a relative week} | |
6507 | thismonth, lastmonth, thismonth-@var{N} @r{a relative month} | |
6508 | thisyear, lastyear, thisyear-@var{N} @r{a relative year} | |
a7808fba | 6509 | @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} |
c8d0cf5c | 6510 | :tstart @r{A time string specifying when to start considering times.} |
271672fa BG |
6511 | @r{Relative times like @code{"<-2w>"} can also be used. See} |
6512 | @r{@ref{Matching tags and properties} for relative time syntax.} | |
c8d0cf5c | 6513 | :tend @r{A time string specifying when to stop considering times.} |
271672fa BG |
6514 | @r{Relative times like @code{"<now>"} can also be used. See} |
6515 | @r{@ref{Matching tags and properties} for relative time syntax.} | |
6516 | :wstart @r{The starting day of the week. The default is 1 for monday.} | |
6517 | :mstart @r{The starting day of the month. The default 1 is for the first} | |
6518 | @r{day of the month.} | |
a7808fba CD |
6519 | :step @r{@code{week} or @code{day}, to split the table into chunks.} |
6520 | @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} | |
acedf35c CD |
6521 | :stepskip0 @r{Do not show steps that have zero time.} |
6522 | :fileskip0 @r{Do not show table sections from files which did not contribute.} | |
ce57c2fe BG |
6523 | :tags @r{A tags match to select entries that should contribute. See} |
6524 | @r{@ref{Matching tags and properties} for the match syntax.} | |
acedf35c CD |
6525 | @end example |
6526 | ||
6527 | Then there are options which determine the formatting of the table. There | |
6528 | options are interpreted by the function @code{org-clocktable-write-default}, | |
6529 | but you can specify your own function using the @code{:formatter} parameter. | |
6530 | @example | |
6531 | :emphasize @r{When @code{t}, emphasize level one and level two items.} | |
ce57c2fe | 6532 | :lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".} |
c8d0cf5c | 6533 | :link @r{Link the item headlines in the table to their origins.} |
acedf35c CD |
6534 | :narrow @r{An integer to limit the width of the headline column in} |
6535 | @r{the org table. If you write it like @samp{50!}, then the} | |
6536 | @r{headline will also be shortened in export.} | |
6537 | :indent @r{Indent each headline field according to its level.} | |
6538 | :tcolumns @r{Number of columns to be used for times. If this is smaller} | |
6539 | @r{than @code{:maxlevel}, lower levels will be lumped into one column.} | |
6540 | :level @r{Should a level number column be included?} | |
6541 | :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}} | |
6542 | @r{All are overwritten except if there is an explicit @code{:narrow}} | |
6543 | :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} | |
6544 | @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} | |
ce57c2fe BG |
6545 | :properties @r{List of properties that should be shown in the table. Each} |
6546 | @r{property will get its own column.} | |
6547 | :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.} | |
e45e3595 | 6548 | :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} |
c8d0cf5c | 6549 | @r{As a special case, @samp{:formula %} adds a column with % time.} |
acedf35c | 6550 | @r{If you do not specify a formula here, any existing formula} |
e45e3595 | 6551 | @r{below the clock table will survive updates and be evaluated.} |
acedf35c | 6552 | :formatter @r{A function to format clock data and insert it into the buffer.} |
4009494e | 6553 | @end example |
c8d0cf5c | 6554 | To get a clock summary of the current level 1 tree, for the current |
dbc28aaa | 6555 | day, you could write |
4009494e | 6556 | @example |
a7808fba | 6557 | #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
4009494e GM |
6558 | #+END: clocktable |
6559 | @end example | |
c8d0cf5c | 6560 | @noindent |
4009494e | 6561 | and to use a specific time range you could write@footnote{Note that all |
c8d0cf5c CD |
6562 | parameters must be specified in a single line---the line is broken here |
6563 | only to fit it into the manual.} | |
4009494e | 6564 | @example |
28a16a1b | 6565 | #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
4009494e | 6566 | :tend "<2006-08-10 Thu 12:00>" |
4009494e GM |
6567 | #+END: clocktable |
6568 | @end example | |
271672fa BG |
6569 | A range starting a week ago and ending right now could be written as |
6570 | @example | |
6571 | #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>" | |
6572 | #+END: clocktable | |
6573 | @end example | |
e45e3595 CD |
6574 | A summary of the current subtree with % times would be |
6575 | @example | |
6576 | #+BEGIN: clocktable :scope subtree :link t :formula % | |
6577 | #+END: clocktable | |
6578 | @end example | |
acedf35c CD |
6579 | A horizontally compact representation of everything clocked during last week |
6580 | would be | |
6581 | @example | |
6582 | #+BEGIN: clocktable :scope agenda :block lastweek :compact t | |
6583 | #+END: clocktable | |
6584 | @end example | |
4009494e | 6585 | |
acedf35c | 6586 | @node Resolving idle time, , The clock table, Clocking work time |
8223b1d2 BG |
6587 | @subsection Resolving idle time and continuous clocking |
6588 | ||
6589 | @subsubheading Resolving idle time | |
a351880d | 6590 | @cindex resolve idle time |
271672fa | 6591 | @vindex org-clock-x11idle-program-name |
a351880d CD |
6592 | |
6593 | @cindex idle, resolve, dangling | |
6594 | If you clock in on a work item, and then walk away from your | |
6595 | computer---perhaps to take a phone call---you often need to ``resolve'' the | |
6596 | time you were away by either subtracting it from the current clock, or | |
6597 | applying it to another one. | |
6598 | ||
6599 | @vindex org-clock-idle-time | |
6600 | By customizing the variable @code{org-clock-idle-time} to some integer, such | |
6601 | as 10 or 15, Emacs can alert you when you get back to your computer after | |
6602 | being idle for that many minutes@footnote{On computers using Mac OS X, | |
153ae947 | 6603 | idleness is based on actual user idleness, not just Emacs' idle time. For |
a351880d | 6604 | X11, you can install a utility program @file{x11idle.c}, available in the |
271672fa BG |
6605 | @code{contrib/scripts} directory of the Org git distribution, or install the |
6606 | @file{xprintidle} package and set it to the variable | |
6607 | @code{org-clock-x11idle-program-name} if you are running Debian, to get the | |
6608 | same general treatment of idleness. On other systems, idle time refers to | |
6609 | Emacs idle time only.}, and ask what you want to do with the idle time. | |
6610 | There will be a question waiting for you when you get back, indicating how | |
6611 | much idle time has passed (constantly updated with the current amount), as | |
6612 | well as a set of choices to correct the discrepancy: | |
a351880d CD |
6613 | |
6614 | @table @kbd | |
6615 | @item k | |
6616 | To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org | |
6617 | will ask how many of the minutes to keep. Press @key{RET} to keep them all, | |
6618 | effectively changing nothing, or enter a number to keep that many minutes. | |
6619 | @item K | |
6620 | If you use the shift key and press @kbd{K}, it will keep however many minutes | |
6621 | you request and then immediately clock out of that task. If you keep all of | |
6622 | the minutes, this is the same as just clocking out of the current task. | |
6623 | @item s | |
6624 | To keep none of the minutes, use @kbd{s} to subtract all the away time from | |
6625 | the clock, and then check back in from the moment you returned. | |
6626 | @item S | |
6627 | To keep none of the minutes and just clock out at the start of the away time, | |
6628 | use the shift key and press @kbd{S}. Remember that using shift will always | |
6629 | leave you clocked out, no matter which option you choose. | |
6630 | @item C | |
6631 | To cancel the clock altogether, use @kbd{C}. Note that if instead of | |
86fbb8ca CD |
6632 | canceling you subtract the away time, and the resulting clock amount is less |
6633 | than a minute, the clock will still be canceled rather than clutter up the | |
a351880d CD |
6634 | log with an empty entry. |
6635 | @end table | |
6636 | ||
6637 | What if you subtracted those away minutes from the current clock, and now | |
6638 | want to apply them to a new clock? Simply clock in to any task immediately | |
6639 | after the subtraction. Org will notice that you have subtracted time ``on | |
6640 | the books'', so to speak, and will ask if you want to apply those minutes to | |
6641 | the next task you clock in on. | |
6642 | ||
6643 | There is one other instance when this clock resolution magic occurs. Say you | |
6644 | were clocked in and hacking away, and suddenly your cat chased a mouse who | |
6645 | scared a hamster that crashed into your UPS's power button! You suddenly | |
6646 | lose all your buffers, but thanks to auto-save you still have your recent Org | |
6647 | mode changes, including your last clock in. | |
6648 | ||
6649 | If you restart Emacs and clock into any task, Org will notice that you have a | |
6650 | dangling clock which was never clocked out from your last session. Using | |
6651 | that clock's starting time as the beginning of the unaccounted-for period, | |
6652 | Org will ask how you want to resolve that time. The logic and behavior is | |
ce57c2fe | 6653 | identical to dealing with away time due to idleness; it is just happening due |
a351880d CD |
6654 | to a recovery event rather than a set amount of idle time. |
6655 | ||
6656 | You can also check all the files visited by your Org agenda for dangling | |
8223b1d2 BG |
6657 | clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}). |
6658 | ||
6659 | @subsubheading Continuous clocking | |
6660 | @cindex continuous clocking | |
6661 | @vindex org-clock-continuously | |
6662 | ||
6663 | You may want to start clocking from the time when you clocked out the | |
6664 | previous task. To enable this systematically, set @code{org-clock-continuously} | |
6665 | to @code{t}. Each time you clock in, Org retrieves the clock-out time of the | |
6666 | last clocked entry for this session, and start the new clock from there. | |
6667 | ||
6668 | If you only want this from time to time, use three universal prefix arguments | |
6669 | with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}. | |
a351880d | 6670 | |
acedf35c | 6671 | @node Effort estimates, Relative timer, Clocking work time, Dates and Times |
a7808fba | 6672 | @section Effort estimates |
96c8522a | 6673 | @cindex effort estimates |
a7808fba | 6674 | |
c8d0cf5c CD |
6675 | @cindex property, Effort |
6676 | @vindex org-effort-property | |
a7808fba CD |
6677 | If you want to plan your work in a very detailed way, or if you need to |
6678 | produce offers with quotations of the estimated work effort, you may want to | |
6679 | assign effort estimates to entries. If you are also clocking your work, you | |
6680 | may later want to compare the planned effort with the actual working time, a | |
6681 | great way to improve planning estimates. Effort estimates are stored in a | |
6682 | special property @samp{Effort}@footnote{You may change the property being | |
6eb02347 CD |
6683 | used with the variable @code{org-effort-property}.}. You can set the effort |
6684 | for an entry with the following commands: | |
6685 | ||
6686 | @table @kbd | |
acedf35c | 6687 | @orgcmd{C-c C-x e,org-set-effort} |
6eb02347 | 6688 | Set the effort estimate for the current entry. With a numeric prefix |
acedf35c | 6689 | argument, set it to the Nth allowed value (see below). This command is also |
6eb02347 | 6690 | accessible from the agenda with the @kbd{e} key. |
acedf35c | 6691 | @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate} |
6eb02347 CD |
6692 | Modify the effort estimate of the item currently being clocked. |
6693 | @end table | |
6694 | ||
6695 | Clearly the best way to work with effort estimates is through column view | |
6696 | (@pxref{Column view}). You should start by setting up discrete values for | |
6697 | effort estimates, and a @code{COLUMNS} format that displays these values | |
6698 | together with clock sums (if you want to clock your time). For a specific | |
6699 | buffer you can use | |
a7808fba CD |
6700 | |
6701 | @example | |
ce57c2fe | 6702 | #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 |
a7808fba CD |
6703 | #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM |
6704 | @end example | |
6705 | ||
6706 | @noindent | |
c8d0cf5c CD |
6707 | @vindex org-global-properties |
6708 | @vindex org-columns-default-format | |
71d35b24 CD |
6709 | or, even better, you can set up these values globally by customizing the |
6710 | variables @code{org-global-properties} and @code{org-columns-default-format}. | |
6711 | In particular if you want to use this setup also in the agenda, a global | |
6712 | setup may be advised. | |
a7808fba CD |
6713 | |
6714 | The way to assign estimates to individual items is then to switch to column | |
6715 | mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the | |
6716 | value. The values you enter will immediately be summed up in the hierarchy. | |
6717 | In the column next to it, any clocked time will be displayed. | |
6718 | ||
c8d0cf5c | 6719 | @vindex org-agenda-columns-add-appointments-to-effort-sum |
a7808fba CD |
6720 | If you switch to column view in the daily/weekly agenda, the effort column |
6721 | will summarize the estimated work effort for each day@footnote{Please note | |
6722 | the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda | |
b349f79f | 6723 | column view}).}, and you can use this to find space in your schedule. To get |
a7808fba CD |
6724 | an overview of the entire part of the day that is committed, you can set the |
6725 | option @code{org-agenda-columns-add-appointments-to-effort-sum}. The | |
6726 | appointments on a day that take place over a specified time interval will | |
6727 | then also be added to the load estimate of the day. | |
6728 | ||
71d35b24 CD |
6729 | Effort estimates can be used in secondary agenda filtering that is triggered |
6730 | with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have | |
6731 | these estimates defined consistently, two or three key presses will narrow | |
6732 | down the list to stuff that fits into an available time slot. | |
864c9740 | 6733 | |
afe98dfa | 6734 | @node Relative timer, Countdown timer, Effort estimates, Dates and Times |
96c8522a CD |
6735 | @section Taking notes with a relative timer |
6736 | @cindex relative timer | |
6737 | ||
6738 | When taking notes during, for example, a meeting or a video viewing, it can | |
6739 | be useful to have access to times relative to a starting time. Org provides | |
6740 | such a relative timer and make it easy to create timed notes. | |
6741 | ||
6742 | @table @kbd | |
acedf35c | 6743 | @orgcmd{C-c C-x .,org-timer} |
96c8522a CD |
6744 | Insert a relative time into the buffer. The first time you use this, the |
6745 | timer will be started. When called with a prefix argument, the timer is | |
6746 | restarted. | |
acedf35c | 6747 | @orgcmd{C-c C-x -,org-timer-item} |
96c8522a CD |
6748 | Insert a description list item with the current relative time. With a prefix |
6749 | argument, first reset the timer to 0. | |
acedf35c | 6750 | @orgcmd{M-@key{RET},org-insert-heading} |
377952e0 | 6751 | Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert |
96c8522a | 6752 | new timer items. |
acedf35c | 6753 | @c for key sequences with a comma, command name macros fail :( |
55e0839d CD |
6754 | @kindex C-c C-x , |
6755 | @item C-c C-x , | |
acedf35c CD |
6756 | Pause the timer, or continue it if it is already paused |
6757 | (@command{org-timer-pause-or-continue}). | |
c8d0cf5c | 6758 | @c removed the sentence because it is redundant to the following item |
55e0839d CD |
6759 | @kindex C-u C-c C-x , |
6760 | @item C-u C-c C-x , | |
6761 | Stop the timer. After this, you can only start a new timer, not continue the | |
6762 | old one. This command also removes the timer from the mode line. | |
acedf35c | 6763 | @orgcmd{C-c C-x 0,org-timer-start} |
96c8522a CD |
6764 | Reset the timer without inserting anything into the buffer. By default, the |
6765 | timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to | |
6766 | specific starting offset. The user is prompted for the offset, with a | |
6767 | default taken from a timer string at point, if any, So this can be used to | |
6768 | restart taking notes after a break in the process. When called with a double | |
86fbb8ca | 6769 | prefix argument @kbd{C-u C-u}, change all timer strings in the active region |
96c8522a CD |
6770 | by a certain amount. This can be used to fix timer strings if the timer was |
6771 | not started at exactly the right moment. | |
6772 | @end table | |
6773 | ||
afe98dfa CD |
6774 | @node Countdown timer, , Relative timer, Dates and Times |
6775 | @section Countdown timer | |
6776 | @cindex Countdown timer | |
6777 | @kindex C-c C-x ; | |
6778 | @kindex ; | |
6779 | ||
e66ba1df | 6780 | Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown |
27e428e7 | 6781 | timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else. |
afe98dfa CD |
6782 | |
6783 | @code{org-timer-set-timer} prompts the user for a duration and displays a | |
6784 | countdown timer in the modeline. @code{org-timer-default-timer} sets the | |
6785 | default countdown value. Giving a prefix numeric argument overrides this | |
6786 | default value. | |
6787 | ||
a351880d CD |
6788 | @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top |
6789 | @chapter Capture - Refile - Archive | |
864c9740 CD |
6790 | @cindex capture |
6791 | ||
6792 | An important part of any organization system is the ability to quickly | |
6793 | capture new ideas and tasks, and to associate reference material with them. | |
86fbb8ca | 6794 | Org does this using a process called @i{capture}. It also can store files |
a351880d CD |
6795 | related to a task (@i{attachments}) in a special directory. Once in the |
6796 | system, tasks and projects need to be moved around. Moving completed project | |
6797 | trees to an archive file keeps the system compact and fast. | |
864c9740 CD |
6798 | |
6799 | @menu | |
c0468714 GM |
6800 | * Capture:: Capturing new stuff |
6801 | * Attachments:: Add files to tasks | |
6802 | * RSS Feeds:: Getting input from RSS feeds | |
1df7defd | 6803 | * Protocols:: External (e.g., Browser) access to Emacs and Org |
271672fa | 6804 | * Refile and copy:: Moving/copying a tree from one place to another |
c0468714 | 6805 | * Archiving:: What to do with finished projects |
864c9740 CD |
6806 | @end menu |
6807 | ||
86fbb8ca CD |
6808 | @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive |
6809 | @section Capture | |
6810 | @cindex capture | |
dbc28aaa | 6811 | |
271672fa BG |
6812 | Capture lets you quickly store notes with little interruption of your work |
6813 | flow. Org's method for capturing new items is heavily inspired by John | |
6814 | Wiegley excellent @file{remember.el} package. Up to version 6.36, Org | |
6815 | used a special setup for @file{remember.el}, then replaced it with | |
6816 | @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has | |
6817 | been completely replaced by @file{org-capture.el}. | |
86fbb8ca | 6818 | |
271672fa BG |
6819 | If your configuration depends on @file{org-remember.el}, you need to update |
6820 | it and use the setup described below. To convert your | |
6821 | @code{org-remember-templates}, run the command | |
86fbb8ca | 6822 | @example |
271672fa | 6823 | @kbd{M-x org-capture-import-remember-templates RET} |
86fbb8ca CD |
6824 | @end example |
6825 | @noindent and then customize the new variable with @kbd{M-x | |
6826 | customize-variable org-capture-templates}, check the result, and save the | |
271672fa | 6827 | customization. |
dbc28aaa CD |
6828 | |
6829 | @menu | |
c0468714 GM |
6830 | * Setting up capture:: Where notes will be stored |
6831 | * Using capture:: Commands to invoke and terminate capture | |
6832 | * Capture templates:: Define the outline of different note types | |
dbc28aaa CD |
6833 | @end menu |
6834 | ||
86fbb8ca CD |
6835 | @node Setting up capture, Using capture, Capture, Capture |
6836 | @subsection Setting up capture | |
dbc28aaa | 6837 | |
86fbb8ca CD |
6838 | The following customization sets a default target file for notes, and defines |
6839 | a global key@footnote{Please select your own key, @kbd{C-c c} is only a | |
6840 | suggestion.} for capturing new material. | |
dbc28aaa | 6841 | |
afe98dfa | 6842 | @vindex org-default-notes-file |
271672fa BG |
6843 | @smalllisp |
6844 | @group | |
dbc28aaa | 6845 | (setq org-default-notes-file (concat org-directory "/notes.org")) |
86fbb8ca | 6846 | (define-key global-map "\C-cc" 'org-capture) |
271672fa BG |
6847 | @end group |
6848 | @end smalllisp | |
dbc28aaa | 6849 | |
86fbb8ca CD |
6850 | @node Using capture, Capture templates, Setting up capture, Capture |
6851 | @subsection Using capture | |
28a16a1b | 6852 | |
86fbb8ca | 6853 | @table @kbd |
acedf35c CD |
6854 | @orgcmd{C-c c,org-capture} |
6855 | Call the command @code{org-capture}. Note that this keybinding is global and | |
c7cf0ebc | 6856 | not active by default: you need to install it. If you have templates |
ce57c2fe | 6857 | @cindex date tree |
acedf35c CD |
6858 | defined @pxref{Capture templates}, it will offer these templates for |
6859 | selection or use a new Org outline node as the default template. It will | |
6860 | insert the template into the target file and switch to an indirect buffer | |
6861 | narrowed to this new node. You may then insert the information you want. | |
6862 | ||
6863 | @orgcmd{C-c C-c,org-capture-finalize} | |
6864 | Once you have finished entering information into the capture buffer, @kbd{C-c | |
6865 | C-c} will return you to the window configuration before the capture process, | |
6866 | so that you can resume your work without further distraction. When called | |
6867 | with a prefix arg, finalize and then jump to the captured item. | |
6868 | ||
6869 | @orgcmd{C-c C-w,org-capture-refile} | |
271672fa | 6870 | Finalize the capture process by refiling (@pxref{Refile and copy}) the note to |
afe98dfa | 6871 | a different place. Please realize that this is a normal refiling command |
acedf35c | 6872 | that will be executed---so the cursor position at the moment you run this |
afe98dfa | 6873 | command is important. If you have inserted a tree with a parent and |
acedf35c CD |
6874 | children, first move the cursor back to the parent. Any prefix argument |
6875 | given to this command will be passed on to the @code{org-refile} command. | |
86fbb8ca | 6876 | |
acedf35c | 6877 | @orgcmd{C-c C-k,org-capture-kill} |
86fbb8ca | 6878 | Abort the capture process and return to the previous state. |
acedf35c | 6879 | |
86fbb8ca CD |
6880 | @end table |
6881 | ||
6882 | You can also call @code{org-capture} in a special way from the agenda, using | |
6883 | the @kbd{k c} key combination. With this access, any timestamps inserted by | |
6884 | the selected capture template will default to the cursor date in the agenda, | |
6885 | rather than to the current date. | |
6886 | ||
acedf35c CD |
6887 | To find the locations of the last stored capture, use @code{org-capture} with |
6888 | prefix commands: | |
6889 | ||
6890 | @table @kbd | |
6891 | @orgkey{C-u C-c c} | |
ce57c2fe | 6892 | Visit the target location of a capture template. You get to select the |
acedf35c CD |
6893 | template in the usual way. |
6894 | @orgkey{C-u C-u C-c c} | |
6895 | Visit the last stored capture item in its buffer. | |
6896 | @end table | |
6897 | ||
8223b1d2 BG |
6898 | @vindex org-capture-bookmark |
6899 | @cindex org-capture-last-stored | |
6900 | You can also jump to the bookmark @code{org-capture-last-stored}, which will | |
6901 | automatically be created unless you set @code{org-capture-bookmark} to | |
6902 | @code{nil}. | |
6903 | ||
6904 | To insert the capture at point in an Org buffer, call @code{org-capture} with | |
6905 | a @code{C-0} prefix argument. | |
6906 | ||
86fbb8ca CD |
6907 | @node Capture templates, , Using capture, Capture |
6908 | @subsection Capture templates | |
6909 | @cindex templates, for Capture | |
6910 | ||
6911 | You can use templates for different types of capture items, and | |
6912 | for different target locations. The easiest way to create such templates is | |
6913 | through the customize interface. | |
6914 | ||
6915 | @table @kbd | |
acedf35c | 6916 | @orgkey{C-c c C} |
86fbb8ca CD |
6917 | Customize the variable @code{org-capture-templates}. |
6918 | @end table | |
6919 | ||
6920 | Before we give the formal description of template definitions, let's look at | |
6921 | an example. Say you would like to use one template to create general TODO | |
6922 | entries, and you want to put these entries under the heading @samp{Tasks} in | |
6923 | your file @file{~/org/gtd.org}. Also, a date tree in the file | |
6924 | @file{journal.org} should capture journal entries. A possible configuration | |
6925 | would look like: | |
28a16a1b | 6926 | |
271672fa BG |
6927 | @smalllisp |
6928 | @group | |
86fbb8ca CD |
6929 | (setq org-capture-templates |
6930 | '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") | |
6931 | "* TODO %?\n %i\n %a") | |
6932 | ("j" "Journal" entry (file+datetree "~/org/journal.org") | |
6933 | "* %?\nEntered on %U\n %i\n %a"))) | |
271672fa BG |
6934 | @end group |
6935 | @end smalllisp | |
86fbb8ca CD |
6936 | |
6937 | @noindent If you then press @kbd{C-c c t}, Org will prepare the template | |
6938 | for you like this: | |
dbc28aaa CD |
6939 | @example |
6940 | * TODO | |
86fbb8ca | 6941 | [[file:@var{link to where you initiated capture}]] |
dbc28aaa CD |
6942 | @end example |
6943 | ||
6944 | @noindent | |
86fbb8ca CD |
6945 | During expansion of the template, @code{%a} has been replaced by a link to |
6946 | the location from where you called the capture command. This can be | |
6947 | extremely useful for deriving tasks from emails, for example. You fill in | |
271672fa | 6948 | the task definition, press @kbd{C-c C-c} and Org returns you to the same |
86fbb8ca CD |
6949 | place where you started the capture process. |
6950 | ||
ce57c2fe BG |
6951 | To define special keys to capture to a particular template without going |
6952 | through the interactive template selection, you can create your key binding | |
6953 | like this: | |
6954 | ||
6955 | @lisp | |
6956 | (define-key global-map "\C-cx" | |
6957 | (lambda () (interactive) (org-capture nil "x"))) | |
6958 | @end lisp | |
86fbb8ca CD |
6959 | |
6960 | @menu | |
c0468714 GM |
6961 | * Template elements:: What is needed for a complete template entry |
6962 | * Template expansion:: Filling in information about time and context | |
8223b1d2 | 6963 | * Templates in contexts:: Only show a template in a specific context |
86fbb8ca CD |
6964 | @end menu |
6965 | ||
6966 | @node Template elements, Template expansion, Capture templates, Capture templates | |
6967 | @subsubsection Template elements | |
6968 | ||
e66ba1df | 6969 | Now lets look at the elements of a template definition. Each entry in |
ce57c2fe | 6970 | @code{org-capture-templates} is a list with the following items: |
86fbb8ca CD |
6971 | |
6972 | @table @var | |
6973 | @item keys | |
6974 | The keys that will select the template, as a string, characters | |
6975 | only, for example @code{"a"} for a template to be selected with a | |
6976 | single key, or @code{"bt"} for selection with two keys. When using | |
ce57c2fe | 6977 | several keys, keys using the same prefix key must be sequential |
86fbb8ca CD |
6978 | in the list and preceded by a 2-element entry explaining the |
6979 | prefix key, for example | |
271672fa | 6980 | @smalllisp |
86fbb8ca | 6981 | ("b" "Templates for marking stuff to buy") |
271672fa | 6982 | @end smalllisp |
86fbb8ca CD |
6983 | @noindent If you do not define a template for the @kbd{C} key, this key will |
6984 | be used to open the customize buffer for this complex variable. | |
6985 | ||
6986 | @item description | |
6987 | A short string describing the template, which will be shown during | |
6988 | selection. | |
6989 | ||
6990 | @item type | |
6991 | The type of entry, a symbol. Valid values are: | |
271672fa | 6992 | |
86fbb8ca CD |
6993 | @table @code |
6994 | @item entry | |
e66ba1df BG |
6995 | An Org mode node, with a headline. Will be filed as the child of the target |
6996 | entry or as a top-level entry. The target file should be an Org mode file. | |
86fbb8ca CD |
6997 | @item item |
6998 | A plain list item, placed in the first plain list at the target | |
6999 | location. Again the target file should be an Org file. | |
7000 | @item checkitem | |
7001 | A checkbox item. This only differs from the plain list item by the | |
7002 | default template. | |
7003 | @item table-line | |
7004 | a new line in the first table at the target location. Where exactly the | |
7005 | line will be inserted depends on the properties @code{:prepend} and | |
7006 | @code{:table-line-pos} (see below). | |
7007 | @item plain | |
7008 | Text to be inserted as it is. | |
7009 | @end table | |
7010 | ||
7011 | @item target | |
afe98dfa | 7012 | @vindex org-default-notes-file |
e66ba1df | 7013 | Specification of where the captured item should be placed. In Org mode |
afe98dfa | 7014 | files, targets usually define a node. Entries will become children of this |
acedf35c | 7015 | node. Other types will be added to the table or list in the body of this |
afe98dfa | 7016 | node. Most target specifications contain a file name. If that file name is |
ce57c2fe BG |
7017 | the empty string, it defaults to @code{org-default-notes-file}. A file can |
7018 | also be given as a variable, function, or Emacs Lisp form. | |
86fbb8ca CD |
7019 | |
7020 | Valid values are: | |
271672fa | 7021 | |
86fbb8ca CD |
7022 | @table @code |
7023 | @item (file "path/to/file") | |
7024 | Text will be placed at the beginning or end of that file. | |
7025 | ||
7026 | @item (id "id of existing org entry") | |
7027 | Filing as child of this entry, or in the body of the entry. | |
7028 | ||
7029 | @item (file+headline "path/to/file" "node headline") | |
7030 | Fast configuration if the target heading is unique in the file. | |
7031 | ||
7032 | @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...) | |
7033 | For non-unique headings, the full path is safer. | |
7034 | ||
7035 | @item (file+regexp "path/to/file" "regexp to find location") | |
7036 | Use a regular expression to position the cursor. | |
7037 | ||
7038 | @item (file+datetree "path/to/file") | |
271672fa BG |
7039 | Will create a heading in a date tree for today's date@footnote{Datetree |
7040 | headlines for years accept tags, so if you use both @code{* 2013 :noexport:} | |
7041 | and @code{* 2013} in your file, the capture will refile the note to the first | |
7042 | one matched.}. | |
acedf35c CD |
7043 | |
7044 | @item (file+datetree+prompt "path/to/file") | |
7045 | Will create a heading in a date tree, but will prompt for the date. | |
86fbb8ca CD |
7046 | |
7047 | @item (file+function "path/to/file" function-finding-location) | |
7048 | A function to find the right location in the file. | |
7049 | ||
7050 | @item (clock) | |
7051 | File to the entry that is currently being clocked. | |
7052 | ||
7053 | @item (function function-finding-location) | |
7054 | Most general way, write your own function to find both | |
7055 | file and location. | |
7056 | @end table | |
7057 | ||
7058 | @item template | |
7059 | The template for creating the capture item. If you leave this empty, an | |
7060 | appropriate default template will be used. Otherwise this is a string with | |
7061 | escape codes, which will be replaced depending on time and context of the | |
7062 | capture call. The string with escapes may be loaded from a template file, | |
7063 | using the special syntax @code{(file "path/to/template")}. See below for | |
7064 | more details. | |
7065 | ||
7066 | @item properties | |
7067 | The rest of the entry is a property list of additional options. | |
7068 | Recognized properties are: | |
271672fa | 7069 | |
86fbb8ca CD |
7070 | @table @code |
7071 | @item :prepend | |
7072 | Normally new captured information will be appended at | |
7073 | the target location (last child, last table line, last list item...). | |
7074 | Setting this property will change that. | |
7075 | ||
7076 | @item :immediate-finish | |
7077 | When set, do not offer to edit the information, just | |
7078 | file it away immediately. This makes sense if the template only needs | |
7079 | information that can be added automatically. | |
7080 | ||
7081 | @item :empty-lines | |
7082 | Set this to the number of lines to insert | |
7083 | before and after the new item. Default 0, only common other value is 1. | |
7084 | ||
7085 | @item :clock-in | |
7086 | Start the clock in this item. | |
7087 | ||
ce57c2fe BG |
7088 | @item :clock-keep |
7089 | Keep the clock running when filing the captured entry. | |
7090 | ||
86fbb8ca CD |
7091 | @item :clock-resume |
7092 | If starting the capture interrupted a clock, restart that clock when finished | |
ce57c2fe BG |
7093 | with the capture. Note that @code{:clock-keep} has precedence over |
7094 | @code{:clock-resume}. When setting both to @code{t}, the current clock will | |
7095 | run and the previous one will not be resumed. | |
86fbb8ca CD |
7096 | |
7097 | @item :unnarrowed | |
7098 | Do not narrow the target buffer, simply show the full buffer. Default is to | |
7099 | narrow it so that you only see the new material. | |
afe98dfa | 7100 | |
ce57c2fe BG |
7101 | @item :table-line-pos |
7102 | Specification of the location in the table where the new line should be | |
7103 | inserted. It should be a string like @code{"II-3"} meaning that the new | |
7104 | line should become the third line before the second horizontal separator | |
7105 | line. | |
7106 | ||
afe98dfa CD |
7107 | @item :kill-buffer |
7108 | If the target file was not yet visited when capture was invoked, kill the | |
7109 | buffer again after capture is completed. | |
86fbb8ca CD |
7110 | @end table |
7111 | @end table | |
7112 | ||
8223b1d2 | 7113 | @node Template expansion, Templates in contexts, Template elements, Capture templates |
86fbb8ca CD |
7114 | @subsubsection Template expansion |
7115 | ||
7116 | In the template itself, special @kbd{%}-escapes@footnote{If you need one of | |
8223b1d2 | 7117 | these sequences literally, escape the @kbd{%} with a backslash.} allow |
e66ba1df | 7118 | dynamic insertion of content. The templates are expanded in the order given here: |
86fbb8ca | 7119 | |
86fbb8ca | 7120 | @smallexample |
8223b1d2 BG |
7121 | %[@var{file}] @r{Insert the contents of the file given by @var{file}.} |
7122 | %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.} | |
271672fa BG |
7123 | @r{For convenience, %:keyword (see below) placeholders} |
7124 | @r{within the expression will be expanded prior to this.} | |
7125 | @r{The sexp must return a string.} | |
8223b1d2 BG |
7126 | %<...> @r{The result of format-time-string on the ... format specification.} |
7127 | %t @r{Timestamp, date only.} | |
7128 | %T @r{Timestamp, with date and time.} | |
7129 | %u, %U @r{Like the above, but inactive timestamps.} | |
7130 | %i @r{Initial content, the region when capture is called while the} | |
86fbb8ca | 7131 | @r{region is active.} |
b349f79f | 7132 | @r{The entire text will be indented like @code{%i} itself.} |
8223b1d2 BG |
7133 | %a @r{Annotation, normally the link created with @code{org-store-link}.} |
7134 | %A @r{Like @code{%a}, but prompt for the description part.} | |
7135 | %l @r{Like %a, but only insert the literal link.} | |
a7808fba CD |
7136 | %c @r{Current kill ring head.} |
7137 | %x @r{Content of the X clipboard.} | |
8223b1d2 BG |
7138 | %k @r{Title of the currently clocked task.} |
7139 | %K @r{Link to the currently clocked task.} | |
7140 | %n @r{User name (taken from @code{user-full-name}).} | |
7141 | %f @r{File visited by current buffer when org-capture was called.} | |
7142 | %F @r{Full path of the file or directory visited by current buffer.} | |
7143 | %:keyword @r{Specific information for certain link types, see below.} | |
7144 | %^g @r{Prompt for tags, with completion on tags in target file.} | |
7145 | %^G @r{Prompt for tags, with completion all tags in all agenda files.} | |
7146 | %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.} | |
ce57c2fe BG |
7147 | @r{You may define a prompt like @code{%^@{Birthday@}t}.} |
7148 | %^C @r{Interactive selection of which kill or clip to use.} | |
7149 | %^L @r{Like @code{%^C}, but insert as link.} | |
7150 | %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.} | |
7151 | %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.} | |
7152 | @r{You may specify a default value and a completion table with} | |
7153 | @r{%^@{prompt|default|completion2|completion3...@}.} | |
7154 | @r{The arrow keys access a prompt-specific history.} | |
8223b1d2 BG |
7155 | %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is} |
7156 | @r{a number, starting from 1.} | |
7157 | %? @r{After completing the template, position cursor here.} | |
86fbb8ca | 7158 | @end smallexample |
dbc28aaa CD |
7159 | |
7160 | @noindent | |
7161 | For specific link types, the following keywords will be | |
7162 | defined@footnote{If you define your own link types (@pxref{Adding | |
7163 | hyperlink types}), any property you store with | |
86fbb8ca | 7164 | @code{org-store-link-props} can be accessed in capture templates in a |
dbc28aaa CD |
7165 | similar way.}: |
7166 | ||
c8d0cf5c | 7167 | @vindex org-from-is-user-regexp |
86fbb8ca | 7168 | @smallexample |
8223b1d2 BG |
7169 | Link type | Available keywords |
7170 | ---------------------------------+---------------------------------------------- | |
7171 | bbdb | %:name %:company | |
7172 | irc | %:server %:port %:nick | |
7173 | vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id | |
7174 | | %:from %:fromname %:fromaddress | |
7175 | | %:to %:toname %:toaddress | |
7176 | | %:date @r{(message date header field)} | |
7177 | | %:date-timestamp @r{(date as active timestamp)} | |
7178 | | %:date-timestamp-inactive @r{(date as inactive timestamp)} | |
7179 | | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}} | |
7180 | gnus | %:group, @r{for messages also all email fields} | |
7181 | w3, w3m | %:url | |
7182 | info | %:file %:node | |
7183 | calendar | %:date | |
86fbb8ca | 7184 | @end smallexample |
dbc28aaa CD |
7185 | |
7186 | @noindent | |
7187 | To place the cursor after template expansion use: | |
7188 | ||
86fbb8ca | 7189 | @smallexample |
dbc28aaa | 7190 | %? @r{After completing the template, position cursor here.} |
86fbb8ca | 7191 | @end smallexample |
dbc28aaa | 7192 | |
8223b1d2 BG |
7193 | @node Templates in contexts, , Template expansion, Capture templates |
7194 | @subsubsection Templates in contexts | |
7195 | ||
7196 | @vindex org-capture-templates-contexts | |
7197 | To control whether a capture template should be accessible from a specific | |
271672fa | 7198 | context, you can customize @code{org-capture-templates-contexts}. Let's say |
8223b1d2 BG |
7199 | for example that you have a capture template @code{"p"} for storing Gnus |
7200 | emails containing patches. Then you would configure this option like this: | |
7201 | ||
271672fa | 7202 | @smalllisp |
8223b1d2 BG |
7203 | (setq org-capture-templates-contexts |
7204 | '(("p" (in-mode . "message-mode")))) | |
271672fa | 7205 | @end smalllisp |
8223b1d2 BG |
7206 | |
7207 | You can also tell that the command key @code{"p"} should refer to another | |
7208 | template. In that case, add this command key like this: | |
7209 | ||
271672fa | 7210 | @smalllisp |
8223b1d2 BG |
7211 | (setq org-capture-templates-contexts |
7212 | '(("p" "q" (in-mode . "message-mode")))) | |
271672fa | 7213 | @end smalllisp |
8223b1d2 BG |
7214 | |
7215 | See the docstring of the variable for more information. | |
c8d0cf5c | 7216 | |
86fbb8ca | 7217 | @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive |
864c9740 CD |
7218 | @section Attachments |
7219 | @cindex attachments | |
7220 | ||
c8d0cf5c | 7221 | @vindex org-attach-directory |
864c9740 CD |
7222 | It is often useful to associate reference material with an outline node/task. |
7223 | Small chunks of plain text can simply be stored in the subtree of a project. | |
86fbb8ca | 7224 | Hyperlinks (@pxref{Hyperlinks}) can establish associations with |
864c9740 CD |
7225 | files that live elsewhere on your computer or in the cloud, like emails or |
7226 | source code files belonging to a project. Another method is @i{attachments}, | |
7227 | which are files located in a directory belonging to an outline node. Org | |
7228 | uses directories named by the unique ID of each entry. These directories are | |
7229 | located in the @file{data} directory which lives in the same directory where | |
c8d0cf5c CD |
7230 | your Org file lives@footnote{If you move entries or Org files from one |
7231 | directory to another, you may want to configure @code{org-attach-directory} | |
864c9740 | 7232 | to contain an absolute path.}. If you initialize this directory with |
c8d0cf5c | 7233 | @code{git init}, Org will automatically commit changes when it sees them. |
864c9740 CD |
7234 | The attachment system has been contributed to Org by John Wiegley. |
7235 | ||
c8d0cf5c | 7236 | In cases where it seems better to do so, you can also attach a directory of your |
55e0839d CD |
7237 | choice to an entry. You can also make children inherit the attachment |
7238 | directory from a parent, so that an entire subtree uses the same attached | |
7239 | directory. | |
7240 | ||
86fbb8ca | 7241 | @noindent The following commands deal with attachments: |
864c9740 CD |
7242 | |
7243 | @table @kbd | |
acedf35c | 7244 | @orgcmd{C-c C-a,org-attach} |
864c9740 | 7245 | The dispatcher for commands related to the attachment system. After these |
86fbb8ca | 7246 | keys, a list of commands is displayed and you must press an additional key |
864c9740 CD |
7247 | to select a command: |
7248 | ||
7249 | @table @kbd | |
acedf35c | 7250 | @orgcmdtkc{a,C-c C-a a,org-attach-attach} |
c8d0cf5c | 7251 | @vindex org-attach-method |
864c9740 CD |
7252 | Select a file and move it into the task's attachment directory. The file |
7253 | will be copied, moved, or linked, depending on @code{org-attach-method}. | |
7254 | Note that hard links are not supported on all systems. | |
7255 | ||
7256 | @kindex C-c C-a c | |
96c8522a CD |
7257 | @kindex C-c C-a m |
7258 | @kindex C-c C-a l | |
864c9740 CD |
7259 | @item c/m/l |
7260 | Attach a file using the copy/move/link method. | |
7261 | Note that hard links are not supported on all systems. | |
7262 | ||
acedf35c | 7263 | @orgcmdtkc{n,C-c C-a n,org-attach-new} |
864c9740 CD |
7264 | Create a new attachment as an Emacs buffer. |
7265 | ||
acedf35c | 7266 | @orgcmdtkc{z,C-c C-a z,org-attach-sync} |
864c9740 CD |
7267 | Synchronize the current task with its attachment directory, in case you added |
7268 | attachments yourself. | |
7269 | ||
ce57c2fe | 7270 | @orgcmdtkc{o,C-c C-a o,org-attach-open} |
c8d0cf5c | 7271 | @vindex org-file-apps |
86fbb8ca | 7272 | Open current task's attachment. If there is more than one, prompt for a |
864c9740 | 7273 | file name first. Opening will follow the rules set by @code{org-file-apps}. |
a50253cc | 7274 | For more details, see the information on following hyperlinks |
864c9740 CD |
7275 | (@pxref{Handling links}). |
7276 | ||
acedf35c | 7277 | @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs} |
864c9740 CD |
7278 | Also open the attachment, but force opening the file in Emacs. |
7279 | ||
acedf35c | 7280 | @orgcmdtkc{f,C-c C-a f,org-attach-reveal} |
864c9740 CD |
7281 | Open the current task's attachment directory. |
7282 | ||
acedf35c | 7283 | @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs} |
c8d0cf5c | 7284 | Also open the directory, but force using @command{dired} in Emacs. |
864c9740 | 7285 | |
acedf35c | 7286 | @orgcmdtkc{d,C-c C-a d,org-attach-delete-one} |
864c9740 CD |
7287 | Select and delete a single attachment. |
7288 | ||
acedf35c | 7289 | @orgcmdtkc{D,C-c C-a D,org-attach-delete-all} |
864c9740 | 7290 | Delete all of a task's attachments. A safer way is to open the directory in |
c8d0cf5c | 7291 | @command{dired} and delete from there. |
55e0839d | 7292 | |
acedf35c | 7293 | @orgcmdtkc{s,C-c C-a s,org-attach-set-directory} |
c8d0cf5c | 7294 | @cindex property, ATTACH_DIR |
55e0839d CD |
7295 | Set a specific directory as the entry's attachment directory. This works by |
7296 | putting the directory path into the @code{ATTACH_DIR} property. | |
7297 | ||
acedf35c | 7298 | @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit} |
c8d0cf5c | 7299 | @cindex property, ATTACH_DIR_INHERIT |
55e0839d | 7300 | Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the |
c8d0cf5c | 7301 | same directory for attachments as the parent does. |
864c9740 CD |
7302 | @end table |
7303 | @end table | |
7304 | ||
a351880d | 7305 | @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive |
c8d0cf5c CD |
7306 | @section RSS feeds |
7307 | @cindex RSS feeds | |
86fbb8ca | 7308 | @cindex Atom feeds |
c8d0cf5c | 7309 | |
86fbb8ca CD |
7310 | Org can add and change entries based on information found in RSS feeds and |
7311 | Atom feeds. You could use this to make a task out of each new podcast in a | |
c8d0cf5c | 7312 | podcast feed. Or you could use a phone-based note-creating service on the |
86fbb8ca CD |
7313 | web to import tasks into Org. To access feeds, configure the variable |
7314 | @code{org-feed-alist}. The docstring of this variable has detailed | |
c8d0cf5c CD |
7315 | information. Here is just an example: |
7316 | ||
271672fa BG |
7317 | @smalllisp |
7318 | @group | |
c8d0cf5c | 7319 | (setq org-feed-alist |
86fbb8ca | 7320 | '(("Slashdot" |
c0468714 GM |
7321 | "http://rss.slashdot.org/Slashdot/slashdot" |
7322 | "~/txt/org/feeds.org" "Slashdot Entries"))) | |
271672fa BG |
7323 | @end group |
7324 | @end smalllisp | |
86fbb8ca | 7325 | |
c8d0cf5c | 7326 | @noindent |
86fbb8ca CD |
7327 | will configure that new items from the feed provided by |
7328 | @code{rss.slashdot.org} will result in new entries in the file | |
7329 | @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever | |
7330 | the following command is used: | |
c8d0cf5c CD |
7331 | |
7332 | @table @kbd | |
acedf35c | 7333 | @orgcmd{C-c C-x g,org-feed-update-all} |
c8d0cf5c CD |
7334 | @item C-c C-x g |
7335 | Collect items from the feeds configured in @code{org-feed-alist} and act upon | |
7336 | them. | |
acedf35c | 7337 | @orgcmd{C-c C-x G,org-feed-goto-inbox} |
c8d0cf5c CD |
7338 | Prompt for a feed name and go to the inbox configured for this feed. |
7339 | @end table | |
7340 | ||
7341 | Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which | |
7342 | it will store information about the status of items in the feed, to avoid | |
7343 | adding the same item several times. You should add @samp{FEEDSTATUS} to the | |
7344 | list of drawers in that file: | |
7345 | ||
7346 | @example | |
7347 | #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS | |
7348 | @end example | |
7349 | ||
86fbb8ca CD |
7350 | For more information, including how to read atom feeds, see |
7351 | @file{org-feed.el} and the docstring of @code{org-feed-alist}. | |
c8d0cf5c | 7352 | |
271672fa | 7353 | @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive |
c8d0cf5c CD |
7354 | @section Protocols for external access |
7355 | @cindex protocols, for external access | |
7356 | @cindex emacsserver | |
7357 | ||
7358 | You can set up Org for handling protocol calls from outside applications that | |
7359 | are passed to Emacs through the @file{emacsserver}. For example, you can | |
7360 | configure bookmarks in your web browser to send a link to the current page to | |
86fbb8ca | 7361 | Org and create a note from it using capture (@pxref{Capture}). Or you |
c8d0cf5c CD |
7362 | could create a bookmark that will tell Emacs to open the local source file of |
7363 | a remote website you are looking at with the browser. See | |
7364 | @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed | |
7365 | documentation and setup instructions. | |
7366 | ||
271672fa BG |
7367 | @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive |
7368 | @section Refile and copy | |
a351880d | 7369 | @cindex refiling notes |
271672fa | 7370 | @cindex copying notes |
c8d0cf5c | 7371 | |
271672fa BG |
7372 | When reviewing the captured data, you may want to refile or to copy some of |
7373 | the entries into a different list, for example into a project. Cutting, | |
7374 | finding the right location, and then pasting the note is cumbersome. To | |
7375 | simplify this process, you can use the following special command: | |
4009494e | 7376 | |
a351880d | 7377 | @table @kbd |
271672fa BG |
7378 | @orgcmd{C-c M-w,org-copy} |
7379 | @findex org-copy | |
7380 | Copying works like refiling, except that the original note is not deleted. | |
acedf35c | 7381 | @orgcmd{C-c C-w,org-refile} |
271672fa | 7382 | @findex org-refile |
a351880d CD |
7383 | @vindex org-reverse-note-order |
7384 | @vindex org-refile-targets | |
7385 | @vindex org-refile-use-outline-path | |
7386 | @vindex org-outline-path-complete-in-steps | |
7387 | @vindex org-refile-allow-creating-parent-nodes | |
ed21c5c8 | 7388 | @vindex org-log-refile |
86fbb8ca | 7389 | @vindex org-refile-use-cache |
271672fa | 7390 | @vindex org-refile-keep |
a351880d CD |
7391 | Refile the entry or region at point. This command offers possible locations |
7392 | for refiling the entry and lets you select one with completion. The item (or | |
7393 | all items in the region) is filed below the target heading as a subitem. | |
7394 | Depending on @code{org-reverse-note-order}, it will be either the first or | |
7395 | last subitem.@* | |
7396 | By default, all level 1 headlines in the current buffer are considered to be | |
7397 | targets, but you can have more complex definitions across a number of files. | |
7398 | See the variable @code{org-refile-targets} for details. If you would like to | |
7399 | select a location via a file-path-like completion along the outline path, see | |
7400 | the variables @code{org-refile-use-outline-path} and | |
7401 | @code{org-outline-path-complete-in-steps}. If you would like to be able to | |
045b9da7 | 7402 | create new nodes as new parents for refiling on the fly, check the |
a351880d | 7403 | variable @code{org-refile-allow-creating-parent-nodes}. |
ed21c5c8 CD |
7404 | When the variable @code{org-log-refile}@footnote{with corresponding |
7405 | @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile}, | |
ce57c2fe | 7406 | and @code{nologrefile}} is set, a timestamp or a note will be |
ed21c5c8 | 7407 | recorded when an entry has been refiled. |
acedf35c | 7408 | @orgkey{C-u C-c C-w} |
a351880d | 7409 | Use the refile interface to jump to a heading. |
acedf35c | 7410 | @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored} |
a351880d CD |
7411 | Jump to the location where @code{org-refile} last moved a tree to. |
7412 | @item C-2 C-c C-w | |
7413 | Refile as the child of the item currently being clocked. | |
271672fa BG |
7414 | @item C-3 C-c C-w |
7415 | Refile and keep the entry in place. Also see @code{org-refile-keep} to make | |
7416 | this the default behavior, and beware that this may result in duplicated | |
7417 | @code{ID} properties. | |
acedf35c | 7418 | @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear} |
86fbb8ca | 7419 | Clear the target cache. Caching of refile targets can be turned on by |
acedf35c | 7420 | setting @code{org-refile-use-cache}. To make the command see new possible |
86fbb8ca | 7421 | targets, you have to clear the cache with this command. |
a351880d | 7422 | @end table |
4009494e | 7423 | |
271672fa | 7424 | @node Archiving, , Refile and copy, Capture - Refile - Archive |
a351880d CD |
7425 | @section Archiving |
7426 | @cindex archiving | |
4009494e | 7427 | |
a351880d CD |
7428 | When a project represented by a (sub)tree is finished, you may want |
7429 | to move the tree out of the way and to stop it from contributing to the | |
7430 | agenda. Archiving is important to keep your working files compact and global | |
7431 | searches like the construction of agenda views fast. | |
7432 | ||
7433 | @table @kbd | |
acedf35c | 7434 | @orgcmd{C-c C-x C-a,org-archive-subtree-default} |
a351880d CD |
7435 | @vindex org-archive-default-command |
7436 | Archive the current entry using the command specified in the variable | |
7437 | @code{org-archive-default-command}. | |
7438 | @end table | |
7439 | ||
7440 | @menu | |
c0468714 GM |
7441 | * Moving subtrees:: Moving a tree to an archive file |
7442 | * Internal archiving:: Switch off a tree but keep it in the file | |
a351880d CD |
7443 | @end menu |
7444 | ||
7445 | @node Moving subtrees, Internal archiving, Archiving, Archiving | |
7446 | @subsection Moving a tree to the archive file | |
7447 | @cindex external archiving | |
7448 | ||
7449 | The most common archiving action is to move a project tree to another file, | |
7450 | the archive file. | |
7451 | ||
7452 | @table @kbd | |
acedf35c | 7453 | @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree} |
a351880d CD |
7454 | @vindex org-archive-location |
7455 | Archive the subtree starting at the cursor position to the location | |
7456 | given by @code{org-archive-location}. | |
acedf35c | 7457 | @orgkey{C-u C-c C-x C-s} |
a351880d CD |
7458 | Check if any direct children of the current headline could be moved to |
7459 | the archive. To do this, each subtree is checked for open TODO entries. | |
7460 | If none are found, the command offers to move it to the archive | |
7461 | location. If the cursor is @emph{not} on a headline when this command | |
7462 | is invoked, the level 1 trees will be checked. | |
7463 | @end table | |
7464 | ||
7465 | @cindex archive locations | |
7466 | The default archive location is a file in the same directory as the | |
7467 | current file, with the name derived by appending @file{_archive} to the | |
8223b1d2 BG |
7468 | current file name. You can also choose what heading to file archived |
7469 | items under, with the possibility to add them to a datetree in a file. | |
7470 | For information and examples on how to specify the file and the heading, | |
a351880d | 7471 | see the documentation string of the variable |
8223b1d2 BG |
7472 | @code{org-archive-location}. |
7473 | ||
7474 | There is also an in-buffer option for setting this variable, for | |
7475 | example@footnote{For backward compatibility, the following also works: | |
7476 | If there are several such lines in a file, each specifies the archive | |
7477 | location for the text below it. The first such line also applies to any | |
7478 | text before its definition. However, using this method is | |
7479 | @emph{strongly} deprecated as it is incompatible with the outline | |
7480 | structure of the document. The correct method for setting multiple | |
7481 | archive locations in a buffer is using properties.}: | |
a351880d CD |
7482 | |
7483 | @cindex #+ARCHIVE | |
7484 | @example | |
7485 | #+ARCHIVE: %s_done:: | |
7486 | @end example | |
7487 | ||
7488 | @cindex property, ARCHIVE | |
7489 | @noindent | |
7490 | If you would like to have a special ARCHIVE location for a single entry | |
7491 | or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the | |
7492 | location as the value (@pxref{Properties and Columns}). | |
7493 | ||
7494 | @vindex org-archive-save-context-info | |
7495 | When a subtree is moved, it receives a number of special properties that | |
7496 | record context information like the file from where the entry came, its | |
7497 | outline path the archiving time etc. Configure the variable | |
7498 | @code{org-archive-save-context-info} to adjust the amount of information | |
7499 | added. | |
7500 | ||
7501 | ||
7502 | @node Internal archiving, , Moving subtrees, Archiving | |
7503 | @subsection Internal archiving | |
7504 | ||
7505 | If you want to just switch off (for agenda views) certain subtrees without | |
7506 | moving them to a different file, you can use the @code{ARCHIVE tag}. | |
7507 | ||
7508 | A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
7509 | its location in the outline tree, but behaves in the following way: | |
7510 | @itemize @minus | |
7511 | @item | |
7512 | @vindex org-cycle-open-archived-trees | |
7513 | It does not open when you attempt to do so with a visibility cycling | |
7514 | command (@pxref{Visibility cycling}). You can force cycling archived | |
7515 | subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
7516 | @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
7517 | @code{show-all} will open archived subtrees. | |
7518 | @item | |
7519 | @vindex org-sparse-tree-open-archived-trees | |
7520 | During sparse tree construction (@pxref{Sparse trees}), matches in | |
7521 | archived subtrees are not exposed, unless you configure the option | |
7522 | @code{org-sparse-tree-open-archived-trees}. | |
7523 | @item | |
7524 | @vindex org-agenda-skip-archived-trees | |
7525 | During agenda view construction (@pxref{Agenda Views}), the content of | |
7526 | archived trees is ignored unless you configure the option | |
7527 | @code{org-agenda-skip-archived-trees}, in which case these trees will always | |
7528 | be included. In the agenda you can press @kbd{v a} to get archives | |
7529 | temporarily included. | |
7530 | @item | |
7531 | @vindex org-export-with-archived-trees | |
7532 | Archived trees are not exported (@pxref{Exporting}), only the headline | |
7533 | is. Configure the details using the variable | |
7534 | @code{org-export-with-archived-trees}. | |
7535 | @item | |
86fbb8ca | 7536 | @vindex org-columns-skip-archived-trees |
a351880d | 7537 | Archived trees are excluded from column view unless the variable |
86fbb8ca | 7538 | @code{org-columns-skip-archived-trees} is configured to @code{nil}. |
a351880d CD |
7539 | @end itemize |
7540 | ||
86fbb8ca | 7541 | The following commands help manage the ARCHIVE tag: |
a351880d CD |
7542 | |
7543 | @table @kbd | |
acedf35c | 7544 | @orgcmd{C-c C-x a,org-toggle-archive-tag} |
a351880d CD |
7545 | Toggle the ARCHIVE tag for the current headline. When the tag is set, |
7546 | the headline changes to a shadowed face, and the subtree below it is | |
7547 | hidden. | |
acedf35c | 7548 | @orgkey{C-u C-c C-x a} |
a351880d CD |
7549 | Check if any direct children of the current headline should be archived. |
7550 | To do this, each subtree is checked for open TODO entries. If none are | |
7551 | found, the command offers to set the ARCHIVE tag for the child. If the | |
7552 | cursor is @emph{not} on a headline when this command is invoked, the | |
7553 | level 1 trees will be checked. | |
acedf35c | 7554 | @orgcmd{C-@kbd{TAB},org-force-cycle-archived} |
a351880d | 7555 | Cycle a tree even if it is tagged with ARCHIVE. |
acedf35c | 7556 | @orgcmd{C-c C-x A,org-archive-to-archive-sibling} |
a351880d CD |
7557 | Move the current entry to the @emph{Archive Sibling}. This is a sibling of |
7558 | the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The | |
7559 | entry becomes a child of that sibling and in this way retains a lot of its | |
7560 | original context, including inherited tags and approximate position in the | |
7561 | outline. | |
7562 | @end table | |
7563 | ||
7564 | ||
7565 | @node Agenda Views, Markup, Capture - Refile - Archive, Top | |
86fbb8ca | 7566 | @chapter Agenda views |
a351880d CD |
7567 | @cindex agenda views |
7568 | ||
7569 | Due to the way Org works, TODO items, time-stamped items, and | |
7570 | tagged headlines can be scattered throughout a file or even a number of | |
7571 | files. To get an overview of open action items, or of events that are | |
7572 | important for a particular date, this information must be collected, | |
7573 | sorted and displayed in an organized way. | |
7574 | ||
7575 | Org can select items based on various criteria and display them | |
7576 | in a separate buffer. Seven different view types are provided: | |
7577 | ||
7578 | @itemize @bullet | |
7579 | @item | |
7580 | an @emph{agenda} that is like a calendar and shows information | |
7581 | for specific dates, | |
7582 | @item | |
7583 | a @emph{TODO list} that covers all unfinished | |
7584 | action items, | |
7585 | @item | |
7586 | a @emph{match view}, showings headlines based on the tags, properties, and | |
7587 | TODO state associated with them, | |
7588 | @item | |
7589 | a @emph{timeline view} that shows all events in a single Org file, | |
7590 | in time-sorted view, | |
7591 | @item | |
7592 | a @emph{text search view} that shows all entries from multiple files | |
7593 | that contain specified keywords, | |
7594 | @item | |
7595 | a @emph{stuck projects view} showing projects that currently don't move | |
7596 | along, and | |
7597 | @item | |
7598 | @emph{custom views} that are special searches and combinations of different | |
7599 | views. | |
4009494e GM |
7600 | @end itemize |
7601 | ||
7602 | @noindent | |
7603 | The extracted information is displayed in a special @emph{agenda | |
7604 | buffer}. This buffer is read-only, but provides commands to visit the | |
a7808fba | 7605 | corresponding locations in the original Org files, and even to |
28a16a1b | 7606 | edit these files remotely. |
4009494e | 7607 | |
c8d0cf5c CD |
7608 | @vindex org-agenda-window-setup |
7609 | @vindex org-agenda-restore-windows-after-quit | |
4009494e GM |
7610 | Two variables control how the agenda buffer is displayed and whether the |
7611 | window configuration is restored when the agenda exits: | |
7612 | @code{org-agenda-window-setup} and | |
7613 | @code{org-agenda-restore-windows-after-quit}. | |
7614 | ||
7615 | @menu | |
c0468714 GM |
7616 | * Agenda files:: Files being searched for agenda information |
7617 | * Agenda dispatcher:: Keyboard access to agenda views | |
7618 | * Built-in agenda views:: What is available out of the box? | |
7619 | * Presentation and sorting:: How agenda items are prepared for display | |
7620 | * Agenda commands:: Remote editing of Org trees | |
7621 | * Custom agenda views:: Defining special searches and views | |
7622 | * Exporting Agenda Views:: Writing a view to a file | |
7623 | * Agenda column view:: Using column view for collected entries | |
4009494e GM |
7624 | @end menu |
7625 | ||
a7808fba | 7626 | @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
4009494e GM |
7627 | @section Agenda files |
7628 | @cindex agenda files | |
7629 | @cindex files for agenda | |
7630 | ||
c8d0cf5c | 7631 | @vindex org-agenda-files |
dbc28aaa CD |
7632 | The information to be shown is normally collected from all @emph{agenda |
7633 | files}, the files listed in the variable | |
7634 | @code{org-agenda-files}@footnote{If the value of that variable is not a | |
7635 | list, but a single file name, then the list of agenda files will be | |
ce57c2fe | 7636 | maintained in that external file.}. If a directory is part of this list, |
dbc28aaa CD |
7637 | all files with the extension @file{.org} in this directory will be part |
7638 | of the list. | |
7639 | ||
c8d0cf5c CD |
7640 | Thus, even if you only work with a single Org file, that file should |
7641 | be put into the list@footnote{When using the dispatcher, pressing | |
dbc28aaa CD |
7642 | @kbd{<} before selecting a command will actually limit the command to |
7643 | the current file, and ignore @code{org-agenda-files} until the next | |
4009494e GM |
7644 | dispatcher command.}. You can customize @code{org-agenda-files}, but |
7645 | the easiest way to maintain it is through the following commands | |
7646 | ||
7647 | @cindex files, adding to agenda list | |
7648 | @table @kbd | |
ce57c2fe | 7649 | @orgcmd{C-c [,org-agenda-file-to-front} |
4009494e GM |
7650 | Add current file to the list of agenda files. The file is added to |
7651 | the front of the list. If it was already in the list, it is moved to | |
a7808fba | 7652 | the front. With a prefix argument, file is added/moved to the end. |
acedf35c | 7653 | @orgcmd{C-c ],org-remove-file} |
4009494e GM |
7654 | Remove current file from the list of agenda files. |
7655 | @kindex C-, | |
e66ba1df | 7656 | @cindex cycling, of agenda files |
acedf35c CD |
7657 | @orgcmd{C-',org-cycle-agenda-files} |
7658 | @itemx C-, | |
4009494e | 7659 | Cycle through agenda file list, visiting one file after the other. |
a7808fba | 7660 | @kindex M-x org-iswitchb |
271672fa | 7661 | @item M-x org-iswitchb RET |
a7808fba CD |
7662 | Command to use an @code{iswitchb}-like interface to switch to and between Org |
7663 | buffers. | |
4009494e GM |
7664 | @end table |
7665 | ||
7666 | @noindent | |
7667 | The Org menu contains the current list of files and can be used | |
7668 | to visit any of them. | |
7669 | ||
c8d0cf5c CD |
7670 | If you would like to focus the agenda temporarily on a file not in |
7671 | this list, or on just one file in the list, or even on only a subtree in a | |
7672 | file, then this can be done in different ways. For a single agenda command, | |
dbc28aaa CD |
7673 | you may press @kbd{<} once or several times in the dispatcher |
7674 | (@pxref{Agenda dispatcher}). To restrict the agenda scope for an | |
7675 | extended period, use the following commands: | |
7676 | ||
7677 | @table @kbd | |
acedf35c | 7678 | @orgcmd{C-c C-x <,org-agenda-set-restriction-lock} |
dbc28aaa CD |
7679 | Permanently restrict the agenda to the current subtree. When with a |
7680 | prefix argument, or with the cursor before the first headline in a file, | |
7681 | the agenda scope is set to the entire file. This restriction remains in | |
7682 | effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} | |
7683 | or @kbd{>} in the agenda dispatcher. If there is a window displaying an | |
7684 | agenda view, the new restriction takes effect immediately. | |
acedf35c | 7685 | @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock} |
dbc28aaa CD |
7686 | Remove the permanent restriction created by @kbd{C-c C-x <}. |
7687 | @end table | |
7688 | ||
7689 | @noindent | |
c8d0cf5c | 7690 | When working with @file{speedbar.el}, you can use the following commands in |
a7808fba | 7691 | the Speedbar frame: |
271672fa | 7692 | |
dbc28aaa | 7693 | @table @kbd |
acedf35c | 7694 | @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction} |
c8d0cf5c CD |
7695 | Permanently restrict the agenda to the item---either an Org file or a subtree |
7696 | in such a file---at the cursor in the Speedbar frame. | |
dbc28aaa CD |
7697 | If there is a window displaying an agenda view, the new restriction takes |
7698 | effect immediately. | |
acedf35c | 7699 | @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock} |
c8d0cf5c | 7700 | Lift the restriction. |
dbc28aaa CD |
7701 | @end table |
7702 | ||
a7808fba | 7703 | @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
4009494e GM |
7704 | @section The agenda dispatcher |
7705 | @cindex agenda dispatcher | |
7706 | @cindex dispatching agenda commands | |
c8d0cf5c | 7707 | The views are created through a dispatcher, which should be bound to a |
ce57c2fe | 7708 | global key---for example @kbd{C-c a} (@pxref{Activation}). In the |
4009494e GM |
7709 | following we will assume that @kbd{C-c a} is indeed how the dispatcher |
7710 | is accessed and list keyboard access to commands accordingly. After | |
7711 | pressing @kbd{C-c a}, an additional letter is required to execute a | |
7712 | command. The dispatcher offers the following default commands: | |
271672fa | 7713 | |
4009494e GM |
7714 | @table @kbd |
7715 | @item a | |
a7808fba | 7716 | Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
4009494e GM |
7717 | @item t @r{/} T |
7718 | Create a list of all TODO items (@pxref{Global TODO list}). | |
7719 | @item m @r{/} M | |
7720 | Create a list of headlines matching a TAGS expression (@pxref{Matching | |
7721 | tags and properties}). | |
7722 | @item L | |
7723 | Create the timeline view for the current buffer (@pxref{Timeline}). | |
28a16a1b CD |
7724 | @item s |
7725 | Create a list of entries selected by a boolean expression of keywords | |
7726 | and/or regular expressions that must or must not occur in the entry. | |
dbc28aaa | 7727 | @item / |
c8d0cf5c | 7728 | @vindex org-agenda-text-search-extra-files |
dbc28aaa | 7729 | Search for a regular expression in all agenda files and additionally in |
c8d0cf5c | 7730 | the files listed in @code{org-agenda-text-search-extra-files}. This |
dbc28aaa CD |
7731 | uses the Emacs command @code{multi-occur}. A prefix argument can be |
7732 | used to specify the number of context lines for each match, default is | |
7733 | 1. | |
28a16a1b CD |
7734 | @item # @r{/} ! |
7735 | Create a list of stuck projects (@pxref{Stuck projects}). | |
dbc28aaa CD |
7736 | @item < |
7737 | Restrict an agenda command to the current buffer@footnote{For backward | |
7738 | compatibility, you can also press @kbd{1} to restrict to the current | |
7739 | buffer.}. After pressing @kbd{<}, you still need to press the character | |
7740 | selecting the command. | |
7741 | @item < < | |
4009494e | 7742 | If there is an active region, restrict the following agenda command to |
dbc28aaa CD |
7743 | the region. Otherwise, restrict it to the current subtree@footnote{For |
7744 | backward compatibility, you can also press @kbd{0} to restrict to the | |
c8d0cf5c | 7745 | current region/subtree.}. After pressing @kbd{< <}, you still need to press the |
dbc28aaa | 7746 | character selecting the command. |
8223b1d2 BG |
7747 | |
7748 | @item * | |
7749 | @vindex org-agenda-sticky | |
7750 | Toggle sticky agenda views. By default, Org maintains only a single agenda | |
7751 | buffer and rebuilds it each time you change the view, to make sure everything | |
7752 | is always up to date. If you switch between views often and the build time | |
7753 | bothers you, you can turn on sticky agenda buffers (make this the default by | |
7754 | customizing the variable @code{org-agenda-sticky}). With sticky agendas, the | |
7755 | dispatcher only switches to the selected view, you need to update it by hand | |
7756 | with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with | |
7757 | @code{org-toggle-sticky-agenda}. | |
4009494e GM |
7758 | @end table |
7759 | ||
7760 | You can also define custom commands that will be accessible through the | |
7761 | dispatcher, just like the default commands. This includes the | |
7762 | possibility to create extended agenda buffers that contain several | |
7763 | blocks together, for example the weekly agenda, the global TODO list and | |
7764 | a number of special tags matches. @xref{Custom agenda views}. | |
7765 | ||
a7808fba | 7766 | @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
4009494e GM |
7767 | @section The built-in agenda views |
7768 | ||
7769 | In this section we describe the built-in views. | |
7770 | ||
7771 | @menu | |
c0468714 GM |
7772 | * Weekly/daily agenda:: The calendar page with current tasks |
7773 | * Global TODO list:: All unfinished action items | |
4009494e | 7774 | * Matching tags and properties:: Structured information with fine-tuned search |
c0468714 GM |
7775 | * Timeline:: Time-sorted view for single file |
7776 | * Search view:: Find entries by searching for text | |
7777 | * Stuck projects:: Find projects you need to review | |
4009494e GM |
7778 | @end menu |
7779 | ||
a7808fba | 7780 | @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
4009494e GM |
7781 | @subsection The weekly/daily agenda |
7782 | @cindex agenda | |
7783 | @cindex weekly agenda | |
7784 | @cindex daily agenda | |
7785 | ||
7786 | The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
7787 | paper agenda, showing all the tasks for the current week or day. | |
7788 | ||
7789 | @table @kbd | |
7790 | @cindex org-agenda, command | |
acedf35c | 7791 | @orgcmd{C-c a a,org-agenda-list} |
c8d0cf5c | 7792 | Compile an agenda for the current week from a list of Org files. The agenda |
864c9740 CD |
7793 | shows the entries for each day. With a numeric prefix@footnote{For backward |
7794 | compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be | |
7795 | listed before the agenda. This feature is deprecated, use the dedicated TODO | |
7796 | list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 | |
acedf35c | 7797 | C-c a a}) you may set the number of days to be displayed. |
4009494e GM |
7798 | @end table |
7799 | ||
acedf35c CD |
7800 | @vindex org-agenda-span |
7801 | @vindex org-agenda-ndays | |
271672fa BG |
7802 | @vindex org-agenda-start-day |
7803 | @vindex org-agenda-start-on-weekday | |
acedf35c CD |
7804 | The default number of days displayed in the agenda is set by the variable |
7805 | @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This | |
7806 | variable can be set to any number of days you want to see by default in the | |
271672fa BG |
7807 | agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or |
7808 | @code{year}. For weekly agendas, the default is to start on the previous | |
7809 | monday (see @code{org-agenda-start-on-weekday}). You can also set the start | |
7810 | date using a date shift: @code{(setq org-agenda-start-day "+10d")} will | |
7811 | start the agenda ten days from today in the future. | |
acedf35c | 7812 | |
4009494e GM |
7813 | Remote editing from the agenda buffer means, for example, that you can |
7814 | change the dates of deadlines and appointments from the agenda buffer. | |
7815 | The commands available in the Agenda buffer are listed in @ref{Agenda | |
7816 | commands}. | |
7817 | ||
7818 | @subsubheading Calendar/Diary integration | |
7819 | @cindex calendar integration | |
7820 | @cindex diary integration | |
7821 | ||
7822 | Emacs contains the calendar and diary by Edward M. Reingold. The | |
7823 | calendar displays a three-month calendar with holidays from different | |
7824 | countries and cultures. The diary allows you to keep track of | |
7825 | anniversaries, lunar phases, sunrise/set, recurrent appointments | |
7826 | (weekly, monthly) and more. In this way, it is quite complementary to | |
a7808fba | 7827 | Org. It can be very useful to combine output from Org with |
4009494e GM |
7828 | the diary. |
7829 | ||
e66ba1df | 7830 | In order to include entries from the Emacs diary into Org mode's |
4009494e GM |
7831 | agenda, you only need to customize the variable |
7832 | ||
7833 | @lisp | |
7834 | (setq org-agenda-include-diary t) | |
7835 | @end lisp | |
7836 | ||
7837 | @noindent After that, everything will happen automatically. All diary | |
c8d0cf5c | 7838 | entries including holidays, anniversaries, etc., will be included in the |
e66ba1df | 7839 | agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
4009494e GM |
7840 | @key{RET} can be used from the agenda buffer to jump to the diary |
7841 | file in order to edit existing diary entries. The @kbd{i} command to | |
7842 | insert new entries for the current date works in the agenda buffer, as | |
7843 | well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
7844 | Sunrise/Sunset times, show lunar phases and to convert to other | |
7845 | calendars, respectively. @kbd{c} can be used to switch back and forth | |
7846 | between calendar and agenda. | |
7847 | ||
7848 | If you are using the diary only for sexp entries and holidays, it is | |
7849 | faster to not use the above setting, but instead to copy or even move | |
e66ba1df | 7850 | the entries into an Org file. Org mode evaluates diary-style sexp |
4009494e GM |
7851 | entries, and does it faster because there is no overhead for first |
7852 | creating the diary display. Note that the sexp entries must start at | |
c8d0cf5c | 7853 | the left margin, no whitespace is allowed before them. For example, |
a7808fba | 7854 | the following segment of an Org file will be processed and entries |
4009494e GM |
7855 | will be made in the agenda: |
7856 | ||
7857 | @example | |
7858 | * Birthdays and similar stuff | |
7859 | #+CATEGORY: Holiday | |
7860 | %%(org-calendar-holiday) ; special function for holiday names | |
7861 | #+CATEGORY: Ann | |
e4920bc9 | 7862 | %%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old |
ce57c2fe | 7863 | %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old |
4009494e GM |
7864 | @end example |
7865 | ||
c8d0cf5c CD |
7866 | @subsubheading Anniversaries from BBDB |
7867 | @cindex BBDB, anniversaries | |
7868 | @cindex anniversaries, from BBDB | |
7869 | ||
7870 | If you are using the Big Brothers Database to store your contacts, you will | |
7871 | very likely prefer to store anniversaries in BBDB rather than in a | |
7872 | separate Org or diary file. Org supports this and will show BBDB | |
7873 | anniversaries as part of the agenda. All you need to do is to add the | |
5a5fa834 | 7874 | following to one of your agenda files: |
c8d0cf5c CD |
7875 | |
7876 | @example | |
7877 | * Anniversaries | |
7878 | :PROPERTIES: | |
7879 | :CATEGORY: Anniv | |
86fbb8ca | 7880 | :END: |
c8d0cf5c CD |
7881 | %%(org-bbdb-anniversaries) |
7882 | @end example | |
7883 | ||
7884 | You can then go ahead and define anniversaries for a BBDB record. Basically, | |
7885 | you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB | |
ce57c2fe BG |
7886 | record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD}, |
7887 | followed by a space and the class of the anniversary (@samp{birthday} or | |
7888 | @samp{wedding}, or a format string). If you omit the class, it will default to | |
7889 | @samp{birthday}. Here are a few examples, the header for the file | |
7890 | @file{org-bbdb.el} contains more detailed information. | |
c8d0cf5c CD |
7891 | |
7892 | @example | |
7893 | 1973-06-22 | |
ce57c2fe | 7894 | 06-22 |
c8d0cf5c | 7895 | 1955-08-02 wedding |
e66ba1df | 7896 | 2008-04-14 %s released version 6.01 of org mode, %d years ago |
c8d0cf5c CD |
7897 | @end example |
7898 | ||
7899 | After a change to BBDB, or for the first agenda display during an Emacs | |
7900 | session, the agenda display will suffer a short delay as Org updates its | |
7901 | hash with anniversaries. However, from then on things will be very fast---much | |
7902 | faster in fact than a long list of @samp{%%(diary-anniversary)} entries | |
7903 | in an Org or Diary file. | |
7904 | ||
dbc28aaa CD |
7905 | @subsubheading Appointment reminders |
7906 | @cindex @file{appt.el} | |
7907 | @cindex appointment reminders | |
e66ba1df BG |
7908 | @cindex appointment |
7909 | @cindex reminders | |
dbc28aaa | 7910 | |
8223b1d2 BG |
7911 | Org can interact with Emacs appointments notification facility. To add the |
7912 | appointments of your agenda files, use the command @code{org-agenda-to-appt}. | |
7913 | This command lets you filter through the list of your appointments and add | |
7914 | only those belonging to a specific category or matching a regular expression. | |
7915 | It also reads a @code{APPT_WARNTIME} property which will then override the | |
7916 | value of @code{appt-message-warning-time} for this appointment. See the | |
7917 | docstring for details. | |
dbc28aaa | 7918 | |
a7808fba | 7919 | @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
4009494e GM |
7920 | @subsection The global TODO list |
7921 | @cindex global TODO list | |
7922 | @cindex TODO list, global | |
7923 | ||
c8d0cf5c | 7924 | The global TODO list contains all unfinished TODO items formatted and |
4009494e GM |
7925 | collected into a single place. |
7926 | ||
7927 | @table @kbd | |
acedf35c | 7928 | @orgcmd{C-c a t,org-todo-list} |
86fbb8ca CD |
7929 | Show the global TODO list. This collects the TODO items from all agenda |
7930 | files (@pxref{Agenda Views}) into a single buffer. By default, this lists | |
7931 | items with a state the is not a DONE state. The buffer is in | |
7932 | @code{agenda-mode}, so there are commands to examine and manipulate the TODO | |
7933 | entries directly from that buffer (@pxref{Agenda commands}). | |
acedf35c | 7934 | @orgcmd{C-c a T,org-todo-list} |
4009494e | 7935 | @cindex TODO keyword matching |
c8d0cf5c | 7936 | @vindex org-todo-keywords |
86fbb8ca CD |
7937 | Like the above, but allows selection of a specific TODO keyword. You can |
7938 | also do this by specifying a prefix argument to @kbd{C-c a t}. You are | |
7939 | prompted for a keyword, and you may also specify several keywords by | |
7940 | separating them with @samp{|} as the boolean OR operator. With a numeric | |
acedf35c | 7941 | prefix, the Nth keyword in @code{org-todo-keywords} is selected. |
4009494e GM |
7942 | @kindex r |
7943 | The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
7944 | a prefix argument to this command to change the selected TODO keyword, | |
7945 | for example @kbd{3 r}. If you often need a search for a specific | |
7946 | keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
7947 | Matching specific TODO keywords can also be done as part of a tags | |
7948 | search (@pxref{Tag searches}). | |
7949 | @end table | |
7950 | ||
7951 | Remote editing of TODO items means that you can change the state of a | |
7952 | TODO entry with a single key press. The commands available in the | |
7953 | TODO list are described in @ref{Agenda commands}. | |
7954 | ||
a7808fba CD |
7955 | @cindex sublevels, inclusion into TODO list |
7956 | Normally the global TODO list simply shows all headlines with TODO | |
4009494e GM |
7957 | keywords. This list can become very long. There are two ways to keep |
7958 | it more compact: | |
7959 | @itemize @minus | |
7960 | @item | |
c8d0cf5c CD |
7961 | @vindex org-agenda-todo-ignore-scheduled |
7962 | @vindex org-agenda-todo-ignore-deadlines | |
acedf35c | 7963 | @vindex org-agenda-todo-ignore-timestamp |
c8d0cf5c CD |
7964 | @vindex org-agenda-todo-ignore-with-date |
7965 | Some people view a TODO item that has been @emph{scheduled} for execution or | |
7966 | have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}. | |
7967 | Configure the variables @code{org-agenda-todo-ignore-scheduled}, | |
acedf35c CD |
7968 | @code{org-agenda-todo-ignore-deadlines}, |
7969 | @code{org-agenda-todo-ignore-timestamp} and/or | |
7970 | @code{org-agenda-todo-ignore-with-date} to exclude such items from the global | |
7971 | TODO list. | |
c8d0cf5c CD |
7972 | @item |
7973 | @vindex org-agenda-todo-list-sublevels | |
4009494e GM |
7974 | TODO items may have sublevels to break up the task into subtasks. In |
7975 | such cases it may be enough to list only the highest level TODO headline | |
7976 | and omit the sublevels from the global list. Configure the variable | |
7977 | @code{org-agenda-todo-list-sublevels} to get this behavior. | |
7978 | @end itemize | |
7979 | ||
7980 | @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views | |
a7808fba | 7981 | @subsection Matching tags and properties |
4009494e GM |
7982 | @cindex matching, of tags |
7983 | @cindex matching, of properties | |
7984 | @cindex tags view | |
864c9740 | 7985 | @cindex match view |
4009494e | 7986 | |
c8d0cf5c CD |
7987 | If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}), |
7988 | or have properties (@pxref{Properties and Columns}), you can select headlines | |
7989 | based on this metadata and collect them into an agenda buffer. The match | |
7990 | syntax described here also applies when creating sparse trees with @kbd{C-c / | |
7991 | m}. | |
4009494e GM |
7992 | |
7993 | @table @kbd | |
acedf35c | 7994 | @orgcmd{C-c a m,org-tags-view} |
4009494e GM |
7995 | Produce a list of all headlines that match a given set of tags. The |
7996 | command prompts for a selection criterion, which is a boolean logic | |
dbc28aaa CD |
7997 | expression with tags, like @samp{+work+urgent-withboss} or |
7998 | @samp{work|home} (@pxref{Tags}). If you often need a specific search, | |
4009494e | 7999 | define a custom command for it (@pxref{Agenda dispatcher}). |
acedf35c | 8000 | @orgcmd{C-c a M,org-tags-view} |
c8d0cf5c CD |
8001 | @vindex org-tags-match-list-sublevels |
8002 | @vindex org-agenda-tags-todo-honor-ignore-options | |
86fbb8ca CD |
8003 | Like @kbd{C-c a m}, but only select headlines that are also TODO items in a |
8004 | not-DONE state and force checking subitems (see variable | |
8005 | @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items, | |
8006 | see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching | |
8007 | specific TODO keywords together with a tags match is also possible, see | |
8008 | @ref{Tag searches}. | |
4009494e GM |
8009 | @end table |
8010 | ||
8011 | The commands available in the tags list are described in @ref{Agenda | |
8012 | commands}. | |
8013 | ||
c8d0cf5c | 8014 | @subsubheading Match syntax |
4009494e | 8015 | |
c8d0cf5c | 8016 | @cindex Boolean logic, for tag/property searches |
271672fa BG |
8017 | A search string can use Boolean operators @samp{&} for @code{AND} and |
8018 | @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}. | |
8019 | Parentheses are not implemented. Each element in the search is either a | |
8020 | tag, a regular expression matching tags, or an expression like | |
8021 | @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a | |
8022 | property value. Each element may be preceded by @samp{-}, to select | |
8023 | against it, and @samp{+} is syntactic sugar for positive selection. The | |
8024 | @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is | |
8025 | present. Here are some examples, using only tags. | |
4009494e | 8026 | |
c8d0cf5c | 8027 | @table @samp |
271672fa BG |
8028 | @item work |
8029 | Select headlines tagged @samp{:work:}. | |
8030 | @item work&boss | |
8031 | Select headlines tagged @samp{:work:} and @samp{:boss:}. | |
c8d0cf5c CD |
8032 | @item +work-boss |
8033 | Select headlines tagged @samp{:work:}, but discard those also tagged | |
8034 | @samp{:boss:}. | |
8035 | @item work|laptop | |
8036 | Selects lines tagged @samp{:work:} or @samp{:laptop:}. | |
8037 | @item work|laptop+night | |
8038 | Like before, but require the @samp{:laptop:} lines to be tagged also | |
8039 | @samp{:night:}. | |
4009494e GM |
8040 | @end table |
8041 | ||
c8d0cf5c CD |
8042 | @cindex regular expressions, with tags search |
8043 | Instead of a tag, you may also specify a regular expression enclosed in curly | |
8044 | braces. For example, | |
8045 | @samp{work+@{^boss.*@}} matches headlines that contain the tag | |
8046 | @samp{:work:} and any tag @i{starting} with @samp{boss}. | |
8047 | ||
271672fa BG |
8048 | @cindex group tags, as regular expressions |
8049 | Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g., | |
8050 | if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then | |
8051 | searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}} | |
8052 | and searching for @samp{-work} will search for all headlines but those with | |
8053 | one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}). | |
8054 | ||
c8d0cf5c CD |
8055 | @cindex TODO keyword matching, with tags search |
8056 | @cindex level, require for tags/property match | |
8057 | @cindex category, require for tags/property match | |
8058 | @vindex org-odd-levels-only | |
8059 | You may also test for properties (@pxref{Properties and Columns}) at the same | |
8060 | time as matching tags. The properties may be real properties, or special | |
8061 | properties that represent other metadata (@pxref{Special properties}). For | |
8062 | example, the ``property'' @code{TODO} represents the TODO keyword of the | |
d1389828 | 8063 | entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of |
271672fa | 8064 | the entry. The ITEM special property cannot currently be used in tags/property |
8223b1d2 BG |
8065 | searches@footnote{But @pxref{x-agenda-skip-entry-regexp, |
8066 | ,skipping entries based on regexp}.}. | |
c8d0cf5c | 8067 | |
271672fa BG |
8068 | Except the @pxref{Special properties}, one other ``property'' can also be |
8069 | used. @code{LEVEL} represents the level of an entry. So a search | |
8070 | @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have | |
8071 | the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@. | |
8072 | In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count | |
8073 | the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. | |
8074 | ||
c8d0cf5c | 8075 | Here are more examples: |
271672fa | 8076 | |
c8d0cf5c CD |
8077 | @table @samp |
8078 | @item work+TODO="WAITING" | |
8079 | Select @samp{:work:}-tagged TODO lines with the specific TODO | |
8080 | keyword @samp{WAITING}. | |
8081 | @item work+TODO="WAITING"|home+TODO="WAITING" | |
8082 | Waiting tasks both at work and at home. | |
8083 | @end table | |
8084 | ||
8085 | When matching properties, a number of different operators can be used to test | |
8086 | the value of a property. Here is a complex example: | |
8087 | ||
8088 | @example | |
8089 | +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \ | |
8090 | +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>" | |
8091 | @end example | |
8092 | ||
8093 | @noindent | |
8094 | The type of comparison will depend on how the comparison value is written: | |
8095 | @itemize @minus | |
8096 | @item | |
8097 | If the comparison value is a plain number, a numerical comparison is done, | |
8098 | and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, | |
8099 | @samp{>=}, and @samp{<>}. | |
8100 | @item | |
8101 | If the comparison value is enclosed in double-quotes, | |
8102 | a string comparison is done, and the same operators are allowed. | |
8103 | @item | |
8104 | If the comparison value is enclosed in double-quotes @emph{and} angular | |
8105 | brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are | |
8106 | assumed to be date/time specifications in the standard Org way, and the | |
8107 | comparison will be done accordingly. Special values that will be recognized | |
8108 | are @code{"<now>"} for now (including time), and @code{"<today>"}, and | |
1df7defd | 8109 | @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time |
c8d0cf5c CD |
8110 | specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units |
8111 | @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, | |
8112 | respectively, can be used. | |
8113 | @item | |
8114 | If the comparison value is enclosed | |
8115 | in curly braces, a regexp match is performed, with @samp{=} meaning that the | |
8116 | regexp matches the property value, and @samp{<>} meaning that it does not | |
8117 | match. | |
8118 | @end itemize | |
8119 | ||
8120 | So the search string in the example finds entries tagged @samp{:work:} but | |
8121 | not @samp{:boss:}, which also have a priority value @samp{A}, a | |
8122 | @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort} | |
8123 | property that is numerically smaller than 2, a @samp{:With:} property that is | |
8124 | matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled | |
8125 | on or after October 11, 2008. | |
8126 | ||
8127 | Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any | |
8128 | other properties will slow down the search. However, once you have paid the | |
8129 | price by accessing one property, testing additional properties is cheap | |
8130 | again. | |
8131 | ||
e66ba1df | 8132 | You can configure Org mode to use property inheritance during a search, but |
c8d0cf5c CD |
8133 | beware that this can slow down searches considerably. See @ref{Property |
8134 | inheritance}, for details. | |
8135 | ||
8136 | For backward compatibility, and also for typing speed, there is also a | |
8137 | different way to test TODO states in a search. For this, terminate the | |
8138 | tags/property part of the search string (which may include several terms | |
8139 | connected with @samp{|}) with a @samp{/} and then specify a Boolean | |
8140 | expression just for TODO keywords. The syntax is then similar to that for | |
86fbb8ca | 8141 | tags, but should be applied with care: for example, a positive selection on |
1df7defd | 8142 | several TODO keywords cannot meaningfully be combined with boolean AND@. |
86fbb8ca CD |
8143 | However, @emph{negative selection} combined with AND can be meaningful. To |
8144 | make sure that only lines are checked that actually have any TODO keyword | |
8145 | (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO | |
8146 | part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will | |
8147 | not match TODO keywords in a DONE state. Examples: | |
c8d0cf5c CD |
8148 | |
8149 | @table @samp | |
8150 | @item work/WAITING | |
8151 | Same as @samp{work+TODO="WAITING"} | |
8152 | @item work/!-WAITING-NEXT | |
8153 | Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} | |
8154 | nor @samp{NEXT} | |
8155 | @item work/!+WAITING|+NEXT | |
8156 | Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or | |
8157 | @samp{NEXT}. | |
8158 | @end table | |
8159 | ||
a351880d | 8160 | @node Timeline, Search view, Matching tags and properties, Built-in agenda views |
c8d0cf5c CD |
8161 | @subsection Timeline for a single file |
8162 | @cindex timeline, single file | |
8163 | @cindex time-sorted view | |
8164 | ||
e66ba1df | 8165 | The timeline summarizes all time-stamped items from a single Org mode |
c8d0cf5c CD |
8166 | file in a @emph{time-sorted view}. The main purpose of this command is |
8167 | to give an overview over events in a project. | |
8168 | ||
8169 | @table @kbd | |
acedf35c | 8170 | @orgcmd{C-c a L,org-timeline} |
c8d0cf5c CD |
8171 | Show a time-sorted view of the Org file, with all time-stamped items. |
8172 | When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
8173 | (scheduled or not) are also listed under the current date. | |
8174 | @end table | |
8175 | ||
8176 | @noindent | |
8177 | The commands available in the timeline buffer are listed in | |
8178 | @ref{Agenda commands}. | |
8179 | ||
a351880d CD |
8180 | @node Search view, Stuck projects, Timeline, Built-in agenda views |
8181 | @subsection Search view | |
8182 | @cindex search view | |
8183 | @cindex text search | |
8184 | @cindex searching, for text | |
c8d0cf5c | 8185 | |
e66ba1df | 8186 | This agenda view is a general text search facility for Org mode entries. |
c8d0cf5c | 8187 | It is particularly useful to find notes. |
28a16a1b CD |
8188 | |
8189 | @table @kbd | |
acedf35c | 8190 | @orgcmd{C-c a s,org-search-view} |
a351880d CD |
8191 | This is a special search that lets you select entries by matching a substring |
8192 | or specific words using a boolean logic. | |
8193 | @end table | |
8194 | For example, the search string @samp{computer equipment} will find entries | |
8195 | that contain @samp{computer equipment} as a substring. If the two words are | |
8196 | separated by more space or a line break, the search will still match. | |
8197 | Search view can also search for specific keywords in the entry, using Boolean | |
8198 | logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}} | |
28a16a1b CD |
8199 | will search for note entries that contain the keywords @code{computer} |
8200 | and @code{wifi}, but not the keyword @code{ethernet}, and which are also | |
8201 | not matched by the regular expression @code{8\.11[bg]}, meaning to | |
ed21c5c8 CD |
8202 | exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on |
8203 | word search, other @samp{+} characters are optional. For more details, see | |
8204 | the docstring of the command @code{org-search-view}. | |
28a16a1b | 8205 | |
c8d0cf5c | 8206 | @vindex org-agenda-text-search-extra-files |
28a16a1b CD |
8207 | Note that in addition to the agenda files, this command will also search |
8208 | the files listed in @code{org-agenda-text-search-extra-files}. | |
28a16a1b | 8209 | |
a351880d | 8210 | @node Stuck projects, , Search view, Built-in agenda views |
4009494e | 8211 | @subsection Stuck projects |
ce57c2fe | 8212 | @pindex GTD, Getting Things Done |
4009494e GM |
8213 | |
8214 | If you are following a system like David Allen's GTD to organize your | |
8215 | work, one of the ``duties'' you have is a regular review to make sure | |
8216 | that all projects move along. A @emph{stuck} project is a project that | |
8217 | has no defined next actions, so it will never show up in the TODO lists | |
e66ba1df | 8218 | Org mode produces. During the review, you need to identify such |
4009494e GM |
8219 | projects and define next actions for them. |
8220 | ||
8221 | @table @kbd | |
acedf35c | 8222 | @orgcmd{C-c a #,org-agenda-list-stuck-projects} |
4009494e GM |
8223 | List projects that are stuck. |
8224 | @kindex C-c a ! | |
8225 | @item C-c a ! | |
c8d0cf5c | 8226 | @vindex org-stuck-projects |
4009494e GM |
8227 | Customize the variable @code{org-stuck-projects} to define what a stuck |
8228 | project is and how to find it. | |
8229 | @end table | |
8230 | ||
8231 | You almost certainly will have to configure this view before it will | |
8232 | work for you. The built-in default assumes that all your projects are | |
8233 | level-2 headlines, and that a project is not stuck if it has at least | |
a7808fba | 8234 | one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. |
4009494e | 8235 | |
e66ba1df | 8236 | Let's assume that you, in your own way of using Org mode, identify |
a7808fba | 8237 | projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
864c9740 | 8238 | indicate a project that should not be considered yet. Let's further |
a7808fba | 8239 | assume that the TODO keyword DONE marks finished projects, and that NEXT |
4009494e GM |
8240 | and TODO indicate next actions. The tag @@SHOP indicates shopping and |
8241 | is a next action even without the NEXT tag. Finally, if the project | |
8242 | contains the special word IGNORE anywhere, it should not be listed | |
8243 | either. In this case you would start by identifying eligible projects | |
c8d0cf5c CD |
8244 | with a tags/todo match@footnote{@xref{Tag searches}.} |
8245 | @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and | |
8246 | IGNORE in the subtree to identify projects that are not stuck. The | |
8247 | correct customization for this is | |
4009494e GM |
8248 | |
8249 | @lisp | |
8250 | (setq org-stuck-projects | |
8251 | '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
8252 | "\\<IGNORE\\>")) | |
8253 | @end lisp | |
8254 | ||
c8d0cf5c CD |
8255 | Note that if a project is identified as non-stuck, the subtree of this entry |
8256 | will still be searched for stuck projects. | |
4009494e | 8257 | |
a7808fba | 8258 | @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
4009494e GM |
8259 | @section Presentation and sorting |
8260 | @cindex presentation, of agenda items | |
8261 | ||
c8d0cf5c | 8262 | @vindex org-agenda-prefix-format |
ce57c2fe | 8263 | @vindex org-agenda-tags-column |
e66ba1df | 8264 | Before displaying items in an agenda view, Org mode visually prepares the |
ce57c2fe BG |
8265 | items and sorts them. Each item occupies a single line. The line starts |
8266 | with a @emph{prefix} that contains the @emph{category} (@pxref{Categories}) | |
8267 | of the item and other important information. You can customize in which | |
8268 | column tags will be displayed through @code{org-agenda-tags-column}. You can | |
8269 | also customize the prefix using the option @code{org-agenda-prefix-format}. | |
8270 | This prefix is followed by a cleaned-up version of the outline headline | |
4009494e GM |
8271 | associated with the item. |
8272 | ||
8273 | @menu | |
c0468714 GM |
8274 | * Categories:: Not all tasks are equal |
8275 | * Time-of-day specifications:: How the agenda knows the time | |
271672fa BG |
8276 | * Sorting agenda items:: The order of things |
8277 | * Filtering/limiting agenda items:: Dynamically narrow the agenda | |
4009494e GM |
8278 | @end menu |
8279 | ||
8280 | @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
8281 | @subsection Categories | |
8282 | ||
8283 | @cindex category | |
afe98dfa | 8284 | @cindex #+CATEGORY |
4009494e GM |
8285 | The category is a broad label assigned to each agenda item. By default, |
8286 | the category is simply derived from the file name, but you can also | |
dbc28aaa | 8287 | specify it with a special line in the buffer, like this@footnote{For |
c8d0cf5c | 8288 | backward compatibility, the following also works: if there are several |
dbc28aaa CD |
8289 | such lines in a file, each specifies the category for the text below it. |
8290 | The first category also applies to any text before the first CATEGORY | |
8291 | line. However, using this method is @emph{strongly} deprecated as it is | |
8292 | incompatible with the outline structure of the document. The correct | |
8293 | method for setting multiple categories in a buffer is using a | |
8294 | property.}: | |
4009494e GM |
8295 | |
8296 | @example | |
8297 | #+CATEGORY: Thesis | |
8298 | @end example | |
8299 | ||
dbc28aaa | 8300 | @noindent |
c8d0cf5c | 8301 | @cindex property, CATEGORY |
dbc28aaa | 8302 | If you would like to have a special CATEGORY for a single entry or a |
55e0839d CD |
8303 | (sub)tree, give the entry a @code{:CATEGORY:} property with the |
8304 | special category you want to apply as the value. | |
dbc28aaa CD |
8305 | |
8306 | @noindent | |
8307 | The display in the agenda buffer looks best if the category is not | |
8308 | longer than 10 characters. | |
4009494e | 8309 | |
acedf35c CD |
8310 | @noindent |
8311 | You can set up icons for category by customizing the | |
8312 | @code{org-agenda-category-icon-alist} variable. | |
8313 | ||
271672fa | 8314 | @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting |
a7808fba | 8315 | @subsection Time-of-day specifications |
4009494e GM |
8316 | @cindex time-of-day specification |
8317 | ||
e66ba1df | 8318 | Org mode checks each agenda item for a time-of-day specification. The |
c8d0cf5c | 8319 | time can be part of the timestamp that triggered inclusion into the |
4009494e | 8320 | agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time |
c8d0cf5c | 8321 | ranges can be specified with two timestamps, like |
4009494e GM |
8322 | @c |
8323 | @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
8324 | ||
8325 | In the headline of the entry itself, a time(range) may also appear as | |
44ce9197 | 8326 | plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda |
a7808fba | 8327 | integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
4009494e GM |
8328 | specifications in diary entries are recognized as well. |
8329 | ||
e66ba1df | 8330 | For agenda display, Org mode extracts the time and displays it in a |
4009494e GM |
8331 | standard 24 hour format as part of the prefix. The example times in |
8332 | the previous paragraphs would end up in the agenda like this: | |
8333 | ||
8334 | @example | |
8335 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
8336 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
8337 | 19:00...... The Vogon reads his poem | |
a50253cc | 8338 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
8339 | @end example |
8340 | ||
8341 | @cindex time grid | |
8342 | If the agenda is in single-day mode, or for the display of today, the | |
8343 | timed entries are embedded in a time grid, like | |
8344 | ||
8345 | @example | |
8346 | 8:00...... ------------------ | |
8347 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
8348 | 10:00...... ------------------ | |
8349 | 12:00...... ------------------ | |
8350 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
8351 | 14:00...... ------------------ | |
8352 | 16:00...... ------------------ | |
8353 | 18:00...... ------------------ | |
8354 | 19:00...... The Vogon reads his poem | |
8355 | 20:00...... ------------------ | |
2096a1b6 | 8356 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
8357 | @end example |
8358 | ||
c8d0cf5c CD |
8359 | @vindex org-agenda-use-time-grid |
8360 | @vindex org-agenda-time-grid | |
4009494e GM |
8361 | The time grid can be turned on and off with the variable |
8362 | @code{org-agenda-use-time-grid}, and can be configured with | |
8363 | @code{org-agenda-time-grid}. | |
8364 | ||
271672fa BG |
8365 | @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting |
8366 | @subsection Sorting agenda items | |
4009494e GM |
8367 | @cindex sorting, of agenda items |
8368 | @cindex priorities, of agenda items | |
8369 | Before being inserted into a view, the items are sorted. How this is | |
8370 | done depends on the type of view. | |
8371 | @itemize @bullet | |
8372 | @item | |
c8d0cf5c | 8373 | @vindex org-agenda-files |
4009494e GM |
8374 | For the daily/weekly agenda, the items for each day are sorted. The |
8375 | default order is to first collect all items containing an explicit | |
8376 | time-of-day specification. These entries will be shown at the beginning | |
8377 | of the list, as a @emph{schedule} for the day. After that, items remain | |
8378 | grouped in categories, in the sequence given by @code{org-agenda-files}. | |
8379 | Within each category, items are sorted by priority (@pxref{Priorities}), | |
8380 | which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
8381 | for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
8382 | overdue scheduled or deadline items. | |
28a16a1b | 8383 | @item |
4009494e GM |
8384 | For the TODO list, items remain in the order of categories, but within |
8385 | each category, sorting takes place according to priority | |
c8d0cf5c CD |
8386 | (@pxref{Priorities}). The priority used for sorting derives from the |
8387 | priority cookie, with additions depending on how close an item is to its due | |
8388 | or scheduled date. | |
4009494e GM |
8389 | @item |
8390 | For tags matches, items are not sorted at all, but just appear in the | |
8391 | sequence in which they are found in the agenda files. | |
8392 | @end itemize | |
8393 | ||
c8d0cf5c | 8394 | @vindex org-agenda-sorting-strategy |
4009494e | 8395 | Sorting can be customized using the variable |
a7808fba | 8396 | @code{org-agenda-sorting-strategy}, and may also include criteria based on |
71d35b24 | 8397 | the estimated effort of an entry (@pxref{Effort estimates}). |
4009494e | 8398 | |
271672fa BG |
8399 | @node Filtering/limiting agenda items, , Sorting agenda items, Presentation and sorting |
8400 | @subsection Filtering/limiting agenda items | |
4009494e | 8401 | |
271672fa BG |
8402 | Agenda built-in or customized commands are statically defined. Agenda |
8403 | filters and limits provide two ways of dynamically narrowing down the list of | |
8404 | agenda entries: @emph{fitlers} and @emph{limits}. Filters only act on the | |
8405 | display of the items, while limits take effect before the list of agenda | |
8406 | entries is built. Filter are more often used interactively, while limits are | |
8407 | mostly useful when defined as local variables within custom agenda commands. | |
4009494e | 8408 | |
271672fa BG |
8409 | @subsubheading Filtering in the agenda |
8410 | @cindex filtering, by tag, category, top headline and effort, in agenda | |
8411 | @cindex tag filtering, in agenda | |
8412 | @cindex category filtering, in agenda | |
8413 | @cindex top headline filtering, in agenda | |
8414 | @cindex effort filtering, in agenda | |
8415 | @cindex query editing, in agenda | |
4009494e GM |
8416 | |
8417 | @table @kbd | |
271672fa BG |
8418 | @orgcmd{/,org-agenda-filter-by-tag} |
8419 | @vindex org-agenda-tag-filter-preset | |
8420 | Filter the agenda view with respect to a tag and/or effort estimates. The | |
8421 | difference between this and a custom agenda command is that filtering is very | |
8422 | fast, so that you can switch quickly between different filters without having | |
8423 | to recreate the agenda.@footnote{Custom commands can preset a filter by | |
8424 | binding the variable @code{org-agenda-tag-filter-preset} as an option. This | |
8425 | filter will then be applied to the view and persist as a basic filter through | |
8426 | refreshes and more secondary filtering. The filter is a global property of | |
8427 | the entire agenda view---in a block agenda, you should only set this in the | |
8428 | global options section, not in the section of an individual block.} | |
6eb02347 | 8429 | |
271672fa BG |
8430 | You will be prompted for a tag selection letter; @key{SPC} will mean any tag at |
8431 | all. Pressing @key{TAB} at that prompt will offer use completion to select a | |
8432 | tag (including any tags that do not have a selection character). The command | |
8433 | then hides all entries that do not contain or inherit this tag. When called | |
8434 | with prefix arg, remove the entries that @emph{do} have the tag. A second | |
8435 | @kbd{/} at the prompt will turn off the filter and unhide any hidden entries. | |
8436 | If the first key you press is either @kbd{+} or @kbd{-}, the previous filter | |
8437 | will be narrowed by requiring or forbidding the selected additional tag. | |
8438 | Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also | |
8439 | immediately use the @kbd{\} command. | |
4009494e | 8440 | |
271672fa BG |
8441 | @vindex org-sort-agenda-noeffort-is-high |
8442 | In order to filter for effort estimates, you should set up allowed | |
8443 | efforts globally, for example | |
8444 | @lisp | |
8445 | (setq org-global-properties | |
8446 | '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) | |
8447 | @end lisp | |
8448 | You can then filter for an effort by first typing an operator, one of | |
8449 | @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort | |
8450 | estimate in your array of allowed values, where @kbd{0} means the 10th value. | |
8451 | The filter will then restrict to entries with effort smaller-or-equal, equal, | |
8452 | or larger-or-equal than the selected value. If the digits 0--9 are not used | |
8453 | as fast access keys to tags, you can also simply press the index digit | |
8454 | directly without an operator. In this case, @kbd{<} will be assumed. For | |
8455 | application of the operator, entries without a defined effort will be treated | |
8456 | according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter | |
8457 | for tasks without effort definition, press @kbd{?} as the operator. | |
8458 | ||
8459 | Org also supports automatic, context-aware tag filtering. If the variable | |
8460 | @code{org-agenda-auto-exclude-function} is set to a user-defined function, | |
8461 | that function can decide which tags should be excluded from the agenda | |
8462 | automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET} | |
8463 | as a sub-option key and runs the auto exclusion logic. For example, let's | |
8464 | say you use a @code{Net} tag to identify tasks which need network access, an | |
8465 | @code{Errand} tag for errands in town, and a @code{Call} tag for making phone | |
8466 | calls. You could auto-exclude these tags based on the availability of the | |
8467 | Internet, and outside of business hours, with something like this: | |
8468 | ||
8469 | @smalllisp | |
8470 | @group | |
8471 | (defun org-my-auto-exclude-function (tag) | |
8472 | (and (cond | |
8473 | ((string= tag "Net") | |
8474 | (/= 0 (call-process "/sbin/ping" nil nil nil | |
8475 | "-c1" "-q" "-t1" "mail.gnu.org"))) | |
8476 | ((or (string= tag "Errand") (string= tag "Call")) | |
8477 | (let ((hour (nth 2 (decode-time)))) | |
8478 | (or (< hour 8) (> hour 21))))) | |
8479 | (concat "-" tag))) | |
8480 | ||
8481 | (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function) | |
8482 | @end group | |
8483 | @end smalllisp | |
8484 | ||
8485 | @orgcmd{\\,org-agenda-filter-by-tag-refine} | |
8486 | Narrow the current agenda filter by an additional condition. When called with | |
8487 | prefix arg, remove the entries that @emph{do} have the tag, or that do match | |
8488 | the effort criterion. You can achieve the same effect by pressing @kbd{+} or | |
8489 | @kbd{-} as the first key after the @kbd{/} command. | |
8490 | ||
8491 | @c | |
8492 | @kindex [ | |
8493 | @kindex ] | |
8494 | @kindex @{ | |
8495 | @kindex @} | |
8496 | @item [ ] @{ @} | |
8497 | @table @i | |
8498 | @item @r{in} search view | |
8499 | add new search words (@kbd{[} and @kbd{]}) or new regular expressions | |
8500 | (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will | |
8501 | add a positive search term prefixed by @samp{+}, indicating that this search | |
8502 | term @i{must} occur/match in the entry. The closing bracket/brace will add a | |
8503 | negative search term which @i{must not} occur/match in the entry for it to be | |
8504 | selected. | |
8505 | @end table | |
8506 | ||
8507 | @orgcmd{<,org-agenda-filter-by-category} | |
8508 | @vindex org-agenda-category-filter-preset | |
8509 | ||
8510 | Filter the current agenda view with respect to the category of the item at | |
8511 | point. Pressing @code{<} another time will remove this filter. You can add | |
8512 | a filter preset through the option @code{org-agenda-category-filter-preset} | |
8513 | (see below.) | |
8514 | ||
8515 | @orgcmd{^,org-agenda-filter-by-top-headline} | |
8516 | Filter the current agenda view and only display the siblings and the parent | |
8517 | headline of the one at point. | |
8518 | ||
8519 | @orgcmd{=,org-agenda-filter-by-regexp} | |
8520 | @vindex org-agenda-regexp-filter-preset | |
8521 | ||
8522 | Filter the agenda view by a regular expression: only show agenda entries | |
8523 | matching the regular expression the user entered. When called with a prefix | |
8524 | argument, it will filter @emph{out} entries matching the regexp. With two | |
8525 | universal prefix arguments, it will remove all the regexp filters, which can | |
8526 | be accumulated. You can add a filter preset through the option | |
8527 | @code{org-agenda-category-filter-preset} (see below.) | |
8528 | ||
8529 | @orgcmd{|,org-agenda-filter-remove-all} | |
8530 | Remove all filters in the current agenda view. | |
8531 | @end table | |
8532 | ||
8533 | @subsubheading Setting limits for the agenda | |
8534 | @cindex limits, in agenda | |
8535 | @vindex org-agenda-max-entries | |
8536 | @vindex org-agenda-max-effort | |
8537 | @vindex org-agenda-max-todos | |
8538 | @vindex org-agenda-max-tags | |
8539 | ||
8540 | Here is a list of options that you can set, either globally, or locally in | |
8541 | your custom agenda views@pxref{Custom agenda views}. | |
8542 | ||
8543 | @table @var | |
8544 | @item org-agenda-max-entries | |
8545 | Limit the number of entries. | |
8546 | @item org-agenda-max-effort | |
8547 | Limit the duration of accumulated efforts (as minutes). | |
8548 | @item org-agenda-max-todos | |
8549 | Limit the number of entries with TODO keywords. | |
8550 | @item org-agenda-max-tags | |
8551 | Limit the number of tagged entries. | |
8552 | @end table | |
8553 | ||
8554 | When set to a positive integer, each option will exclude entries from other | |
d1389828 | 8555 | categories: for example, @code{(setq org-agenda-max-effort 100)} will limit |
271672fa BG |
8556 | the agenda to 100 minutes of effort and exclude any entry that as no effort |
8557 | property. If you want to include entries with no effort property, use a | |
8558 | negative value for @code{org-agenda-max-effort}. | |
8559 | ||
8560 | One useful setup is to use @code{org-agenda-max-entries} locally in a custom | |
8561 | command. For example, this custom command will display the next five entries | |
8562 | with a @code{NEXT} TODO keyword. | |
8563 | ||
8564 | @smalllisp | |
8565 | (setq org-agenda-custom-commands | |
8566 | '(("n" todo "NEXT" | |
8567 | ((org-agenda-max-entries 5))))) | |
8568 | @end smalllisp | |
8569 | ||
8570 | Once you mark one of these five entry as @code{DONE}, rebuilding the agenda | |
8571 | will again the next five entries again, including the first entry that was | |
8572 | excluded so far. | |
8573 | ||
8574 | You can also dynamically set temporary limits@footnote{Those temporary limits | |
8575 | are lost when rebuilding the agenda.}: | |
8576 | ||
8577 | @table @kbd | |
8578 | @orgcmd{~,org-agenda-limit-interactively} | |
8579 | This prompts for the type of limit to apply and its value. | |
8580 | @end table | |
8581 | ||
8582 | @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views | |
8583 | @section Commands in the agenda buffer | |
8584 | @cindex commands, in agenda buffer | |
8585 | ||
8586 | Entries in the agenda buffer are linked back to the Org file or diary | |
8587 | file where they originate. You are not allowed to edit the agenda | |
8588 | buffer itself, but commands are provided to show and jump to the | |
8589 | original entry location, and to edit the Org files ``remotely'' from | |
8590 | the agenda buffer. In this way, all information is stored only once, | |
8591 | removing the risk that your agenda and note files may diverge. | |
8592 | ||
8593 | Some commands can be executed with mouse clicks on agenda lines. For | |
8594 | the other commands, the cursor needs to be in the desired line. | |
8595 | ||
8596 | @table @kbd | |
8597 | @tsubheading{Motion} | |
8598 | @cindex motion commands in agenda | |
8599 | @orgcmd{n,org-agenda-next-line} | |
8600 | Next line (same as @key{down} and @kbd{C-n}). | |
8601 | @orgcmd{p,org-agenda-previous-line} | |
8602 | Previous line (same as @key{up} and @kbd{C-p}). | |
8603 | @tsubheading{View/Go to Org file} | |
8604 | @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up} | |
8605 | Display the original location of the item in another window. | |
8606 | With prefix arg, make sure that the entire entry is made visible in the | |
8607 | outline, not only the heading. | |
8608 | @c | |
8609 | @orgcmd{L,org-agenda-recenter} | |
8610 | Display original location and recenter that window. | |
8611 | @c | |
8612 | @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto} | |
8613 | Go to the original location of the item in another window. | |
8614 | @c | |
8615 | @orgcmd{@key{RET},org-agenda-switch-to} | |
8616 | Go to the original location of the item and delete other windows. | |
8617 | @c | |
8618 | @orgcmd{F,org-agenda-follow-mode} | |
8619 | @vindex org-agenda-start-with-follow-mode | |
8620 | Toggle Follow mode. In Follow mode, as you move the cursor through | |
8621 | the agenda buffer, the other window always shows the corresponding | |
8622 | location in the Org file. The initial setting for this mode in new | |
8623 | agenda buffers can be set with the variable | |
8624 | @code{org-agenda-start-with-follow-mode}. | |
8625 | @c | |
8626 | @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer} | |
8627 | Display the entire subtree of the current item in an indirect buffer. With a | |
8628 | numeric prefix argument N, go up to level N and then take that tree. If N is | |
8629 | negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the | |
8630 | previously used indirect buffer. | |
8631 | ||
8632 | @orgcmd{C-c C-o,org-agenda-open-link} | |
8633 | Follow a link in the entry. This will offer a selection of any links in the | |
8634 | text belonging to the referenced Org node. If there is only one link, it | |
8635 | will be followed without a selection prompt. | |
8636 | ||
8637 | @tsubheading{Change display} | |
8638 | @cindex display changing, in agenda | |
8639 | @kindex A | |
8640 | @item A | |
8641 | Interactively select another agenda view and append it to the current view. | |
ce57c2fe | 8642 | @c |
4009494e GM |
8643 | @kindex o |
8644 | @item o | |
8645 | Delete other windows. | |
8646 | @c | |
e4920bc9 | 8647 | @orgcmdkskc{v d,d,org-agenda-day-view} |
8c8b834f | 8648 | @xorgcmdkskc{v w,w,org-agenda-week-view} |
271672fa | 8649 | @xorgcmd{v t,org-agenda-fortnight-view} |
acedf35c | 8650 | @xorgcmd{v m,org-agenda-month-view} |
8c8b834f | 8651 | @xorgcmd{v y,org-agenda-year-view} |
ce57c2fe BG |
8652 | @xorgcmd{v SPC,org-agenda-reset-view} |
8653 | @vindex org-agenda-span | |
8654 | Switch to day/week/month/year view. When switching to day or week view, this | |
8655 | setting becomes the default for subsequent agenda refreshes. Since month and | |
8656 | year views are slow to create, they do not become the default. A numeric | |
8657 | prefix argument may be used to jump directly to a specific day of the year, | |
8658 | ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to | |
8659 | February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or | |
8660 | month view, a year may be encoded in the prefix argument as well. For | |
8661 | example, @kbd{200712 w} will jump to week 12 in 2007. If such a year | |
8662 | specification has only one or two digits, it will be mapped to the interval | |
f99f1641 | 8663 | 1938--2037. @kbd{v @key{SPC}} will reset to what is set in |
ce57c2fe | 8664 | @code{org-agenda-span}. |
4009494e | 8665 | @c |
acedf35c CD |
8666 | @orgcmd{f,org-agenda-later} |
8667 | Go forward in time to display the following @code{org-agenda-current-span} days. | |
6eb02347 | 8668 | For example, if the display covers a week, switch to the following week. |
acedf35c | 8669 | With prefix arg, go forward that many times @code{org-agenda-current-span} days. |
6eb02347 | 8670 | @c |
acedf35c | 8671 | @orgcmd{b,org-agenda-earlier} |
6eb02347 CD |
8672 | Go backward in time to display earlier dates. |
8673 | @c | |
acedf35c | 8674 | @orgcmd{.,org-agenda-goto-today} |
6eb02347 CD |
8675 | Go to today. |
8676 | @c | |
acedf35c | 8677 | @orgcmd{j,org-agenda-goto-date} |
6eb02347 CD |
8678 | Prompt for a date and go there. |
8679 | @c | |
acedf35c CD |
8680 | @orgcmd{J,org-agenda-clock-goto} |
8681 | Go to the currently clocked-in task @i{in the agenda buffer}. | |
afe98dfa | 8682 | @c |
acedf35c | 8683 | @orgcmd{D,org-agenda-toggle-diary} |
a7808fba | 8684 | Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
4009494e | 8685 | @c |
acedf35c | 8686 | @orgcmdkskc{v l,l,org-agenda-log-mode} |
ed21c5c8 | 8687 | @kindex v L |
6eb02347 CD |
8688 | @vindex org-log-done |
8689 | @vindex org-agenda-log-mode-items | |
8690 | Toggle Logbook mode. In Logbook mode, entries that were marked DONE while | |
8691 | logging was on (variable @code{org-log-done}) are shown in the agenda, as are | |
8692 | entries that have been clocked on that day. You can configure the entry | |
8693 | types that should be included in log mode using the variable | |
8694 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show | |
8695 | all possible logbook entries, including state changes. When called with two | |
271672fa | 8696 | prefix arguments @kbd{C-u C-u}, show only logging information, nothing else. |
ed21c5c8 | 8697 | @kbd{v L} is equivalent to @kbd{C-u v l}. |
6eb02347 | 8698 | @c |
acedf35c | 8699 | @orgcmdkskc{v [,[,org-agenda-manipulate-query-add} |
6eb02347 CD |
8700 | Include inactive timestamps into the current view. Only for weekly/daily |
8701 | agenda and timeline views. | |
8702 | @c | |
acedf35c CD |
8703 | @orgcmd{v a,org-agenda-archives-mode} |
8704 | @xorgcmd{v A,org-agenda-archives-mode 'files} | |
6eb02347 CD |
8705 | Toggle Archives mode. In Archives mode, trees that are marked |
8706 | @code{ARCHIVED} are also scanned when producing the agenda. When you use the | |
8707 | capital @kbd{A}, even all archive files are included. To exit archives mode, | |
8708 | press @kbd{v a} again. | |
8709 | @c | |
acedf35c | 8710 | @orgcmdkskc{v R,R,org-agenda-clockreport-mode} |
6eb02347 | 8711 | @vindex org-agenda-start-with-clockreport-mode |
e66ba1df | 8712 | @vindex org-clock-report-include-clocking-task |
6eb02347 | 8713 | Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will |
271672fa | 8714 | always show a table with the clocked times for the time span and file scope |
6eb02347 CD |
8715 | covered by the current agenda view. The initial setting for this mode in new |
8716 | agenda buffers can be set with the variable | |
acedf35c | 8717 | @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument |
1df7defd | 8718 | when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show |
acedf35c | 8719 | contributions from entries that are hidden by agenda filtering@footnote{Only |
e66ba1df BG |
8720 | tags filtering will be respected here, effort filtering is ignored.}. See |
8721 | also the variable @code{org-clock-report-include-clocking-task}. | |
6eb02347 | 8722 | @c |
ce57c2fe BG |
8723 | @orgkey{v c} |
8724 | @vindex org-agenda-clock-consistency-checks | |
8725 | Show overlapping clock entries, clocking gaps, and other clocking problems in | |
8726 | the current agenda range. You can then visit clocking lines and fix them | |
8727 | manually. See the variable @code{org-agenda-clock-consistency-checks} for | |
8728 | information on how to customize the definition of what constituted a clocking | |
8729 | problem. To return to normal agenda display, press @kbd{l} to exit Logbook | |
8730 | mode. | |
8731 | @c | |
acedf35c | 8732 | @orgcmdkskc{v E,E,org-agenda-entry-text-mode} |
6eb02347 CD |
8733 | @vindex org-agenda-start-with-entry-text-mode |
8734 | @vindex org-agenda-entry-text-maxlines | |
8735 | Toggle entry text mode. In entry text mode, a number of lines from the Org | |
8736 | outline node referenced by an agenda line will be displayed below the line. | |
8737 | The maximum number of lines is given by the variable | |
8738 | @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric | |
8739 | prefix argument will temporarily modify that number to the prefix value. | |
8740 | @c | |
acedf35c | 8741 | @orgcmd{G,org-agenda-toggle-time-grid} |
c8d0cf5c CD |
8742 | @vindex org-agenda-use-time-grid |
8743 | @vindex org-agenda-time-grid | |
4009494e GM |
8744 | Toggle the time grid on and off. See also the variables |
8745 | @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
8746 | @c | |
ce57c2fe | 8747 | @orgcmd{r,org-agenda-redo} |
560bb6ea | 8748 | Recreate the agenda buffer, for example to reflect the changes after |
3bcfba17 | 8749 | modification of the timestamps of items with @kbd{S-@key{left}} and |
560bb6ea | 8750 | @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix |
4009494e GM |
8751 | argument is interpreted to create a selective list for a specific TODO |
8752 | keyword. | |
ce57c2fe | 8753 | @orgcmd{g,org-agenda-redo} |
28a16a1b | 8754 | Same as @kbd{r}. |
4009494e | 8755 | @c |
acedf35c | 8756 | @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers} |
c8d0cf5c CD |
8757 | Save all Org buffers in the current Emacs session, and also the locations of |
8758 | IDs. | |
4009494e | 8759 | @c |
acedf35c | 8760 | @orgcmd{C-c C-x C-c,org-agenda-columns} |
c8d0cf5c | 8761 | @vindex org-columns-default-format |
a7808fba CD |
8762 | Invoke column view (@pxref{Column view}) in the agenda buffer. The column |
8763 | view format is taken from the entry at point, or (if there is no entry at | |
8764 | point), from the first entry in the agenda view. So whatever the format for | |
8765 | that entry would be in the original buffer (taken from a property, from a | |
8766 | @code{#+COLUMNS} line, or from the default variable | |
8767 | @code{org-columns-default-format}), will be used in the agenda. | |
4009494e | 8768 | |
acedf35c | 8769 | @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock} |
c8d0cf5c CD |
8770 | Remove the restriction lock on the agenda, if it is currently restricted to a |
8771 | file or subtree (@pxref{Agenda files}). | |
8772 | ||
864c9740 | 8773 | @tsubheading{Secondary filtering and query editing} |
28a16a1b | 8774 | |
271672fa BG |
8775 | For a detailed description of these commands, see @pxref{Filtering/limiting |
8776 | agenda items}. | |
e66ba1df | 8777 | |
acedf35c | 8778 | @orgcmd{/,org-agenda-filter-by-tag} |
e66ba1df | 8779 | @vindex org-agenda-tag-filter-preset |
271672fa | 8780 | Filter the agenda view with respect to a tag and/or effort estimates. |
71d35b24 | 8781 | |
271672fa BG |
8782 | @orgcmd{\\,org-agenda-filter-by-tag-refine} |
8783 | Narrow the current agenda filter by an additional condition. | |
71d35b24 | 8784 | |
271672fa BG |
8785 | @orgcmd{<,org-agenda-filter-by-category} |
8786 | @vindex org-agenda-category-filter-preset | |
71d35b24 | 8787 | |
271672fa BG |
8788 | Filter the current agenda view with respect to the category of the item at |
8789 | point. Pressing @code{<} another time will remove this filter. | |
a351880d | 8790 | |
271672fa BG |
8791 | @orgcmd{^,org-agenda-filter-by-top-headline} |
8792 | Filter the current agenda view and only display the siblings and the parent | |
8793 | headline of the one at point. | |
a351880d | 8794 | |
271672fa BG |
8795 | @orgcmd{=,org-agenda-filter-by-regexp} |
8796 | @vindex org-agenda-regexp-filter-preset | |
a351880d | 8797 | |
271672fa BG |
8798 | Filter the agenda view by a regular expression: only show agenda entries |
8799 | matching the regular expression the user entered. When called with a prefix | |
8800 | argument, it will filter @emph{out} entries matching the regexp. With two | |
8801 | universal prefix arguments, it will remove all the regexp filters, which can | |
8802 | be accumulated. You can add a filter preset through the option | |
8803 | @code{org-agenda-category-filter-preset} (see below.) | |
864c9740 | 8804 | |
271672fa BG |
8805 | @orgcmd{|,org-agenda-filter-remove-all} |
8806 | Remove all filters in the current agenda view. | |
28a16a1b | 8807 | |
4009494e GM |
8808 | @tsubheading{Remote editing} |
8809 | @cindex remote editing, from agenda | |
8810 | ||
f99f1641 | 8811 | @item 0--9 |
4009494e GM |
8812 | Digit argument. |
8813 | @c | |
8814 | @cindex undoing remote-editing events | |
8815 | @cindex remote editing, undo | |
acedf35c | 8816 | @orgcmd{C-_,org-agenda-undo} |
4009494e GM |
8817 | Undo a change due to a remote editing command. The change is undone |
8818 | both in the agenda buffer and in the remote buffer. | |
8819 | @c | |
acedf35c | 8820 | @orgcmd{t,org-agenda-todo} |
4009494e GM |
8821 | Change the TODO state of the item, both in the agenda and in the |
8822 | original org file. | |
8823 | @c | |
acedf35c CD |
8824 | @orgcmd{C-S-@key{right},org-agenda-todo-nextset} |
8825 | @orgcmd{C-S-@key{left},org-agenda-todo-previousset} | |
a351880d CD |
8826 | Switch to the next/previous set of TODO keywords. |
8827 | @c | |
acedf35c | 8828 | @orgcmd{C-k,org-agenda-kill} |
c8d0cf5c | 8829 | @vindex org-agenda-confirm-kill |
4009494e | 8830 | Delete the current agenda item along with the entire subtree belonging |
a7808fba | 8831 | to it in the original Org file. If the text to be deleted remotely |
4009494e GM |
8832 | is longer than one line, the kill needs to be confirmed by the user. See |
8833 | variable @code{org-agenda-confirm-kill}. | |
8834 | @c | |
acedf35c | 8835 | @orgcmd{C-c C-w,org-agenda-refile} |
c8d0cf5c CD |
8836 | Refile the entry at point. |
8837 | @c | |
acedf35c | 8838 | @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation} |
a351880d CD |
8839 | @vindex org-archive-default-command |
8840 | Archive the subtree corresponding to the entry at point using the default | |
8841 | archiving command set in @code{org-archive-default-command}. When using the | |
8842 | @code{a} key, confirmation will be required. | |
8843 | @c | |
acedf35c | 8844 | @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag} |
a7808fba CD |
8845 | Toggle the ARCHIVE tag for the current headline. |
8846 | @c | |
acedf35c | 8847 | @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling} |
c8d0cf5c CD |
8848 | Move the subtree corresponding to the current entry to its @emph{archive |
8849 | sibling}. | |
a7808fba | 8850 | @c |
acedf35c | 8851 | @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive} |
a7808fba | 8852 | Archive the subtree corresponding to the current headline. This means the |
b349f79f | 8853 | entry will be moved to the configured archive location, most likely a |
a7808fba | 8854 | different file. |
4009494e | 8855 | @c |
acedf35c | 8856 | @orgcmd{T,org-agenda-show-tags} |
c8d0cf5c | 8857 | @vindex org-agenda-show-inherited-tags |
96c8522a CD |
8858 | Show all tags associated with the current item. This is useful if you have |
8859 | turned off @code{org-agenda-show-inherited-tags}, but still want to see all | |
8860 | tags of a headline occasionally. | |
4009494e | 8861 | @c |
acedf35c | 8862 | @orgcmd{:,org-agenda-set-tags} |
dbc28aaa CD |
8863 | Set tags for the current headline. If there is an active region in the |
8864 | agenda, change a tag for all headings in the region. | |
4009494e | 8865 | @c |
4009494e GM |
8866 | @kindex , |
8867 | @item , | |
acedf35c | 8868 | Set the priority for the current item (@command{org-agenda-priority}). |
e66ba1df | 8869 | Org mode prompts for the priority character. If you reply with @key{SPC}, |
ce57c2fe | 8870 | the priority cookie is removed from the entry. |
4009494e | 8871 | @c |
acedf35c | 8872 | @orgcmd{P,org-agenda-show-priority} |
4009494e GM |
8873 | Display weighted priority of current item. |
8874 | @c | |
acedf35c | 8875 | @orgcmdkkc{+,S-@key{up},org-agenda-priority-up} |
4009494e GM |
8876 | Increase the priority of the current item. The priority is changed in |
8877 | the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
8878 | key for this. | |
8879 | @c | |
acedf35c | 8880 | @orgcmdkkc{-,S-@key{down},org-agenda-priority-down} |
4009494e GM |
8881 | Decrease the priority of the current item. |
8882 | @c | |
acedf35c | 8883 | @orgcmdkkc{z,C-c C-z,org-agenda-add-note} |
c8d0cf5c | 8884 | @vindex org-log-into-drawer |
acedf35c | 8885 | Add a note to the entry. This note will be recorded, and then filed to the |
c8d0cf5c | 8886 | same location where state change notes are put. Depending on |
acedf35c | 8887 | @code{org-log-into-drawer}, this may be inside a drawer. |
c8d0cf5c | 8888 | @c |
acedf35c | 8889 | @orgcmd{C-c C-a,org-attach} |
864c9740 CD |
8890 | Dispatcher for all command related to attachments. |
8891 | @c | |
acedf35c CD |
8892 | @orgcmd{C-c C-s,org-agenda-schedule} |
8893 | Schedule this item. With prefix arg remove the scheduling timestamp | |
4009494e | 8894 | @c |
acedf35c CD |
8895 | @orgcmd{C-c C-d,org-agenda-deadline} |
8896 | Set a deadline for this item. With prefix arg remove the deadline. | |
4009494e | 8897 | @c |
acedf35c | 8898 | @orgcmd{S-@key{right},org-agenda-do-date-later} |
c8d0cf5c | 8899 | Change the timestamp associated with the current line by one day into the |
e66ba1df BG |
8900 | future. If the date is in the past, the first call to this command will move |
8901 | it to today.@* | |
8902 | With a numeric prefix argument, change it by that many days. For example, | |
8903 | @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix, | |
8904 | change the time by one hour. If you immediately repeat the command, it will | |
8905 | continue to change hours even without the prefix arg. With a double @kbd{C-u | |
8906 | C-u} prefix, do the same for changing minutes.@* | |
8907 | The stamp is changed in the original Org file, but the change is not directly | |
8908 | reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer. | |
4009494e | 8909 | @c |
acedf35c | 8910 | @orgcmd{S-@key{left},org-agenda-do-date-earlier} |
c8d0cf5c | 8911 | Change the timestamp associated with the current line by one day |
4009494e GM |
8912 | into the past. |
8913 | @c | |
acedf35c | 8914 | @orgcmd{>,org-agenda-date-prompt} |
ed21c5c8 CD |
8915 | Change the timestamp associated with the current line. The key @kbd{>} has |
8916 | been chosen, because it is the same as @kbd{S-.} on my keyboard. | |
4009494e | 8917 | @c |
acedf35c | 8918 | @orgcmd{I,org-agenda-clock-in} |
4009494e GM |
8919 | Start the clock on the current item. If a clock is running already, it |
8920 | is stopped first. | |
8921 | @c | |
acedf35c | 8922 | @orgcmd{O,org-agenda-clock-out} |
4009494e GM |
8923 | Stop the previously started clock. |
8924 | @c | |
acedf35c | 8925 | @orgcmd{X,org-agenda-clock-cancel} |
4009494e | 8926 | Cancel the currently running clock. |
acedf35c CD |
8927 | @c |
8928 | @orgcmd{J,org-agenda-clock-goto} | |
dbc28aaa | 8929 | Jump to the running clock in another window. |
8223b1d2 BG |
8930 | @c |
8931 | @orgcmd{k,org-agenda-capture} | |
8932 | Like @code{org-capture}, but use the date at point as the default date for | |
271672fa | 8933 | the capture template. See @code{org-capture-use-agenda-date} to make this |
8223b1d2 BG |
8934 | the default behavior of @code{org-capture}. |
8935 | @cindex capturing, from agenda | |
8936 | @vindex org-capture-use-agenda-date | |
dbc28aaa | 8937 | |
271672fa BG |
8938 | @tsubheading{Dragging agenda lines forward/backward} |
8939 | @cindex dragging, agenda lines | |
8940 | ||
8941 | @orgcmd{M-<up>,org-agenda-drag-line-backward} | |
8942 | Drag the line at point backward one line@footnote{Moving agenda lines does | |
8943 | not persist after an agenda refresh and does not modify the contributing | |
8944 | @file{.org} files}. With a numeric prefix argument, drag backward by that | |
8945 | many lines. | |
8946 | ||
8947 | @orgcmd{M-<down>,org-agenda-drag-line-forward} | |
8948 | Drag the line at point forward one line. With a numeric prefix argument, | |
8949 | drag forward by that many lines. | |
8950 | ||
c8d0cf5c CD |
8951 | @tsubheading{Bulk remote editing selected entries} |
8952 | @cindex remote editing, bulk, from agenda | |
8223b1d2 | 8953 | @vindex org-agenda-bulk-custom-functions |
c8d0cf5c | 8954 | |
acedf35c | 8955 | @orgcmd{m,org-agenda-bulk-mark} |
271672fa BG |
8956 | Mark the entry at point for bulk action. With numeric prefix argument, mark |
8957 | that many successive entries. | |
acedf35c | 8958 | @c |
271672fa BG |
8959 | @orgcmd{*,org-agenda-bulk-mark-all} |
8960 | Mark all visible agenda entries for bulk action. | |
ce57c2fe | 8961 | @c |
acedf35c | 8962 | @orgcmd{u,org-agenda-bulk-unmark} |
271672fa | 8963 | Unmark entry at point for bulk action. |
acedf35c CD |
8964 | @c |
8965 | @orgcmd{U,org-agenda-bulk-remove-all-marks} | |
c8d0cf5c | 8966 | Unmark all marked entries for bulk action. |
acedf35c | 8967 | @c |
271672fa BG |
8968 | @orgcmd{M-m,org-agenda-bulk-toggle} |
8969 | Toggle mark of the entry at point for bulk action. | |
8970 | @c | |
8971 | @orgcmd{M-*,org-agenda-bulk-toggle-all} | |
8972 | Toggle marks of all visible entries for bulk action. | |
8973 | @c | |
8974 | @orgcmd{%,org-agenda-bulk-mark-regexp} | |
8975 | Mark entries matching a regular expression for bulk action. | |
8976 | @c | |
acedf35c | 8977 | @orgcmd{B,org-agenda-bulk-action} |
c8d0cf5c | 8978 | Bulk action: act on all marked entries in the agenda. This will prompt for |
ed21c5c8 CD |
8979 | another key to select the action to be applied. The prefix arg to @kbd{B} |
8980 | will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove | |
8223b1d2 BG |
8981 | these special timestamps. By default, marks are removed after the bulk. If |
8982 | you want them to persist, set @code{org-agenda-bulk-persistent-marks} to | |
8983 | @code{t} or hit @kbd{p} at the prompt. | |
8984 | ||
271672fa BG |
8985 | @table @kbd |
8986 | @item * | |
8987 | Toggle persistent marks. | |
8988 | @item $ | |
8989 | Archive all selected entries. | |
8990 | @item A | |
8991 | Archive entries by moving them to their respective archive siblings. | |
8992 | @item t | |
8993 | Change TODO state. This prompts for a single TODO keyword and changes the | |
8994 | state of all selected entries, bypassing blocking and suppressing logging | |
8995 | notes (but not timestamps). | |
8996 | @item + | |
8997 | Add a tag to all selected entries. | |
8998 | @item - | |
8999 | Remove a tag from all selected entries. | |
9000 | @item s | |
9001 | Schedule all items to a new date. To shift existing schedule dates by a | |
9002 | fixed number of days, use something starting with double plus at the prompt, | |
9003 | for example @samp{++8d} or @samp{++2w}. | |
9004 | @item d | |
9005 | Set deadline to a specific date. | |
9006 | @item r | |
9007 | Prompt for a single refile target and move all entries. The entries will no | |
9008 | longer be in the agenda; refresh (@kbd{g}) to bring them back. | |
9009 | @item S | |
9010 | Reschedule randomly into the coming N days. N will be prompted for. With | |
9011 | prefix arg (@kbd{C-u B S}), scatter only across weekdays. | |
9012 | @item f | |
9013 | Apply a function@footnote{You can also create persistent custom functions | |
9014 | through @code{org-agenda-bulk-custom-functions}.} to marked entries. For | |
9015 | example, the function below sets the CATEGORY property of the entries to web. | |
c8d0cf5c | 9016 | |
271672fa BG |
9017 | @lisp |
9018 | @group | |
9019 | (defun set-category () | |
9020 | (interactive "P") | |
9021 | (let* ((marker (or (org-get-at-bol 'org-hd-marker) | |
9022 | (org-agenda-error))) | |
9023 | (buffer (marker-buffer marker))) | |
9024 | (with-current-buffer buffer | |
9025 | (save-excursion | |
9026 | (save-restriction | |
9027 | (widen) | |
9028 | (goto-char marker) | |
9029 | (org-back-to-heading t) | |
9030 | (org-set-property "CATEGORY" "web")))))) | |
9031 | @end group | |
9032 | @end lisp | |
9033 | @end table | |
c8d0cf5c | 9034 | |
4009494e GM |
9035 | @tsubheading{Calendar commands} |
9036 | @cindex calendar commands, from agenda | |
acedf35c CD |
9037 | |
9038 | @orgcmd{c,org-agenda-goto-calendar} | |
4009494e GM |
9039 | Open the Emacs calendar and move to the date at the agenda cursor. |
9040 | @c | |
acedf35c | 9041 | @orgcmd{c,org-calendar-goto-agenda} |
e66ba1df | 9042 | When in the calendar, compute and show the Org mode agenda for the |
4009494e GM |
9043 | date at the cursor. |
9044 | @c | |
9045 | @cindex diary entries, creating from agenda | |
acedf35c | 9046 | @orgcmd{i,org-agenda-diary-entry} |
a351880d CD |
9047 | @vindex org-agenda-diary-file |
9048 | Insert a new entry into the diary, using the date at the cursor and (for | |
9049 | block entries) the date at the mark. This will add to the Emacs diary | |
9050 | file@footnote{This file is parsed for the agenda when | |
9051 | @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i} | |
9052 | command in the calendar. The diary file will pop up in another window, where | |
9053 | you can add the entry. | |
9054 | ||
e66ba1df BG |
9055 | If you configure @code{org-agenda-diary-file} to point to an Org mode file, |
9056 | Org will create entries (in Org mode syntax) in that file instead. Most | |
a351880d CD |
9057 | entries will be stored in a date-based outline tree that will later make it |
9058 | easy to archive appointments from previous months/years. The tree will be | |
86fbb8ca | 9059 | built under an entry with a @code{DATE_TREE} property, or else with years as |
acedf35c | 9060 | top-level entries. Emacs will prompt you for the entry text---if you specify |
a351880d CD |
9061 | it, the entry will be created in @code{org-agenda-diary-file} without further |
9062 | interaction. If you directly press @key{RET} at the prompt without typing | |
9063 | text, the target file will be shown in another window for you to finish the | |
9064 | entry there. See also the @kbd{k r} command. | |
4009494e | 9065 | @c |
acedf35c | 9066 | @orgcmd{M,org-agenda-phases-of-moon} |
4009494e GM |
9067 | Show the phases of the moon for the three months around current date. |
9068 | @c | |
acedf35c | 9069 | @orgcmd{S,org-agenda-sunrise-sunset} |
4009494e | 9070 | Show sunrise and sunset times. The geographical location must be set |
c8d0cf5c | 9071 | with calendar variables, see the documentation for the Emacs calendar. |
4009494e | 9072 | @c |
acedf35c | 9073 | @orgcmd{C,org-agenda-convert-date} |
4009494e GM |
9074 | Convert the date at cursor into many other cultural and historic |
9075 | calendars. | |
9076 | @c | |
acedf35c | 9077 | @orgcmd{H,org-agenda-holidays} |
c8d0cf5c | 9078 | Show holidays for three months around the cursor date. |
a7808fba | 9079 | |
271672fa | 9080 | @item M-x org-icalendar-combine-agenda-files RET |
4009494e | 9081 | Export a single iCalendar file containing entries from all agenda files. |
a7808fba | 9082 | This is a globally available command, and also available in the agenda menu. |
4009494e GM |
9083 | |
9084 | @tsubheading{Exporting to a file} | |
8223b1d2 | 9085 | @orgcmd{C-x C-w,org-agenda-write} |
4009494e GM |
9086 | @cindex exporting agenda views |
9087 | @cindex agenda views, exporting | |
c8d0cf5c CD |
9088 | @vindex org-agenda-exporter-settings |
9089 | Write the agenda view to a file. Depending on the extension of the selected | |
271672fa BG |
9090 | file name, the view will be exported as HTML (@file{.html} or @file{.htm}), |
9091 | Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text | |
9092 | (any other extension). When exporting to Org, only the body of original | |
9093 | headlines are exported, not subtrees or inherited tags. When called with a | |
9094 | @kbd{C-u} prefix argument, immediately open the newly created file. Use the | |
9095 | variable @code{org-agenda-exporter-settings} to set options for | |
9096 | @file{ps-print} and for @file{htmlize} to be used during export. | |
4009494e GM |
9097 | |
9098 | @tsubheading{Quit and Exit} | |
acedf35c | 9099 | @orgcmd{q,org-agenda-quit} |
4009494e GM |
9100 | Quit agenda, remove the agenda buffer. |
9101 | @c | |
4009494e | 9102 | @cindex agenda files, removing buffers |
acedf35c | 9103 | @orgcmd{x,org-agenda-exit} |
4009494e GM |
9104 | Exit agenda, remove the agenda buffer and all buffers loaded by Emacs |
9105 | for the compilation of the agenda. Buffers created by the user to | |
c8d0cf5c | 9106 | visit Org files will not be removed. |
4009494e GM |
9107 | @end table |
9108 | ||
9109 | ||
c8d0cf5c | 9110 | @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views |
4009494e GM |
9111 | @section Custom agenda views |
9112 | @cindex custom agenda views | |
9113 | @cindex agenda views, custom | |
9114 | ||
9115 | Custom agenda commands serve two purposes: to store and quickly access | |
9116 | frequently used TODO and tags searches, and to create special composite | |
9117 | agenda buffers. Custom agenda commands will be accessible through the | |
9118 | dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
9119 | ||
9120 | @menu | |
c0468714 GM |
9121 | * Storing searches:: Type once, use often |
9122 | * Block agenda:: All the stuff you need in a single buffer | |
9123 | * Setting Options:: Changing the rules | |
4009494e GM |
9124 | @end menu |
9125 | ||
9126 | @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
9127 | @subsection Storing searches | |
9128 | ||
9129 | The first application of custom searches is the definition of keyboard | |
9130 | shortcuts for frequently used searches, either creating an agenda | |
9131 | buffer, or a sparse tree (the latter covering of course only the current | |
9132 | buffer). | |
9133 | @kindex C-c a C | |
c8d0cf5c | 9134 | @vindex org-agenda-custom-commands |
c7cf0ebc | 9135 | @cindex agenda views, main example |
271672fa BG |
9136 | @cindex agenda, as an agenda views |
9137 | @cindex agenda*, as an agenda views | |
c7cf0ebc BG |
9138 | @cindex tags, as an agenda view |
9139 | @cindex todo, as an agenda view | |
9140 | @cindex tags-todo | |
9141 | @cindex todo-tree | |
9142 | @cindex occur-tree | |
9143 | @cindex tags-tree | |
8223b1d2 | 9144 | |
4009494e GM |
9145 | Custom commands are configured in the variable |
9146 | @code{org-agenda-custom-commands}. You can customize this variable, for | |
8223b1d2 | 9147 | example by pressing @kbd{C-c a C}. You can also directly set it with Emacs |
271672fa BG |
9148 | Lisp in @file{.emacs}. The following example contains all valid agenda |
9149 | views: | |
4009494e GM |
9150 | |
9151 | @lisp | |
9152 | @group | |
9153 | (setq org-agenda-custom-commands | |
271672fa BG |
9154 | '(("x" agenda) |
9155 | ("y" agenda*) | |
9156 | ("w" todo "WAITING") | |
4009494e | 9157 | ("W" todo-tree "WAITING") |
dbc28aaa CD |
9158 | ("u" tags "+boss-urgent") |
9159 | ("v" tags-todo "+boss-urgent") | |
9160 | ("U" tags-tree "+boss-urgent") | |
9161 | ("f" occur-tree "\\<FIXME\\>") | |
9162 | ("h" . "HOME+Name tags searches") ; description for "h" prefix | |
9163 | ("hl" tags "+home+Lisa") | |
9164 | ("hp" tags "+home+Peter") | |
9165 | ("hk" tags "+home+Kim"))) | |
4009494e GM |
9166 | @end group |
9167 | @end lisp | |
9168 | ||
9169 | @noindent | |
dbc28aaa CD |
9170 | The initial string in each entry defines the keys you have to press |
9171 | after the dispatcher command @kbd{C-c a} in order to access the command. | |
9172 | Usually this will be just a single character, but if you have many | |
9173 | similar commands, you can also define two-letter combinations where the | |
9174 | first character is the same in several combinations and serves as a | |
9175 | prefix key@footnote{You can provide a description for a prefix key by | |
9176 | inserting a cons cell with the prefix and the description.}. The second | |
9177 | parameter is the search type, followed by the string or regular | |
9178 | expression to be used for the matching. The example above will | |
9179 | therefore define: | |
4009494e GM |
9180 | |
9181 | @table @kbd | |
271672fa BG |
9182 | @item C-c a x |
9183 | as a global search for agenda entries planned@footnote{@emph{Planned} means | |
9184 | here that these entries have some planning information attached to them, like | |
9185 | a time-stamp, a scheduled or a deadline string. See | |
9186 | @code{org-agenda-entry-types} on how to set what planning information will be | |
9187 | taken into account.} this week/day. | |
9188 | @item C-c a y | |
9189 | as a global search for agenda entries planned this week/day, but only those | |
9190 | with an hour specification like @code{[h]h:mm}---think of them as appointments. | |
4009494e GM |
9191 | @item C-c a w |
9192 | as a global search for TODO entries with @samp{WAITING} as the TODO | |
9193 | keyword | |
9194 | @item C-c a W | |
9195 | as the same search, but only in the current buffer and displaying the | |
9196 | results as a sparse tree | |
9197 | @item C-c a u | |
dbc28aaa CD |
9198 | as a global tags search for headlines marked @samp{:boss:} but not |
9199 | @samp{:urgent:} | |
4009494e GM |
9200 | @item C-c a v |
9201 | as the same search as @kbd{C-c a u}, but limiting the search to | |
9202 | headlines that are also TODO items | |
9203 | @item C-c a U | |
9204 | as the same search as @kbd{C-c a u}, but only in the current buffer and | |
9205 | displaying the result as a sparse tree | |
9206 | @item C-c a f | |
9207 | to create a sparse tree (again: current buffer only) with all entries | |
dbc28aaa CD |
9208 | containing the word @samp{FIXME} |
9209 | @item C-c a h | |
9210 | as a prefix command for a HOME tags search where you have to press an | |
9211 | additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa, | |
9212 | Peter, or Kim) as additional tag to match. | |
4009494e GM |
9213 | @end table |
9214 | ||
c7cf0ebc BG |
9215 | Note that the @code{*-tree} agenda views need to be called from an |
9216 | Org buffer as they operate on the current buffer only. | |
9217 | ||
4009494e GM |
9218 | @node Block agenda, Setting Options, Storing searches, Custom agenda views |
9219 | @subsection Block agenda | |
9220 | @cindex block agenda | |
9221 | @cindex agenda, with block views | |
9222 | ||
9223 | Another possibility is the construction of agenda views that comprise | |
9224 | the results of @emph{several} commands, each of which creates a block in | |
9225 | the agenda buffer. The available commands include @code{agenda} for the | |
9226 | daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} | |
a7808fba | 9227 | for the global TODO list (as constructed with @kbd{C-c a t}), and the |
4009494e GM |
9228 | matching commands discussed above: @code{todo}, @code{tags}, and |
9229 | @code{tags-todo}. Here are two examples: | |
9230 | ||
9231 | @lisp | |
9232 | @group | |
9233 | (setq org-agenda-custom-commands | |
9234 | '(("h" "Agenda and Home-related tasks" | |
28a16a1b | 9235 | ((agenda "") |
dbc28aaa CD |
9236 | (tags-todo "home") |
9237 | (tags "garden"))) | |
4009494e | 9238 | ("o" "Agenda and Office-related tasks" |
28a16a1b | 9239 | ((agenda "") |
dbc28aaa CD |
9240 | (tags-todo "work") |
9241 | (tags "office"))))) | |
4009494e GM |
9242 | @end group |
9243 | @end lisp | |
9244 | ||
9245 | @noindent | |
9246 | This will define @kbd{C-c a h} to create a multi-block view for stuff | |
9247 | you need to attend to at home. The resulting agenda buffer will contain | |
9248 | your agenda for the current week, all TODO items that carry the tag | |
dbc28aaa | 9249 | @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
4009494e GM |
9250 | command @kbd{C-c a o} provides a similar view for office tasks. |
9251 | ||
c8d0cf5c | 9252 | @node Setting Options, , Block agenda, Custom agenda views |
a7808fba | 9253 | @subsection Setting options for custom commands |
4009494e GM |
9254 | @cindex options, for custom agenda views |
9255 | ||
c8d0cf5c | 9256 | @vindex org-agenda-custom-commands |
e66ba1df | 9257 | Org mode contains a number of variables regulating agenda construction |
4009494e GM |
9258 | and display. The global variables define the behavior for all agenda |
9259 | commands, including the custom commands. However, if you want to change | |
9260 | some settings just for a single custom view, you can do so. Setting | |
9261 | options requires inserting a list of variable names and values at the | |
9262 | right spot in @code{org-agenda-custom-commands}. For example: | |
9263 | ||
9264 | @lisp | |
9265 | @group | |
9266 | (setq org-agenda-custom-commands | |
9267 | '(("w" todo "WAITING" | |
9268 | ((org-agenda-sorting-strategy '(priority-down)) | |
9269 | (org-agenda-prefix-format " Mixed: "))) | |
dbc28aaa | 9270 | ("U" tags-tree "+boss-urgent" |
4009494e | 9271 | ((org-show-following-heading nil) |
28a16a1b CD |
9272 | (org-show-hierarchy-above nil))) |
9273 | ("N" search "" | |
9274 | ((org-agenda-files '("~org/notes.org")) | |
9275 | (org-agenda-text-search-extra-files nil))))) | |
4009494e GM |
9276 | @end group |
9277 | @end lisp | |
9278 | ||
9279 | @noindent | |
9280 | Now the @kbd{C-c a w} command will sort the collected entries only by | |
dbc28aaa | 9281 | priority, and the prefix format is modified to just say @samp{ Mixed: } |
4009494e GM |
9282 | instead of giving the category of the entry. The sparse tags tree of |
9283 | @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
9284 | headline hierarchy above the match, nor the headline following the match | |
28a16a1b CD |
9285 | will be shown. The command @kbd{C-c a N} will do a text search limited |
9286 | to only a single file. | |
4009494e | 9287 | |
c8d0cf5c | 9288 | @vindex org-agenda-custom-commands |
4009494e GM |
9289 | For command sets creating a block agenda, |
9290 | @code{org-agenda-custom-commands} has two separate spots for setting | |
9291 | options. You can add options that should be valid for just a single | |
9292 | command in the set, and options that should be valid for all commands in | |
acedf35c | 9293 | the set. The former are just added to the command entry; the latter |
4009494e GM |
9294 | must come after the list of command entries. Going back to the block |
9295 | agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
9296 | for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
9297 | the results for GARDEN tags query in the opposite order, | |
9298 | @code{priority-up}. This would look like this: | |
9299 | ||
9300 | @lisp | |
9301 | @group | |
9302 | (setq org-agenda-custom-commands | |
9303 | '(("h" "Agenda and Home-related tasks" | |
9304 | ((agenda) | |
dbc28aaa CD |
9305 | (tags-todo "home") |
9306 | (tags "garden" | |
4009494e GM |
9307 | ((org-agenda-sorting-strategy '(priority-up))))) |
9308 | ((org-agenda-sorting-strategy '(priority-down)))) | |
9309 | ("o" "Agenda and Office-related tasks" | |
9310 | ((agenda) | |
dbc28aaa CD |
9311 | (tags-todo "work") |
9312 | (tags "office"))))) | |
4009494e GM |
9313 | @end group |
9314 | @end lisp | |
9315 | ||
c8d0cf5c CD |
9316 | As you see, the values and parentheses setting is a little complex. |
9317 | When in doubt, use the customize interface to set this variable---it | |
9318 | fully supports its structure. Just one caveat: when setting options in | |
9319 | this interface, the @emph{values} are just Lisp expressions. So if the | |
9320 | value is a string, you need to add the double-quotes around the value | |
4009494e GM |
9321 | yourself. |
9322 | ||
8223b1d2 BG |
9323 | @vindex org-agenda-custom-commands-contexts |
9324 | To control whether an agenda command should be accessible from a specific | |
271672fa | 9325 | context, you can customize @code{org-agenda-custom-commands-contexts}. Let's |
8223b1d2 BG |
9326 | say for example that you have an agenda commands @code{"o"} displaying a view |
9327 | that you only need when reading emails. Then you would configure this option | |
9328 | like this: | |
9329 | ||
271672fa | 9330 | @lisp |
8223b1d2 BG |
9331 | (setq org-agenda-custom-commands-contexts |
9332 | '(("o" (in-mode . "message-mode")))) | |
271672fa | 9333 | @end lisp |
8223b1d2 BG |
9334 | |
9335 | You can also tell that the command key @code{"o"} should refer to another | |
9336 | command key @code{"r"}. In that case, add this command key like this: | |
9337 | ||
271672fa | 9338 | @lisp |
8223b1d2 BG |
9339 | (setq org-agenda-custom-commands-contexts |
9340 | '(("o" "r" (in-mode . "message-mode")))) | |
271672fa | 9341 | @end lisp |
8223b1d2 BG |
9342 | |
9343 | See the docstring of the variable for more information. | |
4009494e | 9344 | |
c8d0cf5c CD |
9345 | @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views |
9346 | @section Exporting Agenda Views | |
4009494e GM |
9347 | @cindex agenda views, exporting |
9348 | ||
3da3282e | 9349 | If you are away from your computer, it can be very useful to have a printed |
e66ba1df | 9350 | version of some agenda views to carry around. Org mode can export custom |
3da3282e | 9351 | agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's |
e66ba1df | 9352 | @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the |
c8d0cf5c | 9353 | ghostscript @file{ps2pdf} utility must be installed on the system. Selecting |
e66ba1df | 9354 | a PDF file will also create the postscript file.}, and iCalendar files. If |
c8d0cf5c | 9355 | you want to do this only occasionally, use the command |
4009494e GM |
9356 | |
9357 | @table @kbd | |
8223b1d2 | 9358 | @orgcmd{C-x C-w,org-agenda-write} |
4009494e GM |
9359 | @cindex exporting agenda views |
9360 | @cindex agenda views, exporting | |
c8d0cf5c | 9361 | @vindex org-agenda-exporter-settings |
7006d207 CD |
9362 | Write the agenda view to a file. Depending on the extension of the selected |
9363 | file name, the view will be exported as HTML (extension @file{.html} or | |
e66ba1df | 9364 | @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension |
a351880d CD |
9365 | @file{.ics}), or plain text (any other extension). Use the variable |
9366 | @code{org-agenda-exporter-settings} to set options for @file{ps-print} and | |
9367 | for @file{htmlize} to be used during export, for example | |
28a16a1b | 9368 | |
c8d0cf5c CD |
9369 | @vindex org-agenda-add-entry-text-maxlines |
9370 | @vindex htmlize-output-type | |
9371 | @vindex ps-number-of-columns | |
9372 | @vindex ps-landscape-mode | |
4009494e GM |
9373 | @lisp |
9374 | (setq org-agenda-exporter-settings | |
9375 | '((ps-number-of-columns 2) | |
9376 | (ps-landscape-mode t) | |
c8d0cf5c | 9377 | (org-agenda-add-entry-text-maxlines 5) |
4009494e GM |
9378 | (htmlize-output-type 'css))) |
9379 | @end lisp | |
9380 | @end table | |
9381 | ||
9382 | If you need to export certain agenda views frequently, you can associate | |
9383 | any custom agenda command with a list of output file names | |
9384 | @footnote{If you want to store standard views like the weekly agenda | |
9385 | or the global TODO list as well, you need to define custom commands for | |
28a16a1b | 9386 | them in order to be able to specify file names.}. Here is an example |
c8d0cf5c CD |
9387 | that first defines custom commands for the agenda and the global |
9388 | TODO list, together with a number of files to which to export them. | |
28a16a1b | 9389 | Then we define two block agenda commands and specify file names for them |
4009494e GM |
9390 | as well. File names can be relative to the current working directory, |
9391 | or absolute. | |
9392 | ||
9393 | @lisp | |
9394 | @group | |
9395 | (setq org-agenda-custom-commands | |
9396 | '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
9397 | ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
9398 | ("h" "Agenda and Home-related tasks" | |
28a16a1b | 9399 | ((agenda "") |
dbc28aaa CD |
9400 | (tags-todo "home") |
9401 | (tags "garden")) | |
4009494e GM |
9402 | nil |
9403 | ("~/views/home.html")) | |
9404 | ("o" "Agenda and Office-related tasks" | |
9405 | ((agenda) | |
dbc28aaa CD |
9406 | (tags-todo "work") |
9407 | (tags "office")) | |
4009494e | 9408 | nil |
28a16a1b | 9409 | ("~/views/office.ps" "~/calendars/office.ics")))) |
4009494e GM |
9410 | @end group |
9411 | @end lisp | |
9412 | ||
9413 | The extension of the file name determines the type of export. If it is | |
e66ba1df | 9414 | @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
4009494e GM |
9415 | the buffer to HTML and save it to this file name. If the extension is |
9416 | @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce | |
e66ba1df | 9417 | Postscript output. If the extension is @file{.ics}, iCalendar export is |
28a16a1b | 9418 | run export over all files that were used to construct the agenda, and |
c8d0cf5c | 9419 | limit the export to entries listed in the agenda. Any other |
28a16a1b | 9420 | extension produces a plain ASCII file. |
4009494e GM |
9421 | |
9422 | The export files are @emph{not} created when you use one of those | |
28a16a1b CD |
9423 | commands interactively because this might use too much overhead. |
9424 | Instead, there is a special command to produce @emph{all} specified | |
9425 | files in one step: | |
4009494e GM |
9426 | |
9427 | @table @kbd | |
acedf35c | 9428 | @orgcmd{C-c a e,org-store-agenda-views} |
28a16a1b | 9429 | Export all agenda views that have export file names associated with |
4009494e GM |
9430 | them. |
9431 | @end table | |
9432 | ||
9433 | You can use the options section of the custom agenda commands to also | |
9434 | set options for the export commands. For example: | |
9435 | ||
9436 | @lisp | |
9437 | (setq org-agenda-custom-commands | |
9438 | '(("X" agenda "" | |
9439 | ((ps-number-of-columns 2) | |
9440 | (ps-landscape-mode t) | |
9441 | (org-agenda-prefix-format " [ ] ") | |
9442 | (org-agenda-with-colors nil) | |
9443 | (org-agenda-remove-tags t)) | |
9444 | ("theagenda.ps")))) | |
9445 | @end lisp | |
9446 | ||
9447 | @noindent | |
e66ba1df | 9448 | This command sets two options for the Postscript exporter, to make it |
c8d0cf5c | 9449 | print in two columns in landscape format---the resulting page can be cut |
4009494e GM |
9450 | in two and then used in a paper agenda. The remaining settings modify |
9451 | the agenda prefix to omit category and scheduling information, and | |
9452 | instead include a checkbox to check off items. We also remove the tags | |
9453 | to make the lines compact, and we don't want to use colors for the | |
9454 | black-and-white printer. Settings specified in | |
9455 | @code{org-agenda-exporter-settings} will also apply, but the settings | |
9456 | in @code{org-agenda-custom-commands} take precedence. | |
9457 | ||
9458 | @noindent | |
9459 | From the command line you may also use | |
9460 | @example | |
e66ba1df | 9461 | emacs -eval (org-batch-store-agenda-views) -kill |
4009494e GM |
9462 | @end example |
9463 | @noindent | |
c8d0cf5c CD |
9464 | or, if you need to modify some parameters@footnote{Quoting depends on the |
9465 | system you use, please check the FAQ for examples.} | |
4009494e GM |
9466 | @example |
9467 | emacs -eval '(org-batch-store-agenda-views \ | |
e66ba1df | 9468 | org-agenda-span (quote month) \ |
dbc28aaa | 9469 | org-agenda-start-day "2007-11-01" \ |
4009494e GM |
9470 | org-agenda-include-diary nil \ |
9471 | org-agenda-files (quote ("~/org/project.org")))' \ | |
9472 | -kill | |
9473 | @end example | |
9474 | @noindent | |
9475 | which will create the agenda views restricted to the file | |
c8d0cf5c | 9476 | @file{~/org/project.org}, without diary entries and with a 30-day |
28a16a1b | 9477 | extent. |
4009494e | 9478 | |
c8d0cf5c CD |
9479 | You can also extract agenda information in a way that allows further |
9480 | processing by other programs. See @ref{Extracting agenda information}, for | |
9481 | more information. | |
4009494e | 9482 | |
4009494e | 9483 | |
c8d0cf5c | 9484 | @node Agenda column view, , Exporting Agenda Views, Agenda Views |
a7808fba CD |
9485 | @section Using column view in the agenda |
9486 | @cindex column view, in agenda | |
9487 | @cindex agenda, column view | |
9488 | ||
9489 | Column view (@pxref{Column view}) is normally used to view and edit | |
9490 | properties embedded in the hierarchical structure of an Org file. It can be | |
9491 | quite useful to use column view also from the agenda, where entries are | |
9492 | collected by certain criteria. | |
9493 | ||
9494 | @table @kbd | |
acedf35c | 9495 | @orgcmd{C-c C-x C-c,org-agenda-columns} |
a7808fba CD |
9496 | Turn on column view in the agenda. |
9497 | @end table | |
9498 | ||
9499 | To understand how to use this properly, it is important to realize that the | |
9500 | entries in the agenda are no longer in their proper outline environment. | |
9501 | This causes the following issues: | |
9502 | ||
9503 | @enumerate | |
9504 | @item | |
c8d0cf5c CD |
9505 | @vindex org-columns-default-format |
9506 | @vindex org-overriding-columns-format | |
a7808fba CD |
9507 | Org needs to make a decision which @code{COLUMNS} format to use. Since the |
9508 | entries in the agenda are collected from different files, and different files | |
9509 | may have different @code{COLUMNS} formats, this is a non-trivial problem. | |
ce57c2fe | 9510 | Org first checks if the variable @code{org-agenda-overriding-columns-format} is |
c8d0cf5c | 9511 | currently set, and if so, takes the format from there. Otherwise it takes |
a7808fba | 9512 | the format associated with the first item in the agenda, or, if that item |
c8d0cf5c | 9513 | does not have a specific format (defined in a property, or in its file), it |
a7808fba CD |
9514 | uses @code{org-columns-default-format}. |
9515 | @item | |
c8d0cf5c | 9516 | @cindex property, special, CLOCKSUM |
a7808fba CD |
9517 | If any of the columns has a summary type defined (@pxref{Column attributes}), |
9518 | turning on column view in the agenda will visit all relevant agenda files and | |
9519 | make sure that the computations of this property are up to date. This is | |
9520 | also true for the special @code{CLOCKSUM} property. Org will then sum the | |
9521 | values displayed in the agenda. In the daily/weekly agenda, the sums will | |
acedf35c | 9522 | cover a single day; in all other views they cover the entire block. It is |
a7808fba CD |
9523 | vital to realize that the agenda may show the same entry @emph{twice} (for |
9524 | example as scheduled and as a deadline), and it may show two entries from the | |
c8d0cf5c | 9525 | same hierarchy (for example a @emph{parent} and its @emph{child}). In these |
a7808fba CD |
9526 | cases, the summation in the agenda will lead to incorrect results because |
9527 | some values will count double. | |
9528 | @item | |
9529 | When the column view in the agenda shows the @code{CLOCKSUM}, that is always | |
9530 | the entire clocked time for this item. So even in the daily/weekly agenda, | |
9531 | the clocksum listed in column view may originate from times outside the | |
9532 | current view. This has the advantage that you can compare these values with | |
c8d0cf5c | 9533 | a column listing the planned total effort for a task---one of the major |
a7808fba CD |
9534 | applications for column view in the agenda. If you want information about |
9535 | clocked time in the displayed period use clock table mode (press @kbd{R} in | |
9536 | the agenda). | |
8223b1d2 BG |
9537 | |
9538 | @item | |
9539 | @cindex property, special, CLOCKSUM_T | |
9540 | When the column view in the agenda shows the @code{CLOCKSUM_T}, that is | |
9541 | always today's clocked time for this item. So even in the weekly agenda, | |
9542 | the clocksum listed in column view only originates from today. This lets | |
9543 | you compare the time you spent on a task for today, with the time already | |
9544 | spent (via @code{CLOCKSUM}) and with the planned total effort for it. | |
a7808fba CD |
9545 | @end enumerate |
9546 | ||
9547 | ||
a351880d CD |
9548 | @node Markup, Exporting, Agenda Views, Top |
9549 | @chapter Markup for rich export | |
4009494e | 9550 | |
e66ba1df | 9551 | When exporting Org mode documents, the exporter tries to reflect the |
271672fa BG |
9552 | structure of the document as accurately as possible in the back-end. Since |
9553 | export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has | |
9554 | rules on how to prepare text for rich export. This section summarizes the | |
9555 | markup rules used in an Org mode buffer. | |
4009494e | 9556 | |
a351880d | 9557 | @menu |
c0468714 | 9558 | * Structural markup elements:: The basic structure as seen by the exporter |
271672fa | 9559 | * Images and tables:: Images, tables and caption mechanism |
c0468714 GM |
9560 | * Literal examples:: Source code examples with special formatting |
9561 | * Include files:: Include additional files into a document | |
9562 | * Index entries:: Making an index | |
271672fa | 9563 | * Macro replacement:: Use macros to create templates |
e66ba1df | 9564 | * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents |
271672fa | 9565 | * Special blocks:: Containers targeted at export back-ends |
a351880d CD |
9566 | @end menu |
9567 | ||
9568 | @node Structural markup elements, Images and tables, Markup, Markup | |
9569 | @section Structural markup elements | |
4009494e GM |
9570 | |
9571 | @menu | |
c0468714 GM |
9572 | * Document title:: Where the title is taken from |
9573 | * Headings and sections:: The document structure as seen by the exporter | |
9574 | * Table of contents:: The if and where of the table of contents | |
c0468714 GM |
9575 | * Lists:: Lists |
9576 | * Paragraphs:: Paragraphs | |
9577 | * Footnote markup:: Footnotes | |
9578 | * Emphasis and monospace:: Bold, italic, etc. | |
9579 | * Horizontal rules:: Make a line | |
9580 | * Comment lines:: What will *not* be exported | |
4009494e GM |
9581 | @end menu |
9582 | ||
a351880d CD |
9583 | @node Document title, Headings and sections, Structural markup elements, Structural markup elements |
9584 | @subheading Document title | |
9585 | @cindex document title, markup rules | |
4009494e | 9586 | |
a351880d CD |
9587 | @noindent |
9588 | The title of the exported document is taken from the special line | |
4009494e | 9589 | |
a351880d | 9590 | @cindex #+TITLE |
4009494e | 9591 | @example |
a351880d | 9592 | #+TITLE: This is the title of the document |
4009494e | 9593 | @end example |
a351880d | 9594 | |
c8d0cf5c | 9595 | @noindent |
271672fa BG |
9596 | If this line does not exist, the title will be the name of the file |
9597 | associated to buffer, without extension, or the buffer name. | |
4009494e | 9598 | |
a351880d | 9599 | @cindex property, EXPORT_TITLE |
271672fa BG |
9600 | If you are exporting only a subtree, its heading will become the title of the |
9601 | document. If the subtree has a property @code{EXPORT_TITLE}, that will take | |
9602 | precedence. | |
4009494e | 9603 | |
a351880d CD |
9604 | @node Headings and sections, Table of contents, Document title, Structural markup elements |
9605 | @subheading Headings and sections | |
9606 | @cindex headings and sections, markup rules | |
9607 | ||
9608 | @vindex org-export-headline-levels | |
9609 | The outline structure of the document as described in @ref{Document | |
9610 | Structure}, forms the basis for defining sections of the exported document. | |
9611 | However, since the outline structure is also used for (for example) lists of | |
9612 | tasks, only the first three outline levels will be used as headings. Deeper | |
9613 | levels will become itemized lists. You can change the location of this | |
9614 | switch globally by setting the variable @code{org-export-headline-levels}, or on a | |
9615 | per-file basis with a line | |
4009494e | 9616 | |
a351880d | 9617 | @cindex #+OPTIONS |
4009494e | 9618 | @example |
a351880d | 9619 | #+OPTIONS: H:4 |
4009494e GM |
9620 | @end example |
9621 | ||
271672fa | 9622 | @node Table of contents, Lists, Headings and sections, Structural markup elements |
a351880d CD |
9623 | @subheading Table of contents |
9624 | @cindex table of contents, markup rules | |
4009494e | 9625 | |
271672fa | 9626 | @cindex #+TOC |
a351880d CD |
9627 | @vindex org-export-with-toc |
9628 | The table of contents is normally inserted directly before the first headline | |
271672fa BG |
9629 | of the file. The depth of the table is by default the same as the number of |
9630 | headline levels, but you can choose a smaller number, or turn off the table | |
9631 | of contents entirely, by configuring the variable @code{org-export-with-toc}, | |
9632 | or on a per-file basis with a line like | |
b349f79f CD |
9633 | |
9634 | @example | |
9635 | #+OPTIONS: toc:2 (only to two levels in TOC) | |
271672fa | 9636 | #+OPTIONS: toc:nil (no default TOC at all) |
b349f79f CD |
9637 | @end example |
9638 | ||
271672fa | 9639 | If you would like to move the table of contents to a different location, you |
d1389828 | 9640 | should turn off the default table using @code{org-export-with-toc} or |
271672fa BG |
9641 | @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired |
9642 | location(s). | |
b349f79f | 9643 | |
271672fa BG |
9644 | @example |
9645 | #+OPTIONS: toc:nil (no default TOC) | |
9646 | ... | |
9647 | #+TOC: headlines 2 (insert TOC here, with two headline levels) | |
9648 | @end example | |
b349f79f | 9649 | |
271672fa BG |
9650 | Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC} |
9651 | keyword can also generate a list of all tables (resp.@: all listings) with a | |
9652 | caption in the buffer. | |
b349f79f CD |
9653 | |
9654 | @example | |
271672fa BG |
9655 | #+TOC: listings (build a list of listings) |
9656 | #+TOC: tables (build a list of tables) | |
b349f79f CD |
9657 | @end example |
9658 | ||
271672fa BG |
9659 | @cindex property, ALT_TITLE |
9660 | The headline's title usually determines its corresponding entry in a table of | |
9661 | contents. However, it is possible to specify an alternative title by | |
9662 | setting @code{ALT_TITLE} property accordingly. It will then be used when | |
9663 | building the table. | |
9664 | ||
9665 | @node Lists, Paragraphs, Table of contents, Structural markup elements | |
b349f79f CD |
9666 | @subheading Lists |
9667 | @cindex lists, markup rules | |
9668 | ||
271672fa BG |
9669 | Plain lists as described in @ref{Plain lists}, are translated to the back-end's |
9670 | syntax for such lists. Most back-ends support unordered, ordered, and | |
b349f79f CD |
9671 | description lists. |
9672 | ||
a351880d | 9673 | @node Paragraphs, Footnote markup, Lists, Structural markup elements |
b349f79f CD |
9674 | @subheading Paragraphs, line breaks, and quoting |
9675 | @cindex paragraphs, markup rules | |
9676 | ||
9677 | Paragraphs are separated by at least one empty line. If you need to enforce | |
9678 | a line break within a paragraph, use @samp{\\} at the end of a line. | |
9679 | ||
9680 | To keep the line breaks in a region, but otherwise use normal formatting, you | |
9681 | can use this construct, which can also be used to format poetry. | |
9682 | ||
c8d0cf5c | 9683 | @cindex #+BEGIN_VERSE |
b349f79f CD |
9684 | @example |
9685 | #+BEGIN_VERSE | |
864c9740 CD |
9686 | Great clouds overhead |
9687 | Tiny black birds rise and fall | |
9688 | Snow covers Emacs | |
96c8522a | 9689 | |
864c9740 | 9690 | -- AlexSchroeder |
b349f79f CD |
9691 | #+END_VERSE |
9692 | @end example | |
9693 | ||
9694 | When quoting a passage from another document, it is customary to format this | |
9695 | as a paragraph that is indented on both the left and the right margin. You | |
e66ba1df | 9696 | can include quotations in Org mode documents like this: |
b349f79f | 9697 | |
c8d0cf5c | 9698 | @cindex #+BEGIN_QUOTE |
b349f79f CD |
9699 | @example |
9700 | #+BEGIN_QUOTE | |
9701 | Everything should be made as simple as possible, | |
9702 | but not any simpler -- Albert Einstein | |
9703 | #+END_QUOTE | |
9704 | @end example | |
9705 | ||
c8d0cf5c CD |
9706 | If you would like to center some text, do it like this: |
9707 | @cindex #+BEGIN_CENTER | |
9708 | @example | |
9709 | #+BEGIN_CENTER | |
9710 | Everything should be made as simple as possible, \\ | |
9711 | but not any simpler | |
9712 | #+END_CENTER | |
9713 | @end example | |
b349f79f | 9714 | |
a351880d CD |
9715 | |
9716 | @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements | |
9717 | @subheading Footnote markup | |
9718 | @cindex footnotes, markup rules | |
9719 | @cindex @file{footnote.el} | |
9720 | ||
ce57c2fe | 9721 | Footnotes defined in the way described in @ref{Footnotes}, will be exported |
271672fa | 9722 | by all back-ends. Org allows multiple references to the same note, and |
ce57c2fe | 9723 | multiple footnotes side by side. |
a351880d CD |
9724 | |
9725 | @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements | |
9726 | @subheading Emphasis and monospace | |
9727 | ||
9728 | @cindex underlined text, markup rules | |
9729 | @cindex bold text, markup rules | |
9730 | @cindex italic text, markup rules | |
9731 | @cindex verbatim text, markup rules | |
9732 | @cindex code text, markup rules | |
9733 | @cindex strike-through text, markup rules | |
271672fa BG |
9734 | @vindex org-fontify-emphasized-text |
9735 | @vindex org-emphasis-regexp-components | |
9736 | @vindex org-emphasis-alist | |
a351880d CD |
9737 | You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} |
9738 | and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text | |
e66ba1df | 9739 | in the code and verbatim string is not processed for Org mode specific |
271672fa BG |
9740 | syntax, it is exported verbatim. |
9741 | ||
9742 | To turn off fontification for marked up text, you can set | |
9743 | @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of | |
9744 | available markup syntax, you can customize @code{org-emphasis-alist}. To fine | |
9745 | tune what characters are allowed before and after the markup characters, you | |
9746 | can tweak @code{org-emphasis-regexp-components}. Beware that changing one of | |
9747 | the above variables will no take effect until you reload Org, for which you | |
9748 | may need to restart Emacs. | |
a351880d CD |
9749 | |
9750 | @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements | |
9751 | @subheading Horizontal rules | |
9752 | @cindex horizontal rules, markup rules | |
ce57c2fe | 9753 | A line consisting of only dashes, and at least 5 of them, will be exported as |
271672fa | 9754 | a horizontal line. |
a351880d CD |
9755 | |
9756 | @node Comment lines, , Horizontal rules, Structural markup elements | |
9757 | @subheading Comment lines | |
9758 | @cindex comment lines | |
9759 | @cindex exporting, not | |
9760 | @cindex #+BEGIN_COMMENT | |
9761 | ||
63aa0982 BG |
9762 | Lines starting with zero or more whitespace characters followed by one |
9763 | @samp{#} and a whitespace are treated as comments and will never be exported. | |
9764 | Also entire subtrees starting with the word @samp{COMMENT} will never be | |
9765 | exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT} | |
9766 | ... @samp{#+END_COMMENT} will not be exported. | |
a351880d CD |
9767 | |
9768 | @table @kbd | |
9769 | @kindex C-c ; | |
9770 | @item C-c ; | |
9771 | Toggle the COMMENT keyword at the beginning of an entry. | |
9772 | @end table | |
9773 | ||
9774 | ||
9775 | @node Images and tables, Literal examples, Structural markup elements, Markup | |
9776 | @section Images and Tables | |
9777 | ||
9778 | @cindex tables, markup rules | |
9779 | @cindex #+CAPTION | |
271672fa | 9780 | @cindex #+NAME |
e66ba1df BG |
9781 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with |
9782 | the @file{table.el} package will be exported properly. For Org mode tables, | |
a351880d CD |
9783 | the lines before the first horizontal separator line will become table header |
9784 | lines. You can use the following lines somewhere before the table to assign | |
ed21c5c8 | 9785 | a caption and a label for cross references, and in the text you can refer to |
271672fa | 9786 | the object with @code{[[tab:basic-data]]} (@pxref{Internal links}): |
a351880d CD |
9787 | |
9788 | @example | |
9789 | #+CAPTION: This is the caption for the next table (or link) | |
271672fa | 9790 | #+NAME: tab:basic-data |
a351880d CD |
9791 | | ... | ...| |
9792 | |-----|----| | |
9793 | @end example | |
9794 | ||
ce57c2fe BG |
9795 | Optionally, the caption can take the form: |
9796 | @example | |
271672fa | 9797 | #+CAPTION[Caption for list of tables]: Caption for table. |
ce57c2fe BG |
9798 | @end example |
9799 | ||
a351880d | 9800 | @cindex inlined images, markup rules |
271672fa BG |
9801 | Some back-ends allow you to directly include images into the exported |
9802 | document. Org does this, if a link to an image files does not have | |
9803 | a description part, for example @code{[[./img/a.jpg]]}. If you wish to | |
9804 | define a caption for the image and maybe a label for internal cross | |
9805 | references, make sure that the link is on a line by itself and precede it | |
9806 | with @code{#+CAPTION} and @code{#+NAME} as follows: | |
a351880d CD |
9807 | |
9808 | @example | |
9809 | #+CAPTION: This is the caption for the next figure link (or table) | |
271672fa | 9810 | #+NAME: fig:SED-HR4049 |
a351880d CD |
9811 | [[./img/a.jpg]] |
9812 | @end example | |
9813 | ||
271672fa BG |
9814 | @noindent |
9815 | Such images can be displayed within the buffer. @xref{Handling links,the | |
9816 | discussion of image links}. | |
a351880d | 9817 | |
271672fa BG |
9818 | Even though images and tables are prominent examples of captioned structures, |
9819 | the same caption mechanism can apply to many others (e.g., @LaTeX{} | |
9820 | equations, source code blocks). Depending on the export back-end, those may | |
9821 | or may not be handled. | |
a351880d CD |
9822 | |
9823 | @node Literal examples, Include files, Images and tables, Markup | |
9824 | @section Literal examples | |
b349f79f | 9825 | @cindex literal examples, markup rules |
c8d0cf5c | 9826 | @cindex code line references, markup rules |
b349f79f CD |
9827 | |
9828 | You can include literal examples that should not be subjected to | |
9829 | markup. Such examples will be typeset in monospace, so this is well suited | |
9830 | for source code and similar examples. | |
9831 | @cindex #+BEGIN_EXAMPLE | |
9832 | ||
9833 | @example | |
9834 | #+BEGIN_EXAMPLE | |
9835 | Some example from a text file. | |
9836 | #+END_EXAMPLE | |
9837 | @end example | |
9838 | ||
c8d0cf5c CD |
9839 | Note that such blocks may be @i{indented} in order to align nicely with |
9840 | indented text and in particular with plain list structure (@pxref{Plain | |
9841 | lists}). For simplicity when using small examples, you can also start the | |
9842 | example lines with a colon followed by a space. There may also be additional | |
55e0839d | 9843 | whitespace before the colon: |
b349f79f CD |
9844 | |
9845 | @example | |
55e0839d CD |
9846 | Here is an example |
9847 | : Some example from a text file. | |
b349f79f CD |
9848 | @end example |
9849 | ||
9850 | @cindex formatting source code, markup rules | |
9851 | If the example is source code from a programming language, or any other text | |
9852 | that can be marked up by font-lock in Emacs, you can ask for the example to | |
afe98dfa | 9853 | look like the fontified Emacs buffer@footnote{This works automatically for |
271672fa | 9854 | the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package, |
e66ba1df | 9855 | which is distributed with Org). Fontified code chunks in @LaTeX{} can be |
afe98dfa | 9856 | achieved using either the listings or the |
8223b1d2 | 9857 | @url{http://code.google.com/p/minted, minted,} package. Refer to |
271672fa | 9858 | @code{org-latex-listings} documentation for details.}. This is done |
8223b1d2 BG |
9859 | with the @samp{src} block, where you also need to specify the name of the |
9860 | major mode that should be used to fontify the example@footnote{Code in | |
9861 | @samp{src} blocks may also be evaluated either interactively or on export. | |
9862 | See @pxref{Working With Source Code} for more information on evaluating code | |
9863 | blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code | |
9864 | blocks. | |
b349f79f CD |
9865 | @cindex #+BEGIN_SRC |
9866 | ||
9867 | @example | |
9868 | #+BEGIN_SRC emacs-lisp | |
86fbb8ca CD |
9869 | (defun org-xor (a b) |
9870 | "Exclusive or." | |
9871 | (if a (not b) b)) | |
b349f79f CD |
9872 | #+END_SRC |
9873 | @end example | |
9874 | ||
55e0839d CD |
9875 | Both in @code{example} and in @code{src} snippets, you can add a @code{-n} |
9876 | switch to the end of the @code{BEGIN} line, to get the lines of the example | |
9877 | numbered. If you use a @code{+n} switch, the numbering from the previous | |
9878 | numbered snippet will be continued in the current one. In literal examples, | |
9879 | Org will interpret strings like @samp{(ref:name)} as labels, and use them as | |
1df7defd | 9880 | targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name |
c8d0cf5c CD |
9881 | enclosed in single parenthesis). In HTML, hovering the mouse over such a |
9882 | link will remote-highlight the corresponding code line, which is kind of | |
9883 | cool. | |
9884 | ||
9885 | You can also add a @code{-r} switch which @i{removes} the labels from the | |
9886 | source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the | |
9887 | labels in the source code while using line numbers for the links, which might | |
e66ba1df | 9888 | be useful to explain those in an Org mode example code.}. With the @code{-n} |
c8d0cf5c CD |
9889 | switch, links to these references will be labeled by the line numbers from |
9890 | the code listing, otherwise links will use the labels with no parentheses. | |
9891 | Here is an example: | |
55e0839d CD |
9892 | |
9893 | @example | |
9894 | #+BEGIN_SRC emacs-lisp -n -r | |
9895 | (save-excursion (ref:sc) | |
9896 | (goto-char (point-min)) (ref:jump) | |
c8d0cf5c CD |
9897 | #+END_SRC |
9898 | In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] | |
55e0839d CD |
9899 | jumps to point-min. |
9900 | @end example | |
9901 | ||
c8d0cf5c | 9902 | @vindex org-coderef-label-format |
55e0839d CD |
9903 | If the syntax for the label format conflicts with the language syntax, use a |
9904 | @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal | |
9905 | -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}. | |
9906 | ||
ce57c2fe BG |
9907 | HTML export also allows examples to be published as text areas (@pxref{Text |
9908 | areas in HTML export}). | |
9909 | ||
9910 | Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added | |
9911 | so often, shortcuts are provided using the Easy Templates facility | |
9912 | (@pxref{Easy Templates}). | |
55e0839d | 9913 | |
b349f79f CD |
9914 | @table @kbd |
9915 | @kindex C-c ' | |
9916 | @item C-c ' | |
9917 | Edit the source code example at point in its native mode. This works by | |
c8d0cf5c | 9918 | switching to a temporary buffer with the source code. You need to exit by |
bdebdb64 BG |
9919 | pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}, |
9920 | @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them | |
9921 | from being interpreted by Org as outline nodes or special syntax. These | |
9922 | commas will be stripped for editing with @kbd{C-c '}, and also for export.}. | |
9923 | The edited version will then replace the old version in the Org buffer. | |
9924 | Fixed-width regions (where each line starts with a colon followed by a space) | |
9925 | will be edited using @code{artist-mode}@footnote{You may select | |
9926 | a different-mode with the variable @code{org-edit-fixed-width-region-mode}.} | |
9927 | to allow creating ASCII drawings easily. Using this command in an empty line | |
9928 | will create a new fixed-width region. | |
55e0839d CD |
9929 | @kindex C-c l |
9930 | @item C-c l | |
9931 | Calling @code{org-store-link} while editing a source code example in a | |
acedf35c | 9932 | temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure |
55e0839d CD |
9933 | that it is unique in the current buffer, and insert it with the proper |
9934 | formatting like @samp{(ref:label)} at the end of the current line. Then the | |
9935 | label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. | |
b349f79f CD |
9936 | @end table |
9937 | ||
9938 | ||
ed21c5c8 | 9939 | @node Include files, Index entries, Literal examples, Markup |
a351880d | 9940 | @section Include files |
b349f79f CD |
9941 | @cindex include files, markup rules |
9942 | ||
9943 | During export, you can include the content of another file. For example, to | |
c8d0cf5c | 9944 | include your @file{.emacs} file, you could use: |
b349f79f CD |
9945 | @cindex #+INCLUDE |
9946 | ||
9947 | @example | |
9948 | #+INCLUDE: "~/.emacs" src emacs-lisp | |
9949 | @end example | |
271672fa | 9950 | |
c8d0cf5c | 9951 | @noindent |
1df7defd | 9952 | The optional second and third parameter are the markup (e.g., @samp{quote}, |
b349f79f | 9953 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the |
acedf35c | 9954 | language for formatting the contents. The markup is optional; if it is not |
e66ba1df | 9955 | given, the text will be assumed to be in Org mode format and will be |
271672fa BG |
9956 | processed normally. |
9957 | ||
9958 | Contents of the included file will belong to the same structure (headline, | |
9959 | item) containing the @code{INCLUDE} keyword. In particular, headlines within | |
da5ecfa9 | 9960 | the file will become children of the current section. That behavior can be |
271672fa BG |
9961 | changed by providing an additional keyword parameter, @code{:minlevel}. In |
9962 | that case, all headlines in the included file will be shifted so the one with | |
9963 | the lowest level reaches that specified level. For example, to make a file | |
9964 | become a sibling of the current top-level headline, use | |
44ce9197 CD |
9965 | |
9966 | @example | |
271672fa | 9967 | #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1 |
44ce9197 | 9968 | @end example |
b349f79f | 9969 | |
ce57c2fe BG |
9970 | You can also include a portion of a file by specifying a lines range using |
9971 | the @code{:lines} parameter. The line at the upper end of the range will not | |
9972 | be included. The start and/or the end of the range may be omitted to use the | |
9973 | obvious defaults. | |
9974 | ||
9975 | @example | |
9976 | #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded} | |
9977 | #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded} | |
9978 | #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF} | |
9979 | @end example | |
9980 | ||
b349f79f CD |
9981 | @table @kbd |
9982 | @kindex C-c ' | |
9983 | @item C-c ' | |
9984 | Visit the include file at point. | |
9985 | @end table | |
9986 | ||
ed21c5c8 | 9987 | @node Index entries, Macro replacement, Include files, Markup |
86fbb8ca | 9988 | @section Index entries |
ed21c5c8 CD |
9989 | @cindex index entries, for publishing |
9990 | ||
9991 | You can specify entries that will be used for generating an index during | |
9992 | publishing. This is done by lines starting with @code{#+INDEX}. An entry | |
9993 | the contains an exclamation mark will create a sub item. See @ref{Generating | |
9994 | an index} for more information. | |
9995 | ||
9996 | @example | |
86fbb8ca | 9997 | * Curriculum Vitae |
ed21c5c8 CD |
9998 | #+INDEX: CV |
9999 | #+INDEX: Application!CV | |
10000 | @end example | |
10001 | ||
10002 | ||
b349f79f | 10003 | |
ed21c5c8 | 10004 | |
e66ba1df | 10005 | @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup |
a351880d CD |
10006 | @section Macro replacement |
10007 | @cindex macro replacement, during export | |
10008 | @cindex #+MACRO | |
10009 | ||
10010 | You can define text snippets with | |
10011 | ||
10012 | @example | |
10013 | #+MACRO: name replacement text $1, $2 are arguments | |
10014 | @end example | |
10015 | ||
271672fa BG |
10016 | @noindent which can be referenced in |
10017 | paragraphs, verse blocks, table cells and some keywords with | |
10018 | @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments, | |
10019 | commas within arguments have to be escaped with a backslash character. | |
10020 | Conversely, backslash characters before a comma, and only them, need to be | |
10021 | escaped with another backslash character.}. In addition to defined macros, | |
10022 | @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference | |
10023 | information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines. | |
10024 | Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and | |
a351880d CD |
10025 | @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time |
10026 | and to the modification time of the file being exported, respectively. | |
10027 | @var{FORMAT} should be a format string understood by | |
10028 | @code{format-time-string}. | |
10029 | ||
271672fa | 10030 | Macro expansion takes place during export. |
a351880d CD |
10031 | |
10032 | ||
271672fa | 10033 | @node Embedded @LaTeX{}, Special blocks, Macro replacement, Markup |
acedf35c | 10034 | @section Embedded @LaTeX{} |
a351880d | 10035 | @cindex @TeX{} interpretation |
acedf35c CD |
10036 | @cindex @LaTeX{} interpretation |
10037 | ||
10038 | Plain ASCII is normally sufficient for almost all note taking. Exceptions | |
10039 | include scientific notes, which often require mathematical symbols and the | |
10040 | occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on | |
10041 | Donald E. Knuth's @TeX{} system. Many of the features described here as | |
10042 | ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this | |
e66ba1df | 10043 | distinction.} is widely used to typeset scientific documents. Org mode |
acedf35c CD |
10044 | supports embedding @LaTeX{} code into its files, because many academics are |
10045 | used to writing and reading @LaTeX{} source code, and because it can be | |
271672fa | 10046 | readily processed to produce pretty output for a number of export back-ends. |
a351880d CD |
10047 | |
10048 | @menu | |
c0468714 GM |
10049 | * Special symbols:: Greek letters and other symbols |
10050 | * Subscripts and superscripts:: Simple syntax for raising/lowering text | |
8223b1d2 | 10051 | * @LaTeX{} fragments:: Complex formulas made easy |
e66ba1df | 10052 | * Previewing @LaTeX{} fragments:: What will this snippet look like? |
c0468714 | 10053 | * CDLaTeX mode:: Speed up entering of formulas |
a351880d CD |
10054 | @end menu |
10055 | ||
e66ba1df | 10056 | @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{} |
a351880d CD |
10057 | @subsection Special symbols |
10058 | @cindex math symbols | |
10059 | @cindex special symbols | |
10060 | @cindex @TeX{} macros | |
acedf35c | 10061 | @cindex @LaTeX{} fragments, markup rules |
a351880d | 10062 | @cindex HTML entities |
acedf35c | 10063 | @cindex @LaTeX{} entities |
a351880d | 10064 | |
271672fa BG |
10065 | You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha} |
10066 | to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion | |
10067 | for these symbols is available, just type @samp{\} and maybe a few letters, | |
acedf35c | 10068 | and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{} |
271672fa | 10069 | code, Org mode allows these symbols to be present without surrounding math |
a351880d CD |
10070 | delimiters, for example: |
10071 | ||
10072 | @example | |
10073 | Angles are written as Greek letters \alpha, \beta and \gamma. | |
10074 | @end example | |
10075 | ||
86fbb8ca | 10076 | @vindex org-entities |
a351880d | 10077 | During export, these symbols will be transformed into the native format of |
271672fa | 10078 | the exporter back-end. Strings like @code{\alpha} will be exported as |
acedf35c | 10079 | @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{} |
a351880d | 10080 | output. Similarly, @code{\nbsp} will become @code{ } in HTML and |
acedf35c | 10081 | @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it |
a351880d CD |
10082 | like this: @samp{\Aacute@{@}stor}. |
10083 | ||
10084 | A large number of entities is provided, with names taken from both HTML and | |
acedf35c | 10085 | @LaTeX{}; see the variable @code{org-entities} for the complete list. |
a351880d CD |
10086 | @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and |
10087 | @samp{...} are all converted into special commands creating hyphens of | |
10088 | different lengths or a compact set of dots. | |
10089 | ||
271672fa | 10090 | If you would like to see entities displayed as UTF-8 characters, use the |
86fbb8ca CD |
10091 | following command@footnote{You can turn this on by default by setting the |
10092 | variable @code{org-pretty-entities}, or on a per-file base with the | |
10093 | @code{#+STARTUP} option @code{entitiespretty}.}: | |
10094 | ||
10095 | @table @kbd | |
271672fa | 10096 | @cindex @code{entitiespretty}, STARTUP keyword |
86fbb8ca CD |
10097 | @kindex C-c C-x \ |
10098 | @item C-c C-x \ | |
acedf35c CD |
10099 | Toggle display of entities as UTF-8 characters. This does not change the |
10100 | buffer content which remains plain ASCII, but it overlays the UTF-8 character | |
86fbb8ca CD |
10101 | for display purposes only. |
10102 | @end table | |
10103 | ||
e66ba1df | 10104 | @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{} |
a351880d CD |
10105 | @subsection Subscripts and superscripts |
10106 | @cindex subscript | |
10107 | @cindex superscript | |
10108 | ||
271672fa BG |
10109 | Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and |
10110 | subscripts. Again, these can be used without embedding them in math-mode | |
10111 | delimiters. To increase the readability of ASCII text, it is not necessary | |
10112 | (but OK) to surround multi-character sub- and superscripts with curly braces. | |
10113 | For example | |
67df9cfb CD |
10114 | |
10115 | @example | |
acedf35c | 10116 | The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of |
a351880d | 10117 | the sun is R_@{sun@} = 6.96 x 10^8 m. |
67df9cfb CD |
10118 | @end example |
10119 | ||
271672fa BG |
10120 | @vindex org-use-sub-superscripts |
10121 | If you write a text where the underscore is often used in a different | |
10122 | context, Org's convention to always interpret these as subscripts can get in | |
10123 | your way. Configure the variable @code{org-use-sub-superscripts} to change | |
10124 | this convention. For example, when setting this variable to @code{@{@}}, | |
10125 | @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will. | |
afe98dfa | 10126 | |
86fbb8ca CD |
10127 | @table @kbd |
10128 | @kindex C-c C-x \ | |
10129 | @item C-c C-x \ | |
acedf35c | 10130 | In addition to showing entities as UTF-8 characters, this command will also |
86fbb8ca CD |
10131 | format sub- and superscripts in a WYSIWYM way. |
10132 | @end table | |
67df9cfb | 10133 | |
e66ba1df | 10134 | @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{} |
acedf35c CD |
10135 | @subsection @LaTeX{} fragments |
10136 | @cindex @LaTeX{} fragments | |
b349f79f | 10137 | |
a351880d | 10138 | @vindex org-format-latex-header |
afe98dfa | 10139 | Going beyond symbols and sub- and superscripts, a full formula language is |
e66ba1df | 10140 | needed. Org mode can contain @LaTeX{} math fragments, and it supports ways |
271672fa | 10141 | to process these for several export back-ends. When exporting to @LaTeX{}, |
afe98dfa CD |
10142 | the code is obviously left as it is. When exporting to HTML, Org invokes the |
10143 | @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in | |
10144 | HTML export}) to process and display the math@footnote{If you plan to use | |
10145 | this regularly or on pages with significant page views, you should install | |
271672fa BG |
10146 | @file{MathJax} on your own server in order to limit the load of our server.}. |
10147 | Finally, it can also process the mathematical expressions into | |
10148 | images@footnote{For this to work you need to be on a system with a working | |
10149 | @LaTeX{} installation. You also need the @file{dvipng} program or the | |
10150 | @file{convert}, respectively available at | |
10151 | @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick} | |
10152 | suite. The @LaTeX{} header that will be used when processing a fragment can | |
10153 | be configured with the variable @code{org-format-latex-header}.} that can be | |
10154 | displayed in a browser. | |
b349f79f | 10155 | |
acedf35c CD |
10156 | @LaTeX{} fragments don't need any special marking at all. The following |
10157 | snippets will be identified as @LaTeX{} source code: | |
a351880d CD |
10158 | @itemize @bullet |
10159 | @item | |
afe98dfa | 10160 | Environments of any kind@footnote{When @file{MathJax} is used, only the |
271672fa BG |
10161 | environments recognized by @file{MathJax} will be processed. When |
10162 | @file{dvipng} program or @file{imagemagick} suite is used to create images, | |
10163 | any @LaTeX{} environment will be handled.}. The only requirement is that the | |
10164 | @code{\begin} and @code{\end} statements appear on a new line, at the | |
10165 | beginning of the line or after whitespaces only. | |
a351880d | 10166 | @item |
acedf35c | 10167 | Text within the usual @LaTeX{} math delimiters. To avoid conflicts with |
a351880d CD |
10168 | currency specifications, single @samp{$} characters are only recognized as |
10169 | math delimiters if the enclosed text contains at most two line breaks, is | |
10170 | directly attached to the @samp{$} characters with no whitespace in between, | |
10171 | and if the closing @samp{$} is followed by whitespace, punctuation or a dash. | |
10172 | For the other delimiters, there is no such restriction, so when in doubt, use | |
10173 | @samp{\(...\)} as inline math delimiters. | |
10174 | @end itemize | |
b349f79f | 10175 | |
a351880d | 10176 | @noindent For example: |
b349f79f | 10177 | |
a351880d | 10178 | @example |
271672fa BG |
10179 | \begin@{equation@} |
10180 | x=\sqrt@{b@} | |
10181 | \end@{equation@} | |
b349f79f | 10182 | |
a351880d CD |
10183 | If $a^2=b$ and \( b=2 \), then the solution must be |
10184 | either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
10185 | @end example | |
b349f79f | 10186 | |
271672fa BG |
10187 | @c FIXME |
10188 | @c @noindent | |
10189 | @c @vindex org-format-latex-options | |
10190 | @c If you need any of the delimiter ASCII sequences for other purposes, you | |
10191 | @c can configure the option @code{org-format-latex-options} to deselect the | |
10192 | @c ones you do not wish to have interpreted by the @LaTeX{} converter. | |
b349f79f | 10193 | |
271672fa | 10194 | @vindex org-export-with-latex |
e66ba1df | 10195 | @LaTeX{} processing can be configured with the variable |
271672fa BG |
10196 | @code{org-export-with-latex}. The default setting is @code{t} which means |
10197 | @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends. | |
10198 | You can also set this variable on a per-file basis using one of these | |
10199 | lines: | |
afe98dfa CD |
10200 | |
10201 | @example | |
271672fa BG |
10202 | #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)} |
10203 | #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all} | |
10204 | #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so} | |
afe98dfa CD |
10205 | @end example |
10206 | ||
e66ba1df BG |
10207 | @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{} |
10208 | @subsection Previewing @LaTeX{} fragments | |
10209 | @cindex @LaTeX{} fragments, preview | |
b349f79f | 10210 | |
271672fa BG |
10211 | @vindex org-latex-create-formula-image-program |
10212 | If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the | |
10213 | converter by setting the variable | |
10214 | @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{} | |
10215 | fragments can be processed to produce preview images of the typeset | |
10216 | expressions: | |
b349f79f CD |
10217 | |
10218 | @table @kbd | |
a351880d CD |
10219 | @kindex C-c C-x C-l |
10220 | @item C-c C-x C-l | |
acedf35c | 10221 | Produce a preview image of the @LaTeX{} fragment at point and overlay it |
a351880d CD |
10222 | over the source code. If there is no fragment at point, process all |
10223 | fragments in the current entry (between two headlines). When called | |
10224 | with a prefix argument, process the entire subtree. When called with | |
10225 | two prefix arguments, or when the cursor is before the first headline, | |
10226 | process the entire buffer. | |
10227 | @kindex C-c C-c | |
10228 | @item C-c C-c | |
10229 | Remove the overlay preview images. | |
b349f79f CD |
10230 | @end table |
10231 | ||
a351880d CD |
10232 | @vindex org-format-latex-options |
10233 | You can customize the variable @code{org-format-latex-options} to influence | |
ce57c2fe | 10234 | some aspects of the preview. In particular, the @code{:scale} (and for HTML |
a351880d CD |
10235 | export, @code{:html-scale}) property can be used to adjust the size of the |
10236 | preview images. | |
c8d0cf5c | 10237 | |
271672fa BG |
10238 | @vindex org-startup-with-latex-preview |
10239 | You can turn on the previewing of all @LaTeX{} fragments in a file with | |
10240 | ||
10241 | @example | |
10242 | #+STARTUP: latexpreview | |
10243 | @end example | |
10244 | ||
10245 | To disable it, simply use | |
10246 | ||
10247 | @example | |
10248 | #+STARTUP: nolatexpreview | |
10249 | @end example | |
10250 | ||
e66ba1df BG |
10251 | @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{} |
10252 | @subsection Using CD@LaTeX{} to enter math | |
10253 | @cindex CD@LaTeX{} | |
a351880d | 10254 | |
e66ba1df | 10255 | CD@LaTeX{} mode is a minor mode that is normally used in combination with a |
acedf35c | 10256 | major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of |
e66ba1df BG |
10257 | environments and math templates. Inside Org mode, you can make use of |
10258 | some of the features of CD@LaTeX{} mode. You need to install | |
a351880d CD |
10259 | @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
10260 | AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. | |
e66ba1df BG |
10261 | Don't use CD@LaTeX{} mode itself under Org mode, but use the light |
10262 | version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it | |
271672fa | 10263 | on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all |
a351880d CD |
10264 | Org files with |
10265 | ||
10266 | @lisp | |
10267 | (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
10268 | @end lisp | |
10269 | ||
10270 | When this mode is enabled, the following features are present (for more | |
e66ba1df | 10271 | details see the documentation of CD@LaTeX{} mode): |
a351880d CD |
10272 | @itemize @bullet |
10273 | @kindex C-c @{ | |
10274 | @item | |
10275 | Environment templates can be inserted with @kbd{C-c @{}. | |
10276 | @item | |
10277 | @kindex @key{TAB} | |
10278 | The @key{TAB} key will do template expansion if the cursor is inside a | |
e66ba1df | 10279 | @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is |
a351880d CD |
10280 | inside such a fragment, see the documentation of the function |
10281 | @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
10282 | expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
10283 | correctly inside the first brace. Another @key{TAB} will get you into | |
10284 | the second brace. Even outside fragments, @key{TAB} will expand | |
10285 | environment abbreviations at the beginning of a line. For example, if | |
10286 | you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
10287 | this abbreviation will be expanded to an @code{equation} environment. | |
271672fa | 10288 | To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}. |
a351880d CD |
10289 | @item |
10290 | @kindex _ | |
10291 | @kindex ^ | |
10292 | @vindex cdlatex-simplify-sub-super-scripts | |
acedf35c | 10293 | Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these |
a351880d CD |
10294 | characters together with a pair of braces. If you use @key{TAB} to move |
10295 | out of the braces, and if the braces surround only a single character or | |
10296 | macro, they are removed again (depending on the variable | |
10297 | @code{cdlatex-simplify-sub-super-scripts}). | |
10298 | @item | |
10299 | @kindex ` | |
10300 | Pressing the backquote @kbd{`} followed by a character inserts math | |
acedf35c | 10301 | macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds |
a351880d CD |
10302 | after the backquote, a help window will pop up. |
10303 | @item | |
10304 | @kindex ' | |
10305 | Pressing the single-quote @kbd{'} followed by another character modifies | |
10306 | the symbol before point with an accent or a font. If you wait more than | |
acedf35c CD |
10307 | 1.5 seconds after the single-quote, a help window will pop up. Character |
10308 | modification will work only inside @LaTeX{} fragments; outside the quote | |
a351880d CD |
10309 | is normal. |
10310 | @end itemize | |
10311 | ||
271672fa BG |
10312 | @node Special blocks, , Embedded @LaTeX{}, Markup |
10313 | @section Special blocks | |
10314 | @cindex Special blocks | |
10315 | ||
10316 | Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal | |
10317 | examples}). It is also possible to create blocks containing raw code | |
10318 | targeted at a specific back-ends (e.g., @samp{#+BEGIN_LATEX}). | |
10319 | ||
3c8b09ca BG |
10320 | Any other block is a @emph{special block}. |
10321 | ||
10322 | For example, @samp{#+BEGIN_ABSTRACT} and @samp{#+BEGIN_VIDEO} are special | |
10323 | blocks. The first one is useful when exporting to @LaTeX{}, the second one | |
10324 | when exporting to HTML5. | |
10325 | ||
10326 | Each export back-end decides if they should be exported, and how. When the | |
10327 | block is ignored, its contents are still exported, as if the opening and | |
10328 | closing block lines were not there. For example, when exporting a | |
10329 | @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents within a | |
10330 | @samp{<div name="test">} tag. | |
10331 | ||
10332 | Refer to back-end specific documentation for more information. | |
271672fa | 10333 | |
a351880d CD |
10334 | @node Exporting, Publishing, Markup, Top |
10335 | @chapter Exporting | |
10336 | @cindex exporting | |
10337 | ||
271672fa BG |
10338 | The Org mode export facilities can be used to export Org documents or parts |
10339 | of Org documents to a variety of other formats. In addition, these | |
10340 | facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode} | |
10341 | in foreign buffers so you can author tables and lists in Org syntax and | |
10342 | convert them in place to the target language. | |
10343 | ||
10344 | ASCII export produces a readable and simple version of an Org file for | |
10345 | printing and sharing notes. HTML export allows you to easily publish notes | |
10346 | on the web, or to build full-fledged websites. @LaTeX{} export lets you use | |
10347 | Org mode and its structured editing functions to create arbitrarily complex | |
10348 | @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export | |
10349 | allows seamless collaboration across organizational boundaries. Markdown | |
10350 | export lets you seamlessly collaborate with other developers. Finally, iCal | |
10351 | export can extract entries with deadlines or appointments to produce a file | |
10352 | in the iCalendar format. | |
a351880d CD |
10353 | |
10354 | @menu | |
271672fa BG |
10355 | * The Export Dispatcher:: The main exporter interface |
10356 | * Export back-ends:: Built-in export formats | |
10357 | * Export settings:: Generic export settings | |
c0468714 | 10358 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
271672fa | 10359 | * Beamer export:: Exporting as a Beamer presentation |
c0468714 | 10360 | * HTML export:: Exporting to HTML |
e66ba1df | 10361 | * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF |
271672fa | 10362 | * Markdown export:: Exporting to Markdown |
e66ba1df | 10363 | * OpenDocument Text export:: Exporting to OpenDocument Text |
3c8b09ca | 10364 | * Org export:: Exporting to Org |
271672fa BG |
10365 | * iCalendar export:: Exporting to iCalendar |
10366 | * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org | |
10367 | * Export in foreign buffers:: Author tables in lists in Org syntax | |
10368 | * Advanced configuration:: Fine-tuning the export output | |
a351880d | 10369 | @end menu |
c8d0cf5c | 10370 | |
271672fa BG |
10371 | @node The Export Dispatcher, Export back-ends, Exporting, Exporting |
10372 | @section The Export Dispatcher | |
10373 | @vindex org-export-dispatch-use-expert-ui | |
10374 | @cindex Export, dispatcher | |
10375 | ||
10376 | The main entry point for export related tasks is the dispatcher, a | |
10377 | hierarchical menu from which it is possible to select an export format and | |
10378 | toggle export options@footnote{It is also possible to use a less intrusive | |
10379 | interface by setting @code{org-export-dispatch-use-expert-ui} to a | |
10380 | non-@code{nil} value. In that case, only a prompt is visible from the | |
10381 | minibuffer. From there one can still switch back to regular menu by pressing | |
10382 | @key{?}.} from which it is possible to select an export format and to toggle | |
10383 | export options. | |
10384 | ||
10385 | @c @quotation | |
10386 | @table @asis | |
10387 | @orgcmd{C-c C-e,org-export-dispatch} | |
864c9740 | 10388 | |
271672fa BG |
10389 | Dispatch for export and publishing commands. When called with a @kbd{C-u} |
10390 | prefix argument, repeat the last export command on the current buffer while | |
10391 | preserving toggled options. If the current buffer hasn't changed and subtree | |
10392 | export was activated, the command will affect that same subtree. | |
10393 | @end table | |
10394 | @c @end quotation | |
864c9740 | 10395 | |
271672fa BG |
10396 | Normally the entire buffer is exported, but if there is an active region |
10397 | only that part of the buffer will be exported. | |
864c9740 | 10398 | |
271672fa BG |
10399 | Several export options (@pxref{Export settings}) can be toggled from the |
10400 | export dispatcher with the following key combinations: | |
864c9740 | 10401 | |
271672fa BG |
10402 | @table @kbd |
10403 | @item C-a | |
10404 | @vindex org-export-async-init-file | |
10405 | Toggle asynchronous export. Asynchronous export uses an external Emacs | |
10406 | process that is configured with a specified initialization file. | |
ce57c2fe | 10407 | |
271672fa BG |
10408 | While exporting asynchronously, the output is not displayed. It is stored in |
10409 | a list called ``the export stack'', and can be viewed from there. The stack | |
10410 | can be reached by calling the dispatcher with a double @kbd{C-u} prefix | |
10411 | argument, or with @kbd{&} key from the dispatcher. | |
864c9740 | 10412 | |
271672fa | 10413 | @vindex org-export-in-background |
da5ecfa9 | 10414 | To make this behavior the default, customize the variable |
271672fa | 10415 | @code{org-export-in-background}. |
b349f79f | 10416 | |
271672fa BG |
10417 | @item C-b |
10418 | Toggle body-only export. Its effect depends on the back-end used. | |
10419 | Typically, if the back-end has a header section (like @code{<head>...</head>} | |
10420 | in the HTML back-end), a body-only export will not include this header. | |
10421 | ||
10422 | @item C-s | |
10423 | @vindex org-export-initial-scope | |
10424 | Toggle subtree export. The top heading becomes the document title. | |
10425 | ||
10426 | You can change the default state of this option by setting | |
10427 | @code{org-export-initial-scope}. | |
10428 | ||
10429 | @item C-v | |
10430 | Toggle visible-only export. Only export the text that is currently | |
10431 | visible, i.e. not hidden by outline visibility in the buffer. | |
b349f79f | 10432 | |
b349f79f CD |
10433 | @end table |
10434 | ||
271672fa BG |
10435 | @vindex org-export-copy-to-kill-ring |
10436 | With the exception of asynchronous export, a successful export process writes | |
10437 | its output to the kill-ring. You can configure this behavior by altering the | |
10438 | option @code{org-export-copy-to-kill-ring}. | |
10439 | ||
10440 | @node Export back-ends, Export settings, The Export Dispatcher, Exporting | |
10441 | @section Export back-ends | |
10442 | @cindex Export, back-ends | |
10443 | ||
10444 | An export back-end is a library that translates Org syntax into a foreign | |
10445 | format. An export format is not available until the proper back-end has been | |
10446 | loaded. | |
10447 | ||
10448 | @vindex org-export-backends | |
10449 | By default, the following four back-ends are loaded: @code{ascii}, | |
10450 | @code{html}, @code{icalendar} and @code{latex}. It is possible to add more | |
10451 | (or remove some) by customizing @code{org-export-backends}. | |
10452 | ||
10453 | Built-in back-ends include: | |
10454 | ||
10455 | @itemize | |
10456 | @item ascii (ASCII format) | |
10457 | @item beamer (@LaTeX{} Beamer format) | |
10458 | @item html (HTML format) | |
10459 | @item icalendar (iCalendar format) | |
10460 | @item latex (@LaTeX{} format) | |
10461 | @item man (Man page format) | |
10462 | @item md (Markdown format) | |
10463 | @item odt (OpenDocument Text format) | |
3c8b09ca | 10464 | @item org (Org format) |
271672fa BG |
10465 | @item texinfo (Texinfo format) |
10466 | @end itemize | |
10467 | ||
10468 | Other back-ends might be found in the @code{contrib/} directory | |
10469 | (@pxref{Installation}). | |
10470 | ||
10471 | @node Export settings, ASCII/Latin-1/UTF-8 export, Export back-ends, Exporting | |
10472 | @section Export settings | |
10473 | @cindex Export, settings | |
10474 | ||
10475 | Export options can be set: globally with variables; for an individual file by | |
10476 | making variables buffer-local with in-buffer settings (@pxref{In-buffer | |
10477 | settings}), by setting individual keywords, or by specifying them in a | |
10478 | compact form with the @code{#+OPTIONS} keyword; or for a tree by setting | |
10479 | properties (@pxref{Properties and Columns}). Options set at a specific level | |
10480 | override options set at a more general level. | |
10481 | ||
10482 | @cindex #+SETUPFILE | |
10483 | In-buffer settings may appear anywhere in the file, either directly or | |
10484 | indirectly through a file included using @samp{#+SETUPFILE: filename} syntax. | |
10485 | Option keyword sets tailored to a particular back-end can be inserted from | |
10486 | the export dispatcher (@pxref{The Export Dispatcher}) using the @code{Insert | |
10487 | template} command by pressing @key{#}. To insert keywords individually, | |
10488 | a good way to make sure the keyword is correct is to type @code{#+} and then | |
10489 | to use @kbd{M-<TAB>} for completion. | |
10490 | ||
10491 | The export keywords available for every back-end, and their equivalent global | |
10492 | variables, include: | |
10493 | ||
10494 | @table @samp | |
10495 | @item AUTHOR | |
c8d0cf5c | 10496 | @vindex user-full-name |
271672fa BG |
10497 | The document author (@code{user-full-name}). |
10498 | ||
10499 | @item CREATOR | |
10500 | @vindex org-export-creator-string | |
10501 | Entity responsible for output generation (@code{org-export-creator-string}). | |
10502 | ||
10503 | @item DATE | |
10504 | @vindex org-export-date-timestamp-format | |
10505 | A date or a time-stamp@footnote{The variable | |
10506 | @code{org-export-date-timestamp-format} defines how this time-stamp will be | |
10507 | exported.}. | |
10508 | ||
10509 | @item DESCRIPTION | |
10510 | The document description. Back-ends handle it as they see fit (e.g., for the | |
10511 | XHTML meta tag), if at all. You can use several such keywords for long | |
10512 | descriptions. | |
10513 | ||
10514 | @item EMAIL | |
c8d0cf5c | 10515 | @vindex user-mail-address |
271672fa BG |
10516 | The email address (@code{user-mail-address}). |
10517 | ||
10518 | @item KEYWORDS | |
10519 | The keywords defining the contents of the document. Back-ends handle it as | |
10520 | they see fit (e.g., for the XHTML meta tag), if at all. You can use several | |
10521 | such keywords if the list is long. | |
10522 | ||
10523 | @item LANGUAGE | |
c8d0cf5c | 10524 | @vindex org-export-default-language |
271672fa BG |
10525 | The language used for translating some strings |
10526 | (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell | |
10527 | Org to translate @emph{File} (english) into @emph{Fichier} (french) in the | |
10528 | clocktable. | |
b349f79f | 10529 | |
271672fa BG |
10530 | @item SELECT_TAGS |
10531 | @vindex org-export-select-tags | |
10532 | The tags that select a tree for export (@code{org-export-select-tags}). The | |
10533 | default value is @code{:export:}. Within a subtree tagged with | |
10534 | @code{:export:}, you can still exclude entries with @code{:noexport:} (see | |
73d3db82 BG |
10535 | below). When headlines are selectively exported with @code{:export:} |
10536 | anywhere in a file, text before the first headline is ignored. | |
271672fa BG |
10537 | |
10538 | @item EXCLUDE_TAGS | |
10539 | The tags that exclude a tree from export (@code{org-export-exclude-tags}). | |
10540 | The default value is @code{:noexport:}. Entries with the @code{:noexport:} | |
10541 | tag will be unconditionally excluded from the export, even if they have an | |
10542 | @code{:export:} tag. | |
10543 | ||
10544 | @item TITLE | |
10545 | The title to be shown (otherwise derived from buffer's name). You can use | |
10546 | several such keywords for long titles. | |
10547 | @end table | |
10548 | ||
10549 | The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure | |
10550 | many options this way, you can use several @code{#+OPTIONS} lines.} form that | |
10551 | recognizes the following arguments: | |
10552 | ||
10553 | @table @code | |
10554 | @item ': | |
10555 | @vindex org-export-with-smart-quotes | |
10556 | Toggle smart quotes (@code{org-export-with-smart-quotes}). | |
10557 | ||
10558 | @item *: | |
10559 | Toggle emphasized text (@code{org-export-with-emphasize}). | |
10560 | ||
10561 | @item -: | |
10562 | @vindex org-export-with-special-strings | |
10563 | Toggle conversion of special strings | |
10564 | (@code{org-export-with-special-strings}). | |
10565 | ||
10566 | @item :: | |
10567 | @vindex org-export-with-fixed-width | |
10568 | Toggle fixed-width sections | |
10569 | (@code{org-export-with-fixed-width}). | |
10570 | ||
10571 | @item <: | |
10572 | @vindex org-export-with-timestamps | |
10573 | Toggle inclusion of any time/date active/inactive stamps | |
10574 | (@code{org-export-with-timestamps}). | |
10575 | ||
10576 | @item : | |
10577 | @vindex org-export-preserve-breaks | |
10578 | Toggle line-break-preservation (@code{org-export-preserve-breaks}). | |
10579 | ||
10580 | @item ^: | |
10581 | @vindex org-export-with-sub-superscripts | |
10582 | Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}", | |
10583 | @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as | |
10584 | it is (@code{org-export-with-sub-superscripts}). | |
10585 | ||
10586 | @item arch: | |
10587 | @vindex org-export-with-archived-trees | |
10588 | Configure export of archived trees. Can be set to @code{headline} to only | |
10589 | process the headline, skipping its contents | |
10590 | (@code{org-export-with-archived-trees}). | |
10591 | ||
10592 | @item author: | |
10593 | @vindex org-export-with-author | |
10594 | Toggle inclusion of author name into exported file | |
10595 | (@code{org-export-with-author}). | |
10596 | ||
10597 | @item c: | |
10598 | @vindex org-export-with-clocks | |
10599 | Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}). | |
10600 | ||
10601 | @item creator: | |
10602 | @vindex org-export-with-creator | |
10603 | Configure inclusion of creator info into exported file. It may be set to | |
10604 | @code{comment} (@code{org-export-with-creator}). | |
10605 | ||
10606 | @item d: | |
10607 | @vindex org-export-with-drawers | |
10608 | Toggle inclusion of drawers, or list drawers to include | |
10609 | (@code{org-export-with-drawers}). | |
10610 | ||
10611 | @item e: | |
10612 | @vindex org-export-with-entities | |
10613 | Toggle inclusion of entities (@code{org-export-with-entities}). | |
10614 | ||
10615 | @item email: | |
10616 | @vindex org-export-with-email | |
10617 | Toggle inclusion of the author's e-mail into exported file | |
10618 | (@code{org-export-with-email}). | |
10619 | ||
10620 | @item f: | |
10621 | @vindex org-export-with-footnotes | |
10622 | Toggle the inclusion of footnotes (@code{org-export-with-footnotes}). | |
10623 | ||
10624 | @item H: | |
10625 | @vindex org-export-headline-levels | |
10626 | Set the number of headline levels for export | |
10627 | (@code{org-export-headline-levels}). Below that level, headlines are treated | |
10628 | differently. In most back-ends, they become list items. | |
10629 | ||
10630 | @item inline: | |
10631 | @vindex org-export-with-inlinetasks | |
10632 | Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}). | |
10633 | ||
10634 | @item num: | |
10635 | @vindex org-export-with-section-numbers | |
10636 | Toggle section-numbers (@code{org-export-with-section-numbers}). It can also | |
10637 | be set to a number @samp{n}, so only headlines at that level or above will be | |
10638 | numbered. | |
10639 | ||
10640 | @item p: | |
10641 | @vindex org-export-with-planning | |
10642 | Toggle export of planning information (@code{org-export-with-planning}). | |
10643 | ``Planning information'' is the line containing the @code{SCHEDULED:}, the | |
10644 | @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them. | |
10645 | ||
10646 | @item pri: | |
10647 | @vindex org-export-with-priority | |
10648 | Toggle inclusion of priority cookies (@code{org-export-with-priority}). | |
10649 | ||
10650 | @item stat: | |
10651 | @vindex org-export-with-statistics-cookies | |
10652 | Toggle inclusion of statistics cookies | |
10653 | (@code{org-export-with-statistics-cookies}). | |
10654 | ||
10655 | @item tags: | |
10656 | @vindex org-export-with-tags | |
10657 | Toggle inclusion of tags, may also be @code{not-in-toc} | |
10658 | (@code{org-export-with-tags}). | |
10659 | ||
10660 | @item tasks: | |
10661 | @vindex org-export-with-tasks | |
10662 | Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all | |
10663 | tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep | |
10664 | (@code{org-export-with-tasks}). | |
10665 | ||
10666 | @item tex: | |
10667 | @vindex org-export-with-latex | |
10668 | Configure export of @LaTeX{} fragments and environments. It may be set to | |
10669 | @code{verbatim} (@code{org-export-with-latex}). | |
10670 | ||
10671 | @item timestamp: | |
ce57c2fe | 10672 | @vindex org-export-time-stamp-file |
271672fa BG |
10673 | Toggle inclusion of the creation time into exported file |
10674 | (@code{org-export-time-stamp-file}). | |
4009494e | 10675 | |
271672fa BG |
10676 | @item toc: |
10677 | @vindex org-export-with-toc | |
10678 | Toggle inclusion of the table of contents, or set the level limit | |
10679 | (@code{org-export-with-toc}). | |
10680 | ||
10681 | @item todo: | |
10682 | @vindex org-export-with-todo-keywords | |
10683 | Toggle inclusion of TODO keywords into exported text | |
10684 | (@code{org-export-with-todo-keywords}). | |
10685 | ||
10686 | @item |: | |
10687 | @vindex org-export-with-tables | |
10688 | Toggle inclusion of tables (@code{org-export-with-tables}). | |
4009494e GM |
10689 | @end table |
10690 | ||
271672fa BG |
10691 | @cindex property, EXPORT_FILE_NAME |
10692 | When exporting only a subtree, each of the previous keywords@footnote{With | |
ae93878a | 10693 | the exception of @samp{SETUPFILE}.} can be overridden locally by special node |
271672fa BG |
10694 | properties. These begin with @samp{EXPORT_}, followed by the name of the |
10695 | keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords | |
10696 | become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS} | |
10697 | properties. Subtree export also supports the self-explicit | |
10698 | @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent | |
10699 | for this property. The file name in this case is derived from the file | |
10700 | associated to the buffer, if possible, or asked to the user otherwise.}. | |
10701 | ||
10702 | @cindex #+BIND | |
10703 | @vindex org-export-allow-bind-keywords | |
10704 | If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables | |
10705 | can become buffer-local during export by using the BIND keyword. Its syntax | |
10706 | is @samp{#+BIND: variable value}. This is particularly useful for in-buffer | |
10707 | settings that cannot be changed using specific keywords. | |
10708 | ||
10709 | @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting | |
ed21c5c8 | 10710 | @section ASCII/Latin-1/UTF-8 export |
4009494e | 10711 | @cindex ASCII export |
ed21c5c8 CD |
10712 | @cindex Latin-1 export |
10713 | @cindex UTF-8 export | |
4009494e | 10714 | |
e66ba1df | 10715 | ASCII export produces a simple and very readable version of an Org mode |
1df7defd | 10716 | file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file |
ed21c5c8 | 10717 | with special characters and symbols available in these encodings. |
4009494e | 10718 | |
271672fa BG |
10719 | @vindex org-ascii-links-to-notes |
10720 | Links are exported in a footnote-like style, with the descriptive part in the | |
10721 | text and the link in a note before the next heading. See the variable | |
10722 | @code{org-ascii-links-to-notes} for details and other options. | |
10723 | ||
10724 | @subheading ASCII export commands | |
10725 | ||
4009494e | 10726 | @table @kbd |
271672fa | 10727 | @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii} |
8223b1d2 | 10728 | Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file |
271672fa BG |
10729 | will be @file{myfile.txt}. The file will be overwritten without warning. |
10730 | When the original file is @file{myfile.txt}, the resulting file becomes | |
10731 | @file{myfile.txt.txt} in order to prevent data loss. | |
10732 | @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii} | |
acedf35c | 10733 | Export to a temporary buffer. Do not create a file. |
4009494e GM |
10734 | @end table |
10735 | ||
271672fa BG |
10736 | @subheading Header and sectioning structure |
10737 | ||
10738 | In the exported version, the first three outline levels become headlines, | |
10739 | defining a general document structure. Additional levels are exported as | |
10740 | lists. The transition can also occur at a different level (@pxref{Export | |
10741 | settings}). | |
10742 | ||
10743 | @subheading Quoting ASCII text | |
10744 | ||
10745 | You can insert text that will only appear when using @code{ASCII} back-end | |
10746 | with the following constructs: | |
10747 | ||
10748 | @cindex #+ASCII | |
10749 | @cindex #+BEGIN_ASCII | |
10750 | @example | |
10751 | Text @@@@ascii:and additional text@@@@ within a paragraph. | |
10752 | ||
10753 | #+ASCII: Some text | |
10754 | ||
10755 | #+BEGIN_ASCII | |
10756 | All lines in this block will appear only when using this back-end. | |
10757 | #+END_ASCII | |
10758 | @end example | |
10759 | ||
10760 | @subheading ASCII specific attributes | |
10761 | @cindex #+ATTR_ASCII | |
10762 | @cindex horizontal rules, in ASCII export | |
10763 | ||
10764 | @code{ASCII} back-end only understands one attribute, @code{:width}, which | |
10765 | specifies the length, in characters, of a given horizontal rule. It must be | |
10766 | specified using an @code{ATTR_ASCII} line, directly preceding the rule. | |
10767 | ||
10768 | @example | |
10769 | #+ATTR_ASCII: :width 10 | |
10770 | ----- | |
10771 | @end example | |
10772 | ||
10773 | @node Beamer export, HTML export, ASCII/Latin-1/UTF-8 export, Exporting | |
10774 | @section Beamer export | |
10775 | @cindex Beamer export | |
10776 | ||
10777 | The @LaTeX{} class @emph{Beamer} allows production of high quality | |
10778 | presentations using @LaTeX{} and pdf processing. Org mode has special | |
10779 | support for turning an Org mode file or tree into a Beamer presentation. | |
10780 | ||
10781 | @subheading Beamer export commands | |
10782 | ||
10783 | @table @kbd | |
10784 | @orgcmd{C-c C-e l b,org-beamer-export-to-latex} | |
10785 | Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{} | |
10786 | file will be @file{myfile.tex}. The file will be overwritten without | |
10787 | warning. | |
10788 | @orgcmd{C-c C-e l B,org-beamer-export-as-latex} | |
10789 | Export to a temporary buffer. Do not create a file. | |
10790 | @orgcmd{C-c C-e l P,org-beamer-export-to-pdf} | |
10791 | Export as @LaTeX{} and then process to PDF. | |
10792 | @item C-c C-e l O | |
10793 | Export as @LaTeX{} and then process to PDF, then open the resulting PDF file. | |
10794 | @end table | |
10795 | ||
10796 | @subheading Sectioning, Frames and Blocks | |
10797 | ||
10798 | Any tree with not-too-deep level nesting should in principle be exportable as | |
10799 | a Beamer presentation. Headlines fall into three categories: sectioning | |
10800 | elements, frames and blocks. | |
10801 | ||
10802 | @itemize @minus | |
10803 | @item | |
10804 | @vindex org-beamer-frame-level | |
10805 | Headlines become frames when their level is equal to | |
10806 | @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line | |
10807 | (@pxref{Export settings}). | |
10808 | ||
10809 | @cindex property, BEAMER_ENV | |
10810 | Though, if a headline in the current tree has a @code{BEAMER_ENV} property | |
10811 | set to either to @code{frame} or @code{fullframe}, its level overrides the | |
10812 | variable. A @code{fullframe} is a frame with an empty (ignored) title. | |
10813 | ||
10814 | @item | |
10815 | @vindex org-beamer-environments-default | |
10816 | @vindex org-beamer-environments-extra | |
10817 | All frame's children become @code{block} environments. Special block types | |
10818 | can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If | |
10819 | this property is set, the entry will also get a @code{:B_environment:} tag to | |
10820 | make this visible. This tag has no semantic meaning, it is only a visual | |
10821 | aid.} to an appropriate value (see @code{org-beamer-environments-default} for | |
10822 | supported values and @code{org-beamer-environments-extra} for adding more). | |
10823 | ||
10824 | @item | |
10825 | @cindex property, BEAMER_REF | |
10826 | As a special case, if the @code{BEAMER_ENV} property is set to either | |
10827 | @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the | |
10828 | headline will become, respectively, an appendix, a note (within frame or | |
10829 | between frame, depending on its level), a note with its title ignored or an | |
10830 | @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property | |
10831 | is mandatory in order to refer to the frame being resumed, and contents are | |
10832 | ignored. | |
10833 | ||
10834 | Also, a headline with an @code{ignoreheading} environment will have its | |
10835 | contents only inserted in the output. This special value is useful to have | |
10836 | data between frames, or to properly close a @code{column} environment. | |
10837 | @end itemize | |
10838 | ||
10839 | @cindex property, BEAMER_ACT | |
10840 | @cindex property, BEAMER_OPT | |
10841 | Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties. | |
10842 | The former is translated as an overlay/action specification, or a default | |
10843 | overlay specification when enclosed within square brackets. The latter | |
10844 | specifies options@footnote{The @code{fragile} option is added automatically | |
10845 | if it contains code that requires a verbatim environment, though.} for the | |
10846 | current frame or block. The export back-end will automatically wrap | |
10847 | properties within angular or square brackets when appropriate. | |
10848 | ||
10849 | @cindex property, BEAMER_COL | |
10850 | Moreover, headlines handle the @code{BEAMER_COL} property. Its value should | |
10851 | be a decimal number representing the width of the column as a fraction of the | |
10852 | total text width. If the headline has no specific environment, its title | |
10853 | will be ignored and its contents will fill the column created. Otherwise, | |
10854 | the block will fill the whole column and the title will be preserved. Two | |
10855 | contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same | |
10856 | @code{columns} @LaTeX{} environment. It will end before the next headline | |
10857 | without such a property. This environment is generated automatically. | |
10858 | Although, it can also be explicitly created, with a special @code{columns} | |
10859 | value for @code{BEAMER_ENV} property (if it needs to be set up with some | |
10860 | specific options, for example). | |
10861 | ||
10862 | @subheading Beamer specific syntax | |
10863 | ||
10864 | Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{} | |
10865 | specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is | |
10866 | recognized. See @ref{@LaTeX{} and PDF export} for more information. | |
10867 | ||
10868 | @cindex #+BEAMER_THEME | |
10869 | @cindex #+BEAMER_COLOR_THEME | |
10870 | @cindex #+BEAMER_FONT_THEME | |
10871 | @cindex #+BEAMER_INNER_THEME | |
10872 | @cindex #+BEAMER_OUTER_THEME | |
10873 | Beamer export introduces a number of keywords to insert code in the | |
d1389828 | 10874 | document's header. Four control appearance of the presentation: |
271672fa BG |
10875 | @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME}, |
10876 | @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and | |
10877 | @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments | |
10878 | within square brackets. The last one, @code{#+BEAMER_HEADER}, is more | |
10879 | generic and allows you to append any line of code in the header. | |
10880 | ||
10881 | @example | |
10882 | #+BEAMER_THEME: Rochester [height=20pt] | |
10883 | #+BEAMER_COLOR_THEME: spruce | |
10884 | @end example | |
10885 | ||
10886 | Table of contents generated from @code{toc:t} @code{OPTION} keyword are | |
10887 | wrapped within a @code{frame} environment. Those generated from a @code{TOC} | |
10888 | keyword (@pxref{Table of contents}) are not. In that case, it is also | |
10889 | possible to specify options, enclosed within square brackets. | |
10890 | ||
10891 | @example | |
10892 | #+TOC: headlines [currentsection] | |
10893 | @end example | |
10894 | ||
10895 | Beamer specific code can be inserted with the following constructs: | |
10896 | ||
10897 | @cindex #+BEAMER | |
10898 | @cindex #+BEGIN_BEAMER | |
10899 | @example | |
10900 | #+BEAMER: \pause | |
10901 | ||
10902 | #+BEGIN_BEAMER | |
10903 | All lines in this block will appear only when using this back-end. | |
10904 | #+END_BEAMER | |
10905 | ||
10906 | Text @@@@beamer:some code@@@@ within a paragraph. | |
10907 | @end example | |
10908 | ||
10909 | In particular, this last example can be used to add overlay specifications to | |
10910 | objects whose type is among @code{bold}, @code{item}, @code{link}, | |
10911 | @code{radio-target} and @code{target}, when the value is enclosed within | |
10912 | angular brackets and put at the beginning the object. | |
10913 | ||
10914 | @example | |
10915 | A *@@@@beamer:<2->@@@@useful* feature | |
10916 | @end example | |
10917 | ||
10918 | @cindex #+ATTR_BEAMER | |
10919 | Eventually, every plain list has support for @code{:environment}, | |
10920 | @code{:overlay} and @code{:options} attributes through | |
10921 | @code{ATTR_BEAMER} affiliated keyword. The first one allows the use | |
10922 | of a different environment, the second sets overlay specifications and | |
10923 | the last one inserts optional arguments in current list environment. | |
10924 | ||
10925 | @example | |
10926 | #+ATTR_BEAMER: :overlay +- | |
10927 | - item 1 | |
10928 | - item 2 | |
10929 | @end example | |
10930 | ||
10931 | @subheading Editing support | |
10932 | ||
10933 | You can turn on a special minor mode @code{org-beamer-mode} for faster | |
10934 | editing with: | |
10935 | ||
10936 | @example | |
10937 | #+STARTUP: beamer | |
10938 | @end example | |
10939 | ||
10940 | @table @kbd | |
10941 | @orgcmd{C-c C-b,org-beamer-select-environment} | |
10942 | In @code{org-beamer-mode}, this key offers fast selection of a Beamer | |
10943 | environment or the @code{BEAMER_COL} property. | |
10944 | @end table | |
10945 | ||
10946 | Also, a template for useful in-buffer settings or properties can be inserted | |
10947 | into the buffer with @kbd{M-x org-beamer-insert-options-template}. Among | |
10948 | other things, this will install a column view format which is very handy for | |
10949 | editing special properties used by Beamer. | |
10950 | ||
10951 | @subheading An example | |
4009494e | 10952 | |
271672fa | 10953 | Here is a simple example Org document that is intended for Beamer export. |
4009494e | 10954 | |
271672fa BG |
10955 | @smallexample |
10956 | #+TITLE: Example Presentation | |
10957 | #+AUTHOR: Carsten Dominik | |
10958 | #+OPTIONS: H:2 | |
10959 | #+LATEX_CLASS: beamer | |
10960 | #+LATEX_CLASS_OPTIONS: [presentation] | |
10961 | #+BEAMER_THEME: Madrid | |
10962 | #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt) | |
10963 | ||
10964 | * This is the first structural section | |
10965 | ||
10966 | ** Frame 1 | |
10967 | *** Thanks to Eric Fraga :B_block:BMCOL: | |
10968 | :PROPERTIES: | |
10969 | :BEAMER_COL: 0.48 | |
10970 | :BEAMER_ENV: block | |
10971 | :END: | |
10972 | for the first viable Beamer setup in Org | |
10973 | *** Thanks to everyone else :B_block:BMCOL: | |
10974 | :PROPERTIES: | |
10975 | :BEAMER_COL: 0.48 | |
10976 | :BEAMER_ACT: <2-> | |
10977 | :BEAMER_ENV: block | |
10978 | :END: | |
10979 | for contributing to the discussion | |
10980 | **** This will be formatted as a beamer note :B_note: | |
10981 | :PROPERTIES: | |
10982 | :BEAMER_env: note | |
10983 | :END: | |
10984 | ** Frame 2 (where we will not use columns) | |
10985 | *** Request | |
10986 | Please test this stuff! | |
10987 | @end smallexample | |
10988 | ||
10989 | @node HTML export, @LaTeX{} and PDF export, Beamer export, Exporting | |
4009494e GM |
10990 | @section HTML export |
10991 | @cindex HTML export | |
10992 | ||
d1389828 | 10993 | Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
b6cb4cd5 | 10994 | HTML formatting, in ways similar to John Gruber's @emph{markdown} |
4009494e GM |
10995 | language, but with additional support for tables. |
10996 | ||
10997 | @menu | |
c0468714 | 10998 | * HTML Export commands:: How to invoke HTML export |
271672fa | 10999 | * HTML doctypes:: Org can export to various (X)HTML flavors |
ce57c2fe | 11000 | * HTML preamble and postamble:: How to insert a preamble and a postamble |
e66ba1df | 11001 | * Quoting HTML tags:: Using direct HTML in Org mode |
c0468714 GM |
11002 | * Links in HTML export:: How links will be interpreted and formatted |
11003 | * Tables in HTML export:: How to modify the formatting of tables | |
11004 | * Images in HTML export:: How to insert figures into HTML output | |
afe98dfa | 11005 | * Math formatting in HTML export:: Beautiful math also on the web |
c0468714 GM |
11006 | * Text areas in HTML export:: An alternative way to show an example |
11007 | * CSS support:: Changing the appearance of the output | |
11008 | * JavaScript support:: Info and Folding in a web browser | |
4009494e GM |
11009 | @end menu |
11010 | ||
271672fa | 11011 | @node HTML Export commands, HTML doctypes, HTML export, HTML export |
4009494e GM |
11012 | @subsection HTML export commands |
11013 | ||
4009494e | 11014 | @table @kbd |
271672fa | 11015 | @orgcmd{C-c C-e h h,org-html-export-to-html} |
d1389828 | 11016 | Export as an HTML file. For an Org file @file{myfile.org}, |
ce57c2fe | 11017 | the HTML file will be @file{myfile.html}. The file will be overwritten |
271672fa BG |
11018 | without warning. |
11019 | @kbd{C-c C-e h o} | |
d1389828 | 11020 | Export as an HTML file and immediately open it with a browser. |
271672fa | 11021 | @orgcmd{C-c C-e h H,org-html-export-as-html} |
acedf35c | 11022 | Export to a temporary buffer. Do not create a file. |
4009494e GM |
11023 | @end table |
11024 | ||
271672fa BG |
11025 | @c FIXME Exporting sublevels |
11026 | @c @cindex headline levels, for exporting | |
11027 | @c In the exported version, the first 3 outline levels will become headlines, | |
11028 | @c defining a general document structure. Additional levels will be exported as | |
11029 | @c itemized lists. If you want that transition to occur at a different level, | |
11030 | @c specify it with a numeric prefix argument. For example, | |
11031 | ||
11032 | @c @example | |
11033 | @c @kbd{C-2 C-c C-e b} | |
11034 | @c @end example | |
11035 | ||
11036 | @c @noindent | |
11037 | @c creates two levels of headings and does the rest as items. | |
11038 | ||
11039 | @node HTML doctypes, HTML preamble and postamble, HTML Export commands, HTML export | |
11040 | @subsection HTML doctypes | |
11041 | @vindex org-html-doctype | |
11042 | @vindex org-html-doctype-alist | |
11043 | ||
11044 | Org can export to various (X)HTML flavors. | |
11045 | ||
11046 | Setting the variable @code{org-html-doctype} allows you to export to different | |
d1389828 | 11047 | (X)HTML variants. The exported HTML will be adjusted according to the syntax |
271672fa BG |
11048 | requirements of that variant. You can either set this variable to a doctype |
11049 | string directly, in which case the exporter will try to adjust the syntax | |
11050 | automatically, or you can use a ready-made doctype. The ready-made options | |
11051 | are: | |
11052 | ||
11053 | @itemize | |
11054 | @item | |
11055 | ``html4-strict'' | |
11056 | @item | |
11057 | ``html4-transitional'' | |
11058 | @item | |
11059 | ``html4-frameset'' | |
11060 | @item | |
11061 | ``xhtml-strict'' | |
11062 | @item | |
11063 | ``xhtml-transitional'' | |
11064 | @item | |
11065 | ``xhtml-frameset'' | |
11066 | @item | |
11067 | ``xhtml-11'' | |
11068 | @item | |
11069 | ``html5'' | |
11070 | @item | |
11071 | ``xhtml5'' | |
11072 | @end itemize | |
11073 | ||
11074 | See the variable @code{org-html-doctype-alist} for details. The default is | |
11075 | ``xhtml-strict''. | |
11076 | ||
11077 | @subsubheading Fancy HTML5 export | |
11078 | @vindex org-html-html5-fancy | |
11079 | @vindex org-html-html5-elements | |
11080 | ||
11081 | HTML5 introduces several new element types. By default, Org will not make | |
11082 | use of these element types, but you can set @code{org-html-html5-fancy} to | |
11083 | @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to | |
11084 | enable a few new block-level elements. These are created using arbitrary | |
11085 | #+BEGIN and #+END blocks. For instance: | |
4009494e GM |
11086 | |
11087 | @example | |
271672fa BG |
11088 | #+BEGIN_ASIDE |
11089 | Lorem ipsum | |
11090 | #+END_ASIDE | |
4009494e GM |
11091 | @end example |
11092 | ||
271672fa BG |
11093 | Will export to: |
11094 | ||
11095 | @example | |
11096 | <aside> | |
11097 | <p>Lorem ipsum</p> | |
11098 | </aside> | |
11099 | @end example | |
11100 | ||
11101 | While this: | |
11102 | ||
11103 | @example | |
11104 | #+ATTR_HTML: :controls controls :width 350 | |
11105 | #+BEGIN_VIDEO | |
11106 | #+HTML: <source src="movie.mp4" type="video/mp4"> | |
11107 | #+HTML: <source src="movie.ogg" type="video/ogg"> | |
11108 | Your browser does not support the video tag. | |
11109 | #+END_VIDEO | |
11110 | @end example | |
11111 | ||
11112 | Becomes: | |
11113 | ||
11114 | @example | |
11115 | <video controls="controls" width="350"> | |
11116 | <source src="movie.mp4" type="video/mp4"> | |
11117 | <source src="movie.ogg" type="video/ogg"> | |
11118 | <p>Your browser does not support the video tag.</p> | |
11119 | </video> | |
11120 | @end example | |
11121 | ||
11122 | Special blocks that do not correspond to HTML5 elements (see | |
3c8b09ca BG |
11123 | @code{org-html-html5-elements}) will revert to the usual behavior, i.e., |
11124 | @code{#+BEGIN_LEDERHOSEN} will still export to @samp{<div class="lederhosen">}. | |
4009494e | 11125 | |
271672fa | 11126 | Headlines cannot appear within special blocks. To wrap a headline and its |
3c8b09ca BG |
11127 | contents in e.g., @samp{<section>} or @samp{<article>} tags, set the |
11128 | @code{HTML_CONTAINER} property on the headline itself. | |
ce57c2fe | 11129 | |
271672fa | 11130 | @node HTML preamble and postamble, Quoting HTML tags, HTML doctypes, HTML export |
ce57c2fe | 11131 | @subsection HTML preamble and postamble |
271672fa BG |
11132 | @vindex org-html-preamble |
11133 | @vindex org-html-postamble | |
11134 | @vindex org-html-preamble-format | |
11135 | @vindex org-html-postamble-format | |
11136 | @vindex org-html-validation-link | |
11137 | @vindex org-export-creator-string | |
ce57c2fe BG |
11138 | @vindex org-export-time-stamp-file |
11139 | ||
11140 | The HTML exporter lets you define a preamble and a postamble. | |
11141 | ||
271672fa BG |
11142 | The default value for @code{org-html-preamble} is @code{t}, which means |
11143 | that the preamble is inserted depending on the relevant format string in | |
11144 | @code{org-html-preamble-format}. | |
11145 | ||
11146 | Setting @code{org-html-preamble} to a string will override the default format | |
11147 | string. If you set it to a function, it will insert the output of the | |
11148 | function, which must be a string. Setting to @code{nil} will not insert any | |
11149 | preamble. | |
11150 | ||
11151 | The default value for @code{org-html-postamble} is @code{'auto}, which means | |
11152 | that the HTML exporter will look for information about the author, the email, | |
11153 | the creator and the date, and build the postamble from these values. Setting | |
11154 | @code{org-html-postamble} to @code{t} will insert the postamble from the | |
11155 | relevant format string found in @code{org-html-postamble-format}. Setting it | |
11156 | to @code{nil} will not insert any postamble. | |
ce57c2fe BG |
11157 | |
11158 | @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export | |
4009494e GM |
11159 | @subsection Quoting HTML tags |
11160 | ||
11161 | Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
271672fa BG |
11162 | @samp{>} in HTML export. If you want to include raw HTML code, which |
11163 | should only appear in HTML export, mark it with @samp{@@@@html:} as in | |
11164 | @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML | |
11165 | that should be copied verbatim to the exported file use either | |
4009494e | 11166 | |
c8d0cf5c CD |
11167 | @cindex #+HTML |
11168 | @cindex #+BEGIN_HTML | |
4009494e GM |
11169 | @example |
11170 | #+HTML: Literal HTML code for export | |
11171 | @end example | |
11172 | ||
11173 | @noindent or | |
b349f79f | 11174 | @cindex #+BEGIN_HTML |
4009494e GM |
11175 | |
11176 | @example | |
11177 | #+BEGIN_HTML | |
11178 | All lines between these markers are exported literally | |
11179 | #+END_HTML | |
11180 | @end example | |
11181 | ||
11182 | ||
a351880d CD |
11183 | @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export |
11184 | @subsection Links in HTML export | |
4009494e GM |
11185 | |
11186 | @cindex links, in HTML export | |
11187 | @cindex internal links, in HTML export | |
11188 | @cindex external links, in HTML export | |
1df7defd | 11189 | Internal links (@pxref{Internal links}) will continue to work in HTML@. This |
c8d0cf5c | 11190 | includes automatic links created by radio targets (@pxref{Radio |
55e0839d CD |
11191 | targets}). Links to external files will still work if the target file is on |
11192 | the same @i{relative} path as the published Org file. Links to other | |
11193 | @file{.org} files will be translated into HTML links under the assumption | |
d1389828 | 11194 | that an HTML version also exists of the linked file, at the same relative |
55e0839d CD |
11195 | path. @samp{id:} links can then be used to jump to specific entries across |
11196 | files. For information related to linking files while publishing them to a | |
11197 | publishing directory see @ref{Publishing links}. | |
4009494e | 11198 | |
44ce9197 | 11199 | If you want to specify attributes for links, you can do so using a special |
a50253cc | 11200 | @code{#+ATTR_HTML} line to define attributes that will be added to the |
c8d0cf5c CD |
11201 | @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title} |
11202 | and @code{style} attributes for a link: | |
44ce9197 | 11203 | |
c8d0cf5c | 11204 | @cindex #+ATTR_HTML |
44ce9197 | 11205 | @example |
271672fa | 11206 | #+ATTR_HTML: :title The Org mode homepage :style color:red; |
c8d0cf5c CD |
11207 | [[http://orgmode.org]] |
11208 | @end example | |
11209 | ||
a351880d | 11210 | @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export |
c8d0cf5c CD |
11211 | @subsection Tables |
11212 | @cindex tables, in HTML | |
271672fa | 11213 | @vindex org-html-table-default-attributes |
c8d0cf5c | 11214 | |
271672fa BG |
11215 | Org mode tables are exported to HTML using the table attributes defined in |
11216 | @code{org-html-table-default-attributes}. The default setting makes tables | |
11217 | without cell borders and frame. If you would like to change this for | |
11218 | individual tables, place something like the following before the table: | |
c8d0cf5c CD |
11219 | |
11220 | @cindex #+CAPTION | |
a351880d | 11221 | @cindex #+ATTR_HTML |
c8d0cf5c CD |
11222 | @example |
11223 | #+CAPTION: This is a table with lines around and between cells | |
271672fa | 11224 | #+ATTR_HTML: :border 2 :rules all :frame border |
44ce9197 CD |
11225 | @end example |
11226 | ||
271672fa BG |
11227 | @vindex org-html-table-row-tags |
11228 | You can also modify the default tags used for each row by setting | |
11229 | @code{org-html-table-row-tags}. See the docstring for an example on | |
11230 | how to use this option. | |
11231 | ||
afe98dfa | 11232 | @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export |
a351880d | 11233 | @subsection Images in HTML export |
4009494e GM |
11234 | |
11235 | @cindex images, inline in HTML | |
11236 | @cindex inlining images in HTML | |
271672fa | 11237 | @vindex org-html-inline-images |
a7808fba | 11238 | HTML export can inline images given as links in the Org file, and |
4009494e | 11239 | it can make an image the clickable part of a link. By |
c8d0cf5c | 11240 | default@footnote{But see the variable |
271672fa | 11241 | @code{org-html-inline-images}.}, images are inlined if a link does |
4009494e GM |
11242 | not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, |
11243 | while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
11244 | @samp{the image} that points to the image. If the description part | |
11245 | itself is a @code{file:} link or a @code{http:} URL pointing to an | |
11246 | image, this image will be inlined and activated so that clicking on the | |
11247 | image will activate the link. For example, to include a thumbnail that | |
11248 | will link to a high resolution version of the image, you could use: | |
11249 | ||
11250 | @example | |
11251 | [[file:highres.jpg][file:thumb.jpg]] | |
11252 | @end example | |
11253 | ||
86fbb8ca | 11254 | If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}. |
a351880d CD |
11255 | In the example below we specify the @code{alt} and @code{title} attributes to |
11256 | support text viewers and accessibility, and align it to the right. | |
c8d0cf5c CD |
11257 | |
11258 | @cindex #+CAPTION | |
a351880d | 11259 | @cindex #+ATTR_HTML |
c8d0cf5c CD |
11260 | @example |
11261 | #+CAPTION: A black cat stalking a spider | |
271672fa | 11262 | #+ATTR_HTML: :alt cat/spider image :title Action! :align right |
c8d0cf5c CD |
11263 | [[./img/a.jpg]] |
11264 | @end example | |
11265 | ||
4009494e | 11266 | @noindent |
ce57c2fe | 11267 | You could use @code{http} addresses just as well. |
4009494e | 11268 | |
afe98dfa CD |
11269 | @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export |
11270 | @subsection Math formatting in HTML export | |
11271 | @cindex MathJax | |
11272 | @cindex dvipng | |
271672fa | 11273 | @cindex imagemagick |
afe98dfa | 11274 | |
e66ba1df | 11275 | @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two |
afe98dfa CD |
11276 | different ways on HTML pages. The default is to use the |
11277 | @uref{http://www.mathjax.org, MathJax system} which should work out of the | |
271672fa | 11278 | box with Org mode installation because @uref{http://orgmode.org} serves |
e66ba1df | 11279 | @file{MathJax} for Org mode users for small applications and for testing |
afe98dfa | 11280 | purposes. @b{If you plan to use this regularly or on pages with significant |
acedf35c CD |
11281 | page views, you should install@footnote{Installation instructions can be |
11282 | found on the MathJax website, see | |
11283 | @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on | |
11284 | your own server in order to limit the load of our server.} To configure | |
271672fa | 11285 | @file{MathJax}, use the variable @code{org-html-mathjax-options} or |
acedf35c | 11286 | insert something like the following into the buffer: |
afe98dfa CD |
11287 | |
11288 | @example | |
271672fa | 11289 | #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js" |
afe98dfa CD |
11290 | @end example |
11291 | ||
11292 | @noindent See the docstring of the variable | |
271672fa | 11293 | @code{org-html-mathjax-options} for the meaning of the parameters in |
afe98dfa CD |
11294 | this line. |
11295 | ||
acedf35c CD |
11296 | If you prefer, you can also request that @LaTeX{} fragments are processed |
11297 | into small images that will be inserted into the browser page. Before the | |
11298 | availability of MathJax, this was the default method for Org files. This | |
271672fa BG |
11299 | method requires that the @file{dvipng} program or @file{imagemagick} suite is |
11300 | available on your system. You can still get this processing with | |
11301 | ||
11302 | @example | |
11303 | #+OPTIONS: tex:dvipng | |
11304 | @end example | |
11305 | ||
11306 | or: | |
afe98dfa CD |
11307 | |
11308 | @example | |
271672fa | 11309 | #+OPTIONS: tex:imagemagick |
afe98dfa CD |
11310 | @end example |
11311 | ||
11312 | @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export | |
a351880d | 11313 | @subsection Text areas in HTML export |
55e0839d CD |
11314 | |
11315 | @cindex text areas, in HTML | |
11316 | An alternative way to publish literal code examples in HTML is to use text | |
11317 | areas, where the example can even be edited before pasting it into an | |
271672fa BG |
11318 | application. It is triggered by @code{:textarea} attribute at an |
11319 | @code{example} or @code{src} block. | |
11320 | ||
11321 | You may also use @code{:height} and @code{:width} attributes to specify the | |
11322 | height and width of the text area, which default to the number of lines in | |
11323 | the example, and 80, respectively. For example | |
55e0839d CD |
11324 | |
11325 | @example | |
271672fa BG |
11326 | #+ATTR_HTML: :textarea t :width 40 |
11327 | #+BEGIN_EXAMPLE | |
86fbb8ca CD |
11328 | (defun org-xor (a b) |
11329 | "Exclusive or." | |
11330 | (if a (not b) b)) | |
55e0839d CD |
11331 | #+END_EXAMPLE |
11332 | @end example | |
11333 | ||
11334 | ||
86fbb8ca | 11335 | @node CSS support, JavaScript support, Text areas in HTML export, HTML export |
4009494e | 11336 | @subsection CSS support |
a7808fba CD |
11337 | @cindex CSS, for HTML export |
11338 | @cindex HTML export, CSS | |
4009494e | 11339 | |
271672fa BG |
11340 | @vindex org-html-todo-kwd-class-prefix |
11341 | @vindex org-html-tag-class-prefix | |
11342 | You can modify the CSS style definitions for the exported file. The HTML | |
11343 | exporter assigns the following special CSS classes@footnote{If the classes on | |
11344 | TODO keywords and tags lead to conflicts, use the variables | |
11345 | @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to | |
11346 | make them unique.} to appropriate parts of the document---your style | |
11347 | specifications may change these, in addition to any of the standard classes | |
11348 | like for headlines, tables, etc. | |
c8d0cf5c CD |
11349 | @example |
11350 | p.author @r{author information, including email} | |
11351 | p.date @r{publishing date} | |
e66ba1df | 11352 | p.creator @r{creator info, about org mode version} |
c8d0cf5c CD |
11353 | .title @r{document title} |
11354 | .todo @r{TODO keywords, all not-done states} | |
ce57c2fe | 11355 | .done @r{the DONE keywords, all states that count as done} |
c8d0cf5c CD |
11356 | .WAITING @r{each TODO keyword also uses a class named after itself} |
11357 | .timestamp @r{timestamp} | |
11358 | .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} | |
11359 | .timestamp-wrapper @r{span around keyword plus timestamp} | |
11360 | .tag @r{tag in a headline} | |
11361 | ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"} | |
11362 | .target @r{target for links} | |
11363 | .linenr @r{the line number in a code example} | |
11364 | .code-highlighted @r{for highlighting referenced code lines} | |
11365 | div.outline-N @r{div for outline level N (headline plus text))} | |
11366 | div.outline-text-N @r{extra div for text at outline level N} | |
11367 | .section-number-N @r{section number in headlines, different for each level} | |
271672fa BG |
11368 | .figure-number @r{label like "Figure 1:"} |
11369 | .table-number @r{label like "Table 1:"} | |
11370 | .listing-number @r{label like "Listing 1:"} | |
c8d0cf5c CD |
11371 | div.figure @r{how to format an inlined image} |
11372 | pre.src @r{formatted source code} | |
11373 | pre.example @r{normal example} | |
11374 | p.verse @r{verse paragraph} | |
11375 | div.footnotes @r{footnote section headline} | |
11376 | p.footnote @r{footnote definition paragraph, containing a footnote} | |
11377 | .footref @r{a footnote reference number (always a <sup>)} | |
11378 | .footnum @r{footnote number in footnote definition (always <sup>)} | |
11379 | @end example | |
11380 | ||
271672fa BG |
11381 | @vindex org-html-style-default |
11382 | @vindex org-html-head-include-default-style | |
11383 | @vindex org-html-head | |
11384 | @vindex org-html-head-extra | |
11385 | @cindex #+HTML_INCLUDE_STYLE | |
c8d0cf5c | 11386 | Each exported file contains a compact default style that defines these |
e45e3595 | 11387 | classes in a basic way@footnote{This style is defined in the constant |
271672fa | 11388 | @code{org-html-style-default}, which you should not modify. To turn |
e45e3595 | 11389 | inclusion of these defaults off, customize |
271672fa BG |
11390 | @code{org-html-head-include-default-style} or set @code{html-style} to |
11391 | @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or | |
11392 | add to them by using the variables @code{org-html-head} and | |
11393 | @code{org-html-head-extra}. You can override the global values of these | |
11394 | variables for each file by using these keywords: | |
4009494e | 11395 | |
271672fa BG |
11396 | @cindex #+HTML_HEAD |
11397 | @cindex #+HTML_HEAD_EXTRA | |
4009494e | 11398 | @example |
271672fa BG |
11399 | #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> |
11400 | #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> | |
4009494e GM |
11401 | @end example |
11402 | ||
864c9740 | 11403 | @noindent |
e45e3595 CD |
11404 | For longer style definitions, you can use several such lines. You could also |
11405 | directly write a @code{<style>} @code{</style>} section in this way, without | |
11406 | referring to an external file. | |
4009494e | 11407 | |
afe98dfa CD |
11408 | In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:} |
11409 | property to assign a class to the tree. In order to specify CSS styles for a | |
11410 | particular headline, you can use the id specified in a @code{:CUSTOM_ID:} | |
11411 | property. | |
11412 | ||
4009494e GM |
11413 | @c FIXME: More about header and footer styles |
11414 | @c FIXME: Talk about links and targets. | |
11415 | ||
86fbb8ca CD |
11416 | @node JavaScript support, , CSS support, HTML export |
11417 | @subsection JavaScript supported display of web pages | |
a7808fba | 11418 | |
c8d0cf5c CD |
11419 | @cindex Rose, Sebastian |
11420 | Sebastian Rose has written a JavaScript program especially designed to | |
a7808fba | 11421 | enhance the web viewing experience of HTML files created with Org. This |
55e0839d CD |
11422 | program allows you to view large files in two different ways. The first one |
11423 | is an @emph{Info}-like mode where each section is displayed separately and | |
a7808fba CD |
11424 | navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys |
11425 | as well, press @kbd{?} for an overview of the available keys). The second | |
55e0839d CD |
11426 | view type is a @emph{folding} view much like Org provides inside Emacs. The |
11427 | script is available at @url{http://orgmode.org/org-info.js} and you can find | |
11428 | the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}. | |
271672fa BG |
11429 | We host the script at our site, but if you use it a lot, you might not want |
11430 | to be dependent on @url{http://orgmode.org} and prefer to install a local | |
55e0839d | 11431 | copy on your own web server. |
a7808fba | 11432 | |
271672fa BG |
11433 | All it then takes to use this program is adding a single line to the Org |
11434 | file: | |
a7808fba | 11435 | |
c8d0cf5c | 11436 | @cindex #+INFOJS_OPT |
a7808fba | 11437 | @example |
b349f79f | 11438 | #+INFOJS_OPT: view:info toc:nil |
a7808fba CD |
11439 | @end example |
11440 | ||
11441 | @noindent | |
11442 | If this line is found, the HTML header will automatically contain the code | |
11443 | needed to invoke the script. Using the line above, you can set the following | |
11444 | viewing options: | |
11445 | ||
11446 | @example | |
11447 | path: @r{The path to the script. The default is to grab the script from} | |
11448 | @r{@url{http://orgmode.org/org-info.js}, but you might want to have} | |
11449 | @r{a local copy and use a path like @samp{../scripts/org-info.js}.} | |
8223b1d2 | 11450 | view: @r{Initial view when the website is first shown. Possible values are:} |
a7808fba CD |
11451 | info @r{Info-like interface with one section per page.} |
11452 | overview @r{Folding interface, initially showing only top-level.} | |
11453 | content @r{Folding interface, starting with all headlines visible.} | |
11454 | showall @r{Folding interface, all headlines and text visible.} | |
11455 | sdepth: @r{Maximum headline level that will still become an independent} | |
11456 | @r{section for info and folding modes. The default is taken from} | |
7006d207 CD |
11457 | @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} |
11458 | @r{If this is smaller than in @code{org-export-headline-levels}, each} | |
c8d0cf5c | 11459 | @r{info/folding section can still contain child headlines.} |
acedf35c | 11460 | toc: @r{Should the table of contents @emph{initially} be visible?} |
c8d0cf5c | 11461 | @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.} |
a7808fba | 11462 | tdepth: @r{The depth of the table of contents. The defaults are taken from} |
7006d207 | 11463 | @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.} |
acedf35c | 11464 | ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?} |
b349f79f | 11465 | @r{If yes, the toc will never be displayed as a section.} |
a7808fba | 11466 | ltoc: @r{Should there be short contents (children) in each section?} |
c8d0cf5c | 11467 | @r{Make this @code{above} if the section should be above initial text.} |
a7808fba CD |
11468 | mouse: @r{Headings are highlighted when the mouse is over them. Should be} |
11469 | @r{@samp{underline} (default) or a background color like @samp{#cccccc}.} | |
11470 | buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the} | |
11471 | @r{default), only one such button will be present.} | |
11472 | @end example | |
c8d0cf5c | 11473 | @noindent |
271672fa BG |
11474 | @vindex org-html-infojs-options |
11475 | @vindex org-html-use-infojs | |
a7808fba | 11476 | You can choose default values for these options by customizing the variable |
271672fa BG |
11477 | @code{org-html-infojs-options}. If you always want to apply the script to your |
11478 | pages, configure the variable @code{org-html-use-infojs}. | |
a7808fba | 11479 | |
271672fa | 11480 | @node @LaTeX{} and PDF export, Markdown export, HTML export, Exporting |
acedf35c CD |
11481 | @section @LaTeX{} and PDF export |
11482 | @cindex @LaTeX{} export | |
71d35b24 | 11483 | @cindex PDF export |
271672fa BG |
11484 | |
11485 | @LaTeX{} export can produce an arbitrarily complex LaTeX document of any | |
11486 | standard or custom document class. With further processing@footnote{The | |
11487 | default @LaTeX{} output is designed for processing with @code{pdftex} or | |
11488 | @LaTeX{}. It includes packages that are not compatible with @code{xetex} and | |
11489 | possibly @code{luatex}. The @LaTeX{} exporter can be configured to support | |
11490 | alternative TeX engines, see the options | |
11491 | @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.}, | |
11492 | which the @LaTeX{} exporter is able to control, this back-end is able to | |
11493 | produce PDF output. Because the @LaTeX{} exporter can be configured to use | |
11494 | the @code{hyperref} package, the default setup produces fully-linked PDF | |
11495 | output. | |
11496 | ||
11497 | As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph | |
11498 | will not be started if two contiguous syntactical elements are not separated | |
11499 | by an empty line. | |
11500 | ||
11501 | This back-end also offers enhanced support for footnotes. Thus, it handles | |
11502 | nested footnotes, footnotes in tables and footnotes in a list item's | |
11503 | description. | |
4009494e GM |
11504 | |
11505 | @menu | |
271672fa | 11506 | * @LaTeX{} export commands:: How to export to LaTeX and PDF |
c0468714 | 11507 | * Header and sectioning:: Setting up the export file structure |
e66ba1df | 11508 | * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code |
271672fa | 11509 | * @LaTeX{} specific attributes:: Controlling @LaTeX{} output |
4009494e GM |
11510 | @end menu |
11511 | ||
271672fa | 11512 | @node @LaTeX{} export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export |
acedf35c | 11513 | @subsection @LaTeX{} export commands |
4009494e GM |
11514 | |
11515 | @table @kbd | |
271672fa BG |
11516 | @orgcmd{C-c C-e l l,org-latex-export-to-latex} |
11517 | Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{} | |
11518 | file will be @file{myfile.tex}. The file will be overwritten without | |
11519 | warning. | |
11520 | @orgcmd{C-c C-e l L,org-latex-export-as-latex} | |
acedf35c | 11521 | Export to a temporary buffer. Do not create a file. |
271672fa | 11522 | @orgcmd{C-c C-e l p,org-latex-export-to-pdf} |
acedf35c | 11523 | Export as @LaTeX{} and then process to PDF. |
271672fa | 11524 | @item C-c C-e l o |
acedf35c | 11525 | Export as @LaTeX{} and then process to PDF, then open the resulting PDF file. |
4009494e GM |
11526 | @end table |
11527 | ||
271672fa | 11528 | @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{} export commands, @LaTeX{} and PDF export |
ed21c5c8 | 11529 | @subsection Header and sectioning structure |
acedf35c CD |
11530 | @cindex @LaTeX{} class |
11531 | @cindex @LaTeX{} sectioning structure | |
11532 | @cindex @LaTeX{} header | |
e66ba1df BG |
11533 | @cindex header, for @LaTeX{} files |
11534 | @cindex sectioning structure, for @LaTeX{} export | |
ed21c5c8 | 11535 | |
271672fa BG |
11536 | By default, the first three outline levels become headlines, defining a |
11537 | general document structure. Additional levels are exported as @code{itemize} | |
11538 | or @code{enumerate} lists. The transition can also occur at a different | |
11539 | level (@pxref{Export settings}). | |
11540 | ||
acedf35c | 11541 | By default, the @LaTeX{} output uses the class @code{article}. |
ed21c5c8 | 11542 | |
271672fa BG |
11543 | @vindex org-latex-default-class |
11544 | @vindex org-latex-classes | |
11545 | @vindex org-latex-default-packages-alist | |
11546 | @vindex org-latex-packages-alist | |
ed21c5c8 | 11547 | You can change this globally by setting a different value for |
271672fa BG |
11548 | @code{org-latex-default-class} or locally by adding an option like |
11549 | @code{#+LATEX_CLASS: myclass} in your file, or with | |
11550 | a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region | |
11551 | containing only this (sub)tree. The class must be listed in | |
11552 | @code{org-latex-classes}. This variable defines a header template for each | |
11553 | class@footnote{Into which the values of | |
11554 | @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist} | |
11555 | are spliced.}, and allows you to define the sectioning structure for each | |
11556 | class. You can also define your own classes there. | |
11557 | ||
11558 | @cindex #+LATEX_CLASS | |
11559 | @cindex #+LATEX_CLASS_OPTIONS | |
11560 | @cindex property, EXPORT_LATEX_CLASS | |
11561 | @cindex property, EXPORT_LATEX_CLASS_OPTIONS | |
11562 | The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS} | |
11563 | property can specify the options for the @code{\documentclass} macro. These | |
11564 | options have to be provided, as expected by @LaTeX{}, within square brackets. | |
11565 | ||
11566 | @cindex #+LATEX_HEADER | |
11567 | @cindex #+LATEX_HEADER_EXTRA | |
11568 | You can also use the @code{LATEX_HEADER} and | |
11569 | @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents | |
11570 | from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing | |
11571 | @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order | |
11572 | to add lines to the header. See the docstring of @code{org-latex-classes} for | |
11573 | more information. | |
11574 | ||
11575 | An example is shown below. | |
11576 | ||
11577 | @example | |
11578 | #+LATEX_CLASS: article | |
11579 | #+LATEX_CLASS_OPTIONS: [a4paper] | |
11580 | #+LATEX_HEADER: \usepackage@{xyz@} | |
8223b1d2 BG |
11581 | |
11582 | * Headline 1 | |
11583 | some text | |
11584 | @end example | |
ed21c5c8 | 11585 | |
271672fa | 11586 | @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export |
acedf35c | 11587 | @subsection Quoting @LaTeX{} code |
4009494e | 11588 | |
e66ba1df | 11589 | Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly |
271672fa BG |
11590 | inserted into the @LaTeX{} file. Furthermore, you can add special code that |
11591 | should only be present in @LaTeX{} export with the following constructs: | |
4009494e | 11592 | |
271672fa BG |
11593 | @cindex #+LATEX |
11594 | @cindex #+BEGIN_LATEX | |
4009494e | 11595 | @example |
271672fa | 11596 | Code within @@@@latex:some code@@@@ a paragraph. |
4009494e | 11597 | |
271672fa | 11598 | #+LATEX: Literal @LaTeX{} code for export |
4009494e | 11599 | |
271672fa | 11600 | #+BEGIN_LATEX |
4009494e | 11601 | All lines between these markers are exported literally |
271672fa | 11602 | #+END_LATEX |
4009494e | 11603 | @end example |
dbc28aaa | 11604 | |
271672fa BG |
11605 | @node @LaTeX{} specific attributes, , Quoting @LaTeX{} code, @LaTeX{} and PDF export |
11606 | @subsection @LaTeX{} specific attributes | |
11607 | @cindex #+ATTR_LATEX | |
dbc28aaa | 11608 | |
271672fa BG |
11609 | @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They |
11610 | affect tables, images, plain lists, special blocks and source blocks. | |
11611 | ||
11612 | @subsubheading Tables in @LaTeX{} export | |
acedf35c | 11613 | @cindex tables, in @LaTeX{} export |
67df9cfb | 11614 | |
271672fa BG |
11615 | For @LaTeX{} export of a table, you can specify a label and a caption |
11616 | (@pxref{Images and tables}). You can also use attributes to control table | |
11617 | layout and contents. Valid @LaTeX{} attributes include: | |
11618 | ||
11619 | @table @code | |
11620 | @item :mode | |
11621 | @vindex org-latex-default-table-mode | |
11622 | Nature of table's contents. It can be set to @code{table}, @code{math}, | |
11623 | @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or | |
11624 | @code{inline-math} mode, every cell is exported as-is, horizontal rules are | |
11625 | ignored and the table will be wrapped in a math environment. Also, | |
11626 | contiguous tables sharing the same math mode will be wrapped within the same | |
11627 | environment. Default mode is determined in | |
11628 | @code{org-latex-default-table-mode}. | |
11629 | @item :environment | |
11630 | @vindex org-latex-default-table-environment | |
11631 | Environment used for the table. It can be set to any @LaTeX{} table | |
11632 | environment, like @code{tabularx}@footnote{Requires adding the | |
11633 | @code{tabularx} package to @code{org-latex-packages-alist}.}, | |
11634 | @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the | |
11635 | @code{tabu} package to @code{org-latex-packages-alist}.}, | |
11636 | @code{bmatrix}@enddots{} It defaults to | |
11637 | @code{org-latex-default-table-environment} value. | |
11638 | @item :caption | |
11639 | @code{#+CAPTION} keyword is the simplest way to set a caption for a table | |
11640 | (@pxref{Images and tables}). If you need more advanced commands for that | |
11641 | task, you can use @code{:caption} attribute instead. Its value should be raw | |
11642 | @LaTeX{} code. It has precedence over @code{#+CAPTION}. | |
11643 | @item :float | |
11644 | @itemx :placement | |
11645 | Float environment for the table. Possible values are @code{sidewaystable}, | |
11646 | @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with | |
11647 | a caption will have a @code{table} environment. Moreover, @code{:placement} | |
11648 | attribute can specify the positioning of the float. | |
11649 | @item :align | |
11650 | @itemx :font | |
11651 | @itemx :width | |
11652 | Set, respectively, the alignment string of the table, its font size and its | |
11653 | width. They only apply on regular tables. | |
11654 | @item :spread | |
11655 | Boolean specific to the @code{tabu} and @code{longtabu} environments, and | |
11656 | only takes effect when used in conjunction with the @code{:width} attribute. | |
11657 | When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the | |
11658 | value of @code{:width}. | |
11659 | @item :booktabs | |
11660 | @itemx :center | |
11661 | @itemx :rmlines | |
11662 | @vindex org-latex-tables-booktabs | |
11663 | @vindex org-latex-tables-centered | |
11664 | They toggle, respectively, @code{booktabs} usage (assuming the package is | |
11665 | properly loaded), table centering and removal of every horizontal rule but | |
11666 | the first one (in a "table.el" table only). In particular, | |
11667 | @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered}) | |
11668 | activates the first (respectively second) attribute globally. | |
11669 | @item :math-prefix | |
11670 | @itemx :math-suffix | |
11671 | @itemx :math-arguments | |
11672 | A string that will be inserted, respectively, before the table within the | |
11673 | math environment, after the table within the math environment, and between | |
11674 | the macro name and the contents of the table. The @code{:math-arguments} | |
11675 | attribute is used for matrix macros that require more than one argument | |
11676 | (e.g., @code{qbordermatrix}). | |
11677 | @end table | |
11678 | ||
11679 | Thus, attributes can be used in a wide array of situations, like writing | |
11680 | a table that will span over multiple pages, or a matrix product: | |
67df9cfb CD |
11681 | |
11682 | @example | |
271672fa | 11683 | #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l |
67df9cfb CD |
11684 | | ..... | ..... | |
11685 | | ..... | ..... | | |
271672fa BG |
11686 | |
11687 | #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times | |
11688 | | a | b | | |
11689 | | c | d | | |
11690 | #+ATTR_LATEX: :mode math :environment bmatrix | |
11691 | | 1 | 2 | | |
11692 | | 3 | 4 | | |
67df9cfb CD |
11693 | @end example |
11694 | ||
271672fa BG |
11695 | In the example below, @LaTeX{} command |
11696 | @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption. | |
ce57c2fe | 11697 | |
ce57c2fe | 11698 | @example |
271672fa | 11699 | #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@} |
ce57c2fe BG |
11700 | | ..... | ..... | |
11701 | | ..... | ..... | | |
11702 | @end example | |
67df9cfb | 11703 | |
271672fa BG |
11704 | |
11705 | @subsubheading Images in @LaTeX{} export | |
acedf35c CD |
11706 | @cindex images, inline in @LaTeX{} |
11707 | @cindex inlining images in @LaTeX{} | |
67df9cfb CD |
11708 | |
11709 | Images that are linked to without a description part in the link, like | |
11710 | @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF | |
acedf35c | 11711 | output file resulting from @LaTeX{} processing. Org will use an |
271672fa BG |
11712 | @code{\includegraphics} macro to insert the image@footnote{In the case of |
11713 | TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an | |
11714 | @code{\input} macro wrapped within a @code{tikzpicture} environment.}. | |
11715 | ||
11716 | You can specify specify image width or height with, respectively, | |
11717 | @code{:width} and @code{:height} attributes. It is also possible to add any | |
11718 | other option with the @code{:options} attribute, as shown in the following | |
11719 | example: | |
67df9cfb CD |
11720 | |
11721 | @example | |
271672fa | 11722 | #+ATTR_LATEX: :width 5cm :options angle=90 |
67df9cfb CD |
11723 | [[./img/sed-hr4049.pdf]] |
11724 | @end example | |
11725 | ||
271672fa BG |
11726 | If you need a specific command for the caption, use @code{:caption} |
11727 | attribute. It will override standard @code{#+CAPTION} value, if any. | |
ce57c2fe | 11728 | |
271672fa BG |
11729 | @example |
11730 | #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@} | |
11731 | [[./img/sed-hr4049.pdf]] | |
11732 | @end example | |
ed21c5c8 | 11733 | |
271672fa BG |
11734 | If you have specified a caption as described in @ref{Images and tables}, the |
11735 | picture will be wrapped into a @code{figure} environment and thus become | |
11736 | a floating element. You can also ask Org to export an image as a float | |
11737 | without specifying caption by setting the @code{:float} attribute. You may | |
11738 | also set it to: | |
11739 | @itemize @minus | |
11740 | @item | |
11741 | @code{t}: if you want to use the standard @samp{figure} environment. It is | |
11742 | used by default if you provide a caption to the image. | |
11743 | @item | |
11744 | @code{multicolumn}: if you wish to include an image which spans multiple | |
11745 | columns in a page. This will export the image wrapped in a @code{figure*} | |
acedf35c | 11746 | environment. |
271672fa BG |
11747 | @item |
11748 | @code{wrap}: if you would like to let text flow around the image. It will | |
11749 | make the figure occupy the left half of the page. | |
11750 | @item | |
11751 | @code{nil}: if you need to avoid any floating environment, even when | |
11752 | a caption is provided. | |
11753 | @end itemize | |
11754 | @noindent | |
11755 | To modify the placement option of any floating environment, set the | |
11756 | @code{placement} attribute. | |
ed21c5c8 CD |
11757 | |
11758 | @example | |
271672fa BG |
11759 | #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@} |
11760 | [[./img/hst.png]] | |
ed21c5c8 CD |
11761 | @end example |
11762 | ||
271672fa BG |
11763 | If the @code{:comment-include} attribute is set to a non-@code{nil} value, |
11764 | the @LaTeX{} @code{\includegraphics} macro will be commented out. | |
ed21c5c8 | 11765 | |
271672fa BG |
11766 | @subsubheading Plain lists in @LaTeX{} export |
11767 | @cindex plain lists, in @LaTeX{} export | |
c8d0cf5c | 11768 | |
271672fa BG |
11769 | Plain lists accept two optional attributes: @code{:environment} and |
11770 | @code{:options}. The first one allows the use of a non-standard | |
11771 | environment (e.g., @samp{inparaenum}). The second one specifies | |
11772 | optional arguments for that environment (square brackets may be | |
11773 | omitted). | |
c8d0cf5c | 11774 | |
271672fa BG |
11775 | @example |
11776 | #+ATTR_LATEX: :environment compactitem :options $\circ$ | |
11777 | - you need ``paralist'' package to reproduce this example. | |
11778 | @end example | |
c8d0cf5c | 11779 | |
271672fa BG |
11780 | @subsubheading Source blocks in @LaTeX{} export |
11781 | @cindex source blocks, in @LaTeX{} export | |
c8d0cf5c | 11782 | |
271672fa BG |
11783 | In addition to syntax defined in @ref{Literal examples}, names and captions |
11784 | (@pxref{Images and tables}), source blocks also accept a @code{:float} | |
11785 | attribute. You may set it to: | |
11786 | @itemize @minus | |
11787 | @item | |
11788 | @code{t}: if you want to make the source block a float. It is the default | |
11789 | value when a caption is provided. | |
11790 | @item | |
d1389828 PE |
11791 | @code{multicolumn}: if you wish to include a source block which spans multiple |
11792 | columns in a page. | |
271672fa | 11793 | @item |
d1389828 | 11794 | @code{nil}: if you need to avoid any floating environment, even when a caption |
271672fa BG |
11795 | is provided. It is useful for source code that may not fit in a single page. |
11796 | @end itemize | |
c8d0cf5c | 11797 | |
271672fa BG |
11798 | @example |
11799 | #+ATTR_LATEX: :float nil | |
11800 | #+BEGIN_SRC emacs-lisp | |
11801 | Code that may not fit in a single page. | |
11802 | #+END_SRC | |
11803 | @end example | |
c8d0cf5c | 11804 | |
271672fa BG |
11805 | @subsubheading Special blocks in @LaTeX{} export |
11806 | @cindex special blocks, in @LaTeX{} export | |
3c8b09ca BG |
11807 | @cindex abstract, in @LaTeX{} export |
11808 | @cindex proof, in @LaTeX{} export | |
c8d0cf5c | 11809 | |
271672fa BG |
11810 | In @LaTeX{} back-end, special blocks become environments of the same name. |
11811 | Value of @code{:options} attribute will be appended as-is to that | |
11812 | environment's opening string. For example: | |
c8d0cf5c | 11813 | |
c8d0cf5c | 11814 | @example |
3c8b09ca BG |
11815 | #+BEGIN_ABSTRACT |
11816 | We demonstrate how to solve the Syracuse problem. | |
11817 | #+END_ABSTRACT | |
11818 | ||
271672fa BG |
11819 | #+ATTR_LATEX: :options [Proof of important theorem] |
11820 | #+BEGIN_PROOF | |
11821 | ... | |
11822 | Therefore, any even number greater than 2 is the sum of two primes. | |
11823 | #+END_PROOF | |
c8d0cf5c CD |
11824 | @end example |
11825 | ||
271672fa BG |
11826 | @noindent |
11827 | becomes | |
c8d0cf5c CD |
11828 | |
11829 | @example | |
3c8b09ca BG |
11830 | \begin@{abstract@} |
11831 | We demonstrate how to solve the Syracuse problem. | |
11832 | \end@{abstract@} | |
11833 | ||
271672fa BG |
11834 | \begin@{proof@}[Proof of important theorem] |
11835 | ... | |
11836 | Therefore, any even number greater than 2 is the sum of two primes. | |
11837 | \end@{proof@} | |
c8d0cf5c CD |
11838 | @end example |
11839 | ||
271672fa BG |
11840 | If you need to insert a specific caption command, use @code{:caption} |
11841 | attribute. It will override standard @code{#+CAPTION} value, if any. For | |
11842 | example: | |
c8d0cf5c CD |
11843 | |
11844 | @example | |
271672fa BG |
11845 | #+ATTR_LATEX: :caption \MyCaption@{HeadingA@} |
11846 | #+BEGIN_PROOF | |
11847 | ... | |
11848 | #+END_PROOF | |
c8d0cf5c CD |
11849 | @end example |
11850 | ||
271672fa BG |
11851 | @subsubheading Horizontal rules |
11852 | @cindex horizontal rules, in @LaTeX{} export | |
c8d0cf5c | 11853 | |
271672fa BG |
11854 | Width and thickness of a given horizontal rule can be controlled with, |
11855 | respectively, @code{:width} and @code{:thickness} attributes: | |
c8d0cf5c | 11856 | |
c8d0cf5c | 11857 | @example |
271672fa BG |
11858 | #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt |
11859 | ----- | |
c8d0cf5c CD |
11860 | @end example |
11861 | ||
271672fa BG |
11862 | @node Markdown export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting |
11863 | @section Markdown export | |
11864 | @cindex Markdown export | |
c8d0cf5c | 11865 | |
d1389828 | 11866 | @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor, |
271672fa BG |
11867 | as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org |
11868 | mode buffer. | |
c8d0cf5c | 11869 | |
271672fa BG |
11870 | It is built over HTML back-end: any construct not supported by Markdown |
11871 | syntax (e.g., tables) will be controlled and translated by @code{html} | |
11872 | back-end (@pxref{HTML export}). | |
c8d0cf5c | 11873 | |
271672fa | 11874 | @subheading Markdown export commands |
c8d0cf5c | 11875 | |
271672fa BG |
11876 | @table @kbd |
11877 | @orgcmd{C-c C-e m m,org-md-export-to-markdown} | |
11878 | Export as a text file written in Markdown syntax. For an Org file, | |
11879 | @file{myfile.org}, the resulting file will be @file{myfile.md}. The file | |
11880 | will be overwritten without warning. | |
11881 | @orgcmd{C-c C-e m M,org-md-export-as-markdown} | |
11882 | Export to a temporary buffer. Do not create a file. | |
11883 | @item C-c C-e m o | |
11884 | Export as a text file with Markdown syntax, then open it. | |
11885 | @end table | |
11886 | ||
11887 | @subheading Header and sectioning structure | |
11888 | ||
11889 | @vindex org-md-headline-style | |
11890 | Markdown export can generate both @code{atx} and @code{setext} types for | |
11891 | headlines, according to @code{org-md-headline-style}. The former introduces | |
11892 | a hard limit of two levels, whereas the latter pushes it to six. Headlines | |
11893 | below that limit are exported as lists. You can also set a soft limit before | |
11894 | that one (@pxref{Export settings}). | |
c8d0cf5c | 11895 | |
ce57c2fe BG |
11896 | @c begin opendocument |
11897 | ||
3c8b09ca | 11898 | @node OpenDocument Text export, Org export, Markdown export, Exporting |
e66ba1df | 11899 | @section OpenDocument Text export |
e66ba1df BG |
11900 | @cindex ODT |
11901 | @cindex OpenDocument | |
11902 | @cindex export, OpenDocument | |
11903 | @cindex LibreOffice | |
e66ba1df | 11904 | |
271672fa BG |
11905 | Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text |
11906 | (ODT) format. Documents created by this exporter use the | |
11907 | @cite{OpenDocument-v1.2 | |
e66ba1df BG |
11908 | specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, |
11909 | Open Document Format for Office Applications (OpenDocument) Version 1.2}} and | |
11910 | are compatible with LibreOffice 3.4. | |
ce57c2fe BG |
11911 | |
11912 | @menu | |
153ae947 BG |
11913 | * Pre-requisites for ODT export:: What packages ODT exporter relies on |
11914 | * ODT export commands:: How to invoke ODT export | |
11915 | * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files | |
e66ba1df | 11916 | * Applying custom styles:: How to apply custom styles to the output |
153ae947 BG |
11917 | * Links in ODT export:: How links will be interpreted and formatted |
11918 | * Tables in ODT export:: How Tables are exported | |
11919 | * Images in ODT export:: How to insert images | |
11920 | * Math formatting in ODT export:: How @LaTeX{} fragments are formatted | |
11921 | * Labels and captions in ODT export:: How captions are rendered | |
11922 | * Literal examples in ODT export:: How source and example blocks are formatted | |
11923 | * Advanced topics in ODT export:: Read this if you are a power user | |
ce57c2fe BG |
11924 | @end menu |
11925 | ||
153ae947 BG |
11926 | @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export |
11927 | @subsection Pre-requisites for ODT export | |
e66ba1df | 11928 | @cindex zip |
153ae947 | 11929 | The ODT exporter relies on the @file{zip} program to create the final |
e66ba1df BG |
11930 | output. Check the availability of this program before proceeding further. |
11931 | ||
153ae947 BG |
11932 | @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export |
11933 | @subsection ODT export commands | |
e66ba1df | 11934 | |
153ae947 | 11935 | @subsubheading Exporting to ODT |
e66ba1df | 11936 | @anchor{x-export-to-odt} |
ce57c2fe BG |
11937 | |
11938 | @cindex region, active | |
11939 | @cindex active region | |
11940 | @cindex transient-mark-mode | |
11941 | @table @kbd | |
271672fa | 11942 | @orgcmd{C-c C-e o o,org-odt-export-to-odt} |
ce57c2fe | 11943 | @cindex property EXPORT_FILE_NAME |
e66ba1df BG |
11944 | |
11945 | Export as OpenDocument Text file. | |
153ae947 | 11946 | |
271672fa BG |
11947 | @vindex org-odt-preferred-output-format |
11948 | If @code{org-odt-preferred-output-format} is specified, automatically convert | |
11949 | the exported file to that format. @xref{x-export-to-other-formats, , | |
153ae947 | 11950 | Automatically exporting to other formats}. |
e66ba1df | 11951 | |
153ae947 | 11952 | For an Org file @file{myfile.org}, the ODT file will be |
e66ba1df BG |
11953 | @file{myfile.odt}. The file will be overwritten without warning. If there |
11954 | is an active region,@footnote{This requires @code{transient-mark-mode} to be | |
11955 | turned on} only the region will be exported. If the selected region is a | |
11956 | single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the | |
11957 | tree head will become the document title. If the tree head entry has, or | |
11958 | inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the | |
11959 | export. | |
11960 | ||
271672fa | 11961 | @kbd{C-c C-e o O} |
8223b1d2 | 11962 | Export as an OpenDocument Text file and open the resulting file. |
153ae947 | 11963 | |
271672fa BG |
11964 | @vindex org-odt-preferred-output-format |
11965 | If @code{org-odt-preferred-output-format} is specified, open the converted | |
11966 | file instead. @xref{x-export-to-other-formats, , Automatically exporting to | |
11967 | other formats}. | |
ce57c2fe BG |
11968 | @end table |
11969 | ||
153ae947 BG |
11970 | @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export |
11971 | @subsection Extending ODT export | |
11972 | ||
11973 | The ODT exporter can interface with a variety of document | |
11974 | converters and supports popular converters out of the box. As a result, you | |
11975 | can use it to export to formats like @samp{doc} or convert a document from | |
11976 | one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}). | |
11977 | ||
11978 | @cindex @file{unoconv} | |
11979 | @cindex LibreOffice | |
11980 | If you have a working installation of LibreOffice, a document converter is | |
11981 | pre-configured for you and you can use it right away. If you would like to | |
11982 | use @file{unoconv} as your preferred converter, customize the variable | |
271672fa | 11983 | @code{org-odt-convert-process} to point to @code{unoconv}. You can |
801a68c8 BG |
11984 | also use your own favorite converter or tweak the default settings of the |
11985 | @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a | |
11986 | document converter}. | |
153ae947 BG |
11987 | |
11988 | @subsubsection Automatically exporting to other formats | |
e66ba1df | 11989 | @anchor{x-export-to-other-formats} |
153ae947 | 11990 | |
271672fa | 11991 | @vindex org-odt-preferred-output-format |
153ae947 BG |
11992 | Very often, you will find yourself exporting to ODT format, only to |
11993 | immediately save the exported document to other formats like @samp{doc}, | |
11994 | @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your | |
e66ba1df | 11995 | preferred output format by customizing the variable |
271672fa | 11996 | @code{org-odt-preferred-output-format}. This way, the export commands |
153ae947 BG |
11997 | (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a |
11998 | format that is of immediate interest to you. | |
11999 | ||
12000 | @subsubsection Converting between document formats | |
12001 | @anchor{x-convert-to-other-formats} | |
12002 | ||
12003 | There are many document converters in the wild which support conversion to | |
12004 | and from various file formats, including, but not limited to the | |
12005 | ODT format. LibreOffice converter, mentioned above, is one such | |
12006 | converter. Once a converter is configured, you can interact with it using | |
12007 | the following command. | |
e66ba1df | 12008 | |
271672fa | 12009 | @vindex org-odt-convert |
153ae947 BG |
12010 | @table @kbd |
12011 | ||
271672fa | 12012 | @item M-x org-odt-convert RET |
153ae947 BG |
12013 | Convert an existing document from one format to another. With a prefix |
12014 | argument, also open the newly produced file. | |
12015 | @end table | |
12016 | ||
12017 | @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export | |
e66ba1df | 12018 | @subsection Applying custom styles |
ce57c2fe BG |
12019 | @cindex styles, custom |
12020 | @cindex template, custom | |
12021 | ||
153ae947 | 12022 | The ODT exporter ships with a set of OpenDocument styles |
e66ba1df BG |
12023 | (@pxref{Working with OpenDocument style files}) that ensure a well-formatted |
12024 | output. These factory styles, however, may not cater to your specific | |
12025 | tastes. To customize the output, you can either modify the above styles | |
12026 | files directly, or generate the required styles using an application like | |
12027 | LibreOffice. The latter method is suitable for expert and non-expert | |
12028 | users alike, and is described here. | |
ce57c2fe | 12029 | |
f99f1641 | 12030 | @subsubsection Applying custom styles: the easy way |
ce57c2fe BG |
12031 | |
12032 | @enumerate | |
12033 | @item | |
e66ba1df | 12034 | Create a sample @file{example.org} file with the below settings and export it |
153ae947 | 12035 | to ODT format. |
e66ba1df BG |
12036 | |
12037 | @example | |
12038 | #+OPTIONS: H:10 num:t | |
12039 | @end example | |
12040 | ||
12041 | @item | |
12042 | Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist} | |
f99f1641 PE |
12043 | to locate the target styles---these typically have the @samp{Org} prefix---and |
12044 | modify those to your taste. Save the modified file either as an | |
e66ba1df BG |
12045 | OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file. |
12046 | ||
ce57c2fe | 12047 | @item |
e66ba1df | 12048 | @cindex #+ODT_STYLES_FILE |
271672fa BG |
12049 | @vindex org-odt-styles-file |
12050 | Customize the variable @code{org-odt-styles-file} and point it to the | |
e66ba1df BG |
12051 | newly created file. For additional configuration options |
12052 | @pxref{x-overriding-factory-styles,,Overriding factory styles}. | |
12053 | ||
12054 | If you would like to choose a style on a per-file basis, you can use the | |
12055 | @code{#+ODT_STYLES_FILE} option. A typical setting will look like | |
12056 | ||
12057 | @example | |
12058 | #+ODT_STYLES_FILE: "/path/to/example.ott" | |
12059 | @end example | |
12060 | ||
12061 | or | |
12062 | ||
12063 | @example | |
12064 | #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png")) | |
12065 | @end example | |
12066 | ||
ce57c2fe BG |
12067 | @end enumerate |
12068 | ||
e66ba1df BG |
12069 | @subsubsection Using third-party styles and templates |
12070 | ||
12071 | You can use third-party styles and templates for customizing your output. | |
12072 | This will produce the desired output only if the template provides all | |
12073 | style names that the @samp{ODT} exporter relies on. Unless this condition is | |
12074 | met, the output is going to be less than satisfactory. So it is highly | |
12075 | recommended that you only work with templates that are directly derived from | |
12076 | the factory settings. | |
12077 | ||
153ae947 BG |
12078 | @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export |
12079 | @subsection Links in ODT export | |
271672fa | 12080 | @cindex links, in ODT export |
e66ba1df | 12081 | |
153ae947 BG |
12082 | ODT exporter creates native cross-references for internal links. It creates |
12083 | Internet-style links for all other links. | |
12084 | ||
12085 | A link with no description and destined to a regular (un-itemized) outline | |
12086 | heading is replaced with a cross-reference and section number of the heading. | |
e66ba1df | 12087 | |
153ae947 | 12088 | A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced |
7bd20f91 | 12089 | with a cross-reference and sequence number of the labeled entity. |
153ae947 BG |
12090 | @xref{Labels and captions in ODT export}. |
12091 | ||
12092 | @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export | |
12093 | @subsection Tables in ODT export | |
271672fa | 12094 | @cindex tables, in ODT export |
ce57c2fe | 12095 | |
e66ba1df | 12096 | Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el} |
f99f1641 PE |
12097 | tables is supported. However, export of complex @file{table.el} tables---tables |
12098 | that have column or row spans---is not supported. Such tables are | |
e66ba1df | 12099 | stripped from the exported document. |
ce57c2fe | 12100 | |
153ae947 BG |
12101 | By default, a table is exported with top and bottom frames and with rules |
12102 | separating row and column groups (@pxref{Column groups}). Furthermore, all | |
12103 | tables are typeset to occupy the same width. If the table specifies | |
12104 | alignment and relative width for its columns (@pxref{Column width and | |
12105 | alignment}) then these are honored on export.@footnote{The column widths are | |
12106 | interpreted as weighted ratios with the default weight being 1} | |
e66ba1df BG |
12107 | |
12108 | @cindex #+ATTR_ODT | |
153ae947 BG |
12109 | You can control the width of the table by specifying @code{:rel-width} |
12110 | property using an @code{#+ATTR_ODT} line. | |
12111 | ||
12112 | For example, consider the following table which makes use of all the rules | |
7bd20f91 | 12113 | mentioned above. |
153ae947 BG |
12114 | |
12115 | @example | |
12116 | #+ATTR_ODT: :rel-width 50 | |
12117 | | Area/Month | Jan | Feb | Mar | Sum | | |
12118 | |---------------+-------+-------+-------+-------| | |
12119 | | / | < | | | < | | |
12120 | | <l13> | <r5> | <r5> | <r5> | <r6> | | |
12121 | | North America | 1 | 21 | 926 | 948 | | |
12122 | | Middle East | 6 | 75 | 844 | 925 | | |
12123 | | Asia Pacific | 9 | 27 | 790 | 826 | | |
12124 | |---------------+-------+-------+-------+-------| | |
12125 | | Sum | 16 | 123 | 2560 | 2699 | | |
12126 | @end example | |
12127 | ||
12128 | On export, the table will occupy 50% of text area. The columns will be sized | |
12129 | (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned | |
12130 | and rest of the columns will be right-aligned. There will be vertical rules | |
12131 | after separating the header and last columns from other columns. There will | |
12132 | be horizontal rules separating the header and last rows from other rows. | |
12133 | ||
12134 | If you are not satisfied with the above formatting options, you can create | |
12135 | custom table styles and associate them with a table using the | |
12136 | @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}. | |
e66ba1df | 12137 | |
153ae947 BG |
12138 | @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export |
12139 | @subsection Images in ODT export | |
12140 | @cindex images, embedding in ODT | |
12141 | @cindex embedding images in ODT | |
e66ba1df BG |
12142 | |
12143 | @subsubheading Embedding images | |
12144 | You can embed images within the exported document by providing a link to the | |
12145 | desired image file with no link description. For example, to embed | |
12146 | @samp{img.png} do either of the following: | |
12147 | ||
12148 | @example | |
12149 | [[file:img.png]] | |
12150 | @end example | |
12151 | ||
12152 | @example | |
12153 | [[./img.png]] | |
12154 | @end example | |
12155 | ||
12156 | @subsubheading Embedding clickable images | |
12157 | You can create clickable images by providing a link whose description is a | |
12158 | link to an image file. For example, to embed a image | |
12159 | @file{org-mode-unicorn.png} which when clicked jumps to | |
12160 | @uref{http://Orgmode.org} website, do the following | |
12161 | ||
12162 | @example | |
12163 | [[http://orgmode.org][./org-mode-unicorn.png]] | |
12164 | @end example | |
12165 | ||
12166 | @subsubheading Sizing and scaling of embedded images | |
12167 | ||
153ae947 | 12168 | @cindex #+ATTR_ODT |
e66ba1df BG |
12169 | You can control the size and scale of the embedded images using the |
12170 | @code{#+ATTR_ODT} attribute. | |
12171 | ||
153ae947 | 12172 | @cindex identify, ImageMagick |
271672fa | 12173 | @vindex org-odt-pixels-per-inch |
153ae947 BG |
12174 | The exporter specifies the desired size of the image in the final document in |
12175 | units of centimeters. In order to scale the embedded images, the exporter | |
12176 | queries for pixel dimensions of the images using one of a) ImageMagick's | |
12177 | @file{identify} program or b) Emacs `create-image' and `image-size' | |
271672fa | 12178 | APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you |
153ae947 BG |
12179 | routinely produce documents that have large images or you export your Org |
12180 | files that has images using a Emacs batch script, then the use of | |
271672fa | 12181 | @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently |
153ae947 | 12182 | converted in to units of centimeters using |
271672fa | 12183 | @code{org-odt-pixels-per-inch}. The default value of this variable is |
e66ba1df BG |
12184 | set to @code{display-pixels-per-inch}. You can tweak this variable to |
12185 | achieve the best results. | |
12186 | ||
12187 | The examples below illustrate the various possibilities. | |
12188 | ||
12189 | @table @asis | |
e66ba1df BG |
12190 | @item Explicitly size the image |
12191 | To embed @file{img.png} as a 10 cm x 10 cm image, do the following: | |
12192 | ||
12193 | @example | |
12194 | #+ATTR_ODT: :width 10 :height 10 | |
12195 | [[./img.png]] | |
12196 | @end example | |
12197 | ||
12198 | @item Scale the image | |
12199 | To embed @file{img.png} at half its size, do the following: | |
12200 | ||
12201 | @example | |
12202 | #+ATTR_ODT: :scale 0.5 | |
12203 | [[./img.png]] | |
12204 | @end example | |
12205 | ||
12206 | @item Scale the image to a specific width | |
12207 | To embed @file{img.png} with a width of 10 cm while retaining the original | |
12208 | height:width ratio, do the following: | |
12209 | ||
12210 | @example | |
12211 | #+ATTR_ODT: :width 10 | |
12212 | [[./img.png]] | |
12213 | @end example | |
12214 | ||
12215 | @item Scale the image to a specific height | |
12216 | To embed @file{img.png} with a height of 10 cm while retaining the original | |
12217 | height:width ratio, do the following | |
12218 | ||
12219 | @example | |
12220 | #+ATTR_ODT: :height 10 | |
12221 | [[./img.png]] | |
12222 | @end example | |
12223 | @end table | |
12224 | ||
153ae947 BG |
12225 | @subsubheading Anchoring of images |
12226 | ||
12227 | @cindex #+ATTR_ODT | |
12228 | You can control the manner in which an image is anchored by setting the | |
12229 | @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one | |
f99f1641 | 12230 | of the the following three values for the @code{:anchor} property: |
153ae947 BG |
12231 | @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}. |
12232 | ||
12233 | To create an image that is anchored to a page, do the following: | |
12234 | @example | |
12235 | #+ATTR_ODT: :anchor "page" | |
12236 | [[./img.png]] | |
12237 | @end example | |
12238 | ||
12239 | @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export | |
12240 | @subsection Math formatting in ODT export | |
e66ba1df | 12241 | |
153ae947 | 12242 | The ODT exporter has special support for handling math. |
e66ba1df BG |
12243 | |
12244 | @menu | |
12245 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments | |
12246 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format | |
12247 | @end menu | |
12248 | ||
153ae947 | 12249 | @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export |
e66ba1df BG |
12250 | @subsubsection Working with @LaTeX{} math snippets |
12251 | ||
12252 | @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT | |
12253 | document in one of the following ways: | |
12254 | ||
12255 | @cindex MathML | |
12256 | @enumerate | |
12257 | @item MathML | |
12258 | ||
12259 | This option is activated on a per-file basis with | |
12260 | ||
12261 | @example | |
12262 | #+OPTIONS: LaTeX:t | |
12263 | @end example | |
12264 | ||
12265 | With this option, @LaTeX{} fragments are first converted into MathML | |
12266 | fragments using an external @LaTeX{}-to-MathML converter program. The | |
12267 | resulting MathML fragments are then embedded as an OpenDocument Formula in | |
12268 | the exported document. | |
12269 | ||
12270 | @vindex org-latex-to-mathml-convert-command | |
12271 | @vindex org-latex-to-mathml-jar-file | |
12272 | ||
12273 | You can specify the @LaTeX{}-to-MathML converter by customizing the variables | |
12274 | @code{org-latex-to-mathml-convert-command} and | |
12275 | @code{org-latex-to-mathml-jar-file}. | |
12276 | ||
12277 | If you prefer to use @file{MathToWeb}@footnote{See | |
12278 | @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your | |
12279 | converter, you can configure the above variables as shown below. | |
12280 | ||
12281 | @lisp | |
12282 | (setq org-latex-to-mathml-convert-command | |
12283 | "java -jar %j -unicode -force -df %o %I" | |
12284 | org-latex-to-mathml-jar-file | |
12285 | "/path/to/mathtoweb.jar") | |
12286 | @end lisp | |
12287 | ||
12288 | You can use the following commands to quickly verify the reliability of | |
12289 | the @LaTeX{}-to-MathML converter. | |
12290 | ||
12291 | @table @kbd | |
271672fa | 12292 | @item M-x org-odt-export-as-odf RET |
8223b1d2 | 12293 | Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file. |
e66ba1df | 12294 | |
271672fa | 12295 | @item M-x org-odt-export-as-odf-and-open RET |
8223b1d2 BG |
12296 | Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file |
12297 | and open the formula file with the system-registered application. | |
e66ba1df BG |
12298 | @end table |
12299 | ||
12300 | @cindex dvipng | |
271672fa | 12301 | @cindex imagemagick |
e66ba1df BG |
12302 | @item PNG images |
12303 | ||
12304 | This option is activated on a per-file basis with | |
12305 | ||
12306 | @example | |
271672fa BG |
12307 | #+OPTIONS: tex:dvipng |
12308 | @end example | |
12309 | ||
12310 | or: | |
12311 | ||
12312 | @example | |
12313 | #+OPTIONS: tex:imagemagick | |
e66ba1df BG |
12314 | @end example |
12315 | ||
12316 | With this option, @LaTeX{} fragments are processed into PNG images and the | |
12317 | resulting images are embedded in the exported document. This method requires | |
271672fa BG |
12318 | that the @file{dvipng} program or @file{imagemagick} suite be available on |
12319 | your system. | |
e66ba1df BG |
12320 | @end enumerate |
12321 | ||
153ae947 | 12322 | @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export |
e66ba1df BG |
12323 | @subsubsection Working with MathML or OpenDocument formula files |
12324 | ||
12325 | For various reasons, you may find embedding @LaTeX{} math snippets in an | |
153ae947 | 12326 | ODT document less than reliable. In that case, you can embed a |
801a68c8 | 12327 | math equation by linking to its MathML (@file{.mml}) source or its |
e66ba1df BG |
12328 | OpenDocument formula (@file{.odf}) file as shown below: |
12329 | ||
12330 | @example | |
12331 | [[./equation.mml]] | |
12332 | @end example | |
12333 | ||
12334 | or | |
12335 | ||
12336 | @example | |
12337 | [[./equation.odf]] | |
12338 | @end example | |
12339 | ||
153ae947 BG |
12340 | @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export |
12341 | @subsection Labels and captions in ODT export | |
e66ba1df | 12342 | |
f99f1641 PE |
12343 | You can label and caption various category of objects---an inline image, a |
12344 | table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and | |
153ae947 | 12345 | @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates |
7bd20f91 | 12346 | each labeled or captioned object of a given category separately. As a |
153ae947 BG |
12347 | result, each such object is assigned a sequence number based on order of it's |
12348 | appearance in the Org file. | |
e66ba1df | 12349 | |
153ae947 BG |
12350 | In the exported document, a user-provided caption is augmented with the |
12351 | category and sequence number. Consider the following inline image in an Org | |
12352 | file. | |
12353 | ||
12354 | @example | |
12355 | #+CAPTION: Bell curve | |
12356 | #+LABEL: fig:SED-HR4049 | |
12357 | [[./img/a.png]] | |
12358 | @end example | |
e66ba1df | 12359 | |
153ae947 | 12360 | It could be rendered as shown below in the exported document. |
e66ba1df | 12361 | |
153ae947 BG |
12362 | @example |
12363 | Figure 2: Bell curve | |
12364 | @end example | |
12365 | ||
271672fa | 12366 | @vindex org-odt-category-map-alist |
153ae947 | 12367 | You can modify the category component of the caption by customizing the |
271672fa BG |
12368 | option @code{org-odt-category-map-alist}. For example, to tag all embedded |
12369 | images with the string @samp{Illustration} (instead of the default | |
12370 | @samp{Figure}) use the following setting: | |
153ae947 BG |
12371 | |
12372 | @lisp | |
271672fa BG |
12373 | (setq org-odt-category-map-alist |
12374 | (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p))) | |
153ae947 | 12375 | @end lisp |
e66ba1df | 12376 | |
153ae947 BG |
12377 | With this, previous image will be captioned as below in the exported |
12378 | document. | |
e66ba1df | 12379 | |
153ae947 BG |
12380 | @example |
12381 | Illustration 2: Bell curve | |
12382 | @end example | |
12383 | ||
12384 | @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export | |
12385 | @subsection Literal examples in ODT export | |
e66ba1df | 12386 | |
153ae947 BG |
12387 | Export of literal examples (@pxref{Literal examples}) with full fontification |
12388 | is supported. Internally, the exporter relies on @file{htmlfontify.el} to | |
12389 | generate all style definitions needed for a fancy listing.@footnote{Your | |
801a68c8 | 12390 | @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for |
153ae947 BG |
12391 | fontification to be turned on.} The auto-generated styles have @samp{OrgSrc} |
12392 | as prefix and inherit their color from the faces used by Emacs | |
12393 | @code{font-lock} library for the source language. | |
e66ba1df | 12394 | |
271672fa BG |
12395 | @vindex org-odt-fontify-srcblocks |
12396 | If you prefer to use your own custom styles for fontification, you can do | |
12397 | so by customizing the option | |
12398 | @code{org-odt-create-custom-styles-for-srcblocks}. | |
153ae947 | 12399 | |
271672fa | 12400 | @vindex org-odt-create-custom-styles-for-srcblocks |
153ae947 | 12401 | You can turn off fontification of literal examples by customizing the |
271672fa | 12402 | option @code{org-odt-fontify-srcblocks}. |
153ae947 BG |
12403 | |
12404 | @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export | |
12405 | @subsection Advanced topics in ODT export | |
12406 | ||
12407 | If you rely heavily on ODT export, you may want to exploit the full | |
e66ba1df BG |
12408 | set of features that the exporter offers. This section describes features |
12409 | that would be of interest to power users. | |
12410 | ||
12411 | @menu | |
153ae947 | 12412 | * Configuring a document converter:: How to register a document converter |
e66ba1df BG |
12413 | * Working with OpenDocument style files:: Explore the internals |
12414 | * Creating one-off styles:: How to produce custom highlighting etc | |
153ae947 | 12415 | * Customizing tables in ODT export:: How to define and use Table templates |
e66ba1df BG |
12416 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files |
12417 | @end menu | |
12418 | ||
153ae947 BG |
12419 | @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export |
12420 | @subsubsection Configuring a document converter | |
ce57c2fe | 12421 | @cindex convert |
153ae947 | 12422 | @cindex doc, docx, rtf |
e66ba1df | 12423 | @cindex converter |
ce57c2fe | 12424 | |
153ae947 BG |
12425 | The ODT exporter can work with popular converters with little or no |
12426 | extra configuration from your side. @xref{Extending ODT export}. | |
12427 | If you are using a converter that is not supported by default or if you would | |
12428 | like to tweak the default converter settings, proceed as below. | |
e66ba1df BG |
12429 | |
12430 | @enumerate | |
12431 | @item Register the converter | |
12432 | ||
271672fa BG |
12433 | @vindex org-odt-convert-processes |
12434 | Name your converter and add it to the list of known converters by | |
12435 | customizing the option @code{org-odt-convert-processes}. Also specify how | |
12436 | the converter can be invoked via command-line to effect the conversion. | |
e66ba1df BG |
12437 | |
12438 | @item Configure its capabilities | |
ce57c2fe | 12439 | |
271672fa BG |
12440 | @vindex org-odt-convert-capabilities |
12441 | @anchor{x-odt-converter-capabilities} Specify the set of formats the | |
12442 | converter can handle by customizing the variable | |
12443 | @code{org-odt-convert-capabilities}. Use the default value for this | |
12444 | variable as a guide for configuring your converter. As suggested by the | |
12445 | default setting, you can specify the full set of formats supported by the | |
e66ba1df BG |
12446 | converter and not limit yourself to specifying formats that are related to |
12447 | just the OpenDocument Text format. | |
12448 | ||
12449 | @item Choose the converter | |
12450 | ||
271672fa | 12451 | @vindex org-odt-convert-process |
e66ba1df | 12452 | Select the newly added converter as the preferred one by customizing the |
271672fa | 12453 | option @code{org-odt-convert-process}. |
e66ba1df BG |
12454 | @end enumerate |
12455 | ||
153ae947 | 12456 | @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export |
e66ba1df BG |
12457 | @subsubsection Working with OpenDocument style files |
12458 | @cindex styles, custom | |
12459 | @cindex template, custom | |
ce57c2fe | 12460 | |
153ae947 | 12461 | This section explores the internals of the ODT exporter and the |
e66ba1df BG |
12462 | means by which it produces styled documents. Read this section if you are |
12463 | interested in exploring the automatic and custom OpenDocument styles used by | |
12464 | the exporter. | |
12465 | ||
12466 | @anchor{x-factory-styles} | |
12467 | @subsubheading Factory styles | |
12468 | ||
153ae947 | 12469 | The ODT exporter relies on two files for generating its output. |
e66ba1df BG |
12470 | These files are bundled with the distribution under the directory pointed to |
12471 | by the variable @code{org-odt-styles-dir}. The two files are: | |
12472 | ||
12473 | @itemize | |
12474 | @anchor{x-orgodtstyles-xml} | |
12475 | @item | |
12476 | @file{OrgOdtStyles.xml} | |
12477 | ||
12478 | This file contributes to the @file{styles.xml} file of the final @samp{ODT} | |
12479 | document. This file gets modified for the following purposes: | |
12480 | @enumerate | |
12481 | ||
12482 | @item | |
12483 | To control outline numbering based on user settings. | |
12484 | ||
12485 | @item | |
12486 | To add styles generated by @file{htmlfontify.el} for fontification of code | |
12487 | blocks. | |
12488 | @end enumerate | |
12489 | ||
12490 | @anchor{x-orgodtcontenttemplate-xml} | |
12491 | @item | |
12492 | @file{OrgOdtContentTemplate.xml} | |
12493 | ||
12494 | This file contributes to the @file{content.xml} file of the final @samp{ODT} | |
12495 | document. The contents of the Org outline are inserted between the | |
12496 | @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file. | |
12497 | ||
12498 | Apart from serving as a template file for the final @file{content.xml}, the | |
12499 | file serves the following purposes: | |
12500 | @enumerate | |
12501 | ||
12502 | @item | |
12503 | It contains automatic styles for formatting of tables which are referenced by | |
12504 | the exporter. | |
12505 | ||
12506 | @item | |
12507 | It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>} | |
f99f1641 PE |
12508 | elements that control how various entities---tables, images, equations, |
12509 | etc.---are numbered. | |
e66ba1df BG |
12510 | @end enumerate |
12511 | @end itemize | |
12512 | ||
12513 | @anchor{x-overriding-factory-styles} | |
12514 | @subsubheading Overriding factory styles | |
153ae947 | 12515 | The following two variables control the location from which the ODT |
e66ba1df BG |
12516 | exporter picks up the custom styles and content template files. You can |
12517 | customize these variables to override the factory styles used by the | |
12518 | exporter. | |
12519 | ||
12520 | @itemize | |
271672fa | 12521 | @anchor{x-org-odt-styles-file} |
e66ba1df | 12522 | @item |
271672fa | 12523 | @code{org-odt-styles-file} |
e66ba1df BG |
12524 | |
12525 | Use this variable to specify the @file{styles.xml} that will be used in the | |
12526 | final output. You can specify one of the following values: | |
12527 | ||
12528 | @enumerate | |
12529 | @item A @file{styles.xml} file | |
12530 | ||
12531 | Use this file instead of the default @file{styles.xml} | |
12532 | ||
12533 | @item A @file{.odt} or @file{.ott} file | |
12534 | ||
12535 | Use the @file{styles.xml} contained in the specified OpenDocument Text or | |
12536 | Template file | |
12537 | ||
12538 | @item A @file{.odt} or @file{.ott} file and a subset of files contained within them | |
12539 | ||
12540 | Use the @file{styles.xml} contained in the specified OpenDocument Text or | |
12541 | Template file. Additionally extract the specified member files and embed | |
12542 | those within the final @samp{ODT} document. | |
12543 | ||
12544 | Use this option if the @file{styles.xml} file references additional files | |
12545 | like header and footer images. | |
12546 | ||
12547 | @item @code{nil} | |
12548 | ||
12549 | Use the default @file{styles.xml} | |
12550 | @end enumerate | |
12551 | ||
271672fa | 12552 | @anchor{x-org-odt-content-template-file} |
e66ba1df | 12553 | @item |
271672fa | 12554 | @code{org-odt-content-template-file} |
e66ba1df BG |
12555 | |
12556 | Use this variable to specify the blank @file{content.xml} that will be used | |
12557 | in the final output. | |
12558 | @end itemize | |
12559 | ||
153ae947 | 12560 | @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export |
e66ba1df BG |
12561 | @subsubsection Creating one-off styles |
12562 | ||
12563 | There are times when you would want one-off formatting in the exported | |
12564 | document. You can achieve this by embedding raw OpenDocument XML in the Org | |
12565 | file. The use of this feature is better illustrated with couple of examples. | |
12566 | ||
12567 | @enumerate | |
12568 | @item Embedding ODT tags as part of regular text | |
12569 | ||
73d3db82 BG |
12570 | You can inline OpenDocument syntax by enclosing it within |
12571 | @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do | |
12572 | the following: | |
e66ba1df BG |
12573 | |
12574 | @example | |
73d3db82 BG |
12575 | @@@@odt:<text:span text:style-name="Highlight">This is a highlighted |
12576 | text</text:span>@@@@. But this is a regular text. | |
e66ba1df BG |
12577 | @end example |
12578 | ||
12579 | @strong{Hint:} To see the above example in action, edit your | |
801a68c8 | 12580 | @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a |
e66ba1df BG |
12581 | custom @samp{Highlight} style as shown below. |
12582 | ||
12583 | @example | |
12584 | <style:style style:name="Highlight" style:family="text"> | |
12585 | <style:text-properties fo:background-color="#ff0000"/> | |
12586 | </style:style> | |
12587 | @end example | |
12588 | ||
12589 | @item Embedding a one-line OpenDocument XML | |
12590 | ||
12591 | You can add a simple OpenDocument one-liner using the @code{#+ODT:} | |
12592 | directive. For example, to force a page break do the following: | |
12593 | ||
12594 | @example | |
12595 | #+ODT: <text:p text:style-name="PageBreak"/> | |
12596 | @end example | |
12597 | ||
12598 | @strong{Hint:} To see the above example in action, edit your | |
801a68c8 | 12599 | @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a |
e66ba1df BG |
12600 | custom @samp{PageBreak} style as shown below. |
12601 | ||
12602 | @example | |
12603 | <style:style style:name="PageBreak" style:family="paragraph" | |
271672fa | 12604 | style:parent-style-name="Text_20_body"> |
e66ba1df BG |
12605 | <style:paragraph-properties fo:break-before="page"/> |
12606 | </style:style> | |
12607 | @end example | |
12608 | ||
12609 | @item Embedding a block of OpenDocument XML | |
12610 | ||
12611 | You can add a large block of OpenDocument XML using the | |
12612 | @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct. | |
12613 | ||
12614 | For example, to create a one-off paragraph that uses bold text, do the | |
12615 | following: | |
12616 | ||
12617 | @example | |
12618 | #+BEGIN_ODT | |
12619 | <text:p text:style-name="Text_20_body_20_bold"> | |
12620 | This paragraph is specially formatted and uses bold text. | |
12621 | </text:p> | |
12622 | #+END_ODT | |
12623 | @end example | |
12624 | ||
12625 | @end enumerate | |
12626 | ||
153ae947 BG |
12627 | @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export |
12628 | @subsubsection Customizing tables in ODT export | |
e66ba1df BG |
12629 | @cindex tables, in ODT export |
12630 | ||
12631 | @cindex #+ATTR_ODT | |
12632 | You can override the default formatting of the table by specifying a custom | |
12633 | table style with the @code{#+ATTR_ODT} line. For a discussion on default | |
153ae947 | 12634 | formatting of tables @pxref{Tables in ODT export}. |
e66ba1df BG |
12635 | |
12636 | This feature closely mimics the way table templates are defined in the | |
12637 | OpenDocument-v1.2 | |
12638 | specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, | |
12639 | OpenDocument-v1.2 Specification}} | |
12640 | ||
f99f1641 | 12641 | @subsubheading Custom table styles: an illustration |
e66ba1df | 12642 | |
271672fa BG |
12643 | @vindex org-odt-table-styles |
12644 | To have a quick preview of this feature, install the below setting and | |
12645 | export the table that follows: | |
e66ba1df BG |
12646 | |
12647 | @lisp | |
271672fa BG |
12648 | (setq org-odt-table-styles |
12649 | (append org-odt-table-styles | |
12650 | '(("TableWithHeaderRowAndColumn" "Custom" | |
12651 | ((use-first-row-styles . t) | |
12652 | (use-first-column-styles . t))) | |
12653 | ("TableWithFirstRowandLastRow" "Custom" | |
12654 | ((use-first-row-styles . t) | |
12655 | (use-last-row-styles . t)))))) | |
e66ba1df BG |
12656 | @end lisp |
12657 | ||
12658 | @example | |
153ae947 | 12659 | #+ATTR_ODT: :style "TableWithHeaderRowAndColumn" |
e66ba1df BG |
12660 | | Name | Phone | Age | |
12661 | | Peter | 1234 | 17 | | |
12662 | | Anna | 4321 | 25 | | |
12663 | @end example | |
12664 | ||
12665 | In the above example, you used a template named @samp{Custom} and installed | |
12666 | two table styles with the names @samp{TableWithHeaderRowAndColumn} and | |
12667 | @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument | |
271672fa BG |
12668 | styles needed for producing the above template have been pre-defined for |
12669 | you. These styles are available under the section marked @samp{Custom | |
12670 | Table Template} in @file{OrgOdtContentTemplate.xml} | |
e66ba1df BG |
12671 | (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need |
12672 | additional templates you have to define these styles yourselves. | |
12673 | ||
f99f1641 | 12674 | @subsubheading Custom table styles: the nitty-gritty |
e66ba1df BG |
12675 | To use this feature proceed as follows: |
12676 | ||
12677 | @enumerate | |
12678 | @item | |
12679 | Create a table template@footnote{See the @code{<table:table-template>} | |
12680 | element of the OpenDocument-v1.2 specification} | |
12681 | ||
12682 | A table template is nothing but a set of @samp{table-cell} and | |
12683 | @samp{paragraph} styles for each of the following table cell categories: | |
12684 | ||
12685 | @itemize @minus | |
12686 | @item Body | |
12687 | @item First column | |
12688 | @item Last column | |
12689 | @item First row | |
12690 | @item Last row | |
12691 | @item Even row | |
12692 | @item Odd row | |
12693 | @item Even column | |
12694 | @item Odd Column | |
12695 | @end itemize | |
12696 | ||
12697 | The names for the above styles must be chosen based on the name of the table | |
12698 | template using a well-defined convention. | |
12699 | ||
12700 | The naming convention is better illustrated with an example. For a table | |
12701 | template with the name @samp{Custom}, the needed style names are listed in | |
12702 | the following table. | |
12703 | ||
12704 | @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph} | |
12705 | @headitem Table cell type | |
12706 | @tab @code{table-cell} style | |
12707 | @tab @code{paragraph} style | |
12708 | @item | |
12709 | @tab | |
12710 | @tab | |
12711 | @item Body | |
12712 | @tab @samp{CustomTableCell} | |
12713 | @tab @samp{CustomTableParagraph} | |
12714 | @item First column | |
12715 | @tab @samp{CustomFirstColumnTableCell} | |
12716 | @tab @samp{CustomFirstColumnTableParagraph} | |
12717 | @item Last column | |
12718 | @tab @samp{CustomLastColumnTableCell} | |
12719 | @tab @samp{CustomLastColumnTableParagraph} | |
12720 | @item First row | |
12721 | @tab @samp{CustomFirstRowTableCell} | |
12722 | @tab @samp{CustomFirstRowTableParagraph} | |
12723 | @item Last row | |
12724 | @tab @samp{CustomLastRowTableCell} | |
12725 | @tab @samp{CustomLastRowTableParagraph} | |
12726 | @item Even row | |
12727 | @tab @samp{CustomEvenRowTableCell} | |
12728 | @tab @samp{CustomEvenRowTableParagraph} | |
12729 | @item Odd row | |
12730 | @tab @samp{CustomOddRowTableCell} | |
12731 | @tab @samp{CustomOddRowTableParagraph} | |
12732 | @item Even column | |
12733 | @tab @samp{CustomEvenColumnTableCell} | |
12734 | @tab @samp{CustomEvenColumnTableParagraph} | |
12735 | @item Odd column | |
12736 | @tab @samp{CustomOddColumnTableCell} | |
12737 | @tab @samp{CustomOddColumnTableParagraph} | |
12738 | @end multitable | |
12739 | ||
12740 | To create a table template with the name @samp{Custom}, define the above | |
12741 | styles in the | |
12742 | @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element | |
12743 | of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory | |
12744 | styles}). | |
12745 | ||
12746 | @item | |
12747 | Define a table style@footnote{See the attributes @code{table:template-name}, | |
12748 | @code{table:use-first-row-styles}, @code{table:use-last-row-styles}, | |
12749 | @code{table:use-first-column-styles}, @code{table:use-last-column-styles}, | |
12750 | @code{table:use-banding-rows-styles}, and | |
12751 | @code{table:use-banding-column-styles} of the @code{<table:table>} element in | |
12752 | the OpenDocument-v1.2 specification} | |
12753 | ||
271672fa | 12754 | @vindex org-odt-table-styles |
e66ba1df | 12755 | To define a table style, create an entry for the style in the variable |
271672fa | 12756 | @code{org-odt-table-styles} and specify the following: |
e66ba1df BG |
12757 | |
12758 | @itemize @minus | |
12759 | @item the name of the table template created in step (1) | |
12760 | @item the set of cell styles in that template that are to be activated | |
12761 | @end itemize | |
12762 | ||
12763 | For example, the entry below defines two different table styles | |
153ae947 BG |
12764 | @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow} |
12765 | based on the same template @samp{Custom}. The styles achieve their intended | |
12766 | effect by selectively activating the individual cell styles in that template. | |
e66ba1df BG |
12767 | |
12768 | @lisp | |
271672fa BG |
12769 | (setq org-odt-table-styles |
12770 | (append org-odt-table-styles | |
12771 | '(("TableWithHeaderRowAndColumn" "Custom" | |
12772 | ((use-first-row-styles . t) | |
12773 | (use-first-column-styles . t))) | |
12774 | ("TableWithFirstRowandLastRow" "Custom" | |
12775 | ((use-first-row-styles . t) | |
12776 | (use-last-row-styles . t)))))) | |
e66ba1df BG |
12777 | @end lisp |
12778 | ||
271672fa BG |
12779 | @item |
12780 | Associate a table with the table style | |
86fbb8ca | 12781 | |
271672fa BG |
12782 | To do this, specify the table style created in step (2) as part of |
12783 | the @code{ATTR_ODT} line as shown below. | |
86fbb8ca | 12784 | |
271672fa BG |
12785 | @example |
12786 | #+ATTR_ODT: :style "TableWithHeaderRowAndColumn" | |
12787 | | Name | Phone | Age | | |
12788 | | Peter | 1234 | 17 | | |
12789 | | Anna | 4321 | 25 | | |
12790 | @end example | |
12791 | @end enumerate | |
a351880d | 12792 | |
271672fa BG |
12793 | @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export |
12794 | @subsubsection Validating OpenDocument XML | |
a351880d | 12795 | |
271672fa BG |
12796 | Occasionally, you will discover that the document created by the |
12797 | ODT exporter cannot be opened by your favorite application. One of | |
12798 | the common reasons for this is that the @file{.odt} file is corrupt. In such | |
12799 | cases, you may want to validate the document against the OpenDocument RELAX | |
12800 | NG Compact Syntax (RNC) schema. | |
a351880d | 12801 | |
271672fa BG |
12802 | For de-compressing the @file{.odt} file@footnote{@file{.odt} files are |
12803 | nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For | |
12804 | general help with validation (and schema-sensitive editing) of XML files: | |
12805 | @inforef{Introduction,,nxml-mode}. | |
4009494e | 12806 | |
271672fa BG |
12807 | @vindex org-odt-schema-dir |
12808 | If you have ready access to OpenDocument @file{.rnc} files and the needed | |
12809 | schema-locating rules in a single folder, you can customize the variable | |
12810 | @code{org-odt-schema-dir} to point to that directory. The ODT exporter | |
12811 | will take care of updating the @code{rng-schema-locating-files} for you. | |
4009494e | 12812 | |
271672fa | 12813 | @c end opendocument |
4009494e | 12814 | |
3c8b09ca BG |
12815 | @node Org export |
12816 | @section Org export | |
12817 | @cindex Org export | |
12818 | ||
12819 | @code{org} export back-end creates a normalized version of the Org document | |
12820 | in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating | |
12821 | code blocks}) and removes other back-ends specific contents. | |
12822 | ||
12823 | @subheading Org export commands | |
12824 | ||
12825 | @table @kbd | |
12826 | @orgcmd{C-c C-e O o,org-org-export-to-org} | |
12827 | Export as an Org document. For an Org file, @file{myfile.org}, the resulting | |
12828 | file will be @file{myfile.org.org}. The file will be overwritten without | |
12829 | warning. | |
12830 | @orgcmd{C-c C-e O O,org-org-export-as-org} | |
12831 | Export to a temporary buffer. Do not create a file. | |
12832 | @item C-c C-e O v | |
12833 | Export to an Org file, then open it. | |
12834 | @end table | |
12835 | ||
12836 | @node iCalendar export, Other built-in back-ends, Org export, Exporting | |
4009494e GM |
12837 | @section iCalendar export |
12838 | @cindex iCalendar export | |
12839 | ||
c8d0cf5c CD |
12840 | @vindex org-icalendar-include-todo |
12841 | @vindex org-icalendar-use-deadline | |
12842 | @vindex org-icalendar-use-scheduled | |
12843 | @vindex org-icalendar-categories | |
afe98dfa | 12844 | @vindex org-icalendar-alarm-time |
e66ba1df | 12845 | Some people use Org mode for keeping track of projects, but still prefer a |
c8d0cf5c CD |
12846 | standard calendar application for anniversaries and appointments. In this |
12847 | case it can be useful to show deadlines and other time-stamped items in Org | |
e66ba1df | 12848 | files in the calendar application. Org mode can export calendar information |
c8d0cf5c CD |
12849 | in the standard iCalendar format. If you also want to have TODO entries |
12850 | included in the export, configure the variable | |
12851 | @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT, | |
1df7defd | 12852 | and TODO items as VTODO@. It will also create events from deadlines that are |
c8d0cf5c CD |
12853 | in non-TODO items. Deadlines and scheduling dates in TODO items will be used |
12854 | to set the start and due dates for the TODO entry@footnote{See the variables | |
12855 | @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}. | |
12856 | As categories, it will use the tags locally defined in the heading, and the | |
12857 | file/tree category@footnote{To add inherited tags or the TODO state, | |
afe98dfa CD |
12858 | configure the variable @code{org-icalendar-categories}.}. See the variable |
12859 | @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a | |
12860 | time. | |
c8d0cf5c CD |
12861 | |
12862 | @vindex org-icalendar-store-UID | |
12863 | @cindex property, ID | |
b349f79f CD |
12864 | The iCalendar standard requires each entry to have a globally unique |
12865 | identifier (UID). Org creates these identifiers during export. If you set | |
12866 | the variable @code{org-icalendar-store-UID}, the UID will be stored in the | |
12867 | @code{:ID:} property of the entry and re-used next time you report this | |
12868 | entry. Since a single entry can give rise to multiple iCalendar entries (as | |
12869 | a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds | |
12870 | prefixes to the UID, depending on what triggered the inclusion of the entry. | |
12871 | In this way the UID remains unique, but a synchronization program can still | |
12872 | figure out from which entry all the different instances originate. | |
12873 | ||
4009494e | 12874 | @table @kbd |
271672fa BG |
12875 | @orgcmd{C-c C-e c f,org-icalendar-export-to-ics} |
12876 | Create iCalendar entries for the current buffer and store them in the same | |
4009494e | 12877 | directory, using a file extension @file{.ics}. |
271672fa | 12878 | @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files} |
c8d0cf5c | 12879 | @vindex org-agenda-files |
271672fa | 12880 | Like @kbd{C-c C-e c f}, but do this for all files in |
4009494e GM |
12881 | @code{org-agenda-files}. For each of these files, a separate iCalendar |
12882 | file will be written. | |
271672fa BG |
12883 | @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files} |
12884 | @vindex org-icalendar-combined-agenda-file | |
4009494e GM |
12885 | Create a single large iCalendar file from all files in |
12886 | @code{org-agenda-files} and write it to the file given by | |
271672fa | 12887 | @code{org-icalendar-combined-agenda-file}. |
4009494e GM |
12888 | @end table |
12889 | ||
c8d0cf5c CD |
12890 | @vindex org-use-property-inheritance |
12891 | @vindex org-icalendar-include-body | |
12892 | @cindex property, SUMMARY | |
12893 | @cindex property, DESCRIPTION | |
12894 | @cindex property, LOCATION | |
96c8522a CD |
12895 | The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION |
12896 | property can be inherited from higher in the hierarchy if you configure | |
12897 | @code{org-use-property-inheritance} accordingly.} properties if the selected | |
12898 | entries have them. If not, the summary will be derived from the headline, | |
12899 | and the description from the body (limited to | |
28a16a1b | 12900 | @code{org-icalendar-include-body} characters). |
dbc28aaa | 12901 | |
c8d0cf5c | 12902 | How this calendar is best read and updated, depends on the application |
4009494e GM |
12903 | you are using. The FAQ covers this issue. |
12904 | ||
271672fa BG |
12905 | @node Other built-in back-ends, Export in foreign buffers, iCalendar export, Exporting |
12906 | @section Other built-in back-ends | |
12907 | @cindex export back-ends, built-in | |
12908 | @vindex org-export-backends | |
12909 | ||
d1389828 | 12910 | On top of the aforementioned back-ends, Org comes with other built-in ones: |
271672fa BG |
12911 | |
12912 | @itemize | |
12913 | @item @file{ox-man.el}: export to a man page. | |
12914 | @item @file{ox-texinfo.el}: export to @code{Texinfo} format. | |
271672fa BG |
12915 | @end itemize |
12916 | ||
12917 | To activate these export back-end, customize @code{org-export-backends} or | |
12918 | load them directly with e.g., @code{(require 'ox-texinfo)}. This will add | |
12919 | new keys in the export dispatcher (@pxref{The Export Dispatcher}). | |
12920 | ||
12921 | See the comment section of these files for more information on how to use | |
12922 | them. | |
12923 | ||
12924 | @node Export in foreign buffers, Advanced configuration, Other built-in back-ends, Exporting | |
12925 | @section Export in foreign buffers | |
12926 | ||
12927 | Most built-in back-ends come with a command to convert the selected region | |
12928 | into a selected format and replace this region by the exported output. Here | |
12929 | is a list of such conversion commands: | |
12930 | ||
12931 | @table @code | |
12932 | @item org-html-convert-region-to-html | |
12933 | Convert the selected region into HTML. | |
12934 | @item org-latex-convert-region-to-latex | |
12935 | Convert the selected region into @LaTeX{}. | |
12936 | @item org-texinfo-convert-region-to-texinfo | |
12937 | Convert the selected region into @code{Texinfo}. | |
12938 | @item org-md-convert-region-to-md | |
12939 | Convert the selected region into @code{MarkDown}. | |
12940 | @end table | |
12941 | ||
d1389828 PE |
12942 | This is particularly useful for converting tables and lists in foreign |
12943 | buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then | |
271672fa BG |
12944 | use Org commands for editing a list, and finally select and convert the list |
12945 | with @code{M-x org-html-convert-region-to-html RET}. | |
12946 | ||
12947 | @node Advanced configuration, , Export in foreign buffers, Exporting | |
12948 | @section Advanced configuration | |
12949 | ||
12950 | @subheading Hooks | |
12951 | ||
12952 | @vindex org-export-before-processing-hook | |
12953 | @vindex org-export-before-parsing-hook | |
12954 | Two hooks are run during the first steps of the export process. The first | |
12955 | one, @code{org-export-before-processing-hook} is called before expanding | |
12956 | macros, Babel code and include keywords in the buffer. The second one, | |
12957 | @code{org-export-before-parsing-hook}, as its name suggests, happens just | |
12958 | before parsing the buffer. Their main use is for heavy duties, that is | |
12959 | duties involving structural modifications of the document. For example, one | |
12960 | may want to remove every headline in the buffer during export. The following | |
12961 | code can achieve this: | |
12962 | ||
12963 | @lisp | |
12964 | @group | |
12965 | (defun my-headline-removal (backend) | |
12966 | "Remove all headlines in the current buffer. | |
12967 | BACKEND is the export back-end being used, as a symbol." | |
12968 | (org-map-entries | |
12969 | (lambda () (delete-region (point) (progn (forward-line) (point)))))) | |
12970 | ||
12971 | (add-hook 'org-export-before-parsing-hook 'my-headline-removal) | |
12972 | @end group | |
12973 | @end lisp | |
12974 | ||
12975 | Note that functions used in these hooks require a mandatory argument, | |
12976 | a symbol representing the back-end used. | |
12977 | ||
12978 | @subheading Filters | |
12979 | ||
12980 | @cindex Filters, exporting | |
12981 | Filters are lists of functions applied on a specific part of the output from | |
12982 | a given back-end. More explicitly, each time a back-end transforms an Org | |
12983 | object or element into another language, all functions within a given filter | |
12984 | type are called in turn on the string produced. The string returned by the | |
12985 | last function will be the one used in the final output. | |
12986 | ||
12987 | There are filters sets for each type of element or object, for plain text, | |
12988 | for the parse tree, for the export options and for the final output. They | |
12989 | are all named after the same scheme: @code{org-export-filter-TYPE-functions}, | |
12990 | where @code{TYPE} is the type targeted by the filter. Valid types are: | |
12991 | ||
12992 | @multitable @columnfractions .33 .33 .33 | |
12993 | @item bold | |
12994 | @tab babel-call | |
12995 | @tab center-block | |
12996 | @item clock | |
12997 | @tab code | |
12998 | @tab comment | |
12999 | @item comment-block | |
13000 | @tab diary-sexp | |
13001 | @tab drawer | |
13002 | @item dynamic-block | |
13003 | @tab entity | |
13004 | @tab example-block | |
13005 | @item export-block | |
13006 | @tab export-snippet | |
13007 | @tab final-output | |
13008 | @item fixed-width | |
13009 | @tab footnote-definition | |
13010 | @tab footnote-reference | |
13011 | @item headline | |
13012 | @tab horizontal-rule | |
13013 | @tab inline-babel-call | |
13014 | @item inline-src-block | |
13015 | @tab inlinetask | |
13016 | @tab italic | |
13017 | @item item | |
13018 | @tab keyword | |
13019 | @tab latex-environment | |
13020 | @item latex-fragment | |
13021 | @tab line-break | |
13022 | @tab link | |
13023 | @item node-property | |
13024 | @tab options | |
13025 | @tab paragraph | |
13026 | @item parse-tree | |
13027 | @tab plain-list | |
13028 | @tab plain-text | |
13029 | @item planning | |
13030 | @tab property-drawer | |
13031 | @tab quote-block | |
13032 | @item quote-section | |
13033 | @tab radio-target | |
13034 | @tab section | |
13035 | @item special-block | |
13036 | @tab src-block | |
13037 | @tab statistics-cookie | |
13038 | @item strike-through | |
13039 | @tab subscript | |
13040 | @tab superscript | |
13041 | @item table | |
13042 | @tab table-cell | |
13043 | @tab table-row | |
13044 | @item target | |
13045 | @tab timestamp | |
13046 | @tab underline | |
13047 | @item verbatim | |
13048 | @tab verse-block | |
13049 | @tab | |
13050 | @end multitable | |
13051 | ||
13052 | For example, the following snippet allows me to use non-breaking spaces in | |
13053 | the Org buffer and get them translated into @LaTeX{} without using the | |
13054 | @code{\nbsp} macro (where @code{_} stands for the non-breaking space): | |
13055 | ||
13056 | @lisp | |
13057 | @group | |
13058 | (defun my-latex-filter-nobreaks (text backend info) | |
13059 | "Ensure \"Â \" are properly handled in LaTeX export." | |
13060 | (when (org-export-derived-backend-p backend 'latex) | |
13061 | (replace-regexp-in-string "Â " "~" text))) | |
13062 | ||
13063 | (add-to-list 'org-export-filter-plain-text-functions | |
13064 | 'my-latex-filter-nobreaks) | |
13065 | @end group | |
13066 | @end lisp | |
13067 | ||
13068 | Three arguments must be provided to a filter: the code being changed, the | |
13069 | back-end used, and some information about the export process. You can safely | |
13070 | ignore the third argument for most purposes. Note the use of | |
13071 | @code{org-export-derived-backend-p}, which ensures that the filter will only | |
13072 | be applied when using @code{latex} back-end or any other back-end derived | |
13073 | from it (e.g., @code{beamer}). | |
13074 | ||
13075 | @subheading Extending an existing back-end | |
13076 | ||
13077 | This is obviously the most powerful customization, since the changes happen | |
13078 | at the parser level. Indeed, some export back-ends are built as extensions | |
13079 | of other ones (e.g. Markdown back-end an extension of HTML back-end). | |
13080 | ||
13081 | Extending a back-end means that if an element type is not transcoded by the | |
13082 | new back-end, it will be handled by the original one. Hence you can extend | |
13083 | specific parts of a back-end without too much work. | |
13084 | ||
13085 | As an example, imagine we want the @code{ascii} back-end to display the | |
13086 | language used in a source block, when it is available, but only when some | |
13087 | attribute is non-@code{nil}, like the following: | |
13088 | ||
13089 | @example | |
13090 | #+ATTR_ASCII: :language t | |
13091 | @end example | |
13092 | ||
13093 | Because that back-end is lacking in that area, we are going to create a new | |
13094 | back-end, @code{my-ascii} that will do the job. | |
13095 | ||
13096 | @lisp | |
13097 | @group | |
13098 | (defun my-ascii-src-block (src-block contents info) | |
13099 | "Transcode a SRC-BLOCK element from Org to ASCII. | |
13100 | CONTENTS is nil. INFO is a plist used as a communication | |
13101 | channel." | |
13102 | (if (not (org-export-read-attribute :attr_ascii src-block :language)) | |
13103 | (org-export-with-backend 'ascii src-block contents info) | |
13104 | (concat | |
13105 | (format ",--[ %s ]--\n%s`----" | |
13106 | (org-element-property :language src-block) | |
13107 | (replace-regexp-in-string | |
13108 | "^" "| " | |
13109 | (org-element-normalize-string | |
13110 | (org-export-format-code-default src-block info))))))) | |
13111 | ||
13112 | (org-export-define-derived-backend 'my-ascii 'ascii | |
13113 | :translate-alist '((src-block . my-ascii-src-block))) | |
13114 | @end group | |
13115 | @end lisp | |
13116 | ||
13117 | The @code{my-ascii-src-block} function looks at the attribute above the | |
b483c570 | 13118 | element. If it isn't true, it gives hand to the @code{ascii} back-end. |
271672fa | 13119 | Otherwise, it creates a box around the code, leaving room for the language. |
da5ecfa9 | 13120 | A new back-end is then created. It only changes its behavior when |
271672fa BG |
13121 | translating @code{src-block} type element. Now, all it takes to use the new |
13122 | back-end is calling the following from an Org buffer: | |
13123 | ||
13124 | @smalllisp | |
13125 | (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*") | |
13126 | @end smalllisp | |
13127 | ||
13128 | It is obviously possible to write an interactive function for this, install | |
13129 | it in the export dispatcher menu, and so on. | |
13130 | ||
86fbb8ca | 13131 | @node Publishing, Working With Source Code, Exporting, Top |
4009494e GM |
13132 | @chapter Publishing |
13133 | @cindex publishing | |
13134 | ||
c8d0cf5c CD |
13135 | Org includes a publishing management system that allows you to configure |
13136 | automatic HTML conversion of @emph{projects} composed of interlinked org | |
13137 | files. You can also configure Org to automatically upload your exported HTML | |
13138 | pages and related attachments, such as images and source code files, to a web | |
13139 | server. | |
4009494e | 13140 | |
c8d0cf5c CD |
13141 | You can also use Org to convert files into PDF, or even combine HTML and PDF |
13142 | conversion so that files are available in both formats on the server. | |
4009494e | 13143 | |
c8d0cf5c | 13144 | Publishing has been contributed to Org by David O'Toole. |
4009494e GM |
13145 | |
13146 | @menu | |
c0468714 GM |
13147 | * Configuration:: Defining projects |
13148 | * Uploading files:: How to get files up on the server | |
13149 | * Sample configuration:: Example projects | |
13150 | * Triggering publication:: Publication commands | |
4009494e GM |
13151 | @end menu |
13152 | ||
c8d0cf5c | 13153 | @node Configuration, Uploading files, Publishing, Publishing |
4009494e GM |
13154 | @section Configuration |
13155 | ||
13156 | Publishing needs significant configuration to specify files, destination | |
13157 | and many other properties of a project. | |
13158 | ||
13159 | @menu | |
c0468714 GM |
13160 | * Project alist:: The central configuration variable |
13161 | * Sources and destinations:: From here to there | |
13162 | * Selecting files:: What files are part of the project? | |
13163 | * Publishing action:: Setting the function doing the publishing | |
ce57c2fe | 13164 | * Publishing options:: Tweaking HTML/@LaTeX{} export |
c0468714 GM |
13165 | * Publishing links:: Which links keep working after publishing? |
13166 | * Sitemap:: Generating a list of all pages | |
13167 | * Generating an index:: An index that reaches across pages | |
4009494e GM |
13168 | @end menu |
13169 | ||
13170 | @node Project alist, Sources and destinations, Configuration, Configuration | |
13171 | @subsection The variable @code{org-publish-project-alist} | |
13172 | @cindex org-publish-project-alist | |
13173 | @cindex projects, for publishing | |
13174 | ||
c8d0cf5c CD |
13175 | @vindex org-publish-project-alist |
13176 | Publishing is configured almost entirely through setting the value of one | |
13177 | variable, called @code{org-publish-project-alist}. Each element of the list | |
13178 | configures one project, and may be in one of the two following forms: | |
4009494e GM |
13179 | |
13180 | @lisp | |
ce57c2fe | 13181 | ("project-name" :property value :property value ...) |
1df7defd | 13182 | @r{i.e., a well-formed property list with alternating keys and values} |
28a16a1b | 13183 | @r{or} |
c8d0cf5c | 13184 | ("project-name" :components ("project-name" "project-name" ...)) |
4009494e GM |
13185 | |
13186 | @end lisp | |
13187 | ||
c8d0cf5c CD |
13188 | In both cases, projects are configured by specifying property values. A |
13189 | project defines the set of files that will be published, as well as the | |
13190 | publishing configuration to use when publishing those files. When a project | |
13191 | takes the second form listed above, the individual members of the | |
13192 | @code{:components} property are taken to be sub-projects, which group | |
13193 | together files requiring different publishing options. When you publish such | |
13194 | a ``meta-project'', all the components will also be published, in the | |
13195 | sequence given. | |
4009494e GM |
13196 | |
13197 | @node Sources and destinations, Selecting files, Project alist, Configuration | |
13198 | @subsection Sources and destinations for files | |
13199 | @cindex directories, for publishing | |
13200 | ||
c8d0cf5c CD |
13201 | Most properties are optional, but some should always be set. In |
13202 | particular, Org needs to know where to look for source files, | |
4009494e GM |
13203 | and where to put published files. |
13204 | ||
13205 | @multitable @columnfractions 0.3 0.7 | |
13206 | @item @code{:base-directory} | |
13207 | @tab Directory containing publishing source files | |
13208 | @item @code{:publishing-directory} | |
c8d0cf5c | 13209 | @tab Directory where output files will be published. You can directly |
271672fa | 13210 | publish to a web server using a file name syntax appropriate for |
c8d0cf5c CD |
13211 | the Emacs @file{tramp} package. Or you can publish to a local directory and |
13212 | use external tools to upload your website (@pxref{Uploading files}). | |
4009494e | 13213 | @item @code{:preparation-function} |
ed21c5c8 CD |
13214 | @tab Function or list of functions to be called before starting the |
13215 | publishing process, for example, to run @code{make} for updating files to be | |
13216 | published. The project property list is scoped into this call as the | |
13217 | variable @code{project-plist}. | |
b349f79f | 13218 | @item @code{:completion-function} |
ed21c5c8 CD |
13219 | @tab Function or list of functions called after finishing the publishing |
13220 | process, for example, to change permissions of the resulting files. The | |
13221 | project property list is scoped into this call as the variable | |
13222 | @code{project-plist}. | |
4009494e GM |
13223 | @end multitable |
13224 | @noindent | |
13225 | ||
13226 | @node Selecting files, Publishing action, Sources and destinations, Configuration | |
13227 | @subsection Selecting files | |
13228 | @cindex files, selecting for publishing | |
13229 | ||
13230 | By default, all files with extension @file{.org} in the base directory | |
13231 | are considered part of the project. This can be modified by setting the | |
28a16a1b | 13232 | properties |
4009494e GM |
13233 | @multitable @columnfractions 0.25 0.75 |
13234 | @item @code{:base-extension} | |
13235 | @tab Extension (without the dot!) of source files. This actually is a | |
c8d0cf5c CD |
13236 | regular expression. Set this to the symbol @code{any} if you want to get all |
13237 | files in @code{:base-directory}, even without extension. | |
4009494e | 13238 | |
28a16a1b | 13239 | @item @code{:exclude} |
4009494e GM |
13240 | @tab Regular expression to match file names that should not be |
13241 | published, even though they have been selected on the basis of their | |
13242 | extension. | |
13243 | ||
13244 | @item @code{:include} | |
13245 | @tab List of files to be included regardless of @code{:base-extension} | |
13246 | and @code{:exclude}. | |
acedf35c CD |
13247 | |
13248 | @item @code{:recursive} | |
271672fa | 13249 | @tab non-@code{nil} means, check base-directory recursively for files to publish. |
4009494e GM |
13250 | @end multitable |
13251 | ||
13252 | @node Publishing action, Publishing options, Selecting files, Configuration | |
a7808fba | 13253 | @subsection Publishing action |
4009494e GM |
13254 | @cindex action, for publishing |
13255 | ||
13256 | Publishing means that a file is copied to the destination directory and | |
71d35b24 CD |
13257 | possibly transformed in the process. The default transformation is to export |
13258 | Org files as HTML files, and this is done by the function | |
271672fa | 13259 | @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML |
c8d0cf5c | 13260 | export}). But you also can publish your content as PDF files using |
271672fa BG |
13261 | @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc., |
13262 | using the corresponding functions. | |
13263 | ||
13264 | If you want to publish the Org file as an @code{.org} file but with the | |
13265 | @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the | |
13266 | function @code{org-org-publish-to-org}. This will produce @file{file.org} | |
13267 | and put it in the publishing directory. If you want a htmlized version of | |
13268 | this file, set the parameter @code{:htmlized-source} to @code{t}, it will | |
13269 | produce @file{file.org.html} in the publishing directory@footnote{If the | |
13270 | publishing directory is the same than the source directory, @file{file.org} | |
13271 | will be exported as @file{file.org.org}, so probably don't want to do this.}. | |
13272 | ||
13273 | Other files like images only need to be copied to the publishing destination. | |
13274 | For this you can use @code{org-publish-attachment}. For non-org files, you | |
13275 | always need to specify the publishing function: | |
4009494e GM |
13276 | |
13277 | @multitable @columnfractions 0.3 0.7 | |
13278 | @item @code{:publishing-function} | |
13279 | @tab Function executing the publication of a file. This may also be a | |
13280 | list of functions, which will all be called in turn. | |
c8d0cf5c | 13281 | @item @code{:htmlized-source} |
271672fa | 13282 | @tab non-@code{nil} means, publish htmlized source. |
4009494e GM |
13283 | @end multitable |
13284 | ||
ed21c5c8 | 13285 | The function must accept three arguments: a property list containing at least |
271672fa BG |
13286 | a @code{:publishing-directory} property, the name of the file to be published |
13287 | and the path to the publishing directory of the output file. It should take | |
13288 | the specified file, make the necessary transformation (if any) and place the | |
13289 | result into the destination folder. | |
4009494e GM |
13290 | |
13291 | @node Publishing options, Publishing links, Publishing action, Configuration | |
271672fa | 13292 | @subsection Options for the exporters |
4009494e GM |
13293 | @cindex options, for publishing |
13294 | ||
271672fa BG |
13295 | The property list can be used to set many export options for the exporters. |
13296 | In most cases, these properties correspond to user variables in Org. The | |
13297 | first table below lists these properties along with the variable they belong | |
13298 | to. The second table list HTML specific properties. See the documentation | |
13299 | string of these options for details. | |
4009494e | 13300 | |
c8d0cf5c | 13301 | @vindex org-display-custom-times |
271672fa BG |
13302 | @vindex org-export-default-language |
13303 | @vindex org-export-exclude-tags | |
c8d0cf5c | 13304 | @vindex org-export-headline-levels |
c8d0cf5c | 13305 | @vindex org-export-preserve-breaks |
271672fa BG |
13306 | @vindex org-export-publishing-directory |
13307 | @vindex org-export-select-tags | |
c8d0cf5c | 13308 | @vindex org-export-with-archived-trees |
271672fa BG |
13309 | @vindex org-export-with-author |
13310 | @vindex org-export-with-creator | |
13311 | @vindex org-export-with-drawers | |
13312 | @vindex org-export-with-email | |
c8d0cf5c | 13313 | @vindex org-export-with-emphasize |
271672fa | 13314 | @vindex org-export-with-fixed-width |
c8d0cf5c | 13315 | @vindex org-export-with-footnotes |
271672fa BG |
13316 | @vindex org-export-with-latex |
13317 | @vindex org-export-with-planning | |
13318 | @vindex org-export-with-priority | |
13319 | @vindex org-export-with-section-numbers | |
13320 | @vindex org-export-with-special-strings | |
13321 | @vindex org-export-with-sub-superscripts | |
13322 | @vindex org-export-with-tables | |
c8d0cf5c | 13323 | @vindex org-export-with-tags |
ce57c2fe | 13324 | @vindex org-export-with-tasks |
c8d0cf5c | 13325 | @vindex org-export-with-timestamps |
271672fa BG |
13326 | @vindex org-export-with-toc |
13327 | @vindex org-export-with-todo-keywords | |
c8d0cf5c | 13328 | @vindex user-mail-address |
c8d0cf5c | 13329 | |
96c8522a | 13330 | @multitable @columnfractions 0.32 0.68 |
271672fa BG |
13331 | @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} |
13332 | @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} | |
4009494e | 13333 | @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
271672fa | 13334 | @item @code{:language} @tab @code{org-export-default-language} |
96c8522a | 13335 | @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} |
4009494e | 13336 | @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} |
271672fa | 13337 | @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} |
864c9740 | 13338 | @item @code{:select-tags} @tab @code{org-export-select-tags} |
271672fa BG |
13339 | @item @code{:with-author} @tab @code{org-export-with-author} |
13340 | @item @code{:with-creator} @tab @code{org-export-with-creator} | |
13341 | @item @code{:with-drawers} @tab @code{org-export-with-drawers} | |
13342 | @item @code{:with-email} @tab @code{org-export-with-email} | |
13343 | @item @code{:with-emphasize} @tab @code{org-export-with-emphasize} | |
13344 | @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width} | |
13345 | @item @code{:with-footnotes} @tab @code{org-export-with-footnotes} | |
13346 | @item @code{:with-latex} @tab @code{org-export-with-latex} | |
13347 | @item @code{:with-planning} @tab @code{org-export-with-planning} | |
13348 | @item @code{:with-priority} @tab @code{org-export-with-priority} | |
13349 | @item @code{:with-special-strings} @tab @code{org-export-with-special-strings} | |
13350 | @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts} | |
13351 | @item @code{:with-tables} @tab @code{org-export-with-tables} | |
13352 | @item @code{:with-tags} @tab @code{org-export-with-tags} | |
13353 | @item @code{:with-tasks} @tab @code{org-export-with-tasks} | |
13354 | @item @code{:with-timestamps} @tab @code{org-export-with-timestamps} | |
13355 | @item @code{:with-toc} @tab @code{org-export-with-toc} | |
13356 | @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords} | |
4009494e GM |
13357 | @end multitable |
13358 | ||
271672fa | 13359 | @vindex org-html-doctype |
3c8b09ca BG |
13360 | @vindex org-html-container-element |
13361 | @vindex org-html-html5-fancy | |
271672fa BG |
13362 | @vindex org-html-xml-declaration |
13363 | @vindex org-html-link-up | |
13364 | @vindex org-html-link-home | |
13365 | @vindex org-html-link-org-files-as-html | |
3c8b09ca | 13366 | @vindex org-html-link-use-abs-url |
271672fa BG |
13367 | @vindex org-html-head |
13368 | @vindex org-html-head-extra | |
13369 | @vindex org-html-inline-images | |
13370 | @vindex org-html-extension | |
13371 | @vindex org-html-preamble | |
13372 | @vindex org-html-postamble | |
13373 | @vindex org-html-table-default-attributes | |
3c8b09ca | 13374 | @vindex org-html-table-row-tags |
271672fa BG |
13375 | @vindex org-html-head-include-default-style |
13376 | @vindex org-html-head-include-scripts | |
13377 | @multitable @columnfractions 0.32 0.68 | |
13378 | @item @code{:html-doctype} @tab @code{org-html-doctype} | |
3c8b09ca BG |
13379 | @item @code{:html-container} @tab @code{org-html-container-element} |
13380 | @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy} | |
271672fa BG |
13381 | @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration} |
13382 | @item @code{:html-link-up} @tab @code{org-html-link-up} | |
13383 | @item @code{:html-link-home} @tab @code{org-html-link-home} | |
13384 | @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html} | |
3c8b09ca | 13385 | @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url} |
271672fa BG |
13386 | @item @code{:html-head} @tab @code{org-html-head} |
13387 | @item @code{:html-head-extra} @tab @code{org-html-head-extra} | |
13388 | @item @code{:html-inline-images} @tab @code{org-html-inline-images} | |
13389 | @item @code{:html-extension} @tab @code{org-html-extension} | |
13390 | @item @code{:html-preamble} @tab @code{org-html-preamble} | |
13391 | @item @code{:html-postamble} @tab @code{org-html-postamble} | |
3c8b09ca BG |
13392 | @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes} |
13393 | @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags} | |
271672fa BG |
13394 | @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style} |
13395 | @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts} | |
13396 | @end multitable | |
ce57c2fe | 13397 | |
271672fa BG |
13398 | Most of the @code{org-export-with-*} variables have the same effect in each |
13399 | exporter. | |
4009494e | 13400 | |
c8d0cf5c | 13401 | @vindex org-publish-project-alist |
271672fa BG |
13402 | When a property is given a value in @code{org-publish-project-alist}, its |
13403 | setting overrides the value of the corresponding user variable (if any) | |
13404 | during publishing. Options set within a file (@pxref{Export settings}), | |
13405 | however, override everything. | |
4009494e | 13406 | |
ed21c5c8 | 13407 | @node Publishing links, Sitemap, Publishing options, Configuration |
4009494e GM |
13408 | @subsection Links between published files |
13409 | @cindex links, publishing | |
13410 | ||
271672fa BG |
13411 | To create a link from one Org file to another, you would use something like |
13412 | @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.} | |
13413 | (@pxref{Hyperlinks}). When published, this link becomes a link to | |
13414 | @file{foo.html}. You can thus interlink the pages of your "org web" project | |
13415 | and the links will work as expected when you publish them to HTML@. If you | |
13416 | also publish the Org source file and want to link to it, use an @code{http:} | |
13417 | link instead of a @code{file:} link, because @code{file:} links are converted | |
13418 | to link to the corresponding @file{html} file. | |
4009494e | 13419 | |
ce57c2fe | 13420 | You may also link to related files, such as images. Provided you are careful |
c8d0cf5c | 13421 | with relative file names, and provided you have also configured Org to upload |
ce57c2fe | 13422 | the related files, these links will work too. See @ref{Complex example}, for |
c8d0cf5c | 13423 | an example of this usage. |
4009494e | 13424 | |
ed21c5c8 CD |
13425 | @node Sitemap, Generating an index, Publishing links, Configuration |
13426 | @subsection Generating a sitemap | |
13427 | @cindex sitemap, of published pages | |
4009494e | 13428 | |
86fbb8ca | 13429 | The following properties may be used to control publishing of |
ed21c5c8 | 13430 | a map of files for a given project. |
4009494e | 13431 | |
86fbb8ca | 13432 | @multitable @columnfractions 0.35 0.65 |
ed21c5c8 | 13433 | @item @code{:auto-sitemap} |
271672fa | 13434 | @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project} |
c8d0cf5c | 13435 | or @code{org-publish-all}. |
4009494e | 13436 | |
ed21c5c8 | 13437 | @item @code{:sitemap-filename} |
ce57c2fe | 13438 | @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which |
c8d0cf5c | 13439 | becomes @file{sitemap.html}). |
4009494e | 13440 | |
ed21c5c8 | 13441 | @item @code{:sitemap-title} |
ce57c2fe | 13442 | @tab Title of sitemap page. Defaults to name of file. |
4009494e | 13443 | |
ed21c5c8 CD |
13444 | @item @code{:sitemap-function} |
13445 | @tab Plug-in function to use for generation of the sitemap. | |
13446 | Defaults to @code{org-publish-org-sitemap}, which generates a plain list | |
4009494e | 13447 | of links to all files in the project. |
86fbb8ca CD |
13448 | |
13449 | @item @code{:sitemap-sort-folders} | |
13450 | @tab Where folders should appear in the sitemap. Set this to @code{first} | |
13451 | (default) or @code{last} to display folders first or last, | |
13452 | respectively. Any other value will mix files and folders. | |
13453 | ||
ce57c2fe BG |
13454 | @item @code{:sitemap-sort-files} |
13455 | @tab How the files are sorted in the site map. Set this to | |
13456 | @code{alphabetically} (default), @code{chronologically} or | |
13457 | @code{anti-chronologically}. @code{chronologically} sorts the files with | |
13458 | older date first while @code{anti-chronologically} sorts the files with newer | |
13459 | date first. @code{alphabetically} sorts the files alphabetically. The date of | |
13460 | a file is retrieved with @code{org-publish-find-date}. | |
86fbb8ca CD |
13461 | |
13462 | @item @code{:sitemap-ignore-case} | |
13463 | @tab Should sorting be case-sensitive? Default @code{nil}. | |
13464 | ||
ce57c2fe | 13465 | @item @code{:sitemap-file-entry-format} |
c80e3b4a | 13466 | @tab With this option one can tell how a sitemap's entry is formatted in the |
ce57c2fe BG |
13467 | sitemap. This is a format string with some escape sequences: @code{%t} stands |
13468 | for the title of the file, @code{%a} stands for the author of the file and | |
13469 | @code{%d} stands for the date of the file. The date is retrieved with the | |
c80e3b4a | 13470 | @code{org-publish-find-date} function and formatted with |
ce57c2fe BG |
13471 | @code{org-publish-sitemap-date-format}. Default @code{%t}. |
13472 | ||
13473 | @item @code{:sitemap-date-format} | |
13474 | @tab Format string for the @code{format-time-string} function that tells how | |
c80e3b4a | 13475 | a sitemap entry's date is to be formatted. This property bypasses |
ce57c2fe BG |
13476 | @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}. |
13477 | ||
13478 | @item @code{:sitemap-sans-extension} | |
271672fa | 13479 | @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap. |
ce57c2fe BG |
13480 | Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}). |
13481 | Defaults to @code{nil}. | |
13482 | ||
4009494e GM |
13483 | @end multitable |
13484 | ||
ed21c5c8 CD |
13485 | @node Generating an index, , Sitemap, Configuration |
13486 | @subsection Generating an index | |
13487 | @cindex index, in a publishing project | |
13488 | ||
e66ba1df | 13489 | Org mode can generate an index across the files of a publishing project. |
ed21c5c8 CD |
13490 | |
13491 | @multitable @columnfractions 0.25 0.75 | |
13492 | @item @code{:makeindex} | |
271672fa | 13493 | @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and |
ed21c5c8 CD |
13494 | publish it as @file{theindex.html}. |
13495 | @end multitable | |
13496 | ||
ce57c2fe | 13497 | The file will be created when first publishing a project with the |
8223b1d2 | 13498 | @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE: |
ce57c2fe BG |
13499 | "theindex.inc"}. You can then build around this include statement by adding |
13500 | a title, style information, etc. | |
ed21c5c8 | 13501 | |
c8d0cf5c CD |
13502 | @node Uploading files, Sample configuration, Configuration, Publishing |
13503 | @section Uploading files | |
13504 | @cindex rsync | |
13505 | @cindex unison | |
13506 | ||
13507 | For those people already utilizing third party sync tools such as | |
13508 | @command{rsync} or @command{unison}, it might be preferable not to use the built in | |
e66ba1df | 13509 | @i{remote} publishing facilities of Org mode which rely heavily on |
c8d0cf5c CD |
13510 | Tramp. Tramp, while very useful and powerful, tends not to be |
13511 | so efficient for multiple file transfer and has been known to cause problems | |
13512 | under heavy usage. | |
13513 | ||
13514 | Specialized synchronization utilities offer several advantages. In addition | |
13515 | to timestamp comparison, they also do content and permissions/attribute | |
13516 | checks. For this reason you might prefer to publish your web to a local | |
13517 | directory (possibly even @i{in place} with your Org files) and then use | |
13518 | @file{unison} or @file{rsync} to do the synchronization with the remote host. | |
13519 | ||
13520 | Since Unison (for example) can be configured as to which files to transfer to | |
13521 | a certain remote destination, it can greatly simplify the project publishing | |
13522 | definition. Simply keep all files in the correct location, process your Org | |
13523 | files with @code{org-publish} and let the synchronization tool do the rest. | |
13524 | You do not need, in this scenario, to include attachments such as @file{jpg}, | |
13525 | @file{css} or @file{gif} files in the project definition since the 3rd party | |
13526 | tool syncs them. | |
13527 | ||
13528 | Publishing to a local directory is also much faster than to a remote one, so | |
13529 | that you can afford more easily to republish entire projects. If you set | |
13530 | @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main | |
13531 | benefit of re-including any changed external files such as source example | |
8223b1d2 | 13532 | files you might include with @code{#+INCLUDE:}. The timestamp mechanism in |
c8d0cf5c CD |
13533 | Org is not smart enough to detect if included files have been modified. |
13534 | ||
13535 | @node Sample configuration, Triggering publication, Uploading files, Publishing | |
4009494e GM |
13536 | @section Sample configuration |
13537 | ||
13538 | Below we provide two example configurations. The first one is a simple | |
a7808fba | 13539 | project publishing only a set of Org files. The second example is |
4009494e GM |
13540 | more complex, with a multi-component project. |
13541 | ||
13542 | @menu | |
c0468714 GM |
13543 | * Simple example:: One-component publishing |
13544 | * Complex example:: A multi-component publishing example | |
4009494e GM |
13545 | @end menu |
13546 | ||
13547 | @node Simple example, Complex example, Sample configuration, Sample configuration | |
13548 | @subsection Example: simple publishing configuration | |
13549 | ||
a7808fba | 13550 | This example publishes a set of Org files to the @file{public_html} |
4009494e GM |
13551 | directory on the local machine. |
13552 | ||
13553 | @lisp | |
13554 | (setq org-publish-project-alist | |
28a16a1b | 13555 | '(("org" |
4009494e GM |
13556 | :base-directory "~/org/" |
13557 | :publishing-directory "~/public_html" | |
13558 | :section-numbers nil | |
271672fa BG |
13559 | :with-toc nil |
13560 | :html-head "<link rel=\"stylesheet\" | |
13561 | href=\"../other/mystyle.css\" | |
13562 | type=\"text/css\"/>"))) | |
4009494e GM |
13563 | @end lisp |
13564 | ||
13565 | @node Complex example, , Simple example, Sample configuration | |
13566 | @subsection Example: complex publishing configuration | |
13567 | ||
13568 | This more complicated example publishes an entire website, including | |
c8d0cf5c | 13569 | Org files converted to HTML, image files, Emacs Lisp source code, and |
ce57c2fe | 13570 | style sheets. The publishing directory is remote and private files are |
4009494e GM |
13571 | excluded. |
13572 | ||
13573 | To ensure that links are preserved, care should be taken to replicate | |
13574 | your directory structure on the web server, and to use relative file | |
ce57c2fe | 13575 | paths. For example, if your Org files are kept in @file{~/org} and your |
86fbb8ca | 13576 | publishable images in @file{~/images}, you would link to an image with |
4009494e GM |
13577 | @c |
13578 | @example | |
13579 | file:../images/myimage.png | |
13580 | @end example | |
13581 | @c | |
13582 | On the web server, the relative path to the image should be the | |
ce57c2fe | 13583 | same. You can accomplish this by setting up an "images" folder in the |
a7808fba | 13584 | right place on the web server, and publishing images to it. |
4009494e GM |
13585 | |
13586 | @lisp | |
13587 | (setq org-publish-project-alist | |
13588 | '(("orgfiles" | |
13589 | :base-directory "~/org/" | |
13590 | :base-extension "org" | |
13591 | :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
271672fa | 13592 | :publishing-function org-html-publish-to-html |
4009494e GM |
13593 | :exclude "PrivatePage.org" ;; regexp |
13594 | :headline-levels 3 | |
13595 | :section-numbers nil | |
271672fa BG |
13596 | :with-toc nil |
13597 | :html-head "<link rel=\"stylesheet\" | |
c8d0cf5c | 13598 | href=\"../other/mystyle.css\" type=\"text/css\"/>" |
ce57c2fe | 13599 | :html-preamble t) |
28a16a1b | 13600 | |
4009494e GM |
13601 | ("images" |
13602 | :base-directory "~/images/" | |
13603 | :base-extension "jpg\\|gif\\|png" | |
13604 | :publishing-directory "/ssh:user@@host:~/html/images/" | |
13605 | :publishing-function org-publish-attachment) | |
28a16a1b | 13606 | |
4009494e GM |
13607 | ("other" |
13608 | :base-directory "~/other/" | |
13609 | :base-extension "css\\|el" | |
13610 | :publishing-directory "/ssh:user@@host:~/html/other/" | |
13611 | :publishing-function org-publish-attachment) | |
13612 | ("website" :components ("orgfiles" "images" "other")))) | |
13613 | @end lisp | |
13614 | ||
13615 | @node Triggering publication, , Sample configuration, Publishing | |
13616 | @section Triggering publication | |
13617 | ||
c8d0cf5c | 13618 | Once properly configured, Org can publish with the following commands: |
4009494e GM |
13619 | |
13620 | @table @kbd | |
271672fa | 13621 | @orgcmd{C-c C-e P x,org-publish} |
4009494e | 13622 | Prompt for a specific project and publish all files that belong to it. |
271672fa | 13623 | @orgcmd{C-c C-e P p,org-publish-current-project} |
4009494e | 13624 | Publish the project containing the current file. |
271672fa | 13625 | @orgcmd{C-c C-e P f,org-publish-current-file} |
4009494e | 13626 | Publish only the current file. |
271672fa | 13627 | @orgcmd{C-c C-e P a,org-publish-all} |
c8d0cf5c | 13628 | Publish every project. |
4009494e GM |
13629 | @end table |
13630 | ||
c8d0cf5c | 13631 | @vindex org-publish-use-timestamps-flag |
ce57c2fe BG |
13632 | Org uses timestamps to track when a file has changed. The above functions |
13633 | normally only publish changed files. You can override this and force | |
c8d0cf5c CD |
13634 | publishing of all files by giving a prefix argument to any of the commands |
13635 | above, or by customizing the variable @code{org-publish-use-timestamps-flag}. | |
13636 | This may be necessary in particular if files include other files via | |
13637 | @code{#+SETUPFILE:} or @code{#+INCLUDE:}. | |
4009494e | 13638 | |
86fbb8ca CD |
13639 | @comment node-name, next, previous, up |
13640 | @comment Working With Source Code, Miscellaneous, Publishing, Top | |
13641 | ||
13642 | @node Working With Source Code, Miscellaneous, Publishing, Top | |
13643 | @chapter Working with source code | |
13644 | @cindex Schulte, Eric | |
13645 | @cindex Davison, Dan | |
13646 | @cindex source code, working with | |
13647 | ||
e66ba1df | 13648 | Source code can be included in Org mode documents using a @samp{src} block, |
1df7defd | 13649 | e.g.: |
86fbb8ca CD |
13650 | |
13651 | @example | |
13652 | #+BEGIN_SRC emacs-lisp | |
13653 | (defun org-xor (a b) | |
13654 | "Exclusive or." | |
13655 | (if a (not b) b)) | |
13656 | #+END_SRC | |
13657 | @end example | |
13658 | ||
e66ba1df | 13659 | Org mode provides a number of features for working with live source code, |
86fbb8ca | 13660 | including editing of code blocks in their native major-mode, evaluation of |
ce57c2fe BG |
13661 | code blocks, converting code blocks into source files (known as @dfn{tangling} |
13662 | in literate programming), and exporting code blocks and their | |
afe98dfa CD |
13663 | results in several formats. This functionality was contributed by Eric |
13664 | Schulte and Dan Davison, and was originally named Org-babel. | |
86fbb8ca | 13665 | |
e66ba1df | 13666 | The following sections describe Org mode's code block handling facilities. |
4009494e GM |
13667 | |
13668 | @menu | |
c0468714 GM |
13669 | * Structure of code blocks:: Code block syntax described |
13670 | * Editing source code:: Language major-mode editing | |
13671 | * Exporting code blocks:: Export contents and/or results | |
13672 | * Extracting source code:: Create pure source code files | |
e66ba1df | 13673 | * Evaluating code blocks:: Place results of evaluation in the Org mode buffer |
c0468714 GM |
13674 | * Library of Babel:: Use and contribute to a library of useful code blocks |
13675 | * Languages:: List of supported code block languages | |
13676 | * Header arguments:: Configure code block functionality | |
13677 | * Results of evaluation:: How evaluation results are handled | |
e66ba1df | 13678 | * Noweb reference syntax:: Literate programming in Org mode |
86fbb8ca | 13679 | * Key bindings and useful functions:: Work quickly with code blocks |
c0468714 | 13680 | * Batch execution:: Call functions from the command line |
4009494e GM |
13681 | @end menu |
13682 | ||
86fbb8ca CD |
13683 | @comment node-name, next, previous, up |
13684 | @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code | |
c8d0cf5c | 13685 | |
86fbb8ca CD |
13686 | @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code |
13687 | @section Structure of code blocks | |
13688 | @cindex code block, structure | |
13689 | @cindex source code, block structure | |
e66ba1df BG |
13690 | @cindex #+NAME |
13691 | @cindex #+BEGIN_SRC | |
4009494e | 13692 | |
e66ba1df BG |
13693 | Live code blocks can be specified with a @samp{src} block or |
13694 | inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's | |
13695 | @ref{Easy Templates} system} The structure of a @samp{src} block is | |
6eb02347 | 13696 | |
86fbb8ca | 13697 | @example |
e66ba1df BG |
13698 | #+NAME: <name> |
13699 | #+BEGIN_SRC <language> <switches> <header arguments> | |
86fbb8ca | 13700 | <body> |
e66ba1df | 13701 | #+END_SRC |
86fbb8ca | 13702 | @end example |
4009494e | 13703 | |
e66ba1df BG |
13704 | The @code{#+NAME:} line is optional, and can be used to name the code |
13705 | block. Live code blocks require that a language be specified on the | |
13706 | @code{#+BEGIN_SRC} line. Switches and header arguments are optional. | |
13707 | @cindex source code, inline | |
13708 | ||
13709 | Live code blocks can also be specified inline using | |
afe98dfa CD |
13710 | |
13711 | @example | |
13712 | src_<language>@{<body>@} | |
13713 | @end example | |
13714 | ||
13715 | or | |
13716 | ||
13717 | @example | |
13718 | src_<language>[<header arguments>]@{<body>@} | |
13719 | @end example | |
13720 | ||
86fbb8ca | 13721 | @table @code |
e66ba1df BG |
13722 | @item <#+NAME: name> |
13723 | This line associates a name with the code block. This is similar to the | |
271672fa | 13724 | @code{#+NAME: Name} lines that can be used to name tables in Org mode |
e66ba1df BG |
13725 | files. Referencing the name of a code block makes it possible to evaluate |
13726 | the block from other places in the file, from other files, or from Org mode | |
13727 | table formulas (see @ref{The spreadsheet}). Names are assumed to be unique | |
13728 | and the behavior of Org mode when two or more blocks share the same name is | |
ce57c2fe | 13729 | undefined. |
e66ba1df | 13730 | @cindex #+NAME |
86fbb8ca | 13731 | @item <language> |
e66ba1df BG |
13732 | The language of the code in the block (see @ref{Languages}). |
13733 | @cindex source code, language | |
86fbb8ca | 13734 | @item <switches> |
e66ba1df | 13735 | Optional switches control code block export (see the discussion of switches in |
86fbb8ca | 13736 | @ref{Literal examples}) |
e66ba1df | 13737 | @cindex source code, switches |
86fbb8ca CD |
13738 | @item <header arguments> |
13739 | Optional header arguments control many aspects of evaluation, export and | |
e66ba1df | 13740 | tangling of code blocks (see @ref{Header arguments}). |
ce57c2fe | 13741 | Header arguments can also be set on a per-buffer or per-subtree |
86fbb8ca | 13742 | basis using properties. |
e66ba1df | 13743 | @item source code, header arguments |
86fbb8ca | 13744 | @item <body> |
e66ba1df | 13745 | Source code in the specified language. |
4009494e GM |
13746 | @end table |
13747 | ||
86fbb8ca CD |
13748 | @comment node-name, next, previous, up |
13749 | @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code | |
17673adf | 13750 | |
86fbb8ca CD |
13751 | @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code |
13752 | @section Editing source code | |
13753 | @cindex code block, editing | |
13754 | @cindex source code, editing | |
17673adf | 13755 | |
271672fa BG |
13756 | @vindex org-edit-src-auto-save-idle-delay |
13757 | @vindex org-edit-src-turn-on-auto-save | |
86fbb8ca | 13758 | @kindex C-c ' |
271672fa BG |
13759 | Use @kbd{C-c '} to edit the current code block. This brings up a language |
13760 | major-mode edit buffer containing the body of the code block. Manually | |
13761 | saving this buffer with @key{C-x C-s} will write the contents back to the Org | |
13762 | buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the | |
13763 | base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save} | |
13764 | to auto-save this buffer into a separate file using @code{auto-save-mode}. | |
13765 | Use @kbd{C-c '} again to exit. | |
4009494e | 13766 | |
ce57c2fe | 13767 | The @code{org-src-mode} minor mode will be active in the edit buffer. The |
86fbb8ca | 13768 | following variables can be used to configure the behavior of the edit |
ce57c2fe | 13769 | buffer. See also the customization group @code{org-edit-structure} for |
86fbb8ca CD |
13770 | further configuration options. |
13771 | ||
13772 | @table @code | |
13773 | @item org-src-lang-modes | |
13774 | If an Emacs major-mode named @code{<lang>-mode} exists, where | |
13775 | @code{<lang>} is the language named in the header line of the code block, | |
ce57c2fe | 13776 | then the edit buffer will be placed in that major-mode. This variable |
86fbb8ca CD |
13777 | can be used to map arbitrary language names to existing major modes. |
13778 | @item org-src-window-setup | |
13779 | Controls the way Emacs windows are rearranged when the edit buffer is created. | |
13780 | @item org-src-preserve-indentation | |
13781 | This variable is especially useful for tangling languages such as | |
acedf35c | 13782 | Python, in which whitespace indentation in the output is critical. |
86fbb8ca | 13783 | @item org-src-ask-before-returning-to-edit-buffer |
ce57c2fe | 13784 | By default, Org will ask before returning to an open edit buffer. Set this |
271672fa | 13785 | variable to @code{nil} to switch without asking. |
86fbb8ca CD |
13786 | @end table |
13787 | ||
ce57c2fe BG |
13788 | To turn on native code fontification in the @emph{Org} buffer, configure the |
13789 | variable @code{org-src-fontify-natively}. | |
13790 | ||
86fbb8ca CD |
13791 | @comment node-name, next, previous, up |
13792 | @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code | |
13793 | ||
13794 | @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code | |
13795 | @section Exporting code blocks | |
13796 | @cindex code block, exporting | |
13797 | @cindex source code, exporting | |
13798 | ||
e66ba1df BG |
13799 | It is possible to export the @emph{code} of code blocks, the @emph{results} |
13800 | of code block evaluation, @emph{both} the code and the results of code block | |
13801 | evaluation, or @emph{none}. For most languages, the default exports code. | |
1df7defd | 13802 | However, for some languages (e.g., @code{ditaa}) the default exports the |
e66ba1df BG |
13803 | results of code block evaluation. For information on exporting code block |
13804 | bodies, see @ref{Literal examples}. | |
86fbb8ca CD |
13805 | |
13806 | The @code{:exports} header argument can be used to specify export | |
13807 | behavior: | |
13808 | ||
13809 | @subsubheading Header arguments: | |
271672fa | 13810 | |
86fbb8ca CD |
13811 | @table @code |
13812 | @item :exports code | |
ce57c2fe | 13813 | The default in most languages. The body of the code block is exported, as |
86fbb8ca CD |
13814 | described in @ref{Literal examples}. |
13815 | @item :exports results | |
13816 | The code block will be evaluated and the results will be placed in the | |
e66ba1df | 13817 | Org mode buffer for export, either updating previous results of the code |
86fbb8ca CD |
13818 | block located anywhere in the buffer or, if no previous results exist, |
13819 | placing the results immediately after the code block. The body of the code | |
13820 | block will not be exported. | |
13821 | @item :exports both | |
13822 | Both the code block and its results will be exported. | |
13823 | @item :exports none | |
13824 | Neither the code block nor its results will be exported. | |
13825 | @end table | |
13826 | ||
13827 | It is possible to inhibit the evaluation of code blocks during export. | |
acedf35c | 13828 | Setting the @code{org-export-babel-evaluate} variable to @code{nil} will |
86fbb8ca | 13829 | ensure that no code blocks are evaluated as part of the export process. This |
e66ba1df BG |
13830 | can be useful in situations where potentially untrusted Org mode files are |
13831 | exported in an automated fashion, for example when Org mode is used as the | |
271672fa | 13832 | markup language for a wiki. It is also possible to set this variable to |
b483c570 | 13833 | @code{'inline-only}. In that case, only inline code blocks will be |
271672fa BG |
13834 | evaluated, in order to insert their results. Non-inline code blocks are |
13835 | assumed to have their results already inserted in the buffer by manual | |
13836 | evaluation. This setting is useful to avoid expensive recalculations during | |
13837 | export, not to provide security. | |
86fbb8ca CD |
13838 | |
13839 | @comment node-name, next, previous, up | |
13840 | @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code | |
13841 | @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code | |
13842 | @section Extracting source code | |
ce57c2fe | 13843 | @cindex tangling |
86fbb8ca CD |
13844 | @cindex source code, extracting |
13845 | @cindex code block, extracting source code | |
13846 | ||
13847 | Creating pure source code files by extracting code from source blocks is | |
13848 | referred to as ``tangling''---a term adopted from the literate programming | |
13849 | community. During ``tangling'' of code blocks their bodies are expanded | |
13850 | using @code{org-babel-expand-src-block} which can expand both variable and | |
13851 | ``noweb'' style references (see @ref{Noweb reference syntax}). | |
13852 | ||
13853 | @subsubheading Header arguments | |
271672fa | 13854 | |
86fbb8ca CD |
13855 | @table @code |
13856 | @item :tangle no | |
13857 | The default. The code block is not included in the tangled output. | |
13858 | @item :tangle yes | |
ce57c2fe | 13859 | Include the code block in the tangled output. The output file name is the |
86fbb8ca CD |
13860 | name of the org file with the extension @samp{.org} replaced by the extension |
13861 | for the block language. | |
13862 | @item :tangle filename | |
13863 | Include the code block in the tangled output to file @samp{filename}. | |
13864 | @end table | |
13865 | ||
13866 | @kindex C-c C-v t | |
13867 | @subsubheading Functions | |
271672fa | 13868 | |
86fbb8ca | 13869 | @table @code |
ce57c2fe | 13870 | @item org-babel-tangle |
afe98dfa | 13871 | Tangle the current file. Bound to @kbd{C-c C-v t}. |
271672fa BG |
13872 | |
13873 | With prefix argument only tangle the current code block. | |
86fbb8ca | 13874 | @item org-babel-tangle-file |
ce57c2fe | 13875 | Choose a file to tangle. Bound to @kbd{C-c C-v f}. |
86fbb8ca CD |
13876 | @end table |
13877 | ||
13878 | @subsubheading Hooks | |
271672fa | 13879 | |
86fbb8ca CD |
13880 | @table @code |
13881 | @item org-babel-post-tangle-hook | |
13882 | This hook is run from within code files tangled by @code{org-babel-tangle}. | |
13883 | Example applications could include post-processing, compilation or evaluation | |
13884 | of tangled code files. | |
13885 | @end table | |
13886 | ||
271672fa BG |
13887 | @subsubheading Jumping between code and Org |
13888 | ||
13889 | When tangling code from an Org-mode buffer to a source code file, you'll | |
13890 | frequently find yourself viewing the file of tangled source code (e.g., many | |
13891 | debuggers point to lines of the source code file). It is useful to be able | |
13892 | to navigate from the tangled source to the Org-mode buffer from which the | |
13893 | code originated. | |
13894 | ||
13895 | The @code{org-babel-tangle-jump-to-org} function provides this jumping from | |
13896 | code to Org-mode functionality. Two header arguments are required for | |
13897 | jumping to work, first the @code{padline} (@ref{padline}) option must be set | |
13898 | to true (the default setting), second the @code{comments} (@ref{comments}) | |
13899 | header argument must be set to @code{links}, which will insert comments into | |
13900 | the source code buffer which point back to the original Org-mode file. | |
13901 | ||
86fbb8ca CD |
13902 | @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code |
13903 | @section Evaluating code blocks | |
13904 | @cindex code block, evaluating | |
13905 | @cindex source code, evaluating | |
153ae947 | 13906 | @cindex #+RESULTS |
86fbb8ca CD |
13907 | |
13908 | Code blocks can be evaluated@footnote{Whenever code is evaluated there is a | |
e66ba1df BG |
13909 | potential for that code to do harm. Org mode provides safeguards to ensure |
13910 | that code is only evaluated after explicit confirmation from the user. For | |
13911 | information on these safeguards (and on how to disable them) see @ref{Code | |
13912 | evaluation security}.} and the results of evaluation optionally placed in the | |
153ae947 BG |
13913 | Org mode buffer. The results of evaluation are placed following a line that |
13914 | begins by default with @code{#+RESULTS} and optionally a cache identifier | |
13915 | and/or the name of the evaluated code block. The default value of | |
13916 | @code{#+RESULTS} can be changed with the customizable variable | |
13917 | @code{org-babel-results-keyword}. | |
13918 | ||
13919 | By default, the evaluation facility is only enabled for Lisp code blocks | |
8223b1d2 | 13920 | specified as @code{emacs-lisp}. However, source code blocks in many languages |
153ae947 BG |
13921 | can be evaluated within Org mode (see @ref{Languages} for a list of supported |
13922 | languages and @ref{Structure of code blocks} for information on the syntax | |
13923 | used to define a code block). | |
86fbb8ca CD |
13924 | |
13925 | @kindex C-c C-c | |
13926 | There are a number of ways to evaluate code blocks. The simplest is to press | |
13927 | @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The | |
271672fa | 13928 | option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code |
86fbb8ca CD |
13929 | evaluation from the @kbd{C-c C-c} key binding.}. This will call the |
13930 | @code{org-babel-execute-src-block} function to evaluate the block and insert | |
e66ba1df BG |
13931 | its results into the Org mode buffer. |
13932 | @cindex #+CALL | |
86fbb8ca | 13933 | |
8223b1d2 BG |
13934 | It is also possible to evaluate named code blocks from anywhere in an Org |
13935 | mode buffer or an Org mode table. Live code blocks located in the current | |
e66ba1df BG |
13936 | Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel}) |
13937 | can be executed. Named code blocks can be executed with a separate | |
13938 | @code{#+CALL:} line or inline within a block of text. | |
13939 | ||
13940 | The syntax of the @code{#+CALL:} line is | |
86fbb8ca CD |
13941 | |
13942 | @example | |
e66ba1df BG |
13943 | #+CALL: <name>(<arguments>) |
13944 | #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments> | |
ce57c2fe BG |
13945 | @end example |
13946 | ||
e66ba1df | 13947 | The syntax for inline evaluation of named code blocks is |
ce57c2fe BG |
13948 | |
13949 | @example | |
e66ba1df BG |
13950 | ... call_<name>(<arguments>) ... |
13951 | ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ... | |
86fbb8ca CD |
13952 | @end example |
13953 | ||
13954 | @table @code | |
13955 | @item <name> | |
e66ba1df | 13956 | The name of the code block to be evaluated (see @ref{Structure of code blocks}). |
86fbb8ca | 13957 | @item <arguments> |
ce57c2fe | 13958 | Arguments specified in this section will be passed to the code block. These |
e66ba1df BG |
13959 | arguments use standard function call syntax, rather than |
13960 | header argument syntax. For example, a @code{#+CALL:} line that passes the | |
13961 | number four to a code block named @code{double}, which declares the header | |
13962 | argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}. | |
13963 | @item <inside header arguments> | |
13964 | Inside header arguments are passed through and applied to the named code | |
13965 | block. These arguments use header argument syntax rather than standard | |
13966 | function call syntax. Inside header arguments affect how the code block is | |
13967 | evaluated. For example, @code{[:results output]} will collect the results of | |
13968 | everything printed to @code{STDOUT} during execution of the code block. | |
13969 | @item <end header arguments> | |
13970 | End header arguments are applied to the calling instance and do not affect | |
13971 | evaluation of the named code block. They affect how the results are | |
13972 | incorporated into the Org mode buffer and how the call line is exported. For | |
13973 | example, @code{:results html} will insert the results of the call line | |
13974 | evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block. | |
13975 | ||
13976 | For more examples of passing header arguments to @code{#+CALL:} lines see | |
ce57c2fe BG |
13977 | @ref{Header arguments in function calls}. |
13978 | @end table | |
86fbb8ca CD |
13979 | |
13980 | @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code | |
13981 | @section Library of Babel | |
13982 | @cindex babel, library of | |
13983 | @cindex source code, library | |
13984 | @cindex code block, library | |
13985 | ||
e66ba1df BG |
13986 | The ``Library of Babel'' consists of code blocks that can be called from any |
13987 | Org mode file. Code blocks defined in the ``Library of Babel'' can be called | |
13988 | remotely as if they were in the current Org mode buffer (see @ref{Evaluating | |
13989 | code blocks} for information on the syntax of remote code block evaluation). | |
13990 | ||
13991 | ||
13992 | The central repository of code blocks in the ``Library of Babel'' is housed | |
13993 | in an Org mode file located in the @samp{contrib} directory of Org mode. | |
13994 | ||
13995 | Users can add code blocks they believe to be generally useful to their | |
13996 | ``Library of Babel.'' The code blocks can be stored in any Org mode file and | |
13997 | then loaded into the library with @code{org-babel-lob-ingest}. | |
86fbb8ca | 13998 | |
86fbb8ca | 13999 | |
afe98dfa | 14000 | @kindex C-c C-v i |
e66ba1df | 14001 | Code blocks located in any Org mode file can be loaded into the ``Library of |
86fbb8ca | 14002 | Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v |
afe98dfa | 14003 | i}. |
86fbb8ca CD |
14004 | |
14005 | @node Languages, Header arguments, Library of Babel, Working With Source Code | |
14006 | @section Languages | |
14007 | @cindex babel, languages | |
14008 | @cindex source code, languages | |
14009 | @cindex code block, languages | |
14010 | ||
14011 | Code blocks in the following languages are supported. | |
14012 | ||
14013 | @multitable @columnfractions 0.28 0.3 0.22 0.2 | |
14014 | @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier} | |
ce57c2fe BG |
14015 | @item Asymptote @tab asymptote @tab Awk @tab awk |
14016 | @item Emacs Calc @tab calc @tab C @tab C | |
86fbb8ca | 14017 | @item C++ @tab C++ @tab Clojure @tab clojure |
acedf35c | 14018 | @item CSS @tab css @tab ditaa @tab ditaa |
86fbb8ca CD |
14019 | @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp |
14020 | @item gnuplot @tab gnuplot @tab Haskell @tab haskell | |
ce57c2fe BG |
14021 | @item Java @tab java @tab @tab |
14022 | @item Javascript @tab js @tab LaTeX @tab latex | |
14023 | @item Ledger @tab ledger @tab Lisp @tab lisp | |
14024 | @item Lilypond @tab lilypond @tab MATLAB @tab matlab | |
86fbb8ca | 14025 | @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml |
e66ba1df | 14026 | @item Octave @tab octave @tab Org mode @tab org |
ce57c2fe BG |
14027 | @item Oz @tab oz @tab Perl @tab perl |
14028 | @item Plantuml @tab plantuml @tab Python @tab python | |
86fbb8ca | 14029 | @item R @tab R @tab Ruby @tab ruby |
ce57c2fe BG |
14030 | @item Sass @tab sass @tab Scheme @tab scheme |
14031 | @item GNU Screen @tab screen @tab shell @tab sh | |
14032 | @item SQL @tab sql @tab SQLite @tab sqlite | |
86fbb8ca CD |
14033 | @end multitable |
14034 | ||
14035 | Language-specific documentation is available for some languages. If | |
14036 | available, it can be found at | |
8223b1d2 | 14037 | @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}. |
86fbb8ca | 14038 | |
271672fa BG |
14039 | The option @code{org-babel-load-languages} controls which languages are |
14040 | enabled for evaluation (by default only @code{emacs-lisp} is enabled). This | |
14041 | variable can be set using the customization interface or by adding code like | |
14042 | the following to your emacs configuration. | |
86fbb8ca CD |
14043 | |
14044 | @quotation | |
14045 | The following disables @code{emacs-lisp} evaluation and enables evaluation of | |
14046 | @code{R} code blocks. | |
14047 | @end quotation | |
14048 | ||
14049 | @lisp | |
14050 | (org-babel-do-load-languages | |
14051 | 'org-babel-load-languages | |
14052 | '((emacs-lisp . nil) | |
14053 | (R . t))) | |
14054 | @end lisp | |
14055 | ||
14056 | It is also possible to enable support for a language by loading the related | |
14057 | elisp file with @code{require}. | |
14058 | ||
14059 | @quotation | |
14060 | The following adds support for evaluating @code{clojure} code blocks. | |
14061 | @end quotation | |
14062 | ||
14063 | @lisp | |
14064 | (require 'ob-clojure) | |
14065 | @end lisp | |
14066 | ||
14067 | @node Header arguments, Results of evaluation, Languages, Working With Source Code | |
14068 | @section Header arguments | |
14069 | @cindex code block, header arguments | |
14070 | @cindex source code, block header arguments | |
14071 | ||
14072 | Code block functionality can be configured with header arguments. This | |
14073 | section provides an overview of the use of header arguments, and then | |
14074 | describes each header argument in detail. | |
14075 | ||
14076 | @menu | |
c0468714 GM |
14077 | * Using header arguments:: Different ways to set header arguments |
14078 | * Specific header arguments:: List of header arguments | |
86fbb8ca CD |
14079 | @end menu |
14080 | ||
14081 | @node Using header arguments, Specific header arguments, Header arguments, Header arguments | |
14082 | @subsection Using header arguments | |
14083 | ||
271672fa BG |
14084 | The values of header arguments can be set in several way. When the header |
14085 | arguments in each layer have been determined, they are combined in order from | |
14086 | the first, least specific (having the lowest priority) up to the last, most | |
14087 | specific (having the highest priority). A header argument with a higher | |
14088 | priority replaces the same header argument specified at lower priority. | |
86fbb8ca CD |
14089 | @menu |
14090 | * System-wide header arguments:: Set global default values | |
c0468714 | 14091 | * Language-specific header arguments:: Set default values by language |
e66ba1df | 14092 | * Header arguments in Org mode properties:: Set default values for a buffer or heading |
271672fa | 14093 | * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading |
86fbb8ca | 14094 | * Code block specific header arguments:: The most common way to set values |
afe98dfa | 14095 | * Header arguments in function calls:: The most specific level |
86fbb8ca CD |
14096 | @end menu |
14097 | ||
14098 | ||
14099 | @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments | |
14100 | @subsubheading System-wide header arguments | |
14101 | @vindex org-babel-default-header-args | |
271672fa | 14102 | System-wide values of header arguments can be specified by adapting the |
86fbb8ca CD |
14103 | @code{org-babel-default-header-args} variable: |
14104 | ||
14105 | @example | |
14106 | :session => "none" | |
14107 | :results => "replace" | |
14108 | :exports => "code" | |
14109 | :cache => "no" | |
14110 | :noweb => "no" | |
14111 | @end example | |
14112 | ||
86fbb8ca CD |
14113 | For example, the following example could be used to set the default value of |
14114 | @code{:noweb} header arguments to @code{yes}. This would have the effect of | |
14115 | expanding @code{:noweb} references by default when evaluating source code | |
14116 | blocks. | |
14117 | ||
14118 | @lisp | |
14119 | (setq org-babel-default-header-args | |
63aa0982 | 14120 | (cons '(:noweb . "yes") |
271672fa | 14121 | (assq-delete-all :noweb org-babel-default-header-args))) |
86fbb8ca CD |
14122 | @end lisp |
14123 | ||
271672fa | 14124 | @node Language-specific header arguments, Header arguments in Org mode properties, System-wide header arguments, Using header arguments |
86fbb8ca | 14125 | @subsubheading Language-specific header arguments |
271672fa BG |
14126 | Each language can define its own set of default header arguments in variable |
14127 | @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name | |
14128 | of the language. See the language-specific documentation available online at | |
86fbb8ca CD |
14129 | @uref{http://orgmode.org/worg/org-contrib/babel}. |
14130 | ||
271672fa BG |
14131 | @node Header arguments in Org mode properties, Language-specific header arguments in Org mode properties, Language-specific header arguments, Using header arguments |
14132 | @subsubheading Header arguments in Org mode properties | |
14133 | ||
e66ba1df BG |
14134 | Buffer-wide header arguments may be specified as properties through the use |
14135 | of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see | |
14136 | @ref{Property syntax}). | |
86fbb8ca | 14137 | |
271672fa BG |
14138 | For example the following would set @code{session} to @code{*R*} (only for R |
14139 | code blocks), and @code{results} to @code{silent} for every code block in the | |
14140 | buffer, ensuring that all execution took place in the same session, and no | |
14141 | results would be inserted into the buffer. | |
86fbb8ca CD |
14142 | |
14143 | @example | |
271672fa BG |
14144 | #+PROPERTY: header-args:R :session *R* |
14145 | #+PROPERTY: header-args :results silent | |
86fbb8ca CD |
14146 | @end example |
14147 | ||
271672fa BG |
14148 | Header arguments read from Org mode properties can also be set on a |
14149 | per-subtree basis using property drawers (see @ref{Property syntax}). | |
e66ba1df | 14150 | @vindex org-use-property-inheritance |
271672fa BG |
14151 | When properties are used to set default header arguments, they are always |
14152 | looked up with inheritance, regardless of the value of | |
14153 | @code{org-use-property-inheritance}. Properties are evaluated as seen by the | |
14154 | outermost call or source block.@footnote{The deprecated syntax for default | |
14155 | header argument properties, using the name of the header argument as a | |
14156 | property name directly, evaluates the property as seen by the corresponding | |
da5ecfa9 | 14157 | source block definition. This behavior has been kept for backwards |
271672fa BG |
14158 | compatibility.} |
14159 | ||
14160 | In the following example the value of | |
e66ba1df BG |
14161 | the @code{:cache} header argument will default to @code{yes} in all code |
14162 | blocks in the subtree rooted at the following heading: | |
86fbb8ca CD |
14163 | |
14164 | @example | |
14165 | * outline header | |
63aa0982 | 14166 | :PROPERTIES: |
271672fa | 14167 | :header-args: :cache yes |
63aa0982 | 14168 | :END: |
86fbb8ca CD |
14169 | @end example |
14170 | ||
14171 | @kindex C-c C-x p | |
14172 | @vindex org-babel-default-header-args | |
14173 | Properties defined in this way override the properties set in | |
271672fa BG |
14174 | @code{org-babel-default-header-args} and are applied for all activated |
14175 | languages. It is convenient to use the @code{org-set-property} function | |
14176 | bound to @kbd{C-c C-x p} to set properties in Org mode documents. | |
14177 | ||
14178 | @node Language-specific header arguments in Org mode properties, Code block specific header arguments, Header arguments in Org mode properties, Using header arguments | |
14179 | @subsubheading Language-specific header arguments in Org mode properties | |
14180 | ||
14181 | Language-specific header arguments are also read from properties | |
14182 | @code{header-args:<lang>} where @code{<lang>} is the name of the language | |
14183 | targeted. As an example | |
14184 | ||
14185 | @example | |
14186 | * Heading | |
14187 | :PROPERTIES: | |
14188 | :header-args:clojure: :session *clojure-1* | |
14189 | :header-args:R: :session *R* | |
14190 | :END: | |
14191 | ** Subheading | |
14192 | :PROPERTIES: | |
14193 | :header-args:clojure: :session *clojure-2* | |
14194 | :END: | |
14195 | @end example | |
14196 | ||
14197 | would independently set a default session header argument for R and clojure | |
14198 | for calls and source blocks under subtree ``Heading'' and change to a | |
14199 | different clojure setting for evaluations under subtree ``Subheading'', while | |
14200 | the R session is inherited from ``Heading'' and therefore unchanged. | |
86fbb8ca | 14201 | |
271672fa | 14202 | @node Code block specific header arguments, Header arguments in function calls, Language-specific header arguments in Org mode properties, Using header arguments |
86fbb8ca CD |
14203 | @subsubheading Code block specific header arguments |
14204 | ||
14205 | The most common way to assign values to header arguments is at the | |
14206 | code block level. This can be done by listing a sequence of header | |
e66ba1df | 14207 | arguments and their values as part of the @code{#+BEGIN_SRC} line. |
86fbb8ca CD |
14208 | Properties set in this way override both the values of |
14209 | @code{org-babel-default-header-args} and header arguments specified as | |
14210 | properties. In the following example, the @code{:results} header argument | |
14211 | is set to @code{silent}, meaning the results of execution will not be | |
14212 | inserted in the buffer, and the @code{:exports} header argument is set to | |
14213 | @code{code}, meaning only the body of the code block will be | |
e66ba1df | 14214 | preserved on export to HTML or @LaTeX{}. |
86fbb8ca CD |
14215 | |
14216 | @example | |
e66ba1df BG |
14217 | #+NAME: factorial |
14218 | #+BEGIN_SRC haskell :results silent :exports code :var n=0 | |
86fbb8ca CD |
14219 | fac 0 = 1 |
14220 | fac n = n * fac (n-1) | |
e66ba1df | 14221 | #+END_SRC |
86fbb8ca | 14222 | @end example |
e66ba1df | 14223 | Similarly, it is possible to set header arguments for inline code blocks |
86fbb8ca CD |
14224 | |
14225 | @example | |
14226 | src_haskell[:exports both]@{fac 5@} | |
14227 | @end example | |
14228 | ||
e66ba1df BG |
14229 | Code block header arguments can span multiple lines using @code{#+HEADER:} or |
14230 | @code{#+HEADERS:} lines preceding a code block or nested between the | |
14231 | @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block. | |
14232 | @cindex #+HEADER: | |
14233 | @cindex #+HEADERS: | |
ce57c2fe BG |
14234 | |
14235 | Multi-line header arguments on an un-named code block: | |
63aa0982 | 14236 | |
ce57c2fe | 14237 | @example |
e66ba1df BG |
14238 | #+HEADERS: :var data1=1 |
14239 | #+BEGIN_SRC emacs-lisp :var data2=2 | |
ce57c2fe | 14240 | (message "data1:%S, data2:%S" data1 data2) |
e66ba1df | 14241 | #+END_SRC |
ce57c2fe | 14242 | |
8223b1d2 | 14243 | #+RESULTS: |
ce57c2fe BG |
14244 | : data1:1, data2:2 |
14245 | @end example | |
14246 | ||
14247 | Multi-line header arguments on a named code block: | |
63aa0982 | 14248 | |
ce57c2fe | 14249 | @example |
e66ba1df BG |
14250 | #+NAME: named-block |
14251 | #+HEADER: :var data=2 | |
14252 | #+BEGIN_SRC emacs-lisp | |
ce57c2fe | 14253 | (message "data:%S" data) |
e66ba1df | 14254 | #+END_SRC |
ce57c2fe | 14255 | |
8223b1d2 | 14256 | #+RESULTS: named-block |
ce57c2fe BG |
14257 | : data:2 |
14258 | @end example | |
14259 | ||
afe98dfa CD |
14260 | @node Header arguments in function calls, , Code block specific header arguments, Using header arguments |
14261 | @comment node-name, next, previous, up | |
14262 | @subsubheading Header arguments in function calls | |
14263 | ||
14264 | At the most specific level, header arguments for ``Library of Babel'' or | |
e66ba1df BG |
14265 | @code{#+CALL:} lines can be set as shown in the two examples below. For more |
14266 | information on the structure of @code{#+CALL:} lines see @ref{Evaluating code | |
ce57c2fe | 14267 | blocks}. |
86fbb8ca | 14268 | |
ce57c2fe | 14269 | The following will apply the @code{:exports results} header argument to the |
e66ba1df | 14270 | evaluation of the @code{#+CALL:} line. |
63aa0982 | 14271 | |
86fbb8ca | 14272 | @example |
e66ba1df | 14273 | #+CALL: factorial(n=5) :exports results |
86fbb8ca CD |
14274 | @end example |
14275 | ||
ce57c2fe BG |
14276 | The following will apply the @code{:session special} header argument to the |
14277 | evaluation of the @code{factorial} code block. | |
63aa0982 | 14278 | |
ce57c2fe | 14279 | @example |
e66ba1df | 14280 | #+CALL: factorial[:session special](n=5) |
ce57c2fe BG |
14281 | @end example |
14282 | ||
86fbb8ca CD |
14283 | @node Specific header arguments, , Using header arguments, Header arguments |
14284 | @subsection Specific header arguments | |
e66ba1df BG |
14285 | Header arguments consist of an initial colon followed by the name of the |
14286 | argument in lowercase letters. The following header arguments are defined: | |
86fbb8ca CD |
14287 | |
14288 | @menu | |
c0468714 GM |
14289 | * var:: Pass arguments to code blocks |
14290 | * results:: Specify the type of results and how they will | |
86fbb8ca | 14291 | be collected and handled |
c0468714 | 14292 | * file:: Specify a path for file output |
8223b1d2 | 14293 | * file-desc:: Specify a description for file results |
c0468714 | 14294 | * dir:: Specify the default (possibly remote) |
86fbb8ca | 14295 | directory for code block execution |
c0468714 GM |
14296 | * exports:: Export code and/or results |
14297 | * tangle:: Toggle tangling and specify file name | |
ce57c2fe BG |
14298 | * mkdirp:: Toggle creation of parent directories of target |
14299 | files during tangling | |
86fbb8ca CD |
14300 | * comments:: Toggle insertion of comments in tangled |
14301 | code files | |
ce57c2fe BG |
14302 | * padline:: Control insertion of padding lines in tangled |
14303 | code files | |
afe98dfa CD |
14304 | * no-expand:: Turn off variable assignment and noweb |
14305 | expansion during tangling | |
c0468714 GM |
14306 | * session:: Preserve the state of code evaluation |
14307 | * noweb:: Toggle expansion of noweb references | |
ce57c2fe | 14308 | * noweb-ref:: Specify block's noweb reference resolution target |
153ae947 | 14309 | * noweb-sep:: String used to separate noweb references |
c0468714 | 14310 | * cache:: Avoid re-evaluating unchanged code blocks |
ce57c2fe | 14311 | * sep:: Delimiter for writing tabular results outside Org |
c0468714 GM |
14312 | * hlines:: Handle horizontal lines in tables |
14313 | * colnames:: Handle column names in tables | |
14314 | * rownames:: Handle row names in tables | |
14315 | * shebang:: Make tangled files executable | |
271672fa | 14316 | * tangle-mode:: Set permission of tangled files |
86fbb8ca | 14317 | * eval:: Limit evaluation of specific code blocks |
8223b1d2 | 14318 | * wrap:: Mark source block evaluation results |
271672fa BG |
14319 | * post:: Post processing of code block results |
14320 | * prologue:: Text to prepend to code block body | |
14321 | * epilogue:: Text to append to code block body | |
86fbb8ca CD |
14322 | @end menu |
14323 | ||
ce57c2fe BG |
14324 | Additional header arguments are defined on a language-specific basis, see |
14325 | @ref{Languages}. | |
14326 | ||
86fbb8ca CD |
14327 | @node var, results, Specific header arguments, Specific header arguments |
14328 | @subsubsection @code{:var} | |
14329 | The @code{:var} header argument is used to pass arguments to code blocks. | |
14330 | The specifics of how arguments are included in a code block vary by language; | |
ce57c2fe | 14331 | these are addressed in the language-specific documentation. However, the |
e66ba1df BG |
14332 | syntax used to specify arguments is the same across all languages. In every |
14333 | case, variables require a default value when they are declared. | |
14334 | ||
14335 | The values passed to arguments can either be literal values, references, or | |
271672fa BG |
14336 | Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). |
14337 | References include anything in the Org mode file that takes a @code{#+NAME:} | |
14338 | or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks, | |
14339 | other code blocks and the results of other code blocks. | |
14340 | ||
14341 | Note: When a reference is made to another code block, the referenced block | |
14342 | will be evaluated unless it has current cached results (see @ref{cache}). | |
86fbb8ca | 14343 | |
e66ba1df BG |
14344 | Argument values can be indexed in a manner similar to arrays (see @ref{var, |
14345 | Indexable variable values}). | |
86fbb8ca CD |
14346 | |
14347 | The following syntax is used to pass arguments to code blocks using the | |
14348 | @code{:var} header argument. | |
14349 | ||
14350 | @example | |
14351 | :var name=assign | |
14352 | @end example | |
14353 | ||
e66ba1df BG |
14354 | The argument, @code{assign}, can either be a literal value, such as a string |
14355 | @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a | |
14356 | literal example, another code block (with or without arguments), or the | |
14357 | results of evaluating another code block. | |
86fbb8ca | 14358 | |
e66ba1df BG |
14359 | Here are examples of passing values by reference: |
14360 | ||
14361 | @table @dfn | |
86fbb8ca | 14362 | |
e66ba1df | 14363 | @item table |
271672fa | 14364 | an Org mode table named with either a @code{#+NAME:} line |
63aa0982 | 14365 | |
86fbb8ca | 14366 | @example |
271672fa | 14367 | #+NAME: example-table |
86fbb8ca CD |
14368 | | 1 | |
14369 | | 2 | | |
14370 | | 3 | | |
14371 | | 4 | | |
14372 | ||
e66ba1df BG |
14373 | #+NAME: table-length |
14374 | #+BEGIN_SRC emacs-lisp :var table=example-table | |
86fbb8ca | 14375 | (length table) |
e66ba1df | 14376 | #+END_SRC |
86fbb8ca | 14377 | |
8223b1d2 | 14378 | #+RESULTS: table-length |
86fbb8ca CD |
14379 | : 4 |
14380 | @end example | |
14381 | ||
e66ba1df BG |
14382 | @item list |
14383 | a simple list named with a @code{#+NAME:} line (note that nesting is not | |
14384 | carried through to the source code block) | |
86fbb8ca CD |
14385 | |
14386 | @example | |
e66ba1df BG |
14387 | #+NAME: example-list |
14388 | - simple | |
14389 | - not | |
14390 | - nested | |
14391 | - list | |
14392 | ||
14393 | #+BEGIN_SRC emacs-lisp :var x=example-list | |
14394 | (print x) | |
14395 | #+END_SRC | |
14396 | ||
8223b1d2 | 14397 | #+RESULTS: |
e66ba1df BG |
14398 | | simple | list | |
14399 | @end example | |
14400 | ||
14401 | @item code block without arguments | |
14402 | a code block name (from the example above), as assigned by @code{#+NAME:}, | |
14403 | optionally followed by parentheses | |
14404 | ||
14405 | @example | |
14406 | #+BEGIN_SRC emacs-lisp :var length=table-length() | |
86fbb8ca | 14407 | (* 2 length) |
e66ba1df | 14408 | #+END_SRC |
86fbb8ca | 14409 | |
8223b1d2 | 14410 | #+RESULTS: |
86fbb8ca CD |
14411 | : 8 |
14412 | @end example | |
14413 | ||
e66ba1df BG |
14414 | @item code block with arguments |
14415 | a code block name, as assigned by @code{#+NAME:}, followed by parentheses and | |
14416 | optional arguments passed within the parentheses following the | |
14417 | code block name using standard function call syntax | |
86fbb8ca CD |
14418 | |
14419 | @example | |
e66ba1df BG |
14420 | #+NAME: double |
14421 | #+BEGIN_SRC emacs-lisp :var input=8 | |
86fbb8ca | 14422 | (* 2 input) |
e66ba1df | 14423 | #+END_SRC |
86fbb8ca | 14424 | |
8223b1d2 | 14425 | #+RESULTS: double |
86fbb8ca CD |
14426 | : 16 |
14427 | ||
e66ba1df BG |
14428 | #+NAME: squared |
14429 | #+BEGIN_SRC emacs-lisp :var input=double(input=1) | |
86fbb8ca | 14430 | (* input input) |
e66ba1df | 14431 | #+END_SRC |
86fbb8ca | 14432 | |
8223b1d2 | 14433 | #+RESULTS: squared |
86fbb8ca CD |
14434 | : 4 |
14435 | @end example | |
e66ba1df BG |
14436 | |
14437 | @item literal example | |
14438 | a literal example block named with a @code{#+NAME:} line | |
14439 | ||
14440 | @example | |
14441 | #+NAME: literal-example | |
14442 | #+BEGIN_EXAMPLE | |
14443 | A literal example | |
14444 | on two lines | |
14445 | #+END_EXAMPLE | |
14446 | ||
14447 | #+NAME: read-literal-example | |
14448 | #+BEGIN_SRC emacs-lisp :var x=literal-example | |
14449 | (concatenate 'string x " for you.") | |
14450 | #+END_SRC | |
14451 | ||
8223b1d2 | 14452 | #+RESULTS: read-literal-example |
e66ba1df BG |
14453 | : A literal example |
14454 | : on two lines for you. | |
14455 | ||
14456 | @end example | |
14457 | ||
14458 | @end table | |
86fbb8ca | 14459 | |
86fbb8ca CD |
14460 | @subsubheading Indexable variable values |
14461 | It is possible to reference portions of variable values by ``indexing'' into | |
14462 | the variables. Indexes are 0 based with negative values counting back from | |
14463 | the end. If an index is separated by @code{,}s then each subsequent section | |
ce57c2fe BG |
14464 | will index into the next deepest nesting or dimension of the value. Note |
14465 | that this indexing occurs @emph{before} other table related header arguments | |
14466 | like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The | |
86fbb8ca CD |
14467 | following example assigns the last cell of the first row the table |
14468 | @code{example-table} to the variable @code{data}: | |
14469 | ||
14470 | @example | |
e66ba1df | 14471 | #+NAME: example-table |
86fbb8ca CD |
14472 | | 1 | a | |
14473 | | 2 | b | | |
14474 | | 3 | c | | |
14475 | | 4 | d | | |
14476 | ||
e66ba1df | 14477 | #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1] |
86fbb8ca | 14478 | data |
e66ba1df | 14479 | #+END_SRC |
86fbb8ca | 14480 | |
8223b1d2 | 14481 | #+RESULTS: |
86fbb8ca CD |
14482 | : a |
14483 | @end example | |
14484 | ||
14485 | Ranges of variable values can be referenced using two integers separated by a | |
14486 | @code{:}, in which case the entire inclusive range is referenced. For | |
14487 | example the following assigns the middle three rows of @code{example-table} | |
14488 | to @code{data}. | |
14489 | ||
14490 | @example | |
e66ba1df | 14491 | #+NAME: example-table |
86fbb8ca CD |
14492 | | 1 | a | |
14493 | | 2 | b | | |
14494 | | 3 | c | | |
14495 | | 4 | d | | |
14496 | | 5 | 3 | | |
14497 | ||
e66ba1df | 14498 | #+BEGIN_SRC emacs-lisp :var data=example-table[1:3] |
86fbb8ca | 14499 | data |
e66ba1df | 14500 | #+END_SRC |
86fbb8ca | 14501 | |
8223b1d2 | 14502 | #+RESULTS: |
86fbb8ca CD |
14503 | | 2 | b | |
14504 | | 3 | c | | |
14505 | | 4 | d | | |
14506 | @end example | |
14507 | ||
14508 | Additionally, an empty index, or the single character @code{*}, are both | |
14509 | interpreted to mean the entire range and as such are equivalent to | |
14510 | @code{0:-1}, as shown in the following example in which the entire first | |
14511 | column is referenced. | |
14512 | ||
14513 | @example | |
e66ba1df | 14514 | #+NAME: example-table |
86fbb8ca CD |
14515 | | 1 | a | |
14516 | | 2 | b | | |
14517 | | 3 | c | | |
14518 | | 4 | d | | |
14519 | ||
e66ba1df | 14520 | #+BEGIN_SRC emacs-lisp :var data=example-table[,0] |
86fbb8ca | 14521 | data |
e66ba1df | 14522 | #+END_SRC |
86fbb8ca | 14523 | |
8223b1d2 | 14524 | #+RESULTS: |
86fbb8ca CD |
14525 | | 1 | 2 | 3 | 4 | |
14526 | @end example | |
14527 | ||
14528 | It is possible to index into the results of code blocks as well as tables. | |
14529 | Any number of dimensions can be indexed. Dimensions are separated from one | |
14530 | another by commas, as shown in the following example. | |
14531 | ||
14532 | @example | |
e66ba1df BG |
14533 | #+NAME: 3D |
14534 | #+BEGIN_SRC emacs-lisp | |
86fbb8ca CD |
14535 | '(((1 2 3) (4 5 6) (7 8 9)) |
14536 | ((10 11 12) (13 14 15) (16 17 18)) | |
14537 | ((19 20 21) (22 23 24) (25 26 27))) | |
e66ba1df | 14538 | #+END_SRC |
86fbb8ca | 14539 | |
e66ba1df | 14540 | #+BEGIN_SRC emacs-lisp :var data=3D[1,,1] |
86fbb8ca | 14541 | data |
e66ba1df | 14542 | #+END_SRC |
86fbb8ca | 14543 | |
8223b1d2 | 14544 | #+RESULTS: |
86fbb8ca CD |
14545 | | 11 | 14 | 17 | |
14546 | @end example | |
14547 | ||
ce57c2fe BG |
14548 | @subsubheading Emacs Lisp evaluation of variables |
14549 | ||
14550 | Emacs lisp code can be used to initialize variable values. When a variable | |
e66ba1df BG |
14551 | value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be |
14552 | evaluated as Emacs Lisp and the result of the evaluation will be assigned as | |
14553 | the variable value. The following example demonstrates use of this | |
14554 | evaluation to reliably pass the file-name of the Org mode buffer to a code | |
14555 | block---note that evaluation of header arguments is guaranteed to take place | |
14556 | in the original Org mode file, while there is no such guarantee for | |
14557 | evaluation of the code block body. | |
ce57c2fe BG |
14558 | |
14559 | @example | |
e66ba1df | 14560 | #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both |
ce57c2fe | 14561 | wc -w $filename |
e66ba1df | 14562 | #+END_SRC |
ce57c2fe BG |
14563 | @end example |
14564 | ||
14565 | Note that values read from tables and lists will not be evaluated as | |
14566 | Emacs Lisp, as shown in the following example. | |
14567 | ||
14568 | @example | |
e66ba1df | 14569 | #+NAME: table |
ce57c2fe BG |
14570 | | (a b c) | |
14571 | ||
e66ba1df BG |
14572 | #+HEADERS: :var data=table[0,0] |
14573 | #+BEGIN_SRC perl | |
ce57c2fe | 14574 | $data |
e66ba1df | 14575 | #+END_SRC |
ce57c2fe | 14576 | |
8223b1d2 | 14577 | #+RESULTS: |
ce57c2fe BG |
14578 | : (a b c) |
14579 | @end example | |
14580 | ||
86fbb8ca CD |
14581 | @node results, file, var, Specific header arguments |
14582 | @subsubsection @code{:results} | |
14583 | ||
271672fa | 14584 | There are four classes of @code{:results} header argument. Only one option |
acedf35c | 14585 | per class may be supplied per code block. |
86fbb8ca CD |
14586 | |
14587 | @itemize @bullet | |
14588 | @item | |
14589 | @b{collection} header arguments specify how the results should be collected | |
14590 | from the code block | |
14591 | @item | |
14592 | @b{type} header arguments specify what type of result the code block will | |
271672fa BG |
14593 | return---which has implications for how they will be processed before |
14594 | insertion into the Org mode buffer | |
14595 | @item | |
14596 | @b{format} header arguments specify what type of result the code block will | |
86fbb8ca | 14597 | return---which has implications for how they will be inserted into the |
e66ba1df | 14598 | Org mode buffer |
86fbb8ca CD |
14599 | @item |
14600 | @b{handling} header arguments specify how the results of evaluating the code | |
14601 | block should be handled. | |
14602 | @end itemize | |
14603 | ||
14604 | @subsubheading Collection | |
14605 | The following options are mutually exclusive, and specify how the results | |
14606 | should be collected from the code block. | |
14607 | ||
14608 | @itemize @bullet | |
14609 | @item @code{value} | |
14610 | This is the default. The result is the value of the last statement in the | |
14611 | code block. This header argument places the evaluation in functional | |
acedf35c | 14612 | mode. Note that in some languages, e.g., Python, use of this result type |
86fbb8ca | 14613 | requires that a @code{return} statement be included in the body of the source |
ce57c2fe | 14614 | code block. E.g., @code{:results value}. |
86fbb8ca CD |
14615 | @item @code{output} |
14616 | The result is the collection of everything printed to STDOUT during the | |
14617 | execution of the code block. This header argument places the | |
14618 | evaluation in scripting mode. E.g., @code{:results output}. | |
14619 | @end itemize | |
14620 | ||
14621 | @subsubheading Type | |
14622 | ||
14623 | The following options are mutually exclusive and specify what type of results | |
14624 | the code block will return. By default, results are inserted as either a | |
14625 | table or scalar depending on their value. | |
14626 | ||
14627 | @itemize @bullet | |
14628 | @item @code{table}, @code{vector} | |
e66ba1df | 14629 | The results should be interpreted as an Org mode table. If a single value is |
86fbb8ca CD |
14630 | returned, it will be converted into a table with one row and one column. |
14631 | E.g., @code{:results value table}. | |
acedf35c | 14632 | @item @code{list} |
e66ba1df | 14633 | The results should be interpreted as an Org mode list. If a single scalar |
acedf35c | 14634 | value is returned it will be converted into a list with only one element. |
86fbb8ca CD |
14635 | @item @code{scalar}, @code{verbatim} |
14636 | The results should be interpreted literally---they will not be | |
e66ba1df | 14637 | converted into a table. The results will be inserted into the Org mode |
86fbb8ca CD |
14638 | buffer as quoted text. E.g., @code{:results value verbatim}. |
14639 | @item @code{file} | |
14640 | The results will be interpreted as the path to a file, and will be inserted | |
e66ba1df | 14641 | into the Org mode buffer as a file link. E.g., @code{:results value file}. |
271672fa BG |
14642 | @end itemize |
14643 | ||
14644 | @subsubheading Format | |
14645 | ||
14646 | The following options are mutually exclusive and specify what type of results | |
14647 | the code block will return. By default, results are inserted according to the | |
14648 | type as specified above. | |
14649 | ||
14650 | @itemize @bullet | |
8223b1d2 | 14651 | @item @code{raw} |
e66ba1df | 14652 | The results are interpreted as raw Org mode code and are inserted directly |
86fbb8ca | 14653 | into the buffer. If the results look like a table they will be aligned as |
e66ba1df | 14654 | such by Org mode. E.g., @code{:results value raw}. |
8223b1d2 BG |
14655 | @item @code{org} |
14656 | The results are will be enclosed in a @code{BEGIN_SRC org} block. | |
14657 | They are not comma-escaped by default but they will be if you hit @kbd{TAB} | |
14658 | in the block and/or if you export the file. E.g., @code{:results value org}. | |
86fbb8ca | 14659 | @item @code{html} |
8223b1d2 | 14660 | Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML} |
86fbb8ca CD |
14661 | block. E.g., @code{:results value html}. |
14662 | @item @code{latex} | |
8223b1d2 | 14663 | Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block. |
86fbb8ca CD |
14664 | E.g., @code{:results value latex}. |
14665 | @item @code{code} | |
fac916bf | 14666 | Result are assumed to be parsable code and are enclosed in a code block. |
86fbb8ca CD |
14667 | E.g., @code{:results value code}. |
14668 | @item @code{pp} | |
14669 | The result is converted to pretty-printed code and is enclosed in a code | |
acedf35c | 14670 | block. This option currently supports Emacs Lisp, Python, and Ruby. E.g., |
86fbb8ca | 14671 | @code{:results value pp}. |
8223b1d2 | 14672 | @item @code{drawer} |
153ae947 | 14673 | The result is wrapped in a RESULTS drawer. This can be useful for |
ce57c2fe | 14674 | inserting @code{raw} or @code{org} syntax results in such a way that their |
153ae947 | 14675 | extent is known and they can be automatically removed or replaced. |
86fbb8ca CD |
14676 | @end itemize |
14677 | ||
14678 | @subsubheading Handling | |
14679 | The following results options indicate what happens with the | |
14680 | results once they are collected. | |
14681 | ||
14682 | @itemize @bullet | |
14683 | @item @code{silent} | |
14684 | The results will be echoed in the minibuffer but will not be inserted into | |
e66ba1df | 14685 | the Org mode buffer. E.g., @code{:results output silent}. |
86fbb8ca CD |
14686 | @item @code{replace} |
14687 | The default value. Any existing results will be removed, and the new results | |
e66ba1df | 14688 | will be inserted into the Org mode buffer in their place. E.g., |
86fbb8ca CD |
14689 | @code{:results output replace}. |
14690 | @item @code{append} | |
14691 | If there are pre-existing results of the code block then the new results will | |
14692 | be appended to the existing results. Otherwise the new results will be | |
14693 | inserted as with @code{replace}. | |
14694 | @item @code{prepend} | |
14695 | If there are pre-existing results of the code block then the new results will | |
14696 | be prepended to the existing results. Otherwise the new results will be | |
14697 | inserted as with @code{replace}. | |
14698 | @end itemize | |
14699 | ||
8223b1d2 | 14700 | @node file, file-desc, results, Specific header arguments |
86fbb8ca CD |
14701 | @subsubsection @code{:file} |
14702 | ||
ce57c2fe | 14703 | The header argument @code{:file} is used to specify an external file in which |
e66ba1df | 14704 | to save code block results. After code block evaluation an Org mode style |
ce57c2fe | 14705 | @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted |
e66ba1df | 14706 | into the Org mode buffer. Some languages including R, gnuplot, dot, and |
ce57c2fe BG |
14707 | ditaa provide special handling of the @code{:file} header argument |
14708 | automatically wrapping the code block body in the boilerplate code required | |
14709 | to save output to the specified file. This is often useful for saving | |
14710 | graphical output of a code block to the specified file. | |
86fbb8ca | 14711 | |
ce57c2fe BG |
14712 | The argument to @code{:file} should be either a string specifying the path to |
14713 | a file, or a list of two strings in which case the first element of the list | |
14714 | should be the path to a file and the second a description for the link. | |
86fbb8ca | 14715 | |
8223b1d2 BG |
14716 | @node file-desc, dir, file, Specific header arguments |
14717 | @subsubsection @code{:file-desc} | |
14718 | ||
14719 | The value of the @code{:file-desc} header argument is used to provide a | |
14720 | description for file code block results which are inserted as Org mode links | |
14721 | (see @ref{Link format}). If the @code{:file-desc} header argument is given | |
14722 | with no value the link path will be placed in both the ``link'' and the | |
14723 | ``description'' portion of the Org mode link. | |
14724 | ||
14725 | @node dir, exports, file-desc, Specific header arguments | |
86fbb8ca CD |
14726 | @subsubsection @code{:dir} and remote execution |
14727 | ||
14728 | While the @code{:file} header argument can be used to specify the path to the | |
14729 | output file, @code{:dir} specifies the default directory during code block | |
ce57c2fe BG |
14730 | execution. If it is absent, then the directory associated with the current |
14731 | buffer is used. In other words, supplying @code{:dir path} temporarily has | |
271672fa | 14732 | the same effect as changing the current directory with @kbd{M-x cd path RET}, and |
ce57c2fe | 14733 | then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets |
86fbb8ca CD |
14734 | the value of the Emacs variable @code{default-directory}. |
14735 | ||
14736 | When using @code{:dir}, you should supply a relative path for file output | |
1df7defd | 14737 | (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which |
86fbb8ca CD |
14738 | case that path will be interpreted relative to the default directory. |
14739 | ||
acedf35c CD |
14740 | In other words, if you want your plot to go into a folder called @file{Work} |
14741 | in your home directory, you could use | |
86fbb8ca CD |
14742 | |
14743 | @example | |
e66ba1df | 14744 | #+BEGIN_SRC R :file myplot.png :dir ~/Work |
86fbb8ca | 14745 | matplot(matrix(rnorm(100), 10), type="l") |
e66ba1df | 14746 | #+END_SRC |
86fbb8ca CD |
14747 | @end example |
14748 | ||
14749 | @subsubheading Remote execution | |
14750 | A directory on a remote machine can be specified using tramp file syntax, in | |
ce57c2fe | 14751 | which case the code will be evaluated on the remote machine. An example is |
86fbb8ca CD |
14752 | |
14753 | @example | |
e66ba1df | 14754 | #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu: |
86fbb8ca | 14755 | plot(1:10, main=system("hostname", intern=TRUE)) |
e66ba1df | 14756 | #+END_SRC |
86fbb8ca CD |
14757 | @end example |
14758 | ||
e66ba1df | 14759 | Text results will be returned to the local Org mode buffer as usual, and file |
86fbb8ca | 14760 | output will be created on the remote machine with relative paths interpreted |
e66ba1df | 14761 | relative to the remote directory. An Org mode link to the remote file will be |
86fbb8ca CD |
14762 | created. |
14763 | ||
14764 | So, in the above example a plot will be created on the remote machine, | |
14765 | and a link of the following form will be inserted in the org buffer: | |
14766 | ||
14767 | @example | |
14768 | [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]] | |
14769 | @end example | |
14770 | ||
14771 | Most of this functionality follows immediately from the fact that @code{:dir} | |
14772 | sets the value of the Emacs variable @code{default-directory}, thanks to | |
ce57c2fe | 14773 | tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to |
acedf35c | 14774 | install tramp separately in order for these features to work correctly. |
86fbb8ca CD |
14775 | |
14776 | @subsubheading Further points | |
14777 | ||
14778 | @itemize @bullet | |
14779 | @item | |
14780 | If @code{:dir} is used in conjunction with @code{:session}, although it will | |
14781 | determine the starting directory for a new session as expected, no attempt is | |
14782 | currently made to alter the directory associated with an existing session. | |
14783 | @item | |
14784 | @code{:dir} should typically not be used to create files during export with | |
ce57c2fe | 14785 | @code{:exports results} or @code{:exports both}. The reason is that, in order |
86fbb8ca | 14786 | to retain portability of exported material between machines, during export |
e66ba1df | 14787 | links inserted into the buffer will @emph{not} be expanded against @code{default |
ce57c2fe | 14788 | directory}. Therefore, if @code{default-directory} is altered using |
86fbb8ca CD |
14789 | @code{:dir}, it is probable that the file will be created in a location to |
14790 | which the link does not point. | |
14791 | @end itemize | |
14792 | ||
14793 | @node exports, tangle, dir, Specific header arguments | |
14794 | @subsubsection @code{:exports} | |
14795 | ||
14796 | The @code{:exports} header argument specifies what should be included in HTML | |
e66ba1df | 14797 | or @LaTeX{} exports of the Org mode file. |
86fbb8ca CD |
14798 | |
14799 | @itemize @bullet | |
14800 | @item @code{code} | |
14801 | The default. The body of code is included into the exported file. E.g., | |
14802 | @code{:exports code}. | |
14803 | @item @code{results} | |
ce57c2fe | 14804 | The result of evaluating the code is included in the exported file. E.g., |
86fbb8ca CD |
14805 | @code{:exports results}. |
14806 | @item @code{both} | |
ce57c2fe | 14807 | Both the code and results are included in the exported file. E.g., |
86fbb8ca CD |
14808 | @code{:exports both}. |
14809 | @item @code{none} | |
14810 | Nothing is included in the exported file. E.g., @code{:exports none}. | |
14811 | @end itemize | |
14812 | ||
ce57c2fe | 14813 | @node tangle, mkdirp, exports, Specific header arguments |
86fbb8ca CD |
14814 | @subsubsection @code{:tangle} |
14815 | ||
14816 | The @code{:tangle} header argument specifies whether or not the code | |
14817 | block should be included in tangled extraction of source code files. | |
14818 | ||
14819 | @itemize @bullet | |
acedf35c | 14820 | @item @code{tangle} |
ce57c2fe | 14821 | The code block is exported to a source code file named after the full path |
e66ba1df | 14822 | (including the directory) and file name (w/o extension) of the Org mode file. |
ce57c2fe | 14823 | E.g., @code{:tangle yes}. |
86fbb8ca CD |
14824 | @item @code{no} |
14825 | The default. The code block is not exported to a source code file. | |
14826 | E.g., @code{:tangle no}. | |
14827 | @item other | |
14828 | Any other string passed to the @code{:tangle} header argument is interpreted | |
e66ba1df | 14829 | as a path (directory and file name relative to the directory of the Org mode |
ce57c2fe | 14830 | file) to which the block will be exported. E.g., @code{:tangle path}. |
86fbb8ca CD |
14831 | @end itemize |
14832 | ||
ce57c2fe BG |
14833 | @node mkdirp, comments, tangle, Specific header arguments |
14834 | @subsubsection @code{:mkdirp} | |
14835 | ||
14836 | The @code{:mkdirp} header argument can be used to create parent directories | |
14837 | of tangled files when missing. This can be set to @code{yes} to enable | |
14838 | directory creation or to @code{no} to inhibit directory creation. | |
14839 | ||
14840 | @node comments, padline, mkdirp, Specific header arguments | |
86fbb8ca CD |
14841 | @subsubsection @code{:comments} |
14842 | By default code blocks are tangled to source-code files without any insertion | |
14843 | of comments beyond those which may already exist in the body of the code | |
afe98dfa CD |
14844 | block. The @code{:comments} header argument can be set as follows to control |
14845 | the insertion of extra comments into the tangled code file. | |
14846 | ||
14847 | @itemize @bullet | |
14848 | @item @code{no} | |
14849 | The default. No extra comments are inserted during tangling. | |
14850 | @item @code{link} | |
14851 | The code block is wrapped in comments which contain pointers back to the | |
14852 | original Org file from which the code was tangled. | |
14853 | @item @code{yes} | |
14854 | A synonym for ``link'' to maintain backwards compatibility. | |
14855 | @item @code{org} | |
e66ba1df | 14856 | Include text from the Org mode file as a comment. |
afe98dfa CD |
14857 | The text is picked from the leading context of the tangled code and is |
14858 | limited by the nearest headline or source block as the case may be. | |
14859 | @item @code{both} | |
14860 | Turns on both the ``link'' and ``org'' comment options. | |
ce57c2fe BG |
14861 | @item @code{noweb} |
14862 | Turns on the ``link'' comment option, and additionally wraps expanded noweb | |
14863 | references in the code block body in link comments. | |
afe98dfa | 14864 | @end itemize |
86fbb8ca | 14865 | |
ce57c2fe BG |
14866 | @node padline, no-expand, comments, Specific header arguments |
14867 | @subsubsection @code{:padline} | |
14868 | Control in insertion of padding lines around code block bodies in tangled | |
14869 | code files. The default value is @code{yes} which results in insertion of | |
14870 | newlines before and after each tangled code block. The following arguments | |
14871 | are accepted. | |
14872 | ||
14873 | @itemize @bullet | |
14874 | @item @code{yes} | |
14875 | Insert newlines before and after each code block body in tangled code files. | |
14876 | @item @code{no} | |
14877 | Do not insert any newline padding in tangled output. | |
14878 | @end itemize | |
14879 | ||
14880 | @node no-expand, session, padline, Specific header arguments | |
86fbb8ca CD |
14881 | @subsubsection @code{:no-expand} |
14882 | ||
14883 | By default, code blocks are expanded with @code{org-babel-expand-src-block} | |
14884 | during tangling. This has the effect of assigning values to variables | |
14885 | specified with @code{:var} (see @ref{var}), and of replacing ``noweb'' | |
14886 | references (see @ref{Noweb reference syntax}) with their targets. The | |
14887 | @code{:no-expand} header argument can be used to turn off this behavior. | |
14888 | ||
14889 | @node session, noweb, no-expand, Specific header arguments | |
14890 | @subsubsection @code{:session} | |
14891 | ||
14892 | The @code{:session} header argument starts a session for an interpreted | |
14893 | language where state is preserved. | |
14894 | ||
14895 | By default, a session is not started. | |
14896 | ||
14897 | A string passed to the @code{:session} header argument will give the session | |
14898 | a name. This makes it possible to run concurrent sessions for each | |
14899 | interpreted language. | |
14900 | ||
ce57c2fe | 14901 | @node noweb, noweb-ref, session, Specific header arguments |
86fbb8ca CD |
14902 | @subsubsection @code{:noweb} |
14903 | ||
8223b1d2 BG |
14904 | The @code{:noweb} header argument controls expansion of ``noweb'' syntax |
14905 | references (see @ref{Noweb reference syntax}) when the code block is | |
14906 | evaluated, tangled, or exported. The @code{:noweb} header argument can have | |
14907 | one of the five values: @code{no}, @code{yes}, @code{tangle}, or | |
14908 | @code{no-export} @code{strip-export}. | |
86fbb8ca CD |
14909 | |
14910 | @itemize @bullet | |
14911 | @item @code{no} | |
8223b1d2 BG |
14912 | The default. ``Noweb'' syntax references in the body of the code block will |
14913 | not be expanded before the code block is evaluated, tangled or exported. | |
14914 | @item @code{yes} | |
14915 | ``Noweb'' syntax references in the body of the code block will be | |
14916 | expanded before the code block is evaluated, tangled or exported. | |
acedf35c | 14917 | @item @code{tangle} |
8223b1d2 BG |
14918 | ``Noweb'' syntax references in the body of the code block will be expanded |
14919 | before the code block is tangled. However, ``noweb'' syntax references will | |
14920 | not be expanded when the code block is evaluated or exported. | |
14921 | @item @code{no-export} | |
14922 | ``Noweb'' syntax references in the body of the code block will be expanded | |
14923 | before the block is evaluated or tangled. However, ``noweb'' syntax | |
14924 | references will not be expanded when the code block is exported. | |
14925 | @item @code{strip-export} | |
14926 | ``Noweb'' syntax references in the body of the code block will be expanded | |
14927 | before the block is evaluated or tangled. However, ``noweb'' syntax | |
271672fa | 14928 | references will be removed when the code block is exported. |
8223b1d2 BG |
14929 | @item @code{eval} |
14930 | ``Noweb'' syntax references in the body of the code block will only be | |
14931 | expanded before the block is evaluated. | |
86fbb8ca CD |
14932 | @end itemize |
14933 | ||
14934 | @subsubheading Noweb prefix lines | |
14935 | Noweb insertions are now placed behind the line prefix of the | |
14936 | @code{<<reference>>}. | |
14937 | This behavior is illustrated in the following example. Because the | |
14938 | @code{<<example>>} noweb reference appears behind the SQL comment syntax, | |
14939 | each line of the expanded noweb reference will be commented. | |
14940 | ||
14941 | This code block: | |
14942 | ||
14943 | @example | |
14944 | -- <<example>> | |
14945 | @end example | |
14946 | ||
86fbb8ca CD |
14947 | expands to: |
14948 | ||
14949 | @example | |
14950 | -- this is the | |
14951 | -- multi-line body of example | |
14952 | @end example | |
14953 | ||
14954 | Note that noweb replacement text that does not contain any newlines will not | |
14955 | be affected by this change, so it is still possible to use inline noweb | |
14956 | references. | |
14957 | ||
153ae947 | 14958 | @node noweb-ref, noweb-sep, noweb, Specific header arguments |
ce57c2fe BG |
14959 | @subsubsection @code{:noweb-ref} |
14960 | When expanding ``noweb'' style references the bodies of all code block with | |
14961 | @emph{either} a block name matching the reference name @emph{or} a | |
14962 | @code{:noweb-ref} header argument matching the reference name will be | |
14963 | concatenated together to form the replacement text. | |
14964 | ||
14965 | By setting this header argument at the sub-tree or file level, simple code | |
14966 | block concatenation may be achieved. For example, when tangling the | |
e66ba1df BG |
14967 | following Org mode file, the bodies of code blocks will be concatenated into |
14968 | the resulting pure code file@footnote{(The example needs property inheritance | |
14969 | to be turned on for the @code{noweb-ref} property, see @ref{Property | |
14970 | inheritance}).}. | |
ce57c2fe BG |
14971 | |
14972 | @example | |
e66ba1df | 14973 | #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh |
ce57c2fe | 14974 | <<fullest-disk>> |
e66ba1df | 14975 | #+END_SRC |
ce57c2fe BG |
14976 | * the mount point of the fullest disk |
14977 | :PROPERTIES: | |
14978 | :noweb-ref: fullest-disk | |
14979 | :END: | |
14980 | ||
14981 | ** query all mounted disks | |
e66ba1df | 14982 | #+BEGIN_SRC sh |
ce57c2fe | 14983 | df \ |
e66ba1df | 14984 | #+END_SRC |
ce57c2fe BG |
14985 | |
14986 | ** strip the header row | |
e66ba1df | 14987 | #+BEGIN_SRC sh |
ce57c2fe | 14988 | |sed '1d' \ |
e66ba1df | 14989 | #+END_SRC |
ce57c2fe BG |
14990 | |
14991 | ** sort by the percent full | |
e66ba1df | 14992 | #+BEGIN_SRC sh |
ce57c2fe | 14993 | |awk '@{print $5 " " $6@}'|sort -n |tail -1 \ |
e66ba1df | 14994 | #+END_SRC |
ce57c2fe BG |
14995 | |
14996 | ** extract the mount point | |
e66ba1df | 14997 | #+BEGIN_SRC sh |
ce57c2fe | 14998 | |awk '@{print $2@}' |
e66ba1df | 14999 | #+END_SRC |
ce57c2fe BG |
15000 | @end example |
15001 | ||
153ae947 BG |
15002 | The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string |
15003 | used to separate accumulate noweb references like those above. By default a | |
15004 | newline is used. | |
15005 | ||
15006 | @node noweb-sep, cache, noweb-ref, Specific header arguments | |
15007 | @subsubsection @code{:noweb-sep} | |
15008 | ||
15009 | The @code{:noweb-sep} header argument holds the string used to separate | |
15010 | accumulate noweb references (see @ref{noweb-ref}). By default a newline is | |
15011 | used. | |
15012 | ||
15013 | @node cache, sep, noweb-sep, Specific header arguments | |
86fbb8ca CD |
15014 | @subsubsection @code{:cache} |
15015 | ||
15016 | The @code{:cache} header argument controls the use of in-buffer caching of | |
15017 | the results of evaluating code blocks. It can be used to avoid re-evaluating | |
153ae947 BG |
15018 | unchanged code blocks. Note that the @code{:cache} header argument will not |
15019 | attempt to cache results when the @code{:session} header argument is used, | |
15020 | because the results of the code block execution may be stored in the session | |
8223b1d2 | 15021 | outside of the Org mode buffer. The @code{:cache} header argument can have |
153ae947 | 15022 | one of two values: @code{yes} or @code{no}. |
86fbb8ca CD |
15023 | |
15024 | @itemize @bullet | |
15025 | @item @code{no} | |
15026 | The default. No caching takes place, and the code block will be evaluated | |
15027 | every time it is called. | |
15028 | @item @code{yes} | |
acedf35c | 15029 | Every time the code block is run a SHA1 hash of the code and arguments |
86fbb8ca | 15030 | passed to the block will be generated. This hash is packed into the |
8223b1d2 | 15031 | @code{#+RESULTS:} line and will be checked on subsequent |
86fbb8ca CD |
15032 | executions of the code block. If the code block has not |
15033 | changed since the last time it was evaluated, it will not be re-evaluated. | |
15034 | @end itemize | |
15035 | ||
ce57c2fe BG |
15036 | Code block caches notice if the value of a variable argument |
15037 | to the code block has changed. If this is the case, the cache is | |
15038 | invalidated and the code block is re-run. In the following example, | |
15039 | @code{caller} will not be re-run unless the results of @code{random} have | |
15040 | changed since it was last run. | |
15041 | ||
15042 | @example | |
e66ba1df BG |
15043 | #+NAME: random |
15044 | #+BEGIN_SRC R :cache yes | |
ce57c2fe | 15045 | runif(1) |
e66ba1df | 15046 | #+END_SRC |
ce57c2fe | 15047 | |
8223b1d2 | 15048 | #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random |
ce57c2fe BG |
15049 | 0.4659510825295 |
15050 | ||
e66ba1df BG |
15051 | #+NAME: caller |
15052 | #+BEGIN_SRC emacs-lisp :var x=random :cache yes | |
ce57c2fe | 15053 | x |
e66ba1df | 15054 | #+END_SRC |
ce57c2fe | 15055 | |
8223b1d2 | 15056 | #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller |
ce57c2fe BG |
15057 | 0.254227238707244 |
15058 | @end example | |
15059 | ||
15060 | @node sep, hlines, cache, Specific header arguments | |
15061 | @subsubsection @code{:sep} | |
15062 | ||
15063 | The @code{:sep} header argument can be used to control the delimiter used | |
e66ba1df | 15064 | when writing tabular results out to files external to Org mode. This is used |
ce57c2fe BG |
15065 | either when opening tabular results of a code block by calling the |
15066 | @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block, | |
15067 | or when writing code block results to an external file (see @ref{file}) | |
15068 | header argument. | |
15069 | ||
15070 | By default, when @code{:sep} is not specified output tables are tab | |
15071 | delimited. | |
15072 | ||
15073 | @node hlines, colnames, sep, Specific header arguments | |
86fbb8ca CD |
15074 | @subsubsection @code{:hlines} |
15075 | ||
15076 | Tables are frequently represented with one or more horizontal lines, or | |
15077 | hlines. The @code{:hlines} argument to a code block accepts the | |
15078 | values @code{yes} or @code{no}, with a default value of @code{no}. | |
15079 | ||
15080 | @itemize @bullet | |
15081 | @item @code{no} | |
15082 | Strips horizontal lines from the input table. In most languages this is the | |
15083 | desired effect because an @code{hline} symbol is interpreted as an unbound | |
15084 | variable and raises an error. Setting @code{:hlines no} or relying on the | |
15085 | default value yields the following results. | |
15086 | ||
15087 | @example | |
271672fa | 15088 | #+NAME: many-cols |
86fbb8ca CD |
15089 | | a | b | c | |
15090 | |---+---+---| | |
15091 | | d | e | f | | |
15092 | |---+---+---| | |
15093 | | g | h | i | | |
15094 | ||
e66ba1df BG |
15095 | #+NAME: echo-table |
15096 | #+BEGIN_SRC python :var tab=many-cols | |
86fbb8ca | 15097 | return tab |
e66ba1df | 15098 | #+END_SRC |
86fbb8ca | 15099 | |
8223b1d2 | 15100 | #+RESULTS: echo-table |
86fbb8ca CD |
15101 | | a | b | c | |
15102 | | d | e | f | | |
15103 | | g | h | i | | |
15104 | @end example | |
15105 | ||
15106 | @item @code{yes} | |
ce57c2fe | 15107 | Leaves hlines in the table. Setting @code{:hlines yes} has this effect. |
86fbb8ca CD |
15108 | |
15109 | @example | |
271672fa | 15110 | #+NAME: many-cols |
86fbb8ca CD |
15111 | | a | b | c | |
15112 | |---+---+---| | |
15113 | | d | e | f | | |
15114 | |---+---+---| | |
15115 | | g | h | i | | |
15116 | ||
e66ba1df BG |
15117 | #+NAME: echo-table |
15118 | #+BEGIN_SRC python :var tab=many-cols :hlines yes | |
86fbb8ca | 15119 | return tab |
e66ba1df | 15120 | #+END_SRC |
86fbb8ca | 15121 | |
8223b1d2 | 15122 | #+RESULTS: echo-table |
86fbb8ca CD |
15123 | | a | b | c | |
15124 | |---+---+---| | |
15125 | | d | e | f | | |
15126 | |---+---+---| | |
15127 | | g | h | i | | |
15128 | @end example | |
15129 | @end itemize | |
15130 | ||
15131 | @node colnames, rownames, hlines, Specific header arguments | |
15132 | @subsubsection @code{:colnames} | |
15133 | ||
15134 | The @code{:colnames} header argument accepts the values @code{yes}, | |
15135 | @code{no}, or @code{nil} for unassigned. The default value is @code{nil}. | |
e66ba1df | 15136 | Note that the behavior of the @code{:colnames} header argument may differ |
271672fa | 15137 | across languages. |
86fbb8ca CD |
15138 | |
15139 | @itemize @bullet | |
15140 | @item @code{nil} | |
15141 | If an input table looks like it has column names | |
15142 | (because its second row is an hline), then the column | |
15143 | names will be removed from the table before | |
15144 | processing, then reapplied to the results. | |
15145 | ||
15146 | @example | |
271672fa | 15147 | #+NAME: less-cols |
86fbb8ca CD |
15148 | | a | |
15149 | |---| | |
15150 | | b | | |
15151 | | c | | |
15152 | ||
e66ba1df BG |
15153 | #+NAME: echo-table-again |
15154 | #+BEGIN_SRC python :var tab=less-cols | |
86fbb8ca | 15155 | return [[val + '*' for val in row] for row in tab] |
e66ba1df | 15156 | #+END_SRC |
86fbb8ca | 15157 | |
8223b1d2 | 15158 | #+RESULTS: echo-table-again |
86fbb8ca CD |
15159 | | a | |
15160 | |----| | |
15161 | | b* | | |
15162 | | c* | | |
15163 | @end example | |
15164 | ||
ce57c2fe BG |
15165 | Please note that column names are not removed before the table is indexed |
15166 | using variable indexing @xref{var, Indexable variable values}. | |
15167 | ||
86fbb8ca CD |
15168 | @item @code{no} |
15169 | No column name pre-processing takes place | |
15170 | ||
15171 | @item @code{yes} | |
15172 | Column names are removed and reapplied as with @code{nil} even if the table | |
1df7defd | 15173 | does not ``look like'' it has column names (i.e., the second row is not an |
86fbb8ca CD |
15174 | hline) |
15175 | @end itemize | |
15176 | ||
15177 | @node rownames, shebang, colnames, Specific header arguments | |
15178 | @subsubsection @code{:rownames} | |
15179 | ||
271672fa BG |
15180 | The @code{:rownames} header argument can take on the values @code{yes} or |
15181 | @code{no}, with a default value of @code{no}. Note that Emacs Lisp code | |
15182 | blocks ignore the @code{:rownames} header argument entirely given the ease | |
15183 | with which tables with row names may be handled directly in Emacs Lisp. | |
86fbb8ca CD |
15184 | |
15185 | @itemize @bullet | |
15186 | @item @code{no} | |
15187 | No row name pre-processing will take place. | |
15188 | ||
15189 | @item @code{yes} | |
15190 | The first column of the table is removed from the table before processing, | |
15191 | and is then reapplied to the results. | |
15192 | ||
15193 | @example | |
271672fa | 15194 | #+NAME: with-rownames |
86fbb8ca CD |
15195 | | one | 1 | 2 | 3 | 4 | 5 | |
15196 | | two | 6 | 7 | 8 | 9 | 10 | | |
15197 | ||
e66ba1df BG |
15198 | #+NAME: echo-table-once-again |
15199 | #+BEGIN_SRC python :var tab=with-rownames :rownames yes | |
86fbb8ca | 15200 | return [[val + 10 for val in row] for row in tab] |
e66ba1df | 15201 | #+END_SRC |
86fbb8ca | 15202 | |
8223b1d2 | 15203 | #+RESULTS: echo-table-once-again |
86fbb8ca CD |
15204 | | one | 11 | 12 | 13 | 14 | 15 | |
15205 | | two | 16 | 17 | 18 | 19 | 20 | | |
15206 | @end example | |
ce57c2fe BG |
15207 | |
15208 | Please note that row names are not removed before the table is indexed using | |
15209 | variable indexing @xref{var, Indexable variable values}. | |
15210 | ||
86fbb8ca CD |
15211 | @end itemize |
15212 | ||
271672fa | 15213 | @node shebang, tangle-mode, rownames, Specific header arguments |
86fbb8ca CD |
15214 | @subsubsection @code{:shebang} |
15215 | ||
15216 | Setting the @code{:shebang} header argument to a string value | |
1df7defd | 15217 | (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the |
86fbb8ca CD |
15218 | first line of any tangled file holding the code block, and the file |
15219 | permissions of the tangled file are set to make it executable. | |
15220 | ||
271672fa BG |
15221 | |
15222 | @node tangle-mode, eval, shebang, Specific header arguments | |
15223 | @subsubsection @code{:tangle-mode} | |
15224 | ||
15225 | The @code{tangle-mode} header argument controls the permission set on tangled | |
15226 | files. The value of this header argument will be passed to | |
15227 | @code{set-file-modes}. For example, to set a tangled file as read only use | |
15228 | @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable | |
15229 | use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang} | |
15230 | (@ref{shebang}) header arguments will automatically be made executable unless | |
15231 | the @code{tangle-mode} header argument is also used. The behavior is | |
15232 | undefined if multiple code blocks with different values for the | |
15233 | @code{tangle-mode} header argument are tangled to the same file. | |
15234 | ||
15235 | @node eval, wrap, tangle-mode, Specific header arguments | |
86fbb8ca CD |
15236 | @subsubsection @code{:eval} |
15237 | The @code{:eval} header argument can be used to limit the evaluation of | |
e66ba1df BG |
15238 | specific code blocks. The @code{:eval} header argument can be useful for |
15239 | protecting against the evaluation of dangerous code blocks or to ensure that | |
15240 | evaluation will require a query regardless of the value of the | |
15241 | @code{org-confirm-babel-evaluate} variable. The possible values of | |
15242 | @code{:eval} and their effects are shown below. | |
15243 | ||
15244 | @table @code | |
15245 | @item never or no | |
15246 | The code block will not be evaluated under any circumstances. | |
15247 | @item query | |
15248 | Evaluation of the code block will require a query. | |
15249 | @item never-export or no-export | |
15250 | The code block will not be evaluated during export but may still be called | |
15251 | interactively. | |
15252 | @item query-export | |
15253 | Evaluation of the code block during export will require a query. | |
15254 | @end table | |
86fbb8ca | 15255 | |
ce57c2fe BG |
15256 | If this header argument is not set then evaluation is determined by the value |
15257 | of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation | |
15258 | security}. | |
15259 | ||
271672fa | 15260 | @node wrap, post, eval, Specific header arguments |
8223b1d2 BG |
15261 | @subsubsection @code{:wrap} |
15262 | The @code{:wrap} header argument is used to mark the results of source block | |
15263 | evaluation. The header argument can be passed a string that will be appended | |
15264 | to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the | |
15265 | results. If not string is specified then the results will be wrapped in a | |
15266 | @code{#+BEGIN/END_RESULTS} block. | |
15267 | ||
271672fa BG |
15268 | @node post, prologue, wrap, Specific header arguments |
15269 | @subsubsection @code{:post} | |
15270 | The @code{:post} header argument is used to post-process the results of a | |
15271 | code block execution. When a post argument is given, the results of the code | |
15272 | block will temporarily be bound to the @code{*this*} variable. This variable | |
15273 | may then be included in header argument forms such as those used in @ref{var} | |
15274 | header argument specifications allowing passing of results to other code | |
15275 | blocks, or direct execution via Emacs Lisp. | |
15276 | ||
15277 | The following example illustrates the usage of the @code{:post} header | |
15278 | argument. | |
15279 | ||
15280 | @example | |
15281 | #+name: attr_wrap | |
15282 | #+begin_src sh :var data="" :var width="\\textwidth" :results output | |
15283 | echo "#+ATTR_LATEX :width $width" | |
15284 | echo "$data" | |
15285 | #+end_src | |
15286 | ||
15287 | #+header: :file /tmp/it.png | |
15288 | #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer | |
15289 | digraph@{ | |
15290 | a -> b; | |
15291 | b -> c; | |
15292 | c -> a; | |
15293 | @} | |
15294 | #+end_src | |
15295 | ||
15296 | #+RESULTS: | |
15297 | :RESULTS: | |
15298 | #+ATTR_LATEX :width 5cm | |
15299 | [[file:/tmp/it.png]] | |
15300 | :END: | |
15301 | @end example | |
15302 | ||
15303 | @node prologue, epilogue, post, Specific header arguments | |
15304 | @subsubsection @code{:prologue} | |
15305 | The value of the @code{prologue} header argument will be prepended to the | |
15306 | code block body before execution. For example, @code{:prologue "reset"} may | |
15307 | be used to reset a gnuplot session before execution of a particular code | |
15308 | block, or the following configuration may be used to do this for all gnuplot | |
15309 | code blocks. Also see @ref{epilogue}. | |
15310 | ||
15311 | @lisp | |
15312 | (add-to-list 'org-babel-default-header-args:gnuplot | |
15313 | '((:prologue . "reset"))) | |
15314 | @end lisp | |
15315 | ||
15316 | @node epilogue, , prologue, Specific header arguments | |
15317 | @subsubsection @code{:epilogue} | |
15318 | The value of the @code{epilogue} header argument will be appended to the code | |
15319 | block body before execution. Also see @ref{prologue}. | |
15320 | ||
86fbb8ca CD |
15321 | @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code |
15322 | @section Results of evaluation | |
15323 | @cindex code block, results of evaluation | |
15324 | @cindex source code, results of evaluation | |
15325 | ||
15326 | The way in which results are handled depends on whether a session is invoked, | |
15327 | as well as on whether @code{:results value} or @code{:results output} is | |
ce57c2fe BG |
15328 | used. The following table shows the table possibilities. For a full listing |
15329 | of the possible results header arguments see @ref{results}. | |
86fbb8ca CD |
15330 | |
15331 | @multitable @columnfractions 0.26 0.33 0.41 | |
15332 | @item @tab @b{Non-session} @tab @b{Session} | |
15333 | @item @code{:results value} @tab value of last expression @tab value of last expression | |
15334 | @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output | |
15335 | @end multitable | |
15336 | ||
15337 | Note: With @code{:results value}, the result in both @code{:session} and | |
e66ba1df | 15338 | non-session is returned to Org mode as a table (a one- or two-dimensional |
86fbb8ca CD |
15339 | vector of strings or numbers) when appropriate. |
15340 | ||
15341 | @subsection Non-session | |
15342 | @subsubsection @code{:results value} | |
ce57c2fe | 15343 | This is the default. Internally, the value is obtained by wrapping the code |
86fbb8ca | 15344 | in a function definition in the external language, and evaluating that |
ce57c2fe BG |
15345 | function. Therefore, code should be written as if it were the body of such a |
15346 | function. In particular, note that Python does not automatically return a | |
86fbb8ca | 15347 | value from a function unless a @code{return} statement is present, and so a |
acedf35c | 15348 | @samp{return} statement will usually be required in Python. |
86fbb8ca CD |
15349 | |
15350 | This is the only one of the four evaluation contexts in which the code is | |
15351 | automatically wrapped in a function definition. | |
15352 | ||
15353 | @subsubsection @code{:results output} | |
15354 | The code is passed to the interpreter as an external process, and the | |
ce57c2fe | 15355 | contents of the standard output stream are returned as text. (In certain |
86fbb8ca CD |
15356 | languages this also contains the error output stream; this is an area for |
15357 | future work.) | |
15358 | ||
acedf35c | 15359 | @subsection Session |
86fbb8ca | 15360 | @subsubsection @code{:results value} |
ce57c2fe BG |
15361 | The code is passed to an interpreter running as an interactive Emacs inferior |
15362 | process. Only languages which provide tools for interactive evaluation of | |
15363 | code have session support, so some language (e.g., C and ditaa) do not | |
15364 | support the @code{:session} header argument, and in other languages (e.g., | |
15365 | Python and Haskell) which have limitations on the code which may be entered | |
15366 | into interactive sessions, those limitations apply to the code in code blocks | |
15367 | using the @code{:session} header argument as well. | |
15368 | ||
15369 | Unless the @code{:results output} option is supplied (see below) the result | |
15370 | returned is the result of the last evaluation performed by the | |
15371 | interpreter. (This is obtained in a language-specific manner: the value of | |
15372 | the variable @code{_} in Python and Ruby, and the value of @code{.Last.value} | |
15373 | in R). | |
86fbb8ca CD |
15374 | |
15375 | @subsubsection @code{:results output} | |
15376 | The code is passed to the interpreter running as an interactive Emacs | |
ce57c2fe BG |
15377 | inferior process. The result returned is the concatenation of the sequence of |
15378 | (text) output from the interactive interpreter. Notice that this is not | |
86fbb8ca CD |
15379 | necessarily the same as what would be sent to @code{STDOUT} if the same code |
15380 | were passed to a non-interactive interpreter running as an external | |
ce57c2fe | 15381 | process. For example, compare the following two blocks: |
86fbb8ca CD |
15382 | |
15383 | @example | |
e66ba1df | 15384 | #+BEGIN_SRC python :results output |
86fbb8ca CD |
15385 | print "hello" |
15386 | 2 | |
15387 | print "bye" | |
e66ba1df | 15388 | #+END_SRC |
86fbb8ca | 15389 | |
8223b1d2 | 15390 | #+RESULTS: |
86fbb8ca CD |
15391 | : hello |
15392 | : bye | |
15393 | @end example | |
15394 | ||
acedf35c | 15395 | In non-session mode, the `2' is not printed and does not appear. |
63aa0982 | 15396 | |
86fbb8ca | 15397 | @example |
e66ba1df | 15398 | #+BEGIN_SRC python :results output :session |
86fbb8ca CD |
15399 | print "hello" |
15400 | 2 | |
15401 | print "bye" | |
e66ba1df | 15402 | #+END_SRC |
86fbb8ca | 15403 | |
8223b1d2 | 15404 | #+RESULTS: |
86fbb8ca CD |
15405 | : hello |
15406 | : 2 | |
15407 | : bye | |
15408 | @end example | |
15409 | ||
acedf35c | 15410 | But in @code{:session} mode, the interactive interpreter receives input `2' |
ce57c2fe | 15411 | and prints out its value, `2'. (Indeed, the other print statements are |
86fbb8ca CD |
15412 | unnecessary here). |
15413 | ||
15414 | @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code | |
15415 | @section Noweb reference syntax | |
15416 | @cindex code block, noweb reference | |
15417 | @cindex syntax, noweb | |
15418 | @cindex source code, noweb reference | |
15419 | ||
15420 | The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate | |
15421 | Programming system allows named blocks of code to be referenced by using the | |
15422 | familiar Noweb syntax: | |
15423 | ||
15424 | @example | |
15425 | <<code-block-name>> | |
15426 | @end example | |
15427 | ||
15428 | When a code block is tangled or evaluated, whether or not ``noweb'' | |
15429 | references are expanded depends upon the value of the @code{:noweb} header | |
15430 | argument. If @code{:noweb yes}, then a Noweb reference is expanded before | |
15431 | evaluation. If @code{:noweb no}, the default, then the reference is not | |
e66ba1df BG |
15432 | expanded before evaluation. See the @ref{noweb-ref} header argument for |
15433 | a more flexible way to resolve noweb references. | |
86fbb8ca | 15434 | |
153ae947 BG |
15435 | It is possible to include the @emph{results} of a code block rather than the |
15436 | body. This is done by appending parenthesis to the code block name which may | |
15437 | optionally contain arguments to the code block as shown below. | |
15438 | ||
15439 | @example | |
15440 | <<code-block-name(optional arguments)>> | |
15441 | @end example | |
15442 | ||
86fbb8ca CD |
15443 | Note: the default value, @code{:noweb no}, was chosen to ensure that |
15444 | correct code is not broken in a language, such as Ruby, where | |
15445 | @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not | |
15446 | syntactically valid in languages that you use, then please consider setting | |
15447 | the default value. | |
15448 | ||
8223b1d2 | 15449 | Note: if noweb tangling is slow in large Org mode files consider setting the |
271672fa | 15450 | @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}. |
e66ba1df BG |
15451 | This will result in faster noweb reference resolution at the expense of not |
15452 | correctly resolving inherited values of the @code{:noweb-ref} header | |
15453 | argument. | |
15454 | ||
86fbb8ca CD |
15455 | @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code |
15456 | @section Key bindings and useful functions | |
15457 | @cindex code block, key bindings | |
15458 | ||
e66ba1df | 15459 | Many common Org mode key sequences are re-bound depending on |
86fbb8ca CD |
15460 | the context. |
15461 | ||
15462 | Within a code block, the following key bindings | |
15463 | are active: | |
15464 | ||
15465 | @multitable @columnfractions 0.25 0.75 | |
15466 | @kindex C-c C-c | |
ce57c2fe | 15467 | @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} |
86fbb8ca | 15468 | @kindex C-c C-o |
ce57c2fe | 15469 | @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} |
86fbb8ca | 15470 | @kindex C-up |
ce57c2fe | 15471 | @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session} |
86fbb8ca | 15472 | @kindex M-down |
ce57c2fe | 15473 | @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session} |
86fbb8ca CD |
15474 | @end multitable |
15475 | ||
e66ba1df | 15476 | In an Org mode buffer, the following key bindings are active: |
86fbb8ca CD |
15477 | |
15478 | @multitable @columnfractions 0.45 0.55 | |
153ae947 BG |
15479 | @kindex C-c C-v p |
15480 | @kindex C-c C-v C-p | |
15481 | @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block} | |
15482 | @kindex C-c C-v n | |
15483 | @kindex C-c C-v C-n | |
15484 | @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block} | |
15485 | @kindex C-c C-v e | |
15486 | @kindex C-c C-v C-e | |
15487 | @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe} | |
15488 | @kindex C-c C-v o | |
15489 | @kindex C-c C-v C-o | |
15490 | @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result} | |
15491 | @kindex C-c C-v v | |
15492 | @kindex C-c C-v C-v | |
15493 | @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block} | |
15494 | @kindex C-c C-v u | |
15495 | @kindex C-c C-v C-u | |
15496 | @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head} | |
15497 | @kindex C-c C-v g | |
15498 | @kindex C-c C-v C-g | |
15499 | @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block} | |
15500 | @kindex C-c C-v r | |
15501 | @kindex C-c C-v C-r | |
15502 | @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result} | |
86fbb8ca CD |
15503 | @kindex C-c C-v b |
15504 | @kindex C-c C-v C-b | |
ce57c2fe | 15505 | @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} |
86fbb8ca CD |
15506 | @kindex C-c C-v s |
15507 | @kindex C-c C-v C-s | |
ce57c2fe | 15508 | @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} |
153ae947 BG |
15509 | @kindex C-c C-v d |
15510 | @kindex C-c C-v C-d | |
15511 | @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block} | |
86fbb8ca CD |
15512 | @kindex C-c C-v t |
15513 | @kindex C-c C-v C-t | |
ce57c2fe | 15514 | @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} |
153ae947 BG |
15515 | @kindex C-c C-v f |
15516 | @kindex C-c C-v C-f | |
15517 | @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} | |
15518 | @kindex C-c C-v c | |
15519 | @kindex C-c C-v C-c | |
15520 | @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block} | |
15521 | @kindex C-c C-v j | |
15522 | @kindex C-c C-v C-j | |
15523 | @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg} | |
15524 | @kindex C-c C-v l | |
15525 | @kindex C-c C-v C-l | |
15526 | @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session} | |
15527 | @kindex C-c C-v i | |
15528 | @kindex C-c C-v C-i | |
15529 | @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest} | |
15530 | @kindex C-c C-v I | |
15531 | @kindex C-c C-v C-I | |
15532 | @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info} | |
86fbb8ca CD |
15533 | @kindex C-c C-v z |
15534 | @kindex C-c C-v C-z | |
153ae947 BG |
15535 | @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code} |
15536 | @kindex C-c C-v a | |
15537 | @kindex C-c C-v C-a | |
15538 | @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} | |
15539 | @kindex C-c C-v h | |
15540 | @kindex C-c C-v C-h | |
15541 | @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings} | |
15542 | @kindex C-c C-v x | |
15543 | @kindex C-c C-v C-x | |
15544 | @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer} | |
86fbb8ca CD |
15545 | @end multitable |
15546 | ||
15547 | @c When possible these keybindings were extended to work when the control key is | |
15548 | @c kept pressed, resulting in the following additional keybindings. | |
15549 | ||
15550 | @c @multitable @columnfractions 0.25 0.75 | |
ce57c2fe BG |
15551 | @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} |
15552 | @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} | |
15553 | @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} | |
15554 | @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} | |
15555 | @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} | |
15556 | @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} | |
15557 | @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} | |
15558 | @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} | |
86fbb8ca CD |
15559 | @c @end multitable |
15560 | ||
15561 | @node Batch execution, , Key bindings and useful functions, Working With Source Code | |
15562 | @section Batch execution | |
15563 | @cindex code block, batch execution | |
15564 | @cindex source code, batch execution | |
15565 | ||
15566 | It is possible to call functions from the command line. This shell | |
15567 | script calls @code{org-babel-tangle} on every one of its arguments. | |
15568 | ||
15569 | Be sure to adjust the paths to fit your system. | |
15570 | ||
15571 | @example | |
15572 | #!/bin/sh | |
15573 | # -*- mode: shell-script -*- | |
15574 | # | |
afe98dfa | 15575 | # tangle files with org-mode |
86fbb8ca CD |
15576 | # |
15577 | DIR=`pwd` | |
15578 | FILES="" | |
15579 | ||
15580 | # wrap each argument in the code required to call tangle on it | |
15581 | for i in $@@; do | |
afe98dfa | 15582 | FILES="$FILES \"$i\"" |
86fbb8ca CD |
15583 | done |
15584 | ||
bdebdb64 | 15585 | emacs -Q --batch \ |
86fbb8ca CD |
15586 | --eval "(progn |
15587 | (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\")) | |
8223b1d2 | 15588 | (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t)) |
86fbb8ca CD |
15589 | (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle) |
15590 | (mapc (lambda (file) | |
15591 | (find-file (expand-file-name file \"$DIR\")) | |
15592 | (org-babel-tangle) | |
afe98dfa | 15593 | (kill-buffer)) '($FILES)))" 2>&1 |grep tangled |
86fbb8ca CD |
15594 | @end example |
15595 | ||
15596 | @node Miscellaneous, Hacking, Working With Source Code, Top | |
15597 | @chapter Miscellaneous | |
15598 | ||
15599 | @menu | |
c0468714 | 15600 | * Completion:: M-TAB knows what you need |
afe98dfa | 15601 | * Easy Templates:: Quick insertion of structural elements |
c0468714 GM |
15602 | * Speed keys:: Electric commands at the beginning of a headline |
15603 | * Code evaluation security:: Org mode files evaluate inline code | |
15604 | * Customization:: Adapting Org to your taste | |
15605 | * In-buffer settings:: Overview of the #+KEYWORDS | |
15606 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
15607 | * Clean view:: Getting rid of leading stars in the outline | |
15608 | * TTY keys:: Using Org on a tty | |
15609 | * Interaction:: Other Emacs packages | |
271672fa | 15610 | * org-crypt:: Encrypting Org files |
86fbb8ca CD |
15611 | @end menu |
15612 | ||
15613 | ||
afe98dfa | 15614 | @node Completion, Easy Templates, Miscellaneous, Miscellaneous |
86fbb8ca CD |
15615 | @section Completion |
15616 | @cindex completion, of @TeX{} symbols | |
15617 | @cindex completion, of TODO keywords | |
15618 | @cindex completion, of dictionary words | |
15619 | @cindex completion, of option keywords | |
15620 | @cindex completion, of tags | |
15621 | @cindex completion, of property keys | |
15622 | @cindex completion, of link abbreviations | |
15623 | @cindex @TeX{} symbol completion | |
15624 | @cindex TODO keywords completion | |
15625 | @cindex dictionary word completion | |
15626 | @cindex option keyword completion | |
15627 | @cindex tag completion | |
15628 | @cindex link abbreviations, completion of | |
15629 | ||
e66ba1df | 15630 | Emacs would not be Emacs without completion, and Org mode uses it whenever it |
86fbb8ca CD |
15631 | makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for |
15632 | some of the completion prompts, you can specify your preference by setting at | |
15633 | most one of the variables @code{org-completion-use-iswitchb} | |
15634 | @code{org-completion-use-ido}. | |
15635 | ||
15636 | Org supports in-buffer completion. This type of completion does | |
15637 | not make use of the minibuffer. You simply type a few letters into | |
15638 | the buffer and use the key to complete text right there. | |
15639 | ||
15640 | @table @kbd | |
15641 | @kindex M-@key{TAB} | |
15642 | @item M-@key{TAB} | |
15643 | Complete word at point | |
15644 | @itemize @bullet | |
15645 | @item | |
15646 | At the beginning of a headline, complete TODO keywords. | |
15647 | @item | |
15648 | After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
15649 | @item | |
15650 | After @samp{*}, complete headlines in the current buffer so that they | |
15651 | can be used in search links like @samp{[[*find this headline]]}. | |
15652 | @item | |
15653 | After @samp{:} in a headline, complete tags. The list of tags is taken | |
15654 | from the variable @code{org-tag-alist} (possibly set through the | |
15655 | @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
15656 | dynamically from all tags used in the current buffer. | |
15657 | @item | |
15658 | After @samp{:} and not in a headline, complete property keys. The list | |
15659 | of keys is constructed dynamically from all keys used in the current | |
15660 | buffer. | |
15661 | @item | |
15662 | After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
15663 | @item | |
15664 | After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |
e66ba1df | 15665 | @samp{OPTIONS} which set file-specific options for Org mode. When the |
86fbb8ca CD |
15666 | option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
15667 | will insert example settings for this keyword. | |
15668 | @item | |
15669 | In the line after @samp{#+STARTUP: }, complete startup keywords, | |
1df7defd | 15670 | i.e., valid keys for this line. |
86fbb8ca CD |
15671 | @item |
15672 | Elsewhere, complete dictionary words using Ispell. | |
15673 | @end itemize | |
15674 | @end table | |
15675 | ||
afe98dfa CD |
15676 | @node Easy Templates, Speed keys, Completion, Miscellaneous |
15677 | @section Easy Templates | |
15678 | @cindex template insertion | |
15679 | @cindex insertion, of templates | |
15680 | ||
e66ba1df | 15681 | Org mode supports insertion of empty structural elements (like |
afe98dfa CD |
15682 | @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key |
15683 | strokes. This is achieved through a native template expansion mechanism. | |
15684 | Note that Emacs has several other template mechanisms which could be used in | |
15685 | a similar way, for example @file{yasnippet}. | |
15686 | ||
15687 | To insert a structural element, type a @samp{<}, followed by a template | |
15688 | selector and @kbd{@key{TAB}}. Completion takes effect only when the above | |
15689 | keystrokes are typed on a line by itself. | |
15690 | ||
15691 | The following template selectors are currently supported. | |
15692 | ||
15693 | @multitable @columnfractions 0.1 0.9 | |
8223b1d2 BG |
15694 | @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC} |
15695 | @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE} | |
15696 | @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE} | |
15697 | @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE} | |
15698 | @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER} | |
15699 | @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX} | |
15700 | @item @kbd{L} @tab @code{#+LaTeX:} | |
15701 | @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML} | |
15702 | @item @kbd{H} @tab @code{#+HTML:} | |
15703 | @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII} | |
15704 | @item @kbd{A} @tab @code{#+ASCII:} | |
15705 | @item @kbd{i} @tab @code{#+INDEX:} line | |
15706 | @item @kbd{I} @tab @code{#+INCLUDE:} line | |
afe98dfa CD |
15707 | @end multitable |
15708 | ||
15709 | For example, on an empty line, typing "<e" and then pressing TAB, will expand | |
15710 | into a complete EXAMPLE template. | |
15711 | ||
15712 | You can install additional templates by customizing the variable | |
ce57c2fe | 15713 | @code{org-structure-template-alist}. See the docstring of the variable for |
afe98dfa CD |
15714 | additional details. |
15715 | ||
15716 | @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous | |
86fbb8ca CD |
15717 | @section Speed keys |
15718 | @cindex speed keys | |
15719 | @vindex org-use-speed-commands | |
15720 | @vindex org-speed-commands-user | |
15721 | ||
15722 | Single keys can be made to execute commands when the cursor is at the | |
1df7defd | 15723 | beginning of a headline, i.e., before the first star. Configure the variable |
86fbb8ca CD |
15724 | @code{org-use-speed-commands} to activate this feature. There is a |
15725 | pre-defined list of commands, and you can add more such commands using the | |
15726 | variable @code{org-speed-commands-user}. Speed keys do not only speed up | |
15727 | navigation and other commands, but they also provide an alternative way to | |
acedf35c | 15728 | execute commands bound to keys that are not or not easily available on a TTY, |
86fbb8ca CD |
15729 | or on a small mobile device with a limited keyboard. |
15730 | ||
15731 | To see which commands are available, activate the feature and press @kbd{?} | |
15732 | with the cursor at the beginning of a headline. | |
15733 | ||
15734 | @node Code evaluation security, Customization, Speed keys, Miscellaneous | |
15735 | @section Code evaluation and security issues | |
15736 | ||
afe98dfa | 15737 | Org provides tools to work with the code snippets, including evaluating them. |
86fbb8ca CD |
15738 | |
15739 | Running code on your machine always comes with a security risk. Badly | |
15740 | written or malicious code can be executed on purpose or by accident. Org has | |
15741 | default settings which will only evaluate such code if you give explicit | |
15742 | permission to do so, and as a casual user of these features you should leave | |
15743 | these precautions intact. | |
15744 | ||
15745 | For people who regularly work with such code, the confirmation prompts can | |
15746 | become annoying, and you might want to turn them off. This can be done, but | |
15747 | you must be aware of the risks that are involved. | |
15748 | ||
15749 | Code evaluation can happen under the following circumstances: | |
15750 | ||
15751 | @table @i | |
15752 | @item Source code blocks | |
15753 | Source code blocks can be evaluated during export, or when pressing @kbd{C-c | |
15754 | C-c} in the block. The most important thing to realize here is that Org mode | |
afe98dfa | 15755 | files which contain code snippets are, in a certain sense, like executable |
86fbb8ca | 15756 | files. So you should accept them and load them into Emacs only from trusted |
acedf35c | 15757 | sources---just like you would do with a program you install on your computer. |
86fbb8ca CD |
15758 | |
15759 | Make sure you know what you are doing before customizing the variables | |
afe98dfa | 15760 | which take off the default security brakes. |
86fbb8ca CD |
15761 | |
15762 | @defopt org-confirm-babel-evaluate | |
ce57c2fe | 15763 | When t (the default), the user is asked before every code block evaluation. |
271672fa | 15764 | When @code{nil}, the user is not asked. When set to a function, it is called with |
ce57c2fe | 15765 | two arguments (language and body of the code block) and should return t to |
271672fa | 15766 | ask and @code{nil} not to ask. |
86fbb8ca CD |
15767 | @end defopt |
15768 | ||
ce57c2fe BG |
15769 | For example, here is how to execute "ditaa" code (which is considered safe) |
15770 | without asking: | |
63aa0982 | 15771 | |
271672fa | 15772 | @lisp |
ce57c2fe BG |
15773 | (defun my-org-confirm-babel-evaluate (lang body) |
15774 | (not (string= lang "ditaa"))) ; don't ask for ditaa | |
15775 | (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate) | |
271672fa | 15776 | @end lisp |
ce57c2fe | 15777 | |
86fbb8ca CD |
15778 | @item Following @code{shell} and @code{elisp} links |
15779 | Org has two link types that can directly evaluate code (@pxref{External | |
afe98dfa | 15780 | links}). These links can be problematic because the code to be evaluated is |
86fbb8ca CD |
15781 | not visible. |
15782 | ||
15783 | @defopt org-confirm-shell-link-function | |
15784 | Function to queries user about shell link execution. | |
15785 | @end defopt | |
15786 | @defopt org-confirm-elisp-link-function | |
15787 | Functions to query user for Emacs Lisp link execution. | |
15788 | @end defopt | |
15789 | ||
86fbb8ca CD |
15790 | @item Formulas in tables |
15791 | Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated | |
15792 | either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter. | |
15793 | @end table | |
15794 | ||
15795 | @node Customization, In-buffer settings, Code evaluation security, Miscellaneous | |
15796 | @section Customization | |
15797 | @cindex customization | |
15798 | @cindex options, for customization | |
15799 | @cindex variables, for customization | |
15800 | ||
8223b1d2 | 15801 | There are more than 500 variables that can be used to customize |
86fbb8ca CD |
15802 | Org. For the sake of compactness of the manual, I am not |
15803 | describing the variables here. A structured overview of customization | |
271672fa | 15804 | variables is available with @kbd{M-x org-customize RET}. Or select |
86fbb8ca CD |
15805 | @code{Browse Org Group} from the @code{Org->Customization} menu. Many |
15806 | settings can also be activated on a per-file basis, by putting special | |
15807 | lines into the buffer (@pxref{In-buffer settings}). | |
4009494e GM |
15808 | |
15809 | @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
15810 | @section Summary of in-buffer settings | |
15811 | @cindex in-buffer settings | |
15812 | @cindex special keywords | |
15813 | ||
e66ba1df | 15814 | Org mode uses special lines in the buffer to define settings on a |
4009494e GM |
15815 | per-file basis. These lines start with a @samp{#+} followed by a |
15816 | keyword, a colon, and then individual words defining a setting. Several | |
15817 | setting words can be in the same line, but you can also have multiple | |
15818 | lines for the keyword. While these settings are described throughout | |
15819 | the manual, here is a summary. After changing any of those lines in the | |
15820 | buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
15821 | activate the changes immediately. Otherwise they become effective only | |
15822 | when the file is visited again in a new Emacs session. | |
15823 | ||
c8d0cf5c | 15824 | @vindex org-archive-location |
4009494e GM |
15825 | @table @kbd |
15826 | @item #+ARCHIVE: %s_done:: | |
15827 | This line sets the archive location for the agenda file. It applies for | |
15828 | all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
15829 | of the file. The first such line also applies to any entries before it. | |
15830 | The corresponding variable is @code{org-archive-location}. | |
15831 | @item #+CATEGORY: | |
15832 | This line sets the category for the agenda file. The category applies | |
15833 | for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
15834 | end of the file. The first such line also applies to any entries before it. | |
15835 | @item #+COLUMNS: %25ITEM ..... | |
c8d0cf5c | 15836 | @cindex property, COLUMNS |
4009494e | 15837 | Set the default format for columns view. This format applies when |
c8d0cf5c | 15838 | columns view is invoked in locations where no @code{COLUMNS} property |
dbc28aaa | 15839 | applies. |
4009494e | 15840 | @item #+CONSTANTS: name1=value1 ... |
c8d0cf5c CD |
15841 | @vindex org-table-formula-constants |
15842 | @vindex org-table-formula | |
4009494e | 15843 | Set file-local values for constants to be used in table formulas. This |
acedf35c | 15844 | line sets the local variable @code{org-table-formula-constants-local}. |
dbc28aaa | 15845 | The global version of this variable is |
4009494e | 15846 | @code{org-table-formula-constants}. |
b349f79f CD |
15847 | @item #+FILETAGS: :tag1:tag2:tag3: |
15848 | Set tags that can be inherited by any entry in the file, including the | |
15849 | top-level entries. | |
dbc28aaa | 15850 | @item #+DRAWERS: NAME1 ..... |
c8d0cf5c | 15851 | @vindex org-drawers |
8223b1d2 BG |
15852 | Set the file-local set of additional drawers. The corresponding global |
15853 | variable is @code{org-drawers}. | |
4009494e | 15854 | @item #+LINK: linkword replace |
c8d0cf5c | 15855 | @vindex org-link-abbrev-alist |
4009494e GM |
15856 | These lines (several are allowed) specify link abbreviations. |
15857 | @xref{Link abbreviations}. The corresponding variable is | |
15858 | @code{org-link-abbrev-alist}. | |
15859 | @item #+PRIORITIES: highest lowest default | |
c8d0cf5c CD |
15860 | @vindex org-highest-priority |
15861 | @vindex org-lowest-priority | |
15862 | @vindex org-default-priority | |
4009494e | 15863 | This line sets the limits and the default for the priorities. All three |
f99f1641 | 15864 | must be either letters A--Z or numbers 0--9. The highest priority must |
acedf35c | 15865 | have a lower ASCII number than the lowest priority. |
4009494e GM |
15866 | @item #+PROPERTY: Property_Name Value |
15867 | This line sets a default inheritance value for entries in the current | |
15868 | buffer, most useful for specifying the allowed values of a property. | |
c8d0cf5c | 15869 | @cindex #+SETUPFILE |
b349f79f CD |
15870 | @item #+SETUPFILE: file |
15871 | This line defines a file that holds more in-buffer setup. Normally this is | |
15872 | entirely ignored. Only when the buffer is parsed for option-setting lines | |
1e20eeb7 | 15873 | (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a |
b349f79f | 15874 | settings line, or when exporting), then the contents of this file are parsed |
a50253cc | 15875 | as if they had been included in the buffer. In particular, the file can be |
e66ba1df | 15876 | any other Org mode file with internal setup. You can visit the file the |
b349f79f | 15877 | cursor is in the line with @kbd{C-c '}. |
4009494e | 15878 | @item #+STARTUP: |
271672fa | 15879 | @cindex #+STARTUP |
e66ba1df | 15880 | This line sets options to be used at startup of Org mode, when an |
c8d0cf5c CD |
15881 | Org file is being visited. |
15882 | ||
15883 | The first set of options deals with the initial visibility of the outline | |
15884 | tree. The corresponding variable for global default settings is | |
15885 | @code{org-startup-folded}, with a default value @code{t}, which means | |
15886 | @code{overview}. | |
15887 | @vindex org-startup-folded | |
4009494e GM |
15888 | @cindex @code{overview}, STARTUP keyword |
15889 | @cindex @code{content}, STARTUP keyword | |
15890 | @cindex @code{showall}, STARTUP keyword | |
7006d207 | 15891 | @cindex @code{showeverything}, STARTUP keyword |
4009494e | 15892 | @example |
7006d207 CD |
15893 | overview @r{top-level headlines only} |
15894 | content @r{all headlines} | |
15895 | showall @r{no folding of any entries} | |
15896 | showeverything @r{show even drawer contents} | |
4009494e | 15897 | @end example |
c8d0cf5c CD |
15898 | |
15899 | @vindex org-startup-indented | |
15900 | @cindex @code{indent}, STARTUP keyword | |
15901 | @cindex @code{noindent}, STARTUP keyword | |
15902 | Dynamic virtual indentation is controlled by the variable | |
e66ba1df | 15903 | @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required} |
c8d0cf5c CD |
15904 | @example |
15905 | indent @r{start with @code{org-indent-mode} turned on} | |
15906 | noindent @r{start with @code{org-indent-mode} turned off} | |
15907 | @end example | |
15908 | ||
15909 | @vindex org-startup-align-all-tables | |
4009494e GM |
15910 | Then there are options for aligning tables upon visiting a file. This |
15911 | is useful in files containing narrowed table columns. The corresponding | |
15912 | variable is @code{org-startup-align-all-tables}, with a default value | |
28a16a1b | 15913 | @code{nil}. |
4009494e GM |
15914 | @cindex @code{align}, STARTUP keyword |
15915 | @cindex @code{noalign}, STARTUP keyword | |
15916 | @example | |
15917 | align @r{align all tables} | |
15918 | noalign @r{don't align tables on startup} | |
15919 | @end example | |
afe98dfa CD |
15920 | |
15921 | @vindex org-startup-with-inline-images | |
15922 | When visiting a file, inline images can be automatically displayed. The | |
15923 | corresponding variable is @code{org-startup-with-inline-images}, with a | |
15924 | default value @code{nil} to avoid delays when visiting a file. | |
15925 | @cindex @code{inlineimages}, STARTUP keyword | |
15926 | @cindex @code{noinlineimages}, STARTUP keyword | |
15927 | @example | |
15928 | inlineimages @r{show inline images} | |
15929 | noinlineimages @r{don't show inline images on startup} | |
15930 | @end example | |
15931 | ||
271672fa BG |
15932 | @vindex org-startup-with-latex-preview |
15933 | When visiting a file, @LaTeX{} fragments can be converted to images | |
15934 | automatically. The variable @code{org-startup-with-latex-preview} which | |
15935 | controls this behavior, is set to @code{nil} by default to avoid delays on | |
15936 | startup. | |
15937 | @cindex @code{latexpreview}, STARTUP keyword | |
15938 | @cindex @code{nolatexpreview}, STARTUP keyword | |
15939 | @example | |
15940 | latexpreview @r{preview @LaTeX{} fragments} | |
15941 | nolatexpreview @r{don't preview @LaTeX{} fragments} | |
15942 | @end example | |
15943 | ||
c8d0cf5c CD |
15944 | @vindex org-log-done |
15945 | @vindex org-log-note-clock-out | |
15946 | @vindex org-log-repeat | |
15947 | Logging the closing and reopening of TODO items and clock intervals can be | |
15948 | configured using these options (see variables @code{org-log-done}, | |
15949 | @code{org-log-note-clock-out} and @code{org-log-repeat}) | |
4009494e | 15950 | @cindex @code{logdone}, STARTUP keyword |
4009494e | 15951 | @cindex @code{lognotedone}, STARTUP keyword |
28a16a1b | 15952 | @cindex @code{nologdone}, STARTUP keyword |
4009494e | 15953 | @cindex @code{lognoteclock-out}, STARTUP keyword |
28a16a1b | 15954 | @cindex @code{nolognoteclock-out}, STARTUP keyword |
4009494e | 15955 | @cindex @code{logrepeat}, STARTUP keyword |
28a16a1b | 15956 | @cindex @code{lognoterepeat}, STARTUP keyword |
4009494e | 15957 | @cindex @code{nologrepeat}, STARTUP keyword |
a351880d CD |
15958 | @cindex @code{logreschedule}, STARTUP keyword |
15959 | @cindex @code{lognotereschedule}, STARTUP keyword | |
15960 | @cindex @code{nologreschedule}, STARTUP keyword | |
15961 | @cindex @code{logredeadline}, STARTUP keyword | |
15962 | @cindex @code{lognoteredeadline}, STARTUP keyword | |
15963 | @cindex @code{nologredeadline}, STARTUP keyword | |
ed21c5c8 CD |
15964 | @cindex @code{logrefile}, STARTUP keyword |
15965 | @cindex @code{lognoterefile}, STARTUP keyword | |
15966 | @cindex @code{nologrefile}, STARTUP keyword | |
271672fa BG |
15967 | @cindex @code{logdrawer}, STARTUP keyword |
15968 | @cindex @code{nologdrawer}, STARTUP keyword | |
15969 | @cindex @code{logstatesreversed}, STARTUP keyword | |
15970 | @cindex @code{nologstatesreversed}, STARTUP keyword | |
15971 | @example | |
15972 | logdone @r{record a timestamp when an item is marked DONE} | |
15973 | lognotedone @r{record timestamp and a note when DONE} | |
15974 | nologdone @r{don't record when items are marked DONE} | |
15975 | logrepeat @r{record a time when reinstating a repeating item} | |
15976 | lognoterepeat @r{record a note when reinstating a repeating item} | |
15977 | nologrepeat @r{do not record when reinstating repeating item} | |
15978 | lognoteclock-out @r{record a note when clocking out} | |
15979 | nolognoteclock-out @r{don't record a note when clocking out} | |
15980 | logreschedule @r{record a timestamp when scheduling time changes} | |
15981 | lognotereschedule @r{record a note when scheduling time changes} | |
15982 | nologreschedule @r{do not record when a scheduling date changes} | |
15983 | logredeadline @r{record a timestamp when deadline changes} | |
15984 | lognoteredeadline @r{record a note when deadline changes} | |
15985 | nologredeadline @r{do not record when a deadline date changes} | |
15986 | logrefile @r{record a timestamp when refiling} | |
15987 | lognoterefile @r{record a note when refiling} | |
15988 | nologrefile @r{do not record when refiling} | |
15989 | logdrawer @r{store log into drawer} | |
15990 | nologdrawer @r{store log outside of drawer} | |
15991 | logstatesreversed @r{reverse the order of states notes} | |
15992 | nologstatesreversed @r{do not reverse the order of states notes} | |
4009494e | 15993 | @end example |
271672fa | 15994 | |
c8d0cf5c CD |
15995 | @vindex org-hide-leading-stars |
15996 | @vindex org-odd-levels-only | |
b349f79f CD |
15997 | Here are the options for hiding leading stars in outline headings, and for |
15998 | indenting outlines. The corresponding variables are | |
15999 | @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a | |
16000 | default setting @code{nil} (meaning @code{showstars} and @code{oddeven}). | |
4009494e GM |
16001 | @cindex @code{hidestars}, STARTUP keyword |
16002 | @cindex @code{showstars}, STARTUP keyword | |
16003 | @cindex @code{odd}, STARTUP keyword | |
16004 | @cindex @code{even}, STARTUP keyword | |
16005 | @example | |
16006 | hidestars @r{make all but one of the stars starting a headline invisible.} | |
16007 | showstars @r{show all stars starting a headline} | |
b349f79f CD |
16008 | indent @r{virtual indentation according to outline level} |
16009 | noindent @r{no virtual indentation according to outline level} | |
4009494e GM |
16010 | odd @r{allow only odd outline levels (1,3,...)} |
16011 | oddeven @r{allow all outline levels} | |
16012 | @end example | |
271672fa | 16013 | |
c8d0cf5c CD |
16014 | @vindex org-put-time-stamp-overlays |
16015 | @vindex org-time-stamp-overlay-formats | |
16016 | To turn on custom format overlays over timestamps (variables | |
4009494e GM |
16017 | @code{org-put-time-stamp-overlays} and |
16018 | @code{org-time-stamp-overlay-formats}), use | |
16019 | @cindex @code{customtime}, STARTUP keyword | |
16020 | @example | |
16021 | customtime @r{overlay custom time format} | |
16022 | @end example | |
271672fa | 16023 | |
c8d0cf5c | 16024 | @vindex constants-unit-system |
4009494e GM |
16025 | The following options influence the table spreadsheet (variable |
16026 | @code{constants-unit-system}). | |
16027 | @cindex @code{constcgs}, STARTUP keyword | |
16028 | @cindex @code{constSI}, STARTUP keyword | |
16029 | @example | |
16030 | constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
16031 | constSI @r{@file{constants.el} should use the SI unit system} | |
16032 | @end example | |
271672fa | 16033 | |
c8d0cf5c CD |
16034 | @vindex org-footnote-define-inline |
16035 | @vindex org-footnote-auto-label | |
16036 | @vindex org-footnote-auto-adjust | |
55e0839d | 16037 | To influence footnote settings, use the following keywords. The |
c8d0cf5c CD |
16038 | corresponding variables are @code{org-footnote-define-inline}, |
16039 | @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}. | |
55e0839d | 16040 | @cindex @code{fninline}, STARTUP keyword |
c8d0cf5c | 16041 | @cindex @code{nofninline}, STARTUP keyword |
55e0839d CD |
16042 | @cindex @code{fnlocal}, STARTUP keyword |
16043 | @cindex @code{fnprompt}, STARTUP keyword | |
16044 | @cindex @code{fnauto}, STARTUP keyword | |
16045 | @cindex @code{fnconfirm}, STARTUP keyword | |
16046 | @cindex @code{fnplain}, STARTUP keyword | |
c8d0cf5c CD |
16047 | @cindex @code{fnadjust}, STARTUP keyword |
16048 | @cindex @code{nofnadjust}, STARTUP keyword | |
55e0839d CD |
16049 | @example |
16050 | fninline @r{define footnotes inline} | |
16051 | fnnoinline @r{define footnotes in separate section} | |
16052 | fnlocal @r{define footnotes near first reference, but not inline} | |
16053 | fnprompt @r{prompt for footnote labels} | |
ce57c2fe | 16054 | fnauto @r{create @code{[fn:1]}-like labels automatically (default)} |
55e0839d | 16055 | fnconfirm @r{offer automatic label for editing or confirmation} |
ce57c2fe | 16056 | fnplain @r{create @code{[1]}-like labels automatically} |
c8d0cf5c CD |
16057 | fnadjust @r{automatically renumber and sort footnotes} |
16058 | nofnadjust @r{do not renumber and sort automatically} | |
16059 | @end example | |
271672fa | 16060 | |
c8d0cf5c | 16061 | @cindex org-hide-block-startup |
ce57c2fe | 16062 | To hide blocks on startup, use these keywords. The corresponding variable is |
c8d0cf5c CD |
16063 | @code{org-hide-block-startup}. |
16064 | @cindex @code{hideblocks}, STARTUP keyword | |
16065 | @cindex @code{nohideblocks}, STARTUP keyword | |
16066 | @example | |
16067 | hideblocks @r{Hide all begin/end blocks on startup} | |
16068 | nohideblocks @r{Do not hide blocks on startup} | |
55e0839d | 16069 | @end example |
271672fa | 16070 | |
86fbb8ca | 16071 | @cindex org-pretty-entities |
acedf35c | 16072 | The display of entities as UTF-8 characters is governed by the variable |
86fbb8ca CD |
16073 | @code{org-pretty-entities} and the keywords |
16074 | @cindex @code{entitiespretty}, STARTUP keyword | |
16075 | @cindex @code{entitiesplain}, STARTUP keyword | |
16076 | @example | |
acedf35c | 16077 | entitiespretty @r{Show entities as UTF-8 characters where possible} |
86fbb8ca CD |
16078 | entitiesplain @r{Leave entities plain} |
16079 | @end example | |
271672fa | 16080 | |
4009494e | 16081 | @item #+TAGS: TAG1(c1) TAG2(c2) |
c8d0cf5c | 16082 | @vindex org-tag-alist |
cad1d376 | 16083 | These lines (several such lines are allowed) specify the valid tags in |
4009494e GM |
16084 | this file, and (potentially) the corresponding @emph{fast tag selection} |
16085 | keys. The corresponding variable is @code{org-tag-alist}. | |
271672fa | 16086 | @cindex #+TBLFM |
4009494e GM |
16087 | @item #+TBLFM: |
16088 | This line contains the formulas for the table directly above the line. | |
271672fa BG |
16089 | |
16090 | Table can have multiple lines containing @samp{#+TBLFM:}. Note | |
16091 | that only the first line of @samp{#+TBLFM:} will be applied when | |
16092 | you recalculate the table. For more details see @ref{Using | |
16093 | multiple #+TBLFM lines} in @ref{Editing and debugging formulas}. | |
16094 | ||
16095 | @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:, | |
16096 | @itemx #+OPTIONS:, #+BIND:, | |
86fbb8ca | 16097 | @itemx #+DESCRIPTION:, #+KEYWORDS:, |
271672fa BG |
16098 | @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:, |
16099 | @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:, | |
16100 | @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS: | |
4009494e | 16101 | These lines provide settings for exporting files. For more details see |
271672fa | 16102 | @ref{Export settings}. |
c8d0cf5c CD |
16103 | @item #+TODO: #+SEQ_TODO: #+TYP_TODO: |
16104 | @vindex org-todo-keywords | |
4009494e | 16105 | These lines set the TODO keywords and their interpretation in the |
c8d0cf5c | 16106 | current file. The corresponding variable is @code{org-todo-keywords}. |
4009494e GM |
16107 | @end table |
16108 | ||
16109 | @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
16110 | @section The very busy C-c C-c key | |
16111 | @kindex C-c C-c | |
16112 | @cindex C-c C-c, overview | |
16113 | ||
a7808fba | 16114 | The key @kbd{C-c C-c} has many purposes in Org, which are all |
4009494e GM |
16115 | mentioned scattered throughout this manual. One specific function of |
16116 | this key is to add @emph{tags} to a headline (@pxref{Tags}). In many | |
c8d0cf5c CD |
16117 | other circumstances it means something like @emph{``Hey Org, look |
16118 | here and update according to what you see here''}. Here is a summary of | |
4009494e GM |
16119 | what this means in different contexts. |
16120 | ||
16121 | @itemize @minus | |
16122 | @item | |
16123 | If there are highlights in the buffer from the creation of a sparse | |
16124 | tree, or from clock display, remove these highlights. | |
16125 | @item | |
16126 | If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
16127 | triggers scanning the buffer for these lines and updating the | |
28a16a1b | 16128 | information. |
4009494e GM |
16129 | @item |
16130 | If the cursor is inside a table, realign the table. This command | |
16131 | works even if the automatic table editor has been turned off. | |
16132 | @item | |
16133 | If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
16134 | the entire table. | |
16135 | @item | |
86fbb8ca | 16136 | If the current buffer is a capture buffer, close the note and file it. |
4009494e GM |
16137 | With a prefix argument, file it, without further interaction, to the |
16138 | default location. | |
16139 | @item | |
16140 | If the cursor is on a @code{<<<target>>>}, update radio targets and | |
16141 | corresponding links in this buffer. | |
16142 | @item | |
16143 | If the cursor is in a property line or at the start or end of a property | |
16144 | drawer, offer property commands. | |
16145 | @item | |
55e0839d | 16146 | If the cursor is at a footnote reference, go to the corresponding |
271672fa | 16147 | definition, and @emph{vice versa}. |
55e0839d | 16148 | @item |
6eb02347 CD |
16149 | If the cursor is on a statistics cookie, update it. |
16150 | @item | |
4009494e GM |
16151 | If the cursor is in a plain list item with a checkbox, toggle the status |
16152 | of the checkbox. | |
16153 | @item | |
16154 | If the cursor is on a numbered item in a plain list, renumber the | |
16155 | ordered list. | |
dbc28aaa | 16156 | @item |
c8d0cf5c | 16157 | If the cursor is on the @code{#+BEGIN} line of a dynamic block, the |
dbc28aaa | 16158 | block is updated. |
e66ba1df BG |
16159 | @item |
16160 | If the cursor is at a timestamp, fix the day name in the timestamp. | |
4009494e GM |
16161 | @end itemize |
16162 | ||
16163 | @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
16164 | @section A cleaner outline view | |
16165 | @cindex hiding leading stars | |
b349f79f CD |
16166 | @cindex dynamic indentation |
16167 | @cindex odd-levels-only outlines | |
4009494e GM |
16168 | @cindex clean outline view |
16169 | ||
c8d0cf5c CD |
16170 | Some people find it noisy and distracting that the Org headlines start with a |
16171 | potentially large number of stars, and that text below the headlines is not | |
6eb02347 CD |
16172 | indented. While this is no problem when writing a @emph{book-like} document |
16173 | where the outline headings are really section headings, in a more | |
16174 | @emph{list-oriented} outline, indented structure is a lot cleaner: | |
4009494e GM |
16175 | |
16176 | @example | |
b349f79f CD |
16177 | @group |
16178 | * Top level headline | * Top level headline | |
16179 | ** Second level | * Second level | |
16180 | *** 3rd level | * 3rd level | |
16181 | some text | some text | |
16182 | *** 3rd level | * 3rd level | |
16183 | more text | more text | |
16184 | * Another top level headline | * Another top level headline | |
16185 | @end group | |
4009494e GM |
16186 | @end example |
16187 | ||
16188 | @noindent | |
86fbb8ca CD |
16189 | |
16190 | If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash | |
16191 | with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can | |
16192 | be achieved dynamically at display time using @code{org-indent-mode}. In | |
16193 | this minor mode, all lines are prefixed for display with the necessary amount | |
16194 | of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix} | |
16195 | property, such that @code{visual-line-mode} (or purely setting | |
16196 | @code{word-wrap}) wraps long lines (including headlines) correctly indented. | |
16197 | }. Also headlines are prefixed with additional stars, so that the amount of | |
16198 | indentation shifts by two@footnote{See the variable | |
ed21c5c8 CD |
16199 | @code{org-indent-indentation-per-level}.} spaces per level. All headline |
16200 | stars but the last one are made invisible using the @code{org-hide} | |
16201 | face@footnote{Turning on @code{org-indent-mode} sets | |
16202 | @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to | |
f99f1641 | 16203 | @code{nil}.}; see below under @samp{2.} for more information on how this |
ed21c5c8 CD |
16204 | works. You can turn on @code{org-indent-mode} for all files by customizing |
16205 | the variable @code{org-startup-indented}, or you can turn it on for | |
16206 | individual files using | |
c8d0cf5c CD |
16207 | |
16208 | @example | |
16209 | #+STARTUP: indent | |
16210 | @end example | |
16211 | ||
acedf35c | 16212 | If you want a similar effect in an earlier version of Emacs and/or Org, or if |
c8d0cf5c CD |
16213 | you want the indentation to be hard space characters so that the plain text |
16214 | file looks as similar as possible to the Emacs display, Org supports you in | |
16215 | the following way: | |
4009494e | 16216 | |
b349f79f | 16217 | @enumerate |
96c8522a | 16218 | @item |
b349f79f CD |
16219 | @emph{Indentation of text below headlines}@* |
16220 | You may indent text below each headline to make the left boundary line up | |
16221 | with the headline, like | |
4009494e | 16222 | |
b349f79f CD |
16223 | @example |
16224 | *** 3rd level | |
16225 | more text, now indented | |
16226 | @end example | |
16227 | ||
c8d0cf5c CD |
16228 | @vindex org-adapt-indentation |
16229 | Org supports this with paragraph filling, line wrapping, and structure | |
16230 | editing@footnote{See also the variable @code{org-adapt-indentation}.}, | |
16231 | preserving or adapting the indentation as appropriate. | |
b349f79f CD |
16232 | |
16233 | @item | |
c8d0cf5c | 16234 | @vindex org-hide-leading-stars |
b349f79f CD |
16235 | @emph{Hiding leading stars}@* You can modify the display in such a way that |
16236 | all leading stars become invisible. To do this in a global way, configure | |
16237 | the variable @code{org-hide-leading-stars} or change this on a per-file basis | |
16238 | with | |
4009494e GM |
16239 | |
16240 | @example | |
4009494e | 16241 | #+STARTUP: hidestars |
c8d0cf5c | 16242 | #+STARTUP: showstars |
4009494e GM |
16243 | @end example |
16244 | ||
b349f79f | 16245 | With hidden stars, the tree becomes: |
4009494e GM |
16246 | |
16247 | @example | |
b349f79f | 16248 | @group |
4009494e GM |
16249 | * Top level headline |
16250 | * Second level | |
16251 | * 3rd level | |
b349f79f CD |
16252 | ... |
16253 | @end group | |
4009494e GM |
16254 | @end example |
16255 | ||
16256 | @noindent | |
c8d0cf5c CD |
16257 | @vindex org-hide @r{(face)} |
16258 | The leading stars are not truly replaced by whitespace, they are only | |
16259 | fontified with the face @code{org-hide} that uses the background color as | |
16260 | font color. If you are not using either white or black background, you may | |
16261 | have to customize this face to get the wanted effect. Another possibility is | |
16262 | to set this font such that the extra stars are @i{almost} invisible, for | |
16263 | example using the color @code{grey90} on a white background. | |
4009494e | 16264 | |
b349f79f | 16265 | @item |
c8d0cf5c | 16266 | @vindex org-odd-levels-only |
b349f79f CD |
16267 | Things become cleaner still if you skip all the even levels and use only odd |
16268 | levels 1, 3, 5..., effectively adding two stars to go from one outline level | |
c8d0cf5c | 16269 | to the next@footnote{When you need to specify a level for a property search |
1e20eeb7 | 16270 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this |
c8d0cf5c CD |
16271 | way we get the outline view shown at the beginning of this section. In order |
16272 | to make the structure editing and export commands handle this convention | |
16273 | correctly, configure the variable @code{org-odd-levels-only}, or set this on | |
16274 | a per-file basis with one of the following lines: | |
4009494e GM |
16275 | |
16276 | @example | |
16277 | #+STARTUP: odd | |
16278 | #+STARTUP: oddeven | |
16279 | @end example | |
16280 | ||
a7808fba | 16281 | You can convert an Org file from single-star-per-level to the |
4009494e GM |
16282 | double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
16283 | RET} in that file. The reverse operation is @kbd{M-x | |
16284 | org-convert-to-oddeven-levels}. | |
b349f79f | 16285 | @end enumerate |
4009494e GM |
16286 | |
16287 | @node TTY keys, Interaction, Clean view, Miscellaneous | |
a7808fba CD |
16288 | @section Using Org on a tty |
16289 | @cindex tty key bindings | |
4009494e | 16290 | |
c8d0cf5c | 16291 | Because Org contains a large number of commands, by default many of |
a7808fba | 16292 | Org's core commands are bound to keys that are generally not |
dbc28aaa CD |
16293 | accessible on a tty, such as the cursor keys (@key{left}, @key{right}, |
16294 | @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used | |
16295 | together with modifiers like @key{Meta} and/or @key{Shift}. To access | |
16296 | these commands on a tty when special keys are unavailable, the following | |
16297 | alternative bindings can be used. The tty bindings below will likely be | |
16298 | more cumbersome; you may find for some of the bindings below that a | |
c8d0cf5c CD |
16299 | customized workaround suits you better. For example, changing a timestamp |
16300 | is really only fun with @kbd{S-@key{cursor}} keys, whereas on a | |
dbc28aaa | 16301 | tty you would rather use @kbd{C-c .} to re-insert the timestamp. |
4009494e | 16302 | |
17673adf | 16303 | @multitable @columnfractions 0.15 0.2 0.1 0.2 |
86fbb8ca CD |
16304 | @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2} |
16305 | @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab | |
16306 | @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}} | |
16307 | @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab | |
17673adf | 16308 | @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}} |
86fbb8ca CD |
16309 | @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab |
16310 | @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}} | |
16311 | @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab | |
17673adf | 16312 | @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}} |
86fbb8ca | 16313 | @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab |
17673adf CD |
16314 | @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab |
16315 | @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}} | |
16316 | @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab | |
16317 | @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab | |
16318 | @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab | |
16319 | @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab | |
16320 | @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab | |
16321 | @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab | |
16322 | @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab | |
4009494e GM |
16323 | @end multitable |
16324 | ||
c8d0cf5c | 16325 | |
271672fa | 16326 | @node Interaction, org-crypt, TTY keys, Miscellaneous |
4009494e GM |
16327 | @section Interaction with other packages |
16328 | @cindex packages, interaction with other | |
a7808fba | 16329 | Org lives in the world of GNU Emacs and interacts in various ways |
4009494e GM |
16330 | with other code out there. |
16331 | ||
16332 | @menu | |
c0468714 GM |
16333 | * Cooperation:: Packages Org cooperates with |
16334 | * Conflicts:: Packages that lead to conflicts | |
4009494e GM |
16335 | @end menu |
16336 | ||
16337 | @node Cooperation, Conflicts, Interaction, Interaction | |
a7808fba | 16338 | @subsection Packages that Org cooperates with |
4009494e GM |
16339 | |
16340 | @table @asis | |
16341 | @cindex @file{calc.el} | |
c8d0cf5c | 16342 | @cindex Gillespie, Dave |
4009494e | 16343 | @item @file{calc.el} by Dave Gillespie |
a7808fba CD |
16344 | Org uses the Calc package for implementing spreadsheet |
16345 | functionality in its tables (@pxref{The spreadsheet}). Org | |
16346 | checks for the availability of Calc by looking for the function | |
c8d0cf5c | 16347 | @code{calc-eval} which will have been autoloaded during setup if Calc has |
a7808fba | 16348 | been installed properly. As of Emacs 22, Calc is part of the Emacs |
4009494e | 16349 | distribution. Another possibility for interaction between the two |
ce57c2fe | 16350 | packages is using Calc for embedded calculations. @xref{Embedded Mode, |
153ae947 | 16351 | , Embedded Mode, calc, GNU Emacs Calc Manual}. |
4009494e | 16352 | @item @file{constants.el} by Carsten Dominik |
c8d0cf5c CD |
16353 | @cindex @file{constants.el} |
16354 | @cindex Dominik, Carsten | |
16355 | @vindex org-table-formula-constants | |
4009494e GM |
16356 | In a table formula (@pxref{The spreadsheet}), it is possible to use |
16357 | names for natural constants or units. Instead of defining your own | |
16358 | constants in the variable @code{org-table-formula-constants}, install | |
16359 | the @file{constants} package which defines a large number of constants | |
16360 | and units, and lets you use unit prefixes like @samp{M} for | |
1e20eeb7 | 16361 | @samp{Mega}, etc. You will need version 2.0 of this package, available |
ce57c2fe | 16362 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
4009494e GM |
16363 | the function @code{constants-get}, which has to be autoloaded in your |
16364 | setup. See the installation instructions in the file | |
16365 | @file{constants.el}. | |
16366 | @item @file{cdlatex.el} by Carsten Dominik | |
16367 | @cindex @file{cdlatex.el} | |
c8d0cf5c | 16368 | @cindex Dominik, Carsten |
e66ba1df | 16369 | Org mode can make use of the CD@LaTeX{} package to efficiently enter |
acedf35c | 16370 | @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}. |
dbc28aaa CD |
16371 | @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg |
16372 | @cindex @file{imenu.el} | |
e66ba1df | 16373 | Imenu allows menu access to an index of items in a file. Org mode |
c8d0cf5c | 16374 | supports Imenu---all you need to do to get the index is the following: |
dbc28aaa | 16375 | @lisp |
28a16a1b | 16376 | (add-hook 'org-mode-hook |
a7808fba | 16377 | (lambda () (imenu-add-to-menubar "Imenu"))) |
dbc28aaa | 16378 | @end lisp |
c8d0cf5c CD |
16379 | @vindex org-imenu-depth |
16380 | By default the index is two levels deep---you can modify the depth using | |
dbc28aaa | 16381 | the option @code{org-imenu-depth}. |
4009494e GM |
16382 | @item @file{remember.el} by John Wiegley |
16383 | @cindex @file{remember.el} | |
c8d0cf5c | 16384 | @cindex Wiegley, John |
86fbb8ca | 16385 | Org used to use this package for capture, but no longer does. |
dbc28aaa CD |
16386 | @item @file{speedbar.el} by Eric M. Ludlam |
16387 | @cindex @file{speedbar.el} | |
c8d0cf5c | 16388 | @cindex Ludlam, Eric M. |
dbc28aaa | 16389 | Speedbar is a package that creates a special frame displaying files and |
e66ba1df | 16390 | index items in files. Org mode supports Speedbar and allows you to |
c8d0cf5c | 16391 | drill into Org files directly from the Speedbar. It also allows you to |
dbc28aaa | 16392 | restrict the scope of agenda commands to a file or a subtree by using |
a7808fba | 16393 | the command @kbd{<} in the Speedbar frame. |
4009494e GM |
16394 | @cindex @file{table.el} |
16395 | @item @file{table.el} by Takaaki Ota | |
16396 | @kindex C-c C-c | |
16397 | @cindex table editor, @file{table.el} | |
16398 | @cindex @file{table.el} | |
c8d0cf5c | 16399 | @cindex Ota, Takaaki |
4009494e | 16400 | |
ed21c5c8 CD |
16401 | Complex ASCII tables with automatic line wrapping, column- and row-spanning, |
16402 | and alignment can be created using the Emacs table package by Takaaki Ota | |
16403 | (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22). | |
e66ba1df BG |
16404 | Org mode will recognize these tables and export them properly. Because of |
16405 | interference with other Org mode functionality, you unfortunately cannot edit | |
ed21c5c8 CD |
16406 | these tables directly in the buffer. Instead, you need to use the command |
16407 | @kbd{C-c '} to edit them, similar to source code snippets. | |
4009494e GM |
16408 | |
16409 | @table @kbd | |
acedf35c | 16410 | @orgcmd{C-c ',org-edit-special} |
ed21c5c8 | 16411 | Edit a @file{table.el} table. Works when the cursor is in a table.el table. |
4009494e | 16412 | @c |
acedf35c | 16413 | @orgcmd{C-c ~,org-table-create-with-table.el} |
c8d0cf5c | 16414 | Insert a @file{table.el} table. If there is already a table at point, this |
e66ba1df | 16415 | command converts it between the @file{table.el} format and the Org mode |
4009494e GM |
16416 | format. See the documentation string of the command |
16417 | @code{org-convert-table} for the restrictions under which this is | |
16418 | possible. | |
16419 | @end table | |
ed21c5c8 | 16420 | @file{table.el} is part of Emacs since Emacs 22. |
4009494e | 16421 | @item @file{footnote.el} by Steven L. Baur |
c8d0cf5c CD |
16422 | @cindex @file{footnote.el} |
16423 | @cindex Baur, Steven L. | |
e66ba1df BG |
16424 | Org mode recognizes numerical footnotes as provided by this package. |
16425 | However, Org mode also has its own footnote support (@pxref{Footnotes}), | |
55e0839d | 16426 | which makes using @file{footnote.el} unnecessary. |
4009494e GM |
16427 | @end table |
16428 | ||
16429 | @node Conflicts, , Cooperation, Interaction | |
e66ba1df | 16430 | @subsection Packages that lead to conflicts with Org mode |
4009494e GM |
16431 | |
16432 | @table @asis | |
16433 | ||
3da3282e | 16434 | @cindex @code{shift-selection-mode} |
c8d0cf5c | 16435 | @vindex org-support-shift-select |
3da3282e CD |
16436 | In Emacs 23, @code{shift-selection-mode} is on by default, meaning that |
16437 | cursor motions combined with the shift key should start or enlarge regions. | |
16438 | This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change | |
16439 | timestamps, TODO keywords, priorities, and item bullet types if the cursor is | |
16440 | at such a location. By default, @kbd{S-@key{cursor}} commands outside | |
16441 | special contexts don't do anything, but you can customize the variable | |
e66ba1df | 16442 | @code{org-support-shift-select}. Org mode then tries to accommodate shift |
3da3282e CD |
16443 | selection by (i) using it outside of the special contexts where special |
16444 | commands apply, and by (ii) extending an existing active region even if the | |
16445 | cursor moves across a special context. | |
4009494e | 16446 | |
4009494e | 16447 | @item @file{CUA.el} by Kim. F. Storm |
c8d0cf5c CD |
16448 | @cindex @file{CUA.el} |
16449 | @cindex Storm, Kim. F. | |
16450 | @vindex org-replace-disputed-keys | |
3da3282e | 16451 | Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode |
c8d0cf5c | 16452 | (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the |
3da3282e CD |
16453 | region. In fact, Emacs 23 has this built-in in the form of |
16454 | @code{shift-selection-mode}, see previous paragraph. If you are using Emacs | |
c8d0cf5c | 16455 | 23, you probably don't want to use another package for this purpose. However, |
3da3282e | 16456 | if you prefer to leave these keys to a different package while working in |
e66ba1df | 16457 | Org mode, configure the variable @code{org-replace-disputed-keys}. When set, |
3da3282e CD |
16458 | Org will move the following key bindings in Org files, and in the agenda |
16459 | buffer (but not during date selection). | |
4009494e GM |
16460 | |
16461 | @example | |
ce57c2fe BG |
16462 | S-UP @result{} M-p S-DOWN @result{} M-n |
16463 | S-LEFT @result{} M-- S-RIGHT @result{} M-+ | |
16464 | C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+ | |
4009494e GM |
16465 | @end example |
16466 | ||
c8d0cf5c | 16467 | @vindex org-disputed-keys |
4009494e GM |
16468 | Yes, these are unfortunately more difficult to remember. If you want |
16469 | to have other replacement keys, look at the variable | |
16470 | @code{org-disputed-keys}. | |
3da3282e | 16471 | |
271672fa BG |
16472 | @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org} |
16473 | @cindex @file{ecomplete.el} | |
16474 | ||
16475 | Ecomplete provides ``electric'' address completion in address header | |
16476 | lines in message buffers. Sadly Orgtbl mode cuts ecompletes power | |
16477 | supply: No completion happens when Orgtbl mode is enabled in message | |
16478 | buffers while entering text in address header lines. If one wants to | |
16479 | use ecomplete one should @emph{not} follow the advice to automagically | |
16480 | turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but | |
16481 | instead---after filling in the message headers---turn on Orgtbl mode | |
16482 | manually when needed in the messages body. | |
16483 | ||
8223b1d2 BG |
16484 | @item @file{filladapt.el} by Kyle Jones |
16485 | @cindex @file{filladapt.el} | |
16486 | ||
16487 | Org mode tries to do the right thing when filling paragraphs, list items and | |
16488 | other elements. Many users reported they had problems using both | |
16489 | @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like | |
16490 | this: | |
16491 | ||
16492 | @lisp | |
16493 | (add-hook 'org-mode-hook 'turn-off-filladapt-mode) | |
16494 | @end lisp | |
16495 | ||
c8d0cf5c CD |
16496 | @item @file{yasnippet.el} |
16497 | @cindex @file{yasnippet.el} | |
271672fa | 16498 | The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of |
acedf35c | 16499 | @code{"\t"}) overrules YASnippet's access to this key. The following code |
c8d0cf5c CD |
16500 | fixed this problem: |
16501 | ||
16502 | @lisp | |
16503 | (add-hook 'org-mode-hook | |
c0468714 GM |
16504 | (lambda () |
16505 | (org-set-local 'yas/trigger-key [tab]) | |
e66ba1df | 16506 | (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand))) |
c8d0cf5c CD |
16507 | @end lisp |
16508 | ||
ce57c2fe BG |
16509 | The latest version of yasnippet doesn't play well with Org mode. If the |
16510 | above code does not fix the conflict, start by defining the following | |
16511 | function: | |
16512 | ||
16513 | @lisp | |
16514 | (defun yas/org-very-safe-expand () | |
63aa0982 | 16515 | (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) |
ce57c2fe BG |
16516 | @end lisp |
16517 | ||
16518 | Then, tell Org mode what to do with the new function: | |
16519 | ||
16520 | @lisp | |
16521 | (add-hook 'org-mode-hook | |
16522 | (lambda () | |
271672fa BG |
16523 | (make-variable-buffer-local 'yas/trigger-key) |
16524 | (setq yas/trigger-key [tab]) | |
16525 | (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) | |
16526 | (define-key yas/keymap [tab] 'yas/next-field))) | |
ce57c2fe BG |
16527 | @end lisp |
16528 | ||
4009494e GM |
16529 | @item @file{windmove.el} by Hovav Shacham |
16530 | @cindex @file{windmove.el} | |
c8d0cf5c | 16531 | This package also uses the @kbd{S-<cursor>} keys, so everything written |
86fbb8ca | 16532 | in the paragraph above about CUA mode also applies here. If you want make |
e66ba1df | 16533 | the windmove function active in locations where Org mode does not have |
86fbb8ca CD |
16534 | special functionality on @kbd{S-@key{cursor}}, add this to your |
16535 | configuration: | |
16536 | ||
16537 | @lisp | |
16538 | ;; Make windmove work in org-mode: | |
16539 | (add-hook 'org-shiftup-final-hook 'windmove-up) | |
16540 | (add-hook 'org-shiftleft-final-hook 'windmove-left) | |
16541 | (add-hook 'org-shiftdown-final-hook 'windmove-down) | |
16542 | (add-hook 'org-shiftright-final-hook 'windmove-right) | |
16543 | @end lisp | |
4009494e | 16544 | |
a351880d CD |
16545 | @item @file{viper.el} by Michael Kifer |
16546 | @cindex @file{viper.el} | |
16547 | @kindex C-c / | |
16548 | Viper uses @kbd{C-c /} and therefore makes this key not access the | |
e66ba1df | 16549 | corresponding Org mode command @code{org-sparse-tree}. You need to find |
a351880d CD |
16550 | another key for this command, or override the key in |
16551 | @code{viper-vi-global-user-map} with | |
16552 | ||
16553 | @lisp | |
16554 | (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree) | |
16555 | @end lisp | |
16556 | ||
271672fa BG |
16557 | |
16558 | ||
4009494e GM |
16559 | @end table |
16560 | ||
271672fa | 16561 | @node org-crypt, , Interaction, Miscellaneous |
ce57c2fe BG |
16562 | @section org-crypt.el |
16563 | @cindex @file{org-crypt.el} | |
16564 | @cindex @code{org-decrypt-entry} | |
16565 | ||
16566 | Org-crypt will encrypt the text of an entry, but not the headline, or | |
16567 | properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt | |
16568 | files. | |
16569 | ||
16570 | Any text below a headline that has a @samp{:crypt:} tag will be automatically | |
16571 | be encrypted when the file is saved. If you want to use a different tag just | |
16572 | customize the @code{org-crypt-tag-matcher} setting. | |
16573 | ||
16574 | To use org-crypt it is suggested that you have the following in your | |
16575 | @file{.emacs}: | |
16576 | ||
271672fa | 16577 | @lisp |
ce57c2fe BG |
16578 | (require 'org-crypt) |
16579 | (org-crypt-use-before-save-magic) | |
16580 | (setq org-tags-exclude-from-inheritance (quote ("crypt"))) | |
16581 | ||
16582 | (setq org-crypt-key nil) | |
16583 | ;; GPG key to use for encryption | |
16584 | ;; Either the Key ID or set to nil to use symmetric encryption. | |
16585 | ||
16586 | (setq auto-save-default nil) | |
16587 | ;; Auto-saving does not cooperate with org-crypt.el: so you need | |
16588 | ;; to turn it off if you plan to use org-crypt.el quite often. | |
16589 | ;; Otherwise, you'll get an (annoying) message each time you | |
16590 | ;; start Org. | |
16591 | ||
16592 | ;; To turn it off only locally, you can insert this: | |
16593 | ;; | |
16594 | ;; # -*- buffer-auto-save-file-name: nil; -*- | |
271672fa | 16595 | @end lisp |
ce57c2fe BG |
16596 | |
16597 | Excluding the crypt tag from inheritance prevents already encrypted text | |
16598 | being encrypted again. | |
7006d207 CD |
16599 | |
16600 | @node Hacking, MobileOrg, Miscellaneous, Top | |
b349f79f | 16601 | @appendix Hacking |
c8d0cf5c | 16602 | @cindex hacking |
b349f79f CD |
16603 | |
16604 | This appendix covers some aspects where users can extend the functionality of | |
a7808fba | 16605 | Org. |
4009494e GM |
16606 | |
16607 | @menu | |
8223b1d2 | 16608 | * Hooks:: How to reach into Org's internals |
c0468714 GM |
16609 | * Add-on packages:: Available extensions |
16610 | * Adding hyperlink types:: New custom link types | |
271672fa | 16611 | * Adding export back-ends:: How to write new export back-ends |
c0468714 | 16612 | * Context-sensitive commands:: How to add functionality to such commands |
acedf35c | 16613 | * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs |
c0468714 GM |
16614 | * Dynamic blocks:: Automatically filled blocks |
16615 | * Special agenda views:: Customized views | |
271672fa BG |
16616 | * Speeding up your agendas:: Tips on how to speed up your agendas |
16617 | * Extracting agenda information:: Post-processing of agenda information | |
c0468714 GM |
16618 | * Using the property API:: Writing programs that use entry properties |
16619 | * Using the mapping API:: Mapping over all or selected entries | |
4009494e GM |
16620 | @end menu |
16621 | ||
c8d0cf5c CD |
16622 | @node Hooks, Add-on packages, Hacking, Hacking |
16623 | @section Hooks | |
16624 | @cindex hooks | |
16625 | ||
16626 | Org has a large number of hook variables that can be used to add | |
16627 | functionality. This appendix about hacking is going to illustrate the | |
16628 | use of some of them. A complete list of all hooks with documentation is | |
16629 | maintained by the Worg project and can be found at | |
16630 | @uref{http://orgmode.org/worg/org-configs/org-hooks.php}. | |
16631 | ||
16632 | @node Add-on packages, Adding hyperlink types, Hooks, Hacking | |
16633 | @section Add-on packages | |
16634 | @cindex add-on packages | |
16635 | ||
16636 | A large number of add-on packages have been written by various authors. | |
271672fa | 16637 | |
c8d0cf5c | 16638 | These packages are not part of Emacs, but they are distributed as contributed |
271672fa BG |
16639 | packages with the separate release available at @uref{http://orgmode.org}. |
16640 | See the @file{contrib/README} file in the source code directory for a list of | |
16641 | contributed files. You may also find some more information on the Worg page: | |
c8d0cf5c CD |
16642 | @uref{http://orgmode.org/worg/org-contrib/}. |
16643 | ||
271672fa | 16644 | @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking |
4009494e GM |
16645 | @section Adding hyperlink types |
16646 | @cindex hyperlinks, adding new types | |
16647 | ||
a7808fba | 16648 | Org has a large number of hyperlink types built-in |
c8d0cf5c CD |
16649 | (@pxref{Hyperlinks}). If you would like to add new link types, Org |
16650 | provides an interface for doing so. Let's look at an example file, | |
16651 | @file{org-man.el}, that will add support for creating links like | |
a7808fba | 16652 | @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
c8d0cf5c | 16653 | Emacs: |
4009494e GM |
16654 | |
16655 | @lisp | |
a7808fba | 16656 | ;;; org-man.el - Support for links to manpages in Org |
4009494e GM |
16657 | |
16658 | (require 'org) | |
16659 | ||
16660 | (org-add-link-type "man" 'org-man-open) | |
16661 | (add-hook 'org-store-link-functions 'org-man-store-link) | |
16662 | ||
16663 | (defcustom org-man-command 'man | |
16664 | "The Emacs command to be used to display a man page." | |
16665 | :group 'org-link | |
16666 | :type '(choice (const man) (const woman))) | |
16667 | ||
16668 | (defun org-man-open (path) | |
16669 | "Visit the manpage on PATH. | |
16670 | PATH should be a topic that can be thrown at the man command." | |
16671 | (funcall org-man-command path)) | |
16672 | ||
16673 | (defun org-man-store-link () | |
16674 | "Store a link to a manpage." | |
16675 | (when (memq major-mode '(Man-mode woman-mode)) | |
16676 | ;; This is a man page, we do make this link | |
16677 | (let* ((page (org-man-get-page-name)) | |
16678 | (link (concat "man:" page)) | |
16679 | (description (format "Manpage for %s" page))) | |
16680 | (org-store-link-props | |
16681 | :type "man" | |
16682 | :link link | |
16683 | :description description)))) | |
16684 | ||
16685 | (defun org-man-get-page-name () | |
16686 | "Extract the page name from the buffer name." | |
16687 | ;; This works for both `Man-mode' and `woman-mode'. | |
16688 | (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
16689 | (match-string 1 (buffer-name)) | |
16690 | (error "Cannot create link to this man page"))) | |
16691 | ||
16692 | (provide 'org-man) | |
16693 | ||
16694 | ;;; org-man.el ends here | |
16695 | @end lisp | |
16696 | ||
16697 | @noindent | |
16698 | You would activate this new link type in @file{.emacs} with | |
16699 | ||
16700 | @lisp | |
16701 | (require 'org-man) | |
16702 | @end lisp | |
16703 | ||
16704 | @noindent | |
864c9740 | 16705 | Let's go through the file and see what it does. |
4009494e | 16706 | @enumerate |
28a16a1b | 16707 | @item |
4009494e GM |
16708 | It does @code{(require 'org)} to make sure that @file{org.el} has been |
16709 | loaded. | |
16710 | @item | |
16711 | The next line calls @code{org-add-link-type} to define a new link type | |
16712 | with prefix @samp{man}. The call also contains the name of a function | |
16713 | that will be called to follow such a link. | |
16714 | @item | |
c8d0cf5c | 16715 | @vindex org-store-link-functions |
4009494e GM |
16716 | The next line adds a function to @code{org-store-link-functions}, in |
16717 | order to allow the command @kbd{C-c l} to record a useful link in a | |
16718 | buffer displaying a man page. | |
16719 | @end enumerate | |
16720 | ||
16721 | The rest of the file defines the necessary variables and functions. | |
c8d0cf5c | 16722 | First there is a customization variable that determines which Emacs |
a7808fba | 16723 | command should be used to display man pages. There are two options, |
4009494e | 16724 | @code{man} and @code{woman}. Then the function to follow a link is |
c8d0cf5c | 16725 | defined. It gets the link path as an argument---in this case the link |
4009494e GM |
16726 | path is just a topic for the manual command. The function calls the |
16727 | value of @code{org-man-command} to display the man page. | |
16728 | ||
16729 | Finally the function @code{org-man-store-link} is defined. When you try | |
c8d0cf5c | 16730 | to store a link with @kbd{C-c l}, this function will be called to |
4009494e | 16731 | try to make a link. The function must first decide if it is supposed to |
c8d0cf5c | 16732 | create the link for this buffer type; we do this by checking the value |
4009494e | 16733 | of the variable @code{major-mode}. If not, the function must exit and |
a7808fba CD |
16734 | return the value @code{nil}. If yes, the link is created by getting the |
16735 | manual topic from the buffer name and prefixing it with the string | |
4009494e GM |
16736 | @samp{man:}. Then it must call the command @code{org-store-link-props} |
16737 | and set the @code{:type} and @code{:link} properties. Optionally you | |
16738 | can also set the @code{:description} property to provide a default for | |
a7808fba | 16739 | the link description when the link is later inserted into an Org |
4009494e GM |
16740 | buffer with @kbd{C-c C-l}. |
16741 | ||
acedf35c | 16742 | When it makes sense for your new link type, you may also define a function |
1df7defd | 16743 | @code{org-PREFIX-complete-link} that implements special (e.g., completion) |
c8d0cf5c CD |
16744 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
16745 | not accept any arguments, and return the full link with prefix. | |
16746 | ||
271672fa BG |
16747 | @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking |
16748 | @section Adding export back-ends | |
16749 | @cindex Export, writing back-ends | |
16750 | ||
16751 | Org 8.0 comes with a completely rewritten export engine which makes it easy | |
16752 | to write new export back-ends, either from scratch, or from deriving them | |
16753 | from existing ones. | |
16754 | ||
16755 | Your two entry points are respectively @code{org-export-define-backend} and | |
16756 | @code{org-export-define-derived-backend}. To grok these functions, you | |
16757 | should first have a look at @file{ox-latex.el} (for how to define a new | |
16758 | back-end from scratch) and @file{ox-beamer.el} (for how to derive a new | |
16759 | back-end from an existing one. | |
16760 | ||
16761 | When creating a new back-end from scratch, the basic idea is to set the name | |
16762 | of the back-end (as a symbol) and an an alist of elements and export | |
16763 | functions. On top of this, you will need to set additional keywords like | |
16764 | @code{:menu-entry} (to display the back-end in the export dispatcher), | |
16765 | @code{:export-block} (to specify what blocks should not be exported by this | |
16766 | back-end), and @code{:options-alist} (to let the user set export options that | |
16767 | are specific to this back-end.) | |
16768 | ||
16769 | Deriving a new back-end is similar, except that you need to set | |
16770 | @code{:translate-alist} to an alist of export functions that should be used | |
16771 | instead of the parent back-end functions. | |
16772 | ||
16773 | For a complete reference documentation, see | |
16774 | @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export | |
16775 | Reference on Worg}. | |
16776 | ||
16777 | @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking | |
c8d0cf5c CD |
16778 | @section Context-sensitive commands |
16779 | @cindex context-sensitive commands, hooks | |
16780 | @cindex add-ons, context-sensitive commands | |
16781 | @vindex org-ctrl-c-ctrl-c-hook | |
16782 | ||
16783 | Org has several commands that act differently depending on context. The most | |
153ae947 | 16784 | important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}). |
c8d0cf5c CD |
16785 | Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property. |
16786 | ||
16787 | Add-ons can tap into this functionality by providing a function that detects | |
16788 | special context for that add-on and executes functionality appropriate for | |
16789 | the context. Here is an example from Dan Davison's @file{org-R.el} which | |
afe98dfa | 16790 | allows you to evaluate commands based on the @file{R} programming language |
e66ba1df | 16791 | @footnote{@file{org-R.el} has been replaced by the Org mode functionality |
afe98dfa CD |
16792 | described in @ref{Working With Source Code} and is now obsolete.}. For this |
16793 | package, special contexts are lines that start with @code{#+R:} or | |
c8d0cf5c CD |
16794 | @code{#+RR:}. |
16795 | ||
16796 | @lisp | |
16797 | (defun org-R-apply-maybe () | |
16798 | "Detect if this is context for org-R and execute R commands." | |
16799 | (if (save-excursion | |
16800 | (beginning-of-line 1) | |
16801 | (looking-at "#\\+RR?:")) | |
16802 | (progn (call-interactively 'org-R-apply) | |
16803 | t) ;; to signal that we took action | |
16804 | nil)) ;; to signal that we did not | |
16805 | ||
16806 | (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe) | |
16807 | @end lisp | |
16808 | ||
16809 | The function first checks if the cursor is in such a line. If that is the | |
16810 | case, @code{org-R-apply} is called and the function returns @code{t} to | |
16811 | signal that action was taken, and @kbd{C-c C-c} will stop looking for other | |
ce57c2fe BG |
16812 | contexts. If the function finds it should do nothing locally, it returns |
16813 | @code{nil} so that other, similar functions can have a try. | |
c8d0cf5c CD |
16814 | |
16815 | ||
16816 | @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking | |
a7808fba | 16817 | @section Tables and lists in arbitrary syntax |
4009494e | 16818 | @cindex tables, in other modes |
dbc28aaa | 16819 | @cindex lists, in other modes |
a7808fba | 16820 | @cindex Orgtbl mode |
4009494e | 16821 | |
a7808fba | 16822 | Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
4009494e | 16823 | frequent feature request has been to make it work with native tables in |
acedf35c | 16824 | specific languages, for example @LaTeX{}. However, this is extremely |
dbc28aaa | 16825 | hard to do in a general way, would lead to a customization nightmare, |
ce57c2fe | 16826 | and would take away much of the simplicity of the Orgtbl mode table |
dbc28aaa CD |
16827 | editor. |
16828 | ||
a7808fba | 16829 | This appendix describes a different approach. We keep the Orgtbl mode |
4009494e GM |
16830 | table in its native format (the @i{source table}), and use a custom |
16831 | function to @i{translate} the table to the correct syntax, and to | |
16832 | @i{install} it in the right location (the @i{target table}). This puts | |
16833 | the burden of writing conversion functions on the user, but it allows | |
16834 | for a very flexible system. | |
16835 | ||
86fbb8ca CD |
16836 | Bastien added the ability to do the same with lists, in Orgstruct mode. You |
16837 | can use Org's facilities to edit and structure lists by turning | |
16838 | @code{orgstruct-mode} on, then locally exporting such lists in another format | |
acedf35c | 16839 | (HTML, @LaTeX{} or Texinfo.) |
dbc28aaa CD |
16840 | |
16841 | ||
4009494e | 16842 | @menu |
c0468714 | 16843 | * Radio tables:: Sending and receiving radio tables |
e66ba1df | 16844 | * A @LaTeX{} example:: Step by step, almost a tutorial |
c0468714 | 16845 | * Translator functions:: Copy and modify |
271672fa | 16846 | * Radio lists:: Sending and receiving lists |
4009494e GM |
16847 | @end menu |
16848 | ||
e66ba1df | 16849 | @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax |
4009494e GM |
16850 | @subsection Radio tables |
16851 | @cindex radio tables | |
16852 | ||
16853 | To define the location of the target table, you first need to create two | |
271672fa BG |
16854 | lines that are comments in the current mode, but contain magic words |
16855 | @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will | |
16856 | insert the translated table between these lines, replacing whatever was there | |
16857 | before. For example in C mode where comments are between @code{/* ... */}: | |
4009494e GM |
16858 | |
16859 | @example | |
16860 | /* BEGIN RECEIVE ORGTBL table_name */ | |
16861 | /* END RECEIVE ORGTBL table_name */ | |
16862 | @end example | |
16863 | ||
16864 | @noindent | |
16865 | Just above the source table, we put a special line that tells | |
a7808fba | 16866 | Orgtbl mode how to translate this table and where to install it. For |
4009494e | 16867 | example: |
c8d0cf5c | 16868 | @cindex #+ORGTBL |
4009494e GM |
16869 | @example |
16870 | #+ORGTBL: SEND table_name translation_function arguments.... | |
16871 | @end example | |
16872 | ||
16873 | @noindent | |
16874 | @code{table_name} is the reference name for the table that is also used | |
ce57c2fe | 16875 | in the receiver lines. @code{translation_function} is the Lisp function |
4009494e GM |
16876 | that does the translation. Furthermore, the line can contain a list of |
16877 | arguments (alternating key and value) at the end. The arguments will be | |
16878 | passed as a property list to the translation function for | |
16879 | interpretation. A few standard parameters are already recognized and | |
16880 | acted upon before the translation function is called: | |
16881 | ||
16882 | @table @code | |
16883 | @item :skip N | |
b349f79f CD |
16884 | Skip the first N lines of the table. Hlines do count as separate lines for |
16885 | this parameter! | |
16886 | ||
4009494e GM |
16887 | @item :skipcols (n1 n2 ...) |
16888 | List of columns that should be skipped. If the table has a column with | |
16889 | calculation marks, that column is automatically discarded as well. | |
16890 | Please note that the translator function sees the table @emph{after} the | |
16891 | removal of these columns, the function never knows that there have been | |
16892 | additional columns. | |
8223b1d2 BG |
16893 | |
16894 | @item :no-escape t | |
271672fa BG |
16895 | When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting |
16896 | the table. The default value is @code{nil}. | |
4009494e GM |
16897 | @end table |
16898 | ||
16899 | @noindent | |
16900 | The one problem remaining is how to keep the source table in the buffer | |
16901 | without disturbing the normal workings of the file, for example during | |
acedf35c | 16902 | compilation of a C file or processing of a @LaTeX{} file. There are a |
4009494e GM |
16903 | number of different solutions: |
16904 | ||
16905 | @itemize @bullet | |
16906 | @item | |
16907 | The table could be placed in a block comment if that is supported by the | |
a7808fba | 16908 | language. For example, in C mode you could wrap the table between |
4009494e | 16909 | @samp{/*} and @samp{*/} lines. |
28a16a1b | 16910 | @item |
4009494e | 16911 | Sometimes it is possible to put the table after some kind of @i{END} |
c8d0cf5c | 16912 | statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}} |
acedf35c | 16913 | in @LaTeX{}. |
4009494e | 16914 | @item |
c8d0cf5c | 16915 | You can just comment the table line-by-line whenever you want to process |
4009494e | 16916 | the file, and uncomment it whenever you need to edit the table. This |
271672fa | 16917 | only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET} |
c8d0cf5c | 16918 | makes this comment-toggling very easy, in particular if you bind it to a |
4009494e GM |
16919 | key. |
16920 | @end itemize | |
16921 | ||
e66ba1df | 16922 | @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax |
acedf35c CD |
16923 | @subsection A @LaTeX{} example of radio tables |
16924 | @cindex @LaTeX{}, and Orgtbl mode | |
4009494e | 16925 | |
acedf35c | 16926 | The best way to wrap the source table in @LaTeX{} is to use the |
4009494e GM |
16927 | @code{comment} environment provided by @file{comment.sty}. It has to be |
16928 | activated by placing @code{\usepackage@{comment@}} into the document | |
a7808fba | 16929 | header. Orgtbl mode can insert a radio table skeleton@footnote{By |
acedf35c | 16930 | default this works only for @LaTeX{}, HTML, and Texinfo. Configure the |
271672fa BG |
16931 | variable @code{orgtbl-radio-table-templates} to install templates for other |
16932 | modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will | |
55e0839d | 16933 | be prompted for a table name, let's say we use @samp{salesfigures}. You |
4009494e GM |
16934 | will then get the following template: |
16935 | ||
c8d0cf5c | 16936 | @cindex #+ORGTBL, SEND |
4009494e GM |
16937 | @example |
16938 | % BEGIN RECEIVE ORGTBL salesfigures | |
16939 | % END RECEIVE ORGTBL salesfigures | |
16940 | \begin@{comment@} | |
16941 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
16942 | | | | | |
16943 | \end@{comment@} | |
16944 | @end example | |
16945 | ||
16946 | @noindent | |
acedf35c | 16947 | @vindex @LaTeX{}-verbatim-environments |
a7808fba | 16948 | The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
acedf35c | 16949 | @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it |
4009494e | 16950 | into the receiver location with name @code{salesfigures}. You may now |
acedf35c | 16951 | fill in the table---feel free to use the spreadsheet features@footnote{If |
4009494e | 16952 | the @samp{#+TBLFM} line contains an odd number of dollar characters, |
acedf35c | 16953 | this may cause problems with font-lock in @LaTeX{} mode. As shown in the |
4009494e GM |
16954 | example you can fix this by adding an extra line inside the |
16955 | @code{comment} environment that is used to balance the dollar | |
c8d0cf5c | 16956 | expressions. If you are using AUC@TeX{} with the font-latex library, a |
4009494e GM |
16957 | much better solution is to add the @code{comment} environment to the |
16958 | variable @code{LaTeX-verbatim-environments}.}: | |
16959 | ||
16960 | @example | |
16961 | % BEGIN RECEIVE ORGTBL salesfigures | |
16962 | % END RECEIVE ORGTBL salesfigures | |
16963 | \begin@{comment@} | |
16964 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
16965 | | Month | Days | Nr sold | per day | | |
16966 | |-------+------+---------+---------| | |
16967 | | Jan | 23 | 55 | 2.4 | | |
16968 | | Feb | 21 | 16 | 0.8 | | |
16969 | | March | 22 | 278 | 12.6 | | |
16970 | #+TBLFM: $4=$3/$2;%.1f | |
16971 | % $ (optional extra dollar to keep font-lock happy, see footnote) | |
16972 | \end@{comment@} | |
16973 | @end example | |
16974 | ||
16975 | @noindent | |
16976 | When you are done, press @kbd{C-c C-c} in the table to get the converted | |
16977 | table inserted between the two marker lines. | |
16978 | ||
55e0839d | 16979 | Now let's assume you want to make the table header by hand, because you |
1df7defd | 16980 | want to control how columns are aligned, etc. In this case we make sure |
c8d0cf5c | 16981 | that the table translator skips the first 2 lines of the source |
1df7defd | 16982 | table, and tell the command to work as a @i{splice}, i.e., to not produce |
4009494e GM |
16983 | header and footer commands of the target table: |
16984 | ||
16985 | @example | |
16986 | \begin@{tabular@}@{lrrr@} | |
16987 | Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
16988 | % BEGIN RECEIVE ORGTBL salesfigures | |
16989 | % END RECEIVE ORGTBL salesfigures | |
16990 | \end@{tabular@} | |
16991 | % | |
16992 | \begin@{comment@} | |
16993 | #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
16994 | | Month | Days | Nr sold | per day | | |
16995 | |-------+------+---------+---------| | |
16996 | | Jan | 23 | 55 | 2.4 | | |
16997 | | Feb | 21 | 16 | 0.8 | | |
16998 | | March | 22 | 278 | 12.6 | | |
16999 | #+TBLFM: $4=$3/$2;%.1f | |
17000 | \end@{comment@} | |
17001 | @end example | |
17002 | ||
acedf35c | 17003 | The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of |
a7808fba | 17004 | Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
4009494e | 17005 | and marks horizontal lines with @code{\hline}. Furthermore, it |
c8d0cf5c | 17006 | interprets the following parameters (see also @pxref{Translator functions}): |
4009494e GM |
17007 | |
17008 | @table @code | |
17009 | @item :splice nil/t | |
17010 | When set to t, return only table body lines, don't wrap them into a | |
271672fa | 17011 | tabular environment. Default is @code{nil}. |
4009494e GM |
17012 | |
17013 | @item :fmt fmt | |
c8d0cf5c | 17014 | A format to be used to wrap each field, it should contain @code{%s} for the |
4009494e GM |
17015 | original field value. For example, to wrap each field value in dollars, |
17016 | you could use @code{:fmt "$%s$"}. This may also be a property list with | |
ce57c2fe | 17017 | column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. |
a7808fba CD |
17018 | A function of one argument can be used in place of the strings; the |
17019 | function must return a formatted string. | |
4009494e GM |
17020 | |
17021 | @item :efmt efmt | |
17022 | Use this format to print numbers with exponentials. The format should | |
17023 | have @code{%s} twice for inserting mantissa and exponent, for example | |
17024 | @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
17025 | may also be a property list with column numbers and formats, for example | |
17026 | @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
17027 | @code{efmt} has been applied to a value, @code{fmt} will also be | |
a7808fba CD |
17028 | applied. Similar to @code{fmt}, functions of two arguments can be |
17029 | supplied instead of strings. | |
4009494e GM |
17030 | @end table |
17031 | ||
e66ba1df | 17032 | @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax |
4009494e | 17033 | @subsection Translator functions |
a7808fba | 17034 | @cindex HTML, and Orgtbl mode |
4009494e GM |
17035 | @cindex translator function |
17036 | ||
b349f79f CD |
17037 | Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv} |
17038 | (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values) | |
17039 | @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}. | |
17040 | Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same | |
17041 | code that produces tables during HTML export.}, these all use a generic | |
17042 | translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex} | |
17043 | itself is a very short function that computes the column definitions for the | |
17044 | @code{tabular} environment, defines a few field and line separators and then | |
c8d0cf5c | 17045 | hands processing over to the generic translator. Here is the entire code: |
4009494e GM |
17046 | |
17047 | @lisp | |
17048 | @group | |
17049 | (defun orgtbl-to-latex (table params) | |
a7808fba | 17050 | "Convert the Orgtbl mode TABLE to LaTeX." |
4009494e GM |
17051 | (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
17052 | org-table-last-alignment "")) | |
17053 | (params2 | |
17054 | (list | |
17055 | :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
17056 | :tend "\\end@{tabular@}" | |
17057 | :lstart "" :lend " \\\\" :sep " & " | |
17058 | :efmt "%s\\,(%s)" :hline "\\hline"))) | |
17059 | (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
17060 | @end group | |
17061 | @end lisp | |
17062 | ||
17063 | As you can see, the properties passed into the function (variable | |
17064 | @var{PARAMS}) are combined with the ones newly defined in the function | |
1df7defd | 17065 | (variable @var{PARAMS2}). The ones passed into the function (i.e., the |
4009494e | 17066 | ones set by the @samp{ORGTBL SEND} line) take precedence. So if you |
acedf35c | 17067 | would like to use the @LaTeX{} translator, but wanted the line endings to |
4009494e GM |
17068 | be @samp{\\[2mm]} instead of the default @samp{\\}, you could just |
17069 | overrule the default with | |
17070 | ||
17071 | @example | |
17072 | #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
17073 | @end example | |
17074 | ||
17075 | For a new language, you can either write your own converter function in | |
acedf35c | 17076 | analogy with the @LaTeX{} translator, or you can use the generic function |
4009494e GM |
17077 | directly. For example, if you have a language where a table is started |
17078 | with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
c8d0cf5c | 17079 | started with @samp{!BL!}, ended with @samp{!EL!}, and where the field |
4009494e GM |
17080 | separator is a TAB, you could call the generic translator like this (on |
17081 | a single line!): | |
17082 | ||
17083 | @example | |
17084 | #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
17085 | :lstart "!BL! " :lend " !EL!" :sep "\t" | |
17086 | @end example | |
17087 | ||
17088 | @noindent | |
17089 | Please check the documentation string of the function | |
17090 | @code{orgtbl-to-generic} for a full list of parameters understood by | |
c8d0cf5c | 17091 | that function, and remember that you can pass each of them into |
4009494e GM |
17092 | @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function |
17093 | using the generic function. | |
17094 | ||
17095 | Of course you can also write a completely new function doing complicated | |
17096 | things the generic translator cannot do. A translator function takes | |
17097 | two arguments. The first argument is the table, a list of lines, each | |
17098 | line either the symbol @code{hline} or a list of fields. The second | |
17099 | argument is the property list containing all parameters specified in the | |
17100 | @samp{#+ORGTBL: SEND} line. The function must return a single string | |
17101 | containing the formatted table. If you write a generally useful | |
c8d0cf5c | 17102 | translator, please post it on @email{emacs-orgmode@@gnu.org} so that |
4009494e GM |
17103 | others can benefit from your work. |
17104 | ||
86fbb8ca | 17105 | @node Radio lists, , Translator functions, Tables in arbitrary syntax |
dbc28aaa CD |
17106 | @subsection Radio lists |
17107 | @cindex radio lists | |
17108 | @cindex org-list-insert-radio-list | |
17109 | ||
acedf35c | 17110 | Sending and receiving radio lists works exactly the same way as sending and |
6eb02347 | 17111 | receiving radio tables (@pxref{Radio tables}). As for radio tables, you can |
acedf35c | 17112 | insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling |
6eb02347 | 17113 | @code{org-list-insert-radio-list}. |
dbc28aaa CD |
17114 | |
17115 | Here are the differences with radio tables: | |
17116 | ||
17117 | @itemize @minus | |
17118 | @item | |
86fbb8ca CD |
17119 | Orgstruct mode must be active. |
17120 | @item | |
17121 | Use the @code{ORGLST} keyword instead of @code{ORGTBL}. | |
dbc28aaa CD |
17122 | @item |
17123 | The available translation functions for radio lists don't take | |
17124 | parameters. | |
28a16a1b | 17125 | @item |
c8d0cf5c | 17126 | @kbd{C-c C-c} will work when pressed on the first item of the list. |
dbc28aaa CD |
17127 | @end itemize |
17128 | ||
acedf35c CD |
17129 | Here is a @LaTeX{} example. Let's say that you have this in your |
17130 | @LaTeX{} file: | |
dbc28aaa | 17131 | |
86fbb8ca | 17132 | @cindex #+ORGLST |
dbc28aaa CD |
17133 | @example |
17134 | % BEGIN RECEIVE ORGLST to-buy | |
17135 | % END RECEIVE ORGLST to-buy | |
17136 | \begin@{comment@} | |
86fbb8ca | 17137 | #+ORGLST: SEND to-buy org-list-to-latex |
dbc28aaa CD |
17138 | - a new house |
17139 | - a new computer | |
17140 | + a new keyboard | |
17141 | + a new mouse | |
17142 | - a new life | |
17143 | \end@{comment@} | |
17144 | @end example | |
17145 | ||
d3517077 | 17146 | Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted |
acedf35c | 17147 | @LaTeX{} list between the two marker lines. |
dbc28aaa | 17148 | |
b349f79f | 17149 | @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking |
4009494e GM |
17150 | @section Dynamic blocks |
17151 | @cindex dynamic blocks | |
17152 | ||
a7808fba | 17153 | Org documents can contain @emph{dynamic blocks}. These are |
4009494e GM |
17154 | specially marked regions that are updated by some user-written function. |
17155 | A good example for such a block is the clock table inserted by the | |
17156 | command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
17157 | ||
acedf35c | 17158 | Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name |
4009494e GM |
17159 | to the block and can also specify parameters for the function producing |
17160 | the content of the block. | |
17161 | ||
acedf35c | 17162 | @cindex #+BEGIN:dynamic block |
4009494e GM |
17163 | @example |
17164 | #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
17165 | ||
17166 | #+END: | |
17167 | @end example | |
17168 | ||
17169 | Dynamic blocks are updated with the following commands | |
17170 | ||
17171 | @table @kbd | |
acedf35c | 17172 | @orgcmd{C-c C-x C-u,org-dblock-update} |
4009494e | 17173 | Update dynamic block at point. |
acedf35c | 17174 | @orgkey{C-u C-c C-x C-u} |
4009494e GM |
17175 | Update all dynamic blocks in the current file. |
17176 | @end table | |
17177 | ||
17178 | Updating a dynamic block means to remove all the text between BEGIN and | |
17179 | END, parse the BEGIN line for parameters and then call the specific | |
28a16a1b CD |
17180 | writer function for this block to insert the new content. If you want |
17181 | to use the original content in the writer function, you can use the | |
17182 | extra parameter @code{:content}. | |
17183 | ||
17184 | For a block with name @code{myblock}, the writer function is | |
4009494e GM |
17185 | @code{org-dblock-write:myblock} with as only parameter a property list |
17186 | with the parameters given in the begin line. Here is a trivial example | |
17187 | of a block that keeps track of when the block update function was last | |
17188 | run: | |
17189 | ||
17190 | @example | |
17191 | #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
17192 | ||
17193 | #+END: | |
17194 | @end example | |
17195 | ||
17196 | @noindent | |
17197 | The corresponding block writer function could look like this: | |
17198 | ||
17199 | @lisp | |
17200 | (defun org-dblock-write:block-update-time (params) | |
63aa0982 BG |
17201 | (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) |
17202 | (insert "Last block update at: " | |
271672fa | 17203 | (format-time-string fmt (current-time))))) |
4009494e GM |
17204 | @end lisp |
17205 | ||
17206 | If you want to make sure that all dynamic blocks are always up-to-date, | |
17207 | you could add the function @code{org-update-all-dblocks} to a hook, for | |
17208 | example @code{before-save-hook}. @code{org-update-all-dblocks} is | |
c8d0cf5c | 17209 | written in a way such that it does nothing in buffers that are not in |
a7808fba | 17210 | @code{org-mode}. |
4009494e | 17211 | |
ce57c2fe BG |
17212 | You can narrow the current buffer to the current dynamic block (like any |
17213 | other block) with @code{org-narrow-to-block}. | |
17214 | ||
271672fa | 17215 | @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking |
a7808fba | 17216 | @section Special agenda views |
4009494e GM |
17217 | @cindex agenda views, user-defined |
17218 | ||
ce57c2fe BG |
17219 | @vindex org-agenda-skip-function |
17220 | @vindex org-agenda-skip-function-global | |
afe98dfa | 17221 | Org provides a special hook that can be used to narrow down the selection |
271672fa BG |
17222 | made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The |
17223 | @code{agenda*} view is the same than @code{agenda} except that it only | |
17224 | considers @emph{appointments}, i.e., scheduled and deadline items that have a | |
17225 | time specification @code{[h]h:mm} in their time-stamps.}, @code{todo}, | |
17226 | @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may | |
17227 | specify a function that is used at each match to verify if the match should | |
17228 | indeed be part of the agenda view, and if not, how much should be skipped. | |
17229 | You can specify a global condition that will be applied to all agenda views, | |
17230 | this condition would be stored in the variable | |
17231 | @code{org-agenda-skip-function-global}. More commonly, such a definition is | |
17232 | applied only to specific custom searches, using | |
17233 | @code{org-agenda-skip-function}. | |
4009494e GM |
17234 | |
17235 | Let's say you want to produce a list of projects that contain a WAITING | |
17236 | tag anywhere in the project tree. Let's further assume that you have | |
a7808fba | 17237 | marked all tree headings that define a project with the TODO keyword |
1df7defd | 17238 | PROJECT@. In this case you would run a TODO search for the keyword |
4009494e GM |
17239 | PROJECT, but skip the match unless there is a WAITING tag anywhere in |
17240 | the subtree belonging to the project line. | |
17241 | ||
17242 | To achieve this, you must write a function that searches the subtree for | |
17243 | the tag. If the tag is found, the function must return @code{nil} to | |
17244 | indicate that this match should not be skipped. If there is no such | |
17245 | tag, return the location of the end of the subtree, to indicate that | |
17246 | search should continue from there. | |
17247 | ||
17248 | @lisp | |
17249 | (defun my-skip-unless-waiting () | |
17250 | "Skip trees that are not waiting" | |
17251 | (let ((subtree-end (save-excursion (org-end-of-subtree t)))) | |
dbc28aaa | 17252 | (if (re-search-forward ":waiting:" subtree-end t) |
4009494e GM |
17253 | nil ; tag found, do not skip |
17254 | subtree-end))) ; tag not found, continue after end of subtree | |
17255 | @end lisp | |
17256 | ||
17257 | Now you may use this function in an agenda custom command, for example | |
17258 | like this: | |
17259 | ||
17260 | @lisp | |
17261 | (org-add-agenda-custom-command | |
17262 | '("b" todo "PROJECT" | |
e45e3595 | 17263 | ((org-agenda-skip-function 'my-skip-unless-waiting) |
4009494e GM |
17264 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
17265 | @end lisp | |
17266 | ||
c8d0cf5c | 17267 | @vindex org-agenda-overriding-header |
4009494e GM |
17268 | Note that this also binds @code{org-agenda-overriding-header} to get a |
17269 | meaningful header in the agenda view. | |
17270 | ||
c8d0cf5c CD |
17271 | @vindex org-odd-levels-only |
17272 | @vindex org-agenda-skip-function | |
a7808fba CD |
17273 | A general way to create custom searches is to base them on a search for |
17274 | entries with a certain level limit. If you want to study all entries with | |
c8d0cf5c CD |
17275 | your custom search function, simply do a search for |
17276 | @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a | |
17277 | level number corresponds to order in the hierarchy, not to the number of | |
17278 | stars.}, and then use @code{org-agenda-skip-function} to select the entries | |
17279 | you really want to have. | |
a7808fba | 17280 | |
4009494e GM |
17281 | You may also put a Lisp form into @code{org-agenda-skip-function}. In |
17282 | particular, you may use the functions @code{org-agenda-skip-entry-if} | |
17283 | and @code{org-agenda-skip-subtree-if} in this form, for example: | |
17284 | ||
17285 | @table @code | |
6d72f719 | 17286 | @item (org-agenda-skip-entry-if 'scheduled) |
4009494e | 17287 | Skip current entry if it has been scheduled. |
6d72f719 | 17288 | @item (org-agenda-skip-entry-if 'notscheduled) |
4009494e | 17289 | Skip current entry if it has not been scheduled. |
6d72f719 | 17290 | @item (org-agenda-skip-entry-if 'deadline) |
4009494e | 17291 | Skip current entry if it has a deadline. |
6d72f719 | 17292 | @item (org-agenda-skip-entry-if 'scheduled 'deadline) |
4009494e | 17293 | Skip current entry if it has a deadline, or if it is scheduled. |
6d72f719 | 17294 | @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING")) |
ed21c5c8 | 17295 | Skip current entry if the TODO keyword is TODO or WAITING. |
6d72f719 | 17296 | @item (org-agenda-skip-entry-if 'todo 'done) |
ed21c5c8 | 17297 | Skip current entry if the TODO keyword marks a DONE state. |
6d72f719 | 17298 | @item (org-agenda-skip-entry-if 'timestamp) |
c8d0cf5c | 17299 | Skip current entry if it has any timestamp, may also be deadline or scheduled. |
8223b1d2 BG |
17300 | @anchor{x-agenda-skip-entry-regexp} |
17301 | @item (org-agenda-skip-entry-if 'regexp "regular expression") | |
dbc28aaa | 17302 | Skip current entry if the regular expression matches in the entry. |
8223b1d2 | 17303 | @item (org-agenda-skip-entry-if 'notregexp "regular expression") |
dbc28aaa | 17304 | Skip current entry unless the regular expression matches. |
6d72f719 | 17305 | @item (org-agenda-skip-subtree-if 'regexp "regular expression") |
4009494e GM |
17306 | Same as above, but check and skip the entire subtree. |
17307 | @end table | |
17308 | ||
17309 | Therefore we could also have written the search for WAITING projects | |
17310 | like this, even without defining a special function: | |
17311 | ||
17312 | @lisp | |
17313 | (org-add-agenda-custom-command | |
17314 | '("b" todo "PROJECT" | |
17315 | ((org-agenda-skip-function '(org-agenda-skip-subtree-if | |
dbc28aaa | 17316 | 'regexp ":waiting:")) |
4009494e GM |
17317 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
17318 | @end lisp | |
17319 | ||
271672fa BG |
17320 | @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking |
17321 | @section Speeding up your agendas | |
17322 | @cindex agenda views, optimization | |
17323 | ||
17324 | When your Org files grow in both number and size, agenda commands may start | |
17325 | to become slow. Below are some tips on how to speed up the agenda commands. | |
17326 | ||
17327 | @enumerate | |
17328 | @item | |
d1389828 PE |
17329 | Reduce the number of Org agenda files: this will reduce the slowness caused |
17330 | by accessing a hard drive. | |
271672fa BG |
17331 | @item |
17332 | Reduce the number of DONE and archived headlines: this way the agenda does | |
17333 | not need to skip them. | |
17334 | @item | |
17335 | @vindex org-agenda-dim-blocked-tasks | |
17336 | Inhibit the dimming of blocked tasks: | |
17337 | @lisp | |
17338 | (setq org-agenda-dim-blocked-tasks nil) | |
17339 | @end lisp | |
17340 | @item | |
17341 | @vindex org-startup-folded | |
17342 | @vindex org-agenda-inhibit-startup | |
17343 | Inhibit agenda files startup options: | |
17344 | @lisp | |
17345 | (setq org-agenda-inhibit-startup nil) | |
17346 | @end lisp | |
17347 | @item | |
17348 | @vindex org-agenda-show-inherited-tags | |
17349 | @vindex org-agenda-use-tag-inheritance | |
17350 | Disable tag inheritance in agenda: | |
17351 | @lisp | |
17352 | (setq org-agenda-use-tag-inheritance nil) | |
17353 | @end lisp | |
17354 | @end enumerate | |
17355 | ||
17356 | You can set these options for specific agenda views only. See the docstrings | |
17357 | of these variables for details on why they affect the agenda generation, and | |
17358 | this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg | |
17359 | page} for further explanations. | |
17360 | ||
17361 | @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking | |
c8d0cf5c CD |
17362 | @section Extracting agenda information |
17363 | @cindex agenda, pipe | |
17364 | @cindex Scripts, for agenda processing | |
17365 | ||
17366 | @vindex org-agenda-custom-commands | |
17367 | Org provides commands to access agenda information for the command | |
17368 | line in Emacs batch mode. This extracted information can be sent | |
17369 | directly to a printer, or it can be read by a program that does further | |
17370 | processing of the data. The first of these commands is the function | |
17371 | @code{org-batch-agenda}, that produces an agenda view and sends it as | |
1df7defd | 17372 | ASCII text to STDOUT@. The command takes a single string as parameter. |
c8d0cf5c CD |
17373 | If the string has length 1, it is used as a key to one of the commands |
17374 | you have configured in @code{org-agenda-custom-commands}, basically any | |
17375 | key you can use after @kbd{C-c a}. For example, to directly print the | |
17376 | current TODO list, you could use | |
17377 | ||
17378 | @example | |
17379 | emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
17380 | @end example | |
17381 | ||
17382 | If the parameter is a string with 2 or more characters, it is used as a | |
17383 | tags/TODO match string. For example, to print your local shopping list | |
17384 | (all items with the tag @samp{shop}, but excluding the tag | |
17385 | @samp{NewYork}), you could use | |
17386 | ||
17387 | @example | |
17388 | emacs -batch -l ~/.emacs \ | |
17389 | -eval '(org-batch-agenda "+shop-NewYork")' | lpr | |
17390 | @end example | |
17391 | ||
17392 | @noindent | |
17393 | You may also modify parameters on the fly like this: | |
17394 | ||
17395 | @example | |
17396 | emacs -batch -l ~/.emacs \ | |
17397 | -eval '(org-batch-agenda "a" \ | |
e66ba1df | 17398 | org-agenda-span (quote month) \ |
c8d0cf5c CD |
17399 | org-agenda-include-diary nil \ |
17400 | org-agenda-files (quote ("~/org/project.org")))' \ | |
17401 | | lpr | |
17402 | @end example | |
17403 | ||
17404 | @noindent | |
17405 | which will produce a 30-day agenda, fully restricted to the Org file | |
17406 | @file{~/org/projects.org}, not even including the diary. | |
17407 | ||
17408 | If you want to process the agenda data in more sophisticated ways, you | |
17409 | can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
17410 | list of values for each agenda item. Each line in the output will | |
17411 | contain a number of fields separated by commas. The fields in a line | |
17412 | are: | |
17413 | ||
17414 | @example | |
17415 | category @r{The category of the item} | |
17416 | head @r{The headline, without TODO keyword, TAGS and PRIORITY} | |
17417 | type @r{The type of the agenda entry, can be} | |
17418 | todo @r{selected in TODO match} | |
17419 | tagsmatch @r{selected in tags match} | |
17420 | diary @r{imported from diary} | |
17421 | deadline @r{a deadline} | |
17422 | scheduled @r{scheduled} | |
17423 | timestamp @r{appointment, selected by timestamp} | |
17424 | closed @r{entry was closed on date} | |
17425 | upcoming-deadline @r{warning about nearing deadline} | |
17426 | past-scheduled @r{forwarded scheduled item} | |
17427 | block @r{entry has date block including date} | |
17428 | todo @r{The TODO keyword, if any} | |
17429 | tags @r{All tags including inherited ones, separated by colons} | |
17430 | date @r{The relevant date, like 2007-2-14} | |
17431 | time @r{The time, like 15:00-16:50} | |
17432 | extra @r{String with extra planning info} | |
17433 | priority-l @r{The priority letter if any was given} | |
17434 | priority-n @r{The computed numerical priority} | |
17435 | @end example | |
17436 | ||
17437 | @noindent | |
17438 | Time and date will only be given if a timestamp (or deadline/scheduled) | |
17439 | led to the selection of the item. | |
17440 | ||
17441 | A CSV list like this is very easy to use in a post-processing script. | |
17442 | For example, here is a Perl program that gets the TODO list from | |
17443 | Emacs/Org and prints all the items, preceded by a checkbox: | |
17444 | ||
17445 | @example | |
17446 | #!/usr/bin/perl | |
17447 | ||
17448 | # define the Emacs command to run | |
17449 | $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
17450 | ||
17451 | # run it and capture the output | |
17452 | $agenda = qx@{$cmd 2>/dev/null@}; | |
17453 | ||
17454 | # loop over all lines | |
17455 | foreach $line (split(/\n/,$agenda)) @{ | |
17456 | # get the individual values | |
17457 | ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
17458 | $priority_l,$priority_n) = split(/,/,$line); | |
17459 | # process and print | |
17460 | print "[ ] $head\n"; | |
17461 | @} | |
17462 | @end example | |
17463 | ||
c8d0cf5c | 17464 | @node Using the property API, Using the mapping API, Extracting agenda information, Hacking |
4009494e GM |
17465 | @section Using the property API |
17466 | @cindex API, for properties | |
17467 | @cindex properties, API | |
17468 | ||
17469 | Here is a description of the functions that can be used to work with | |
17470 | properties. | |
17471 | ||
17472 | @defun org-entry-properties &optional pom which | |
c8d0cf5c | 17473 | Get all properties of the entry at point-or-marker POM.@* |
4009494e GM |
17474 | This includes the TODO keyword, the tags, time strings for deadline, |
17475 | scheduled, and clocking, and any additional properties defined in the | |
acedf35c | 17476 | entry. The return value is an alist. Keys may occur multiple times |
c8d0cf5c | 17477 | if the property key was used several times.@* |
271672fa BG |
17478 | POM may also be @code{nil}, in which case the current entry is used. |
17479 | If WHICH is @code{nil} or `all', get all properties. If WHICH is | |
4009494e GM |
17480 | `special' or `standard', only get that subclass. |
17481 | @end defun | |
c8d0cf5c | 17482 | @vindex org-use-property-inheritance |
8223b1d2 | 17483 | @findex org-insert-property-drawer |
4009494e | 17484 | @defun org-entry-get pom property &optional inherit |
271672fa BG |
17485 | Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default, |
17486 | this only looks at properties defined locally in the entry. If @code{INHERIT} | |
17487 | is non-@code{nil} and the entry does not have the property, then also check | |
17488 | higher levels of the hierarchy. If @code{INHERIT} is the symbol | |
a7808fba | 17489 | @code{selective}, use inheritance if and only if the setting of |
271672fa | 17490 | @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance. |
4009494e GM |
17491 | @end defun |
17492 | ||
17493 | @defun org-entry-delete pom property | |
271672fa | 17494 | Delete the property @code{PROPERTY} from entry at point-or-marker POM. |
4009494e GM |
17495 | @end defun |
17496 | ||
17497 | @defun org-entry-put pom property value | |
271672fa | 17498 | Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM. |
4009494e GM |
17499 | @end defun |
17500 | ||
17501 | @defun org-buffer-property-keys &optional include-specials | |
17502 | Get all property keys in the current buffer. | |
17503 | @end defun | |
17504 | ||
17505 | @defun org-insert-property-drawer | |
8223b1d2 | 17506 | Insert a property drawer for the current entry. Also |
4009494e GM |
17507 | @end defun |
17508 | ||
864c9740 | 17509 | @defun org-entry-put-multivalued-property pom property &rest values |
271672fa BG |
17510 | Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@. |
17511 | @code{VALUES} should be a list of strings. They will be concatenated, with | |
17512 | spaces as separators. | |
864c9740 CD |
17513 | @end defun |
17514 | ||
17515 | @defun org-entry-get-multivalued-property pom property | |
271672fa BG |
17516 | Treat the value of the property @code{PROPERTY} as a whitespace-separated |
17517 | list of values and return the values as a list of strings. | |
864c9740 CD |
17518 | @end defun |
17519 | ||
a7808fba | 17520 | @defun org-entry-add-to-multivalued-property pom property value |
271672fa BG |
17521 | Treat the value of the property @code{PROPERTY} as a whitespace-separated |
17522 | list of values and make sure that @code{VALUE} is in this list. | |
a7808fba CD |
17523 | @end defun |
17524 | ||
17525 | @defun org-entry-remove-from-multivalued-property pom property value | |
271672fa BG |
17526 | Treat the value of the property @code{PROPERTY} as a whitespace-separated |
17527 | list of values and make sure that @code{VALUE} is @emph{not} in this list. | |
a7808fba CD |
17528 | @end defun |
17529 | ||
17530 | @defun org-entry-member-in-multivalued-property pom property value | |
271672fa BG |
17531 | Treat the value of the property @code{PROPERTY} as a whitespace-separated |
17532 | list of values and check if @code{VALUE} is in this list. | |
a7808fba CD |
17533 | @end defun |
17534 | ||
ed21c5c8 | 17535 | @defopt org-property-allowed-value-functions |
acedf35c | 17536 | Hook for functions supplying allowed values for a specific property. |
ed21c5c8 CD |
17537 | The functions must take a single argument, the name of the property, and |
17538 | return a flat list of allowed values. If @samp{:ETC} is one of | |
17539 | the values, use the values as completion help, but allow also other values | |
17540 | to be entered. The functions must return @code{nil} if they are not | |
17541 | responsible for this property. | |
17542 | @end defopt | |
17543 | ||
b349f79f CD |
17544 | @node Using the mapping API, , Using the property API, Hacking |
17545 | @section Using the mapping API | |
17546 | @cindex API, for mapping | |
17547 | @cindex mapping entries, API | |
17548 | ||
17549 | Org has sophisticated mapping capabilities to find all entries satisfying | |
17550 | certain criteria. Internally, this functionality is used to produce agenda | |
17551 | views, but there is also an API that can be used to execute arbitrary | |
17552 | functions for each or selected entries. The main entry point for this API | |
96c8522a | 17553 | is: |
b349f79f CD |
17554 | |
17555 | @defun org-map-entries func &optional match scope &rest skip | |
271672fa | 17556 | Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}. |
b349f79f | 17557 | |
271672fa BG |
17558 | @code{FUNC} is a function or a Lisp form. The function will be called |
17559 | without arguments, with the cursor positioned at the beginning of the | |
17560 | headline. The return values of all calls to the function will be collected | |
17561 | and returned as a list. | |
b349f79f | 17562 | |
271672fa BG |
17563 | The call to @code{FUNC} will be wrapped into a save-excursion form, so |
17564 | @code{FUNC} does not need to preserve point. After evaluation, the cursor | |
17565 | will be moved to the end of the line (presumably of the headline of the | |
17566 | processed entry) and search continues from there. Under some circumstances, | |
17567 | this may not produce the wanted results. For example, if you have removed | |
17568 | (e.g., archived) the current (sub)tree it could mean that the next entry will | |
17569 | be skipped entirely. In such cases, you can specify the position from where | |
17570 | search should continue by making @code{FUNC} set the variable | |
17571 | @code{org-map-continue-from} to the desired buffer position. | |
c8d0cf5c | 17572 | |
271672fa BG |
17573 | @code{MATCH} is a tags/property/todo match as it is used in the agenda match |
17574 | view. Only headlines that are matched by this query will be considered | |
17575 | during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all | |
17576 | headlines will be visited by the iteration. | |
b349f79f | 17577 | |
271672fa | 17578 | @code{SCOPE} determines the scope of this command. It can be any of: |
b349f79f CD |
17579 | |
17580 | @example | |
17581 | nil @r{the current buffer, respecting the restriction if any} | |
17582 | tree @r{the subtree started with the entry at point} | |
ce57c2fe | 17583 | region @r{The entries within the active region, if any} |
b349f79f CD |
17584 | file @r{the current buffer, without restriction} |
17585 | file-with-archives | |
17586 | @r{the current buffer, and any archives associated with it} | |
17587 | agenda @r{all agenda files} | |
17588 | agenda-with-archives | |
17589 | @r{all agenda files with any archive files associated with them} | |
17590 | (file1 file2 ...) | |
17591 | @r{if this is a list, all files in the list will be scanned} | |
17592 | @end example | |
c8d0cf5c | 17593 | @noindent |
b349f79f CD |
17594 | The remaining args are treated as settings for the skipping facilities of |
17595 | the scanner. The following items can be given here: | |
17596 | ||
c8d0cf5c | 17597 | @vindex org-agenda-skip-function |
b349f79f CD |
17598 | @example |
17599 | archive @r{skip trees with the archive tag} | |
17600 | comment @r{skip trees with the COMMENT keyword} | |
17601 | function or Lisp form | |
17602 | @r{will be used as value for @code{org-agenda-skip-function},} | |
867d4bb3 | 17603 | @r{so whenever the function returns t, FUNC} |
b349f79f CD |
17604 | @r{will not be called for that entry and search will} |
17605 | @r{continue from the point where the function leaves it} | |
17606 | @end example | |
17607 | @end defun | |
17608 | ||
17609 | The function given to that mapping routine can really do anything you like. | |
a50253cc GM |
17610 | It can use the property API (@pxref{Using the property API}) to gather more |
17611 | information about the entry, or in order to change metadata in the entry. | |
b349f79f | 17612 | Here are a couple of functions that might be handy: |
96c8522a | 17613 | |
b349f79f | 17614 | @defun org-todo &optional arg |
acedf35c | 17615 | Change the TODO state of the entry. See the docstring of the functions for |
271672fa | 17616 | the many possible values for the argument @code{ARG}. |
b349f79f CD |
17617 | @end defun |
17618 | ||
17619 | @defun org-priority &optional action | |
acedf35c | 17620 | Change the priority of the entry. See the docstring of this function for the |
271672fa | 17621 | possible values for @code{ACTION}. |
b349f79f CD |
17622 | @end defun |
17623 | ||
17624 | @defun org-toggle-tag tag &optional onoff | |
271672fa BG |
17625 | Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to |
17626 | either @code{on} or @code{off} will not toggle tag, but ensure that it is | |
17627 | either on or off. | |
b349f79f CD |
17628 | @end defun |
17629 | ||
17630 | @defun org-promote | |
17631 | Promote the current entry. | |
17632 | @end defun | |
17633 | ||
17634 | @defun org-demote | |
17635 | Demote the current entry. | |
17636 | @end defun | |
17637 | ||
17638 | Here is a simple example that will turn all entries in the current file with | |
17639 | a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}. | |
17640 | Entries in comment trees and in archive trees will be ignored. | |
17641 | ||
17642 | @lisp | |
17643 | (org-map-entries | |
63aa0982 BG |
17644 | '(org-todo "UPCOMING") |
17645 | "+TOMORROW" 'file 'archive 'comment) | |
b349f79f CD |
17646 | @end lisp |
17647 | ||
17648 | The following example counts the number of entries with TODO keyword | |
17649 | @code{WAITING}, in all agenda files. | |
17650 | ||
17651 | @lisp | |
96c8522a | 17652 | (length (org-map-entries t "/+WAITING" 'agenda)) |
b349f79f CD |
17653 | @end lisp |
17654 | ||
7006d207 CD |
17655 | @node MobileOrg, History and Acknowledgments, Hacking, Top |
17656 | @appendix MobileOrg | |
17657 | @cindex iPhone | |
17658 | @cindex MobileOrg | |
17659 | ||
8223b1d2 BG |
17660 | @i{MobileOrg} is the name of the mobile companion app for Org mode, currently |
17661 | available for iOS and for Android. @i{MobileOrg} offers offline viewing and | |
17662 | capture support for an Org mode system rooted on a ``real'' computer. It | |
271672fa BG |
17663 | does also allow you to record changes to existing entries. The |
17664 | @uref{https://github.com/MobileOrg/, iOS implementation} for the | |
17665 | @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland | |
17666 | and is now in the hands Sean Escriva. Android users should check out | |
86fbb8ca | 17667 | @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android} |
8223b1d2 BG |
17668 | by Matt Jones. The two implementations are not identical but offer similar |
17669 | features. | |
7006d207 CD |
17670 | |
17671 | This appendix describes the support Org has for creating agenda views in a | |
17672 | format that can be displayed by @i{MobileOrg}, and for integrating notes | |
a351880d CD |
17673 | captured and changes made by @i{MobileOrg} into the main system. |
17674 | ||
17675 | For changing tags and TODO states in MobileOrg, you should have set up the | |
271672fa | 17676 | customization variables @code{org-todo-keywords} and @code{org-tag-alist} to |
86fbb8ca | 17677 | cover all important tags and TODO keywords, even if individual files use only |
a351880d | 17678 | part of these. MobileOrg will also offer you states and tags set up with |
86fbb8ca | 17679 | in-buffer settings, but it will understand the logistics of TODO state |
a351880d CD |
17680 | @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags |
17681 | (@pxref{Setting tags}) only for those set in these variables. | |
7006d207 CD |
17682 | |
17683 | @menu | |
c0468714 GM |
17684 | * Setting up the staging area:: Where to interact with the mobile device |
17685 | * Pushing to MobileOrg:: Uploading Org files and agendas | |
17686 | * Pulling from MobileOrg:: Integrating captured and flagged items | |
7006d207 CD |
17687 | @end menu |
17688 | ||
17689 | @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg | |
17690 | @section Setting up the staging area | |
17691 | ||
acedf35c | 17692 | MobileOrg needs to interact with Emacs through a directory on a server. If you |
afe98dfa | 17693 | are using a public server, you should consider to encrypt the files that are |
e66ba1df | 17694 | uploaded to the server. This can be done with Org mode 7.02 and with |
afe98dfa CD |
17695 | @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl} |
17696 | installation on your system. To turn on encryption, set a password in | |
17697 | @i{MobileOrg} and, on the Emacs side, configure the variable | |
17698 | @code{org-mobile-use-encryption}@footnote{If you can safely store the | |
17699 | password in your Emacs setup, you might also want to configure | |
17700 | @code{org-mobile-encryption-password}. Please read the docstring of that | |
17701 | variable. Note that encryption will apply only to the contents of the | |
17702 | @file{.org} files. The file names themselves will remain visible.}. | |
17703 | ||
17704 | The easiest way to create that directory is to use a free | |
17705 | @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use | |
17706 | Dropbox, or if your version of MobileOrg does not support it, you can use a | |
acedf35c | 17707 | webdav server. For more information, check out the documentation of MobileOrg and also this |
ce57c2fe | 17708 | @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}. |
86fbb8ca CD |
17709 | When MobileOrg first connects to your Dropbox, it will create a directory |
17710 | @i{MobileOrg} inside the Dropbox. After the directory has been created, tell | |
17711 | Emacs about it: | |
a351880d | 17712 | |
86fbb8ca CD |
17713 | @lisp |
17714 | (setq org-mobile-directory "~/Dropbox/MobileOrg") | |
17715 | @end lisp | |
a351880d | 17716 | |
e66ba1df | 17717 | Org mode has commands to put files for @i{MobileOrg} into that directory, |
86fbb8ca | 17718 | and to read captured notes from there. |
7006d207 CD |
17719 | |
17720 | @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg | |
17721 | @section Pushing to MobileOrg | |
17722 | ||
17723 | This operation copies all files currently listed in @code{org-mobile-files} | |
17724 | to the directory @code{org-mobile-directory}. By default this list contains | |
17725 | all agenda files (as listed in @code{org-agenda-files}), but additional files | |
ce57c2fe | 17726 | can be included by customizing @code{org-mobile-files}. File names will be |
acedf35c | 17727 | staged with paths relative to @code{org-directory}, so all files should be |
c7cf0ebc BG |
17728 | inside this directory@footnote{Symbolic links in @code{org-directory} need to |
17729 | have the same name than their targets.}. | |
17730 | ||
17731 | The push operation also creates a special Org file @file{agendas.org} with | |
17732 | all custom agenda view defined by the user@footnote{While creating the | |
17733 | agendas, Org mode will force ID properties on all referenced entries, so that | |
17734 | these entries can be uniquely identified if @i{MobileOrg} flags them for | |
17735 | further action. If you do not want to get these properties in so many | |
17736 | entries, you can set the variable @code{org-mobile-force-id-on-agenda-items} | |
17737 | to @code{nil}. Org mode will then rely on outline paths, in the hope that | |
17738 | these will be unique enough.}. | |
17739 | ||
afe98dfa CD |
17740 | Finally, Org writes the file @file{index.org}, containing links to all other |
17741 | files. @i{MobileOrg} first reads this file from the server, and then | |
17742 | downloads all agendas and Org files listed in it. To speed up the download, | |
735135f9 | 17743 | MobileOrg will only read files whose checksums@footnote{Checksums are stored |
8223b1d2 | 17744 | automatically in the file @file{checksums.dat}} have changed. |
7006d207 CD |
17745 | |
17746 | @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg | |
17747 | @section Pulling from MobileOrg | |
17748 | ||
86fbb8ca CD |
17749 | When @i{MobileOrg} synchronizes with the server, it not only pulls the Org |
17750 | files for viewing. It also appends captured entries and pointers to flagged | |
17751 | and changed entries to the file @file{mobileorg.org} on the server. Org has | |
17752 | a @emph{pull} operation that integrates this information into an inbox file | |
17753 | and operates on the pointers to flagged entries. Here is how it works: | |
7006d207 CD |
17754 | |
17755 | @enumerate | |
17756 | @item | |
17757 | Org moves all entries found in | |
17758 | @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this | |
17759 | operation.} and appends them to the file pointed to by the variable | |
a351880d CD |
17760 | @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event |
17761 | will be a top-level entry in the inbox file. | |
17762 | @item | |
17763 | After moving the entries, Org will attempt to implement the changes made in | |
17764 | @i{MobileOrg}. Some changes are applied directly and without user | |
17765 | interaction. Examples are all changes to tags, TODO state, headline and body | |
17766 | text that can be cleanly applied. Entries that have been flagged for further | |
17767 | action will receive a tag @code{:FLAGGED:}, so that they can be easily found | |
17768 | again. When there is a problem finding an entry or applying the change, the | |
17769 | pointer entry will remain in the inbox and will be marked with an error | |
17770 | message. You need to later resolve these issues by hand. | |
7006d207 CD |
17771 | @item |
17772 | Org will then generate an agenda view with all flagged entries. The user | |
17773 | should then go through these entries and do whatever actions are necessary. | |
17774 | If a note has been stored while flagging an entry in @i{MobileOrg}, that note | |
17775 | will be displayed in the echo area when the cursor is on the corresponding | |
17776 | agenda line. | |
271672fa | 17777 | |
7006d207 CD |
17778 | @table @kbd |
17779 | @kindex ? | |
17780 | @item ? | |
17781 | Pressing @kbd{?} in that special agenda will display the full flagging note in | |
17782 | another window and also push it onto the kill ring. So you could use @kbd{? | |
17783 | z C-y C-c C-c} to store that flagging note as a normal note in the entry. | |
17784 | Pressing @kbd{?} twice in succession will offer to remove the | |
17785 | @code{:FLAGGED:} tag along with the recorded flagging note (which is stored | |
acedf35c | 17786 | in a property). In this way you indicate that the intended processing for |
a351880d | 17787 | this flagged entry is finished. |
7006d207 CD |
17788 | @end table |
17789 | @end enumerate | |
17790 | ||
17791 | @kindex C-c a ? | |
17792 | If you are not able to process all flagged entries directly, you can always | |
afe98dfa | 17793 | return to this agenda view@footnote{Note, however, that there is a subtle |
271672fa BG |
17794 | difference. The view created automatically by @kbd{M-x org-mobile-pull RET} |
17795 | is guaranteed to search all files that have been addressed by the last pull. | |
17796 | This might include a file that is not currently in your list of agenda files. | |
17797 | If you later use @kbd{C-c a ?} to regenerate the view, only the current | |
17798 | agenda files will be searched.} using @kbd{C-c a ?}. | |
7006d207 | 17799 | |
257b2c7d | 17800 | @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top |
86fbb8ca CD |
17801 | @appendix History and acknowledgments |
17802 | @cindex acknowledgments | |
4009494e GM |
17803 | @cindex history |
17804 | @cindex thanks | |
17805 | ||
8223b1d2 BG |
17806 | @section From Carsten |
17807 | ||
86fbb8ca CD |
17808 | Org was born in 2003, out of frustration over the user interface of the Emacs |
17809 | Outline mode. I was trying to organize my notes and projects, and using | |
17810 | Emacs seemed to be the natural way to go. However, having to remember eleven | |
17811 | different commands with two or three keys per command, only to hide and show | |
17812 | parts of the outline tree, that seemed entirely unacceptable to me. Also, | |
17813 | when using outlines to take notes, I constantly wanted to restructure the | |
17814 | tree, organizing it parallel to my thoughts and plans. @emph{Visibility | |
17815 | cycling} and @emph{structure editing} were originally implemented in the | |
17816 | package @file{outline-magic.el}, but quickly moved to the more general | |
17817 | @file{org.el}. As this environment became comfortable for project planning, | |
17818 | the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and | |
17819 | @emph{table support}. These areas highlighted the two main goals that Org | |
17820 | still has today: to be a new, outline-based, plain text mode with innovative | |
17821 | and intuitive editing features, and to incorporate project planning | |
17822 | functionality directly into a notes file. | |
a7808fba | 17823 | |
c8d0cf5c CD |
17824 | Since the first release, literally thousands of emails to me or to |
17825 | @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
4009494e GM |
17826 | reports, feedback, new ideas, and sometimes patches and add-on code. |
17827 | Many thanks to everyone who has helped to improve this package. I am | |
17828 | trying to keep here a list of the people who had significant influence | |
a7808fba | 17829 | in shaping one or more aspects of Org. The list may not be |
4009494e GM |
17830 | complete, if I have forgotten someone, please accept my apologies and |
17831 | let me know. | |
17832 | ||
86fbb8ca CD |
17833 | Before I get to this list, a few special mentions are in order: |
17834 | ||
17835 | @table @i | |
17836 | @item Bastien Guerry | |
17837 | Bastien has written a large number of extensions to Org (most of them | |
e66ba1df | 17838 | integrated into the core by now), including the @LaTeX{} exporter and the plain |
86fbb8ca CD |
17839 | list parser. His support during the early days, when he basically acted as |
17840 | co-maintainer, was central to the success of this project. Bastien also | |
8223b1d2 | 17841 | invented Worg, helped establishing the Web presence of Org, and sponsored |
86fbb8ca CD |
17842 | hosting costs for the orgmode.org website. |
17843 | @item Eric Schulte and Dan Davison | |
17844 | Eric and Dan are jointly responsible for the Org-babel system, which turns | |
17845 | Org into a multi-language environment for evaluating code and doing literate | |
17846 | programming and reproducible research. | |
17847 | @item John Wiegley | |
acedf35c CD |
17848 | John has contributed a number of great ideas and patches directly to Org, |
17849 | including the attachment system (@file{org-attach.el}), integration with | |
17850 | Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO | |
17851 | items, habit tracking (@file{org-habits.el}), and encryption | |
17852 | (@file{org-crypt.el}). Also, the capture system is really an extended copy | |
17853 | of his great @file{remember.el}. | |
86fbb8ca CD |
17854 | @item Sebastian Rose |
17855 | Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work | |
17856 | of an ignorant amateur. Sebastian has pushed this part of Org onto a much | |
17857 | higher level. He also wrote @file{org-info.js}, a Java script for displaying | |
271672fa | 17858 | web pages derived from Org using an Info-like or a folding interface with |
86fbb8ca CD |
17859 | single-key navigation. |
17860 | @end table | |
17861 | ||
8223b1d2 BG |
17862 | @noindent See below for the full list of contributions! Again, please |
17863 | let me know what I am missing here! | |
17864 | ||
17865 | @section From Bastien | |
17866 | ||
17867 | I (Bastien) have been maintaining Org since January 2011. This appendix | |
17868 | would not be complete without adding a few more acknowledgements and thanks | |
17869 | to Carsten's ones above. | |
17870 | ||
17871 | I am first grateful to Carsten for his trust while handing me over the | |
271672fa BG |
17872 | maintainership of Org. His unremitting support is what really helped me |
17873 | getting more confident over time, with both the community and the code. | |
8223b1d2 BG |
17874 | |
17875 | When I took over maintainership, I knew I would have to make Org more | |
17876 | collaborative than ever, as I would have to rely on people that are more | |
17877 | knowledgeable than I am on many parts of the code. Here is a list of the | |
17878 | persons I could rely on, they should really be considered co-maintainers, | |
17879 | either of the code or the community: | |
17880 | ||
17881 | @table @i | |
17882 | @item Eric Schulte | |
17883 | Eric is maintaining the Babel parts of Org. His reactivity here kept me away | |
17884 | from worrying about possible bugs here and let me focus on other parts. | |
17885 | ||
17886 | @item Nicolas Goaziou | |
271672fa BG |
17887 | Nicolas is maintaining the consistency of the deepest parts of Org. His |
17888 | work on @file{org-element.el} and @file{ox.el} has been outstanding, and | |
17889 | opened the doors for many new ideas and features. He rewrote many of the | |
17890 | old exporters to use the new export engine, and helped with documenting | |
17891 | this major change. More importantly (if that's possible), he has been more | |
17892 | than reliable during all the work done for Org 8.0, and always very | |
17893 | reactive on the mailing list. | |
8223b1d2 BG |
17894 | |
17895 | @item Achim Gratz | |
17896 | Achim rewrote the building process of Org, turning some @emph{ad hoc} tools | |
17897 | into a flexible and conceptually clean process. He patiently coped with the | |
1e20eeb7 | 17898 | many hiccups that such a change can create for users. |
8223b1d2 BG |
17899 | |
17900 | @item Nick Dokos | |
17901 | The Org mode mailing list would not be such a nice place without Nick, who | |
17902 | patiently helped users so many times. It is impossible to overestimate such | |
17903 | a great help, and the list would not be so active without him. | |
17904 | @end table | |
17905 | ||
17906 | I received support from so many users that it is clearly impossible to be | |
f99f1641 | 17907 | fair when shortlisting a few of them, but Org's history would not be |
8223b1d2 BG |
17908 | complete if the ones above were not mentioned in this manual. |
17909 | ||
17910 | @section List of contributions | |
86fbb8ca | 17911 | |
4009494e GM |
17912 | @itemize @bullet |
17913 | ||
17914 | @item | |
17915 | @i{Russel Adams} came up with the idea for drawers. | |
17916 | @item | |
271672fa BG |
17917 | @i{Suvayu Ali} has steadily helped on the mailing list, providing useful |
17918 | feedback on many features and several patches. | |
17919 | @item | |
17920 | @i{Luis Anaya} wrote @file{ox-man.el}. | |
17921 | @item | |
a7808fba | 17922 | @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
4009494e | 17923 | @item |
271672fa BG |
17924 | @i{Michael Brand} helped by reporting many bugs and testing many features. |
17925 | He also implemented the distinction between empty fields and 0-value fields | |
17926 | in Org's spreadsheets. | |
17927 | @item | |
b349f79f | 17928 | @i{Christophe Bataillon} created the great unicorn logo that we use on the |
e66ba1df | 17929 | Org mode website. |
b349f79f | 17930 | @item |
c8d0cf5c CD |
17931 | @i{Alex Bochannek} provided a patch for rounding timestamps. |
17932 | @item | |
ed21c5c8 CD |
17933 | @i{Jan Böcker} wrote @file{org-docview.el}. |
17934 | @item | |
e66ba1df | 17935 | @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files. |
c8d0cf5c CD |
17936 | @item |
17937 | @i{Tom Breton} wrote @file{org-choose.el}. | |
4009494e GM |
17938 | @item |
17939 | @i{Charles Cave}'s suggestion sparked the implementation of templates | |
86fbb8ca | 17940 | for Remember, which are now templates for capture. |
4009494e GM |
17941 | @item |
17942 | @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
17943 | specified time. | |
17944 | @item | |
c8d0cf5c | 17945 | @i{Gregory Chernov} patched support for Lisp forms into table |
4009494e GM |
17946 | calculations and improved XEmacs compatibility, in particular by porting |
17947 | @file{nouline.el} to XEmacs. | |
17948 | @item | |
c8d0cf5c CD |
17949 | @i{Sacha Chua} suggested copying some linking code from Planner. |
17950 | @item | |
271672fa BG |
17951 | @i{Toby S. Cubitt} contributed to the code for clock formats. |
17952 | @item | |
17953 | @i{Baoqiu Cui} contributed the DocBook exporter. It has been deleted from | |
17954 | Org 8.0: you can now export to Texinfo and export the @file{.texi} file to | |
17955 | DocBook using @code{makeinfo}. | |
4009494e | 17956 | @item |
5fbc0f11 | 17957 | @i{Eddward DeVilla} proposed and tested checkbox statistics. He also |
4009494e GM |
17958 | came up with the idea of properties, and that there should be an API for |
17959 | them. | |
17960 | @item | |
c8d0cf5c CD |
17961 | @i{Nick Dokos} tracked down several nasty bugs. |
17962 | @item | |
4009494e GM |
17963 | @i{Kees Dullemond} used to edit projects lists directly in HTML and so |
17964 | inspired some of the early development, including HTML export. He also | |
17965 | asked for a way to narrow wide table columns. | |
17966 | @item | |
271672fa | 17967 | @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for |
d1389828 | 17968 | several years now. He also sponsored the hosting costs until Rackspace |
271672fa BG |
17969 | started to host us for free. |
17970 | @item | |
86fbb8ca CD |
17971 | @i{Thomas S. Dye} contributed documentation on Worg and helped integrating |
17972 | the Org-Babel documentation into the manual. | |
17973 | @item | |
acedf35c CD |
17974 | @i{Christian Egli} converted the documentation into Texinfo format, inspired |
17975 | the agenda, patched CSS formatting into the HTML exporter, and wrote | |
271672fa BG |
17976 | @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as |
17977 | @file{ox-taskjuggler.el} for Org 8.0. | |
4009494e GM |
17978 | @item |
17979 | @i{David Emery} provided a patch for custom CSS support in exported | |
17980 | HTML agendas. | |
17981 | @item | |
271672fa BG |
17982 | @i{Sean Escriva} took over MobileOrg development on the iPhone platform. |
17983 | @item | |
4009494e GM |
17984 | @i{Nic Ferrier} contributed mailcap and XOXO support. |
17985 | @item | |
28a16a1b CD |
17986 | @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes. |
17987 | @item | |
4009494e GM |
17988 | @i{John Foerch} figured out how to make incremental search show context |
17989 | around a match in a hidden outline tree. | |
17990 | @item | |
a351880d CD |
17991 | @i{Raimar Finken} wrote @file{org-git-line.el}. |
17992 | @item | |
17993 | @i{Mikael Fornius} works as a mailing list moderator. | |
17994 | @item | |
17995 | @i{Austin Frank} works as a mailing list moderator. | |
17996 | @item | |
acedf35c CD |
17997 | @i{Eric Fraga} drove the development of BEAMER export with ideas and |
17998 | testing. | |
17999 | @item | |
18000 | @i{Barry Gidden} did proofreading the manual in preparation for the book | |
18001 | publication through Network Theory Ltd. | |
18002 | @item | |
dbc28aaa | 18003 | @i{Niels Giesen} had the idea to automatically archive DONE trees. |
4009494e | 18004 | @item |
271672fa BG |
18005 | @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote |
18006 | @file{org-element.el} and @file{org-export.el}, which was a huge step forward | |
18007 | in implementing a clean framework for Org exporters. | |
afe98dfa | 18008 | @item |
4009494e GM |
18009 | @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. |
18010 | @item | |
acedf35c CD |
18011 | @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a |
18012 | book. | |
18013 | @item | |
a7808fba CD |
18014 | @i{Bernt Hansen} has driven much of the support for auto-repeating tasks, |
18015 | task state change logging, and the clocktable. His clear explanations have | |
c8d0cf5c | 18016 | been critical when we started to adopt the Git version control system. |
a7808fba | 18017 | @item |
c8d0cf5c | 18018 | @i{Manuel Hermenegildo} has contributed various ideas, small fixes and |
864c9740 CD |
18019 | patches. |
18020 | @item | |
a7808fba CD |
18021 | @i{Phil Jackson} wrote @file{org-irc.el}. |
18022 | @item | |
4009494e GM |
18023 | @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
18024 | folded entries, and column view for properties. | |
18025 | @item | |
86fbb8ca CD |
18026 | @i{Matt Jones} wrote @i{MobileOrg Android}. |
18027 | @item | |
a7808fba CD |
18028 | @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. |
18029 | @item | |
271672fa BG |
18030 | @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}. |
18031 | @item | |
acedf35c | 18032 | @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also |
4009494e GM |
18033 | provided frequent feedback and some patches. |
18034 | @item | |
55e0839d CD |
18035 | @i{Matt Lundin} has proposed last-row references for table formulas and named |
18036 | invisible anchors. He has also worked a lot on the FAQ. | |
18037 | @item | |
86fbb8ca CD |
18038 | @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org, |
18039 | and is a prolific contributor on the mailing list with competent replies, | |
18040 | small fixes and patches. | |
18041 | @item | |
4009494e GM |
18042 | @i{Jason F. McBrayer} suggested agenda export to CSV format. |
18043 | @item | |
271672fa | 18044 | @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas. |
dbc28aaa | 18045 | @item |
4009494e GM |
18046 | @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
18047 | basis. | |
18048 | @item | |
18049 | @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
18050 | happy. | |
18051 | @item | |
7006d207 CD |
18052 | @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone. |
18053 | @item | |
c8d0cf5c CD |
18054 | @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file |
18055 | and being able to quickly restrict the agenda to a subtree. | |
4009494e | 18056 | @item |
c8d0cf5c CD |
18057 | @i{Todd Neal} provided patches for links to Info files and Elisp forms. |
18058 | @item | |
18059 | @i{Greg Newman} refreshed the unicorn logo into its current form. | |
4009494e GM |
18060 | @item |
18061 | @i{Tim O'Callaghan} suggested in-file links, search options for general | |
18062 | file links, and TAGS. | |
18063 | @item | |
acedf35c | 18064 | @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text |
86fbb8ca CD |
18065 | version of the reference card. |
18066 | @item | |
4009494e GM |
18067 | @i{Takeshi Okano} translated the manual and David O'Toole's tutorial |
18068 | into Japanese. | |
18069 | @item | |
18070 | @i{Oliver Oppitz} suggested multi-state TODO items. | |
18071 | @item | |
18072 | @i{Scott Otterson} sparked the introduction of descriptive text for | |
18073 | links, among other things. | |
18074 | @item | |
18075 | @i{Pete Phillips} helped during the development of the TAGS feature, and | |
18076 | provided frequent feedback. | |
18077 | @item | |
271672fa BG |
18078 | @i{Francesco Pizzolante} provided patches that helped speeding up the agenda |
18079 | generation. | |
18080 | @item | |
c8d0cf5c CD |
18081 | @i{Martin Pohlack} provided the code snippet to bundle character insertion |
18082 | into bundles of 20 for undo. | |
18083 | @item | |
271672fa BG |
18084 | @i{Rackspace.com} is hosting our website for free. Thank you Rackspace! |
18085 | @item | |
4009494e GM |
18086 | @i{T.V. Raman} reported bugs and suggested improvements. |
18087 | @item | |
18088 | @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
18089 | control. | |
18090 | @item | |
a351880d CD |
18091 | @i{Paul Rivier} provided the basic implementation of named footnotes. He |
18092 | also acted as mailing list moderator for some time. | |
55e0839d | 18093 | @item |
4009494e GM |
18094 | @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
18095 | @item | |
18096 | @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a | |
18097 | conflict with @file{allout.el}. | |
18098 | @item | |
c8d0cf5c | 18099 | @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with |
b349f79f | 18100 | extensive patches. |
4009494e | 18101 | @item |
b349f79f CD |
18102 | @i{Philip Rooke} created the Org reference card, provided lots |
18103 | of feedback, developed and applied standards to the Org documentation. | |
4009494e GM |
18104 | @item |
18105 | @i{Christian Schlauer} proposed angular brackets around links, among | |
18106 | other things. | |
18107 | @item | |
271672fa BG |
18108 | @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can |
18109 | enjoy folding in non-org buffers by using Org headlines in comments. | |
18110 | @item | |
ed21c5c8 CD |
18111 | @i{Paul Sexton} wrote @file{org-ctags.el}. |
18112 | @item | |
b349f79f | 18113 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
4009494e GM |
18114 | @file{organizer-mode.el}. |
18115 | @item | |
55e0839d CD |
18116 | @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal |
18117 | examples, and remote highlighting for referenced code lines. | |
a7808fba | 18118 | @item |
64fb801f CD |
18119 | @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is |
18120 | now packaged into Org's @file{contrib} directory. | |
18121 | @item | |
4009494e GM |
18122 | @i{Daniel Sinder} came up with the idea of internal archiving by locking |
18123 | subtrees. | |
18124 | @item | |
18125 | @i{Dale Smith} proposed link abbreviations. | |
18126 | @item | |
864c9740 CD |
18127 | @i{James TD Smith} has contributed a large number of patches for useful |
18128 | tweaks and features. | |
18129 | @item | |
b349f79f CD |
18130 | @i{Adam Spiers} asked for global linking commands, inspired the link |
18131 | extension system, added support for mairix, and proposed the mapping API. | |
4009494e | 18132 | @item |
86fbb8ca | 18133 | @i{Ulf Stegemann} created the table to translate special symbols to HTML, |
e66ba1df | 18134 | @LaTeX{}, UTF-8, Latin-1 and ASCII. |
86fbb8ca | 18135 | @item |
96c8522a CD |
18136 | @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content |
18137 | with links transformation to Org syntax. | |
18138 | @item | |
4009494e GM |
18139 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
18140 | chapter about publishing. | |
18141 | @item | |
271672fa | 18142 | @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter. |
ce57c2fe | 18143 | @item |
e66ba1df | 18144 | @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and |
27e428e7 | 18145 | enabled source code highlighting in Gnus. |
acedf35c | 18146 | @item |
86fbb8ca CD |
18147 | @i{Stefan Vollmar} organized a video-recorded talk at the |
18148 | Max-Planck-Institute for Neurology. He also inspired the creation of a | |
18149 | concept index for HTML export. | |
18150 | @item | |
4009494e GM |
18151 | @i{J@"urgen Vollmer} contributed code generating the table of contents |
18152 | in HTML output. | |
18153 | @item | |
ed21c5c8 CD |
18154 | @i{Samuel Wales} has provided important feedback and bug reports. |
18155 | @item | |
4009494e GM |
18156 | @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} |
18157 | keyword. | |
18158 | @item | |
18159 | @i{David Wainberg} suggested archiving, and improvements to the linking | |
18160 | system. | |
18161 | @item | |
4009494e | 18162 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in |
a7808fba | 18163 | linking to Gnus. |
4009494e | 18164 | @item |
a7808fba | 18165 | @i{Roland Winkler} requested additional key bindings to make Org |
4009494e GM |
18166 | work on a tty. |
18167 | @item | |
18168 | @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
18169 | and contributed various ideas and code snippets. | |
18170 | @end itemize | |
18171 | ||
18172 | ||
257b2c7d GM |
18173 | @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top |
18174 | @appendix GNU Free Documentation License | |
18175 | @include doclicense.texi | |
18176 | ||
18177 | ||
18178 | @node Main Index, Key Index, GNU Free Documentation License, Top | |
86fbb8ca | 18179 | @unnumbered Concept index |
4009494e GM |
18180 | |
18181 | @printindex cp | |
18182 | ||
afe98dfa | 18183 | @node Key Index, Command and Function Index, Main Index, Top |
86fbb8ca | 18184 | @unnumbered Key index |
4009494e GM |
18185 | |
18186 | @printindex ky | |
18187 | ||
afe98dfa CD |
18188 | @node Command and Function Index, Variable Index, Key Index, Top |
18189 | @unnumbered Command and function index | |
18190 | ||
18191 | @printindex fn | |
18192 | ||
18193 | @node Variable Index, , Command and Function Index, Top | |
86fbb8ca | 18194 | @unnumbered Variable index |
c8d0cf5c CD |
18195 | |
18196 | This is not a complete index of variables and faces, only the ones that are | |
18197 | mentioned in the manual. For a more complete list, use @kbd{M-x | |
a351880d | 18198 | org-customize @key{RET}} and then click yourself through the tree. |
c8d0cf5c CD |
18199 | |
18200 | @printindex vr | |
18201 | ||
4009494e GM |
18202 | @bye |
18203 | ||
a7808fba | 18204 | @c Local variables: |
a7808fba | 18205 | @c fill-column: 77 |
afe98dfa | 18206 | @c indent-tabs-mode: nil |
acedf35c CD |
18207 | @c paragraph-start: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$" |
18208 | @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$" | |
a7808fba | 18209 | @c End: |
44ce9197 | 18210 | |
7006d207 CD |
18211 | |
18212 | @c LocalWords: webdavhost pre |